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);
63 if (!S_ISDIR(stat_buf.st_mode))
66 #if defined(HAVE_EACCESS)
67 if (eaccess(path, R_OK | X_OK) != 0)
69 #elif defined(HAVE_EUIDACCESS)
70 if (euidaccess(path, R_OK | X_OK) != 0)
74 darray_append(ctx->includes, tmp);
78 darray_append(ctx->failed_includes, tmp);
83 xkb_context_include_path_get_system_path(struct xkb_context *ctx)
85 const char *root = secure_getenv("XKB_CONFIG_ROOT");
86 return root ? root : DFLT_XKB_CONFIG_ROOT;
90 * Append the default include directories to the context.
93 xkb_context_include_path_append_default(struct xkb_context *ctx)
95 const char *home, *xdg, *root;
100 home = secure_getenv("HOME");
102 xdg = secure_getenv("XDG_CONFIG_HOME");
104 err = asprintf(&user_path, "%s/xkb", xdg);
106 ret |= xkb_context_include_path_append(ctx, user_path);
109 } else if (home != NULL) {
110 /* XDG_CONFIG_HOME fallback is $HOME/.config/ */
111 err = asprintf(&user_path, "%s/.config/xkb", home);
113 ret |= xkb_context_include_path_append(ctx, user_path);
119 err = asprintf(&user_path, "%s/.xkb", home);
121 ret |= xkb_context_include_path_append(ctx, user_path);
126 root = xkb_context_include_path_get_system_path(ctx);
127 ret |= xkb_context_include_path_append(ctx, root);
133 * Remove all entries in the context's include path.
136 xkb_context_include_path_clear(struct xkb_context *ctx)
140 darray_foreach(path, ctx->includes)
142 darray_free(ctx->includes);
144 darray_foreach(path, ctx->failed_includes)
146 darray_free(ctx->failed_includes);
150 * xkb_context_include_path_clear() + xkb_context_include_path_append_default()
153 xkb_context_include_path_reset_defaults(struct xkb_context *ctx)
155 xkb_context_include_path_clear(ctx);
156 return xkb_context_include_path_append_default(ctx);
160 * Returns the number of entries in the context's include path.
162 XKB_EXPORT unsigned int
163 xkb_context_num_include_paths(struct xkb_context *ctx)
165 return darray_size(ctx->includes);
169 * Returns the given entry in the context's include path, or NULL if an
170 * invalid index is passed.
172 XKB_EXPORT const char *
173 xkb_context_include_path_get(struct xkb_context *ctx, unsigned int idx)
175 if (idx >= xkb_context_num_include_paths(ctx))
178 return darray_item(ctx->includes, idx);
182 * Take a new reference on the context.
184 XKB_EXPORT struct xkb_context *
185 xkb_context_ref(struct xkb_context *ctx)
192 * Drop an existing reference on the context, and free it if the refcnt is
196 xkb_context_unref(struct xkb_context *ctx)
198 if (!ctx || --ctx->refcnt > 0)
201 xkb_context_include_path_clear(ctx);
202 atom_table_free(ctx->atom_table);
207 log_level_to_prefix(enum xkb_log_level level)
210 case XKB_LOG_LEVEL_DEBUG:
211 return "xkbcommon: DEBUG: ";
212 case XKB_LOG_LEVEL_INFO:
213 return "xkbcommon: INFO: ";
214 case XKB_LOG_LEVEL_WARNING:
215 return "xkbcommon: WARNING: ";
216 case XKB_LOG_LEVEL_ERROR:
217 return "xkbcommon: ERROR: ";
218 case XKB_LOG_LEVEL_CRITICAL:
219 return "xkbcommon: CRITICAL: ";
225 ATTR_PRINTF(3, 0) static void
226 default_log_fn(struct xkb_context *ctx, enum xkb_log_level level,
227 const char *fmt, va_list args)
229 const char *prefix = log_level_to_prefix(level);
232 fprintf(stderr, "%s", prefix);
233 vfprintf(stderr, fmt, args);
236 static enum xkb_log_level
237 log_level(const char *level) {
239 enum xkb_log_level lvl;
242 lvl = strtol(level, &endptr, 10);
243 if (errno == 0 && (endptr[0] == '\0' || is_space(endptr[0])))
245 if (istreq_prefix("crit", level))
246 return XKB_LOG_LEVEL_CRITICAL;
247 if (istreq_prefix("err", level))
248 return XKB_LOG_LEVEL_ERROR;
249 if (istreq_prefix("warn", level))
250 return XKB_LOG_LEVEL_WARNING;
251 if (istreq_prefix("info", level))
252 return XKB_LOG_LEVEL_INFO;
253 if (istreq_prefix("debug", level) || istreq_prefix("dbg", level))
254 return XKB_LOG_LEVEL_DEBUG;
256 return XKB_LOG_LEVEL_ERROR;
260 log_verbosity(const char *verbosity) {
265 v = strtol(verbosity, &endptr, 10);
273 * Create a new context.
275 XKB_EXPORT struct xkb_context *
276 xkb_context_new(enum xkb_context_flags flags)
279 struct xkb_context *ctx = calloc(1, sizeof(*ctx));
285 ctx->log_fn = default_log_fn;
286 ctx->log_level = XKB_LOG_LEVEL_ERROR;
287 ctx->log_verbosity = 0;
289 /* Environment overwrites defaults. */
290 env = secure_getenv("XKB_LOG_LEVEL");
292 xkb_context_set_log_level(ctx, log_level(env));
294 env = secure_getenv("XKB_LOG_VERBOSITY");
296 xkb_context_set_log_verbosity(ctx, log_verbosity(env));
298 if (!(flags & XKB_CONTEXT_NO_DEFAULT_INCLUDES) &&
299 !xkb_context_include_path_append_default(ctx)) {
300 log_err(ctx, "failed to add default include path %s\n",
301 DFLT_XKB_CONFIG_ROOT);
302 xkb_context_unref(ctx);
306 ctx->use_environment_names = !(flags & XKB_CONTEXT_NO_ENVIRONMENT_NAMES);
308 ctx->atom_table = atom_table_new();
309 if (!ctx->atom_table) {
310 xkb_context_unref(ctx);
318 xkb_context_set_log_fn(struct xkb_context *ctx,
319 void (*log_fn)(struct xkb_context *ctx,
320 enum xkb_log_level level,
321 const char *fmt, va_list args))
323 ctx->log_fn = (log_fn ? log_fn : default_log_fn);
326 XKB_EXPORT enum xkb_log_level
327 xkb_context_get_log_level(struct xkb_context *ctx)
329 return ctx->log_level;
333 xkb_context_set_log_level(struct xkb_context *ctx, enum xkb_log_level level)
335 ctx->log_level = level;
339 xkb_context_get_log_verbosity(struct xkb_context *ctx)
341 return ctx->log_verbosity;
345 xkb_context_set_log_verbosity(struct xkb_context *ctx, int verbosity)
347 ctx->log_verbosity = verbosity;
351 xkb_context_get_user_data(struct xkb_context *ctx)
354 return ctx->user_data;
359 xkb_context_set_user_data(struct xkb_context *ctx, void *user_data)
361 ctx->user_data = user_data;