platform/upstream/libxkbcommon.git
13 months agoKeysyms: Update using latest xorgproto
Pierre Le Marre [Thu, 28 Sep 2023 05:18:56 +0000 (07:18 +0200)]
Keysyms: Update using latest xorgproto

xorgproto commit: 1c8128d72df22843a2022576850bc5ab5e3a46ea.

13 months agoscripts/makeheader: Minor improvements
Pierre Le Marre [Thu, 28 Sep 2023 05:18:51 +0000 (07:18 +0200)]
scripts/makeheader: Minor improvements

Use `pathlib` for proper path handling.

13 months agoShow invalid escape sequences
Pierre Le Marre [Tue, 26 Sep 2023 15:05:14 +0000 (17:05 +0200)]
Show invalid escape sequences

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

13 months agoPrevent overflow of octal escape sequences
Pierre Le Marre [Tue, 26 Sep 2023 15:05:14 +0000 (17:05 +0200)]
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.

13 months agoDisallow producing NULL character with escape sequences
Pierre Le Marre [Tue, 26 Sep 2023 15:05:05 +0000 (17:05 +0200)]
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.

13 months agoCompose: add iterator API
Ran Benita [Mon, 25 Sep 2023 09:41:48 +0000 (11:41 +0200)]
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>
13 months agoMessages: merge macros with and without message code
Pierre Le Marre [Thu, 21 Sep 2023 18:06:27 +0000 (20:06 +0200)]
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`.

13 months agoMessages: add new messages to registry
Pierre Le Marre [Thu, 21 Sep 2023 18:06:27 +0000 (20:06 +0200)]
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

13 months agoKeysyms: improve generator (#364)
Wismill [Wed, 20 Sep 2023 05:45:15 +0000 (07:45 +0200)]
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`.

13 months agoAdd a new warning for numeric keysyms
Pierre Le Marre [Mon, 18 Sep 2023 16:17:39 +0000 (18:17 +0200)]
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.

13 months agoAdd xkb-check-messages tool
Pierre Le Marre [Mon, 18 Sep 2023 16:17:39 +0000 (18:17 +0200)]
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.

13 months agoUse warning code in xkeyboard-config test
Pierre Le Marre [Mon, 18 Sep 2023 16:17:39 +0000 (18:17 +0200)]
Use warning code in xkeyboard-config test

13 months agoStructured log messages with a message registry
Pierre Le Marre [Mon, 18 Sep 2023 16:17:34 +0000 (18:17 +0200)]
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.

