macwindowmanager.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 GRAPHICS_MACGUI_MACWINDOWMANAGER_H
#define GRAPHICS_MACGUI_MACWINDOWMANAGER_H

#include "common/hashmap.h"
#include "common/list.h"
#include "common/mutex.h"
#include "common/stack.h"
#include "common/events.h"

#include "graphics/font.h"
#include "graphics/fontman.h"
#include "graphics/palette.h"
#include "graphics/macgui/macwindow.h"
#include "graphics/macgui/macmenu.h"

#include "engines/engine.h"

namespace Common {
class Archive;
}

namespace Graphics {

namespace MacGUIConstants {
enum {
    kDesktopArc = 7
};

enum {
    kColorBlack = 0,
    kColorGray80 = 1,
    kColorGray88 = 2,
    kColorGrayEE = 3,
    kColorWhite = 4,
    kColorGreen = 5,
    kColorGreen2 = 6,
    kColorCount
};

enum {
    kPatternSolid = 1,
    kPatternStripes = 2,
    kPatternCheckers = 3,
    kPatternCheckers2 = 4,
    kPatternLightGray = 5,
    kPatternDarkGray = 6
};

enum MacCursorType {
    kMacCursorArrow,
    kMacCursorBeam,
    kMacCursorCrossHair,
    kMacCursorCrossBar,
    kMacCursorWatch,
    kMacCursorCustom,
    kMacCursorOff
};

enum {
    kWMModeNone                 = 0,
    kWMModeNoDesktop            = (1 << 0),
    kWMModeAutohideMenu         = (1 << 1),
    kWMModalMenuMode            = (1 << 2),
    kWMModeForceBuiltinFonts    = (1 << 3),
    kWMModeUnicode              = (1 << 4),
    kWMModeManualDrawWidgets    = (1 << 5),
    kWMModeFullscreen           = (1 << 6),
    kWMModeButtonDialogStyle    = (1 << 7),
    kWMNoScummVMWallpaper       = (1 << 8),
    kWMModeWin95                = (1 << 9),
    kWMModeForceMacFontsInWin95 = (1 << 10), // Enforce Mac font for languages which don't have glyphs in ms_sans_serif.ttf
    kWMModeNoCursorOverride     = (1 << 11),
    kWMModeForceMacBorder       = (1 << 12),
    kWMModeForceMacFonts        = (1 << 13), // Enforce Mac fonts even when there are viable TTF substitutions
    kWMModeNoSystemRedraw       = (1 << 14), // Skip g_system->copyRectToScreen (for 3D game backends)
};

}
using namespace MacGUIConstants;

class Cursor;

class ManagedSurface;

class MacCursor;
class MacMenu;
class MacTextWindow;
class MacWidget;

class MacFont;

class MacFontManager;

typedef Common::Array<const byte *> MacPatterns;

struct MacPlotData {
    Graphics::ManagedSurface *surface;
    Graphics::ManagedSurface *mask;
    MacPatterns *patterns;
    uint fillType;
    int fillOriginX;
    int fillOriginY;
    int thickness;
    uint bgColor;
    bool invert;

    MacPlotData(Graphics::ManagedSurface *s, Graphics::ManagedSurface *m, MacPatterns *p, uint f, int fx, int fy, int t, uint bg, bool inv = false) :
        surface(s), mask(m), patterns(p), fillType(f), fillOriginX(fx), fillOriginY(fy), thickness(t), bgColor(bg), invert(inv) {
    }
};

struct ZoomBox {
    Common::Rect start;
    Common::Rect end;
    Common::Array<Common::Rect> last;
    int delay;
    int step;
    uint32 startTime;
    uint32 nextTime;
};

class MacWindowManager {
public:
    MacWindowManager(uint32 mode = 0, MacPatterns *patterns = nullptr, Common::Language language = Common::UNK_LANG,
                     const Graphics::PixelFormat &pixelFormat = Graphics::PixelFormat::createFormatCLUT8());
    ~MacWindowManager();

    Primitives &getDrawPrimitives() const { return *_macDrawPrimitives; }
    Primitives &getDrawInvertPrimitives() const;

