gui-manager.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 GUIMANAGER_H
#define GUIMANAGER_H

#include "common/scummsys.h"
#include "common/singleton.h"
#include "common/stack.h"
#include "common/str.h"
#include "common/list.h"
#include "common/mutex.h"
#include "common/printman.h"

#include "gui/ThemeEngine.h"
#include "gui/widget.h"

class OSystem;

namespace Graphics {
class Font;
class MacWindowManager;
}

namespace Common {
    struct Event;
    class Keymap;
}

namespace GUI {

enum {
    kActionEnd,
    kActionShiftEnd,
    kActionHome,
    kActionShiftHome,
    kActionCopy,
    kActionCut,
    kActionPaste,
};

enum {
    kIconsSetLoadedCmd  = 'icns'
};

class Dialog;
class ThemeEval;
class GuiObject;
class Tooltip;

#define g_gui   (GUI::GuiManager::instance())


// Height of a single text line
#define kLineHeight (g_gui.getFontHeight() + 2)



// Simple dialog stack class
// Anybody nesting dialogs deeper than 4 is mad anyway
typedef Common::FixedStack<Dialog *> DialogStack;


class GuiManager : public Common::Singleton<GuiManager>, public CommandSender {
    friend class Dialog;
    friend class Common::Singleton<SingletonBaseType>;
    GuiManager();
    ~GuiManager() override;
public:

    // Main entry for the GUI: this will start an event loop that keeps running
    // until no dialogs are active anymore.
    void runLoop();

    // If the GUI loop is running close all the dialogs causing the loop to finish.
    // Typically you may want to use it after setting the ConfMan active domain to
    // a game domain to cause the game to start.
    void exitLoop();

    void processEvent(const Common::Event &event, Dialog *const activeDialog);
    Common::Keymap *getKeymap() const;
    void scheduleTopDialogRedraw();
    void scheduleFullRedraw();

    bool isActive() const   { return ! _dialogStack.empty(); }

    bool loadNewTheme(Common::String id, ThemeEngine::GraphicsMode gfx = ThemeEngine::kGfxDisabled, bool force = false);
    ThemeEngine *theme() { return _theme; }

    ThemeEval *xmlEval() { return _theme->getEvaluator(); }

    void lockIconsSet() { _iconsMutex.lock(); }
    void unlockIconsSet()  { _iconsMutex.unlock(); }
    Common::SearchSet &getIconsSet() { return _iconsSet; }

    int16 getGUIWidth() const { return _baseWidth; }
    int16 getGUIHeight() const { return _baseHeight; }
    float getScaleFactor() const { return _scaleFactor; }
    void computeScaleFactor();

    bool useLowResGUI() const { return _baseWidth <= 320; }

    bool useRTL() const { return _useRTL; }
    void setLanguageRTL();

    const Graphics::Font &getFont(ThemeEngine::FontStyle style = ThemeEngine::kFontStyleBold) const { return *(_theme->getFont(style)); }
    int getFontHeight(ThemeEngine::FontStyle style = ThemeEngine::kFontStyleBold) const { return _theme->getFontHeight(style); }
    int getStringWidth(const Common::String &str, ThemeEngine::FontStyle style = ThemeEngine::kFontStyleBold) const { return _theme->getStringWidth(str, style); }
    int getStringWidth(const Common::U32String &str, ThemeEngine::FontStyle style = ThemeEngine::kFontStyleBold) const { return _theme->getStringWidth(str, style); }
    int getCharWidth(uint32 c, ThemeEngine::FontStyle style = ThemeEngine::kFontStyleBold) const { return _theme->getCharWidth(c, style); }
    int getKerningOffset(uint32 left, uint32 right, ThemeEngine::FontStyle font = ThemeEngine::kFontStyleBold) const { return _theme->getKerningOffset(left, right, font); }

    bool checkScreenChange();

    void addToTrash(GuiObject*, Dialog* parent = nullptr);
    void initTextToSpeech();

    bool _launched;

    void redrawFull();

    void initIconsSet();

    void displayTopDialogOnly(bool mode);

    Graphics::MacWindowManager *getWM();

    // Defined in printing-dialog.cpp
    void printImage(const Graphics::ManagedSurface &surf, bool defaultFitToPage, bool defaultCenter, PageOrientation defaultOrientation);
    void printImage(const Graphics::ManagedSurface &surf);

protected:
    enum RedrawStatus {
        kRedrawDisabled = 0,
        kRedrawOpenTooltip,
        kRedrawCloseTooltip,
        kRedrawOpenDialog,
        kRedrawCloseDialog,
        kRedrawTopDialog,
        kRedrawFull
    };

    OSystem         *_system;

    ThemeEngine     *_theme;

//  bool        _needRedraw;
    RedrawStatus _redrawStatus;
    int         _lastScreenChangeID;
    int16       _baseWidth, _baseHeight;
    float       _scaleFactor;
    DialogStack _dialogStack;

    bool        _stateIsSaved;

    bool        _useStdCursor;

    bool        _useRTL;

    bool        _displayTopDialogOnly;

    Common::Mutex _iconsMutex;
    Common::SearchSet _iconsSet;
    bool _iconsSetChanged;

    Graphics::MacWindowManager *_wm = nullptr;

    // position and time of last mouse click (used to detect double clicks)
    struct MousePos {
        MousePos() : x(-1), y(-1), count(0) { time = 0; }
        int16 x, y; // Position of mouse when the click occurred
        uint32 time;    // Time
        int count;  // How often was it already pressed?
    } _lastClick, _lastMousePosition, _globalMousePosition;

    struct TooltipData {
        TooltipData() : x(-1), y(-1), wdg(nullptr) { time = 0; }
        uint32 time; // Time
        Widget *wdg; // Widget that had its tooltip shown
        int16 x, y;  // Position of mouse before tooltip was focused
    } _lastTooltipShown;
    Tooltip *_tooltip;

    // mouse cursor state
    uint32  _cursorAnimateCounter;
    uint32  _cursorAnimateTimer;
    byte    _cursor[2048];

    // delayed deletion of GuiObject
    struct GuiObjectTrashItem {
        GuiObject* object;
        Dialog* parent;
    };
    Common::List<GuiObjectTrashItem> _guiObjectTrash;

    void initKeymap();
    void enableKeymap(bool enabled);

    void saveState();
    void restoreState();

    void openDialog(Dialog *dialog);
    void closeTopDialog();

    void redraw();
    void redrawInternalTopDialogOnly();
    void redrawInternal();

    void setupCursor();
    void animateCursor();

    Dialog *getTopDialog() const;

    void screenChange();

    void giveFocusToDialog(Dialog *dialog);
    void setLastMousePos(int16 x, int16 y);

    void emptyTrash(Dialog *const activeDialog);
};

} // End of namespace GUI

#endif