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 /**
 136  * Returns the given entry in the context's include path, or NULL if an
 137  * invalid index is passed.
 138  */
 139 XKB_EXPORT const char *
 140 xkb_context_include_path_get(struct xkb_context *ctx, unsigned int idx)
 141 {
 142     if (idx >= xkb_context_num_include_paths(ctx))
 143         return NULL;
 144
 145     return darray_item(ctx->includes, idx);
 146 }
 147
 148 unsigned
 149 xkb_context_take_file_id(struct xkb_context *ctx)
 150 {
 151     return ctx->file_id++;
 152 }
 153
 154 /**
 155  * Take a new reference on the context.
 156  */
 157 XKB_EXPORT struct xkb_context *
 158 xkb_context_ref(struct xkb_context *ctx)
 159 {
 160     ctx->refcnt++;
 161     return ctx;
 162 }
 163
 164 /**
 165  * Drop an existing reference on the context, and free it if the refcnt is
 166  * now 0.
 167  */
 168 XKB_EXPORT void
 169 xkb_context_unref(struct xkb_context *ctx)
 170 {
 171     if (--ctx->refcnt > 0)
 172         return;
 173
 174     xkb_context_include_path_clear(ctx);
 175     atom_table_free(ctx->atom_table);
 176     free(ctx);
 177 }
 178
 179 static const char *
 180 log_level_to_prefix(enum xkb_log_level level)
 181 {
 182     switch (level) {
 183     case XKB_LOG_LEVEL_DEBUG:
 184         return "Debug:";
 185     case XKB_LOG_LEVEL_INFO:
 186         return "Info:";
 187     case XKB_LOG_LEVEL_WARNING:
 188         return "Warning:";
 189     case XKB_LOG_LEVEL_ERROR:
 190         return "Error:";
 191     case XKB_LOG_LEVEL_CRITICAL:
 192         return "Critical:";
 193     default:
 194         return NULL;
 195     }
 196 }
 197
 198 ATTR_PRINTF(3, 0) static void
 199 default_log_fn(struct xkb_context *ctx, enum xkb_log_level level,
 200                const char *fmt, va_list args)
 201 {
 202     const char *prefix = log_level_to_prefix(level);
 203
 204     if (prefix)
 205         fprintf(stderr, "%-10s", prefix);
 206     vfprintf(stderr, fmt, args);
 207 }
 208
 209 static enum xkb_log_level
 210 log_level(const char *level) {
 211     char *endptr;
 212     enum xkb_log_level lvl;
 213
 214     errno = 0;
 215     lvl = strtol(level, &endptr, 10);
 216     if (errno == 0 && (endptr[0] == '\0' || isspace(endptr[0])))
 217         return lvl;
 218     if (istreq_prefix("crit", level))
 219         return XKB_LOG_LEVEL_CRITICAL;
 220     if (istreq_prefix("err", level))
 221         return XKB_LOG_LEVEL_ERROR;
 222     if (istreq_prefix("warn", level))
 223         return XKB_LOG_LEVEL_WARNING;
 224     if (istreq_prefix("info", level))
 225         return XKB_LOG_LEVEL_INFO;
 226     if (istreq_prefix("debug", level) || istreq_prefix("dbg", level))
 227         return XKB_LOG_LEVEL_DEBUG;
 228
 229     return XKB_LOG_LEVEL_ERROR;
 230 }
 231
 232 static int
 233 log_verbosity(const char *verbosity) {
 234     char *endptr;
 235     int v;
 236
 237     errno = 0;
 238     v = strtol(verbosity, &endptr, 10);
 239     if (errno == 0)
 240         return v;
 241
 242     return 0;
 243 }
 244
 245 /**
 246  * Create a new context.
 247  */
 248 XKB_EXPORT struct xkb_context *
 249 xkb_context_new(enum xkb_context_flags flags)
 250 {
 251     const char *env;
 252     struct xkb_context *ctx = calloc(1, sizeof(*ctx));
 253
 254     if (!ctx)
 255         return NULL;
 256
 257     ctx->refcnt = 1;
 258     ctx->log_fn = default_log_fn;
 259     ctx->log_level = XKB_LOG_LEVEL_ERROR;
 260     ctx->log_verbosity = 0;
 261
 262     /* Environment overwrites defaults. */
 263     env = getenv("XKB_LOG");
 264     if (env)
 265         xkb_set_log_level(ctx, log_level(env));
 266
 267     env = getenv("XKB_VERBOSITY");
 268     if (env)
 269         xkb_set_log_verbosity(ctx, log_verbosity(env));
 270
 271     if (!(flags & XKB_CONTEXT_NO_DEFAULT_INCLUDES) &&
 272         !xkb_context_include_path_append_default(ctx)) {
 273         log_err(ctx, "failed to add default include path %s\n",
 274                 DFLT_XKB_CONFIG_ROOT);
 275         xkb_context_unref(ctx);
 276         return NULL;
 277     }
 278
 279     ctx->atom_table = atom_table_new();
 280     if (!ctx->atom_table) {
 281         xkb_context_unref(ctx);
 282         return NULL;
 283     }
 284
 285     return ctx;
 286 }
 287
 288 xkb_atom_t
 289 xkb_atom_lookup(struct xkb_context *ctx, const char *string)
 290 {
 291     return atom_lookup(ctx->atom_table, string);
 292 }
 293
 294 xkb_atom_t
 295 xkb_atom_intern(struct xkb_context *ctx, const char *string)
 296 {
 297     return atom_intern(ctx->atom_table, string, false);
 298 }
 299
 300 xkb_atom_t
 301 xkb_atom_steal(struct xkb_context *ctx, char *string)
 302 {
 303     return atom_intern(ctx->atom_table, string, true);
 304 }
 305
 306 char *
 307 xkb_atom_strdup(struct xkb_context *ctx, xkb_atom_t atom)
 308 {
 309     return atom_strdup(ctx->atom_table, atom);
 310 }
 311
 312 const char *
 313 xkb_atom_text(struct xkb_context *ctx, xkb_atom_t atom)
 314 {
 315     return atom_text(ctx->atom_table, atom);
 316 }
 317
 318 void
 319 xkb_log(struct xkb_context *ctx, enum xkb_log_level level,
 320         const char *fmt, ...)
 321 {
 322     va_list args;
 323
 324     va_start(args, fmt);
 325     ctx->log_fn(ctx, level, fmt, args);
 326     va_end(args);
 327 }
 328
 329 XKB_EXPORT void
 330 xkb_set_log_fn(struct xkb_context *ctx,
 331                void (*log_fn)(struct xkb_context *ctx,
 332                               enum xkb_log_level level,
 333                               const char *fmt, va_list args))
 334 {
 335     ctx->log_fn = (log_fn ? log_fn : default_log_fn);
 336 }
 337
 338 XKB_EXPORT enum xkb_log_level
 339 xkb_get_log_level(struct xkb_context *ctx)
 340 {
 341     return ctx->log_level;
 342 }
 343
 344 XKB_EXPORT void
 345 xkb_set_log_level(struct xkb_context *ctx, enum xkb_log_level level)
 346 {
 347     ctx->log_level = level;
 348 }
 349
 350 XKB_EXPORT int
 351 xkb_get_log_verbosity(struct xkb_context *ctx)
 352 {
 353     return ctx->log_verbosity;
 354 }
 355
 356 XKB_EXPORT void
 357 xkb_set_log_verbosity(struct xkb_context *ctx, int verbosity)
 358 {
 359     ctx->log_verbosity = verbosity;
 360 }
 361
 362 XKB_EXPORT void *
 363 xkb_get_user_data(struct xkb_context *ctx)
 364 {
 365     if (ctx)
 366         return ctx->user_data;
 367     return NULL;
 368 }
 369
 370 XKB_EXPORT void
 371 xkb_set_user_data(struct xkb_context *ctx, void *user_data)
 372 {
 373     ctx->user_data = user_data;
 374 }