144 lines
4.3 KiB
C
144 lines
4.3 KiB
C
|
//###########################################################################
|
||
|
|
//
|
||
|
|
// FILE: cmdline.h
|
||
|
|
//
|
||
|
|
// TITLE: Prototypes for command line processing functions.
|
||
|
|
//
|
||
|
|
//###########################################################################
|
||
|
|
// $TI Release: F2837xD Support Library v3.05.00.00 $
|
||
|
|
// $Release Date: Tue Jun 26 03:15:23 CDT 2018 $
|
||
|
|
// $Copyright:
|
||
|
|
// Copyright (C) 2013-2018 Texas Instruments Incorporated - http://www.ti.com/
|
||
|
|
//
|
||
|
|
// Redistribution and use in source and binary forms, with or without
|
||
|
|
// modification, are permitted provided that the following conditions
|
||
|
|
// are met:
|
||
|
|
//
|
||
|
|
// Redistributions of source code must retain the above copyright
|
||
|
|
// notice, this list of conditions and the following disclaimer.
|
||
|
|
//
|
||
|
|
// 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.
|
||
|
|
//
|
||
|
|
// Neither the name of Texas Instruments Incorporated 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 THE COPYRIGHT HOLDERS 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 COPYRIGHT
|
||
|
|
// OWNER 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 __CMDLINE_H__
|
||
|
|
#define __CMDLINE_H__
|
||
|
|
|
||
|
|
//*****************************************************************************
|
||
|
|
//
|
||
|
|
// If building with a C++ compiler, make all of the definitions in this header
|
||
|
|
// have a C binding.
|
||
|
|
//
|
||
|
|
//*****************************************************************************
|
||
|
|
#ifdef __cplusplus
|
||
|
|
extern "C"
|
||
|
|
{
|
||
|
|
#endif
|
||
|
|
|
||
|
|
//*****************************************************************************
|
||
|
|
//
|
||
|
|
//! \addtogroup cmdline_api
|
||
|
|
//! @{
|
||
|
|
//
|
||
|
|
//*****************************************************************************
|
||
|
|
|
||
|
|
//
|
||
|
|
//! Defines the value that is returned if the command is not found.
|
||
|
|
//
|
||
|
|
#define CMDLINE_BAD_CMD (-1)
|
||
|
|
|
||
|
|
//
|
||
|
|
//! Defines the value that is returned if there are too many arguments.
|
||
|
|
//
|
||
|
|
#define CMDLINE_TOO_MANY_ARGS (-2)
|
||
|
|
|
||
|
|
//
|
||
|
|
//! Defines the value that is returned if there are too few arguments.
|
||
|
|
//
|
||
|
|
#define CMDLINE_TOO_FEW_ARGS (-3)
|
||
|
|
|
||
|
|
//
|
||
|
|
//! Defines the value that is returned if an argument is invalid.
|
||
|
|
//
|
||
|
|
#define CMDLINE_INVALID_ARG (-4)
|
||
|
|
|
||
|
|
//
|
||
|
|
// Command line function callback type.
|
||
|
|
//
|
||
|
|
typedef int (*pfnCmdLine)(int argc, char *argv[]);
|
||
|
|
|
||
|
|
//
|
||
|
|
//! Structure for an entry in the command list table.
|
||
|
|
//
|
||
|
|
typedef struct
|
||
|
|
{
|
||
|
|
//
|
||
|
|
//! A pointer to a string containing the name of the command.
|
||
|
|
//
|
||
|
|
const char *pcCmd;
|
||
|
|
|
||
|
|
//
|
||
|
|
//! A function pointer to the implementation of the command.
|
||
|
|
//
|
||
|
|
pfnCmdLine pfnCmd;
|
||
|
|
|
||
|
|
//
|
||
|
|
//! A pointer to a string of brief help text for the command.
|
||
|
|
//
|
||
|
|
const char *pcHelp;
|
||
|
|
}
|
||
|
|
tCmdLineEntry;
|
||
|
|
|
||
|
|
//
|
||
|
|
//! This is the command table that must be provided by the application. The
|
||
|
|
//! last element of the array must be a structure whose pcCmd field contains
|
||
|
|
//! a NULL pointer.
|
||
|
|
//
|
||
|
|
extern tCmdLineEntry g_psCmdTable[];
|
||
|
|
|
||
|
|
//*****************************************************************************
|
||
|
|
//
|
||
|
|
// Close the Doxygen group.
|
||
|
|
//! @}
|
||
|
|
//
|
||
|
|
//*****************************************************************************
|
||
|
|
|
||
|
|
//
|
||
|
|
// Function Prototypes
|
||
|
|
//
|
||
|
|
extern int CmdLineProcess(char *pcCmdLine);
|
||
|
|
|
||
|
|
//*****************************************************************************
|
||
|
|
//
|
||
|
|
// Mark the end of the C bindings section for C++ compilers.
|
||
|
|
//
|
||
|
|
//*****************************************************************************
|
||
|
|
#ifdef __cplusplus
|
||
|
|
}
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#endif // __CMDLINE_H__
|
||
|
|
|
||
|
|
//
|
||
|
|
// End of file
|
||
|
|
//
|