Edit

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

Branch :

  • Show log

    Commit

  • Author : Ran Benita
    Date : 2012-08-01 18:46:01
    Hash : 3bea189b
    Message : Make top level Handle*File functions nicer Signed-off-by: Ran Benita <ran234@gmail.com>

  • src/xkbcomp/keycodes.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 "expr.h"
    #include "parseutils.h"
    
    /*
     * The xkb_keycodes section
     * ========================
     *
     * This is the simplest section type, and is the first one to be
     * compiled. The purpose of this is mostly to map between the
     * hardware/evdev scancodes and xkb keycodes. Each key is given a name
     * of up to 4 letters, by which it can be referred to later, e.g. in the
     * symbols section.
     *
     * Minimum/Maximum keycode
     * -----------------------
     * Statements of the form:
     *      minimum = 8;
     *      maximum = 255;
     *
     * The file may explicitly declare the minimum and/or maximum keycode
     * contained therein (traditionally 8-255, inherited from old xfree86
     * keycodes). If these are stated explicitly, they are enforced. If
     * they are not stated, they are computed automatically.
     *
     * Keycode statements
     * ------------------
     * Statements of the form:
     *      <TLDE> = 49;
     *      <AE01> = 10;
     *
     * The above would let 49 and 10 be valid keycodes in the keymap, and
     * assign them the names TLDE and AE01 respectively. The format <WXYZ> is
     * always used to refer to a key by name.
     *
     * [ The naming convention <AE01> just denoted the position of the key
     * in the main alphanumric section of the keyboard, with the top left key
     * (usually "~") acting as origin. <AE01> is the key in the first row
     * second column (which is usually "1"). ]
     *
     * In the common case this just maps to the evdev scancodes from
     * /usr/include/linux/input.h, e.g. the following definitions:
     *      #define KEY_GRAVE            41
     *      #define KEY_1                2
     * Similar definitions appear in the xf86-input-keyboard driver. Note
     * that in all current keymaps there's a constant offset of 8 (for
     * historical reasons).
     *
     * If there's a conflict, like the same name given to different keycodes,
     * or same keycode given different names, it is resolved according to the
     * merge mode which applies to the definitions.
     *
     * The reason for the 4 characters limit is that the name is sometimes
     * converted to an unsigned long (in a direct mapping), instead of a char
     * array (see KeyNameToLong, LongToKeyName).
     *
     * Alias statements
     * ----------------
     * Statements of the form:
     *      alias <MENU> = <COMP>;
     *
     * Allows to refer to a previously defined key (here <COMP>) by another
     * name (here <MENU>). Conflicts are handled similarly.
     *
     * Indicator name statements
     * -------------------------
     * Statements of the form:
     *      indicator 1 = "Caps Lock";
     *      indicator 2 = "Num Lock";
     *      indicator 3 = "Scroll Lock";
     *
     * Assigns a name the indicator (i.e. keyboard LED) with the given index.
     * The amount of possible indicators is predetermined (XkbNumIndicators).
     * The indicator may be referred by this name later in the compat section
     * and by the user.
     *
     * Effect on the keymap
     * --------------------
     * After all of keycodes sections have been compiled, the following members
     * of struct xkb_keymap are finalized:
     *      xkb_keycode_t min_key_code;
     *      xkb_keycode_t max_key_code;
     *      darray(struct xkb_key_alias) key_aliases;
     *      const char *indicator_names[XkbNumIndicators];
     *      char *keycodes_section_name;
     * Further, the array of keys:
     *      darray(struct xkb_key) keys;
     * had been resized to its final size (i.e. all of the xkb_key objects are
     * referable by their keycode). However the objects themselves do not
     * contain any useful information besides the key name at this point.
     */
    
    typedef struct _AliasInfo {
        enum merge_mode merge;
        unsigned file_id;
        struct list entry;
    
        unsigned long alias;
        unsigned long real;
    } AliasInfo;
    
    typedef struct _IndicatorNameInfo {
        enum merge_mode merge;
        unsigned file_id;
        struct list entry;
    
        xkb_led_index_t ndx;
        xkb_atom_t name;
        bool virtual;
    } IndicatorNameInfo;
    
    typedef struct _KeyNamesInfo {
        char *name;     /* e.g. evdev+aliases(qwerty) */
        int errorCount;
        unsigned file_id;
        enum merge_mode merge;
        xkb_keycode_t computedMin; /* lowest keycode stored */
        xkb_keycode_t computedMax; /* highest keycode stored */
        xkb_keycode_t explicitMin;
        xkb_keycode_t explicitMax;
        darray(unsigned long) names;
        darray(unsigned int) files;
        struct list leds;
        struct list aliases;
    
        struct xkb_keymap *keymap;
    } KeyNamesInfo;
    
    static void
    ResizeKeyNameArrays(KeyNamesInfo *info, int newMax)
    {
        if (newMax < darray_size(info->names))
            return;
    
        darray_resize0(info->names, newMax + 1);
        darray_resize0(info->files, newMax + 1);
    }
    
    static void
    InitAliasInfo(AliasInfo *info, enum merge_mode merge, unsigned file_id,
                  char alias[XkbKeyNameLength], char real[XkbKeyNameLength])
    {
        memset(info, 0, sizeof(*info));
        info->merge = merge;
        info->file_id = file_id;
        info->alias = KeyNameToLong(alias);
        info->real = KeyNameToLong(real);
    }
    
    static void
    InitIndicatorNameInfo(IndicatorNameInfo * ii, KeyNamesInfo * info)
    {
        ii->merge = info->merge;
        ii->file_id = info->file_id;
        ii->ndx = 0;
        ii->name = XKB_ATOM_NONE;
        ii->virtual = false;
    }
    
    static IndicatorNameInfo *
    NextIndicatorName(KeyNamesInfo * info)
    {
        IndicatorNameInfo *ii;
    
        ii = malloc(sizeof(*ii));
        if (!ii)
            return NULL;
    
        InitIndicatorNameInfo(ii, info);
        list_append(&ii->entry, &info->leds);
    
        return ii;
    }
    
    static IndicatorNameInfo *
    FindIndicatorByIndex(KeyNamesInfo * info, xkb_led_index_t ndx)
    {
        IndicatorNameInfo *old;
    
        list_foreach(old, &info->leds, entry)
            if (old->ndx == ndx)
                return old;
    
        return NULL;
    }
    
    static IndicatorNameInfo *
    FindIndicatorByName(KeyNamesInfo * info, xkb_atom_t name)
    {
        IndicatorNameInfo *old;
    
        list_foreach(old, &info->leds, entry)
            if (old->name == name)
                return old;
    
        return NULL;
    }
    
    static bool
    AddIndicatorName(KeyNamesInfo *info, enum merge_mode merge,
                     IndicatorNameInfo *new)
    {
        IndicatorNameInfo *old;
        bool replace;
        int verbosity = xkb_get_log_verbosity(info->keymap->ctx);
    
        replace = (merge == MERGE_REPLACE) || (merge == MERGE_OVERRIDE);
    
        old = FindIndicatorByName(info, new->name);
        if (old) {
            if ((old->file_id == new->file_id && verbosity > 0) ||
                verbosity > 9) {
                if (old->ndx == new->ndx) {
                    if (old->virtual != new->virtual) {
                        if (replace)
                            old->virtual = new->virtual;
                        log_warn(info->keymap->ctx, "Multiple indicators named %s; "
                                 "Using %s instead of %s\n",
                                 xkb_atom_text(info->keymap->ctx, new->name),
                                 (old->virtual ? "virtual" : "real"),
                                 (old->virtual ? "real" : "virtual"));
                    }
                    else {
                        log_warn(info->keymap->ctx, "Multiple indicators named %s; "
                                 "Identical definitions ignored\n",
                                 xkb_atom_text(info->keymap->ctx, new->name));
                    }
                    return true;
                }
                else {
                    log_warn(info->keymap->ctx, "Multiple indicators named %s; "
                             "Using %d, ignoring %d\n",
                             xkb_atom_text(info->keymap->ctx, new->name),
                             (replace ? old->ndx : new->ndx),
                             (replace ? new->ndx : old->ndx));
                }
    
                if (replace) {
                    list_del(&old->entry);
                    free(old);
                }
            }
        }
    
        old = FindIndicatorByIndex(info, new->ndx);
        if (old) {
            if ((old->file_id == new->file_id && verbosity > 0) ||
                verbosity > 9) {
                if (old->name == new->name && old->virtual == new->virtual) {
                    log_warn(info->keymap->ctx,
                             "Multiple names for indicator %d; "
                             "Identical definitions ignored\n", new->ndx);
                } else {
                    const char *oldType, *newType;
                    xkb_atom_t using, ignoring;
                    if (old->virtual)
                        oldType = "virtual indicator";
                    else
                        oldType = "real indicator";
                    if (new->virtual)
                        newType = "virtual indicator";
                    else
                        newType = "real indicator";
                    if (replace) {
                        using = new->name;
                        ignoring = old->name;
                    }
                    else {
                        using = old->name;
                        ignoring = new->name;
                    }
                    log_warn(info->keymap->ctx,
                             "Multiple names for indicator %d; "
                             "Using %s %s, ignoring %s %s\n",
                             new->ndx,
                             oldType, xkb_atom_text(info->keymap->ctx, using),
                             newType, xkb_atom_text(info->keymap->ctx, ignoring));
                }
            }
            if (replace) {
                old->name = new->name;
                old->virtual = new->virtual;
            }
            return true;
        }
        old = new;
        new = NextIndicatorName(info);
        if (!new) {
            log_wsgo(info->keymap->ctx,
                     "Couldn't allocate name for indicator %d; Ignored\n",
                     old->ndx);
            return false;
        }
        new->name = old->name;
        new->ndx = old->ndx;
        new->virtual = old->virtual;
        return true;
    }
    
    static void
    ClearKeyNamesInfo(KeyNamesInfo * info)
    {
        AliasInfo *alias, *next_alias;
        IndicatorNameInfo *ii, *next_ii;
    
        free(info->name);
        info->name = NULL;
        info->merge = MERGE_DEFAULT;
        info->computedMax = info->explicitMax = info->explicitMin = 0;
        info->computedMin = XKB_KEYCODE_MAX;
        darray_free(info->names);
        darray_free(info->files);
        list_foreach_safe(ii, next_ii, &info->leds, entry)
            free(ii);
        list_init(&info->leds);
        list_foreach_safe(alias, next_alias, &info->aliases, entry)
            free(alias);
        list_init(&info->aliases);
    }
    
    static void
    InitKeyNamesInfo(KeyNamesInfo *info, struct xkb_keymap *keymap,
                     unsigned file_id)
    {
        info->name = NULL;
        info->merge = MERGE_DEFAULT;
        list_init(&info->leds);
        list_init(&info->aliases);
        info->file_id = file_id;
        darray_init(info->names);
        darray_init(info->files);
        ClearKeyNamesInfo(info);
        info->errorCount = 0;
        info->keymap = keymap;
    }
    
    static int
    FindKeyByLong(KeyNamesInfo * info, unsigned long name)
    {
        xkb_keycode_t i;
    
        for (i = info->computedMin; i <= info->computedMax; i++)
            if (darray_item(info->names, i) == name)
                return i;
    
        return 0;
    }
    
    /**
     * Store the name of the key as a long in the info struct under the given
     * keycode. If the same keys is referred to twice, print a warning.
     * Note that the key's name is stored as a long, the keycode is the index.
     */
    static bool
    AddKeyName(KeyNamesInfo *info, xkb_keycode_t kc, unsigned long name,
               enum merge_mode merge, unsigned file_id, bool reportCollisions)
    {
        xkb_keycode_t old;
        int verbosity = xkb_get_log_verbosity(info->keymap->ctx);
    
        ResizeKeyNameArrays(info, kc);
    
        if (kc < info->computedMin)
            info->computedMin = kc;
        if (kc > info->computedMax)
            info->computedMax = kc;
    
        if (reportCollisions)
            reportCollisions = (verbosity > 7 ||
                                (verbosity > 0 &&
                                 file_id == darray_item(info->files, kc)));
    
        if (darray_item(info->names, kc) != 0) {
            const char *lname = LongKeyNameText(darray_item(info->names, kc));
            const char *kname = LongKeyNameText(name);
    
            if (darray_item(info->names, kc) == name && reportCollisions) {
                log_warn(info->keymap->ctx,
                         "Multiple identical key name definitions; "
                         "Later occurences of \"%s = %d\" ignored\n", lname, kc);
                return true;
            }
    
            if (merge == MERGE_AUGMENT) {
                if (reportCollisions)
                    log_warn(info->keymap->ctx,
                             "Multiple names for keycode %d; "
                             "Using %s, ignoring %s\n", kc, lname, kname);
                return true;
            }
            else {
                if (reportCollisions)
                    log_warn(info->keymap->ctx,
                             "Multiple names for keycode %d; "
                             "Using %s, ignoring %s\n", kc, kname, lname);
                darray_item(info->names, kc) = 0;
                darray_item(info->files, kc) = 0;
            }
        }
    
        old = FindKeyByLong(info, name);
        if (old != 0 && old != kc) {
            const char *kname = LongKeyNameText(name);
    
            if (merge == MERGE_OVERRIDE) {
                darray_item(info->names, old) = 0;
                darray_item(info->files, old) = 0;
                if (reportCollisions)
                    log_warn(info->keymap->ctx,
                             "Key name %s assigned to multiple keys; "
                             "Using %d, ignoring %d\n", kname, kc, old);
            }
            else {
                if (reportCollisions && verbosity > 3)
                    log_warn(info->keymap->ctx,
                             "Key name %s assigned to multiple keys; "
                             "Using %d, ignoring %d\n", kname, old, kc);
                return true;
            }
        }
    
        darray_item(info->names, kc) = name;
        darray_item(info->files, kc) = file_id;
        return true;
    }
    
    /***====================================================================***/
    
    static int
    HandleAliasDef(KeyNamesInfo *info, KeyAliasDef *def, enum merge_mode merge,
                   unsigned file_id);
    
    static bool
    MergeAliases(KeyNamesInfo *into, KeyNamesInfo *from, enum merge_mode merge)
    {
        AliasInfo *alias, *next;
        KeyAliasDef def;
    
        if (list_empty(&from->aliases))
            return true;
    
        if (list_empty(&into->aliases)) {
            list_replace(&from->aliases, &into->aliases);
            list_init(&from->aliases);
            return true;
        }
    
        memset(&def, 0, sizeof(def));
    
        list_foreach_safe(alias, next, &from->aliases, entry) {
            def.merge = (merge == MERGE_DEFAULT) ? alias->merge : merge;
            LongToKeyName(alias->alias, def.alias);
            LongToKeyName(alias->real, def.real);
    
            if (!HandleAliasDef(into, &def, def.merge, alias->file_id))
                return false;
        }
    
        return true;
    }
    
    static void
    MergeIncludedKeycodes(KeyNamesInfo *into, KeyNamesInfo *from,
                          enum merge_mode merge)
    {
        xkb_keycode_t i;
        IndicatorNameInfo *led;
    
        if (from->errorCount > 0) {
            into->errorCount += from->errorCount;
            return;
        }
    
        if (into->name == NULL) {
            into->name = from->name;
            from->name = NULL;
        }
    
        ResizeKeyNameArrays(into, from->computedMax);
    
        for (i = from->computedMin; i <= from->computedMax; i++) {
            unsigned long name = darray_item(from->names, i);
            if (name == 0)
                continue;
    
            if (!AddKeyName(into, i, name, merge, from->file_id, false))
                into->errorCount++;
        }
    
        list_foreach(led, &from->leds, entry) {
            led->merge = (merge == MERGE_DEFAULT ? led->merge : merge);
            if (!AddIndicatorName(into, led->merge, led))
                into->errorCount++;
        }
    
        if (!MergeAliases(into, from, merge))
            into->errorCount++;
    
        if (from->explicitMin != 0)
            if (into->explicitMin == 0 || into->explicitMin > from->explicitMin)
                into->explicitMin = from->explicitMin;
    
        if (from->explicitMax > 0)
            if (into->explicitMax == 0 || into->explicitMax < from->explicitMax)
                into->explicitMax = from->explicitMax;
    }
    
    static void
    HandleKeycodesFile(KeyNamesInfo *info, XkbFile *file, enum merge_mode merge);
    
    /**
     * Handle the given include statement (e.g. "include "evdev+aliases(qwerty)").
     *
     * @param info Struct to store the key info in.
     * @param stmt The include statement from the keymap file.
     */
    static bool
    HandleIncludeKeycodes(KeyNamesInfo *info, IncludeStmt *stmt)
    {
        enum merge_mode merge = MERGE_DEFAULT;
        XkbFile *rtrn;
        KeyNamesInfo included, next_incl;
    
        /* XXX: What's that? */
        if (stmt->file && streq(stmt->file, "computed")) {
            info->keymap->flags |= AutoKeyNames;
            info->explicitMin = 0;
            info->explicitMax = XKB_KEYCODE_MAX;
            return (info->errorCount == 0);
        }
    
        InitKeyNamesInfo(&included, info->keymap, info->file_id);
        if (stmt->stmt) {
            free(included.name);
            included.name = stmt->stmt;
            stmt->stmt = NULL;
        }
    
        for (; stmt; stmt = stmt->next_incl) {
            if (!ProcessIncludeFile(info->keymap->ctx, stmt, FILE_TYPE_KEYCODES,
                                    &rtrn, &merge)) {
                info->errorCount += 10;
                ClearKeyNamesInfo(&included);
                return false;
            }
    
            InitKeyNamesInfo(&next_incl, info->keymap, rtrn->id);
    
            HandleKeycodesFile(&next_incl, rtrn, MERGE_OVERRIDE);
    
            MergeIncludedKeycodes(&included, &next_incl, merge);
    
            ClearKeyNamesInfo(&next_incl);
            FreeXKBFile(rtrn);
        }
    
        MergeIncludedKeycodes(info, &included, merge);
        ClearKeyNamesInfo(&included);
    
        return (info->errorCount == 0);
    }
    
    /**
     * Parse the given statement and store the output in the info struct.
     * e.g. <ESC> = 9
     */
    static int
    HandleKeycodeDef(KeyNamesInfo *info, KeycodeDef *stmt, enum merge_mode merge)
    {
        if ((info->explicitMin != 0 && stmt->value < info->explicitMin) ||
            (info->explicitMax != 0 && stmt->value > info->explicitMax)) {
            log_err(info->keymap->ctx,
                    "Illegal keycode %lu for name %s; "
                    "Must be in the range %d-%d inclusive\n",
                    stmt->value, KeyNameText(stmt->name), info->explicitMin,
                    info->explicitMax ? info->explicitMax : XKB_KEYCODE_MAX);
            return 0;
        }
    
        if (stmt->merge != MERGE_DEFAULT) {
            if (stmt->merge == MERGE_REPLACE)
                merge = MERGE_OVERRIDE;
            else
                merge = stmt->merge;
        }
    
        return AddKeyName(info, stmt->value, KeyNameToLong(stmt->name), merge,
                          info->file_id, true);
    }
    
    static void
    HandleAliasCollision(KeyNamesInfo *info, AliasInfo *old, AliasInfo *new)
    {
        int verbosity = xkb_get_log_verbosity(info->keymap->ctx);
    
        if (new->real == old->real) {
            if ((new->file_id == old->file_id && verbosity > 0) || verbosity > 9)
                log_warn(info->keymap->ctx,
                         "Alias of %s for %s declared more than once; "
                         "First definition ignored\n",
                         LongKeyNameText(new->alias), LongKeyNameText(new->real));
        }
        else {
            unsigned long use, ignore;
    
            if (new->merge == MERGE_AUGMENT) {
                use = old->real;
                ignore = new->real;
            }
            else {
                use = new->real;
                ignore = old->real;
            }
    
            if ((old->file_id == new->file_id && verbosity > 0) || verbosity > 9)
                log_warn(info->keymap->ctx,
                         "Multiple definitions for alias %s; "
                         "Using %s, ignoring %s\n",
                         LongKeyNameText(old->alias), LongKeyNameText(use),
                         LongKeyNameText(ignore));
    
            if (use != old->real)
                old->real = use;
        }
    
        old->file_id = new->file_id;
        old->merge = new->merge;
    }
    
    static int
    HandleAliasDef(KeyNamesInfo *info, KeyAliasDef *def, enum merge_mode merge,
                   unsigned file_id)
    {
        AliasInfo *alias;
    
        list_foreach(alias, &info->aliases, entry) {
            if (alias->alias == KeyNameToLong(def->alias)) {
                AliasInfo new;
                InitAliasInfo(&new, merge, file_id, def->alias, def->real);
                HandleAliasCollision(info, alias, &new);
                return true;
            }
        }
    
        alias = calloc(1, sizeof(*alias));
        if (!alias) {
            log_wsgo(info->keymap->ctx, "Allocation failure in HandleAliasDef\n");
            return false;
        }
    
        alias->file_id = file_id;
        alias->merge = merge;
        alias->alias = KeyNameToLong(def->alias);
        alias->real = KeyNameToLong(def->real);
        list_append(&alias->entry, &info->aliases);
    
        return true;
    }
    
    #define MIN_KEYCODE_DEF 0
    #define MAX_KEYCODE_DEF 1
    
    /**
     * Handle the minimum/maximum statement of the xkb file.
     * Sets explicitMin/Max of the info struct.
     *
     * @return 1 on success, 0 otherwise.
     */
    static int
    HandleKeyNameVar(KeyNamesInfo *info, VarDef *stmt)
    {
        const char *elem, *field;
        xkb_keycode_t kc;
        ExprDef *arrayNdx;
        int which;
    
        if (!ExprResolveLhs(info->keymap->ctx, stmt->name, &elem, &field,
                            &arrayNdx))
            return false;               /* internal error, already reported */
    
        if (elem) {
            log_err(info->keymap->ctx,
                    "Unknown element %s encountered; "
                    "Default for field %s ignored\n", elem, field);
            return false;
        }
    
        if (istreq(field, "minimum")) {
            which = MIN_KEYCODE_DEF;
        }
        else if (istreq(field, "maximum")) {
            which = MAX_KEYCODE_DEF;
        }
        else {
            log_err(info->keymap->ctx,
                    "Unknown field encountered; "
                    "Assigment to field %s ignored\n", field);
            return false;
        }
    
        if (arrayNdx != NULL) {
            log_err(info->keymap->ctx,
                    "The %s setting is not an array; "
                    "Illegal array reference ignored\n", field);
            return false;
        }
    
        if (!ExprResolveKeyCode(info->keymap->ctx, stmt->value, &kc)) {
            log_err(info->keymap->ctx,
                    "Illegal keycode encountered; "
                    "Assignment to field %s ignored\n", field);
            return false;
        }
    
        if (kc > XKB_KEYCODE_MAX) {
            log_err(info->keymap->ctx,
                    "Illegal keycode %d (must be in the range %d-%d inclusive); "
                    "Value of \"%s\" not changed\n",
                    kc, 0, XKB_KEYCODE_MAX, field);
            return false;
        }
    
        if (which == MIN_KEYCODE_DEF) {
            if (info->explicitMax > 0 && info->explicitMax < kc) {
                log_err(info->keymap->ctx,
                        "Minimum key code (%d) must be <= maximum key code (%d); "
                        "Minimum key code value not changed\n",
                        kc, info->explicitMax);
                return false;
            }
    
            if (info->computedMax > 0 && info->computedMin < kc) {
                log_err(info->keymap->ctx,
                        "Minimum key code (%d) must be <= lowest defined key (%d); "
                        "Minimum key code value not changed\n",
                        kc, info->computedMin);
                return false;
            }
    
            info->explicitMin = kc;
        }
        else if (which == MAX_KEYCODE_DEF) {
            if (info->explicitMin > 0 && info->explicitMin > kc) {
                log_err(info->keymap->ctx,
                        "Maximum code (%d) must be >= minimum key code (%d); "
                        "Maximum code value not changed\n",
                        kc, info->explicitMin);
                return false;
            }
    
            if (info->computedMax > 0 && info->computedMax > kc) {
                log_err(info->keymap->ctx,
                        "Maximum code (%d) must be >= highest defined key (%d); "
                        "Maximum code value not changed\n",
                        kc, info->computedMax);
                return false;
            }
    
            info->explicitMax = kc;
        }
    
        return true;
    }
    
    static int
    HandleIndicatorNameDef(KeyNamesInfo *info, IndicatorNameDef *def,
                           enum merge_mode merge)
    {
        IndicatorNameInfo ii;
        const char *str;
    
        if (def->ndx < 1 || def->ndx > XkbNumIndicators) {
            info->errorCount++;
            log_err(info->keymap->ctx,
                    "Name specified for illegal indicator index %d\n; Ignored\n",
                    def->ndx);
            return false;
        }
    
        InitIndicatorNameInfo(&ii, info);
    
        if (!ExprResolveString(info->keymap->ctx, def->name, &str)) {
            char buf[20];
            snprintf(buf, sizeof(buf), "%d", def->ndx);
            info->errorCount++;
            return ReportBadType(info->keymap, "indicator", "name", buf,
                                 "string");
        }
    
        ii.ndx = (xkb_led_index_t) def->ndx;
        ii.name = xkb_atom_intern(info->keymap->ctx, str);
        ii.virtual = def->virtual;
    
        return AddIndicatorName(info, merge, &ii);
    }
    
    /**
     * Handle the xkb_keycodes section of a xkb file.
     * All information about parsed keys is stored in the info struct.
     *
     * Such a section may have include statements, in which case this function is
     * semi-recursive (it calls HandleIncludeKeycodes, which may call
     * HandleKeycodesFile again).
     *
     * @param info Struct to contain the fully parsed key information.
     * @param file The input file (parsed xkb_keycodes section)
     * @param merge Merge strategy (MERGE_OVERRIDE, etc.)
     */
    static void
    HandleKeycodesFile(KeyNamesInfo *info, XkbFile *file, enum merge_mode merge)
    {
        ParseCommon *stmt;
        bool ok;
    
        free(info->name);
        info->name = strdup_safe(file->name);
    
        for (stmt = file->defs; stmt; stmt = stmt->next) {
            switch (stmt->type) {
            case STMT_INCLUDE:    /* e.g. include "evdev+aliases(qwerty)" */
                ok = HandleIncludeKeycodes(info, (IncludeStmt *) stmt);
                break;
            case STMT_KEYCODE: /* e.g. <ESC> = 9; */
                ok = HandleKeycodeDef(info, (KeycodeDef *) stmt, merge);
                break;
            case STMT_ALIAS: /* e.g. alias <MENU> = <COMP>; */
                ok = HandleAliasDef(info, (KeyAliasDef *) stmt, merge,
                                    info->file_id);
                break;
            case STMT_VAR: /* e.g. minimum, maximum */
                ok = HandleKeyNameVar(info, (VarDef *) stmt);
                break;
            case STMT_INDICATOR_NAME: /* e.g. indicator 1 = "Caps Lock"; */
                ok = HandleIndicatorNameDef(info, (IndicatorNameDef *) stmt,
                                            merge);
                break;
            default:
                log_err(info->keymap->ctx,
                        "Keycode files may define key and indicator names only; "
                        "Ignoring %s\n", StmtTypeToString(stmt->type));
                ok = false;
                break;
            }
    
            if (!ok)
                info->errorCount++;
    
            if (info->errorCount > 10) {
                log_err(info->keymap->ctx, "Abandoning keycodes file \"%s\"\n",
                        file->topName);
                break;
            }
        }
    }
    
    static int
    ApplyAliases(KeyNamesInfo *info)
    {
        int i;
        struct xkb_key *key;
        struct xkb_key_alias *old, *a;
        AliasInfo *alias, *next;
        int nNew = 0, nOld;
        struct xkb_keymap *keymap = info->keymap;
    
        nOld = darray_size(keymap->key_aliases);
        old = &darray_item(keymap->key_aliases, 0);
    
        list_foreach(alias, &info->aliases, entry) {
            key = FindNamedKey(keymap, alias->real, false,
                               CreateKeyNames(keymap), 0);
            if (!key) {
                log_lvl(info->keymap->ctx, 5,
                        "Attempt to alias %s to non-existent key %s; Ignored\n",
                        LongKeyNameText(alias->alias),
                        LongKeyNameText(alias->real));
                alias->alias = 0;
                continue;
            }
    
            key = FindNamedKey(keymap, alias->alias, false, false, 0);
            if (key) {
                log_lvl(info->keymap->ctx, 5,
                        "Attempt to create alias with the name of a real key; "
                        "Alias \"%s = %s\" ignored\n",
                        LongKeyNameText(alias->alias),
                        LongKeyNameText(alias->real));
                alias->alias = 0;
                continue;
            }
    
            nNew++;
    
            if (!old)
                continue;
    
            for (i = 0, a = old; i < nOld; i++, a++) {
                AliasInfo old_alias;
    
                if (KeyNameToLong(a->alias) == alias->alias)
                    continue;
    
                InitAliasInfo(&old_alias, MERGE_AUGMENT, 0, a->alias, a->real);
                HandleAliasCollision(info, &old_alias, alias);
                old_alias.real = KeyNameToLong(a->real);
                alias->alias = 0;
                nNew--;
                break;
            }
        }
    
        if (nNew == 0)
            goto out;
    
        darray_resize0(keymap->key_aliases, nOld + nNew);
    
        a = &darray_item(keymap->key_aliases, nOld);
        list_foreach(alias, &info->aliases, entry) {
            if (alias->alias != 0) {
                LongToKeyName(alias->alias, a->alias);
                LongToKeyName(alias->real, a->real);
                a++;
            }
        }
    
    out:
        list_foreach_safe(alias, next, &info->aliases, entry)
            free(alias);
        list_init(&info->aliases);
        return true;
    }
    
    /**
     * Compile the xkb_keycodes section, parse it's output, return the results.
     *
     * @param file The parsed XKB file (may have include statements requiring
     * further parsing)
     * @param result The effective keycodes, as gathered from the file.
     * @param merge Merge strategy.
     *
     * @return true on success, false otherwise.
     */
    bool
    CompileKeycodes(XkbFile *file, struct xkb_keymap *keymap,
                    enum merge_mode merge)
    {
        xkb_keycode_t kc;
        KeyNamesInfo info; /* contains all the info after parsing */
        IndicatorNameInfo *ii;
    
        InitKeyNamesInfo(&info, keymap, file->id);
    
        HandleKeycodesFile(&info, file, merge);
    
        /* all the keys are now stored in info */
    
        if (info.errorCount != 0)
            goto err_info;
    
        if (info.explicitMin > 0) /* if "minimum" statement was present */
            keymap->min_key_code = info.explicitMin;
        else
            keymap->min_key_code = info.computedMin;
    
        if (info.explicitMax > 0) /* if "maximum" statement was present */
            keymap->max_key_code = info.explicitMax;
        else
            keymap->max_key_code = info.computedMax;
    
        darray_resize0(keymap->keys, keymap->max_key_code + 1);
        for (kc = info.computedMin; kc <= info.computedMax; kc++)
            LongToKeyName(darray_item(info.names, kc),
                          XkbKey(keymap, kc)->name);
    
        keymap->keycodes_section_name = strdup_safe(info.name);
    
        list_foreach(ii, &info.leds, entry)
            keymap->indicator_names[ii->ndx - 1] =
                xkb_atom_text(keymap->ctx, ii->name);
    
        ApplyAliases(&info);
    
        ClearKeyNamesInfo(&info);
        return true;
    
    err_info:
        ClearKeyNamesInfo(&info);
        return false;
    }