[BACK]Return to aitcli.h CVS log [TXT] [DIR] Up to [ELWIX - Embedded LightWeight unIX -] / libaitcli / inc

Diff for /libaitcli/inc/aitcli.h between versions 1.2.2.4 and 1.5

version 1.2.2.4, 2010/06/04 16:16:17 version 1.5, 2012/07/22 22:37:08
Line 5 Line 5
 * $Author$  * $Author$
 * $Id$  * $Id$
 *  *
*************************************************************************/**************************************************************************
 The ELWIX and AITNET software is distributed under the following
 terms:
 
 All of the documentation and software included in the ELWIX and AITNET
 Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>
 
 Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
         by Michael Pounov <misho@elwix.org>.  All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
 1. Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
 2. Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.
 3. All advertising materials mentioning features or use of this software
    must display the following acknowledgement:
 This product includes software developed by Michael Pounov <misho@elwix.org>
 ELWIX - Embedded LightWeight unIX and its contributors.
 4. Neither the name of AITNET nor the names of its contributors
    may be used to endorse or promote products derived from this software
    without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 SUCH DAMAGE.
 */
 #ifndef __AITCLI_H  #ifndef __AITCLI_H
 #define __AITCLI_H  #define __AITCLI_H
   
   
   #include <termios.h>
   #include <sys/queue.h>
   
   
   #ifndef STRSIZ
 #define STRSIZ          256  #define STRSIZ          256
   #endif
   
 /* Key definitions */  /* Key definitions */
   
