shell.h

Go to the documentation of this file.

 
#ifndef SEMF_COMMUNICATION_ESH_SHELL_H_
#define SEMF_COMMUNICATION_ESH_SHELL_H_
 
#include <semf/utils/core/lists/linkedlist.h>
#include <semf/utils/core/signals/signal.h>
#include <semf/communication/esh/arrowcontrol.h>
#include <semf/communication/esh/command.h>
#include <semf/communication/esh/history.h>
#include <semf/communication/esh/printer.h>
#include <semf/communication/esh/processor.h>
#include <semf/communication/esh/tabulator.h>
#include <semf/communication/uarthardware.h>
#include <array>
#include <cstdint>
#include <string_view>
 
namespace semf::esh
{
class Shell
{
public:
    struct Config
    {
        char* const lineBuffer;
        const size_t lineBufferSize;
        char** const argvBuffer;
        const size_t argvBufferSize;
        char* historyBuffer;
        const size_t numberOfEntries;
        bool echo;
        std::string_view prompt;
    };
    Shell(UartHardware& uart, const Config& config);
    Shell(const Shell& other) = delete;
    virtual ~Shell() = default;
    void addCommand(Command& cmd);
    void start();
    void loop();
    SEMF_SIGNAL(error, Error);
 
private:
    static constexpr char kDelete = '\177';
    static constexpr char kEscape = '\33';
 
    void onCharAvailable(char character);
    void onTabDone(size_t charCount);
    void onExecuted();
    void onArrowUp();
    void onArrowDown();
    void updateStateAndPrint();
    void onError(Error error);
    void readNextCharacter();
 
    const Config m_config;
    History m_history;
    Printer m_printer;
    LinkedList<Command> m_commands;
    Tabulator m_tab;
    Processor m_processor;
    ArrowControl m_arrow;
    int m_count = 0;
    SEMF_SLOT(m_onCharAvailableSlot, Shell, *this, onCharAvailable, char);
    SEMF_SLOT(m_restartShell, Shell, *this, start);
    SEMF_SLOT(m_onTabDoneSlot, Shell, *this, onTabDone, size_t);
    SEMF_SLOT(m_onExecutedSlot, Shell, *this, onExecuted);
    SEMF_SLOT(m_onArrowUpSlot, Shell, *this, onArrowUp);
    SEMF_SLOT(m_onArrowDownSlot, Shell, *this, onArrowDown);
    SEMF_SLOT(m_readNextCharSlot, Shell, *this, readNextCharacter);
    SEMF_SLOT(m_onErrorSlot, Shell, *this, onError, Error);
};
}  // namespace semf::esh
#endif  // SEMF_COMMUNICATION_ESH_SHELL_H_