File:  [ELWIX - Embedded LightWeight unIX -] / libaitcli / src / cli.c
Revision 1.12: download - view: text, annotated - select for diffs - revision graph
Mon Dec 5 22:23:38 2022 UTC (17 months, 3 weeks ago) by misho
Branches: MAIN
CVS tags: cli4_6, cli4_5, HEAD, CLI4_5, CLI4_4
version 4.4

    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.12 2022/12/05 22:23:38 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 - 2022
   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: 	((linebuffer_t*) cli_buffer)->line_kill = 42;
   62: 	return RETCODE_EOF;
   63: }
   64: 
   65: /*
   66:  * cli_Cmd_Help() - Builtin helper function for Help screen
   67:  *
   68:  * @cli_buffer = CLI buffer
   69:  * @idx = Config level
   70:  * @args = Parsed arguments array
   71:  * return: RETCODE_ERR in error or RETCODE_OK
   72: */
   73: int
   74: cli_Cmd_Help(void * __restrict cli_buffer, int idx, char ** __restrict args)
   75: {
   76: 	linebuffer_t *buf = cli_buffer;
   77: 	struct tagCommand *cmd;
   78: 
   79: 	if (!cli_buffer) {
   80: 		cli_SetErr(EINVAL, "Invalid input parameters ...");
   81: 		return RETCODE_ERR;
   82: 	}
   83: 
   84: 	cli_Printf(buf, "\n");
   85: 	if (!args) {
   86: 		SLIST_FOREACH(cmd, &buf->line_cmds, cmd_next) {
   87: 			if (!(cmd->cmd_level & (1 << idx)))
   88: 				continue;
   89: 
   90: 			cli_Printf(buf, "%s\t\t%s\n", cmd->cmd_name, cmd->cmd_help);
   91: 		}
   92: 	} else {
   93: 		if (!args[1])
   94: 			cli_Printf(buf, "Help screen::\n");
   95: 		else
   96: 			if (!strncmp(args[1], "---", 3))
   97: 				return RETCODE_OK;
   98: 
   99: 		SLIST_FOREACH(cmd, &buf->line_cmds, cmd_next) {
  100: 			if (!(cmd->cmd_level & (1 << idx)))
  101: 				continue;
  102: 			if (args[1] && (!(cmd->cmd_level & (1 << idx)) || 
  103: 						strcmp(args[1], cmd->cmd_name)))
  104: 				continue;
  105: 
  106: 			cli_Printf(buf, "%s%s\t\t%s\n", args[1] ? "Syntax::\n\t" : "", cmd->cmd_name, 
  107: 					args[1] ? cmd->cmd_info: cmd->cmd_help);
  108: 		}
  109: 	}
  110: 	cli_Printf(cli_buffer, "\r");
  111: 
  112: 	return RETCODE_OK;
  113: }
  114: 
  115: /*
  116:  * cli_Cmd_Unsupported() - Builtin helper function for unsupported commands
  117:  *
  118:  * @cli_buffer = CLI buffer
  119:  * @idx = Config level
  120:  * @args = Parsed arguments array
  121:  * return: RETCODE_OK ok
  122: */
  123: int
  124: cli_Cmd_Unsupported(void * __restrict cli_buffer, int idx, char ** __restrict args)
  125: {
  126: 	cli_Printf(cli_buffer, "Command %s not supported in this version ...\n", args[0]);
  127: 	return RETCODE_OK;
  128: }
  129: 
  130: /*
  131:  * cli_Cmd_Config() - Builtin helper function for enter into config level from Cli
  132:  *
  133:  * @cli_buffer = CLI buffer
  134:  * @idx = Config level
  135:  * @args = Parsed arguments array
  136:  * return: RETCODE_ERR in error or RETCODE_OK
  137: */
  138: int
  139: cli_Cmd_Config(void * __restrict cli_buffer, int idx, char ** __restrict args)
  140: {
  141: 	linebuffer_t *buf = cli_buffer;
  142: 	char szPrompt[STRSIZ + 16] = {[0 ... STRSIZ + 15] = 0};
  143: 
  144: 	if (idx == sizeof idx * 8 - 1)
  145: 		return RETCODE_ERR;
  146: 
  147: 	buf->line_level++;
  148: 	snprintf(szPrompt, sizeof szPrompt, "%s{%d}> ", buf->line_porigin, buf->line_level);
  149: 	cli_setPrompt(buf, szPrompt);
  150: 	cli_Printf(buf, "Enter to config level %d\n", buf->line_level);
  151: 	return RETCODE_OK;
  152: }
  153: 
  154: /*
  155:  * cli_Cmd_End() - Builtin helper function for end config level from Cli
  156:  *
  157:  * @cli_buffer = CLI buffer
  158:  * @idx = Config level
  159:  * @args = Parsed arguments array
  160:  * return: RETCODE_EOF in level 0 or RETCODE_OK
  161: */
  162: int
  163: cli_Cmd_End(void * __restrict cli_buffer, int idx, char ** __restrict args)
  164: {
  165: 	linebuffer_t *buf = cli_buffer;
  166: 	char szPrompt[STRSIZ + 16] = {[0 ... STRSIZ + 15] = 0};
  167: 
  168: 	if (!idx)
  169: 		return cli_Cmd_Exit(cli_buffer, idx, args);
  170: 
  171: 	buf->line_level--;
  172: 	snprintf(szPrompt, sizeof szPrompt, "%s{%d}> ", buf->line_porigin, buf->line_level);
  173: 	cli_setPrompt(buf, szPrompt);
  174: 	cli_Printf(buf, "Enter to config level %d\n", buf->line_level);
  175: 	return RETCODE_OK;
  176: }
  177: 
  178: /*
  179:  * cli_Cmd_Top() - Builtin helper function for top level of Cli
  180:  *
  181:  * @cli_buffer = CLI buffer
  182:  * @idx = Config level
  183:  * @args = Parsed arguments array
  184:  * return: RETCODE_OK ok
  185: */
  186: int
  187: cli_Cmd_Top(void * __restrict cli_buffer, int idx, char ** __restrict args)
  188: {
  189: 	linebuffer_t *buf = cli_buffer;
  190: 	char szPrompt[STRSIZ + 16] = {[0 ... STRSIZ + 15] = 0};
  191: 
  192: 	buf->line_level ^= buf->line_level;
  193: 	snprintf(szPrompt, sizeof szPrompt, "%s{%d}> ", buf->line_porigin, buf->line_level);
  194: 	cli_setPrompt(buf, szPrompt);
  195: 	cli_Printf(buf, "Enter to top config level %d\n", buf->line_level);
  196: 	return RETCODE_OK;
  197: }
  198: 
  199: /*
  200:  * cli_Cmd_WhereAmI() - Builtin helper function for query level of Cli
  201:  *
  202:  * @cli_buffer = CLI buffer
  203:  * @idx = Config level
  204:  * @args = Parsed arguments array
  205:  * return: RETCODE_OK ok
  206: */
  207: int
  208: cli_Cmd_WhereAmI(void * __restrict cli_buffer, int idx, char ** __restrict args)
  209: {
  210: 	linebuffer_t *buf = cli_buffer;
  211: 
  212: 	cli_Printf(buf, "Current config level is %d\n", buf->line_level);
  213: 	return RETCODE_OK;
  214: }

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