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>
34 #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);
55 if (!S_ISDIR(stat_buf.st_mode))
58 #if defined(HAVE_EACCESS)
59 if (eaccess(path, R_OK | X_OK) != 0)
61 #elif defined(HAVE_EUIDACCESS)
62 if (euidaccess(path, R_OK | X_OK) != 0)
66 darray_append(ctx->includes, tmp);
70 darray_append(ctx->failed_includes, tmp);
75 xkb_context_include_path_get_system_path(struct xkb_context *ctx)
77 const char *root = secure_getenv("XKB_CONFIG_ROOT");
78 return root ? root : DFLT_XKB_CONFIG_ROOT;
82 * Append the default include directories to the context.
85 xkb_context_include_path_append_default(struct xkb_context *ctx)
87 const char *home, *xdg, *root;
92 home = secure_getenv("HOME");
94 xdg = secure_getenv("XDG_CONFIG_HOME");
96 err = asprintf(&user_path, "%s/xkb", xdg);
98 ret |= xkb_context_include_path_append(ctx, user_path);
101 } else if (home != NULL) {
102 /* XDG_CONFIG_HOME fallback is $HOME/.config/ */
103 err = asprintf(&user_path, "%s/.config/xkb", home);
105 ret |= xkb_context_include_path_append(ctx, user_path);
111 err = asprintf(&user_path, "%s/.xkb", home);
113 ret |= xkb_context_include_path_append(ctx, user_path);
118 root = xkb_context_include_path_get_system_path(ctx);
119 ret |= xkb_context_include_path_append(ctx, root);
125 * Remove all entries in the context's include path.
128 xkb_context_include_path_clear(struct xkb_context *ctx)
132 darray_foreach(path, ctx->includes)
134 darray_free(ctx->includes);
136 darray_foreach(path, ctx->failed_includes)
138 darray_free(ctx->failed_includes);
142 * xkb_context_include_path_clear() + xkb_context_include_path_append_default()
145 xkb_context_include_path_reset_defaults(struct xkb_context *ctx)
147 xkb_context_include_path_clear(ctx);
148 return xkb_context_include_path_append_default(ctx);
152 * Returns the number of entries in the context's include path.
154 XKB_EXPORT unsigned int
155 xkb_context_num_include_paths(struct xkb_context *ctx)
157 return darray_size(ctx->includes);
161 * Returns the given entry in the context's include path, or NULL if an
162 * invalid index is passed.
164 XKB_EXPORT const char *
165 xkb_context_include_path_get(struct xkb_context *ctx, unsigned int idx)
167 if (idx >= xkb_context_num_include_paths(ctx))
170 return darray_item(ctx->includes, idx);
174 * Take a new reference on the context.
176 XKB_EXPORT struct xkb_context *
177 xkb_context_ref(struct xkb_context *ctx)
184 * Drop an existing reference on the context, and free it if the refcnt is
188 xkb_context_unref(struct xkb_context *ctx)
190 if (!ctx || --ctx->refcnt > 0)
193 xkb_context_include_path_clear(ctx);
194 atom_table_free(ctx->atom_table);
199 log_level_to_prefix(enum xkb_log_level level)
202 case XKB_LOG_LEVEL_DEBUG:
203 return "xkbcommon: DEBUG: ";
204 case XKB_LOG_LEVEL_INFO:
205 return "xkbcommon: INFO: ";
206 case XKB_LOG_LEVEL_WARNING:
207 return "xkbcommon: WARNING: ";
208 case XKB_LOG_LEVEL_ERROR:
209 return "xkbcommon: ERROR: ";
210 case XKB_LOG_LEVEL_CRITICAL:
211 return "xkbcommon: CRITICAL: ";
217 ATTR_PRINTF(3, 0) static void
218 default_log_fn(struct xkb_context *ctx, enum xkb_log_level level,
219 const char *fmt, va_list args)
221 const char *prefix = log_level_to_prefix(level);
224 fprintf(stderr, "%s", prefix);
225 vfprintf(stderr, fmt, args);
228 static enum xkb_log_level
229 log_level(const char *level) {
231 enum xkb_log_level lvl;
234 lvl = strtol(level, &endptr, 10);
235 if (errno == 0 && (endptr[0] == '\0' || is_space(endptr[0])))
237 if (istreq_prefix("crit", level))
238 return XKB_LOG_LEVEL_CRITICAL;
239 if (istreq_prefix("err", level))
240 return XKB_LOG_LEVEL_ERROR;
241 if (istreq_prefix("warn", level))
242 return XKB_LOG_LEVEL_WARNING;
243 if (istreq_prefix("info", level))
244 return XKB_LOG_LEVEL_INFO;
245 if (istreq_prefix("debug", level) || istreq_prefix("dbg", level))
246 return XKB_LOG_LEVEL_DEBUG;
248 return XKB_LOG_LEVEL_ERROR;
252 log_verbosity(const char *verbosity) {
257 v = strtol(verbosity, &endptr, 10);
265 * Create a new context.
267 XKB_EXPORT struct xkb_context *
268 xkb_context_new(enum xkb_context_flags flags)
271 struct xkb_context *ctx = calloc(1, sizeof(*ctx));
277 ctx->log_fn = default_log_fn;
278 ctx->log_level = XKB_LOG_LEVEL_ERROR;
279 ctx->log_verbosity = 0;
281 /* Environment overwrites defaults. */
282 env = secure_getenv("XKB_LOG_LEVEL");
284 xkb_context_set_log_level(ctx, log_level(env));
286 env = secure_getenv("XKB_LOG_VERBOSITY");
288 xkb_context_set_log_verbosity(ctx, log_verbosity(env));
290 if (!(flags & XKB_CONTEXT_NO_DEFAULT_INCLUDES) &&
291 !xkb_context_include_path_append_default(ctx)) {
292 log_err(ctx, "failed to add default include path %s\n",
293 DFLT_XKB_CONFIG_ROOT);
294 xkb_context_unref(ctx);
298 ctx->use_environment_names = !(flags & XKB_CONTEXT_NO_ENVIRONMENT_NAMES);
300 ctx->atom_table = atom_table_new();
301 if (!ctx->atom_table) {
302 xkb_context_unref(ctx);
310 xkb_context_set_log_fn(struct xkb_context *ctx,
311 void (*log_fn)(struct xkb_context *ctx,
312 enum xkb_log_level level,
313 const char *fmt, va_list args))
315 ctx->log_fn = (log_fn ? log_fn : default_log_fn);
318 XKB_EXPORT enum xkb_log_level
319 xkb_context_get_log_level(struct xkb_context *ctx)
321 return ctx->log_level;
325 xkb_context_set_log_level(struct xkb_context *ctx, enum xkb_log_level level)
327 ctx->log_level = level;
331 xkb_context_get_log_verbosity(struct xkb_context *ctx)
333 return ctx->log_verbosity;
337 xkb_context_set_log_verbosity(struct xkb_context *ctx, int verbosity)
339 ctx->log_verbosity = verbosity;
343 xkb_context_get_user_data(struct xkb_context *ctx)
346 return ctx->user_data;
351 xkb_context_set_user_data(struct xkb_context *ctx, void *user_data)
353 ctx->user_data = user_data;