xkbcommon/xkbcommon-compose.h

   1 /*
   2  * Copyright © 2013 Ran Benita
   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
  24 #ifndef _XKBCOMMON_COMPOSE_H
  25 #define _XKBCOMMON_COMPOSE_H
  26
  27 #include <xkbcommon/xkbcommon.h>
  28
  29 #ifdef __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 /**
  34  * @file
  35  * libxkbcommon Compose API - support for Compose and dead-keys.
  36  */
  37
  38 /**
  39  * @defgroup compose Compose and dead-keys support
  40  * Support for Compose and dead-keys.
  41  * @since 0.5.0
  42  *
  43  * @{
  44  */
  45
  46 /**
  47  * @page compose-overview Overview
  48  * @parblock
  49  *
  50  * Compose and dead-keys are a common feature of many keyboard input
  51  * systems.  They extend the range of the keysysm that can be produced
  52  * directly from a keyboard by using a sequence of key strokes, instead
  53  * of just one.
  54  *
  55  * Here are some example sequences, in the libX11 Compose file format:
  56  *
  57  *     <dead_acute> <a>         : "á"   aacute # LATIN SMALL LETTER A WITH ACUTE
  58  *     <Multi_key> <A> <T>      : "@"   at     # COMMERCIAL AT
  59  *
  60  * When the user presses a key which produces the `<dead_acute>` keysym,
  61  * nothing initially happens (thus the key is dubbed a "dead-key").  But
  62  * when the user enters `<a>`, "á" is "composed", in place of "a".  If
  63  * instead the user had entered a keysym which does not follow
  64  * `<dead_acute>` in any compose sequence, the sequence is said to be
  65  * "cancelled".
  66  *
  67  * Compose files define many such sequences.  For a description of the
  68  * common file format for Compose files, see the Compose(5) man page.
  69  *
  70  * A successfuly-composed sequence has two results: a keysym and a UTF-8
  71  * string.  At least one of the two is defined for each sequence.  If only
  72  * a keysym is given, the keysym's string representation is used for the
  73  * result string (using xkb_keysym_to_utf8()).
  74  *
  75  * This library provides low-level support for Compose file parsing and
  76  * processing.  Higher-level APIs (such as libX11's `Xutf8LookupString`(3))
  77  * may be built upon it, or it can be used directly.
  78  *
  79  * @endparblock
  80  */
  81
  82 /**
  83  * @page compose-conflicting Conflicting Sequences
  84  * @parblock
  85  *
  86  * To avoid ambiguity, a sequence is not allowed to be a prefix of another.
  87  * In such a case, the conflict is resolved thus:
  88  *
  89  * 1. A longer sequence overrides a shorter one.
  90  * 2. An equal sequence overrides an existing one.
  91  * 3. A shorter sequence does not override a longer one.
  92  *
  93  * Sequences of length 1 are allowed.
  94  *
  95  * @endparblock
  96  */
  97
  98 /**
  99  * @page compose-cancellation Cancellation Behavior
 100  * @parblock
 101  *
 102  * What should happen when a sequence is cancelled?  For example, consider
 103  * there are only the above sequences, and the input keysyms are
 104  * `<dead_acute> <b>`.  There are a few approaches:
 105  *
 106  * 1. Swallow the cancelling keysym; that is, no keysym is produced.
 107  *    This is the approach taken by libX11.
 108  * 2. Let the cancelling keysym through; that is, `<b>` is produced.
 109  * 3. Replay the entire sequence; that is, `<dead_acute> <b>` is produced.
 110  *    This is the approach taken by Microsoft Windows (approximately;
 111  *    instead of `<dead_acute>`, the underlying key is used.  This is
 112  *    difficult to simulate with XKB keymaps).
 113  *
 114  * You can program whichever approach best fits users' expectations.
 115  *
 116  * @endparblock
 117  */
 118
 119 /**
 120  * @struct xkb_compose_table
 121  * Opaque Compose table object.
 122  *
 123  * The compose table holds the definitions of the Compose sequences, as
 124  * gathered from Compose files.  It is immutable.
 125  */
 126 struct xkb_compose_table;
 127
 128 /**
 129  * @struct xkb_compose_state
 130  * Opaque Compose state object.
 131  *
 132  * The compose state maintains state for compose sequence matching, such
 133  * as which possible sequences are being matched, and the position within
 134  * these sequences.  It acts as a simple state machine wherein keysyms are
 135  * the input, and composed keysyms and strings are the output.
 136  *
 137  * The compose state is usually associated with a keyboard device.
 138  */
 139 struct xkb_compose_state;
 140
 141 /** Flags affecting Compose file compilation. */
 142 enum xkb_compose_compile_flags {
 143     /** Do not apply any flags. */
 144     XKB_COMPOSE_COMPILE_NO_FLAGS = 0
 145 };
 146
 147 /** The recognized Compose file formats. */
 148 enum xkb_compose_format {
 149     /** The classic libX11 Compose text format, described in Compose(5). */
 150     XKB_COMPOSE_FORMAT_TEXT_V1 = 1
 151 };
 152
 153 /**
 154  * @page compose-locale Compose Locale
 155  * @parblock
 156  *
 157  * Compose files are locale dependent:
 158  * - Compose files are written for a locale, and the locale is used when
 159  *   searching for the appropriate file to use.
 160  * - Compose files may reference the locale internally, with directives
 161  *   such as \%L.
 162  *
 163  * As such, functions like xkb_compose_table_new_from_locale() require
 164  * a `locale` parameter.  This will usually be the current locale (see
 165  * locale(7) for more details).  You may also want to allow the user to
 166  * explicitly configure it, so he can use the Compose file of a given
 167  * locale, but not use that locale for other things.
 168  *
 169  * You may query the current locale as follows:
 170  * @code
 171  *     const char *locale;
 172  *     locale = setlocale(LC_CTYPE, NULL);
 173  * @endcode
 174  *
 175  * This will only give useful results if the program had previously set
 176  * the current locale using setlocale(3), with `LC_CTYPE` or `LC_ALL`
 177  * and a non-NULL argument.
 178  *
 179  * If you prefer not to use the locale system of the C runtime library,
 180  * you may nevertheless obtain the user's locale directly using
 181  * environment variables, as described in locale(7).  For example,
 182  * @code
 183  *     locale = getenv("LC_ALL");
 184  *     if (!locale)
 185  *         locale = getenv("LC_CTYPE");
 186  *     if (!locale)
 187  *         locale = getenv("LANG");
 188  *     if (!locale)
 189  *         locale = "C";
 190  * @endcode
 191  *
 192  * Note that some locales supported by the C standard library may not
 193  * have a Compose file assigned.
 194  *
 195  * @endparblock
 196  */
 197
 198 /**
 199  * Create a compose table for a given locale.
 200  *
 201  * The locale is used for searching the file-system for an appropriate
 202  * Compose file.  The search order is described in Compose(5).  It is
 203  * affected by the following environment variables:
 204  *
 205  * 1. `XCOMPOSEFILE` - see Compose(5).
 206  * 2. `HOME` - see Compose(5).
 207  * 3. `XLOCALEDIR` - if set, used as the base directory for the system's
 208  *    X locale files, e.g. `/usr/share/X11/locale`, instead of the
 209  *    preconfigured directory.
 210  *
 211  * @param context
 212  *     The library context in which to create the compose table.
 213  * @param locale
 214  *     The current locale.  See @ref compose-locale.
 215  * @param flags
 216  *     Optional flags for the compose table, or 0.
 217  *
 218  * @returns A compose table for the given locale, or NULL if the
 219  * compilation failed or a Compose file was not found.
 220  *
 221  * @memberof xkb_compose_table
 222  */
 223 struct xkb_compose_table *
 224 xkb_compose_table_new_from_locale(struct xkb_context *context,
 225                                   const char *locale,
 226                                   enum xkb_compose_compile_flags flags);
 227
 228 /**
 229  * Create a new compose table from a Compose file.
 230  *
 231  * @param context
 232  *     The library context in which to create the compose table.
 233  * @param file
 234  *     The Compose file to compile.
 235  * @param locale
 236  *     The current locale.  See @ref compose-locale.
 237  * @param format
 238  *     The text format of the Compose file to compile.
 239  * @param flags
 240  *     Optional flags for the compose table, or 0.
 241  *
 242  * @returns A compose table compiled from the given file, or NULL if
 243  * the compilation failed.
 244  *
 245  * @memberof xkb_compose_table
 246  */
 247 struct xkb_compose_table *
 248 xkb_compose_table_new_from_file(struct xkb_context *context,
 249                                 FILE *file,
 250                                 const char *locale,
 251                                 enum xkb_compose_format format,
 252                                 enum xkb_compose_compile_flags flags);
 253
 254 /**
 255  * Create a new compose table from a memory buffer.
 256  *
 257  * This is just like xkb_compose_table_new_from_file(), but instead of
 258  * a file, gets the table as one enormous string.
 259  *
 260  * @see xkb_compose_table_new_from_file()
 261  * @memberof xkb_compose_table
 262  */
 263 struct xkb_compose_table *
 264 xkb_compose_table_new_from_buffer(struct xkb_context *context,
 265                                   const char *buffer, size_t length,
 266                                   const char *locale,
 267                                   enum xkb_compose_format format,
 268                                   enum xkb_compose_compile_flags flags);
 269
 270 /**
 271  * Take a new reference on a compose table.
 272  *
 273  * @returns The passed in object.
 274  *
 275  * @memberof xkb_compose_table
 276  */
 277 struct xkb_compose_table *
 278 xkb_compose_table_ref(struct xkb_compose_table *table);
 279
 280 /**
 281  * Release a reference on a compose table, and possibly free it.
 282  *
 283  * @param table The object.  If it is NULL, this function does nothing.
 284  *
 285  * @memberof xkb_compose_table
 286  */
 287 void
 288 xkb_compose_table_unref(struct xkb_compose_table *table);
 289
 290 /** Flags for compose state creation. */
 291 enum xkb_compose_state_flags {
 292     /** Do not apply any flags. */
 293     XKB_COMPOSE_STATE_NO_FLAGS = 0
 294 };
 295
 296 /**
 297  * Create a new compose state object.
 298  *
 299  * @param table
 300  *     The compose table the state will use.
 301  * @param flags
 302  *     Optional flags for the compose state, or 0.
 303  *
 304  * @returns A new compose state, or NULL on failure.
 305  *
 306  * @memberof xkb_compose_state
 307  */
 308 struct xkb_compose_state *
 309 xkb_compose_state_new(struct xkb_compose_table *table,
 310                       enum xkb_compose_state_flags flags);
 311
 312 /**
 313  * Take a new reference on a compose state object.
 314  *
 315  * @returns The passed in object.
 316  *
 317  * @memberof xkb_compose_state
 318  */
 319 struct xkb_compose_state *
 320 xkb_compose_state_ref(struct xkb_compose_state *state);
 321
 322 /**
 323  * Release a reference on a compose state object, and possibly free it.
 324  *
 325  * @param state The object.  If NULL, do nothing.
 326  *
 327  * @memberof xkb_compose_state
 328  */
 329 void
 330 xkb_compose_state_unref(struct xkb_compose_state *state);
 331
 332 /**
 333  * Get the compose table which a compose state object is using.
 334  *
 335  * @returns The compose table which was passed to xkb_compose_state_new()
 336  * when creating this state object.
 337  *
 338  * This function does not take a new reference on the compose table; you
 339  * must explicitly reference it yourself if you plan to use it beyond the
 340  * lifetime of the state.
 341  *
 342  * @memberof xkb_compose_state
 343  */
 344 struct xkb_compose_table *
 345 xkb_compose_state_get_compose_table(struct xkb_compose_state *state);
 346
 347 /** Status of the Compose sequence state machine. */
 348 enum xkb_compose_status {
 349     /** The initial state; no sequence has started yet. */
 350     XKB_COMPOSE_NOTHING,
 351     /** In the middle of a sequence. */
 352     XKB_COMPOSE_COMPOSING,
 353     /** A complete sequence has been matched. */
 354     XKB_COMPOSE_COMPOSED,
 355     /** The last sequence was cancelled due to an unmatched keysym. */
 356     XKB_COMPOSE_CANCELLED
 357 };
 358
 359 /** The effect of a keysym fed to xkb_compose_state_feed(). */
 360 enum xkb_compose_feed_result {
 361     /** The keysym had no effect - it did not affect the status. */
 362     XKB_COMPOSE_FEED_IGNORED,
 363     /** The keysym started, advanced or cancelled a sequence. */
 364     XKB_COMPOSE_FEED_ACCEPTED
 365 };
 366
 367 /**
 368  * Feed one keysym to the Compose sequence state machine.
 369  *
 370  * This function can advance into a compose sequence, cancel a sequence,
 371  * start a new sequence, or do nothing in particular.  The resulting
 372  * status may be observed with xkb_compose_state_get_status().
 373  *
 374  * Some keysyms, such as keysyms for modifier keys, are ignored - they
 375  * have no effect on the status or otherwise.
 376  *
 377  * The following is a description of the possible status transitions, in
 378  * the format CURRENT STATUS => NEXT STATUS, given a non-ignored input
 379  * keysym `keysym`:
 380  *
 381    @verbatim
 382    NOTHING or CANCELLED or COMPOSED =>
 383       NOTHING   if keysym does not start a sequence.
 384       COMPOSING if keysym starts a sequence.
 385       COMPOSED  if keysym starts and terminates a single-keysym sequence.
 386
 387    COMPOSING =>
 388       COMPOSING if keysym advances any of the currently possible
 389                 sequences but does not terminate any of them.
 390       COMPOSED  if keysym terminates one of the currently possible
 391                 sequences.
 392       CANCELLED if keysym does not advance any of the currently
 393                 possible sequences.
 394    @endverbatim
 395  *
 396  * The current Compose formats do not support multiple-keysyms.
 397  * Therefore, if you are using a function such as xkb_state_key_get_syms()
 398  * and it returns more than one keysym, consider feeding XKB_KEY_NoSymbol
 399  * instead.
 400  *
 401  * @param state
 402  *     The compose state object.
 403  * @param keysym
 404  *     A keysym, usually obtained after a key-press event, with a
 405  *     function such as xkb_state_key_get_one_sym().
 406  *
 407  * @returns Whether the keysym was ignored.  This is useful, for example,
 408  * if you want to keep a record of the sequence matched thus far.
 409  *
 410  * @memberof xkb_compose_state
 411  */
 412 enum xkb_compose_feed_result
 413 xkb_compose_state_feed(struct xkb_compose_state *state,
 414                        xkb_keysym_t keysym);
 415
 416 /**
 417  * Reset the Compose sequence state machine.
 418  *
 419  * The status is set to XKB_COMPOSE_NOTHING, and the current sequence
 420  * is discarded.
 421  *
 422  * @memberof xkb_compose_state
 423  */
 424 void
 425 xkb_compose_state_reset(struct xkb_compose_state *state);
 426
 427 /**
 428  * Get the current status of the compose state machine.
 429  *
 430  * @see xkb_compose_status
 431  * @memberof xkb_compose_state
 432  **/
 433 enum xkb_compose_status
 434 xkb_compose_state_get_status(struct xkb_compose_state *state);
 435
 436 /**
 437  * Get the result Unicode/UTF-8 string for a composed sequence.
 438  *
 439  * See @ref compose-overview for more details.  This function is only
 440  * useful when the status is XKB_COMPOSE_COMPOSED.
 441  *
 442  * @param[in] state
 443  *     The compose state.
 444  * @param[out] buffer
 445  *     A buffer to write the string into.
 446  * @param[in] size
 447  *     Size of the buffer.
 448  *
 449  * @warning If the buffer passed is too small, the string is truncated
 450  * (though still NUL-terminated).
 451  *
 452  * @returns
 453  *   The number of bytes required for the string, excluding the NUL byte.
 454  *   If the sequence is not complete, or does not have a viable result
 455  *   string, returns 0, and sets `buffer` to the empty string (if possible).
 456  * @returns
 457  *   You may check if truncation has occurred by comparing the return value
 458  *   with the size of `buffer`, similarly to the `snprintf`(3) function.
 459  *   You may safely pass NULL and 0 to `buffer` and `size` to find the
 460  *   required size (without the NUL-byte).
 461  *
 462  * @memberof xkb_compose_state
 463  **/
 464 int
 465 xkb_compose_state_get_utf8(struct xkb_compose_state *state,
 466                            char *buffer, size_t size);
 467
 468 /**
 469  * Get the result keysym for a composed sequence.
 470  *
 471  * See @ref compose-overview for more details.  This function is only
 472  * useful when the status is XKB_COMPOSE_COMPOSED.
 473  *
 474  * @returns The result keysym.  If the sequence is not complete, or does
 475  * not specify a result keysym, returns XKB_KEY_NoSymbol.
 476  *
 477  * @memberof xkb_compose_state
 478  **/
 479 xkb_keysym_t
 480 xkb_compose_state_get_one_sym(struct xkb_compose_state *state);
 481
 482 /** @} */
 483
 484 #ifdef __cplusplus
 485 } /* extern "C" */
 486 #endif
 487
 488 #endif /* _XKBCOMMON_COMPOSE_H */