menu.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program 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.
 *
 * This program 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef ALCACHOFA_MENU_H
#define ALCACHOFA_MENU_H

#include "common/savefile.h"

namespace Alcachofa {

class Room;
class SlideButton;

// the order of these enums are compatible to V3 the first to be developed
// any other version needs some translation

enum class MainMenuAction : int32 {
    ContinueGame = 0,
    Save,
    Load,
    InternetMenu,
    OptionsMenu,
    Exit,
    NextSave,
    PrevSave,
    NewGame, // unused in any game
    AlsoExit, // there seems to be no difference to Exit

    ConfirmSavestate, // only used in V1
    Accept, // only used in V2
    Cancel, // only used in V2
};

enum class OptionsMenuAction : int32 {
    SubtitlesOn = 0,
    SubtitlesOff,
    HighQuality,
    LowQuality,
    Bits32,
    Bits16,
    MainMenu,

    Cursor0, // only used in V2
    Cursor1,
    Cursor2,
    Cursor3,
};

enum class OptionsMenuValue : int32 {
    Music = 0,
    Speech = 1,
    Sensitivity = 2 // only used in V2 and no effect for ScummVM
};

class Menu {
public:
    static Menu *create();
    Menu();
    virtual ~Menu();

    inline bool isOpen() const { return _isOpen; }
    inline uint32 millisBeforeMenu() const { return _millisBeforeMenu; }
    inline Room *previousRoom() { return _previousRoom; }
    inline FakeSemaphore &interactionSemaphore() { return _interactionSemaphore; }
    inline SlideButton *&currentSlideButton() { return _currentSlideButton; }

    void triggerLoad();
    void resetAfterLoad();
    virtual void updateOpeningMenu();

    virtual void triggerMainMenuAction(MainMenuAction action);
    void triggerOptionsAction(OptionsMenuAction action);
    void triggerOptionsValue(OptionsMenuValue valueId, float value);

    // if we do still have a big thumbnail, any autosaves, ScummVM-saves, ingame-saves
    // do not have to render themselves, they can just reuse the one we have.
    // as such - may return nullptr
    const Graphics::Surface *getBigThumbnail() const;

protected:
    inline bool isOnNewSlot() const { return _selectedSavefileI >= _savefiles.size(); }
    virtual void updateSelectedSavefile(bool hasJustSaved);
    virtual void setOptionsState() = 0;

    void openOptionsMenu();
    void triggerSave();
    bool tryReadOldSavefile();
    void continueGame();
    void continueMainMenu();

    bool
        _isOpen = false,
        _openAtNextFrame = false;
    uint32
        _millisBeforeMenu = 0,
        _selectedSavefileI = 0;
    Room *_previousRoom = nullptr;
    FakeSemaphore _interactionSemaphore; // to prevent ScummVM loading during button clicks
    SlideButton *_currentSlideButton = nullptr; // due to V2 we cannot store this in OptionsMenu
    Common::String _selectedSavefileDescription = "<unset>";
    Common::Array<Common::String> _savefiles;
    Graphics::ManagedSurface
        _bigThumbnail, // big because it is for the in-game menu, not for ScummVM
        _selectedThumbnail;
    Common::SaveFileManager *_saveFileMgr;
};

class MenuV3 : public Menu {
public:
    void triggerMainMenuAction(MainMenuAction action) override;

protected:
    void updateSelectedSavefile(bool hasJustSaved) override;
    void setOptionsState() override;
};

class MenuV2 : public Menu {
public:
    void updateOpeningMenu() override;
    void triggerMainMenuAction(MainMenuAction action) override;

protected:
    void updateSelectedSavefile(bool hasJustSaved) override;
    void setOptionsState() override;
    void toggleMessageBox(bool show);
};

class MenuV1 : public Menu {
public:
    void updateOpeningMenu() override;
    void triggerMainMenuAction(MainMenuAction action) override;

protected:
    void updateSelectedSavefile(bool hasJustSaved) override;
    void setOptionsState() override;

private:
    friend class ButtonV1;
    void switchToState(MainMenuAction state);

    MainMenuAction _currentState = MainMenuAction::ConfirmSavestate;
};

}

#endif // ALCACHOFA_MENU_H