--- libaitcli/inc/cli.h 2011/03/16 17:24:03 1.2 +++ libaitcli/inc/cli.h 2013/10/08 12:04:42 1.6 @@ -3,9 +3,46 @@ * by Michael Pounov * * $Author: misho $ -* $Id: cli.h,v 1.2 2011/03/16 17:24:03 misho Exp $ +* $Id: cli.h,v 1.6 2013/10/08 12:04:42 misho Exp $ * -*************************************************************************/ +************************************************************************** +The ELWIX and AITNET software is distributed under the following +terms: + +All of the documentation and software included in the ELWIX and AITNET +Releases is copyrighted by ELWIX - Sofia/Bulgaria + +Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 + by Michael Pounov . All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions +are met: +1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. +2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. +3. All advertising materials mentioning features or use of this software + must display the following acknowledgement: +This product includes software developed by Michael Pounov +ELWIX - Embedded LightWeight unIX and its contributors. +4. Neither the name of AITNET nor the names of its contributors + may be used to endorse or promote products derived from this software + without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +SUCH DAMAGE. +*/ #ifndef __CLI_H #define __CLI_H @@ -13,21 +50,59 @@ /* CLI Helper functions */ /* - * cli_Cmd_Exit() Builtin helper function for Exit from Cli - * @buffer = CLI buffer - * @idx = Selected command ID + * cli_Cmd_Exit() - Builtin helper function for Exit from Cli + * + * @cli_buffer = CLI buffer + * @idx = Config level * @args = Parsed arguments array * return: RETCODE_EOF exit from Cli! - */ -int cli_Cmd_Exit(void * __restrict buffer, int idx, char ** __restrict args); +*/ +int cli_Cmd_Exit(void * __restrict cli_buffer, int idx, char ** __restrict args); /* - * cli_Cmd_Help() Builtin helper function for Help screen - * @buffer = CLI buffer - * @idx = Selected command ID + * cli_Cmd_Help() - Builtin helper function for Help screen + * + * @cli_buffer = CLI buffer + * @idx = Config level * @args = Parsed arguments array * return: RETCODE_ERR in error or RETCODE_OK */ -int cli_Cmd_Help(void * __restrict buffer, int idx, char ** __restrict args); +int cli_Cmd_Help(void * __restrict cli_buffer, int idx, char ** __restrict args); +/* + * cli_Cmd_Config() - Builtin helper function for enter into config level from Cli + * + * @cli_buffer = CLI buffer + * @idx = Config level + * @args = Parsed arguments array + * return: RETCODE_ERR in error or RETCODE_OK +*/ +int cli_Cmd_Config(void * __restrict cli_buffer, int idx, char ** __restrict args); +/* + * cli_Cmd_End() - Builtin helper function for end config level from Cli + * + * @cli_buffer = CLI buffer + * @idx = Config level + * @args = Parsed arguments array + * return: RETCODE_EOF in level 0 or RETCODE_OK +*/ +int cli_Cmd_End(void * __restrict cli_buffer, int idx, char ** __restrict args); +/* + * cli_Cmd_Top() - Builtin helper function for top level of Cli + * + * @cli_buffer = CLI buffer + * @idx = Config level + * @args = Parsed arguments array + * return: RETCODE_OK ok +*/ +int cli_Cmd_Top(void * __restrict cli_buffer, int idx, char ** __restrict args); +/* + * cli_Cmd_WhereAmI() - Builtin helper function for query level of Cli + * + * @cli_buffer = CLI buffer + * @idx = Config level + * @args = Parsed arguments array + * return: RETCODE_OK ok +*/ +int cli_Cmd_WhereAmI(void * __restrict cli_buffer, int idx, char ** __restrict args); #endif