types: separate ctx
[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->keymap, 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->keymap, 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->keymap, 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->keymap, entry.mods.mods & type->mods),
345                 MapEntryTxt(info, &entry));
346         entry.mods.mods &= type->mods;
347     }
348
349     if (!ExprResolveLevel(info->ctx, value, &entry.level)) {
350         log_err(info->ctx,
351                 "Level specifications in a key type must be integer; "
352                 "Ignoring malformed level specification\n");
353         return false;
354     }
355
356     entry.preserve.mods = 0;
357
358     return AddMapEntry(info, type, &entry, true, true);
359 }
360
361 /***====================================================================***/
362
363 static bool
364 AddPreserve(KeyTypesInfo *info, KeyTypeInfo *type,
365             xkb_mod_mask_t mods, xkb_mod_mask_t preserve_mods)
366 {
367     struct xkb_key_type_entry *entry;
368     struct xkb_key_type_entry new;
369
370     darray_foreach(entry, type->entries) {
371         if (entry->mods.mods != mods)
372             continue;
373
374         /* Map exists without previous preserve (or "None"); override. */
375         if (entry->preserve.mods == 0) {
376             entry->preserve.mods = preserve_mods;
377             return true;
378         }
379
380         /* Map exists with same preserve; do nothing. */
381         if (entry->preserve.mods == preserve_mods) {
382             log_vrb(info->ctx, 10,
383                     "Identical definitions for preserve[%s] in %s; "
384                     "Ignored\n",
385                     ModMaskText(info->keymap, mods),
386                     TypeTxt(info, type));
387             return true;
388         }
389
390         /* Map exists with different preserve; latter wins. */
391         log_vrb(info->ctx, 1,
392                 "Multiple definitions for preserve[%s] in %s; "
393                 "Using %s, ignoring %s\n",
394                 ModMaskText(info->keymap, mods),
395                 TypeTxt(info, type),
396                 ModMaskText(info->keymap, preserve_mods),
397                 ModMaskText(info->keymap, entry->preserve.mods));
398
399         entry->preserve.mods = preserve_mods;
400         return true;
401     }
402
403     /*
404      * Map does not exist, i.e. preserve[] came before map[].
405      * Create a map with the specified mask mapping to Level1. The level
406      * may be overridden later with an explicit map[] statement.
407      */
408     new.level = 0;
409     new.mods.mods = mods;
410     new.preserve.mods = preserve_mods;
411     darray_append(type->entries, new);
412     return true;
413 }
414
415 static bool
416 SetPreserve(KeyTypesInfo *info, KeyTypeInfo *type, ExprDef *arrayNdx,
417             ExprDef *value)
418 {
419     xkb_mod_mask_t mods, preserve_mods;
420
421     if (arrayNdx == NULL)
422         return ReportTypeShouldBeArray(info, type, "preserve entry");
423
424     if (!ExprResolveModMask(info->keymap, arrayNdx, MOD_BOTH, &mods))
425         return ReportTypeBadType(info, type, "preserve entry",
426                                  "modifier mask");
427
428     if (mods & ~type->mods) {
429         const char *before, *after;
430
431         before = ModMaskText(info->keymap, mods);
432         mods &= type->mods;
433         after = ModMaskText(info->keymap, mods);
434
435         log_vrb(info->ctx, 1,
436                 "Preserve for modifiers not used by the %s type; "
437                 "Index %s converted to %s\n",
438                 TypeTxt(info, type), before, after);
439     }
440
441     if (!ExprResolveModMask(info->keymap, value, MOD_BOTH, &preserve_mods)) {
442         log_err(info->ctx,
443                 "Preserve value in a key type is not a modifier mask; "
444                 "Ignoring preserve[%s] in type %s\n",
445                 ModMaskText(info->keymap, mods),
446                 TypeTxt(info, type));
447         return false;
448     }
449
450     if (preserve_mods & ~mods) {
451         const char *before, *after;
452
453         before = ModMaskText(info->keymap, preserve_mods);
454         preserve_mods &= mods;
455         after = ModMaskText(info->keymap, preserve_mods);
456
457         log_vrb(info->ctx, 1,
458                 "Illegal value for preserve[%s] in type %s; "
459                 "Converted %s to %s\n",
460                 ModMaskText(info->keymap, mods),
461                 TypeTxt(info, type), before, after);
462     }
463
464     return AddPreserve(info, type, mods, preserve_mods);
465 }
466
467 /***====================================================================***/
468
469 static bool
470 AddLevelName(KeyTypesInfo *info, KeyTypeInfo *type,
471              xkb_level_index_t level, xkb_atom_t name, bool clobber)
472 {
473     /* New name. */
474     if (level >= darray_size(type->level_names)) {
475         darray_resize0(type->level_names, level + 1);
476         goto finish;
477     }
478
479     /* Same level, same name. */
480     if (darray_item(type->level_names, level) == name) {
481         log_vrb(info->ctx, 10,
482                 "Duplicate names for level %d of key type %s; Ignored\n",
483                 level + 1, TypeTxt(info, type));
484         return true;
485     }
486
487     /* Same level, different name. */
488     if (darray_item(type->level_names, level) != XKB_ATOM_NONE) {
489         const char *old, *new;
490         old = xkb_atom_text(info->ctx,
491                             darray_item(type->level_names, level));
492         new = xkb_atom_text(info->ctx, name);
493         log_vrb(info->ctx, 1,
494                 "Multiple names for level %d of key type %s; "
495                 "Using %s, ignoring %s\n",
496                 level + 1, TypeTxt(info, type),
497                 (clobber ? new : old), (clobber ? old : new));
498
499         if (!clobber)
500             return true;
501     }
502
503     /* XXX: What about different level, same name? */
504
505 finish:
506     darray_item(type->level_names, level) = name;
507     return true;
508 }
509
510 static bool
511 SetLevelName(KeyTypesInfo *info, KeyTypeInfo *type, ExprDef *arrayNdx,
512              ExprDef *value)
513 {
514     xkb_level_index_t level;
515     xkb_atom_t level_name;
516
517     if (arrayNdx == NULL)
518         return ReportTypeShouldBeArray(info, type, "level name");
519
520     if (!ExprResolveLevel(info->ctx, arrayNdx, &level))
521         return ReportTypeBadType(info, type, "level name", "integer");
522
523     if (!ExprResolveString(info->ctx, value, &level_name)) {
524         log_err(info->ctx,
525                 "Non-string name for level %d in key type %s; "
526                 "Ignoring illegal level name definition\n",
527                 level + 1, xkb_atom_text(info->ctx, type->name));
528         return false;
529     }
530
531     return AddLevelName(info, type, level, level_name, true);
532 }
533
534 /***====================================================================***/
535
536 static bool
537 SetKeyTypeField(KeyTypesInfo *info, KeyTypeInfo *type,
538                 const char *field, ExprDef *arrayNdx, ExprDef *value)
539 {
540     bool ok = false;
541     enum type_field type_field = 0;
542
543     if (istreq(field, "modifiers")) {
544         type_field = TYPE_FIELD_MASK;
545         ok = SetModifiers(info, type, arrayNdx, value);
546     }
547     else if (istreq(field, "map")) {
548         type_field = TYPE_FIELD_MAP;
549         ok = SetMapEntry(info, type, arrayNdx, value);
550     }
551     else if (istreq(field, "preserve")) {
552         type_field = TYPE_FIELD_PRESERVE;
553         ok = SetPreserve(info, type, arrayNdx, value);
554     }
555     else if (istreq(field, "levelname") || istreq(field, "level_name")) {
556         type_field = TYPE_FIELD_LEVEL_NAME;
557         ok = SetLevelName(info, type, arrayNdx, value);
558     } else {
559         log_err(info->ctx,
560                 "Unknown field %s in key type %s; Definition ignored\n",
561                 field, TypeTxt(info, type));
562     }
563
564     type->defined |= type_field;
565     return ok;
566 }
567
568 static bool
569 HandleKeyTypeBody(KeyTypesInfo *info, VarDef *def, KeyTypeInfo *type)
570 {
571     bool ok = true;
572     const char *elem, *field;
573     ExprDef *arrayNdx;
574
575     for (; def; def = (VarDef *) def->common.next) {
576         ok = ExprResolveLhs(info->ctx, def->name, &elem, &field,
577                             &arrayNdx);
578         if (!ok)
579             continue;
580
581         if (elem && istreq(elem, "type")) {
582             log_err(info->ctx,
583                     "Support for changing the default type has been removed; "
584                     "Statement ignored\n");
585             continue;
586         }
587
588         ok = SetKeyTypeField(info, type, field, arrayNdx, def->value);
589     }
590
591     return ok;
592 }
593
594 static bool
595 HandleKeyTypeDef(KeyTypesInfo *info, KeyTypeDef *def, enum merge_mode merge)
596 {
597     KeyTypeInfo type = {
598         .defined = 0,
599         .merge = (def->merge == MERGE_DEFAULT ? merge : def->merge),
600         .name = def->name,
601         .mods = 0,
602         .num_levels = 1,
603         .entries = darray_new(),
604         .level_names = darray_new(),
605     };
606
607     if (!HandleKeyTypeBody(info, def->body, &type)) {
608         info->errorCount++;
609         return false;
610     }
611
612     if (!AddKeyType(info, &type, true)) {
613         info->errorCount++;
614         return false;
615     }
616
617     return true;
618 }
619
620 static void
621 HandleKeyTypesFile(KeyTypesInfo *info, XkbFile *file, enum merge_mode merge)
622 {
623     bool ok;
624
625     free(info->name);
626     info->name = strdup_safe(file->name);
627
628     for (ParseCommon *stmt = file->defs; stmt; stmt = stmt->next) {
629         switch (stmt->type) {
630         case STMT_INCLUDE:
631             ok = HandleIncludeKeyTypes(info, (IncludeStmt *) stmt);
632             break;
633         case STMT_TYPE:
634             ok = HandleKeyTypeDef(info, (KeyTypeDef *) stmt, merge);
635             break;
636         case STMT_VAR:
637             log_err(info->ctx,
638                     "Support for changing the default type has been removed; "
639                     "Statement ignored\n");
640             ok = true;
641             break;
642         case STMT_VMOD:
643             ok = HandleVModDef(info->keymap, (VModDef *) stmt, merge);
644             break;
645         default:
646             log_err(info->ctx,
647                     "Key type files may not include other declarations; "
648                     "Ignoring %s\n", stmt_type_to_string(stmt->type));
649             ok = false;
650             break;
651         }
652
653         if (!ok)
654             info->errorCount++;
655
656         if (info->errorCount > 10) {
657             log_err(info->ctx,
658                     "Abandoning keytypes file \"%s\"\n", file->topName);
659             break;
660         }
661     }
662 }
663
664 /***====================================================================***/
665
666 static bool
667 CopyKeyTypesToKeymap(struct xkb_keymap *keymap, KeyTypesInfo *info)
668 {
669     keymap->types_section_name = strdup_safe(info->name);
670     XkbEscapeMapName(keymap->types_section_name);
671
672     keymap->num_types = darray_size(info->types);
673     if (keymap->num_types == 0)
674         keymap->num_types = 1;
675
676     keymap->types = calloc(keymap->num_types, sizeof(*keymap->types));
677
678     /*
679      * If no types were specified, a default unnamed one-level type is
680      * used for all keys.
681      */
682     if (darray_empty(info->types)) {
683         struct xkb_key_type *type = &keymap->types[0];
684
685         type->mods.mods = 0;
686         type->num_levels = 1;
687         type->entries = NULL;
688         type->num_entries = 0;
689         type->name = xkb_atom_intern_literal(keymap->ctx, "default");
690         type->level_names = NULL;
691
692         return true;
693     }
694
695     for (unsigned i = 0; i < keymap->num_types; i++) {
696         KeyTypeInfo *def = &darray_item(info->types, i);
697         struct xkb_key_type *type = &keymap->types[i];
698
699         type->mods.mods = def->mods;
700         type->num_levels = def->num_levels;
701         type->entries = darray_mem(def->entries, 0);
702         type->num_entries = darray_size(def->entries);
703         darray_init(def->entries);
704         type->name = def->name;
705         type->level_names = darray_mem(def->level_names, 0);
706         darray_init(def->level_names);
707     }
708
709     return true;
710 }
711
712 /***====================================================================***/
713
714 bool
715 CompileKeyTypes(XkbFile *file, struct xkb_keymap *keymap,
716                 enum merge_mode merge)
717 {
718     KeyTypesInfo info;
719
720     InitKeyTypesInfo(&info, keymap);
721
722     HandleKeyTypesFile(&info, file, merge);
723     if (info.errorCount != 0)
724         goto err_info;
725
726     if (!CopyKeyTypesToKeymap(keymap, &info))
727         goto err_info;
728
729     ClearKeyTypesInfo(&info);
730     return true;
731
732 err_info:
733     ClearKeyTypesInfo(&info);
734     return false;
735 }