Merge pull request #2048 from yunline/joystick-fix

Remove `event._joy_instance_map`

Author: Starbuck5

docs/reST/c_api.rst

@@ -12,6 +12,7 @@ pygame C API
    c_api/display.rst
    c_api/event.rst
    c_api/freetype.rst
+   c_api/joystick.rst
    c_api/mixer.rst
    c_api/rect.rst
    c_api/rwobject.rst

docs/reST/c_api/joystick.rst

@@ -0,0 +1,29 @@
+.. include:: ../common.txt
+
+.. highlight:: c
+
+******************************************
+    API exported by pygame.joystick
+******************************************
+
+src_c/joystick.c
+================
+
+The extension module :py:mod:`pygame.joystick`.
+
+Header file: src_c/include/pygame.h
+
+.. c:var:: PyTypeObject *pgJoystick_Type
+
+   The Pygame joystick object type :py:class:`pygame.Joystick`.
+
+.. c:function:: PyObject* pgJoystick_New(int id)
+
+   Return a new :py:class:`pygame.Joystick` instance.
+   On failure, raise a Python exception and return ``NULL``.
+
+.. c:function:: int pgJoystick_GetDeviceIndexByInstanceID(int instance_id)
+
+   Get the device index of a joystick by a instance id.
+   Return a device index.
+   On failure, it returns -1.

src_c/_pygame.h

@@ -331,7 +331,7 @@ struct pgColorObject {
  */
 
 #define PYGAMEAPI_RECT_NUMSLOTS 10
-#define PYGAMEAPI_JOYSTICK_NUMSLOTS 2
+#define PYGAMEAPI_JOYSTICK_NUMSLOTS 3
 #define PYGAMEAPI_DISPLAY_NUMSLOTS 2
 #define PYGAMEAPI_SURFACE_NUMSLOTS 4
 #define PYGAMEAPI_SURFLOCK_NUMSLOTS 8

src_c/event.c

@@ -53,9 +53,6 @@
 
 #define PG_GET_LIST_LEN 128
 
-// Map joystick instance IDs to device ids for partial backwards compatibility
-static PyObject *joy_instance_map = NULL;
-
 /* _custom_event stores the next custom user event type that will be
  * returned by pygame.event.custom_type() */
 #define _PGE_CUSTOM_EVENT_INIT PGE_USEREVENT + 1
@@ -851,51 +848,11 @@ get_joy_guid(int device_index)
     return PyUnicode_FromString(strguid);
 }
 
-/** Try to insert the instance ID for a new device into the joystick mapping.
- */
-void
-_joy_map_add(int device_index)
-{
-    int instance_id = (int)SDL_JoystickGetDeviceInstanceID(device_index);
-    PyObject *k, *v;
-    if (instance_id != -1) {
-        k = PyLong_FromLong(instance_id);
-        v = PyLong_FromLong(device_index);
-        if (k != NULL && v != NULL) {
-            PyDict_SetItem(joy_instance_map, k, v);
-        }
-        Py_XDECREF(k);
-        Py_XDECREF(v);
-    }
-}
-
-/** Look up a device ID for an instance ID. */
-PyObject *
-_joy_map_instance(int instance_id)
-{
-    PyObject *v, *k = PyLong_FromLong(instance_id);
-    if (!k) {
-        Py_RETURN_NONE;
-    }
-    v = PyDict_GetItem(joy_instance_map, k);
-    if (v) {
-        Py_DECREF(k);
-        Py_INCREF(v);
-        return v;
-    }
-    return k;
-}
-
-/** Discard a joystick from the joystick instance -> device mapping. */
-void
-_joy_map_discard(int instance_id)
+static PyObject *
+get_joy_device_index(int instance_id)
 {
-    PyObject *k = PyLong_FromLong(instance_id);
-
-    if (k) {
-        PyDict_DelItem(joy_instance_map, k);
-        Py_DECREF(k);
-    }
+    int device_index = pgJoystick_GetDeviceIndexByInstanceID(instance_id);
+    return PyLong_FromLong(device_index);
 }
 
 static PyObject *
@@ -995,23 +952,23 @@ dict_from_event(SDL_Event *event)
                 PyBool_FromLong((event->button.which == SDL_TOUCH_MOUSEID)));
             break;
         case SDL_JOYAXISMOTION:
