Ticket #8711: backends-lib.v1.patch

D:/programming/projects/gsoc/scummvm/backends/events/default/default-events.h

@@ -28 +28 @@
 
 #include "common/stdafx.h"
 #include "common/events.h"
+#include "backends/events/generic/generic-events.h"
 
 /*
 At some point we will remove pollEvent from OSystem and change
@@ -41 +42 @@
 use a subclass of EventProvider.
 */
 
-class DefaultEventManager : public Common::EventManager {
+class DefaultEventManager : public GenericEventManager {
         OSystem *_boss;
 
         Common::Point _mousePos;

D:/programming/projects/gsoc/scummvm/backends/events/generic/generic-events.cpp

@@ +1 @@
+/* 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 2
+ * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * $URL: https://scummvm.svn.sourceforge.net/svnroot/scummvm/scummvm/trunk/backends/events/default/default-events.cpp $
+ * $Id: default-events.cpp 27831 2007-07-01 18:22:25Z fingolfin $
+ *
+ */
+
+#if !defined(DISABLE_GENERIC_EVENTMANAGER)
+
+#include "common/stdafx.h"
+#include "common/config-manager.h"
+#include "common/system.h"
+#include "backends/events/generic/generic-events.h"
+
+#include "engines/engine.h"
+#include "gui/message.h"
+
+GenericEventManager::GenericEventManager() {
+
+}
+
+Common::UserAction GenericEventManager::resolveUserAction() const {
+        Common::UserAction action;
+        // 
+        return action;
+}
+        
+Common::Button GenericEventManager::pollButton() const {
+        Common::Button btn;
+        // retrieves
+        return btn;
+}
+
+void GenericEventManager::registerEngineActions(std::set<Common::UserAction> actions) {
+}
+
+void GenericEventManager::registerGameActions(std::set<Common::UserAction> actions) {
+}
+
+void GenericEventManager::registerBackendButtons(std::set<Common::Button>) {
+}
+
+void GenericEventManager::checkMappings(bool engine) {
+}
+
+#endif // !defined(DISABLE_GENERIC_EVENTMANAGER)

D:/programming/projects/gsoc/scummvm/backends/events/generic/generic-events.h

@@ +1 @@
+/* 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 2
+ * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ */
+
+#if !defined(BACKEND_EVENTS_GENERIC_H) && !defined(DISABLE_GENERIC_EVENTMANAGER)
+#define BACKEND_EVENTS_GENERIC_H
+
+#include "common/stdafx.h"
+#include "common/events.h"
+
+class GenericEventManager : public Common::EventManager {
+
+        Common::Point _mousePos;
+        std::set <Common::UserAction> _engineActions;
+        std::set <Common::UserAction> _gameActions;
+        std::set <Common::Button> _backendButtons;
+
+public:
+        GenericEventManager();
+
+        virtual Common::UserAction resolveUserAction() const;
+        
+        virtual Common::Button pollButton() const;
+        virtual Common::Point getMousePos() const { return _mousePos; }
+
+        virtual void registerEngineActions(std::set<Common::UserAction>);
+        virtual void registerGameActions(std::set<Common::UserAction>);
+
+protected:
+
+        virtual void registerBackendButtons(std::set<Common::Button>);
+
+private:
+
+        void checkMappings(bool engine);
+};
+
+#endif

D:/programming/projects/gsoc/scummvm/common/buttons.h

@@ +1 @@
+/* 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 2
+ * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ */
+
+#ifndef COMMON_BUTTONS_H
+#define COMMON_BUTTONS_H
+
+#include "common/scummsys.h"
+
+namespace Common {
+
+enum ButtonCode {
+        BUTTON_INVALID     = 0,
+
+        BUTTON_BACKSPACE   = 8,
+        BUTTON_TAB         = 9,
+        BUTTON_CLEAR       = 12,
+        BUTTON_RETURN      = 13,
+        BUTTON_PAUSE       = 19,
+        BUTTON_ESCAPE      = 27,
+        BUTTON_SPACE       = 32,
+        BUTTON_EXCLAIM     = 33,
+        BUTTON_QUOTEDBL    = 34,
+        BUTTON_HASH        = 35,
+        BUTTON_DOLLAR      = 36,
+        BUTTON_AMPERSAND   = 38,
+        BUTTON_QUOTE       = 39,
+        BUTTON_LEFTPAREN   = 40,
+        BUTTON_RIGHTPAREN  = 41,
+        BUTTON_ASTERISK    = 42,
+        BUTTON_PLUS        = 43,
+        BUTTON_COMMA       = 44,
+        BUTTON_MINUS       = 45,
+        BUTTON_PERIOD      = 46,
+        BUTTON_SLASH       = 47,
+        BUTTON_0           = 48,
+        BUTTON_1           = 49,
+        BUTTON_2           = 50,
+        BUTTON_3           = 51,
+        BUTTON_4           = 52,
+        BUTTON_5           = 53,
+        BUTTON_6           = 54,
+        BUTTON_7           = 55,
+        BUTTON_8           = 56,
+        BUTTON_9           = 57,
+        BUTTON_COLON       = 58,
+        BUTTON_SEMICOLON   = 59,
+        BUTTON_LESS        = 60,
+        BUTTON_EQUALS      = 61,
+        BUTTON_GREATER     = 62,
+        BUTTON_QUESTION    = 63,
+        BUTTON_AT          = 64,
+
+        BUTTON_LEFTBRACKET = 91,
+        BUTTON_BACKSLASH   = 92,
+        BUTTON_RIGHTBRACKET= 93,
+        BUTTON_CARET       = 94,
+        BUTTON_UNDERSCORE  = 95,
+        BUTTON_BACKQUOTE   = 96,
+        BUTTON_a           = 97,
+        BUTTON_b           = 98,
+        BUTTON_c           = 99,
+        BUTTON_d           = 100,
+        BUTTON_e           = 101,
+        BUTTON_f           = 102,
+        BUTTON_g           = 103,
+        BUTTON_h           = 104,
+        BUTTON_i           = 105,
+        BUTTON_j           = 106,
+        BUTTON_k           = 107,
+        BUTTON_l           = 108,
+        BUTTON_m           = 109,
+        BUTTON_n           = 110,
+        BUTTON_o           = 111,
+        BUTTON_p           = 112,
+        BUTTON_q           = 113,
+        BUTTON_r           = 114,
+        BUTTON_s           = 115,
+        BUTTON_t           = 116,
+        BUTTON_u           = 117,
+        BUTTON_v           = 118,
+        BUTTON_w           = 119,
+        BUTTON_x           = 120,
+        BUTTON_y           = 121,
+        BUTTON_z           = 122,
+        BUTTON_DELETE      = 127,
+
+        // Numeric keypad
+        BUTTON_KP0         = 256,
+        BUTTON_KP1         = 257,
+        BUTTON_KP2         = 258,
+        BUTTON_KP3         = 259,
+        BUTTON_KP4         = 260,
+        BUTTON_KP5         = 261,
+        BUTTON_KP6         = 262,
+        BUTTON_KP7         = 263,
+        BUTTON_KP8         = 264,
+        BUTTON_KP9         = 265,
+        BUTTON_KP_PERIOD   = 266,
+        BUTTON_KP_DIVIDE   = 267,
+        BUTTON_KP_MULTIPLY = 268,
+        BUTTON_KP_MINUS    = 269,
+        BUTTON_KP_PLUS     = 270,
+        BUTTON_KP_ENTER    = 271,
+        BUTTON_KP_EQUALS   = 272,
+
+        // Arrows + Home/End pad
+        BUTTON_UP          = 273,
+        BUTTON_DOWN        = 274,
+        BUTTON_RIGHT       = 275,
+        BUTTON_LEFT        = 276,
+        BUTTON_INSERT      = 277,
+        BUTTON_HOME        = 278,
+        BUTTON_END         = 279,
+        BUTTON_PAGEUP      = 280,
+        BUTTON_PAGEDOWN    = 281,
+
+        // Function keys
+        BUTTON_F1          = 282,
+        BUTTON_F2          = 283,
+        BUTTON_F3          = 284,
+        BUTTON_F4          = 285,
+        BUTTON_F5          = 286,
+        BUTTON_F6          = 287,
+        BUTTON_F7          = 288,
+        BUTTON_F8          = 289,
+        BUTTON_F9          = 290,
+        BUTTON_F10         = 291,
+        BUTTON_F11         = 292,
+        BUTTON_F12         = 293,
+        BUTTON_F13         = 294,
+        BUTTON_F14         = 295,
+        BUTTON_F15         = 296,
+
+        // Key state modifier keys
+        BUTTON_NUMLOCK     = 300,
+        BUTTON_CAPSLOCK    = 301,
+        BUTTON_SCROLLOCK   = 302,
+        BUTTON_RSHIFT      = 303,
+        BUTTON_LSHIFT      = 304,
+        BUTTON_RCTRL       = 305,
+        BUTTON_LCTRL       = 306,
+        BUTTON_RALT        = 307,
+        BUTTON_LALT        = 308,
+        BUTTON_RMETA       = 309,
+        BUTTON_LMETA       = 310,
+        BUTTON_LSUPER      = 311,      // Left "Windows" key
+        BUTTON_RSUPER      = 312,      // Right "Windows" key
+        BUTTON_MODE        = 313,      // "Alt Gr" key
+        BUTTON_COMPOSE     = 314,      // Multi-key compose key
+
+        // Miscellaneous function keys 
+        BUTTON_HELP        = 315,
+        BUTTON_PRINT       = 316,
+        BUTTON_SYSREQ      = 317,
+        BUTTON_BREAK       = 318,
+        BUTTON_MENU        = 319,
+        BUTTON_POWER       = 320,      // Power Macintosh power key
+        BUTTON_EURO        = 321,      // Some european keyboards
+        BUTTON_UNDO        = 322,       // Atari keyboard has Undo
+
+        // Mouse buttons
+        BUTTON_MOUSE_LEFT  = 400,
+        BUTTON_MOUSE_RIGHT = 401,
+        BUTTON_MOUSE_WHEEL = 402
+
+        // Device specific buttons go here
+};
+
+/**
+ * Button status, as used in the UserAction struct.
+ */
+struct Button {
+        /**
+         * Abstract key code (will be the same for any given key regardless
+         * of modifiers being held at the same time.
+         * For example, this is the same for both 'A' and Shift-'A'.
+         * @todo Document which values are to be used for non-ASCII keys
+         * like F1-F10. For now, let's just say that our primary backend
+         * is the SDL one, and it uses the values SDL uses... so until
+         * we fix this, your best bet is to get a copy of SDL_keysym.h
+         * and look at that, if you want to find out a key code.
+         */
+        ButtonCode code;
+
+        /**
+         * Status of the modifier keys. Bits are set in this for each
+         * pressed modifier
+         * @see KBD_CTRL, KBD_ALT, KBD_SHIFT
+         */
+        byte flags;
+
+        /**
+         * True for the key down event, false for the key up event
+         */
+        bool down;
+        
+        Button(ButtonCode bc = BUTTON_INVALID, byte f = 0, bool down = true) {
+                code = bc;
+                flags = f;
+        }
+        
+        void reset() {
+                code = BUTTON_INVALID;
+                flags = 0;
+                down = true;
+        }
+};
+
+} // End of namespace Common
+
+#endif

D:/programming/projects/gsoc/scummvm/common/events.h

@@ -27 +27 @@
 #define COMMON_EVENTS_H
 
 #include "common/keyboard.h"
+#include "common/buttons.h"
 #include "common/rect.h"
 #include "common/system.h"
 #include "common/noncopyable.h"
 
+#include <set>
+
 namespace Common {
 
 /**
@@ -117 +120 @@
         Common::Point mouse;
 };
 
+enum UserActionType {
+        // engines specific actions
+        kQuitUserAction,  // *maybe* could replace EVENT_QUIT
+        kPredictiveDialogUserAction,
+        kOptionsDialogUserAction,
+        kSaveLoadDialogUserAction,
+        kPauseUserAction,
+        kInputUserAction,
+        
+        // games specific actions
+        kMoveUserAction,
+        kUseUserAction
+};
 
+struct UserAction {
+        UserActionType type;  // an enum type, see below
+        String description; // Human readable description, for a GUI keymapping config dialog
+        Button defaultBtn;  // an (optional) default key combo to be assigned to this; includes modifier state
+};
+
 /**
  * The EventManager provides user input events to the client code.
  * In addition, it keeps track of the state of various input devices,
@@ -137 +159 @@
          * Get the next event in the event queue.
          * @param event point to an Event struct, which will be filled with the event data.
          * @return true if an event was retrieved.
+         * @deprecated use pollAction instead
          */
         virtual bool pollEvent(Common::Event &event) = 0;
 
 
+        virtual Common::UserAction resolveUserAction() const = 0;
+
+
         /** Return the current key state */
         virtual Common::Point getMousePos() const = 0;
         
@@ -148 +174 @@
          * Return a bitmask with the button states:
          * - bit 0: left button up=1, down=0
          * - bit 1: right button up=1, down=0
+         * @deprecated use pollAction() which returns UserAction instead
          */
         virtual int getButtonState() const = 0;
         
-        /** Get a bitmask with the current modifier state */
+        /**
+         * Get a bitmask with the current modifier state
+         * @deprecated use pollAction() which returns UserAction instead
+         */
         virtual int getModifierState() const = 0;
 
         /**
          * Should the application terminate? Set to true if we
          * received an EVENT_QUIT.
+         * @deprecated use pollAction().type == Common::kQuitUserAction instead
          */
         virtual int shouldQuit() const = 0;
         
@@ -166 +197 @@
         // TODO: Keyboard repeat support?
         
         // TODO: Consider removing OSystem::getScreenChangeID and
-        // replacing it by a generic getScreenChangeID method here
+        // replacing it by a generic getScreenChaneID method here
+
+        virtual void registerEngineActions(std::set<Common::UserAction>) = 0;
+        virtual void registerGameActions(std::set<Common::UserAction>) = 0;
+
+protected:
+
+        /**
+         * Returns currently pressed button
+         */
+        virtual Common::Button pollButton() const = 0;
+
+
+        virtual void registerBackendButtons(std::set<Common::Button>) = 0;
+
 };
 
 } // End of namespace Common