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 <X11/extensions/XKBstrcommon.h>
  33 #include <X11/extensions/XKBrulescommon.h>
  34 #include "X11/extensions/XKBcommon.h"
  35
  36 /***====================================================================***/
  37
  38 extern Bool
  39 XkbcComputeEffectiveMap(XkbcDescPtr xkb, XkbcKeyTypePtr type,
  40                         unsigned char *map_rtrn);
  41
  42 /***====================================================================***/
  43
  44 extern int
  45 XkbcInitCanonicalKeyTypes(XkbcDescPtr xkb, unsigned which, int keypadVMod);
  46
  47 extern Bool
  48 XkbcVirtualModsToReal(XkbcDescPtr xkb, unsigned virtual_mask,
  49                       unsigned *mask_rtrn);
  50
  51 extern void
  52 XkbcEnsureSafeMapName(char *name);
  53
  54 extern unsigned
  55 _XkbcKSCheckCase(CARD32 sym);
  56
  57 #define XkbcKSIsLower(k) (_XkbcKSCheckCase(k) & _XkbKSLower)
  58 #define XkbcKSIsUpper(k) (_XkbcKSCheckCase(k) & _XkbKSUpper)
  59
  60 extern Bool
  61 XkbcNameMatchesPattern(char *name, char *ptrn);
  62
  63 /***====================================================================***/
  64
  65 extern char *
  66 XkbcAtomGetString(uint32_t atom);
  67
  68 extern uint32_t
  69 XkbcInternAtom(const char *name, Bool onlyIfExists);
  70
  71 /***====================================================================***/
  72
  73 extern char *
  74 XkbcAtomText(uint32_t atm);
  75
  76 extern char *
  77 XkbcVModIndexText(XkbcDescPtr xkb, unsigned ndx);
  78
  79 extern char *
  80 XkbcVModMaskText(XkbcDescPtr xkb, unsigned modMask, unsigned mask);
  81
  82 extern char *
  83 XkbcModIndexText(unsigned ndx);
  84
  85 extern char *
  86 XkbcModMaskText(unsigned mask, Bool cFormat);
  87
  88 extern char *
  89 XkbcConfigText(unsigned config);
  90
  91 extern char *
  92 XkbcGeomFPText(int val);
  93
  94 extern char *
  95 XkbcActionTypeText(unsigned type);
  96
  97 extern char *
  98 XkbcKeysymText(CARD32 sym);
  99
 100 extern char *
 101 XkbcKeyNameText(char *name);
 102
 103 extern char *
 104 XkbcSIMatchText(unsigned type);
 105
 106 #endif /* _XKBMISC_H_ */