List.h

//
// $Id: List.h,v 1.34 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(LIST_OL_GUARD)
#define LIST_OL_GUARD

#include <ObjectiveLib/Functional.h>
#include <ObjectiveLib/Iterator.h>

@class OLListNode;

@interface OLListIterator : OLBidirectionalIterator
{
@private
    OLListNode*     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 OLList :
#if defined(OL_NO_OPENSTEP)
    Object <OLBackInserter, OLFrontInserter, OLInserter, OLStreamable>
#else
    NSObject <OLBackInserter, OLFrontInserter, OLInserter, OLStreamable, NSCopying, NSCoding>
#endif
{
@protected
    OLListNode*     node;
}

+ (id) list;

+ (id) listFrom: (OLForwardIterator*)first to: (OLForwardIterator*)last;

+ (id) listWithList: (OLList*)right;

+ (id) listWithSize: (unsigned)size filledWith: (id)value;

/* @{ */
- (id) init;

- (id) initFrom: (OLForwardIterator*)first to: (OLForwardIterator*)last;

#if !defined(OL_NO_OPENSTEP)

- (id) initWithCoder: (NSCoder*)decoder;
#endif

- (id) initWithList: (OLList*)list;

- (id) initWithObjectInStream: (OLObjectInStream*)stream;

- (id) initWithSize: (unsigned)size filledWith: (id)value;

#if defined(OL_NO_OPENSTEP)
- (id) free;
#else
- (void) dealloc;
#endif
/* @} */

- (void) assign: (unsigned)count filledWith: (id)value;

- (void) assignFrom: (OLForwardIterator*)first to: (OLForwardIterator*)last;

- (id) back;

- (OLListIterator*) begin;

- (void) clear;

- (int) compare: (id)other;

#if defined(OL_NO_OPENSTEP)

- (id) copy;
#else

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

- (BOOL) empty;

#if !defined(OL_NO_OPENSTEP)

- (void) encodeWithCoder: (NSCoder*)encoder;
#endif

- (OLListIterator*) end;

- (OLListIterator*) erase: (OLListIterator*)where;

- (OLListIterator*) eraseFrom: (OLListIterator*)first to: (OLListIterator*)last;

- (id) front;

- (void) insertAt: (OLListIterator*)where count: (unsigned)num filledWith: (id)value;

- (void) insertAt: (OLListIterator*)where from: (OLForwardIterator*)first to: (OLForwardIterator*)last;

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

- (BOOL) isEqual: (id)object;

- (unsigned) maxSize;

- (void) merge: (OLList*)right;

- (void) merge: (OLList*)right withOrder: (id<OLBoolBinaryFunction>)pred;

- (void) popBack;

- (void) popFront;

- (void) pushBack: (id)object;

- (void) pushFront: (id)object;

- (OLReverseBidiIterator*) rbegin;

- (void) remove: (id)object;

- (void) removeIf: (id<OLBoolUnaryFunction>)pred;

- (OLReverseBidiIterator*) rend;

- (void) resize: (unsigned)count filledWith: (id)value;

- (void) reverse;

- (unsigned) size;

- (void) sort;

- (void) sortWith: (id<OLBoolBinaryFunction>)pred;

- (void) spliceAt: (OLListIterator*)where list: (OLList*)right;

- (void) spliceAt: (OLListIterator*)where list: (OLList*)right from: (OLListIterator*)first;

- (void) spliceAt: (OLListIterator*)where list: (OLList*)right from: (OLListIterator*)first to: (OLListIterator*)last;

- (void) swap: (OLList*)right;

- (void) unique;

- (void) uniqueWith: (id<OLBoolBinaryFunction>)pred;

- (void) writeSelfToStream: (OLObjectOutStream*)stream;

@end

#endif

---

Generated Sun Apr 22 15:17:59 2007, © 2004-2007 Will Mason