src/context.c

   1 /*
   2  * Copyright © 2012 Intel Corporation
   3  * Copyright © 2012 Ran Benita
   4  *
   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:
  11  *
  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
  14  * Software.
  15  *
  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.
  23  *
  24  * Author: Daniel Stone <daniel@fooishbar.org>
  25  */
  26
  27 #include "config.h"
  28
  29 #include <sys/types.h>
  30 #include <sys/stat.h>
  31 #include <errno.h>
  32 #ifdef _MSC_VER
  33 # include <direct.h>
  34 # include <io.h>
  35 # ifndef S_ISDIR
  36 #  define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)
  37 # endif
  38 #else
  39 # include <unistd.h>
  40 #endif
  41
  42 #include "xkbcommon/xkbcommon.h"
  43 #include "utils.h"
  44 #include "context.h"
  45
  46 /**
  47  * Append one directory to the context's include path.
  48  */
  49 XKB_EXPORT int
  50 xkb_context_include_path_append(struct xkb_context *ctx, const char *path)
  51 {
  52     struct stat stat_buf;
  53     int err;
  54     char *tmp;
  55
  56     tmp = strdup(path);
  57     if (!tmp)
  58         goto err;
  59
  60     err = stat(path, &stat_buf);
  61     if (err != 0) {
  62         err = errno;
  63         goto err;
  64     }
  65     if (!S_ISDIR(stat_buf.st_mode)) {
  66         err = ENOTDIR;
  67         goto err;
  68     }
  69
  70     if (!check_eaccess(path, R_OK | X_OK)) {
  71         err = EACCES;
  72         goto err;
  73     }
  74
  75     darray_append(ctx->includes, tmp);
  76     log_dbg(ctx, "Include path added: %s\n", tmp);
  77
  78     return 1;
  79
  80 err:
  81     darray_append(ctx->failed_includes, tmp);
  82     log_dbg(ctx, "Include path failed: %s (%s)\n", tmp, strerror(err));
  83     return 0;
  84 }
  85
  86 const char *
  87 xkb_context_include_path_get_system_path(struct xkb_context *ctx)
  88 {
  89     const char *root = secure_getenv("XKB_CONFIG_ROOT");
  90     return root ? root : DFLT_XKB_CONFIG_ROOT;
  91 }
  92
  93 /**
  94  * Append the default include directories to the context.
  95  */
  96 XKB_EXPORT int
  97 xkb_context_include_path_append_default(struct xkb_context *ctx)
  98 {
  99     const char *home, *xdg, *root;
 100     char *user_path;
 101     int err;
 102     int ret = 0;
 103
 104     home = secure_getenv("HOME");
 105
 106     xdg = secure_getenv("XDG_CONFIG_HOME");
 107     if (xdg != NULL) {
 108         err = asprintf(&user_path, "%s/xkb", xdg);
 109         if (err >= 0) {
 110             ret |= xkb_context_include_path_append(ctx, user_path);
 111             free(user_path);
 112         }
 113     } else if (home != NULL) {
 114         /* XDG_CONFIG_HOME fallback is $HOME/.config/ */
 115         err = asprintf(&user_path, "%s/.config/xkb", home);
 116         if (err >= 0) {
 117             ret |= xkb_context_include_path_append(ctx, user_path);
 118             free(user_path);
 119         }
 120     }
 121
 122     if (home != NULL) {
 123         err = asprintf(&user_path, "%s/.xkb", home);
 124         if (err >= 0) {
 125             ret |= xkb_context_include_path_append(ctx, user_path);
 126             free(user_path);
 127         }
 128     }
 129
 130     root = xkb_context_include_path_get_system_path(ctx);
 131     ret |= xkb_context_include_path_append(ctx, root);
 132
 133     return ret;
 134 }
 135
 136 /**
 137  * Remove all entries in the context's include path.
 138  */
 139 XKB_EXPORT void
 140 xkb_context_include_path_clear(struct xkb_context *ctx)
 141 {
 142     char **path;
 143
 144     darray_foreach(path, ctx->includes)
 145         free(*path);
 146     darray_free(ctx->includes);
 147
 148     darray_foreach(path, ctx->failed_includes)
 149         free(*path);
 150     darray_free(ctx->failed_includes);
 151 }
 152
 153 /**
 154  * xkb_context_include_path_clear() + xkb_context_include_path_append_default()
 155  */
 156 XKB_EXPORT int
 157 xkb_context_include_path_reset_defaults(struct xkb_context *ctx)
 158 {
 159     xkb_context_include_path_clear(ctx);
 160     return xkb_context_include_path_append_default(ctx);
 161 }
 162
 163 /**
 164  * Returns the number of entries in the context's include path.
 165  */
 166 XKB_EXPORT unsigned int
 167 xkb_context_num_include_paths(struct xkb_context *ctx)
 168 {
 169     return darray_size(ctx->includes);
 170 }
 171
 172 /**
 173  * Returns the given entry in the context's include path, or NULL if an
 174  * invalid index is passed.
 175  */
 176 XKB_EXPORT const char *
 177 xkb_context_include_path_get(struct xkb_context *ctx, unsigned int idx)
 178 {
 179     if (idx >= xkb_context_num_include_paths(ctx))
 180         return NULL;
 181
 182     return darray_item(ctx->includes, idx);
 183 }
 184
 185 /**
 186  * Take a new reference on the context.
 187  */
 188 XKB_EXPORT struct xkb_context *
 189 xkb_context_ref(struct xkb_context *ctx)
 190 {
 191     ctx->refcnt++;
 192     return ctx;
 193 }
 194
 195 /**
 196  * Drop an existing reference on the context, and free it if the refcnt is
 197  * now 0.
 198  */
 199 XKB_EXPORT void
 200 xkb_context_unref(struct xkb_context *ctx)
 201 {
 202     if (!ctx || --ctx->refcnt > 0)
 203         return;
 204
 205     xkb_context_include_path_clear(ctx);
 206     atom_table_free(ctx->atom_table);
 207     free(ctx);
 208 }
 209
 210 static const char *
 211 log_level_to_prefix(enum xkb_log_level level)
 212 {
 213     switch (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: ";
 224     default:
 225         return NULL;
 226     }
 227 }
 228
 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)
 232 {
 233     const char *prefix = log_level_to_prefix(level);
 234
 235     if (prefix)
 236         fprintf(stderr, "%s", prefix);
 237     vfprintf(stderr, fmt, args);
 238 }
 239
 240 static enum xkb_log_level
 241 log_level(const char *level) {
 242     char *endptr;
 243     enum xkb_log_level lvl;
 244
 245     errno = 0;
 246     lvl = strtol(level, &endptr, 10);
 247     if (errno == 0 && (endptr[0] == '\0' || is_space(endptr[0])))
 248         return lvl;
 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;
 259
 260     return XKB_LOG_LEVEL_ERROR;
 261 }
 262
 263 static int
 264 log_verbosity(const char *verbosity) {
 265     char *endptr;
 266     int v;
 267
 268     errno = 0;
 269     v = strtol(verbosity, &endptr, 10);
 270     if (errno == 0)
 271         return v;
 272
 273     return 0;
 274 }
 275
 276 /**
 277  * Create a new context.
 278  */
 279 XKB_EXPORT struct xkb_context *
 280 xkb_context_new(enum xkb_context_flags flags)
 281 {
 282     const char *env;
 283     struct xkb_context *ctx = calloc(1, sizeof(*ctx));
 284
 285     if (!ctx)
 286         return NULL;
 287
 288     ctx->refcnt = 1;
 289     ctx->log_fn = default_log_fn;
 290     ctx->log_level = XKB_LOG_LEVEL_ERROR;
 291     ctx->log_verbosity = 0;
 292
 293     /* Environment overwrites defaults. */
 294     env = secure_getenv("XKB_LOG_LEVEL");
 295     if (env)
 296         xkb_context_set_log_level(ctx, log_level(env));
 297
 298     env = secure_getenv("XKB_LOG_VERBOSITY");
 299     if (env)
 300         xkb_context_set_log_verbosity(ctx, log_verbosity(env));
 301
 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);
 307         return NULL;
 308     }
 309
 310     ctx->use_environment_names = !(flags & XKB_CONTEXT_NO_ENVIRONMENT_NAMES);
 311
 312     ctx->atom_table = atom_table_new();
 313     if (!ctx->atom_table) {
 314         xkb_context_unref(ctx);
 315         return NULL;
 316     }
 317
 318     return ctx;
 319 }
 320
 321 XKB_EXPORT void
 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))
 326 {
 327     ctx->log_fn = (log_fn ? log_fn : default_log_fn);
 328 }
 329
 330 XKB_EXPORT enum xkb_log_level
 331 xkb_context_get_log_level(struct xkb_context *ctx)
 332 {
 333     return ctx->log_level;
 334 }
 335
 336 XKB_EXPORT void
 337 xkb_context_set_log_level(struct xkb_context *ctx, enum xkb_log_level level)
 338 {
 339     ctx->log_level = level;
 340 }
 341
 342 XKB_EXPORT int
 343 xkb_context_get_log_verbosity(struct xkb_context *ctx)
 344 {
 345     return ctx->log_verbosity;
 346 }
 347
 348 XKB_EXPORT void
 349 xkb_context_set_log_verbosity(struct xkb_context *ctx, int verbosity)
 350 {
 351     ctx->log_verbosity = verbosity;
 352 }
 353
 354 XKB_EXPORT void *
 355 xkb_context_get_user_data(struct xkb_context *ctx)
 356 {
 357     if (ctx)
 358         return ctx->user_data;
 359     return NULL;
 360 }
 361
 362 XKB_EXPORT void
 363 xkb_context_set_user_data(struct xkb_context *ctx, void *user_data)
 364 {
 365     ctx->user_data = user_data;
 366 }