src/xkbcomp/expr.h

   1 /************************************************************
   2  * Copyright (c) 1994 by Silicon Graphics Computer Systems, Inc.
   3  *
   4  * Permission to use, copy, modify, and distribute this
   5  * software and its documentation for any purpose and without
   6  * fee is hereby granted, provided that the above copyright
   7  * notice appear in all copies and that both that copyright
   8  * notice and this permission notice appear in supporting
   9  * documentation, and that the name of Silicon Graphics not be
  10  * used in advertising or publicity pertaining to distribution
  11  * of the software without specific prior written permission.
  12  * Silicon Graphics makes no representation about the suitability
  13  * of this software for any purpose. It is provided "as is"
  14  * without any express or implied warranty.
  15  *
  16  * SILICON GRAPHICS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
  17  * SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  18  * AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL SILICON
  19  * GRAPHICS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
  20  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  21  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  22  * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION  WITH
  23  * THE USE OR PERFORMANCE OF THIS SOFTWARE.
  24  *
  25  ********************************************************/
  26
  27 #ifndef EXPR_H
  28 #define EXPR_H 1
  29
  30 #include "xkbcomp-priv.h"
  31
  32 typedef union _ExprResult {
  33     int ival;
  34     unsigned uval;
  35 } ExprResult;
  36
  37 typedef struct _LookupEntry {
  38     const char *name;
  39     unsigned result;
  40 } LookupEntry;
  41
  42 extern const char *
  43 exprOpText(enum expr_op_type op);
  44
  45 bool
  46 ExprResolveLhs(struct xkb_context *ctx, ExprDef *expr, const char **elem_rtrn,
  47                const char **field_rtrn, ExprDef **index_rtrn);
  48
  49 extern bool
  50 LookupModMask(struct xkb_context *ctx, const void *priv, xkb_atom_t field,
  51               enum expr_value_type type, ExprResult *val_rtrn);
  52
  53 extern bool
  54 LookupVModMask(struct xkb_context *ctx, const void *priv, xkb_atom_t field,
  55                enum expr_value_type type, ExprResult *val_rtrn);
  56
  57 extern bool
  58 LookupModIndex(struct xkb_context *ctx, const void *priv, xkb_atom_t field,
  59                enum expr_value_type type, ExprResult *val_rtrn);
  60
  61 extern int
  62 ExprResolveModMask(struct xkb_context *ctx, ExprDef *expr,
  63                    ExprResult *val_rtrn);
  64
  65 extern int
  66 ExprResolveVModMask(struct xkb_keymap *keymap, ExprDef *expr,
  67                     ExprResult *val_rtrn);
  68
  69 bool
  70 ExprResolveBoolean(struct xkb_context *ctx, ExprDef *expr, bool *set_rtrn);
  71
  72 bool
  73 ExprResolveKeyCode(struct xkb_context *ctx, ExprDef *expr, xkb_keycode_t *kc);
  74
  75 extern int
  76 ExprResolveInteger(struct xkb_context *ctx, ExprDef *expr,
  77                    ExprResult *val_rtrn);
  78
  79 bool
  80 ExprResolveLevel(struct xkb_context *ctx, ExprDef *expr,
  81                  unsigned int *level_rtrn);
  82
  83 bool
  84 ExprResolveGroup(struct xkb_context *ctx, ExprDef *expr,
  85                  xkb_group_index_t *group_rtrn);
  86
  87 bool
  88 ExprResolveButton(struct xkb_context *ctx, ExprDef *expr, int *btn_rtrn);
  89
  90 bool
  91 ExprResolveString(struct xkb_context *ctx, ExprDef *expr,
  92                   const char **val_rtrn);
  93
  94 bool
  95 ExprResolveKeyName(struct xkb_context *ctx, ExprDef *expr,
  96                    char name[XkbKeyNameLength]);
  97
  98 extern int
  99 ExprResolveEnum(struct xkb_context *ctx, ExprDef *expr, ExprResult *val_rtrn,
 100                 const LookupEntry *values);
 101
 102 extern int
 103 ExprResolveMask(struct xkb_context *ctx, ExprDef *expr, ExprResult *val_rtrn,
 104                 const LookupEntry *values);
 105
 106 bool
 107 ExprResolveKeySym(struct xkb_context *ctx, ExprDef *expr,
 108                   xkb_keysym_t *sym_rtrn);
 109
 110 #endif /* EXPR_H */