Use term keycode instead of just plain code.

tuomasjjrasanen · tuomasjjrasanen · commit 7339a36537f4 · 2010-01-16T21:42:39.000+02:00
diff --git a/setup.py b/setup.py
@@ -10,8 +10,8 @@
                              libraries=['suinput'],
                              )
 
-codes_module = Extension('uinput.codes',
-                         sources=['src/codes.c'])
+keycodes_module = Extension('uinput.keycodes',
+                         sources=['src/keycodes.c'])
 
 setup(name='python-uinput',
       version='0.2',
@@ -22,7 +22,7 @@
       download_url='http://codegrove.org/python-uinput/0.2/python-uinput-0.2.tar.gz',
       package_dir={'uinput': 'src'},
       packages=['uinput'],
-      ext_modules=[pysuinput_module, codes_module],
+      ext_modules=[pysuinput_module, keycodes_module],
       license='LGPLv3+',
       platforms=['Linux'],
       classifiers=[
diff --git a/src/__init__.py b/src/__init__.py
@@ -24,7 +24,7 @@
 >>> import uinput
 >>> driver = uinput.Driver()
 >>> driver.move_pointer(100, 100)
->>> driver.click(uinput.codes.BTN_LEFT)
+>>> driver.click(uinput.keycodes.BTN_LEFT)
 """
 
 import _suinput
@@ -47,7 +47,7 @@
 from _suinput import BUS_GSC
 from _suinput import BUS_ATARI
 
-import codes
+import keycodes
 
 __all__ = [
     "Driver",
@@ -102,69 +102,69 @@ def move_pointer(self, x, y):
         """
         _suinput.move_pointer(self._context, x, y)
 
-    def press(self, code):
+    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.
 
-        code must be one of the constant values defined in
-        uinput.codes -module.
+        keycode must be one of the constant values defined in
+        uinput.keycodes -module.
         """
-        _suinput.press(self._context, code)
+        _suinput.press(self._context, keycode)
 
-    def release(self, code):
+    def release(self, keycode):
         """Sends a release event to the event device.
 
-        code must be one of the constant values defined in
-        uinput.codes -module.
+        keycode must be one of the constant values defined in
+        uinput.keycodes -module.
         """
-        _suinput.release(self._context, code)
+        _suinput.release(self._context, keycode)
 
-    def click(self, code):
+    def click(self, keycode):
         """Sends a press and release events to the event device.
 
-        code must be one of the constant values defined in
-        uinput.codes -module.
+        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.
         """
-        _suinput.click(self._context, code)
+        _suinput.click(self._context, keycode)
 
-    def press_release(self, signed_code):
+    def press_release(self, signed_keycode):
         """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.
+        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_code must be one of the constant
-        values defined in uinput.codes module.
+        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_code
+        same result as calling press() when the value of signed_keycode
         is positive and release() when negative.
         """
-        _suinput.press_release(self._context, signed_code)
+        _suinput.press_release(self._context, signed_keycode)
 
-    def toggle(self, code):
+    def toggle(self, keycode):
         """Press button if it is not pressed currently, release it otherwise.
         
-        code must be one of the constant values defined in
-        uinput.codes -module.
+        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.
         """
-        _suinput.toggle(self._context, code)
+        _suinput.toggle(self._context, keycode)
 
-    def is_pressed(self, code):
+    def is_pressed(self, keycode):
         """Return True if button is pressed, False otherwise.
 
-        code must be one of the constant values defined in
-        uinput.codes -module.
+        keycode must be one of the constant values defined in
+        uinput.keycodes -module.
         """
-        return _suinput.is_pressed(self._context, code)
+        return _suinput.is_pressed(self._context, keycode)
 
     def __del__(self):
         _suinput.close(self._context)
 
-is_valid_code = _suinput.is_valid_code
+is_valid_keycode = _suinput.is_valid_code
diff --git a/src/keycodes.c b/src/keycodes.c
@@ -1,5 +1,5 @@
 /*
-  codes.c - Button and key codes used in Linux input system
+  keycodes.c - Button and key codes used in Linux input system
   Copyright (C) 2009 Tuomas Räsänen <tuos@codegrove.org>
 
   This library is free software; you can redistribute it and/or
@@ -21,14 +21,14 @@
 
 #include "linux/uinput.h"
 
-static PyMethodDef codesMethods[] = {
+static PyMethodDef keycodesMethods[] = {
 	{NULL, NULL, 0, NULL}
 };
 
-PyMODINIT_FUNC initcodes(void)
+PyMODINIT_FUNC initkeycodes(void)
 {
 	PyObject *module;
-	module = Py_InitModule3("codes", codesMethods,
+	module = Py_InitModule3("keycodes", keycodesMethods,
 				"Button and key codes used in Linux input system");
 	PyModule_AddIntMacro(module, KEY_ESC);
 	PyModule_AddIntMacro(module, KEY_1);
