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>
36 # define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)
42 #include "xkbcommon/xkbcommon.h"
47 * Append one directory to the context's include path.
50 xkb_context_include_path_append(struct xkb_context *ctx, const char *path)
60 err = stat(path, &stat_buf);
65 if (!S_ISDIR(stat_buf.st_mode)) {
70 if (!check_eaccess(path, R_OK | X_OK)) {
75 darray_append(ctx->includes, tmp);
76 log_dbg(ctx, "Include path added: %s\n", tmp);
81 darray_append(ctx->failed_includes, tmp);
82 log_dbg(ctx, "Include path failed: %s (%s)\n", tmp, strerror(err));
87 xkb_context_include_path_get_extra_path(struct xkb_context *ctx)
89 const char *extra = secure_getenv("XKB_CONFIG_EXTRA_PATH");
90 return extra ? extra : DFLT_XKB_CONFIG_EXTRA_PATH;
94 xkb_context_include_path_get_system_path(struct xkb_context *ctx)
96 const char *root = secure_getenv("XKB_CONFIG_ROOT");
97 return root ? root : DFLT_XKB_CONFIG_ROOT;
101 * Append the default include directories to the context.
104 xkb_context_include_path_append_default(struct xkb_context *ctx)
106 const char *home, *xdg, *root, *extra;
110 home = secure_getenv("HOME");
112 xdg = secure_getenv("XDG_CONFIG_HOME");
114 user_path = asprintf_safe("%s/xkb", xdg);
116 ret |= xkb_context_include_path_append(ctx, user_path);
119 } else if (home != NULL) {
120 /* XDG_CONFIG_HOME fallback is $HOME/.config/ */
121 user_path = asprintf_safe("%s/.config/xkb", home);
123 ret |= xkb_context_include_path_append(ctx, user_path);
129 user_path = asprintf_safe("%s/.xkb", home);
131 ret |= xkb_context_include_path_append(ctx, user_path);
136 extra = xkb_context_include_path_get_extra_path(ctx);
137 ret |= xkb_context_include_path_append(ctx, extra);
138 root = xkb_context_include_path_get_system_path(ctx);
139 ret |= xkb_context_include_path_append(ctx, root);
145 * Remove all entries in the context's include path.
148 xkb_context_include_path_clear(struct xkb_context *ctx)
152 darray_foreach(path, ctx->includes)
154 darray_free(ctx->includes);
156 darray_foreach(path, ctx->failed_includes)
158 darray_free(ctx->failed_includes);
162 * xkb_context_include_path_clear() + xkb_context_include_path_append_default()
165 xkb_context_include_path_reset_defaults(struct xkb_context *ctx)
167 xkb_context_include_path_clear(ctx);
168 return xkb_context_include_path_append_default(ctx);
172 * Returns the number of entries in the context's include path.
174 XKB_EXPORT unsigned int
175 xkb_context_num_include_paths(struct xkb_context *ctx)
177 return darray_size(ctx->includes);
181 * Returns the given entry in the context's include path, or NULL if an
182 * invalid index is passed.
184 XKB_EXPORT const char *
185 xkb_context_include_path_get(struct xkb_context *ctx, unsigned int idx)
187 if (idx >= xkb_context_num_include_paths(ctx))
190 return darray_item(ctx->includes, idx);
194 * Take a new reference on the context.
196 XKB_EXPORT struct xkb_context *
197 xkb_context_ref(struct xkb_context *ctx)
204 * Drop an existing reference on the context, and free it if the refcnt is
208 xkb_context_unref(struct xkb_context *ctx)
210 if (!ctx || --ctx->refcnt > 0)
213 free(ctx->x11_atom_cache);
214 xkb_context_include_path_clear(ctx);
215 atom_table_free(ctx->atom_table);
220 log_level_to_prefix(enum xkb_log_level level)
223 case XKB_LOG_LEVEL_DEBUG:
224 return "xkbcommon: DEBUG: ";
225 case XKB_LOG_LEVEL_INFO:
226 return "xkbcommon: INFO: ";
227 case XKB_LOG_LEVEL_WARNING:
228 return "xkbcommon: WARNING: ";
229 case XKB_LOG_LEVEL_ERROR:
230 return "xkbcommon: ERROR: ";
231 case XKB_LOG_LEVEL_CRITICAL:
232 return "xkbcommon: CRITICAL: ";
238 ATTR_PRINTF(3, 0) static void
239 default_log_fn(struct xkb_context *ctx, enum xkb_log_level level,
240 const char *fmt, va_list args)
242 const char *prefix = log_level_to_prefix(level);
245 fprintf(stderr, "%s", prefix);
246 vfprintf(stderr, fmt, args);
249 static enum xkb_log_level
250 log_level(const char *level) {
252 enum xkb_log_level lvl;
255 lvl = strtol(level, &endptr, 10);
256 if (errno == 0 && (endptr[0] == '\0' || is_space(endptr[0])))
258 if (istreq_prefix("crit", level))
259 return XKB_LOG_LEVEL_CRITICAL;
260 if (istreq_prefix("err", level))
261 return XKB_LOG_LEVEL_ERROR;
262 if (istreq_prefix("warn", level))
263 return XKB_LOG_LEVEL_WARNING;
264 if (istreq_prefix("info", level))
265 return XKB_LOG_LEVEL_INFO;
266 if (istreq_prefix("debug", level) || istreq_prefix("dbg", level))
267 return XKB_LOG_LEVEL_DEBUG;
269 return XKB_LOG_LEVEL_ERROR;
273 log_verbosity(const char *verbosity) {
278 v = strtol(verbosity, &endptr, 10);
286 * Create a new context.
288 XKB_EXPORT struct xkb_context *
289 xkb_context_new(enum xkb_context_flags flags)
292 struct xkb_context *ctx = calloc(1, sizeof(*ctx));
298 ctx->log_fn = default_log_fn;
299 ctx->log_level = XKB_LOG_LEVEL_ERROR;
300 ctx->log_verbosity = 0;
302 /* Environment overwrites defaults. */
303 env = secure_getenv("XKB_LOG_LEVEL");
305 xkb_context_set_log_level(ctx, log_level(env));
307 env = secure_getenv("XKB_LOG_VERBOSITY");
309 xkb_context_set_log_verbosity(ctx, log_verbosity(env));
311 if (!(flags & XKB_CONTEXT_NO_DEFAULT_INCLUDES) &&
312 !xkb_context_include_path_append_default(ctx)) {
313 log_err(ctx, "failed to add default include path %s\n",
314 DFLT_XKB_CONFIG_ROOT);
315 xkb_context_unref(ctx);
319 ctx->use_environment_names = !(flags & XKB_CONTEXT_NO_ENVIRONMENT_NAMES);
321 ctx->atom_table = atom_table_new();
322 if (!ctx->atom_table) {
323 xkb_context_unref(ctx);
327 ctx->x11_atom_cache = NULL;
333 xkb_context_set_log_fn(struct xkb_context *ctx,
334 void (*log_fn)(struct xkb_context *ctx,
335 enum xkb_log_level level,
336 const char *fmt, va_list args))
338 ctx->log_fn = (log_fn ? log_fn : default_log_fn);
341 XKB_EXPORT enum xkb_log_level
342 xkb_context_get_log_level(struct xkb_context *ctx)
344 return ctx->log_level;
348 xkb_context_set_log_level(struct xkb_context *ctx, enum xkb_log_level level)
350 ctx->log_level = level;
354 xkb_context_get_log_verbosity(struct xkb_context *ctx)
356 return ctx->log_verbosity;
360 xkb_context_set_log_verbosity(struct xkb_context *ctx, int verbosity)
362 ctx->log_verbosity = verbosity;
366 xkb_context_get_user_data(struct xkb_context *ctx)
369 return ctx->user_data;
374 xkb_context_set_user_data(struct xkb_context *ctx, void *user_data)
376 ctx->user_data = user_data;