File: rulescomp.c

package info (click to toggle)
libxkbcommon 1.12.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 8,184 kB
  • sloc: ansic: 57,023; xml: 8,785; python: 7,449; yacc: 913; sh: 253; makefile: 23
file content (332 lines) | stat: -rw-r--r-- 13,637 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
/*
 * Copyright © 2009 Dan Nicholson
 * SPDX-License-Identifier: MIT
 */

#include "config.h"

#include <assert.h>

#include "xkbcommon/xkbcommon.h"

#include "evdev-scancodes.h"
#include "src/keymap.h"
#include "src/keysym.h"
#include "test.h"
#include "utils.h"

/* xkb_rule_names API */
static int
test_rmlvo_va(struct xkb_context *context, enum xkb_keymap_format format,
              const char *rules, const char *model, const char *layout,
              const char *variant, const char *options, va_list ap)
{
    struct xkb_keymap * const keymap =
        test_compile_rules(context, format, rules, model, layout, variant, options);
    if (!keymap)
        return 0;

    fprintf(stderr, "Compiled '%s' '%s' '%s' '%s' '%s'\n",
            strnull(rules), strnull(model), strnull(layout),
            strnull(variant), strnull(options));

    const int ret = test_key_seq_va(keymap, ap);

    xkb_keymap_unref(keymap);

    return ret;
}

/* xkb_rmlvo_builder API */
static int
test_rmlvo_builder_va(struct xkb_context *context, enum xkb_keymap_format format,
                      const char *rules, const char *model, const char *layout,
                      const char *variant, const char *options, va_list ap)
{
    struct xkb_keymap * const keymap =
        test_compile_rmlvo(context, format, rules, model, layout, variant, options);
    if (!keymap)
        return 0;

    fprintf(stderr, "Compiled '%s' '%s' '%s' '%s' '%s'\n",
            strnull(rules), strnull(model), strnull(layout),
            strnull(variant), strnull(options));

    const int ret = test_key_seq_va(keymap, ap);

    xkb_keymap_unref(keymap);

    return ret;
}

static int
test_rmlvo(struct xkb_context *context, enum xkb_keymap_format format,
           const char *rules, const char *model, const char *layout,
           const char *variant, const char *options, ...)
{
    va_list ap;
    int ret;

    va_start(ap, options);
    ret = test_rmlvo_va(context, format, rules, model, layout, variant, options, ap);
    va_end(ap);

    va_start(ap, options);
    ret &= test_rmlvo_builder_va(context, format,
                                 rules, model, layout, variant, options, ap);
    va_end(ap);

    return ret;
}

static int
test_rmlvo_env(struct xkb_context *ctx, enum xkb_keymap_format format,
               const char *rules, const char *model, const char *layout,
               const char *variant, const char *options, ...)
{
    va_list ap;
    int ret;

    va_start (ap, options);

    if (!isempty(rules))
        setenv("XKB_DEFAULT_RULES", rules, 1);
    else
        unsetenv("XKB_DEFAULT_RULES");

    if (!isempty(model))
        setenv("XKB_DEFAULT_MODEL", model, 1);
    else
        unsetenv("XKB_DEFAULT_MODEL");

    if (!isempty(layout))
        setenv("XKB_DEFAULT_LAYOUT", layout, 1);
    else
        unsetenv("XKB_DEFAULT_LAYOUT");

    if (!isempty(variant))
        setenv("XKB_DEFAULT_VARIANT", variant, 1);
    else
        unsetenv("XKB_DEFAULT_VARIANT");

    if (!isempty(options))
        setenv("XKB_DEFAULT_OPTIONS", options, 1);
    else
        unsetenv("XKB_DEFAULT_OPTIONS");

    ret = test_rmlvo_va(ctx, format, NULL, NULL, NULL, NULL, NULL, ap);

    va_end(ap);

    return ret;
}

