keysym: use a more descriptive argument name

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

keysym: open-code bsearch

We want to optimize things here which requires messing with the binary
search some.

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

interactive-evdev: fix missing initialization

Accidentally got lost in 6b65be4.

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

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>

x11: fix comparison of integer expressions of different signedness

src/x11/keymap.c:980:26: warning: comparison of integer expressions of different signedness: ‘size_t’ {aka ‘long unsigned int’} and ‘int’ [-Wsign-compare]
  980 |     for (size_t i = 0; i < length; i++) {
      |                          ^

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

xkbcomp: plug a potential memory leak

libxkbcommon-1.0.3/src/xkbcomp/ast-build.c:526: leaked_storage: Variable "file"
going out of scope leaks the storage it points to.

Where we exit the loop early, we don't release the various allocated memory.

Make this patch more obvious my moving the declaration for those into the loop
as well, this way we know that they aren't used outside the loop anywhere.

Found by coverity

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

registry: plug a potential memleak for invalid rules files

If the name is missing in a configItem, we'd fail and leak the memory for
description, brief and vendor.

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

test: fix missing va_end in case of test failures

Found by coverity

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

bench: silence coverity complaint about a double free

False positive because we rely on xkb_components_from_rules() to initalize this
struct, but let's localize the variable anyway to shut coverity up.

libxkbcommon-1.0.3/bench/rules.c:59:9: warning[-Wanalyzer-double-free]:
double-free of kccgst.symbols

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

Inline x11_atom_interner_adopt_atoms() into callers

Signed-off-by: Uli Schlachter <psychon@znc.in>

Save another GetAtomName round trip

Both get_atom_name() and the new atom interner required a round trip. Move
get_atom_name() into the atom interner to save one more round trip. This brings
xkb_x11_keymap_new_from_device() down to two round trips, which is the minimum
possible number.

(Also, I think the new code in keymap.c is more readable than the mess I
previously created)

With this last commit in the series, this definitely:

Fixes: https://github.com/xkbcommon/libxkbcommon/pull/217
Signed-off-by: Uli Schlachter <psychon@znc.in>

Also batch the XKB GetNames request

This gets rid of another round trip.

Signed-off-by: Uli Schlachter <psychon@znc.in>

Also batch the XKB-GetMapMap request

This gets rid of one more round trip.

Signed-off-by: Uli Schlachter <psychon@znc.in>

Remove three more round trips

There are a number of XKB requests needed to request all the information from
the X11 server. So far, the code was sending one request and waiting for the
reply. This commit starts batching the request so that we get multiple replies
with one round trip.

This removes three round trips.

Only the simple requests are converted. get_map() and get_names() use some
bitmasks that are needed for both the request and the reply. These will be dealt
with separately.

Signed-off-by: Uli Schlachter <psychon@znc.in>

Save three more round trips in xkb_x11_keymap_new_from_device()

Instead of asking for an atom name and waiting for the reply four times, this
now sends four GetAtomName requests and waits for all the replies at once. Thus,
this saves three round trips.

Signed-off-by: Uli Schlachter <psychon@znc.in>

xkb_x11_keymap_new_from_device: Less X11 round-trips

On my system, calling xkb_x11_keymap_new_from_device() did 78 round trips to the
X11 server, which seems excessive. This commit brings this number down to about
9 to 10 round trips.

The existing functions adopt_atom() and adopt_atoms() guarantee that the atom
was adopted by the time they return. Thus, each call to these functions must do
a round-trip. However, none of the callers need this guarantee.

This commit makes "atom adopting" asynchronous: Only some time later is the atom
actually adopted. Until then, it is in some pending "limbo" state.

This actually fixes a TODO in the comments.

Fixes: https://github.com/xkbcommon/libxkbcommon/issues/216
Signed-off-by: Uli Schlachter <psychon@znc.in>

Bump version to 1.1.0

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

doc: add keymap-format-text-v1.md to the HTML documentation

It's incomplete but might be helpful for someone.

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

doc: add note on variants in rule names

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

Fix a few keysymtab entries to match their comment in xkbcommon-keysyms.h

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

scripts: remove meson-junit-report.py

Not used since ed5a0b4fede69b8e6dc4db53d97ea4ae0a73956d.

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

meson.build: replace the remaining join_paths() with the nicer / syntax

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

test: add a keysym tester

A simple script that creates a new layout with the given keysym replacing TLDE.
Then we compile a keymap and search for the keysym being assigned to TLDE and
bail if that fails.

The list of keysyms is manually maintained but we only need to add one or two to
spot-check whenever the xorgproto is updated.

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

Fix documentation for XKB_CONFIG_EXTRA_PATH

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

Update keysym definitions to latest xorgproto

As of xorgproto commit e5d8af9711516385f8346c9e077692b29c914478

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

scripts: update makeheader script for the _EVDEVK keysym defines

As of xorgproto commit 5dbb5b76597f [1], the 0x10081XXX keycode range is defined
for direct evdev kernel keycode mapping. For example, KEY_MACRO1 (0x290) is
mapped to 0x10081290. The format of the #define lines for these keys is
stable to allow for parsing:

  #define XF86XK_FooBar _EVDEVK(0x123) /* optional comment */

Update our script so we detect these new lines. Our keysym generation is a
two-step process: makeheader and then makekeys. Replacing the key with its full
value in the makeheader script means we don't have to update makekeys to handle
the _EVDEVK macro and our header file is fully resolved.

[1] https://gitlab.freedesktop.org/xorg/proto/xorgproto/-/merge_requests/23

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

Update imported comments in xkbcommon-keysyms.h

Matches xorgproto commits 39eb5974 and 09602b213.

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

test: fix interactive evdev test invocation

rmlvos is the parent list which then fails during a list join because, well,
it's a list of lists.

Fixes #206

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

test: fill in srcdir/builddir when not set in the environment

Makes this test easier to run from the commandline. Where either of top_srcdir
or top_builddir isn't set, fill them in from the CWD or fail otherwise.

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

doc/keymap: some slight editing

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

doc/keymap: add documentation for xkb_symbols (#205)

Bump version to 1.0.3

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

keymap-dump: follow xkbcomp in printing affect=both in pointer actions

It is equivalent to nothing but good to match up.

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

x11: fix type level names missing

When reading the keymap, the level names would get discarded.
Regressed in 26453b84732da870f5695ee347970b337cfea9c1.

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

test/data: update host.xkb to match keymap-dump style

This is needed for fixing the x11comp test.

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

x11/keymap: fix case with no actions

Possible regression in f41e609bbea8447fc82849a1a6ea0d116189f2f8 (not
confirmed yet).

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

Bump version to 1.0.2

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

x11: cache X11 atoms

On every keymap notify event, the keymap should be refreshed, which
fetches the required X11 atoms. A big keymap might have a few hundred of
atoms.

A profile by a user has shown this *might* be slow when some intensive
amount of keymap activity is occurring. It might also be slow on a
remote X server.

While I'm not really sure this is the actual bottleneck, caching the
atoms is easy enough and only needs a couple kb of memory, so do that.

On the added bench-x11:

Before: retrieved 2500 keymaps from X in 11.233237s
After : retrieved 2500 keymaps from X in 1.592339s

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

x11: eliminate slow divisions

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

build: combine test & bench internal deps

No need to duplicate this really.

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

ci: fix windows CI failure due to add-path deprecation

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

test: catch unrecognized keysyms in the xkeyboard-config test

Prompted by
https://gitlab.freedesktop.org/xkeyboard-config/xkeyboard-config/-/merge_requests/127

We run the keymap tool with --verbose which will print the messages from the
compiler to the log file as well. And then we can search for the warning
regarding an unrecognized keysym and fail our test based on that.

xkbcomp: where a keysym cannot be resolved, set it to NoSymbol

Where resolve_keysym fails we warn but use the otherwise uninitialized variable
as our keysym. That later ends up in the keymap as random garbage hex value.

Simplest test case, set this in the 'us' keymap:
    key <TLDE>               {      [        xyz ] };

And without this patch we get random garbage:
./build/xkbcli-compile-keymap --layout us | grep TLDE:
    key <TLDE>               {      [      0x018a5cf0 ] };

With this patch, we now get NoSymbol:
./build/xkbcli-compile-keymap --layout us | grep TLDE:
    key <TLDE>               {      [        NoSymbol ] };

doc: add note about "short" layout names (#194)

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

Bump version to 1.0.1

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

parser: fix another format string for int64_t (#191)

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>

test/tool-option-parsing: skip testing of disabled tools

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

test/tool-option-parsing: switch from pytest to unittest

For me, installing pytest for libxkbcommon is a bit problematic, so I
end up skipping it which is not great.

Switch to unittest which is built in to Python. It's not as nice as
pytest but good enough in this case.

Note: I was too lazy to switch the plain asserts to unittest
assertions...

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

test/tool-option-parsing: keep isolated by using our own test data

Make it possible to run the test on all machines.

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

build: move tests to after tools

So tests can refer to stuff set by the tools section.

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

utils: include unistd.h where we have it

MacOS doesn't have eaccess/euidaccess but it does have unistd.h, so let's
include it to silence the R_OK redefinition compiler warnings.

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

context: fix a compiler warning

../src/context.c:57:9: warning: variable 'err' is used uninitialized whenever
'if' condition is true [-Wsometimes-uninitialized]

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

registry: mark the rxkb_log function as attribute printf

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

ci: enable xkbregistry on macos job

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

test: include unstd.h in the registry test to cut down the MacOS warnings

mkdtmp, rmdir and unlink are in unstd.h on MacOS. Since including that it
doesn't hurt us on Linux, let's do it without ifdefs.

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

test/data: add rule registry files

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

test/data: sync from xkeyboard-config 2.30

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

test/data: change quartz.xkb from CRLF to LF

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

test: fix the xkbcli --version test

Fixes https://github.com/xkbcommon/libxkbcommon/issues/185

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

build: remove old pkgconfig templates

In meson these are generated instead.

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

Bump version to 1.0.0

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

xkbcli: fix interactive-x11 not showing in help

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

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

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>

ci: fix windows job not finding bison

Instead of using the unpredictable chocolatey let's just handle it
ourselves. The versions are pinned but that's arguably good.

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

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>

PACKAGING: mention xkbcli

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

build: fix meson "uses features which were added in newer versions" warning

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

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>

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>

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>

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>

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>

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>

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>

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>

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>

tools/interactive-evdev: fixup 64bff65

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

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>

doc: ignore rxkb, RXBK prefixes in doxygen

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

test/tool-option-parsing: remove --kccgst test, it's private for now

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

tools: run test-tool-option-parsing.py like a regular test

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

tools/compile-keymap: hide --kccgst comment on public build

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

tools: fix strcmp mistake in 0066e38

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

build: use gnu_symbol_visibility instead of explicit -fvisibility

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

build: use nicer / syntax instead of join_paths()

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

tools: make independent from src/

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

build: use cc.get_supported_arguments()

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

build: remove explicit -Wextra

Implied by `warning_level=2`.

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

tools: some minor changes to xkbcli

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

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>

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>

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>

tools: don't mangle the path for tools, just exec directly

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

tools: don't assert on 64+ commandline arguments, just return

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

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>

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>

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>

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>