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