File:  [ELWIX - Embedded LightWeight unIX -] / libaitio / inc / aitio.h
Revision 1.11.2.11: download - view: text, annotated - select for diffs - revision graph
Thu Sep 1 15:11:16 2011 UTC (12 years, 10 months ago) by misho
Branches: io2_1
Diff to: branchpoint 1.11: preferred, unified
add new helper blob macro

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

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>