Add a parameter to mouse.get_pressed() to pick between 3 and 5 button mice. For backwards compatibility it defaults to 3.

Author: MyreMylar

buildconfig/pygame-stubs/mouse.pyi

@@ -1,6 +1,6 @@
 from typing import Tuple, Union, List, overload, Sequence
 
-def get_pressed() -> Tuple[bool, bool, bool, bool, bool]: ...
+def get_pressed(num_buttons: int) -> Union[Tuple[bool, bool, bool], Tuple[bool, bool, bool, bool, bool]]: ...
 def get_pos() -> Tuple[int, int]: ...
 def get_rel() -> Tuple[int, int]: ...
 @overload

docs/reST/ref/mouse.rst

@@ -73,7 +73,7 @@ to access data about the mouse scroll, such as ``which`` (it will tell you what
 .. function:: get_pressed
 
    | :sl:`get the state of the mouse buttons`
-   | :sg:`get_pressed() -> (button1, button2, button3, button4, button5)`
+   | :sg:`get_pressed(num_buttons=3) -> (button1, button2, button3) or (button1, button2, button3, button4, button5)`
 
    Returns a sequence of booleans representing the state of all the mouse
    buttons. A true value means the mouse is currently being pressed at the time
@@ -94,7 +94,8 @@ to access data about the mouse scroll, such as ``which`` (it will tell you what
    Note, remember to call ``pygame.event.get()`` before this function.
    Otherwise it will not work.
 
-   ``button4`` & ``button5`` were added to the returned tuple for pygame 2.
+   To support five button mice, an optional parameter ``num_buttons`` has been added in pygame 2. When this is set to 5
+   ``button4`` & ``button5`` are added to the returned tuple. Only 3 and 5 are valid values for this parameter.
    .. versionadded:: 2.0.0
 
    .. ## pygame.mouse.get_pressed ##

src_c/doc/mouse_doc.h

@@ -1,6 +1,6 @@
 /* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
 #define DOC_PYGAMEMOUSE "pygame module to work with the mouse"
-#define DOC_PYGAMEMOUSEGETPRESSED "get_pressed() -> (button1, button2, button3, button4, button5)\nget the state of the mouse buttons"
+#define DOC_PYGAMEMOUSEGETPRESSED "get_pressed(num_buttons=3) -> (button1, button2, button3) or (button1, button2, button3, button4, button5)\nget the state of the mouse buttons."
 #define DOC_PYGAMEMOUSEGETPOS "get_pos() -> (x, y)\nget the mouse cursor position"
 #define DOC_PYGAMEMOUSEGETREL "get_rel() -> (x, y)\nget the amount of mouse movement"
 #define DOC_PYGAMEMOUSESETPOS "set_pos([x, y]) -> None\nset the mouse cursor position"
@@ -59,4 +59,4 @@ pygame.mouse.get_cursor
  get_cursor() -> (size, hotspot, xormasks, andmasks)
 get the image of the mouse cursor
 
-*/
+*/

src_c/mouse.c

@@ -134,22 +134,35 @@ mouse_get_rel(PyObject *self)
 }
 
 static PyObject *
-mouse_get_pressed(PyObject *self)
+mouse_get_pressed(PyObject *self, PyObject *args, PyObject *kwargs)
 {
     PyObject *tuple;
     int state;
+    int num_buttons = 3;
 
+    static char *kwids[] = {
+        "num_buttons",
+        NULL
+    };
+
+    if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|i", kwids,
+                                     &num_buttons))
+    return NULL;
     VIDEO_INIT_CHECK();
 
+    if (num_buttons != 3 && num_buttons != 5)
+        return RAISE(PyExc_ValueError, "Number of buttons needs to be 3 or 5.");
+
     state = SDL_GetMouseState(NULL, NULL);
-    if (!(tuple = PyTuple_New(5)))
+    if (!(tuple = PyTuple_New(num_buttons)))
         return NULL;
 
