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 <stdio.h>
  32 #include <X11/X.h>
  33 #include <X11/Xdefs.h>
  34 #include <X11/Xfuncproto.h>
  35 #include <X11/keysym.h>
  36 #include <X11/extensions/XKBstrcommon.h>
  37 #include <X11/extensions/XKBgeomcommon.h>
  38 #include <X11/extensions/XKBrulescommon.h>
  39
  40 /* Common keyboard description structure */
  41 typedef struct _XkbcDesc {
  42     unsigned int        defined;
  43     unsigned short      flags;
  44     unsigned short      device_spec;
  45     KeyCode             min_key_code;
  46     KeyCode             max_key_code;
  47
  48     XkbControlsPtr      ctrls;
  49     XkbServerMapPtr     server;
  50     XkbClientMapPtr     map;
  51     XkbIndicatorPtr     indicators;
  52     XkbNamesPtr         names;
  53     XkbCompatMapPtr     compat;
  54     XkbGeometryPtr      geom;
  55 } XkbcDescRec, *XkbcDescPtr;
  56
  57 #define _XkbcKSLower (1 << 0)
  58 #define _XkbcKSUpper (1 << 1)
  59
  60 #define XkbcKSIsLower(k) (_XkbcKSCheckCase(k) & _XkbcKSLower)
  61 #define XkbcKSIsUpper(k) (_XkbcKSCheckCase(k) & _XkbcKSUpper)
  62 #define XkbcKSIsKeypad(k) \
  63     (((k) >= XK_KP_Space) && ((k) <= XK_KP_Equal))
  64 #define XkbcKSIsDeadKey(k) \
  65     (((k) >= XK_dead_grave) && ((k) <= XK_dead_semivoiced_sound))
  66
  67 _XFUNCPROTOBEGIN
  68
  69 extern XkbcDescPtr
  70 XkbcCompileKeymapFromRules(const char *rules, XkbRF_VarDefsPtr defs);
  71
  72 extern XkbcDescPtr
  73 XkbcCompileKeymapFromComponents(XkbComponentNamesPtr ktcsg);
  74
  75 extern char *
  76 XkbcKeysymToString(KeySym ks);
  77
  78 extern KeySym
  79 XkbcStringToKeysym(const char *s);
  80
  81 extern int
  82 XkbcAllocCompatMap(XkbcDescPtr xkb, unsigned which, unsigned nSI);
  83
  84 extern void
  85 XkbcFreeCompatMap(XkbcDescPtr xkb, unsigned which, Bool freeMap);
  86
  87 extern int
  88 XkbcAllocNames(XkbcDescPtr xkb, unsigned which, int nTotalRG, int nTotalAliases);
  89
  90 extern void
  91 XkbcFreeNames(XkbcDescPtr xkb, unsigned which, Bool freeMap);
  92
  93 extern int
  94 XkbcAllocControls(XkbcDescPtr xkb, unsigned which);
  95
  96 extern void
  97 XkbcFreeControls(XkbcDescPtr xkb, unsigned which, Bool freeMap);
  98
  99 extern int
 100 XkbcAllocIndicatorMaps(XkbcDescPtr xkb);
 101
 102 extern void
 103 XkbcFreeIndicatorMaps(XkbcDescPtr xkb);
 104
 105 extern XkbcDescRec *
 106 XkbcAllocKeyboard(void);
 107
 108 extern void
 109 XkbcFreeKeyboard(XkbcDescPtr xkb, unsigned which, Bool freeAll);
 110
 111 extern int
 112 XkbcAllocClientMap(XkbcDescPtr xkb, unsigned which, unsigned nTotalTypes);
 113
 114 extern int
 115 XkbcAllocServerMap(XkbcDescPtr xkb, unsigned which, unsigned nNewActions);
 116
 117 extern int
 118 XkbcCopyKeyType(XkbKeyTypePtr from, XkbKeyTypePtr into);
 119
 120 extern int
 121 XkbcCopyKeyTypes(XkbKeyTypePtr from, XkbKeyTypePtr into, int num_types);
 122
 123 extern int
 124 XkbcResizeKeyType(XkbcDescPtr xkb, int type_ndx, int map_count,
 125                   Bool want_preserve, int new_num_lvls);
 126
 127 extern KeySym *
 128 XkbcResizeKeySyms(XkbcDescPtr xkb, int key, int needed);
 129
 130 extern int
 131 XkbcChangeKeycodeRange(XkbcDescPtr xkb, int minKC, int maxKC,
 132                        XkbChangesPtr changes);
 133
 134 extern XkbAction *
 135 XkbcResizeKeyActions(XkbcDescPtr xkb, int key, int needed);
 136
 137 extern void
 138 XkbcFreeClientMap(XkbcDescPtr xkb, unsigned what, Bool freeMap);
 139
 140 extern void
 141 XkbcFreeServerMap(XkbcDescPtr xkb, unsigned what, Bool freeMap);
 142
 143 extern void
 144 XkbcFreeGeomProperties(XkbGeometryPtr geom, int first, int count, Bool freeAll);
 145
 146 extern void
 147 XkbcFreeGeomKeyAliases(XkbGeometryPtr geom, int first, int count, Bool freeAll);
 148
 149 extern void
 150 XkbcFreeGeomColors(XkbGeometryPtr geom, int first, int count, Bool freeAll);
 151
 152 extern void
 153 XkbcFreeGeomPoints(XkbOutlinePtr outline, int first, int count, Bool freeAll);
 154
 155 extern void
 156 XkbcFreeGeomOutlines(XkbShapePtr shape, int first, int count, Bool freeAll);
 157
 158 extern void
 159 XkbcFreeGeomShapes(XkbGeometryPtr geom, int first, int count, Bool freeAll);
 160
 161 extern void
 162 XkbcFreeGeomOverlayKeys(XkbOverlayRowPtr row, int first, int count,
 163                         Bool freeAll);
 164
 165 extern void
 166 XkbcFreeGeomOverlayRows(XkbOverlayPtr overlay, int first, int count,
 167                         Bool freeAll);
 168
 169 extern void
 170 XkbcFreeGeomOverlays(XkbSectionPtr section, int first, int count, Bool freeAll);
 171
 172 extern void
 173 XkbcFreeGeomKeys(XkbRowPtr row, int first, int count, Bool freeAll);
 174
 175 extern void
 176 XkbcFreeGeomRows(XkbSectionPtr section, int first, int count, Bool freeAll);
 177
 178 extern void
 179 XkbcFreeGeomSections(XkbGeometryPtr geom, int first, int count, Bool freeAll);
 180
 181 extern void
 182 XkbcFreeGeomDoodads(XkbDoodadPtr doodads, int nDoodads, Bool freeAll);
 183
 184 extern void
 185 XkbcFreeGeometry(XkbGeometryPtr geom, unsigned which, Bool freeMap);
 186
 187 extern int
 188 XkbcAllocGeomProps(XkbGeometryPtr geom, int nProps);
 189
 190 extern int
 191 XkbcAllocGeomColors(XkbGeometryPtr geom, int nColors);
 192
 193 extern int
 194 XkbcAllocGeomKeyAliases(XkbGeometryPtr geom, int nKeyAliases);
 195
 196 extern int
 197 XkbcAllocGeomShapes(XkbGeometryPtr geom, int nShapes);
 198
 199 extern int
 200 XkbcAllocGeomSections(XkbGeometryPtr geom, int nSections);
 201
 202 extern int
 203 XkbcAllocGeomOverlays(XkbSectionPtr section, int nOverlays);
 204
 205 extern int
 206 XkbcAllocGeomOverlayRows(XkbOverlayPtr overlay, int nRows);
 207
 208 extern int
 209 XkbcAllocGeomOverlayKeys(XkbOverlayRowPtr row, int nKeys);
 210
 211 extern int
 212 XkbcAllocGeomDoodads(XkbGeometryPtr geom, int nDoodads);
 213
 214 extern int
 215 XkbcAllocGeomSectionDoodads(XkbSectionPtr section, int nDoodads);
 216
 217 extern int
 218 XkbcAllocGeomOutlines(XkbShapePtr shape, int nOL);
 219
 220 extern int
 221 XkbcAllocGeomRows(XkbSectionPtr section, int nRows);
 222
 223 extern int
 224 XkbcAllocGeomPoints(XkbOutlinePtr ol, int nPts);
 225
 226 extern int
 227 XkbcAllocGeomKeys(XkbRowPtr row, int nKeys);
 228
 229 extern int
 230 XkbcAllocGeometry(XkbcDescPtr xkb, XkbGeometrySizesPtr sizes);
 231
 232 extern XkbPropertyPtr
 233 XkbcAddGeomProperty(XkbGeometryPtr geom, char *name, char *value);
 234
 235 extern XkbKeyAliasPtr
 236 XkbcAddGeomKeyAlias(XkbGeometryPtr geom, char *aliasStr, char *realStr);
 237
 238 extern XkbColorPtr
 239 XkbcAddGeomColor(XkbGeometryPtr geom, char *spec, unsigned int pixel);
 240
 241 extern XkbOutlinePtr
 242 XkbcAddGeomOutline(XkbShapePtr shape, int sz_points);
 243
 244 extern XkbShapePtr
 245 XkbcAddGeomShape(XkbGeometryPtr geom, Atom name, int sz_outlines);
 246
 247 extern XkbKeyPtr
 248 XkbcAddGeomKey(XkbRowPtr row);
 249
 250 extern XkbRowPtr
 251 XkbcAddGeomRow(XkbSectionPtr section, int sz_keys);
 252
 253 extern XkbSectionPtr
 254 XkbcAddGeomSection(XkbGeometryPtr geom, Atom name,
 255                    int sz_rows, int sz_doodads, int sz_over);
 256
 257 extern XkbDoodadPtr
 258 XkbcAddGeomDoodad(XkbGeometryPtr geom, XkbSectionPtr section, Atom name);
 259
 260 extern XkbOverlayKeyPtr
 261 XkbcAddGeomOverlayKey(XkbOverlayPtr overlay, XkbOverlayRowPtr row,
 262                       char *over, char *under);
 263
 264 extern XkbOverlayRowPtr
 265 XkbcAddGeomOverlayRow(XkbOverlayPtr overlay, int row_under, int sz_keys);
 266
 267 extern XkbOverlayPtr
 268 XkbcAddGeomOverlay(XkbSectionPtr section, Atom name, int sz_rows);
 269
 270 extern void
 271 XkbcInitAtoms(void);
 272
 273 extern char *
 274 XkbcAtomGetString(Atom atom);
 275
 276 extern Atom
 277 XkbcInternAtom(char *name, Bool onlyIfExists);
 278
 279 extern char *
 280 XkbcAtomText(Atom atm);
 281
 282 extern char *
 283 XkbcVModIndexText(XkbcDescPtr xkb, unsigned ndx);
 284
 285 extern char *
 286 XkbcVModMaskText(XkbcDescPtr xkb, unsigned modMask, unsigned mask);
 287
 288 extern char *
 289 XkbcModIndexText(unsigned ndx);
 290
 291 extern char *
 292 XkbcModMaskText(unsigned mask, Bool cFormat);
 293
 294 extern char *
 295 XkbcConfigText(unsigned config);
 296
 297 extern char *
 298 XkbcGeomFPText(int val);
 299
 300 extern char *
 301 XkbcActionTypeText(unsigned type);
 302
 303 extern char *
 304 XkbcKeysymText(KeySym sym);
 305
 306 extern char *
 307 XkbcKeyNameText(char *name);
 308
 309 extern char *
 310 XkbcSIMatchText(unsigned type);
 311
 312 extern Bool
 313 XkbcComputeShapeBounds(XkbShapePtr shape);
 314
 315 extern Bool
 316 XkbcComputeShapeTop(XkbShapePtr shape, XkbBoundsPtr bounds);
 317
 318 extern Bool
 319 XkbcComputeRowBounds(XkbGeometryPtr geom, XkbSectionPtr section, XkbRowPtr row);
 320
 321 extern Bool
 322 XkbcComputeSectionBounds(XkbGeometryPtr geom, XkbSectionPtr section);
 323
 324 extern Bool
 325 XkbcRF_GetComponents(XkbRF_RulesPtr rules, XkbRF_VarDefsPtr defs,
 326                      XkbComponentNamesPtr names);
 327
 328 extern XkbRF_RulePtr
 329 XkbcRF_AddRule(XkbRF_RulesPtr rules);
 330
 331 extern XkbRF_GroupPtr
 332 XkbcRF_AddGroup(XkbRF_RulesPtr rules);
 333
 334 extern Bool
 335 XkbcRF_LoadRules(FILE *file, XkbRF_RulesPtr rules);
 336
 337 extern Bool
 338 XkbcRF_LoadRulesByName(char *base, char *locale, XkbRF_RulesPtr rules);
 339
 340 extern XkbRF_VarDescPtr
 341 XkbcRF_AddVarDesc(XkbRF_DescribeVarsPtr vars);
 342
 343 extern XkbRF_VarDescPtr
 344 XkbcRF_AddVarDescCopy(XkbRF_DescribeVarsPtr vars, XkbRF_VarDescPtr from);
 345
 346 extern XkbRF_DescribeVarsPtr
 347 XkbcRF_AddVarToDescribe(XkbRF_RulesPtr rules, char *name);
 348
 349 extern Bool
 350 XkbcRF_LoadDescriptions(FILE *file, XkbRF_RulesPtr rules);
 351
 352 extern Bool
 353 XkbcRF_LoadDescriptionsByName(char *base, char *locale, XkbRF_RulesPtr rules);
 354
 355 extern XkbRF_RulesPtr
 356 XkbcRF_Load(char *base, char *locale, Bool wantDesc, Bool wantRules);
 357
 358 extern XkbRF_RulesPtr
 359 XkbcRF_Create(int szRules, int szExtra);
 360
 361 extern void
 362 XkbcRF_Free(XkbRF_RulesPtr rules, Bool freeRules);
 363
 364 extern int
 365 XkbcInitCanonicalKeyTypes(XkbcDescPtr xkb, unsigned which, int keypadVMod);
 366
 367 extern Bool
 368 XkbcVirtualModsToReal(XkbcDescPtr xkb, unsigned virtual_mask,
 369                       unsigned *mask_rtrn);
 370
 371 extern Bool
 372 XkbcComputeEffectiveMap(XkbcDescPtr xkb, XkbKeyTypePtr type,
 373                         unsigned char *map_rtrn);
 374
 375 extern void
 376 XkbcEnsureSafeMapName(char *name);
 377
 378 extern unsigned
 379 _XkbcKSCheckCase(KeySym  sym);
 380
 381 _XFUNCPROTOEND
 382
 383 #endif /* _XKBCOMMON_H_ */