NaClApplication: using special classes for input events.

NaCl and SDL2 are now hotswappable again without any unimplemented or
superfluous function parameters.

Also added missing EnumSet operators for Modifiers.

src/Platform/NaClApplication.cpp

@@ -83,27 +83,33 @@ bool NaClApplication::HandleInputEvent(const pp::InputEvent& event) {
     CORRADE_INTERNAL_ASSERT(!(flags & Flag::SwapInProgress));
 
     switch(event.GetType()) {
-        case PP_INPUTEVENT_TYPE_KEYDOWN: {
+        case PP_INPUTEVENT_TYPE_KEYDOWN:
+        case PP_INPUTEVENT_TYPE_KEYUP: {
             pp::KeyboardInputEvent keyEvent(event);
-            keyPressEvent(static_cast<Key>(keyEvent.GetKeyCode()), static_cast<Modifier>(keyEvent.GetModifiers()), {});
+            KeyEvent e(static_cast<KeyEvent::Key>(keyEvent.GetKeyCode()), static_cast<InputEvent::Modifier>(keyEvent.GetModifiers()));
+            event.GetType() == PP_INPUTEVENT_TYPE_KEYDOWN ? keyPressEvent(e) : keyReleaseEvent(e);
+            if(!e.isAccepted()) return false;
             break;
-        } case PP_INPUTEVENT_TYPE_KEYUP: {
+        }
-            pp::KeyboardInputEvent keyEvent(event);
+
-            keyReleaseEvent(static_cast<Key>(keyEvent.GetKeyCode()), static_cast<Modifier>(keyEvent.GetModifiers()), {});
+        case PP_INPUTEVENT_TYPE_MOUSEDOWN:
-            break;
+        case PP_INPUTEVENT_TYPE_MOUSEUP: {
-        } case PP_INPUTEVENT_TYPE_MOUSEDOWN: {
-            pp::MouseInputEvent mouseEvent(event);
-            mousePressEvent(static_cast<MouseButton>(mouseEvent.GetButton()), static_cast<Modifier>(mouseEvent.GetModifiers()), {mouseEvent.GetPosition().x(), mouseEvent.GetPosition().y()});
-            break;
-        } case PP_INPUTEVENT_TYPE_MOUSEUP: {
             pp::MouseInputEvent mouseEvent(event);
-            mouseReleaseEvent(static_cast<MouseButton>(mouseEvent.GetButton()), static_cast<Modifier>(mouseEvent.GetModifiers()), {mouseEvent.GetPosition().x(), mouseEvent.GetPosition().y()});
+            MouseEvent e(static_cast<MouseEvent::Button>(mouseEvent.GetButton()), {mouseEvent.GetPosition().x(), mouseEvent.GetPosition().y()}, static_cast<InputEvent::Modifier>(mouseEvent.GetModifiers()));
+            event.GetType() == PP_INPUTEVENT_TYPE_MOUSEDOWN ? mousePressEvent(e) : mouseReleaseEvent(e);
+            if(!e.isAccepted()) return false;
             break;
-        } case PP_INPUTEVENT_TYPE_MOUSEMOVE: {
+        }
+
+        case PP_INPUTEVENT_TYPE_MOUSEMOVE: {
             pp::MouseInputEvent mouseEvent(event);
-            mouseMotionEvent(static_cast<Modifier>(mouseEvent.GetModifiers()), {mouseEvent.GetPosition().x(), mouseEvent.GetPosition().y()});
+            MouseMoveEvent e({mouseEvent.GetPosition().x(), mouseEvent.GetPosition().y()}, static_cast<InputEvent::Modifier>(mouseEvent.GetModifiers()));
+            mouseMoveEvent(e);
+            if(!e.isAccepted()) return false;
             break;
-        } default: return false;
+        }
+
+        default: return false;
     }
 
     /* Not need to redraw => assume the event was ignored */

src/Platform/NaClApplication.h

@@ -63,6 +63,11 @@ MAGNUM_NACLAPPLICATION_MAIN(MyApplication)
 */
 class NaClApplication: public pp::Instance, public pp::Graphics3DClient {
     public:
+        class InputEvent;
+        class KeyEvent;
+        class MouseEvent;
+        class MouseMoveEvent;
+
         /**
          * @brief Constructor
          * @param instance  Module instance
@@ -94,12 +99,103 @@ class NaClApplication: public pp::Instance, public pp::Graphics3DClient {
 
         /** @{ @name Keyboard handling */
 
+        /**
+         * @brief Key press event
+         *
+         * Called when an key is pressed. Default implementation does nothing.
+         * If you accept the event, call @ref InputEvent::setAccepted() "setAccepted()"
+         * on it, otherwise the event will be propagated to the browser.
+         */
+        virtual void keyPressEvent(KeyEvent& event);
+
+        /**
+         * @brief Key release event
+         *
+         * Called when an key is released. Default implementation does nothing.
+         * If you accept the event, call @ref InputEvent::setAccepted() "setAccepted()"
+         * on it, otherwise the event will be propagated to the browser.
+         */
+        virtual void keyReleaseEvent(KeyEvent& event);
+
+        /*@}*/
+
+        /** @{ @name Mouse handling */
+
+        /**
+         * @brief Mouse press event
+         *
+         * Called when mouse button is pressed. Default implementation does
+         * nothing. If you accept the event, call @ref InputEvent::setAccepted() "setAccepted()"
+         * on it, otherwise the event will be propagated to the browser.
+         */
+        virtual void mousePressEvent(MouseEvent& event);
+
+        /**
+         * @brief Mouse release event
+         *
+         * Called when mouse button is released. Default implementation does
+         * nothing. If you accept the event, call @ref InputEvent::setAccepted() "setAccepted()"
+         * on it, otherwise the event will be propagated to the browser.
+         */
+        virtual void mouseReleaseEvent(MouseEvent& event);
+
+        /**
+         * @brief Mouse move event
+         *
+         * Called when mouse is moved. Default implementation does nothing. If
+         * you accept the event, call @ref InputEvent::setAccepted() "setAccepted()"
+         * on it, otherwise the event will be propagated to the browser.
+         */
+        virtual void mouseMoveEvent(MouseMoveEvent& event);
+
+        /*@}*/
+
+    private:
+        enum class Flag: std::uint8_t {
+            ViewportUpdated = 1 << 0,
+            SwapInProgress = 1 << 1,
+            Redraw = 1 << 2
+        };
+        typedef Corrade::Containers::EnumSet<Flag, std::uint8_t> Flags;
+
+        inline void Graphics3DContextLost() override {
+            CORRADE_ASSERT(false, "NaClApplication: context unexpectedly lost", );
+        }
+
+        void DidChangeView(const pp::View& view) override;
+
+        bool HandleInputEvent(const pp::InputEvent& event) override;
+
+        static void swapCallback(void* applicationInstance, std::int32_t);
+
+        pp::Graphics3D* graphics;
+        Context* c;
+        Math::Vector2<GLsizei> viewportSize;
+        Flags flags;
+
+        CORRADE_ENUMSET_FRIEND_OPERATORS(Flags)
+};
+
+/**
+@brief Base for input events
+
+If you accept the event, call setAccepted(), otherwise the event will be
+propagated to the browser.
+@see KeyEvent, MouseEvent, MouseMoveEvent, keyPressEvent(), keyReleaseEvent(),
+    mousePressEvent(), mouseReleaseEvent(), mouseMoveEvent()
+*/
+class NaClApplication::InputEvent {
+    InputEvent(const InputEvent& other) = delete;
+    InputEvent(InputEvent&& other) = delete;
+    InputEvent& operator=(const InputEvent& other) = delete;
+    InputEvent& operator=(InputEvent&& other) = delete;
+
     public:
         /**
          * @brief %Modifier
          *
          * @todo AltGr + PP_INPUTEVENT_MODIFIER_ISKEYPAD, PP_INPUTEVENT_MODIFIER_ISAUTOREPEAT
-         * @see Modifiers, keyPressEvent(), keyReleaseEvent()
+         * @see Modifiers, modifiers()
          */
         enum class Modifier: std::uint32_t {
             Shift = PP_INPUTEVENT_MODIFIER_SHIFTKEY,    /**< Shift */
@@ -118,16 +214,51 @@ class NaClApplication: public pp::Instance, public pp::Graphics3DClient {
         /**
          * @brief Set of modifiers
          *
-         * @see keyPressEvent(), keyReleaseEvent(), mousePressEvent(),
+         * @see modifiers()
-         *      mouseReleaseEvent(), mouseMotionEvent()
          */
         typedef Corrade::Containers::EnumSet<Modifier, std::uint32_t> Modifiers;
 
+        inline virtual ~InputEvent() {}
+
+        /** @brief Modifiers */
+        inline Modifiers modifiers() const { return _modifiers; }
+
+        /**
+         * @brief Set event as accepted
+         *
+         * If the event is ignored (i.e., not set as accepted), it is
+         * propagated to the browser. By default is each event ignored.
+         */
+        inline void setAccepted(bool accepted = true) { _accepted = accepted; }
+
+        /** @brief Whether the event is accepted */
+        inline bool isAccepted() { return _accepted; }
+
+    #ifndef DOXYGEN_GENERATING_OUTPUT
+    protected:
+        inline InputEvent(Modifiers modifiers): _accepted(false), _modifiers(modifiers) {}
+    #endif
+
+    private:
+        bool _accepted;
+        const Modifiers _modifiers;
+};
+
+/**
+@brief Key event
+
+See InputEvent for more information.
+@see keyPressEvent(), keyReleaseEvent()
+*/
+class NaClApplication::KeyEvent: public NaClApplication::InputEvent {
+    friend class NaClApplication;
+
+    public:
         /**
          * @brief Key
          *
          * @todo Slash, percent, equal to be compatible with *XApplication
-         * @see keyPressEvent(), keyReleaseEvent()
+         * @see key()
          */
         enum class Key: std::uint32_t {
             Enter = 0x0D,               /**< Enter */
@@ -199,99 +330,66 @@ class NaClApplication: public pp::Instance, public pp::Graphics3DClient {
             Z = 'Z'                     /**< Letter Z */
         };
 
-    protected:
+        /** @brief Key */
-        /**
+        inline Key key() const { return _key; }
-         * @brief Key press event
-         * @param key       Key pressed
-         * @param modifiers Active modifiers
-         * @param position  Cursor position (not implemented)
-         *
-         * Called when an key is pressed. Default implementation does nothing.
-         */
-        virtual void keyPressEvent(Key key, Modifiers modifiers, const Math::Vector2<int>& position);
 
-        /**
+    private:
-         * @brief Key release event
+        inline KeyEvent(Key key, Modifiers modifiers): InputEvent(modifiers), _key(key) {}
-         * @param key       Key released
-         * @param modifiers Active modifiers
-         * @param position  Cursor position (not implemented)
-         */
-        virtual void keyReleaseEvent(Key key, Modifiers modifiers, const Math::Vector2<int>& position);
 
-        /*@}*/
+        const Key _key;
+};
 
-        /** @{ @name Mouse handling */
+/**
+@brief Mouse event
+
+See InputEvent for more information.
+@see MouseMoveEvent, mousePressEvent(), mouseReleaseEvent()
+*/
+class NaClApplication::MouseEvent: public NaClApplication::InputEvent {
+    friend class NaClApplication;
 
     public:
         /**
-         * @brief Mouse button
+         * @brief Button
          *
-         * @see mousePressEvent(), mouseReleaseEvent()
+         * @see button()
          */
-        enum class MouseButton: unsigned int {
+        enum class Button: unsigned int {
             Left = PP_INPUTEVENT_MOUSEBUTTON_LEFT,      /**< Left button */
             Middle = PP_INPUTEVENT_MOUSEBUTTON_MIDDLE,  /**< Middle button */
             Right = PP_INPUTEVENT_MOUSEBUTTON_RIGHT     /**< Right button */
         };
 
-    protected:
+        /** @brief Button */
-        /**
+        inline Button button() const { return _button; }
-         * @brief Mouse press event
-         * @param button    Button pressed
-         * @param modifiers Active modifiers
-         * @param position  Cursor position
-         *
-         * Called when mouse button is pressed. Default implementation does
-         * nothing.
-         */
-        virtual void mousePressEvent(MouseButton button, Modifiers modifiers, const Math::Vector2<int>& position);
 
-        /**
+        /** @brief Position */
-         * @brief Mouse release event
+        inline Math::Vector2<int> position() const { return _position; }
-         * @param button    Button released
-         * @param modifiers Active modifiers
-         * @param position  Cursor position
-         *
-         * Called when mouse button is released. Default implementation does
-         * nothing.
-         */
-        virtual void mouseReleaseEvent(MouseButton button, Modifiers modifiers, const Math::Vector2<int>& position);
-
-        /**
-         * @brief Mouse motion event
-         * @param modifiers Active modifiers
-         * @param position  Cursor position
-         *
-         * Called when mouse is moved.
-         */
-        virtual void mouseMotionEvent(Modifiers modifiers, const Math::Vector2<int>& position);
-
-        /*@}*/
 
     private:
-        enum class Flag: std::uint8_t {
+        inline MouseEvent(Button button, const Math::Vector2<int>& position, Modifiers modifiers): InputEvent(modifiers), _button(button), _position(position) {}
-            ViewportUpdated = 1 << 0,
-            SwapInProgress = 1 << 1,
-            Redraw = 1 << 2
-        };
-        typedef Corrade::Containers::EnumSet<Flag, std::uint8_t> Flags;
 
-        inline void Graphics3DContextLost() override {
+        const Button _button;
-            CORRADE_ASSERT(false, "NaClApplication: context unexpectedly lost", );
+        const Math::Vector2<int> _position;
-        }
+};
 
-        void DidChangeView(const pp::View& view) override;
+/**
+@brief Mouse move event
 
-        bool HandleInputEvent(const pp::InputEvent& event) override;
+See InputEvent for more information.
+@see MouseEvent, mouseMoveEvent()
+*/
+class NaClApplication::MouseMoveEvent: public NaClApplication::InputEvent {
+    friend class NaClApplication;
 
-        static void swapCallback(void* applicationInstance, std::int32_t);
+    public:
+        /** @brief Position */
+        inline Math::Vector2<int> position() const { return _position; }
 
-        pp::Graphics3D* graphics;
+    private:
-        Context* c;
+        inline MouseMoveEvent(const Math::Vector2<int>& position, Modifiers modifiers): InputEvent(modifiers), _position(position) {}
-        Math::Vector2<GLsizei> viewportSize;
-        Flags flags;
 
-        CORRADE_ENUMSET_FRIEND_OPERATORS(Flags)
+        const Math::Vector2<int> _position;
 };
 
 CORRADE_ENUMSET_OPERATORS(NaClApplication::Flags)
@@ -339,13 +437,14 @@ When no other application header is included this macro is also aliased to
 #endif
 #endif
 
-/* Implementations for inline functions with unused parameters */
+CORRADE_ENUMSET_OPERATORS(NaClApplication::InputEvent::Modifiers)
-inline void NaClApplication::keyPressEvent(Key, Modifiers, const Math::Vector2<int>&) {}
-inline void NaClApplication::keyReleaseEvent(Key, Modifiers, const Math::Vector2<int>&) {}
-inline void NaClApplication::mousePressEvent(MouseButton, Modifiers, const Math::Vector2<int>&) {}
-inline void NaClApplication::mouseReleaseEvent(MouseButton, Modifiers, const Math::Vector2<int>&) {}
-inline void NaClApplication::mouseMotionEvent(Modifiers, const Math::Vector2<int>&) {}
 
+/* Implementations for inline functions with unused parameters */
+inline void NaClApplication::keyPressEvent(KeyEvent&) {}
+inline void NaClApplication::keyReleaseEvent(KeyEvent&) {}
+inline void NaClApplication::mousePressEvent(MouseEvent&) {}
+inline void NaClApplication::mouseReleaseEvent(MouseEvent&) {}
+inline void NaClApplication::mouseMoveEvent(MouseMoveEvent&) {}
 
 }}