parser: don't leak AST nodes for discarded symbols
[platform/upstream/libxkbcommon.git] / test / common.c
index dbb0cfe..e6cd1c3 100644 (file)
 /*
-Copyright 2009 Dan Nicholson
-Copyright © 2012 Daniel Stone
-Copyright © 2012 Ran Benita
-
-Permission is hereby granted, free of charge, to any person obtaining a
-copy of this software and associated documentation files (the "Software"),
-to deal in the Software without restriction, including without limitation
-the rights to use, copy, modify, merge, publish, distribute, sublicense,
-and/or sell copies of the Software, and to permit persons to whom the
-Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
-ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-Except as contained in this notice, the names of the authors or their
-institutions shall not be used in advertising or otherwise to promote the
-sale, use or other dealings in this Software without prior written
-authorization from the authors.
-*/
-
-#include <assert.h>
-#include <stdlib.h>
-#include <stdio.h>
-#include <string.h>
+ * Copyright © 2009 Dan Nicholson <dbn.lists@gmail.com>
+ * Copyright © 2012 Intel Corporation
+ * Copyright © 2012 Ran Benita <ran234@gmail.com>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+ * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ * Except as contained in this notice, the names of the authors or their
+ * institutions shall not be used in advertising or otherwise to promote the
+ * sale, use or other dealings in this Software without prior written
+ * authorization from the authors.
+ *
+ * Author: Dan Nicholson <dbn.lists@gmail.com>
+ *         Daniel Stone <daniel@fooishbar.org>
+ *         Ran Benita <ran234@gmail.com>
+ */
+
 #include <limits.h>
 #include <fcntl.h>
 #include <unistd.h>
 #include <sys/types.h>
 #include <sys/stat.h>
 
-#include "xkbcommon/xkbcommon.h"
 #include "test.h"
 
