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.6.4.4 2013/10/08 10:45:08 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 != 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 != idx)
100: continue;
101: if (args[1] && (cmd->cmd_level != idx || strcmp(args[1], cmd->cmd_name)))
102: continue;
103:
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);
106: }
107: }
108: cli_Printf(cli_buffer, "\r");
109:
110: return RETCODE_OK;
111: }
112:
113: /*
114: * cli_Cmd_Unsupported() - Builtin helper function for unsupported commands
115: *
116: * @cli_buffer = CLI buffer
117: * @idx = Config level
118: * @args = Parsed arguments array
119: * return: RETCODE_OK ok
120: */
121: int
122: cli_Cmd_Unsupported(void * __restrict cli_buffer, int idx, char ** __restrict args)
123: {
124: cli_Printf(cli_buffer, "Command %s not supported in this version ...\n", args[0]);
125: return RETCODE_OK;
126: }
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: */
136: int
137: cli_Cmd_Config(void * __restrict cli_buffer, int idx, char ** __restrict args)
138: {
139: linebuffer_t *buf = cli_buffer;
140:
141: if (idx == sizeof idx * 8)
142: return RETCODE_ERR;
143:
144: buf->line_level++;
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
154: * return: RETCODE_EOF in level 0 or RETCODE_OK
155: */
156: int
157: cli_Cmd_End(void * __restrict cli_buffer, int idx, char ** __restrict args)
158: {
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;
182: return RETCODE_OK;
183: }
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>