OFMutableArray.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2026 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 "OFArray.h"
 
OF_ASSUME_NONNULL_BEGIN
 
@class OFIndexSet;

 
#ifdef OF_HAVE_BLOCKS
typedef id _Nonnull (^OFArrayReplaceBlock)(id object, size_t index);
#endif

@interface OFMutableArray OF_GENERIC(ObjectType): OFArray OF_GENERIC(ObjectType)
#if !defined(OF_HAVE_GENERICS) && !defined(DOXYGEN)
# define ObjectType id
#endif
+ (instancetype)arrayWithCapacity: (size_t)capacity;

- (instancetype)init OF_DESIGNATED_INITIALIZER;

- (instancetype)initWithCapacity: (size_t)capacity OF_DESIGNATED_INITIALIZER;

- (void)addObject: (ObjectType)object;

- (void)addObjectsFromArray: (OFArray OF_GENERIC(ObjectType) *)array;

- (void)insertObject: (ObjectType)object atIndex: (size_t)index;

- (void)insertObjectsFromArray: (OFArray OF_GENERIC(ObjectType) *)array
               atIndex: (size_t)index;

- (void)insertObjects: (OFArray OF_GENERIC(ObjectType) *)array
        atIndexes: (OFIndexSet *)indexes;

- (void)replaceObject: (ObjectType)oldObject withObject: (ObjectType)newObject;

- (void)replaceObjectAtIndex: (size_t)index withObject: (ObjectType)object;

- (void)replaceObjectsInRange: (OFRange)range
     withObjectsFromArray: (OFArray OF_GENERIC(ObjectType) *)objects;

- (void)replaceObjectsAtIndexes: (OFIndexSet *)indexes
            withObjects: (OFArray OF_GENERIC(ObjectType) *)objects;

- (void)setObject: (ObjectType)object atIndexedSubscript: (size_t)index;

- (void)replaceObjectIdenticalTo: (ObjectType)oldObject
              withObject: (ObjectType)newObject;

- (void)removeObject: (ObjectType)object;

- (void)removeObjectIdenticalTo: (ObjectType)object;

- (void)removeObjectAtIndex: (size_t)index;

- (void)removeObjectsInRange: (OFRange)range;

- (void)removeObjectsAtIndexes: (OFIndexSet *)indexes;

- (void)removeLastObject;

- (void)removeAllObjects;
 
#ifdef OF_HAVE_BLOCKS
- (void)replaceObjectsUsingBlock: (OFArrayReplaceBlock)block;
#endif

- (void)exchangeObjectAtIndex: (size_t)index1 withObjectAtIndex: (size_t)index2;

- (void)sort;

- (void)sortUsingSelector: (SEL)selector options: (OFArraySortOptions)options;

- (void)sortUsingFunction: (OFCompareFunction)compare
          context: (nullable void *)context
          options: (OFArraySortOptions)options;
 
#ifdef OF_HAVE_BLOCKS
- (void)sortUsingComparator: (OFComparator)comparator
            options: (OFArraySortOptions)options;
#endif

- (void)reverse;

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