Diff for /libaitcli/src/cli.c between versions 1.1 and 1.9

version 1.1, 2010/04/16 13:20:29 version 1.9, 2013/11/20 16:26:51
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, 2013
         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.
 */
 #include "global.h"  #include "global.h"
   
   
 /*  /*
 * cli_Cmd_Exit() Builtin helper function for Exit from Cli * cli_Cmd_Exit() - Builtin helper function for Exit from Cli
 * @cmds = Commands list *
 * @idx = Selected command ID * @cli_buffer = CLI buffer
 * @out = Output handle * @idx = Config level
  * @args = Parsed arguments array   * @args = Parsed arguments array
 * return: 1 exit from Cli! * return: RETCODE_EOF exit from Cli!
 */  */
int cli_Cmd_Exit(void *cmds, int idx, FILE *out, char ** __restrict args)int
 cli_Cmd_Exit(void * __restrict cli_buffer, int idx, char ** __restrict args)
 {  {
        return 1;        cli_Printf(cli_buffer, "\n");
         return RETCODE_EOF;
 }  }
   
 /*  /*
 * cli_Cmd_Help() Builtin helper function for Help screen * cli_Cmd_Help() - Builtin helper function for Help screen
 * @cmds = Commands list *
 * @idx = Selected command ID * @cli_buffer = CLI buffer
 * @out = Output handle * @idx = Config level
  * @args = Parsed arguments array   * @args = Parsed arguments array
 * return: -1 error, 0 = ok * return: RETCODE_ERR in error or RETCODE_OK
 */  */
int cli_Cmd_Help(void *cmds, int idx, FILE *out, char ** __restrict args)int
 cli_Cmd_Help(void * __restrict cli_buffer, int idx, char ** __restrict args)
 {  {
        register int i;        linebuffer_t *buf = cli_buffer;
        cliCommands_t *commands = cmds;        struct tagCommand *cmd;
   
        if (!cmds)        if (!cli_buffer) {
                return -1;                cli_SetErr(EINVAL, "Invalid input parameters ...");
                 return RETCODE_ERR;
         }
   
           cli_Printf(buf, "\n");
         if (!args) {          if (!args) {
                cli_Printf(out, "\n");                SLIST_FOREACH(cmd, &buf->line_cmds, cmd_next) {
                for (i = 0; commands[i].cmd_name; i++)                        if (!(cmd->cmd_level & (1 << idx)))
                        cli_Printf(out, "%s\t\t%s\n", commands[i].cmd_name, commands[i].cmd_doc);                                continue;
 
                         cli_Printf(buf, "%s\t\t%s\n", cmd->cmd_name, cmd->cmd_help);
                 }
         } else {          } else {
                 if (!args[1])                  if (!args[1])
                        cli_Printf(out, "Help screen::\n");                        cli_Printf(buf, "Help screen::\n");
                 else                  else
                         if (!strncmp(args[1], "---", 3))                          if (!strncmp(args[1], "---", 3))
                                return 0;                                return RETCODE_OK;
   
                for (i = 0; commands[i].cmd_name; i++) {                SLIST_FOREACH(cmd, &buf->line_cmds, cmd_next) {
                        if (args[1] && strcmp(args[1], commands[i].cmd_name))                        if (!(cmd->cmd_level & (1 << idx)))
                                 continue;                                  continue;
                           if (args[1] && (!(cmd->cmd_level & (1 << idx)) || 
                                                   strcmp(args[1], cmd->cmd_name)))
                                   continue;
   
                        cli_Printf(out, "%s%s\t\t%s\n", args[1] ? "Syntax::\n\t" : "", commands[i].cmd_name,                         cli_Printf(buf, "%s%s\t\t%s\n", args[1] ? "Syntax::\n\t" : "", cmd->cmd_name, 
                                        args[1] ? commands[i].cmd_help : commands[i].cmd_doc);                                        args[1] ? cmd->cmd_info: cmd->cmd_help);
                 }                  }
         }          }
           cli_Printf(cli_buffer, "\r");
   
        return 0;        return RETCODE_OK;
 }  }
   
 /*  /*
 * cli_Cmd_Unsupported() Builtin helper function for unsupported commands * cli_Cmd_Unsupported() - Builtin helper function for unsupported commands
 * @cmds = Commands list *
 * @idx = Selected command ID * @cli_buffer = CLI buffer
 * @out = Output handle * @idx = Config level
  * @args = Parsed arguments array   * @args = Parsed arguments array
 * return: -1 error, 0 = ok, 1 exit from Cli! * return: RETCODE_OK ok
 */  */
