Edit
kc3-lang/libxkbcommon/test/buffercomp.c
Ran Benita
- test/buffercomp.c
-
/* * Copyright © 2009 Dan Nicholson * SPDX-License-Identifier: MIT */ #include "config.h" #include <assert.h> #include <stdio.h> #include <stdlib.h> #include "test.h" #define DATA_PATH "keymaps/stringcomp.data" static void test_encodings(struct xkb_context *ctx) { struct xkb_keymap *keymap; /* Accept UTF-8 encoded BOM (U+FEFF) */ const char utf8_with_bom[] = "\xef\xbb\xbfxkb_keymap {" " xkb_keycodes { };" " xkb_types { };" " xkb_compat { };" " xkb_symbols { };" "};"; keymap = test_compile_buffer(ctx, utf8_with_bom, sizeof(utf8_with_bom)); assert(keymap); xkb_keymap_unref(keymap); /* Reject UTF-16LE encoded string */ const char utf16_le[] = "x\0k\0b\0_\0k\0e\0y\0m\0a\0p\0 \0{\0\n\0" " \0 \0x\0k\0b\0_\0k\0e\0y\0c\0o\0d\0e\0s\0 \0{\0 \0i\0n\0c\0l\0u\0d\0e\0 \0\"\0e\0v\0d\0e\0v\0\"\0 \0}\0;\0\n\0" " \0 \0x\0k\0b\0_\0t\0y\0p\0e\0s\0 \0{\0 \0i\0n\0c\0l\0u\0d\0e\0 \0\"\0c\0o\0m\0p\0l\0e\0t\0e\0\"\0 \0}\0;\0\n\0" " \0 \0x\0k\0b\0_\0c\0o\0m\0p\0a\0t\0 \0{\0 \0i\0n\0c\0l\0u\0d\0e\0 \0\"\0c\0o\0m\0p\0l\0e\0t\0e\0\"\0 \0}\0;\0\n\0" " \0 \0x\0k\0b\0_\0s\0y\0m\0b\0o\0l\0s\0 \0{\0 \0i\0n\0c\0l\0u\0d\0e\0 \0\"\0p\0c\0\"\0 \0}\0;\0\n\0" "}\0;\0"; keymap = test_compile_buffer(ctx, utf16_le, sizeof(utf16_le)); assert(!keymap); /* Reject UTF-16LE with BOM encoded string */ const char utf16_le_with_bom[] = "\xff\xfex\0k\0b\0_\0k\0e\0y\0m\0a\0p\0 \0{\0\n\0" " \0 \0x\0k\0b\0_\0k\0e\0y\0c\0o\0d\0e\0s\0 \0{\0 \0i\0n\0c\0l\0u\0d\0e\0 \0\"\0e\0v\0d\0e\0v\0\"\0 \0}\0;\0\n\0" " \0 \0x\0k\0b\0_\0t\0y\0p\0e\0s\0 \0{\0 \0i\0n\0c\0l\0u\0d\0e\0 \0\"\0c\0o\0m\0p\0l\0e\0t\0e\0\"\0 \0}\0;\0\n\0" " \0 \0x\0k\0b\0_\0c\0o\0m\0p\0a\0t\0 \0{\0 \0i\0n\0c\0l\0u\0d\0e\0 \0\"\0c\0o\0m\0p\0l\0e\0t\0e\0\"\0 \0}\0;\0\n\0" " \0 \0x\0k\0b\0_\0s\0y\0m\0b\0o\0l\0s\0 \0{\0 \0i\0n\0c\0l\0u\0d\0e\0 \0\"\0p\0c\0\"\0 \0}\0;\0\n\0" "}\0;\0"; keymap = test_compile_buffer(ctx, utf16_le_with_bom, sizeof(utf16_le_with_bom)); assert(!keymap); /* Reject UTF-16BE encoded string */ const char utf16_be[] = "\0x\0k\0b\0_\0k\0e\0y\0m\0a\0p\0 \0{\0\n\0" " \0 \0x\0k\0b\0_\0k\0e\0y\0c\0o\0d\0e\0s\0 \0{\0 \0i\0n\0c\0l\0u\0d\0e\0 \0\"\0e\0v\0d\0e\0v\0\"\0 \0}\0;\0\n\0" " \0 \0x\0k\0b\0_\0t\0y\0p\0e\0s\0 \0{\0 \0i\0n\0c\0l\0u\0d\0e\0 \0\"\0c\0o\0m\0p\0l\0e\0t\0e\0\"\0 \0}\0;\0\n\0" " \0 \0x\0k\0b\0_\0c\0o\0m\0p\0a\0t\0 \0{\0 \0i\0n\0c\0l\0u\0d\0e\0 \0\"\0c\0o\0m\0p\0l\0e\0t\0e\0\"\0 \0}\0;\0\n\0" " \0 \0x\0k\0b\0_\0s\0y\0m\0b\0o\0l\0s\0 \0{\0 \0i\0n\0c\0l\0u\0d\0e\0 \0\"\0p\0c\0\"\0 \0}\0;\0\n\0" "}\0;"; keymap = test_compile_buffer(ctx, utf16_be, sizeof(utf16_be)); assert(!keymap); } static void test_component_syntax_error(struct xkb_context *ctx) { /* The following used to trigger memory leak */ const char* const keymaps[] = { "xkb_keymap {" " xkb_keycodes { };" "};" "};", /* Syntax error, keymap “complete” */ "xkb_keymap {" " xkb_keycodes { };" " xkb_types { };" " xkb_compat { };" " xkb_symbols { };" "};" "};"/* Syntax error, keymap complete */, "xkb_keymap {" " xkb_keycodes { };" "}" /* Syntax error, incomplete map */ " xkb_types { };" " xkb_compat { };" " xkb_symbols { };" "};", "xkb_keymap {" " xkb_keycodes { };" ";" /* Syntax error, incomplete map */ " xkb_types { };" " xkb_compat { };" " xkb_symbols { };" "};", }; for (unsigned int k = 0; k < ARRAY_SIZE(keymaps); k++) { fprintf(stderr, "------\n*** %s: #%u ***\n", __func__, k); const struct xkb_keymap *keymap = test_compile_buffer(ctx, keymaps[k], strlen(keymaps[k])); assert(!keymap); } } static void test_recursive(struct xkb_context *ctx) { struct xkb_keymap *keymap; const char* const keymaps[] = { /* Recursive keycodes */ "Keycodes: recursive", "xkb_keymap {" " xkb_keycodes { include \"evdev+recursive\" };" " xkb_types { include \"complete\" };" " xkb_compat { include \"complete\" };" " xkb_symbols { include \"pc\" };" "};", "Keycodes: recursive(bar)", "xkb_keymap {" " xkb_keycodes { include \"evdev+recursive(bar)\" };" " xkb_types { include \"complete\" };" " xkb_compat { include \"complete\" };" " xkb_symbols { include \"pc\" };" "};", /* Recursive key types */ "Key types: recursive", "xkb_keymap {" " xkb_keycodes { include \"evdev\" };" " xkb_types { include \"recursive\" };" " xkb_compat { include \"complete\" };" " xkb_symbols { include \"pc\" };" "};", "Key types: recursive(bar)", "xkb_keymap {" " xkb_keycodes { include \"evdev\" };" " xkb_types { include \"recursive(bar)\" };" " xkb_compat { include \"complete\" };" " xkb_symbols { include \"pc\" };" "};", /* Recursive compat */ "Compat: recursive", "xkb_keymap {" " xkb_keycodes { include \"evdev\" };" " xkb_types { include \"recursive\" };" " xkb_compat { include \"complete\" };" " xkb_symbols { include \"pc\" };" "};", "Compat: recursive(bar)", "xkb_keymap {" " xkb_keycodes { include \"evdev\" };" " xkb_types { include \"complete\" };" " xkb_compat { include \"recursive(bar)\" };" " xkb_symbols { include \"pc\" };" "};", /* Recursive symbols */ "Symbols: recursive", "xkb_keymap {" " xkb_keycodes { include \"evdev\" };" " xkb_types { include \"complete\" };" " xkb_compat { include \"complete\" };" " xkb_symbols { include \"recursive\" };" "};", "Symbols: recursive(bar)", "xkb_keymap {" " xkb_keycodes { include \"evdev\" };" " xkb_types { include \"complete\" };" " xkb_compat { include \"complete\" };" " xkb_symbols { include \"recursive(bar)\" };" "};" }; for (unsigned int k = 0; k < ARRAY_SIZE(keymaps); k++) { fprintf(stderr, "------\n*** %s: #%u %s ***\n", __func__, k, keymaps[k]); k++; keymap = test_compile_buffer(ctx, keymaps[k], strlen(keymaps[k])); assert(!keymap); } } /* Test some limits related to allocations */ static void test_alloc_limits(struct xkb_context *ctx) { const char * const keymaps[] = { /* Keycodes */ "xkb_keymap {\n" /* Valid keycode value, but we should not handle it * with our *continuous* array! */ " xkb_keycodes { <> = 0xfffffffe; };\n" " xkb_types { };\n" " xkb_compat { };\n" " xkb_symbols { key <> {[a]}; };\n" "};", /* Key types */ "xkb_keymap {\n" " xkb_keycodes { };\n" " xkb_types {\n" " type \"X\" { map[none] = 0xfffffffe; };\n" /* Invalid level index */ " };\n" " xkb_compat { };\n" " xkb_symbols { };\n" "};", "xkb_keymap {\n" " xkb_keycodes { };\n" " xkb_types {\n" " type \"X\" {levelname[0xfffffffe]=\"x\";};\n" /* Invalid level index */ " };\n" " xkb_compat { };\n" " xkb_symbols { };\n" "};" }; for (unsigned int k = 0; k < ARRAY_SIZE(keymaps); k++) { fprintf(stderr, "------\n*** %s: #%u ***\n", __func__, k); const struct xkb_keymap *keymap = test_compile_buffer(ctx, keymaps[k], strlen(keymaps[k])); assert(!keymap); } } /* Test various multi-{keysym,action} syntaxes */ static void test_multi_keysyms_actions(struct xkb_context *ctx) { struct xkb_keymap *keymap; /* Macros to define the tests */ #define make_keymap(keysyms, actions) \ "xkb_keymap {\n" \ " xkb_keycodes {\n" \ " minimum= 8;\n" \ " maximum= 10;\n" \ " <AE01> = 10;\n" \ " };\n" \ " xkb_types { include \"basic\" };\n" \ " xkb_compat { include \"basic\" };\n" \ " xkb_symbols {\n" \ " key <AE01> { " keysyms actions " };\n" \ " };\n" \ "};" #define make_keymap_with_keysyms(keysyms) \ make_keymap("[" keysyms "]", "") #define make_keymap_with_actions(actions) \ make_keymap("", "actions[1] = [" actions "]") #define test_keymaps \ make_keymaps_with(make_keymap_with_keysyms, \ "a", "b", "c", "d"), \ make_keymaps_with(make_keymap_with_actions, \ "SetMods(modifiers=Control)", \ "SetGroup(group=+1)", \ "Private(data=\"foo\")", \ "Private(data=\"bar\")") #define run_test(kind, condition, msg, ...) do { \ const char* const keymaps[] = { test_keymaps }; \ for (size_t k = 0; k < ARRAY_SIZE(keymaps); k++) { \ fprintf(stderr, \ "------\n" \ "*** %s: " kind "#%zu ***\n", \ __func__, k + 1); \ keymap = test_compile_buffer(ctx, keymaps[k], \ strlen(keymaps[k])); \ assert_printf(condition, \ "The following symbols " msg " parse:\n%s\n", \ keymaps[k]); \ __VA_ARGS__; \ } \ } while (0) /* Test: valid keymaps */ #define make_keymaps_with(func, a, b, c, d) \ func(a), \ func(a", "b), \ func("{ "a", "b" }"), \ func("{ "a", "b", "c" }"), \ func(a", { "b", "c" }"), \ func("{ "a", "b" }, "c), \ func("{ "a", "b" }, { "c", "d" }"), \ func("{ "a", "b" }, "c", { "d", "a" }"), \ func("{ "a", "b" }, { "c", "d" }, "a) run_test("valid", keymap != NULL, "does *not*", xkb_keymap_unref(keymap)); #undef make_keymaps_with /* Test: invalid keymaps */ #define make_keymaps_with(func, a, b, c, d) \ func("{}"), \ func("{ {} }"), \ func("{ "a" }"), \ func("{ "a", {} }"), \ func("{ {}, "b" }"), \ func("{ {}, {} }"), \ func("{ "a", { "b" } }"), \ func("{ { "a" }, "b" }"), \ func("{ { "a", "b" }, "c" }"), \ func("{ "a", { "b", "c" } }"), \ func("{ "a", {}, "c" }"), \ func("{ "a", "b", {} }"), \ func("{ {}, "b", "c" }"), \ func("{ { "a", "b" }, "c", "d" }"), \ func("{ "a", { "b", "c" }, "d" }"), \ func("{ "a", "b", { "c", "d" } }"), \ func("{ { "a", "b" }, { "c", "d" } }") run_test("invalid", keymap == NULL, "*does*"); #undef make_keymap #undef make_keymap_with_actions #undef make_keymap_with_keysyms #undef make_keymaps_with #undef test_keymaps #undef run_test } static void test_invalid_symbols_fields(struct xkb_context *ctx) { /* Any of the following is invalid syntax, but also use to trigger * a NULL pointer deference, thus this regression test */ const char * const keymaps[] = { "xkb_keymap {\n" " xkb_keycodes { <> = 9; };\n" " xkb_types { };\n" " xkb_compat { };\n" " xkb_symbols { key <> { vmods = [] }; };\n" "};", "xkb_keymap {\n" " xkb_keycodes { <> = 9; };\n" " xkb_types { };\n" " xkb_compat { };\n" " xkb_symbols { key <> { repeat = [] }; };\n" "};", "xkb_keymap {\n" " xkb_keycodes { <> = 9; };\n" " xkb_types { };\n" " xkb_compat { };\n" " xkb_symbols { key <> { type = [] }; };\n" "};", "xkb_keymap {\n" " xkb_keycodes { <> = 9; };\n" " xkb_types { };\n" " xkb_compat { };\n" " xkb_symbols { key <> { groupswrap = [] }; };\n" "};", "xkb_keymap {\n" " xkb_keycodes { <> = 9; };\n" " xkb_types { };\n" " xkb_compat { };\n" " xkb_symbols { key <> { groupsredirect = [] }; };\n" "};", /* Used to parse without error because the “repeats” key field is valid, * but we should fail in the following 2 keymaps */ "xkb_keymap {\n" " xkb_keycodes { <> = 9; };\n" " xkb_types { };\n" " xkb_compat { };\n" " xkb_symbols { key <> { vmods=[], repeats=false }; };\n" "};", "xkb_keymap {\n" " xkb_keycodes { <> = 9; };\n" " xkb_types { };\n" " xkb_compat { };\n" " xkb_symbols { key <> { repeats=false, vmods=[] }; };\n" "};" }; for (unsigned int k = 0; k < ARRAY_SIZE(keymaps); k++) { fprintf(stderr, "------\n*** %s: #%u ***\n", __func__, k); const struct xkb_keymap *keymap = test_compile_buffer(ctx, keymaps[k], strlen(keymaps[k])); assert(!keymap); } } static void test_prebuilt_keymap_roundtrip(struct xkb_context *ctx) { /* Load in a prebuilt keymap, make sure we can compile it from memory, * then compare it to make sure we get the same result when dumping it * to a string. */ char *original = test_read_file(DATA_PATH); assert(original); /* Load a prebuild keymap, once without, once with the trailing \0 */ for (unsigned int i = 0; i <= 1; i++) { fprintf(stderr, "------\n*** %s, trailing \\0: %d ***\n", __func__, i); struct xkb_keymap *keymap = test_compile_buffer(ctx, original, strlen(original) + i); assert(keymap); char *dump = xkb_keymap_get_as_string(keymap, XKB_KEYMAP_USE_ORIGINAL_FORMAT); assert(dump); if (!streq(original, dump)) { fprintf(stderr, "round-trip test failed: dumped map differs from original\n"); fprintf(stderr, "path to original file: %s\n", test_get_path(DATA_PATH)); fprintf(stderr, "length: dumped %lu, original %lu\n", (unsigned long) strlen(dump), (unsigned long) strlen(original)); fprintf(stderr, "dumped map:\n"); fprintf(stderr, "%s\n", dump); fflush(stderr); assert(0); } free(dump); xkb_keymap_unref(keymap); } free(original); } static void test_keymap_from_rules(struct xkb_context *ctx) { /* Make sure we can recompile our output for a normal keymap from rules. */ fprintf(stderr, "------\n*** %s ***\n", __func__); struct xkb_keymap *keymap = test_compile_rules(ctx, NULL, NULL, "ru,ca,de,us", ",multix,neo,intl", NULL); assert(keymap); char *dump = xkb_keymap_get_as_string(keymap, XKB_KEYMAP_USE_ORIGINAL_FORMAT); assert(dump); xkb_keymap_unref(keymap); keymap = test_compile_buffer(ctx, dump, strlen(dump)); assert(keymap); xkb_keymap_unref(keymap); free(dump); } int main(int argc, char *argv[]) { test_init(); struct xkb_context *ctx = test_get_context(CONTEXT_NO_FLAG); assert(ctx); /* Make sure we can't (falsely claim to) compile an empty string. */ struct xkb_keymap *keymap = test_compile_buffer(ctx, "", 0); assert(!keymap); test_encodings(ctx); test_component_syntax_error(ctx); test_recursive(ctx); test_alloc_limits(ctx); test_multi_keysyms_actions(ctx); test_invalid_symbols_fields(ctx); test_prebuilt_keymap_roundtrip(ctx); test_keymap_from_rules(ctx); xkb_context_unref(ctx); return EXIT_SUCCESS; }