OFList.h

/*
 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017
 *   Jonathan Schleifer <js@heap.zone>
 *
 * 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 *_Nullable next;
    of_list_object_t *_Nullable previous;
    id __unsafe_unretained object;
};

@interface OFList OF_GENERIC(ObjectType): OFObject <OFCopying, OFCollection,
    OFSerialization>
#if !defined(OF_HAVE_GENERICS) && !defined(DOXYGEN)
# define ObjectType id
#endif
{
    of_list_object_t *_Nullable _firstListObject;
    of_list_object_t *_Nullable _lastListObject;
    size_t _count;
    unsigned long  _mutations;
}

@property OF_NULLABLE_PROPERTY (readonly, nonatomic)
    of_list_object_t *firstListObject;

@property OF_NULLABLE_PROPERTY (readonly, nonatomic)
    of_list_object_t *lastListObject;

+ (instancetype)list;

- (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: (ObjectType)object;

- (bool)containsObjectIdenticalTo: (ObjectType)object;

- (OFEnumerator OF_GENERIC(ObjectType) *)objectEnumerator;

- (nullable ObjectType)firstObject;

- (nullable ObjectType)lastObject;

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

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

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

OF_ASSUME_NONNULL_END