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