//
//  SPTreeNode.h
//  sequel-pro
//
//  Created by Stuart Connolly (stuconnolly.com) on November 23, 2010.
//  Copyright (c) 2010 Stuart Connolly. All rights reserved.
//
//  Permission is hereby granted, free of charge, to any person
//  obtaining a copy of this software and associated documentation
//  files (the "Software"), to deal in the Software without
//  restriction, including without limitation the rights to use,
//  copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the
//  Software is furnished to do so, subject to the following
//  conditions:
//
//  The above copyright notice and this permission notice shall be
//  included in all copies or substantial portions of the Software.
//
//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
//  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
//  OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
//  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
//  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
//  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
//  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
//  OTHER DEALINGS IN THE SOFTWARE.
//
//  More info at <https://github.com/sequelpro/sequelpro>

/**
 * @class SPTreeNode SPTreeNode.h
 *
 * @author Stuart Connolly http://stuconnolly.com/
 *
 * NSTreeNode subclass which adds some convenience methods.
 */
@interface SPTreeNode : NSTreeNode <NSCoding>
{
	BOOL isGroup;
}

@property (nullable, readonly, copy) NSArray<SPTreeNode *> *childNodes;

/**
 * @property isGroup Indicates whether or not the node is a group.
 */
@property (readwrite, assign) BOOL isGroup;

- (void)removeObjectFromChildren:(nonnull id)object;

- (nonnull NSMutableArray *)descendants;
- (nonnull NSMutableArray *)childLeafs;
- (nonnull NSMutableArray *)allChildLeafs;
- (nonnull NSMutableArray *)groupChildren;

- (nullable SPTreeNode *)parentFromArray:(nonnull NSArray *)array;

- (BOOL)isDescendantOfOrOneOfNodes:(nonnull NSArray *)nodes;
- (BOOL)isDescendantOfNodes:(nonnull NSArray *)nodes;

- (nonnull NSDictionary *)dictionaryRepresentation;

@end