1: /*************************************************************************
2: * (C) 2010 AITNET ltd - Sofia/Bulgaria - <misho@aitbg.com>
3: * by Michael Pounov <misho@openbsd-bg.org>
4: *
5: * $Author: misho $
6: * $Id: aitcli.h,v 1.6 2013/05/30 09:16:42 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, 2012, 2013
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 __AITCLI_H
47: #define __AITCLI_H
48:
49:
50: #include <termios.h>
51: #include <sys/queue.h>
52:
53:
54: #ifndef STRSIZ
55: #define STRSIZ 256
56: #endif
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 {
189: int hist_len;
190: char hist_line[BUFSIZ];
191:
192: TAILQ_ENTRY(tagHistory) hist_next;
193: };
194: typedef TAILQ_HEAD(tqHistoryHead, tagHistory) history_t;
195:
196: /* Bind keys structure types */
197:
198: typedef int (*bindkey_func_t)(int idx, /*linebuffer_t **/ void * __restrict buffer);
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:
208: typedef int (*cmd_func_t)(/*linebuffer_t **/ void * __restrict buffer, int idx, char ** __restrict args);
209: struct tagCommand {
210: int cmd_level;
211:
212: int cmd_len;
213: char cmd_name[STRSIZ];
214:
215: char cmd_info[STRSIZ];
216: char cmd_help[STRSIZ];
217:
218: cmd_func_t cmd_func;
219:
220: SLIST_ENTRY(tagCommand) cmd_next;
221: };
222: typedef SLIST_HEAD(slCommandHead, tagCommand) commands_t;
223:
224:
225: /* Main structure, Buffer for CLI work with thread models ;-) special designed by M.Punov */
226:
227: typedef struct {
228: char line_mode;
229:
230: char *line_prompt;
231:
232: int line_bol;
233: int line_eol;
234: int line_len;
235: char *line_buf;
236:
237: const struct tagHistory *line_h;
238: history_t line_history;
239:
240: bindkey_t *line_keys;
241:
242: int line_level;
243: commands_t line_cmds;
244:
245: int line_in;
246: int line_out;
247: } linebuffer_t;
248:
249:
250: /* Error support functions */
251:
252: // cli_GetErrno() Get error code of last operation
253: int cli_GetErrno();
254: // cli_GetError() Get error text of last operation
255: const char *cli_GetError();
256:
257:
258: /* TELNET support for CLI */
259:
260: #define MAX_SUB_LEN 255
261:
262: struct telnetAttrs {
263: unsigned char ta_cmd;
264: unsigned char ta_opt;
265: unsigned char ta_sublen;
266: unsigned char ta_sub[MAX_SUB_LEN];
267: };
268:
269:
270: #ifndef NDEBUG
271: /*
272: * cli_telnetDumpAttrs() - Telnet debug attributes list, if NDEBUG defined not include
273: *
274: * @attr = attributes list
275: * @nAttr = attributes list size
276: * return: none
277: */
278: void cli_telnetDumpAttrs(struct telnetAttrs *attr, int nAttr);
279: #else
280: extern void cli_telnetDumpAttrs(struct telnetAttrs *, int);
281: #endif
282:
283:
284: /*
285: * cli_telnetRecv() - Telnet receive commands, negotiate with telnet peer
286: *
287: * @sock = socket for communication
288: * @attr = received attributes list, must be free after use, but if NULL receive in binary mode
289: * @nAttr = received attributes list size, if is NULL receive in binary mode
290: * @pdata = received data in supplied buffer
291: * @datLen = buffer pdata size
292: * return: 0 not present data; -1 error:: can`t read; -2 timeout; -3 EOF; >0 number of received bytes
293: */
294: int cli_telnetRecv(int sock, struct telnetAttrs **attr, int *nAttr, void *data, int datLen);
295: /*
296: * cli_telnetSend() - Telnet send commands, negotiate with telnet peer
297: *
298: * @sock = socket for communication
299: * @attr = send attributes list
300: * @nAttr = send attributes list size
301: * @data = data for send
302: * @datLen = data size
303: * @Term = Terminate with GA (Go Ahead), 1 send after data GA command
304: * return: 0 not sended commands; -1 error:: can`t send; >0 number of sended bytes
305: */
306: int cli_telnetSend(int sock, struct telnetAttrs *attr, int nAttr, void *data, int datLen, int Term);
307:
308: /*
309: * cli_telnet_Get_SubOpt() - Telnet get sub option function
310: *
311: * @attr = input attribute
312: * @code = sub-option code for opt
313: * @data = sub-option data
314: * @datLen = data size set max size in input, output return copy size
315: * return: -1 can`t get option; !=-1 option code
316: */
317: int cli_telnet_Get_SubOpt(struct telnetAttrs *attr, unsigned char *code,
318: void *data, unsigned char *datLen);
319: /*
320: * cli_telnet_Set_SubOpt() - Telnet set sub option function
321: *
322: * @attr = output attribute
323: * @opt = attribute option
324: * @code = sub-option code for opt, if 0xff not specified
325: * @data = sub-option data, if NULL not specified
326: * @datLen = data size, if 0 not specified
327: * return: -1 can`t set sub-otion; 0 ok
328: */
329: int cli_telnet_Set_SubOpt(struct telnetAttrs *attr, unsigned char opt, unsigned char code,
330: void *data, unsigned char datLen);
331:
332: /*
333: * cli_telnet_GetCmd() - Telnet get command
334: *
335: * @attr = input attribute
336: * return: -1 can`t get command; !=-1 command <<24 return sublen, <<8 return option, <<0 command
337: */
338: unsigned int cli_telnet_GetCmd(struct telnetAttrs *attr);
339: /*
340: * cli_telnet_SetCmd() - Telnet set command
341: *
342: * @attr = input attribute
343: * @cmd = command
344: * @opt = option, if 0xff not specified
345: * @arg1 = sub-option code, if 0xff not specified
346: * @arg2 = sub-option data, if NULL not specified
347: * @arg3 = sub-option data size, if 0 not specified data
348: * return: -1 can`t set command; !=-1 ok
349: */
350: int cli_telnet_SetCmd(struct telnetAttrs *attr, unsigned char cmd, unsigned char opt, ...);
351:
352: /*
353: * cli_telnet_Answer() - Automatic generate commands answer to send from telnet
354: *
355: * @caps = Array of capability options
356: * @nCaps = number of capability options
357: * @attr = input attribute
358: * @nAttr = number of input attributes
359: * @ans = output answered attributes, must be e_free() after use
360: * @Ans = number of output answered attributes
361: * return: -1 can`t answer; !=-1 ok
362: */
363: int cli_telnet_Answer(unsigned char *caps, int nCaps, struct telnetAttrs *attr, int nAttr,
364: struct telnetAttrs **ans, int *Ans);
365:
366:
367: // Add capability option, x = 0 false, 1 true
368: #define ADD_CAPS(opt, x) ((opt) | (x) ? 0x80 : 0)
369: // Is supported this option ...
370: #define SUP_CAPS(caps) ((caps) & 0x80)
371: // get capability option
372: #define CAP(caps) ((caps) & 0x7f)
373:
374:
375: /* CLI Helper functions */
376:
377: /*
378: * cli_Cmd_Unsupported() - Builtin helper function for unsupported commands
379: *
380: * @buffer = CLI buffer
381: * @idx = Selected command ID
382: * @args = Parsed arguments array
383: * return: RETCODE_OK ok
384: */
385: int cli_Cmd_Unsupported(void * __restrict buffer, int idx, char ** __restrict args);
386:
387:
388: /* CLI Functions */
389:
390: /*
391: * cli_BindKey() - Bind function to key
392: *
393: * @key = key structure
394: * @buffer = CLI buffer
395: * return: RETCODE_ERR error, RETCODE_OK ok, >0 bind at position
396: */
397: int cli_BindKey(bindkey_t * __restrict key, linebuffer_t * __restrict buffer);
398:
399:
400: /*
401: * cli_addCommand() - Add command to CLI session
402: *
403: * @buffer = CLI buffer
404: * @csCmd = Command name
405: * @cliLevel = Level in CLI, -1 unprivi(view from all), 0 main config, 1 sub config ...
406: * @funcCmd = Callback function when user call command
407: * @csInfo = Inline information for command
408: * @csHelp = Help line when call help
409: * return: RETCODE_ERR error, RETCODE_OK ok
410: */
411: int
412: cli_addCommand(linebuffer_t * __restrict buffer, const char *csCmd, int cliLevel, cmd_func_t funcCmd,
413: const char *csInfo, const char *csHelp);
414: /*
415: * cli_delCommand() - Delete command from CLI session
416: *
417: * @buffer = CLI buffer
418: * @csCmd = Command name
419: * @cliLevel = Level in CLI, -1 unprivi(view from all), 0 main config, 1 sub config ...
420: * return: RETCODE_ERR error, RETCODE_OK ok
421: */
422: int
423: cli_delCommand(linebuffer_t * __restrict buffer, const char *csCmd, int cliLevel);
424: /*
425: * cli_updCommand() - Update command in CLI session
426: *
427: * @buffer = CLI buffer
428: * @csCmd = Command name
429: * @cliLevel = Level in CLI, -1 unprivi(view from all), 0 main config, 1 sub config ...
430: * @funcCmd = Callback function when user call command
431: * @csInfo = Inline information for command
432: * @csHelp = Help line when call help
433: * return: RETCODE_ERR error, RETCODE_OK ok
434: */
435: int
436: cli_updCommand(linebuffer_t * __restrict buffer, const char *csCmd, int cliLevel, cmd_func_t funcCmd,
437: const char *csInfo, const char *csHelp);
438:
439:
440: /*
441: * cli_addHistory() - Add line to history
442: *
443: * @buffer = CLI buffer
444: * @str = Add custom text or if NULL use readed line from CLI buffer
445: * return: RETCODE_ERR error, RETCODE_OK ok
446: */
447: int cli_addHistory(linebuffer_t * __restrict buffer, const char * __restrict str);
448: /*
449: * cli_saveHistory() - Save history to file
450: *
451: * @buffer = CLI buffer
452: * @histfile = History filename, if NULL will be use default name
453: * @lines = Maximum history lines to save
454: * return: RETCODE_ERR error, RETCODE_OK ok
455: */
456: int cli_saveHistory(linebuffer_t * __restrict buffer, const char *histfile, int lines);
457: /*
458: * cli_loadHistory() - Load history from file
459: *
460: * @buffer = CLI buffer
461: * @histfile = History filename, if NULL will be use default name
462: * return: RETCODE_ERR error, RETCODE_OK ok
463: */
464: int cli_loadHistory(linebuffer_t * __restrict buffer, const char *histfile);
465: /*
466: * cli_resetHistory() - Reset history search in CLI session
467: *
468: * @buffer = CLI buffer
469: * return: none
470: */
471: void cli_resetHistory(linebuffer_t * __restrict buffer);
472:
473: /*
474: * cli_freeLine() - Clear entire line
475: *
476: * @buffer = CLI buffer
477: * return: RETCODE_ERR error, RETCODE_OK ok
478: */
479: int cli_freeLine(linebuffer_t * __restrict buffer);
480: /*
481: * cli_setPrompt() - Set new prompt for CLI session
482: *
483: * @buffer = CLI buffer
484: * @prompt = new text for prompt or if NULL disable prompt
485: * return: none
486: */
487: void cli_setPrompt(linebuffer_t * __restrict buffer, const char *prompt);
488: /*
489: * cli_Printf() - Send message to CLI session
490: *
491: * @buffer = CLI buffer
492: * @fmt = printf format string
493: * @... = arguments defined in fmt
494: * return: none
495: */
496: void cli_Printf(linebuffer_t * __restrict buffer, char *fmt, ...);
497: /*
498: * cli_PrintHelp() - Print help screen
499: *
500: * @buffer = CLI buffer
501: * return: none
502: */
503: void cli_PrintHelp(linebuffer_t * __restrict buffer);
504:
505: /*
506: * cliEnd() - Clear data, Free resources and close CLI session
507: *
508: * @buffer = CLI buffer
509: * return: RETCODE_ERR error, RETCODE_OK ok
510: */
511: void cliEnd(linebuffer_t * __restrict buffer);
512: /*
513: * cliInit() - Start CLI session, allocate memory for resources and bind keys
514: *
515: * @fin = Input device handle
516: * @fout = Output device handle
517: * @prompt = text for prompt, if NULL disable prompt
518: * return: NULL if error or !=NULL CLI buffer
519: */
520: linebuffer_t *cliInit(int fin, int fout, const char *prompt);
521:
522: /*
523: * cliInitLine() - Init CLI input line terminal
524: *
525: * @buffer = CLI buffer
526: * return: none
527: */
528: int cliInitLine(linebuffer_t * __restrict buffer);
529: /*
530: * cliReadLine() - Read line from opened CLI session
531: *
532: * @buffer = CLI buffer
533: * return: NULL if error or !=NULL readed line, must be e_free after use!
534: */
535: char *cliReadLine(linebuffer_t * __restrict buffer);
536:
537: /*
538: * cliLoop() - CLI main loop
539: *
540: * @buffer = CLI buffer
541: * @csHistFile = History file name
542: * return: RETCODE_ERR error, RETCODE_OK ok
543: */
544: int cliLoop(linebuffer_t * __restrict buffer, const char *csHistFile);
545: /*
546: * cliNetLoop() - CLI network main loop binded to socket
547: *
548: * @buffer = CLI buffer
549: * @csHistFile = History file name
550: * @sock = client socket
551: * @term = stdin termios
552: * @win = window size of tty
553: * return: RETCODE_ERR error, RETCODE_OK ok
554: */
555: int cliNetLoop(linebuffer_t * __restrict buffer, const char *csHistFile, int sock);
556:
557:
558: #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