add keyboard.[ch] to libobt. these are for tracking modifier keys, and translating to/from keycodes/keysyms/modmasks (also include a new obt/internal.h for putting functions that are not public)

1 files changed, 70 insertions, 0 deletions

diff --git a/obt/keyboard.h b/obt/keyboard.h
new file mode 100644
index 00000000..348433fb
--- /dev/null
+++ b/obt/keyboard.h
@@ -0,0 +1,70 @@
+/* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
+
+   obt/keyboard.h for the Openbox window manager
+   Copyright (c) 2007        Dana Jansens
+
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 2 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   See the COPYING file for a copy of the GNU General Public License.
+*/
+
+#ifndef __obt_keyboard_h
+#define __obt_keyboard_h
+
+#include <glib.h>
+#include <X11/Xlib.h>
+
+G_BEGIN_DECLS
+
+/*! These keys are bound to the modifier masks in any fashion,
+  except for CapsLock, Shift, and Control. */
+typedef enum {
+    OBT_MODKEY_KEY_CAPSLOCK,
+    OBT_MODKEY_KEY_NUMLOCK,
+    OBT_MODKEY_KEY_SCROLLLOCK,
+    OBT_MODKEY_KEY_SHIFT,
+    OBT_MODKEY_KEY_CONTROL,
+    OBT_MODKEY_KEY_SUPER,
+    OBT_MODKEY_KEY_HYPER,
+    OBT_MODKEY_KEY_META,
+    OBT_MODKEY_KEY_ALT,
+
+    OBT_MODKEY_NUM_KEYS
+} ObtModkeysKey;
+
+void obt_keyboard_reload();
+
+/*! Get the modifier mask(s) for a KeyCode. (eg. a keycode bound to Alt_L could
+  return a mask of (Mod1Mask | Mask3Mask)) */
+guint obt_keyboard_keycode_to_modmask(guint keycode);
+
+/*! Strip off all modifiers except for the modifier keys. This strips stuff
+  like Button1Mask, and also LockMask, NumlockMask, and ScrolllockMask */
+guint obt_keyboard_only_modmasks(guint mask);
+
+/*! Get the modifier masks for a modifier key. This includes both the left and
+  right keys when there are both. */
+guint obt_keyboard_modkey_to_modmask(ObtModkeysKey key);
+
+/*! Convert a KeySym to a KeyCode, because the X function is terrible - says
+  valgrind. */
+KeyCode obt_keyboard_keysym_to_keycode(KeySym sym);
+
+/*! Give the string form of a KeyCode */
+const gchar *obt_keyboard_keycode_to_string(guint keycode);
+
+/*! Translate a KeyCode to the unicode character it represents */
+gunichar obt_keyboard_keycode_to_unichar(guint keycode);
+
+
+G_END_DECLS
+
+#endif /* __obt_keyboard_h */