Annotation of libaitcli/inc/aitcli.h, revision 1.5

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.5     ! misho       6: * $Id: aitcli.h,v 1.4.2.2 2012/07/22 22:36:21 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.5     ! misho      15: Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
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 {
                    189:        int             hist_len;
                    190:        char            hist_line[BUFSIZ];
                    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: 
                    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 */
1.1       misho     226: 
1.3       misho     227: typedef struct {
                    228:        char                    line_mode;
1.1       misho     229: 
1.3       misho     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 */
1.1       misho     251: 
                    252: // cli_GetErrno() Get error code of last operation
                    253: inline int cli_GetErrno();
                    254: // cli_GetError() Get error text of last operation
                    255: inline const char *cli_GetError();
                    256: 
1.3       misho     257: 
1.4       misho     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:  * @attr = attributes list
                    274:  * @nAttr = attributes list size
                    275:  * return: none
                    276: */
                    277: void cli_telnetDumpAttrs(struct telnetAttrs *attr, int nAttr);
                    278: #else
                    279: extern void cli_telnetDumpAttrs(struct telnetAttrs *, int);
                    280: #endif
                    281: 
                    282: 
                    283: /*
                    284:  * cli_telnetRecv() Telnet receive commands, negotiate with telnet peer
                    285:  * @sock = socket for communication
                    286:  * @attr = received attributes list, must be free after use, but if NULL receive in binary mode
                    287:  * @nAttr = received attributes list size, if is NULL receive in binary mode
                    288:  * @pdata = received data in supplied buffer
                    289:  * @datLen = buffer pdata size
                    290:  * return: 0 not present data; -1 error:: can`t read; -2 timeout; -3 EOF; >0 number of received bytes
                    291: */
                    292: int cli_telnetRecv(int sock, struct telnetAttrs **attr, int *nAttr, void *data, int datLen);
                    293: /*
                    294:  * cli_telnetSend() Telnet send commands, negotiate with telnet peer
                    295:  * @sock = socket for communication
                    296:  * @attr = send attributes list
                    297:  * @nAttr = send attributes list size
                    298:  * @data = data for send
                    299:  * @datLen = data size
                    300:  * @Term = Terminate with GA (Go Ahead), 1 send after data GA command
                    301:  * return: 0 not sended commands; -1 error:: can`t send; >0 number of sended bytes
                    302: */
                    303: int cli_telnetSend(int sock, struct telnetAttrs *attr, int nAttr, void *data, int datLen, int Term);
                    304: 
                    305: /*
                    306:  * cli_telnet_Get_SubOpt() Telnet get sub option function
                    307:  * @attr = input attribute
                    308:  * @code = sub-option code for opt
                    309:  * @data = sub-option data
                    310:  * @datLen = data size set max size in input, output return copy size
                    311:  * return: -1 can`t get option; !=-1 option code
                    312: */
                    313: inline int cli_telnet_Get_SubOpt(struct telnetAttrs *attr, unsigned char *code, 
                    314:                void *data, unsigned char *datLen);
                    315: /*
                    316:  * cli_telnet_Set_SubOpt() Telnet set sub option function
                    317:  * @attr = output attribute
                    318:  * @opt = attribute option
                    319:  * @code = sub-option code for opt, if 0xff not specified
                    320:  * @data = sub-option data, if NULL not specified
                    321:  * @datLen = data size, if 0 not specified
                    322:  * return: -1 can`t set sub-otion; 0 ok
                    323: */
                    324: inline int cli_telnet_Set_SubOpt(struct telnetAttrs *attr, unsigned char opt, unsigned char code, 
                    325:                void *data, unsigned char datLen);
                    326: 
                    327: /*
                    328:  * cli_telnet_GetCmd() Telnet get command
                    329:  * @attr = input attribute
                    330:  * return: -1 can`t get command; !=-1 command <<24 return sublen, <<8 return option, <<0 command
                    331: */
                    332: inline unsigned int cli_telnet_GetCmd(struct telnetAttrs *attr);
                    333: /*
                    334:  * cli_telnet_SetCmd() Telnet set command
                    335:  * @attr = input attribute
                    336:  * @cmd = command
                    337:  * @opt = option, if 0xff not specified
                    338:  * @arg1 = sub-option code, if 0xff not specified
                    339:  * @arg2 = sub-option data, if NULL not specified
                    340:  * @arg3 = sub-option data size, if 0 not specified data
                    341:  * return: -1 can`t set command; !=-1 ok
                    342: */
                    343: inline int cli_telnet_SetCmd(struct telnetAttrs *attr, unsigned char cmd, unsigned char opt, ...);
                    344: 
                    345: /*
                    346:  * cli_telnet_Answer() Automatic generate commands answer to send from telnet
                    347:  * @caps = Array of capability options
                    348:  * @nCaps = number of capability options
                    349:  * @attr = input attribute
                    350:  * @nAttr = number of input attributes
1.5     ! misho     351:  * @ans = output answered attributes, must be io_free() after use
1.4       misho     352:  * @Ans = number of output answered attributes
                    353:  * return: -1 can`t answer; !=-1 ok
                    354: */
                    355: int cli_telnet_Answer(unsigned char *caps, int nCaps, struct telnetAttrs *attr, int nAttr, 
                    356:                struct telnetAttrs **ans, int *Ans);
                    357: 
                    358: 
                    359: // Add capability option, x = 0 false, 1 true
                    360: #define ADD_CAPS(opt, x)       ((opt) | (x) ? 0x80 : 0)
                    361: // Is supported this option ...
                    362: #define SUP_CAPS(caps)         ((caps) & 0x80)
                    363: // get capability option
                    364: #define CAP(caps)              ((caps) & 0x7f)
                    365: 
                    366: 
1.3       misho     367: /* CLI Helper functions */
                    368: 
                    369: /*
                    370:  * cli_Cmd_Unsupported() Builtin helper function for unsupported commands
                    371:  * @buffer = CLI buffer
                    372:  * @idx = Selected command ID
                    373:  * @args = Parsed arguments array
                    374:  * return: RETCODE_OK ok
                    375: */
                    376: int cli_Cmd_Unsupported(void * __restrict buffer, int idx, char ** __restrict args);
                    377: 
                    378: 
                    379: /* CLI Functions */
                    380: 
1.1       misho     381: /*
1.3       misho     382:  * cli_BindKey() Bind function to key
                    383:  * @key = key structure
                    384:  * @buffer = CLI buffer
                    385:  * return: RETCODE_ERR error, RETCODE_OK ok, >0 bind at position
1.1       misho     386: */
1.3       misho     387: int cli_BindKey(bindkey_t * __restrict key, linebuffer_t * __restrict buffer);
                    388: 
1.1       misho     389: 
                    390: /*
1.3       misho     391:  * cli_addCommand() Add command to CLI session
                    392:  * @buffer = CLI buffer
                    393:  * @csCmd = Command name
                    394:  * @cliLevel = Level in CLI, -1 unprivi(view from all), 0 main config, 1 sub config ...
                    395:  * @funcCmd = Callback function when user call command
                    396:  * @csInfo = Inline information for command
                    397:  * @csHelp = Help line when call help
                    398:  * return: RETCODE_ERR error, RETCODE_OK ok
1.2       misho     399: */
1.3       misho     400: int
                    401: cli_addCommand(linebuffer_t * __restrict buffer, const char *csCmd, int cliLevel, cmd_func_t funcCmd, 
                    402:                const char *csInfo, const char *csHelp);
1.2       misho     403: /*
1.3       misho     404:  * cli_delCommand() Delete command from CLI session
                    405:  * @buffer = CLI buffer
                    406:  * @csCmd = Command name
                    407:  * @cliLevel = Level in CLI, -1 unprivi(view from all), 0 main config, 1 sub config ...
                    408:  * return: RETCODE_ERR error, RETCODE_OK ok
1.1       misho     409: */
1.3       misho     410: int
                    411: cli_delCommand(linebuffer_t * __restrict buffer, const char *csCmd, int cliLevel);
1.1       misho     412: /*
1.3       misho     413:  * cli_updCommand() Update command in CLI session
                    414:  * @buffer = CLI buffer
                    415:  * @csCmd = Command name
                    416:  * @cliLevel = Level in CLI, -1 unprivi(view from all), 0 main config, 1 sub config ...
                    417:  * @funcCmd = Callback function when user call command
                    418:  * @csInfo = Inline information for command
                    419:  * @csHelp = Help line when call help
                    420:  * return: RETCODE_ERR error, RETCODE_OK ok
1.2       misho     421: */
1.3       misho     422: int
                    423: cli_updCommand(linebuffer_t * __restrict buffer, const char *csCmd, int cliLevel, cmd_func_t funcCmd, 
                    424:                const char *csInfo, const char *csHelp);
                    425: 
1.2       misho     426: 
                    427: /*
1.3       misho     428:  * cli_addHistory() Add line to history
                    429:  * @buffer = CLI buffer
                    430:  * @str = Add custom text or if NULL use readed line from CLI buffer
                    431:  * return: RETCODE_ERR error, RETCODE_OK ok
1.2       misho     432: */
1.3       misho     433: int cli_addHistory(linebuffer_t * __restrict buffer, const char * __restrict str);
1.2       misho     434: /*
1.3       misho     435:  * cli_saveHistory() Save history to file
                    436:  * @buffer = CLI buffer
                    437:  * @histfile = History filename, if NULL will be use default name
                    438:  * @lines = Maximum history lines to save
                    439:  * return: RETCODE_ERR error, RETCODE_OK ok
1.2       misho     440: */
1.3       misho     441: int cli_saveHistory(linebuffer_t * __restrict buffer, const char *histfile, int lines);
                    442: /*
                    443:  * cli_loadHistory() Load history from file
                    444:  * @buffer = CLI buffer
                    445:  * @histfile = History filename, if NULL will be use default name
                    446:  * return: RETCODE_ERR error, RETCODE_OK ok
                    447: */
                    448: int cli_loadHistory(linebuffer_t * __restrict buffer, const char *histfile);
1.1       misho     449: /*
1.3       misho     450:  * cli_resetHistory() Reset history search in CLI session
                    451:  * @buffer = CLI buffer
1.1       misho     452:  * return: none
                    453: */
1.3       misho     454: inline void cli_resetHistory(linebuffer_t * __restrict buffer);
1.1       misho     455: 
                    456: /*
1.3       misho     457:  * cli_freeLine() Clear entire line
                    458:  * @buffer = CLI buffer
                    459:  * return: RETCODE_ERR error, RETCODE_OK ok
                    460: */
                    461: inline int cli_freeLine(linebuffer_t * __restrict buffer);
                    462: /*
                    463:  * cli_setPrompt() Set new prompt for CLI session
                    464:  * @buffer = CLI buffer
                    465:  * @prompt = new text for prompt or if NULL disable prompt
                    466:  * return: none
1.1       misho     467: */
1.3       misho     468: inline void cli_setPrompt(linebuffer_t * __restrict buffer, const char *prompt);
1.1       misho     469: /*
1.3       misho     470:  * cli_Printf() Send message to CLI session
                    471:  * @buffer = CLI buffer
                    472:  * @fmt = printf format string
                    473:  * @... = arguments defined in fmt
                    474:  * return: none
1.1       misho     475: */
1.3       misho     476: inline void cli_Printf(linebuffer_t * __restrict buffer, char *fmt, ...);
1.1       misho     477: /*
1.3       misho     478:  * cli_PrintHelp() Print help screen
                    479:  * @buffer = CLI buffer
                    480:  * return: none
1.1       misho     481: */
1.3       misho     482: inline void cli_PrintHelp(linebuffer_t * __restrict buffer);
1.1       misho     483: 
1.3       misho     484: /*
                    485:  * cliEnd() Clear data, Free resources and close CLI session
                    486:  * @buffer = CLI buffer
                    487:  * return: RETCODE_ERR error, RETCODE_OK ok
                    488: */
                    489: void cliEnd(linebuffer_t * __restrict buffer);
                    490: /*
                    491:  * cliInit() Start CLI session, allocate memory for resources and bind keys
                    492:  * @fin = Input device handle
                    493:  * @fout = Output device handle
                    494:  * @prompt = text for prompt, if NULL disable prompt
                    495:  * return: NULL if error or !=NULL CLI buffer
                    496: */
                    497: linebuffer_t *cliInit(int fin, int fout, const char *prompt);
1.1       misho     498: 
                    499: /*
1.3       misho     500:  * cliInitLine() Init CLI input line terminal
                    501:  * @buffer = CLI buffer
                    502:  * return: none
1.1       misho     503: */
1.3       misho     504: int cliInitLine(linebuffer_t * __restrict buffer);
1.1       misho     505: /*
1.3       misho     506:  * cliReadLine() Read line from opened CLI session
                    507:  * @buffer = CLI buffer
1.5     ! misho     508:  * return: NULL if error or !=NULL readed line, must be io_free after use!
1.1       misho     509: */
1.3       misho     510: char *cliReadLine(linebuffer_t * __restrict buffer);
1.1       misho     511: 
                    512: /*
1.3       misho     513:  * cliLoop() CLI main loop
                    514:  * @buffer = CLI buffer
                    515:  * @csHistFile = History file name
                    516:  * return: RETCODE_ERR error, RETCODE_OK ok
1.1       misho     517: */
1.3       misho     518: int cliLoop(linebuffer_t * __restrict buffer, const char *csHistFile);
1.1       misho     519: /*
1.3       misho     520:  * cliNetLoop() CLI network main loop binded to socket
                    521:  * @buffer = CLI buffer
                    522:  * @csHistFile = History file name
                    523:  * @sock = client socket
                    524:  * @term = stdin termios
                    525:  * @win = window size of tty
                    526:  * return: RETCODE_ERR error, RETCODE_OK ok
1.1       misho     527: */
1.3       misho     528: int cliNetLoop(linebuffer_t * __restrict buffer, const char *csHistFile, int sock);
1.1       misho     529: 
                    530: 
                    531: #endif

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