err.no Git - sope/blob - sope-core/NGExtensions/NGExtensions/NGStack.h

   1 /*
   2   Copyright (C) 2000-2005 SKYRIX Software AG
   3
   4   This file is part of SOPE.
   5
   6   SOPE is free software; you can redistribute it and/or modify it under
   7   the terms of the GNU Lesser General Public License as published by the
   8   Free Software Foundation; either version 2, or (at your option) any
   9   later version.
  10
  11   SOPE is distributed in the hope that it will be useful, but WITHOUT ANY
  12   WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
  14   License for more details.
  15
  16   You should have received a copy of the GNU Lesser General Public
  17   License along with SOPE; see the file COPYING.  If not, write to the
  18   Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  19   02111-1307, USA.
  20 */
  21
  22 #ifndef __NGExtensions_NGStack_H__
  23 #define __NGExtensions_NGStack_H__
  24
  25 #import <Foundation/NSObject.h>
  26 #import <Foundation/NSException.h>
  27 #import <Foundation/NSArray.h>
  28
  29 @class NSArray;
  30
  31 @protocol NGStack < NSObject >
  32
  33 // state
  34
  35 - (unsigned int)stackPointer;
  36 - (unsigned int)count;
  37 - (BOOL)isEmpty;
  38
  39 // operations
  40
  41 - (void)push:(id)_obj;
  42 - (id)pop;
  43 - (void)clear;
  44
  45 // elements
  46
  47 - (id)elementAtTop;
  48 - (NSEnumerator *)topDownEnumerator;
  49 - (NSEnumerator *)bottomUpEnumerator;
  50
  51 @end
  52
  53 @interface NGStack : NSObject < NGStack, NSCoding, NSCopying >
  54 {
  55 @protected
  56   unsigned int stackPointer;
  57   unsigned int capacity;
  58   id           *stack;
  59 }
  60
  61 + (id)stackWithCapacity:(unsigned int)_capacity;
  62 + (id)stack;
  63 + (id)stackWithArray:(NSArray *)_array;
  64 - (id)init;
  65 - (id)initWithCapacity:(unsigned int)_capacity; // designated initializer
  66 - (id)initWithArray:(NSArray *)_array;
  67
  68 // state
  69
  70 - (unsigned int)capacity;
  71
  72 - (unsigned int)stackPointer;
  73 - (unsigned int)count;
  74 - (BOOL)isEmpty;
  75
  76 // elements
  77
  78 - (id)elementAtTop;
  79 - (id)elementAtBottom;
  80 - (NSEnumerator *)topDownEnumerator;
  81 - (NSEnumerator *)bottomUpEnumerator;
  82
  83 // operations
  84
  85 - (void)push:(id)_obj;
  86 - (id)pop;
  87 - (void)clear;
  88
  89 // description
  90
  91 - (NSArray *)toArray; // array representation, bottom element first
  92
  93 @end
  94
  95 @interface NGStackException : NSException
  96 @end
  97
  98 @interface NSMutableArray(Stack) < NGStack >
  99 @end
 100
 101 #endif /* __NGExtensions_NGStack_H__ */