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

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.3     ! misho       6: * $Id: cli.c,v 1.2.2.1 2011/05/29 22:48:23 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: 
        !            15: Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
        !            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: /*
                     50:  * cli_Cmd_Exit() Builtin helper function for Exit from Cli
1.2       misho      51:  * @buffer = CLI buffer
1.1       misho      52:  * @idx = Selected command ID
                     53:  * @args = Parsed arguments array
1.2       misho      54:  * return: RETCODE_EOF exit from Cli!
1.1       misho      55: */
1.2       misho      56: int cli_Cmd_Exit(void * __restrict buffer, int idx, char ** __restrict args)
1.1       misho      57: {
1.2       misho      58:        cli_Printf(buffer, "\n");
                     59:        return RETCODE_EOF;
1.1       misho      60: }
                     61: 
                     62: /*
                     63:  * cli_Cmd_Help() Builtin helper function for Help screen
1.2       misho      64:  * @buffer = CLI buffer
1.1       misho      65:  * @idx = Selected command ID
                     66:  * @args = Parsed arguments array
1.2       misho      67:  * return: RETCODE_ERR in error or RETCODE_OK
1.1       misho      68: */
1.2       misho      69: int cli_Cmd_Help(void * __restrict buffer, int idx, char ** __restrict args)
1.1       misho      70: {
1.2       misho      71:        linebuffer_t *buf = buffer;
                     72:        struct tagCommand *cmd;
1.1       misho      73: 
1.2       misho      74:        if (!buffer) {
                     75:                cli_SetErr(EINVAL, "Error:: invalid input parameters ...");
                     76:                return RETCODE_ERR;
                     77:        }
1.1       misho      78: 
1.2       misho      79:        cli_Printf(buf, "\n");
1.1       misho      80:        if (!args) {
1.2       misho      81:                SLIST_FOREACH(cmd, &buf->line_cmds, cmd_next)
                     82:                        cli_Printf(buf, "%s\t\t%s\n", cmd->cmd_name, cmd->cmd_help);
1.1       misho      83:        } else {
                     84:                if (!args[1])
1.2       misho      85:                        cli_Printf(buf, "Help screen::\n");
1.1       misho      86:                else
                     87:                        if (!strncmp(args[1], "---", 3))
1.2       misho      88:                                return RETCODE_OK;
1.1       misho      89: 
1.2       misho      90:                SLIST_FOREACH(cmd, &buf->line_cmds, cmd_next) {
                     91:                        if (args[1] && (cmd->cmd_level != buf->line_level || strcmp(args[1], cmd->cmd_name)))
1.1       misho      92:                                continue;
                     93: 
1.2       misho      94:                        cli_Printf(buf, "%s%s\t\t%s\n", args[1] ? "Syntax::\n\t" : "", cmd->cmd_name, 
                     95:                                        args[1] ? cmd->cmd_info: cmd->cmd_help);
1.1       misho      96:                }
                     97:        }
1.2       misho      98:        cli_Printf(buffer, "\r");
1.1       misho      99: 
1.2       misho     100:        return RETCODE_OK;
1.1       misho     101: }
                    102: 
                    103: /*
                    104:  * cli_Cmd_Unsupported() Builtin helper function for unsupported commands
1.2       misho     105:  * @buffer = CLI buffer
1.1       misho     106:  * @idx = Selected command ID
                    107:  * @args = Parsed arguments array
1.2       misho     108:  * return: RETCODE_OK ok
1.1       misho     109: */
1.2       misho     110: int cli_Cmd_Unsupported(void * __restrict buffer, int idx, char ** __restrict args)
1.1       misho     111: {
1.2       misho     112:        cli_Printf(buffer, "Command %s not supported in this version ...\n", args[0]);
                    113:        return RETCODE_OK;
1.1       misho     114: }

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