TcMenuBuilder.h

 
#ifndef TCLIBRARYDEV_TCMENUBUILDER_H
#define TCLIBRARYDEV_TCMENUBUILDER_H
#include "EditableLargeNumberMenuItem.h"
#include "EepromAbstraction.h"
#include "MenuItems.h"
#include "RuntimeMenuItem.h"
 
class LargeFixedNumber;
class TcMenuBuilder;
struct RgbColor32;
class MenuManager;
class ScrollChoiceMenuItem;
 
#define INT_MENU_FLAG_READ 0x01
#define INT_MENU_FLAG_HIDE 0x02
#define INT_MENU_FLAG_LOCAL 0x04
#define INT_MENU_FLAG_SECURE 0x08
 
// This definition is used when dynamic eeprom storage is enabled to indicate save to rom.
#define ROM_SAVE 0x0020
// This definition is used when dynamic eeprom storage is enabled to indicate do not save to eeprom.
#define DONT_SAVE 0xFFFF

class MenuFlags {
    uint8_t flags = 0;
public:
    MenuFlags() = default;
    MenuFlags(const MenuFlags&) = default;
    MenuFlags& operator=(const MenuFlags&) = default;
    ~MenuFlags() = default;
 
    MenuFlags& readOnly() { flags |= INT_MENU_FLAG_READ; return *this; }
    MenuFlags& hide() { flags |= INT_MENU_FLAG_HIDE; return *this; }
    MenuFlags& localOnly() { flags |= INT_MENU_FLAG_LOCAL; return *this; }
    MenuFlags& securePin() { flags |= INT_MENU_FLAG_SECURE; return *this; }
 
    void setOnMenuItem(MenuItem* item) const;
};

const MenuFlags NoMenuFlags;
 
// The builder allocator size allows you to re-configure initial amount that the builder will
// allocate for info blocks. There are up to 8 blocks, meaning 8 * 10 = 80 items by default.
// You can boost the allocater size and it increases by 8 times that amount.
#ifndef BUILDER_ALLOCATER_SIZE
#define BUILDER_ALLOCATER_SIZE 10
#define BUILDER_ALLOCATER_MAX_SEG (BUILDER_ALLOCATER_SIZE - 1)
#define BUILDER_ALLOCATER_TOTAL (BUILDER_ALLOCATER_SIZE * 8)
#endif

class AnalogItemBuilder {
private:
    AnalogMenuItem& item;
    AnalogMenuInfo& info;
    TcMenuBuilder& parentBuilder;
public:
    AnalogItemBuilder(AnalogMenuItem& item, AnalogMenuInfo& info,TcMenuBuilder& parentBuilder) : item(item), info(info), parentBuilder(parentBuilder) {}
    AnalogItemBuilder(const AnalogItemBuilder &) = default;

    AnalogItemBuilder& offset(int16_t offs) { info.offset = offs; return *this; }
    AnalogItemBuilder& divisor(uint16_t divisor) { info.divisor = divisor == 0 ? 1 : divisor; return *this; }
    AnalogItemBuilder& step(int step) { item.setStep(step); return *this; }
    AnalogItemBuilder& maxValue(int maxVal) { info.maxValue = maxVal; return *this; }

    AnalogItemBuilder& unit(const char* unit);

    TcMenuBuilder& endItem() const {return parentBuilder;}
};
 
class ScrollChoiceBuilder {
private:
    AnyMenuInfo& info;
    TcMenuBuilder& parentBuilder;
    uint16_t initialValue;
    MenuFlags menuFlags;
    ScrollChoiceMenuItem* createdItem = nullptr;
public:
    ScrollChoiceBuilder(AnyMenuInfo& info,TcMenuBuilder& parentBuilder, uint16_t initialValue, MenuFlags flags) : info(info), parentBuilder(parentBuilder), initialValue(initialValue), menuFlags(flags) {}
    ScrollChoiceBuilder(const ScrollChoiceBuilder &) = default;