-    PyTuple_SET_ITEM(tuple, 0, PyBool_FromLong((state & SDL_BUTTON_LMASK) != 0));
-    PyTuple_SET_ITEM(tuple, 1, PyBool_FromLong((state & SDL_BUTTON_MMASK) != 0));
-    PyTuple_SET_ITEM(tuple, 2, PyBool_FromLong((state & SDL_BUTTON_RMASK) != 0));
-    PyTuple_SET_ITEM(tuple, 3, PyBool_FromLong((state & SDL_BUTTON_X1MASK) != 0));
-    PyTuple_SET_ITEM(tuple, 4, PyBool_FromLong((state & SDL_BUTTON_X2MASK) != 0));
+        PyTuple_SET_ITEM(tuple, 0, PyBool_FromLong((state & SDL_BUTTON_LMASK) != 0));
+        PyTuple_SET_ITEM(tuple, 1, PyBool_FromLong((state & SDL_BUTTON_MMASK) != 0));
+        PyTuple_SET_ITEM(tuple, 2, PyBool_FromLong((state & SDL_BUTTON_RMASK) != 0));
+    if (num_buttons == 5)
+        PyTuple_SET_ITEM(tuple, 3, PyBool_FromLong((state & SDL_BUTTON_X1MASK) != 0));
+        PyTuple_SET_ITEM(tuple, 4, PyBool_FromLong((state & SDL_BUTTON_X2MASK) != 0));
 
     return tuple;
 }
@@ -355,8 +368,8 @@ static PyMethodDef _mouse_methods[] = {
      DOC_PYGAMEMOUSEGETPOS},
     {"get_rel", (PyCFunction)mouse_get_rel, METH_VARARGS,
      DOC_PYGAMEMOUSEGETREL},
-    {"get_pressed", (PyCFunction)mouse_get_pressed, METH_VARARGS,
-     DOC_PYGAMEMOUSEGETPRESSED},
+    {"get_pressed", (PyCFunction)mouse_get_pressed,
+     METH_VARARGS | METH_KEYWORDS, DOC_PYGAMEMOUSEGETPRESSED},
     {"set_visible", mouse_set_visible, METH_VARARGS,
      DOC_PYGAMEMOUSESETVISIBLE},
     {"get_visible", mouse_get_visible, METH_NOARGS, DOC_PYGAMEMOUSEGETVISIBLE},

test/mouse_test.py

@@ -257,15 +257,37 @@ def test_get_focused(self):
 
     def test_get_pressed(self):
         """Ensures get_pressed returns the correct types."""
+        expected_length = 3
+        buttons_pressed = pygame.mouse.get_pressed()
+        self.assertIsInstance(buttons_pressed, tuple)
+        self.assertEqual(len(buttons_pressed), expected_length)
+        for value in buttons_pressed:
+            self.assertIsInstance(value, bool)
+
         expected_length = 5
+        buttons_pressed = pygame.mouse.get_pressed(num_buttons=5)
+        self.assertIsInstance(buttons_pressed, tuple)
+        self.assertEqual(len(buttons_pressed), expected_length)
+        for value in buttons_pressed:
+            self.assertIsInstance(value, bool)
 
-        buttons_pressed = pygame.mouse.get_pressed()
+        expected_length = 3
+        buttons_pressed = pygame.mouse.get_pressed(3)
+        self.assertIsInstance(buttons_pressed, tuple)
+        self.assertEqual(len(buttons_pressed), expected_length)
+        for value in buttons_pressed:
+            self.assertIsInstance(value, bool)
 
+        expected_length = 5
+        buttons_pressed = pygame.mouse.get_pressed(5)
         self.assertIsInstance(buttons_pressed, tuple)
         self.assertEqual(len(buttons_pressed), expected_length)
         for value in buttons_pressed:
             self.assertIsInstance(value, bool)
 
+        with self.assertRaises(ValueError):
+            pygame.mouse.get_pressed(4)
+
     def test_get_pos(self):
         """Ensures get_pos returns the correct types."""
         expected_length = 2