1: /*************************************************************************
2: * (C) 2013 AITNET ltd - Sofia/Bulgaria - <misho@aitnet.org>
3: * by Michael Pounov <misho@elwix.org>
4: *
5: * $Author: misho $
6: * $Id: aarray.h,v 1.12 2024/10/29 01:16:12 misho Exp $
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:
15: Copyright 2004 - 2024
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:
56: #define array_Data(_arr) ((_arr) ? (_arr)->arr_data : NULL)
57: #define array_Size(_arr) ((_arr) ? (_arr)->arr_num : 0)
58: #define array_Last(_arr) (array_Size((_arr)) ? (_arr)->arr_last : -1)
59: #define array_Zero(_arr) (assert((_arr)), (_arr)->arr_last = -1, \
60: memset((_arr)->arr_data, 0, array_Size((_arr)) * sizeof(intptr_t)))
61:
62: #define array_Ptr(_arr, _d) ((_arr && (_arr)->arr_data) ? (_arr)->arr_data[_d] : NULL)
63: #define array_Get2(_arr, _d) (assert((_arr) && (_arr)->arr_num > _d), ((_arr)->arr_data + _d))
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]))
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); \
70: } while (0)
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; \
75: } while (0)
76: #define array_Var(_arr, _d) (assert((_arr) && (_arr)->arr_num > _d), (ait_val_t*) (_arr)->arr_data[_d])
77:
78: /*
79: * array_Init() - Create and initialize dynamic array
80: *
81: * @numItems = Number of Items
82: * return: NULL error, != NULL allocated memory for array
83: */
84: array_t *array_Init(int numItems);
85: /*
86: * array_Init2() - Initialize dynamic array
87: *
88: * @arr = Allocated array variable
89: * @numItems = Number of Items
90: * return: NULL error, != NULL allocated memory for array
91: */
92: array_t *array_Init2(array_t * __restrict arr, int numItems);
93: /*
94: * array_Destroy() - Free and destroy dynamic array
95: *
96: * @parr = Array
97: * return: none
98: */
99: void array_Destroy(array_t ** __restrict parr);
100: /*
101: * array_Destroy2() - Free data in dynamic array
102: *
103: * @parr = Array
104: * return: none
105: */
106: void array_Destroy2(array_t * __restrict arr);
107: /*
108: * array_Free() - Free all data in dynamic array items
109: * (WARNING! If assign static array dont use this!!!)
110: *
111: * @arr = Array
112: * return: none
113: */
114: void array_Free(array_t * __restrict arr);
115: /*
116: * array_Reset() - Reset array to initial state
117: *
118: * @parr = Array
119: * @purge = Purge all data, if <>0 then will be free entire data memory
120: * return: none
121: */
122: void array_Reset(array_t * __restrict arr, int purge);
123:
124: /*
125: * array_From() - Create and fill array from array with pointers
126: *
127: * @pargv = Array with pointers
128: * @argc = Number of Items, if 0 walk through argv and stop when reach NULL item
129: * return: NULL error, != NULL allocated new array
130: */
131: array_t *array_From(const char *** __restrict pargv, int argc);
132: /*
133: * array_Args() Parse and make array from arguments ... (input string will be modified!!!
134: * and output array must be free with array_Destroy() after use!)
135: *
136: * @psArgs = Input arguments line, after execute string is modified!!!
137: * @nargs = Maximum requested count of arguments from input string psArgs, if 0 all psArgs
138: * @csDelim = Delimiter(s) for separate
139: * @parr = Output array of arguments ... (must be free with array_Destroy() after use!)
140: * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
141: */
142: int array_Args(char * __restrict psArgs, int nargs, const char *csDelim,
143: array_t ** __restrict parr);
144: /*
145: * array_To() - Create and fill array with pointers from dynamic array
146: *
147: * @arr = Array
148: * return: NULL error, != NULL allocated memory for array, NULL terminated
149: */
150: char **array_To(array_t * __restrict arr);
151:
152: /*
153: * array_Len() - Get last used element in dynamic array (array Length)
154: *
155: * @arr = Array
156: * return: -1 empty or >-1 position of last used element
157: */
158: int array_Len(array_t * __restrict arr);
159:
160: /*
161: * array_Grow() - Grow/Shrink dynamic array, Use with care when it shrink!!!
162: *
163: * @arr = Array
164: * @newNumItems = Number of Items
165: * @freeShrink = Free elements before shrink array
166: * return: -1 error, 0 ok
167: */
168: int array_Grow(array_t * __restrict arr, int newNumItems, int freeShrink);
169: /*
170: * array_Vacuum() - Vacuum dynamic array, empty elements will be deleted
171: *
172: * @arr = Array
173: * @fromWhere = 1 begin, 2 ALL empty elements
174: * return: -1 error, 0 ok
175: */
176: int array_Vacuum(array_t * __restrict arr, int fromWhere);
177: /*
178: * array_Concat() Concat source array to destination array
179: *
180: * @dest = Destination array
181: * @src = Source array
182: * return: -1 error; >0 new count of destination array
183: */
184: int array_Concat(array_t * __restrict dest, array_t * __restrict src);
185: /*
186: * array_Copy() Copy source array to destination array
187: *
188: * @dest = Destination array, after use free with array_Destroy()
189: * @src = Source array
190: * return: -1 error; >0 count of destination array
191: */
192: int array_Copy(array_t ** __restrict dest, array_t * __restrict src);
193:
194: /*
195: * array_Elem() - Always GET/PUT element into dynamic array, if not enough elements grow array
196: *
197: * @arr = Array
198: * @n = Position
199: * @data = Element, if set NULL GET element at position or !=NULL PUT element at position
200: * return: -1 error or !=-1 return element at position
201: */
202: void *array_Elem(array_t * __restrict arr, int n, void *data);
203: /*
204: * array_Push() - Push element into dynamic array like stack manner, place at first empty position
205: *
206: * @arr = Array
207: * @data = Element, if set NULL return only first empty position
208: * @nogrow = Don't grow array if not enough space
209: * return: -1 not found empty position, array is full!, >-1 return position of stored element into array
210: */
211: int array_Push(array_t * __restrict arr, void *data, int nogrow);
212: /*
213: * array_Pop() - Pop element from dynamic array like stack manner, last used position
214: *
215: * @arr = Array
216: * @data = Element, if set NULL return only last used position
217: * @nodel = Don't delete after Pop element
218: * return: -1 not found used position, array is empty!, >-1 return element position
219: */
220: int array_Pop(array_t * __restrict arr, void ** __restrict data, int nodel);
221:
222:
223: #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