Introduce xkb_keycode_t for keycodes
[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 typedef union _ExprResult
31 {
32     char *str;
33     int ival;
34     unsigned uval;
35     struct xkb_key_name keyName;
36 } ExprResult;
37
38 typedef Bool(*IdentLookupFunc) (char * /* priv */ ,
39                                 uint32_t /* elem */ ,
40                                 uint32_t /* field */ ,
41                                 unsigned /* type */ ,
42                                 ExprResult *    /* val_rtrn */
43     );
44
45 extern int ExprResolveLhs(ExprDef * /* expr */ ,
46                           ExprResult * /* elem_rtrn */ ,
47                           ExprResult * /* field_rtrn */ ,
48                           ExprDef **    /* index_rtrn */
49     );
50
51 typedef struct _LookupPriv
52 {
53     char * priv;
54     IdentLookupFunc chain;
55     char * chainPriv;
56 } LookupPriv;
57
58 typedef struct _LookupEntry
59 {
60     const char *name;
61     unsigned result;
62 } LookupEntry;
63
64 typedef struct _LookupTable
65 {
66     char *element;
67     LookupEntry *entries;
68     struct _LookupTable *nextElement;
69 } LookupTable;
70
71
72 extern char *exprOpText(unsigned        /* type */
73     );
74
75 extern int RadioLookup(char * /* priv */ ,
76                        uint32_t /* elem */ ,
77                        uint32_t /* field */ ,
78                        unsigned /* type */ ,
79                        ExprResult *     /* val_rtrn */
80     );
81
82 extern int SimpleLookup(char * /* priv */ ,
83                         uint32_t /* elem */ ,
84                         uint32_t /* field */ ,
85                         unsigned /* type */ ,
86                         ExprResult *    /* val_rtrn */
87     );
88
89 extern int LookupModIndex(char * /* priv */ ,
90                           uint32_t /* elem */ ,
91                           uint32_t /* field */ ,
92                           unsigned /* type */ ,
93                           ExprResult *  /* val_rtrn */
94     );
95
96 extern int ExprResolveModMask(ExprDef * /* expr */ ,
97                               ExprResult * /* val_rtrn */ ,
98                               IdentLookupFunc /* lookup */ ,
99                               char *  /* priv */
100     );
101
102 extern int ExprResolveBoolean(ExprDef * /* expr */ ,
103                               ExprResult * /* val_rtrn */ ,
104                               IdentLookupFunc /* lookup */ ,
105                               char *  /* lookupPriv */
106     );
107
108 extern int ExprResolveKeyCode(ExprDef * /* expr */ ,
109                               ExprResult * /* val_rtrn */
110     );
111
112 extern int ExprResolveInteger(ExprDef * /* expr */ ,
113                               ExprResult * /* val_rtrn */ ,
114                               IdentLookupFunc /* lookup */ ,
115                               char *  /* lookupPriv */
116     );
117
118 extern int ExprResolveFloat(ExprDef * /* expr */ ,
119                             ExprResult * /* val_rtrn */ ,
120                             IdentLookupFunc /* lookup */ ,
121                             char *    /* lookupPriv */
122     );
123
124 extern int ExprResolveString(ExprDef * /* expr */ ,
125                              ExprResult * /* val_rtrn */ ,
126                              IdentLookupFunc /* lookup */ ,
127                              char *   /* lookupPriv */
128     );
129
130 extern int ExprResolveKeyName(ExprDef * /* expr */ ,
131                               ExprResult * /* val_rtrn */ ,
132                               IdentLookupFunc /* lookup */ ,
133                               char *  /* lookupPriv */
134     );
135
136 extern int ExprResolveEnum(ExprDef * /* expr */ ,
137                            ExprResult * /* val_rtrn */ ,
138                            LookupEntry *        /* values */
139     );
140
141 extern int ExprResolveMask(ExprDef * /* expr */ ,
142                            ExprResult * /* val_rtrn */ ,
143                            IdentLookupFunc /* lookup */ ,
144                            char *     /* lookupPriv */
145     );
146
147 extern int ExprResolveKeySym(ExprDef * /* expr */ ,
148                              ExprResult * /* val_rtrn */ ,
149                              IdentLookupFunc /* lookup */ ,
150                              char *   /* lookupPriv */
151     );
152
153 #endif /* EXPR_H */