expr: drop ExprResult from ResolveKeyName
[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 union _ExprResult {
33     const char *str;
34     int ival;
35     unsigned uval;
36     char name[XkbKeyNameLength];
37 } ExprResult;
38
39 extern int
40 ExprResolveLhs(struct xkb_keymap *keymap, ExprDef *expr,
41                ExprResult *elem_rtrn, ExprResult *field_rtrn,
42                ExprDef **index_rtrn);
43
44 typedef struct _LookupEntry {
45     const char *name;
46     unsigned result;
47 } LookupEntry;
48
49 extern const char *
50 exprOpText(enum expr_op_type op);
51
52 extern bool
53 LookupModMask(struct xkb_context *ctx, const void *priv, xkb_atom_t field,
54               enum expr_value_type type, ExprResult *val_rtrn);
55
56 extern bool
57 LookupVModMask(struct xkb_context *ctx, const void *priv, xkb_atom_t field,
58                enum expr_value_type type, ExprResult *val_rtrn);
59
60 extern bool
61 LookupModIndex(struct xkb_context *ctx, const void *priv, xkb_atom_t field,
62                enum expr_value_type type, ExprResult *val_rtrn);
63
64 extern int
65 ExprResolveModMask(struct xkb_context *ctx, ExprDef *expr,
66                    ExprResult *val_rtrn);
67
68 extern int
69 ExprResolveVModMask(struct xkb_keymap *keymap, ExprDef *expr,
70                     ExprResult *val_rtrn);
71
72 extern int
73 ExprResolveBoolean(struct xkb_context *ctx, ExprDef *expr,
74                    ExprResult *val_rtrn);
75
76 extern int
77 ExprResolveKeyCode(struct xkb_context *ctx, ExprDef *expr,
78                    ExprResult *val_rtrn);
79
80 extern int
81 ExprResolveInteger(struct xkb_context *ctx, ExprDef *expr,
82                    ExprResult *val_rtrn);
83
84 extern int
85 ExprResolveLevel(struct xkb_context *ctx, ExprDef *expr, ExprResult *val_rtrn);
86
87 extern int
88 ExprResolveGroup(struct xkb_context *ctx, ExprDef *expr, ExprResult *val_rtrn);
89
90 extern int
91 ExprResolveButton(struct xkb_context *ctx, ExprDef *expr,
92                   ExprResult *val_rtrn);
93
94 extern int
95 ExprResolveString(struct xkb_context *ctx, ExprDef *expr,
96                   ExprResult *val_rtrn);
97
98 bool
99 ExprResolveKeyName(struct xkb_context *ctx, ExprDef *expr,
100                    char name[XkbKeyNameLength]);
101
102 extern int
103 ExprResolveEnum(struct xkb_context *ctx, ExprDef *expr, ExprResult *val_rtrn,
104                 const LookupEntry *values);
105
106 extern int
107 ExprResolveMask(struct xkb_context *ctx, ExprDef *expr, ExprResult *val_rtrn,
108                 const LookupEntry *values);
109
110 extern int
111 ExprResolveKeySym(struct xkb_context *ctx, ExprDef *expr,
112                   ExprResult *val_rtrn);
113
114 #endif /* EXPR_H */