test/test.h

   1 /*
   2  * Copyright © 2012 Intel Corporation
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21  * DEALINGS IN THE SOFTWARE.
  22  *
  23  * Author: Daniel Stone <daniel@fooishbar.org>
  24  */
  25
  26 #include <assert.h>
  27
  28 /* Don't use compat names in internal code. */
  29 #define _XKBCOMMON_COMPAT_H
  30 #include "xkbcommon/xkbcommon.h"
  31 #include "utils.h"
  32
  33 /* Automake test exit code to signify SKIP (à la PASS, FAIL, etc). */
  34 #define SKIP_TEST 77
  35
  36 /* The offset between KEY_* numbering, and keycodes in the XKB evdev
  37  * dataset. */
  38 #define EVDEV_OFFSET 8
  39
  40 enum key_seq_state {
  41     DOWN,
  42     REPEAT,
  43     UP,
  44     BOTH,
  45     NEXT,
  46     FINISH,
  47 };
  48
  49 int
  50 test_key_seq(struct xkb_keymap *keymap, ...);
  51
  52 int
  53 test_key_seq_va(struct xkb_keymap *keymap, va_list args);
  54
  55 char *
  56 test_get_path(const char *path_rel);
  57
  58 char *
  59 test_read_file(const char *path_rel);
  60
  61 enum test_context_flags {
  62     CONTEXT_NO_FLAG = 0,
  63     CONTEXT_ALLOW_ENVIRONMENT_NAMES = (1 << 0),
  64 };
  65
  66 struct xkb_context *
  67 test_get_context(enum test_context_flags flags);
  68
  69 struct xkb_keymap *
  70 test_compile_file(struct xkb_context *context, const char *path_rel);
  71
  72 struct xkb_keymap *
  73 test_compile_string(struct xkb_context *context, const char *string);
  74
  75 struct xkb_keymap *
  76 test_compile_buffer(struct xkb_context *context, const char *buf, size_t len);
  77
  78 struct xkb_keymap *
  79 test_compile_rules(struct xkb_context *context, const char *rules,
  80                    const char *model, const char *layout, const char *variant,
  81                    const char *options);
  82
  83 void
  84 test_print_keycode_state(struct xkb_state *state, xkb_keycode_t keycode);
  85
  86 void
  87 test_print_state_changes(enum xkb_state_component changed);