platform/upstream/libxkbcommon.git
3 years agotools: convert man pages from man format to mdoc format
Ran Benita [Mon, 27 Jul 2020 08:24:06 +0000 (11:24 +0300)]
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>
3 years agoPACKAGING: mention xkbcli
Ran Benita [Sun, 30 Aug 2020 18:59:30 +0000 (21:59 +0300)]
PACKAGING: mention xkbcli

Signed-off-by: Ran Benita <ran@unusedvar.com>
3 years agobuild: fix meson "uses features which were added in newer versions" warning
Ran Benita [Sun, 30 Aug 2020 18:54:21 +0000 (21:54 +0300)]
build: fix meson "uses features which were added in newer versions" warning

Signed-off-by: Ran Benita <ran@unusedvar.com>
3 years agodoc: add some disclaimer regarding user-specific key types and compat entries
Peter Hutterer [Wed, 26 Aug 2020 05:47:51 +0000 (15:47 +1000)]
doc: add some disclaimer regarding user-specific key types and compat entries

It's a niche use-case but basically the same as adding symbols, so let's go with
a general handwavy explanation.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agotools: add xkbcli-scaffold-new-layout as helper tool
Peter Hutterer [Fri, 10 Jul 2020 01:32:48 +0000 (11:32 +1000)]
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>
3 years agoAdd /etc/xkb as extra lookup path for system data files
Peter Hutterer [Thu, 9 Jul 2020 22:50:02 +0000 (08:50 +1000)]
Add /etc/xkb as extra lookup path for system data files

This completes the usual triplet of configuration locations available for most
processes:
- vendor-provided data files in /usr/share/X11/xkb
- system-specific data files in /etc/xkb
- user-specific data files in $XDG_CONFIG_HOME/xkb

The default lookup order user, system, vendor, just like everything else that
uses these conventions.

For include directives in rules files, the '%E' resolves to that path.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agoxkbcomp: allow including kccgst files from other paths
Peter Hutterer [Fri, 10 Jul 2020 05:16:50 +0000 (15:16 +1000)]
xkbcomp: allow including kccgst files from other paths

Previously, a 'symbols/us' file in path A would shadow the same file in path B.
This is suboptimal, we rarely need to hide the system files - we care mostly
about *extending* them. By continuing to check other lookup paths, we make it
possible for a XDG_CONFIG_HOME/xkb/symbols/us file to have sections including
those from /usr/share/X11/xkb/symbols/us.

Note that this is not possible for rules files which need to be manually
controlled to get the right bits resolved.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agoxkbcomp: simplify the include path handling
Peter Hutterer [Mon, 27 Jul 2020 01:55:32 +0000 (11:55 +1000)]
xkbcomp: simplify the include path handling

Streamline the code a bit - instead of handling all the if (!file) conditions
handle the case of where we have a file and jump to the end.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agoxkbcomp: move the logging of include paths into a helper function
Peter Hutterer [Mon, 27 Jul 2020 01:48:29 +0000 (11:48 +1000)]
xkbcomp: move the logging of include paths into a helper function

No functional changes, prep work for some other refacturing.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agobuild: fix byacc invocation
Ran Benita [Sat, 8 Aug 2020 11:35:36 +0000 (14:35 +0300)]
build: fix byacc invocation

Fixes: https://github.com/xkbcommon/libxkbcommon/issues/133#issuecomment-670902025
Reported-by: Edward-0
Signed-off-by: Ran Benita <ran@unusedvar.com>
3 years agotest: fix the xkeyboard-config test
Peter Hutterer [Tue, 28 Jul 2020 22:13:14 +0000 (08:13 +1000)]
test: fix the xkeyboard-config test

'xkbcli compile-keymap' doesn't work unless we ninja install first. But for a
test that's to be run from the test directory, that's not a useful option so
let's call the binary directly. The script adds the meson builddir to the PATH
anyway.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agotest: ignore the real XDG_CONFIG_HOME during tests
Peter Hutterer [Mon, 27 Jul 2020 01:26:51 +0000 (11:26 +1000)]
test: ignore the real XDG_CONFIG_HOME during tests

