Duck/Source/DKArray.h at development · hurlybird/Duck · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
// =======================================================================================
//
// DKArray.h
// Duck Object Library -- See LICENSE for legal information.
//
// Copyright (c) 2014-2026 Derek W. Nylen
//
// =======================================================================================
#ifndef _DK_ARRAY_H_
#define _DK_ARRAY_H_

#ifdef __cplusplus
extern "C"
{
#endif


// typedef struct DKArray * DKArrayRef; -- Declared in DKPlatform.h
// typedef struct DKArray * DKMutableArrayRef; -- Declared in DKPlatform.h


DK_API DKClassRef  DKArrayClass( void );
DK_API DKClassRef  DKMutableArrayClass( void );

#define     DKEmptyArray()          DKAutorelease( DKNew( DKArrayClass() ) )
#define     DKMutableArray()        DKAutorelease( DKNew( DKMutableArrayClass() ) )

#define     DKArrayWithCArray( objects, count )  DKArrayInitWithObjects( DKAlloc( DKArrayClass() ), objects, count )
#define     DKArrayWithCollection( collection )  DKArrayInitWithCollection( DKAlloc( DKArrayClass() ), collection )

#define     DKNewMutableArray()     DKNew( DKMutableArrayClass() )

DK_API DKObjectRef DKArrayInitWithVAObjects( DKArrayRef _self, va_list objects );
DK_API DKObjectRef DKArrayInitWithCArray( DKArrayRef _self, DKObjectRef objects[], DKIndex count );
DK_API DKObjectRef DKArrayInitWithCollection( DKArrayRef _self, DKObjectRef collection );
DK_API DKObjectRef DKArrayInitWithCArrayNoCopy( DKArrayRef _self, DKObjectRef objects[], DKIndex count );

DK_API DKArrayRef  DKArrayCopy( DKArrayRef _self );
DK_API DKMutableArrayRef DKArrayMutableCopy( DKArrayRef _self );

DK_API DKIndex     DKArrayGetCount( DKArrayRef _self );

DK_API DKObjectRef DKArrayGetObjectAtIndex( DKArrayRef _self, DKIndex index );
DK_API DKIndex     DKArrayGetObjectsInRange( DKArrayRef _self, DKRange range, DKObjectRef objects[] );

DK_API void        DKArrayReserve( DKMutableArrayRef _self, size_t reserve );
DK_API void        DKArrayAppendObject( DKMutableArrayRef _self, DKObjectRef object );
DK_API void        DKArrayAppendCArray( DKMutableArrayRef _self, DKObjectRef objects[], DKIndex count );
DK_API void        DKArrayAppendCollection( DKMutableArrayRef _self, DKObjectRef srcCollection );

DK_API void        DKArrayReplaceRangeWithCArray( DKMutableArrayRef _self, DKRange range, DKObjectRef objects[], DKIndex count );
DK_API void        DKArrayReplaceRangeWithCollection( DKMutableArrayRef _self, DKRange range, DKObjectRef collection );

DK_API void        DKArraySort( DKMutableArrayRef _self, DKCompareFunction cmp );
DK_API void        DKArrayReverse( DKMutableArrayRef _self );
DK_API void        DKArrayShuffle( DKMutableArrayRef _self );

DK_API int         DKArrayApplyFunction( DKArrayRef _self, DKApplierFunction callback, void * context );


#ifdef __cplusplus
}
#endif

#endif // _DK_ARRAY_H_