stk-code_catmod/lib/irrlicht/source/Irrlicht/CIrrDeviceWayland.h

//
//  SuperTuxKart - a fun racing game with go-kart
//  Copyright (C) 2016-2017 Dawid Gan
//
//  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, write to the Free Software
//  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

#ifndef CIRRDEVICEWAYLAND_H
#define CIRRDEVICEWAYLAND_H

#include "IrrCompileConfig.h"

#ifdef _IRR_COMPILE_WITH_WAYLAND_DEVICE_

#include "CIrrDeviceStub.h"
#include "IImagePresenter.h"
#include "ICursorControl.h"
#include "server_decoration_client_protocol.h"
#include "xdg-shell-unstable-v6-client-protocol.h"

#include <wayland-client.h>
#include <wayland-cursor.h>
#include <wayland-egl.h>
#include <xkbcommon/xkbcommon.h>
#include <xkbcommon/xkbcommon-compose.h>

#include <map>
#include <vector>

class ContextManagerEGL;

namespace irr
{
    class CIrrDeviceWayland : public CIrrDeviceStub,
                              public video::IImagePresenter
    {
    public:
        friend class WaylandCallbacks;

        //! constructor
        CIrrDeviceWayland(const SIrrlichtCreationParameters& param);

        //! destructor
        virtual ~CIrrDeviceWayland();

        //! runs the device. Returns false if device wants to be deleted
        virtual bool run();

        //! Cause the device to temporarily pause execution and let other
        //! processes to run. This should bring down processor usage without
        //! major performance loss for Irrlicht
        virtual void yield();

        //! Pause execution and let other processes to run for a specified
        //! amount of time.
        virtual void sleep(u32 timeMs, bool pauseTimer);

        //! sets the caption of the window
        virtual void setWindowCaption(const wchar_t* text);

        //! sets the class of the window
        virtual void setWindowClass(const char* text);

        //! returns if window is active. if not, nothing need to be drawn
        virtual bool isWindowActive() const;

        //! returns if window has focus.
        virtual bool isWindowFocused() const;

        //! returns if window is minimized.
        virtual bool isWindowMinimized() const;

        //! returns color format of the window.
        virtual video::ECOLOR_FORMAT getColorFormat() const;

        //! presents a surface in the client area
        virtual bool present(video::IImage* surface, void* windowId=0,
                             core::rect<s32>* src=0);

        //! notifies the device that it should close itself
        virtual void closeDevice();

        //! \return Returns a pointer to a list with all video modes
        //! supported by the gfx adapter.
        video::IVideoModeList* getVideoModeList();

        //! Sets if the window should be resizable in windowed mode.
        virtual void setResizable(bool resize=false);

        //! Minimizes the window.
        virtual void minimizeWindow();

        //! Maximizes the window.
        virtual void maximizeWindow();

        //! Restores the window size.
        virtual void restoreWindow();
        
        //! Move window to requested position
        virtual bool moveWindow(int x, int y);

        //! Get current window position.
        virtual bool getWindowPosition(int* x, int* y);

        //! Activate any joysticks, and generate events for them.
        virtual bool activateJoysticks(core::array<SJoystickInfo>& joystickInfo);

        //! Set the current Gamma Value for the Display
        virtual bool setGammaRamp(f32 red, f32 green, f32 blue,
                                  f32 brightness, f32 contrast);

        //! Get the current Gamma Value for the Display
        virtual bool getGammaRamp(f32 &red, f32 &green, f32 &blue,
                                  f32 &brightness, f32 &contrast);

        //! gets text from the clipboard
        //! \return Returns 0 if no string is in there.
        virtual const c8* getTextFromClipboard() const;

        //! copies text to the clipboard
        virtual void copyToClipboard(const c8* text) const;

        //! Remove all messages pending in the system message loop
        virtual void clearSystemMessages();

        //! Get the device type
        virtual E_DEVICE_TYPE getType() const
        {
                return EIDT_WAYLAND;
        }

        static bool isWaylandDeviceWorking();

        ContextManagerEGL* getEGLContext() {return m_egl_context;}
        void updateCursor();
        unsigned int getWidth() {return m_width;}
        unsigned int getHeight() {return m_height;}

    private:

        #if defined(_IRR_COMPILE_WITH_JOYSTICK_EVENTS_)
        struct JoystickInfo
        {
            int fd;
            int axes;
            int buttons;
            SEvent persistentData;

            JoystickInfo() : fd(-1), axes(0), buttons(0) { }
        };

        core::array<JoystickInfo> m_active_joysticks;
        #endif

        wl_compositor* m_compositor;
        wl_cursor* m_cursor;
        wl_cursor_theme* m_cursor_theme;
        wl_display* m_display;
        wl_egl_window* m_egl_window;
        wl_keyboard* m_keyboard;
        wl_output* m_output;
        wl_pointer* m_pointer;
        wl_registry* m_registry;
        wl_seat* m_seat;
        //~ wl_shell* m_shell;
        //~ wl_shell_surface* m_shell_surface;
        wl_shm* m_shm;
        wl_surface* m_cursor_surface;
        wl_surface* m_surface;
        uint32_t m_enter_serial;
        
        zxdg_shell_v6* m_xdg_shell;
        zxdg_surface_v6* m_xdg_surface;
        zxdg_toplevel_v6* m_xdg_toplevel;
        
        org_kde_kwin_server_decoration_manager* m_decoration_manager;
        org_kde_kwin_server_decoration* m_decoration;

        xkb_context* m_xkb_context;
        xkb_compose_table* m_xkb_compose_table;
        xkb_compose_state* m_xkb_compose_state;
        xkb_keymap* m_xkb_keymap;
        xkb_state* m_xkb_state;
        xkb_mod_mask_t m_xkb_alt_mask;
        xkb_mod_mask_t m_xkb_ctrl_mask;
        xkb_mod_mask_t m_xkb_shift_mask;
        bool m_xkb_alt_pressed;
        bool m_xkb_ctrl_pressed;
        bool m_xkb_shift_pressed;
        
        bool m_repeat_enabled;
        SEvent m_repeat_event;
        uint32_t m_repeat_time;
        uint32_t m_repeat_rate;
        uint32_t m_repeat_delay;

        uint32_t m_mouse_button_states;
        unsigned int m_width;
        unsigned int m_height;

        bool m_window_has_focus;
        bool m_window_minimized;
        mutable core::stringc m_clipboard;
        std::map<int, EKEY_CODE> m_key_map;
        std::vector<SEvent> m_events;
        std::vector<core::dimension2du> m_modes;
        ContextManagerEGL* m_egl_context;

        void createDriver();
        void createKeyMap();
        bool createWindow();
        bool initEGL();
        void signalEvent(const SEvent&);
        void pollJoysticks();
        void closeJoysticks();
    };

