OFList.h

/*
 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015
 *   Jonathan Schleifer <js@webkeks.org>
 *
 * All rights reserved.
 *
 * This file is part of ObjFW. It may be distributed under the terms of the
 * Q Public License 1.0, which can be found in the file LICENSE.QPL included in
 * the packaging of this file.
 *
 * Alternatively, it may be distributed under the terms of the GNU General
 * Public License, either version 2 or 3, which can be found in the file
 * LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this
 * file.
 */

#import "OFObject.h"
#import "OFCollection.h"
#import "OFEnumerator.h"
#import "OFSerialization.h"

OF_ASSUME_NONNULL_BEGIN

typedef struct of_list_object_t of_list_object_t;
struct of_list_object_t {
    of_list_object_t *next;
    of_list_object_t *previous;
    id __unsafe_unretained object;
};

#ifdef OF_HAVE_GENERICS
@interface OFList <ObjectType>:
#else
# ifndef DOXYGEN
#  define ObjectType id
# endif
@interface OFList:
#endif
    OFObject <OFCopying, OFCollection, OFSerialization>
{
    of_list_object_t *_firstListObject;
    of_list_object_t *_lastListObject;
    size_t       _count;
    unsigned long    _mutations;
}

#ifdef OF_HAVE_PROPERTIES
@property OF_NULLABLE_PROPERTY (readonly) of_list_object_t *firstListObject;
@property OF_NULLABLE_PROPERTY (readonly) of_list_object_t *lastListObject;
#endif

+ (instancetype)list;

- (nullable of_list_object_t*)firstListObject;

- (nullable of_list_object_t*)lastListObject;

- (of_list_object_t*)appendObject: (ObjectType)object;

- (of_list_object_t*)prependObject: (ObjectType)object;

- (of_list_object_t*)insertObject: (ObjectType)object
         beforeListObject: (of_list_object_t*)listObject;

- (of_list_object_t*)insertObject: (ObjectType)object
          afterListObject: (of_list_object_t*)listObject;

- (void)removeListObject: (of_list_object_t*)listObject;

- (bool)containsObject: (nullable ObjectType)object;

- (bool)containsObjectIdenticalTo: (nullable ObjectType)object;

- (OFEnumerator OF_GENERIC(ObjectType)*)objectEnumerator;

- (nullable ObjectType)firstObject;

- (nullable ObjectType)lastObject;

- (void)removeAllObjects;
@end
#if !defined(OF_HAVE_GENERICS) && !defined(DOXYGEN)
# undef ObjectType
#endif

@interface OFListEnumerator: OFEnumerator
{
    OFList       *_list;
    of_list_object_t *_current;
    unsigned long    _mutations;
    unsigned long    *_mutationsPtr;
}

-     initWithList: (OFList*)list
  mutationsPointer: (unsigned long*)mutationsPtr;
@end

OF_ASSUME_NONNULL_END