File:  [ELWIX - Embedded LightWeight unIX -] / libaitio / inc / aitio.h
Revision 1.6: download - view: text, annotated - select for diffs - revision graph
Thu Feb 10 22:01:34 2011 UTC (13 years, 4 months ago) by misho
Branches: MAIN
CVS tags: io1_6, io1_5, IO1_5, IO1_4, HEAD
final version

/*************************************************************************
* (C) 2010 AITNET ltd - Sofia/Bulgaria - <misho@aitbg.com>
*  by Michael Pounov <misho@openbsd-bg.org>
*
* $Author: misho $
* $Id: aitio.h,v 1.6 2011/02/10 22:01:34 misho Exp $
*
*************************************************************************/
#ifndef __AITIO_H
#define __AITIO_H


typedef struct _tagURLItem {
	int	vallen;
	char	*value;
} url_Item_t;

struct tagIOURL {
	unsigned char	url_line[BUFSIZ];

	url_Item_t	url_tech;
	url_Item_t	url_user;
	url_Item_t	url_pass;
	url_Item_t	url_host;
	url_Item_t	url_port;
	url_Item_t	url_path;
	url_Item_t	url_args;

	char		*url_reserved;
};

struct tagReqXML {
	unsigned char	xml_line[BUFSIZ];

	url_Item_t	xml_namespace;
	union {
		url_Item_t	container;
		url_Item_t	path;
	}		xml_node;
	url_Item_t	xml_data;
	url_Item_t	xml_attribute;
	url_Item_t	xml_value;
};


// io_GetErrno() Get error code of last operation
inline int io_GetErrno();
// io_GetError() Get error text of last operation
inline const char *io_GetError();


/*
 * ioPromptRead() Read data from input h[0] with prompt to output h[1]
 * @h = file handles h[0] = input, h[1] = output, if NULL use stdin, stdout
 * @csPrompt = Prompt before input, may be NULL
 * @psData = Readed data
 * @dataLen = Length of data
 * return: 0 EOF; -1 error:: can`t read; >0 count of readed chars
*/
int ioPromptRead(int *h, const char *csPrompt, char * __restrict psData, int dataLen);
/*
 * ioPromptPassword() Read password from input h[0] with prompt to output h[1]
 * @h = file handles h[0] = input, h[1] = output, if NULL use stdin, stdout
 * @csPrompt = Prompt before input, may be NULL
 * @psPass = Readed password
 * @passLen = Length of password
 * @confirm = Confirm password, 0 - get password, !=0 Ask for confirmation
 * return: 0 EOF; -1 error:: can`t read; >0 count of readed chars
*/
int ioPromptPassword(int *h, const char *csPrompt, char * __restrict psPass, int passLen, int confirm);

/*
 * ioRegexVerify() Function for verify data match in regex expression
 * @csRegex = Regulare expression pattern
 * @csData = Data for check and verify
 * @startPos = Return start positions
 * @endPos = Return end positions
 * return: NULL not match or error; !=NULL begin of matched data
*/
const char *ioRegexVerify(const char *csRegex, const char *csData, int *startPos, int *endPos);
/*
 * ioRegexGet() Function for get data match in regex expression
 * @csRegex = Regulare expression pattern
 * @csData = Data from get
 * @psString = Returned string if match
 * @strLen = Length of string
 * return: 0 not match; >0 count of returned chars
*/
int ioRegexGet(const char *csRegex, const char *csData, char * __restrict psString, int strLen);
/*
 * ioRegexReplace() Function for replace data match in regex expression with newdata
 * @csRegex = Regulare expression pattern
 * @csData = Source data
 * @csNew = Data for replace
 * return: NULL not match or error; !=NULL allocated new string, must be free after use!
*/
char *ioRegexReplace(const char *csRegex, const char *csData, const char *csNew);

/*
 * ioVarAst() Function for evaluate string like asterisk variable "{text[:[-]#[:#]]}"
 * @csString = Input string
 * return: NULL error, !=NULL Allocated new string evaluated from input string, must be free()
*/
char *ioVarAst(const char *csString);

