ICommandRegistry.h

Go to the documentation of this file.

#pragma once
 
#include <cstdint>
#include <cstddef>
 
namespace cdc::serial {

using CommandHandler = void (*)(const char* args);

struct SubCommand {
    const char* name;      
    const char* args;      
    const char* help;      
    CommandHandler handler;
};

constexpr size_t kSubCommandHeadBufSize = 80;

struct Command {
    const char* name;                       
    const char* help;                       
    CommandHandler handler;                 
    const char* moduleName;                 
    bool requiresAuth;                      
    const SubCommand* subCommands = nullptr;
};

class ICommandRegistry {
public:
    virtual ~ICommandRegistry() = default;

    virtual bool registerCommand(const Command& cmd) = 0;

    virtual void unregisterModule(const char* moduleName) = 0;

    virtual bool processCommand(const char* line) = 0;

    virtual void showHelp() = 0;

    virtual size_t getCommandCount() const = 0;

    virtual void setAuthProvider(bool (*authCheck)()) = 0;

    virtual void setOnCommandExecuted(void (*callback)()) = 0;

    using LineInterceptor = bool (*)(const char* line);

    virtual void setLineInterceptor(LineInterceptor interceptor) { (void)interceptor; }

    using ByteInterceptor = void (*)(uint8_t byte);

    virtual void setByteInterceptor(ByteInterceptor interceptor) { (void)interceptor; }
    virtual ByteInterceptor getByteInterceptor() const { return nullptr; }
};
 
// Get global command registry instance
ICommandRegistry& getCommandRegistry();
 
} // namespace cdc::serial