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