Annotation of libelwix/inc/elwix/aarray.h, revision 1.12.2.1
1.1 misho 1: /*************************************************************************
2: * (C) 2013 AITNET ltd - Sofia/Bulgaria - <misho@aitnet.org>
3: * by Michael Pounov <misho@elwix.org>
4: *
5: * $Author: misho $
1.12.2.1! misho 6: * $Id: aarray.h,v 1.12 2024/10/29 01:16:12 misho Exp $
1.1 misho 7: *
8: **************************************************************************
9: The ELWIX and AITNET software is distributed under the following
10: terms:
11:
12: All of the documentation and software included in the ELWIX and AITNET
13: Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>
14:
1.12 misho 15: Copyright 2004 - 2024
1.1 misho 16: by Michael Pounov <misho@elwix.org>. All rights reserved.
17:
18: Redistribution and use in source and binary forms, with or without
19: modification, are permitted provided that the following conditions
20: are met:
21: 1. Redistributions of source code must retain the above copyright
22: notice, this list of conditions and the following disclaimer.
23: 2. Redistributions in binary form must reproduce the above copyright
24: notice, this list of conditions and the following disclaimer in the
25: documentation and/or other materials provided with the distribution.
26: 3. All advertising materials mentioning features or use of this software
27: must display the following acknowledgement:
28: This product includes software developed by Michael Pounov <misho@elwix.org>
29: ELWIX - Embedded LightWeight unIX and its contributors.
30: 4. Neither the name of AITNET nor the names of its contributors
31: may be used to endorse or promote products derived from this software
32: without specific prior written permission.
33:
34: THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND
35: ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
36: IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
37: ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
38: FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
39: DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
40: OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
41: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
42: LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
43: OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
44: SUCH DAMAGE.
45: */
46: #ifndef __AARRAY_H
47: #define __AARRAY_H
48:
49:
50: typedef struct _tagArray {
51: int arr_last;
52: int arr_num;
53: void **arr_data;
54: } array_t;
55:
1.12 misho 56: #define array_Data(_arr) ((_arr) ? (_arr)->arr_data : NULL)
1.1 misho 57: #define array_Size(_arr) ((_arr) ? (_arr)->arr_num : 0)
58: #define array_Last(_arr) (array_Size((_arr)) ? (_arr)->arr_last : -1)
1.10 misho 59: #define array_Zero(_arr) (assert((_arr)), (_arr)->arr_last = -1, \
60: memset((_arr)->arr_data, 0, array_Size((_arr)) * sizeof(intptr_t)))
1.1 misho 61:
1.12 misho 62: #define array_Ptr(_arr, _d) ((_arr && (_arr)->arr_data) ? (_arr)->arr_data[_d] : NULL)
1.1 misho 63: #define array_Get2(_arr, _d) (assert((_arr) && (_arr)->arr_num > _d), ((_arr)->arr_data + _d))
1.12 misho 64: #define array_Get(_arr, _d) (assert((_arr) && (_arr)->arr_data), (_arr)->arr_data[_d])
65: #define array(_arr, _d, _type) (assert((_arr) && (_arr)->arr_data), ((_type) (_arr)->arr_data[_d]))
1.7 misho 66: #define array_Set(_arr, _d, _ptr) do { int __d = _d; assert((_arr) && (_arr)->arr_num > __d); \
67: if ((_arr)->arr_last < __d) \
68: (_arr)->arr_last = __d; \
69: (_arr)->arr_data[__d] = (void*) (_ptr); \
1.1 misho 70: } while (0)
1.7 misho 71: #define array_Del(_arr, _d, _fri) do { int __d = _d; assert((_arr) && (_arr)->arr_num > __d); \
72: if (_fri && (_arr)->arr_data[__d]) \
73: e_free((_arr)->arr_data[__d]); \
74: (_arr)->arr_data[__d] = NULL; \
1.1 misho 75: } while (0)
1.11 misho 76: #define array_Var(_arr, _d) (assert((_arr) && (_arr)->arr_num > _d), (ait_val_t*) (_arr)->arr_data[_d])
1.1 misho 77:
1.12.2.1! misho 78: #ifdef __cplusplus
! 79: extern "C" {
! 80: #endif
! 81:
1.1 misho 82: /*
83: * array_Init() - Create and initialize dynamic array
84: *
85: * @numItems = Number of Items
86: * return: NULL error, != NULL allocated memory for array
87: */
1.2 misho 88: array_t *array_Init(int numItems);
1.9 misho 89: /*
90: * array_Init2() - Initialize dynamic array
91: *
92: * @arr = Allocated array variable
93: * @numItems = Number of Items
94: * return: NULL error, != NULL allocated memory for array
95: */
96: array_t *array_Init2(array_t * __restrict arr, int numItems);
1.1 misho 97: /*
98: * array_Destroy() - Free and destroy dynamic array
99: *
100: * @parr = Array
101: * return: none
102: */
1.2 misho 103: void array_Destroy(array_t ** __restrict parr);
1.1 misho 104: /*
1.10 misho 105: * array_Destroy2() - Free data in dynamic array
106: *
107: * @parr = Array
108: * return: none
109: */
110: void array_Destroy2(array_t * __restrict arr);
111: /*
1.1 misho 112: * array_Free() - Free all data in dynamic array items
113: * (WARNING! If assign static array dont use this!!!)
114: *
115: * @arr = Array
116: * return: none
117: */
1.2 misho 118: void array_Free(array_t * __restrict arr);
1.8 misho 119: /*
120: * array_Reset() - Reset array to initial state
121: *
122: * @parr = Array
1.10 misho 123: * @purge = Purge all data, if <>0 then will be free entire data memory
1.8 misho 124: * return: none
125: */
126: void array_Reset(array_t * __restrict arr, int purge);
1.1 misho 127:
128: /*
129: * array_From() - Create and fill array from array with pointers
130: *
131: * @pargv = Array with pointers
132: * @argc = Number of Items, if 0 walk through argv and stop when reach NULL item
133: * return: NULL error, != NULL allocated new array
134: */
135: array_t *array_From(const char *** __restrict pargv, int argc);
136: /*
137: * array_Args() Parse and make array from arguments ... (input string will be modified!!!
1.4 misho 138: * and output array must be free with array_Destroy() after use!)
1.1 misho 139: *
140: * @psArgs = Input arguments line, after execute string is modified!!!
141: * @nargs = Maximum requested count of arguments from input string psArgs, if 0 all psArgs
142: * @csDelim = Delimiter(s) for separate
143: * @parr = Output array of arguments ... (must be free with array_Destroy() after use!)
144: * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
145: */
146: int array_Args(char * __restrict psArgs, int nargs, const char *csDelim,
147: array_t ** __restrict parr);
148: /*
149: * array_To() - Create and fill array with pointers from dynamic array
150: *
151: * @arr = Array
152: * return: NULL error, != NULL allocated memory for array, NULL terminated
153: */
154: char **array_To(array_t * __restrict arr);
155:
156: /*
157: * array_Len() - Get last used element in dynamic array (array Length)
158: *
159: * @arr = Array
160: * return: -1 empty or >-1 position of last used element
161: */
1.2 misho 162: int array_Len(array_t * __restrict arr);
1.1 misho 163:
164: /*
165: * array_Grow() - Grow/Shrink dynamic array, Use with care when it shrink!!!
166: *
167: * @arr = Array
168: * @newNumItems = Number of Items
169: * @freeShrink = Free elements before shrink array
170: * return: -1 error, 0 ok
171: */
172: int array_Grow(array_t * __restrict arr, int newNumItems, int freeShrink);
173: /*
174: * array_Vacuum() - Vacuum dynamic array, empty elements will be deleted
175: *
176: * @arr = Array
177: * @fromWhere = 1 begin, 2 ALL empty elements
178: * return: -1 error, 0 ok
179: */
180: int array_Vacuum(array_t * __restrict arr, int fromWhere);
181: /*
182: * array_Concat() Concat source array to destination array
183: *
184: * @dest = Destination array
185: * @src = Source array
186: * return: -1 error; >0 new count of destination array
187: */
188: int array_Concat(array_t * __restrict dest, array_t * __restrict src);
189: /*
190: * array_Copy() Copy source array to destination array
191: *
1.4 misho 192: * @dest = Destination array, after use free with array_Destroy()
1.1 misho 193: * @src = Source array
194: * return: -1 error; >0 count of destination array
195: */
196: int array_Copy(array_t ** __restrict dest, array_t * __restrict src);
197:
198: /*
199: * array_Elem() - Always GET/PUT element into dynamic array, if not enough elements grow array
200: *
201: * @arr = Array
202: * @n = Position
203: * @data = Element, if set NULL GET element at position or !=NULL PUT element at position
204: * return: -1 error or !=-1 return element at position
205: */
1.2 misho 206: void *array_Elem(array_t * __restrict arr, int n, void *data);
1.1 misho 207: /*
208: * array_Push() - Push element into dynamic array like stack manner, place at first empty position
209: *
210: * @arr = Array
211: * @data = Element, if set NULL return only first empty position
212: * @nogrow = Don't grow array if not enough space
213: * return: -1 not found empty position, array is full!, >-1 return position of stored element into array
214: */
1.2 misho 215: int array_Push(array_t * __restrict arr, void *data, int nogrow);
1.1 misho 216: /*
217: * array_Pop() - Pop element from dynamic array like stack manner, last used position
218: *
219: * @arr = Array
220: * @data = Element, if set NULL return only last used position
221: * @nodel = Don't delete after Pop element
222: * return: -1 not found used position, array is empty!, >-1 return element position
223: */
1.2 misho 224: int array_Pop(array_t * __restrict arr, void ** __restrict data, int nodel);
1.1 misho 225:
1.12.2.1! misho 226: #ifdef __cplusplus
! 227: }
! 228: #endif
1.1 misho 229:
230: #endif
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to aarray.h CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / libelwix / inc / elwix