/*
 * io_Path2File() Parse and make path/filename pair
 * @csArgs = Input argument line
 * @psPath = Output Path, if ==NULL path not returned
 * @pathLen = Size of path array
 * @psFile = Output File
 * @fileLen = Size of file array
 * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
*/
inline int io_Path2File(const char * __restrict csArgs, char * __restrict psPath, int pathLen, 
		char * __restrict psFile, int fileLen);
/*
 * io_MakeAV() Parse and make attribute/value pair
 * @csArgs = Input argument line
 * @csDelim = Delimiter for separate
 * @psAttr = Output Attribute
 * @attrLen = Size of attribute array
 * @psValue = Output Value, if ==NULL this element not present value or not wanted for return
 * @valLen = Size of value array
 * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
*/
inline int io_MakeAV(const char * __restrict csArgs, const char *csDelim, 
		char * __restrict psAttr, int attrLen, char * __restrict psValue, int valLen);
/*
 * io_SizeArray() Parse and calculate size of array
 * @csArgs = Input arguments line
 * @csDelim = Delimiter(s) for separate
 * return: 0 error format; -1 error:: can`t read; >0 ok, number of items
*/
inline int io_SizeArray(const char *csArgs, const char *csDelim);
/*
 * io_MakeArray() Parse and make array of arguments values ... 
 *	(input string will be modified! and output array must be free)
 * @psArgs = Input arguments line, after execute string is modified!!!
 * @csDelim = Delimiter(s) for separate
 * @args = Output array of arguments ... (must be free() after procced function!)
 * @nargs = Maximum requested count of arguments from input string psArgs
 * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
*/
inline int io_MakeArray(char * __restrict psArgs, const char *csDelim, 
		char *** __restrict args, int nargs);

/*
 * io_UnquotStr() Remove quots from input text string 
 * @psLine = Text string
 * return: 0 nothing to do; 1 successful unquoted string
*/
inline int io_UnquotStr(unsigned char * __restrict psLine);
/*
 * io_LTrimStr() Remove left whitespaces from text string
 * @psLine = Text string
 * return: 0 nothing to do; !=0 Removed bytes
*/
inline int io_LTrimStr(unsigned char * __restrict psLine);
/*
 * io_RTrimStr() Remove right whitespaces from text string
 * @psLine = Text string
 * return: 0 nothing to do; !=0 Removed bytes
*/
inline int io_RTrimStr(unsigned char * __restrict psLine);
/*
 * io_TrimStr() Remove left and right whitespaces from text string
 * @psLine = Text string
 * return: 0 nothing to do; !=0 Removed bytes
*/
inline int io_TrimStr(unsigned char * __restrict psLine);
/*
 * io_Ch2Hex() Convert from Char string to Hex string
 * @psLine = Text string
 * @lineLen = Length of Text string
 * return: NULL nothing to do or error; !=0 Allocated new converted data without term\0 (must be free)
*/
inline unsigned char *io_Ch2Hex(unsigned char *psLine, int lineLen);
/*
 * io_Hex2Ch() Convert from Hex string to Char string
 * @psLine = Text string
 * @lineLen = Length of Text string
 * return: NULL nothing to do or error; !=0 Allocated new converted string(must be free)
*/
inline char *io_Hex2Ch(unsigned char *psLine, int lineLen);

/*
 * ioURLGet() Parse and get data from input URL
 * @csURL = Input URL line
 * @url = Output parsed URL
 * return: 0 error format not find tech:// and return URL like path; 
 		-1 error:: can`t read; >0 ok, up bits for known elements
*/
int ioURLGet(const char *csURL, struct tagIOURL *url);
/*
 * ioURLGetValue() Get value from parsed URL
 * @url = Input parsed URL
 * @csAttr = Attribute for search
 * @psValue = Return value of attribute, if ==NULL only check for existence of attribute
 * @valLen = Size of psValue array
 * return: 0 error attribute not find; -1 error:: can`t read; >0 ok, find at position
*/
int ioURLGetValue(struct tagIOURL *url, const char *csAttr, char * __restrict psValue, int valLen);
/*
 * ioURLGetFile() Get file from parsed URL
 * @url = Input parsed URL
 * @psValue = Return filename, if not specified file in url path, replace with /
 * @valLen = Size of psValue array
 * return: -1 error:: can`t read; 0 ok
*/
int ioURLGetFile(struct tagIOURL *url, char * __restrict psValue, int valLen);


