commands.h

/*
Copyright (C) 2006  Adam Charrett

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA

commands.h

Command Processing and command functions.

*/
#ifndef _COMMANDS_H
#define _COMMANDS_H
#include <stdint.h>
#include <stdarg.h>
#include "types.h"
#define COMMAND_OK                    0x0000 
#define COMMAND_ERROR_TOO_MANY_CONNS  0x0001 
#define COMMAND_ERROR_UNKNOWN_COMMAND 0x0002 
#define COMMAND_ERROR_WRONG_ARGS      0x0003 
#define COMMAND_ERROR_AUTHENTICATION  0x0004 
#define COMMAND_ERROR_GENERIC         0xffff 
#define MAX_ERR_MSG 256

typedef struct Command_t
{
    char *command;  
    bool  tokenise; 
    int   minArgs;  
    int   maxArgs;  
    char *shortHelp;
    char *longHelp; 
    void (*commandfunc)(int argc, char **argv); 
}Command_t;

typedef void (*CommandVariableGet_t)(char *name);
typedef void (*CommandVariableSet_t)(char *name, int argc, char **argv);

typedef struct CommandVariable_t
{
    char *name;               
    char *description;        
    CommandVariableGet_t get; 
    CommandVariableSet_t set; 
}CommandVariable_t;


typedef struct CommandContext_t
{
    char *interface;     
    bool remote;         
    int (*printf)(struct CommandContext_t *context, const char *fmt, va_list arg_ptr); 
    char *(*gets)(struct CommandContext_t *context,char *buffer, int len);
    void *privateArg;    
    Command_t *commands; 
    bool authenticated;  
    uint16_t errorNumber;    
    char errorMessage[MAX_ERR_MSG]; 
}CommandContext_t;

#define CommandError(_errcode, _msgformat...) \
    do{\
        CommandContext_t *context = CommandContextGet();\
        context->errorNumber = _errcode;\
        snprintf(context->errorMessage, MAX_ERR_MSG,_msgformat);\
    }while(0)

#define CommandCheckAuthenticated() \
    do{\
        CommandContext_t *context = CommandContextGet();\
        if (!context->authenticated)\
        {\
            CommandError(COMMAND_ERROR_AUTHENTICATION, "Not authenticated!");\
            return;\
        }\
    }while(0)

int CommandInit(void);

void CommandDeInit(void);

void CommandRegisterCommands(Command_t *commands);

void CommandUnRegisterCommands(Command_t *commands);

void CommandLoop(void);

int CommandProcessFile(char *file);

bool CommandExecuteConsole(char *line);

bool CommandExecute(CommandContext_t *context, char *command);

int CommandPrintf(const char *fmt, ...);

char *CommandGets(char *buffer, int len);

CommandContext_t *CommandContextGet(void);

void CommandRegisterVariable(CommandVariable_t *handler);

void CommandUnRegisterVariable(CommandVariable_t *handler);
#endif

---