OFList.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2024 Jonathan Schleifer <js@nil.im>
 *
 * All rights reserved.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3.0 only,
 * as published by the Free Software Foundation.
 *
 * This program 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
 * version 3.0 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3.0 along with this program. If not, see
 * <https://www.gnu.org/licenses/>.
 */
 
#import "OFObject.h"
#import "OFCollection.h"
#import "OFEnumerator.h"
 
OF_ASSUME_NONNULL_BEGIN
 
/*
 * Make clang's -Wdocumentation shut up about about using @struct on something
 * it thinks is not a struct. Doxygen requires it this way.
 */
#ifdef __clang__
# pragma clang diagnostic push
# pragma clang diagnostic ignored "-Wdocumentation"
#endif
typedef struct _OFListItem *OFListItem;
#ifdef __clang__
# pragma clang diagnostic pop
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
extern OFListItem _Nullable OFListItemNext(OFListItem _Nonnull listItem);
 
extern OFListItem _Nullable OFListItemPrevious(OFListItem _Nonnull listItem);
 
extern id _Nonnull OFListItemObject(OFListItem _Nonnull listItem);
#ifdef __cplusplus
}
#endif
 
@interface OFList OF_GENERIC(ObjectType): OFObject <OFCopying, OFCollection>
#if !defined(OF_HAVE_GENERICS) && !defined(DOXYGEN)
# define ObjectType id
#endif
{
    OFListItem _Nullable _firstListItem;
    OFListItem _Nullable _lastListItem;
    size_t _count;
    unsigned long _mutations;
    OF_RESERVE_IVARS(OFList, 4)
}
 
@property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFListItem firstListItem;
 
@property OF_NULLABLE_PROPERTY (readonly, nonatomic) ObjectType firstObject;
 
@property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFListItem lastListItem;
 
@property OF_NULLABLE_PROPERTY (readonly, nonatomic) ObjectType lastObject;
 
+ (instancetype)list;
 
- (OFListItem)appendObject: (ObjectType)object;
 
- (OFListItem)prependObject: (ObjectType)object;
 
- (OFListItem)insertObject: (ObjectType)object
        beforeListItem: (OFListItem)listItem;
 
- (OFListItem)insertObject: (ObjectType)object
         afterListItem: (OFListItem)listItem;
 
- (void)removeListItem: (OFListItem)listItem;
 
- (bool)containsObject: (ObjectType)object;
 
- (bool)containsObjectIdenticalTo: (ObjectType)object;
 
- (void)removeAllObjects;
#if !defined(OF_HAVE_GENERICS) && !defined(DOXYGEN)
# undef ObjectType
#endif
@end
 
OF_ASSUME_NONNULL_END