Let's not have our tests fail if the user has an incompatible
$XDG_CONFIG_HOME/xkb directory.

libxkbcommon has fallbacks when XDG_CONFIG_HOME isn't set so we need to override
this with a real directory instead of just unsetting it.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agotools/interactive-evdev: fixup 64bff65
Ran Benita [Mon, 27 Jul 2020 08:57:24 +0000 (11:57 +0300)]
tools/interactive-evdev: fixup 64bff65

Signed-off-by: Ran Benita <ran@unusedvar.com>
3 years agotools/interactive-evdev: change --evdev-offset to --without-x11-offset
Ran Benita [Mon, 27 Jul 2020 08:51:53 +0000 (11:51 +0300)]
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>
3 years agodoc: ignore rxkb, RXBK prefixes in doxygen
Ran Benita [Sat, 25 Jul 2020 14:18:02 +0000 (17:18 +0300)]
doc: ignore rxkb, RXBK prefixes in doxygen

Signed-off-by: Ran Benita <ran@unusedvar.com>
3 years agotest/tool-option-parsing: remove --kccgst test, it's private for now
Ran Benita [Sat, 25 Jul 2020 13:38:43 +0000 (16:38 +0300)]
test/tool-option-parsing: remove --kccgst test, it's private for now

Signed-off-by: Ran Benita <ran@unusedvar.com>
3 years agotools: run test-tool-option-parsing.py like a regular test
Ran Benita [Sat, 25 Jul 2020 13:30:39 +0000 (16:30 +0300)]
tools: run test-tool-option-parsing.py like a regular test

Signed-off-by: Ran Benita <ran@unusedvar.com>
3 years agotools/compile-keymap: hide --kccgst comment on public build
Ran Benita [Sat, 25 Jul 2020 13:36:54 +0000 (16:36 +0300)]
tools/compile-keymap: hide --kccgst comment on public build

Signed-off-by: Ran Benita <ran@unusedvar.com>
3 years agotools: fix strcmp mistake in 0066e38
Ran Benita [Sat, 25 Jul 2020 13:34:11 +0000 (16:34 +0300)]
tools: fix strcmp mistake in 0066e38

Signed-off-by: Ran Benita <ran@unusedvar.com>
3 years agobuild: use gnu_symbol_visibility instead of explicit -fvisibility
Ran Benita [Sat, 25 Jul 2020 13:06:40 +0000 (16:06 +0300)]
build: use gnu_symbol_visibility instead of explicit -fvisibility

Signed-off-by: Ran Benita <ran@unusedvar.com>
3 years agobuild: use nicer / syntax instead of join_paths()
Ran Benita [Sat, 25 Jul 2020 13:01:00 +0000 (16:01 +0300)]
build: use nicer / syntax instead of join_paths()

Signed-off-by: Ran Benita <ran@unusedvar.com>
3 years agotools: make independent from src/
Ran Benita [Sat, 25 Jul 2020 12:49:17 +0000 (15:49 +0300)]
tools: make independent from src/

Signed-off-by: Ran Benita <ran@unusedvar.com>
3 years agobuild: use cc.get_supported_arguments()
Ran Benita [Sat, 25 Jul 2020 12:24:40 +0000 (15:24 +0300)]
build: use cc.get_supported_arguments()

Signed-off-by: Ran Benita <ran@unusedvar.com>
3 years agobuild: remove explicit -Wextra
Ran Benita [Sat, 25 Jul 2020 12:15:31 +0000 (15:15 +0300)]
build: remove explicit -Wextra

Implied by `warning_level=2`.

Signed-off-by: Ran Benita <ran@unusedvar.com>
3 years agotools: some minor changes to xkbcli
Ran Benita [Sat, 25 Jul 2020 08:17:11 +0000 (11:17 +0300)]
tools: some minor changes to xkbcli

