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_context {
  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_context_include_path_append(struct xkb_context *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
  76 #if defined(HAVE_EACCESS)
  77     if (eaccess(path, R_OK | X_OK) != 0)
  78         return 0;
  79 #elif defined(HAVE_EUIDACCESS)
  80     if (euidaccess(path, R_OK | X_OK) != 0)
  81         return 0;
  82 #endif
  83
  84     ctx->include_paths[ctx->num_include_paths] = strdup(path);
  85     if (!ctx->include_paths[ctx->num_include_paths])
  86         return 0;
  87     ctx->num_include_paths++;
  88
  89     return 1;
  90 }
  91
  92 /**
  93  * Append the default include directories to the context.
  94  */
  95 _X_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
 102     (void) xkb_context_include_path_append(ctx, DFLT_XKB_CONFIG_ROOT);
 103
 104     home = getenv("HOME");
 105     if (!home)
 106         return 1;
 107     err = asprintf(&user_path, "%s/.xkb", home);
 108     if (err <= 0)
 109         return 1;
 110     (void) xkb_context_include_path_append(ctx, user_path);
 111     free(user_path);
 112
 113     return 1;
 114 }
 115
 116 /**
 117  * Remove all entries in the context's include path.
 118  */
 119 _X_EXPORT void
 120 xkb_context_include_path_clear(struct xkb_context *ctx)
 121 {
 122     int i;
 123
 124     for (i = 0; i < ctx->num_include_paths; i++) {
 125         free(ctx->include_paths[i]);
 126         ctx->include_paths[i] = NULL;
 127     }
 128     free(ctx->include_paths);
 129     ctx->include_paths = NULL;
 130     ctx->num_include_paths = 0;
 131 }
 132
 133 /**
 134  * xkb_context_include_path_clear() + xkb_context_include_path_append_default()
 135  */
 136 _X_EXPORT int
 137 xkb_context_include_path_reset_defaults(struct xkb_context *ctx)
 138 {
 139     xkb_context_include_path_clear(ctx);
 140     return xkb_context_include_path_append_default(ctx);
 141 }
 142
 143 /**
 144  * Returns the number of entries in the context's include path.
 145  */
 146 _X_EXPORT unsigned int
 147 xkb_context_num_include_paths(struct xkb_context *ctx)
 148 {
 149     return ctx->num_include_paths;
 150 }
 151
 152 /**
 153  * Returns the given entry in the context's include path, or NULL if an
 154  * invalid index is passed.
 155  */
 156 _X_EXPORT const char *
 157 xkb_context_include_path_get(struct xkb_context *ctx, unsigned int idx)
 158 {
 159     if (idx >= xkb_context_num_include_paths(ctx))
 160         return NULL;
 161
 162     return ctx->include_paths[idx];
 163 }
 164
 165 int
 166 xkb_context_take_file_id(struct xkb_context *ctx)
 167 {
 168     return ctx->file_id++;
 169 }
 170
 171 /**
 172  * Take a new reference on the context.
 173  */
 174 _X_EXPORT struct xkb_context *
 175 xkb_context_ref(struct xkb_context *ctx)
 176 {
 177     ctx->refcnt++;
 178     return ctx;
 179 }
 180
 181 /**
 182  * Drop an existing reference on the context, and free it if the refcnt is
 183  * now 0.
 184  */
 185 _X_EXPORT void
 186 xkb_context_unref(struct xkb_context *ctx)
 187 {
 188     if (--ctx->refcnt > 0)
 189         return;
 190
 191     xkb_context_include_path_clear(ctx);
 192     atom_table_free(ctx->atom_table);
 193     free(ctx);
 194 }
 195
 196 /**
 197  * Create a new context.
 198  */
 199 _X_EXPORT struct xkb_context *
 200 xkb_context_new(enum xkb_context_flags flags)
 201 {
 202     struct xkb_context *ctx = calloc(1, sizeof(*ctx));
 203
 204     if (!ctx)
 205         return NULL;
 206
 207     ctx->refcnt = 1;
 208
 209     if (!(flags & XKB_CONTEXT_NO_DEFAULT_INCLUDES) &&
 210         !xkb_context_include_path_append_default(ctx)) {
 211         xkb_context_unref(ctx);
 212         return NULL;
 213     }
 214
 215     ctx->atom_table = atom_table_new();
 216     if (!ctx->atom_table) {
 217         xkb_context_unref(ctx);
 218         return NULL;
 219     }
 220
 221     return ctx;
 222 }
 223
 224 xkb_atom_t
 225 xkb_atom_intern(struct xkb_context *ctx, const char *string)
 226 {
 227     return atom_intern(ctx->atom_table, string);
 228 }
 229
 230 char *
 231 xkb_atom_strdup(struct xkb_context *ctx, xkb_atom_t atom)
 232 {
 233     return atom_strdup(ctx->atom_table, atom);
 234 }
 235
 236 const char *
 237 xkb_atom_text(struct xkb_context *ctx, xkb_atom_t atom)
 238 {
 239     return atom_text(ctx->atom_table, atom);
 240 }