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>
27 #include <sys/types.h>
32 #include "xkbcommon/xkbcommon.h"
37 * Append one directory to the context's include path.
40 xkb_context_include_path_append(struct xkb_context *ctx, const char *path)
50 err = stat(path, &stat_buf);
53 if (!S_ISDIR(stat_buf.st_mode))
56 #if defined(HAVE_EACCESS)
57 if (eaccess(path, R_OK | X_OK) != 0)
59 #elif defined(HAVE_EUIDACCESS)
60 if (euidaccess(path, R_OK | X_OK) != 0)
64 darray_append(ctx->includes, tmp);
68 darray_append(ctx->failed_includes, tmp);
73 * Append the default include directories to the context.
76 xkb_context_include_path_append_default(struct xkb_context *ctx)
78 const char *home, *xdg, *root;
83 home = secure_getenv("HOME");
85 xdg = secure_getenv("XDG_CONFIG_HOME");
87 err = asprintf(&user_path, "%s/xkb", xdg);
89 ret |= xkb_context_include_path_append(ctx, user_path);
92 } else if (home != NULL) {
93 /* XDG_CONFIG_HOME fallback is $HOME/.config/ */
94 err = asprintf(&user_path, "%s/.config/xkb", home);
96 ret |= xkb_context_include_path_append(ctx, user_path);
102 err = asprintf(&user_path, "%s/.xkb", home);
104 ret |= xkb_context_include_path_append(ctx, user_path);
109 root = secure_getenv("XKB_CONFIG_ROOT");
111 ret |= xkb_context_include_path_append(ctx, root);
113 ret |= xkb_context_include_path_append(ctx, DFLT_XKB_CONFIG_ROOT);
119 * Remove all entries in the context's include path.
122 xkb_context_include_path_clear(struct xkb_context *ctx)
126 darray_foreach(path, ctx->includes)
128 darray_free(ctx->includes);
130 darray_foreach(path, ctx->failed_includes)
132 darray_free(ctx->failed_includes);
136 * xkb_context_include_path_clear() + xkb_context_include_path_append_default()
139 xkb_context_include_path_reset_defaults(struct xkb_context *ctx)
141 xkb_context_include_path_clear(ctx);
142 return xkb_context_include_path_append_default(ctx);
146 * Returns the number of entries in the context's include path.
148 XKB_EXPORT unsigned int
149 xkb_context_num_include_paths(struct xkb_context *ctx)
151 return darray_size(ctx->includes);
155 * Returns the given entry in the context's include path, or NULL if an
156 * invalid index is passed.
158 XKB_EXPORT const char *
159 xkb_context_include_path_get(struct xkb_context *ctx, unsigned int idx)
161 if (idx >= xkb_context_num_include_paths(ctx))
164 return darray_item(ctx->includes, idx);
168 * Take a new reference on the context.
170 XKB_EXPORT struct xkb_context *
171 xkb_context_ref(struct xkb_context *ctx)
178 * Drop an existing reference on the context, and free it if the refcnt is
182 xkb_context_unref(struct xkb_context *ctx)
184 if (!ctx || --ctx->refcnt > 0)
187 xkb_context_include_path_clear(ctx);
188 atom_table_free(ctx->atom_table);
193 log_level_to_prefix(enum xkb_log_level level)
196 case XKB_LOG_LEVEL_DEBUG:
197 return "xkbcommon: DEBUG: ";
198 case XKB_LOG_LEVEL_INFO:
199 return "xkbcommon: INFO: ";
200 case XKB_LOG_LEVEL_WARNING:
201 return "xkbcommon: WARNING: ";
202 case XKB_LOG_LEVEL_ERROR:
203 return "xkbcommon: ERROR: ";
204 case XKB_LOG_LEVEL_CRITICAL:
205 return "xkbcommon: CRITICAL: ";
211 ATTR_PRINTF(3, 0) static void
212 default_log_fn(struct xkb_context *ctx, enum xkb_log_level level,
213 const char *fmt, va_list args)
215 const char *prefix = log_level_to_prefix(level);
218 fprintf(stderr, "%s", prefix);
219 vfprintf(stderr, fmt, args);
222 static enum xkb_log_level
223 log_level(const char *level) {
225 enum xkb_log_level lvl;
228 lvl = strtol(level, &endptr, 10);
229 if (errno == 0 && (endptr[0] == '\0' || is_space(endptr[0])))
231 if (istreq_prefix("crit", level))
232 return XKB_LOG_LEVEL_CRITICAL;
233 if (istreq_prefix("err", level))
234 return XKB_LOG_LEVEL_ERROR;
235 if (istreq_prefix("warn", level))
236 return XKB_LOG_LEVEL_WARNING;
237 if (istreq_prefix("info", level))
238 return XKB_LOG_LEVEL_INFO;
239 if (istreq_prefix("debug", level) || istreq_prefix("dbg", level))
240 return XKB_LOG_LEVEL_DEBUG;
242 return XKB_LOG_LEVEL_ERROR;
246 log_verbosity(const char *verbosity) {
251 v = strtol(verbosity, &endptr, 10);
259 * Create a new context.
261 XKB_EXPORT struct xkb_context *
262 xkb_context_new(enum xkb_context_flags flags)
265 struct xkb_context *ctx = calloc(1, sizeof(*ctx));
271 ctx->log_fn = default_log_fn;
272 ctx->log_level = XKB_LOG_LEVEL_ERROR;
273 ctx->log_verbosity = 0;
275 /* Environment overwrites defaults. */
276 env = secure_getenv("XKB_LOG_LEVEL");
278 xkb_context_set_log_level(ctx, log_level(env));
280 env = secure_getenv("XKB_LOG_VERBOSITY");
282 xkb_context_set_log_verbosity(ctx, log_verbosity(env));
284 if (!(flags & XKB_CONTEXT_NO_DEFAULT_INCLUDES) &&
285 !xkb_context_include_path_append_default(ctx)) {
286 log_err(ctx, "failed to add default include path %s\n",
287 DFLT_XKB_CONFIG_ROOT);
288 xkb_context_unref(ctx);
292 ctx->use_environment_names = !(flags & XKB_CONTEXT_NO_ENVIRONMENT_NAMES);
294 ctx->atom_table = atom_table_new();
295 if (!ctx->atom_table) {
296 xkb_context_unref(ctx);
304 xkb_context_set_log_fn(struct xkb_context *ctx,
305 void (*log_fn)(struct xkb_context *ctx,
306 enum xkb_log_level level,
307 const char *fmt, va_list args))
309 ctx->log_fn = (log_fn ? log_fn : default_log_fn);
312 XKB_EXPORT enum xkb_log_level
313 xkb_context_get_log_level(struct xkb_context *ctx)
315 return ctx->log_level;
319 xkb_context_set_log_level(struct xkb_context *ctx, enum xkb_log_level level)
321 ctx->log_level = level;
325 xkb_context_get_log_verbosity(struct xkb_context *ctx)
327 return ctx->log_verbosity;
331 xkb_context_set_log_verbosity(struct xkb_context *ctx, int verbosity)
333 ctx->log_verbosity = verbosity;
337 xkb_context_get_user_data(struct xkb_context *ctx)
340 return ctx->user_data;
345 xkb_context_set_user_data(struct xkb_context *ctx, void *user_data)
347 ctx->user_data = user_data;