2 * Copyright © 2012 Intel Corporation
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:
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
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.
23 * Author: Daniel Stone <daniel@fooishbar.org>
34 ATTR_PRINTF(3, 0) void (*log_fn)(struct xkb_context *ctx,
35 enum xkb_log_level level,
36 const char *fmt, va_list args);
37 enum xkb_log_level log_level;
41 struct xkb_rule_names names_dflt;
43 darray(char *) includes;
44 darray(char *) failed_includes;
46 struct atom_table *atom_table;
48 /* Used and allocated by xkbcommon-x11, free()d with the context. */
51 /* Buffer for the *Text() functions. */
52 char text_buffer[2048];
55 unsigned int use_environment_names : 1;
59 xkb_context_num_failed_include_paths(struct xkb_context *ctx);
62 xkb_context_failed_include_path_get(struct xkb_context *ctx,
66 xkb_context_include_path_get_extra_path(struct xkb_context *ctx);
69 xkb_context_include_path_get_system_path(struct xkb_context *ctx);
72 * Returns XKB_ATOM_NONE if @string was not previously interned,
73 * otherwise returns the atom.
76 xkb_atom_lookup(struct xkb_context *ctx, const char *string);
79 xkb_atom_intern(struct xkb_context *ctx, const char *string, size_t len);
81 #define xkb_atom_intern_literal(ctx, literal) \
82 xkb_atom_intern((ctx), (literal), sizeof(literal) - 1)
85 * If @string is dynamically allocated, NUL-terminated, free'd immediately
86 * after being interned, and not used afterwards, use this function
87 * instead of xkb_atom_intern to avoid some unnecessary allocations.
88 * The caller should not use or free the passed in string afterwards.
91 xkb_atom_steal(struct xkb_context *ctx, char *string);
94 xkb_atom_text(struct xkb_context *ctx, xkb_atom_t atom);
97 xkb_context_get_buffer(struct xkb_context *ctx, size_t size);
99 ATTR_PRINTF(4, 5) void
100 xkb_log(struct xkb_context *ctx, enum xkb_log_level level, int verbosity,
101 const char *fmt, ...);
104 xkb_context_sanitize_rule_names(struct xkb_context *ctx,
105 struct xkb_rule_names *rmlvo);
108 * The format is not part of the argument list in order to avoid the
109 * "ISO C99 requires rest arguments to be used" warning when only the
110 * format is supplied without arguments. Not supplying it would still
111 * result in an error, though.
113 #define log_dbg(ctx, ...) \
114 xkb_log((ctx), XKB_LOG_LEVEL_DEBUG, 0, __VA_ARGS__)
115 #define log_info(ctx, ...) \
116 xkb_log((ctx), XKB_LOG_LEVEL_INFO, 0, __VA_ARGS__)
117 #define log_warn(ctx, ...) \
118 xkb_log((ctx), XKB_LOG_LEVEL_WARNING, 0, __VA_ARGS__)
119 #define log_err(ctx, ...) \
120 xkb_log((ctx), XKB_LOG_LEVEL_ERROR, 0, __VA_ARGS__)
121 #define log_wsgo(ctx, ...) \
122 xkb_log((ctx), XKB_LOG_LEVEL_CRITICAL, 0, __VA_ARGS__)
123 #define log_vrb(ctx, vrb, ...) \
124 xkb_log((ctx), XKB_LOG_LEVEL_WARNING, (vrb), __VA_ARGS__)
127 * Variants which are prefixed by the name of the function they're
129 * Here we must have the silly 1 variant.
131 #define log_err_func(ctx, fmt, ...) \
132 log_err(ctx, "%s: " fmt, __func__, __VA_ARGS__)
133 #define log_err_func1(ctx, fmt) \
134 log_err(ctx, "%s: " fmt, __func__)