SCStack.h

Go to the documentation of this file.

//
//  SCStack.h
//  scl
//
//  Created by Viacheslav Smolensky on 13.04.12.
//  Copyright (c) 2007 - 2018 by Samond Development Corporation. All rights reserved.
//

#import <Foundation/Foundation.h>
#import <scl/NSArray+SCArray.h>
#import <scl/NSDictionary+SCDictionary.h>
#import <scl/SCCollection.h>

#pragma mark -
#pragma mark Class Constants

#define SCStackClass    @"SCStack"

@interface SCStack : SCCollection {
    NSMutableArray *_stack; // Internal data storage
}

@property (nonatomic, readonly, assign) id topObject;

#pragma mark -
#pragma mark Creating Stacks
+ (instancetype)stackWithCoder:(NSCoder *)coder;
+ (instancetype)stackWithContentsOfSerializedFile:(NSString *)path;
+ (instancetype)stackWithDataDictionary:(NSDictionary *)dictionary;
+ (instancetype)stackWithDataDictionaryFromFile:(NSString *)path;
+ (instancetype)stackWithStream:(SCStream *)stream;
+ (instancetype)stackWithFileStream:(NSString *)path;
+ (instancetype)stackWithData:(NSData *)data;
+ (instancetype)stackWithContentsOfFile:(NSString *)path;
+ (instancetype)stackWithContentsOfURL:(NSURL *)url;
+ (instancetype)stackWithContentsOfURLString:(NSString *)urlString;

+ (instancetype)stackWithName:(NSString *)name;
+ (instancetype)stackWithObject:(id<SCCollectioning>)object;
+ (instancetype)stackWithObjects:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;
+ (instancetype)stackWithCollection:(id<SCCollection>)collection;
+ (instancetype)stackWithArray:(SCArray *)array;
+ (instancetype)stackWithStack:(SCStack *)stack;
+ (instancetype)stack;

#pragma mark -
#pragma mark Initializing Stacks
- (instancetype)initWithName:(NSString *)name;
- (instancetype)initWithObject:(id<SCCollectioning>)object;
- (instancetype)initWithObjects:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;
- (instancetype)initWithCollection:(id<SCCollection>)collection;
- (instancetype)initWithArray:(SCArray *)array;
- (instancetype)initWithStack:(SCStack *)stack;
- (instancetype)init;

#pragma mark -
#pragma mark Copying Stacks
- (void)setStack:(SCStack *)stack;

#pragma mark -
#pragma mark Comparing Stacks
- (BOOL)isEqualToStack:(SCStack *)stack;

#pragma mark -
#pragma mark Deriving New Stacks
- (SCStack *)stackByPushingObject:(id<SCCollectioning>)object;
- (SCStack *)stackByPushingObjects:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;
- (SCStack *)stackByPushingCollection:(id<SCCollection>)collection;
- (SCStack *)stackByPushingObjectsFromArray:(SCArray *)array;
- (SCStack *)stackByPushingArray:(SCArray *)array;
- (SCStack *)stackByPushingObjectsFromStack:(SCStack *)stack;
- (SCStack *)stackByPushingStack:(SCStack *)stack;

#pragma mark -
#pragma mark Pushing Objects
- (void)pushObject:(id<SCCollectioning>)object;
- (void)pushObjects:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;
- (void)pushCollection:(id<SCCollection>)collection;
- (void)pushObjectsFromArray:(SCArray *)array;
- (void)pushArray:(SCArray *)array;
- (void)pushObjectsFromStack:(SCStack *)stack;
- (void)pushStack:(SCStack *)stack;

#pragma mark -
#pragma mark Poping Objects
- (void)pop;
- (id)popObject;

#pragma mark -
#pragma mark Removing Objects
- (void)removeTopObject;

#pragma mark -
#pragma mark Copying Objects
- (void)duplicateTopObject;

@end