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

#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 "OFSerialization.h"
#import "OFJSONRepresentation.h"
#import "OFMessagePackRepresentation.h"

OF_ASSUME_NONNULL_BEGIN

@class OFString;

enum {
    OF_ARRAY_SKIP_EMPTY = 1,
    OF_ARRAY_SORT_DESCENDING = 2
};

#ifdef OF_HAVE_BLOCKS

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

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

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

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

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

+ (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;

- initWithObject: (ObjectType)object;

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

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

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

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

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

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

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

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

- (ObjectType const __unsafe_unretained _Nonnull *_Nonnull)objects;

- (size_t)indexOfObject: (ObjectType)object;

- (size_t)indexOfObjectIdenticalTo: (ObjectType)object;

- (bool)containsObject: (ObjectType)object;

- (bool)containsObjectIdenticalTo: (ObjectType)object;

- (nullable ObjectType)firstObject;

- (nullable ObjectType)lastObject;

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

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

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

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

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

- (void)makeObjectsPerformSelector: (SEL)selector;

- (void)makeObjectsPerformSelector: (SEL)selector
            withObject: (nullable id)object;

- (OFArray OF_GENERIC(ObjectType) *)sortedArray;

- (OFArray OF_GENERIC(ObjectType) *)sortedArrayWithOptions: (int)options;

- (OFArray OF_GENERIC(ObjectType) *)reversedArray;

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

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

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

- (OFEnumerator OF_GENERIC(ObjectType) *)objectEnumerator;

#ifdef OF_HAVE_BLOCKS

- (void)enumerateObjectsUsingBlock: (of_array_enumeration_block_t)block;

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

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

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

@interface OFArrayEnumerator: OFEnumerator
{
    OFArray *_array;
    size_t _count;
    unsigned long _mutations;
    unsigned long *_Nullable _mutationsPtr;
    size_t _position;
}

- initWithArray: (OFArray *)data
   mutationsPtr: (nullable unsigned long *)mutationsPtr;
@end

OF_ASSUME_NONNULL_END

#import "OFMutableArray.h"

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