-            _pg_insobj(dict, "joy", _joy_map_instance(event->jaxis.which));
+            _pg_insobj(dict, "joy", get_joy_device_index(event->jaxis.which));
             _pg_insobj(dict, "instance_id",
                        PyLong_FromLong(event->jaxis.which));
             _pg_insobj(dict, "axis", PyLong_FromLong(event->jaxis.axis));
             _pg_insobj(dict, "value",
                        PyFloat_FromDouble(event->jaxis.value / 32767.0));
             break;
         case SDL_JOYBALLMOTION:
-            _pg_insobj(dict, "joy", _joy_map_instance(event->jaxis.which));
+            _pg_insobj(dict, "joy", get_joy_device_index(event->jaxis.which));
             _pg_insobj(dict, "instance_id",
                        PyLong_FromLong(event->jball.which));
             _pg_insobj(dict, "ball", PyLong_FromLong(event->jball.ball));
             obj = Py_BuildValue("(ii)", event->jball.xrel, event->jball.yrel);
             _pg_insobj(dict, "rel", obj);
             break;
         case SDL_JOYHATMOTION:
-            _pg_insobj(dict, "joy", _joy_map_instance(event->jaxis.which));
+            _pg_insobj(dict, "joy", get_joy_device_index(event->jaxis.which));
             _pg_insobj(dict, "instance_id",
                        PyLong_FromLong(event->jhat.which));
             _pg_insobj(dict, "hat", PyLong_FromLong(event->jhat.hat));
@@ -1028,7 +985,7 @@ dict_from_event(SDL_Event *event)
             break;
         case SDL_JOYBUTTONUP:
         case SDL_JOYBUTTONDOWN:
-            _pg_insobj(dict, "joy", _joy_map_instance(event->jaxis.which));
+            _pg_insobj(dict, "joy", get_joy_device_index(event->jaxis.which));
             _pg_insobj(dict, "instance_id",
                        PyLong_FromLong(event->jbutton.which));
             _pg_insobj(dict, "button", PyLong_FromLong(event->jbutton.button));
@@ -1158,7 +1115,6 @@ dict_from_event(SDL_Event *event)
             _pg_insobj(dict, "guid", get_joy_guid(event->jdevice.which));
             break;
         case SDL_JOYDEVICEADDED:
-            _joy_map_add(event->jdevice.which);
             _pg_insobj(dict, "device_index",
                        PyLong_FromLong(event->jdevice.which));
             _pg_insobj(dict, "guid", get_joy_guid(event->jdevice.which));
@@ -1170,7 +1126,6 @@ dict_from_event(SDL_Event *event)
                        PyLong_FromLong(event->cdevice.which));
             break;
         case SDL_JOYDEVICEREMOVED:
-            _joy_map_discard(event->jdevice.which);
             _pg_insobj(dict, "instance_id",
                        PyLong_FromLong(event->jdevice.which));
             break;
@@ -2263,6 +2218,11 @@ MODINIT_DEFINE(event)
         return NULL;
     }
 
+    import_pygame_joystick();
+    if (PyErr_Occurred()) {
+        return NULL;
+    }
+
     /* type preparation */
     if (PyType_Ready(&pgEvent_Type) < 0) {
         return NULL;
@@ -2274,15 +2234,6 @@ MODINIT_DEFINE(event)
         return NULL;
     }
 
