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 <ctype.h>
  30 #include <errno.h>
  31 #include <stdarg.h>
  32 #include <stdio.h>
  33 #include <unistd.h>
  34
  35 #include "xkb-priv.h"
  36 #include "atom.h"
  37
  38 /**
  39  * Append one directory to the context's include path.
  40  */
  41 XKB_EXPORT int
  42 xkb_context_include_path_append(struct xkb_context *ctx, const char *path)
  43 {
  44     struct stat stat_buf;
  45     int err;
  46     char *tmp;
  47
  48     tmp = strdup(path);
  49     if (!tmp)
  50         goto err;
  51
  52     err = stat(path, &stat_buf);
  53     if (err != 0)
  54         goto err;
  55     if (!S_ISDIR(stat_buf.st_mode))
  56         goto err;
  57
  58 #if defined(HAVE_EACCESS)
  59     if (eaccess(path, R_OK | X_OK) != 0)
  60         goto err;
  61 #elif defined(HAVE_EUIDACCESS)
  62     if (euidaccess(path, R_OK | X_OK) != 0)
  63         goto err;
  64 #endif
  65
  66     darray_append(ctx->includes, tmp);
  67     return 1;
  68
  69 err:
  70     darray_append(ctx->failed_includes, tmp);
  71     return 0;
  72 }
  73
  74 /**
  75  * Append the default include directories to the context.
  76  */
  77 XKB_EXPORT int
  78 xkb_context_include_path_append_default(struct xkb_context *ctx)
  79 {
  80     const char *home;
  81     char *user_path;
  82     int err;
  83     int ret = 0;
  84
  85     ret |= xkb_context_include_path_append(ctx, DFLT_XKB_CONFIG_ROOT);
  86
  87     home = getenv("HOME");
  88     if (!home)
  89         return ret;
  90     err = asprintf(&user_path, "%s/.xkb", home);
  91     if (err <= 0)
  92         return ret;
  93     ret |= xkb_context_include_path_append(ctx, user_path);
  94     free(user_path);
  95
  96     return ret;
  97 }
  98
  99 /**
 100  * Remove all entries in the context's include path.
 101  */
 102 XKB_EXPORT void
 103 xkb_context_include_path_clear(struct xkb_context *ctx)
 104 {
 105     char **path;
 106
 107     darray_foreach(path, ctx->includes)
 108         free(*path);
 109     darray_free(ctx->includes);
 110
 111     darray_foreach(path, ctx->failed_includes)
 112         free(*path);
 113     darray_free(ctx->failed_includes);
 114 }
 115
 116 /**
 117  * xkb_context_include_path_clear() + xkb_context_include_path_append_default()
 118  */
 119 XKB_EXPORT int
 120 xkb_context_include_path_reset_defaults(struct xkb_context *ctx)
 121 {
 122     xkb_context_include_path_clear(ctx);
 123     return xkb_context_include_path_append_default(ctx);
 124 }
 125
 126 /**
 127  * Returns the number of entries in the context's include path.
 128  */
 129 XKB_EXPORT unsigned int
 130 xkb_context_num_include_paths(struct xkb_context *ctx)
 131 {
 132     return darray_size(ctx->includes);
 133 }
 134
 135 unsigned int
 136 xkb_context_num_failed_include_paths(struct xkb_context *ctx)
 137 {
 138     return darray_size(ctx->failed_includes);
 139 }
 140
 141 /**
 142  * Returns the given entry in the context's include path, or NULL if an
 143  * invalid index is passed.
 144  */
 145 XKB_EXPORT const char *
 146 xkb_context_include_path_get(struct xkb_context *ctx, unsigned int idx)
 147 {
 148     if (idx >= xkb_context_num_include_paths(ctx))
 149         return NULL;
 150
 151     return darray_item(ctx->includes, idx);
 152 }
 153
 154 const char *
 155 xkb_context_failed_include_path_get(struct xkb_context *ctx,
 156                                     unsigned int idx)
 157 {
 158     if (idx >= xkb_context_num_failed_include_paths(ctx))
 159         return NULL;
 160
 161     return darray_item(ctx->failed_includes, idx);
 162 }
 163
 164 unsigned
 165 xkb_context_take_file_id(struct xkb_context *ctx)
 166 {
 167     return ctx->file_id++;
 168 }
 169
 170 /**
 171  * Take a new reference on the context.
 172  */
 173 XKB_EXPORT struct xkb_context *
 174 xkb_context_ref(struct xkb_context *ctx)
 175 {
 176     ctx->refcnt++;
 177     return ctx;
 178 }
 179
 180 /**
 181  * Drop an existing reference on the context, and free it if the refcnt is
 182  * now 0.
 183  */
 184 XKB_EXPORT void
 185 xkb_context_unref(struct xkb_context *ctx)
 186 {
 187     if (--ctx->refcnt > 0)
 188         return;
 189
 190     xkb_context_include_path_clear(ctx);
 191     atom_table_free(ctx->atom_table);
 192     free(ctx);
 193 }
 194
 195 static const char *
 196 log_level_to_prefix(enum xkb_log_level level)
 197 {
 198     switch (level) {
 199     case XKB_LOG_LEVEL_DEBUG:
 200         return "Debug:";
 201     case XKB_LOG_LEVEL_INFO:
 202         return "Info:";
 203     case XKB_LOG_LEVEL_WARNING:
 204         return "Warning:";
 205     case XKB_LOG_LEVEL_ERROR:
 206         return "Error:";
 207     case XKB_LOG_LEVEL_CRITICAL:
 208         return "Critical:";
 209     default:
 210         return NULL;
 211     }
 212 }
 213
 214 ATTR_PRINTF(3, 0) static void
 215 default_log_fn(struct xkb_context *ctx, enum xkb_log_level level,
 216                const char *fmt, va_list args)
 217 {
 218     const char *prefix = log_level_to_prefix(level);
 219
 220     if (prefix)
 221         fprintf(stderr, "%-10s", prefix);
 222     vfprintf(stderr, fmt, args);
 223 }
 224
 225 static enum xkb_log_level
 226 log_level(const char *level) {
 227     char *endptr;
 228     enum xkb_log_level lvl;
 229
 230     errno = 0;
 231     lvl = strtol(level, &endptr, 10);
 232     if (errno == 0 && (endptr[0] == '\0' || isspace(endptr[0])))
 233         return lvl;
 234     if (istreq_prefix("crit", level))
 235         return XKB_LOG_LEVEL_CRITICAL;
 236     if (istreq_prefix("err", level))
 237         return XKB_LOG_LEVEL_ERROR;
 238     if (istreq_prefix("warn", level))
 239         return XKB_LOG_LEVEL_WARNING;
 240     if (istreq_prefix("info", level))
 241         return XKB_LOG_LEVEL_INFO;
 242     if (istreq_prefix("debug", level) || istreq_prefix("dbg", level))
 243         return XKB_LOG_LEVEL_DEBUG;
 244
 245     return XKB_LOG_LEVEL_ERROR;
 246 }
 247
 248 static int
 249 log_verbosity(const char *verbosity) {
 250     char *endptr;
 251     int v;
 252
 253     errno = 0;
 254     v = strtol(verbosity, &endptr, 10);
 255     if (errno == 0)
 256         return v;
 257
 258     return 0;
 259 }
 260
 261 /**
 262  * Create a new context.
 263  */
 264 XKB_EXPORT struct xkb_context *
 265 xkb_context_new(enum xkb_context_flags flags)
 266 {
 267     const char *env;
 268     struct xkb_context *ctx = calloc(1, sizeof(*ctx));
 269
 270     if (!ctx)
 271         return NULL;
 272
 273     ctx->refcnt = 1;
 274     ctx->log_fn = default_log_fn;
 275     ctx->log_level = XKB_LOG_LEVEL_ERROR;
 276     ctx->log_verbosity = 0;
 277
 278     /* Environment overwrites defaults. */
 279     env = getenv("XKB_LOG");
 280     if (env)
 281         xkb_set_log_level(ctx, log_level(env));
 282
 283     env = getenv("XKB_VERBOSITY");
 284     if (env)
 285         xkb_set_log_verbosity(ctx, log_verbosity(env));
 286
 287     if (!(flags & XKB_CONTEXT_NO_DEFAULT_INCLUDES) &&
 288         !xkb_context_include_path_append_default(ctx)) {
 289         log_err(ctx, "failed to add default include path %s\n",
 290                 DFLT_XKB_CONFIG_ROOT);
 291         xkb_context_unref(ctx);
 292         return NULL;
 293     }
 294
 295     ctx->atom_table = atom_table_new();
 296     if (!ctx->atom_table) {
 297         xkb_context_unref(ctx);
 298         return NULL;
 299     }
 300
 301     return ctx;
 302 }
 303
 304 xkb_atom_t
 305 xkb_atom_lookup(struct xkb_context *ctx, const char *string)
 306 {
 307     return atom_lookup(ctx->atom_table, string);
 308 }
 309
 310 xkb_atom_t
 311 xkb_atom_intern(struct xkb_context *ctx, const char *string)
 312 {
 313     return atom_intern(ctx->atom_table, string, false);
 314 }
 315
 316 xkb_atom_t
 317 xkb_atom_steal(struct xkb_context *ctx, char *string)
 318 {
 319     return atom_intern(ctx->atom_table, string, true);
 320 }
 321
 322 char *
 323 xkb_atom_strdup(struct xkb_context *ctx, xkb_atom_t atom)
 324 {
 325     return atom_strdup(ctx->atom_table, atom);
 326 }
 327
 328 const char *
 329 xkb_atom_text(struct xkb_context *ctx, xkb_atom_t atom)
 330 {
 331     return atom_text(ctx->atom_table, atom);
 332 }
 333
 334 void
 335 xkb_log(struct xkb_context *ctx, enum xkb_log_level level,
 336         const char *fmt, ...)
 337 {
 338     va_list args;
 339
 340     va_start(args, fmt);
 341     ctx->log_fn(ctx, level, fmt, args);
 342     va_end(args);
 343 }
 344
 345 XKB_EXPORT void
 346 xkb_set_log_fn(struct xkb_context *ctx,
 347                void (*log_fn)(struct xkb_context *ctx,
 348                               enum xkb_log_level level,
 349                               const char *fmt, va_list args))
 350 {
 351     ctx->log_fn = (log_fn ? log_fn : default_log_fn);
 352 }
 353
 354 XKB_EXPORT enum xkb_log_level
 355 xkb_get_log_level(struct xkb_context *ctx)
 356 {
 357     return ctx->log_level;
 358 }
 359
 360 XKB_EXPORT void
 361 xkb_set_log_level(struct xkb_context *ctx, enum xkb_log_level level)
 362 {
 363     ctx->log_level = level;
 364 }
 365
 366 XKB_EXPORT int
 367 xkb_get_log_verbosity(struct xkb_context *ctx)
 368 {
 369     return ctx->log_verbosity;
 370 }
 371
 372 XKB_EXPORT void
 373 xkb_set_log_verbosity(struct xkb_context *ctx, int verbosity)
 374 {
 375     ctx->log_verbosity = verbosity;
 376 }
 377
 378 XKB_EXPORT void *
 379 xkb_get_user_data(struct xkb_context *ctx)
 380 {
 381     if (ctx)
 382         return ctx->user_data;
 383     return NULL;
 384 }
 385
 386 XKB_EXPORT void
 387 xkb_set_user_data(struct xkb_context *ctx, void *user_data)
 388 {
 389     ctx->user_data = user_data;
 390 }