expr: drop ExprResult from ResolveMask
[platform/upstream/libxkbcommon.git] / src / xkbcomp / action.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 "action.h"
28
29 static bool actionsInitialized;
30 static ExprDef constTrue;
31 static ExprDef constFalse;
32
33 /***====================================================================***/
34
35 static const LookupEntry actionStrings[] = {
36     { "noaction",          XkbSA_NoAction       },
37     { "setmods",           XkbSA_SetMods        },
38     { "latchmods",         XkbSA_LatchMods      },
39     { "lockmods",          XkbSA_LockMods       },
40     { "setgroup",          XkbSA_SetGroup       },
41     { "latchgroup",        XkbSA_LatchGroup     },
42     { "lockgroup",         XkbSA_LockGroup      },
43     { "moveptr",           XkbSA_MovePtr        },
44     { "movepointer",       XkbSA_MovePtr        },
45     { "ptrbtn",            XkbSA_PtrBtn         },
46     { "pointerbutton",     XkbSA_PtrBtn         },
47     { "lockptrbtn",        XkbSA_LockPtrBtn     },
48     { "lockpointerbutton", XkbSA_LockPtrBtn     },
49     { "lockptrbutton",     XkbSA_LockPtrBtn     },
50     { "lockpointerbtn",    XkbSA_LockPtrBtn     },
51     { "setptrdflt",        XkbSA_SetPtrDflt     },
52     { "setpointerdefault", XkbSA_SetPtrDflt     },
53     { "isolock",           XkbSA_ISOLock        },
54     { "terminate",         XkbSA_Terminate      },
55     { "terminateserver",   XkbSA_Terminate      },
56     { "switchscreen",      XkbSA_SwitchScreen   },
57     { "setcontrols",       XkbSA_SetControls    },
58     { "lockcontrols",      XkbSA_LockControls   },
59     { "actionmessage",     XkbSA_ActionMessage  },
60     { "messageaction",     XkbSA_ActionMessage  },
61     { "message",           XkbSA_ActionMessage  },
62     { "redirect",          XkbSA_RedirectKey    },
63     { "redirectkey",       XkbSA_RedirectKey    },
64     { "devbtn",            XkbSA_DeviceBtn      },
65     { "devicebtn",         XkbSA_DeviceBtn      },
66     { "devbutton",         XkbSA_DeviceBtn      },
67     { "devicebutton",      XkbSA_DeviceBtn      },
68     { "lockdevbtn",        XkbSA_DeviceBtn      },
69     { "lockdevicebtn",     XkbSA_LockDeviceBtn  },
70     { "lockdevbutton",     XkbSA_LockDeviceBtn  },
71     { "lockdevicebutton",  XkbSA_LockDeviceBtn  },
72     { "devval",            XkbSA_DeviceValuator },
73     { "deviceval",         XkbSA_DeviceValuator },
74     { "devvaluator",       XkbSA_DeviceValuator },
75     { "devicevaluator",    XkbSA_DeviceValuator },
76     { "private",           PrivateAction        },
77     { NULL,                0                    }
78 };
79
80 static const LookupEntry fieldStrings[] = {
81     { "clearLocks",       F_ClearLocks  },
82     { "latchToLock",      F_LatchToLock },
83     { "genKeyEvent",      F_GenKeyEvent },
84     { "generateKeyEvent", F_GenKeyEvent },
85     { "report",           F_Report      },
86     { "default",          F_Default     },
87     { "affect",           F_Affect      },
88     { "increment",        F_Increment   },
89     { "modifiers",        F_Modifiers   },
90     { "mods",             F_Modifiers   },
91     { "group",            F_Group       },
92     { "x",                F_X           },
93     { "y",                F_Y           },
94     { "accel",            F_Accel       },
95     { "accelerate",       F_Accel       },
96     { "repeat",           F_Accel       },
97     { "button",           F_Button      },
98     { "value",            F_Value       },
99     { "controls",         F_Controls    },
100     { "ctrls",            F_Controls    },
101     { "type",             F_Type        },
102     { "count",            F_Count       },
103     { "screen",           F_Screen      },
104     { "same",             F_Same        },
105     { "sameServer",       F_Same        },
106     { "data",             F_Data        },
107     { "device",           F_Device      },
108     { "dev",              F_Device      },
109     { "key",              F_Keycode     },
110     { "keycode",          F_Keycode     },
111     { "kc",               F_Keycode     },
112     { "clearmods",        F_ModsToClear },
113     { "clearmodifiers",   F_ModsToClear },
114     { NULL,               0             }
115 };
116
117 static bool
118 stringToValue(const LookupEntry tab[], const char *string,
119               unsigned *value_rtrn)
120 {
121     const LookupEntry *entry;
122
123     if (!string)
124         return false;
125
126     for (entry = tab; entry->name != NULL; entry++) {
127         if (istreq(entry->name, string)) {
128             *value_rtrn = entry->result;
129             return true;
130         }
131     }
132
133     return false;
134 }
135
136 static const char *
137 valueToString(const LookupEntry tab[], unsigned value)
138 {
139     const LookupEntry *entry;
140
141     for (entry = tab; entry->name != NULL; entry++)
142         if (entry->result == value)
143             return entry->name;
144
145     return "unknown";
146 }
147
148 static bool
149 stringToAction(const char *str, unsigned *type_rtrn)
150 {
151     return stringToValue(actionStrings, str, type_rtrn);
152 }
153
154 static bool
155 stringToField(const char *str, unsigned *field_rtrn)
156 {
157     return stringToValue(fieldStrings, str, field_rtrn);
158 }
159
160 static const char *
161 fieldText(unsigned field)
162 {
163     return valueToString(fieldStrings, field);
164 }
165
166 /***====================================================================***/
167
168 static inline bool
169 ReportMismatch(struct xkb_keymap *keymap, unsigned action, unsigned field,
170                const char *type)
171 {
172     log_err(keymap->ctx,
173             "Value of %s field must be of type %s; "
174             "Action %s definition ignored\n",
175             fieldText(field), type, ActionTypeText(action));
176     return false;
177 }
178
179 static inline bool
180 ReportIllegal(struct xkb_keymap *keymap, unsigned action, unsigned field)
181 {
182     log_err(keymap->ctx,
183             "Field %s is not defined for an action of type %s; "
184             "Action definition ignored\n",
185             fieldText(field), ActionTypeText(action));
186     return false;
187 }
188
189 static inline bool
190 ReportActionNotArray(struct xkb_keymap *keymap, unsigned action,
191                      unsigned field)
192 {
193     log_err(keymap->ctx,
194             "The %s field in the %s action is not an array; "
195             "Action definition ignored\n",
196             fieldText(field), ActionTypeText(action));
197     return false;
198 }
199
200 static inline bool
201 ReportNotFound(struct xkb_keymap *keymap, unsigned action, unsigned field,
202                const char *what, const char *bad)
203 {
204     log_err(keymap->ctx,
205             "%s named %s not found; "
206             "Ignoring the %s field of an %s action\n",
207             what, bad, fieldText(field), ActionTypeText(action));
208     return false;
209 }
210
211 static bool
212 HandleNoAction(struct xkb_keymap *keymap, struct xkb_any_action *action,
213                unsigned field, ExprDef *array_ndx, ExprDef *value)
214
215 {
216     return ReportIllegal(keymap, action->type, field);
217 }
218
219 static bool
220 CheckLatchLockFlags(struct xkb_keymap *keymap, unsigned action,
221                     unsigned field, ExprDef * value, unsigned *flags_inout)
222 {
223     unsigned tmp;
224     bool result;
225
226     if (field == F_ClearLocks)
227         tmp = XkbSA_ClearLocks;
228     else if (field == F_LatchToLock)
229         tmp = XkbSA_LatchToLock;
230     else
231         return false;           /* WSGO! */
232
233     if (!ExprResolveBoolean(keymap->ctx, value, &result))
234         return ReportMismatch(keymap, action, field, "boolean");
235
236     if (result)
237         *flags_inout |= tmp;
238     else
239         *flags_inout &= ~tmp;
240
241     return true;
242 }
243
244 static bool
245 CheckModifierField(struct xkb_keymap *keymap, unsigned action, ExprDef *value,
246                    unsigned *flags_inout, xkb_mod_mask_t *mods_rtrn)
247 {
248     if (value->op == EXPR_IDENT) {
249         const char *valStr;
250         valStr = xkb_atom_text(keymap->ctx, value->value.str);
251         if (valStr && (istreq(valStr, "usemodmapmods") ||
252                        istreq(valStr, "modmapmods"))) {
253
254             *mods_rtrn = 0;
255             *flags_inout |= XkbSA_UseModMapMods;
256             return true;
257         }
258     }
259
260     if (!ExprResolveVModMask(keymap, value, mods_rtrn))
261         return ReportMismatch(keymap, action, F_Modifiers, "modifier mask");
262
263     *flags_inout &= ~XkbSA_UseModMapMods;
264     return true;
265 }
266
267 static bool
268 HandleSetLatchMods(struct xkb_keymap *keymap, struct xkb_any_action *action,
269                    unsigned field, ExprDef *array_ndx, ExprDef *value)
270 {
271     struct xkb_mod_action *act;
272     unsigned rtrn;
273     unsigned t1;
274     xkb_mod_mask_t t2;
275
276     act = (struct xkb_mod_action *) action;
277     if (array_ndx != NULL) {
278         switch (field) {
279         case F_ClearLocks:
280         case F_LatchToLock:
281         case F_Modifiers:
282             return ReportActionNotArray(keymap, action->type, field);
283         }
284     }
285     switch (field) {
286     case F_ClearLocks:
287     case F_LatchToLock:
288         rtrn = act->flags;
289         if (CheckLatchLockFlags(keymap, action->type, field, value, &rtrn)) {
290             act->flags = rtrn;
291             return true;
292         }
293         return false;
294
295     case F_Modifiers:
296         t1 = act->flags;
297         if (CheckModifierField(keymap, action->type, value, &t1, &t2)) {
298             act->flags = t1;
299             act->real_mods = act->mask = (t2 & 0xff);
300             act->vmods = (t2 >> 8) & 0xffff;
301             return true;
302         }
303         return false;
304     }
305     return ReportIllegal(keymap, action->type, field);
306 }
307
308 static bool
309 HandleLockMods(struct xkb_keymap *keymap, struct xkb_any_action *action,
310                unsigned field, ExprDef *array_ndx, ExprDef *value)
311 {
312     struct xkb_mod_action *act;
313     unsigned t1;
314     xkb_mod_mask_t t2;
315
316     act = (struct xkb_mod_action *) action;
317     if ((array_ndx != NULL) && (field == F_Modifiers))
318         return ReportActionNotArray(keymap, action->type, field);
319     switch (field) {
320     case F_Modifiers:
321         t1 = act->flags;
322         if (CheckModifierField(keymap, action->type, value, &t1, &t2)) {
323             act->flags = t1;
324             act->real_mods = act->mask = (t2 & 0xff);
325             act->vmods = (t2 >> 8) & 0xffff;
326             return true;
327         }
328         return false;
329     }
330     return ReportIllegal(keymap, action->type, field);
331 }
332
333 static bool
334 CheckGroupField(struct xkb_keymap *keymap, unsigned action,
335                 ExprDef * value, unsigned *flags_inout,
336                 xkb_group_index_t *grp_rtrn)
337 {
338     ExprDef *spec;
339
340     if (value->op == EXPR_NEGATE || value->op == EXPR_UNARY_PLUS) {
341         *flags_inout &= ~XkbSA_GroupAbsolute;
342         spec = value->value.child;
343     }
344     else {
345         *flags_inout |= XkbSA_GroupAbsolute;
346         spec = value;
347     }
348
349     if (!ExprResolveGroup(keymap->ctx, spec, grp_rtrn))
350         return ReportMismatch(keymap, action, F_Group,
351                               "integer (range 1..8)");
352
353     if (value->op == EXPR_NEGATE)
354         *grp_rtrn = -*grp_rtrn;
355     else if (value->op != EXPR_UNARY_PLUS)
356         (*grp_rtrn)--;
357
358     return true;
359 }
360
361 static bool
362 HandleSetLatchGroup(struct xkb_keymap *keymap, struct xkb_any_action *action,
363                     unsigned field, ExprDef *array_ndx, ExprDef *value)
364 {
365     struct xkb_group_action *act;
366     unsigned rtrn;
367     unsigned t1;
368     xkb_group_index_t t2;
369
370     act = (struct xkb_group_action *) action;
371     if (array_ndx != NULL) {
372         switch (field) {
373         case F_ClearLocks:
374         case F_LatchToLock:
375         case F_Group:
376             return ReportActionNotArray(keymap, action->type, field);
377         }
378     }
379     switch (field) {
380     case F_ClearLocks:
381     case F_LatchToLock:
382         rtrn = act->flags;
383         if (CheckLatchLockFlags(keymap, action->type, field, value, &rtrn)) {
384             act->flags = rtrn;
385             return true;
386         }
387         return false;
388
389     case F_Group:
390         t1 = act->flags;
391         if (CheckGroupField(keymap, action->type, value, &t1, &t2)) {
392             act->flags = t1;
393             act->group = t2;
394             return true;
395         }
396         return false;
397     }
398     return ReportIllegal(keymap, action->type, field);
399 }
400
401 static bool
402 HandleLockGroup(struct xkb_keymap *keymap, struct xkb_any_action *action,
403                 unsigned field, ExprDef *array_ndx, ExprDef *value)
404 {
405     struct xkb_group_action *act;
406     unsigned t1;
407     xkb_group_index_t t2;
408
409     act = (struct xkb_group_action *) action;
410     if ((array_ndx != NULL) && (field == F_Group))
411         return ReportActionNotArray(keymap, action->type, field);
412     if (field == F_Group) {
413         t1 = act->flags;
414         if (CheckGroupField(keymap, action->type, value, &t1, &t2)) {
415             act->flags = t1;
416             act->group = t2;
417             return true;
418         }
419         return false;
420     }
421     return ReportIllegal(keymap, action->type, field);
422 }
423
424 static bool
425 HandleMovePtr(struct xkb_keymap *keymap, struct xkb_any_action *action,
426               unsigned field, ExprDef *array_ndx, ExprDef *value)
427 {
428     struct xkb_pointer_action *act;
429     bool absolute;
430
431     act = (struct xkb_pointer_action *) action;
432     if ((array_ndx != NULL) && ((field == F_X) || (field == F_Y)))
433         return ReportActionNotArray(keymap, action->type, field);
434
435     if (field == F_X || field == F_Y) {
436         int val;
437
438         if (value->op == EXPR_NEGATE || value->op == EXPR_UNARY_PLUS)
439             absolute = false;
440         else
441             absolute = true;
442
443         if (!ExprResolveInteger(keymap->ctx, value, &val))
444             return ReportMismatch(keymap, action->type, field, "integer");
445
446         if (field == F_X) {
447             if (absolute)
448                 act->flags |= XkbSA_MoveAbsoluteX;
449             act->x = val;
450         }
451         else {
452             if (absolute)
453                 act->flags |= XkbSA_MoveAbsoluteY;
454             act->y = val;
455         }
456
457         return true;
458     }
459     else if (field == F_Accel) {
460         bool set;
461
462         if (!ExprResolveBoolean(keymap->ctx, value, &set))
463             return ReportMismatch(keymap, action->type, field, "boolean");
464
465         if (set)
466             act->flags &= ~XkbSA_NoAcceleration;
467         else
468             act->flags |= XkbSA_NoAcceleration;
469     }
470
471     return ReportIllegal(keymap, action->type, field);
472 }
473
474 static const LookupEntry lockWhich[] = {
475     { "both", 0 },
476     { "lock", XkbSA_LockNoUnlock },
477     { "neither", (XkbSA_LockNoLock | XkbSA_LockNoUnlock) },
478     { "unlock", XkbSA_LockNoLock },
479     { NULL, 0 }
480 };
481
482 static bool
483 HandlePtrBtn(struct xkb_keymap *keymap, struct xkb_any_action *action,
484              unsigned field, ExprDef *array_ndx, ExprDef *value)
485 {
486     ExprResult rtrn;
487     struct xkb_pointer_button_action *act;
488
489     act = (struct xkb_pointer_button_action *) action;
490     if (field == F_Button) {
491         int btn;
492
493         if (array_ndx)
494             return ReportActionNotArray(keymap, action->type, field);
495
496         if (!ExprResolveButton(keymap->ctx, value, &btn))
497             return ReportMismatch(keymap, action->type, field,
498                                   "integer (range 1..5)");
499
500         if (btn < 0 || btn > 5) {
501             log_err(keymap->ctx,
502                     "Button must specify default or be in the range 1..5; "
503                     "Illegal button value %d ignored\n", btn);
504             return false;
505         }
506
507         act->button = btn;
508         return true;
509     }
510     else if ((action->type == XkbSA_LockPtrBtn) && (field == F_Affect)) {
511         if (array_ndx != NULL)
512             return ReportActionNotArray(keymap, action->type, field);
513         if (!ExprResolveEnum(keymap->ctx, value, &rtrn, lockWhich))
514             return ReportMismatch(keymap, action->type, field,
515                                   "lock or unlock");
516         act->flags &= ~(XkbSA_LockNoLock | XkbSA_LockNoUnlock);
517         act->flags |= rtrn.ival;
518         return true;
519     }
520     else if (field == F_Count) {
521         int btn;
522
523         if (array_ndx)
524             return ReportActionNotArray(keymap, action->type, field);
525
526         /* XXX: Should this actually be ResolveButton? */
527         if (!ExprResolveButton(keymap->ctx, value, &btn))
528             return ReportMismatch(keymap, action->type, field, "integer");
529
530         if (btn < 0 || btn > 255) {
531             log_err(keymap->ctx,
532                     "The count field must have a value in the range 0..255; "
533                     "Illegal count %d ignored\n", rtrn.ival);
534             return false;
535         }
536
537         act->count = btn;
538         return true;
539     }
540     return ReportIllegal(keymap, action->type, field);
541 }
542
543 static const LookupEntry ptrDflts[] = {
544     { "dfltbtn", XkbSA_AffectDfltBtn },
545     { "defaultbutton", XkbSA_AffectDfltBtn },
546     { "button", XkbSA_AffectDfltBtn },
547     { NULL, 0 }
548 };
549
550 static bool
551 HandleSetPtrDflt(struct xkb_keymap *keymap, struct xkb_any_action *action,
552                  unsigned field, ExprDef *array_ndx, ExprDef *value)
553 {
554     ExprResult rtrn;
555     struct xkb_pointer_default_action *act;
556
557     act = (struct xkb_pointer_default_action *) action;
558     if (field == F_Affect) {
559         if (array_ndx != NULL)
560             return ReportActionNotArray(keymap, action->type, field);
561         if (!ExprResolveEnum(keymap->ctx, value, &rtrn, ptrDflts))
562             return ReportMismatch(keymap, action->type, field,
563                                   "pointer component");
564         act->affect = rtrn.uval;
565         return true;
566     }
567     else if ((field == F_Button) || (field == F_Value)) {
568         ExprDef *button;
569         int btn;
570
571         if (array_ndx)
572             return ReportActionNotArray(keymap, action->type, field);
573
574         if (value->op == EXPR_NEGATE || value->op == EXPR_UNARY_PLUS) {
575             act->flags &= ~XkbSA_DfltBtnAbsolute;
576             button = value->value.child;
577         }
578         else {
579             act->flags |= XkbSA_DfltBtnAbsolute;
580             button = value;
581         }
582
583         if (!ExprResolveButton(keymap->ctx, button, &btn))
584             return ReportMismatch(keymap, action->type, field,
585                                   "integer (range 1..5)");
586
587         if (btn < 0 || btn > 5) {
588             log_err(keymap->ctx,
589                     "New default button value must be in the range 1..5; "
590                     "Illegal default button value %d ignored\n", rtrn.ival);
591             return false;
592         }
593         if (btn == 0) {
594             log_err(keymap->ctx,
595                     "Cannot set default pointer button to \"default\"; "
596                     "Illegal default button setting ignored\n");
597             return false;
598         }
599
600         act->value = (value->op == EXPR_NEGATE ? -btn: btn);
601         return true;
602     }
603
604     return ReportIllegal(keymap, action->type, field);
605 }
606
607 static const LookupEntry isoNames[] = {
608     { "mods", XkbSA_ISONoAffectMods },
609     { "modifiers", XkbSA_ISONoAffectMods },
610     { "group", XkbSA_ISONoAffectGroup },
611     { "groups", XkbSA_ISONoAffectGroup },
612     { "ptr", XkbSA_ISONoAffectPtr },
613     { "pointer", XkbSA_ISONoAffectPtr },
614     { "ctrls", XkbSA_ISONoAffectCtrls },
615     { "controls", XkbSA_ISONoAffectCtrls },
616     { "all", ~((unsigned) 0) },
617     { "none", 0 },
618     { NULL, 0 },
619 };
620
621 static bool
622 HandleISOLock(struct xkb_keymap *keymap, struct xkb_any_action *action,
623               unsigned field, ExprDef *array_ndx, ExprDef *value)
624 {
625     struct xkb_iso_action *act;
626
627     act = (struct xkb_iso_action *) action;
628     if (field == F_Modifiers) {
629         unsigned flags;
630         xkb_mod_mask_t mods;
631
632         if (array_ndx)
633             return ReportActionNotArray(keymap, action->type, field);
634
635         flags = act->flags;
636         if (!CheckModifierField(keymap, action->type, value, &flags, &mods))
637             return false;
638
639         act->flags = flags & (~XkbSA_ISODfltIsGroup);
640         act->real_mods = mods & 0xff;
641         act->vmods = (mods >> 8) & 0xff;
642         return true;
643     }
644     else if (field == F_Group) {
645         xkb_group_index_t group;
646         unsigned flags;
647
648         if (array_ndx)
649             return ReportActionNotArray(keymap, action->type, field);
650
651         flags = act->flags;
652         if (!CheckGroupField(keymap, action->type, value, &flags, &group))
653             return false;
654
655         act->flags = flags | XkbSA_ISODfltIsGroup;
656         act->group = group;
657         return true;
658     } else if (F_Affect) {
659         xkb_mod_mask_t mask;
660
661         if (array_ndx)
662             return ReportActionNotArray(keymap, action->type, field);
663
664         if (!ExprResolveMask(keymap->ctx, value, &mask, isoNames))
665             return ReportMismatch(keymap, action->type, field,
666                                   "keyboard component");
667
668         act->affect = (~mask) & XkbSA_ISOAffectMask;
669         return true;
670     }
671
672     return ReportIllegal(keymap, action->type, field);
673 }
674
675 static bool
676 HandleSwitchScreen(struct xkb_keymap *keymap, struct xkb_any_action *action,
677                    unsigned field, ExprDef *array_ndx, ExprDef *value)
678 {
679     ExprResult rtrn;
680     struct xkb_switch_screen_action *act;
681
682     act = (struct xkb_switch_screen_action *) action;
683     if (field == F_Screen) {
684         ExprDef *scrn;
685         int val;
686
687         if (array_ndx)
688             return ReportActionNotArray(keymap, action->type, field);
689
690         if (value->op == EXPR_NEGATE || value->op == EXPR_UNARY_PLUS) {
691             act->flags &= ~XkbSA_SwitchAbsolute;
692             scrn = value->value.child;
693         }
694         else {
695             act->flags |= XkbSA_SwitchAbsolute;
696             scrn = value;
697         }
698
699         if (!ExprResolveInteger(keymap->ctx, scrn, &val))
700             return ReportMismatch(keymap, action->type, field,
701                                   "integer (0..255)");
702
703         if (val < 0 || val > 255) {
704             log_err(keymap->ctx,
705                     "Screen index must be in the range 1..255; "
706                     "Illegal screen value %d ignored\n", rtrn.ival);
707             return false;
708         }
709
710         act->screen = (value->op == EXPR_NEGATE ? -val : val);
711         return true;
712     }
713     else if (field == F_Same) {
714         bool set;
715
716         if (array_ndx)
717             return ReportActionNotArray(keymap, action->type, field);
718
719         if (!ExprResolveBoolean(keymap->ctx, value, &set))
720             return ReportMismatch(keymap, action->type, field, "boolean");
721
722         if (set)
723             act->flags &= ~XkbSA_SwitchApplication;
724         else
725             act->flags |= XkbSA_SwitchApplication;
726
727         return true;
728     }
729
730     return ReportIllegal(keymap, action->type, field);
731 }
732
733 const LookupEntry ctrlNames[] = {
734     { "repeatkeys", XkbRepeatKeysMask },
735     { "repeat", XkbRepeatKeysMask },
736     { "autorepeat", XkbRepeatKeysMask },
737     { "slowkeys", XkbSlowKeysMask },
738     { "bouncekeys", XkbBounceKeysMask },
739     { "stickykeys", XkbStickyKeysMask },
740     { "mousekeys", XkbMouseKeysMask },
741     { "mousekeysaccel", XkbMouseKeysAccelMask },
742     { "accessxkeys", XkbAccessXKeysMask },
743     { "accessxtimeout", XkbAccessXTimeoutMask },
744     { "accessxfeedback", XkbAccessXFeedbackMask },
745     { "audiblebell", XkbAudibleBellMask },
746     { "ignoregrouplock", XkbIgnoreGroupLockMask },
747     { "all", XkbAllBooleanCtrlsMask },
748     { "overlay1", 0 },
749     { "overlay2", 0 },
750     { "none", 0 },
751     { NULL, 0 }
752 };
753
754 static bool
755 HandleSetLockControls(struct xkb_keymap *keymap,
756                       struct xkb_any_action *action,
757                       unsigned field, ExprDef *array_ndx,
758                       ExprDef *value)
759 {
760     struct xkb_controls_action *act;
761
762     act = (struct xkb_controls_action *) action;
763     if (field == F_Controls) {
764         unsigned int mask;
765
766         if (array_ndx)
767             return ReportActionNotArray(keymap, action->type, field);
768
769         if (!ExprResolveMask(keymap->ctx, value, &mask, ctrlNames))
770             return ReportMismatch(keymap, action->type, field,
771                                   "controls mask");
772
773         act->ctrls = mask;
774         return true;
775     }
776
777     return ReportIllegal(keymap, action->type, field);
778 }
779
780 static const LookupEntry evNames[] = {
781     { "press", XkbSA_MessageOnPress },
782     { "keypress", XkbSA_MessageOnPress },
783     { "release", XkbSA_MessageOnRelease },
784     { "keyrelease", XkbSA_MessageOnRelease },
785     { "all", XkbSA_MessageOnPress | XkbSA_MessageOnRelease },
786     { "none", 0 },
787     { NULL, 0 }
788 };
789
790 static bool
791 HandleActionMessage(struct xkb_keymap *keymap, struct xkb_any_action *action,
792                     unsigned field, ExprDef *array_ndx, ExprDef *value)
793 {
794     struct xkb_message_action *act;
795
796     act = (struct xkb_message_action *) action;
797     if (field == F_Report) {
798         unsigned int mask;
799
800         if (array_ndx)
801             return ReportActionNotArray(keymap, action->type, field);
802
803         if (!ExprResolveMask(keymap->ctx, value, &mask, evNames))
804             return ReportMismatch(keymap, action->type, field,
805                                   "key event mask");
806
807         /* FIXME: Something seems wrong here... */
808         act->flags &= ~(XkbSA_MessageOnPress | XkbSA_MessageOnRelease);
809         act->flags = mask & (XkbSA_MessageOnPress | XkbSA_MessageOnRelease);
810         return true;
811     }
812     else if (field == F_GenKeyEvent) {
813         bool set;
814
815         if (array_ndx)
816             return ReportActionNotArray(keymap, action->type, field);
817
818         if (!ExprResolveBoolean(keymap->ctx, value, &set))
819             return ReportMismatch(keymap, action->type, field, "boolean");
820
821         if (set)
822             act->flags |= XkbSA_MessageGenKeyEvent;
823         else
824             act->flags &= ~XkbSA_MessageGenKeyEvent;
825
826         return true;
827     }
828     else if (field == F_Data && !array_ndx) {
829         const char *str;
830         int len;
831
832         if (!ExprResolveString(keymap->ctx, value, &str))
833             return ReportMismatch(keymap, action->type, field, "string");
834
835         len = strlen(str);
836         if (len < 1 || len > 6) {
837             log_warn(keymap->ctx,
838                      "An action message can hold only 6 bytes; "
839                      "Extra %d bytes ignored\n", len - 6);
840         }
841
842         strncpy((char *) act->message, str, 6);
843         return true;
844     }
845     else if (field == F_Data && array_ndx) {
846         int ndx, datum;
847
848         if (!ExprResolveInteger(keymap->ctx, array_ndx, &ndx)) {
849             log_err(keymap->ctx,
850                     "Array subscript must be integer; "
851                     "Illegal subscript ignored\n");
852             return false;
853         }
854
855         if (ndx < 0 || ndx > 5) {
856             log_err(keymap->ctx,
857                     "An action message is at most 6 bytes long; "
858                     "Attempt to use data[%d] ignored\n", ndx);
859             return false;
860         }
861
862         if (!ExprResolveInteger(keymap->ctx, value, &datum))
863             return ReportMismatch(keymap, action->type, field, "integer");
864
865         if (datum < 0 || datum > 255) {
866             log_err(keymap->ctx,
867                     "Message data must be in the range 0..255; "
868                     "Illegal datum %d ignored\n", datum);
869             return false;
870         }
871
872         act->message[ndx] = (uint8_t) datum;
873         return true;
874     }
875
876     return ReportIllegal(keymap, action->type, field);
877 }
878
879 static bool
880 HandleRedirectKey(struct xkb_keymap *keymap, struct xkb_any_action *action,
881                   unsigned field, ExprDef *array_ndx, ExprDef *value)
882 {
883     struct xkb_key *key;
884     struct xkb_redirect_key_action *act;
885     unsigned t1;
886     xkb_mod_mask_t t2;
887     unsigned long tmp;
888     char key_name[XkbKeyNameLength];
889
890     if (array_ndx != NULL)
891         return ReportActionNotArray(keymap, action->type, field);
892
893     act = (struct xkb_redirect_key_action *) action;
894     switch (field) {
895     case F_Keycode:
896         if (!ExprResolveKeyName(keymap->ctx, value, key_name))
897             return ReportMismatch(keymap, action->type, field, "key name");
898
899         tmp = KeyNameToLong(key_name);
900         key = FindNamedKey(keymap, tmp, true, CreateKeyNames(keymap), 0);
901         if (!key)
902             return ReportNotFound(keymap, action->type, field, "Key",
903                                   KeyNameText(key_name));
904         act->new_kc = XkbKeyGetKeycode(keymap, key);
905         return true;
906
907     case F_ModsToClear:
908     case F_Modifiers:
909         t1 = 0;
910         if (CheckModifierField(keymap, action->type, value, &t1, &t2)) {
911             act->mods_mask |= (t2 & 0xff);
912             if (field == F_Modifiers)
913                 act->mods |= (t2 & 0xff);
914             else
915                 act->mods &= ~(t2 & 0xff);
916
917             t2 = (t2 >> 8) & 0xffff;
918             act->vmods_mask |= t2;
919             if (field == F_Modifiers)
920                 act->vmods |= t2;
921             else
922                 act->vmods &= ~t2;
923             return true;
924         }
925         return true;
926     }
927     return ReportIllegal(keymap, action->type, field);
928 }
929
930 static bool
931 HandleDeviceBtn(struct xkb_keymap *keymap, struct xkb_any_action *action,
932                 unsigned field, ExprDef *array_ndx, ExprDef *value)
933 {
934     ExprResult rtrn;
935     struct xkb_device_button_action *act;
936
937     act = (struct xkb_device_button_action *) action;
938     if (field == F_Button) {
939         int val;
940
941         if (array_ndx)
942             return ReportActionNotArray(keymap, action->type, field);
943
944         if (!ExprResolveInteger(keymap->ctx, value, &val))
945             return ReportMismatch(keymap, action->type, field,
946                                   "integer (range 1..255)");
947
948         if (val < 0 || val > 255) {
949             log_err(keymap->ctx,
950                     "Button must specify default or be in the range 1..255; "
951                     "Illegal button value %d ignored\n", val);
952             return false;
953         }
954
955         act->button = val;
956         return true;
957     }
958     else if ((action->type == XkbSA_LockDeviceBtn) && (field == F_Affect)) {
959         if (array_ndx != NULL)
960             return ReportActionNotArray(keymap, action->type, field);
961         if (!ExprResolveEnum(keymap->ctx, value, &rtrn, lockWhich))
962             return ReportMismatch(keymap, action->type, field,
963                                   "lock or unlock");
964         act->flags &= ~(XkbSA_LockNoLock | XkbSA_LockNoUnlock);
965         act->flags |= rtrn.ival;
966         return true;
967     }
968     else if (field == F_Count) {
969         int btn;
970
971         if (array_ndx)
972             return ReportActionNotArray(keymap, action->type, field);
973
974         /* XXX: Should this actually be ResolveButton? */
975         if (!ExprResolveButton(keymap->ctx, value, &btn))
976             return ReportMismatch(keymap, action->type, field, "integer");
977
978         if (btn < 0 || btn > 255) {
979             log_err(keymap->ctx,
980                     "The count field must have a value in the range 0..255; "
981                     "Illegal count %d ignored\n", rtrn.ival);
982             return false;
983         }
984
985         act->count = btn;
986         return true;
987     }
988     else if (field == F_Device) {
989         int val;
990
991         if (array_ndx)
992             return ReportActionNotArray(keymap, action->type, field);
993
994         if (!ExprResolveInteger(keymap->ctx, value, &val))
995             return ReportMismatch(keymap, action->type, field,
996                                   "integer (range 1..255)");
997
998         if (val < 0 || val > 255) {
999             log_err(keymap->ctx,
1000                     "Device must specify default or be in the range 1..255; "
1001                     "Illegal device value %d ignored\n", val);
1002             return false;
1003         }
1004
1005         act->device = val;
1006         return true;
1007     }
1008
1009     return ReportIllegal(keymap, action->type, field);
1010 }
1011
1012 static bool
1013 HandleDeviceValuator(struct xkb_keymap *keymap, struct xkb_any_action *action,
1014                      unsigned field, ExprDef *array_ndx, ExprDef *value)
1015 {
1016 #if 0
1017     ExprResult rtrn;
1018     struct xkb_device_valuator_action *act;
1019
1020     act = (struct xkb_device_valuator_action *) action;
1021     /*  XXX - Not yet implemented */
1022 #endif
1023     return false;
1024 }
1025
1026 static bool
1027 HandlePrivate(struct xkb_keymap *keymap, struct xkb_any_action *action,
1028               unsigned field, ExprDef *array_ndx, ExprDef *value)
1029 {
1030     if (field == F_Type) {
1031         int type;
1032
1033         if (!ExprResolveInteger(keymap->ctx, value, &type))
1034             return ReportMismatch(keymap, PrivateAction, field, "integer");
1035
1036         if (type < 0 || type > 255) {
1037             log_err(keymap->ctx,
1038                     "Private action type must be in the range 0..255; "
1039                     "Illegal type %d ignored\n", type);
1040             return false;
1041         }
1042
1043         action->type = (uint8_t) type;
1044         return true;
1045     }
1046     else if (field == F_Data) {
1047         if (array_ndx == NULL) {
1048             const char *str;
1049             int len;
1050
1051             if (!ExprResolveString(keymap->ctx, value, &str))
1052                 return ReportMismatch(keymap, action->type, field, "string");
1053
1054             len = strlen(str);
1055             if (len < 1 || len > 7) {
1056                 log_warn(keymap->ctx,
1057                          "A private action has 7 data bytes; "
1058                          "Extra %d bytes ignored\n", len - 6);
1059                 return false;
1060             }
1061
1062             strncpy((char *) action->data, str, sizeof(action->data));
1063             return true;
1064         }
1065         else {
1066             int ndx, datum;
1067
1068             if (!ExprResolveInteger(keymap->ctx, array_ndx, &ndx)) {
1069                 log_err(keymap->ctx,
1070                         "Array subscript must be integer; "
1071                         "Illegal subscript ignored\n");
1072                 return false;
1073             }
1074
1075             if (ndx < 0 || ndx >= sizeof(action->data)) {
1076                 log_err(keymap->ctx,
1077                         "The data for a private action is %zu bytes long; "
1078                         "Attempt to use data[%d] ignored\n",
1079                         sizeof(action->data), ndx);
1080                 return false;
1081             }
1082
1083             if (!ExprResolveInteger(keymap->ctx, value, &datum))
1084                 return ReportMismatch(keymap, action->type, field, "integer");
1085
1086             if (datum < 0 || datum > 255) {
1087                 log_err(keymap->ctx,
1088                         "All data for a private action must be 0..255; "
1089                         "Illegal datum %d ignored\n", datum);
1090                 return false;
1091             }
1092
1093             action->data[ndx] = (uint8_t) datum;
1094             return true;
1095         }
1096     }
1097
1098     return ReportIllegal(keymap, PrivateAction, field);
1099 }
1100
1101 typedef bool (*actionHandler)(struct xkb_keymap *keymap,
1102                               struct xkb_any_action *action, unsigned field,
1103                               ExprDef *array_ndx, ExprDef *value);
1104
1105 static const actionHandler handleAction[XkbSA_NumActions + 1] = {
1106     [XkbSA_NoAction] = HandleNoAction,
1107     [XkbSA_SetMods] = HandleSetLatchMods,
1108     [XkbSA_LatchMods] = HandleSetLatchMods,
1109     [XkbSA_LockMods] = HandleLockMods,
1110     [XkbSA_SetGroup] = HandleSetLatchGroup,
1111     [XkbSA_LatchGroup] = HandleSetLatchGroup,
1112     [XkbSA_LockGroup] = HandleLockGroup,
1113     [XkbSA_MovePtr] = HandleMovePtr,
1114     [XkbSA_PtrBtn] = HandlePtrBtn,
1115     [XkbSA_LockPtrBtn] = HandlePtrBtn,
1116     [XkbSA_SetPtrDflt] = HandleSetPtrDflt,
1117     [XkbSA_ISOLock] = HandleISOLock,
1118     [XkbSA_Terminate] = HandleNoAction,
1119     [XkbSA_SwitchScreen] = HandleSwitchScreen,
1120     [XkbSA_SetControls] = HandleSetLockControls,
1121     [XkbSA_LockControls] = HandleSetLockControls,
1122     [XkbSA_ActionMessage] = HandleActionMessage,
1123     [XkbSA_RedirectKey] = HandleRedirectKey,
1124     [XkbSA_DeviceBtn] = HandleDeviceBtn,
1125     [XkbSA_LockDeviceBtn] = HandleDeviceBtn,
1126     [XkbSA_DeviceValuator] = HandleDeviceValuator,
1127     [PrivateAction] = HandlePrivate,
1128 };
1129
1130 /***====================================================================***/
1131
1132 static void
1133 ApplyActionFactoryDefaults(union xkb_action * action)
1134 {
1135     if (action->type == XkbSA_SetPtrDflt) { /* increment default button */
1136         action->dflt.affect = XkbSA_AffectDfltBtn;
1137         action->dflt.flags = 0;
1138         action->dflt.value = 1;
1139     }
1140     else if (action->type == XkbSA_ISOLock) {
1141         action->iso.real_mods = LockMask;
1142     }
1143 }
1144
1145 static void
1146 ActionsInit(struct xkb_context *ctx);
1147
1148 int
1149 HandleActionDef(ExprDef * def,
1150                 struct xkb_keymap *keymap,
1151                 struct xkb_any_action *action, ActionInfo *info)
1152 {
1153     ExprDef *arg;
1154     const char *str;
1155     unsigned tmp, hndlrType;
1156
1157     if (!actionsInitialized)
1158         ActionsInit(keymap->ctx);
1159
1160     if (def->op != EXPR_ACTION_DECL) {
1161         log_err(keymap->ctx, "Expected an action definition, found %s\n",
1162                 exprOpText(def->op));
1163         return false;
1164     }
1165     str = xkb_atom_text(keymap->ctx, def->value.action.name);
1166     if (!str) {
1167         log_wsgo(keymap->ctx, "Missing name in action definition!!\n");
1168         return false;
1169     }
1170     if (!stringToAction(str, &tmp)) {
1171         log_err(keymap->ctx, "Unknown action %s\n", str);
1172         return false;
1173     }
1174     action->type = hndlrType = tmp;
1175     if (action->type != XkbSA_NoAction) {
1176         ApplyActionFactoryDefaults((union xkb_action *) action);
1177         while (info)
1178         {
1179             if ((info->action == XkbSA_NoAction)
1180                 || (info->action == hndlrType)) {
1181                 if (!(*handleAction[hndlrType])(keymap, action,
1182                                                 info->field,
1183                                                 info->array_ndx,
1184                                                 info->value)) {
1185                     return false;
1186                 }
1187             }
1188             info = info->next;
1189         }
1190     }
1191     for (arg = def->value.action.args; arg != NULL;
1192          arg = (ExprDef *) arg->common.next) {
1193         ExprDef *field, *value, *arrayRtrn;
1194         const char *elemRtrn, *fieldRtrn;
1195         unsigned fieldNdx;
1196
1197         if (arg->op == EXPR_ASSIGN) {
1198             field = arg->value.binary.left;
1199             value = arg->value.binary.right;
1200         }
1201         else {
1202             if (arg->op == EXPR_NOT || arg->op == EXPR_INVERT) {
1203                 field = arg->value.child;
1204                 constFalse.value.str = xkb_atom_intern(keymap->ctx, "false");
1205                 value = &constFalse;
1206             }
1207             else {
1208                 field = arg;
1209                 constTrue.value.str = xkb_atom_intern(keymap->ctx, "true");
1210                 value = &constTrue;
1211             }
1212         }
1213         if (!ExprResolveLhs(keymap->ctx, field, &elemRtrn, &fieldRtrn,
1214                             &arrayRtrn))
1215             return false;       /* internal error -- already reported */
1216
1217         if (elemRtrn != NULL) {
1218             log_err(keymap->ctx,
1219                     "Cannot change defaults in an action definition; "
1220                     "Ignoring attempt to change %s.%s\n",
1221                     elemRtrn, fieldRtrn);
1222             return false;
1223         }
1224         if (!stringToField(fieldRtrn, &fieldNdx)) {
1225             log_err(keymap->ctx, "Unknown field name %s\n", fieldRtrn);
1226             return false;
1227         }
1228         if (!handleAction[hndlrType](keymap, action, fieldNdx, arrayRtrn,
1229                                      value))
1230             return false;
1231     }
1232     return true;
1233 }
1234
1235 /***====================================================================***/
1236
1237 int
1238 SetActionField(struct xkb_keymap *keymap, const char *elem, const char *field,
1239                ExprDef *array_ndx, ExprDef *value, ActionInfo **info_rtrn)
1240 {
1241     ActionInfo *new, *old;
1242
1243     if (!actionsInitialized)
1244         ActionsInit(keymap->ctx);
1245
1246     new = malloc(sizeof(*new));
1247     if (!new) {
1248         log_wsgo(keymap->ctx, "Couldn't allocate space for action default\n");
1249         return false;
1250     }
1251
1252     if (istreq(elem, "action"))
1253         new->action = XkbSA_NoAction;
1254     else {
1255         if (!stringToAction(elem, &new->action)) {
1256             free(new);
1257             return false;
1258         }
1259         if (new->action == XkbSA_NoAction) {
1260             log_err(keymap->ctx,
1261                     "\"%s\" is not a valid field in a NoAction action\n",
1262                     field);
1263             free(new);
1264             return false;
1265         }
1266     }
1267     if (!stringToField(field, &new->field)) {
1268         log_err(keymap->ctx, "\"%s\" is not a legal field name\n", field);
1269         free(new);
1270         return false;
1271     }
1272     new->array_ndx = array_ndx;
1273     new->value = value;
1274     new->next = NULL;
1275     old = *info_rtrn;
1276     while ((old) && (old->next))
1277         old = old->next;
1278     if (old == NULL)
1279         *info_rtrn = new;
1280     else
1281         old->next = new;
1282     return true;
1283 }
1284
1285 /***====================================================================***/
1286
1287 static void
1288 ActionsInit(struct xkb_context *ctx)
1289 {
1290     if (!actionsInitialized) {
1291         memset(&constTrue, 0, sizeof(constTrue));
1292         memset(&constFalse, 0, sizeof(constFalse));
1293         constTrue.common.type = STMT_EXPR;
1294         constTrue.common.next = NULL;
1295         constTrue.op = EXPR_IDENT;
1296         constTrue.value_type = EXPR_TYPE_BOOLEAN;
1297         constTrue.value.str = xkb_atom_intern(ctx, "true");
1298         constFalse.common.type = STMT_EXPR;
1299         constFalse.common.next = NULL;
1300         constFalse.op = EXPR_IDENT;
1301         constFalse.value_type = EXPR_TYPE_BOOLEAN;
1302         constFalse.value.str = xkb_atom_intern(ctx, "false");
1303         actionsInitialized = 1;
1304     }
1305 }
1306
1307 union xkb_action *
1308 ResizeKeyActions(struct xkb_keymap *keymap, struct xkb_key *key,
1309                  uint32_t needed)
1310 {
1311     size_t old_ndx, old_num_acts, new_ndx;
1312
1313     if (needed == 0) {
1314         key->acts_index = 0;
1315         return NULL;
1316     }
1317
1318     if (XkbKeyHasActions(key) && key->width >= needed)
1319         return XkbKeyActionsPtr(keymap, key);
1320
1321     /*
1322      * The key may already be in the array, but without enough space.
1323      * This should not happen often, so in order to avoid moving and
1324      * copying stuff from acts and key_acts, we just allocate new
1325      * space for the key at the end, and leave the old space alone.
1326      */
1327
1328     old_ndx = key->acts_index;
1329     old_num_acts = XkbKeyNumActions(key);
1330     new_ndx = darray_size(keymap->acts);
1331
1332     darray_resize0(keymap->acts, new_ndx + needed);
1333     key->acts_index = new_ndx;
1334
1335     /*
1336      * The key was already in the array, copy the old actions to the
1337      * new space.
1338      */
1339     if (old_ndx != 0)
1340         memcpy(darray_mem(keymap->acts, new_ndx),
1341                darray_mem(keymap->acts, old_ndx),
1342                old_num_acts * sizeof(union xkb_action));
1343
1344     return XkbKeyActionsPtr(keymap, key);
1345 }