types: use xkb_mod_set instead of entire keymap
[platform/upstream/libxkbcommon.git] / src / xkbcomp / types.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 "vmod.h"
30 #include "expr.h"
31 #include "include.h"
32
33 enum type_field {
34     TYPE_FIELD_MASK       = (1 << 0),
35     TYPE_FIELD_MAP        = (1 << 1),
36     TYPE_FIELD_PRESERVE   = (1 << 2),
37     TYPE_FIELD_LEVEL_NAME = (1 << 3),
38 };
39
40 typedef struct {
41     enum type_field defined;
42     enum merge_mode merge;
43
44     xkb_atom_t name;
45     xkb_mod_mask_t mods;
46     xkb_level_index_t num_levels;
47     darray(struct xkb_key_type_entry) entries;
48     darray(xkb_atom_t) level_names;
49 } KeyTypeInfo;
50
51 typedef struct {
52     char *name;
53     int errorCount;
54
55     darray(KeyTypeInfo) types;
56     struct xkb_mod_set mods;
57
58     struct xkb_context *ctx;
59 } KeyTypesInfo;
60
61 /***====================================================================***/
62
63 static inline const char *
64 MapEntryTxt(KeyTypesInfo *info, struct xkb_key_type_entry *entry)
65 {
66     return ModMaskText(info->ctx, &info->mods, entry->mods.mods);
67 }
68
69 static inline const char *
70 TypeTxt(KeyTypesInfo *info, KeyTypeInfo *type)
71 {
72     return xkb_atom_text(info->ctx, type->name);
73 }
74
75 static inline const char *
76 TypeMaskTxt(KeyTypesInfo *info, KeyTypeInfo *type)
77 {
78     return ModMaskText(info->ctx, &info->mods, type->mods);
79 }
80
81 static inline bool
82 ReportTypeShouldBeArray(KeyTypesInfo *info, KeyTypeInfo *type,
83                         const char *field)
84 {
85     return ReportShouldBeArray(info->ctx, "key type", field,
86                                TypeTxt(info, type));
87 }
88
89 static inline bool
90 ReportTypeBadType(KeyTypesInfo *info, KeyTypeInfo *type,
91                   const char *field, const char *wanted)
92 {
93     return ReportBadType(info->ctx, "key type", field,
94                          TypeTxt(info, type), wanted);
95 }
96
97 /***====================================================================***/
98
99 static void
100 InitKeyTypesInfo(KeyTypesInfo *info, struct xkb_context *ctx,
101                  const struct xkb_mod_set *mods)
102 {
103     memset(info, 0, sizeof(*info));
104     info->ctx = ctx;
105     CopyModSet(&info->mods, mods);
106 }
107
108 static void
109 ClearKeyTypeInfo(KeyTypeInfo *type)
110 {
111     darray_free(type->entries);
112     darray_free(type->level_names);
113 }
114
115 static void
116 ClearKeyTypesInfo(KeyTypesInfo *info)
117 {
118     free(info->name);
119     ClearModSet(&info->mods);
120     darray_free(info->types);
121 }
122
123 static KeyTypeInfo *
124 FindMatchingKeyType(KeyTypesInfo *info, xkb_atom_t name)
125 {
126     KeyTypeInfo *old;
127
128     darray_foreach(old, info->types)
129         if (old->name == name)
130             return old;
131
132     return NULL;
133 }
134
135 static bool
136 AddKeyType(KeyTypesInfo *info, KeyTypeInfo *new, bool same_file)
137 {
138     KeyTypeInfo *old;
139     const int verbosity = xkb_context_get_log_verbosity(info->ctx);
140
141     old = FindMatchingKeyType(info, new->name);
142     if (old) {
143         if (new->merge == MERGE_REPLACE || new->merge == MERGE_OVERRIDE) {
144             if ((same_file && verbosity > 0) || verbosity > 9) {
145                 log_warn(info->ctx,
146                          "Multiple definitions of the %s key type; "
147                          "Earlier definition ignored\n",
148                          xkb_atom_text(info->ctx, new->name));
149             }
150
151             ClearKeyTypeInfo(old);
152             *old = *new;
153             darray_init(new->entries);
154             darray_init(new->level_names);
155             return true;
156         }
157
158         if (same_file)
159             log_vrb(info->ctx, 4,
160                     "Multiple definitions of the %s key type; "
161                     "Later definition ignored\n",
162                     xkb_atom_text(info->ctx, new->name));
163
164         ClearKeyTypeInfo(new);
165         return true;
166     }
167
168     darray_append(info->types, *new);
169     return true;
170 }
171
172 /***====================================================================***/
173
174 static void
175 MergeIncludedKeyTypes(KeyTypesInfo *into, KeyTypesInfo *from,
176                       enum merge_mode merge)
177 {
178     KeyTypeInfo *type;
179
180     if (from->errorCount > 0) {
181         into->errorCount += from->errorCount;
182         return;
183     }
184
185     MoveModSet(&into->mods, &from->mods);
186
187     if (into->name == NULL) {
188         into->name = from->name;
189         from->name = NULL;
190     }
191
192     if (darray_empty(into->types)) {
193         into->types = from->types;
194         darray_init(from->types);
195     }
196     else {
197         darray_foreach(type, from->types) {
198             type->merge = (merge == MERGE_DEFAULT ? type->merge : merge);
199             if (!AddKeyType(into, type, false))
200                 into->errorCount++;
201         }
202     }
203 }
204
205 static void
206 HandleKeyTypesFile(KeyTypesInfo *info, XkbFile *file, enum merge_mode merge);
207
208 static bool
209 HandleIncludeKeyTypes(KeyTypesInfo *info, IncludeStmt *include)
210 {
211     KeyTypesInfo included;
212
213     InitKeyTypesInfo(&included, info->ctx, &info->mods);
214     included.name = include->stmt;
215     include->stmt = NULL;
216
217     for (IncludeStmt *stmt = include; stmt; stmt = stmt->next_incl) {
218         KeyTypesInfo next_incl;
219         XkbFile *file;
220
221         file = ProcessIncludeFile(info->ctx, stmt, FILE_TYPE_TYPES);
222         if (!file) {
223             info->errorCount += 10;
224             ClearKeyTypesInfo(&included);
225             return false;
226         }
227
228         InitKeyTypesInfo(&next_incl, info->ctx, &included.mods);
229
230         HandleKeyTypesFile(&next_incl, file, stmt->merge);
231
232         MergeIncludedKeyTypes(&included, &next_incl, stmt->merge);
233
234         ClearKeyTypesInfo(&next_incl);
235         FreeXkbFile(file);
236     }
237
238     MergeIncludedKeyTypes(info, &included, include->merge);
239     ClearKeyTypesInfo(&included);
240
241     return (info->errorCount == 0);
242 }
243
244 /***====================================================================***/
245
246 static bool
247 SetModifiers(KeyTypesInfo *info, KeyTypeInfo *type, ExprDef *arrayNdx,
248              ExprDef *value)
249 {
250     xkb_mod_mask_t mods;
251
252     if (arrayNdx)
253         log_warn(info->ctx,
254                  "The modifiers field of a key type is not an array; "
255                  "Illegal array subscript ignored\n");
256
257     if (!ExprResolveModMask(info->ctx, value, MOD_BOTH, &info->mods, &mods)) {
258         log_err(info->ctx,
259                 "Key type mask field must be a modifier mask; "
260                 "Key type definition ignored\n");
261         return false;
262     }
263
264     if (type->defined & TYPE_FIELD_MASK) {
265         log_warn(info->ctx,
266                  "Multiple modifier mask definitions for key type %s; "
267                  "Using %s, ignoring %s\n",
268                  xkb_atom_text(info->ctx, type->name),
269                  TypeMaskTxt(info, type),
270                  ModMaskText(info->ctx, &info->mods, mods));
271         return false;
272     }
273
274     type->mods = mods;
275     return true;
276 }
277
278 /***====================================================================***/
279
280 static struct xkb_key_type_entry *
281 FindMatchingMapEntry(KeyTypeInfo *type, xkb_mod_mask_t mods)
282 {
283     struct xkb_key_type_entry *entry;
284
285     darray_foreach(entry, type->entries)
286         if (entry->mods.mods == mods)
287             return entry;
288
289     return NULL;
290 }
291
292 static bool
293 AddMapEntry(KeyTypesInfo *info, KeyTypeInfo *type,
294             struct xkb_key_type_entry *new, bool clobber, bool report)
295 {
296     struct xkb_key_type_entry *old;
297
298     old = FindMatchingMapEntry(type, new->mods.mods);
299     if (old) {
300         if (report && old->level != new->level) {
301             log_warn(info->ctx,
302                      "Multiple map entries for %s in %s; "
303                      "Using %d, ignoring %d\n",
304                      MapEntryTxt(info, new), TypeTxt(info, type),
305                      (clobber ? new->level : old->level) + 1,
306                      (clobber ? old->level : new->level) + 1);
307         }
308         else {
309             log_vrb(info->ctx, 10,
310                     "Multiple occurrences of map[%s]= %d in %s; Ignored\n",
311                     MapEntryTxt(info, new), new->level + 1,
312                     TypeTxt(info, type));
313             return true;
314         }
315
316         if (clobber) {
317             if (new->level >= type->num_levels)
318                 type->num_levels = new->level + 1;
319             old->level = new->level;
320         }
321
322         return true;
323     }
324
325     if (new->level >= type->num_levels)
326         type->num_levels = new->level + 1;
327
328     darray_append(type->entries, *new);
329     return true;
330 }
331
332 static bool
333 SetMapEntry(KeyTypesInfo *info, KeyTypeInfo *type, ExprDef *arrayNdx,
334             ExprDef *value)
335 {
336     struct xkb_key_type_entry entry;
337
338     if (arrayNdx == NULL)
339         return ReportTypeShouldBeArray(info, type, "map entry");
340
341     if (!ExprResolveModMask(info->ctx, arrayNdx, MOD_BOTH, &info->mods,
342                             &entry.mods.mods))
343         return ReportTypeBadType(info, type, "map entry", "modifier mask");
344
345     if (entry.mods.mods & (~type->mods)) {
346         log_vrb(info->ctx, 1,
347                 "Map entry for unused modifiers in %s; "
348                 "Using %s instead of %s\n",
349                 TypeTxt(info, type),
350                 ModMaskText(info->ctx, &info->mods,
351                             entry.mods.mods & type->mods),
352                 MapEntryTxt(info, &entry));
353         entry.mods.mods &= type->mods;
354     }
355
356     if (!ExprResolveLevel(info->ctx, value, &entry.level)) {
357         log_err(info->ctx,
358                 "Level specifications in a key type must be integer; "
359                 "Ignoring malformed level specification\n");
360         return false;
361     }
362
363     entry.preserve.mods = 0;
364
365     return AddMapEntry(info, type, &entry, true, true);
366 }
367
368 /***====================================================================***/
369
370 static bool
371 AddPreserve(KeyTypesInfo *info, KeyTypeInfo *type,
372             xkb_mod_mask_t mods, xkb_mod_mask_t preserve_mods)
373 {
374     struct xkb_key_type_entry *entry;
375     struct xkb_key_type_entry new;
376
377     darray_foreach(entry, type->entries) {
378         if (entry->mods.mods != mods)
379             continue;
380
381         /* Map exists without previous preserve (or "None"); override. */
382         if (entry->preserve.mods == 0) {
383             entry->preserve.mods = preserve_mods;
384             return true;
385         }
386
387         /* Map exists with same preserve; do nothing. */
388         if (entry->preserve.mods == preserve_mods) {
389             log_vrb(info->ctx, 10,
390                     "Identical definitions for preserve[%s] in %s; "
391                     "Ignored\n",
392                     ModMaskText(info->ctx, &info->mods, mods),
393                     TypeTxt(info, type));
394             return true;
395         }
396
397         /* Map exists with different preserve; latter wins. */
398         log_vrb(info->ctx, 1,
399                 "Multiple definitions for preserve[%s] in %s; "
400                 "Using %s, ignoring %s\n",
401                 ModMaskText(info->ctx, &info->mods, mods),
402                 TypeTxt(info, type),
403                 ModMaskText(info->ctx, &info->mods, preserve_mods),
404                 ModMaskText(info->ctx, &info->mods, entry->preserve.mods));
405
406         entry->preserve.mods = preserve_mods;
407         return true;
408     }
409
410     /*
411      * Map does not exist, i.e. preserve[] came before map[].
412      * Create a map with the specified mask mapping to Level1. The level
413      * may be overridden later with an explicit map[] statement.
414      */
415     new.level = 0;
416     new.mods.mods = mods;
417     new.preserve.mods = preserve_mods;
418     darray_append(type->entries, new);
419     return true;
420 }
421
422 static bool
423 SetPreserve(KeyTypesInfo *info, KeyTypeInfo *type, ExprDef *arrayNdx,
424             ExprDef *value)
425 {
426     xkb_mod_mask_t mods, preserve_mods;
427
428     if (arrayNdx == NULL)
429         return ReportTypeShouldBeArray(info, type, "preserve entry");
430
431     if (!ExprResolveModMask(info->ctx, arrayNdx, MOD_BOTH, &info->mods, &mods))
432         return ReportTypeBadType(info, type, "preserve entry",
433                                  "modifier mask");
434
435     if (mods & ~type->mods) {
436         const char *before, *after;
437
438         before = ModMaskText(info->ctx, &info->mods, mods);
439         mods &= type->mods;
440         after = ModMaskText(info->ctx, &info->mods, mods);
441
442         log_vrb(info->ctx, 1,
443                 "Preserve for modifiers not used by the %s type; "
444                 "Index %s converted to %s\n",
445                 TypeTxt(info, type), before, after);
446     }
447
448     if (!ExprResolveModMask(info->ctx, value, MOD_BOTH, &info->mods,
449                             &preserve_mods)) {
450         log_err(info->ctx,
451                 "Preserve value in a key type is not a modifier mask; "
452                 "Ignoring preserve[%s] in type %s\n",
453                 ModMaskText(info->ctx, &info->mods, mods),
454                 TypeTxt(info, type));
455         return false;
456     }
457
458     if (preserve_mods & ~mods) {
459         const char *before, *after;
460
461         before = ModMaskText(info->ctx, &info->mods, preserve_mods);
462         preserve_mods &= mods;
463         after = ModMaskText(info->ctx, &info->mods, preserve_mods);
464
465         log_vrb(info->ctx, 1,
466                 "Illegal value for preserve[%s] in type %s; "
467                 "Converted %s to %s\n",
468                 ModMaskText(info->ctx, &info->mods, mods),
469                 TypeTxt(info, type), before, after);
470     }
471
472     return AddPreserve(info, type, mods, preserve_mods);
473 }
474
475 /***====================================================================***/
476
477 static bool
478 AddLevelName(KeyTypesInfo *info, KeyTypeInfo *type,
479              xkb_level_index_t level, xkb_atom_t name, bool clobber)
480 {
481     /* New name. */
482     if (level >= darray_size(type->level_names)) {
483         darray_resize0(type->level_names, level + 1);
484         goto finish;
485     }
486
487     /* Same level, same name. */
488     if (darray_item(type->level_names, level) == name) {
489         log_vrb(info->ctx, 10,
490                 "Duplicate names for level %d of key type %s; Ignored\n",
491                 level + 1, TypeTxt(info, type));
492         return true;
493     }
494
495     /* Same level, different name. */
496     if (darray_item(type->level_names, level) != XKB_ATOM_NONE) {
497         const char *old, *new;
498         old = xkb_atom_text(info->ctx,
499                             darray_item(type->level_names, level));
500         new = xkb_atom_text(info->ctx, name);
501         log_vrb(info->ctx, 1,
502                 "Multiple names for level %d of key type %s; "
503                 "Using %s, ignoring %s\n",
504                 level + 1, TypeTxt(info, type),
505                 (clobber ? new : old), (clobber ? old : new));
506
507         if (!clobber)
508             return true;
509     }
510
511     /* XXX: What about different level, same name? */
512
513 finish:
514     darray_item(type->level_names, level) = name;
515     return true;
516 }
517
518 static bool
519 SetLevelName(KeyTypesInfo *info, KeyTypeInfo *type, ExprDef *arrayNdx,
520              ExprDef *value)
521 {
522     xkb_level_index_t level;
523     xkb_atom_t level_name;
524
525     if (arrayNdx == NULL)
526         return ReportTypeShouldBeArray(info, type, "level name");
527
528     if (!ExprResolveLevel(info->ctx, arrayNdx, &level))
529         return ReportTypeBadType(info, type, "level name", "integer");
530
531     if (!ExprResolveString(info->ctx, value, &level_name)) {
532         log_err(info->ctx,
533                 "Non-string name for level %d in key type %s; "
534                 "Ignoring illegal level name definition\n",
535                 level + 1, xkb_atom_text(info->ctx, type->name));
536         return false;
537     }
538
539     return AddLevelName(info, type, level, level_name, true);
540 }
541
542 /***====================================================================***/
543
544 static bool
545 SetKeyTypeField(KeyTypesInfo *info, KeyTypeInfo *type,
546                 const char *field, ExprDef *arrayNdx, ExprDef *value)
547 {
548     bool ok = false;
549     enum type_field type_field = 0;
550
551     if (istreq(field, "modifiers")) {
552         type_field = TYPE_FIELD_MASK;
553         ok = SetModifiers(info, type, arrayNdx, value);
554     }
555     else if (istreq(field, "map")) {
556         type_field = TYPE_FIELD_MAP;
557         ok = SetMapEntry(info, type, arrayNdx, value);
558     }
559     else if (istreq(field, "preserve")) {
560         type_field = TYPE_FIELD_PRESERVE;
561         ok = SetPreserve(info, type, arrayNdx, value);
562     }
563     else if (istreq(field, "levelname") || istreq(field, "level_name")) {
564         type_field = TYPE_FIELD_LEVEL_NAME;
565         ok = SetLevelName(info, type, arrayNdx, value);
566     } else {
567         log_err(info->ctx,
568                 "Unknown field %s in key type %s; Definition ignored\n",
569                 field, TypeTxt(info, type));
570     }
571
572     type->defined |= type_field;
573     return ok;
574 }
575
576 static bool
577 HandleKeyTypeBody(KeyTypesInfo *info, VarDef *def, KeyTypeInfo *type)
578 {
579     bool ok = true;
580     const char *elem, *field;
581     ExprDef *arrayNdx;
582
583     for (; def; def = (VarDef *) def->common.next) {
584         ok = ExprResolveLhs(info->ctx, def->name, &elem, &field,
585                             &arrayNdx);
586         if (!ok)
587             continue;
588
589         if (elem && istreq(elem, "type")) {
590             log_err(info->ctx,
591                     "Support for changing the default type has been removed; "
592                     "Statement ignored\n");
593             continue;
594         }
595
596         ok = SetKeyTypeField(info, type, field, arrayNdx, def->value);
597     }
598
599     return ok;
600 }
601
602 static bool
603 HandleKeyTypeDef(KeyTypesInfo *info, KeyTypeDef *def, enum merge_mode merge)
604 {
605     KeyTypeInfo type = {
606         .defined = 0,
607         .merge = (def->merge == MERGE_DEFAULT ? merge : def->merge),
608         .name = def->name,
609         .mods = 0,
610         .num_levels = 1,
611         .entries = darray_new(),
612         .level_names = darray_new(),
613     };
614
615     if (!HandleKeyTypeBody(info, def->body, &type)) {
616         info->errorCount++;
617         return false;
618     }
619
620     if (!AddKeyType(info, &type, true)) {
621         info->errorCount++;
622         return false;
623     }
624
625     return true;
626 }
627
628 static void
629 HandleKeyTypesFile(KeyTypesInfo *info, XkbFile *file, enum merge_mode merge)
630 {
631     bool ok;
632
633     free(info->name);
634     info->name = strdup_safe(file->name);
635
636     for (ParseCommon *stmt = file->defs; stmt; stmt = stmt->next) {
637         switch (stmt->type) {
638         case STMT_INCLUDE:
639             ok = HandleIncludeKeyTypes(info, (IncludeStmt *) stmt);
640             break;
641         case STMT_TYPE:
642             ok = HandleKeyTypeDef(info, (KeyTypeDef *) stmt, merge);
643             break;
644         case STMT_VAR:
645             log_err(info->ctx,
646                     "Support for changing the default type has been removed; "
647                     "Statement ignored\n");
648             ok = true;
649             break;
650         case STMT_VMOD:
651             ok = HandleVModDef(info->ctx, &info->mods, (VModDef *) stmt, merge);
652             break;
653         default:
654             log_err(info->ctx,
655                     "Key type files may not include other declarations; "
656                     "Ignoring %s\n", stmt_type_to_string(stmt->type));
657             ok = false;
658             break;
659         }
660
661         if (!ok)
662             info->errorCount++;
663
664         if (info->errorCount > 10) {
665             log_err(info->ctx,
666                     "Abandoning keytypes file \"%s\"\n", file->topName);
667             break;
668         }
669     }
670 }
671
672 /***====================================================================***/
673
674 static bool
675 CopyKeyTypesToKeymap(struct xkb_keymap *keymap, KeyTypesInfo *info)
676 {
677     keymap->types_section_name = strdup_safe(info->name);
678     XkbEscapeMapName(keymap->types_section_name);
679
680     MoveModSet(&keymap->mods, &info->mods);
681
682     keymap->num_types = darray_size(info->types);
683     if (keymap->num_types == 0)
684         keymap->num_types = 1;
685
686     keymap->types = calloc(keymap->num_types, sizeof(*keymap->types));
687
688     /*
689      * If no types were specified, a default unnamed one-level type is
690      * used for all keys.
691      */
692     if (darray_empty(info->types)) {
693         struct xkb_key_type *type = &keymap->types[0];
694
695         type->mods.mods = 0;
696         type->num_levels = 1;
697         type->entries = NULL;
698         type->num_entries = 0;
699         type->name = xkb_atom_intern_literal(keymap->ctx, "default");
700         type->level_names = NULL;
701
702         return true;
703     }
704
705     for (unsigned i = 0; i < keymap->num_types; i++) {
706         KeyTypeInfo *def = &darray_item(info->types, i);
707         struct xkb_key_type *type = &keymap->types[i];
708
709         type->mods.mods = def->mods;
710         type->num_levels = def->num_levels;
711         type->entries = darray_mem(def->entries, 0);
712         type->num_entries = darray_size(def->entries);
713         darray_init(def->entries);
714         type->name = def->name;
715         type->level_names = darray_mem(def->level_names, 0);
716         darray_init(def->level_names);
717     }
718
719     return true;
720 }
721
722 /***====================================================================***/
723
724 bool
725 CompileKeyTypes(XkbFile *file, struct xkb_keymap *keymap,
726                 enum merge_mode merge)
727 {
728     KeyTypesInfo info;
729
730     InitKeyTypesInfo(&info, keymap->ctx, &keymap->mods);
731
732     HandleKeyTypesFile(&info, file, merge);
733     if (info.errorCount != 0)
734         goto err_info;
735
736     if (!CopyKeyTypesToKeymap(keymap, &info))
737         goto err_info;
738
739     ClearKeyTypesInfo(&info);
740     return true;
741
742 err_info:
743     ClearKeyTypesInfo(&info);
744     return false;
745 }