cArcadeInput.h

///////////////////////////////////////////////////////
//*-------------------------------------------------*//
//| Part of Project One (https://www.maus-games.at) |//
//*-------------------------------------------------*//
//| Copyright (c) 2010 Martin Mauersics             |//
//| Released under the zlib License                 |//
//*-------------------------------------------------*//
///////////////////////////////////////////////////////
#pragma once
#ifndef _P1_GUARD_ARCADEINPUT_H_
#define _P1_GUARD_ARCADEINPUT_H_

// TODO 3: implement string sanitize function, and check function (for save and replay ?)
// TODO 3: require two enter presses to confirm with keyboard input
// TODO 3: cancel feature CORE_INPUT_CHAR(ESCAPE) (check coreTextBox issues) (with message box "do you really want to ...", but makes only sense in volatile situations)
// TODO 3: add blinking label-cursor | (also to engine textbox) (separate object on pos+size.x)
// TODO 3: check if template longer than expected length can cause issues (or shorter)
// TODO 3: \ ^ ° < >


// ****************************************************************
// arcade input definitions
#define ARCADE_PAGES           (ARRAY_SIZE(g_aacArcadeGlyph))                      // 
#define ARCADE_GLYPHS          (ARRAY_SIZE(g_aacArcadeGlyph[0]))                   // 
#define ARCADE_COLUMNS         (9u)                                                // 
#define ARCADE_ROWS            (ARCADE_GLYPHS / ARCADE_COLUMNS)                    // 
#define ARCADE_TEXTS           (1u)                                                // 

#define ARCADE_IS_COMMAND(x,y) (std::iscntrl(coreUint8(g_aacArcadeGlyph[x][y])))   // 
#define ARCADE_COMMAND_ALT     ('\t')                                              // 
#define ARCADE_COMMAND_DEL     (CORE_INPUT_CHAR(BACKSPACE))                        // 
#define ARCADE_COMMAND_END     (CORE_INPUT_CHAR(RETURN))                           // 

// 
alignas(ALIGNMENT_CACHE) static constexpr coreChar g_aacArcadeGlyph[][9 * 5] =
{
    {
        'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I',
        'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R',
        'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z', '0',
        '1', '2', '3', '4', '5', '6', '7', '8', '9',
        '.', ',', '(', ')', '~', ' ',
        ARCADE_COMMAND_ALT,
        ARCADE_COMMAND_DEL,
        ARCADE_COMMAND_END
    },
    {
        'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i',
        'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r',
        's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '#',
        '!', '?', '+', '-', '*', '/', '$', '%', '&',
        ':', ';', '[', ']', '=', '_',
        ARCADE_COMMAND_ALT,
        ARCADE_COMMAND_DEL,
        ARCADE_COMMAND_END
    }
};

STATIC_ASSERT(ARCADE_COLUMNS * ARCADE_ROWS == ARCADE_GLYPHS)


// ****************************************************************
// arcade input class
class cArcadeInput final : public cGuiObject
{
private:
    cGuiObject m_Background;                  // 

    cGuiObject m_aButton   [ARCADE_GLYPHS];   // 
    cGuiLabel  m_aaGlyph[2][ARCADE_GLYPHS];   // 

    cGuiLabel  m_aText[ARCADE_TEXTS];         // 
    coreString m_sTextValue;                  // 
    coreString m_sTextTemplate;               // 
    coreUint8  m_iTextLength;                 // 

    cGuiLabel m_State;                        // 

    coreFlow m_fFlashTime;                    // 

    coreUint8 m_iCurPage;                     // 
    coreUint8 m_iCurGlyph;                    // 
    coreBool  m_bFinished;                    // 

    cMenuNavigator m_Navigator;               // 


public:
    cArcadeInput()noexcept;

    DISABLE_COPY(cArcadeInput)

    // render and move the arcade input
    void Render()final;
    void Move  ()final;

    // 
    void Start(const coreChar* pcTemplate, const coreUint8 iLength);
    void Clear();

    // 
    void OverrideText(const coreChar* pcText);

    // 
    inline void Flash() {m_fFlashTime = 1.0f;}

    // 
    inline const coreChar* GetText    ()const {return m_sTextValue.c_str();}
    inline const coreBool& GetFinished()const {return m_bFinished;}


private:
    // 
    void __MoveCursor(const coreUint8 iNewPage, const coreUint8 iNewGylph);

    // 
    void __SetText(const coreChar* pcText);

    // 
    void __PopCharacter();

    // 
    static void __RetrieveIndex(const coreChar cChar, coreUint8* OUTPUT piPageIndex, coreUint8* OUTPUT piGylphIndex);
};


#endif // _P1_GUARD_ARCADEINPUT_H_