kbproto unentanglement: XkbMaxShiftLevel
[platform/upstream/libxkbcommon.git] / src / xkbcomp / expr.c
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 #include "xkbcomp-priv.h"
28 #include "text.h"
29 #include "expr.h"
30
31 typedef bool (*IdentLookupFunc)(struct xkb_context *ctx, const void *priv,
32                                 xkb_atom_t field, enum expr_value_type type,
33                                 unsigned int *val_rtrn);
34
35 bool
36 ExprResolveLhs(struct xkb_context *ctx, const ExprDef *expr,
37                const char **elem_rtrn, const char **field_rtrn,
38                ExprDef **index_rtrn)
39 {
40     switch (expr->op) {
41     case EXPR_IDENT:
42         *elem_rtrn = NULL;
43         *field_rtrn = xkb_atom_text(ctx, expr->value.str);
44         *index_rtrn = NULL;
45         return true;
46     case EXPR_FIELD_REF:
47         *elem_rtrn = xkb_atom_text(ctx, expr->value.field.element);
48         *field_rtrn = xkb_atom_text(ctx, expr->value.field.field);
49         *index_rtrn = NULL;
50         return true;
51     case EXPR_ARRAY_REF:
52         *elem_rtrn = xkb_atom_text(ctx, expr->value.array.element);
53         *field_rtrn = xkb_atom_text(ctx, expr->value.array.field);
54         *index_rtrn = expr->value.array.entry;
55         return true;
56     default:
57         break;
58     }
59     log_wsgo(ctx, "Unexpected operator %d in ResolveLhs\n", expr->op);
60     return false;
61 }
62
63 static bool
64 SimpleLookup(struct xkb_context *ctx, const void *priv, xkb_atom_t field,
65              enum expr_value_type type, unsigned int *val_rtrn)
66 {
67     const LookupEntry *entry;
68     const char *str;
69
70     if (!priv || field == XKB_ATOM_NONE || type != EXPR_TYPE_INT)
71         return false;
72
73     str = xkb_atom_text(ctx, field);
74     for (entry = priv; entry && entry->name; entry++) {
75         if (istreq(str, entry->name)) {
76             *val_rtrn = entry->value;
77             return true;
78         }
79     }
80
81     return false;
82 }
83
84 bool
85 LookupModIndex(struct xkb_context *ctx, const void *priv, xkb_atom_t field,
86                enum expr_value_type type, xkb_mod_index_t *val_rtrn)
87 {
88     const char *name = xkb_atom_text(ctx, field);
89
90     if (istreq(name, "none")) {
91         *val_rtrn = XKB_MOD_INVALID;
92         return true;
93     }
94
95     *val_rtrn = ModNameToIndex(name);
96     return (*val_rtrn != XKB_MOD_INVALID);
97 }
98
99 bool
100 LookupModMask(struct xkb_context *ctx, const void *priv, xkb_atom_t field,
101               enum expr_value_type type, xkb_mod_mask_t *val_rtrn)
102 {
103     const char *str;
104     xkb_mod_index_t ndx;
105
106     if (type != EXPR_TYPE_INT)
107         return false;
108
109     str = xkb_atom_text(ctx, field);
110
111     if (istreq(str, "all"))
112         *val_rtrn  = 0xff;
113     else if (istreq(str, "none"))
114         *val_rtrn = 0;
115     else if (LookupModIndex(ctx, priv, field, type, &ndx))
116         *val_rtrn = (1 << ndx);
117     else
118         return false;
119
120     return true;
121 }
122
123 bool
124 ExprResolveBoolean(struct xkb_context *ctx, const ExprDef *expr,
125                    bool *set_rtrn)
126 {
127     bool ok = false;
128     const char *ident;
129
130     switch (expr->op) {
131     case EXPR_VALUE:
132         if (expr->value_type != EXPR_TYPE_BOOLEAN) {
133             log_err(ctx,
134                     "Found constant of type %s where boolean was expected\n",
135                     expr_value_type_to_string(expr->value_type));
136             return false;
137         }
138         *set_rtrn = !!expr->value.ival;
139         return true;
140
141     case EXPR_IDENT:
142         ident = xkb_atom_text(ctx, expr->value.str);
143         if (ident) {
144             if (istreq(ident, "true") ||
145                 istreq(ident, "yes") ||
146                 istreq(ident, "on")) {
147                 *set_rtrn = true;
148                 return true;
149             }
150             else if (istreq(ident, "false") ||
151                      istreq(ident, "no") ||
152                      istreq(ident, "off")) {
153                 *set_rtrn = false;
154                 return true;
155             }
156         }
157         log_err(ctx, "Identifier \"%s\" of type boolean is unknown\n",
158                 xkb_atom_text(ctx, expr->value.str));
159         return false;
160
161     case EXPR_FIELD_REF:
162         log_err(ctx, "Default \"%s.%s\" of type boolean is unknown\n",
163                 xkb_atom_text(ctx, expr->value.field.element),
164                 xkb_atom_text(ctx, expr->value.field.field));
165         return false;
166
167     case EXPR_INVERT:
168     case EXPR_NOT:
169         ok = ExprResolveBoolean(ctx, expr, set_rtrn);
170         if (ok)
171             *set_rtrn = !*set_rtrn;
172         return ok;
173     case EXPR_ADD:
174     case EXPR_SUBTRACT:
175     case EXPR_MULTIPLY:
176     case EXPR_DIVIDE:
177     case EXPR_ASSIGN:
178     case EXPR_NEGATE:
179     case EXPR_UNARY_PLUS:
180         log_err(ctx, "%s of boolean values not permitted\n",
181                 expr_op_type_to_string(expr->op));
182         break;
183
184     default:
185         log_wsgo(ctx, "Unknown operator %d in ResolveBoolean\n", expr->op);
186         break;
187     }
188
189     return false;
190 }
191
192 bool
193 ExprResolveKeyCode(struct xkb_context *ctx, const ExprDef *expr,
194                    xkb_keycode_t *kc)
195 {
196     xkb_keycode_t leftRtrn, rightRtrn;
197     ExprDef *left, *right;
198
199     switch (expr->op) {
200     case EXPR_VALUE:
201         if (expr->value_type != EXPR_TYPE_INT) {
202             log_err(ctx,
203                     "Found constant of type %s where an int was expected\n",
204                     expr_value_type_to_string(expr->value_type));
205             return false;
206         }
207
208         *kc = expr->value.uval;
209         return true;
210
211     case EXPR_ADD:
212     case EXPR_SUBTRACT:
213     case EXPR_MULTIPLY:
214     case EXPR_DIVIDE:
215         left = expr->value.binary.left;
216         right = expr->value.binary.right;
217
218         if (!ExprResolveKeyCode(ctx, left, &leftRtrn) ||
219             !ExprResolveKeyCode(ctx, right, &rightRtrn))
220             return false;
221
222         switch (expr->op) {
223         case EXPR_ADD:
224             *kc = leftRtrn + rightRtrn;
225             break;
226         case EXPR_SUBTRACT:
227             *kc = leftRtrn - rightRtrn;
228             break;
229         case EXPR_MULTIPLY:
230             *kc = leftRtrn * rightRtrn;
231             break;
232         case EXPR_DIVIDE:
233             if (rightRtrn == 0) {
234                 log_err(ctx, "Cannot divide by zero: %d / %d\n",
235                         leftRtrn, rightRtrn);
236                 return false;
237             }
238
239             *kc = leftRtrn / rightRtrn;
240             break;
241         default:
242             break;
243         }
244
245         return true;
246
247     case EXPR_NEGATE:
248         left = expr->value.child;
249         if (!ExprResolveKeyCode(ctx, left, &leftRtrn))
250             return false;
251
252         *kc = ~leftRtrn;
253         return true;
254
255     case EXPR_UNARY_PLUS:
256         left = expr->value.child;
257         return ExprResolveKeyCode(ctx, left, kc);
258
259     default:
260         log_wsgo(ctx, "Unknown operator %d in ResolveKeyCode\n", expr->op);
261         break;
262     }
263
264     return false;
265 }
266
267 /**
268  * This function returns ... something.  It's a bit of a guess, really.
269  *
270  * If an integer is given in value ctx, it will be returned in ival.
271  * If an ident or field reference is given, the lookup function (if given)
272  * will be called.  At the moment, only SimpleLookup use this, and they both
273  * return the results in uval.  And don't support field references.
274  *
275  * Cool.
276  */
277 static bool
278 ExprResolveIntegerLookup(struct xkb_context *ctx, const ExprDef *expr,
279                          int *val_rtrn, IdentLookupFunc lookup,
280                          const void *lookupPriv)
281 {
282     bool ok = false;
283     int l, r;
284     unsigned u;
285     ExprDef *left, *right;
286
287     switch (expr->op) {
288     case EXPR_VALUE:
289         if (expr->value_type != EXPR_TYPE_INT) {
290             log_err(ctx,
291                     "Found constant of type %s where an int was expected\n",
292                     expr_value_type_to_string(expr->value_type));
293             return false;
294         }
295
296         *val_rtrn = expr->value.ival;
297         return true;
298
299     case EXPR_IDENT:
300         if (lookup)
301             ok = lookup(ctx, lookupPriv, expr->value.str, EXPR_TYPE_INT, &u);
302
303         if (!ok)
304             log_err(ctx, "Identifier \"%s\" of type int is unknown\n",
305                     xkb_atom_text(ctx, expr->value.str));
306         else
307             *val_rtrn = (int) u;
308
309         return ok;
310
311     case EXPR_FIELD_REF:
312         log_err(ctx, "Default \"%s.%s\" of type int is unknown\n",
313                 xkb_atom_text(ctx, expr->value.field.element),
314                 xkb_atom_text(ctx, expr->value.field.field));
315         return false;
316
317     case EXPR_ADD:
318     case EXPR_SUBTRACT:
319     case EXPR_MULTIPLY:
320     case EXPR_DIVIDE:
321         left = expr->value.binary.left;
322         right = expr->value.binary.right;
323         if (!ExprResolveIntegerLookup(ctx, left, &l, lookup, lookupPriv) ||
324             !ExprResolveIntegerLookup(ctx, right, &r, lookup, lookupPriv))
325             return false;
326
327         switch (expr->op) {
328         case EXPR_ADD:
329             *val_rtrn = l + r;
330             break;
331         case EXPR_SUBTRACT:
332             *val_rtrn = l - r;
333             break;
334         case EXPR_MULTIPLY:
335             *val_rtrn = l * r;
336             break;
337         case EXPR_DIVIDE:
338             if (r == 0) {
339                 log_err(ctx, "Cannot divide by zero: %d / %d\n", l, r);
340                 return false;
341             }
342             *val_rtrn = l / r;
343             break;
344         default:
345             break;
346         }
347
348         return true;
349
350     case EXPR_ASSIGN:
351         log_wsgo(ctx, "Assignment operator not implemented yet\n");
352         break;
353
354     case EXPR_NOT:
355         log_err(ctx, "The ! operator cannot be applied to an integer\n");
356         return false;
357
358     case EXPR_INVERT:
359     case EXPR_NEGATE:
360         left = expr->value.child;
361         if (!ExprResolveIntegerLookup(ctx, left, &l, lookup, lookupPriv))
362             return false;
363
364         *val_rtrn = (expr->op == EXPR_NEGATE ? -l : ~l);
365         return true;
366
367     case EXPR_UNARY_PLUS:
368         left = expr->value.child;
369         return ExprResolveIntegerLookup(ctx, left, val_rtrn, lookup,
370                                         lookupPriv);
371
372     default:
373         log_wsgo(ctx, "Unknown operator %d in ResolveInteger\n", expr->op);
374         break;
375     }
376
377     return false;
378 }
379
380 bool
381 ExprResolveInteger(struct xkb_context *ctx, const ExprDef *expr,
382                    int *val_rtrn)
383 {
384     return ExprResolveIntegerLookup(ctx, expr, val_rtrn, NULL, NULL);
385 }
386
387 bool
388 ExprResolveGroup(struct xkb_context *ctx, const ExprDef *expr,
389                  xkb_group_index_t *group_rtrn)
390 {
391     bool ok;
392     int result;
393
394     ok = ExprResolveIntegerLookup(ctx, expr, &result, SimpleLookup,
395                                   groupNames);
396     if (!ok)
397         return false;
398
399     if (result <= 0 || result > XKB_NUM_GROUPS) {
400         log_err(ctx, "Group index %u is out of range (1..%d)\n",
401                 result, XKB_NUM_GROUPS);
402         return false;
403     }
404
405     *group_rtrn = (xkb_group_index_t) result;
406     return true;
407 }
408
409 bool
410 ExprResolveLevel(struct xkb_context *ctx, const ExprDef *expr,
411                  xkb_level_index_t *level_rtrn)
412 {
413     bool ok;
414     int result;
415
416     ok = ExprResolveIntegerLookup(ctx, expr, &result, SimpleLookup,
417                                   levelNames);
418     if (!ok)
419         return false;
420
421     if (result < 1) {
422         log_err(ctx, "Shift level %d is out of range\n", result);
423         return false;
424     }
425
426     /* Level is zero-indexed from now on. */
427     *level_rtrn = (unsigned int) (result - 1);
428     return true;
429 }
430
431 bool
432 ExprResolveButton(struct xkb_context *ctx, const ExprDef *expr, int *btn_rtrn)
433 {
434     int result;
435
436     if (!ExprResolveIntegerLookup(ctx, expr, &result, SimpleLookup,
437                                   buttonNames))
438         return false;
439
440     *btn_rtrn = result;
441     return true;
442 }
443
444 bool
445 ExprResolveString(struct xkb_context *ctx, const ExprDef *expr,
446                   xkb_atom_t *val_rtrn)
447 {
448     switch (expr->op) {
449     case EXPR_VALUE:
450         if (expr->value_type != EXPR_TYPE_STRING) {
451             log_err(ctx, "Found constant of type %s, expected a string\n",
452                     expr_value_type_to_string(expr->value_type));
453             return false;
454         }
455
456         *val_rtrn = expr->value.str;
457         return true;
458
459     case EXPR_IDENT:
460         log_err(ctx, "Identifier \"%s\" of type string not found\n",
461                 xkb_atom_text(ctx, expr->value.str));
462         return false;
463
464     case EXPR_FIELD_REF:
465         log_err(ctx, "Default \"%s.%s\" of type string not found\n",
466                 xkb_atom_text(ctx, expr->value.field.element),
467                 xkb_atom_text(ctx, expr->value.field.field));
468         return false;
469
470     case EXPR_ADD:
471     case EXPR_SUBTRACT:
472     case EXPR_MULTIPLY:
473     case EXPR_DIVIDE:
474     case EXPR_ASSIGN:
475     case EXPR_NEGATE:
476     case EXPR_INVERT:
477     case EXPR_NOT:
478     case EXPR_UNARY_PLUS:
479         log_err(ctx, "%s of strings not permitted\n",
480                 expr_op_type_to_string(expr->op));
481         return false;
482
483     default:
484         log_wsgo(ctx, "Unknown operator %d in ResolveString\n", expr->op);
485         break;
486     }
487     return false;
488 }
489
490 bool
491 ExprResolveKeyName(struct xkb_context *ctx, const ExprDef *expr,
492                    char name[XKB_KEY_NAME_LENGTH])
493 {
494     switch (expr->op) {
495     case EXPR_VALUE:
496         if (expr->value_type != EXPR_TYPE_KEYNAME) {
497             log_err(ctx, "Found constant of type %s, expected a key name\n",
498                     expr_value_type_to_string(expr->value_type));
499             return false;
500         }
501         strncpy(name, expr->value.keyName, XKB_KEY_NAME_LENGTH);
502         return true;
503
504     case EXPR_IDENT:
505         log_err(ctx, "Identifier \"%s\" of type string not found\n",
506                 xkb_atom_text(ctx, expr->value.str));
507         return false;
508
509     case EXPR_FIELD_REF:
510         log_err(ctx, "Default \"%s.%s\" of type key name not found\n",
511                 xkb_atom_text(ctx, expr->value.field.element),
512                 xkb_atom_text(ctx, expr->value.field.field));
513         return false;
514
515     case EXPR_ADD:
516     case EXPR_SUBTRACT:
517     case EXPR_MULTIPLY:
518     case EXPR_DIVIDE:
519     case EXPR_ASSIGN:
520     case EXPR_NEGATE:
521     case EXPR_INVERT:
522     case EXPR_NOT:
523     case EXPR_UNARY_PLUS:
524         log_err(ctx, "%s of key name values not permitted\n",
525                 expr_op_type_to_string(expr->op));
526         return false;
527
528     default:
529         log_wsgo(ctx, "Unknown operator %d in ResolveKeyName\n", expr->op);
530         break;
531     }
532     return false;
533 }
534
535 bool
536 ExprResolveEnum(struct xkb_context *ctx, const ExprDef *expr,
537                 unsigned int *val_rtrn, const LookupEntry *values)
538 {
539     if (expr->op != EXPR_IDENT) {
540         log_err(ctx, "Found a %s where an enumerated value was expected\n",
541                 expr_op_type_to_string(expr->op));
542         return false;
543     }
544
545     if (!SimpleLookup(ctx, values, expr->value.str, EXPR_TYPE_INT,
546                       val_rtrn)) {
547         log_err(ctx, "Illegal identifier %s; expected one of:\n",
548                 xkb_atom_text(ctx, expr->value.str));
549         while (values && values->name)
550         {
551             log_err(ctx, "\t%s\n", values->name);
552             values++;
553         }
554         return false;
555     }
556
557     return true;
558 }
559
560 static bool
561 ExprResolveMaskLookup(struct xkb_context *ctx, const ExprDef *expr,
562                       unsigned int *val_rtrn, IdentLookupFunc lookup,
563                       const void *lookupPriv)
564 {
565     bool ok = 0;
566     unsigned int l, r;
567     int v;
568     ExprDef *left, *right;
569     const char *bogus = NULL;
570
571     switch (expr->op) {
572     case EXPR_VALUE:
573         if (expr->value_type != EXPR_TYPE_INT) {
574             log_err(ctx,
575                     "Found constant of type %s where a mask was expected\n",
576                     expr_value_type_to_string(expr->value_type));
577             return false;
578         }
579         *val_rtrn = (unsigned int) expr->value.ival;
580         return true;
581
582     case EXPR_IDENT:
583         ok = lookup(ctx, lookupPriv, expr->value.str, EXPR_TYPE_INT,
584                     val_rtrn);
585         if (!ok)
586             log_err(ctx, "Identifier \"%s\" of type int is unknown\n",
587                     xkb_atom_text(ctx, expr->value.str));
588         return ok;
589
590     case EXPR_FIELD_REF:
591         log_err(ctx, "Default \"%s.%s\" of type int is unknown\n",
592                 xkb_atom_text(ctx, expr->value.field.element),
593                 xkb_atom_text(ctx, expr->value.field.field));
594         return false;
595
596     case EXPR_ARRAY_REF:
597         bogus = "array reference";
598
599     case EXPR_ACTION_DECL:
600         if (bogus == NULL)
601             bogus = "function use";
602         log_err(ctx,
603                 "Unexpected %s in mask expression; Expression Ignored\n",
604                 bogus);
605         return false;
606
607     case EXPR_ADD:
608     case EXPR_SUBTRACT:
609     case EXPR_MULTIPLY:
610     case EXPR_DIVIDE:
611         left = expr->value.binary.left;
612         right = expr->value.binary.right;
613         if (!ExprResolveMaskLookup(ctx, left, &l, lookup, lookupPriv) ||
614             !ExprResolveMaskLookup(ctx, right, &r, lookup, lookupPriv))
615             return false;
616
617         switch (expr->op) {
618         case EXPR_ADD:
619             *val_rtrn = l | r;
620             break;
621         case EXPR_SUBTRACT:
622             *val_rtrn = l & (~r);
623             break;
624         case EXPR_MULTIPLY:
625         case EXPR_DIVIDE:
626             log_err(ctx, "Cannot %s masks; Illegal operation ignored\n",
627                     (expr->op == EXPR_DIVIDE ? "divide" : "multiply"));
628             return false;
629         default:
630             break;
631         }
632
633         return true;
634
635     case EXPR_ASSIGN:
636         log_wsgo(ctx, "Assignment operator not implemented yet\n");
637         break;
638
639     case EXPR_INVERT:
640         left = expr->value.child;
641         if (!ExprResolveIntegerLookup(ctx, left, &v, lookup, lookupPriv))
642             return false;
643
644         *val_rtrn = ~v;
645         return true;
646
647     case EXPR_UNARY_PLUS:
648     case EXPR_NEGATE:
649     case EXPR_NOT:
650         left = expr->value.child;
651         if (!ExprResolveIntegerLookup(ctx, left, &v, lookup, lookupPriv))
652             log_err(ctx, "The %s operator cannot be used with a mask\n",
653                     (expr->op == EXPR_NEGATE ? "-" : "!"));
654         return false;
655
656     default:
657         log_wsgo(ctx, "Unknown operator %d in ResolveMask\n", expr->op);
658         break;
659     }
660
661     return false;
662 }
663
664 bool
665 ExprResolveMask(struct xkb_context *ctx, const ExprDef *expr,
666                 unsigned int *mask_rtrn, const LookupEntry *values)
667 {
668     return ExprResolveMaskLookup(ctx, expr, mask_rtrn, SimpleLookup, values);
669 }
670
671 bool
672 ExprResolveModMask(struct xkb_context *ctx, const ExprDef *expr,
673                    xkb_mod_mask_t *mask_rtrn)
674 {
675     return ExprResolveMaskLookup(ctx, expr, mask_rtrn, LookupModMask, NULL);
676 }
677
678 bool
679 ExprResolveVModMask(struct xkb_keymap *keymap, const ExprDef *expr,
680                     xkb_mod_mask_t *mask_rtrn)
681 {
682     return ExprResolveMaskLookup(keymap->ctx, expr, mask_rtrn, LookupVModMask,
683                                  keymap);
684 }
685
686 bool
687 ExprResolveKeySym(struct xkb_context *ctx, const ExprDef *expr,
688                   xkb_keysym_t *sym_rtrn)
689 {
690     int val;
691
692     if (expr->op == EXPR_IDENT) {
693         const char *str;
694         str = xkb_atom_text(ctx, expr->value.str);
695         *sym_rtrn = xkb_keysym_from_name(str);
696         if (*sym_rtrn != XKB_KEY_NoSymbol)
697             return true;
698     }
699
700     if (!ExprResolveInteger(ctx, expr, &val))
701         return false;
702
703     if (val < 0 || val >= 10)
704         return false;
705
706     *sym_rtrn = ((xkb_keysym_t) val) + '0';
707     return true;
708 }