Iterator.h

//
// $Id: Iterator.h,v 1.39 2007/03/06 20:42:19 will_mason Exp $
//
// vi: set ft=objc:

/*
 * ObjectiveLib - a library of containers and algorithms for Objective-C
 *
 * Copyright (c) 2004-2007
 * Will Mason
 *
 * Portions:
 *
 * Copyright (c) 1994
 * Hewlett-Packard Company
 *
 * Copyright (c) 1996,1997
 * Silicon Graphics Computer Systems, Inc.
 *
 * Copyright (c) 1997
 * Moscow Center for SPARC Technology
 *
 * Copyright (c) 1999 
 * Boris Fomitchev
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * You may contact the author at will_mason@users.sourceforge.net.
 */

#if !defined(ITERATOR_OL_GUARD)
#define ITERATOR_OL_GUARD

#include <ObjectiveLib/Pair.h>

@interface OLIterator :
#if defined(OL_NO_OPENSTEP)
    Object
#else
    NSObject <NSCopying>
#endif
{
}

+ (void) advanceIterator: (OLIterator*)itor distance: (int)count;

+ (unsigned) distanceFrom: (OLIterator*)first to: (OLIterator*)last;

- (id) assign: (id)object;

#if defined(OL_NO_OPENSTEP)

- (id) copy;
#else

- (id) copyWithZone: (NSZone*)zone;
#endif

- (id) dereference;

- (BOOL) isEqual: (id)object;

@end

@interface OLForwardIterator : OLIterator
{
}

- (id) advance;

@end

@interface OLBidirectionalIterator : OLForwardIterator
{
}

- (id) reverse;

@end

@interface OLRandomAccessIterator : OLBidirectionalIterator
{
}

- (id) advanceBy: (int)count;

- (int) difference: (OLRandomAccessIterator*)other;

@end

@interface OLReverseBidiIterator : OLBidirectionalIterator
{
@protected
    OLBidirectionalIterator* current;
}

/* @{ */

- (id) initWithIterator: (OLBidirectionalIterator*)itor;

#if defined(OL_NO_OPENSTEP)
- (id) free;
#else
- (void) dealloc;
#endif

/* @} */

- (id) advance;

- (id) assign: (id)object;
#if defined(OL_NO_OPENSTEP)
- (id) copy;
#else
- (id) copyWithZone: (NSZone*)zone;
#endif
- (id) dereference;
- (BOOL) isEqual: (id)object;

- (id) reverse;

@end

@interface OLReverseRandomIterator : OLReverseBidiIterator
{
}

- (id) advanceBy: (int)count;
#if defined(OL_NO_OPENSTEP)
- (id) copy;
#else
- (id) copyWithZone: (NSZone*)zone;
#endif
- (BOOL) isEqual: (id)object;

@end

@protocol OLBackInserter

- (BOOL) isEqual: (id)object;

- (void) pushBack: (id)object;

@end

@interface OLBackInsertIterator : OLForwardIterator
{
@protected
    id<OLBackInserter> container;
}

/* @{ */
- (id) initWithBackInserter: (id<OLBackInserter>)cnr;
/* @} */

- (id) assign: (id)object;
#if defined(OL_NO_OPENSTEP)
- (id) copy;
#else
- (id) copyWithZone: (NSZone*)zone;
#endif
- (BOOL) isEqual: (id)object;

@end

@protocol OLFrontInserter

- (BOOL) isEqual: (id)object;

- (void) pushFront: (id)object;

@end

@interface OLFrontInsertIterator : OLForwardIterator
{
@protected
    id<OLFrontInserter> container;
}

/* @{ */
- (id) initWithFrontInserter: (id<OLFrontInserter>)cnr;
/* @} */

- (id) assign: (id)object;
#if defined(OL_NO_OPENSTEP)
- (id) copy;
#else
- (id) copyWithZone: (NSZone*)zone;
#endif
- (BOOL) isEqual: (id)object;

@end

@protocol OLInserter

- (OLIterator*) insertAt: (OLIterator*)where value: (id)object;

- (BOOL) isEqual: (id)object;

@end

@interface OLInsertIterator : OLForwardIterator
{
@protected
    id<OLInserter>      container;

    OLForwardIterator*  iterator;
}

/* @{ */
- (id) initWithInserter: (id<OLInserter>)cnr iterator: (OLForwardIterator*)itor;
#if defined(OL_NO_OPENSTEP)
- (id) free;
#else
- (void) dealloc;
#endif
/* @} */

- (id) assign: (id)object;
#if defined(OL_NO_OPENSTEP)
- (id) copy;
#else
- (id) copyWithZone: (NSZone*)zone;
#endif
- (BOOL) isEqual: (id)object;

@end

@class OLTreeNode;

@interface OLAssociativeIterator : OLBidirectionalIterator
{
@private
    OLTreeNode* node;
}

- (id) advance;
- (id) assign: (id)object;
#if defined(OL_NO_OPENSTEP)
- (id) copy;
#else
- (id) copyWithZone: (NSZone*)zone;
#endif
- (id) dereference;
- (BOOL) isEqual: (id)object;
- (id) reverse;

@end

@interface OLArrayIterator : OLRandomAccessIterator
{
@protected
    id* current;
}

+ (OLPair*) pairWithPointer: (id*)p1 andPointer: (id*)p2;

+ (OLPair*) pairWithPointer: (id*)p distance: (unsigned)count;

/* @{ */
- (id) initWithPointer: (id*)ptr;
/* @} */

- (id) advance;
- (id) advanceBy: (int)count;
- (id) assign: (id)object;
#if defined(OL_NO_OPENSTEP)
- (id) copy;
#else
- (id) copyWithZone: (NSZone*)zone;
#endif
- (id) dereference;
- (int) difference: (OLRandomAccessIterator*)other;
- (BOOL) isEqual: (id)object;
- (id) reverse;

@end

struct _OLHashTableNode;

@class OLHashTable;

@interface OLHashIterator : OLForwardIterator
{
@private
    OLHashTable*                table;

    struct _OLHashTableNode*    current;
}

- (id) advance;
- (id) assign: (id)object;
#if defined(OL_NO_OPENSTEP)
- (id) copy;
#else
- (id) copyWithZone: (NSZone*)zone;
#endif
- (id) dereference;
- (BOOL) isEqual: (id)object;

@end

#endif

---

Generated Sun Apr 22 15:12:39 2007, © 2004-2007 Will Mason