src/context-priv.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 "config.h"
  28
  29 #include <sys/types.h>
  30 #include <sys/stat.h>
  31 #include <errno.h>
  32
  33 #include "xkbcommon/xkbcommon.h"
  34 #include "utils.h"
  35 #include "context.h"
  36
  37 unsigned int
  38 xkb_context_num_failed_include_paths(struct xkb_context *ctx)
  39 {
  40     return darray_size(ctx->failed_includes);
  41 }
  42
  43 const char *
  44 xkb_context_failed_include_path_get(struct xkb_context *ctx,
  45                                     unsigned int idx)
  46 {
  47     if (idx >= xkb_context_num_failed_include_paths(ctx))
  48         return NULL;
  49
  50     return darray_item(ctx->failed_includes, idx);
  51 }
  52
  53 xkb_atom_t
  54 xkb_atom_lookup(struct xkb_context *ctx, const char *string)
  55 {
  56     return atom_intern(ctx->atom_table, string, strlen(string), false);
  57 }
  58
  59 xkb_atom_t
  60 xkb_atom_intern(struct xkb_context *ctx, const char *string, size_t len)
  61 {
  62     return atom_intern(ctx->atom_table, string, len, true);
  63 }
  64
  65 const char *
  66 xkb_atom_text(struct xkb_context *ctx, xkb_atom_t atom)
  67 {
  68     return atom_text(ctx->atom_table, atom);
  69 }
  70
  71 void
  72 xkb_log(struct xkb_context *ctx, enum xkb_log_level level, int verbosity,
  73         const char *fmt, ...)
  74 {
  75     va_list args;
  76
  77     if (ctx->log_level < level || ctx->log_verbosity < verbosity)
  78         return;
  79
  80     va_start(args, fmt);
  81     ctx->log_fn(ctx, level, fmt, args);
  82     va_end(args);
  83 }
  84
  85 char *
  86 xkb_context_get_buffer(struct xkb_context *ctx, size_t size)
  87 {
  88     char *rtrn;
  89
  90     if (size >= sizeof(ctx->text_buffer))
  91         return NULL;
  92
  93     if (sizeof(ctx->text_buffer) - ctx->text_next <= size)
  94         ctx->text_next = 0;
  95
  96     rtrn = &ctx->text_buffer[ctx->text_next];
  97     ctx->text_next += size;
  98
  99     return rtrn;
 100 }
 101
 102 #ifndef DEFAULT_XKB_VARIANT
 103 #define DEFAULT_XKB_VARIANT NULL
 104 #endif
 105
 106 #ifndef DEFAULT_XKB_OPTIONS
 107 #define DEFAULT_XKB_OPTIONS NULL
 108 #endif
 109
 110 static const char *
 111 xkb_context_get_default_rules(struct xkb_context *ctx)
 112 {
 113     const char *env = NULL;
 114
 115     if (ctx->use_environment_names)
 116         env = secure_getenv("XKB_DEFAULT_RULES");
 117
 118     return env ? env : DEFAULT_XKB_RULES;
 119 }
 120
 121 static const char *
 122 xkb_context_get_default_model(struct xkb_context *ctx)
 123 {
 124     const char *env = NULL;
 125
 126     if (ctx->use_environment_names)
 127         env = secure_getenv("XKB_DEFAULT_MODEL");
 128
 129     return env ? env : DEFAULT_XKB_MODEL;
 130 }
 131
 132 static const char *
 133 xkb_context_get_default_layout(struct xkb_context *ctx)
 134 {
 135     const char *env = NULL;
 136
 137     if (ctx->use_environment_names)
 138         env = secure_getenv("XKB_DEFAULT_LAYOUT");
 139
 140     return env ? env : DEFAULT_XKB_LAYOUT;
 141 }
 142
 143 static const char *
 144 xkb_context_get_default_variant(struct xkb_context *ctx)
 145 {
 146     const char *env = NULL;
 147     const char *layout = secure_getenv("XKB_DEFAULT_LAYOUT");
 148
 149     /* We don't want to inherit the variant if they haven't also set a
 150      * layout, since they're so closely paired. */
 151     if (layout && ctx->use_environment_names)
 152         env = secure_getenv("XKB_DEFAULT_VARIANT");
 153
 154     return env ? env : DEFAULT_XKB_VARIANT;
 155 }
 156
 157 static const char *
 158 xkb_context_get_default_options(struct xkb_context *ctx)
 159 {
 160     const char *env = NULL;
 161
 162     if (ctx->use_environment_names)
 163         env = secure_getenv("XKB_DEFAULT_OPTIONS");
 164
 165     return env ? env : DEFAULT_XKB_OPTIONS;
 166 }
 167
 168 void
 169 xkb_context_sanitize_rule_names(struct xkb_context *ctx,
 170                                 struct xkb_rule_names *rmlvo)
 171 {
 172     if (isempty(rmlvo->rules))
 173         rmlvo->rules = xkb_context_get_default_rules(ctx);
 174     if (isempty(rmlvo->model))
 175         rmlvo->model = xkb_context_get_default_model(ctx);
 176     /* Layout and variant are tied together, so don't try to use one from
 177      * the caller and one from the environment. */
 178     if (isempty(rmlvo->layout)) {
 179         rmlvo->layout = xkb_context_get_default_layout(ctx);
 180         rmlvo->variant = xkb_context_get_default_variant(ctx);
 181     }
 182     /* Options can be empty, so respect that if passed in. */
 183     if (rmlvo->options == NULL)
 184         rmlvo->options = xkb_context_get_default_options(ctx);
 185 }