src/xkbmisc.h

   1 /*
   2 Copyright 2009  Dan Nicholson
   3
   4 Permission is hereby granted, free of charge, to any person obtaining a
   5 copy of this software and associated documentation files (the "Software"),
   6 to deal in the Software without restriction, including without limitation
   7 the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8 and/or sell copies of the Software, and to permit persons to whom the
   9 Software is furnished to do so, subject to the following conditions:
  10
  11 The above copyright notice and this permission notice shall be included in
  12 all copies or substantial portions of the Software.
  13
  14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17 AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  18 ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  19 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  20
  21 Except as contained in this notice, the names of the authors or their
  22 institutions shall not be used in advertising or otherwise to promote the
  23 sale, use or other dealings in this Software without prior written
  24 authorization from the authors.
  25 */
  26
  27 #ifndef _XKBMISC_H_
  28 #define _XKBMISC_H_
  29
  30 #include <X11/X.h>
  31 #include <X11/Xdefs.h>
  32 #include "xkbcommon/xkbcommon.h"
  33
  34 typedef uint32_t xkb_atom_t;
  35
  36 /***====================================================================***/
  37
  38 extern Bool
  39 XkbcComputeEffectiveMap(struct xkb_desc * xkb, struct xkb_key_type * type,
  40                         unsigned char *map_rtrn);
  41
  42 /***====================================================================***/
  43
  44 extern int
  45 XkbcInitCanonicalKeyTypes(struct xkb_desc * xkb, unsigned which, int keypadVMod);
  46
  47 extern Bool
  48 XkbcVirtualModsToReal(struct xkb_desc * xkb, unsigned virtual_mask,
  49                       unsigned *mask_rtrn);
  50
  51 extern void
  52 XkbcEnsureSafeMapName(char *name);
  53
  54 extern unsigned
  55 _XkbcKSCheckCase(xkb_keysym_t sym);
  56
  57 #define _XkbKSLower (1 << 0)
  58 #define _XkbKSUpper (1 << 1)
  59
  60 #define XkbcKSIsLower(k) (_XkbcKSCheckCase(k) & _XkbKSLower)
  61 #define XkbcKSIsUpper(k) (_XkbcKSCheckCase(k) & _XkbKSUpper)
  62
  63 #define XkbKSIsKeypad(k) (((k) >= XK_KP_Space) && ((k) <= XK_KP_Equal))
  64 #define XkbKSIsDeadKey(k) \
  65     (((k) >= XK_dead_grave) && ((k) <= XK_dead_semivoiced_sound))
  66
  67 extern Bool
  68 XkbcNameMatchesPattern(char *name, char *ptrn);
  69
  70 /***====================================================================***/
  71
  72 extern xkb_atom_t
  73 xkb_intern_atom(const char *string);
  74
  75 extern char *
  76 XkbcAtomGetString(xkb_atom_t atom);
  77
  78 extern void
  79 XkbcFreeAllAtoms(void);
  80
  81 /***====================================================================***/
  82
  83 extern const char *
  84 XkbcAtomText(xkb_atom_t atm);
  85
  86 extern const char *
  87 XkbcVModMaskText(struct xkb_desc * xkb, unsigned modMask, unsigned mask);
  88
  89 extern const char *
  90 XkbcModIndexText(unsigned ndx);
  91
  92 extern const char *
  93 XkbcModMaskText(unsigned mask, Bool cFormat);
  94
  95 extern const char *
  96 XkbcConfigText(unsigned config);
  97
  98 extern const char *
  99 XkbcActionTypeText(unsigned type);
 100
 101 extern const char *
 102 XkbcKeysymText(xkb_keysym_t sym);
 103
 104 extern const char *
 105 XkbcKeyNameText(char *name);
 106
 107 extern const char *
 108 XkbcSIMatchText(unsigned type);
 109
 110 #endif /* _XKBMISC_H_ */