test: print the layout-tester progress bar to stdout by default
[platform/upstream/libxkbcommon.git] / 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 "xkbcommon/xkbcommon-compose.h"
32 #include "utils.h"
33
34 /* Automake test exit code to signify SKIP (à la PASS, FAIL, etc). */
35 #define SKIP_TEST 77
36
37 /* The offset between KEY_* numbering, and keycodes in the XKB evdev
38  * dataset. */
39 #define EVDEV_OFFSET 8
40
41 enum key_seq_state {
42     DOWN,
43     REPEAT,
44     UP,
45     BOTH,
46     NEXT,
47     FINISH,
48 };
49
50 int
51 test_key_seq(struct xkb_keymap *keymap, ...);
52
53 int
54 test_key_seq_va(struct xkb_keymap *keymap, va_list args);
55
56 char *
57 test_get_path(const char *path_rel);
58
59 char *
60 test_read_file(const char *path_rel);
61
62 enum test_context_flags {
63     CONTEXT_NO_FLAG = 0,
64     CONTEXT_ALLOW_ENVIRONMENT_NAMES = (1 << 0),
65 };
66
67 struct xkb_context *
68 test_get_context(enum test_context_flags flags);
69
70 struct xkb_keymap *
71 test_compile_file(struct xkb_context *context, const char *path_rel);
72
73 struct xkb_keymap *
74 test_compile_string(struct xkb_context *context, const char *string);
75
76 struct xkb_keymap *
77 test_compile_buffer(struct xkb_context *context, const char *buf, size_t len);
78
79 struct xkb_keymap *
80 test_compile_rules(struct xkb_context *context, const char *rules,
81                    const char *model, const char *layout, const char *variant,
82                    const char *options);
83
84
85 #ifdef _MSC_VER
86 #define setenv(varname, value, overwrite) _putenv_s((varname), (value))
87 #define unsetenv(varname) _putenv_s(varname, "")
88 #endif