src/xkbrules.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 _XKBRULES_H_
  28 #define _XKBRULES_H_
  29
  30 #include <stdio.h>
  31 #include <X11/X.h>
  32 #include <X11/Xdefs.h>
  33 #include "xkbcommon/xkbcommon.h"
  34
  35
  36 /* From filecommon */
  37
  38 #define XkbXKMFile  0
  39 #define XkbCFile    1
  40 #define XkbXKBFile  2
  41 #define XkbMessage  3
  42
  43 #define XkbMapDefined   (1 << 0)
  44 #define XkbStateDefined (1 << 1)
  45
  46 /***====================================================================***/
  47
  48 #define _XkbSuccess                 0
  49 #define _XkbErrMissingNames         1
  50 #define _XkbErrMissingTypes         2
  51 #define _XkbErrMissingReqTypes      3
  52 #define _XkbErrMissingSymbols       4
  53 #define _XkbErrMissingVMods         5
  54 #define _XkbErrMissingIndicators    6
  55 #define _XkbErrMissingCompatMap     7
  56 #define _XkbErrMissingSymInterps    8
  57 #define _XkbErrMissingGeometry      9
  58 #define _XkbErrIllegalDoodad        10
  59 #define _XkbErrIllegalTOCType       11
  60 #define _XkbErrIllegalContents      12
  61 #define _XkbErrEmptyFile            13
  62 #define _XkbErrFileNotFound         14
  63 #define _XkbErrFileCannotOpen       15
  64 #define _XkbErrBadValue             16
  65 #define _XkbErrBadMatch             17
  66 #define _XkbErrBadTypeName          18
  67 #define _XkbErrBadTypeWidth         19
  68 #define _XkbErrBadFileType          20
  69 #define _XkbErrBadFileVersion       21
  70 #define _XkbErrBadFileFormat        22
  71 #define _XkbErrBadAlloc             23
  72 #define _XkbErrBadLength            24
  73 #define _XkbErrXReqFailure          25
  74 #define _XkbErrBadImplementation    26
  75
  76 typedef struct _XkbRF_VarDefs {
  77     char *          model;
  78     char *          layout;
  79     char *          variant;
  80     char *          options;
  81     unsigned short  sz_extra;
  82     unsigned short  num_extra;
  83     char *          extra_names;
  84     char **         extra_values;
  85 } XkbRF_VarDefsRec,*XkbRF_VarDefsPtr;
  86
  87 typedef struct _XkbRF_VarDesc {
  88     char *  name;
  89     char *  desc;
  90 } XkbRF_VarDescRec, *XkbRF_VarDescPtr;
  91
  92 typedef struct _XkbRF_DescribeVars {
  93     int                 sz_desc;
  94     int                 num_desc;
  95     XkbRF_VarDescPtr    desc;
  96 } XkbRF_DescribeVarsRec,*XkbRF_DescribeVarsPtr;
  97
  98 typedef struct _XkbRF_Rule {
  99     int         number;
 100     int         layout_num;
 101     int         variant_num;
 102     char *      model;
 103     char *      layout;
 104     char *      variant;
 105     char *      option;
 106     /* yields */
 107     char *      keycodes;
 108     char *      symbols;
 109     char *      types;
 110     char *      compat;
 111     char *      geometry;
 112     char *      keymap;
 113     unsigned    flags;
 114 } XkbRF_RuleRec,*XkbRF_RulePtr;
 115
 116 typedef struct _XkbRF_Group {
 117     int     number;
 118     char *  name;
 119     char *  words;
 120 } XkbRF_GroupRec, *XkbRF_GroupPtr;
 121
 122 #define XkbRF_PendingMatch  (1L<<1)
 123 #define XkbRF_Option        (1L<<2)
 124 #define XkbRF_Append        (1L<<3)
 125 #define XkbRF_Normal        (1L<<4)
 126 #define XkbRF_Invalid       (1L<<5)
 127
 128 typedef struct _XkbRF_Rules {
 129     XkbRF_DescribeVarsRec   models;
 130     XkbRF_DescribeVarsRec   layouts;
 131     XkbRF_DescribeVarsRec   variants;
 132     XkbRF_DescribeVarsRec   options;
 133     unsigned short          sz_extra;
 134     unsigned short          num_extra;
 135     char **                 extra_names;
 136     XkbRF_DescribeVarsPtr   extra;
 137
 138     unsigned short          sz_rules;
 139     unsigned short          num_rules;
 140     XkbRF_RulePtr           rules;
 141     unsigned short          sz_groups;
 142     unsigned short          num_groups;
 143     XkbRF_GroupPtr          groups;
 144 } XkbRF_RulesRec, *XkbRF_RulesPtr;
 145
 146 #define _XKB_RF_NAMES_PROP_ATOM     "_XKB_RULES_NAMES"
 147 #define _XKB_RF_NAMES_PROP_MAXLEN   1024
 148
 149 /* Action structures used in the server */
 150
 151 extern Bool
 152 XkbcRF_GetComponents(XkbRF_RulesPtr rules, XkbRF_VarDefsPtr defs,
 153                      struct xkb_component_names * names);
 154
 155 extern Bool
 156 XkbcRF_LoadRules(FILE *file, XkbRF_RulesPtr rules);
 157
 158 extern void
 159 XkbcRF_Free(XkbRF_RulesPtr rules, Bool freeRules);
 160
 161 #endif /* _XKBRULES_H_ */