CommandProcessing/src/CommandProcessing/Handler.h

Go to the documentation of this file.

/*
 * CommandHandler.h
 *
 *  Created on: 2 jul. 2015
 *      Author: Herman
 */
#pragma once
 
#include <WVector.h>
#include <Data/Stream/ReadWriteStream.h>
#include <Data/Stream/MemoryDataStream.h>
#include <Data/Buffer/LineBuffer.h>
#include "Command.h"
 
namespace CommandProcessing
{
constexpr size_t MAX_COMMANDSIZE = 64;
 
class Handler
{
public:
    Handler()
    {
    }
 
    Handler(ReadWriteStream* stream, bool owned = true) : outputStream(stream), ownedStream(owned)
    {
    }
 
    Handler(const Handler& rhs) = delete;
 
    ~Handler()
    {
        if(ownedStream) {
            delete outputStream;
        }
    }
 
    // I/O methods
 
    void setOutputStream(ReadWriteStream* stream, bool owned = true)
    {
        if(ownedStream) {
            delete outputStream;
        }
 
        outputStream = stream;
        ownedStream = owned;
    }
 
    ReadWriteStream& getOutputStream()
    {
        if(outputStream == nullptr) {
            outputStream = new MemoryDataStream();
            ownedStream = true;
        }
 
        return *outputStream;
    }
 
    size_t process(char charToWrite);
 
    size_t process(const char* buffer, size_t size)
    {
        size_t retval = 0;
        for(size_t i = 0; i < size; i++) {
            if(process(buffer[i]) != 1) {
                break;
            }
            retval++;
        }
        return retval;
    }
 
    String processNow(const char* buffer, size_t size);
 
    // Command registration/de-registration methods
 
    bool registerCommand(const Command& command);
 
    bool unregisterCommand(const Command& command);
 
    void registerSystemCommands();
 
    Command getCommand(const String& name) const;
 
    bool isVerbose() const
    {
        return verboseMode;
    }
 
    void setVerbose(bool mode)
    {
        verboseMode = mode;
    }
 
    String getCommandPrompt() const;
 
    void setCommandPrompt(const String& prompt)
    {
        this->prompt = prompt;
    }
 
    char getCommandEOL() const SMING_DEPRECATED
    {
        return '\n';
    }
 
    void setCommandEOL(char eol) SMING_DEPRECATED
    {
        (void)eol;
    }
 
    String getCommandWelcomeMessage() const;
 
    void setCommandWelcomeMessage(const String& message)
    {
        welcomeMessage = message;
    }
 
private:
    Vector<CommandDef> registeredCommands;
    String prompt;
    bool verboseMode{false};
    String welcomeMessage;
 
    ReadWriteStream* outputStream{nullptr};
    bool ownedStream = true;
    LineBuffer<MAX_COMMANDSIZE> commandBuf;
 
    void processHelpCommand(String commandLine, ReadWriteStream& outputStream);
    void processStatusCommand(String commandLine, ReadWriteStream& outputStream);
    void processEchoCommand(String commandLine, ReadWriteStream& outputStream);
    void processDebugOnCommand(String commandLine, ReadWriteStream& outputStream);
    void processDebugOffCommand(String commandLine, ReadWriteStream& outputStream);
    void processCommandOptions(String commandLine, ReadWriteStream& outputStream);
 
    void processCommandLine(const String& cmdString);
};
 
} // namespace CommandProcessing