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 "xkbcommon/xkbcommon.h"
  32 #include "XKBcommonint.h"
  33 #include "utils.h"
  34
  35 struct xkb_context {
  36     int refcnt;
  37     char **include_paths;
  38     int num_include_paths;
  39     int size_include_paths;
  40 };
  41
  42 /**
  43  * Append one directory to the context's include path.
  44  */
  45 _X_EXPORT int
  46 xkb_context_include_path_append(struct xkb_context *context, const char *path)
  47 {
  48     struct stat stat_buf;
  49     int err;
  50
  51     if (context->size_include_paths <= context->num_include_paths) {
  52         int new_size;
  53         char **new_paths;
  54         new_size = context->size_include_paths + 2;
  55         new_paths = uTypedRecalloc(context->include_paths,
  56                                    context->size_include_paths,
  57                                    new_size,
  58                                    char *);
  59         if (!new_paths)
  60             return 0;
  61         context->include_paths = new_paths;
  62         context->size_include_paths = new_size;
  63     }
  64
  65     err = stat(path, &stat_buf);
  66     if (err != 0)
  67         return 0;
  68     if (!S_ISDIR(stat_buf.st_mode))
  69         return 0;
  70     if (eaccess(path, R_OK | X_OK) != 0)
  71         return 0;
  72
  73     context->include_paths[context->num_include_paths] = strdup(path);
  74     if (!context->include_paths[context->num_include_paths])
  75         return 0;
  76     context->num_include_paths++;
  77
  78     return 1;
  79 }
  80
  81 /**
  82  * Append the default include directories to the context.
  83  */
  84 _X_EXPORT int
  85 xkb_context_include_path_append_default(struct xkb_context *context)
  86 {
  87     const char *home = getenv("HOME");
  88     char *user_path;
  89     int err;
  90
  91     (void) xkb_context_include_path_append(context, DFLT_XKB_CONFIG_ROOT);
  92
  93     home = getenv("HOME");
  94     if (!home)
  95         return 1;
  96     err = asprintf(&user_path, "%s/.xkb", home);
  97     if (err <= 0)
  98         return 1;
  99     (void) xkb_context_include_path_append(context, user_path);
 100     free(user_path);
 101
 102     return 1;
 103 }
 104
 105 /**
 106  * Remove all entries in the context's include path.
 107  */
 108 _X_EXPORT void
 109 xkb_context_include_path_clear(struct xkb_context *context)
 110 {
 111     int i;
 112
 113     for (i = 0; i < context->num_include_paths; i++) {
 114         free(context->include_paths[i]);
 115         context->include_paths[i] = NULL;
 116     }
 117     free(context->include_paths);
 118     context->include_paths = NULL;
 119     context->num_include_paths = 0;
 120 }
 121
 122 /**
 123  * xkb_context_include_path_clear() + xkb_context_include_path_append_default()
 124  */
 125 _X_EXPORT int
 126 xkb_context_include_path_reset_defaults(struct xkb_context *context)
 127 {
 128     xkb_context_include_path_clear(context);
 129     return xkb_context_include_path_append_default(context);
 130 }
 131
 132 /**
 133  * Returns the number of entries in the context's include path.
 134  */
 135 _X_EXPORT unsigned int
 136 xkb_context_num_include_paths(struct xkb_context *context)
 137 {
 138     return context->num_include_paths;
 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 _X_EXPORT const char *
 146 xkb_context_include_path_get(struct xkb_context *context, unsigned int idx)
 147 {
 148     if (idx >= xkb_context_num_include_paths(context))
 149         return NULL;
 150
 151     return context->include_paths[idx];
 152 }
 153
 154 /**
 155  * Take a new reference on the context.
 156  */
 157 _X_EXPORT struct xkb_context *
 158 xkb_context_ref(struct xkb_context *context)
 159 {
 160     context->refcnt++;
 161     return context;
 162 }
 163
 164 /**
 165  * Drop an existing reference on the context, and free it if the refcnt is
 166  * now 0.
 167  */
 168 _X_EXPORT void
 169 xkb_context_unref(struct xkb_context *context)
 170 {
 171     if (--context->refcnt > 0)
 172         return;
 173
 174     xkb_context_include_path_clear(context);
 175     free(context);
 176 }
 177
 178 /**
 179  * Create a new context.
 180  */
 181 _X_EXPORT struct xkb_context *
 182 xkb_context_new(void)
 183 {
 184     struct xkb_context *context = calloc(1, sizeof(*context));
 185
 186     if (!context)
 187         return NULL;
 188
 189     context->refcnt = 1;
 190
 191     if (!xkb_context_include_path_append_default(context)) {
 192         xkb_context_unref(context);
 193         return NULL;
 194     }
 195
 196     return context;
 197 }