tools


Log

Author Commit Date CI Message
Pierre Le Marre 0f9c95df 2023-11-01T18:12:15 interactive-x11: Add support for Compose
Pierre Le Marre c7f4e308 2023-11-01T13:06:38 interactive-wayland: Add support for Compose
Pierre Le Marre 357c00b3 2023-10-03T10:28:47 Tools: Improve xkbcli help messages and manual pages Add missing `--help` and `--short` entries.
Pierre Le Marre 1c1542d6 2023-09-29T20:44:06 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?
Pierre Le Marre ca7aa69c 2023-09-26T17:05:05 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.
Ran Benita a1770132 2023-09-25T11:41:48 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>
Pierre Le Marre a83d745b 2023-09-21T20:06:27 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
Pierre Le Marre eafd3ace 2023-09-18T18:17:39 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.
Pierre Le Marre 417d0747 2023-09-18T18:17:39 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.
Pierre Le Marre 0e3e2d17 2023-09-18T12:17:11 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`.
Pierre Le Marre b5079dc9 2023-09-18T12:15:06 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
Pierre Le Marre c23c6bb9 2023-09-18T12:06:45 Interactive tools: always print keycode
Pierre Le Marre 44029221 2023-09-18T11:59:30 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.
Pierre Le Marre 0d01a933 2023-07-04T09:34:08 Replace keycode numeric offset with EVDEV_OFFSET Add a constant `EVDEV_OFFSET` to make the semantic of the offset clearer.
Ran Benita f75c0a2d 2023-07-01T19:39:31 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>
Pierre Le Marre de9d8207 2023-06-16T09:54:09 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".
Ran Benita bd79a960 2023-04-11T23:24:47 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>
Jan Alexander Steffens (heftig) 320f56d2 2022-09-04T00:51:07 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`.
Peter Hutterer 50a24569 2021-11-10T14:45:53 tools/list: print an empty string for null vendor strings Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Peter Hutterer abb115c7 2021-11-08T14:33:29 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
Ran Benita e8cb4311 2021-11-01T23:56:22 man: mention `xkbcli list` output is meant to be in YAML 1.2 format Signed-off-by: Ran Benita <ran@unusedvar.com>
Ran Benita f8c430cf 2021-07-31T22:03:33 tools/how-to-type: add --keysym for how to type a keysym Previously, could only check how to type a Unicode codepoint, but searching for a keysym directly is also occasionally useful. Signed-off-by: Ran Benita <ran@unusedvar.com>
Simon Ser 5419e577 2021-07-12T11:05:50 tools/interactive-x11: use keysym to look for Esc Don't assume that keycode 9 means Escape. Instead, use the keymap to check for Esc. Logic copied from the Wayland version. Signed-off-by: Simon Ser <contact@emersion.fr>
Ran Benita b6aadd57 2021-05-08T21:30:52 tools: add compose tool for Compose debugging Not very useful so not exposed in xkbcli. Signed-off-by: Ran Benita <ran@unusedvar.com>
Peter Hutterer f434c690 2021-04-22T12:52:55 tools: change xkbcli list to output YAML We have a lot of keyboard layouts and the current output format is virtually useless at searching for a specific one to debug any issues with either the layout list or the output from libxkbregistry. Let's use YAML instead because that can easily be post-processed to extract the specific layouts wanted, e.g. to get the list of all layouts: xkbcli-list | yq -r ".layouts[].layout" to get the list of all variants of the "us" layout: xkbcli-list | yq -r '.layouts[] | select(.layout == "us") | .variant and the number of option groups: xkbcli-list | yq -r '.option_groups[] | length' Note that the top-level nodes have been de-capitalized, so where it was "Models" before it is now "models" and the "Options" node is now "option_groups". Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Peter Hutterer 693ffb07 2021-04-22T12:42:00 tools: change the list separator handling Slightly easier to read than the "bool first" approach. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Evgeniy Khramtsov f04c7e93 2021-04-14T12:56:07 interactive-wayland: fallback to ftruncate() if needed Fallback to ftruncate() if the underlying filesystem does not support posix_fallocate(). Idea by: Jan Beich <jbeich@FreeBSD.org>, Niclas Zeising <zeising@FreeBSD.org> Inspired by: Wayland cursor/os-compatibility.c [ran: small adjustments] Signed-off-by: Ran Benita <ran@unusedvar.com>
Ran Benita cda2eaf1 2021-03-29T20:59:12 man: add missing pointer to xkbcli-compile-keymap(1) Signed-off-by: Ran Benita <ran@unusedvar.com>
Ran Benita c14910a0 2021-03-28T16:10:52 interactive-evdev: fix missing initialization Accidentally got lost in 6b65be4. Signed-off-by: Ran Benita <ran@unusedvar.com>
Ran Benita 6b65be4c 2021-03-28T12:55:08 interactive-evdev: switch from epoll(2) to poll(2) Turns out FreeBSD supports evdev, so this toll can work on it; however it does not support epoll, so switch to poll, which is portable. Reported-by: Evgeniy Khramtsov <evgeniy@khramtsov.org> Signed-off-by: Ran Benita <ran@unusedvar.com>
Ran Benita c5565bd0 2020-09-09T10:09:13 tools: align `xkbcli how-to-type` output ourselves Can possibly add a machine-parsable format if desired, but for now just have it work nicely. Signed-off-by: Ran Benita <ran@unusedvar.com>
Ran Benita 0f8ae6ec 2020-09-05T23:41:08 xkbcli: fix interactive-x11 not showing in help Signed-off-by: Ran Benita <ran@unusedvar.com>
Peter Hutterer 66e7f0da 2020-09-03T08:30:45 Revert: tools: add xkbcli-scaffold-new-layout as helper tool While this tool is useful for users starting with a new keyboard layout, it is a somewhat bad fit for libxkbcommon. It's the only python tool, we don't even install it yet (because we're not sure yet what it's supposed to do) and there's a potential for it to expand into more corner cases. The only tie it has to libxkbcommon is that it templates the data files that libxkbcommon reads, but those files are effectively public API. Let's remove this tool from there and instead move it to a separate git repository where it can go its own way. This reverts commit d00cf64dbc586a1052e1f0d0e7f1a48bbff293ec
Peter Hutterer 4d0d5091 2020-08-31T08:36:38 meson.build: define PATH_MAX where it's missing PATH_MAX is not POSIX and can be missing on some systems, notably Windows (which provides MAX_PATH instead tough) and Hurd. Let's define it to a sane value where missing, i.e. the one it's defined to in limits.h. Except on Windows where we're limited to 260. Fixes https://github.com/xkbcommon/libxkbcommon/issues/180 Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Ran Benita d5c6b581 2020-07-27T11:24:06 tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
Peter Hutterer d00cf64d 2020-07-10T11:32:48 tools: add xkbcli-scaffold-new-layout as helper tool This tool set ups the required directory structure and template files to add new keyboard layouts or options. For example, run like this: xkbcli-scaffold-new-layout --layout 'us(myvariant)' --option 'custom:foo' This will up the evdev rules file, the evdev.xml file, the symbols/us file and symbols/custom file in $XDG_CONFIG_HOME so that the user has everything in place and can start filling in the actual key mappings. This tool is currently uninstalled until we figure out whether it's useful. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Ran Benita fcc6b28f 2020-07-27T11:57:24 tools/interactive-evdev: fixup 64bff65 Signed-off-by: Ran Benita <ran@unusedvar.com>
Ran Benita 64bff65a 2020-07-27T11:51:53 tools/interactive-evdev: change --evdev-offset to --without-x11-offset There is no reason to give full control rather than just enable/disable. Signed-off-by: Ran Benita <ran@unusedvar.com>
Ran Benita 608e9361 2020-07-25T16:30:39 tools: run test-tool-option-parsing.py like a regular test Signed-off-by: Ran Benita <ran@unusedvar.com>
Ran Benita 95111740 2020-07-25T16:36:54 tools/compile-keymap: hide --kccgst comment on public build Signed-off-by: Ran Benita <ran@unusedvar.com>
Ran Benita 2fefe558 2020-07-25T16:34:11 tools: fix strcmp mistake in 0066e38 Signed-off-by: Ran Benita <ran@unusedvar.com>
Ran Benita 0066e387 2020-07-25T15:49:17 tools: make independent from src/ Signed-off-by: Ran Benita <ran@unusedvar.com>
Ran Benita f439ce18 2020-07-25T11:17:11 tools: some minor changes to xkbcli Signed-off-by: Ran Benita <ran@unusedvar.com>
Peter Hutterer ce5eb1ac 2020-07-24T13:31:03 tools: link the tools against libxkbcommon.so only The tools previously linked against a static version (by simply recompiling everythiong). This isn't necessary, we can link them against libxkbcommon.so. Only exception: The xbkcli-compile-keymap tool needs a private API for the --kccgst flag. Avoid this by disabling this flag in the installed tool and building the same tool, statically linked but not-installed. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Peter Hutterer a472e030 2020-07-24T13:25:11 tools: avoid use of a private api This is merely to fill in some NULL pointers anyway, we can just use the #defines we have available at build time. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Peter Hutterer cd119a28 2020-07-23T09:37:15 Drop use of ronn, switch to raw roff instead Drop the ronn source files, check in the generated files instead. This gets rid of the ruby+gem+ronn toolchain requirement at the cost of having to edit raw man pages. ronn files are as-generated but with the preamble and generation date removed. The latter isn't important enough to keep, it'll just go stale for manually maintained files and it's not worth setting up a configure_file() just for that date. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Peter Hutterer 31b38c31 2020-07-22T11:52:13 tools: don't mangle the path for tools, just exec directly Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Peter Hutterer ba52e34d 2020-07-22T11:15:27 tools: don't assert on 64+ commandline arguments, just return Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Peter Hutterer d480f053 2020-07-13T15:38:50 tools: add a test program to parse the commandline options A pytest wrapper around our xkbcli tool - copied from libinput. This calls our various xkbcli tools with varying options and check that they either succeed or return the right error code. The coverage is limited, it does not (and cannot) test for all possible combinations but it should provide a good red flag if we have inconsistent behavior or accidentally break some combination of flags. Meanwhile, we can at least assume that all our commandline arguments are parsed without segfaulting or worse. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Peter Hutterer 449ed2b8 2020-07-13T12:28:43 tools: drop getopt vs getopt_long differentiation On all platforms we build on where getopt.h is available, getopt_long is also available. Only Windows doesn't have either but that's no reason for us to differentiate between the two. If we need to special-case getopt vs getopt_long, it's probably better to implement our own cross-platform version of it and use that. Fixes #161 Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Peter Hutterer 7d36a3d1 2020-07-13T12:26:07 tools: switch how-to-type to getopt_long This provides consistency with the other tools that now all take long options. Plus, it's more obvious to have the arguments spelled out. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Peter Hutterer ab3be693 2020-07-13T12:13:23 tools: switch interactive-evdev to getopt_long Requiring long options for this tool means it's immediately obvious what an invocation does, compare e.g. xkbcli interactive-evdev -gcd to the equivalent: xkbcli interactive-evdev --consumed-mode=gtk --enalbe-compose --report-state-changes This drops the evdev offset argument - that offset should never be anything other than 8, having this as argument here is more likely to confuse or produce misleading debugging logs. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Peter Hutterer 71418206 2020-07-09T12:15:45 tools: consistently return 2 on invalid usage Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Peter Hutterer 29e80e7b 2020-07-08T13:30:47 tools: install our tools as xkbcli subcommands The xkbcli tool usage help is ifdef'd out where the tool isn't built but the man page always includes all tools. Easier that way. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Peter Hutterer ed57fb8b 2020-07-08T12:51:54 tools: add a xkbcli tool as entry point for the various tools we have This is the base tool, no subtools are currently connected so you only get help and version for now. The goal here is to have a git-like infrastructure where /usr/bin/xkbcli is the main tool, anything else will hide in libexec. The infrastructure for this is copied from libinput. Tools themselves will will be installed in $prefix/libexec/xkbcommon and the xkbcli tool forks off whatever argv[1] is after modifying the PATH to include the libexec dir. libinput has additional code for checking whether we're running this from the builddir but it's a bit iffy and it's usefulness is limited - if you're in the builddir anyway you can just run ./builddir/xkbcli-<toolname> directly. So for this code here, running ./builddir/xkbcli <toolname> will execute the one in the prefix/libexecdir. Since we want that tool available everywhere even where some of the subtools aren't present, we need to ifdef the getopt handling. man page generation is handled via ronn which is a ruby program but allows markdown for the sources. It's hidden behind a meson option to disable where downloading ronn isn't an option. The setup is generic enough that we can add other man-pages by just appending to the array. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Peter Hutterer 2cb90c95 2020-07-08T09:55:20 tools: add option to print full RMLVO elements to rmlvo-to-keymap Since the most common use-case is to provide only some elements of RMLVO, this makes it possible to show what is actually being used in the background based on the built-in defaults. Print this in a format that's mostly JSON-compatible or at least easy to parse, just in case. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Peter Hutterer fc2d4fa2 2020-07-07T11:43:08 tools: add ability to compile from kccgst to rmlvo-to-keymap This obsoletes the print-compiled-keymap tool though we now require that the kccgst components are passed via stdin, there is no file loading ability. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Peter Hutterer 00bb7cd3 2020-07-07T11:22:57 tools: add include path handling to rmlvo-to-keymap Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Peter Hutterer fd391471 2020-07-07T10:40:05 tools: add ability to print the KcCGST components for rmlvo-to-keymap This makes the rmlvo-to-kccgst tool obsolete. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Peter Hutterer 09d6b965 2020-07-07T10:55:30 tools: expand help output for rmlvo-to-keymap Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Peter Hutterer d0a29eee 2020-07-07T10:17:12 tools: add verbose logging to rmlvo-to-keymap Since we want to log the include paths too we need to split the context init up, otherwise include paths are added before we can set the verbosity. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Peter Hutterer 4889f550 2020-07-06T16:07:11 tools: always print the rmlvo-to-keymap outcome The most common case for this tool is to check what the keymap is for a given RMLVO. Let's print that by default, the use-cases that just check for compilation success can discard stdout instead. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Peter Hutterer afb26e7d 2020-05-12T14:09:50 Add libxkbregistry to query available RMLVO This library is the replacement for clients parsing evdev.xml directly. Instead, they should use the API here so that in the future we may even be able to swap evdev.xml for a more suitable data format. The library parses through evdev.xml (using libxml2) and - if requested - through evdev.extras.xml as well. The merge approach is optimised for the default case where we have a system-installed rules XML and another file in $XDG_CONFIG_DIR that adds a few entries. We load the system file first, then append any custom ones to that. It's not possible to overwrite the MLVO list provided by the system files - if you want to do that, get the change upstream. XML validation is handled through the DTD itself which means we only need to check for a nonempty name, everything else the DTD validation should complain about. The logging system is effectively identical to xkbcommon. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Ran Benita 878cc7a5 2020-06-28T09:50:47 tools: don't depend on src/utils.h The idea is to make the tools/demos as standalone as possible so that they may serve as examples as well. Signed-off-by: Ran Benita <ran@unusedvar.com>
Peter Hutterer 8b8a4645 2020-06-24T09:00:08 tools: allow stdin for compiling keymaps This connects two tools to be useful together: xkbcommon-rmlvo-to-kccgst | xkbcommon-print-compiled-keymap - which will result in the full keymap generated by the former tool. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Peter Hutterer 0ecd5522 2020-06-24T08:59:29 tools: print the kccgst format in a usable syntax Might as well spit that out in the format that e.g. xkbcomp understands. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Peter Hutterer 3adbe54e 2020-06-23T16:20:08 tools: move the remaining tools from test to here Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Peter Hutterer c09bf363 2020-06-23T14:01:48 test: untangle interactive-evdev from the test headers Move (sometimes duplicate) the required bits into new shared files tools-common.(c|h) that are compiled into the internal tools library. Rename the test_foo() functions to tools_foo() and in one case just copy the code of the keymap compile function to the tool. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Peter Hutterer 2eb5d2c8 2020-06-23T16:06:10 test: simplify error handling in interactive-evdev Passing -errno around and having separate labels depending on failure types is superfluous here. All the unref calls can handle NULL and nothing cares about errno once we're out of the immediate scope. So let's simplify this and deal with 0 and 1 only. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Peter Hutterer ec2bbe59 2020-06-22T13:07:46 Move the various tools to a tools/ directory Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>