Annotation of libaitio/inc/aitio.h, revision 1.11.2.7
1.1 misho 1: /*************************************************************************
1.8 misho 2: * (C) 2010 AITNET ltd - Sofia/Bulgaria - <misho@aitnet.org>
3: * by Michael Pounov <misho@elwix.org>
1.1 misho 4: *
5: * $Author: misho $
1.11.2.7! misho 6: * $Id: aitio.h,v 1.11.2.6 2011/08/31 12:29:32 misho Exp $
1.1 misho 7: *
1.8 misho 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, 2005, 2006, 2007, 2008, 2009, 2010, 2011
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: */
1.1 misho 46: #ifndef __AITIO_H
47: #define __AITIO_H
48:
49:
1.8 misho 50: #include <assert.h>
1.7 misho 51: #include <openssl/evp.h>
52:
53:
1.8 misho 54: #define VACUUM_LEFT 1
55: #define VACUUM_BETWEEN 2
56:
1.11.2.1 misho 57: /* AIT arrays */
1.8 misho 58:
1.9 misho 59: typedef void ** sarr_seg_t;
60: typedef struct _tagSplitArray {
61: int sarr_num;
62: int sarr_seg;
63: int sarr_siz;
64: sarr_seg_t *sarr_data;
65: } sarr_t;
66:
1.8 misho 67: typedef struct _tagArray {
68: int arr_num;
69: void **arr_data;
70: } array_t;
71:
1.11.2.1 misho 72: /* URL staff ... */
73:
1.2 misho 74: typedef struct _tagURLItem {
75: int vallen;
76: char *value;
77: } url_Item_t;
78:
79: struct tagIOURL {
80: unsigned char url_line[BUFSIZ];
81:
82: url_Item_t url_tech;
83: url_Item_t url_user;
84: url_Item_t url_pass;
85: url_Item_t url_host;
86: url_Item_t url_port;
87: url_Item_t url_path;
88: url_Item_t url_args;
89:
90: char *url_reserved;
91: };
92:
1.6 misho 93: struct tagReqXML {
94: unsigned char xml_line[BUFSIZ];
95:
96: url_Item_t xml_namespace;
97: union {
98: url_Item_t container;
99: url_Item_t path;
100: } xml_node;
101: url_Item_t xml_data;
102: url_Item_t xml_attribute;
103: url_Item_t xml_value;
104: };
105:
1.11.2.2 misho 106: /* AIT RPC variables and managment */
1.11.2.1 misho 107:
108: typedef enum {
109: empty, /* empty -> variable is not set */
1.11.2.6 misho 110: buffer, string, blob, /* buffer -> uint8_t*; string -> int8_t*; blob -> void*(+socket); */
111: f32, f64, /* float -> f32; double -> f64 */
1.11.2.1 misho 112: u8, u16, u32, u64, /* unsigned integers ... */
1.11.2.5 misho 113: i8, i16, i32, i64, /* integers ... */
1.11.2.1 misho 114: } ait_type_t;
115:
116: typedef struct {
117: uint8_t val_type;
118: uint32_t val_len;
119: union {
1.11.2.6 misho 120: uint64_t net;
121:
122: uint8_t *buffer;
1.11.2.1 misho 123: int8_t *string;
124: uint32_t blob;
1.11.2.6 misho 125: float f32;
126: double f64;
1.11.2.1 misho 127: uint8_t u8;
128: uint16_t u16;
129: uint32_t u32;
130: uint64_t u64;
131: int8_t i8;
132: int16_t i16;
133: int32_t i32;
134: int64_t i64;
135: } val;
136: } __packed ait_val_t;
137:
1.11.2.6 misho 138: #define AIT_TYPE(_vl) ((ait_type_t) (_vl)->val_type)
1.11.2.3 misho 139: #define AIT_LEN(_vl) (_vl)->val_len
1.11.2.5 misho 140: #define AIT_BLOB_CHUNKS(_vl, _n) (assert((_vl)), AIT_LEN((_vl)) / _n + (AIT_LEN((_vl)) % _n) ? 1 : 0)
141: #define AIT_ISEMPTY(_vl) (assert((_vl)), AIT_TYPE((_vl)) == empty)
1.11.2.1 misho 142:
1.11.2.5 misho 143: #define AIT_GET_BUF(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == buffer), (_vl)->val.buffer)
144: #define AIT_GET_STR(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == string), (_vl)->val.string)
145: #define AIT_GET_BLOB(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == blob), (_vl)->val.blob)
146: #define AIT_GET_U8(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == u8), (_vl)->val.u8)
147: #define AIT_GET_U16(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == u16), (_vl)->val.u16)
148: #define AIT_GET_U32(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == u32), (_vl)->val.u32)
149: #define AIT_GET_U64(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == u64), (_vl)->val.u64)
150: #define AIT_GET_I8(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == i8), (_vl)->val.i8)
151: #define AIT_GET_I16(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == i16), (_vl)->val.i16)
152: #define AIT_GET_I32(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == i32), (_vl)->val.i32)
153: #define AIT_GET_I64(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == i64), (_vl)->val.i64)
1.11.2.6 misho 154: #define AIT_GET_F32(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == f32), (_vl)->val.f32)
155: #define AIT_GET_F64(_vl) (assert((_vl)), assert(AIT_TYPE((_vl)) == f64), (_vl)->val.f64)
1.11.2.1 misho 156:
157: #define AIT_SET_BUF(_vl, _v, _len) do { ait_val_t *__val = (_vl); assert(__val); assert((_v)); \
158: __val->val.buffer = malloc(_len); \
159: if (__val->val.buffer) { \
1.11.2.3 misho 160: __val->val_type = buffer; AIT_LEN(__val) = _len; \
1.11.2.1 misho 161: memcpy(__val->val.buffer, (_v), _len); \
162: } } while (0)
1.11.2.4 misho 163: #define AIT_SET_STR(_vl, _v) do { ait_val_t *__val = (_vl); assert(__val); \
1.11.2.1 misho 164: __val->val.string = (int8_t*) strdup((_v)); \
165: if (__val->val.string) { \
1.11.2.3 misho 166: __val->val_type = string; \
1.11.2.1 misho 167: AIT_LEN(__val) = strlen((_v)) + 1; \
168: } } while (0)
169: #define AIT_SET_BLOB(_vl, _n, _len) do { ait_val_t *__val = (_vl); assert(__val); \
1.11.2.3 misho 170: __val->val_type = blob; AIT_LEN(__val) = _len; \
1.11.2.1 misho 171: __val->val.blob = _n; } while (0)
172: #define AIT_SET_BLOB2(_vl, _bv) do { ait_val_t *__val = (_vl); assert(__val); assert((_bv)); \
1.11.2.3 misho 173: __val->val_type = blob; AIT_LEN(__val) = (_bv)->blob_len; \
1.11.2.1 misho 174: __val->val.blob = (_bv)->blob_var; } while (0)
175:
176: #define AIT_SET_U8(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
1.11.2.3 misho 177: __val->val_type = u8; __val->val.u8 = _n; \
1.11.2.1 misho 178: AIT_LEN(__val) = sizeof(uint8_t); } while (0)
179: #define AIT_SET_U16(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
1.11.2.3 misho 180: __val->val_type = u16; __val->val.u16 = _n; \
1.11.2.1 misho 181: AIT_LEN(__val) = sizeof(uint16_t); } while (0)
182: #define AIT_SET_U32(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
1.11.2.3 misho 183: __val->val_type = u32; __val->val.u32 = _n; \
1.11.2.1 misho 184: AIT_LEN(__val) = sizeof(uint32_t); } while (0)
185: #define AIT_SET_U64(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
1.11.2.3 misho 186: __val->val_type = u64; __val->val.u64 = _n; \
1.11.2.1 misho 187: AIT_LEN(__val) = sizeof(uint64_t); } while (0)
188: #define AIT_SET_I8(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
1.11.2.3 misho 189: __val->val_type = i8; __val->val.i8 = _n; \
1.11.2.1 misho 190: AIT_LEN(__val) = sizeof(int8_t); } while (0)
191: #define AIT_SET_I16(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
1.11.2.3 misho 192: __val->val_type = i16; __val->val.i16 = _n; \
1.11.2.1 misho 193: AIT_LEN(__val) = sizeof(int16_t); } while (0)
194: #define AIT_SET_I32(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
1.11.2.3 misho 195: __val->val_type = i32; __val->val.i32 = _n; \
1.11.2.1 misho 196: AIT_LEN(__val) = sizeof(int32_t); } while (0)
197: #define AIT_SET_I64(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
1.11.2.3 misho 198: __val->val_type = i64; __val->val.i64 = _n; \
1.11.2.1 misho 199: AIT_LEN(__val) = sizeof(int64_t); } while (0)
1.11.2.6 misho 200: #define AIT_SET_F32(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
201: __val->val_type = f32; __val->val.f32 = _n; \
202: AIT_LEN(__val) = sizeof(float); } while (0)
203: #define AIT_SET_F64(_vl, _n) do { ait_val_t *__val = (_vl); assert(__val); \
204: __val->val_type = f64; __val->val.f64 = _n; \
205: AIT_LEN(__val) = sizeof(double); } while (0)
1.11.2.1 misho 206:
1.11.2.5 misho 207: /* if attribute zeroCopy is set not execute free() */
1.11.2.1 misho 208: #define AIT_FREE_VAL(_vl) do { ait_val_t *__val = (_vl); assert(__val); \
1.11.2.3 misho 209: switch (__val->val_type) { \
1.11.2.1 misho 210: case buffer: \
211: if (__val->val.buffer) { \
212: free(__val->val.buffer); \
213: __val->val.buffer = NULL; \
214: } \
215: break; \
216: case string: \
217: if (__val->val.string) { \
218: free(__val->val.string); \
219: __val->val.string = NULL; \
220: } \
221: break; \
1.11.2.3 misho 222: default: \
223: break; \
1.11.2.1 misho 224: } \
1.11.2.3 misho 225: __val->val_type = empty; \
1.11.2.1 misho 226: AIT_LEN(__val) = 0; \
227: } while (0)
228:
1.3 misho 229:
1.1 misho 230: // io_GetErrno() Get error code of last operation
231: inline int io_GetErrno();
232: // io_GetError() Get error text of last operation
233: inline const char *io_GetError();
234:
235:
236: /*
1.11.2.6 misho 237: * io_vals2buffer() Marshaling data from array with variables to buffer
238: * @buf = Buffer
239: * @buflen = Size of buffer
240: * @vars = Variable array
241: * return: -1 error, 0 nothing done or >0 size of marshaled data
242: */
243: int io_vals2buffer(unsigned char **buf, int buflen, array_t *vars);
244: /*
245: * io_buffer2vals() De-marshaling data from buffer to array with variables
246: * @buf = Buffer
247: * @buflen = Size of buffer
248: * @vnum = Number of variables into buffer
249: * @zcpy = Zero-copy for variables, if !=0 don't use io_arrayFree() for free variables and
250: *DON'T MODIFY OR DESTROY BUFFER*. =0 call io_arrayFree() before io_arrayDestroy()
251: * return: =NULL error, !=NULL allocated variable array, after use must free with io_arrayDestroy()
252: */
253: array_t *io_buffer2vals(unsigned char *buf, int buflen, int vnum, int zcpy);
254:
255: /*
1.1 misho 256: * ioPromptRead() Read data from input h[0] with prompt to output h[1]
257: * @h = file handles h[0] = input, h[1] = output, if NULL use stdin, stdout
258: * @csPrompt = Prompt before input, may be NULL
259: * @psData = Readed data
260: * @dataLen = Length of data
261: * return: 0 EOF; -1 error:: can`t read; >0 count of readed chars
262: */
263: int ioPromptRead(int *h, const char *csPrompt, char * __restrict psData, int dataLen);
264: /*
265: * ioPromptPassword() Read password from input h[0] with prompt to output h[1]
266: * @h = file handles h[0] = input, h[1] = output, if NULL use stdin, stdout
267: * @csPrompt = Prompt before input, may be NULL
268: * @psPass = Readed password
269: * @passLen = Length of password
270: * @confirm = Confirm password, 0 - get password, !=0 Ask for confirmation
271: * return: 0 EOF; -1 error:: can`t read; >0 count of readed chars
272: */
273: int ioPromptPassword(int *h, const char *csPrompt, char * __restrict psPass, int passLen, int confirm);
274:
275: /*
276: * ioRegexVerify() Function for verify data match in regex expression
277: * @csRegex = Regulare expression pattern
278: * @csData = Data for check and verify
279: * @startPos = Return start positions
280: * @endPos = Return end positions
281: * return: NULL not match or error; !=NULL begin of matched data
282: */
283: const char *ioRegexVerify(const char *csRegex, const char *csData, int *startPos, int *endPos);
284: /*
285: * ioRegexGet() Function for get data match in regex expression
286: * @csRegex = Regulare expression pattern
287: * @csData = Data from get
288: * @psString = Returned string if match
289: * @strLen = Length of string
290: * return: 0 not match; >0 count of returned chars
291: */
292: int ioRegexGet(const char *csRegex, const char *csData, char * __restrict psString, int strLen);
293: /*
294: * ioRegexReplace() Function for replace data match in regex expression with newdata
295: * @csRegex = Regulare expression pattern
296: * @csData = Source data
297: * @csNew = Data for replace
298: * return: NULL not match or error; !=NULL allocated new string, must be free after use!
299: */
300: char *ioRegexReplace(const char *csRegex, const char *csData, const char *csNew);
301:
1.2 misho 302: /*
1.6 misho 303: * ioVarAst() Function for evaluate string like asterisk variable "{text[:[-]#[:#]]}"
304: * @csString = Input string
305: * return: NULL error, !=NULL Allocated new string evaluated from input string, must be free()
306: */
307: char *ioVarAst(const char *csString);
308:
309: /*
1.2 misho 310: * io_Path2File() Parse and make path/filename pair
311: * @csArgs = Input argument line
312: * @psPath = Output Path, if ==NULL path not returned
313: * @pathLen = Size of path array
314: * @psFile = Output File
315: * @fileLen = Size of file array
316: * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
317: */
318: inline int io_Path2File(const char * __restrict csArgs, char * __restrict psPath, int pathLen,
319: char * __restrict psFile, int fileLen);
320:
321: /*
1.4 misho 322: * io_UnquotStr() Remove quots from input text string
323: * @psLine = Text string
324: * return: 0 nothing to do; 1 successful unquoted string
325: */
1.5 misho 326: inline int io_UnquotStr(unsigned char * __restrict psLine);
1.4 misho 327: /*
328: * io_LTrimStr() Remove left whitespaces from text string
329: * @psLine = Text string
330: * return: 0 nothing to do; !=0 Removed bytes
331: */
1.5 misho 332: inline int io_LTrimStr(unsigned char * __restrict psLine);
1.4 misho 333: /*
334: * io_RTrimStr() Remove right whitespaces from text string
335: * @psLine = Text string
336: * return: 0 nothing to do; !=0 Removed bytes
337: */
1.5 misho 338: inline int io_RTrimStr(unsigned char * __restrict psLine);
1.4 misho 339: /*
340: * io_TrimStr() Remove left and right whitespaces from text string
341: * @psLine = Text string
342: * return: 0 nothing to do; !=0 Removed bytes
343: */
1.5 misho 344: inline int io_TrimStr(unsigned char * __restrict psLine);
1.4 misho 345: /*
1.5 misho 346: * io_Ch2Hex() Convert from Char string to Hex string
1.4 misho 347: * @psLine = Text string
348: * @lineLen = Length of Text string
1.5 misho 349: * return: NULL nothing to do or error; !=0 Allocated new converted data without term\0 (must be free)
1.4 misho 350: */
1.5 misho 351: inline unsigned char *io_Ch2Hex(unsigned char *psLine, int lineLen);
1.4 misho 352: /*
1.5 misho 353: * io_Hex2Ch() Convert from Hex string to Char string
1.4 misho 354: * @psLine = Text string
355: * @lineLen = Length of Text string
356: * return: NULL nothing to do or error; !=0 Allocated new converted string(must be free)
357: */
1.5 misho 358: inline char *io_Hex2Ch(unsigned char *psLine, int lineLen);
1.4 misho 359:
360: /*
1.8 misho 361: * io_arrayInit() - Create and initialize dynamic array
362: * @numItems = Number of Items
363: * return: NULL error, != NULL allocated memory for array
364: */
365: inline array_t *io_arrayInit(int numItems);
366: /*
1.10 misho 367: * io_arrayDestroy() - Free and destroy dynamic array
1.8 misho 368: * @parr = Array
369: * return: none
370: */
371: inline void io_arrayDestroy(array_t ** __restrict parr);
372: /*
1.10 misho 373: * io_arrayFree() - Free all data in dynamic array items
1.8 misho 374: * (WARNING! If assign static array dont use this!!!)
375: * @arr = Array
376: * return: none
377: */
378: inline void io_arrayFree(array_t * __restrict arr);
379: /*
1.10 misho 380: * io_arrayFrom() - Create and fill array from array with pointers
1.11 misho 381: * @pargv = Array with pointers
1.10 misho 382: * @argc = Number of Items, if 0 walk through argv and stop when reach NULL item
1.11 misho 383: * return: NULL error, != NULL allocated new array
1.10 misho 384: */
1.11 misho 385: inline array_t *io_arrayFrom(const char *** __restrict pargv, int argc);
1.10 misho 386: /*
387: * io_arrayTo() - Create and fill array with pointers from dynamic array
388: * @arr = Array
1.11 misho 389: * return: NULL error, != NULL allocated memory for array, NULL terminated
1.10 misho 390: */
391: inline char **io_arrayTo(array_t * __restrict arr);
392: /*
1.8 misho 393: * io_arrayLen() - Get last used element in dynamic array (array Length)
394: * @arr = Array
395: * return: -1 error, 0 empty or >0 position of last used element
396: */
397: inline int io_arrayLen(array_t * __restrict arr);
398: /*
1.10 misho 399: * io_arrayConcat() Concat source array to destination array
400: * @dest = Destination array
401: * @src = Source array
402: * return: -1 error; >0 new count of destination array
403: */
404: int io_arrayConcat(array_t * __restrict dest, array_t * __restrict src);
405: /*
1.11.2.7! misho 406: * io_arrayCopy() Copy source array to destination array
! 407: * @dest = Destination array, after use free with io_arrayDestroy()
! 408: * @src = Source array
! 409: * return: -1 error; >0 count of destination array
! 410: */
! 411: int io_arrayCopy(array_t ** __restrict dest, array_t * __restrict src);
! 412: /*
1.8 misho 413: * io_arrayGrow() - Grow/Shrink dynamic array, Use with care when it shrink!!!
414: * @arr = Array
415: * @newNumItems = Number of Items
1.11.2.6 misho 416: * @freeShrink = Free elements before shrink array
1.8 misho 417: * return: -1 error, 0 ok
418: */
1.11.2.6 misho 419: int io_arrayGrow(array_t * __restrict arr, int newNumItems, int freeShrink);
1.8 misho 420: /*
421: * io_arrayVacuum() - Vacuum dynamic array, empty elements will be deleted
422: * @arr = Array
423: * @fromWhere = 1 begin, 2 ALL empty elements
424: * return: -1 error, 0 ok
425: */
426: int io_arrayVacuum(array_t * __restrict arr, int fromWhere);
427:
1.11 misho 428: #define io_arraySize(_arr) (assert((_arr)), (_arr)->arr_num)
1.11.2.6 misho 429: #define io_arrayZero(_arr) (assert((_arr)), memset((_arr)->arr_data, 0, \
430: io_arraySize((_arr)) * sizeof(void*)))
1.8 misho 431:
1.11 misho 432: #define io_arrayGet(_arr, _d) (assert((_arr) && (_arr)->arr_num > _d), *((_arr)->arr_data + _d))
433: #define io_array(_arr, _d, _type) (assert((_arr) && (_arr)->arr_num > _d), \
434: ((_type) *((_arr)->arr_data + _d)))
1.8 misho 435: #define io_arraySet(_arr, _d, _ptr) do { \
1.11 misho 436: assert((_arr) && (_arr)->arr_num > _d); \
437: *((_arr)->arr_data + _d) = (void*) (_ptr); \
1.8 misho 438: } while (0)
1.11 misho 439: #define io_arrayDel(_arr, _d, _fri) do { \
440: assert((_arr) && (_arr)->arr_num > _d); \
441: if (_fri) \
442: free(*((_arr)->arr_data + _d)); \
443: *((_arr)->arr_data + _d) = NULL; \
1.9 misho 444: } while (0)
1.8 misho 445:
446: /*
447: * io_arrayPush() - Push element into dynamic array like stack manner, place at first empty position
448: * @arr = Array
449: * @data = Element, if set NULL return only first empty position
450: * return: -1 not found empty position, array is full!, >-1 return position of stored element into array
451: */
452: inline int io_arrayPush(array_t * __restrict arr, void **data);
453: /*
454: * io_arrayPop() - Pop element from dynamic array like stack manner, last used position
455: * @arr = Array
1.11 misho 456: * @data = Element, if set NULL return only last used position
1.8 misho 457: * @delAfter = Delete after Pop element, !=0 delete element from array after return data
458: * return: -1 not found used position, array is empty!, >-1 return element position
459: */
460: inline int io_arrayPop(array_t * __restrict arr, void ** __restrict data, int delAfter);
461:
462: /*
463: * io_argsNum() Parse and calculate number of arguments
464: * @csArgs = Input arguments line
465: * @csDelim = Delimiter(s) for separate
466: * return: 0 error format; -1 error:: can`t read; >0 ok, number of items
467: */
468: inline int io_argsNum(const char *csArgs, const char *csDelim);
469:
470: /*
471: * io_arrayMake() Parse and make array from arguments ... (input string will be modified!!!
472: * and output array must be free with io_arrayDestroy() after use!)
473: * @psArgs = Input arguments line, after execute string is modified!!!
474: * @nargs = Maximum requested count of arguments from input string psArgs, if 0 all psArgs
475: * @csDelim = Delimiter(s) for separate
476: * @parr = Output array of arguments ... (must be free with io_arrayDestroy() after use!)
477: * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
478: */
479: int io_arrayMake(char * __restrict psArgs, int nargs, const char *csDelim,
480: array_t ** __restrict parr);
481:
482: /*
483: * io_MakeAV() Parse and make attribute/value pair
484: * @csArgs = Input argument line
485: * @csDelim = Delimiter for separate
486: * @psAttr = Output Attribute
487: * @attrLen = Size of attribute array
488: * @psValue = Output Value, if ==NULL this element not present value or not wanted for return
489: * @valLen = Size of value array
490: * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
491: */
492: int io_MakeAV(const char * __restrict csArgs, const char *csDelim,
493: char * __restrict psAttr, int attrLen, char * __restrict psValue, int valLen);
494:
1.9 misho 495: /*
496: * io_sarrInit() - Create and initialize dynamic split-order array
497: * @numItems = Number of Items
498: * @segLen = Length of segment
499: * return: NULL error, != NULL allocated memory for array
500: */
501: inline sarr_t *io_sarrInit(int numItems, int segLen);
502: /*
503: * io_sarrDestroy() - Free all data in dynamic split-order array and Destroy array
504: * @parr = Array
505: * return: none
506: */
507: inline void io_sarrDestroy(sarr_t ** __restrict parr);
508: /*
509: * io_sarrGrow() - Grow/Shrink dynamic split-order array, Use with care when it shrink!!!
510: * @arr = Array
511: * @newNumItems = Number of Items
512: * return: -1 error, 0 ok
513: */
514: int io_sarrGrow(sarr_t * __restrict arr, int newNumItems);
515: /*
516: * io_sarrVacuum() - Vacuum dynamic split-order array, empty segments will be freed
517: * @arr = Array
518: * return: -1 error, >-1 freed segments
519: */
520: inline int io_sarrVacuum(sarr_t * __restrict arr);
1.11 misho 521: #define io_sarrSize(_arr) (assert((_arr)), (_arr)->sarr_num)
1.9 misho 522: /*
523: * io_sarrGet() - Get element from dynamic split-order array
524: * @arr = Array
525: * @idx = Index (warning 1st element is at position 1)
526: * return: NULL not found, !=NULL element
527: */
528: inline void *io_sarrGet(sarr_t * __restrict arr, unsigned int idx);
529: /*
530: * io_sarrGet2() - Always get element from dynamic split-order array
531: * Function automatic grow array. Good use for Hash tables!
532: * @arr = Array
533: * @idx = Index (warning 1st element is at position 1)
534: * return: NULL not found, !=NULL element
535: */
536: void *io_sarrGet2(sarr_t * __restrict arr, unsigned int idx);
537: /*
538: * io_sarrSet() - Set element to dynamic split-order array
539: * @arr = Array
540: * @idx = Index (warning 1st element is at position 1)
541: * @data = Value
542: * return: NULL error or empty, !=NULL old value in element
543: */
544: inline void *io_sarrSet(sarr_t * __restrict arr, unsigned int idx, void *data);
1.11 misho 545: #define io_sarrDel(_arr, _idx) io_sarrSet((_arr), _idx, NULL)
546: #define io_sarr(_arr, _idx, _type) (_type)io_sarrGet((_arr), _idx)
547: /*
548: * io_sarr2array() - Convert from split-order array to dynamic array
549: * @sa = split array
550: * @sarrFree = after convert split array !=0 will be destroyed sarray
551: * return: NULL error or != NULL new array
552: */
553: array_t *io_sarr2array(sarr_t ** __restrict sa, int sarrFree);
554: /*
555: * io_array2sarr() - Convert from dynamic array to split-order array
556: * @a = array
557: * @segLen = Length of segment
558: * @arrFree = after convert array !=0 will be destroyed
559: * return: NULL error or != NULL new sarr
560: */
561: sarr_t *io_array2sarr(array_t ** __restrict a, int segLen, int arrFree);
1.8 misho 562:
563: /*
1.10 misho 564: * io_CopyEnv() Copy environment to new environment array;
565: * @oldenv = Environment array
566: * return: NULL error; !=NULL Allocated new environment array(must be free)
567: */
568: char **io_CopyEnv(const char **oldenv);
569: /*
570: * io_ExecArgs() Build exec arguments from other array
571: * @psProg = Program name for execute
572: * @oldarg = Arguments array
573: * return: NULL error; !=NULL Allocated execution array(must be free)
574: */
575: char **io_ExecArgs(const char *psProg, const char **oldarg);
576: /*
577: * io_FreeNullTerm() Free dynamic allocated null terminated array with strings
578: * @arr = Pointer to array for free
579: * return: none
580: */
581: inline void io_FreeNullTerm(char *** __restrict arr);
582:
583: /*
1.2 misho 584: * ioURLGet() Parse and get data from input URL
585: * @csURL = Input URL line
586: * @url = Output parsed URL
587: * return: 0 error format not find tech:// and return URL like path;
588: -1 error:: can`t read; >0 ok, up bits for known elements
589: */
590: int ioURLGet(const char *csURL, struct tagIOURL *url);
591: /*
592: * ioURLGetValue() Get value from parsed URL
593: * @url = Input parsed URL
594: * @csAttr = Attribute for search
595: * @psValue = Return value of attribute, if ==NULL only check for existence of attribute
596: * @valLen = Size of psValue array
597: * return: 0 error attribute not find; -1 error:: can`t read; >0 ok, find at position
598: */
599: int ioURLGetValue(struct tagIOURL *url, const char *csAttr, char * __restrict psValue, int valLen);
600: /*
601: * ioURLGetFile() Get file from parsed URL
602: * @url = Input parsed URL
603: * @psValue = Return filename, if not specified file in url path, replace with /
604: * @valLen = Size of psValue array
605: * return: -1 error:: can`t read; 0 ok
606: */
607: int ioURLGetFile(struct tagIOURL *url, char * __restrict psValue, int valLen);
608:
1.3 misho 609:
610: /*
1.6 misho 611: * ioXMLGet() Parse and get data from input XML request string [ns:]container[|attribute[=value]][?data]
612: * @csXML = Input XML request line
613: * @xml = Output parsed XML request
614: * return: 0 error format incorrect, -1 error:: can`t read; >0 ok readed elements bits
615: */
616: int ioXMLGet(const char *csXML, struct tagReqXML *xml);
617:
618:
619: /*
1.5 misho 620: * ioMkDir() Function for racursive directory creation and validation
621: * @csDir = Full directory path
622: * @mode = Mode for directory creation if missing dir
623: * return: -1 error, 0 directory path exist, >0 created missing dirs
624: */
625: int ioMkDir(const char *csDir, int mode);
626:
1.6 misho 627: /*
628: * ioWatchDirLoop() Function for watching changes in directory and fire callback
629: * @csDir = Full directory path
630: * @callback = Callback if raise event! nOp -1 delete, 0 change/move, 1 create
631: * return: -1 error, !=-1 ok, number of total signaled events
632: */
633: int ioWatchDirLoop(const char *csDir, int (*callback)(const char *csName, int nOp));
634:
1.5 misho 635:
636: /*
637: * io_rread() Raw VFS read function
638: * @fd = File handle
639: * @buf = Read buffer
640: * @nbytes = Read buffer size
641: * @offset = Read from position, if -1 read nbytes from current position
642: * @update = Update file handle position !0
643: * return: -1 error or !=-1 readed bytes
644: */
645: inline int io_rread(int fd, void * __restrict buf, size_t nbytes, off_t offset, int update);
646: /*
647: * io_rwrite() Raw VFS write function
648: * @fd = File handle
649: * @buf = Write buffer
650: * @nbytes = Write bytes from buffer
651: * @offset = Write at position, if -1 write nbytes from current position
652: * @update = Update file handle position !0
653: * return: -1 error or !=-1 writed bytes
654: */
655: inline int io_rwrite(int fd, void * __restrict buf, size_t nbytes, off_t offset, int update);
656:
657: /* Disk I/O helper macros */
658: #define io_read(f, b, n) io_rread(f, b, n, -1, 1)
659: #define io_write(f, b, n) io_rwrite(f, b, n, -1, 1)
660:
661:
662: /* Debug helper macros */
663: extern int io_Debug;
664:
665: #define io_initDebug(x) io_Debug = (x);
666: #define io_addDebug io_Debug++
667: #define ioDEBUG(x, fmt, ...) do { \
668: assert((fmt)); \
669: char str[STRSIZ] = { 0 }; \
1.11 misho 670: snprintf(str, sizeof str, (fmt), ##__VA_ARGS__); \
1.5 misho 671: if ((x) <= io_Debug) \
672: syslog(LOG_DEBUG, "ioDebug(%d):%s(%d): %s\n", \
673: (x), __func__, __LINE__, str); \
674: } while (0)
675:
676: #define ioERROR(x, fmt, ...) do { \
677: assert((fmt)); \
678: char str[STRSIZ] = { 0 }; \
1.11 misho 679: snprintf(str, sizeof str, (fmt), ##__VA_ARGS__); \
1.5 misho 680: syslog(LOG_ERR, "ioError():%s(%d): #%d - %s\n", \
681: __func__, __LINE__, (x), str); \
682: } while (0)
683: #define io_sysERROR(x) do { \
684: if (x > 0 || errno) \
685: syslog(LOG_ERR, "ioError(sys):%s(%d): #%d - %s\n", \
686: __func__, __LINE__, x > 0 ? x : errno, \
687: strerror(x > 0 ? x : errno)); \
688: } while (0)
689: #define io_aitERROR(ait) do { \
690: if (ait##_GetErrno()) \
691: syslog(LOG_ERR, "ioError(ait):%s(%d): #%d - %s\n", \
692: __func__, __LINE__, ait##_GetErrno(), \
693: ait##_GetError()); \
694: } while (0)
1.3 misho 695:
1.1 misho 696:
1.7 misho 697: /* Crypto framework */
698:
699: /*
700: * ioCipher() Cipher wrapper for all supported crypto algorythms
701: * @pInput = input buffer
702: * @inLen = input buffer len
703: * @ppOutput = output allocated buffe, must be free after use
704: * @Cipher = cipher engine, like EVP_bf_cbc() or etc...
705: * @pKey = key
706: * @pIV = IV, salt (8 bytes)
707: * @nMode = Mode 0 - decrypting or 1 - encrypting
708: * return: 0 not present data or error!; >0 number of processed and returned bytes into ppOutput
709: */
710: int ioCipher(unsigned char *pInput, int inLen, unsigned char **ppOutput, const EVP_CIPHER *Cipher,
711: unsigned char *pKey, unsigned char *pIV, int nMode);
712:
713: /*
714: * io_Blowfish() Blowfish cipher algorythm, work with ASCII hex strings
715: * @pInput = input buffer
716: * @inLen = input buffer len
717: * @ppOutput = output allocated buffe, must be free after use
718: * @pKey = key
719: * @pIV = IV, salt (8 bytes)
720: * @nMode = Mode 0 - decrypting or 1 - encrypting
721: * return: 0 not present data or error!; >0 number of processed and returned bytes into ppOutput
722: */
1.8 misho 723: int io_Blowfish(unsigned char *pInput, int inLen, unsigned char **ppOutput,
724: unsigned char *pKey, unsigned char *pIV, int nMode);
1.7 misho 725:
726:
1.1 misho 727: #endif
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to aitio.h CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / libaitio / inc