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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
|
/*!The Treasure Box Library
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Copyright (C) 2009 - 2017, TBOOX Open Source Group.
*
* @author ruki
* @file element.h
* @ingroup container
*
*/
#ifndef TB_CONTAINER_ELEMENT_H
#define TB_CONTAINER_ELEMENT_H
/* //////////////////////////////////////////////////////////////////////////////////////
* includes
*/
#include "prefix.h"
/* //////////////////////////////////////////////////////////////////////////////////////
* extern
*/
__tb_extern_c_enter__
/* //////////////////////////////////////////////////////////////////////////////////////
* types
*/
/// the element ref type
typedef struct __tb_element_t* tb_element_ref_t;
/*! the element data hash function type
*
* @param element the element
* @param data the element data
* @param mask the hash mask
* @param index the hash index
*
* @return the hash value
*/
typedef tb_size_t (*tb_element_hash_func_t)(tb_element_ref_t element, tb_cpointer_t data, tb_size_t mask, tb_size_t index);
/*! the element data compare function type
*
* @param element the element
* @param ldata the left-hand data
* @param rdata the right-hand data
*
* @return equal: 0, 1: >, -1: <
*/
typedef tb_long_t (*tb_element_comp_func_t)(tb_element_ref_t element, tb_cpointer_t ldata, tb_cpointer_t rdata);
/*! the element data function type
*
* @param element the element
* @param buff the element data address
*
* @return the element data
*/
typedef tb_pointer_t (*tb_element_data_func_t)(tb_element_ref_t element, tb_cpointer_t buff);
/*! the element data string function type
*
* @param element the element
* @param data the element data
* @param cstr the string buffer
* @param maxn the string buffer maximum size
*
* @return the string pointer
*/
typedef tb_char_t const* (*tb_element_cstr_func_t)(tb_element_ref_t element, tb_cpointer_t data, tb_char_t* cstr, tb_size_t maxn);
/*! the element free function type
*
* @param element the element
* @param buff the element buffer
*/
typedef tb_void_t (*tb_element_free_func_t)(tb_element_ref_t element, tb_pointer_t buff);
/*! the element duplicate function type
*
* allocate a new element and copy the element data
*
* @param element the element
* @param buff the element buffer
* @param data the element data
*/
typedef tb_void_t (*tb_element_dupl_func_t)(tb_element_ref_t element, tb_pointer_t buff, tb_cpointer_t data);
/*! the element replace function type
*
* free the previous element data and duplicate the new data
*
* @param element the element
* @param buff the element buffer
* @param data the element data
*/
typedef tb_void_t (*tb_element_repl_func_t)(tb_element_ref_t element, tb_pointer_t buff, tb_cpointer_t data);
/*! the element copy function type
*
* only copy the element data and not allocate new element
*
* @param element the element
* @param buff the element buffer
* @param data the element data
*/
typedef tb_void_t (*tb_element_copy_func_t)(tb_element_ref_t element, tb_pointer_t buff, tb_cpointer_t data);
/*! the elements free function type
*
* free some elements
*
* @param element the element
* @param buff the element buffer
* @param size the element count
*/
typedef tb_void_t (*tb_element_nfree_func_t)(tb_element_ref_t element, tb_pointer_t buff, tb_size_t size);
/*! the elements duplicate function type
*
* duplicate some elements
*
* @param element the element
* @param buff the element buffer
* @param data the element data
* @param size the element count
*/
typedef tb_void_t (*tb_element_ndupl_func_t)(tb_element_ref_t element, tb_pointer_t buff, tb_cpointer_t data, tb_size_t size);
/*! the elements replace function type
*
* replace some elements
*
* @param element the element
* @param buff the element buffer
* @param data the element data
* @param size the element count
*/
typedef tb_void_t (*tb_element_nrepl_func_t)(tb_element_ref_t element, tb_pointer_t buff, tb_cpointer_t data, tb_size_t size);
/*! the elements copy function type
*
* copy some elements
*
* @param element the element
* @param buff the element buffer
* @param data the element data
* @param size the element count
*/
typedef tb_void_t (*tb_element_ncopy_func_t)(tb_element_ref_t element, tb_pointer_t buff, tb_cpointer_t data, tb_size_t size);
/// the element type
typedef enum __tb_element_type_t
{
TB_ELEMENT_TYPE_NULL = 0 //!< null
, TB_ELEMENT_TYPE_LONG = 1 //!< long
, TB_ELEMENT_TYPE_SIZE = 2 //!< size
, TB_ELEMENT_TYPE_UINT8 = 3 //!< uint8
, TB_ELEMENT_TYPE_UINT16 = 4 //!< uint16
, TB_ELEMENT_TYPE_UINT32 = 5 //!< uint32
, TB_ELEMENT_TYPE_STR = 6 //!< string
, TB_ELEMENT_TYPE_PTR = 7 //!< pointer
, TB_ELEMENT_TYPE_MEM = 8 //!< memory
, TB_ELEMENT_TYPE_OBJ = 9 //!< object
, TB_ELEMENT_TYPE_TRUE = 10 //!< true
, TB_ELEMENT_TYPE_USER = 11 //!< the user-defined type
}tb_element_type_t;
/// the element type
typedef struct __tb_element_t
{
/// the element type
tb_uint16_t type;
/// the element flag
tb_uint16_t flag;
/// the element size
tb_uint16_t size;
/// the priv data
tb_cpointer_t priv;
/// the hash function
tb_element_hash_func_t hash;
/// the compare function
tb_element_comp_func_t comp;
/// the data function
tb_element_data_func_t data;
/// the string function
tb_element_cstr_func_t cstr;
/// the free element
tb_element_free_func_t free;
/// the duplicate function
tb_element_dupl_func_t dupl;
/// the replace function
tb_element_repl_func_t repl;
/// the copy function
tb_element_copy_func_t copy;
/// the free elements function
tb_element_nfree_func_t nfree;
/// the duplicate elements function
tb_element_ndupl_func_t ndupl;
/// the replace elements function
tb_element_nrepl_func_t nrepl;
/// the copy elements function
tb_element_ncopy_func_t ncopy;
}tb_element_t;
/* //////////////////////////////////////////////////////////////////////////////////////
* interfaces
*/
/*! the null element, no space
*
* @return the element
*/
tb_element_t tb_element_null(tb_noarg_t);
/*! the true element, no space
*
* .e.g for hash data
*
* @return the element
*/
tb_element_t tb_element_true(tb_noarg_t);
/*! the long element
*
* @return the element
*/
tb_element_t tb_element_long(tb_noarg_t);
/*! the size element
*
* @return the element
*/
tb_element_t tb_element_size(tb_noarg_t);
/*! the uint8 element
*
* @return the element
*/
tb_element_t tb_element_uint8(tb_noarg_t);
/*! the uint16 element for
*
* @return the element
*/
tb_element_t tb_element_uint16(tb_noarg_t);
/*! the uint32 element
*
* @return the element
*/
tb_element_t tb_element_uint32(tb_noarg_t);
/*! the string element
*
* @param is_case is case?
*
* @return the element
*/
tb_element_t tb_element_str(tb_bool_t is_case);
/*! the pointer element
*
* @note if the free function have been hooked, the nfree need hook too.
*
* @param free the element free function
* @param priv the private data of the element free function
*
* @return the element
*/
tb_element_t tb_element_ptr(tb_element_free_func_t free, tb_cpointer_t priv);
/*! the object element
*
* @return the element
*/
tb_element_t tb_element_obj(tb_noarg_t);
/*! the memory element with the fixed space
*
* @param size the element size
* @param free the element free function
* @param priv the private data of the element free function
*
* @return the element
*/
tb_element_t tb_element_mem(tb_size_t size, tb_element_free_func_t free, tb_cpointer_t priv);
/* //////////////////////////////////////////////////////////////////////////////////////
* extern
*/
__tb_extern_c_leave__
#endif
|