/* Test more than 4 groups */
static void
test_extended_groups(struct xkb_context *ctx)
{
    struct {
        enum xkb_keymap_format format;
        xkb_layout_index_t num_layouts;
        const char *layouts;
    } tests[] = {
        /* v1: 4 groups */
        {
            .format = XKB_KEYMAP_FORMAT_TEXT_V1,
            .layouts = "cz,us,ca,de",
            .num_layouts = XKB_MAX_GROUPS_X11
        },
        /* v1: 5 groups, discard 1 group */
        {
            .format = XKB_KEYMAP_FORMAT_TEXT_V1,
            .layouts = "cz,us,ca,de,in",
            .num_layouts = XKB_MAX_GROUPS_X11
        },
        /* v2: 5 groups */
        {
            .format = XKB_KEYMAP_FORMAT_TEXT_V2,
            .layouts = "cz,us,ca,de,in",
            .num_layouts = XKB_MAX_GROUPS_X11 + 1
        },
        /* v2: 32 groups */
        {
            .format = XKB_KEYMAP_FORMAT_TEXT_V2,
            .layouts = "cz,us,ca,de,in,cz,us,ca,de,in,cz,us,ca,de,in,"
                       "cz,us,ca,de,in,cz,us,ca,de,in,cz,us,ca,de,in,"
                       "cz,us",
            .num_layouts = XKB_MAX_GROUPS
        },
        /* v2: 33 groups, discard 1 group */
        {
            .format = XKB_KEYMAP_FORMAT_TEXT_V2,
            .layouts = "cz,us,ca,de,in,cz,us,ca,de,in,cz,us,ca,de,in,"
                       "cz,us,ca,de,in,cz,us,ca,de,in,cz,us,ca,de,in,"
                       "cz,us,ca",
            .num_layouts = XKB_MAX_GROUPS
        },
    };

    for (size_t k = 0; k < ARRAY_SIZE(tests); k++) {
        fprintf(stderr, "------\n*** %s: #%zu ***\n", __func__, k);
        struct xkb_keymap *keymap =
            test_compile_rules(ctx, tests[k].format, "evdev-modern",
                               "pc105", tests[k].layouts, NULL, NULL);
        assert(keymap);
        assert(xkb_keymap_num_layouts(keymap) == tests[k].num_layouts);
        xkb_keymap_unref(keymap);
    }

#define U(cp) (XKB_KEYSYM_UNICODE_OFFSET + (cp))
    assert(test_rmlvo_env(ctx, XKB_KEYMAP_FORMAT_TEXT_V2, "evdev-modern",
                          "", "cz,us,ca,de,in,ru,il", ",,,,,phonetic,",
                          "grp:menu_toggle",
                          KEY_2,          BOTH, XKB_KEY_ecaron,           NEXT,
                          KEY_COMPOSE,    BOTH, XKB_KEY_ISO_Next_Group,   NEXT,
                          KEY_Y,          BOTH, XKB_KEY_y,                NEXT,
                          KEY_COMPOSE,    BOTH, XKB_KEY_ISO_Next_Group,   NEXT,
                          KEY_102ND,      BOTH, XKB_KEY_guillemetleft,    NEXT,
                          KEY_COMPOSE,    BOTH, XKB_KEY_ISO_Next_Group,   NEXT,
                          KEY_Y,          BOTH, XKB_KEY_z,                NEXT,
                          KEY_COMPOSE,    BOTH, XKB_KEY_ISO_Next_Group,   NEXT,
                          KEY_Y,          BOTH, U(0x092c),                NEXT,
                          KEY_COMPOSE,    BOTH, XKB_KEY_ISO_Next_Group,   NEXT,
                          KEY_Y,          BOTH, XKB_KEY_Cyrillic_ze,      NEXT,
                          KEY_COMPOSE,    BOTH, XKB_KEY_ISO_Next_Group,   NEXT,
                          KEY_Y,          BOTH, XKB_KEY_hebrew_tet,       FINISH));
#undef U
}

