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