Annotation of libaitcli/inc/aitcli.h, revision 1.15
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.15 ! misho 6: * $Id: aitcli.h,v 1.14.4.3 2025/12/23 23:11:13 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.15 ! 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;
240:
1.15 ! misho 241: int line_posin;
! 242: int line_lenin;
! 243: char *line_input;
! 244:
1.3 misho 245: const struct tagHistory *line_h;
246: history_t line_history;
247:
248: bindkey_t *line_keys;
1.15 ! misho 249: bindkey_t *line_inkeys;
1.3 misho 250:
251: int line_level;
252: commands_t line_cmds;
253:
254: int line_in;
255: int line_out;
256: } linebuffer_t;
257:
1.14 misho 258: #ifdef __cplusplus
259: extern "C" {
260: #endif
1.3 misho 261:
262: /* Error support functions */
1.1 misho 263:
264: // cli_GetErrno() Get error code of last operation
1.6 misho 265: int cli_GetErrno();
1.1 misho 266: // cli_GetError() Get error text of last operation
1.6 misho 267: const char *cli_GetError();
1.1 misho 268:
1.3 misho 269:
1.4 misho 270: /* TELNET support for CLI */
271:
272: #define MAX_SUB_LEN 255
273:
274: struct telnetAttrs {
275: unsigned char ta_cmd;
276: unsigned char ta_opt;
277: unsigned char ta_sublen;
278: unsigned char ta_sub[MAX_SUB_LEN];
279: };
280:
281:
282: #ifndef NDEBUG
283: /*
1.6 misho 284: * cli_telnetDumpAttrs() - Telnet debug attributes list, if NDEBUG defined not include
285: *
1.4 misho 286: * @attr = attributes list
287: * @nAttr = attributes list size
288: * return: none
289: */
290: void cli_telnetDumpAttrs(struct telnetAttrs *attr, int nAttr);
291: #else
292: extern void cli_telnetDumpAttrs(struct telnetAttrs *, int);
293: #endif
294:
295:
296: /*
1.6 misho 297: * cli_telnetRecv() - Telnet receive commands, negotiate with telnet peer
298: *
1.4 misho 299: * @sock = socket for communication
300: * @attr = received attributes list, must be free after use, but if NULL receive in binary mode
301: * @nAttr = received attributes list size, if is NULL receive in binary mode
302: * @pdata = received data in supplied buffer
303: * @datLen = buffer pdata size
304: * return: 0 not present data; -1 error:: can`t read; -2 timeout; -3 EOF; >0 number of received bytes
305: */
306: int cli_telnetRecv(int sock, struct telnetAttrs **attr, int *nAttr, void *data, int datLen);
307: /*
1.6 misho 308: * cli_telnetSend() - Telnet send commands, negotiate with telnet peer
309: *
1.4 misho 310: * @sock = socket for communication
311: * @attr = send attributes list
312: * @nAttr = send attributes list size
313: * @data = data for send
314: * @datLen = data size
315: * @Term = Terminate with GA (Go Ahead), 1 send after data GA command
316: * return: 0 not sended commands; -1 error:: can`t send; >0 number of sended bytes
317: */
318: int cli_telnetSend(int sock, struct telnetAttrs *attr, int nAttr, void *data, int datLen, int Term);
319:
320: /*
1.6 misho 321: * cli_telnet_Get_SubOpt() - Telnet get sub option function
322: *
1.4 misho 323: * @attr = input attribute
324: * @code = sub-option code for opt
325: * @data = sub-option data
326: * @datLen = data size set max size in input, output return copy size
327: * return: -1 can`t get option; !=-1 option code
328: */
1.6 misho 329: int cli_telnet_Get_SubOpt(struct telnetAttrs *attr, unsigned char *code,
1.4 misho 330: void *data, unsigned char *datLen);
331: /*
1.6 misho 332: * cli_telnet_Set_SubOpt() - Telnet set sub option function
333: *
1.4 misho 334: * @attr = output attribute
335: * @opt = attribute option
336: * @code = sub-option code for opt, if 0xff not specified
337: * @data = sub-option data, if NULL not specified
338: * @datLen = data size, if 0 not specified
339: * return: -1 can`t set sub-otion; 0 ok
340: */
1.6 misho 341: int cli_telnet_Set_SubOpt(struct telnetAttrs *attr, unsigned char opt, unsigned char code,
1.4 misho 342: void *data, unsigned char datLen);
343:
344: /*
1.6 misho 345: * cli_telnet_GetCmd() - Telnet get command
346: *
1.4 misho 347: * @attr = input attribute
348: * return: -1 can`t get command; !=-1 command <<24 return sublen, <<8 return option, <<0 command
349: */
1.6 misho 350: unsigned int cli_telnet_GetCmd(struct telnetAttrs *attr);
1.4 misho 351: /*
1.6 misho 352: * cli_telnet_SetCmd() - Telnet set command
353: *
1.4 misho 354: * @attr = input attribute
355: * @cmd = command
1.11 misho 356: * @optz = option, if 0xff not specified
1.4 misho 357: * @arg1 = sub-option code, if 0xff not specified
358: * @arg2 = sub-option data, if NULL not specified
359: * @arg3 = sub-option data size, if 0 not specified data
360: * return: -1 can`t set command; !=-1 ok
361: */
1.11 misho 362: int cli_telnet_SetCmd(struct telnetAttrs *attr, unsigned char cmd, int optz, ...);
1.4 misho 363:
364: /*
1.6 misho 365: * cli_telnet_Answer() - Automatic generate commands answer to send from telnet
366: *
1.4 misho 367: * @caps = Array of capability options
368: * @nCaps = number of capability options
369: * @attr = input attribute
370: * @nAttr = number of input attributes
1.6 misho 371: * @ans = output answered attributes, must be e_free() after use
1.4 misho 372: * @Ans = number of output answered attributes
373: * return: -1 can`t answer; !=-1 ok
374: */
375: int cli_telnet_Answer(unsigned char *caps, int nCaps, struct telnetAttrs *attr, int nAttr,
376: struct telnetAttrs **ans, int *Ans);
377:
378:
379: // Add capability option, x = 0 false, 1 true
380: #define ADD_CAPS(opt, x) ((opt) | (x) ? 0x80 : 0)
381: // Is supported this option ...
382: #define SUP_CAPS(caps) ((caps) & 0x80)
383: // get capability option
384: #define CAP(caps) ((caps) & 0x7f)
385:
386:
1.3 misho 387: /* CLI Helper functions */
388:
389: /*
1.6 misho 390: * cli_Cmd_Unsupported() - Builtin helper function for unsupported commands
391: *
1.7 misho 392: * @cli_buffer = CLI buffer
1.8 misho 393: * @idx = Config level
1.3 misho 394: * @args = Parsed arguments array
395: * return: RETCODE_OK ok
396: */
1.7 misho 397: int cli_Cmd_Unsupported(void * __restrict cli_buffer, int idx, char ** __restrict args);
1.3 misho 398:
399:
400: /* CLI Functions */
401:
1.1 misho 402: /*
1.6 misho 403: * cli_BindKey() - Bind function to key
404: *
1.3 misho 405: * @key = key structure
1.7 misho 406: * @cli_buffer = CLI buffer
1.3 misho 407: * return: RETCODE_ERR error, RETCODE_OK ok, >0 bind at position
1.1 misho 408: */
1.7 misho 409: int cli_BindKey(bindkey_t * __restrict key, linebuffer_t * __restrict cli_buffer);
1.3 misho 410:
1.1 misho 411:
412: /*
1.6 misho 413: * cli_addCommand() - Add command to CLI session
414: *
1.7 misho 415: * @cli_buffer = CLI buffer
1.3 misho 416: * @csCmd = Command name
1.8 misho 417: * @cliLevel = Level in CLI, -1 view from all levels, 0 hidden, >0 mask levels
1.3 misho 418: * @funcCmd = Callback function when user call command
419: * @csInfo = Inline information for command
420: * @csHelp = Help line when call help
421: * return: RETCODE_ERR error, RETCODE_OK ok
1.2 misho 422: */
1.3 misho 423: int
1.7 misho 424: cli_addCommand(linebuffer_t * __restrict cli_buffer, const char *csCmd,
425: int cliLevel, cmd_func_t funcCmd,
1.3 misho 426: const char *csInfo, const char *csHelp);
1.2 misho 427: /*
1.6 misho 428: * cli_delCommand() - Delete command from CLI session
429: *
1.7 misho 430: * @cli_buffer = CLI buffer
1.3 misho 431: * @csCmd = Command name
1.8 misho 432: * @cliLevel = Level in CLI, -1 view from all levels, 0 hidden, >0 mask levels
1.3 misho 433: * return: RETCODE_ERR error, RETCODE_OK ok
1.1 misho 434: */
1.3 misho 435: int
1.7 misho 436: cli_delCommand(linebuffer_t * __restrict cli_buffer, const char *csCmd, int cliLevel);
1.1 misho 437: /*
1.6 misho 438: * cli_updCommand() - Update command in CLI session
439: *
1.7 misho 440: * @cli_buffer = CLI buffer
1.3 misho 441: * @csCmd = Command name
1.8 misho 442: * @cliLevel = Level in CLI, -1 view from all levels, 0 hidden, >0 mask levels
1.3 misho 443: * @funcCmd = Callback function when user call command
444: * @csInfo = Inline information for command
445: * @csHelp = Help line when call help
446: * return: RETCODE_ERR error, RETCODE_OK ok
1.2 misho 447: */
1.3 misho 448: int
1.7 misho 449: cli_updCommand(linebuffer_t * __restrict cli_buffer, const char *csCmd,
450: int cliLevel, cmd_func_t funcCmd,
1.3 misho 451: const char *csInfo, const char *csHelp);
452:
1.2 misho 453:
454: /*
1.6 misho 455: * cli_addHistory() - Add line to history
456: *
1.7 misho 457: * @cli_buffer = CLI buffer
1.3 misho 458: * @str = Add custom text or if NULL use readed line from CLI buffer
459: * return: RETCODE_ERR error, RETCODE_OK ok
1.2 misho 460: */
1.7 misho 461: int cli_addHistory(linebuffer_t * __restrict cli_buffer, const char * __restrict str);
1.2 misho 462: /*
1.6 misho 463: * cli_saveHistory() - Save history to file
464: *
1.7 misho 465: * @cli_buffer = CLI buffer
1.3 misho 466: * @histfile = History filename, if NULL will be use default name
467: * @lines = Maximum history lines to save
468: * return: RETCODE_ERR error, RETCODE_OK ok
1.2 misho 469: */
1.7 misho 470: int cli_saveHistory(linebuffer_t * __restrict cli_buffer, const char *histfile, int lines);
1.3 misho 471: /*
1.6 misho 472: * cli_loadHistory() - Load history from file
473: *
1.7 misho 474: * @cli_buffer = CLI buffer
1.3 misho 475: * @histfile = History filename, if NULL will be use default name
476: * return: RETCODE_ERR error, RETCODE_OK ok
477: */
1.7 misho 478: int cli_loadHistory(linebuffer_t * __restrict cli_buffer, const char *histfile);
1.1 misho 479: /*
1.6 misho 480: * cli_resetHistory() - Reset history search in CLI session
481: *
1.7 misho 482: * @cli_buffer = CLI buffer
1.1 misho 483: * return: none
484: */
1.7 misho 485: void cli_resetHistory(linebuffer_t * __restrict cli_buffer);
1.1 misho 486:
487: /*
1.15 ! misho 488: * cli_freeInput() - Clear entire input
! 489: *
! 490: * @cli_buffer = CLI buffer
! 491: * return: RETCODE_ERR error, RETCODE_OK ok
! 492: */
! 493: int cli_freeInput(linebuffer_t * __restrict cli_buffer);
! 494: /*
1.6 misho 495: * cli_freeLine() - Clear entire line
496: *
1.7 misho 497: * @cli_buffer = CLI buffer
1.3 misho 498: * return: RETCODE_ERR error, RETCODE_OK ok
499: */
1.7 misho 500: int cli_freeLine(linebuffer_t * __restrict cli_buffer);
1.3 misho 501: /*
1.6 misho 502: * cli_setPrompt() - Set new prompt for CLI session
503: *
1.7 misho 504: * @cli_buffer = CLI buffer
1.3 misho 505: * @prompt = new text for prompt or if NULL disable prompt
506: * return: none
1.1 misho 507: */
1.7 misho 508: void cli_setPrompt(linebuffer_t * __restrict cli_buffer, const char *prompt);
1.1 misho 509: /*
1.6 misho 510: * cli_Printf() - Send message to CLI session
511: *
1.7 misho 512: * @cli_buffer = CLI buffer
1.3 misho 513: * @fmt = printf format string
514: * @... = arguments defined in fmt
515: * return: none
1.1 misho 516: */
1.7 misho 517: void cli_Printf(linebuffer_t * __restrict cli_buffer, char *fmt, ...);
1.1 misho 518: /*
1.6 misho 519: * cli_PrintHelp() - Print help screen
520: *
1.7 misho 521: * @cli_buffer = CLI buffer
1.3 misho 522: * return: none
1.1 misho 523: */
1.7 misho 524: void cli_PrintHelp(linebuffer_t * __restrict cli_buffer);
1.1 misho 525:
1.3 misho 526: /*
1.6 misho 527: * cliEnd() - Clear data, Free resources and close CLI session
528: *
1.7 misho 529: * @cli_buffer = CLI buffer
1.3 misho 530: * return: RETCODE_ERR error, RETCODE_OK ok
531: */
1.7 misho 532: void cliEnd(linebuffer_t * __restrict cli_buffer);
1.3 misho 533: /*
1.6 misho 534: * cliInit() - Start CLI session, allocate memory for resources and bind keys
535: *
1.3 misho 536: * @fin = Input device handle
537: * @fout = Output device handle
538: * @prompt = text for prompt, if NULL disable prompt
539: * return: NULL if error or !=NULL CLI buffer
540: */
541: linebuffer_t *cliInit(int fin, int fout, const char *prompt);
1.1 misho 542:
543: /*
1.13 misho 544: * cliSetLine() - Set CLI input line terminal
1.6 misho 545: *
1.7 misho 546: * @cli_buffer = CLI buffer
1.13 misho 547: * @old = Old terminal settings
548: * return: -1 error or 0 ok
549: */
550: int cliSetLine(linebuffer_t * __restrict cli_buffer, struct termios * __restrict old);
551: /*
552: * cliResetLine() - Reset CLI input line terminal
553: *
554: * @cli_buffer = CLI buffer
555: * @old = Original terminal settings
556: * return: -1 error or 0 ok
1.1 misho 557: */
1.13 misho 558: int cliResetLine(linebuffer_t * __restrict cli_buffer, struct termios * __restrict orig);
1.1 misho 559: /*
1.15 ! misho 560: * cliEcho() - Switch echo on or off
! 561: *
! 562: * @cli_buffer = CLI buffer
! 563: * @on = On or off for echo on input handler
! 564: * return: -1 error or 0 ok
! 565: */
! 566: int cliEcho(linebuffer_t * __restrict cli_buffer, int on);
! 567: /*
1.6 misho 568: * cliReadLine() - Read line from opened CLI session
569: *
1.7 misho 570: * @cli_buffer = CLI buffer
1.9 misho 571: * @timeout = Session timeout (-1 infinit)
1.6 misho 572: * return: NULL if error or !=NULL readed line, must be e_free after use!
1.1 misho 573: */
1.10 misho 574: char *cliReadLine(linebuffer_t * __restrict cli_buffer, int timeout);
1.15 ! misho 575: /*
! 576: * cliInputLine() - Input line from opened CLI session
! 577: *
! 578: * @cli_buffer = CLI buffer
! 579: * @timeout = Session timeout (-1 infinit)
! 580: * return: NULL if error or !=NULL readed line, must be e_free after use!
! 581: */
! 582: char *cliInputLine(linebuffer_t * __restrict cli_buffer, int timeout);
1.12 misho 583:
584: /*
585: * cliRun() - CLI run command line
586: *
587: * @cli_buffer = CLI buffer
588: * @psInput = Input command line
589: * @prompt = Display prompt after command
590: * return: RETCODE_ERR error, RETCODE_OK ok
591: */
592: int cliRun(linebuffer_t * __restrict cli_buffer, char *psInput, int prompt);
1.1 misho 593:
594: /*
1.6 misho 595: * cliLoop() - CLI main loop
596: *
1.7 misho 597: * @cli_buffer = CLI buffer
1.3 misho 598: * @csHistFile = History file name
1.9 misho 599: * @timeout = Session timeout (-1 infinit)
1.3 misho 600: * return: RETCODE_ERR error, RETCODE_OK ok
1.1 misho 601: */
1.10 misho 602: int cliLoop(linebuffer_t * __restrict cli_buffer, const char *csHistFile, int timeout);
1.1 misho 603: /*
1.6 misho 604: * cliNetLoop() - CLI network main loop binded to socket
605: *
1.7 misho 606: * @cli_buffer = CLI buffer
1.3 misho 607: * @csHistFile = History file name
608: * @sock = client socket
1.9 misho 609: * @timeout = Session timeout (-1 infinit)
1.3 misho 610: * return: RETCODE_ERR error, RETCODE_OK ok
1.1 misho 611: */
1.9 misho 612: int cliNetLoop(linebuffer_t * __restrict cli_buffer, const char *csHistFile,
1.10 misho 613: int sock, int timeout);
614: #define cliKillLoop(_x) (assert((_x)), (_x)->line_kill = 1)
1.1 misho 615:
1.14 misho 616: #ifdef __cplusplus
617: }
618: #endif
1.1 misho 619:
620: #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