    ScrollChoiceBuilder& fromRamChoices(const char* fixedArray, int numItems, int fixedItemSize);

    ScrollChoiceBuilder& fromRomChoices(EepromPosition eepromPosition, int numItems, int fixedItemSize);
 
    ScrollChoiceBuilder& ofCustomRtFunction(RuntimeRenderingFn rtRenderFn, int numItems);

    ScrollChoiceBuilder& cachingEepromValues();

    TcMenuBuilder& endItem() const;
};

class TcMenuBuilder {
public:
    explicit TcMenuBuilder(SubMenuItem* root, TcMenuBuilder* parent = nullptr) : currentSub(root), parent(parent) {}
    TcMenuBuilder(const TcMenuBuilder &) = default;
    TcMenuBuilder& operator=(const TcMenuBuilder &) = default;
    ~TcMenuBuilder() = default;

    TcMenuBuilder& usingDynamicEEPROMStorage();
    
    TcMenuBuilder& floatItem(menuid_t id, const char *name, EepromPosition eepromPosition, uint16_t decimalPlaces, MenuFlags flags, float initial = 0.0F, MenuCallbackFn callbackFn = nullptr);

    TcMenuBuilder& actionItem(menuid_t id, const char *name, MenuFlags flags, MenuCallbackFn callbackFn = nullptr);

    TcMenuBuilder& boolItem(menuid_t id, const char *name, EepromPosition eepromPosition, BooleanNaming naming, MenuFlags flags, bool initial = false, MenuCallbackFn callbackFn = nullptr);

    AnalogItemBuilder analogBuilder(menuid_t id, const char *name, EepromPosition eepromPosition, MenuFlags flags, uint16_t initialValue = 0, MenuCallbackFn callbackFn = nullptr);

    TcMenuBuilder& enumItem(menuid_t id, const char *name, EepromPosition eepromPosition, const char **enumEntries,
                            uint16_t numEntries, MenuFlags flags, uint16_t value = 0,
                            MenuCallbackFn callbackFn = nullptr);

    TcMenuBuilder subMenu(menuid_t id, const char *name, MenuFlags flags, MenuCallbackFn callbackFn = nullptr);

    TcMenuBuilder& textItem(menuid_t id, const char *name, EepromPosition eepromPosition, uint16_t textLength,
                            MenuFlags flags, const char *initial = "", MenuCallbackFn callbackFn = nullptr);

    TcMenuBuilder& textCustomRt(menuid_t id, const char *name, EepromPosition eepromPosition, uint16_t textLength,
                                RuntimeRenderingFn renderFn, MenuFlags flags, const char* initial = "", MenuCallbackFn callbackFn = nullptr);

    TcMenuBuilder& ipAddressItem(menuid_t id, const char *name, EepromPosition eepromPosition, MenuFlags flags, MenuCallbackFn callbackFn = nullptr);

    TcMenuBuilder& ipAddressItem(menuid_t id, const char *name, EepromPosition eepromPosition, MenuFlags flags,
                                 IpAddressStorage ipInitial, MenuCallbackFn callbackFn = nullptr);

    TcMenuBuilder& ipAddressCustomRt(menuid_t id, const char *name, EepromPosition eepromPosition, MenuFlags flags,
                                     RuntimeRenderingFn renderFn, IpAddressStorage ipInitial, MenuCallbackFn callbackFn = nullptr);
 
    TcMenuBuilder& timeItem(menuid_t id, const char *name, EepromPosition eepromPosition, MenuFlags flags, MultiEditWireType timeFormat,
                            const TimeStorage& timeStorage, MenuCallbackFn callbackFn = nullptr);
 
    TcMenuBuilder& timeItem(menuid_t id, const char *name, EepromPosition eepromPosition, MenuFlags flags, MultiEditWireType timeFormat,
                            MenuCallbackFn callbackFn = nullptr);
 
