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_system_path(struct xkb_context *ctx)
89 const char *root = secure_getenv("XKB_CONFIG_ROOT");
90 return root ? root : DFLT_XKB_CONFIG_ROOT;
94 * Append the default include directories to the context.
97 xkb_context_include_path_append_default(struct xkb_context *ctx)
99 const char *home, *xdg, *root;
104 home = secure_getenv("HOME");
106 xdg = secure_getenv("XDG_CONFIG_HOME");
108 err = asprintf(&user_path, "%s/xkb", xdg);
110 ret |= xkb_context_include_path_append(ctx, user_path);
113 } else if (home != NULL) {
114 /* XDG_CONFIG_HOME fallback is $HOME/.config/ */
115 err = asprintf(&user_path, "%s/.config/xkb", home);
117 ret |= xkb_context_include_path_append(ctx, user_path);
123 err = asprintf(&user_path, "%s/.xkb", home);
125 ret |= xkb_context_include_path_append(ctx, user_path);
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 xkb_context_include_path_clear(ctx);
206 atom_table_free(ctx->atom_table);
211 log_level_to_prefix(enum xkb_log_level level)
214 case XKB_LOG_LEVEL_DEBUG:
215 return "xkbcommon: DEBUG: ";
216 case XKB_LOG_LEVEL_INFO:
217 return "xkbcommon: INFO: ";
218 case XKB_LOG_LEVEL_WARNING:
219 return "xkbcommon: WARNING: ";
220 case XKB_LOG_LEVEL_ERROR:
221 return "xkbcommon: ERROR: ";
222 case XKB_LOG_LEVEL_CRITICAL:
223 return "xkbcommon: CRITICAL: ";
229 ATTR_PRINTF(3, 0) static void
230 default_log_fn(struct xkb_context *ctx, enum xkb_log_level level,
231 const char *fmt, va_list args)
233 const char *prefix = log_level_to_prefix(level);
236 fprintf(stderr, "%s", prefix);
237 vfprintf(stderr, fmt, args);
240 static enum xkb_log_level
241 log_level(const char *level) {
243 enum xkb_log_level lvl;
246 lvl = strtol(level, &endptr, 10);
247 if (errno == 0 && (endptr[0] == '\0' || is_space(endptr[0])))
249 if (istreq_prefix("crit", level))
250 return XKB_LOG_LEVEL_CRITICAL;
251 if (istreq_prefix("err", level))
252 return XKB_LOG_LEVEL_ERROR;
253 if (istreq_prefix("warn", level))
254 return XKB_LOG_LEVEL_WARNING;
255 if (istreq_prefix("info", level))
256 return XKB_LOG_LEVEL_INFO;
257 if (istreq_prefix("debug", level) || istreq_prefix("dbg", level))
258 return XKB_LOG_LEVEL_DEBUG;
260 return XKB_LOG_LEVEL_ERROR;
264 log_verbosity(const char *verbosity) {
269 v = strtol(verbosity, &endptr, 10);
277 * Create a new context.
279 XKB_EXPORT struct xkb_context *
280 xkb_context_new(enum xkb_context_flags flags)
283 struct xkb_context *ctx = calloc(1, sizeof(*ctx));
289 ctx->log_fn = default_log_fn;
290 ctx->log_level = XKB_LOG_LEVEL_ERROR;
291 ctx->log_verbosity = 0;
293 /* Environment overwrites defaults. */
294 env = secure_getenv("XKB_LOG_LEVEL");
296 xkb_context_set_log_level(ctx, log_level(env));
298 env = secure_getenv("XKB_LOG_VERBOSITY");
300 xkb_context_set_log_verbosity(ctx, log_verbosity(env));
302 if (!(flags & XKB_CONTEXT_NO_DEFAULT_INCLUDES) &&
303 !xkb_context_include_path_append_default(ctx)) {
304 log_err(ctx, "failed to add default include path %s\n",
305 DFLT_XKB_CONFIG_ROOT);
306 xkb_context_unref(ctx);
310 ctx->use_environment_names = !(flags & XKB_CONTEXT_NO_ENVIRONMENT_NAMES);
312 ctx->atom_table = atom_table_new();
313 if (!ctx->atom_table) {
314 xkb_context_unref(ctx);
322 xkb_context_set_log_fn(struct xkb_context *ctx,
323 void (*log_fn)(struct xkb_context *ctx,
324 enum xkb_log_level level,
325 const char *fmt, va_list args))
327 ctx->log_fn = (log_fn ? log_fn : default_log_fn);
330 XKB_EXPORT enum xkb_log_level
331 xkb_context_get_log_level(struct xkb_context *ctx)
333 return ctx->log_level;
337 xkb_context_set_log_level(struct xkb_context *ctx, enum xkb_log_level level)
339 ctx->log_level = level;
343 xkb_context_get_log_verbosity(struct xkb_context *ctx)
345 return ctx->log_verbosity;
349 xkb_context_set_log_verbosity(struct xkb_context *ctx, int verbosity)
351 ctx->log_verbosity = verbosity;
355 xkb_context_get_user_data(struct xkb_context *ctx)
358 return ctx->user_data;
363 xkb_context_set_user_data(struct xkb_context *ctx, void *user_data)
365 ctx->user_data = user_data;