Signed-off-by: Ran Benita <ran@unusedvar.com>
3 years agotools: link the tools against libxkbcommon.so only
Peter Hutterer [Fri, 24 Jul 2020 03:31:03 +0000 (13:31 +1000)]
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>
3 years agotools: avoid use of a private api
Peter Hutterer [Fri, 24 Jul 2020 03:25:11 +0000 (13:25 +1000)]
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>
3 years agoDrop use of ronn, switch to raw roff instead
Peter Hutterer [Wed, 22 Jul 2020 23:37:15 +0000 (09:37 +1000)]
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>
3 years agotools: don't mangle the path for tools, just exec directly
Peter Hutterer [Wed, 22 Jul 2020 01:52:13 +0000 (11:52 +1000)]
tools: don't mangle the path for tools, just exec directly

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agotools: don't assert on 64+ commandline arguments, just return
Peter Hutterer [Wed, 22 Jul 2020 01:15:27 +0000 (11:15 +1000)]
tools: don't assert on 64+ commandline arguments, just return

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agotools: add a test program to parse the commandline options
Peter Hutterer [Mon, 13 Jul 2020 05:38:50 +0000 (15:38 +1000)]
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>
3 years agotools: drop getopt vs getopt_long differentiation
Peter Hutterer [Mon, 13 Jul 2020 02:28:43 +0000 (12:28 +1000)]
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>
3 years agotools: switch how-to-type to getopt_long
Peter Hutterer [Mon, 13 Jul 2020 02:26:07 +0000 (12:26 +1000)]
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>
3 years agotools: switch interactive-evdev to getopt_long
Peter Hutterer [Mon, 13 Jul 2020 02:13:23 +0000 (12:13 +1000)]
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>
3 years agotools: consistently return 2 on invalid usage
Peter Hutterer [Thu, 9 Jul 2020 02:15:45 +0000 (12:15 +1000)]
tools: consistently return 2 on invalid usage

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agotools: install our tools as xkbcli subcommands
Peter Hutterer [Wed, 8 Jul 2020 03:30:47 +0000 (13:30 +1000)]
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>
3 years agotools: add a xkbcli tool as entry point for the various tools we have
Peter Hutterer [Wed, 8 Jul 2020 02:51:54 +0000 (12:51 +1000)]
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>
3 years agomeson.build: move registry-list tool down to the tools section
Peter Hutterer [Thu, 9 Jul 2020 03:52:58 +0000 (13:52 +1000)]
meson.build: move registry-list tool down to the tools section

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agomeson.build: only build the tools where getopt.h is available
Peter Hutterer [Thu, 9 Jul 2020 03:31:20 +0000 (13:31 +1000)]
meson.build: only build the tools where getopt.h is available

Windows doesn't have getopt.h. This would prevent building the tools but
they are behind other checks that cause them to be disabled. The only tools
that don't need getopt.h  are interactive-wayland and interactive-x11 but
neither is particularly useful on Windows. Just hide all tools behind the getopt
check in preparation for the upcoming tool consolidation work.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agomeson.build: move the config.h generation to the bottom
Peter Hutterer [Wed, 8 Jul 2020 02:35:23 +0000 (12:35 +1000)]
meson.build: move the config.h generation to the bottom

We cannot add to configh_data after this command so let's generate this last.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agomeson.build: registry list is dependent on getopt_long
Peter Hutterer [Thu, 9 Jul 2020 01:06:23 +0000 (11:06 +1000)]
meson.build: registry list is dependent on getopt_long

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agomeson.build: drop install:false from configure_file
Peter Hutterer [Thu, 9 Jul 2020 02:24:22 +0000 (12:24 +1000)]
meson.build: drop install:false from configure_file

meson complains because this requires 0.50.0 and we don't require that. But
since it defaults to false anyway, let's just omit it.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agomeson.build: add the valgrind test setup, exclude python tests
Peter Hutterer [Wed, 22 Jul 2020 23:04:10 +0000 (09:04 +1000)]
meson.build: add the valgrind test setup, exclude python tests

