OFMutableArray.h

Go to the documentation of this file.

/*
 * 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 "OFArray.h"

OF_ASSUME_NONNULL_BEGIN

#ifdef OF_HAVE_BLOCKS

typedef id _Nonnull (^of_array_replace_block_t)(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;

- initWithCapacity: (size_t)capacity;

- (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)replaceObject: (ObjectType)oldObject
       withObject: (ObjectType)newObject;

- (void)replaceObjectAtIndex: (size_t)index
          withObject: (ObjectType)object;
-    (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: (of_range_t)range;

- (void)removeLastObject;

- (void)removeAllObjects;

#ifdef OF_HAVE_BLOCKS

- (void)replaceObjectsUsingBlock: (of_array_replace_block_t)block;
#endif

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

- (void)sort;

- (void)sortWithOptions: (int)options;

- (void)reverse;

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

OF_ASSUME_NONNULL_END