BaseDialog.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018 https://www.thecoderscorner.com (Dave Cherry).
 * This product is licensed under an Apache license, see the LICENSE file in the top-level directory.
 */
 
#ifndef TCMENU_BASE_DIALOG_H_
#define TCMENU_BASE_DIALOG_H_
 
#define FIRST_DEFAULT_BUTTON 0
#define SECOND_DEFAULT_BUTTON 1
#define CUSTOM_DIALOG_BUTTON_START 2
 
enum ButtonType: uint8_t {
    BTNTYPE_OK, BTNTYPE_ACCEPT, BTNTYPE_CANCEL, BTNTYPE_CLOSE, BTNTYPE_NONE,
    BTNTYPE_CUSTOM0 = 15, BTNTYPE_CUSTOM1, BTNTYPE_CUSTOM2, BTNTYPE_CUSTOM3,
    BTNTYPE_CUSTOM4, BTNTYPE_CUSTOM5, BTNTYPE_CUSTOM6, BTNTYPE_CUSTOM7 };
 
 
class BaseDialog;
typedef void (*CompletedHandlerFn)(ButtonType buttonPressed, void* yourData);
 
#define DLG_FLAG_SMALLDISPLAY 0
#define DLG_FLAG_INUSE 1
#define DLG_FLAG_CAN_SEND_REMOTE 2 
#define DLG_FLAG_MENUITEM_BASED 3
#define DLG_FLAG_NEEDS_RENDERING 4
#define DLG_FLAG_USING_OO_CONTROLLER 5
#define DLG_FLAG_REMOTE_0 8
#define DLG_FLAG_REMOTE_1 9
#define DLG_FLAG_REMOTE_2 10
#define DLG_FLAG_REMOTE_3 11
#define DLG_FLAG_REMOTE_4 12
 
#define DLG_FLAG_REMOTE_MASK 0xff00
 
#define DLG_VISIBLE 'S'
#define DLG_HIDDEN 'H'
#define DLG_ACTION 'A'
 
class TagValueRemoteConnector; // forward reference
 
class BaseDialogController {
public:
    virtual void initialiseAndGetHeader(BaseDialog* dialog, char* buffer, size_t bufferSize)=0;
    virtual void dialogDismissed(ButtonType buttonType)=0;
 
    virtual bool dialogButtonPressed(int buttonNum)=0;
 
    virtual void copyCustomButtonText(int buttonNumber, char* buffer, size_t bufferSize)=0;
};
 
class BaseDialog {
protected:
    char header[20];
    const char* headerPgm; // for backwards compatibility with 1.7, not used in 2.0
    union {
        BaseDialogController* controller;
        CompletedHandlerFn completedHandler;
    };
    void* userData;
    ButtonType button1;
    ButtonType button2;
    uint8_t lastBtnVal;
    uint16_t flags;
    MenuRedrawState needsDrawing;
public:
    BaseDialog();
    virtual ~BaseDialog() = default;
 
    void setButtons(ButtonType btn1, ButtonType btn2, int defVal = 0);
 
    void show(const char* headerPgm, bool allowRemote, CompletedHandlerFn completedHandler = NULL);
 
    void showRam(const char* headerRam, bool allowRemote, CompletedHandlerFn completedHandler = NULL);
 
    void showController(bool allowRemote, BaseDialogController* controller);
 
    void setUserData(void *data) { this->userData = data; }
 
    virtual void copyIntoBuffer(const char* sz);
 
    virtual void internalSetVisible(bool visible);
 
    virtual char* getBufferData();
 
    void hide();
 
    bool isUsingOOController() { return bitRead(flags, DLG_FLAG_USING_OO_CONTROLLER); }
 
    bool isInUse() {return bitRead(flags, DLG_FLAG_INUSE);}
 
    bool isCompressedMode() {return bitRead(flags, DLG_FLAG_SMALLDISPLAY);}
 
