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         goto err;
  63     if (!S_ISDIR(stat_buf.st_mode))
  64         goto err;
  65
  66     if (!check_eaccess(path, R_OK | X_OK))
  67         goto err;
  68
  69     darray_append(ctx->includes, tmp);
  70     return 1;
  71
  72 err:
  73     darray_append(ctx->failed_includes, tmp);
  74     return 0;
  75 }
  76
  77 const char *
  78 xkb_context_include_path_get_system_path(struct xkb_context *ctx)
  79 {
  80     const char *root = secure_getenv("XKB_CONFIG_ROOT");
  81     return root ? root : DFLT_XKB_CONFIG_ROOT;
  82 }
  83
  84 /**
  85  * Append the default include directories to the context.
  86  */
  87 XKB_EXPORT int
  88 xkb_context_include_path_append_default(struct xkb_context *ctx)
  89 {
  90     const char *home, *xdg, *root;
  91     char *user_path;
  92     int err;
  93     int ret = 0;
  94
  95     home = secure_getenv("HOME");
  96
  97     xdg = secure_getenv("XDG_CONFIG_HOME");
  98     if (xdg != NULL) {
  99         err = asprintf(&user_path, "%s/xkb", xdg);
 100         if (err >= 0) {
 101             ret |= xkb_context_include_path_append(ctx, user_path);
 102             free(user_path);
 103         }
 104     } else if (home != NULL) {
 105         /* XDG_CONFIG_HOME fallback is $HOME/.config/ */
 106         err = asprintf(&user_path, "%s/.config/xkb", home);
 107         if (err >= 0) {
 108             ret |= xkb_context_include_path_append(ctx, user_path);
 109             free(user_path);
 110         }
 111     }
 112
 113     if (home != NULL) {
 114         err = asprintf(&user_path, "%s/.xkb", home);
 115         if (err >= 0) {
 116             ret |= xkb_context_include_path_append(ctx, user_path);
 117             free(user_path);
 118         }
 119     }
 120
 121     root = xkb_context_include_path_get_system_path(ctx);
 122     ret |= xkb_context_include_path_append(ctx, root);
 123
 124     return ret;
 125 }
 126
 127 /**
 128  * Remove all entries in the context's include path.
 129  */
 130 XKB_EXPORT void
 131 xkb_context_include_path_clear(struct xkb_context *ctx)
 132 {
 133     char **path;
 134
 135     darray_foreach(path, ctx->includes)
 136         free(*path);
 137     darray_free(ctx->includes);
 138
 139     darray_foreach(path, ctx->failed_includes)
 140         free(*path);
 141     darray_free(ctx->failed_includes);
 142 }
 143
 144 /**
 145  * xkb_context_include_path_clear() + xkb_context_include_path_append_default()
 146  */
 147 XKB_EXPORT int
 148 xkb_context_include_path_reset_defaults(struct xkb_context *ctx)
 149 {
 150     xkb_context_include_path_clear(ctx);
 151     return xkb_context_include_path_append_default(ctx);
 152 }
 153
 154 /**
 155  * Returns the number of entries in the context's include path.
 156  */
 157 XKB_EXPORT unsigned int
 158 xkb_context_num_include_paths(struct xkb_context *ctx)
 159 {
 160     return darray_size(ctx->includes);
 161 }
 162
 163 /**
 164  * Returns the given entry in the context's include path, or NULL if an
 165  * invalid index is passed.
 166  */
 167 XKB_EXPORT const char *
 168 xkb_context_include_path_get(struct xkb_context *ctx, unsigned int idx)
 169 {
 170     if (idx >= xkb_context_num_include_paths(ctx))
 171         return NULL;
 172
 173     return darray_item(ctx->includes, idx);
 174 }
 175
 176 /**
 177  * Take a new reference on the context.
 178  */
 179 XKB_EXPORT struct xkb_context *
 180 xkb_context_ref(struct xkb_context *ctx)
 181 {
 182     ctx->refcnt++;
 183     return ctx;
 184 }
 185
 186 /**
 187  * Drop an existing reference on the context, and free it if the refcnt is
 188  * now 0.
 189  */
 190 XKB_EXPORT void
 191 xkb_context_unref(struct xkb_context *ctx)
 192 {
 193     if (!ctx || --ctx->refcnt > 0)
 194         return;
 195
 196     xkb_context_include_path_clear(ctx);
 197     atom_table_free(ctx->atom_table);
 198     free(ctx);
 199 }
 200
 201 static const char *
 202 log_level_to_prefix(enum xkb_log_level level)
 203 {
 204     switch (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: ";
 215     default:
 216         return NULL;
 217     }
 218 }
 219
 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)
 223 {
 224     const char *prefix = log_level_to_prefix(level);
 225
 226     if (prefix)
 227         fprintf(stderr, "%s", prefix);
 228     vfprintf(stderr, fmt, args);
 229 }
 230
 231 static enum xkb_log_level
 232 log_level(const char *level) {
 233     char *endptr;
 234     enum xkb_log_level lvl;
 235
 236     errno = 0;
 237     lvl = strtol(level, &endptr, 10);
 238     if (errno == 0 && (endptr[0] == '\0' || is_space(endptr[0])))
 239         return lvl;
 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;
 250
 251     return XKB_LOG_LEVEL_ERROR;
 252 }
 253
 254 static int
 255 log_verbosity(const char *verbosity) {
 256     char *endptr;
 257     int v;
 258
 259     errno = 0;
 260     v = strtol(verbosity, &endptr, 10);
 261     if (errno == 0)
 262         return v;
 263
 264     return 0;
 265 }
 266
 267 /**
 268  * Create a new context.
 269  */
 270 XKB_EXPORT struct xkb_context *
 271 xkb_context_new(enum xkb_context_flags flags)
 272 {
 273     const char *env;
 274     struct xkb_context *ctx = calloc(1, sizeof(*ctx));
 275
 276     if (!ctx)
 277         return NULL;
 278
 279     ctx->refcnt = 1;
 280     ctx->log_fn = default_log_fn;
 281     ctx->log_level = XKB_LOG_LEVEL_ERROR;
 282     ctx->log_verbosity = 0;
 283
 284     /* Environment overwrites defaults. */
 285     env = secure_getenv("XKB_LOG_LEVEL");
 286     if (env)
 287         xkb_context_set_log_level(ctx, log_level(env));
 288
 289     env = secure_getenv("XKB_LOG_VERBOSITY");
 290     if (env)
 291         xkb_context_set_log_verbosity(ctx, log_verbosity(env));
 292
 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);
 298         return NULL;
 299     }
 300
 301     ctx->use_environment_names = !(flags & XKB_CONTEXT_NO_ENVIRONMENT_NAMES);
 302
 303     ctx->atom_table = atom_table_new();
 304     if (!ctx->atom_table) {
 305         xkb_context_unref(ctx);
 306         return NULL;
 307     }
 308
 309     return ctx;
 310 }
 311
 312 XKB_EXPORT void
 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))
 317 {
 318     ctx->log_fn = (log_fn ? log_fn : default_log_fn);
 319 }
 320
 321 XKB_EXPORT enum xkb_log_level
 322 xkb_context_get_log_level(struct xkb_context *ctx)
 323 {
 324     return ctx->log_level;
 325 }
 326
 327 XKB_EXPORT void
 328 xkb_context_set_log_level(struct xkb_context *ctx, enum xkb_log_level level)
 329 {
 330     ctx->log_level = level;
 331 }
 332
 333 XKB_EXPORT int
 334 xkb_context_get_log_verbosity(struct xkb_context *ctx)
 335 {
 336     return ctx->log_verbosity;
 337 }
 338
 339 XKB_EXPORT void
 340 xkb_context_set_log_verbosity(struct xkb_context *ctx, int verbosity)
 341 {
 342     ctx->log_verbosity = verbosity;
 343 }
 344
 345 XKB_EXPORT void *
 346 xkb_context_get_user_data(struct xkb_context *ctx)
 347 {
 348     if (ctx)
 349         return ctx->user_data;
 350     return NULL;
 351 }
 352
 353 XKB_EXPORT void
 354 xkb_context_set_user_data(struct xkb_context *ctx, void *user_data)
 355 {
 356     ctx->user_data = user_data;
 357 }