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 <stdbool.h>
  31
  32 #include "xkbcommon/xkbcommon.h"
  33
  34 /* From filecommon */
  35
  36 typedef struct _XkbRF_VarDefs {
  37     const char *    model;
  38     const char *    layout;
  39     const char *    variant;
  40     const char *    options;
  41     unsigned short  sz_extra;
  42     unsigned short  num_extra;
  43     char *          extra_names;
  44     char **         extra_values;
  45 } XkbRF_VarDefsRec,*XkbRF_VarDefsPtr;
  46
  47 typedef struct _XkbRF_VarDesc {
  48     char *  name;
  49     char *  desc;
  50 } XkbRF_VarDescRec, *XkbRF_VarDescPtr;
  51
  52 typedef struct _XkbRF_DescribeVars {
  53     int                 sz_desc;
  54     int                 num_desc;
  55     XkbRF_VarDescPtr    desc;
  56 } XkbRF_DescribeVarsRec,*XkbRF_DescribeVarsPtr;
  57
  58 typedef struct _XkbRF_Rule {
  59     int         number;
  60     int         layout_num;
  61     int         variant_num;
  62     char *      model;
  63     char *      layout;
  64     char *      variant;
  65     char *      option;
  66     /* yields */
  67     char *      keycodes;
  68     char *      symbols;
  69     char *      types;
  70     char *      compat;
  71     char *      keymap;
  72     unsigned    flags;
  73 } XkbRF_RuleRec,*XkbRF_RulePtr;
  74
  75 typedef struct _XkbRF_Group {
  76     int     number;
  77     char *  name;
  78     char *  words;
  79 } XkbRF_GroupRec, *XkbRF_GroupPtr;
  80
  81 #define XkbRF_PendingMatch  (1L<<1)
  82 #define XkbRF_Option        (1L<<2)
  83 #define XkbRF_Append        (1L<<3)
  84 #define XkbRF_Normal        (1L<<4)
  85 #define XkbRF_Invalid       (1L<<5)
  86
  87 typedef struct _XkbRF_Rules {
  88     XkbRF_DescribeVarsRec   models;
  89     XkbRF_DescribeVarsRec   layouts;
  90     XkbRF_DescribeVarsRec   variants;
  91     XkbRF_DescribeVarsRec   options;
  92     unsigned short          num_extra;
  93     XkbRF_DescribeVarsPtr   extra;
  94
  95     unsigned short          sz_rules;
  96     unsigned short          num_rules;
  97     XkbRF_RulePtr           rules;
  98     unsigned short          sz_groups;
  99     unsigned short          num_groups;
 100     XkbRF_GroupPtr          groups;
 101 } XkbRF_RulesRec, *XkbRF_RulesPtr;
 102
 103 /* Action structures used in the server */
 104
 105 extern bool
 106 XkbcRF_GetComponents(XkbRF_RulesPtr rules, XkbRF_VarDefsPtr defs,
 107                      struct xkb_component_names * names);
 108
 109 extern bool
 110 XkbcRF_LoadRules(FILE *file, XkbRF_RulesPtr rules);
 111
 112 extern void
 113 XkbcRF_Free(XkbRF_RulesPtr rules);
 114
 115 #endif /* _XKBRULES_H_ */