Array.h

Go to the documentation of this file.

/*
 * Objectively: Ultra-lightweight object oriented framework for GNU C.
 * Copyright (C) 2014 Jay Dolan <jay@jaydolan.com>
 *
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 * claim that you wrote the original software. If you use this software
 * in a product, an acknowledgment in the product documentation would be
 * appreciated but is not required.
 *
 * 2. Altered source versions must be plainly marked as such, and must not be
 * misrepresented as being the original software.
 *
 * 3. This notice may not be removed or altered from any source distribution.
 */
 
#pragma once
 
#include <stdarg.h>
 
#include <Objectively/Object.h>
 
typedef struct Array Array;
typedef struct ArrayInterface ArrayInterface;
 
typedef void (*ArrayEnumerator)(const Array *array, ident obj, ident data);
 
struct Array {
 
    Object object;
 
    ArrayInterface *interface;
 
    size_t count;
 
    ident *elements;
};
 
typedef struct MutableArray MutableArray;
 
struct ArrayInterface {
 
    ObjectInterface objectInterface;
 
    Array *(*arrayWithArray)(const Array *array);
 
    Array *(*arrayWithObjects)(ident obj, ...);
 
    Array *(*arrayWithVaList)(va_list args);
 
    String *(*componentsJoinedByCharacters)(const Array *self, const char *chars);
 
    String *(*componentsJoinedByString)(const Array *self, const String *string);
 
    _Bool (*containsObject)(const Array *self, const ident obj);
 
    void (*enumerateObjects)(const Array *self, ArrayEnumerator enumerator, ident data);
 
    Array *(*filteredArray)(const Array *self, Predicate predicate, ident data);
 
    ident (*findObject)(const Array *self, Predicate predicate, ident data);
 
    ident (*firstObject)(const Array *self);
 
    ssize_t (*indexOfObject)(const Array *self, const ident obj);
 
    Array *(*initWithArray)(Array *self, const Array *array);
 
    Array *(*initWithObjects)(Array *self, ...);
 
    Array *(*initWithVaList)(Array *self, va_list args);
 
    ident (*lastObject)(const Array *self);
 
    Array *(*mappedArray)(const Array *self, Functor functor, ident data);
 
    MutableArray *(*mutableCopy)(const Array *self);
 
    ident (*objectAtIndex)(const Array *self, size_t index);
 
    ident (*reduce)(const Array *self, Reducer reducer, ident accumulator, ident data);
 
    Array *(*sortedArray)(const Array *self, Comparator comparator);
};
 
OBJECTIVELY_EXPORT Class *_Array(void);