OFArray.h

/*
 * Copyright (c) 2008, 2009, 2010, 2011, 2012
 *   Jonathan Schleifer <js@webkeks.org>
 *
 * 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"

@class OFString;

#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 odject, size_t index);
typedef id (^of_array_map_block_t)(id object, size_t index);
typedef id (^of_array_fold_block_t)(id left, id right);
#endif

@interface OFArray: OFObject <OFCopying, OFMutableCopying, OFCollection,
    OFSerialization, OFJSONRepresentation>
#ifdef OF_HAVE_PROPERTIES
@property (readonly) size_t count;
#endif

+ (instancetype)array;

+ (instancetype)arrayWithObject: (id)object;

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

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

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

- initWithObject: (id)object;

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

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

- initWithArray: (OFArray*)array;

- initWithObjects: (id const*)objects
        count: (size_t)count;

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

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

- (id*)objects;

- (size_t)indexOfObject: (id)object;

- (size_t)indexOfObjectIdenticalTo: (id)object;

- (BOOL)containsObjectIdenticalTo: (id)object;

- (id)firstObject;

- (id)lastObject;

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

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

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

- (void)makeObjectsPerformSelector: (SEL)selector;

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

- (OFArray*)sortedArray;

- (OFArray*)reversedArray;

- (OFArray*)arrayByAddingObject: (id)object;

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

- (OFArray*)arrayByRemovingObject: (id)object;

#ifdef OF_HAVE_BLOCKS

- (void)enumerateObjectsUsingBlock: (of_array_enumeration_block_t)block;

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

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

- (id)foldUsingBlock: (of_array_fold_block_t)block;
#endif
@end

@interface OFArrayEnumerator: OFEnumerator
{
    OFArray       *array;
    size_t        count;
    unsigned long mutations;
    unsigned long *mutationsPtr;
    size_t        position;
}

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

#import "OFMutableArray.h"

#ifndef NSINTEGER_DEFINED
/* Required for array literals to work */
@compatibility_alias NSArray OFArray;
#endif