xkbcommon.map : add an omitted api : xkb_keymap_key_set_repeats

Change-Id: I4188a29b0b170f6d729f1ea8762a1decca6acc3a
Signed-off-by: Sung-Jin Park <sj76.park@samsung.com>

packaging: add disable-docs option

Change-Id: I8d41d36a05601ba752f3166f978c81c22349a3b2
Signed-off-by: Sung-Jin Park <sj76.park@samsung.com>

packaging: modify some files to bump to 0.7.2

Change-Id: I19d76d9b0e6ee79c1f0a07a7099131aca69d53dc
Signed-off-by: Sung-Jin Park <sj76.park@samsung.com>

cast a function's return value

Change-Id: I16fe4f7393941353ccc12eb9c365a6911d075a17

packaging: add gawk to fix dependency broken issue

Change-Id: I24e14b56c9ed2f05bfd78b1c524b5921b5ff178b
Signed-off-by: Sung-Jin Park <sj76.park@samsung.com>

packaging: update packaging file to install license file via %license macro

Change-Id: I40e0c148db7b6c668a62d273287d26855d13eb62
Signed-off-by: Sung-Jin Park <sj76.park@samsung.com>

Change a key symbol generationg file

Change-Id: I3e360b3233f60374e73e394b5621af18965e351b

Fix .spec to create build directory with the version (e.g) libxkbcommon-{version}

Change-Id: I1a03ab7d2d5f6294be6cc8b78bc8e3394e17c34e

Remove unnecessary options

Change-Id: I605e843c10f982d20c64d8d6a1049b2c86526143

Remove build-time profile dependencies

The usage of profile macro in the previous spec file
has no effect on the code or binary.

Remove the usage of profile macro from the spec file
to allow build optimization.

Change-Id: Ib75ce96679880c38af39117fb7d4d520d776f92f
Signed-off-by: MyungJoo Ham <myungjoo.ham@samsung.com>

Remove the exception for tizen common in .spec file

Change-Id: I70882938d33cd69bb6392d50b66918fbbb7660ac

Generate new keysyms although profile is common

Change-Id: I3311c7455a0bcb5ab0fc2c42a9276c34bf64a2da

Add a new API to set key repeat

Change-Id: If1644c4c6575b4eb7cadb8c1e11147651013d8ef

Apply directory macros and install license file to the proper directory

Change-Id: Icf6d15c1ad958177ee19e479e3368465261cee44

Change a buildrequires e-tizen-data to xkb-tizen-data for install a keylayout file

Change-Id: Iafe622fe6e4a92903968ed1dbe3c1493fdf0a936

Revert "Package version up"

This reverts commit fde4b3a46856a0bbdd581dffd0abe48cbdaefc25.

Change-Id: If8d2594eef776e0e9634377bdbe76cb7eeb90db8

Package version up

Change-Id: Ifcdd49774afaea23c0a8473ccfa597e280feacd2

Modify a dependancy for install a keymap file e-tizen-data to xkb-data

Change-Id: I8461b799bcc6a73afb1f91e3bd48340fa20060a6

Modify a keymap maker script for remove duplicataed defined symbols

Change-Id: I674217754f90bfbc548514f3a695dc3587861e56

Generate a tizen keymap header using a tizen key layout file - The tizen keylayout file is defined in specific profiles (except a common profile)

Change-Id: I96eef7cea11466129fd723a6ee6b35fb378c4dae

packaging: gbs: use upstream-git branch

Change-Id: I16ca48771ed638bb19707728edab44388e0a1d76
Signed-off-by: Philippe Coval <philippe.coval@open.eurogiciel.org>

packaging: depend on the same release

Change-Id: Icbd6b049c83820cfb84c0da0df6ceb138a99afea
Signed-off-by: Philippe Coval <philippe.coval@open.eurogiciel.org>

packaging: Bump to version 0.4.3

Use upstream git repo instead of pristin-tar.

Also clean spec file.

Change-Id: Idcbac423d2cd35cea1a4c697fa41889584cbfad0
Bug-Tizen: TC-1846
Signed-off-by: Kévin THIERRY <kevin.thierry@open.eurogiciel.org>
Signed-off-by: Philippe Coval <philippe.coval@open.eurogiciel.org>

add --disable-x11

Change-Id: I6d12c715006d1bbd32f0985801b050281edf9aa3

