New functions: toggle(), is_pressed(), is_valid_code()

tuomasjjrasanen · tuomasjjrasanen · commit 673734ede260 · 2010-01-16T21:37:32.000+02:00
diff --git a/src/__init__.py b/src/__init__.py
@@ -54,7 +54,6 @@
     ]
 
 class Driver(object):
-
     """Device driver for the Linux uinput-system.
 
     For the documentation of the constructor arguments, see the
@@ -63,7 +62,7 @@ class Driver(object):
 
     def __init__(self, name="python-uinput", bustype=_suinput.BUS_VIRTUAL,
                  vendor=0, product=0, version=0):
-        self._input_fd = _suinput.open(name, bustype, vendor, product, version)
+        self._context = _suinput.open(name, bustype, vendor, product, version)
         self._name = name
         self._bustype = bustype
         self._vendor = vendor
@@ -72,7 +71,7 @@ def __init__(self, name="python-uinput", bustype=_suinput.BUS_VIRTUAL,
 
     @property
     def name(self):
-        "Kernel name of the device."
+        "Name of the device."
         return self._name
 
     @property
@@ -84,66 +83,88 @@ def bustype(self):
 
     @property
     def vendor(self):
-        """Vendor number of the device."""
+        """Arbitrary 16 bit unsigned integer vendor id."""
         return self._vendor
 
     @property
     def product(self):
-        """Product number of the device."""
+        """Arbitrary 16 bit unsigned integer product id."""
         return self._product
 
     @property
     def version(self):
-        """Version number of the device."""
+        """Arbitrary 16 bit unsigned integer version number."""
         return self._version
 
     def move_pointer(self, x, y):
         """Sends a relative pointer motion event to the event device.
         Values increase towards right-bottom.
         """
-        _suinput.move_pointer(self._input_fd, x, y)
+        _suinput.move_pointer(self._context, x, y)
 
-    def press(self, uinput_code):
+    def press(self, code):
         """Sends a press event to the event device. Event is repeated after
         a short delay until a release event is sent.
 
-        `uinput_code` must be one of the constant values defined in
+        code must be one of the constant values defined in
         uinput.codes -module.
         """
-        _suinput.press(self._input_fd, uinput_code)
+        _suinput.press(self._context, code)
 
-    def release(self, uinput_code):
+    def release(self, code):
         """Sends a release event to the event device.
 
-        `uinput_code` must be one of the constant values defined in
+        code must be one of the constant values defined in
         uinput.codes -module.
         """
-        _suinput.release(self._input_fd, uinput_code)
+        _suinput.release(self._context, code)
 
-    def click(self, uinput_code):
+    def click(self, code):
         """Sends a press and release events to the event device.
 
-        `uinput_code` must be one of the constant values defined in
+        code must be one of the constant values defined in
         uinput.codes -module.
 
         This method is provided as a convenience and has effectively the
         same result as calling press() and release() sequentially.
         """
-        _suinput.click(self._input_fd, uinput_code)
+        _suinput.click(self._context, code)
 
-    def press_release(self, signed_uinput_code):
-        """Sends a press or a release event to the event device. The sign
-        of the `signed_uinput_code` determines which type of event is sent.
-        Positive `signed_uinput_code` means press and negative means release.
+    def press_release(self, signed_code):
+        """Sends a press or a release event to the event device.
+        The sign of the signed_code determines which type of event is sent.
+        Positive signed_code means press and negative means release.
 
-        Absolute value of `signed_uinput_code` must be one of the constant
-        values defined in uinput.codes -module.
+        Absolute value of signed_code must be one of the constant
+        values defined in uinput.codes module.
 
         This method is provided as a convenience and has effectively the
-        same result as calling press() when the value of `signed_uinput_code`
+        same result as calling press() when the value of signed_code
         is positive and release() when negative.
         """
