include/X11/extensions/XKBcommon.h

   1 /*
   2 Copyright 1985, 1987, 1990, 1998  The Open Group
   3 Copyright 2008  Dan Nicholson
   4
   5 Permission is hereby granted, free of charge, to any person obtaining a
   6 copy of this software and associated documentation files (the "Software"),
   7 to deal in the Software without restriction, including without limitation
   8 the rights to use, copy, modify, merge, publish, distribute, sublicense,
   9 and/or sell copies of the Software, and to permit persons to whom the
  10 Software is furnished to do so, subject to the following conditions:
  11
  12 The above copyright notice and this permission notice shall be included in
  13 all copies or substantial portions of the Software.
  14
  15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18 AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  19 ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  20 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  21
  22 Except as contained in this notice, the names of the authors or their
  23 institutions shall not be used in advertising or otherwise to promote the
  24 sale, use or other dealings in this Software without prior written
  25 authorization from the authors.
  26 */
  27
  28 #ifndef _XKBCOMMON_H_
  29 #define _XKBCOMMON_H_
  30
  31 #include <X11/X.h>
  32 #include <X11/Xdefs.h>
  33 #include <X11/Xfuncproto.h>
  34 #include <X11/keysym.h>
  35 #include <X11/extensions/XKBstrcommon.h>
  36 #include <X11/extensions/XKBgeomcommon.h>
  37
  38 /* Common keyboard description structure */
  39 typedef struct _XkbcDesc {
  40     unsigned int        defined;
  41     unsigned short      flags;
  42     unsigned short      device_spec;
  43     KeyCode             min_key_code;
  44     KeyCode             max_key_code;
  45
  46     XkbControlsPtr      ctrls;
  47     XkbServerMapPtr     server;
  48     XkbClientMapPtr     map;
  49     XkbIndicatorPtr     indicators;
  50     XkbNamesPtr         names;
  51     XkbCompatMapPtr     compat;
  52     XkbGeometryPtr      geom;
  53 } XkbcDescRec, *XkbcDescPtr;
  54
  55 #define _XkbcKSLower (1 << 0)
  56 #define _XkbcKSUpper (1 << 1)
  57
  58 #define XkbcKSIsLower(k) (_XkbcKSCheckCase(k) & _XkbcKSLower)
  59 #define XkbcKSIsUpper(k) (_XkbcKSCheckCase(k) & _XkbcKSUpper)
  60 #define XkbcKSIsKeypad(k) \
  61     (((k) >= XK_KP_Space) && ((k) <= XK_KP_Equal))
  62 #define XkbcKSIsDeadKey(k) \
  63     (((k) >= XK_dead_grave) && ((k) <= XK_dead_semivoiced_sound))
  64
  65 _XFUNCPROTOBEGIN
  66
  67 extern char *
  68 XkbcKeysymToString(KeySym ks);
  69
  70 extern KeySym
  71 XkbcStringToKeysym(const char *s);
  72
  73 extern int
  74 XkbcAllocCompatMap(XkbcDescPtr xkb, unsigned which, unsigned nSI);
  75
  76 extern void
  77 XkbcFreeCompatMap(XkbcDescPtr xkb, unsigned which, Bool freeMap);
  78
  79 extern int
  80 XkbcAllocNames(XkbcDescPtr xkb, unsigned which, int nTotalRG, int nTotalAliases);
  81
  82 extern void
  83 XkbcFreeNames(XkbcDescPtr xkb, unsigned which, Bool freeMap);
  84
  85 extern int
  86 XkbcAllocControls(XkbcDescPtr xkb, unsigned which);
  87
  88 extern void
  89 XkbcFreeControls(XkbcDescPtr xkb, unsigned which, Bool freeMap);
  90
  91 extern int
  92 XkbcAllocIndicatorMaps(XkbcDescPtr xkb);
  93
  94 extern void
  95 XkbcFreeIndicatorMaps(XkbcDescPtr xkb);
  96
  97 extern XkbcDescRec *
  98 XkbcAllocKeyboard(void);
  99
 100 extern void
 101 XkbcFreeKeyboard(XkbcDescPtr xkb, unsigned which, Bool freeAll);
 102
 103 extern int
 104 XkbcAllocClientMap(XkbcDescPtr xkb, unsigned which, unsigned nTotalTypes);
 105
 106 extern int
 107 XkbcAllocServerMap(XkbcDescPtr xkb, unsigned which, unsigned nNewActions);
 108
 109 extern int
 110 XkbcCopyKeyType(XkbKeyTypePtr from, XkbKeyTypePtr into);
 111
 112 extern int
 113 XkbcCopyKeyTypes(XkbKeyTypePtr from, XkbKeyTypePtr into, int num_types);
 114
 115 extern int
 116 XkbcResizeKeyType(XkbcDescPtr xkb, int type_ndx, int map_count,
 117                   Bool want_preserve, int new_num_lvls);
 118
 119 extern KeySym *
 120 XkbcResizeKeySyms(XkbcDescPtr xkb, int key, int needed);
 121
 122 extern int
 123 XkbcChangeKeycodeRange(XkbcDescPtr xkb, int minKC, int maxKC,
 124                        XkbChangesPtr changes);
 125
 126 extern XkbAction *
 127 XkbcResizeKeyActions(XkbcDescPtr xkb, int key, int needed);
 128
 129 extern void
 130 XkbcFreeClientMap(XkbcDescPtr xkb, unsigned what, Bool freeMap);
 131
 132 extern void
 133 XkbcFreeServerMap(XkbcDescPtr xkb, unsigned what, Bool freeMap);
 134
 135 extern void
 136 XkbcFreeGeomProperties(XkbGeometryPtr geom, int first, int count, Bool freeAll);
 137
 138 extern void
 139 XkbcFreeGeomKeyAliases(XkbGeometryPtr geom, int first, int count, Bool freeAll);
 140
 141 extern void
 142 XkbcFreeGeomColors(XkbGeometryPtr geom, int first, int count, Bool freeAll);
 143
 144 extern void
 145 XkbcFreeGeomPoints(XkbOutlinePtr outline, int first, int count, Bool freeAll);
 146
 147 extern void
 148 XkbcFreeGeomOutlines(XkbShapePtr shape, int first, int count, Bool freeAll);
 149
 150 extern void
 151 XkbcFreeGeomShapes(XkbGeometryPtr geom, int first, int count, Bool freeAll);
 152
 153 extern void
 154 XkbcFreeGeomOverlayKeys(XkbOverlayRowPtr row, int first, int count,
 155                         Bool freeAll);
 156
 157 extern void
 158 XkbcFreeGeomOverlayRows(XkbOverlayPtr overlay, int first, int count,
 159                         Bool freeAll);
 160
 161 extern void
 162 XkbcFreeGeomOverlays(XkbSectionPtr section, int first, int count, Bool freeAll);
 163
 164 extern void
 165 XkbcFreeGeomKeys(XkbRowPtr row, int first, int count, Bool freeAll);
 166
 167 extern void
 168 XkbcFreeGeomRows(XkbSectionPtr section, int first, int count, Bool freeAll);
 169
 170 extern void
 171 XkbcFreeGeomSections(XkbGeometryPtr geom, int first, int count, Bool freeAll);
 172
 173 extern void
 174 XkbcFreeGeomDoodads(XkbDoodadPtr doodads, int nDoodads, Bool freeAll);
 175
 176 extern void
 177 XkbcFreeGeometry(XkbGeometryPtr geom, unsigned which, Bool freeMap);
 178
 179 extern int
 180 XkbcAllocGeomProps(XkbGeometryPtr geom, int nProps);
 181
 182 extern int
 183 XkbcAllocGeomColors(XkbGeometryPtr geom, int nColors);
 184
 185 extern int
 186 XkbcAllocGeomKeyAliases(XkbGeometryPtr geom, int nKeyAliases);
 187
 188 extern int
 189 XkbcAllocGeomShapes(XkbGeometryPtr geom, int nShapes);
 190
 191 extern int
 192 XkbcAllocGeomSections(XkbGeometryPtr geom, int nSections);
 193
 194 extern int
 195 XkbcAllocGeomOverlays(XkbSectionPtr section, int nOverlays);
 196
 197 extern int
 198 XkbcAllocGeomOverlayRows(XkbOverlayPtr overlay, int nRows);
 199
 200 extern int
 201 XkbcAllocGeomOverlayKeys(XkbOverlayRowPtr row, int nKeys);
 202
 203 extern int
 204 XkbcAllocGeomDoodads(XkbGeometryPtr geom, int nDoodads);
 205
 206 extern int
 207 XkbcAllocGeomSectionDoodads(XkbSectionPtr section, int nDoodads);
 208
 209 extern int
 210 XkbcAllocGeomOutlines(XkbShapePtr shape, int nOL);
 211
 212 extern int
 213 XkbcAllocGeomRows(XkbSectionPtr section, int nRows);
 214
 215 extern int
 216 XkbcAllocGeomPoints(XkbOutlinePtr ol, int nPts);
 217
 218 extern int
 219 XkbcAllocGeomKeys(XkbRowPtr row, int nKeys);
 220
 221 extern int
 222 XkbcAllocGeometry(XkbcDescPtr xkb, XkbGeometrySizesPtr sizes);
 223
 224 extern XkbPropertyPtr
 225 XkbcAddGeomProperty(XkbGeometryPtr geom, char *name, char *value);
 226
 227 extern XkbKeyAliasPtr
 228 XkbcAddGeomKeyAlias(XkbGeometryPtr geom, char *aliasStr, char *realStr);
 229
 230 extern XkbColorPtr
 231 XkbcAddGeomColor(XkbGeometryPtr geom, char *spec, unsigned int pixel);
 232
 233 extern XkbOutlinePtr
 234 XkbcAddGeomOutline(XkbShapePtr shape, int sz_points);
 235
 236 extern XkbShapePtr
 237 XkbcAddGeomShape(XkbGeometryPtr geom, Atom name, int sz_outlines);
 238
 239 extern XkbKeyPtr
 240 XkbcAddGeomKey(XkbRowPtr row);
 241
 242 extern XkbRowPtr
 243 XkbcAddGeomRow(XkbSectionPtr section, int sz_keys);
 244
 245 extern XkbSectionPtr
 246 XkbcAddGeomSection(XkbGeometryPtr geom, Atom name,
 247                    int sz_rows, int sz_doodads, int sz_over);
 248
 249 extern XkbDoodadPtr
 250 XkbcAddGeomDoodad(XkbGeometryPtr geom, XkbSectionPtr section, Atom name);
 251
 252 extern XkbOverlayKeyPtr
 253 XkbcAddGeomOverlayKey(XkbOverlayPtr overlay, XkbOverlayRowPtr row,
 254                       char *over, char *under);
 255
 256 extern XkbOverlayRowPtr
 257 XkbcAddGeomOverlayRow(XkbOverlayPtr overlay, int row_under, int sz_keys);
 258
 259 extern XkbOverlayPtr
 260 XkbcAddGeomOverlay(XkbSectionPtr section, Atom name, int sz_rows);
 261
 262 extern void
 263 XkbcInitAtoms(void);
 264
 265 extern char *
 266 XkbcAtomGetString(Atom atom);
 267
 268 extern Atom
 269 XkbcInternAtom(char *name, Bool onlyIfExists);
 270
 271 extern char *
 272 XkbcAtomText(Atom atm);
 273
 274 extern char *
 275 XkbcVModIndexText(XkbcDescPtr xkb, unsigned ndx);
 276
 277 extern char *
 278 XkbcVModMaskText(XkbcDescPtr xkb, unsigned modMask, unsigned mask);
 279
 280 extern char *
 281 XkbcModIndexText(unsigned ndx);
 282
 283 extern char *
 284 XkbcModMaskText(unsigned mask, Bool cFormat);
 285
 286 extern char *
 287 XkbcConfigText(unsigned config);
 288
 289 extern char *
 290 XkbcGeomFPText(int val);
 291
 292 extern char *
 293 XkbcActionTypeText(unsigned type);
 294
 295 extern char *
 296 XkbcKeysymText(KeySym sym);
 297
 298 extern char *
 299 XkbcKeyNameText(char *name);
 300
 301 extern char *
 302 XkbcSIMatchText(unsigned type);
 303
 304 extern Bool
 305 XkbcComputeShapeBounds(XkbShapePtr shape);
 306
 307 extern Bool
 308 XkbcComputeShapeTop(XkbShapePtr shape, XkbBoundsPtr bounds);
 309
 310 extern Bool
 311 XkbcComputeRowBounds(XkbGeometryPtr geom, XkbSectionPtr section, XkbRowPtr row);
 312
 313 extern Bool
 314 XkbcComputeSectionBounds(XkbGeometryPtr geom, XkbSectionPtr section);
 315
 316 extern int
 317 XkbcInitCanonicalKeyTypes(XkbcDescPtr xkb, unsigned which, int keypadVMod);
 318
 319 extern Bool
 320 XkbcVirtualModsToReal(XkbcDescPtr xkb, unsigned virtual_mask,
 321                       unsigned *mask_rtrn);
 322
 323 extern Bool
 324 XkbcComputeEffectiveMap(XkbcDescPtr xkb, XkbKeyTypePtr type,
 325                         unsigned char *map_rtrn);
 326
 327 extern void
 328 XkbcEnsureSafeMapName(char *name);
 329
 330 extern unsigned
 331 _XkbcKSCheckCase(KeySym  sym);
 332
 333 _XFUNCPROTOEND
 334
 335 #endif /* _XKBCOMMON_H_ */