Annotation of libaitcli/src/cli.c, revision 1.6.4.4

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.6.4.4 ! misho       6: * $Id: cli.c,v 1.6.4.3 2013/10/08 09:51:02 misho Exp $
1.1       misho       7: *
1.3       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, 2013
1.3       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: #include "global.h"
                     47: 
                     48: 
                     49: /*
1.5       misho      50:  * cli_Cmd_Exit() - Builtin helper function for Exit from Cli
                     51:  *
1.6       misho      52:  * @cli_buffer = CLI buffer
1.6.4.3   misho      53:  * @idx = Config level
1.1       misho      54:  * @args = Parsed arguments array
1.2       misho      55:  * return: RETCODE_EOF exit from Cli!
1.1       misho      56: */
1.6.4.4 ! misho      57: int
        !            58: cli_Cmd_Exit(void * __restrict cli_buffer, int idx, char ** __restrict args)
1.1       misho      59: {
1.6       misho      60:        cli_Printf(cli_buffer, "\n");
1.2       misho      61:        return RETCODE_EOF;
1.1       misho      62: }
                     63: 
                     64: /*
1.5       misho      65:  * cli_Cmd_Help() - Builtin helper function for Help screen
                     66:  *
1.6       misho      67:  * @cli_buffer = CLI buffer
1.6.4.3   misho      68:  * @idx = Config level
1.1       misho      69:  * @args = Parsed arguments array
1.2       misho      70:  * return: RETCODE_ERR in error or RETCODE_OK
1.1       misho      71: */
1.6.4.4 ! misho      72: int
        !            73: cli_Cmd_Help(void * __restrict cli_buffer, int idx, char ** __restrict args)
1.1       misho      74: {
1.6       misho      75:        linebuffer_t *buf = cli_buffer;
1.2       misho      76:        struct tagCommand *cmd;
1.1       misho      77: 
1.6       misho      78:        if (!cli_buffer) {
1.5       misho      79:                cli_SetErr(EINVAL, "Invalid input parameters ...");
1.2       misho      80:                return RETCODE_ERR;
                     81:        }
1.1       misho      82: 
1.2       misho      83:        cli_Printf(buf, "\n");
1.1       misho      84:        if (!args) {
1.6.4.2   misho      85:                SLIST_FOREACH(cmd, &buf->line_cmds, cmd_next) {
                     86:                        if (cmd->cmd_level != idx)
                     87:                                continue;
                     88: 
1.2       misho      89:                        cli_Printf(buf, "%s\t\t%s\n", cmd->cmd_name, cmd->cmd_help);
1.6.4.2   misho      90:                }
1.1       misho      91:        } else {
                     92:                if (!args[1])
1.2       misho      93:                        cli_Printf(buf, "Help screen::\n");
1.1       misho      94:                else
                     95:                        if (!strncmp(args[1], "---", 3))
1.2       misho      96:                                return RETCODE_OK;
1.1       misho      97: 
1.2       misho      98:                SLIST_FOREACH(cmd, &buf->line_cmds, cmd_next) {
1.6.4.2   misho      99:                        if (cmd->cmd_level != idx)
                    100:                                continue;
1.6.4.1   misho     101:                        if (args[1] && (cmd->cmd_level != idx || strcmp(args[1], cmd->cmd_name)))
1.1       misho     102:                                continue;
                    103: 
1.2       misho     104:                        cli_Printf(buf, "%s%s\t\t%s\n", args[1] ? "Syntax::\n\t" : "", cmd->cmd_name, 
                    105:                                        args[1] ? cmd->cmd_info: cmd->cmd_help);
1.1       misho     106:                }
                    107:        }
1.6       misho     108:        cli_Printf(cli_buffer, "\r");
1.1       misho     109: 
1.2       misho     110:        return RETCODE_OK;
1.1       misho     111: }
                    112: 
                    113: /*
1.5       misho     114:  * cli_Cmd_Unsupported() - Builtin helper function for unsupported commands
                    115:  *
1.6       misho     116:  * @cli_buffer = CLI buffer
1.6.4.3   misho     117:  * @idx = Config level
1.1       misho     118:  * @args = Parsed arguments array
1.2       misho     119:  * return: RETCODE_OK ok
1.1       misho     120: */
1.6.4.4 ! misho     121: int
        !           122: cli_Cmd_Unsupported(void * __restrict cli_buffer, int idx, char ** __restrict args)
1.1       misho     123: {
1.6       misho     124:        cli_Printf(cli_buffer, "Command %s not supported in this version ...\n", args[0]);
1.2       misho     125:        return RETCODE_OK;
1.1       misho     126: }
1.6.4.3   misho     127: 
                    128: /*
                    129:  * cli_Cmd_Config() - Builtin helper function for enter into config level from Cli
                    130:  *
                    131:  * @cli_buffer = CLI buffer
                    132:  * @idx = Config level
                    133:  * @args = Parsed arguments array
                    134:  * return: RETCODE_ERR in error or RETCODE_OK
                    135: */
1.6.4.4 ! misho     136: int
        !           137: cli_Cmd_Config(void * __restrict cli_buffer, int idx, char ** __restrict args)
1.6.4.3   misho     138: {
1.6.4.4 ! misho     139:        linebuffer_t *buf = cli_buffer;
        !           140: 
        !           141:        if (idx == sizeof idx * 8)
        !           142:                return RETCODE_ERR;
        !           143: 
        !           144:        buf->line_level++;
1.6.4.3   misho     145:        return RETCODE_OK;
                    146: }
                    147: 
                    148: /*
                    149:  * cli_Cmd_End() - Builtin helper function for end config level from Cli
                    150:  *
                    151:  * @cli_buffer = CLI buffer
                    152:  * @idx = Config level
                    153:  * @args = Parsed arguments array
1.6.4.4 ! misho     154:  * return: RETCODE_EOF in level 0 or RETCODE_OK
1.6.4.3   misho     155: */
1.6.4.4 ! misho     156: int
        !           157: cli_Cmd_End(void * __restrict cli_buffer, int idx, char ** __restrict args)
1.6.4.3   misho     158: {
1.6.4.4 ! misho     159:        linebuffer_t *buf = cli_buffer;
        !           160: 
        !           161:        if (!idx)
        !           162:                cli_Cmd_Exit(cli_buffer, idx, args);
        !           163: 
        !           164:        buf->line_level--;
        !           165:        return RETCODE_OK;
        !           166: }
        !           167: 
        !           168: /*
        !           169:  * cli_Cmd_Top() - Builtin helper function for top level of Cli
        !           170:  *
        !           171:  * @cli_buffer = CLI buffer
        !           172:  * @idx = Config level
        !           173:  * @args = Parsed arguments array
        !           174:  * return: RETCODE_OK ok
        !           175: */
        !           176: int
        !           177: cli_Cmd_Top(void * __restrict cli_buffer, int idx, char ** __restrict args)
        !           178: {
        !           179:        linebuffer_t *buf = cli_buffer;
        !           180: 
        !           181:        buf->line_level ^= buf->line_level;
1.6.4.3   misho     182:        return RETCODE_OK;
                    183: }

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