cursorman.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_CURSORMAN_H
#define GRAPHICS_CURSORMAN_H

#include "common/scummsys.h"
#include "common/stack.h"
#include "common/singleton.h"
#include "common/frac.h"
#include "graphics/cursor.h"
#include "graphics/surface.h"

namespace Graphics {

class CursorManager : public Common::Singleton<CursorManager> {
public:
    bool isVisible();

    bool showMouse(bool visible);

    void pushCursor(const void *buf, uint w, uint h, int hotspotX, int hotspotY, uint32 keycolor, const Graphics::PixelFormat *format = NULL, const byte *mask = nullptr, frac_t scaleX = FRAC_ONE, frac_t scaleY = FRAC_ONE);

    void pushCursor(const Surface &surf, int hotspotX, int hotspotY, uint32 keycolor, const byte *mask = nullptr, frac_t scaleX = FRAC_ONE, frac_t scaleY = FRAC_ONE);

    void popCursor();

    void replaceCursor(const void *buf, uint w, uint h, int hotspotX, int hotspotY, uint32 keycolor, const Graphics::PixelFormat *format = nullptr, const byte *mask = nullptr, frac_t scaleX = FRAC_ONE, frac_t scaleY = FRAC_ONE);

    void replaceCursor(const Surface &surf, int hotspotX, int hotspotY, uint32 keycolor, const byte *mask = nullptr, frac_t scaleX = FRAC_ONE, frac_t scaleY = FRAC_ONE);

    void replaceCursor(const Graphics::Cursor *cursor, frac_t scaleX = FRAC_ONE, frac_t scaleY = FRAC_ONE);

    void popAllCursors();

    bool supportsCursorPalettes();

    void disableCursorPalette(bool disable);

    void pushCursorPalette(const byte *colors, uint start, uint num);

    void popCursorPalette();

    void replaceCursorPalette(const byte *colors, uint start, uint num);

    void lock(bool locked);

    void setDefaultArrowCursor(bool push = false);

private:
    friend class Common::Singleton<SingletonBaseType>;
    // Even though this is basically the default constructor we implement it
    // ourselves, so it is private and thus there is no way to create this class
    // except from the Singleton code.
    CursorManager() {
        _locked = false;
    }
    ~CursorManager();

    struct Cursor {
        Surface _surf;
        byte *_mask;
        bool _visible;
        int _hotspotX;
        int _hotspotY;
        uint32 _keycolor;
        frac_t _scaleX;
        frac_t _scaleY;

        uint _size;

        // _surf set to default by Graphics::Surface default constructor
        Cursor() : _mask(0), _visible(false), _hotspotX(0), _hotspotY(0), _keycolor(0), _scaleX(FRAC_ONE), _scaleY(FRAC_ONE), _size(0) {}

        Cursor(const Surface &surf, int hotspotX, int hotspotY, uint32 keycolor, const byte *mask, frac_t scaleX, frac_t scaleY);
        ~Cursor();
    };

    struct Palette {
        byte *_data;
        uint _start;
        uint _num;
        uint _size;

        bool _disabled;

        Palette() : _data(0), _start(0), _num(0), _size(0), _disabled(false) {}

        Palette(const byte *colors, uint start, uint num);
        ~Palette();
    };
    Common::Stack<Cursor *> _cursorStack;
    Common::Stack<Palette *> _cursorPaletteStack;
    bool _locked;

    bool systemSupportsCursorMask(const byte *mask, uint width, uint height);
};
} // End of namespace Graphics

#define CursorMan   (::Graphics::CursorManager::instance())

#endif