    //! Implementation of the linux cursor control
    class CCursorControl : public gui::ICursorControl
    {
    public:
        CCursorControl(CIrrDeviceWayland* device) : m_device(device),
            m_is_visible(true), m_use_reference_rect(false) {};

        ~CCursorControl() {};

        //! Changes the visible state of the mouse cursor.
        virtual void setVisible(bool visible)
        {
            if (visible == m_is_visible)
                return;

            m_is_visible = visible;
            m_device->updateCursor();
        }

        //! Returns if the cursor is currently visible.
        virtual bool isVisible() const
        {
            return m_is_visible;
        }

        //! Sets the new position of the cursor.
        virtual void setPosition(const core::position2d<f32> &pos)
        {
            setPosition(pos.X, pos.Y);
        }

        //! Sets the new position of the cursor.
        virtual void setPosition(f32 x, f32 y)
        {
            setPosition((s32)(x * m_device->getWidth()),
                        (s32)(y * m_device->getHeight()));
        }

        //! Sets the new position of the cursor.
        virtual void setPosition(const core::position2d<s32> &pos)
        {
            setPosition(pos.X, pos.Y);
        }

        //! Sets the new position of the cursor.
        virtual void setPosition(s32 x, s32 y)
        {
            m_cursor_pos.X = x;
            m_cursor_pos.Y = y;
        }

        //! Returns the current position of the mouse cursor.
        virtual const core::position2d<s32>& getPosition()
        {
            return m_cursor_pos;
        }

        virtual core::position2d<f32> getRelativePosition()
        {
            if (!m_use_reference_rect)
            {
                return core::position2d<f32>(
                                m_cursor_pos.X / (f32)m_device->getWidth(),
                                m_cursor_pos.Y / (f32)m_device->getHeight());
            }

            return core::position2d<f32>(
                            m_cursor_pos.X / (f32)m_reference_rect.getWidth(),
                            m_cursor_pos.Y / (f32)m_reference_rect.getHeight());
        }

        virtual void setReferenceRect(core::rect<s32>* rect=0)
        {
            m_use_reference_rect = false;

            if (rect)
            {
                m_reference_rect = *rect;
                m_use_reference_rect = true;

                // prevent division through zero and uneven sizes
                if (m_reference_rect.getHeight() == 0 ||
                    m_reference_rect.getHeight() % 2)
                    m_reference_rect.LowerRightCorner.Y += 1;

                if (m_reference_rect.getWidth() == 0 ||
                    m_reference_rect.getWidth() % 2)
                    m_reference_rect.LowerRightCorner.X += 1;
            }
        }

        //! Sets the active cursor icon
        virtual void setActiveIcon(gui::ECURSOR_ICON iconId) {};

        //! Gets the currently active icon
        virtual gui::ECURSOR_ICON getActiveIcon() const
        {
            return gui::ECI_NORMAL;
        }

        //! Add a custom sprite as cursor icon.
        virtual gui::ECURSOR_ICON addIcon(const gui::SCursorSprite& icon)
        {
            return gui::ECI_NORMAL;
        }

        //! replace the given cursor icon.
        virtual void changeIcon(gui::ECURSOR_ICON iconId,
                                const gui::SCursorSprite& icon) {}

        /** Return a system-specific size which is supported for cursors.
            Larger icons will fail, smaller icons might work. */
        virtual core::dimension2di getSupportedIconSize() const
        {
            return core::dimension2di(0, 0);
        }

    private:

        CIrrDeviceWayland* m_device;
        core::position2d<s32> m_cursor_pos;
        core::rect<s32> m_reference_rect;
        bool m_is_visible;
        bool m_use_reference_rect;
    };

} // end namespace irr

#endif

#endif // CIRRDEVICEWAYLAND_H