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