int cli_Cmd_Unsupported(void *cmds, int idx, FILE *out, char ** __restrict args)int
 cli_Cmd_Unsupported(void * __restrict cli_buffer, int idx, char ** __restrict args)
 {  {
        cli_Printf(out, "Command %s not supported in this version ...\n", args[0]);        cli_Printf(cli_buffer, "Command %s not supported in this version ...\n", args[0]);
        return 0;        return RETCODE_OK;
 }  }
   
 // ------------------------------------------------------------  
   
 /*  /*
 * cli_Comp_Filename() Builtin helper function for filename completion arguments * cli_Cmd_Config() - Builtin helper function for enter into config level from Cli
 * @text = Text line *
 * @state = Position state * @cli_buffer = CLI buffer
 * return: NULL not found filename, != NULL filename * @idx = Config level
  * @args = Parsed arguments array
  * return: RETCODE_ERR in error or RETCODE_OK
 */  */
char *cli_Comp_Filename(const char *text, int state)int
 cli_Cmd_Config(void * __restrict cli_buffer, int idx, char ** __restrict args)
 {  {
        return rl_filename_completion_function(text, state);        linebuffer_t *buf = cli_buffer;
 
         if (idx == sizeof idx * 8 - 1)
                 return RETCODE_ERR;
 
         buf->line_level++;
         cli_Printf(buf, "Enter to config level %d\n", buf->line_level);
         return RETCODE_OK;
 }  }
   
   /*
    * cli_Cmd_End() - Builtin helper function for end config level from Cli
    *
    * @cli_buffer = CLI buffer
    * @idx = Config level
    * @args = Parsed arguments array
    * return: RETCODE_EOF in level 0 or RETCODE_OK
   */
   int
   cli_Cmd_End(void * __restrict cli_buffer, int idx, char ** __restrict args)
   {
           linebuffer_t *buf = cli_buffer;
   
// ------------------------------------------------------------        if (!idx)
                 return cli_Cmd_Exit(cli_buffer, idx, args);
   
           buf->line_level--;
           cli_Printf(buf, "Enter to config level %d\n", buf->line_level);
           return RETCODE_OK;
   }
   
 /*  /*
 * cli_PrintHelp() Helper print for missing command arguments * cli_Cmd_Top() - Builtin helper function for top level of Cli
 * @out = Output stream *
 * @cmds = Commands list * @cli_buffer = CLI buffer
 * @idx = Selected command ID * @idx = Config level
 * return: -1 error, !=-1 ok * @args = Parsed arguments array
 * return: none * return: RETCODE_OK ok
 */  */
inline int cli_PrintHelp(FILE *out, void *cmds, int idx)int
 cli_Cmd_Top(void * __restrict cli_buffer, int idx, char ** __restrict args)
 {  {
        cliCommands_t *c = cmds;        linebuffer_t *buf = cli_buffer;
   
        return cli_Printf(out, "%s\n", c[idx].cmd_help);        buf->line_level ^= buf->line_level;
         cli_Printf(buf, "Enter to top config level %d\n", buf->line_level);
         return RETCODE_OK;
 }  }
   
   /*
    * cli_Cmd_WhereAmI() - Builtin helper function for query level of Cli
    *
    * @cli_buffer = CLI buffer
    * @idx = Config level
    * @args = Parsed arguments array
    * return: RETCODE_OK ok
   */
   int
   cli_Cmd_WhereAmI(void * __restrict cli_buffer, int idx, char ** __restrict args)
   {
           linebuffer_t *buf = cli_buffer;
   
           cli_Printf(buf, "Current config level is %d\n", buf->line_level);
           return RETCODE_OK;
   }

Removed from v.1.1  
changed lines
  Added in v.1.9


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