File:  [ELWIX - Embedded LightWeight unIX -] / libaitcli / src / cli.c
Revision 1.7: download - view: text, annotated - select for diffs - revision graph
Tue Oct 8 12:04:42 2013 UTC (10 years, 8 months ago) by misho
Branches: MAIN
CVS tags: cli3_4, HEAD
version 3.3

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

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