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 <sys/types.h>
  28 #include <sys/stat.h>
  29 #include <errno.h>
  30 #include <unistd.h>
  31
  32 #include "xkbcommon/xkbcommon.h"
  33 #include "utils.h"
  34 #include "context.h"
  35
  36 /**
  37  * Append one directory to the context's include path.
  38  */
  39 XKB_EXPORT int
  40 xkb_context_include_path_append(struct xkb_context *ctx, const char *path)
  41 {
  42     struct stat stat_buf;
  43     int err;
  44     char *tmp;
  45
  46     tmp = strdup(path);
  47     if (!tmp)
  48         goto err;
  49
  50     err = stat(path, &stat_buf);
  51     if (err != 0)
  52         goto err;
  53     if (!S_ISDIR(stat_buf.st_mode))
  54         goto err;
  55
  56 #if defined(HAVE_EACCESS)
  57     if (eaccess(path, R_OK | X_OK) != 0)
  58         goto err;
  59 #elif defined(HAVE_EUIDACCESS)
  60     if (euidaccess(path, R_OK | X_OK) != 0)
  61         goto err;
  62 #endif
  63
  64     darray_append(ctx->includes, tmp);
  65     return 1;
  66
  67 err:
  68     darray_append(ctx->failed_includes, tmp);
  69     return 0;
  70 }
  71
  72 /**
  73  * Append the default include directories to the context.
  74  */
  75 XKB_EXPORT int
  76 xkb_context_include_path_append_default(struct xkb_context *ctx)
  77 {
  78     const char *home, *root;
  79     char *user_path;
  80     int err;
  81     int ret = 0;
  82
  83     root = secure_getenv("XKB_CONFIG_ROOT");
  84     if (root != NULL)
  85        ret |= xkb_context_include_path_append(ctx, root);
  86     else
  87        ret |= xkb_context_include_path_append(ctx, DFLT_XKB_CONFIG_ROOT);
  88
  89     home = secure_getenv("HOME");
  90     if (!home)
  91         return ret;
  92     err = asprintf(&user_path, "%s/.xkb", home);
  93     if (err <= 0)
  94         return ret;
  95     ret |= xkb_context_include_path_append(ctx, user_path);
  96     free(user_path);
  97
  98     return ret;
  99 }
 100
 101 /**
 102  * Remove all entries in the context's include path.
 103  */
 104 XKB_EXPORT void
 105 xkb_context_include_path_clear(struct xkb_context *ctx)
 106 {
 107     char **path;
 108
 109     darray_foreach(path, ctx->includes)
 110         free(*path);
 111     darray_free(ctx->includes);
 112
 113     darray_foreach(path, ctx->failed_includes)
 114         free(*path);
 115     darray_free(ctx->failed_includes);
 116 }
 117
 118 /**
 119  * xkb_context_include_path_clear() + xkb_context_include_path_append_default()
 120  */
 121 XKB_EXPORT int
 122 xkb_context_include_path_reset_defaults(struct xkb_context *ctx)
 123 {
 124     xkb_context_include_path_clear(ctx);
 125     return xkb_context_include_path_append_default(ctx);
 126 }
 127
 128 /**
 129  * Returns the number of entries in the context's include path.
 130  */
 131 XKB_EXPORT unsigned int
 132 xkb_context_num_include_paths(struct xkb_context *ctx)
 133 {
 134     return darray_size(ctx->includes);
 135 }
 136
 137 /**
 138  * Returns the given entry in the context's include path, or NULL if an
 139  * invalid index is passed.
 140  */
 141 XKB_EXPORT const char *
 142 xkb_context_include_path_get(struct xkb_context *ctx, unsigned int idx)
 143 {
 144     if (idx >= xkb_context_num_include_paths(ctx))
 145         return NULL;
 146
 147     return darray_item(ctx->includes, idx);
 148 }
 149
 150 /**
 151  * Take a new reference on the context.
 152  */
 153 XKB_EXPORT struct xkb_context *
 154 xkb_context_ref(struct xkb_context *ctx)
 155 {
 156     ctx->refcnt++;
 157     return ctx;
 158 }
 159
 160 /**
 161  * Drop an existing reference on the context, and free it if the refcnt is
 162  * now 0.
 163  */
 164 XKB_EXPORT void
 165 xkb_context_unref(struct xkb_context *ctx)
 166 {
 167     if (!ctx || --ctx->refcnt > 0)
 168         return;
 169
 170     xkb_context_include_path_clear(ctx);
 171     atom_table_free(ctx->atom_table);
 172     free(ctx);
 173 }
 174
 175 static const char *
 176 log_level_to_prefix(enum xkb_log_level level)
 177 {
 178     switch (level) {
 179     case XKB_LOG_LEVEL_DEBUG:
 180         return "xkbcommon: DEBUG: ";
 181     case XKB_LOG_LEVEL_INFO:
 182         return "xkbcommon: INFO: ";
 183     case XKB_LOG_LEVEL_WARNING:
 184         return "xkbcommon: WARNING: ";
 185     case XKB_LOG_LEVEL_ERROR:
 186         return "xkbcommon: ERROR: ";
 187     case XKB_LOG_LEVEL_CRITICAL:
 188         return "xkbcommon: CRITICAL: ";
 189     default:
 190         return NULL;
 191     }
 192 }
 193
 194 ATTR_PRINTF(3, 0) static void
 195 default_log_fn(struct xkb_context *ctx, enum xkb_log_level level,
 196                const char *fmt, va_list args)
 197 {
 198     const char *prefix = log_level_to_prefix(level);
 199
 200     if (prefix)
 201         fprintf(stderr, "%s", prefix);
 202     vfprintf(stderr, fmt, args);
 203 }
 204
 205 static enum xkb_log_level
 206 log_level(const char *level) {
 207     char *endptr;
 208     enum xkb_log_level lvl;
 209
 210     errno = 0;
 211     lvl = strtol(level, &endptr, 10);
 212     if (errno == 0 && (endptr[0] == '\0' || is_space(endptr[0])))
 213         return lvl;
 214     if (istreq_prefix("crit", level))
 215         return XKB_LOG_LEVEL_CRITICAL;
 216     if (istreq_prefix("err", level))
 217         return XKB_LOG_LEVEL_ERROR;
 218     if (istreq_prefix("warn", level))
 219         return XKB_LOG_LEVEL_WARNING;
 220     if (istreq_prefix("info", level))
 221         return XKB_LOG_LEVEL_INFO;
 222     if (istreq_prefix("debug", level) || istreq_prefix("dbg", level))
 223         return XKB_LOG_LEVEL_DEBUG;
 224
 225     return XKB_LOG_LEVEL_ERROR;
 226 }
 227
 228 static int
 229 log_verbosity(const char *verbosity) {
 230     char *endptr;
 231     int v;
 232
 233     errno = 0;
 234     v = strtol(verbosity, &endptr, 10);
 235     if (errno == 0)
 236         return v;
 237
 238     return 0;
 239 }
 240
 241 /**
 242  * Create a new context.
 243  */
 244 XKB_EXPORT struct xkb_context *
 245 xkb_context_new(enum xkb_context_flags flags)
 246 {
 247     const char *env;
 248     struct xkb_context *ctx = calloc(1, sizeof(*ctx));
 249
 250     if (!ctx)
 251         return NULL;
 252
 253     ctx->refcnt = 1;
 254     ctx->log_fn = default_log_fn;
 255     ctx->log_level = XKB_LOG_LEVEL_ERROR;
 256     ctx->log_verbosity = 0;
 257
 258     /* Environment overwrites defaults. */
 259     env = secure_getenv("XKB_LOG_LEVEL");
 260     if (env)
 261         xkb_context_set_log_level(ctx, log_level(env));
 262
 263     env = secure_getenv("XKB_LOG_VERBOSITY");
 264     if (env)
 265         xkb_context_set_log_verbosity(ctx, log_verbosity(env));
 266
 267     if (!(flags & XKB_CONTEXT_NO_DEFAULT_INCLUDES) &&
 268         !xkb_context_include_path_append_default(ctx)) {
 269         log_err(ctx, "failed to add default include path %s\n",
 270                 DFLT_XKB_CONFIG_ROOT);
 271         xkb_context_unref(ctx);
 272         return NULL;
 273     }
 274
 275     ctx->use_environment_names = !(flags & XKB_CONTEXT_NO_ENVIRONMENT_NAMES);
 276
 277     ctx->atom_table = atom_table_new();
 278     if (!ctx->atom_table) {
 279         xkb_context_unref(ctx);
 280         return NULL;
 281     }
 282
 283     return ctx;
 284 }
 285
 286 XKB_EXPORT void
 287 xkb_context_set_log_fn(struct xkb_context *ctx,
 288                        void (*log_fn)(struct xkb_context *ctx,
 289                                       enum xkb_log_level level,
 290                                       const char *fmt, va_list args))
 291 {
 292     ctx->log_fn = (log_fn ? log_fn : default_log_fn);
 293 }
 294
 295 XKB_EXPORT enum xkb_log_level
 296 xkb_context_get_log_level(struct xkb_context *ctx)
 297 {
 298     return ctx->log_level;
 299 }
 300
 301 XKB_EXPORT void
 302 xkb_context_set_log_level(struct xkb_context *ctx, enum xkb_log_level level)
 303 {
 304     ctx->log_level = level;
 305 }
 306
 307 XKB_EXPORT int
 308 xkb_context_get_log_verbosity(struct xkb_context *ctx)
 309 {
 310     return ctx->log_verbosity;
 311 }
 312
 313 XKB_EXPORT void
 314 xkb_context_set_log_verbosity(struct xkb_context *ctx, int verbosity)
 315 {
 316     ctx->log_verbosity = verbosity;
 317 }
 318
 319 XKB_EXPORT void *
 320 xkb_context_get_user_data(struct xkb_context *ctx)
 321 {
 322     if (ctx)
 323         return ctx->user_data;
 324     return NULL;
 325 }
 326
 327 XKB_EXPORT void
 328 xkb_context_set_user_data(struct xkb_context *ctx, void *user_data)
 329 {
 330     ctx->user_data = user_data;
 331 }