Refresh documentation and move uinput.is_valid_keycode to uinput.keycodes.is_valid

tuomasjjrasanen · tuomasjjrasanen · commit b504266e7819 · 2010-01-16T22:25:12.000+02:00
diff --git a/setup.py b/setup.py
@@ -11,7 +11,9 @@
                              )
 
 keycodes_module = Extension('uinput.keycodes',
-                         sources=['src/keycodes.c'])
+                            sources=['src/keycodes.c'],
+                            libraries=['suinput'],
+                            )
 
 setup(name='python-uinput',
       version='0.2',
diff --git a/src/__init__.py b/src/__init__.py
@@ -56,6 +56,8 @@
 class Driver(object):
     """Device driver for the Linux uinput-system.
 
+    keycodes are defined in uinput.keycodes -module.
+
     For the documentation of the constructor arguments, see the
     documentation of the corresponding properties.
     """
@@ -76,8 +78,7 @@ def name(self):
 
     @property
     def bustype(self):
-        """Bustype of the device.
-        Must be one of the BUS_ -prefixed constant values.
+        """One of the BUS_ -prefixed constant values.
         """
         return self._bustype
 
@@ -97,74 +98,34 @@ def version(self):
         return self._version
 
     def move_pointer(self, x, y):
-        """Sends a relative pointer motion event to the event device.
-        Values increase towards right-bottom.
-        """
+        "Move pointer towards bottom-right."
         _suinput.move_pointer(self._context, x, y)
 
     def press(self, keycode):
-        """Sends a press event to the event device. Event is repeated after
-        a short delay until a release event is sent.
-
-        keycode must be one of the constant values defined in
-        uinput.keycodes -module.
-        """
+        """Send a press event.
+        Event is repeated after a short delay until a release event is sent."""
         _suinput.press(self._context, keycode)
 
     def release(self, keycode):
-        """Sends a release event to the event device.
-
-        keycode must be one of the constant values defined in
-        uinput.keycodes -module.
-        """
+        "Send a release event."
         _suinput.release(self._context, keycode)
 
     def click(self, keycode):
-        """Sends a press and release events to the event device.
-
-        keycode must be one of the constant values defined in
-        uinput.keycodes -module.
-
-        This method is provided as a convenience and has effectively the
-        same result as calling press() and release() sequentially.
-        """
+        "Send a press and a release event."
         _suinput.click(self._context, keycode)
 
     def press_release(self, signed_keycode):
-        """Sends a press or a release event to the event device.
-        The sign of the signed_keycode determines which type of event is sent.
-        Positive signed_keycode means press and negative means release.
-
-        Absolute value of signed_keycode must be one of the constant
-        values defined in uinput.keycodes module.
-
-        This method is provided as a convenience and has effectively the
-        same result as calling press() when the value of signed_keycode
-        is positive and release() when negative.
-        """
+        """Send a press event if signed_keycode > 0, otherwise send
+        a release event."""
         _suinput.press_release(self._context, signed_keycode)
 
     def toggle(self, keycode):
-        """Press button if it is not pressed currently, release it otherwise.
-        
-        keycode must be one of the constant values defined in
-        uinput.keycodes -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.
-        """
+        "Press button if it is not pressed currently, release it otherwise."
         _suinput.toggle(self._context, keycode)
 
     def is_pressed(self, keycode):
-        """Return True if button is pressed, False otherwise.
-
-        keycode must be one of the constant values defined in
-        uinput.keycodes -module.
-        """
+        "Return True if button is pressed, otherwise return False."
         return _suinput.is_pressed(self._context, keycode)
 
     def __del__(self):
         _suinput.close(self._context)
-
-is_valid_keycode = _suinput.is_valid_code
diff --git a/src/keycodes.c b/src/keycodes.c
@@ -18,10 +18,22 @@
 */
 
 #include <Python.h>
+#include <suinput.h>
 
-#include "linux/uinput.h"
+static PyObject *pysuinput_is_valid(PyObject *self, PyObject *args)
+{
+	uint16_t keycode;
+	if (!PyArg_ParseTuple(args, "H", &keycode))
+		return NULL;
+	return PyBool_FromLong(suinput_is_valid_keycode(keycode));
+}
 
 static PyMethodDef keycodesMethods[] = {
+	{"is_valid", pysuinput_is_valid, METH_VARARGS,
+	 "is_valid(keycode)\n\n"
+	 "Return True if keycode is valid, otherwise return False."
+	},
+
 	{NULL, NULL, 0, NULL}
 };
 
diff --git a/src/pysuinput.c b/src/pysuinput.c
@@ -54,11 +54,11 @@ static PyObject *pysuinput_press(PyObject *self, PyObject *args)
 {
 	PyObject *py_driver;
 	struct suinput_driver *c_driver;
-	uint16_t code;
-	if (!PyArg_ParseTuple(args, "OH", &py_driver, &code))
+	uint16_t keycode;
+	if (!PyArg_ParseTuple(args, "OH", &py_driver, &keycode))
 		return NULL;
 	c_driver = (struct suinput_driver *)PyCObject_AsVoidPtr(py_driver);
-	if (suinput_press(c_driver, code) == -1)
+	if (suinput_press(c_driver, keycode) == -1)
 		return PyErr_SetFromErrno(PyExc_IOError);
 	Py_RETURN_NONE;
 }
@@ -67,11 +67,11 @@ static PyObject *pysuinput_release(PyObject *self, PyObject *args)
 {
 	PyObject *py_driver;
 	struct suinput_driver *c_driver;
-	uint16_t code;
-	if (!PyArg_ParseTuple(args, "OH", &py_driver, &code))
+	uint16_t keycode;
+	if (!PyArg_ParseTuple(args, "OH", &py_driver, &keycode))
 		return NULL;
 	c_driver = (struct suinput_driver *)PyCObject_AsVoidPtr(py_driver);
-	if (suinput_release(c_driver, code) == -1)
+	if (suinput_release(c_driver, keycode) == -1)
 		return PyErr_SetFromErrno(PyExc_IOError);
 	Py_RETURN_NONE;
 }
@@ -80,11 +80,11 @@ static PyObject *pysuinput_click(PyObject *self, PyObject *args)
 {
 	PyObject *py_driver;
 	struct suinput_driver *c_driver;
-	uint16_t code;
-	if (!PyArg_ParseTuple(args, "OH", &py_driver, &code))
+	uint16_t keycode;
+	if (!PyArg_ParseTuple(args, "OH", &py_driver, &keycode))
 		return NULL;
 	c_driver = (struct suinput_driver *)PyCObject_AsVoidPtr(py_driver);
-	if (suinput_click(c_driver, code) == -1)
+	if (suinput_click(c_driver, keycode) == -1)
 		return PyErr_SetFromErrno(PyExc_IOError);
 	Py_RETURN_NONE;
 }
@@ -108,11 +108,11 @@ static PyObject *pysuinput_press_release(PyObject *self, PyObject *args)
 {
 	PyObject *py_driver;
 	struct suinput_driver *c_driver;
-	int16_t code;
-	if (!PyArg_ParseTuple(args, "Oh", &py_driver, &code))
+	int16_t keycode;
+	if (!PyArg_ParseTuple(args, "Oh", &py_driver, &keycode))
 		return NULL;
 	c_driver = (struct suinput_driver *)PyCObject_AsVoidPtr(py_driver);
-	if (suinput_press_release(c_driver, code) == -1)
+	if (suinput_press_release(c_driver, keycode) == -1)
 		return PyErr_SetFromErrno(PyExc_IOError);
 	Py_RETURN_NONE;
 }
@@ -121,11 +121,11 @@ 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))
+	uint16_t keycode;
+	if (!PyArg_ParseTuple(args, "OH", &py_driver, &keycode))
 		return NULL;
 	c_driver = (struct suinput_driver *)PyCObject_AsVoidPtr(py_driver);
-	if (suinput_toggle(c_driver, code) == -1)
+	if (suinput_toggle(c_driver, keycode) == -1)
 		return PyErr_SetFromErrno(PyExc_IOError);
 	Py_RETURN_NONE;
 }
@@ -134,121 +134,64 @@ 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))
+	uint16_t keycode;
+	if (!PyArg_ParseTuple(args, "OH", &py_driver, &keycode))
 		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));
+	return PyBool_FromLong(suinput_is_pressed(c_driver, keycode));
 }
 
 static PyMethodDef pysuinputMethods[] = {
 	{"open", pysuinput_open, METH_VARARGS,
 	 "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"
-	 "\n"
-	 "All possible values of `bustype` are defined as constants prefixed\n"
-	 "by BUS_.\n"   
+	 "Return an input driver.\n"
+	 "All possible values of bustype are defined as constants prefixed\n"
+	 "by BUS_, vendor, product and version are unsigned 16 bit integers."
+	 "close() must be called for every object returned by this function."
 	},
 
 	{"close", pysuinput_close, METH_VARARGS,
 	 "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"
-	 "Behaviour is undefined when passed a file descriptor not returned by\n"
-	 "suinput_open()."
+	 "Close and destroy the driver."
 	},
 
 	{"click", pysuinput_click, METH_VARARGS,
-	 "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"
-	 "Behaviour is undefined when passed a file descriptor not returned by\n"
-	 "suinput_open().\n"
-	 "\n"
-	 "All possible values of `code` are defined as constants in\n"
-	 "uinput.codes -module.\n"
-	 "\n"
-	 "This function is provided as a convenience and has effectively the\n"
-	 "same result as calling suinput_press() and suinput_release()\n"
-	 "sequentially."
+	 "click(driver, keycode)\n\n"
+	 "Send a press and a release event."
 	},
 
 	{"press", pysuinput_press, METH_VARARGS,
-	 "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"
-	 "\n"
-	 "Behaviour is undefined when passed a file descriptor not returned by\n"
-	 "suinput_open().\n"
-	 "\n"
-	 "All possible values of `code` are defined as constants in\n"
-	 "uinput.codes -module."
+	 "press(driver, keycode)\n\n"
+	 "Send a press event.\n"
+	 "Event is repeated after a short delay until a release event is sent."
 	},
 
 	{"release", pysuinput_release, METH_VARARGS,
-	 "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"
-	 "Behaviour is undefined when passed a file descriptor not returned by\n"
-	 "suinput_open().\n"
-	 "\n"
-	 "All possible values of `code` are defined as constants in\n"
-	 "uinput.codes -module."
+	 "release(driver, keycode)\n\n"
+	 "Send a release event."
 	},
 
 	{"move_pointer", pysuinput_move_pointer, METH_VARARGS,
 	 "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"
-	 "\n"
-	 "Behaviour is undefined when passed a file descriptor not returned by\n"
-	 "suinput_open()."
+	 "Move pointer towards bottom-right."
 	},
 
 	{"press_release", pysuinput_press_release, METH_VARARGS,
-	 "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"
-	 "success. On error, -1 is returned, and errno is set appropriately.\n"
-	 "\n"
-	 "Behaviour is undefined when passed a file descriptor not returned by\n"
-	 "suinput_open().\n"
-	 "\n"
-	 "All possible absolute values of `code` are defined as constants in\n"
-	 "uinput.codes -module.\n"
-	 "\n"
-	 "This function is provided as a convenience and has effectively the\n"
-	 "same result as calling suinput_press() when the value of `code` is\n"
-	 "positive and suinput_release() when negative."
-
+	 "press_release(driver, signed_keycode)\n\n"
+	 "Send a press event if signed_keycode > 0, otherwise send\n"
+	 "a release event."
 	},
 
 	{"toggle", pysuinput_toggle, METH_VARARGS,
-	 ""
+	 "toggle(driver, keycode)\n\n"
+	 "Press button if it is not pressed currently, release it otherwise."
 	},
 
 	{"is_pressed", pysuinput_is_pressed, METH_VARARGS,
-	 ""
-	},
-
-	{"is_valid_code", pysuinput_is_valid_code, METH_VARARGS,
-	 ""
+	 "is_pressed(driver, keycode)\n\n"
+	 "Return True if button is pressed, False otherwise.\n"
+	 "keycode must be one of the constant values defined in\n"
+	 "uinput.keycodes -module."
 	},
 
 	{NULL, NULL, 0, NULL}

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,9 @@`
`11`	`11`	`)`
`12`	`12`
`13`	`13`	`keycodes_module = Extension('uinput.keycodes',`
`14`		`- sources=['src/keycodes.c'])`
	`14`	`+ sources=['src/keycodes.c'],`
	`15`	`+ libraries=['suinput'],`
	`16`	`+ )`
`15`	`17`
`16`	`18`	`setup(name='python-uinput',`
`17`	`19`	`version='0.2',`