src/context.c

   1 /*
   2  * Copyright © 2012 Intel Corporation
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21  * DEALINGS IN THE SOFTWARE.
  22  *
  23  * Author: Daniel Stone <daniel@fooishbar.org>
  24  */
  25
  26 #include <sys/types.h>
  27 #include <sys/stat.h>
  28 #include <stdio.h>
  29 #include <unistd.h>
  30
  31 #include "xkb-priv.h"
  32 #include "atom.h"
  33
  34 struct xkb_ctx {
  35     int refcnt;
  36
  37     char **include_paths;
  38     int num_include_paths;
  39     int size_include_paths;
  40
  41     /* xkbcomp needs to assign sequential IDs to XkbFile's it creates. */
  42     int file_id;
  43
  44     struct atom_table *atom_table;
  45 };
  46
  47 /**
  48  * Append one directory to the context's include path.
  49  */
  50 _X_EXPORT int
  51 xkb_ctx_include_path_append(struct xkb_ctx *ctx, const char *path)
  52 {
  53     struct stat stat_buf;
  54     int err;
  55
  56     if (ctx->size_include_paths <= ctx->num_include_paths) {
  57         int new_size;
  58         char **new_paths;
  59         new_size = ctx->size_include_paths + 2;
  60         new_paths = uTypedRecalloc(ctx->include_paths,
  61                                    ctx->size_include_paths,
  62                                    new_size,
  63                                    char *);
  64         if (!new_paths)
  65             return 0;
  66         ctx->include_paths = new_paths;
  67         ctx->size_include_paths = new_size;
  68     }
  69
  70     err = stat(path, &stat_buf);
  71     if (err != 0)
  72         return 0;
  73     if (!S_ISDIR(stat_buf.st_mode))
  74         return 0;
  75     if (eaccess(path, R_OK | X_OK) != 0)
  76         return 0;
  77
  78     ctx->include_paths[ctx->num_include_paths] = strdup(path);
  79     if (!ctx->include_paths[ctx->num_include_paths])
  80         return 0;
  81     ctx->num_include_paths++;
  82
  83     return 1;
  84 }
  85
  86 /**
  87  * Append the default include directories to the context.
  88  */
  89 _X_EXPORT int
  90 xkb_ctx_include_path_append_default(struct xkb_ctx *ctx)
  91 {
  92     const char *home = getenv("HOME");
  93     char *user_path;
  94     int err;
  95
  96     (void) xkb_ctx_include_path_append(ctx, DFLT_XKB_CONFIG_ROOT);
  97
  98     home = getenv("HOME");
  99     if (!home)
 100         return 1;
 101     err = asprintf(&user_path, "%s/.xkb", home);
 102     if (err <= 0)
 103         return 1;
 104     (void) xkb_ctx_include_path_append(ctx, user_path);
 105     free(user_path);
 106
 107     return 1;
 108 }
 109
 110 /**
 111  * Remove all entries in the context's include path.
 112  */
 113 _X_EXPORT void
 114 xkb_ctx_include_path_clear(struct xkb_ctx *ctx)
 115 {
 116     int i;
 117
 118     for (i = 0; i < ctx->num_include_paths; i++) {
 119         free(ctx->include_paths[i]);
 120         ctx->include_paths[i] = NULL;
 121     }
 122     free(ctx->include_paths);
 123     ctx->include_paths = NULL;
 124     ctx->num_include_paths = 0;
 125 }
 126
 127 /**
 128  * xkb_ctx_include_path_clear() + xkb_ctx_include_path_append_default()
 129  */
 130 _X_EXPORT int
 131 xkb_ctx_include_path_reset_defaults(struct xkb_ctx *ctx)
 132 {
 133     xkb_ctx_include_path_clear(ctx);
 134     return xkb_ctx_include_path_append_default(ctx);
 135 }
 136
 137 /**
 138  * Returns the number of entries in the context's include path.
 139  */
 140 _X_EXPORT unsigned int
 141 xkb_ctx_num_include_paths(struct xkb_ctx *ctx)
 142 {
 143     return ctx->num_include_paths;
 144 }
 145
 146 /**
 147  * Returns the given entry in the context's include path, or NULL if an
 148  * invalid index is passed.
 149  */
 150 _X_EXPORT const char *
 151 xkb_ctx_include_path_get(struct xkb_ctx *ctx, unsigned int idx)
 152 {
 153     if (idx >= xkb_ctx_num_include_paths(ctx))
 154         return NULL;
 155
 156     return ctx->include_paths[idx];
 157 }
 158
 159 int
 160 xkb_ctx_take_file_id(struct xkb_ctx *ctx)
 161 {
 162     return ctx->file_id++;
 163 }
 164
 165 /**
 166  * Take a new reference on the context.
 167  */
 168 _X_EXPORT struct xkb_ctx *
 169 xkb_ctx_ref(struct xkb_ctx *ctx)
 170 {
 171     ctx->refcnt++;
 172     return ctx;
 173 }
 174
 175 /**
 176  * Drop an existing reference on the context, and free it if the refcnt is
 177  * now 0.
 178  */
 179 _X_EXPORT void
 180 xkb_ctx_unref(struct xkb_ctx *ctx)
 181 {
 182     if (--ctx->refcnt > 0)
 183         return;
 184
 185     xkb_ctx_include_path_clear(ctx);
 186     atom_table_free(ctx->atom_table);
 187     free(ctx);
 188 }
 189
 190 /**
 191  * Create a new context.
 192  */
 193 _X_EXPORT struct xkb_ctx *
 194 xkb_ctx_new(enum xkb_ctx_flags flags)
 195 {
 196     struct xkb_ctx *ctx = calloc(1, sizeof(*ctx));
 197
 198     if (!ctx)
 199         return NULL;
 200
 201     ctx->refcnt = 1;
 202
 203     if (!(flags & XKB_CONTEXT_NO_DEFAULT_INCLUDES) &&
 204         !xkb_ctx_include_path_append_default(ctx)) {
 205         xkb_ctx_unref(ctx);
 206         return NULL;
 207     }
 208
 209     ctx->atom_table = atom_table_new();
 210     if (!ctx->atom_table) {
 211         xkb_ctx_unref(ctx);
 212         return NULL;
 213     }
 214
 215     return ctx;
 216 }
 217
 218 xkb_atom_t
 219 xkb_atom_intern(struct xkb_ctx *ctx, const char *string)
 220 {
 221     return atom_intern(ctx->atom_table, string);
 222 }
 223
 224 char *
 225 xkb_atom_strdup(struct xkb_ctx *ctx, xkb_atom_t atom)
 226 {
 227     return atom_strdup(ctx->atom_table, atom);
 228 }
 229
 230 const char *
 231 xkb_atom_text(struct xkb_ctx *ctx, xkb_atom_t atom)
 232 {
 233     return atom_text(ctx->atom_table, atom);
 234 }