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