Annotation of libaitio/inc/aitio.h, revision 1.4
1.1 misho 1: /*************************************************************************
2: * (C) 2010 AITNET ltd - Sofia/Bulgaria - <misho@aitbg.com>
3: * by Michael Pounov <misho@openbsd-bg.org>
4: *
5: * $Author: misho $
1.4 ! misho 6: * $Id: aitio.h,v 1.3.2.6 2010/04/06 14:26:55 misho Exp $
1.1 misho 7: *
8: *************************************************************************/
9: #ifndef __AITIO_H
10: #define __AITIO_H
11:
12:
1.2 misho 13: typedef struct _tagURLItem {
14: int vallen;
15: char *value;
16: } url_Item_t;
17:
18: struct tagIOURL {
19: unsigned char url_line[BUFSIZ];
20:
21: url_Item_t url_tech;
22: url_Item_t url_user;
23: url_Item_t url_pass;
24: url_Item_t url_host;
25: url_Item_t url_port;
26: url_Item_t url_path;
27: url_Item_t url_args;
28:
29: char *url_reserved;
30: };
31:
1.3 misho 32: struct tagIOCmd {
33: const char *cmd_name;
34: int (*cmd_func)(void *, FILE *, char **);
35: const char *cmd_doc;
36: const char *cmd_help;
37: char *(*cmd_comp)(const char *, int);
38: };
39:
40: typedef struct tagIOCmd ioCommands_t;
41: typedef char *io_CompEntry_t(const char *, int);
42: typedef char **io_Completion_t(const char *, int, int);
43:
44:
1.1 misho 45: // io_GetErrno() Get error code of last operation
46: inline int io_GetErrno();
47: // io_GetError() Get error text of last operation
48: inline const char *io_GetError();
49:
50:
51: /*
52: * ioPromptRead() Read data from input h[0] with prompt to output h[1]
53: * @h = file handles h[0] = input, h[1] = output, if NULL use stdin, stdout
54: * @csPrompt = Prompt before input, may be NULL
55: * @psData = Readed data
56: * @dataLen = Length of data
57: * return: 0 EOF; -1 error:: can`t read; >0 count of readed chars
58: */
59: int ioPromptRead(int *h, const char *csPrompt, char * __restrict psData, int dataLen);
60: /*
61: * ioPromptPassword() Read password from input h[0] with prompt to output h[1]
62: * @h = file handles h[0] = input, h[1] = output, if NULL use stdin, stdout
63: * @csPrompt = Prompt before input, may be NULL
64: * @psPass = Readed password
65: * @passLen = Length of password
66: * @confirm = Confirm password, 0 - get password, !=0 Ask for confirmation
67: * return: 0 EOF; -1 error:: can`t read; >0 count of readed chars
68: */
69: int ioPromptPassword(int *h, const char *csPrompt, char * __restrict psPass, int passLen, int confirm);
70:
71: /*
72: * ioRegexVerify() Function for verify data match in regex expression
73: * @csRegex = Regulare expression pattern
74: * @csData = Data for check and verify
75: * @startPos = Return start positions
76: * @endPos = Return end positions
77: * return: NULL not match or error; !=NULL begin of matched data
78: */
79: const char *ioRegexVerify(const char *csRegex, const char *csData, int *startPos, int *endPos);
80: /*
81: * ioRegexGet() Function for get data match in regex expression
82: * @csRegex = Regulare expression pattern
83: * @csData = Data from get
84: * @psString = Returned string if match
85: * @strLen = Length of string
86: * return: 0 not match; >0 count of returned chars
87: */
88: int ioRegexGet(const char *csRegex, const char *csData, char * __restrict psString, int strLen);
89: /*
90: * ioRegexReplace() Function for replace data match in regex expression with newdata
91: * @csRegex = Regulare expression pattern
92: * @csData = Source data
93: * @csNew = Data for replace
94: * return: NULL not match or error; !=NULL allocated new string, must be free after use!
95: */
96: char *ioRegexReplace(const char *csRegex, const char *csData, const char *csNew);
97:
1.2 misho 98: /*
99: * io_Path2File() Parse and make path/filename pair
100: * @csArgs = Input argument line
101: * @psPath = Output Path, if ==NULL path not returned
102: * @pathLen = Size of path array
103: * @psFile = Output File
104: * @fileLen = Size of file array
105: * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
106: */
107: inline int io_Path2File(const char * __restrict csArgs, char * __restrict psPath, int pathLen,
108: char * __restrict psFile, int fileLen);
109: /*
110: * io_MakeAV() Parse and make attribute/value pair
111: * @csArgs = Input argument line
112: * @csDelim = Delimiter for separate
113: * @psAttr = Output Attribute
114: * @attrLen = Size of attribute array
115: * @psValue = Output Value, if ==NULL this element not present value or not wanted for return
116: * @valLen = Size of value array
117: * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
118: */
119: inline int io_MakeAV(const char * __restrict csArgs, const char *csDelim,
120: char * __restrict psAttr, int attrLen, char * __restrict psValue, int valLen);
121: /*
122: * io_SizeArray() Parse and calculate size of array
123: * @csArgs = Input arguments line
124: * @csDelim = Delimiter(s) for separate
125: * return: 0 error format; -1 error:: can`t read; >0 ok, number of items
126: */
127: inline int io_SizeArray(const char *csArgs, const char *csDelim);
128: /*
1.3 misho 129: * io_MakeArray() Parse and make array of arguments values ...
130: * (input string will be modified! and output array must be free)
131: * @psArgs = Input arguments line, after execute string is modified!!!
1.2 misho 132: * @csDelim = Delimiter(s) for separate
133: * @args = Output array of arguments ... (must be free() after procced function!)
1.3 misho 134: * @nargs = Maximum requested count of arguments from input string psArgs
1.2 misho 135: * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
136: */
137: inline int io_MakeArray(char * __restrict psArgs, const char *csDelim,
138: char *** __restrict args, int nargs);
139:
140: /*
1.4 ! misho 141: * io_UnquotStr() Remove quots from input text string
! 142: * @psLine = Text string
! 143: * return: 0 nothing to do; 1 successful unquoted string
! 144: */
! 145: inline int io_UnquotStr(unsigned char *psLine);
! 146: /*
! 147: * io_LTrimStr() Remove left whitespaces from text string
! 148: * @psLine = Text string
! 149: * return: 0 nothing to do; !=0 Removed bytes
! 150: */
! 151: inline int io_LTrimStr(unsigned char *psLine);
! 152: /*
! 153: * io_RTrimStr() Remove right whitespaces from text string
! 154: * @psLine = Text string
! 155: * return: 0 nothing to do; !=0 Removed bytes
! 156: */
! 157: inline int io_RTrimStr(unsigned char *psLine);
! 158: /*
! 159: * io_TrimStr() Remove left and right whitespaces from text string
! 160: * @psLine = Text string
! 161: * return: 0 nothing to do; !=0 Removed bytes
! 162: */
! 163: inline int io_TrimStr(unsigned char *psLine);
! 164: /*
! 165: * io_Char2Hex() Convert from Char string to Hex string
! 166: * @psLine = Text string
! 167: * @lineLen = Length of Text string
! 168: * return: NULL nothing to do or error; !=0 Allocated new converted string(must be free)
! 169: */
! 170: inline char *io_Char2Hex(unsigned char *psLine, int lineLen);
! 171: /*
! 172: * io_Hex2Char() Convert from Hex string to Char string
! 173: * @psLine = Text string
! 174: * @lineLen = Length of Text string
! 175: * return: NULL nothing to do or error; !=0 Allocated new converted string(must be free)
! 176: */
! 177: inline char *io_Hex2Char(unsigned char *psLine, int lineLen);
! 178:
! 179: /*
1.2 misho 180: * ioURLGet() Parse and get data from input URL
181: * @csURL = Input URL line
182: * @url = Output parsed URL
183: * return: 0 error format not find tech:// and return URL like path;
184: -1 error:: can`t read; >0 ok, up bits for known elements
185: */
186: int ioURLGet(const char *csURL, struct tagIOURL *url);
187: /*
188: * ioURLGetValue() Get value from parsed URL
189: * @url = Input parsed URL
190: * @csAttr = Attribute for search
191: * @psValue = Return value of attribute, if ==NULL only check for existence of attribute
192: * @valLen = Size of psValue array
193: * return: 0 error attribute not find; -1 error:: can`t read; >0 ok, find at position
194: */
195: int ioURLGetValue(struct tagIOURL *url, const char *csAttr, char * __restrict psValue, int valLen);
196: /*
197: * ioURLGetFile() Get file from parsed URL
198: * @url = Input parsed URL
199: * @psValue = Return filename, if not specified file in url path, replace with /
200: * @valLen = Size of psValue array
201: * return: -1 error:: can`t read; 0 ok
202: */
203: int ioURLGetFile(struct tagIOURL *url, char * __restrict psValue, int valLen);
204:
1.3 misho 205: /*
206: * ioCLIComp() Initialize completion CLI features
207: * @cmdComplete = Completion function
208: * @cmdEntry = Compentry function
209: * return: none
210: */
211: inline void ioCLIComp(io_Completion_t *cmdComplete, io_CompEntry_t *cmdEntry);
212: /*
213: * ioCLIExec() Execute CLI main loop
214: * @cmdList = Commands list
215: * @out = Output handle
216: * @csPrompt = Prompt text
217: * return: -1 error, 0 = exit w/^+D, 1 done.
218: */
219: int ioCLIExec(ioCommands_t *cmdList, FILE *out, const char *csPrompt);
220:
221: /*
222: * io_Cmd_Unsupported() Builtin helper function for unsupported commands
223: * @cmds = Commands list
224: * @out = Output handle
225: * @args = Parsed arguments array
226: * return: -1 error, 0 = ok, 1 exit from Cli!
227: */
228: int io_Cmd_Unsupported(void *cmds, FILE *out, char ** __restrict args);
229: /*
230: * io_Cmd_Help() Builtin helper function for Help screen
231: * @cmds = Commands list
232: * @out = Output handle
233: * @args = Parsed arguments array
234: * return: -1 error, 0 = ok
235: */
236: int io_Cmd_Help(void *cmds, FILE *out, char ** __restrict args);
237: /*
238: * io_Cmd_Exit() Builtin helper function for Exit from Cli
239: * @cmds = Commands list
240: * @out = Output handle
241: * @args = Parsed arguments array
242: * return: 1 exit from Cli!
243: */
244: int io_Cmd_Exit(void *cmds, FILE *out, char ** __restrict args);
245:
246:
247: /*
248: * io_Make_Comp_Commands - Declare helper function for Commands completion arguments
249: */
250: #define IO_MAKE_COMP_COMMANDS(FUNC, CMDS) \
251: char *FUNC(const char *text, int state) \
252: { \
253: register int i; \
254: int len = strlen(text); \
255: for (i = state; CMDS[i].cmd_name; i++) { \
256: if (strncmp(CMDS[i].cmd_name, "---", 3) && \
257: !strncmp(CMDS[i].cmd_name, text, len)) \
258: return strdup(CMDS[i].cmd_name); \
259: } \
260: return NULL; \
261: }
262:
263: /*
1.4 ! misho 264: * io_Make_Comp_Args - Declare helper function for Arguments completion
! 265: */
! 266: #define IO_MAKE_COMP_ARGS(FUNC, ARGS) \
! 267: char *FUNC(const char *text __attribute__((unused)), int state) \
! 268: { \
! 269: while (ARGS[state]) \
! 270: return strdup(ARGS[state]); \
! 271: return NULL; \
! 272: }
! 273:
! 274: /*
1.3 misho 275: * io_Comp_Filename() Builtin helper function for filename completion arguments
276: * @text = Text line
277: * @state = Position state
278: * return: NULL not found filename, != NULL filename
279: */
280: char *io_Comp_Filename(const char *text, int state);
281:
1.1 misho 282:
283: #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