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