    void dialogRendering(unsigned int currentValue, bool userClicked);
 
    bool isMenuItemBased() { return bitRead(flags, DLG_FLAG_MENUITEM_BASED); }
    bool isRenderNeeded() { return bitRead(flags, DLG_FLAG_NEEDS_RENDERING); }
    bool isRemoteUpdateNeeded(int remote) { return bitRead(flags, remote + DLG_FLAG_REMOTE_0) && bitRead(flags, DLG_FLAG_CAN_SEND_REMOTE); }
    void setRemoteUpdateNeeded(int remote, bool b) { bitWrite(flags, remote + DLG_FLAG_REMOTE_0, b); }
    void setRemoteUpdateNeededAll() { flags |= DLG_FLAG_REMOTE_MASK; }
    void clearRemoteUpdateNeededAll() { flags &= ~DLG_FLAG_REMOTE_MASK; }
    void setRemoteAllowed(bool allowed) {bitWrite(flags, DLG_FLAG_CAN_SEND_REMOTE, allowed); }
 
    void encodeMessage(TagValueRemoteConnector* remote);
    void remoteAction(ButtonType type);
 
    bool copyButtonText(char* data, int buttonNum, int currentValue, bool isActive);
 
    bool copyButtonText(char* data, int buttonNum, int currentValue) {
        return copyButtonText(data, buttonNum, currentValue, buttonNum == currentValue);
    }
 
    void actionPerformed(int btnNum);
protected:
    void setInUse(bool b) {bitWrite(flags, DLG_FLAG_INUSE, b);}
 
    virtual void internalRender(int currentValue)=0;
 
    void setNeedsDrawing(bool b) {
        if(b && needsDrawing == MENUDRAW_COMPLETE_REDRAW) return;
        needsDrawing = b ? MENUDRAW_EDITOR_CHANGE : MENUDRAW_NO_CHANGE;
    }
 
    ButtonType findActiveBtn(unsigned int currentValue);
 
    void internalShow(bool allowRemote);
};
 
int dialogButtonRenderFn(RuntimeMenuItem* item, uint8_t /*row*/, RenderFnMode mode, char* buffer, int bufferSize);
 
class LocalDialogButtonMenuItem : public RuntimeMenuItem {
private:
    uint8_t buttonNumber;
public:
    LocalDialogButtonMenuItem(RuntimeRenderingFn renderFn, menuid_t id, int btnNum, MenuItem* next)
            : RuntimeMenuItem(MENUTYPE_DIALOG_BUTTON, id, renderFn, 0, 1, next), buttonNumber(btnNum) {
        setLocalOnly(true);
    }
    int getButtonNumber() { return  buttonNumber; }
};
 
#define FIRST_USER_BUTTON_NUM 2
 
class MenuBasedDialog : public BaseDialog {
private:
    BackMenuItem backItem;
    TextMenuItem bufferItem;
    LocalDialogButtonMenuItem btn1Item;
    LocalDialogButtonMenuItem btn2Item;
    int addedMenuItems;
public:
    MenuBasedDialog();
    ~MenuBasedDialog() override = default;
 
    uint16_t getBackMenuItemId() { return backItem.getId(); }
 
    void internalSetVisible(bool visible) override;
    void copyIntoBuffer(const char *sz) override;
 
    void insertMenuItem(MenuItem* item);
 
    void copyHeader(char *buffer, int bufferSize);
 
    char* getBufferData() override { return const_cast<char *>(bufferItem.getTextValue()); }
 
    TextMenuItem* getBufferMenuItem() { return &bufferItem; }
 
protected:
    void internalRender(int currentValue) override {}
 
    void resetDialogFields();
};
 
typedef void (*DialogInitialiser)(MenuBasedDialog*);
 
void withMenuDialogIfAvailable(DialogInitialiser dlgFn);
 
#endif //TCMENU_BASE_DIALOG_H_