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 /*
  28  * Copyright © 2012 Intel Corporation
  29  * Copyright © 2012 Ran Benita <ran234@gmail.com>
  30  *
  31  * Permission is hereby granted, free of charge, to any person obtaining a
  32  * copy of this software and associated documentation files (the "Software"),
  33  * to deal in the Software without restriction, including without limitation
  34  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  35  * and/or sell copies of the Software, and to permit persons to whom the
  36  * Software is furnished to do so, subject to the following conditions:
  37  *
  38  * The above copyright notice and this permission notice (including the next
  39  * paragraph) shall be included in all copies or substantial portions of the
  40  * Software.
  41  *
  42  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  43  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  44  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  45  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  46  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  47  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  48  * DEALINGS IN THE SOFTWARE.
  49  *
  50  * Author: Daniel Stone <daniel@fooishbar.org>
  51  *         Ran Benita <ran234@gmail.com>
  52  */
  53
  54 #include "xkbcomp-priv.h"
  55 #include "text.h"
  56 #include "expr.h"
  57 #include "action.h"
  58
  59 static const ExprBoolean constTrue = {
  60     .expr = {
  61         .common = { .type = STMT_EXPR, .next = NULL },
  62         .op = EXPR_VALUE,
  63         .value_type = EXPR_TYPE_BOOLEAN,
  64     },
  65     .set = true,
  66 };
  67
  68 static const ExprBoolean constFalse = {
  69     .expr = {
  70         .common = { .type = STMT_EXPR, .next = NULL },
  71         .op = EXPR_VALUE,
  72         .value_type = EXPR_TYPE_BOOLEAN,
  73     },
  74     .set = false,
  75 };
  76
  77 enum action_field {
  78     ACTION_FIELD_CLEAR_LOCKS,
  79     ACTION_FIELD_LATCH_TO_LOCK,
  80     ACTION_FIELD_GEN_KEY_EVENT,
  81     ACTION_FIELD_REPORT,
  82     ACTION_FIELD_DEFAULT,
  83     ACTION_FIELD_AFFECT,
  84     ACTION_FIELD_INCREMENT,
  85     ACTION_FIELD_MODIFIERS,
  86     ACTION_FIELD_GROUP,
  87     ACTION_FIELD_X,
  88     ACTION_FIELD_Y,
  89     ACTION_FIELD_ACCEL,
  90     ACTION_FIELD_BUTTON,
  91     ACTION_FIELD_VALUE,
  92     ACTION_FIELD_CONTROLS,
  93     ACTION_FIELD_TYPE,
  94     ACTION_FIELD_COUNT,
  95     ACTION_FIELD_SCREEN,
  96     ACTION_FIELD_SAME,
  97     ACTION_FIELD_DATA,
  98     ACTION_FIELD_DEVICE,
  99     ACTION_FIELD_KEYCODE,
 100     ACTION_FIELD_MODS_TO_CLEAR,
 101 };
 102
 103 ActionsInfo *
 104 NewActionsInfo(void)
 105 {
 106     unsigned type;
 107     ActionsInfo *info;
 108
 109     info = calloc(1, sizeof(*info));
 110     if (!info)
 111         return NULL;
 112
 113     for (type = 0; type < _ACTION_TYPE_NUM_ENTRIES; type++)
 114         info->actions[type].type = type;
 115
 116     /* Apply some "factory defaults". */
 117
 118     /* Increment default button. */
 119     info->actions[ACTION_TYPE_PTR_DEFAULT].dflt.flags = 0;
 120     info->actions[ACTION_TYPE_PTR_DEFAULT].dflt.value = 1;
 121
 122     return info;
 123 }
 124
 125 void
 126 FreeActionsInfo(ActionsInfo *info)
 127 {
 128     free(info);
 129 }
 130
 131 static const LookupEntry fieldStrings[] = {
 132     { "clearLocks",       ACTION_FIELD_CLEAR_LOCKS   },
 133     { "latchToLock",      ACTION_FIELD_LATCH_TO_LOCK },
 134     { "genKeyEvent",      ACTION_FIELD_GEN_KEY_EVENT },
 135     { "generateKeyEvent", ACTION_FIELD_GEN_KEY_EVENT },
 136     { "report",           ACTION_FIELD_REPORT        },
 137     { "default",          ACTION_FIELD_DEFAULT       },
 138     { "affect",           ACTION_FIELD_AFFECT        },
 139     { "increment",        ACTION_FIELD_INCREMENT     },
 140     { "modifiers",        ACTION_FIELD_MODIFIERS     },
 141     { "mods",             ACTION_FIELD_MODIFIERS     },
 142     { "group",            ACTION_FIELD_GROUP         },
 143     { "x",                ACTION_FIELD_X             },
 144     { "y",                ACTION_FIELD_Y             },
 145     { "accel",            ACTION_FIELD_ACCEL         },
 146     { "accelerate",       ACTION_FIELD_ACCEL         },
 147     { "repeat",           ACTION_FIELD_ACCEL         },
 148     { "button",           ACTION_FIELD_BUTTON        },
 149     { "value",            ACTION_FIELD_VALUE         },
 150     { "controls",         ACTION_FIELD_CONTROLS      },
 151     { "ctrls",            ACTION_FIELD_CONTROLS      },
 152     { "type",             ACTION_FIELD_TYPE          },
 153     { "count",            ACTION_FIELD_COUNT         },
 154     { "screen",           ACTION_FIELD_SCREEN        },
 155     { "same",             ACTION_FIELD_SAME          },
 156     { "sameServer",       ACTION_FIELD_SAME          },
 157     { "data",             ACTION_FIELD_DATA          },
 158     { "device",           ACTION_FIELD_DEVICE        },
 159     { "dev",              ACTION_FIELD_DEVICE        },
 160     { "key",              ACTION_FIELD_KEYCODE       },
 161     { "keycode",          ACTION_FIELD_KEYCODE       },
 162     { "kc",               ACTION_FIELD_KEYCODE       },
 163     { "clearmods",        ACTION_FIELD_MODS_TO_CLEAR },
 164     { "clearmodifiers",   ACTION_FIELD_MODS_TO_CLEAR },
 165     { NULL,               0                          }
 166 };
 167
 168 static bool
 169 stringToAction(const char *str, unsigned *type_rtrn)
 170 {
 171     return LookupString(actionTypeNames, str, type_rtrn);
 172 }
 173
 174 static bool
 175 stringToField(const char *str, enum action_field *field_rtrn)
 176 {
 177     return LookupString(fieldStrings, str, field_rtrn);
 178 }
 179
 180 static const char *
 181 fieldText(enum action_field field)
 182 {
 183     return LookupValue(fieldStrings, field);
 184 }
 185
 186 /***====================================================================***/
 187
 188 static inline bool
 189 ReportMismatch(struct xkb_keymap *keymap, enum xkb_action_type action,
 190                enum action_field field, const char *type)
 191 {
 192     log_err(keymap->ctx,
 193             "Value of %s field must be of type %s; "
 194             "Action %s definition ignored\n",
 195             fieldText(field), type, ActionTypeText(action));
 196     return false;
 197 }
 198
 199 static inline bool
 200 ReportIllegal(struct xkb_keymap *keymap, enum xkb_action_type action,
 201               enum action_field field)
 202 {
 203     log_err(keymap->ctx,
 204             "Field %s is not defined for an action of type %s; "
 205             "Action definition ignored\n",
 206             fieldText(field), ActionTypeText(action));
 207     return false;
 208 }
 209
 210 static inline bool
 211 ReportActionNotArray(struct xkb_keymap *keymap, enum xkb_action_type action,
 212                      enum action_field field)
 213 {
 214     log_err(keymap->ctx,
 215             "The %s field in the %s action is not an array; "
 216             "Action definition ignored\n",
 217             fieldText(field), ActionTypeText(action));
 218     return false;
 219 }
 220
 221 static bool
 222 HandleNoAction(struct xkb_keymap *keymap, union xkb_action *action,
 223                enum action_field field, const ExprDef *array_ndx,
 224                const ExprDef *value)
 225
 226 {
 227     return true;
 228 }
 229
 230 static bool
 231 CheckLatchLockFlags(struct xkb_keymap *keymap, enum xkb_action_type action,
 232                     enum action_field field, const ExprDef *value,
 233                     enum xkb_action_flags *flags_inout)
 234 {
 235     enum xkb_action_flags tmp;
 236     bool result;
 237
 238     if (field == ACTION_FIELD_CLEAR_LOCKS)
 239         tmp = ACTION_LOCK_CLEAR;
 240     else if (field == ACTION_FIELD_LATCH_TO_LOCK)
 241         tmp = ACTION_LATCH_TO_LOCK;
 242     else
 243         return false;           /* WSGO! */
 244
 245     if (!ExprResolveBoolean(keymap->ctx, value, &result))
 246         return ReportMismatch(keymap, action, field, "boolean");
 247
 248     if (result)
 249         *flags_inout |= tmp;
 250     else
 251         *flags_inout &= ~tmp;
 252
 253     return true;
 254 }
 255
 256 static bool
 257 CheckModifierField(struct xkb_keymap *keymap, enum xkb_action_type action,
 258                    const ExprDef *value, enum xkb_action_flags *flags_inout,
 259                    xkb_mod_mask_t *mods_rtrn)
 260 {
 261     if (value->expr.op == EXPR_IDENT) {
 262         const char *valStr;
 263         valStr = xkb_atom_text(keymap->ctx, value->ident.ident);
 264         if (valStr && (istreq(valStr, "usemodmapmods") ||
 265                        istreq(valStr, "modmapmods"))) {
 266
 267             *mods_rtrn = 0;
 268             *flags_inout |= ACTION_MODS_LOOKUP_MODMAP;
 269             return true;
 270         }
 271     }
 272
 273     if (!ExprResolveModMask(keymap, value, MOD_BOTH, mods_rtrn))
 274         return ReportMismatch(keymap, action,
 275                               ACTION_FIELD_MODIFIERS, "modifier mask");
 276
 277     *flags_inout &= ~ACTION_MODS_LOOKUP_MODMAP;
 278     return true;
 279 }
 280
 281 static bool
 282 HandleSetLatchMods(struct xkb_keymap *keymap, union xkb_action *action,
 283                    enum action_field field, const ExprDef *array_ndx,
 284                    const ExprDef *value)
 285 {
 286     struct xkb_mod_action *act = &action->mods;
 287     enum xkb_action_flags rtrn, t1;
 288     xkb_mod_mask_t t2;
 289
 290     if (array_ndx != NULL) {
 291         switch (field) {
 292         case ACTION_FIELD_CLEAR_LOCKS:
 293         case ACTION_FIELD_LATCH_TO_LOCK:
 294         case ACTION_FIELD_MODIFIERS:
 295             return ReportActionNotArray(keymap, action->type, field);
 296         default:
 297             break;
 298         }
 299     }
 300
 301     switch (field) {
 302     case ACTION_FIELD_CLEAR_LOCKS:
 303     case ACTION_FIELD_LATCH_TO_LOCK:
 304         rtrn = act->flags;
 305         if (CheckLatchLockFlags(keymap, action->type, field, value, &rtrn)) {
 306             act->flags = rtrn;
 307             return true;
 308         }
 309         return false;
 310
 311     case ACTION_FIELD_MODIFIERS:
 312         t1 = act->flags;
 313         if (CheckModifierField(keymap, action->type, value, &t1, &t2)) {
 314             act->flags = t1;
 315             act->mods.mods = t2;
 316             return true;
 317         }
 318         return false;
 319
 320     default:
 321         break;
 322     }
 323
 324     return ReportIllegal(keymap, action->type, field);
 325 }
 326
 327 static bool
 328 HandleLockMods(struct xkb_keymap *keymap, union xkb_action *action,
 329                enum action_field field, const ExprDef *array_ndx,
 330                const ExprDef *value)
 331 {
 332     struct xkb_mod_action *act = &action->mods;
 333     enum xkb_action_flags t1;
 334     xkb_mod_mask_t t2;
 335
 336     if (array_ndx && field == ACTION_FIELD_MODIFIERS)
 337         return ReportActionNotArray(keymap, action->type, field);
 338
 339     switch (field) {
 340     case ACTION_FIELD_MODIFIERS:
 341         t1 = act->flags;
 342         if (CheckModifierField(keymap, action->type, value, &t1, &t2)) {
 343             act->flags = t1;
 344             act->mods.mods = t2;
 345             return true;
 346         }
 347         return false;
 348
 349     default:
 350         break;
 351     }
 352
 353     return ReportIllegal(keymap, action->type, field);
 354 }
 355
 356 static bool
 357 CheckGroupField(struct xkb_keymap *keymap, unsigned action,
 358                 const ExprDef *value, enum xkb_action_flags *flags_inout,
 359                 xkb_layout_index_t *grp_rtrn)
 360 {
 361     const ExprDef *spec;
 362
 363     if (value->expr.op == EXPR_NEGATE || value->expr.op == EXPR_UNARY_PLUS) {
 364         *flags_inout &= ~ACTION_ABSOLUTE_SWITCH;
 365         spec = value->unary.child;
 366     }
 367     else {
 368         *flags_inout |= ACTION_ABSOLUTE_SWITCH;
 369         spec = value;
 370     }
 371
 372     if (!ExprResolveGroup(keymap->ctx, spec, grp_rtrn))
 373         return ReportMismatch(keymap, action, ACTION_FIELD_GROUP,
 374                               "integer (range 1..8)");
 375
 376     if (value->expr.op == EXPR_NEGATE)
 377         *grp_rtrn = -*grp_rtrn;
 378     else if (value->expr.op != EXPR_UNARY_PLUS)
 379         (*grp_rtrn)--;
 380
 381     return true;
 382 }
 383
 384 static bool
 385 HandleSetLatchGroup(struct xkb_keymap *keymap, union xkb_action *action,
 386                     enum action_field field, const ExprDef *array_ndx,
 387                     const ExprDef *value)
 388 {
 389     struct xkb_group_action *act = &action->group;
 390     enum xkb_action_flags rtrn, t1;
 391     xkb_layout_index_t t2;
 392
 393     if (array_ndx != NULL) {
 394         switch (field) {
 395         case ACTION_FIELD_CLEAR_LOCKS:
 396         case ACTION_FIELD_LATCH_TO_LOCK:
 397         case ACTION_FIELD_GROUP:
 398             return ReportActionNotArray(keymap, action->type, field);
 399
 400         default:
 401             break;
 402         }
 403     }
 404
 405     switch (field) {
 406     case ACTION_FIELD_CLEAR_LOCKS:
 407     case ACTION_FIELD_LATCH_TO_LOCK:
 408         rtrn = act->flags;
 409         if (CheckLatchLockFlags(keymap, action->type, field, value, &rtrn)) {
 410             act->flags = rtrn;
 411             return true;
 412         }
 413         return false;
 414
 415     case ACTION_FIELD_GROUP:
 416         t1 = act->flags;
 417         if (CheckGroupField(keymap, action->type, value, &t1, &t2)) {
 418             act->flags = t1;
 419             act->group = t2;
 420             return true;
 421         }
 422         return false;
 423
 424     default:
 425         break;
 426     }
 427
 428     return ReportIllegal(keymap, action->type, field);
 429 }
 430
 431 static bool
 432 HandleLockGroup(struct xkb_keymap *keymap, union xkb_action *action,
 433                 enum action_field field, const ExprDef *array_ndx,
 434                 const ExprDef *value)
 435 {
 436     struct xkb_group_action *act = &action->group;
 437     enum xkb_action_flags t1;
 438     xkb_layout_index_t t2;
 439
 440     if ((array_ndx != NULL) && (field == ACTION_FIELD_GROUP))
 441         return ReportActionNotArray(keymap, action->type, field);
 442     if (field == ACTION_FIELD_GROUP) {
 443         t1 = act->flags;
 444         if (CheckGroupField(keymap, action->type, value, &t1, &t2)) {
 445             act->flags = t1;
 446             act->group = t2;
 447             return true;
 448         }
 449         return false;
 450     }
 451     return ReportIllegal(keymap, action->type, field);
 452 }
 453
 454 static bool
 455 HandleMovePtr(struct xkb_keymap *keymap, union xkb_action *action,
 456               enum action_field field, const ExprDef *array_ndx,
 457               const ExprDef *value)
 458 {
 459     struct xkb_pointer_action *act = &action->ptr;
 460
 461     if (array_ndx && (field == ACTION_FIELD_X || field == ACTION_FIELD_Y))
 462         return ReportActionNotArray(keymap, action->type, field);
 463
 464     if (field == ACTION_FIELD_X || field == ACTION_FIELD_Y) {
 465         int val;
 466         const bool absolute = (value->expr.op != EXPR_NEGATE &&
 467                                value->expr.op != EXPR_UNARY_PLUS);
 468
 469         if (!ExprResolveInteger(keymap->ctx, value, &val))
 470             return ReportMismatch(keymap, action->type, field, "integer");
 471
 472         if (field == ACTION_FIELD_X) {
 473             if (absolute)
 474                 act->flags |= ACTION_ABSOLUTE_X;
 475             act->x = val;
 476         }
 477         else {
 478             if (absolute)
 479                 act->flags |= ACTION_ABSOLUTE_Y;
 480             act->y = val;
 481         }
 482
 483         return true;
 484     }
 485     else if (field == ACTION_FIELD_ACCEL) {
 486         bool set;
 487
 488         if (!ExprResolveBoolean(keymap->ctx, value, &set))
 489             return ReportMismatch(keymap, action->type, field, "boolean");
 490
 491         if (set)
 492             act->flags &= ~ACTION_NO_ACCEL;
 493         else
 494             act->flags |= ACTION_NO_ACCEL;
 495     }
 496
 497     return ReportIllegal(keymap, action->type, field);
 498 }
 499
 500 static const LookupEntry lockWhich[] = {
 501     { "both", 0 },
 502     { "lock", ACTION_LOCK_NO_UNLOCK },
 503     { "neither", (ACTION_LOCK_NO_LOCK | ACTION_LOCK_NO_UNLOCK) },
 504     { "unlock", ACTION_LOCK_NO_LOCK },
 505     { NULL, 0 }
 506 };
 507
 508 static bool
 509 HandlePtrBtn(struct xkb_keymap *keymap, union xkb_action *action,
 510              enum action_field field, const ExprDef *array_ndx,
 511              const ExprDef *value)
 512 {
 513     struct xkb_pointer_button_action *act = &action->btn;
 514
 515     if (field == ACTION_FIELD_BUTTON) {
 516         int btn;
 517
 518         if (array_ndx)
 519             return ReportActionNotArray(keymap, action->type, field);
 520
 521         if (!ExprResolveButton(keymap->ctx, value, &btn))
 522             return ReportMismatch(keymap, action->type, field,
 523                                   "integer (range 1..5)");
 524
 525         if (btn < 0 || btn > 5) {
 526             log_err(keymap->ctx,
 527                     "Button must specify default or be in the range 1..5; "
 528                     "Illegal button value %d ignored\n", btn);
 529             return false;
 530         }
 531
 532         act->button = btn;
 533         return true;
 534     }
 535     else if (action->type == ACTION_TYPE_PTR_LOCK &&
 536              field == ACTION_FIELD_AFFECT) {
 537         enum xkb_action_flags val;
 538
 539         if (array_ndx)
 540             return ReportActionNotArray(keymap, action->type, field);
 541
 542         if (!ExprResolveEnum(keymap->ctx, value, &val, lockWhich))
 543             return ReportMismatch(keymap, action->type, field,
 544                                   "lock or unlock");
 545
 546         act->flags &= ~(ACTION_LOCK_NO_LOCK | ACTION_LOCK_NO_UNLOCK);
 547         act->flags |= val;
 548         return true;
 549     }
 550     else if (field == ACTION_FIELD_COUNT) {
 551         int btn;
 552
 553         if (array_ndx)
 554             return ReportActionNotArray(keymap, action->type, field);
 555
 556         /* XXX: Should this actually be ResolveButton? */
 557         if (!ExprResolveButton(keymap->ctx, value, &btn))
 558             return ReportMismatch(keymap, action->type, field, "integer");
 559
 560         if (btn < 0 || btn > 255) {
 561             log_err(keymap->ctx,
 562                     "The count field must have a value in the range 0..255; "
 563                     "Illegal count %d ignored\n", btn);
 564             return false;
 565         }
 566
 567         act->count = btn;
 568         return true;
 569     }
 570     return ReportIllegal(keymap, action->type, field);
 571 }
 572
 573 static const LookupEntry ptrDflts[] = {
 574     { "dfltbtn", 1 },
 575     { "defaultbutton", 1 },
 576     { "button", 1 },
 577     { NULL, 0 }
 578 };
 579
 580 static bool
 581 HandleSetPtrDflt(struct xkb_keymap *keymap, union xkb_action *action,
 582                  enum action_field field, const ExprDef *array_ndx,
 583                  const ExprDef *value)
 584 {
 585     struct xkb_pointer_default_action *act = &action->dflt;
 586
 587     if (field == ACTION_FIELD_AFFECT) {
 588         unsigned int val;
 589
 590         if (array_ndx)
 591             return ReportActionNotArray(keymap, action->type, field);
 592
 593         if (!ExprResolveEnum(keymap->ctx, value, &val, ptrDflts))
 594             return ReportMismatch(keymap, action->type, field,
 595                                   "pointer component");
 596         return true;
 597     }
 598     else if (field == ACTION_FIELD_BUTTON || field == ACTION_FIELD_VALUE) {
 599         const ExprDef *button;
 600         int btn;
 601
 602         if (array_ndx)
 603             return ReportActionNotArray(keymap, action->type, field);
 604
 605         if (value->expr.op == EXPR_NEGATE ||
 606             value->expr.op == EXPR_UNARY_PLUS) {
 607             act->flags &= ~ACTION_ABSOLUTE_SWITCH;
 608             button = value->unary.child;
 609         }
 610         else {
 611             act->flags |= ACTION_ABSOLUTE_SWITCH;
 612             button = value;
 613         }
 614
 615         if (!ExprResolveButton(keymap->ctx, button, &btn))
 616             return ReportMismatch(keymap, action->type, field,
 617                                   "integer (range 1..5)");
 618
 619         if (btn < 0 || btn > 5) {
 620             log_err(keymap->ctx,
 621                     "New default button value must be in the range 1..5; "
 622                     "Illegal default button value %d ignored\n", btn);
 623             return false;
 624         }
 625         if (btn == 0) {
 626             log_err(keymap->ctx,
 627                     "Cannot set default pointer button to \"default\"; "
 628                     "Illegal default button setting ignored\n");
 629             return false;
 630         }
 631
 632         act->value = (value->expr.op == EXPR_NEGATE ? -btn: btn);
 633         return true;
 634     }
 635
 636     return ReportIllegal(keymap, action->type, field);
 637 }
 638
 639 static bool
 640 HandleSwitchScreen(struct xkb_keymap *keymap, union xkb_action *action,
 641                    enum action_field field, const ExprDef *array_ndx,
 642                    const ExprDef *value)
 643 {
 644     struct xkb_switch_screen_action *act = &action->screen;
 645
 646     if (field == ACTION_FIELD_SCREEN) {
 647         const ExprDef *scrn;
 648         int val;
 649
 650         if (array_ndx)
 651             return ReportActionNotArray(keymap, action->type, field);
 652
 653         if (value->expr.op == EXPR_NEGATE ||
 654             value->expr.op == EXPR_UNARY_PLUS) {
 655             act->flags &= ~ACTION_ABSOLUTE_SWITCH;
 656             scrn = value->unary.child;
 657         }
 658         else {
 659             act->flags |= ACTION_ABSOLUTE_SWITCH;
 660             scrn = value;
 661         }
 662
 663         if (!ExprResolveInteger(keymap->ctx, scrn, &val))
 664             return ReportMismatch(keymap, action->type, field,
 665                                   "integer (0..255)");
 666
 667         if (val < 0 || val > 255) {
 668             log_err(keymap->ctx,
 669                     "Screen index must be in the range 1..255; "
 670                     "Illegal screen value %d ignored\n", val);
 671             return false;
 672         }
 673
 674         act->screen = (value->expr.op == EXPR_NEGATE ? -val : val);
 675         return true;
 676     }
 677     else if (field == ACTION_FIELD_SAME) {
 678         bool set;
 679
 680         if (array_ndx)
 681             return ReportActionNotArray(keymap, action->type, field);
 682
 683         if (!ExprResolveBoolean(keymap->ctx, value, &set))
 684             return ReportMismatch(keymap, action->type, field, "boolean");
 685
 686         if (set)
 687             act->flags &= ~ACTION_SAME_SCREEN;
 688         else
 689             act->flags |= ACTION_SAME_SCREEN;
 690
 691         return true;
 692     }
 693
 694     return ReportIllegal(keymap, action->type, field);
 695 }
 696
 697 static bool
 698 HandleSetLockControls(struct xkb_keymap *keymap, union xkb_action *action,
 699                       enum action_field field, const ExprDef *array_ndx,
 700                       const ExprDef *value)
 701 {
 702     struct xkb_controls_action *act = &action->ctrls;
 703
 704     if (field == ACTION_FIELD_CONTROLS) {
 705         unsigned int mask;
 706
 707         if (array_ndx)
 708             return ReportActionNotArray(keymap, action->type, field);
 709
 710         if (!ExprResolveMask(keymap->ctx, value, &mask, ctrlMaskNames))
 711             return ReportMismatch(keymap, action->type, field,
 712                                   "controls mask");
 713
 714         act->ctrls = mask;
 715         return true;
 716     }
 717
 718     return ReportIllegal(keymap, action->type, field);
 719 }
 720
 721 static bool
 722 HandlePrivate(struct xkb_keymap *keymap, union xkb_action *action,
 723               enum action_field field, const ExprDef *array_ndx,
 724               const ExprDef *value)
 725 {
 726     struct xkb_private_action *act = &action->priv;
 727
 728     if (field == ACTION_FIELD_TYPE) {
 729         int type;
 730
 731         if (!ExprResolveInteger(keymap->ctx, value, &type))
 732             return ReportMismatch(keymap, ACTION_TYPE_PRIVATE, field, "integer");
 733
 734         if (type < 0 || type > 255) {
 735             log_err(keymap->ctx,
 736                     "Private action type must be in the range 0..255; "
 737                     "Illegal type %d ignored\n", type);
 738             return false;
 739         }
 740
 741         /*
 742          * It's possible for someone to write something like this:
 743          *      actions = [ Private(type=3,data[0]=1,data[1]=3,data[2]=3) ]
 744          * where the type refers to some existing action type, e.g. LockMods.
 745          * This assumes that this action's struct is laid out in memory
 746          * exactly as described in the XKB specification and libraries.
 747          * We, however, have changed these structs in various ways, so this
 748          * assumption is no longer true. Since this is a lousy "feature", we
 749          * make actions like these no-ops for now.
 750          */
 751         if (type < ACTION_TYPE_PRIVATE) {
 752             log_info(keymap->ctx,
 753                      "Private actions of type %s are not supported; Ignored\n",
 754                      ActionTypeText(type));
 755             act->type = ACTION_TYPE_NONE;
 756         }
 757         else {
 758             act->type = (enum xkb_action_type) type;
 759         }
 760
 761         return true;
 762     }
 763     else if (field == ACTION_FIELD_DATA) {
 764         if (array_ndx == NULL) {
 765             xkb_atom_t val;
 766             const char *str;
 767             int len;
 768
 769             if (!ExprResolveString(keymap->ctx, value, &val))
 770                 return ReportMismatch(keymap, action->type, field, "string");
 771
 772             str = xkb_atom_text(keymap->ctx, val);
 773             len = strlen(str);
 774             if (len < 1 || len > 7) {
 775                 log_warn(keymap->ctx,
 776                          "A private action has 7 data bytes; "
 777                          "Extra %d bytes ignored\n", len - 6);
 778                 return false;
 779             }
 780
 781             strncpy((char *) act->data, str, sizeof(act->data));
 782             return true;
 783         }
 784         else {
 785             int ndx, datum;
 786
 787             if (!ExprResolveInteger(keymap->ctx, array_ndx, &ndx)) {
 788                 log_err(keymap->ctx,
 789                         "Array subscript must be integer; "
 790                         "Illegal subscript ignored\n");
 791                 return false;
 792             }
 793
 794             if (ndx < 0 || ndx >= sizeof(act->data)) {
 795                 log_err(keymap->ctx,
 796                         "The data for a private action is %lu bytes long; "
 797                         "Attempt to use data[%d] ignored\n",
 798                         (unsigned long) sizeof(act->data), ndx);
 799                 return false;
 800             }
 801
 802             if (!ExprResolveInteger(keymap->ctx, value, &datum))
 803                 return ReportMismatch(keymap, act->type, field, "integer");
 804
 805             if (datum < 0 || datum > 255) {
 806                 log_err(keymap->ctx,
 807                         "All data for a private action must be 0..255; "
 808                         "Illegal datum %d ignored\n", datum);
 809                 return false;
 810             }
 811
 812             act->data[ndx] = (uint8_t) datum;
 813             return true;
 814         }
 815     }
 816
 817     return ReportIllegal(keymap, ACTION_TYPE_NONE, field);
 818 }
 819
 820 typedef bool (*actionHandler)(struct xkb_keymap *keymap,
 821                               union xkb_action *action,
 822                               enum action_field field,
 823                               const ExprDef *array_ndx,
 824                               const ExprDef *value);
 825
 826 static const actionHandler handleAction[_ACTION_TYPE_NUM_ENTRIES] = {
 827     [ACTION_TYPE_NONE] = HandleNoAction,
 828     [ACTION_TYPE_MOD_SET] = HandleSetLatchMods,
 829     [ACTION_TYPE_MOD_LATCH] = HandleSetLatchMods,
 830     [ACTION_TYPE_MOD_LOCK] = HandleLockMods,
 831     [ACTION_TYPE_GROUP_SET] = HandleSetLatchGroup,
 832     [ACTION_TYPE_GROUP_LATCH] = HandleSetLatchGroup,
 833     [ACTION_TYPE_GROUP_LOCK] = HandleLockGroup,
 834     [ACTION_TYPE_PTR_MOVE] = HandleMovePtr,
 835     [ACTION_TYPE_PTR_BUTTON] = HandlePtrBtn,
 836     [ACTION_TYPE_PTR_LOCK] = HandlePtrBtn,
 837     [ACTION_TYPE_PTR_DEFAULT] = HandleSetPtrDflt,
 838     [ACTION_TYPE_TERMINATE] = HandleNoAction,
 839     [ACTION_TYPE_SWITCH_VT] = HandleSwitchScreen,
 840     [ACTION_TYPE_CTRL_SET] = HandleSetLockControls,
 841     [ACTION_TYPE_CTRL_LOCK] = HandleSetLockControls,
 842     [ACTION_TYPE_PRIVATE] = HandlePrivate,
 843 };
 844
 845 /***====================================================================***/
 846
 847 bool
 848 HandleActionDef(ExprDef *def, struct xkb_keymap *keymap,
 849                 union xkb_action *action, ActionsInfo *info)
 850 {
 851     ExprDef *arg;
 852     const char *str;
 853     unsigned handler_type;
 854
 855     if (def->expr.op != EXPR_ACTION_DECL) {
 856         log_err(keymap->ctx, "Expected an action definition, found %s\n",
 857                 expr_op_type_to_string(def->expr.op));
 858         return false;
 859     }
 860
 861     str = xkb_atom_text(keymap->ctx, def->action.name);
 862     if (!stringToAction(str, &handler_type)) {
 863         log_err(keymap->ctx, "Unknown action %s\n", str);
 864         return false;
 865     }
 866
 867     /*
 868      * Get the default values for this action type, as modified by
 869      * statements such as:
 870      *     latchMods.clearLocks = True;
 871      */
 872     *action = info->actions[handler_type];
 873
 874     /*
 875      * Now change the action properties as specified for this
 876      * particular instance, e.g. "modifiers" and "clearLocks" in:
 877      *     SetMods(modifiers=Alt,clearLocks);
 878      */
 879     for (arg = def->action.args; arg != NULL;
 880          arg = (ExprDef *) arg->common.next) {
 881         const ExprDef *value;
 882         ExprDef *field, *arrayRtrn;
 883         const char *elemRtrn, *fieldRtrn;
 884         enum action_field fieldNdx;
 885
 886         if (arg->expr.op == EXPR_ASSIGN) {
 887             field = arg->binary.left;
 888             value = arg->binary.right;
 889         }
 890         else if (arg->expr.op == EXPR_NOT || arg->expr.op == EXPR_INVERT) {
 891             field = arg->unary.child;
 892             value = (const ExprDef *) &constFalse;
 893         }
 894         else {
 895             field = arg;
 896             value = (const ExprDef *) &constTrue;
 897         }
 898
 899         if (!ExprResolveLhs(keymap->ctx, field, &elemRtrn, &fieldRtrn,
 900                             &arrayRtrn))
 901             return false;
 902
 903         if (elemRtrn) {
 904             log_err(keymap->ctx,
 905                     "Cannot change defaults in an action definition; "
 906                     "Ignoring attempt to change %s.%s\n",
 907                     elemRtrn, fieldRtrn);
 908             return false;
 909         }
 910
 911         if (!stringToField(fieldRtrn, &fieldNdx)) {
 912             log_err(keymap->ctx, "Unknown field name %s\n", fieldRtrn);
 913             return false;
 914         }
 915
 916         if (!handleAction[handler_type](keymap, action, fieldNdx, arrayRtrn,
 917                                         value))
 918             return false;
 919     }
 920
 921     return true;
 922 }
 923
 924
 925 bool
 926 SetActionField(struct xkb_keymap *keymap, const char *elem, const char *field,
 927                ExprDef *array_ndx, ExprDef *value, ActionsInfo *info)
 928 {
 929     unsigned action;
 930     enum action_field action_field;
 931
 932     if (!stringToAction(elem, &action))
 933         return false;
 934
 935     if (!stringToField(field, &action_field)) {
 936         log_err(keymap->ctx, "\"%s\" is not a legal field name\n", field);
 937         return false;
 938     }
 939
 940     return handleAction[action](keymap, &info->actions[action],
 941                                 action_field, array_ndx, value);
 942 }