OperatorMenus.h

/**************************************************************************
 *     This file is part of the RPU OS for Arduino Project.

    I, Dick Hamill, the author of this program disclaim all copyright
    in order to make this program freely available in perpetuity to
    anyone who would like to use it. Dick Hamill, 12/7/2024

    RPU OS is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    RPU OS is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    See <https://www.gnu.org/licenses/>.
 */


#ifndef OPERATOR_MENUS_H
#define OPERATOR_MENUS_H

#ifdef OPERATOR_MENUS_CPP
#define NUM_CPC_PAIRS 9
extern boolean CPCSelectionsHaveBeenRead;
extern byte CPCPairs[NUM_CPC_PAIRS][2];
extern byte CPCSelection[3];
#endif

#define OPERATOR_MENU_ADJ_TYPE_LIST                 1
#define OPERATOR_MENU_ADJ_TYPE_MIN_MAX              2
#define OPERATOR_MENU_ADJ_TYPE_MIN_MAX_DEFAULT      3
#define OPERATOR_MENU_ADJ_TYPE_SCORE                4
#define OPERATOR_MENU_ADJ_TYPE_SCORE_WITH_DEFAULT   5
#define OPERATOR_MENU_ADJ_TYPE_SCORE_NO_DEFAULT     6
#define OPERATOR_MENU_ADJ_TYPE_CPC                  7
#define OPERATOR_MENU_AUD_DISPLAY_ONLY              10
#define OPERATOR_MENU_AUD_CLEARABLE                 11

#define OPERATOR_MENU_BUTTON_UNDEFINED   0xF0

#define OPERATOR_MENU_RETURN_TO_GAME      0
#define OPERATOR_MENU_SELF_TEST_MENU      1
#define OPERATOR_MENU_AUDITS_MENU         2
#define OPERATOR_MENU_BASIC_ADJ_MENU      3
#define OPERATOR_MENU_GAME_RULES_LEVEL    4
#define OPERATOR_MENU_GAME_ADJ_MENU       5
#define OPERATOR_MENU_NOT_ACTIVE          0xFF

#define OPERATOR_MENU_TEST_LAMPS          0
#define OPERATOR_MENU_TEST_DISPLAYS       1
#define OPERATOR_MENU_TEST_SOLENOIDS      2
#define OPERATOR_MENU_TEST_SWITCHES       3
#define OPERATOR_MENU_TEST_SOUNDS         4
#define OPERATOR_MENU_TEST_EJECT_BALLS    5

#define OPERATOR_MENU_VALUE_UNUSED        0xFD
#define OPERATOR_MENU_VALUE_OUT_OF_RANGE  0xFE


class OperatorMenus
{
  public:
    OperatorMenus();
    ~OperatorMenus();
    
    void    SetLastChangedTime(unsigned long setSelfTestChange);
    void    SetNavigationButtons(byte forwardButtonNum, byte backButtonNum, byte enterButtonNum, byte menuButtonNum);
    void    SetMenuButtonDebounce(short menuButtonDebounce);

    unsigned long GetLastChangedTime();
    
    void    EnterOperatorMenu();
    void    ExitOperatorMenu();
    boolean OperatorMenusActive();
    boolean HasTopLevelChanged();
    byte    GetTopLevel();
    boolean HasSubLevelChanged();
    byte    GetSubLevel();
    void    SetNumSubLevels(byte numSubLevels);
    boolean HasParameterChanged();
    byte    GetParameterID();
    boolean BallEjectInProgress(boolean startBallEject = false);
    void    SetCreditAndBIPRestore(byte creditRestore, byte bipRestore);
    unsigned short GetParameterCallout();

    void    SetParameterControls(   byte adjustmentType, byte numAdjustmentValues, byte *adjustmentValues,
                                    short parameterCallout, short currentAdjustmentStorageByte, 
                                    byte *currentAdjustmentByte, unsigned long *currentAdjustmentUL );
    void    SetAuditControls( unsigned long *currentAuditUL, short currentAuditStorageByte, byte adjustmentType );                                    
    void    SetLampsLookupCallback(byte (*lampLookup)(byte));
    void    SetSolenoidIDLookupCallback(unsigned short (*solenoidIDLookup)(byte));
    void    SetSolenoidStrengthLookupCallback(byte (*solenoidStrengthLookup)(byte));
    void    SetSoundCallbackFunction(byte (*soundCallback)(byte));
    void    SetDisplayTestCallback(byte (*displayTestCallback)(byte, byte, byte));
    int     UpdateMenu(unsigned long currentTime);    

  private:
    byte TopLevel;
    byte SubLevel;
    byte ForwardButton;
    byte BackButton;
    byte EnterButton;
    byte MenuButton;
    byte NumSubLevels;
    byte LastSwitchSeen;
    byte CreditRestore;
    byte BIPRestore;
    byte NumSpeedyChanges;
    short MenuButtonDebounce;
    boolean TopLevelChanged;
    boolean SubLevelChanged;
    boolean ParameterChanged;
    boolean EjectBalls;
    unsigned long LastMenuButtonSeenTime;    
  
    byte AdjustmentType;
    byte NumAdjustmentValues;
    byte AdjustmentValues[8];    
    short CurrentAdjustmentStorageByte;
    byte *CurrentAdjustmentByte;
    byte ParameterID;
    short ParameterCallout;    
    unsigned long *CurrentAdjustmentUL;
    unsigned long SoundSettingTimeout;
    unsigned long AdjustmentScore;

    byte NextTestValue;
    byte LastTestValue;
    byte TestDelay;
    boolean CycleTest;
    
    boolean SolenoidStackStateOnEntry;
    boolean FlipperStateOnEntry;
    
    unsigned long LastTestTime;
    unsigned long SavedValue;
    unsigned long ResetHold;
    unsigned long NextSpeedyValueChange;
    unsigned long LastResetPress;

    void StartSubMenu(unsigned long currentTime);
    boolean AdvanceTopMenu(boolean moveForward);
    boolean AdvanceSubMenu(boolean moveForward, boolean loopMenu, unsigned long currentTime);
    
    void StartTestMode(unsigned long currentTime);
    void UpdateSelfTest(unsigned long currentTime);
    void ReadCurrentSwitches();
    byte GetDisplayMaskForSwitches(byte switch1, byte switch2);
    void HandleEnterButton(boolean doubleClick=false, boolean resetHeld=false, boolean speedyChange=false);
    void ShowParameterValue();
    void ShowAuditValue();

    byte (*LampLookupFunction)(byte);
    byte (*SolenoidStrengthLookupFunction)(byte);
    byte (*SoundTestCallback)(byte);
    byte (*DisplayTestCallback)(byte, byte, byte);
    unsigned short (*SolenoidIDLookupFunction)(byte);
};





#endif