Line 162  typedef struct { Line 205  typedef struct {
   
 /* Commands structure for CLI */  /* Commands structure for CLI */
   
typedef int (*cmd_func_t)(/*linebuffer_t **/ void * __restrict buffer, int argc, char ** __restrict argv);typedef int (*cmd_func_t)(/*linebuffer_t **/ void * __restrict buffer, int idx, char ** __restrict args);
 struct tagCommand {  struct tagCommand {
         int                     cmd_level;          int                     cmd_level;
   
         int                     cmd_min;  
         int                     cmd_len;          int                     cmd_len;
         char                    cmd_name[STRSIZ];          char                    cmd_name[STRSIZ];
   
Line 197  typedef struct { Line 239  typedef struct {
   
         bindkey_t               *line_keys;          bindkey_t               *line_keys;
   
           int                     line_level;
         commands_t              line_cmds;          commands_t              line_cmds;
   
         int                     line_in;          int                     line_in;
Line 212  inline int cli_GetErrno(); Line 255  inline int cli_GetErrno();
 inline const char *cli_GetError();  inline const char *cli_GetError();
   
   
   /* TELNET support for CLI */
   
   #define MAX_SUB_LEN     255
   
   struct telnetAttrs {
           unsigned char ta_cmd;
           unsigned char ta_opt;
           unsigned char ta_sublen;
           unsigned char ta_sub[MAX_SUB_LEN];
   };
   
   
   #ifndef NDEBUG
   /*
    * cli_telnetDumpAttrs() Telnet debug attributes list, if NDEBUG defined not include
    * @attr = attributes list
    * @nAttr = attributes list size
    * return: none
   */
   void cli_telnetDumpAttrs(struct telnetAttrs *attr, int nAttr);
   #else
   extern void cli_telnetDumpAttrs(struct telnetAttrs *, int);
   #endif
   
   
   /*
    * cli_telnetRecv() Telnet receive commands, negotiate with telnet peer
    * @sock = socket for communication
    * @attr = received attributes list, must be free after use, but if NULL receive in binary mode
    * @nAttr = received attributes list size, if is NULL receive in binary mode
    * @pdata = received data in supplied buffer
    * @datLen = buffer pdata size
    * return: 0 not present data; -1 error:: can`t read; -2 timeout; -3 EOF; >0 number of received bytes
   */
   int cli_telnetRecv(int sock, struct telnetAttrs **attr, int *nAttr, void *data, int datLen);
   /*
    * cli_telnetSend() Telnet send commands, negotiate with telnet peer
    * @sock = socket for communication
    * @attr = send attributes list
    * @nAttr = send attributes list size
    * @data = data for send
    * @datLen = data size
    * @Term = Terminate with GA (Go Ahead), 1 send after data GA command
    * return: 0 not sended commands; -1 error:: can`t send; >0 number of sended bytes
   */
   int cli_telnetSend(int sock, struct telnetAttrs *attr, int nAttr, void *data, int datLen, int Term);
   
   /*
    * cli_telnet_Get_SubOpt() Telnet get sub option function
    * @attr = input attribute
    * @code = sub-option code for opt
    * @data = sub-option data
    * @datLen = data size set max size in input, output return copy size
    * return: -1 can`t get option; !=-1 option code
   */
   inline int cli_telnet_Get_SubOpt(struct telnetAttrs *attr, unsigned char *code, 
                   void *data, unsigned char *datLen);
   /*
    * cli_telnet_Set_SubOpt() Telnet set sub option function
    * @attr = output attribute
    * @opt = attribute option
    * @code = sub-option code for opt, if 0xff not specified
    * @data = sub-option data, if NULL not specified
    * @datLen = data size, if 0 not specified
    * return: -1 can`t set sub-otion; 0 ok
   */
   inline int cli_telnet_Set_SubOpt(struct telnetAttrs *attr, unsigned char opt, unsigned char code, 
                   void *data, unsigned char datLen);
   
   /*
    * cli_telnet_GetCmd() Telnet get command
    * @attr = input attribute
    * return: -1 can`t get command; !=-1 command <<24 return sublen, <<8 return option, <<0 command
   */
   inline unsigned int cli_telnet_GetCmd(struct telnetAttrs *attr);
   /*
    * cli_telnet_SetCmd() Telnet set command
    * @attr = input attribute
    * @cmd = command
    * @opt = option, if 0xff not specified
    * @arg1 = sub-option code, if 0xff not specified
    * @arg2 = sub-option data, if NULL not specified
    * @arg3 = sub-option data size, if 0 not specified data
    * return: -1 can`t set command; !=-1 ok
   */
   inline int cli_telnet_SetCmd(struct telnetAttrs *attr, unsigned char cmd, unsigned char opt, ...);
   
   /*
    * cli_telnet_Answer() Automatic generate commands answer to send from telnet
    * @caps = Array of capability options
    * @nCaps = number of capability options
    * @attr = input attribute
    * @nAttr = number of input attributes
    * @ans = output answered attributes, must be io_free() after use
    * @Ans = number of output answered attributes
    * return: -1 can`t answer; !=-1 ok
   */
   int cli_telnet_Answer(unsigned char *caps, int nCaps, struct telnetAttrs *attr, int nAttr, 
                   struct telnetAttrs **ans, int *Ans);
   
   
   // Add capability option, x = 0 false, 1 true
   #define ADD_CAPS(opt, x)        ((opt) | (x) ? 0x80 : 0)
   // Is supported this option ...
   #define SUP_CAPS(caps)          ((caps) & 0x80)
   // get capability option
   #define CAP(caps)               ((caps) & 0x7f)
   
   
   /* CLI Helper functions */
   
   /*
    * cli_Cmd_Unsupported() Builtin helper function for unsupported commands
    * @buffer = CLI buffer
    * @idx = Selected command ID
    * @args = Parsed arguments array
    * return: RETCODE_OK ok
   */
   int cli_Cmd_Unsupported(void * __restrict buffer, int idx, char ** __restrict args);
   
   
 /* CLI Functions */  /* CLI Functions */
   
 /*  /*
Line 222  inline const char *cli_GetError(); Line 386  inline const char *cli_GetError();
 */  */
 int cli_BindKey(bindkey_t * __restrict key, linebuffer_t * __restrict buffer);  int cli_BindKey(bindkey_t * __restrict key, linebuffer_t * __restrict buffer);
   
   
 /*  /*
    * cli_addCommand() Add command to CLI session
    * @buffer = CLI buffer
    * @csCmd = Command name
    * @cliLevel = Level in CLI, -1 unprivi(view from all), 0 main config, 1 sub config ...
    * @funcCmd = Callback function when user call command
    * @csInfo = Inline information for command
    * @csHelp = Help line when call help
    * return: RETCODE_ERR error, RETCODE_OK ok
   */
   int
   cli_addCommand(linebuffer_t * __restrict buffer, const char *csCmd, int cliLevel, cmd_func_t funcCmd, 
                   const char *csInfo, const char *csHelp);
   /*
    * cli_delCommand() Delete command from CLI session
    * @buffer = CLI buffer
    * @csCmd = Command name
    * @cliLevel = Level in CLI, -1 unprivi(view from all), 0 main config, 1 sub config ...
    * return: RETCODE_ERR error, RETCODE_OK ok
   */
   int
   cli_delCommand(linebuffer_t * __restrict buffer, const char *csCmd, int cliLevel);
   /*
    * cli_updCommand() Update command in CLI session
    * @buffer = CLI buffer
    * @csCmd = Command name
    * @cliLevel = Level in CLI, -1 unprivi(view from all), 0 main config, 1 sub config ...
    * @funcCmd = Callback function when user call command
    * @csInfo = Inline information for command
    * @csHelp = Help line when call help
    * return: RETCODE_ERR error, RETCODE_OK ok
   */
   int
   cli_updCommand(linebuffer_t * __restrict buffer, const char *csCmd, int cliLevel, cmd_func_t funcCmd, 
                   const char *csInfo, const char *csHelp);
   
   
   /*
  * cli_addHistory() Add line to history   * cli_addHistory() Add line to history
  * @buffer = CLI buffer   * @buffer = CLI buffer
  * @str = Add custom text or if NULL use readed line from CLI buffer   * @str = Add custom text or if NULL use readed line from CLI buffer
Line 272  inline void cli_setPrompt(linebuffer_t * __restrict bu Line 474  inline void cli_setPrompt(linebuffer_t * __restrict bu
  * return: none   * return: none
 */  */
 inline void cli_Printf(linebuffer_t * __restrict buffer, char *fmt, ...);  inline void cli_Printf(linebuffer_t * __restrict buffer, char *fmt, ...);
   /*
    * cli_PrintHelp() Print help screen
    * @buffer = CLI buffer
    * return: none
   */
   inline void cli_PrintHelp(linebuffer_t * __restrict buffer);
   
 /*  /*
  * cliEnd() Clear data, Free resources and close CLI session   * cliEnd() Clear data, Free resources and close CLI session
Line 289  void cliEnd(linebuffer_t * __restrict buffer); Line 497  void cliEnd(linebuffer_t * __restrict buffer);
 linebuffer_t *cliInit(int fin, int fout, const char *prompt);  linebuffer_t *cliInit(int fin, int fout, const char *prompt);
   
 /*  /*
 * cliReadLine() Read line from opened CLI session * cliInitLine() Init CLI input line terminal
  * @buffer = CLI buffer   * @buffer = CLI buffer
 * return: NULL if error or !=NULL readed line, must be free after use! * return: none
 */  */
char *cliReadLine(linebuffer_t * __restrict buffer);int cliInitLine(linebuffer_t * __restrict buffer);
 /*  /*
 * cliLoop() CLI main loop * cliReadLine() Read line from opened CLI session
  * @buffer = CLI buffer   * @buffer = CLI buffer
 * @csHistFile = History file name * return: NULL if error or !=NULL readed line, must be io_free after use!
 * return: RETCODE_ERR error, RETCODE_OK ok 
 */  */
int cliLoop(linebuffer_t * __restrict buffer, const char *csHistFile);char *cliReadLine(linebuffer_t * __restrict buffer);
   
 /*  /*
  * cliLoop() CLI main loop   * cliLoop() CLI main loop
Line 318  int cliLoop(linebuffer_t * __restrict buffer, const ch Line 525  int cliLoop(linebuffer_t * __restrict buffer, const ch
  * @win = window size of tty   * @win = window size of tty
  * return: RETCODE_ERR error, RETCODE_OK ok   * return: RETCODE_ERR error, RETCODE_OK ok
 */  */
int cliNetLoop(linebuffer_t * __restrict buffer, const char *csHistFile, int sock, int cliNetLoop(linebuffer_t * __restrict buffer, const char *csHistFile, int sock);
                struct termios *term, struct winsize *win); 
 
 
/* CLI Helper functions */ 
 
/* 
 * cli_Cmd_Unsupported() Builtin helper function for unsupported commands 
 * @cmds = Commands list 
 * @idx = Selected command ID 
 * @out = Output handle 
 * @args = Parsed arguments array 
 * return: -1 error, 0 = ok, 1 exit from Cli! 
*/ 
int cli_Cmd_Unsupported(void *cmds, int idx, FILE *out, char ** __restrict args); 
/* 
 * cli_Cmd_Help() Builtin helper function for Help screen 
 * @cmds = Commands list 
 * @idx = Selected command ID 
 * @out = Output handle 
 * @args = Parsed arguments array 
 * return: -1 error, 0 = ok 
*/ 
int cli_Cmd_Help(void *cmds, int idx, FILE *out, char ** __restrict args); 
/* 
 * cli_Cmd_Exit() Builtin helper function for Exit from Cli 
 * @cmds = Commands list 
 * @idx = Selected command ID 
 * @out = Output handle 
 * @args = Parsed arguments array 
 * return: 1 exit from Cli! 
*/ 
int cli_Cmd_Exit(void *cmds, int idx, FILE *out, char ** __restrict args); 
 
 
/* 
 * cli_Register_Commands - Declare helper function for register and export Commands variable 
*/ 
#define CLI_REGISTER_COMMANDS(CMDS)     \ 
        extern commands_t CMDS[]; 
/* 
 * cli_Make_Comp_Commands - Declare helper function for Commands completion arguments 
*/ 
#define CLI_MAKE_COMP_COMMANDS(FUNC, CMDS)      \ 
        char *FUNC(const char *text, int state) \ 
        { \ 
                register int i; \ 
                int len = strlen(text); \ 
                for (i = state; CMDS[i].cmd_name; i++) { \ 
                        if (strncmp(CMDS[i].cmd_name, "---", 3) && \ 
                                        !strncmp(CMDS[i].cmd_name, text, len)) \ 
                                return strdup(CMDS[i].cmd_name); \ 
                } \ 
                return NULL; \ 
        } 
 
/* 
 * cli_Make_Comp_Args - Declare helper function for Arguments completion 
*/ 
#define CLI_MAKE_COMP_ARGS(FUNC, ARGS)  \ 
        char *FUNC(const char *text __attribute__((unused)), int state) \ 
        { \ 
                while (ARGS[state]) \ 
                        return strdup(ARGS[state]); \ 
                return NULL; \ 
        } 
   
   
 #endif  #endif
Removed from v.1.2.2.4  
changed lines
  Added in v.1.5

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