    void setScreen(ManagedSurface *screen);

    void setScreen(int w, int h);

    int getWidth();

    int getHeight();

    MacWindow *addWindow(bool scrollable, bool resizable, bool editable);
    MacTextWindow *addTextWindow(const MacFont *font, int fgcolor, int bgcolor, int maxWidth, TextAlign textAlignment, MacMenu *menu, int padding = 0);
    MacTextWindow *addTextWindow(const Font *font, int fgcolor, int bgcolor, int maxWidth, TextAlign textAlignment, MacMenu *menu, int padding = 0);
    void resizeScreen(int w, int h);

    void addWindowInitialized(MacWindow *macwindow);
    int getLastId() { return _lastId; }
    int getNextId() { return _lastId++; }
    MacMenu *addMenu();
    void addMenu(int id, MacMenu *menu);

    void removeMenu();
    void activateMenu();

    void activateScreenCopy();
    void disableScreenCopy();

    bool isMenuActive();
    void setDesktopMode(uint32 mode);

    void setMenuHotzone(const Common::Rect &rect) { _menuHotzone = rect; }

    void setMenuDelay(int delay) { _menuDelay = delay; }

    void setActiveWindow(int id);

    int getActiveWindow() { return _activeWindow; }

    MacWindow *findWindowAtPoint(int16 x, int16 y);
    MacWindow *findWindowAtPoint(Common::Point point);

    void removeWindow(MacWindow *target);

    void setFullRefresh(bool redraw) { _fullRefresh = redraw; }

    void draw();

    bool processEvent(Common::Event &event);

    BaseMacWindow *getWindow(int id) {
        if (id >= 0 && id < (int)_windows.size())
            return _windows[id];
        return nullptr;
    }

    MacPatterns &getPatterns() { return _patterns; }

    void setActiveWidget(MacWidget *widget);

    void setLockedWidget(MacWidget *widget);

    void setBackgroundWindow(MacWindow *window);

    MacPatterns  &getBuiltinPatterns() { return _builtinPatterns; }

    MacWidget *getActiveWidget() { return _activeWidget; }
    MacWidget *getLockedWidget() { return _lockedWidget; }

    Common::Rect getScreenBounds() { return _screen ? _screen->getBounds() : _screenDims; }

    void clearWidgetRefs(MacWidget *widget);

    void printWMMode(int debuglevel = 0);

private:
    void replaceCursorType(MacCursorType type);

public:
    MacCursorType getCursorType() const;
    static bool getBuiltInCursorData(MacCursorType type, const byte *&data, const byte *&palette,
        const byte *&mask, int &w, int &h, int &hotspotX, int &hotspotY, int &transColor);

    void pushCursor(MacCursorType type, Cursor *cursor = nullptr);
    void replaceCursor(MacCursorType type, Cursor *cursor = nullptr);

    void pushCustomCursor(const byte *data, int w, int h, int hx, int hy, int transcolor);
    void replaceCustomCursor(const byte *data, int w, int h, int hx, int hy, int transcolor);
    void pushCustomCursor(const Graphics::Cursor *cursor);
    void popCursor();

    PauseToken pauseEngine();

    void setMode(uint32 mode);

    void setEngine(Engine *engine);
    void setEngineRedrawCallback(void *engine, void (*redrawCallback)(void *engine));
    void setEngineActivateMenuCallback(void *engine, void (*redrawCallback)(void *engine));

    void passPalette(const byte *palette, uint size);
    void getPaletteEntry(uint32 color, byte &r, byte &g, byte &b);
    uint32 findBestColor(byte cr, byte cg, byte cb);
    void setDesktopColor(byte, byte, byte);

    byte inverter(byte src);

    const byte *getPalette() { return _palette; }
    uint getPaletteSize() { return _paletteSize; }

    void renderZoomBox(bool redraw = false);
    void addZoomBox(ZoomBox *box);

    void removeMarked();

    void loadDataBundle();
    void cleanupDataBundle();
    void cleanupDesktopBmp();

