Commit Graph

2223 Commits (f77c97bd4567ae254421699351cc6b3445c9cb45)

Author SHA1 Message Date
Pierre Le Marre f77c97bd45 keysyms: Test xkb_keysym_to_utf8 length 2024-01-10 14:18:43 +01:00
Pierre Le Marre 817179d866 keysyms: Add xkb_keysym_iterator
Add an efficient way to iterate over the assigned keysyms.

Currently only provided for testing, so we guard it by
`ENABLE_PRIVATE_APIS` in order to reduce the installed library.
2024-01-10 14:18:43 +01:00
Pierre Le Marre 4f52d6068e keysyms: Add xkb_keysym_is_assigned
Add internal API `xkb_keysym_is_assigned` for tests, guarded by
`ENABLE_PRIVATE_APIS` in order to avoid increasing the size of the installed library.
2024-01-10 14:18:43 +01:00
Pierre Le Marre 82f138c633 keysyms: Add min and max assigned keysyms internal API
Currently there is no direct way to know the minimum and maximum keysym
values that are assigned, i.e. that have an explicit name or are
Unicode keysyms.

Introduce the new following internal API:
- XKB_KEYSYM_MIN_ASSIGNED
- XKB_KEYSYM_MAX_ASSIGNED
- XKB_KEYSYM_MIN_EXPLICIT
- XKB_KEYSYM_MAX_EXPLICIT
- XKB_KEYSYM_COUNT_EXPLICIT

Also add a bunch of tests to ensure consistant keysyms bounds.
2024-01-10 14:18:43 +01:00
Pierre Le Marre 4a92f61b5c keysyms: Add Unicode constants
Add the following constants in order to improve the code readability:
- XKB_KEYSYM_UNICODE_OFFSET
- XKB_KEYSYM_UNICODE_MIN
- XKB_KEYSYM_UNICODE_MAX
2024-01-10 14:18:43 +01:00
Peter Hutterer 31ebe0037b test: add a test for multiple keysyms (and some minimal docs)
I couldn't find any reference to *how* the keymap format actually needs to look
like if you want multiple keysyms per level. So let's add a test for it and a
minimal documentation entry.
2023-12-27 12:23:46 +01:00
Pierre Le Marre dd65950f44 Provide ssize_t for Windows
`ssize_t` is not part of standard C but is specific to POSIX.
2023-12-19 07:45:26 +01:00
Pierre Le Marre 7185b023c5 Add documentation to XkbToControl
While some transformations are defined in the section “Interpreting the
Control Modifier” of the XKB protocol, a lot are not. Documentation is
scarce about the topic, so write down some context using the following
sources:

