2 * Copyright © 2013,2021 Ran Benita <ran234@gmail.com>
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:
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
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.
30 #include "xkbcommon/xkbcommon.h"
32 static struct xkb_compose_table *
33 xkb_compose_table_new(struct xkb_context *ctx,
35 enum xkb_compose_format format,
36 enum xkb_compose_compile_flags flags)
38 char *resolved_locale;
39 struct xkb_compose_table *table;
40 struct compose_node dummy;
42 resolved_locale = resolve_locale(ctx, locale);
46 table = calloc(1, sizeof(*table));
48 free(resolved_locale);
53 table->ctx = xkb_context_ref(ctx);
55 table->locale = resolved_locale;
56 table->format = format;
59 darray_init(table->nodes);
60 darray_init(table->utf8);
62 dummy.keysym = XKB_KEY_NoSymbol;
63 dummy.leaf.is_leaf = true;
65 dummy.leaf.keysym = XKB_KEY_NoSymbol;
66 darray_append(table->nodes, dummy);
68 darray_append(table->utf8, '\0');
73 XKB_EXPORT struct xkb_compose_table *
74 xkb_compose_table_ref(struct xkb_compose_table *table)
81 xkb_compose_table_unref(struct xkb_compose_table *table)
83 if (!table || --table->refcnt > 0)
86 darray_free(table->nodes);
87 darray_free(table->utf8);
88 xkb_context_unref(table->ctx);
92 XKB_EXPORT struct xkb_compose_table *
93 xkb_compose_table_new_from_file(struct xkb_context *ctx,
96 enum xkb_compose_format format,
97 enum xkb_compose_compile_flags flags)
99 struct xkb_compose_table *table;
102 if (flags & ~(XKB_COMPOSE_COMPILE_NO_FLAGS)) {
103 log_err_func(ctx, "unrecognized flags: %#x\n", flags);
107 if (format != XKB_COMPOSE_FORMAT_TEXT_V1) {
108 log_err_func(ctx, "unsupported compose format: %d\n", format);
112 table = xkb_compose_table_new(ctx, locale, format, flags);
116 ok = parse_file(table, file, "(unknown file)");
118 xkb_compose_table_unref(table);
125 XKB_EXPORT struct xkb_compose_table *
126 xkb_compose_table_new_from_buffer(struct xkb_context *ctx,
127 const char *buffer, size_t length,
129 enum xkb_compose_format format,
130 enum xkb_compose_compile_flags flags)
132 struct xkb_compose_table *table;
135 if (flags & ~(XKB_COMPOSE_COMPILE_NO_FLAGS)) {
136 log_err_func(ctx, "unrecognized flags: %#x\n", flags);
140 if (format != XKB_COMPOSE_FORMAT_TEXT_V1) {
141 log_err_func(ctx, "unsupported compose format: %d\n", format);
145 table = xkb_compose_table_new(ctx, locale, format, flags);
149 ok = parse_string(table, buffer, length, "(input string)");
151 xkb_compose_table_unref(table);
158 XKB_EXPORT struct xkb_compose_table *
159 xkb_compose_table_new_from_locale(struct xkb_context *ctx,
161 enum xkb_compose_compile_flags flags)
163 struct xkb_compose_table *table;
168 if (flags & ~(XKB_COMPOSE_COMPILE_NO_FLAGS)) {
169 log_err_func(ctx, "unrecognized flags: %#x\n", flags);
173 table = xkb_compose_table_new(ctx, locale, XKB_COMPOSE_FORMAT_TEXT_V1,
178 path = get_xcomposefile_path(ctx);
180 file = fopen(path, "rb");
186 path = get_xdg_xcompose_file_path(ctx);
188 file = fopen(path, "rb");
194 path = get_home_xcompose_file_path(ctx);
196 file = fopen(path, "rb");
202 path = get_locale_compose_file_path(ctx, table->locale);
204 file = fopen(path, "rb");
210 log_err(ctx, XKB_LOG_MESSAGE_NO_ID,
211 "couldn't find a Compose file for locale \"%s\" (mapped to \"%s\")\n",
212 locale, table->locale);
213 xkb_compose_table_unref(table);
217 ok = parse_file(table, file, path);
221 xkb_compose_table_unref(table);
225 log_dbg(ctx, XKB_LOG_MESSAGE_NO_ID,
226 "created compose table from locale %s with path %s\n",
227 table->locale, path);
233 XKB_EXPORT const xkb_keysym_t *
234 xkb_compose_table_entry_sequence(struct xkb_compose_table_entry *entry,
235 size_t *sequence_length)
237 *sequence_length = entry->sequence_length;
238 return entry->sequence;
241 XKB_EXPORT xkb_keysym_t
242 xkb_compose_table_entry_keysym(struct xkb_compose_table_entry *entry)
244 return entry->keysym;
247 XKB_EXPORT const char *
248 xkb_compose_table_entry_utf8(struct xkb_compose_table_entry *entry)
253 enum node_direction {
260 struct xkb_compose_table_iterator_cursor {
261 uint32_t node_offset:30; /* WARNING: ensure it fits MAX_COMPOSE_NODES */
262 uint8_t direction:2; /* enum node_direction: current direction
263 * traversing the tree */
266 struct xkb_compose_table_iterator {
267 struct xkb_compose_table *table;
269 struct xkb_compose_table_entry entry;
270 /* Stack of pending nodes to process */
271 darray(struct xkb_compose_table_iterator_cursor) cursors;
274 XKB_EXPORT struct xkb_compose_table_iterator *
275 xkb_compose_table_iterator_new(struct xkb_compose_table *table)
277 struct xkb_compose_table_iterator *iter;
278 struct xkb_compose_table_iterator_cursor cursor;
279 xkb_keysym_t *sequence;
281 iter = calloc(1, sizeof(*iter));
285 iter->table = xkb_compose_table_ref(table);
286 sequence = calloc(MAX_LHS_LEN, sizeof(xkb_keysym_t));
291 iter->entry.sequence = sequence;
292 iter->entry.sequence_length = 0;
294 darray_init(iter->cursors);
295 cursor.direction = NODE_LEFT;
296 /* Offset 0 is a dummy null entry, skip it. */
297 cursor.node_offset = 1;
298 darray_append(iter->cursors, cursor);
304 xkb_compose_table_iterator_free(struct xkb_compose_table_iterator *iter)
306 xkb_compose_table_unref(iter->table);
307 darray_free(iter->cursors);
308 free(iter->entry.sequence);
312 XKB_EXPORT struct xkb_compose_table_entry *
313 xkb_compose_table_iterator_next(struct xkb_compose_table_iterator *iter)
316 * This function takes the following recursive traversal function,
317 * and makes it non-recursive and resumable. The iter->cursors stack
318 * is analogous to the call stack, and cursor->direction to the
319 * instruction pointer of a stack frame.
321 * traverse(xkb_keysym_t *sequence, size_t sequence_length, uint16_t p) {
323 * // cursor->direction == NODE_LEFT
324 * node = &darray_item(table->nodes, p)
325 * traverse(sequence, sequence_length, node->lokid)
326 * // cursor->direction == NODE_DOWN
327 * sequence[sequence_length++] = node->keysym
329 * emit(sequence, sequence_length, node->leaf.keysym, table->utf[node->leaf.utf8])
331 * traverse(sequence, sequence_length, node->internal.eqkid)
333 * // cursor->direction == NODE_RIGHT
334 * traverse(sequence, sequence_length, node->hikid)
335 * // cursor->direction == NODE_UP
339 struct xkb_compose_table_iterator_cursor *cursor;
340 const struct compose_node *node;
342 while (!darray_empty(iter->cursors)) {
343 cursor = &darray_item(iter->cursors, darray_size(iter->cursors) - 1);
344 node = &darray_item(iter->table->nodes, cursor->node_offset);
346 switch (cursor->direction) {
348 cursor->direction = NODE_DOWN;
350 struct xkb_compose_table_iterator_cursor new_cursor = {node->lokid, NODE_LEFT};
351 darray_append(iter->cursors, new_cursor);
356 cursor->direction = NODE_RIGHT;
357 assert (iter->entry.sequence_length <= MAX_LHS_LEN);
358 iter->entry.sequence[iter->entry.sequence_length] = node->keysym;
359 iter->entry.sequence_length++;
361 iter->entry.keysym = node->leaf.keysym;
362 iter->entry.utf8 = &darray_item(iter->table->utf8, node->leaf.utf8);
365 struct xkb_compose_table_iterator_cursor new_cursor = {node->internal.eqkid, NODE_LEFT};
366 darray_append(iter->cursors, new_cursor);
371 cursor->direction = NODE_UP;
372 iter->entry.sequence_length--;
374 struct xkb_compose_table_iterator_cursor new_cursor = {node->hikid, NODE_LEFT};
375 darray_append(iter->cursors, new_cursor);
380 darray_remove_last(iter->cursors);