AEArray.h

Go to the documentation of this file.

//
//  AEArray.h
//  TheAmazingAudioEngine
//
//  Created by Michael Tyson on 30/03/2016.
//  Copyright © 2016 A Tasty Pixel. All rights reserved.
//
//  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.
//

#ifdef __cplusplus
extern "C" {
#endif
    
#import <Foundation/Foundation.h>

typedef const void * AEArrayToken; 

typedef void * _Nullable (^AEArrayCustomMappingBlock)(id _Nonnull item);

typedef void * _Nullable (^AEArrayIndexedCustomMappingBlock)(id _Nonnull item, int index);

typedef void (^AEArrayReleaseBlock)(id _Nonnull item, void * _Nonnull bytes);

// Some indirection macros required for AEArrayEnumerate
#define __AEArrayVar2(x, y) x ## y
#define __AEArrayVar(x, y) __AEArrayVar2(__ ## x ## _line_, y)

@interface AEArray : NSObject <NSFastEnumeration>

- (instancetype _Nonnull)init;

- (instancetype _Nullable)initWithCustomMapping:(AEArrayCustomMappingBlock _Nullable)block;

- (void)updateWithContentsOfArray:(NSArray * _Nonnull)array;

- (void)updateWithContentsOfArray:(NSArray * _Nonnull)array customMapping:(AEArrayIndexedCustomMappingBlock _Nullable)block;

- (void * _Nullable)pointerValueAtIndex:(int)index;

- (void * _Nullable)pointerValueForObject:(id _Nonnull)object;

- (void)updatePointerValue:(void * _Nullable)value forObject:(id _Nonnull)object;

- (id _Nullable)objectAtIndexedSubscript:(NSUInteger)idx;

AEArrayToken _Nonnull AEArrayGetToken(__unsafe_unretained AEArray * _Nonnull array);

int AEArrayGetCount(AEArrayToken _Nonnull token);

void * _Nullable AEArrayGetItem(AEArrayToken _Nonnull token, int index);

#define AEArrayEnumerateObjects(array, type, varname) \
    AEArrayToken __AEArrayVar(token, __LINE__) = AEArrayGetToken(array); \
    int __AEArrayVar(count, __LINE__) = AEArrayGetCount(__AEArrayVar(token, __LINE__)); \
    int __AEArrayVar(i, __LINE__) = 0; \
    for ( __unsafe_unretained type varname = __AEArrayVar(count, __LINE__) > 0 ? (__bridge type)AEArrayGetItem(__AEArrayVar(token, __LINE__), 0) : NULL; \
          __AEArrayVar(i, __LINE__) < __AEArrayVar(count, __LINE__); \
          __AEArrayVar(i, __LINE__)++, varname = __AEArrayVar(i, __LINE__) < __AEArrayVar(count, __LINE__) ? \
            (__bridge type)AEArrayGetItem(__AEArrayVar(token, __LINE__), __AEArrayVar(i, __LINE__)) : NULL )

#define AEArrayEnumeratePointers(array, type, varname) \
    AEArrayToken __AEArrayVar(token, __LINE__) = AEArrayGetToken(array); \
    int __AEArrayVar(count, __LINE__) = AEArrayGetCount(__AEArrayVar(token, __LINE__)); \
    int __AEArrayVar(i, __LINE__) = 0; \
    for ( type varname = __AEArrayVar(count, __LINE__) > 0 ? (type)AEArrayGetItem(__AEArrayVar(token, __LINE__), 0) : NULL; \
          __AEArrayVar(i, __LINE__) < __AEArrayVar(count, __LINE__); \
          __AEArrayVar(i, __LINE__)++, varname = __AEArrayVar(i, __LINE__) < __AEArrayVar(count, __LINE__) ? \
            (type)AEArrayGetItem(__AEArrayVar(token, __LINE__), __AEArrayVar(i, __LINE__)) : NULL )


@property (nonatomic, readonly) int count;

@property (nonatomic, strong, readonly) NSArray * _Nonnull allValues;

@property (nonatomic, copy) AEArrayReleaseBlock _Nullable releaseBlock;

@end

#ifdef __cplusplus
}
#endif