IModule.h

Go to the documentation of this file.

#pragma once
 
#include "cdc_core/IService.h"
#include <cstdint>
 
struct cJSON;
 
namespace cdc::ui {
    class IView;
}
 
namespace cdc::core {

enum class MenuLocation : uint8_t {
    MAIN_MENU,       // Top-level main menu
    TOOLS_MENU,      // Under Tools submenu
    SETTINGS_MENU,   // Under Settings submenu
    BLUETOOTH_MENU,  // Under Bluetooth submenu (for BLE services)
    WIFI_MENU,       // Under WiFi submenu (for WiFi-related features)
    EXPERT_MENU      // Under Expert submenu (for advanced tools)
};

struct ModuleMenuItem {
    const char* label;              // Display label (use I18n for translation)
    uint8_t priority;               // Sort order (lower = higher in list)
    ui::IView* (*getView)();        // Factory function to get the view (push view on select)
    bool (*isVisible)();            // Optional visibility check (nullptr = always visible)
    const char* moduleName;         // Owner module name (set automatically)
    MenuLocation location;          // Where to show this item
    void (*onSelect)();             // Toggle/action callback (used when getView is nullptr)
};

struct LockScreenContextItem {
    const char* (*getLabel)();      // Dynamic label getter (for state-dependent text)
    void (*callback)();             // Action when selected
    uint8_t priority;               // Sort order (lower = higher in list)
    const char* moduleName;         // Owner module name (set automatically)
};

class IModule : public IService {
public:
    struct SlotRequest {
        const char* mapName = nullptr;
        uint8_t minEccSlots = 0;
        uint16_t minRmemSlots = 0;
    };
 
    struct SlotRange {
        bool hasEcc = false;
        bool hasRmem = false;
        uint8_t eccStart = 0;
        uint8_t eccEnd = 0;
        uint16_t rmemStart = 0;
        uint16_t rmemEnd = 0;
        uint8_t moduleId = 0;
    };

    virtual const char* getVersion() const = 0;

    struct BackupResult {
        uint16_t imported = 0;  
        uint16_t failed = 0;    
    };

    virtual bool exportBackup(cJSON* out) { (void)out; return false; }

    virtual BackupResult importBackup(const cJSON* in) { (void)in; return {}; }

    virtual uint8_t getMenuItems(ModuleMenuItem* items, uint8_t maxItems) {
        (void)items; (void)maxItems;
        return 0;
    }

    virtual ui::IView* getEntryView() { return nullptr; }

    virtual uint8_t getLockScreenContextItems(LockScreenContextItem* items, uint8_t maxItems) {
        (void)items; (void)maxItems;
        return 0;
    }

    virtual void onUnlock() {}

    virtual void onLock() {}

    virtual void onUsbConnect() {}

    virtual void onUsbDisconnect() {}

    virtual void onTick(uint32_t nowMs) { (void)nowMs; }

    virtual void setSlotRange(const SlotRange& range) { (void)range; }

    virtual SlotRequest getSlotRequest() const { return {}; }
};
 
} // namespace cdc::core