-    joy_instance_map = PyDict_New();
-    /* need to keep a reference for use in the module */
-    Py_XINCREF(joy_instance_map);
-    if (PyModule_AddObject(module, "_joy_instance_map", joy_instance_map)) {
-        Py_XDECREF(joy_instance_map);
-        Py_DECREF(module);
-        return NULL;
-    }
-
     Py_INCREF(&pgEvent_Type);
     if (PyModule_AddObject(module, "EventType", (PyObject *)&pgEvent_Type)) {
         Py_DECREF(&pgEvent_Type);

src_c/include/_pygame.h

@@ -229,6 +229,8 @@ typedef struct pgJoystickObject {
 
 #define pgJoystick_Check(x) ((x)->ob_type == &pgJoystick_Type)
 #define pgJoystick_New (*(PyObject * (*)(int)) PYGAMEAPI_GET_SLOT(joystick, 1))
+#define pgJoystick_GetDeviceIndexByInstanceID \
+    (*(int (*)(int))PYGAMEAPI_GET_SLOT(joystick, 2))
 
 #define import_pygame_joystick() IMPORT_PYGAME_MODULE(joystick)
 #endif

src_c/joystick.c

@@ -28,14 +28,11 @@
 #include "doc/joystick_doc.h"
 
 static pgJoystickObject *joylist_head = NULL;
-#ifndef BUILD_STATIC
-static PyObject *joy_instance_map = NULL;
-#endif  // BUILD_STATIC joy_instance_map already defined in src_c/event.c:57
 static PyTypeObject pgJoystick_Type;
 static PyObject *
 pgJoystick_New(int);
 static int
-_joy_map_insert(pgJoystickObject *jstick);
+pgJoystick_GetDeviceIndexByInstanceID(int);
 #define pgJoystick_Check(x) ((x)->ob_type == &pgJoystick_Type)
 
 static PyObject *
@@ -130,39 +127,9 @@ joy_init(PyObject *self, PyObject *_null)
         }
     }
 
-    if (-1 == _joy_map_insert(jstick)) {
-        return NULL;
-    }
-
     Py_RETURN_NONE;
 }
 
-static int
-_joy_map_insert(pgJoystickObject *jstick)
-{
-    SDL_JoystickID instance_id;
-    PyObject *k, *v;
-
-    if (!joy_instance_map) {
-        return -1;
-    }
-
-    instance_id = SDL_JoystickInstanceID(jstick->joy);
-    if (instance_id < 0) {
-        PyErr_SetString(pgExc_SDLError, SDL_GetError());
-        return -1;
-    }
-    k = PyLong_FromLong(instance_id);
-    v = PyLong_FromLong(jstick->id);
-    if (k && v) {
-        PyDict_SetItem(joy_instance_map, k, v);
-    }
-    Py_XDECREF(k);
-    Py_XDECREF(v);
-
-    return 0;
-}
-
 static PyObject *
 joy_quit(PyObject *self, PyObject *_null)
 {
@@ -546,6 +513,20 @@ static PyTypeObject pgJoystick_Type = {
     .tp_methods = joy_methods,
 };
 
+static int
+pgJoystick_GetDeviceIndexByInstanceID(int instance_id)
+{
+    pgJoystickObject *cur;
+    cur = joylist_head;
+    while (cur) {
+        if (SDL_JoystickInstanceID(cur->joy) == instance_id) {
+            return cur->id;
+        }
+        cur = cur->next;
+    }
+    return -1;
+}
+
 static PyObject *
 pgJoystick_New(int id)
 {
@@ -588,11 +569,6 @@ pgJoystick_New(int id)
     }
     joylist_head = jstick;
 
-    if (-1 == _joy_map_insert(jstick)) {
-        Py_DECREF(jstick);
-        return NULL;
-    }
-
     return (PyObject *)jstick;
 }
 
@@ -632,17 +608,6 @@ MODINIT_DEFINE(joystick)
         return NULL;
     }
 
-    /* Grab the instance -> device id mapping */
-    module = PyImport_ImportModule("pygame.event");
-    if (!module) {
-        return NULL;
-    }
-    joy_instance_map = PyObject_GetAttrString(module, "_joy_instance_map");
-    Py_DECREF(module);
-    if (!joy_instance_map) {
-        return NULL;
-    }
-
     /* create the module */
     module = PyModule_Create(&_module);
     if (module == NULL) {
@@ -660,6 +625,7 @@ MODINIT_DEFINE(joystick)
     /* export the c api */
     c_api[0] = &pgJoystick_Type;
     c_api[1] = pgJoystick_New;
+    c_api[2] = pgJoystick_GetDeviceIndexByInstanceID;
     apiobj = encapsulate_api(c_api, "joystick");
     if (PyModule_AddObject(module, PYGAMEAPI_LOCAL_ENTRY, apiobj)) {
         Py_XDECREF(apiobj);

src_c/static.c

@@ -355,14 +355,14 @@ PyInit_pygame_static()
 #undef pgEvent_Type
 #undef pgEvent_New
 
+#include "joystick.c"
+
 #include "event.c"
 
 #include "mouse.c"
 
 #include "key.c"
 
-#include "joystick.c"
-
 #include "time.c"
 
 #include "system.c"