    TcMenuBuilder& timeItemCustomRt(menuid_t id, const char *name, EepromPosition eepromPosition, const TimeStorage& timeStorage,
                                    RuntimeRenderingFn renderFn, MenuFlags flags, MultiEditWireType timeFormat, MenuCallbackFn callbackFn = nullptr);
 
    TcMenuBuilder& dateItem(menuid_t id, const char *name, EepromPosition eepromPosition, MenuFlags flags, DateStorage initial,
                            MenuCallbackFn callbackFn = nullptr);
 
    TcMenuBuilder& dateItem(menuid_t id, const char *name, EepromPosition eepromPosition, MenuFlags flags, MenuCallbackFn callbackFn = nullptr);
 
    TcMenuBuilder& dateItemCustomRt(menuid_t id, const char *name, EepromPosition eepromPosition, MenuFlags flags, DateStorage initial,
                        RuntimeRenderingFn renderFn, MenuCallbackFn callbackFn = nullptr);

    ScrollChoiceBuilder scrollChoiceBuilder(menuid_t id, const char *name, EepromPosition eepromPosition, MenuFlags flags, uint16_t initial = 0, MenuCallbackFn callbackFn = nullptr);

    TcMenuBuilder& rgb32Item(menuid_t id, const char *name, EepromPosition eepromPosition, bool alphaChannel,
                             MenuFlags flags, MenuCallbackFn callbackFn = nullptr);

    TcMenuBuilder& rgb32Item(menuid_t id, const char *name, EepromPosition eepromPosition, bool alphaChannel,
                             MenuFlags flags, const RgbColor32& initial, MenuCallbackFn callbackFn = nullptr);

    TcMenuBuilder& rgb32CustomRt(menuid_t id, const char *name, EepromPosition eepromPosition, bool alphaChannel,
                                 RuntimeRenderingFn renderFn, MenuFlags flags, const RgbColor32& initial, MenuCallbackFn callbackFn = nullptr);

    TcMenuBuilder& listItemRam(menuid_t id, const char *name, uint16_t numberOfRows, const char** arrayOfItems, MenuFlags flags, MenuCallbackFn callbackFn = nullptr);

    TcMenuBuilder& listItemFlash(menuid_t id, const char *name, uint16_t numberOfRows, const char** arrayOfItems, MenuFlags flags, MenuCallbackFn callbackFn = nullptr);

    TcMenuBuilder& listItemRtCustom(menuid_t id, const char *name, uint16_t numberOfRows, RuntimeRenderingFn rtRenderFn, MenuFlags flags, MenuCallbackFn callbackFn = nullptr);

    TcMenuBuilder& largeNumberItem(menuid_t id, const char *name, EepromPosition eepromPosition, const LargeFixedNumber& num,
                                   bool allowNegative, MenuFlags flags, MenuCallbackFn callbackFn = nullptr);

    TcMenuBuilder& largeNumberRtCustom(menuid_t id, const char *name, EepromPosition eepromPosition, const LargeFixedNumber& num,
                                       bool allowNegative, RuntimeRenderingFn renderFn, MenuFlags flags, MenuCallbackFn callbackFn = nullptr);

    TcMenuBuilder& eepromAuthenticationItem(menuid_t id, const char* name, MenuFlags flags, MenuCallbackFn onAuthChanged = nullptr);

    TcMenuBuilder& remoteConnectivityMonitor(menuid_t id, const char* name, MenuFlags flags);

    TcMenuBuilder& appendCustomItem(MenuItem* itemToAdd);

    TcMenuBuilder& endSub();

    AllMenuInfoTypes* fillInAnyInfo(menuid_t id, const char *name, int eeprom, int maxVal, MenuCallbackFn callback_fn);
 
    void putAtEndOfSub(MenuItem * toAdd) const;
 
    MenuItem * getRootItem() const {
        return currentSub->getChild();
    }
 
private:
    SubMenuItem* currentSub;
    TcMenuBuilder* parent;
 
};
 
#endif //TCLIBRARYDEV_TCMENUBUILDER_H