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