    const BorderOffsets &getBorderOffsets(uint32 windowType);
    Common::SeekableReadStream *getBorderFile(uint32 windowType, uint32 flags);
    Common::SeekableReadStream *getFile(const Common::Path &filename);

    void setTextInClipboard(const Common::U32String &str);
    Common::U32String getTextFromClipboard(const Common::U32String &format = Common::U32String(), int *size = nullptr);

    void clearHandlingWidgets();

    void setMenuItemCheckMark(MacMenuItem *menuItem, bool checkMark);
    void setMenuItemEnabled(MacMenuItem *menuItem, bool enabled);
    void setMenuItemName(MacMenuItem *menuItem, const Common::String &name);
    void setMenuItemAction(MacMenuItem *menuItem, int actionId);

    bool getMenuItemCheckMark(MacMenuItem *menuItem);
    bool getMenuItemEnabled(MacMenuItem *menuItem);
    Common::String getMenuItemName(MacMenuItem *menuItem);
    int getMenuItemAction(MacMenuItem *menuItem);
    MacMenu *getMenu();
    MacMenu *getMenu(int id);

    void sayText(const Common::U32String &text) const;
    void setTTSEnabled(bool enabled);

public:
    MacFontManager *_fontMan;
    uint32 _mode;
    Common::Language _language;

    Common::Point _lastClickPos;
    Common::Point _lastMousePos;
    Common::Rect _menuHotzone;

    uint32 _menuTimer;
    bool _mouseDown;

    uint32 _colorBlack, _colorGray80, _colorGray88, _colorGrayEE, _colorWhite, _colorGreen, _colorGreen2;

    MacWidget *_hoveredWidget;

    // we use it to indicate whether we are clicking the hilite-able widget.
    // In list style button mode, we will highlight the subsequent buttons only when we've clicked the hilite-able button initially
    bool _hilitingWidget;

private:
    void loadDesktop();
    void drawDesktop();

    void removeFromStack(BaseMacWindow *target);
    void removeFromWindowList(BaseMacWindow *target);

    void zoomBoxInner(Common::Rect &r, Graphics::MacPlotData &pd);
    bool haveZoomBox() { return !_zoomBoxes.empty(); }

    void adjustDimensions(const Common::Rect &clip, const Common::Rect &dims, int &adjWidth, int &adjHeight);

public:
    Surface *_desktopBmp;
    ManagedSurface *_desktop;
    PixelFormat _pixelformat;

    ManagedSurface *_screen;
    ManagedSurface *_screenCopy;
    Common::Rect _screenDims;

private:
    Common::Mutex _mutex;
    Common::List<BaseMacWindow *> _windowStack;
    Common::HashMap<uint, BaseMacWindow *> _windows;

    Common::List<BaseMacWindow *> _windowsToRemove;
    bool _needsRemoval;

    int _lastId;
    int _activeWindow;

    bool _fullRefresh;

    bool _inEditableArea;

    Primitives *_macDrawPrimitives;
    Primitives *_macDrawInvertPrimitives;

    MacPatterns _patterns;
    MacPatterns _builtinPatterns;
    byte *_palette;
    uint _paletteSize;

    MacMenu *_menu;
    uint32 _menuDelay;

    Engine *_engineP;
    void *_engineR;
    void (*_redrawEngineCallback)(void *engine);
    void *_engineAM;
    void (*_activateMenuCallback)(void *engine);

    MacCursorType _tempType = kMacCursorArrow;
    Common::Stack<MacCursorType> _cursorTypeStack;
    Cursor *_cursor = nullptr;

    MacWidget *_activeWidget;
    MacWidget *_lockedWidget;
    MacWindow *_backgroundWindow;

    PauseToken *_screenCopyPauseToken;

    Common::Array<ZoomBox *> _zoomBoxes;
    Graphics::PaletteLookup _paletteLookup;
    Common::HashMap<uint, uint> _invertColorHash;

    Common::Archive *_dataBundle;

    Common::U32String _clipboard;

    bool _ttsEnabled;
};

const Common::U32String::value_type *readHex(uint16 *res, const Common::U32String::value_type *s, int len);

} // End of namespace Graphics

#endif