1
2 /*
3 * libEtPan! -- a mail stuff library
4 *
5 * carray - Implements simple dynamic pointer arrays
6 *
7 * Copyright (c) 1999-2000, Ga�l Roualland <gael.roualland@iname.com>
8 * interface changes - 2002 - DINH Viet Hoa
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. Neither the name of the libEtPan! project nor the names of its
20 * contributors may be used to endorse or promote products derived
21 * from this software without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * SUCH DAMAGE.
34 */
35
36 /*
37 * $Id$
38 */
39
40 #ifndef CARRAY_H
41 #define CARRAY_H
42
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
46
47 #include <inttypes.h>
48
49 struct carray_s {
50 void ** array;
51 unsigned int len;
52 unsigned int max;
53 };
54
55 typedef struct carray_s carray;
56
57 /* Creates a new array of pointers, with initsize preallocated cells */
58 carray * carray_new(unsigned int initsize);
59
60 /* Adds the pointer to data in the array.
61 Returns the index of the pointer in the array or -1 on error */
62 int carray_add(carray * array, void * data, unsigned int * index);
63
64 int carray_set_size(carray * array, unsigned int new_size);
65
66 /* Removes the cell at this index position. Returns TRUE on success.
67 Order of elements in the array IS changed. */
68 int carray_delete(carray * array, unsigned int indx);
69
70 /* Removes the cell at this index position. Returns TRUE on success.
71 Order of elements in the array IS not changed. */
72 int carray_delete_slow(carray * array, unsigned int indx);
73
74 /* remove without decreasing the size of the array */
75 int carray_delete_fast(carray * array, unsigned int indx);
76
77 /* Some of the following routines can be implemented as macros to
78 be faster. If you don't want it, define NO_MACROS */
79 #ifdef NO_MACROS
80
81 /* Returns the array itself */
82 void ** carray_data(carray);
83
84 /* Returns the number of elements in the array */
85 int carray_count(carray);
86
87 /* Returns the contents of one cell */
88 void * carray_get(carray array, unsigned int indx);
89
90 /* Sets the contents of one cell */
91 void carray_set(carray array, unsigned int indx, void * value);
92
93 #else
94
95 #if 0
96 #define carray_data(a) (a->array)
97 #define carray_count(a) (a->len)
98 #define carray_get(a, indx) (a->array[indx])
99 #define carray_set(a, indx, v) do { a->array[indx]=v; } while(0)
100 #endif
101
carray_data(carray * array)102 static inline void ** carray_data(carray * array) {
103 return array->array;
104 }
105
carray_count(carray * array)106 static inline unsigned int carray_count(carray * array) {
107 return array->len;
108 }
109
carray_get(carray * array,unsigned int indx)110 static inline void * carray_get(carray * array, unsigned int indx) {
111 return array->array[indx];
112 }
113
carray_set(carray * array,unsigned int indx,void * value)114 static inline void carray_set(carray * array,
115 unsigned int indx, void * value) {
116 array->array[indx] = value;
117 }
118 #endif
119
120 void carray_free(carray * array);
121
122 #ifdef __cplusplus
123 }
124 #endif
125
126 #endif
127