File:  [ELWIX - Embedded LightWeight unIX -] / libaitcli / inc / aitcli.h
Revision 1.12: download - view: text, annotated - select for diffs - revision graph
Tue Sep 1 23:19:54 2020 UTC (3 years, 9 months ago) by misho
Branches: MAIN
CVS tags: cli4_3, HEAD, CLI4_2
ver 4.2

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

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