int
main(int argc, char *argv[])
{
    test_init();

    struct xkb_context *ctx = test_get_context(CONTEXT_ALLOW_ENVIRONMENT_NAMES);

    assert(ctx);

#define KS(name) xkb_keysym_from_name(name, 0)

    assert(test_rmlvo(ctx, XKB_KEYMAP_FORMAT_TEXT_V1, "evdev",
                      "pc105", "us,il,ru,ca", ",,,multix",
                      "grp:alts_toggle,ctrl:nocaps,compose:rwin",
                      KEY_Q,          BOTH, XKB_KEY_q,                    NEXT,
                      KEY_LEFTALT,    DOWN, XKB_KEY_Alt_L,                NEXT,
                      KEY_RIGHTALT,   DOWN, XKB_KEY_ISO_Next_Group,       NEXT,
                      KEY_RIGHTALT,   UP,   XKB_KEY_ISO_Level3_Shift,     NEXT,
                      KEY_LEFTALT,    UP,   XKB_KEY_Alt_L,                NEXT,
                      KEY_Q,          BOTH, XKB_KEY_slash,                NEXT,
                      KEY_LEFTSHIFT,  DOWN, XKB_KEY_Shift_L,              NEXT,
                      KEY_Q,          BOTH, XKB_KEY_Q,                    NEXT,
                      KEY_RIGHTMETA,  BOTH, XKB_KEY_Multi_key,            FINISH));
    assert(test_rmlvo(ctx, XKB_KEYMAP_FORMAT_TEXT_V1, "evdev",
                      "pc105", "us,in", "", "grp:alts_toggle",
                      KEY_A,          BOTH, XKB_KEY_a,                    NEXT,
                      KEY_LEFTALT,    DOWN, XKB_KEY_Alt_L,                NEXT,
                      KEY_RIGHTALT,   DOWN, XKB_KEY_ISO_Next_Group,       NEXT,
                      KEY_RIGHTALT,   UP,   XKB_KEY_ISO_Level3_Shift,     NEXT,
                      KEY_LEFTALT,    UP,   XKB_KEY_Alt_L,                NEXT,
                      KEY_A,          BOTH, KS("U094b"),                  FINISH));
    assert(test_rmlvo(ctx, XKB_KEYMAP_FORMAT_TEXT_V1, "evdev",
                      "pc105", "us", "intl", "",
                      KEY_GRAVE,      BOTH,  XKB_KEY_dead_grave,          FINISH));
    assert(test_rmlvo(ctx, XKB_KEYMAP_FORMAT_TEXT_V1, "evdev",
                      "pc105", "us", "intl", "grp:alts_toggle",
                      KEY_GRAVE,      BOTH,  XKB_KEY_dead_grave,          FINISH));

    /* 33 is not a legal group; make sure this is handled gracefully. */
#define EXCESSIVE_GROUPS 33
    static_assert(EXCESSIVE_GROUPS > XKB_MAX_GROUPS, "Test upgrade required");
    assert(test_rmlvo(ctx, XKB_KEYMAP_FORMAT_TEXT_V2, "evdev",
                      "", "us:" STRINGIFY(EXCESSIVE_GROUPS), "", "",
                      KEY_A,          BOTH, XKB_KEY_a,                    FINISH));
#undef EXCESSIVE_GROUPS

    /* Don't choke on missing values in RMLVO. Should just skip them.
       Currently generates us,us,ca. */
    assert(test_rmlvo(ctx, XKB_KEYMAP_FORMAT_TEXT_V1, "evdev",
                      "", "us,,ca", "", "grp:alts_toggle",
                      KEY_A,          BOTH, XKB_KEY_a,                    NEXT,
                      KEY_LEFTALT,    DOWN, XKB_KEY_Alt_L,                NEXT,
                      KEY_RIGHTALT,   DOWN, XKB_KEY_ISO_Next_Group,       NEXT,
                      KEY_RIGHTALT,   UP,   XKB_KEY_ISO_Next_Group,       NEXT,
                      KEY_LEFTALT,    UP,   XKB_KEY_Alt_L,                NEXT,
                      KEY_LEFTALT,    DOWN, XKB_KEY_Alt_L,                NEXT,
                      KEY_RIGHTALT,   DOWN, XKB_KEY_ISO_Next_Group,       NEXT,
                      KEY_RIGHTALT,   UP,   XKB_KEY_ISO_Level3_Shift,     NEXT,
                      KEY_LEFTALT,    UP,   XKB_KEY_Alt_L,                NEXT,
                      KEY_APOSTROPHE, BOTH, XKB_KEY_dead_grave,           FINISH));

    assert(test_rmlvo(ctx, XKB_KEYMAP_FORMAT_TEXT_V1,
                      "", "", "", "", "",
                      KEY_A,          BOTH, XKB_KEY_a,                    FINISH));

    assert(!test_rmlvo(ctx, XKB_KEYMAP_FORMAT_TEXT_V1,
                       "does-not-exist", "", "", "", "",
                       KEY_A,          BOTH, XKB_KEY_a,                   FINISH));

    assert(test_rmlvo_env(ctx, XKB_KEYMAP_FORMAT_TEXT_V1, "evdev",
                          "", "us", "", "",
                          KEY_A,          BOTH, XKB_KEY_a,                FINISH));
    assert(test_rmlvo_env(ctx, XKB_KEYMAP_FORMAT_TEXT_V1,
                          "evdev", "", "us", "", "ctrl:nocaps",
                          KEY_CAPSLOCK,   BOTH, XKB_KEY_Control_L,        FINISH));

    /* Ignores multix and generates us,ca. */
    assert(test_rmlvo_env(ctx, XKB_KEYMAP_FORMAT_TEXT_V1, "evdev",
                          "", "us,ca", ",,,multix", "grp:alts_toggle",
                          KEY_A,          BOTH, XKB_KEY_a,                NEXT,
                          KEY_LEFTALT,    DOWN, XKB_KEY_Alt_L,            NEXT,
                          KEY_RIGHTALT,   DOWN, XKB_KEY_ISO_Next_Group,   NEXT,
                          KEY_RIGHTALT,   UP,   XKB_KEY_ISO_Level3_Shift, NEXT,
                          KEY_LEFTALT,    UP,   XKB_KEY_Alt_L,            NEXT,
                          KEY_GRAVE,      UP,   XKB_KEY_numbersign,       FINISH));

    assert(!test_rmlvo_env(ctx, XKB_KEYMAP_FORMAT_TEXT_V1, "broken", "what-on-earth", "invalid", "", "",
                           KEY_A,          BOTH, XKB_KEY_a,               FINISH));

    /* Ensure a keymap with an empty xkb_keycodes compiles fine. */
    assert(test_rmlvo_env(ctx, XKB_KEYMAP_FORMAT_TEXT_V1, "base", "empty", "empty", "", "",
                          KEY_A,          BOTH, XKB_KEY_NoSymbol,         FINISH));

    /* Check replace merge mode: it should replace the whole <RALT> key */
    const char* replace_options[] = {
        "replace:single,grp:menu_toggle",
        "replace:first,grp:menu_toggle",
        "replace:later,grp:menu_toggle",
    };
    for (unsigned int k = 0; k < ARRAY_SIZE(replace_options); k++) {
        const char* const options = replace_options[k];
        assert(test_rmlvo(ctx, XKB_KEYMAP_FORMAT_TEXT_V1, "merge-mode-replace",
                          "", "us,de", "", options,
                          KEY_RIGHTALT,        BOTH, XKB_KEY_Alt_R,           NEXT,
                          KEY_COMPOSE,         BOTH, XKB_KEY_ISO_Next_Group,  NEXT,
                          KEY_RIGHTALT,        BOTH, XKB_KEY_Alt_R,           FINISH));
    }

    /* Has an illegal escape sequence, but shouldn't fail. */
    assert(test_rmlvo_env(ctx, XKB_KEYMAP_FORMAT_TEXT_V1, "evdev",
                          "", "cz", "bksl", "",
                          KEY_A,          BOTH, XKB_KEY_a,                FINISH));

    test_extended_groups(ctx);

    xkb_context_unref(ctx);

    ctx = test_get_context(0);
    assert(test_rmlvo_env(ctx, XKB_KEYMAP_FORMAT_TEXT_V1, "broken",
                          "but", "ignored", "per", "ctx flags",
                          KEY_A,          BOTH, XKB_KEY_a,                FINISH));

    /* Test response to invalid flags. */
    {
        struct xkb_rule_names rmlvo = { NULL };
        assert(!xkb_keymap_new_from_names2(ctx, &rmlvo,
                                           XKB_KEYMAP_FORMAT_TEXT_V1, -1));
        assert(!xkb_keymap_new_from_names2(ctx, &rmlvo,
                                           XKB_KEYMAP_FORMAT_TEXT_V1, 5453));
    }

    xkb_context_unref(ctx);
    return 0;
}