Add and use xkb_level_index_t
[platform/upstream/libxkbcommon.git] / 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 struct _LookupEntry {
33     const char *name;
34     unsigned int value;
35 } LookupEntry;
36
37 extern const char *
38 exprOpText(enum expr_op_type op);
39
40 bool
41 ExprResolveLhs(struct xkb_context *ctx, const ExprDef *expr,
42                const char **elem_rtrn, const char **field_rtrn,
43                ExprDef **index_rtrn);
44
45 bool
46 LookupModMask(struct xkb_context *ctx, const void *priv, xkb_atom_t field,
47               enum expr_value_type type, xkb_mod_mask_t *val_rtrn);
48
49 bool
50 LookupVModMask(struct xkb_context *ctx, const void *priv, xkb_atom_t field,
51                enum expr_value_type type, xkb_mod_mask_t *val_rtrn);
52
53 bool
54 LookupModIndex(struct xkb_context *ctx, const void *priv, xkb_atom_t field,
55                enum expr_value_type type, xkb_mod_index_t *val_rtrn);
56
57 bool
58 ExprResolveModMask(struct xkb_context *ctx, const ExprDef *expr,
59                    xkb_mod_mask_t *mask_rtrn);
60
61 bool
62 ExprResolveVModMask(struct xkb_keymap *keymap, const ExprDef *expr,
63                     xkb_mod_mask_t *mask_rtrn);
64
65 bool
66 ExprResolveBoolean(struct xkb_context *ctx, const ExprDef *expr,
67                    bool *set_rtrn);
68
69 bool
70 ExprResolveKeyCode(struct xkb_context *ctx, const ExprDef *expr,
71                    xkb_keycode_t *kc);
72
73 bool
74 ExprResolveInteger(struct xkb_context *ctx, const ExprDef *expr,
75                    int *val_rtrn);
76
77 bool
78 ExprResolveLevel(struct xkb_context *ctx, const ExprDef *expr,
79                  xkb_level_index_t *level_rtrn);
80
81 bool
82 ExprResolveGroup(struct xkb_context *ctx, const ExprDef *expr,
83                  xkb_group_index_t *group_rtrn);
84
85 bool
86 ExprResolveButton(struct xkb_context *ctx, const ExprDef *expr,
87                   int *btn_rtrn);
88
89 bool
90 ExprResolveString(struct xkb_context *ctx, const ExprDef *expr,
91                   const char **val_rtrn);
92
93 bool
94 ExprResolveKeyName(struct xkb_context *ctx, const ExprDef *expr,
95                    char name[XkbKeyNameLength]);
96
97 bool
98 ExprResolveEnum(struct xkb_context *ctx, const ExprDef *expr,
99                 unsigned int *val_rtrn, const LookupEntry *values);
100
101 bool
102 ExprResolveMask(struct xkb_context *ctx, const ExprDef *expr,
103                 unsigned int *mask_rtrn, const LookupEntry *values);
104
105 bool
106 ExprResolveKeySym(struct xkb_context *ctx, const ExprDef *expr,
107                   xkb_keysym_t *sym_rtrn);
108
109 #endif /* EXPR_H */