This way we can invoke the expected setup with
  meson test --setup=valgrind

And because we don't care about valgrinding python script, mark that test as
part of the "python-tests" suite and skip it during our CI valgrind run.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Signed-off-by: Ran Benita <ran@unusedvar.com>
3 years agotest: make the symbols-leak-test executable
Peter Hutterer [Wed, 22 Jul 2020 22:49:54 +0000 (08:49 +1000)]
test: make the symbols-leak-test executable

Python leaks like crazy when run under valgrind. But if we make the script
executable **and** it has uses the env invocation (i.e. #!/usr/bin/env python3),
the leaks disappear. This is not the case for a shebang of /usr/bin/python3.

Why exactly this is the case I'm not sure but executables we plan to run
should have the exec bit set. So this is a janitor patch with the nice side
effect of fixing our valgrind runs.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agoMake path retrieval consistent in xkb_compose_table_new_from_locale()
Emmanuel Gil Peyrot [Thu, 16 Jul 2020 23:09:47 +0000 (01:09 +0200)]
Make path retrieval consistent in xkb_compose_table_new_from_locale()

3 years agocompose: add xdg base directory support
Emmanuel Gil Peyrot [Thu, 16 Jul 2020 10:06:49 +0000 (12:06 +0200)]
compose: add xdg base directory support

Before reading ~/.XCompose, try to read $XDG_CONFIG_HOME/XCompose
(falling back to ~/.config/XCompose).

This helps unclutter the home directory of users who want that.

3 years agomeson.build: fix pkgconfig deprecation warning
Peter Hutterer [Wed, 22 Jul 2020 23:22:51 +0000 (09:22 +1000)]
meson.build: fix pkgconfig deprecation warning

../meson.build:239: DEPRECATION: Library xkbcommon was passed to the "libraries"
keyword argument of a previous call to generate() method instead of first
positional argument. Adding xkbcommon to "Requires" field, but this is a
deprecated behaviour that will change in a future version of Meson. Please
report the issue if this warning cannot be avoided in your case.

This was introduced in meson 0.49.0

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agoPACKAING: remove bash
Ran Benita [Wed, 22 Jul 2020 17:02:25 +0000 (20:02 +0300)]
PACKAING: remove bash

Converted to Python.

Signed-off-by: Ran Benita <ran@unusedvar.com>
3 years agotest: fix Windows CI by rewriting symbols-leak-test from bash to python
Ran Benita [Wed, 22 Jul 2020 08:47:15 +0000 (11:47 +0300)]
test: fix Windows CI by rewriting symbols-leak-test from bash to python

The CI started installing some wrapper instead of a real bash which is
what gets found.

See:
https://github.com/actions/virtual-environments/pull/1081

Given meson is written in python, it should always be available
hopefully.

Disabled valgrind wrapper for now because it now also applies to the
python interpreter which leaks like a sieve.

Signed-off-by: Ran Benita <ran@unusedvar.com>
3 years agoci: cache chocolaty download
Ran Benita [Wed, 22 Jul 2020 09:02:44 +0000 (12:02 +0300)]
ci: cache chocolaty download

The bison sourceforge download is quite slow and unreliable.

Hopefully this works. Stolen directly from ruby:
https://github.com/ruby/ruby/blob/a50750c8a960ef62b3e1dbd78b12056f0512b17d/.github/workflows/windows.yml#L26

Signed-off-by: Ran Benita <ran@unusedvar.com>
3 years agoxkbcomp: return NULL, not false in place of a FILE*
Peter Hutterer [Fri, 10 Jul 2020 05:13:38 +0000 (15:13 +1000)]
xkbcomp: return NULL, not false in place of a FILE*

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agoxkbcomp: simplify buffer handling in the include handling
Peter Hutterer [Fri, 10 Jul 2020 05:01:31 +0000 (15:01 +1000)]
xkbcomp: simplify buffer handling in the include handling

Don't do the realloc dance, just asprintf to the buffer and move on. The check
is likely pointless anyway, if we run out of asprintf size, log_error will
probably blow up as well.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agoAdd asprintf_safe helper function
Peter Hutterer [Fri, 10 Jul 2020 04:57:57 +0000 (14:57 +1000)]
Add asprintf_safe helper function

We only ever care about whether we error out or not, so let's wrap this into
something more sane.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agotools: add option to print full RMLVO elements to rmlvo-to-keymap
Peter Hutterer [Tue, 7 Jul 2020 23:55:20 +0000 (09:55 +1000)]
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>
3 years agotools: add ability to compile from kccgst to rmlvo-to-keymap
Peter Hutterer [Tue, 7 Jul 2020 01:43:08 +0000 (11:43 +1000)]
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>
3 years agotools: add include path handling to rmlvo-to-keymap
Peter Hutterer [Tue, 7 Jul 2020 01:22:57 +0000 (11:22 +1000)]
tools: add include path handling to rmlvo-to-keymap

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agotools: add ability to print the KcCGST components for rmlvo-to-keymap
Peter Hutterer [Tue, 7 Jul 2020 00:40:05 +0000 (10:40 +1000)]
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>
3 years agotools: expand help output for rmlvo-to-keymap
Peter Hutterer [Tue, 7 Jul 2020 00:55:30 +0000 (10:55 +1000)]
tools: expand help output for rmlvo-to-keymap

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agotools: add verbose logging to rmlvo-to-keymap
Peter Hutterer [Tue, 7 Jul 2020 00:17:12 +0000 (10:17 +1000)]
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>
3 years agocontext: log include paths for debugging
Peter Hutterer [Tue, 7 Jul 2020 00:16:25 +0000 (10:16 +1000)]
context: log include paths for debugging

Now that we're relying on various different include paths, let's log that ones
we use and the ones we failed to use.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agotools: always print the rmlvo-to-keymap outcome
Peter Hutterer [Mon, 6 Jul 2020 06:07:11 +0000 (16:07 +1000)]
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>
3 years agomeson.build: always set the default variants/options
Peter Hutterer [Tue, 7 Jul 2020 23:12:23 +0000 (09:12 +1000)]
meson.build: always set the default variants/options

Make this more balanced with the rules/layouts so we can rely on that #define to
exist.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agoAdd libxkbregistry to query available RMLVO
Peter Hutterer [Tue, 12 May 2020 04:09:50 +0000 (14:09 +1000)]
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>
3 years agoutils: add streq_null() for streq that allows NULL values
Peter Hutterer [Tue, 23 Jun 2020 01:07:53 +0000 (11:07 +1000)]
utils: add streq_null() for streq that allows NULL values

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agoAdd a snprintf_safe() helper function
Peter Hutterer [Tue, 16 Jun 2020 00:34:07 +0000 (10:34 +1000)]
Add a snprintf_safe() helper function

Returns true on success or false on error _or_ truncation. Since truncation is
almost always an error anyway, we might as well make this easier to check.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agoFactor the access check for paths out
Peter Hutterer [Mon, 1 Jun 2020 04:16:23 +0000 (14:16 +1000)]
Factor the access check for paths out

Easier to re-use without having to duplicate ifdefs.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agotest: fix the xkeyboard-config test for the prefixed tool name
Peter Hutterer [Tue, 30 Jun 2020 21:58:35 +0000 (07:58 +1000)]
test: fix the xkeyboard-config test for the prefixed tool name

Regression introduced in 362130debb5d90d77f0d4f7549880b5f9699f647

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agotools: don't depend on src/utils.h
Ran Benita [Sun, 28 Jun 2020 06:50:47 +0000 (09:50 +0300)]
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>
3 years agotools: allow stdin for compiling keymaps
Peter Hutterer [Tue, 23 Jun 2020 23:00:08 +0000 (09:00 +1000)]
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>
3 years agotools: print the kccgst format in a usable syntax
Peter Hutterer [Tue, 23 Jun 2020 22:59:29 +0000 (08:59 +1000)]
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>
3 years agotest: drop some now-obsolete functions
Peter Hutterer [Tue, 23 Jun 2020 22:30:50 +0000 (08:30 +1000)]
test: drop some now-obsolete functions

These were moved to tools/tools-common.c and now that all tools are switched
over, they're no longer needed.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agomeson.build: prefix all tools with xkbcommon-
Peter Hutterer [Tue, 23 Jun 2020 06:32:05 +0000 (16:32 +1000)]
meson.build: prefix all tools with xkbcommon-

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agotools: move the remaining tools from test to here
Peter Hutterer [Tue, 23 Jun 2020 06:20:08 +0000 (16:20 +1000)]
tools: move the remaining tools from test to here

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agotest: disentangle interactive-wayland from the test headers
Peter Hutterer [Tue, 23 Jun 2020 06:25:50 +0000 (16:25 +1000)]
test: disentangle interactive-wayland from the test headers

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agotest: untangle interactive-x11 from the test headers
Peter Hutterer [Tue, 23 Jun 2020 06:23:24 +0000 (16:23 +1000)]
test: untangle interactive-x11 from the test headers

Use the new tools headers and create a custom internal lib for the x11 tool.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agotest: untangle interactive-evdev from the test headers
Peter Hutterer [Tue, 23 Jun 2020 04:01:48 +0000 (14:01 +1000)]
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>
3 years agotest: simplify error handling in interactive-evdev
Peter Hutterer [Tue, 23 Jun 2020 06:06:10 +0000 (16:06 +1000)]
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>
3 years agoUse a custom internal library for the tools
Peter Hutterer [Tue, 23 Jun 2020 05:56:16 +0000 (15:56 +1000)]
Use a custom internal library for the tools

This is currently identical to the internal test library, but it's a start to
disentangle the two.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agoMove the various tools to a tools/ directory
Peter Hutterer [Mon, 22 Jun 2020 03:07:46 +0000 (13:07 +1000)]
Move the various tools to a tools/ directory

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agotest: how-to-type: prefer local headers over system ones
Peter Hutterer [Mon, 22 Jun 2020 03:08:51 +0000 (13:08 +1000)]
test: how-to-type: prefer local headers over system ones

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agotest: untangle rmlvo-to-kccgst from the test headers
Peter Hutterer [Mon, 22 Jun 2020 03:17:47 +0000 (13:17 +1000)]
test: untangle rmlvo-to-kccgst from the test headers

Using test helpers to init the context gives it fairly specific behavior; unless
the user sets the right environment variables and/or calls it from the right
PWD, it may or may not include the test data.

Let's drop this behavior, make it a default tool to compile a keymap. If there
is a specific need to modify the include paths, we can add this later.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agotest: untangle print-compiled-keymap from the test headers
Peter Hutterer [Mon, 22 Jun 2020 03:04:43 +0000 (13:04 +1000)]
test: untangle print-compiled-keymap from the test headers

Commit 16c84cdd819db516fff089c76b99248fb7dd4e8c removed the getopt handling for
RMLVO arguments, so now this tool only takes a keymap file and compiles it.

Using test helpers to init the context gives it fairly specific behavior; unless
the user sets the right environment variables and/or calls it from the right
PWD, it may or may not include the test data.

Let's drop this behavior, make it a default tool to compile a keymap. If there
is a specific need to modify the include paths, we can add this later.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agotest: simplify an exit path
Peter Hutterer [Mon, 22 Jun 2020 03:01:41 +0000 (13:01 +1000)]
test: simplify an exit path

The unref() functions take NULL as argument, so we don't need different labels
for every possible exit path.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agoRemove the gitignore file
Peter Hutterer [Mon, 22 Jun 2020 03:12:49 +0000 (13:12 +1000)]
Remove the gitignore file

This contained three groups entries:
- autotools stuff which no longer needed
- entries to ignore built artifacts, no longer needed with meson as everyting is
  in the builddir
- special files like cscope.out, etc. These should be handled by a user in their
  global gitignore file since they're fairly specific to a user's setup.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agodoc: correct the include path list
Peter Hutterer [Tue, 16 Jun 2020 00:44:48 +0000 (10:44 +1000)]
doc: correct the include path list

XKB_CONFIG_ROOT (if defined) replaces the built-in system directories.

Fixes 5fb2c6769b7259ba647781bc800d6a46d90cf1a9

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agodoc: add documentation for user configuration
Peter Hutterer [Tue, 2 Jun 2020 06:18:47 +0000 (16:18 +1000)]
doc: add documentation for user configuration

Most of this is currently hidden in the commit message for ca033a29d2ca, let's
make it a bit more public so we have a link to point users to.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
3 years agodoc: add the rules-format file (as markdown)
Peter Hutterer [Tue, 2 Jun 2020 06:11:33 +0000 (16:11 +1000)]
doc: add the rules-format file (as markdown)

Useful to have this as part of the documentation. The rendering isn't great but
at least not any worse than pure text. Markdown escapes % so explaining our use
of %S and %H would require a double % - not idea. Let's just wrap it as a code
block and done.

Includes two typo fixes too, yay.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
4 years agoAdd an editorconfig file
Peter Hutterer [Mon, 25 May 2020 00:29:20 +0000 (10:29 +1000)]
Add an editorconfig file

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
4 years agokeysyms: add XKB_KEY_XF86FullScreen
Ran Benita [Wed, 20 May 2020 17:42:02 +0000 (20:42 +0300)]
keysyms: add XKB_KEY_XF86FullScreen

Updated using ./scripts/update-keysyms using latest xorgproto.

Fixes: https://github.com/xkbcommon/libxkbcommon/issues/147
Signed-off-by: Ran Benita <ran@unusedvar.com>
4 years agokeymap: don't forget about fallback mappings in xkb_keymap_key_get_mods_for_level()
Ran Benita [Sat, 4 Apr 2020 21:07:57 +0000 (00:07 +0300)]
keymap: don't forget about fallback mappings in xkb_keymap_key_get_mods_for_level()

If the active set of modifiers doesn't match any explicit entry of the
key type, the resulting level is 0 (i.e. Level 1). Some key types don't
explicitly map Level 1, taking advantage of this fallback.

Previously, xkb_keymap_key_get_mods_for_level didn't consider this, and
only reported masks for explicit mappings. But this causes some glaring
omissions, like matching "a" in the "us" keymap returning not results.

Since every mask which isn't explicitly mapped falls back to 0, we can't
return the all. Almost always the best choice for this is the empty
mask, so return that, when applicable.

Fixes https://github.com/xkbcommon/libxkbcommon/issues/140.
Reported-by: https://github.com/AliKet
Signed-off-by: Ran Benita <ran@unusedvar.com>
4 years agoFix building X11 tests on PE targets
Jon Turney [Fri, 10 Apr 2020 15:32:13 +0000 (16:32 +0100)]
Fix building X11 tests on PE targets

Link libxkbcommon_x11_internal with libxkbcommon_test_internal, rather
than libxkbcommon.

This avoids some tests linking with both libxkbcommon_test_internal and
libxkbcommon, which causes duplicate symbol problems on PE targets (e.g.
Cygwin) (as all the symbols from libxkbcommon are pulled in at link
time, which clash with libxkbcommon_test_internal)

4 years agoci: remove azure pipelines build
Ran Benita [Sat, 18 Apr 2020 17:57:51 +0000 (20:57 +0300)]
ci: remove azure pipelines build

Broken, replaced with github actions.

Signed-off-by: Ran Benita <ran@unusedvar.com>
4 years agoci: add github actions build
Ran Benita [Sat, 18 Apr 2020 17:52:17 +0000 (20:52 +0300)]
ci: add github actions build

We currently use Azure Pipelines. But it became out of date. Also it
requires a different account and setup than github account itself.

The configuration here is probably not very good and is less featureful
than the Azure one but it's what I managed.

Signed-off-by: Ran Benita <ran@unusedvar.com>
4 years agotest: use flag instead of hardcoded value in examples
Nils [Wed, 25 Mar 2020 08:43:41 +0000 (08:43 +0000)]
test: use flag instead of hardcoded value in examples

4 years agotest/how-to-type: some code fixes/improvements
Ran Benita [Sat, 21 Mar 2020 10:56:13 +0000 (12:56 +0200)]
test/how-to-type: some code fixes/improvements

Signed-off-by: Ran Benita <ran@unusedvar.com>
4 years agotest: add "how to type" demo program
Ran Benita [Fri, 20 Mar 2020 16:29:03 +0000 (18:29 +0200)]
test: add "how to type" demo program

The program takes a unicode codepoint and an RMLVO and prints out all
key + modifier combinations that would result in that codepoint.

The program was written to exercise the new
xkb_keymap_key_get_mods_for_level() function. It's handy and can be
extended in several ways, but enough for now.

Example:

    $ ./build/how-to-type -l us,il,ru 0x41 | column -ts $'\t'
    keysym: A (0x41)
    KEYCODE  KEY NAME  LAYOUT#  LAYOUT NAME   LEVEL#  MODIFIERS
    38       AC01      1        English (US)  2       [ Shift ]
    38       AC01      1        English (US)  2       [ Lock ]
    38       AC01      2        Hebrew        2       [ Shift ]
    38       AC01      2        Hebrew        2       [ Lock ]

    $ ./build/how-to-type -l de -v neo 0x3b6 | column -ts $'\t'
    keysym: Greek_zeta (0x7e6)
    KEYCODE  KEY NAME  LAYOUT#  LAYOUT NAME     LEVEL#  MODIFIERS
    56       AB05      1        German (Neo 2)  4       [ Shift Mod5 ]
    56       AB05      1        German (Neo 2)  4       [ Shift Mod2 Mod3 Mod5 ]
    56       AB05      1        German (Neo 2)  4       [ Shift Lock Mod5 ]
    56       AB05      1        German (Neo 2)  4       [ Lock Mod2 Mod3 Mod5 ]

Signed-off-by: Ran Benita <ran@unusedvar.com>
4 years agodoc: add missing `@since` tags
Ran Benita [Fri, 20 Mar 2020 17:15:48 +0000 (19:15 +0200)]
doc: add missing `@since` tags

Signed-off-by: Ran Benita <ran@unusedvar.com>
4 years agoAPI to query modifier set required to type a keysym
Jaroslaw Kubik [Wed, 5 Feb 2020 16:42:06 +0000 (17:42 +0100)]
API to query modifier set required to type a keysym

The new API is useful to implement features like auto-type and
desktop automation. Since the inputs for these features is usually
specified in terms of the symbols that need to be typed, the
implementation needs to be able to invert the keycode->keysym
transformation and produce a sequence of keycodes that can be used
to type the requested character(s).

4 years agoSupport translation Unicode codepoints to keysyms
Jaroslaw Kubik [Wed, 12 Feb 2020 22:44:42 +0000 (23:44 +0100)]
Support translation Unicode codepoints to keysyms

In order to support features like auto-type and UI automation, the
relevant tools need to be able to invert the keycode->keysym->text
transformation. In order to facilitate that, a new API was added.
It allows querying the keysyms that correspond to particular Unicode
codepoints. For all practical purposes, it can be thought of as an
inverse of xkb_keysym_to_utf32().

4 years agobuild: fix build with byacc
Ran Benita [Tue, 18 Feb 2020 12:12:20 +0000 (14:12 +0200)]
build: fix build with byacc

We apparently broke byacc support in the switch to meson.

byacc only supports short option names. And to make things fun, bison
only supports long option for `--defines`.

Fixes: https://github.com/xkbcommon/libxkbcommon/issues/133
Signed-off-by: Ran Benita <ran@unusedvar.com>