Return to cli.h CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / libaitcli / inc

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.h,v 1.6 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: #ifndef __CLI_H
   47: #define __CLI_H
   48: 
   49: 
   50: /* CLI Helper functions */
   51: 
   52: /*
   53:  * cli_Cmd_Exit() - Builtin helper function for Exit from Cli
   54:  *
   55:  * @cli_buffer = CLI buffer
   56:  * @idx = Config level
   57:  * @args = Parsed arguments array
   58:  * return: RETCODE_EOF exit from Cli!
   59: */
   60: int cli_Cmd_Exit(void * __restrict cli_buffer, int idx, char ** __restrict args);
   61: /*
   62:  * cli_Cmd_Help() - Builtin helper function for Help screen
   63:  *
   64:  * @cli_buffer = CLI buffer
   65:  * @idx = Config level
   66:  * @args = Parsed arguments array
   67:  * return: RETCODE_ERR in error or RETCODE_OK
   68: */
   69: int cli_Cmd_Help(void * __restrict cli_buffer, int idx, char ** __restrict args);
   70: /*
   71:  * cli_Cmd_Config() - Builtin helper function for enter into config level from Cli
   72:  *
   73:  * @cli_buffer = CLI buffer
   74:  * @idx = Config level
   75:  * @args = Parsed arguments array
   76:  * return: RETCODE_ERR in error or RETCODE_OK
   77: */
   78: int cli_Cmd_Config(void * __restrict cli_buffer, int idx, char ** __restrict args);
   79: /*
   80:  * cli_Cmd_End() - Builtin helper function for end config level from Cli
   81:  *
   82:  * @cli_buffer = CLI buffer
   83:  * @idx = Config level
   84:  * @args = Parsed arguments array
   85:  * return: RETCODE_EOF in level 0 or RETCODE_OK
   86: */
   87: int cli_Cmd_End(void * __restrict cli_buffer, int idx, char ** __restrict args);
   88: /*
   89:  * cli_Cmd_Top() - Builtin helper function for top level of Cli
   90:  *
   91:  * @cli_buffer = CLI buffer
   92:  * @idx = Config level
   93:  * @args = Parsed arguments array
   94:  * return: RETCODE_OK ok
   95: */
   96: int cli_Cmd_Top(void * __restrict cli_buffer, int idx, char ** __restrict args);
   97: /*
   98:  * cli_Cmd_WhereAmI() - Builtin helper function for query level of Cli
   99:  *
  100:  * @cli_buffer = CLI buffer
  101:  * @idx = Config level
  102:  * @args = Parsed arguments array
  103:  * return: RETCODE_OK ok
  104: */
  105: int cli_Cmd_WhereAmI(void * __restrict cli_buffer, int idx, char ** __restrict args);
  106: 
  107: 
  108: #endif