Edit

kc3-lang/libxkbcommon/src/xkbcomp/types.c

Branch :

  • Show log

    Commit

  • Author : Ran Benita
    Date : 2013-07-18 14:50:21
    Hash : 4b560287
    Message : xkbcomp: escape the section names before storing them in the keymap This ensures the names are escaped before having any interaction with the user. This was caught by noticing dump(compile(dump())) != dump. Since that's a nice test we add it to stringcomp. https://bugs.freedesktop.org/show_bug.cgi?id=67032 Reported-By: Auke Booij Signed-off-by: Ran Benita <ran234@gmail.com>

  • src/xkbcomp/types.c
  • /************************************************************
     * Copyright (c) 1994 by Silicon Graphics Computer Systems, Inc.
     *
     * Permission to use, copy, modify, and distribute this
     * software and its documentation for any purpose and without
     * fee is hereby granted, provided that the above copyright
     * notice appear in all copies and that both that copyright
     * notice and this permission notice appear in supporting
     * documentation, and that the name of Silicon Graphics not be
     * used in advertising or publicity pertaining to distribution
     * of the software without specific prior written permission.
     * Silicon Graphics makes no representation about the suitability
     * of this software for any purpose. It is provided "as is"
     * without any express or implied warranty.
     *
     * SILICON GRAPHICS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
     * SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
     * AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL SILICON
     * GRAPHICS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
     * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
     * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
     * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION  WITH
     * THE USE OR PERFORMANCE OF THIS SOFTWARE.
     *
     ********************************************************/
    
    #include "xkbcomp-priv.h"
    #include "text.h"
    #include "vmod.h"
    #include "expr.h"
    #include "include.h"
    
    /*
     * The xkb_types section
     * =====================
     * This section is the second to be processesed, after xkb_keycodes.
     * However, it is completely independent and could have been the first
     * to be processed (it does not refer to specific keys as specified in
     * the xkb_keycodes section).
     *
     * This section defines key types, which, given a key and a keyboard
     * state (i.e. modifier state and group), determine the shift level to
     * be used in translating the key to keysyms. These types are assigned
     * to each group in each key, in the xkb_symbols section.
     *
     * Key types are called this way because, in a way, they really describe
     * the "type" of the key (or more correctly, a specific group of the
     * key). For example, an ordinary keymap will provide a type called
     * "KEYPAD", which consists of two levels, with the second level being
     * chosen according to the state of the Num Lock (or Shift) modifiers.
     * Another example is a type called "ONE_LEVEL", which is usually
     * assigned to keys such as Escape; these have just one level and are
     * not affected by the modifier state. Yet more common examples are
     * "TWO_LEVEL" (with Shift choosing the second level), "ALPHABETIC"
     * (where Caps Lock may also choose the second level), etc.
     *
     * Type definitions
     * ----------------
     *  Statements of the form:
     *      type "FOUR_LEVEL" { ... }
     *
     * The above would create a new type named "FOUR_LEVEL".
     * The body of the definition may include statements of the following
     * forms:
     *
     * - level_name statements (mandatory for each level in the type):
     *      level_name[Level1] = "Base";
     *
     *   Gives each level in this type a descriptive name. It isn't used
     *   for any thing.
     *   Note: A level may be specified as Level[1-8] or just a number (can
     *   be more than 8).
     *
     * - modifiers statement (mandatory, should be specified only once):
     *      modifiers = Shift+Lock+LevelThree;
     *
     *   A mask of real and virtual modifiers. These are the only modifiers
     *   being considered when matching the modifier state against the type.
     *   The other modifiers, whether active or not, are masked out in the
     *   calculation.
     *
     * - map entry statements (should have at least as many mappings as there
     *   are levels in the type):
     *      map[Shift+LevelThree] = Level4;
     *
     *   If the active modifiers, masked with the type's modifiers (as stated
     *   above), match (i.e. equal) the modifiers inside the map[] statement,
     *   then the level in the right hand side is chosen. For example, in the
     *   above, if in the current keyboard state the Shift and LevelThree
     *   modifiers are active, while the Lock modifier is not, then the
     *   keysym(s) in the 4th level of the group will be returned to the
     *   user.
     *
     * - preserve statements:
     *      map[Shift+Lock+LevelThree] = Level5;
     *      preserve[Shift+Lock+LevelThree] = Lock;
     *
     *   When a map entry matches the active modifiers and the level it
     *   specified is chosen, then these modifiers are said to be "consumed";
     *   for example, in a simple US keymap where the "g" key is assigned an
     *   ordinary ALPHABETIC key type, if the Lock (Caps Lock) modifier is
     *   active and the key is pressed, then a "G" keysym is produced (as
     *   opposed to lower-case "g"). This is because the type definition has
     *   a map entry like the following:
     *      map[Lock] = Level2;
     *   And as such the Lock modifier is consumed. This information is
     *   relevant for applications which further process the modifiers,
     *   since by then the consumed modifiers have already "done their part"
     *   and should be masked out.
     *
     *   However, sometimes even if a modifier is actually used to choose
     *   the shift level (as Lock above), it should *not* be reported as
     *   consumed, for various reasons. In this case, a preserve[] statement
     *   can be used to augment the map entry. The modifiers inside the square
     *   brackets should match one of the map[] statements in the type. The
     *   right hand side should consists of modifiers from the left hand
     *   side; these modifiers are then "preserved" and not reported as
     *   consumed.
     *
     * Virtual modifier statements
     * ---------------------------
     * Statements of the form:
     *     virtual_modifiers LControl;
     *
     * Can appear in the xkb_types, xkb_compat, xkb_symbols sections.
     * TODO
     *
     * Effect on keymap
     * ----------------
     * After all of the xkb_types sections have been compiled, the following
     * members of struct xkb_keymap are finalized:
     *      struct xkb_key_type *types;
     *      unsigned int num_types;
     *      char *types_section_name;
     * TODO: virtual modifiers.
     */
    
    enum type_field {
        TYPE_FIELD_MASK       = (1 << 0),
        TYPE_FIELD_MAP        = (1 << 1),
        TYPE_FIELD_PRESERVE   = (1 << 2),
        TYPE_FIELD_LEVEL_NAME = (1 << 3),
    };
    
    typedef struct {
        enum type_field defined;
        enum merge_mode merge;
    
        xkb_atom_t name;
        xkb_mod_mask_t mods;
        xkb_level_index_t num_levels;
        darray(struct xkb_key_type_entry) entries;
        darray(xkb_atom_t) level_names;
    } KeyTypeInfo;
    
    typedef struct {
        char *name;
        int errorCount;
    
        darray(KeyTypeInfo) types;
        struct xkb_keymap *keymap;
    } KeyTypesInfo;
    
    /***====================================================================***/
    
    static inline const char *
    MapEntryTxt(KeyTypesInfo *info, struct xkb_key_type_entry *entry)
    {
        return ModMaskText(info->keymap, entry->mods.mods);
    }
    
    static inline const char *
    TypeTxt(KeyTypesInfo *info, KeyTypeInfo *type)
    {
        return xkb_atom_text(info->keymap->ctx, type->name);
    }
    
    static inline const char *
    TypeMaskTxt(KeyTypesInfo *info, KeyTypeInfo *type)
    {
        return ModMaskText(info->keymap, type->mods);
    }
    
    static inline bool
    ReportTypeShouldBeArray(KeyTypesInfo *info, KeyTypeInfo *type,
                            const char *field)
    {
        return ReportShouldBeArray(info->keymap->ctx, "key type", field,
                                   TypeTxt(info, type));
    }
    
    static inline bool
    ReportTypeBadType(KeyTypesInfo *info, KeyTypeInfo *type,
                      const char *field, const char *wanted)
    {
        return ReportBadType(info->keymap->ctx, "key type", field,
                             TypeTxt(info, type), wanted);
    }
    
    static inline bool
    ReportTypeBadWidth(KeyTypesInfo *info, const char *type, int has, int needs)
    {
        log_err(info->keymap->ctx,
                "Key type \"%s\" has %d levels, must have %d; "
                "Illegal type definition ignored\n",
                type, has, needs);
        return false;
    }
    
    /***====================================================================***/
    
    static void
    InitKeyTypesInfo(KeyTypesInfo *info, struct xkb_keymap *keymap)
    {
        memset(info, 0, sizeof(*info));
        info->keymap = keymap;
    }
    
    static void
    ClearKeyTypeInfo(KeyTypeInfo *type)
    {
        darray_free(type->entries);
        darray_free(type->level_names);
    }
    
    static void
    ClearKeyTypesInfo(KeyTypesInfo *info)
    {
        free(info->name);
        darray_free(info->types);
    }
    
    static KeyTypeInfo *
    FindMatchingKeyType(KeyTypesInfo *info, xkb_atom_t name)
    {
        KeyTypeInfo *old;
    
        darray_foreach(old, info->types)
            if (old->name == name)
                return old;
    
        return NULL;
    }
    
    static bool
    AddKeyType(KeyTypesInfo *info, KeyTypeInfo *new, bool same_file)
    {
        KeyTypeInfo *old;
        const int verbosity = xkb_context_get_log_verbosity(info->keymap->ctx);
    
        old = FindMatchingKeyType(info, new->name);
        if (old) {
            if (new->merge == MERGE_REPLACE || new->merge == MERGE_OVERRIDE) {
                if ((same_file && verbosity > 0) || verbosity > 9) {
                    log_warn(info->keymap->ctx,
                             "Multiple definitions of the %s key type; "
                             "Earlier definition ignored\n",
                             xkb_atom_text(info->keymap->ctx, new->name));
                }
    
                ClearKeyTypeInfo(old);
                *old = *new;
                darray_init(new->entries);
                darray_init(new->level_names);
                return true;
            }
    
            if (same_file)
                log_vrb(info->keymap->ctx, 4,
                        "Multiple definitions of the %s key type; "
                        "Later definition ignored\n",
                        xkb_atom_text(info->keymap->ctx, new->name));
    
            ClearKeyTypeInfo(new);
            return true;
        }
    
        darray_append(info->types, *new);
        return true;
    }
    
    /***====================================================================***/
    
    static void
    MergeIncludedKeyTypes(KeyTypesInfo *into, KeyTypesInfo *from,
                          enum merge_mode merge)
    {
        KeyTypeInfo *type;
    
        if (from->errorCount > 0) {
            into->errorCount += from->errorCount;
            return;
        }
    
        if (into->name == NULL) {
            into->name = from->name;
            from->name = NULL;
        }
    
        darray_foreach(type, from->types) {
            type->merge = (merge == MERGE_DEFAULT ? type->merge : merge);
            if (!AddKeyType(into, type, false))
                into->errorCount++;
        }
    }
    
    static void
    HandleKeyTypesFile(KeyTypesInfo *info, XkbFile *file, enum merge_mode merge);
    
    static bool
    HandleIncludeKeyTypes(KeyTypesInfo *info, IncludeStmt *include)
    {
        KeyTypesInfo included;
    
        InitKeyTypesInfo(&included, info->keymap);
        included.name = include->stmt;
        include->stmt = NULL;
    
        for (IncludeStmt *stmt = include; stmt; stmt = stmt->next_incl) {
            KeyTypesInfo next_incl;
            XkbFile *file;
    
            file = ProcessIncludeFile(info->keymap->ctx, stmt, FILE_TYPE_TYPES);
            if (!file) {
                info->errorCount += 10;
                ClearKeyTypesInfo(&included);
                return false;
            }
    
            InitKeyTypesInfo(&next_incl, info->keymap);
    
            HandleKeyTypesFile(&next_incl, file, stmt->merge);
    
            MergeIncludedKeyTypes(&included, &next_incl, stmt->merge);
    
            ClearKeyTypesInfo(&next_incl);
            FreeXkbFile(file);
        }
    
        MergeIncludedKeyTypes(info, &included, include->merge);
        ClearKeyTypesInfo(&included);
    
        return (info->errorCount == 0);
    }
    
    /***====================================================================***/
    
    static bool
    SetModifiers(KeyTypesInfo *info, KeyTypeInfo *type, ExprDef *arrayNdx,
                 ExprDef *value)
    {
        xkb_mod_mask_t mods;
    
        if (arrayNdx)
            log_warn(info->keymap->ctx,
                     "The modifiers field of a key type is not an array; "
                     "Illegal array subscript ignored\n");
    
        if (!ExprResolveModMask(info->keymap, value, MOD_BOTH, &mods)) {
            log_err(info->keymap->ctx,
                    "Key type mask field must be a modifier mask; "
                    "Key type definition ignored\n");
            return false;
        }
    
        if (type->defined & TYPE_FIELD_MASK) {
            log_warn(info->keymap->ctx,
                     "Multiple modifier mask definitions for key type %s; "
                     "Using %s, ignoring %s\n",
                     xkb_atom_text(info->keymap->ctx, type->name),
                     TypeMaskTxt(info, type),
                     ModMaskText(info->keymap, mods));
            return false;
        }
    
        type->mods = mods;
        return true;
    }
    
    /***====================================================================***/
    
    static struct xkb_key_type_entry *
    FindMatchingMapEntry(KeyTypeInfo *type, xkb_mod_mask_t mods)
    {
        struct xkb_key_type_entry *entry;
    
        darray_foreach(entry, type->entries)
            if (entry->mods.mods == mods)
                return entry;
    
        return NULL;
    }
    
    static bool
    AddMapEntry(KeyTypesInfo *info, KeyTypeInfo *type,
                struct xkb_key_type_entry *new, bool clobber, bool report)
    {
        struct xkb_key_type_entry *old;
    
        old = FindMatchingMapEntry(type, new->mods.mods);
        if (old) {
            if (report && old->level != new->level) {
                log_warn(info->keymap->ctx,
                         "Multiple map entries for %s in %s; "
                         "Using %d, ignoring %d\n",
                         MapEntryTxt(info, new), TypeTxt(info, type),
                         (clobber ? new->level : old->level) + 1,
                         (clobber ? old->level : new->level) + 1);
            }
            else {
                log_vrb(info->keymap->ctx, 10,
                        "Multiple occurrences of map[%s]= %d in %s; Ignored\n",
                        MapEntryTxt(info, new), new->level + 1,
                        TypeTxt(info, type));
                return true;
            }
    
            if (clobber) {
                if (new->level >= type->num_levels)
                    type->num_levels = new->level + 1;
                old->level = new->level;
            }
    
            return true;
        }
    
        if (new->level >= type->num_levels)
            type->num_levels = new->level + 1;
    
        darray_append(type->entries, *new);
        return true;
    }
    
    static bool
    SetMapEntry(KeyTypesInfo *info, KeyTypeInfo *type, ExprDef *arrayNdx,
                ExprDef *value)
    {
        struct xkb_key_type_entry entry;
    
        if (arrayNdx == NULL)
            return ReportTypeShouldBeArray(info, type, "map entry");
    
        if (!ExprResolveModMask(info->keymap, arrayNdx, MOD_BOTH, &entry.mods.mods))
            return ReportTypeBadType(info, type, "map entry", "modifier mask");
    
        if (entry.mods.mods & (~type->mods)) {
            log_vrb(info->keymap->ctx, 1,
                    "Map entry for unused modifiers in %s; "
                    "Using %s instead of %s\n",
                    TypeTxt(info, type),
                    ModMaskText(info->keymap, entry.mods.mods & type->mods),
                    MapEntryTxt(info, &entry));
            entry.mods.mods &= type->mods;
        }
    
        if (!ExprResolveLevel(info->keymap->ctx, value, &entry.level)) {
            log_err(info->keymap->ctx,
                    "Level specifications in a key type must be integer; "
                    "Ignoring malformed level specification\n");
            return false;
        }
    
        entry.preserve.mods = 0;
    
        return AddMapEntry(info, type, &entry, true, true);
    }
    
    /***====================================================================***/
    
    static bool
    AddPreserve(KeyTypesInfo *info, KeyTypeInfo *type,
                xkb_mod_mask_t mods, xkb_mod_mask_t preserve_mods)
    {
        struct xkb_key_type_entry *entry;
        struct xkb_key_type_entry new;
    
        darray_foreach(entry, type->entries) {
            if (entry->mods.mods != mods)
                continue;
    
            /* Map exists without previous preserve (or "None"); override. */
            if (entry->preserve.mods == 0) {
                entry->preserve.mods = preserve_mods;
                return true;
            }
    
            /* Map exists with same preserve; do nothing. */
            if (entry->preserve.mods == preserve_mods) {
                log_vrb(info->keymap->ctx, 10,
                        "Identical definitions for preserve[%s] in %s; "
                        "Ignored\n",
                        ModMaskText(info->keymap, mods),
                        TypeTxt(info, type));
                return true;
            }
    
            /* Map exists with different preserve; latter wins. */
            log_vrb(info->keymap->ctx, 1,
                    "Multiple definitions for preserve[%s] in %s; "
                    "Using %s, ignoring %s\n",
                    ModMaskText(info->keymap, mods),
                    TypeTxt(info, type),
                    ModMaskText(info->keymap, preserve_mods),
                    ModMaskText(info->keymap, entry->preserve.mods));
    
            entry->preserve.mods = preserve_mods;
            return true;
        }
    
        /*
         * Map does not exist, i.e. preserve[] came before map[].
         * Create a map with the specified mask mapping to Level1. The level
         * may be overridden later with an explicit map[] statement.
         */
        new.level = 0;
        new.mods.mods = mods;
        new.preserve.mods = preserve_mods;
        darray_append(type->entries, new);
        return true;
    }
    
    static bool
    SetPreserve(KeyTypesInfo *info, KeyTypeInfo *type, ExprDef *arrayNdx,
                ExprDef *value)
    {
        xkb_mod_mask_t mods, preserve_mods;
    
        if (arrayNdx == NULL)
            return ReportTypeShouldBeArray(info, type, "preserve entry");
    
        if (!ExprResolveModMask(info->keymap, arrayNdx, MOD_BOTH, &mods))
            return ReportTypeBadType(info, type, "preserve entry",
                                     "modifier mask");
    
        if (mods & ~type->mods) {
            const char *before, *after;
    
            before = ModMaskText(info->keymap, mods);
            mods &= type->mods;
            after = ModMaskText(info->keymap, mods);
    
            log_vrb(info->keymap->ctx, 1,
                    "Preserve for modifiers not used by the %s type; "
                    "Index %s converted to %s\n",
                    TypeTxt(info, type), before, after);
        }
    
        if (!ExprResolveModMask(info->keymap, value, MOD_BOTH, &preserve_mods)) {
            log_err(info->keymap->ctx,
                    "Preserve value in a key type is not a modifier mask; "
                    "Ignoring preserve[%s] in type %s\n",
                    ModMaskText(info->keymap, mods),
                    TypeTxt(info, type));
            return false;
        }
    
        if (preserve_mods & ~mods) {
            const char *before, *after;
    
            before = ModMaskText(info->keymap, preserve_mods);
            preserve_mods &= mods;
            after = ModMaskText(info->keymap, preserve_mods);
    
            log_vrb(info->keymap->ctx, 1,
                    "Illegal value for preserve[%s] in type %s; "
                    "Converted %s to %s\n",
                    ModMaskText(info->keymap, mods),
                    TypeTxt(info, type), before, after);
        }
    
        return AddPreserve(info, type, mods, preserve_mods);
    }
    
    /***====================================================================***/
    
    static bool
    AddLevelName(KeyTypesInfo *info, KeyTypeInfo *type,
                 xkb_level_index_t level, xkb_atom_t name, bool clobber)
    {
        /* New name. */
        if (level >= darray_size(type->level_names)) {
            darray_resize0(type->level_names, level + 1);
            goto finish;
        }
    
        /* Same level, same name. */
        if (darray_item(type->level_names, level) == name) {
            log_vrb(info->keymap->ctx, 10,
                    "Duplicate names for level %d of key type %s; Ignored\n",
                    level + 1, TypeTxt(info, type));
            return true;
        }
    
        /* Same level, different name. */
        if (darray_item(type->level_names, level) != XKB_ATOM_NONE) {
            const char *old, *new;
            old = xkb_atom_text(info->keymap->ctx,
                                darray_item(type->level_names, level));
            new = xkb_atom_text(info->keymap->ctx, name);
            log_vrb(info->keymap->ctx, 1,
                    "Multiple names for level %d of key type %s; "
                    "Using %s, ignoring %s\n",
                    level + 1, TypeTxt(info, type),
                    (clobber ? new : old), (clobber ? old : new));
    
            if (!clobber)
                return true;
        }
    
        /* XXX: What about different level, same name? */
    
    finish:
        darray_item(type->level_names, level) = name;
        return true;
    }
    
    static bool
    SetLevelName(KeyTypesInfo *info, KeyTypeInfo *type, ExprDef *arrayNdx,
                 ExprDef *value)
    {
        xkb_level_index_t level;
        xkb_atom_t level_name;
        struct xkb_context *ctx = info->keymap->ctx;
    
        if (arrayNdx == NULL)
            return ReportTypeShouldBeArray(info, type, "level name");
    
        if (!ExprResolveLevel(ctx, arrayNdx, &level))
            return ReportTypeBadType(info, type, "level name", "integer");
    
        if (!ExprResolveString(ctx, value, &level_name)) {
            log_err(info->keymap->ctx,
                    "Non-string name for level %d in key type %s; "
                    "Ignoring illegal level name definition\n",
                    level + 1, xkb_atom_text(ctx, type->name));
            return false;
        }
    
        return AddLevelName(info, type, level, level_name, true);
    }
    
    /***====================================================================***/
    
    static bool
    SetKeyTypeField(KeyTypesInfo *info, KeyTypeInfo *type,
                    const char *field, ExprDef *arrayNdx, ExprDef *value)
    {
        bool ok = false;
        enum type_field type_field = 0;
    
        if (istreq(field, "modifiers")) {
            type_field = TYPE_FIELD_MASK;
            ok = SetModifiers(info, type, arrayNdx, value);
        }
        else if (istreq(field, "map")) {
            type_field = TYPE_FIELD_MAP;
            ok = SetMapEntry(info, type, arrayNdx, value);
        }
        else if (istreq(field, "preserve")) {
            type_field = TYPE_FIELD_PRESERVE;
            ok = SetPreserve(info, type, arrayNdx, value);
        }
        else if (istreq(field, "levelname") || istreq(field, "level_name")) {
            type_field = TYPE_FIELD_LEVEL_NAME;
            ok = SetLevelName(info, type, arrayNdx, value);
        } else {
            log_err(info->keymap->ctx,
                    "Unknown field %s in key type %s; Definition ignored\n",
                    field, TypeTxt(info, type));
        }
    
        type->defined |= type_field;
        return ok;
    }
    
    static bool
    HandleKeyTypeBody(KeyTypesInfo *info, VarDef *def, KeyTypeInfo *type)
    {
        bool ok = true;
        const char *elem, *field;
        ExprDef *arrayNdx;
    
        for (; def; def = (VarDef *) def->common.next) {
            ok = ExprResolveLhs(info->keymap->ctx, def->name, &elem, &field,
                                &arrayNdx);
            if (!ok)
                continue;
    
            if (elem && istreq(elem, "type")) {
                log_err(info->keymap->ctx,
                        "Support for changing the default type has been removed; "
                        "Statement ignored\n");
                continue;
            }
    
            ok = SetKeyTypeField(info, type, field, arrayNdx, def->value);
        }
    
        return ok;
    }
    
    static bool
    HandleKeyTypeDef(KeyTypesInfo *info, KeyTypeDef *def, enum merge_mode merge)
    {
        KeyTypeInfo type = {
            .defined = 0,
            .merge = (def->merge == MERGE_DEFAULT ? merge : def->merge),
            .name = def->name,
            .mods = 0,
            .num_levels = 1,
            .entries = darray_new(),
            .level_names = darray_new(),
        };
    
        if (!HandleKeyTypeBody(info, def->body, &type)) {
            info->errorCount++;
            return false;
        }
    
        if (!AddKeyType(info, &type, true)) {
            info->errorCount++;
            return false;
        }
    
        return true;
    }
    
    static void
    HandleKeyTypesFile(KeyTypesInfo *info, XkbFile *file, enum merge_mode merge)
    {
        bool ok;
    
        free(info->name);
        info->name = strdup_safe(file->name);
    
        for (ParseCommon *stmt = file->defs; stmt; stmt = stmt->next) {
            switch (stmt->type) {
            case STMT_INCLUDE:
                ok = HandleIncludeKeyTypes(info, (IncludeStmt *) stmt);
                break;
            case STMT_TYPE:
                ok = HandleKeyTypeDef(info, (KeyTypeDef *) stmt, merge);
                break;
            case STMT_VAR:
                log_err(info->keymap->ctx,
                        "Support for changing the default type has been removed; "
                        "Statement ignored\n");
                ok = true;
                break;
            case STMT_VMOD:
                ok = HandleVModDef(info->keymap, (VModDef *) stmt);
                break;
            default:
                log_err(info->keymap->ctx,
                        "Key type files may not include other declarations; "
                        "Ignoring %s\n", stmt_type_to_string(stmt->type));
                ok = false;
                break;
            }
    
            if (!ok)
                info->errorCount++;
    
            if (info->errorCount > 10) {
                log_err(info->keymap->ctx,
                        "Abandoning keytypes file \"%s\"\n", file->topName);
                break;
            }
        }
    }
    
    /***====================================================================***/
    
    static bool
    CopyKeyTypesToKeymap(struct xkb_keymap *keymap, KeyTypesInfo *info)
    {
        keymap->types_section_name = strdup_safe(info->name);
        XkbEscapeMapName(keymap->types_section_name);
    
        keymap->num_types = darray_size(info->types);
        if (keymap->num_types == 0)
            keymap->num_types = 1;
    
        keymap->types = calloc(keymap->num_types, sizeof(*keymap->types));
    
        /*
         * If no types were specified, a default unnamed one-level type is
         * used for all keys.
         */
        if (darray_empty(info->types)) {
            struct xkb_key_type *type = &keymap->types[0];
    
            type->mods.mods = 0;
            type->num_levels = 1;
            type->entries = NULL;
            type->num_entries = 0;
            type->name = xkb_atom_intern(keymap->ctx, "default");
            type->level_names = NULL;
    
            return true;
        }
    
        for (unsigned i = 0; i < keymap->num_types; i++) {
            KeyTypeInfo *def = &darray_item(info->types, i);
            struct xkb_key_type *type = &keymap->types[i];
    
            type->mods.mods = def->mods;
            type->num_levels = def->num_levels;
            type->entries = darray_mem(def->entries, 0);
            type->num_entries = darray_size(def->entries);
            darray_init(def->entries);
            type->name = def->name;
            type->level_names = darray_mem(def->level_names, 0);
            darray_init(def->level_names);
        }
    
        return true;
    }
    
    /***====================================================================***/
    
    bool
    CompileKeyTypes(XkbFile *file, struct xkb_keymap *keymap,
                    enum merge_mode merge)
    {
        KeyTypesInfo info;
    
        InitKeyTypesInfo(&info, keymap);
    
        HandleKeyTypesFile(&info, file, merge);
        if (info.errorCount != 0)
            goto err_info;
    
        if (!CopyKeyTypesToKeymap(keymap, &info))
            goto err_info;
    
        ClearKeyTypesInfo(&info);
        return true;
    
    err_info:
        ClearKeyTypesInfo(&info);
        return false;
    }