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