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