-const char *
+/*
+ * Test a sequence of keysyms, resulting from a sequence of key presses,
+ * against the keysyms they're supposed to generate.
+ *
+ * - Each test runs with a clean state.
+ * - Each line in the test is made up of:
+ *   + A keycode, given as a KEY_* from linux/input.h.
+ *   + A direction - DOWN for press, UP for release, BOTH for
+ *     immediate press + release, REPEAT to just get the syms.
+ *   + A sequence of keysyms that should result from this keypress.
+ *
+ * The vararg format is:
+ * <KEY_*>  <DOWN | UP | BOTH>  <XKB_KEY_* (zero or more)>  <NEXT | FINISH>
+ *
+ * See below for examples.
+ */
+int
+test_key_seq_va(struct xkb_keymap *keymap, va_list ap)
+{
+    struct xkb_state *state;
+
+    xkb_keycode_t kc;
+    int op;
+    xkb_keysym_t keysym;
+
+    const xkb_keysym_t *syms;
+    xkb_keysym_t sym;
+    unsigned int nsyms, i;
+    char ksbuf[64];
+
+    fprintf(stderr, "----\n");
+
+    state = xkb_state_new(keymap);
+    assert(state);
+
+    for (;;) {
+        kc = va_arg(ap, int) + EVDEV_OFFSET;
+        op = va_arg(ap, int);
+
+        nsyms = xkb_state_key_get_syms(state, kc, &syms);
+        if (nsyms == 1) {
+            sym = xkb_state_key_get_one_sym(state, kc);
+            syms = &sym;
+        }
+
+        fprintf(stderr, "got %u syms for key 0x%x: [", nsyms, kc);
+
+        if (op == DOWN || op == BOTH)
+            xkb_state_update_key(state, kc, XKB_KEY_DOWN);
+        if (op == UP || op == BOTH)
+            xkb_state_update_key(state, kc, XKB_KEY_UP);
+
+        for (i = 0; i < nsyms; i++) {
+            keysym = va_arg(ap, int);
+            xkb_keysym_get_name(syms[i], ksbuf, sizeof(ksbuf));
+            fprintf(stderr, "%s%s", (i != 0) ? ", " : "", ksbuf);
+
+            if (keysym == FINISH || keysym == NEXT) {
+                xkb_keysym_get_name(syms[i], ksbuf, sizeof(ksbuf));
+                fprintf(stderr, "Did not expect keysym: %s.\n", ksbuf);
+                goto fail;
+            }
+
+            if (keysym != syms[i]) {
+                xkb_keysym_get_name(keysym, ksbuf, sizeof(ksbuf));
+                fprintf(stderr, "Expected keysym: %s. ", ksbuf);;
+                xkb_keysym_get_name(syms[i], ksbuf, sizeof(ksbuf));
+                fprintf(stderr, "Got keysym: %s.\n", ksbuf);;
+                goto fail;
+            }
+        }
+
+        if (nsyms == 0) {
+            keysym = va_arg(ap, int);
+            if (keysym != XKB_KEY_NoSymbol) {
+                xkb_keysym_get_name(keysym, ksbuf, sizeof(ksbuf));
+                fprintf(stderr, "Expected %s, but got no keysyms.\n", ksbuf);
+                goto fail;
+            }
+        }
+
+        fprintf(stderr, "]\n");
+
+        keysym = va_arg(ap, int);
+        if (keysym == NEXT)
+            continue;
+        if (keysym == FINISH)
+            break;
+
+        xkb_keysym_get_name(keysym, ksbuf, sizeof(ksbuf));
+        fprintf(stderr, "Expected keysym: %s. Didn't get it.\n", ksbuf);
+        goto fail;
+    }
+
+    xkb_state_unref(state);
+    return 1;
+
+fail:
+    xkb_state_unref(state);
+    return 0;
+}
+
+int
+test_key_seq(struct xkb_keymap *keymap, ...)
+{
+    va_list ap;
+    int ret;
+
+    va_start(ap, keymap);
+    ret = test_key_seq_va(keymap, ap);
+    va_end(ap);
+
+    return ret;
+}
+
+char *
 test_get_path(const char *path_rel)
 {
-    static char path[PATH_MAX];
+    char *path;
+    size_t path_len;
     const char *srcdir = getenv("srcdir");
 
-    snprintf(path, PATH_MAX - 1,
+    path_len = strlen(srcdir ? srcdir : ".") +
+               strlen(path_rel ? path_rel : "") + 12;
+    path = malloc(path_len);
+    if (!path) {
+        fprintf(stderr, "Failed to allocate path (%d chars) for %s\n",
+                (int) path_len, path);
+        return NULL;
+    }
+    snprintf(path, path_len,
              "%s/test/data/%s", srcdir ? srcdir : ".",
              path_rel ? path_rel : "");
 
@@ -56,10 +179,15 @@ char *
 test_read_file(const char *path_rel)
 {
     struct stat info;
-    char *ret, *tmp;
+    char *ret, *tmp, *path;
     int fd, count, remaining;
 
-    fd = open(test_get_path(path_rel), O_RDONLY);
+    path = test_get_path(path_rel);
+    if (!path)
+        return NULL;
+
+    fd = open(path, O_RDONLY);
+    free(path);
     if (fd < 0)
         return NULL;
 
@@ -92,14 +220,34 @@ test_read_file(const char *path_rel)
 }
 
 struct xkb_context *
-test_get_context(void)
+test_get_context(enum test_context_flags test_flags)
 {
-    struct xkb_context *ctx = xkb_context_new(XKB_CONTEXT_NO_DEFAULT_INCLUDES);
+    enum xkb_context_flags ctx_flags;
+    struct xkb_context *ctx;
+    char *path;
+
+    ctx_flags = XKB_CONTEXT_NO_DEFAULT_INCLUDES;
+    if (test_flags & CONTEXT_ALLOW_ENVIRONMENT_NAMES) {
+        unsetenv("XKB_DEFAULT_RULES");
+        unsetenv("XKB_DEFAULT_MODEL");
+        unsetenv("XKB_DEFAULT_LAYOUT");
+        unsetenv("XKB_DEFAULT_VARIANT");
+        unsetenv("XKB_DEFAULT_OPTIONS");
+    }
+    else {
+        ctx_flags |= XKB_CONTEXT_NO_ENVIRONMENT_NAMES;
+    }
 
+    ctx = xkb_context_new(ctx_flags);
     if (!ctx)
         return NULL;
 
-    xkb_context_include_path_append(ctx, test_get_path(""));
+    path = test_get_path("");
+    if (!path)
+        return NULL;
+
+    xkb_context_include_path_append(ctx, path);
+    free(path);
 
     return ctx;
 }
@@ -109,25 +257,32 @@ test_compile_file(struct xkb_context *context, const char *path_rel)
 {
     struct xkb_keymap *keymap;
     FILE *file;
-    const char *path = test_get_path(path_rel);
+    char *path;
+
+    path = test_get_path(path_rel);
+    if (!path)
+        return NULL;
 
     file = fopen(path, "r");
     if (!file) {
         fprintf(stderr, "Failed to open path: %s\n", path);
+        free(path);
         return NULL;
     }
     assert(file != NULL);
 
-    keymap = xkb_map_new_from_file(context, file,
-                                   XKB_KEYMAP_FORMAT_TEXT_V1, 0);
+    keymap = xkb_keymap_new_from_file(context, file,
+                                      XKB_KEYMAP_FORMAT_TEXT_V1, 0);
     fclose(file);
 
     if (!keymap) {
         fprintf(stderr, "Failed to compile path: %s\n", path);
+        free(path);
         return NULL;
     }
 
     fprintf(stderr, "Successfully compiled path: %s\n", path);
+    free(path);
 
     return keymap;
 }
@@ -137,8 +292,8 @@ test_compile_string(struct xkb_context *context, const char *string)
 {
     struct xkb_keymap *keymap;
 
-    keymap = xkb_map_new_from_string(context, string,
-                                     XKB_KEYMAP_FORMAT_TEXT_V1, 0);
+    keymap = xkb_keymap_new_from_string(context, string,
+                                        XKB_KEYMAP_FORMAT_TEXT_V1, 0);
     if (!keymap) {
         fprintf(stderr, "Failed to compile string\n");
         return NULL;
@@ -148,20 +303,39 @@ test_compile_string(struct xkb_context *context, const char *string)
 }
 
 struct xkb_keymap *
+test_compile_buffer(struct xkb_context *context, const char *buf, size_t len)
+{
+    struct xkb_keymap *keymap;
+
+    keymap = xkb_keymap_new_from_buffer(context, buf, len,
+                                        XKB_KEYMAP_FORMAT_TEXT_V1, 0);
+    if (!keymap) {
+        fprintf(stderr, "Failed to compile keymap from memory buffer\n");
+        return NULL;
+    }
+
+    return keymap;
+}
+
+struct xkb_keymap *
 test_compile_rules(struct xkb_context *context, const char *rules,
                    const char *model, const char *layout,
                    const char *variant, const char *options)
 {
     struct xkb_keymap *keymap;
     struct xkb_rule_names rmlvo = {
-        .rules = rules,
-        .model = model,
-        .layout = layout,
-        .variant = variant,
-        .options = options
+        .rules = isempty(rules) ? NULL : rules,
+        .model = isempty(model) ? NULL : model,
+        .layout = isempty(layout) ? NULL : layout,
+        .variant = isempty(variant) ? NULL : variant,
+        .options = isempty(options) ? NULL : options
     };
 
-    keymap = xkb_map_new_from_names(context, &rmlvo, 0);
+    if (!rules && !model && !layout && !variant && !options)
+        keymap = xkb_keymap_new_from_names(context, NULL, 0);
+    else
+        keymap = xkb_keymap_new_from_names(context, &rmlvo, 0);
+
     if (!keymap) {
         fprintf(stderr,
                 "Failed to compile RMLVO: '%s', '%s', '%s', '%s', '%s'\n",
@@ -171,3 +345,95 @@ test_compile_rules(struct xkb_context *context, const char *rules,
 
     return keymap;
 }
+
+void
+test_print_keycode_state(struct xkb_state *state, xkb_keycode_t keycode)
+{
+    struct xkb_keymap *keymap;
+
+    const xkb_keysym_t *syms;
+    int nsyms;
+    char s[16];
+    xkb_layout_index_t layout;
+
+    keymap = xkb_state_get_keymap(state);
+
+    nsyms = xkb_state_key_get_syms(state, keycode, &syms);
+
+    if (nsyms <= 0)
+        return;
+
+    if (nsyms == 1) {
+        xkb_keysym_t sym = xkb_state_key_get_one_sym(state, keycode);
+        xkb_keysym_get_name(sym, s, sizeof(s));
+        printf("keysym [ %-*s ] ", (int) sizeof(s), s);
+    }
+    else {
+        printf("keysyms [ ");
+        for (int i = 0; i < nsyms; i++) {
+            xkb_keysym_get_name(syms[i], s, sizeof(s));
+            printf("%-*s ", (int) sizeof(s), s);
+        }
+        printf("] ");
+    }
+
+    xkb_state_key_get_utf8(state, keycode, s, sizeof(s));
+    printf("unicode [ %s ] ", s);
+
+    layout = xkb_state_key_get_layout(state, keycode);
+    printf("layout [ %s (%d) ] ",
+           xkb_keymap_layout_get_name(keymap, layout), layout);
+
+    printf("level [ %d ] ",
+           xkb_state_key_get_level(state, keycode, layout));
+
+    printf("mods [ ");
+    for (xkb_mod_index_t mod = 0; mod < xkb_keymap_num_mods(keymap); mod++) {
+        if (xkb_state_mod_index_is_active(state, mod,
+                                          XKB_STATE_MODS_EFFECTIVE) <= 0)
+            continue;
+        if (xkb_state_mod_index_is_consumed(state, keycode, mod))
+            printf("-%s ", xkb_keymap_mod_get_name(keymap, mod));
+        else
+            printf("%s ", xkb_keymap_mod_get_name(keymap, mod));
+    }
+    printf("] ");
+
+    printf("leds [ ");
+    for (xkb_led_index_t led = 0; led < xkb_keymap_num_leds(keymap); led++) {
+        if (xkb_state_led_index_is_active(state, led) <= 0)
+            continue;
+        printf("%s ", xkb_keymap_led_get_name(keymap, led));
+    }
+    printf("] ");
+
+    printf("\n");
+}
+
+void
+test_print_state_changes(enum xkb_state_component changed)
+{
+    if (changed == 0)
+        return;
+
+    printf("changed [ ");
+    if (changed & XKB_STATE_LAYOUT_EFFECTIVE)
+        printf("effective-layout ");
+    if (changed & XKB_STATE_LAYOUT_DEPRESSED)
+        printf("depressed-layout ");
+    if (changed & XKB_STATE_LAYOUT_LATCHED)
+        printf("latched-layout ");
+    if (changed & XKB_STATE_LAYOUT_LOCKED)
+        printf("locked-layout ");
+    if (changed & XKB_STATE_MODS_EFFECTIVE)
+        printf("effective-mods ");
+    if (changed & XKB_STATE_MODS_DEPRESSED)
+        printf("depressed-mods ");
+    if (changed & XKB_STATE_MODS_LATCHED)
+        printf("latched-mods ");
+    if (changed & XKB_STATE_MODS_LOCKED)
+        printf("locked-mods ");
+    if (changed & XKB_STATE_LEDS)
+        printf("leds ");
+    printf("]\n");
+}