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 (!check_eaccess(path, R_OK | X_OK))
69 darray_append(ctx->includes, tmp);
73 darray_append(ctx->failed_includes, tmp);
78 xkb_context_include_path_get_system_path(struct xkb_context *ctx)
80 const char *root = secure_getenv("XKB_CONFIG_ROOT");
81 return root ? root : DFLT_XKB_CONFIG_ROOT;
85 * Append the default include directories to the context.
88 xkb_context_include_path_append_default(struct xkb_context *ctx)
90 const char *home, *xdg, *root;
95 home = secure_getenv("HOME");
97 xdg = secure_getenv("XDG_CONFIG_HOME");
99 err = asprintf(&user_path, "%s/xkb", xdg);
101 ret |= xkb_context_include_path_append(ctx, user_path);
104 } else if (home != NULL) {
105 /* XDG_CONFIG_HOME fallback is $HOME/.config/ */
106 err = asprintf(&user_path, "%s/.config/xkb", home);
108 ret |= xkb_context_include_path_append(ctx, user_path);
114 err = asprintf(&user_path, "%s/.xkb", home);
116 ret |= xkb_context_include_path_append(ctx, user_path);
121 root = xkb_context_include_path_get_system_path(ctx);
122 ret |= xkb_context_include_path_append(ctx, root);
128 * Remove all entries in the context's include path.
131 xkb_context_include_path_clear(struct xkb_context *ctx)
135 darray_foreach(path, ctx->includes)
137 darray_free(ctx->includes);
139 darray_foreach(path, ctx->failed_includes)
141 darray_free(ctx->failed_includes);
145 * xkb_context_include_path_clear() + xkb_context_include_path_append_default()
148 xkb_context_include_path_reset_defaults(struct xkb_context *ctx)
150 xkb_context_include_path_clear(ctx);
151 return xkb_context_include_path_append_default(ctx);
155 * Returns the number of entries in the context's include path.
157 XKB_EXPORT unsigned int
158 xkb_context_num_include_paths(struct xkb_context *ctx)
160 return darray_size(ctx->includes);
164 * Returns the given entry in the context's include path, or NULL if an
165 * invalid index is passed.
167 XKB_EXPORT const char *
168 xkb_context_include_path_get(struct xkb_context *ctx, unsigned int idx)
170 if (idx >= xkb_context_num_include_paths(ctx))
173 return darray_item(ctx->includes, idx);
177 * Take a new reference on the context.
179 XKB_EXPORT struct xkb_context *
180 xkb_context_ref(struct xkb_context *ctx)
187 * Drop an existing reference on the context, and free it if the refcnt is
191 xkb_context_unref(struct xkb_context *ctx)
193 if (!ctx || --ctx->refcnt > 0)
196 xkb_context_include_path_clear(ctx);
197 atom_table_free(ctx->atom_table);
202 log_level_to_prefix(enum xkb_log_level level)
205 case XKB_LOG_LEVEL_DEBUG:
206 return "xkbcommon: DEBUG: ";
207 case XKB_LOG_LEVEL_INFO:
208 return "xkbcommon: INFO: ";
209 case XKB_LOG_LEVEL_WARNING:
210 return "xkbcommon: WARNING: ";
211 case XKB_LOG_LEVEL_ERROR:
212 return "xkbcommon: ERROR: ";
213 case XKB_LOG_LEVEL_CRITICAL:
214 return "xkbcommon: CRITICAL: ";
220 ATTR_PRINTF(3, 0) static void
221 default_log_fn(struct xkb_context *ctx, enum xkb_log_level level,
222 const char *fmt, va_list args)
224 const char *prefix = log_level_to_prefix(level);
227 fprintf(stderr, "%s", prefix);
228 vfprintf(stderr, fmt, args);
231 static enum xkb_log_level
232 log_level(const char *level) {
234 enum xkb_log_level lvl;
237 lvl = strtol(level, &endptr, 10);
238 if (errno == 0 && (endptr[0] == '\0' || is_space(endptr[0])))
240 if (istreq_prefix("crit", level))
241 return XKB_LOG_LEVEL_CRITICAL;
242 if (istreq_prefix("err", level))
243 return XKB_LOG_LEVEL_ERROR;
244 if (istreq_prefix("warn", level))
245 return XKB_LOG_LEVEL_WARNING;
246 if (istreq_prefix("info", level))
247 return XKB_LOG_LEVEL_INFO;
248 if (istreq_prefix("debug", level) || istreq_prefix("dbg", level))
249 return XKB_LOG_LEVEL_DEBUG;
251 return XKB_LOG_LEVEL_ERROR;
255 log_verbosity(const char *verbosity) {
260 v = strtol(verbosity, &endptr, 10);
268 * Create a new context.
270 XKB_EXPORT struct xkb_context *
271 xkb_context_new(enum xkb_context_flags flags)
274 struct xkb_context *ctx = calloc(1, sizeof(*ctx));
280 ctx->log_fn = default_log_fn;
281 ctx->log_level = XKB_LOG_LEVEL_ERROR;
282 ctx->log_verbosity = 0;
284 /* Environment overwrites defaults. */
285 env = secure_getenv("XKB_LOG_LEVEL");
287 xkb_context_set_log_level(ctx, log_level(env));
289 env = secure_getenv("XKB_LOG_VERBOSITY");
291 xkb_context_set_log_verbosity(ctx, log_verbosity(env));
293 if (!(flags & XKB_CONTEXT_NO_DEFAULT_INCLUDES) &&
294 !xkb_context_include_path_append_default(ctx)) {
295 log_err(ctx, "failed to add default include path %s\n",
296 DFLT_XKB_CONFIG_ROOT);
297 xkb_context_unref(ctx);
301 ctx->use_environment_names = !(flags & XKB_CONTEXT_NO_ENVIRONMENT_NAMES);
303 ctx->atom_table = atom_table_new();
304 if (!ctx->atom_table) {
305 xkb_context_unref(ctx);
313 xkb_context_set_log_fn(struct xkb_context *ctx,
314 void (*log_fn)(struct xkb_context *ctx,
315 enum xkb_log_level level,
316 const char *fmt, va_list args))
318 ctx->log_fn = (log_fn ? log_fn : default_log_fn);
321 XKB_EXPORT enum xkb_log_level
322 xkb_context_get_log_level(struct xkb_context *ctx)
324 return ctx->log_level;
328 xkb_context_set_log_level(struct xkb_context *ctx, enum xkb_log_level level)
330 ctx->log_level = level;
334 xkb_context_get_log_verbosity(struct xkb_context *ctx)
336 return ctx->log_verbosity;
340 xkb_context_set_log_verbosity(struct xkb_context *ctx, int verbosity)
342 ctx->log_verbosity = verbosity;
346 xkb_context_get_user_data(struct xkb_context *ctx)
349 return ctx->user_data;
354 xkb_context_set_user_data(struct xkb_context *ctx, void *user_data)
356 ctx->user_data = user_data;