-        _suinput.press_release(self._input_fd, signed_uinput_code)
+        _suinput.press_release(self._context, signed_code)
+
+    def toggle(self, code):
+        """Press button if it is not pressed currently, release it otherwise.
+        
+        code must be one of the constant values defined in
+        uinput.codes -module.
+
+        This method is provided as a convenience and has effectively the
+        same result as calling press() if is_pressed() returns False
+        and release() otherwise.
+        """
+        _suinput.toggle(self._context, code)
+
+    def is_pressed(self, code):
+        """Return True if button is pressed, False otherwise.
+
+        code must be one of the constant values defined in
+        uinput.codes -module.
+        """
+        return _suinput.is_pressed(self._context, code)
 
     def __del__(self):
-        _suinput.close(self._input_fd)
+        _suinput.close(self._context)
+
+is_valid_code = _suinput.is_valid_code
diff --git a/src/codes.c b/src/codes.c
@@ -30,7 +30,6 @@ PyMODINIT_FUNC initcodes(void)
 	PyObject *module;
 	module = Py_InitModule3("codes", codesMethods,
 				"Button and key codes used in Linux input system");
-	PyModule_AddIntMacro(module, KEY_RESERVED);
 	PyModule_AddIntMacro(module, KEY_ESC);
 	PyModule_AddIntMacro(module, KEY_1);
 	PyModule_AddIntMacro(module, KEY_2);
diff --git a/src/pysuinput.c b/src/pysuinput.c
@@ -32,82 +32,126 @@ static PyObject *pysuinput_open(PyObject *self, PyObject *args)
 			      &version))
 		return NULL;
 	struct input_id id = {bustype, vendor, product, version};
-	int uinput_fd = suinput_open(name, &id);
-	if (uinput_fd == -1)
+	struct suinput_driver *c_driver = suinput_open(name, &id);
+	if (c_driver == NULL)
 		return PyErr_SetFromErrno(PyExc_IOError);
