command_handler.hpp

Go to the documentation of this file.

/*
 * @brief Provides command handling mapping with a function pointer as handler
 * @ingroup Utilities
 *
 * Version: 11102013    Removed 4th parameter (size) of command handler
 * Version: 05022013    Removed output string and replaced with output interface.
 * Version: 04192013    Removed restriction of command limit, just rely on source str as the command.
 * Version: 02162013    Removed input str (moved to stack).  Improved 'help' command output.
 * Version: 12082012    Added short-command handler capability
 * Version: 07262012    Removed "Version" Handler
 * Version: 06192012    Initial
 */
#ifndef COMMANDHANDLER_HPP_
#define COMMANDHANDLER_HPP_

#include "vector.hpp"
#include "str.hpp"
#include "char_dev.hpp"



typedef bool (*CmdHandlerFuncPtr)(str& cmdParams, CharDev& output, void* pDataParam);

#define CMD_HANDLER_FUNC(name) bool name(str& cmdParams, CharDev& output, void* pDataParam)




class CommandProcessor
{
    public:
        CommandProcessor(int numCmds=8) :
            mCmdHandlerVector(numCmds), mEnShortCmds(true)
        {
        }

        void addHandler(CmdHandlerFuncPtr pFunc, const char* pPersistantCmdStr,
                        const char* pPersistentCmdHelpStr=0, void* pDataParam=0);

        bool handleCommand(str& cmd, CharDev& out);
        inline void enableShortCmds(bool en) { mEnShortCmds = en;}

    private:
        typedef struct
        {
            const char* pCommandStr;  
            const char* pCmdHelpText; 
            CmdHandlerFuncPtr pFunc;  
            void* pDataParam;         
        } CmdProcessorType;

        VECTOR<CmdProcessorType> mCmdHandlerVector; 
        bool mEnShortCmds; 

        void handleCmd(str& input, CharDev& output);

        void getRegisteredCommandList(CharDev& output);

        void getHelpText(str& helpForCmd, CharDev& output);

        void prepareCmdParam(str& input, const char* pCmdToRemove);
};

#endif /* COMMANDHANDLER_HPP_ */