13 months agointeractive-evdev: add option to print modmaps
Pierre Le Marre [Mon, 18 Sep 2023 10:17:11 +0000 (12:17 +0200)]
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`.

13 months agoInteractive tools: add options to hide some fields
Pierre Le Marre [Mon, 18 Sep 2023 10:15:06 +0000 (12:15 +0200)]
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

13 months agoInteractive tools: always print keycode
Pierre Le Marre [Mon, 18 Sep 2023 10:06:45 +0000 (12:06 +0200)]
Interactive tools: always print keycode

13 months agoInteractive tools: Escape control character for Unicode output
Pierre Le Marre [Mon, 18 Sep 2023 09:59:30 +0000 (11:59 +0200)]
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.

13 months agoCI: Use git master for xkeyboard-config on Linux
Pierre Le Marre [Mon, 18 Sep 2023 11:17:30 +0000 (13:17 +0200)]
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.

13 months agoTest: Enable x11comp and use the xvfb wrapper
Pierre Le Marre [Mon, 18 Sep 2023 11:17:30 +0000 (13:17 +0200)]
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.

13 months agoTest: Catch SIGUSR1 from Xvfb for X11 tests
Pierre Le Marre [Mon, 18 Sep 2023 11:17:31 +0000 (13:17 +0200)]
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.

13 months agoTest: Use a xvfb wrapper for x11 test
Pierre Le Marre [Mon, 18 Sep 2023 11:17:17 +0000 (13:17 +0200)]
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.

14 months agodoc: fix some Doxygen warnings
Ran Benita [Mon, 31 Jul 2023 19:35:16 +0000 (22:35 +0300)]
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>
14 months agoparser: change deprecated `%pure-parser` to `%define api.pure` (#370)
M Kelly [Sat, 5 Aug 2023 19:29:36 +0000 (15:29 -0400)]
parser: change deprecated `%pure-parser` to `%define api.pure` (#370)

This is now supported by byacc since version 2.0 20230516

15 months agoImproved tests related to keysyms
Pierre Le Marre [Tue, 4 Jul 2023 07:23:24 +0000 (09:23 +0200)]
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.

15 months agoFix parsing of numeric keysyms in ExprResolveKeySym
Pierre Le Marre [Tue, 4 Jul 2023 07:23:24 +0000 (09:23 +0200)]
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.

15 months agoSimplify parsing of numeric keysyms in parser.y
Pierre Le Marre [Tue, 4 Jul 2023 07:23:24 +0000 (09:23 +0200)]
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.

15 months agoFix xkb_keysym_from_name for numeric keysyms
Pierre Le Marre [Tue, 4 Jul 2023 07:23:24 +0000 (09:23 +0200)]
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.

15 months agoMove STRINGIFY to utils.h and add STRINGIFY2
Pierre Le Marre [Tue, 4 Jul 2023 07:23:23 +0000 (09:23 +0200)]
Move STRINGIFY to utils.h and add STRINGIFY2

15 months agoImprove the documentation of keysyms in xkbcommon.h
Pierre Le Marre [Tue, 4 Jul 2023 07:23:23 +0000 (09:23 +0200)]
Improve the documentation of keysyms in xkbcommon.h

15 months agoAdd XKB_KEYSYM_MIN and XKB_KEYSYM_MAX
Pierre Le Marre [Tue, 4 Jul 2023 07:23:23 +0000 (09:23 +0200)]
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.

16 months agoReplace keycode numeric offset with EVDEV_OFFSET
Pierre Le Marre [Tue, 4 Jul 2023 07:34:08 +0000 (09:34 +0200)]
Replace keycode numeric offset with EVDEV_OFFSET

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

16 months agoCheck the doxygen version
Peter Hutterer [Mon, 3 Jul 2023 05:57:51 +0000 (15:57 +1000)]
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>
16 months agoConfigure github pages
Peter Hutterer [Mon, 8 May 2023 00:35:16 +0000 (10:35 +1000)]
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>
16 months agoxkbcli: allow compile-keymap without args
Ran Benita [Sat, 1 Jul 2023 16:39:31 +0000 (19:39 +0300)]
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>
16 months agoAdd a meson flag to make cool URIs optional
Pierre Le Marre [Tue, 27 Jun 2023 18:31:01 +0000 (20:31 +0200)]
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.

16 months agoTest(compose): fix assumption on environment variables
Pierre Le Marre [Mon, 26 Jun 2023 10:19:49 +0000 (12:19 +0200)]
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.

16 months agointeractive-evdev: includes options
Pierre Le Marre [Fri, 16 Jun 2023 07:54:09 +0000 (09:54 +0200)]
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".

16 months agoCI: Fix documentation generation for macOS
Pierre Le Marre [Fri, 23 Jun 2023 09:12:10 +0000 (11:12 +0200)]
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.

16 months agoFix typo in ensure-stable-doc-urls.py
Pierre Le Marre [Fri, 23 Jun 2023 09:23:18 +0000 (11:23 +0200)]
Fix typo in ensure-stable-doc-urls.py

17 months agocompose: drop the 65535 node limit (#343)
alois31 [Mon, 15 May 2023 12:23:16 +0000 (14:23 +0200)]
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.

17 months agoAdd support for stable doc URLs (#342)
Wismill [Sun, 14 May 2023 13:11:15 +0000 (15:11 +0200)]
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.

17 months agoImprove documentation
Pierre Le Marre [Sat, 13 May 2023 03:30:11 +0000 (05:30 +0200)]
Improve documentation

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

17 months agoDo not interpret nor emit invalid Unicode encoding forms
Pierre Le Marre [Sat, 13 May 2023 15:26:24 +0000 (17:26 +0200)]
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

17 months agoAdd warning when RMLVO with no layout but variant set
Pierre Le Marre [Sat, 13 May 2023 05:17:58 +0000 (07:17 +0200)]
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.

17 months agoci: bump runs-on versions
Ran Benita [Fri, 12 May 2023 19:00:32 +0000 (22:00 +0300)]
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>
17 months agoutils: fix printf format warnings on mingw
Ran Benita [Sat, 6 May 2023 14:14:04 +0000 (17:14 +0300)]
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>
18 months agoci/windows: use the vs backend instead of ninja backend
Ran Benita [Fri, 5 May 2023 07:57:32 +0000 (10:57 +0300)]
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>
18 months agobuild: show a summary
Ran Benita [Fri, 5 May 2023 07:52:07 +0000 (10:52 +0300)]
build: show a summary

Signed-off-by: Ran Benita <ran@unusedvar.com>
18 months agobuild: require bison >= 2.3a
Ran Benita [Fri, 5 May 2023 07:16:30 +0000 (10:16 +0300)]
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>
18 months agobuild: bump required meson to 0.52.0
Ran Benita [Fri, 5 May 2023 07:11:00 +0000 (10:11 +0300)]
build: bump required meson to 0.52.0

Support for version checks in `find_program()`.

Signed-off-by: Ran Benita <ran@unusedvar.com>
18 months agoscanner: allow for a zero terminated string as keymap
Peter Hutterer [Tue, 2 May 2023 04:15:55 +0000 (14:15 +1000)]
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

18 months agoREADME: use meson compile/test over ninja
Peter Hutterer [Thu, 4 May 2023 10:35:39 +0000 (20:35 +1000)]
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.

18 months ago.editorconfig: add .md config
Pierre Le Marre [Thu, 4 May 2023 05:14:54 +0000 (07:14 +0200)]
.editorconfig: add .md config

Signed-off-by: Ran Benita <ran@unusedvar.com>
18 months agoUse consistent indentation for map and CSS files
Ran Benita [Thu, 4 May 2023 08:55:51 +0000 (11:55 +0300)]
Use consistent indentation for map and CSS files

Signed-off-by: Ran Benita <ran@unusedvar.com>
18 months agoregistry: remove a few asprintf/free() calls with snprintf
Peter Hutterer [Thu, 18 Mar 2021 23:49:24 +0000 (09:49 +1000)]
registry: remove a few asprintf/free() calls with snprintf

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
18 months agoregistry: simplify strdup() error handling
Peter Hutterer [Thu, 18 Mar 2021 23:46:15 +0000 (09:46 +1000)]
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>
18 months agomeson.build: register libxkbcommon.dylib link
Ken Cunningham [Wed, 3 May 2023 06:47:56 +0000 (23:47 -0700)]
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

18 months agoAdd support for modmap None (#291)
Wismill [Mon, 1 May 2023 20:30:41 +0000 (22:30 +0200)]
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.

18 months agoImprove the doc of the XKB keymap text format, V1 (#321)
Wismill [Sun, 30 Apr 2023 19:30:36 +0000 (21:30 +0200)]
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

18 months agokeysyms: add new keysyms XF86EmojiPicker, XF86Dictate
Ran Benita [Tue, 11 Apr 2023 19:49:58 +0000 (22:49 +0300)]
keysyms: add new keysyms XF86EmojiPicker, XF86Dictate

Ref: https://gitlab.freedesktop.org/xorg/proto/xorgproto/-/commit/914d8f5e0f469cd0416364dd008e9eea752bf703
Ref: https://gitlab.freedesktop.org/xorg/proto/xorgproto/-/commit/a839f0c7fc5596d10e786394d3b0953eb8a1731b
Signed-off-by: Ran Benita <ran@unusedvar.com>
18 months agoPossible fix for non-MSVC windows compilers
Ran Benita [Tue, 11 Apr 2023 20:24:47 +0000 (23:24 +0300)]
Possible fix for non-MSVC windows compilers

`_MSC_VER` is specific to MSVC, but there can be other compilers targeting
windows. Hopefully they do define `_WIN32`, so let's use that.

Refs: https://github.com/xkbcommon/libxkbcommon/issues/305
Signed-off-by: Ran Benita <ran@unusedvar.com>
19 months agokeysym: replace deprecated Serbian_DZE with Cyrillic_DZHE
Peter Hutterer [Tue, 28 Mar 2023 22:29:15 +0000 (08:29 +1000)]
keysym: replace deprecated Serbian_DZE with Cyrillic_DZHE

Same numeric value for both and the Serbian one has been listed as deprecated
for decades.

See https://gitlab.freedesktop.org/xorg/proto/xorgproto/-/merge_requests/69#note_1843415

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
20 months agobuild: override dependency for use as subproject
Simon Ser [Sat, 18 Feb 2023 10:01:30 +0000 (11:01 +0100)]
build: override dependency for use as subproject

This allows xkbcommon to be used as a subproject.

Signed-off-by: Simon Ser <contact@emersion.fr>
22 months agoNEWS: add "New API" section for last release
Ran Benita [Mon, 2 Jan 2023 19:36:03 +0000 (21:36 +0200)]
NEWS: add "New API" section for last release

Signed-off-by: Ran Benita <ran@unusedvar.com>
22 months agoBump version to 1.5.0 upstream upstream_bkup_20231222 upstream_work_230220 upstream/1.5.0 xkbcommon-1.5.0
Ran Benita [Mon, 2 Jan 2023 19:23:05 +0000 (21:23 +0200)]
Bump version to 1.5.0

Signed-off-by: Ran Benita <ran@unusedvar.com>
22 months agobuild: fix wayland-scanner deprecation code -> private-code
Ran Benita [Mon, 2 Jan 2023 19:10:45 +0000 (21:10 +0200)]
build: fix wayland-scanner deprecation code -> private-code

Signed-off-by: Ran Benita <ran@unusedvar.com>
22 months agodoc: clarify "server state" and "client state" distinction
Ran Benita [Sat, 17 Dec 2022 11:51:10 +0000 (13:51 +0200)]
doc: clarify "server state" and "client state" distinction

Add a common page for the concept and link to there from the relevant
functions.

Signed-off-by: Ran Benita <ran@unusedvar.com>
22 months agobuild: require meson >= 0.51, fix meson deprecations
Ran Benita [Fri, 16 Dec 2022 19:24:57 +0000 (21:24 +0200)]
build: require meson >= 0.51, fix meson deprecations

Signed-off-by: Ran Benita <ran@unusedvar.com>
22 months agoci: don't run linux on push to non-master branches
Ran Benita [Fri, 16 Dec 2022 19:36:13 +0000 (21:36 +0200)]
ci: don't run linux on push to non-master branches

It's redundant with the pull request run.

Signed-off-by: Ran Benita <ran@unusedvar.com>
22 months agocontext: add XKB_CONTEXT_NO_SECURE_GETENV flag (#312)
Ronan Pigott [Fri, 16 Dec 2022 08:26:25 +0000 (01:26 -0700)]
context: add XKB_CONTEXT_NO_SECURE_GETENV flag (#312)

This flag is useful for clients that may have relatively benign capabilities
set, like CAP_SYS_NICE, that also want to use the xkb configuration from the
environment and user configs in XDG_CONFIG_HOME.

Fixes: https://github.com/xkbcommon/libxkbcommon/issues/308
Fixes: https://github.com/xkbcommon/libxkbcommon/issues/129
Signed-off-by: Ran Benita <ran@unusedvar.com>
22 months agobuild: remove -fsanitize-undefined-trap-on-error
Ran Benita [Wed, 14 Dec 2022 16:21:13 +0000 (18:21 +0200)]
build: remove -fsanitize-undefined-trap-on-error

Meson complains; it's probably not that important anymore when using the
`-Db_sanitize` options.

meson.build:36: WARNING: Consider using the built-in option for sanitizers instead of using "-fsanitize-undefined-trap-on-error".

Signed-off-by: Ran Benita <ran@unusedvar.com>
22 months agoCI: bump a few actions to newer versions
Peter Hutterer [Tue, 6 Dec 2022 23:41:11 +0000 (09:41 +1000)]
CI: bump a few actions to newer versions

Node 12 is deprecated so let's bump the actions to newer versions that
use Node 16. See
https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/

2 years agobuild: reenable test-context in MSVC
Ran Benita [Sat, 24 Sep 2022 07:30:00 +0000 (10:30 +0300)]
build: reenable test-context in MSVC

Signed-off-by: Ran Benita <ran@unusedvar.com>
2 years agotest: move mkdir & mkdtemp calls to common place and fix them on MSVC
Ran Benita [Sat, 24 Sep 2022 07:27:51 +0000 (10:27 +0300)]
test: move mkdir & mkdtemp calls to common place and fix them on MSVC

Signed-off-by: Ran Benita <ran@unusedvar.com>
2 years agoutils: move some MSVC compat stuff to common place
Ran Benita [Sat, 24 Sep 2022 07:37:06 +0000 (10:37 +0300)]
utils: move some MSVC compat stuff to common place

Signed-off-by: Ran Benita <ran@unusedvar.com>
2 years agoci/linux: store the test logs as artifacts on failure
Peter Hutterer [Fri, 15 Jul 2022 03:01:52 +0000 (13:01 +1000)]
ci/linux: store the test logs as artifacts on failure

This makes debugging a lot easier than having to reproduce locally.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2 years agoci/linux: split normal testing from valgrind testing
Peter Hutterer [Fri, 15 Jul 2022 03:07:26 +0000 (13:07 +1000)]
ci/linux: split normal testing from valgrind testing

A test case failure usually also triggers valgrind leaks, sifting through those
to find the actual test failure is painful. So let's separate the tests and run
them separately.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2 years agointeractive-wayland: Fix interface versioning
Jan Alexander Steffens (heftig) [Sat, 3 Sep 2022 22:51:07 +0000 (00:51 +0200)]
interactive-wayland: Fix interface versioning

We need to request the lower version of the interface versions we
support and the server supports, not the higher version.

Using the higher version caused crashes due to unbound callbacks on
GNOME, which supports a higher version of `xdg_wm_base`.

2 years agoBump version to 1.4.1 xkbcommon-1.4.1
Ran Benita [Sat, 21 May 2022 19:55:10 +0000 (22:55 +0300)]
Bump version to 1.4.1

Signed-off-by: Ran Benita <ran@unusedvar.com>
2 years agokeysym-utf: remove bogus currency sign entries
Ran Benita [Sun, 15 May 2022 07:41:53 +0000 (10:41 +0300)]
keysym-utf: remove bogus currency sign entries

These ended up being mapping in the 0x100xxxx Unicode range, which are
handled automatically ; these special keysyms don't exist (except for
EuroSign).

    #define XKB_KEY_EcuSign                    0x10020a0  /* U+20A0 EURO-CURRENCY SIGN */
    #define XKB_KEY_ColonSign                  0x10020a1  /* U+20A1 COLON SIGN */
    #define XKB_KEY_CruzeiroSign               0x10020a2  /* U+20A2 CRUZEIRO SIGN */
    #define XKB_KEY_FFrancSign                 0x10020a3  /* U+20A3 FRENCH FRANC SIGN */
    #define XKB_KEY_LiraSign                   0x10020a4  /* U+20A4 LIRA SIGN */
    #define XKB_KEY_MillSign                   0x10020a5  /* U+20A5 MILL SIGN */
    #define XKB_KEY_NairaSign                  0x10020a6  /* U+20A6 NAIRA SIGN */
    #define XKB_KEY_PesetaSign                 0x10020a7  /* U+20A7 PESETA SIGN */
    #define XKB_KEY_RupeeSign                  0x10020a8  /* U+20A8 RUPEE SIGN */
    #define XKB_KEY_WonSign                    0x10020a9  /* U+20A9 WON SIGN */
    #define XKB_KEY_NewSheqelSign              0x10020aa  /* U+20AA NEW SHEQEL SIGN */
    #define XKB_KEY_DongSign                   0x10020ab  /* U+20AB DONG SIGN */
    #define XKB_KEY_EuroSign                      0x20ac  /* U+20AC EURO SIGN */

Signed-off-by: Ran Benita <ran@unusedvar.com>
2 years agokeysym-utf: remove bogus Korean Won sign entry
Ran Benita [Sun, 15 May 2022 07:32:58 +0000 (10:32 +0300)]
keysym-utf: remove bogus Korean Won sign entry

This entry maps a non existing special keysym 0x20a9.
The correct mapping for XKB_KEY_Korean_Won (0x0eff) already exists.

Signed-off-by: Ran Benita <ran@unusedvar.com>
2 years agoRemove bogus euro sign entry from keysymtab
Sam Lantinga [Wed, 27 Apr 2022 16:45:54 +0000 (18:45 +0200)]
Remove bogus euro sign entry from keysymtab

Not sure what it's doing here, but converting "€" to a keysym
doesn't work with this entry. 0x13a4 doesn't appear in
xkbcommon-keysyms.h. 0x20ac is the keysym documented in the
header (and it's the last entry in the table).

It's been in the table since it was introduced in e0524296d2e0
("Add API for getting unicode representation of a keysym").

Co-authored-by: Simon Ser <contact@emersion.fr>
2 years agoDo not clear sibling entries when override.
Weng Xuetian [Sat, 14 May 2022 08:11:32 +0000 (01:11 -0700)]
Do not clear sibling entries when override.

lokid and hikid actually stores the sibling to current node, which
should not be cleared when override. This would break the sequence with
a common prefix when override another.

Fix #286

Signed-off-by: Weng Xuetian <wengxt@gmail.com>
2 years agoci/linux: bring back `apt update` to fix `apt install` 404s
Ran Benita [Sun, 20 Mar 2022 11:50:12 +0000 (13:50 +0200)]
ci/linux: bring back `apt update` to fix `apt install` 404s

Signed-off-by: Ran Benita <ran@unusedvar.com>
2 years agoscanner: prefix functions with `scanner_` to avoid symbol conflicts
Ran Benita [Mon, 14 Mar 2022 14:44:13 +0000 (16:44 +0200)]
scanner: prefix functions with `scanner_` to avoid symbol conflicts

Particularly `eof()` in mingw-w64.

Fixes: https://github.com/xkbcommon/libxkbcommon/pull/285
Reported-by: Marko Lindqvist
Signed-off-by: Ran Benita <ran@unusedvar.com>
2 years agoImprove misleading comments #270
Mladen Milinkovic [Thu, 24 Feb 2022 09:48:50 +0000 (10:48 +0100)]
Improve misleading comments #270

2 years agoci: another possible fix for release workflow
Ran Benita [Fri, 4 Feb 2022 10:59:18 +0000 (12:59 +0200)]
ci: another possible fix for release workflow

Signed-off-by: Ran Benita <ran@unusedvar.com>
2 years agoBump version to 1.4.0 xkbcommon-1.4.0
Ran Benita [Fri, 4 Feb 2022 10:41:50 +0000 (12:41 +0200)]
Bump version to 1.4.0

Signed-off-by: Ran Benita <ran@unusedvar.com>
2 years agotest: add test for variant inheritance of ISO 639/3166 codes
Peter Hutterer [Mon, 24 Jan 2022 01:13:06 +0000 (11:13 +1000)]
test: add test for variant inheritance of ISO 639/3166 codes

See efa99624320f54e6e1ff24e4c4b1fcecdfba43d5

2 years agoVariants should inherit iso639, iso3166 and brief from parent layout if omitted ...
M Hickford [Mon, 24 Jan 2022 01:16:08 +0000 (02:16 +0100)]
Variants should inherit iso639, iso3166 and brief from parent layout if omitted (#266)

2 years agoregistry: skip over invalid ISO639 or ISO3166 entries
Peter Hutterer [Thu, 20 Jan 2022 03:08:36 +0000 (13:08 +1000)]
registry: skip over invalid ISO639 or ISO3166 entries

If the XML file is somehow off, don't load entries that are against the spec.

2 years agotest: show the tool exit status on failure
Peter Hutterer [Thu, 20 Jan 2022 04:17:50 +0000 (14:17 +1000)]
test: show the tool exit status on failure

We already do so for the non-successful cases, let's do this here too so we know
whether it was a signal or a normal exit.

2 years agoregistry: don't call xmlCleanupParser()
Peter Hutterer [Mon, 17 Jan 2022 03:51:48 +0000 (13:51 +1000)]
registry: don't call xmlCleanupParser()

From the documentation:
> It does not clean up parser state, it cleans up memory allocated by the library
> itself. It is a cleanup function for the XML library. It tries to reclaim all
> related global memory allocated for the library processing. [...]
> One should call xmlCleanupParser() only when the process has finished using the library.

http://xmlsoft.org/html/libxml-parser.html#xmlCleanupParser

Since we're a library ourselves we cannot know if something else in the same
proces uses the parser, so we must not call this.

Reported-by: M Hickford
2 years agoCI: always run the linux workflow
Peter Hutterer [Mon, 17 Jan 2022 04:08:59 +0000 (14:08 +1000)]
CI: always run the linux workflow

This makes it easier for contributors to check if their code runs correctly
without having to file a PR.

The Mac and Windows workflows are a bit more involved, so let's keep those on
pull requests only.

2 years agoCI: split and rename the workflows to windows/macos/linux
Peter Hutterer [Mon, 17 Jan 2022 04:05:41 +0000 (14:05 +1000)]
CI: split and rename the workflows to windows/macos/linux

"main" is a bit non-descriptive, let's name them after the platforms we run them
on. Splitting them up allows us to be less selective on how we run the various
workflows, e.g. always running the linux one.

2 years agoUpdate README.md
M Hickford [Thu, 23 Dec 2021 12:58:06 +0000 (12:58 +0000)]
Update README.md

Co-authored-by: Ran Benita <ran@unusedvar.com>
2 years agoAdd instructions to run tests. Add build/ to .gitignore.
matthickford [Mon, 11 Oct 2021 16:30:31 +0000 (18:30 +0200)]
Add instructions to run tests. Add build/ to .gitignore.

2 years agobuild: add enable-tools option
Alex Xu (Hello71) [Fri, 8 Oct 2021 13:51:10 +0000 (09:51 -0400)]
build: add enable-tools option

this is mainly useful for multilib, but may be useful for other users as well

Signed-off-by: Alex Xu (Hello71) <alex_y_xu@yahoo.ca>
2 years agotools/list: print an empty string for null vendor strings
Peter Hutterer [Wed, 10 Nov 2021 04:45:53 +0000 (14:45 +1000)]
tools/list: print an empty string for null vendor strings

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2 years agotools/list: enclose the the various field names in quotes
Peter Hutterer [Mon, 8 Nov 2021 04:33:29 +0000 (14:33 +1000)]
tools/list: enclose the the various field names in quotes

Because otherwise the 'no' layout is treated as disagreement with whatever is to
be disagreed with. Fixed in YAML 1.2 but that's not universally supported.

Fixes #268