Annotation of libaitcli/inc/aitcli.h, revision 1.14.4.2
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.14.4.2! misho 6: * $Id: aitcli.h,v 1.14.4.1 2025/12/21 22:36:19 misho Exp $
1.1 misho 7: *
1.4 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:
1.14.4.1 misho 15: Copyright 2004 - 2025
1.4 misho 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 __AITCLI_H
47: #define __AITCLI_H
48:
49:
1.3 misho 50: #include <termios.h>
51: #include <sys/queue.h>
52:
53:
1.5 misho 54: #ifndef STRSIZ
1.3 misho 55: #define STRSIZ 256
1.5 misho 56: #endif
1.3 misho 57:
58: /* Key definitions */
59:
60: #define K_F1 "\x1b\x4f\x50"
61: #define K_F2 "\x1b\x4f\x51"
62: #define K_F3 "\x1b\x4f\x52"
63: #define K_F4 "\x1b\x4f\x53"
64: #define K_F5 "\x1b\x5b\x31\x35\x7e"
65: #define K_F6 "\x1b\x5b\x31\x37\x7e"
66: #define K_F7 "\x1b\x5b\x31\x38\x7e"
67: #define K_F8 "\x1b\x5b\x31\x39\x7e"
68: #define K_F9 "\x1b\x5b\x32\x30\x7e"
69: #define K_F10 "\x1b\x5b\x32\x31\x7e"
70: #define K_F11 "\x1b\x5b\x32\x33\x7e"
71: #define K_F12 "\x1b\x5b\x32\x34\x7e"
72: #define K_CTRL_F1 "\x1b\x5b\x6b"
73: #define K_CTRL_F2 "\x1b\x5b\x6c"
74: #define K_CTRL_F3 "\x1b\x5b\x6d"
75: #define K_CTRL_F4 "\x1b\x5b\x6e"
76: #define K_CTRL_F5 "\x1b\x5b\x6f"
77: #define K_CTRL_F6 "\x1b\x5b\x70"
78: #define K_CTRL_F7 "\x1b\x5b\x71"
79: #define K_CTRL_F8 "\x1b\x5b\x72"
80: #define K_CTRL_F9 "\x1b\x5b\x73"
81: #define K_CTRL_F10 "\x1b\x5b\x74"
82: #define K_CTRL_F11 "\x1b\x5b\x75"
83: #define K_CTRL_F12 "\x1b\x5b\x76"
84: #define K_CTRL_SH_F1 "\x1b\x5b\x77"
85: #define K_CTRL_SH_F2 "\x1b\x5b\x78"
86: #define K_CTRL_SH_F3 "\x1b\x5b\x79"
87: #define K_CTRL_SH_F4 "\x1b\x5b\x7a"
88: #define K_CTRL_SH_F5 "\x1b\x5b\x40"
89: #define K_CTRL_SH_F6 "\x1b\x5b\x5b"
90: #define K_CTRL_SH_F7 "\x1b\x5b\x5c"
91: #define K_CTRL_SH_F8 "\x1b\x5b\x5d"
92: #define K_CTRL_SH_F9 "\x1b\x5b\x5e"
93: #define K_CTRL_SH_F10 "\x1b\x5b\x5f"
94: #define K_CTRL_SH_F11 "\x1b\x5b\x60"
95: #define K_CTRL_SH_F12 "\x1b\x5b\x7b"
96:
97: #define K_INS "\x1b\x5b\x32\x7e"
98: #define K_DEL "\x1b\x5b\x33\x7e"
99: #define K_PGUP "\x1b\x5b\x35\x7e"
100: #define K_PGDN "\x1b\x5b\x36\x7e"
101: #define K_HOME "\x1b\x5b\x48"
102: #define K_END "\x1b\x5b\x46"
103: #define K_UP "\x1b\x5b\x41"
104: #define K_DOWN "\x1b\x5b\x42"
105: #define K_RIGHT "\x1b\x5b\x43"
106: #define K_LEFT "\x1b\x5b\x44"
107:
108: #define K_NULL "\x0"
109: #define K_CR "\xd"
110: #define K_BTAB "\x1b\x5b\x5a"
111: #define K_TAB "\x9"
112: #define K_ENTER "\xa"
113: #define K_ESC "\x1b"
114: #define K_BACKSPACE "\x7f"
115: #define K_SPACE "\x20"
116:
117: #define K_CTRL_SPACE K_NULL
118: #define K_CTRL_2 K_NULL
119: #define K_CTRL_A "\x1"
120: #define K_CTRL_B "\x2"
121: #define K_CTRL_C "\x3"
122: #define K_CTRL_D "\x4"
123: #define K_CTRL_E "\x5"
124: #define K_CTRL_F "\x6"
125: #define K_CTRL_G "\x7"
126: #define K_CTRL_H "\x8"
127: #define K_CTRL_I K_TAB
128: #define K_CTRL_J K_ENTER
129: #define K_CTRL_K "\xb"
130: #define K_CTRL_L "\xc"
131: #define K_CTRL_M K_ENTER // K_CR
132: #define K_CTRL_N "\xe"
133: #define K_CTRL_O "\xf"
134: #define K_CTRL_P "\x10"
135: #define K_CTRL_Q "\x11"
136: #define K_CTRL_R "\x12"
137: #define K_CTRL_S "\x13"
138: #define K_CTRL_T "\x14"
139: #define K_CTRL_U "\x15"
140: #define K_CTRL_V "\x16"
141: #define K_CTRL_W "\x17"
142: #define K_CTRL_X "\x18"
143: #define K_CTRL_Y "\x19"
144: #define K_CTRL_Z "\x1a"
145: #define K_CTRL_LBRACE "\x1b"
146: #define K_CTRL_PIPE "\x1c"
147: #define K_CTRL_RBRACE "\x1d"
148: #define K_CTRL_6 "\x1e"
149: #define K_CTRL__ "\x1f"
150:
151:
152: #define K_X_CTRL_INS "\x1b\x5b\x32\x3b\x35\x7e"
153: #define K_X_CTRL_DEL "\x1b\x5b\x33\x3b\x35\x7e"
154: #define K_X_CTRL_PGUP "\x1b\x5b\x35\x3b\x35\x7e"
155: #define K_X_CTRL_PGDN "\x1b\x5b\x36\x3b\x35\x7e"
156: #define K_X_CTRL_HOME "\x1b\x5b\x31\x3b\x35\x48"
157: #define K_X_CTRL_END "\x1b\x5b\x31\x3b\x35\x46"
158: #define K_X_CTRL_UP "\x1b\x5b\x31\x3b\x35\x41"
159: #define K_X_CTRL_DOWN "\x1b\x5b\x31\x3b\x35\x42"
160: #define K_X_CTRL_RIGHT "\x1b\x5b\x31\x3b\x35\x43"
161: #define K_X_CTRL_LEFT "\x1b\x5b\x31\x3b\x35\x44"
162:
163: #define K_X_ALT_INS "\x1b\x5b\x32\x3b\x33\x7e"
164: #define K_X_ALT_DEL "\x1b\x5b\x33\x3b\x33\x7e"
165: #define K_X_ALT_PGUP "\x1b\x5b\x35\x3b\x33\x7e"
166: #define K_X_ALT_PGDN "\x1b\x5b\x36\x3b\x33\x7e"
167: #define K_X_ALT_HOME "\x1b\x5b\x31\x3b\x33\x48"
168: #define K_X_ALT_END "\x1b\x5b\x31\x3b\x33\x46"
169: #define K_X_ALT_UP "\x1b\x5b\x31\x3b\x33\x41"
170: #define K_X_ALT_DOWN "\x1b\x5b\x31\x3b\x33\x42"
171: #define K_X_ALT_RIGHT "\x1b\x5b\x31\x3b\x33\x43"
172: #define K_X_ALT_LEFT "\x1b\x5b\x31\x3b\x33\x44"
173:
174: #define K_X_CTL_A_INS "\x1b\x5b\x32\x3b\x37\x7e"
175: #define K_X_CTL_A_DEL "\x1b\x5b\x33\x3b\x37\x7e"
176: #define K_X_CTL_A_PGUP "\x1b\x5b\x35\x3b\x37\x7e"
177: #define K_X_CTL_A_PGDN "\x1b\x5b\x36\x3b\x37\x7e"
178: #define K_X_CTL_A_HOME "\x1b\x5b\x31\x3b\x37\x48"
179: #define K_X_CTL_A_END "\x1b\x5b\x31\x3b\x37\x46"
180: #define K_X_CTL_A_UP "\x1b\x5b\x31\x3b\x37\x41"
181: #define K_X_CTL_A_DOWN "\x1b\x5b\x31\x3b\x37\x42"
182: #define K_X_CTL_A_RIGHT "\x1b\x5b\x31\x3b\x37\x43"
183: #define K_X_CTL_A_LEFT "\x1b\x5b\x31\x3b\x37\x44"
184:
185:
186: /* History types */
187:
188: struct tagHistory {
1.6 misho 189: int hist_len;
190: char hist_line[BUFSIZ];
1.3 misho 191:
192: TAILQ_ENTRY(tagHistory) hist_next;
1.1 misho 193: };
1.3 misho 194: typedef TAILQ_HEAD(tqHistoryHead, tagHistory) history_t;
195:
196: /* Bind keys structure types */
197:
1.7 misho 198: typedef int (*bindkey_func_t)(int idx, /* linebuffer_t * */ void * __restrict cli_buffer);
1.3 misho 199: typedef struct {
200: int key_len;
201: unsigned char key_ch[8];
202: bindkey_func_t key_func;
203: } bindkey_t;
204:
205:
206: /* Commands structure for CLI */
207:
1.11 misho 208: #define CLI_CMD_DEFINE(x) int (x)(void *, int, char **)
1.7 misho 209: typedef int (*cmd_func_t)(/*linebuffer_t **/ void * __restrict cli_buffer, int idx,
210: char ** __restrict args);
1.3 misho 211: struct tagCommand {
212: int cmd_level;
213:
214: int cmd_len;
215: char cmd_name[STRSIZ];
216:
217: char cmd_info[STRSIZ];
218: char cmd_help[STRSIZ];
219:
220: cmd_func_t cmd_func;
221:
222: SLIST_ENTRY(tagCommand) cmd_next;
223: };
224: typedef SLIST_HEAD(slCommandHead, tagCommand) commands_t;
225:
226:
227: /* Main structure, Buffer for CLI work with thread models ;-) special designed by M.Punov */
1.1 misho 228:
1.3 misho 229: typedef struct {
1.10 misho 230: int line_kill;
1.3 misho 231: char line_mode;
1.1 misho 232:
1.11 misho 233: char line_porigin[STRSIZ];
1.3 misho 234: char *line_prompt;
235:
236: int line_bol;
237: int line_eol;
238: int line_len;
239: char *line_buf;
1.14.4.2! misho 240: char *line_input;
1.3 misho 241:
242: const struct tagHistory *line_h;
243: history_t line_history;
244:
245: bindkey_t *line_keys;
1.14.4.2! misho 246: bindkey_t *line_inkeys;
1.3 misho 247:
248: int line_level;
249: commands_t line_cmds;
250:
251: int line_in;
252: int line_out;
253: } linebuffer_t;
254:
1.14 misho 255: #ifdef __cplusplus
256: extern "C" {
257: #endif
1.3 misho 258:
259: /* Error support functions */
1.1 misho 260:
261: // cli_GetErrno() Get error code of last operation
1.6 misho 262: int cli_GetErrno();
1.1 misho 263: // cli_GetError() Get error text of last operation
1.6 misho 264: const char *cli_GetError();
1.1 misho 265:
1.3 misho 266:
1.4 misho 267: /* TELNET support for CLI */
268:
269: #define MAX_SUB_LEN 255
270:
271: struct telnetAttrs {
272: unsigned char ta_cmd;
273: unsigned char ta_opt;
274: unsigned char ta_sublen;
275: unsigned char ta_sub[MAX_SUB_LEN];
276: };
277:
278:
279: #ifndef NDEBUG
280: /*
1.6 misho 281: * cli_telnetDumpAttrs() - Telnet debug attributes list, if NDEBUG defined not include
282: *
1.4 misho 283: * @attr = attributes list
284: * @nAttr = attributes list size
285: * return: none
286: */
287: void cli_telnetDumpAttrs(struct telnetAttrs *attr, int nAttr);
288: #else
289: extern void cli_telnetDumpAttrs(struct telnetAttrs *, int);
290: #endif
291:
292:
293: /*
1.6 misho 294: * cli_telnetRecv() - Telnet receive commands, negotiate with telnet peer
295: *
1.4 misho 296: * @sock = socket for communication
297: * @attr = received attributes list, must be free after use, but if NULL receive in binary mode
298: * @nAttr = received attributes list size, if is NULL receive in binary mode
299: * @pdata = received data in supplied buffer
300: * @datLen = buffer pdata size
301: * return: 0 not present data; -1 error:: can`t read; -2 timeout; -3 EOF; >0 number of received bytes
302: */
303: int cli_telnetRecv(int sock, struct telnetAttrs **attr, int *nAttr, void *data, int datLen);
304: /*
1.6 misho 305: * cli_telnetSend() - Telnet send commands, negotiate with telnet peer
306: *
1.4 misho 307: * @sock = socket for communication
308: * @attr = send attributes list
309: * @nAttr = send attributes list size
310: * @data = data for send
311: * @datLen = data size
312: * @Term = Terminate with GA (Go Ahead), 1 send after data GA command
313: * return: 0 not sended commands; -1 error:: can`t send; >0 number of sended bytes
314: */
315: int cli_telnetSend(int sock, struct telnetAttrs *attr, int nAttr, void *data, int datLen, int Term);
316:
317: /*
1.6 misho 318: * cli_telnet_Get_SubOpt() - Telnet get sub option function
319: *
1.4 misho 320: * @attr = input attribute
321: * @code = sub-option code for opt
322: * @data = sub-option data
323: * @datLen = data size set max size in input, output return copy size
324: * return: -1 can`t get option; !=-1 option code
325: */
1.6 misho 326: int cli_telnet_Get_SubOpt(struct telnetAttrs *attr, unsigned char *code,
1.4 misho 327: void *data, unsigned char *datLen);
328: /*
1.6 misho 329: * cli_telnet_Set_SubOpt() - Telnet set sub option function
330: *
1.4 misho 331: * @attr = output attribute
332: * @opt = attribute option
333: * @code = sub-option code for opt, if 0xff not specified
334: * @data = sub-option data, if NULL not specified
335: * @datLen = data size, if 0 not specified
336: * return: -1 can`t set sub-otion; 0 ok
337: */
1.6 misho 338: int cli_telnet_Set_SubOpt(struct telnetAttrs *attr, unsigned char opt, unsigned char code,
1.4 misho 339: void *data, unsigned char datLen);
340:
341: /*
1.6 misho 342: * cli_telnet_GetCmd() - Telnet get command
343: *
1.4 misho 344: * @attr = input attribute
345: * return: -1 can`t get command; !=-1 command <<24 return sublen, <<8 return option, <<0 command
346: */
1.6 misho 347: unsigned int cli_telnet_GetCmd(struct telnetAttrs *attr);
1.4 misho 348: /*
1.6 misho 349: * cli_telnet_SetCmd() - Telnet set command
350: *
1.4 misho 351: * @attr = input attribute
352: * @cmd = command
1.11 misho 353: * @optz = option, if 0xff not specified
1.4 misho 354: * @arg1 = sub-option code, if 0xff not specified
355: * @arg2 = sub-option data, if NULL not specified
356: * @arg3 = sub-option data size, if 0 not specified data
357: * return: -1 can`t set command; !=-1 ok
358: */
1.11 misho 359: int cli_telnet_SetCmd(struct telnetAttrs *attr, unsigned char cmd, int optz, ...);
1.4 misho 360:
361: /*
1.6 misho 362: * cli_telnet_Answer() - Automatic generate commands answer to send from telnet
363: *
1.4 misho 364: * @caps = Array of capability options
365: * @nCaps = number of capability options
366: * @attr = input attribute
367: * @nAttr = number of input attributes
1.6 misho 368: * @ans = output answered attributes, must be e_free() after use
1.4 misho 369: * @Ans = number of output answered attributes
370: * return: -1 can`t answer; !=-1 ok
371: */
372: int cli_telnet_Answer(unsigned char *caps, int nCaps, struct telnetAttrs *attr, int nAttr,
373: struct telnetAttrs **ans, int *Ans);
374:
375:
376: // Add capability option, x = 0 false, 1 true
377: #define ADD_CAPS(opt, x) ((opt) | (x) ? 0x80 : 0)
378: // Is supported this option ...
379: #define SUP_CAPS(caps) ((caps) & 0x80)
380: // get capability option
381: #define CAP(caps) ((caps) & 0x7f)
382:
383:
1.3 misho 384: /* CLI Helper functions */
385:
386: /*
1.6 misho 387: * cli_Cmd_Unsupported() - Builtin helper function for unsupported commands
388: *
1.7 misho 389: * @cli_buffer = CLI buffer
1.8 misho 390: * @idx = Config level
1.3 misho 391: * @args = Parsed arguments array
392: * return: RETCODE_OK ok
393: */
1.7 misho 394: int cli_Cmd_Unsupported(void * __restrict cli_buffer, int idx, char ** __restrict args);
1.3 misho 395:
396:
397: /* CLI Functions */
398:
1.1 misho 399: /*
1.6 misho 400: * cli_BindKey() - Bind function to key
401: *
1.3 misho 402: * @key = key structure
1.7 misho 403: * @cli_buffer = CLI buffer
1.3 misho 404: * return: RETCODE_ERR error, RETCODE_OK ok, >0 bind at position
1.1 misho 405: */
1.7 misho 406: int cli_BindKey(bindkey_t * __restrict key, linebuffer_t * __restrict cli_buffer);
1.3 misho 407:
1.1 misho 408:
409: /*
1.6 misho 410: * cli_addCommand() - Add command to CLI session
411: *
1.7 misho 412: * @cli_buffer = CLI buffer
1.3 misho 413: * @csCmd = Command name
1.8 misho 414: * @cliLevel = Level in CLI, -1 view from all levels, 0 hidden, >0 mask levels
1.3 misho 415: * @funcCmd = Callback function when user call command
416: * @csInfo = Inline information for command
417: * @csHelp = Help line when call help
418: * return: RETCODE_ERR error, RETCODE_OK ok
1.2 misho 419: */
1.3 misho 420: int
1.7 misho 421: cli_addCommand(linebuffer_t * __restrict cli_buffer, const char *csCmd,
422: int cliLevel, cmd_func_t funcCmd,
1.3 misho 423: const char *csInfo, const char *csHelp);
1.2 misho 424: /*
1.6 misho 425: * cli_delCommand() - Delete command from CLI session
426: *
1.7 misho 427: * @cli_buffer = CLI buffer
1.3 misho 428: * @csCmd = Command name
1.8 misho 429: * @cliLevel = Level in CLI, -1 view from all levels, 0 hidden, >0 mask levels
1.3 misho 430: * return: RETCODE_ERR error, RETCODE_OK ok
1.1 misho 431: */
1.3 misho 432: int
1.7 misho 433: cli_delCommand(linebuffer_t * __restrict cli_buffer, const char *csCmd, int cliLevel);
1.1 misho 434: /*
1.6 misho 435: * cli_updCommand() - Update command in CLI session
436: *
1.7 misho 437: * @cli_buffer = CLI buffer
1.3 misho 438: * @csCmd = Command name
1.8 misho 439: * @cliLevel = Level in CLI, -1 view from all levels, 0 hidden, >0 mask levels
1.3 misho 440: * @funcCmd = Callback function when user call command
441: * @csInfo = Inline information for command
442: * @csHelp = Help line when call help
443: * return: RETCODE_ERR error, RETCODE_OK ok
1.2 misho 444: */
1.3 misho 445: int
1.7 misho 446: cli_updCommand(linebuffer_t * __restrict cli_buffer, const char *csCmd,
447: int cliLevel, cmd_func_t funcCmd,
1.3 misho 448: const char *csInfo, const char *csHelp);
449:
1.2 misho 450:
451: /*
1.6 misho 452: * cli_addHistory() - Add line to history
453: *
1.7 misho 454: * @cli_buffer = CLI buffer
1.3 misho 455: * @str = Add custom text or if NULL use readed line from CLI buffer
456: * return: RETCODE_ERR error, RETCODE_OK ok
1.2 misho 457: */
1.7 misho 458: int cli_addHistory(linebuffer_t * __restrict cli_buffer, const char * __restrict str);
1.2 misho 459: /*
1.6 misho 460: * cli_saveHistory() - Save history to file
461: *
1.7 misho 462: * @cli_buffer = CLI buffer
1.3 misho 463: * @histfile = History filename, if NULL will be use default name
464: * @lines = Maximum history lines to save
465: * return: RETCODE_ERR error, RETCODE_OK ok
1.2 misho 466: */
1.7 misho 467: int cli_saveHistory(linebuffer_t * __restrict cli_buffer, const char *histfile, int lines);
1.3 misho 468: /*
1.6 misho 469: * cli_loadHistory() - Load history from file
470: *
1.7 misho 471: * @cli_buffer = CLI buffer
1.3 misho 472: * @histfile = History filename, if NULL will be use default name
473: * return: RETCODE_ERR error, RETCODE_OK ok
474: */
1.7 misho 475: int cli_loadHistory(linebuffer_t * __restrict cli_buffer, const char *histfile);
1.1 misho 476: /*
1.6 misho 477: * cli_resetHistory() - Reset history search in CLI session
478: *
1.7 misho 479: * @cli_buffer = CLI buffer
1.1 misho 480: * return: none
481: */
1.7 misho 482: void cli_resetHistory(linebuffer_t * __restrict cli_buffer);
1.1 misho 483:
484: /*
1.6 misho 485: * cli_freeLine() - Clear entire line
486: *
1.7 misho 487: * @cli_buffer = CLI buffer
1.3 misho 488: * return: RETCODE_ERR error, RETCODE_OK ok
489: */
1.7 misho 490: int cli_freeLine(linebuffer_t * __restrict cli_buffer);
1.3 misho 491: /*
1.6 misho 492: * cli_setPrompt() - Set new prompt for CLI session
493: *
1.7 misho 494: * @cli_buffer = CLI buffer
1.3 misho 495: * @prompt = new text for prompt or if NULL disable prompt
496: * return: none
1.1 misho 497: */
1.7 misho 498: void cli_setPrompt(linebuffer_t * __restrict cli_buffer, const char *prompt);
1.1 misho 499: /*
1.6 misho 500: * cli_Printf() - Send message to CLI session
501: *
1.7 misho 502: * @cli_buffer = CLI buffer
1.3 misho 503: * @fmt = printf format string
504: * @... = arguments defined in fmt
505: * return: none
1.1 misho 506: */
1.7 misho 507: void cli_Printf(linebuffer_t * __restrict cli_buffer, char *fmt, ...);
1.1 misho 508: /*
1.6 misho 509: * cli_PrintHelp() - Print help screen
510: *
1.7 misho 511: * @cli_buffer = CLI buffer
1.3 misho 512: * return: none
1.1 misho 513: */
1.7 misho 514: void cli_PrintHelp(linebuffer_t * __restrict cli_buffer);
1.1 misho 515:
1.3 misho 516: /*
1.6 misho 517: * cliEnd() - Clear data, Free resources and close CLI session
518: *
1.7 misho 519: * @cli_buffer = CLI buffer
1.3 misho 520: * return: RETCODE_ERR error, RETCODE_OK ok
521: */
1.7 misho 522: void cliEnd(linebuffer_t * __restrict cli_buffer);
1.3 misho 523: /*
1.6 misho 524: * cliInit() - Start CLI session, allocate memory for resources and bind keys
525: *
1.3 misho 526: * @fin = Input device handle
527: * @fout = Output device handle
528: * @prompt = text for prompt, if NULL disable prompt
529: * return: NULL if error or !=NULL CLI buffer
530: */
531: linebuffer_t *cliInit(int fin, int fout, const char *prompt);
1.1 misho 532:
533: /*
1.13 misho 534: * cliSetLine() - Set CLI input line terminal
1.6 misho 535: *
1.7 misho 536: * @cli_buffer = CLI buffer
1.13 misho 537: * @old = Old terminal settings
538: * return: -1 error or 0 ok
539: */
540: int cliSetLine(linebuffer_t * __restrict cli_buffer, struct termios * __restrict old);
541: /*
542: * cliResetLine() - Reset CLI input line terminal
543: *
544: * @cli_buffer = CLI buffer
545: * @old = Original terminal settings
546: * return: -1 error or 0 ok
1.1 misho 547: */
1.13 misho 548: int cliResetLine(linebuffer_t * __restrict cli_buffer, struct termios * __restrict orig);
1.1 misho 549: /*
1.14.4.1 misho 550: * cliEcho() - Switch echo on or off
551: *
552: * @cli_buffer = CLI buffer
553: * @on = On or off for echo on input handler
554: * return: -1 error or 0 ok
555: */
556: int cliEcho(linebuffer_t * __restrict cli_buffer, int on);
557: /*
1.6 misho 558: * cliReadLine() - Read line from opened CLI session
559: *
1.7 misho 560: * @cli_buffer = CLI buffer
1.9 misho 561: * @timeout = Session timeout (-1 infinit)
1.6 misho 562: * return: NULL if error or !=NULL readed line, must be e_free after use!
1.1 misho 563: */
1.10 misho 564: char *cliReadLine(linebuffer_t * __restrict cli_buffer, int timeout);
1.12 misho 565:
566: /*
567: * cliRun() - CLI run command line
568: *
569: * @cli_buffer = CLI buffer
570: * @psInput = Input command line
571: * @prompt = Display prompt after command
572: * return: RETCODE_ERR error, RETCODE_OK ok
573: */
574: int cliRun(linebuffer_t * __restrict cli_buffer, char *psInput, int prompt);
1.1 misho 575:
576: /*
1.6 misho 577: * cliLoop() - CLI main loop
578: *
1.7 misho 579: * @cli_buffer = CLI buffer
1.3 misho 580: * @csHistFile = History file name
1.9 misho 581: * @timeout = Session timeout (-1 infinit)
1.3 misho 582: * return: RETCODE_ERR error, RETCODE_OK ok
1.1 misho 583: */
1.10 misho 584: int cliLoop(linebuffer_t * __restrict cli_buffer, const char *csHistFile, int timeout);
1.1 misho 585: /*
1.6 misho 586: * cliNetLoop() - CLI network main loop binded to socket
587: *
1.7 misho 588: * @cli_buffer = CLI buffer
1.3 misho 589: * @csHistFile = History file name
590: * @sock = client socket
1.9 misho 591: * @timeout = Session timeout (-1 infinit)
1.3 misho 592: * return: RETCODE_ERR error, RETCODE_OK ok
1.1 misho 593: */
1.9 misho 594: int cliNetLoop(linebuffer_t * __restrict cli_buffer, const char *csHistFile,
1.10 misho 595: int sock, int timeout);
596: #define cliKillLoop(_x) (assert((_x)), (_x)->line_kill = 1)
1.1 misho 597:
1.14 misho 598: #ifdef __cplusplus
599: }
600: #endif
1.1 misho 601:
602: #endif
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to aitcli.h CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / libaitcli / inc