remove .gbs.conf because we don't trace remote git any more

Change-Id: I443aa4dd2aad04653758618b338921f43275ab21

package version up

Change-Id: I47163cf02759977333bf7cd78788487c1fd6d444

Removed build dependency on kbproto.

Not use any thing from kbproto, so remove it.

Change-Id: I6059004d9ff9295b63a7f05568ccd1373288f2c1

Removed build dependency on xproto.

Not use any thing from xproto, so remove it.

Change-Id: I7656733575c6b78e0716485525637f41352e29e6
Signed-off-by: Alex Wu <zhiwen.wu@linux.intel.com>

add gbs.conf

Change-Id: Ic11c4792ccd2a9f5ceb7113c1b765a85205bad4a

resetting manifest requested domain to floor

Update to 0.3.0

add packaging

Bump version to 1.6.0

Signed-off-by: Ran Benita <ran@unusedvar.com>

Update NEWS for 1.6.0 (#385)

Keysyms: Fix missing hpYdiaeresis

The handling of keysym name guards (e.g. `#ifndef XK_Ydiaeresis`) was
incomplete and led to a missing keysym.

Make `sripts/makeheader` more robust to C macros handling.

Tools: Add bash completions for xkbcli

- Add bash completion script. It parses the commands help messages to
  provide the completions, thus any new subcommand or option will be
  supported, as long as it has its entry in the help messages. This
  should result in low maintenancei effort.
- Add installation entry in Meson. The path can be configured using
  the following options:
  - `enable-bash-completion` to enable the installation;
  - `bash-completion-path` to control the installation path. It will
    default to: `share/bash-completion/completions`.

TODO: completion for other shells, such as zsh?

Tools: Improve xkbcli help messages and manual pages

Add missing `--help` and `--short` entries.

Fix trailing whitespaces in XKB files

Python: make ruff & black happy

Add support for pre-commit

See https://pre-commit.com for further info. Current checks:

- Whitespaces
- Yaml
- Large files
- Python linting/formatting

TODO: investigate options for C linter and formatter

Keysyms: Fix failing tests

- Update keymap to use reference keysym names.
- Fix x11comp test by handling old x11proto.

  We need xkbcomp to be compiled with at least x11proto-dev 2023.2.
  So we replace the unsupported keysyms with supported ones not
  already in the keymap. This is kind of ugly, but it works. If we
  ever want to restore the original keysyms with their supported names,
  the substitute keysyms will be easy to spot.

Keysyms: Update using latest xorgproto

xorgproto commit: 1c8128d72df22843a2022576850bc5ab5e3a46ea.

scripts/makeheader: Minor improvements

Use `pathlib` for proper path handling.

Show invalid escape sequences

It is easier to debug when the message actually displays the offending
escape sequence.

Prevent overflow of octal escape sequences

The octal parser accepts the range `\1..\777`. The result is cast to
`char` which will silently overflow.

This commit prevents overlow and will treat `\400..\777` as invalid
escape sequences.

Disallow producing NULL character with escape sequences

NULL usually terminates the strings; allowing to produce it via escape
sequences may lead to undefined behaviour.

- Make NULL escape sequences (e.g. `\0` and `\x0`) invalid.
- Add corresponding test.
- Introduce the new message: XKB_WARNING_INVALID_ESCAPE_SEQUENCE.

Compose: add iterator API

Allow users to iterate the entries in a compose table. This is useful
for other projects which want programmable access to the sequences,
without having to write their own parser.

- New API:
  - `xkb_compose_table_entry_sequence`;
  - `xkb_compose_table_entry_keysym`;
  - `xkb_compose_table_entry_utf8`;
  - `xkb_compose_table_iterator_new`;
  - `xkb_compose_table_iterator_free`;
  - `xkb_compose_table_iterator_next`.
- Add tests in `test/compose.c`.
- Add benchmark for compose traversal.
- `tools/compose.c`:
  - Print entries instead of just validating them.
  - Add `--file` option.
  - TODO: make this tool part of the xkbcli commands.

Co-authored-by: Pierre Le Marre <dev@wismill.eu>
Co-authored-by: Ran Benita <ran@unusedvar.com>
Signed-off-by: Ran Benita <ran@unusedvar.com>

Messages: merge macros with and without message code

Previously we had two types of macros for logging: with and without
message code. They were intended to be merged afterwards.

The idea is to use a special code – `XKB_LOG_MESSAGE_NO_ID = 0` – that
should *not* be displayed. But we would like to avoid checking this
special code at run time. This is achieved using macro tricks; they
are detailed in the code (see: `PREPEND_MESSAGE_ID`).

Now it is also easier to spot the remaining undocumented log entries:
just search `XKB_LOG_MESSAGE_NO_ID`.

Messages: add new messages to registry

This commit is another step to identify and document the maximum number
of logging messages. Bulk changes:

- Rename `conflicting-key-type` to `conflicting-key-type-merging-groups`.
  Giving more context in the name allow us to introduce
  `conflicting-key-type-definitions` later.
- Add conflicting-key-type-definitions
- Add conflicting-key-type-map-entry
- Add undeclared-modifiers-in-key-type
  Also improve the log messages.
- Add conflicting-key-type-preserve-entries
- Use XKB_ERROR_UNSUPPORTED_MODIFIER_MASK
- Add illegal-key-type-preserve-result
- Add conflicting-key-type-level-names
- Add duplicate-entry
- Add unsupported-symbols-field
- Add missing-symbols-group-name-index
- Use XKB_ERROR_WRONG_FIELD_TYPE
- Add conflicting-key-name
- Use XKB_WARNING_UNDEFINED_KEYCODE
- Add illegal-keycode-alias
- Add unsupported-geometry-section
- Add missing-default-section
- Add XKB_LOG_MESSAGE_NO_ID
- Rename log_vrb_with_code to log_vrb
- Use ERROR_WRONG_FIELD_TYPE & ERROR_INVALID_SYNTAX
- Add unknown-identifier
- Add invalid-expression-type
- Add invalid-operation + fixes
- Add unknown-operator
- Rename ERROR_UNKNOWN_IDENTIFIER to ERROR_INVALID_IDENTIFIER
- Add undeclared-virtual-modifier
- Add expected-array-entry
- Add invalid-include-statement
- Add included-file-not-found
- Add allocation-error
- Add invalid-included-file
- Process symbols.c
- Add invalid-value
- Add invalid-real-modifier
- Add unknown-field
- Add wrong-scope
- Add invalid-modmap-entry
- Add wrong-statement-type
- Add conflicting-key-symbols-entry
- Add invalid-set-default-statement

Keysyms: improve generator (#364)

Motivation: normalization of keysyms header files in `xorgproto`. See:
https://gitlab.freedesktop.org/xorg/proto/xorgproto/-/merge_requests/80

Improve `scripts/makeheader`:
- Simplify `evdev` and `XK_` substitution and improve alignment. Also, perform
  some additional `XK_` substitutions in comments.
- Format with `black`.

Add a new warning for numeric keysyms

Usually it is better to use the corresponding human-friendly keysym
names. If there is none, then the keysym is most probably not
supported in the ecosystem. The only use case I see is similar to the
PUA in Unicode (see: https://en.wikipedia.org/wiki/Private_Use_Areas).
I am not aware of examples of this kind of use.

Add xkb-check-messages tool

This tool checks whether messages codes are supported.

This is useful e.g. for CI, where one may want to grep for some XKB
error codes and ensure that these are still supported.

Use warning code in xkeyboard-config test

Structured log messages with a message registry

Currently there is little structure in the log messages, making
difficult to use them for the following use cases:

- A user looking for help about a log message: the user probably
  uses a search engine, thus the results will depend on the proper
  indexing of our documentation and the various forums. It relies
  only on the wording of the message, which may change with time.
- A user wants to filter the logs resulting of the use of one of the
  components of xkbcommon. A typical example would be testing
  xkeyboard-config against libxkbcommon. It requires the use of a
  pattern (simple words detection or regex). The issue is that the
  pattern may become silently out-of-sync with xkbcommon.

A common practice (e.g. in compilers) is to assign unique error codes
to reference theses messages, along with an error index for
documentation.

Thus this commit implements the following features:

- Create a message registry (message-registry.yaml) that defines the
  log messages produced by xkbcommon. This is a simple YAML file that
  provides, for each message:

  - A unique numeric code as a short identifier. It is used in the
    output message and thus can be easily be filtered to spot errors
    or searched in the internet. It must not change: if the
    semantics of message changes, it is better to introduce a new
    message for clarity.
  - A unique text identifier, meant for two uses:

    1. Generate constants dealing with log information in our code
       base.
    2. Generate human-friendly names for the documentation.

  - A type: currently warning or error. Used to prefix the constants
    (see hereinabove) and for basic classification in documentation.
  - A short description, used as concise and mandatory documentation.
  - An optionnal detailed description.
  - Optional examples, intended to help the user to fix issues
    themself.
  - Version of xkbcommon it was added. For old entries this often
    unknown, so they will default to 1.0.0.
  - Version of xkbcommon it was removed (optional)

  No entry should ever be deleted from this index, even if the message
  is not used anymore: it ensures we have unique identifiers along the
  history of xkbcommon, and that users can refer to the documentation
  even for older versions.

- Add the script update-message-registry.py to generate the following
  files:

  - messages.h: message code enumeration for the messages currently
    used in the code base. Currently a private API.
  - message.registry.md: the error index documentation page.

- Modify the logging functions to use structured messages. This is a
  work in progress.

interactive-evdev: add option to print modmaps

Add an option to print modmap and vmodmap of relevant keys, as well as
virtual modifiers mapping to real modifier. This is useful for debugging.
It uses private API, so we compile it separately in the fashion of
`xkbcli-compile-keymap/compile-keymap`.

Interactive tools: add options to hide some fields

Display can be cluttered when too many fields are displayed.

Add options to hide some default fields

Interactive tools: always print keycode

Interactive tools: Escape control character for Unicode output

Currently the interactive tools print the string result of key strokes
as it is, without any escape. This is especially annoying for trivial
keysyms such as: Return, BackSpace and Escape.

Fix this by displaying the Unicode code point notation (e.g U+000D for
Return) for single control characters from the C0 set and DEL.

This is a hack: ideally we would like to escape any non-printable
character in the utf-8 string.

CI: Use git master for xkeyboard-config on Linux

xkeyboard-config and xkbcommon projects are quite intertwined so we
want things to blow up early.

It also solves an issue with the x11comp test.

Test: Enable x11comp and use the xvfb wrapper

This test was previously disabled in 914e84e0188b5fbd67855f38f4499bb1412f4516.

Note that it requires a recent version of xkeyboard-config to succeed.

Test: Catch SIGUSR1 from Xvfb for X11 tests

Based on the work done by Peter Hutterer. Original commit message:

If SIGUSR1 is set to SIG_IGN, X servers (all of them, including Xvfb)
will send that signal to the parent process when they're ready to accept
connections. We can use that instead of a hardcoded sleep which brings
the wait down to ~37ms on my box.

Test: Use a xvfb wrapper for x11 test

The x11 test is currently silently skipped in CI, because it requires a
running X server.

Create a xvfb wrapper to run the test. We do not use `xvfb-run`, because
it is a shell script and it causes valgrind to detect unrelated memory
issues in the shell (dash, bash).

Improve wrapper using a special ELF section

TODO: The wrapper is intended to be used with the x11comp test as well.

doc: fix some Doxygen warnings

```
libxkbcommon/doc/introduction-to-xkb.md:67: warning: unable to resolve reference to 'rule-file-format' for \ref command
libxkbcommon/doc/introduction-to-xkb.md:181: warning: unable to resolve reference to 'keymap-text-format-v1' for \ref command
libxkbcommon/doc/rules-format.md:10: warning: unable to resolve reference to 'xkb-intro' for \ref command
```

Signed-off-by: Ran Benita <ran@unusedvar.com>

parser: change deprecated `%pure-parser` to `%define api.pure` (#370)

This is now supported by byacc since version 2.0 20230516

Improved tests related to keysyms

- Add a keymap test with decimal and hexadecimal keysyms.
- Reorganize code in `test/keysym.c` by parsing type: name, Unicode and
  hexadecimal.
- Add more tests for edge cases. In particular:
  - test decimal format (currently not supported);
  - test the Unicode and hexadecimal ranges more thoroughly;
  - test with wrong case without the XKB_KEYSYM_CASE_INSENSITIVE flag;
  - test surrounding spaces.
- Document the tests.

Fix parsing of numeric keysyms in ExprResolveKeySym

`ExprResolveKeySym` in `expr.c` does not parse non-digit numeric
keysyms.

Fixed by checking upper bound; also add warning messages.

Simplify parsing of numeric keysyms in parser.y

In `parser.y`, a numeric keysym is parsed by formatting it in its
hexadecimal form then parsed as a keysym name. This is convoluted.

Fixed by checking directly the upper bound.

Fix xkb_keysym_from_name for numeric keysyms

When parsing hexadecimal keysym using `xkb_keysym_from_name`,
the result is limited by `parse_keysym_hex` to 0xffffffff, but the
maximum keysym is XKB_MAX_KEYSYM, i.e. 0x1fffffff.

Fixed by adding an upper bound.

Move STRINGIFY to utils.h and add STRINGIFY2

Improve the documentation of keysyms in xkbcommon.h

Add XKB_KEYSYM_MIN and XKB_KEYSYM_MAX

Keysyms are 32-bit integers with the 3 most significant bits always set
to zero. See: Appendix A “KEYSYM Encoding” of the X Window System
Protocol at https://www.x.org/releases/current/doc/xproto/x11protocol.html#keysym_encoding.

Add a new constants XKB_KEYSYM_MIN and XKB_KEYSYM_MAX to make the
interval of valid keysyms more obvious in the code.

Replace keycode numeric offset with EVDEV_OFFSET

Add a constant `EVDEV_OFFSET` to make the semantic of the offset clearer.

Check the doxygen version

Doxygen 1.9.7 breaks our urls, see issue #347. Let's put a check for the
doxygen version into our CI build so that if our base distro updates beyond
that, the CI fails and we know we have to build doxygen from scratch or
update to some other version that's supported.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>

Configure github pages

Upload the doxygen output as artifact from the linux build and use that from
the pages job where we combine the static website with our newly build HTML
docs.  The GitHub actions/download-artefact doesn't work across workflows so
we use the other popular one that can do this. The rest of the job is
basically copy/paste from the "Static HTML" example GitHub provides.

To make this useful as drop-in replacement, replace the one fixed link to the
API docs a relative one.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>

xkbcli: allow compile-keymap without args

All of the arguments have defaults, but still an argument is required.
Make it work.

Signed-off-by: Ran Benita <ran@unusedvar.com>

Add a meson flag to make cool URIs optional

The script `ensure-stable-doc-urls.py` relies on the Doxygen output files
names. These may change between Doxygen versions, although the Doxygen
developers intend stability.

Since the script is useful mainly for the online documentation of
xkbcommon, make the target `doc-cool-uris` optional.

Test(compose): fix assumption on environment variables

The test `test_from_locale` fails when there is a user-defined compose
file, e.g. ~/.XCompose.

Indeed, the function `xkb_compose_table_new_from_locale` use various
environment variables to determine the location of the compose file.

Ensure no environment variables but the required ones are set, in order
to have robust tests.

interactive-evdev: includes options

Currently there is no interactive tool allowing to set the include
paths of the context, such as in "compile-keymap". Note that only
"interactive-evdev" makes sense, because it does not rely on a
compositor.

Add --include and --include-defaults to "interactive-evdev" tool.
The code is adapted from "compile-keymap".

CI: Fix documentation generation for macOS

- Force Doxygen version 1.9.6, because 1.9.7 breaks our doc cool URIs,
  i.e. our system that maintain stable doc pages via redirection.

  Associated issue in Doxygen:
  https://github.com/doxygen/doxygen/issues/10146

- Install graphviz to build the .dot files.

Fix typo in ensure-stable-doc-urls.py

compose: drop the 65535 node limit (#343)

In commit 1638409b22aef33d487863876ab214b949db4984, the number of
compose nodes was limited to 65535 to enable "future optimizations",
which apparently means slightly reduced memory usage due to fitting in
a uint16_t. At this time, it was mentioned that the author was not
aware of "any compose files which come close".

However, I'm one of the users that actually do require a larger number
of nodes for their compose file. Thus, use a uint32_t again and raise
the limit significantly.

Add support for stable doc URLs (#342)

Doc URLs may change with time because they depend on Doxygen machinery.
This is unfortunate because it is good practice to keep valid URLs
(see: https://www.w3.org/Provider/Style/URI.html).

I could not find a built-in solution in Doxygen, so the solution proposed
here is to maintain a registry of all URLs and manage legacy URLs as
redirections to their canonical page.

This commit adds a registry of URLs that has three functions:
- Check no previous URL is now invalid.
- Add aliases for moved pages.
- Generate redirection pages for aliases. The redirection works with
  a simple <meta http-equiv="refresh"> HTML tag. See:
  https://developer.mozilla.org/en-US/docs/Web/HTML/Element/meta#http-equiv

This commit also initialize the URLs registry with current pages and some
redirections needed after recent documentation refactoring.

Finally, the CI is updated to catch any change that invalidate previous
URLs.

Improve documentation

- Add introduction to XKB
- Embrace Doxygen features
- More cross links

Do not interpret nor emit invalid Unicode encoding forms

Surrogates are invalid in both UTF-32 and UTF-8.
See https://www.unicode.org/versions/Unicode15.0.0/ch03.pdf#G28875
and https://www.unicode.org/versions/Unicode15.0.0/ch03.pdf#G31703

Add warning when RMLVO with no layout but variant set

There is no feedback that they are both replaced with default values.
Fix it by adding a warning informing about missing layout and show the
defaults for both.

ci: bump runs-on versions

Mostly to bump to macos one which will hopefully fix CI issues there.

Signed-off-by: Ran Benita <ran@unusedvar.com>

utils: fix printf format warnings on mingw

See:
https://github.com/mesonbuild/wrapdb/pull/819
https://github.com/Exiv2/exiv2/blob/c86ae6acf597304db37246434ebc393d732c22c2/src/image_int.hpp#L15
https://sourceforge.net/p/mingw-w64/wiki2/gnu%20printf/

Signed-off-by: Ran Benita <ran@unusedvar.com>

ci/windows: use the vs backend instead of ninja backend

So we have some coverage of that.

Signed-off-by: Ran Benita <ran@unusedvar.com>

build: show a summary

Signed-off-by: Ran Benita <ran@unusedvar.com>

build: require bison >= 2.3a

At least 2.3 (released 2006) which is the version shipped with macos
doesn't work. Reading the changelog I think 2.3a *should* work, so
require that.

Signed-off-by: Ran Benita <ran@unusedvar.com>

build: bump required meson to 0.52.0

Support for version checks in `find_program()`.

Signed-off-by: Ran Benita <ran@unusedvar.com>

scanner: allow for a zero terminated string as keymap

As the documentation for xkb_keymap_new_from_buffer() states, the "input string
does not have to be zero-terminated". The actual implementation however failed
with "unrecognized token/syntax error" when it encountered a null byte.

Fix this by allowing a null byte at the last position of the buffer. Anything
else is likely a client error anyway.

Fixes #307

README: use meson compile/test over ninja

This is backend-agnostic and the recommended way to invoke compilation.

This requires meson 0.55 (July 2020) and we only require 0.51 but at this point
I'm expecting most users who require the README instructions will have a
recent-enough meson anyway.

.editorconfig: add .md config

Signed-off-by: Ran Benita <ran@unusedvar.com>

Use consistent indentation for map and CSS files

Signed-off-by: Ran Benita <ran@unusedvar.com>

registry: remove a few asprintf/free() calls with snprintf

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>

registry: simplify strdup() error handling

strdup() is the least likely call to fail here, let's move it to the bottom so
we don't need to worry about the allocated string.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>

meson.build: register libxkbcommon.dylib link

meson needs to know that the executable tools
link against libxkbcommon.dylib so that the
@rpath references used during the build/test phases
can be rewritten to full path names on install

Add support for modmap None (#291)

Unlike current xkbcommon, X11’s xkbcomp allows to remove entries in
the modifiers’ map using “modifier_map None { … }”.

“None” is translated to the special value “XkbNoModifier” defined in
“X11/extensions/XKB.h”. Then it relies on the fact that in "CopyModMapDef",
the following code:

    1U << entry->modifier

ends up being zero when “entry->modifier” is “XkbNoModifier” (i.e. 0xFF).
Indeed, it relies on the overflow behaviour of the left shift, which in
practice resolves to use only the 5 low bits of the shift amount, i.e.
0x1F here. Then the result of “1U << 0xFF” is cast to “char”, i.e. 0.

This is a good trick but too magical, so in libxkbcommon we will use
an explicit test against our new constant XKB_MOD_NONE.

Improve the doc of the XKB keymap text format, V1 (#321)

- Add table of contents
- Add terminology section
- (WIP) Add Introduction to the format
- Improve the keycode section
- Improve the interpret section
- Add guide to create and use modifiers
- (WIP) Add actions documentation
- Add cross-references
- Add keysyms header to documentation