/*
 * ioXMLGet() Parse and get data from input XML request string [ns:]container[|attribute[=value]][?data]
 * @csXML = Input XML request line
 * @xml = Output parsed XML request
 * return: 0 error format incorrect, -1 error:: can`t read; >0 ok readed elements bits
*/
int ioXMLGet(const char *csXML, struct tagReqXML *xml);


/*
 * ioMkDir() Function for racursive directory creation and validation
 * @csDir = Full directory path
 * @mode = Mode for directory creation if missing dir
 * return: -1 error, 0 directory path exist, >0 created missing dirs
*/
int ioMkDir(const char *csDir, int mode);

/*
 * ioWatchDirLoop() Function for watching changes in directory and fire callback
 * @csDir = Full directory path
 * @callback = Callback if raise event! nOp -1 delete, 0 change/move, 1 create
 * return: -1 error, !=-1 ok, number of total signaled events
*/
int ioWatchDirLoop(const char *csDir, int (*callback)(const char *csName, int nOp));


/*
 * io_rread() Raw VFS read function
 * @fd = File handle
 * @buf = Read buffer
 * @nbytes = Read buffer size
 * @offset = Read from position, if -1 read nbytes from current position
 * @update = Update file handle position !0
 * return: -1 error or !=-1 readed bytes
 */
inline int io_rread(int fd, void * __restrict buf, size_t nbytes, off_t offset, int update);
/*
 * io_rwrite() Raw VFS write function
 * @fd = File handle
 * @buf = Write buffer
 * @nbytes = Write bytes from buffer
 * @offset = Write at position, if -1 write nbytes from current position
 * @update = Update file handle position !0
 * return: -1 error or !=-1 writed bytes
 */
inline int io_rwrite(int fd, void * __restrict buf, size_t nbytes, off_t offset, int update);

/* Disk I/O helper macros */
#define io_read(f, b, n) io_rread(f, b, n, -1, 1)
#define io_write(f, b, n) io_rwrite(f, b, n, -1, 1)


/* Debug helper macros */
extern int io_Debug;

#define io_initDebug(x)		io_Debug = (x);
#define io_addDebug		io_Debug++
#define ioDEBUG(x, fmt, ...)	do { \
					assert((fmt)); \
					char str[STRSIZ] = { 0 }; \
					snprintf(str, STRSIZ, (fmt), ##__VA_ARGS__); \
					if ((x) <= io_Debug) \
						syslog(LOG_DEBUG, "ioDebug(%d):%s(%d): %s\n", \
								(x), __func__, __LINE__, str); \
				} while (0)

#define ioERROR(x, fmt, ...)	do { \
					assert((fmt)); \
					char str[STRSIZ] = { 0 }; \
					snprintf(str, STRSIZ, (fmt), ##__VA_ARGS__); \
					syslog(LOG_ERR, "ioError():%s(%d): #%d - %s\n", \
							 __func__, __LINE__, (x), str); \
				} while (0)
#define io_sysERROR(x)		do { \
					if (x > 0 || errno) \
						syslog(LOG_ERR, "ioError(sys):%s(%d): #%d - %s\n", \
								__func__, __LINE__, x > 0 ? x : errno, \
								strerror(x > 0 ? x : errno)); \
				} while (0)
#define io_aitERROR(ait)	do { \
					if (ait##_GetErrno()) \
						syslog(LOG_ERR, "ioError(ait):%s(%d): #%d - %s\n", \
								__func__, __LINE__, ait##_GetErrno(), \
								ait##_GetError()); \
				} while (0)


#endif

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