2 * Copyright © 2012 Intel Corporation
3 * Copyright © 2012 Ran Benita
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice (including the next
13 * paragraph) shall be included in all copies or substantial portions of the
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
24 * Author: Daniel Stone <daniel@fooishbar.org>
29 #include <sys/types.h>
33 #include "xkbcommon/xkbcommon.h"
39 * Append one directory to the context's include path.
42 xkb_context_include_path_append(struct xkb_context *ctx, const char *path)
52 err = stat(path, &stat_buf);
57 if (!S_ISDIR(stat_buf.st_mode)) {
62 if (!check_eaccess(path, R_OK | X_OK)) {
67 darray_append(ctx->includes, tmp);
68 log_dbg(ctx, "Include path added: %s\n", tmp);
73 darray_append(ctx->failed_includes, tmp);
74 log_dbg(ctx, "Include path failed: %s (%s)\n", tmp, strerror(err));
79 xkb_context_include_path_get_extra_path(struct xkb_context *ctx)
81 const char *extra = xkb_context_getenv(ctx, "XKB_CONFIG_EXTRA_PATH");
82 return extra ? extra : DFLT_XKB_CONFIG_EXTRA_PATH;
86 xkb_context_include_path_get_system_path(struct xkb_context *ctx)
88 const char *root = xkb_context_getenv(ctx, "XKB_CONFIG_ROOT");
89 return root ? root : DFLT_XKB_CONFIG_ROOT;
93 * Append the default include directories to the context.
96 xkb_context_include_path_append_default(struct xkb_context *ctx)
98 const char *home, *xdg, *root, *extra;
102 home = xkb_context_getenv(ctx, "HOME");
104 xdg = xkb_context_getenv(ctx, "XDG_CONFIG_HOME");
106 user_path = asprintf_safe("%s/xkb", xdg);
108 ret |= xkb_context_include_path_append(ctx, user_path);
111 } else if (home != NULL) {
112 /* XDG_CONFIG_HOME fallback is $HOME/.config/ */
113 user_path = asprintf_safe("%s/.config/xkb", home);
115 ret |= xkb_context_include_path_append(ctx, user_path);
121 user_path = asprintf_safe("%s/.xkb", home);
123 ret |= xkb_context_include_path_append(ctx, user_path);
128 extra = xkb_context_include_path_get_extra_path(ctx);
129 ret |= xkb_context_include_path_append(ctx, extra);
130 root = xkb_context_include_path_get_system_path(ctx);
131 ret |= xkb_context_include_path_append(ctx, root);
137 * Remove all entries in the context's include path.
140 xkb_context_include_path_clear(struct xkb_context *ctx)
144 darray_foreach(path, ctx->includes)
146 darray_free(ctx->includes);
148 darray_foreach(path, ctx->failed_includes)
150 darray_free(ctx->failed_includes);
154 * xkb_context_include_path_clear() + xkb_context_include_path_append_default()
157 xkb_context_include_path_reset_defaults(struct xkb_context *ctx)
159 xkb_context_include_path_clear(ctx);
160 return xkb_context_include_path_append_default(ctx);
164 * Returns the number of entries in the context's include path.
166 XKB_EXPORT unsigned int
167 xkb_context_num_include_paths(struct xkb_context *ctx)
169 return darray_size(ctx->includes);
173 * Returns the given entry in the context's include path, or NULL if an
174 * invalid index is passed.
176 XKB_EXPORT const char *
177 xkb_context_include_path_get(struct xkb_context *ctx, unsigned int idx)
179 if (idx >= xkb_context_num_include_paths(ctx))
182 return darray_item(ctx->includes, idx);
186 * Take a new reference on the context.
188 XKB_EXPORT struct xkb_context *
189 xkb_context_ref(struct xkb_context *ctx)
196 * Drop an existing reference on the context, and free it if the refcnt is
200 xkb_context_unref(struct xkb_context *ctx)
202 if (!ctx || --ctx->refcnt > 0)
205 free(ctx->x11_atom_cache);
206 xkb_context_include_path_clear(ctx);
207 atom_table_free(ctx->atom_table);
212 log_level_to_prefix(enum xkb_log_level level)
215 case XKB_LOG_LEVEL_DEBUG:
216 return "xkbcommon: DEBUG: ";
217 case XKB_LOG_LEVEL_INFO:
218 return "xkbcommon: INFO: ";
219 case XKB_LOG_LEVEL_WARNING:
220 return "xkbcommon: WARNING: ";
221 case XKB_LOG_LEVEL_ERROR:
222 return "xkbcommon: ERROR: ";
223 case XKB_LOG_LEVEL_CRITICAL:
224 return "xkbcommon: CRITICAL: ";
230 ATTR_PRINTF(3, 0) static void
231 default_log_fn(struct xkb_context *ctx, enum xkb_log_level level,
232 const char *fmt, va_list args)
234 const char *prefix = log_level_to_prefix(level);
237 fprintf(stderr, "%s", prefix);
238 vfprintf(stderr, fmt, args);
241 static enum xkb_log_level
242 log_level(const char *level) {
244 enum xkb_log_level lvl;
247 lvl = strtol(level, &endptr, 10);
248 if (errno == 0 && (endptr[0] == '\0' || is_space(endptr[0])))
250 if (istreq_prefix("crit", level))
251 return XKB_LOG_LEVEL_CRITICAL;
252 if (istreq_prefix("err", level))
253 return XKB_LOG_LEVEL_ERROR;
254 if (istreq_prefix("warn", level))
255 return XKB_LOG_LEVEL_WARNING;
256 if (istreq_prefix("info", level))
257 return XKB_LOG_LEVEL_INFO;
258 if (istreq_prefix("debug", level) || istreq_prefix("dbg", level))
259 return XKB_LOG_LEVEL_DEBUG;
261 return XKB_LOG_LEVEL_ERROR;
265 log_verbosity(const char *verbosity) {
270 v = strtol(verbosity, &endptr, 10);
278 * Create a new context.
280 XKB_EXPORT struct xkb_context *
281 xkb_context_new(enum xkb_context_flags flags)
284 struct xkb_context *ctx = calloc(1, sizeof(*ctx));
290 ctx->log_fn = default_log_fn;
291 ctx->log_level = XKB_LOG_LEVEL_ERROR;
292 ctx->log_verbosity = 0;
293 ctx->use_environment_names = !(flags & XKB_CONTEXT_NO_ENVIRONMENT_NAMES);
294 ctx->use_secure_getenv = !(flags & XKB_CONTEXT_NO_SECURE_GETENV);
296 /* Environment overwrites defaults. */
297 env = xkb_context_getenv(ctx, "XKB_LOG_LEVEL");
299 xkb_context_set_log_level(ctx, log_level(env));
301 env = xkb_context_getenv(ctx, "XKB_LOG_VERBOSITY");
303 xkb_context_set_log_verbosity(ctx, log_verbosity(env));
305 if (!(flags & XKB_CONTEXT_NO_DEFAULT_INCLUDES) &&
306 !xkb_context_include_path_append_default(ctx)) {
307 log_err(ctx, "failed to add default include path %s\n",
308 DFLT_XKB_CONFIG_ROOT);
309 xkb_context_unref(ctx);
313 ctx->atom_table = atom_table_new();
314 if (!ctx->atom_table) {
315 xkb_context_unref(ctx);
319 ctx->x11_atom_cache = NULL;
325 xkb_context_set_log_fn(struct xkb_context *ctx,
326 void (*log_fn)(struct xkb_context *ctx,
327 enum xkb_log_level level,
328 const char *fmt, va_list args))
330 ctx->log_fn = (log_fn ? log_fn : default_log_fn);
333 XKB_EXPORT enum xkb_log_level
334 xkb_context_get_log_level(struct xkb_context *ctx)
336 return ctx->log_level;
340 xkb_context_set_log_level(struct xkb_context *ctx, enum xkb_log_level level)
342 ctx->log_level = level;
346 xkb_context_get_log_verbosity(struct xkb_context *ctx)
348 return ctx->log_verbosity;
352 xkb_context_set_log_verbosity(struct xkb_context *ctx, int verbosity)
354 ctx->log_verbosity = verbosity;
358 xkb_context_get_user_data(struct xkb_context *ctx)
361 return ctx->user_data;
366 xkb_context_set_user_data(struct xkb_context *ctx, void *user_data)
368 ctx->user_data = user_data;