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

#ifndef __STDC_LIMIT_MACROS
# define __STDC_LIMIT_MACROS
#endif
#ifndef __STDC_CONSTANT_MACROS
# define __STDC_CONSTANT_MACROS
#endif

#include <stdarg.h>

#import "OFObject.h"
#import "OFCollection.h"
#import "OFEnumerator.h"
#import "OFJSONRepresentation.h"
#import "OFMessagePackRepresentation.h"

OF_ASSUME_NONNULL_BEGIN

@class OFIndexSet;
@class OFString;

typedef enum {
    OFArraySkipEmptyComponents = 1
} OFArrayJoinOptions;

typedef enum {
    OFArraySortDescending = 1
} OFArraySortOptions;

#ifdef OF_HAVE_BLOCKS

typedef void (^OFArrayEnumerationBlock)(id object, size_t index, bool *stop);

typedef bool (^OFArrayFilterBlock)(id object, size_t index);

typedef id _Nonnull (^OFArrayMapBlock)(id object, size_t index);

typedef id _Nullable (^OFArrayFoldBlock)(id _Nullable left, id right);
#endif

@interface OFArray OF_GENERIC(ObjectType): OFObject <OFCopying,
    OFMutableCopying, OFCollection, OFJSONRepresentation,
    OFMessagePackRepresentation>
#if !defined(OF_HAVE_GENERICS) && !defined(DOXYGEN)
# define ObjectType id
#endif

@property (readonly, nonatomic)
    ObjectType const __unsafe_unretained _Nonnull *_Nonnull objects;

@property OF_NULLABLE_PROPERTY (readonly, nonatomic) ObjectType firstObject;

@property OF_NULLABLE_PROPERTY (readonly, nonatomic) ObjectType lastObject;

@property (readonly, nonatomic) OFArray OF_GENERIC(ObjectType) *sortedArray;

@property (readonly, nonatomic) OFArray OF_GENERIC(ObjectType) *reversedArray;

+ (instancetype)array;

+ (instancetype)arrayWithObject: (ObjectType)object;

+ (instancetype)arrayWithObjects: (ObjectType)firstObject, ... OF_SENTINEL;

+ (instancetype)arrayWithArray: (OFArray OF_GENERIC(ObjectType) *)array;

+ (instancetype)arrayWithObjects: (ObjectType const _Nonnull *_Nonnull)objects
               count: (size_t)count;

- (instancetype)init OF_DESIGNATED_INITIALIZER;

- (instancetype)initWithObject: (ObjectType)object;

- (instancetype)initWithObjects: (ObjectType)firstObject, ... OF_SENTINEL;

- (instancetype)initWithObject: (ObjectType)firstObject
             arguments: (va_list)arguments;

- (instancetype)initWithArray: (OFArray OF_GENERIC(ObjectType) *)array;

- (instancetype)initWithObjects: (ObjectType const _Nonnull *_Nonnull)objects
              count: (size_t)count OF_DESIGNATED_INITIALIZER;

- (OFEnumerator OF_GENERIC(ObjectType) *)objectEnumerator;

- (ObjectType)objectAtIndex: (size_t)index;
- (ObjectType)objectAtIndexedSubscript: (size_t)index;

- (nullable id)valueForKey: (OFString *)key;

- (void)setValue: (nullable id)value forKey: (OFString *)key;

- (void)getObjects: (ObjectType __unsafe_unretained _Nonnull *_Nonnull)buffer
       inRange: (OFRange)range;

- (size_t)indexOfObject: (ObjectType)object;

- (size_t)indexOfObjectIdenticalTo: (ObjectType)object;

- (bool)containsObject: (ObjectType)object;

- (bool)containsObjectIdenticalTo: (ObjectType)object;

- (OFArray OF_GENERIC(ObjectType) *)objectsInRange: (OFRange)range;

- (OFArray OF_GENERIC(ObjectType) *)objectsAtIndexes: (OFIndexSet *)indexes;

- (OFString *)componentsJoinedByString: (OFString *)separator;

- (OFString *)componentsJoinedByString: (OFString *)separator
                   options: (OFArrayJoinOptions)options;

- (OFString *)componentsJoinedByString: (OFString *)separator
             usingSelector: (SEL)selector;

- (OFString *)componentsJoinedByString: (OFString *)separator
             usingSelector: (SEL)selector
                   options: (OFArrayJoinOptions)options;

- (void)makeObjectsPerformSelector: (SEL)selector
    OF_DEPRECATED(ObjFW, 1, 4, "Use fast enumeration instead");

- (void)makeObjectsPerformSelector: (SEL)selector
            withObject: (nullable id)object
    OF_DEPRECATED(ObjFW, 1, 4, "Use fast enumeration instead");

- (OFArray OF_GENERIC(ObjectType) *)
    sortedArrayUsingSelector: (SEL)selector
             options: (OFArraySortOptions)options;

- (OFArray OF_GENERIC(ObjectType) *)
    sortedArrayUsingFunction: (OFCompareFunction)compare
             context: (nullable void *)context
             options: (OFArraySortOptions)options;

#ifdef OF_HAVE_BLOCKS

- (OFArray OF_GENERIC(ObjectType) *)
    sortedArrayUsingComparator: (OFComparator)comparator
               options: (OFArraySortOptions)options;
#endif

- (OFArray OF_GENERIC(ObjectType) *)arrayByAddingObject: (ObjectType)object;

- (OFArray OF_GENERIC(ObjectType) *)arrayByAddingObjectsFromArray:
    (OFArray OF_GENERIC(ObjectType) *)array;

#ifdef OF_HAVE_BLOCKS

- (void)enumerateObjectsUsingBlock: (OFArrayEnumerationBlock)block;

- (OFArray *)mappedArrayUsingBlock: (OFArrayMapBlock)block;

- (OFArray OF_GENERIC(ObjectType) *)filteredArrayUsingBlock:
    (OFArrayFilterBlock)block;

- (nullable id)foldUsingBlock: (OFArrayFoldBlock)block;
#endif
#if !defined(OF_HAVE_GENERICS) && !defined(DOXYGEN)
# undef ObjectType
#endif
@end

OF_ASSUME_NONNULL_END

#import "OFMutableArray.h"

#if !defined(NSINTEGER_DEFINED) && !__has_feature(objc_modules)
/* Required for array literals to work */
@compatibility_alias NSArray OFArray;
#endif