- https://en.wikipedia.org/wiki/Caret_notation#Use_in_software
- https://www.vt100.net/shuford/terminal/dec_keyboards_news.txt
- https://misc.openbsd.narkive.com/NvSWf6ax/which-key-shortcuts-are-safe-to-bind-and-some-q-s-about-history-and-os-diffs-re-ctrl-4-means
- https://vt100.net/docs/vt220-rm/chapter3.html#T3-5
2023-12-19 07:01:04 +01:00
Brendan Le Foll 244128aa79
Update meson.build error message when enable-wayland enabled (#419)
Let's drop the explicit versions, meson prints a message anyway that 
specifies the version we have vs the one we need.
2023-12-14 10:44:00 +10:00
Pierre Le Marre 20329baf4d xkbcomp: Use `steal` for better memory handling 2023-12-04 10:44:52 +10:00
Pierre Le Marre 20c6fa62a7 registry: Use `steal` for better memory handling 2023-12-04 10:44:52 +10:00
Pierre Le Marre dbc187cfa1 utils: Steal `steal` from libei
Add excerpt of `util-mem.h` from libei defining the macro `steal`, in
order to improve memory management and the code semantics.

See: 38132d6fc5/src/util-mem.h (L92)
2023-12-04 10:44:52 +10:00
ppw0 0db1dc1c4a fix error with "-Wl,--gc-sections" 2023-12-02 19:13:39 +02:00
Pierre Le Marre 7caf57f013 registry: Parse “popularity” attribute
Previously the attribute “popularity” was completely ignored. It also
did not respect the modified DTD, because its default value depends if
we are currently parsing an “extras” rules file.

Fixed:
- Always parse the popularity attribute.
- Change the DTD to reflect that the default value is implied.
2023-11-21 08:10:22 +01:00
Pierre Le Marre cfcc7922c2 xkbcli-compose: Simplify locale options
Current options to set the locale are convoluted:
- An explicit locale *must* be given, while a sane default would be
  to use the user environment.
- Then there are two options that were useful while testing locale
  handling: read environment variables or use `setlocale`. But the
  program has already called:
  ```
  setlocale(LC_ALL, "");
  ```
  so it turns out the two options lead to the same results.

Remove options `--locale-from-env` and `--locale-from-setlocale`
and make the locale default to the user environment.
2023-11-19 09:57:24 +01:00
Pierre Le Marre 0a577a0998 xkbcli-compile-compose: Fix string result escaping
Currently the result string is not escaped and may produce invalid
results.

Fixed by introducing an ad-hoc escape function and relative tests.
2023-11-19 09:57:24 +01:00
Pierre Le Marre d826d70b9b xkbcli: Fix bash completion
`compgen` expect command options list formatted as a newline-separated
list. Add a missing newline when concatenating two lists.
2023-11-19 09:57:24 +01:00
Pierre Le Marre bc330c00e6 xkbcli: Promote compose to xkbcli-compile-compose
Previously this tool was only used for internal testing and thus
not installed. But it is useful for debugging, much like
xkbcli-compile-keymap.
2023-11-19 09:57:24 +01:00
Pierre Le Marre 79502700a6 Doc: fix malformed links and some typos 2023-11-14 10:33:31 +01:00
Pierre Le Marre 00e3058e7b Prevent recursive includes of keymap components
- Add check for recursive includes of keymap components. It relies on
  limiting the include depth. The threshold is currently to 15, which
  seems reasonable with plenty of margin for keymaps in the wild.
- Add corresponding new log message `recursive-include`.
- Add tests for recursive includes.
2023-11-06 22:06:25 +01:00
Pierre Le Marre 4b58ff7859 Fix memory leak in print_keymap
The string buffer was not freed.
2023-11-06 21:44:41 +01:00
Pierre Le Marre 171e0170c2 Fix memory leak in FindFileInXkbPath
The string `buf` was not freed after each call to `asprintf_safe`.

Avoid allocating and introduce the new message: `XKB_ERROR_INSUFFICIENT_BUFFER_SIZE`.
2023-11-06 21:44:41 +01:00
Pierre Le Marre 2b71431007 Fix memory leaks in key types compilation
When there is no error the types are “stolen” and copied to the keymap.
But when there is an error, `MergeIncludedKeyTypes` just return without
“stealing” nor freeing the types.

Fixed by explicitly freeing the key types.

Fixed another leak in `HandleKeyTypeDef` that may occur if there is an
error in parsing a type definition.
2023-11-06 21:44:41 +01:00
Pierre Le Marre 0f9c95df06 interactive-x11: Add support for Compose 2023-11-06 20:57:13 +01:00
Pierre Le Marre c7f4e308f2 interactive-wayland: Add support for Compose 2023-11-06 20:57:13 +01:00
Sam James fed96378a1 state: fix -Walloc-size
GCC 14 introduces a new -Walloc-size included in -Wextra which gives:
```
src/state.c:589:9: warning: allocation of insufficient size ‘1’ for type ‘struct xkb_state’ with size ‘128’ [-Walloc-size]
```

The calloc prototype is:
```
void *calloc(size_t nmemb, size_t size);
```

So, just swap the number of members and size arguments to match the prototype, as
we're initialising 1 struct of size `sizeof(struct xkb_state)`. GCC then sees we're not
doing anything wrong.

Signed-off-by: Sam James <sam@gentoo.org>
2023-11-06 12:32:46 +10:00
Pierre Le Marre 3aaa4e2a53 rules: early detection of invalid encoding 2023-11-03 04:16:50 +01:00
Pierre Le Marre 82e9293e12 xkbcomp: early detection of invalid encoding 2023-11-03 04:16:50 +01:00
Pierre Le Marre a2da57aba1 Compose: early detection of invalid encoding
Also move “unrecognized token” error message before skiping the
line, in order to fix token position.
2023-11-03 04:16:50 +01:00
Pierre Le Marre 6c54681fe7 Compose: Fix UTF-8 BOM detection
The leading UTF-8 BOM detection code is misplaced as it is executed
after each EOL.

Fixed by moving the code before the goto labels.
2023-10-30 12:44:55 +01:00
Pierre Le Marre 9e88718080 rules: skip heading UTF-8 encoded BOM (U+FEFF)
Leading BOM is legal and is used as a signature — an indication that
an otherwise unmarked text file is in UTF-8.
See: https://www.unicode.org/faq/utf_bom.html#bom5 for further details.
2023-10-30 07:15:13 +01:00
Pierre Le Marre f937c30820 xkbcomp: skip heading UTF-8 encoded BOM (U+FEFF)
Leading BOM is legal and is used as a signature — an indication that
an otherwise unmarked text file is in UTF-8.
See: https://www.unicode.org/faq/utf_bom.html#bom5 for further
details.
2023-10-30 07:15:13 +01:00
Pierre Le Marre 59886e4183 Compose: skip heading UTF-8 encoded BOM (U+FEFF)
Leading BOM is legal and is used as a signature — an indication that
an otherwise unmarked text file is in UTF-8.
See: https://www.unicode.org/faq/utf_bom.html#bom5 for further details.
2023-10-30 07:15:13 +01:00
Ran Benita 6073565903 ci: fix url in github release text
Signed-off-by: Ran Benita <ran@unusedvar.com>
2023-10-08 23:55:38 +03:00
Ran Benita d2a08f761c Bump version to 1.6.0
Signed-off-by: Ran Benita <ran@unusedvar.com>
2023-10-08 23:46:48 +03:00
Wismill 05fd5100af
Update NEWS for 1.6.0 (#385) 2023-10-08 23:45:05 +03:00
Pierre Le Marre 238d132406 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.
2023-10-06 09:37:40 +02:00
Pierre Le Marre 1c1542d64f 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?
2023-10-05 06:24:02 +02:00
Pierre Le Marre 357c00b3a1 Tools: Improve xkbcli help messages and manual pages
Add missing `--help` and `--short` entries.
2023-10-05 06:24:02 +02:00
Pierre Le Marre 87dcf30126 Fix trailing whitespaces in XKB files 2023-09-29 09:42:08 +02:00
Pierre Le Marre 1a4a89a749 Python: make ruff & black happy 2023-09-29 09:42:08 +02:00
Pierre Le Marre c6716461d1 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
2023-09-29 09:42:08 +02:00
Pierre Le Marre 0d4541151f 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.
2023-09-28 07:48:37 +02:00
Pierre Le Marre 49690d936b Keysyms: Update using latest xorgproto
xorgproto commit: 1c8128d72df22843a2022576850bc5ab5e3a46ea.
2023-09-28 07:48:37 +02:00
Pierre Le Marre 9c2f0fdbed scripts/makeheader: Minor improvements
Use `pathlib` for proper path handling.
2023-09-28 07:48:37 +02:00
Pierre Le Marre 9d15c6a7a1 Show invalid escape sequences
It is easier to debug when the message actually displays the offending
escape sequence.
2023-09-26 17:25:49 +02:00
Pierre Le Marre 0038c86607 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.
2023-09-26 17:25:49 +02:00
Pierre Le Marre ca7aa69cc0 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.
2023-09-26 17:25:49 +02:00
Ran Benita a17701327e 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>
2023-09-26 09:02:45 +02:00
Pierre Le Marre c0065c95a4 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`.
2023-09-24 09:09:24 +02:00