-	return Py_BuildValue("i", uinput_fd);
+	return PyCObject_FromVoidPtr((void *)c_driver, NULL);
 }
 
 static PyObject *pysuinput_close(PyObject *self, PyObject *args)
 {
-	int uinput_fd;
-	if (!PyArg_ParseTuple(args, "i", &uinput_fd))
+	PyObject *py_driver;
+	struct suinput_driver *c_driver;
+	if (!PyArg_ParseTuple(args, "O", &py_driver))
 		return NULL;
-	if (suinput_close(uinput_fd) == -1)
+	c_driver = (struct suinput_driver *)PyCObject_AsVoidPtr(py_driver);
+	if (suinput_close(c_driver) == -1)
 		return PyErr_SetFromErrno(PyExc_IOError);
 	Py_RETURN_NONE;
 }
 
 static PyObject *pysuinput_press(PyObject *self, PyObject *args)
 {
-	int uinput_fd;
+	PyObject *py_driver;
+	struct suinput_driver *c_driver;
 	uint16_t code;
-	if (!PyArg_ParseTuple(args, "iH", &uinput_fd, &code))
+	if (!PyArg_ParseTuple(args, "OH", &py_driver, &code))
 		return NULL;
-	if (suinput_press(uinput_fd, code) == -1)
+	c_driver = (struct suinput_driver *)PyCObject_AsVoidPtr(py_driver);
+	if (suinput_press(c_driver, code) == -1)
 		return PyErr_SetFromErrno(PyExc_IOError);
 	Py_RETURN_NONE;
 }
 
 static PyObject *pysuinput_release(PyObject *self, PyObject *args)
 {
-	int uinput_fd;
+	PyObject *py_driver;
+	struct suinput_driver *c_driver;
 	uint16_t code;
-	if (!PyArg_ParseTuple(args, "iH", &uinput_fd, &code))
+	if (!PyArg_ParseTuple(args, "OH", &py_driver, &code))
 		return NULL;
-	if (suinput_release(uinput_fd, code) == -1)
+	c_driver = (struct suinput_driver *)PyCObject_AsVoidPtr(py_driver);
+	if (suinput_release(c_driver, code) == -1)
 		return PyErr_SetFromErrno(PyExc_IOError);
 	Py_RETURN_NONE;
 }
 
 static PyObject *pysuinput_click(PyObject *self, PyObject *args)
 {
-	int uinput_fd;
+	PyObject *py_driver;
+	struct suinput_driver *c_driver;
 	uint16_t code;
-	if (!PyArg_ParseTuple(args, "iH", &uinput_fd, &code))
+	if (!PyArg_ParseTuple(args, "OH", &py_driver, &code))
 		return NULL;
-	if (suinput_click(uinput_fd, code) == -1)
+	c_driver = (struct suinput_driver *)PyCObject_AsVoidPtr(py_driver);
+	if (suinput_click(c_driver, code) == -1)
 		return PyErr_SetFromErrno(PyExc_IOError);
 	Py_RETURN_NONE;
 }
 
 static PyObject *pysuinput_move_pointer(PyObject *self, PyObject *args)
 {
-	int uinput_fd;
+	PyObject *py_driver;
+	struct suinput_driver *c_driver;
 	int32_t x;
 	int32_t y;
-	if (!PyArg_ParseTuple(args, "iii", &uinput_fd, &x, &y)) {
+	if (!PyArg_ParseTuple(args, "Oii", &py_driver, &x, &y)) {
 		return NULL;
 	}
-	if (suinput_move_pointer(uinput_fd, x, y) == -1)
+	c_driver = (struct suinput_driver *)PyCObject_AsVoidPtr(py_driver);
+	if (suinput_move_pointer(c_driver, x, y) == -1)
 		return PyErr_SetFromErrno(PyExc_IOError);
 	Py_RETURN_NONE;
 }
 
 static PyObject *pysuinput_press_release(PyObject *self, PyObject *args)
 {
-	int uinput_fd;
+	PyObject *py_driver;
+	struct suinput_driver *c_driver;
 	int16_t code;
-	if (!PyArg_ParseTuple(args, "ih", &uinput_fd, &code))
+	if (!PyArg_ParseTuple(args, "Oh", &py_driver, &code))
 		return NULL;
-	if (suinput_press_release(uinput_fd, code) == -1)
+	c_driver = (struct suinput_driver *)PyCObject_AsVoidPtr(py_driver);
+	if (suinput_press_release(c_driver, code) == -1)
 		return PyErr_SetFromErrno(PyExc_IOError);
 	Py_RETURN_NONE;
 }
 
+static PyObject *pysuinput_toggle(PyObject *self, PyObject *args)
+{
+	PyObject *py_driver;
+	struct suinput_driver *c_driver;
+	uint16_t code;
+	if (!PyArg_ParseTuple(args, "OH", &py_driver, &code))
+		return NULL;
+	c_driver = (struct suinput_driver *)PyCObject_AsVoidPtr(py_driver);
+	if (suinput_toggle(c_driver, code) == -1)
+		return PyErr_SetFromErrno(PyExc_IOError);
+	Py_RETURN_NONE;
+}
+
+static PyObject *pysuinput_is_pressed(PyObject *self, PyObject *args)
+{
+	PyObject *py_driver;
+	struct suinput_driver *c_driver;
+	uint16_t code;
+	if (!PyArg_ParseTuple(args, "OH", &py_driver, &code))
+		return NULL;
+	c_driver = (struct suinput_driver *)PyCObject_AsVoidPtr(py_driver);
+	return PyBool_FromLong(suinput_is_pressed(c_driver, code));
+}
+
+static PyObject *pysuinput_is_valid_code(PyObject *self, PyObject *args)
+{
+	uint16_t code;
+	if (!PyArg_ParseTuple(args, "H", &code))
+		return NULL;
+	return PyBool_FromLong(suinput_is_valid_code(code));
+}
+
 static PyMethodDef pysuinputMethods[] = {
 	{"open", pysuinput_open, METH_VARARGS,
-	 "open(str(name), int(bustype), int(vendor), int(product), int(version))\n\n"
+	 "open(name, bustype, vendor, product, version)\n\n"
 	 "Creates and opens a connection to the event device. Returns an uinput\n"
 	 "file descriptor on success. On error, -1 is returned, and errno is set\n"
 	 "appropriately.\n"
@@ -117,7 +161,7 @@ static PyMethodDef pysuinputMethods[] = {
 	},
 
 	{"close", pysuinput_close, METH_VARARGS,
-	 "close(int(uinput_fd))\n\n"
+	 "close(driver)\n\n"
 	 "Destroys and closes a connection to the event device. Returns 0 on\n"
 	 "success. On error, -1 is returned, and errno is set appropriately.\n"
 	 "\n"
@@ -126,7 +170,7 @@ static PyMethodDef pysuinputMethods[] = {
 	},
 
 	{"click", pysuinput_click, METH_VARARGS,
-	 "click(int(uinput_fd), int(code))\n\n"
+	 "click(driver, code)\n\n"
 	 "Sends a press and release events to the event device. Returns 0 on\n"
 	 "success. On error, -1 is returned, and errno is set appropriately.\n"
 	 "\n"
@@ -142,7 +186,7 @@ static PyMethodDef pysuinputMethods[] = {
 	},
 
 	{"press", pysuinput_press, METH_VARARGS,
-	 "press(int(uinput_fd), int(code))\n\n"
+	 "press(driver, code)\n\n"
 	 "Sends a press event to the event device. Event is repeated after\n"
 	 "a short delay until a release event is sent. Returns 0 on success.\n"
 	 "On error, -1 is returned, and errno is set appropriately.\n"
@@ -155,7 +199,7 @@ static PyMethodDef pysuinputMethods[] = {
 	},
 
 	{"release", pysuinput_release, METH_VARARGS,
-	 "release(int(uinput_fd), int(code))\n\n"
+	 "release(driver, code)\n\n"
 	 "Sends a release event to the event device. Returns 0 on success.\n"
 	 "On error, -1 is returned, and errno is set appropriately.\n"
 	 "\n"
@@ -167,7 +211,7 @@ static PyMethodDef pysuinputMethods[] = {
 	},
 
 	{"move_pointer", pysuinput_move_pointer, METH_VARARGS,
-	 "move_pointer(int(uinput_fd), int(x), int(y))\n\n"
+	 "move_pointer(driver, x, y)\n\n"
 	 "Sends a relative pointer motion event to the event device. Values\n"
 	 "increase towards right-bottom. Returns 0 on success. On error, -1\n"
 	 "is returned, and errno is set appropriately.\n"
@@ -177,7 +221,7 @@ static PyMethodDef pysuinputMethods[] = {
 	},
 
 	{"press_release", pysuinput_press_release, METH_VARARGS,
-	 "press_release(int(uinput_fd), int(signed_code))\n\n"
+	 "press_release(driver, signed_code)\n\n"
 	 "Sends a press or a release event to the event device. The sign of\n"
 	 "`code` determines which type of event is sent. Positive `code`\n"
 	 "means press and negative `code` means release. Returns 0 on\n"
@@ -195,6 +239,18 @@ static PyMethodDef pysuinputMethods[] = {
 
 	},
 
+	{"toggle", pysuinput_toggle, METH_VARARGS,
+	 ""
+	},
+
+	{"is_pressed", pysuinput_is_pressed, METH_VARARGS,
+	 ""
+	},
+
+	{"is_valid_code", pysuinput_is_valid_code, METH_VARARGS,
+	 ""
+	},
+
 	{NULL, NULL, 0, NULL}
 };
 
