keymap: add xkb_keymap_key_by_name(), xkb_keymap_key_get_name(), tests

xkb_keymap_key_by_name() allows finding a keycode from a given keyname and
is useful for generating keyboard events to use in regression tests
during CI

xkb_keymap_key_get_name() is the inverse of xkb_keymap_key_by_name()

Signed-off-by: Mike Blumenkrantz <zmike@osg.samsung.com>
[ran: some stylistic tweaks + another test case]
Signed-off-by: Ran Benita <ran234@gmail.com>

doc/keymap-format-text-v1: add title and intro

Signed-off-by: Ran Benita <ran234@gmail.com>

doc/quick-guide: small improvements

Signed-off-by: Ran Benita <ran234@gmail.com>

doc/keymap-format-text-v1: convert to markdown

Make it more readable for random browsing.

Signed-off-by: Ran Benita <ran234@gmail.com>

doc/keymap-format-text-v1: update info on preserve

Signed-off-by: Ran Benita <ran234@gmail.com>

src/utils: change map_file to not take const string argument

map_file() uses PROT_READ, so const seems fitting; however unmap_file
calls munmap/free, which do not take const, so an UNCONSTIFY is needed.
To avoid the UNCONSTIFY hack, which is likely undefined behavior or some
such, just remove the const.

Signed-off-by: Ran Benita <ran234@gmail.com>

keymap: fix outdated comment

See 725ae134d434bab6c999121d55dbc3582c4acb65.

Signed-off-by: Ran Benita <ran234@gmail.com>

doc/Doxyfile: explicitly set HTML_TIMESTAMP = NO

YES was the default in older version. Having a timestamp hurts
reproducible builds, and serves no purpose, so remove it.

https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=789071

Signed-off-by: Ran Benita <ran234@gmail.com>

doc/Doxyfile: only keep non-default values

Signed-off-by: Ran Benita <ran234@gmail.com>

doc/Doxyfile: sync with latest version

Signed-off-by: Ran Benita <ran234@gmail.com>

state: reduce scope of fake action

Also rename to "dummy" as I think it is a nicer name.

Signed-off-by: Ran Benita <ran234@gmail.com>

Merge pull request #27 from nuko8/osx_test_progs

Modifications to make 'make check' test complete for Mac OS X

bench: Modify benchmarks for a wider range of platforms

 - Add the new files bench.c and bench.h to implement a timer module.
 - Implement the module with clock_gettime(), mach_absolute_time(), or
   gettimeofday(), depending on a given platform.
 - Replace the time measurement code of the benchmark programs with the
   functions of the module.

test/x11comp: Fix contention between X11 and Xvfb on Mac OS X

 - Abandon use of -displayfd.
 - Have x11comp itself look for an unused X11 display number instead.

test/x11comp: remove duplicate FOUR_LEVEL_KEYPAD from test keymap

The `test/data/keymaps/host.xkb` file contains a duplicate definition of
this type. On my computer (linux, xkbcomp 1.3.0, xserver 1.17.2), the
test passes as is, but if I remove the duplicate definition, the
roundtrip brings it back and the test fails. I can also reproduce it
without relation to the test, by loading `test/data/keymaps/host.xkb`
(without the duplicate) using

    xkbcomp -I $(pwd)/test/data/keymaps/host.xkb $DISPLAY

and downloading it again using

    xkbcomp $DISPLAY out.xkb

the duplicate is added. On Mac OS X however, the duplicate is removed
(correctly), so the test fails there.

xkbcommon itself, which was forked from xkbcomp, doesn't have this bug;
in fact, doing

    ./test/print-compiled-keymap -k keymaps/host.xkb

removes the duplicate if it is present.

This is (probably) a regression in xkbcomp or xserver compared to the
versions used in Mac OS X. Since getting a patch for any of these two is
hopeless from my experience, I did not try to investigate further.

I am not sure why, but if I also add a `PC_SUPER_LEVEL2` type, the
duplicate of `FOUR_LEVEL_KEYPAD` doesn't show up. Hopefully the test
will work on all platforms now.

https://github.com/xkbcommon/libxkbcommon/issues/26

Reported-by: @nuko8
Signed-off-by: Ran Benita <ran234@gmail.com>

test/x11comp: small simplifications

xkbcomp doesn't need the search-path argument, since we pass an absolute
path. Keep the plain -I which clears the search path just to be sure.

Signed-off-by: Ran Benita <ran234@gmail.com>

Merge pull request #25 from mvo5/master

Add XKB_CONFIG_ROOT environment

Add XKB_CONFIG_ROOT environment

The XKB_CONFIG_ROOT environment allows overrding the build time
DFLT_XKB_CONFIG_ROOT path.

build: don't fail if linker version scripts are not supported

Some platforms (such as OSX) do not support version scripts. In these
platforms the symbols will not be versioned, but it is OK to omit them.

https://github.com/xkbcommon/libxkbcommon/issues/24

compose: correctly parse modifier syntax

As described in:
http://cgit.freedesktop.org/xorg/lib/libX11/commit/?id=ddf3b09bb262d01b56fbaade421ac85b0e60a69f

Signed-off-by: Ran Benita <ran234@gmail.com>

rename to LICENSE

GitHub uses 'LICENSE' to scrape for repository license information, cf.
https://github.com/blog/1964-open-source-license-usage-on-github-com

Rename to make it a bit easier for it.

doc: some editorial changes to compose documentation

Use nicer Markdown syntax, `surround` some words, fix some typos.

Signed-off-by: Ran Benita <ran234@gmail.com>

test/common: print keycode in decimal not hex

Keycodes are usually written in decimal, so hex is hard to compare.

Signed-off-by: Ran Benita <ran234@gmail.com>

configure.ac: also print ${datarootdir} in summary

It goes something like:

    ${XLOCALEDIR} ->
    ${datarootdir}/locale/X11 ->
    ${prefix}/share/locale/X11 ->
    /usr/share/locale/X11

But AC_MSG_RESULT only performs one substitution. Instead of starting to
expand this stuff manually, just print datarootdir so all the pieces are
there.

Signed-off-by: Ran Benita <ran234@gmail.com>

PACKAGING: fix confusing typo

Signed-off-by: Ran Benita <ran234@gmail.com>

doc: explain the envvars which affect compose

Signed-off-by: Ran Benita <ran234@gmail.com>

keycodes: use correct printf format

Signed-off-by: Ran Benita <ran234@gmail.com>

Reduce variable scopes

Signed-off-by: Ran Benita <ran234@gmail.com>

ast-build: remove log message about allocation failure

We don't do so anywhere else, so until we have something comprehensive,
let's not so here.

Signed-off-by: Ran Benita <ran234@gmail.com>

xkbcomp: remove file->topName

It is useless.

Signed-off-by: Ran Benita <ran234@gmail.com>

xkbcomp/keymap: remove useless free()

Signed-off-by: Ran Benita <ran234@gmail.com>

Bump version to 0.5.0

Signed-off-by: Ran Benita <ran234@gmail.com>

Update NEWS

Signed-off-by: Ran Benita <ran234@gmail.com>

Change initial symbol file versions to V_0.5.0

It will be quite confusing to use V_0.4.3 since this was already
released without symbol versioning.

Hopefully this doesn't cause any trouble for people who are using -git.

Signed-off-by: Ran Benita <ran234@gmail.com>

compose: fill @since TBD

Signed-off-by: Ran Benita <ran234@gmail.com>

doc/compat.md: add compose incompatibilities

Signed-off-by: Ran Benita <ran234@gmail.com>

Add PACKAGING file

Signed-off-by: Ran Benita <ran234@gmail.com>

Makefile.am: add symbol files to EXTRA_DIST

Signed-off-by: Ran Benita <ran234@gmail.com>

README: we also accepts patches through github

Signed-off-by: Ran Benita <ran234@gmail.com>

docs: make html output have a fixed width, hide footer

It's hard to read text which stretches indefinitely.

The footer is not adding much.

Signed-off-by: Ran Benita <ran234@gmail.com>

README: add notes about Compose support

Signed-off-by: Ran Benita <ran234@gmail.com>

doc/quick-guide: some improvements

Signed-off-by: Ran Benita <ran234@gmail.com>

README: remove elaborate details from the intro

Point to the "quick guide" instead.

Signed-off-by: Ran Benita <ran234@gmail.com>

doc/compat.md: we don't support more groups or mods yet

Signed-off-by: Ran Benita <ran234@gmail.com>

README: move compatibility notes to their own page

Signed-off-by: Ran Benita <ran234@gmail.com>

README: link to online API docs

Signed-off-by: Ran Benita <ran234@gmail.com>

README: move note about xkeyboard-config to its own section

Signed-off-by: Ran Benita <ran234@gmail.com>

README: remove section on API stability

This was useful when we *weren't* stable. But now that we are this
should be obvious.

Signed-off-by: Ran Benita <ran234@gmail.com>

Replace some strncmp's with memcmp

Signed-off-by: Ran Benita <ran234@gmail.com>

compose/parser: save len in keysym_from_name cache

This reduces a lot of strcmp's, and allows to use a faster memcmp.

Signed-off-by: Ran Benita <ran234@gmail.com>

test/keyseq: test 'map[None] = Level2;' scenario

See previous commit for an explanation.

Signed-off-by: Ran Benita <ran234@gmail.com>

test/data: add files for model=applealu_ansi layout=us

Signed-off-by: Ran Benita <ran234@gmail.com>

test/data: sync to xkeyboard-config 2.13

(Run ./test/data/sync.sh).

Signed-off-by: Ran Benita <ran234@gmail.com>

state: correctly infer inactive type entries

The current test is incorrect, since 'map[None]' is entirely valid. In
most cases this doesn't cause any problems, since the default fallback
is Level1, and it's almost always 'map[None] = Level1' anyway. But in
one case in xkeyboard-config it isn't, in types/numpad(mac):

    type "KEYPAD" {
        modifiers = None;
        map[None] = Level2;
        level_name[Level2] = "Number";
    };

So before checking if no modifiers were mapped, make sure there *were*
any modifiers at all.

https://bugs.freedesktop.org/show_bug.cgi?id=85092

Reported-by: Gatis Paeglis <gatis.paeglis@digia.com>
Signed-off-by: Ran Benita <ran234@gmail.com>

symbols: don't warn about conflicting syms if they are the same

Signed-off-by: Ran Benita <ran234@gmail.com>

parser: bring back warning about includes of files with no default

Using the same format as xkbcomp.

Signed-off-by: Ran Benita <ran234@gmail.com>

Merge pull request #14 from jasperla/undefined

disable -Wl,--no-undefined on OpenBSD for it doesn't have DT_NEEDED for libc

disable -Wl,--no-undefined on OpenBSD for it doesn't have DT_NEEDED for libc

Merge pull request #13 from jasperla/librt

Make librt optional, required for at least OpenBSD

Make librt optional, required for at least OpenBSD

test/compose: test include statement

Signed-off-by: Ran Benita <ran234@gmail.com>

test/compose: test modifier syntax

Signed-off-by: Ran Benita <ran234@gmail.com>

compose/parser: fix parsing of multiple modifiers

Signed-off-by: Ran Benita <ran234@gmail.com>

compose/parser: parse (! mods) properly

We don't actually do anything with them. But if someone uses them we can
at least not choke.

Signed-off-by: Ran Benita <ran234@gmail.com>

compose/parser: resolve keysyms in parser instead of scanner

It will become context-sensitive.

Signed-off-by: Ran Benita <ran234@gmail.com>

compose/parser: use parameter as intended

Signed-off-by: Ran Benita <ran234@gmail.com>

compose/parser: one more skip_to_eol()

Signed-off-by: Ran Benita <ran234@gmail.com>

compose/parser: fix segfault when including

The keysym cache for the new scanner was not initialized.
To avoid such errors also in the future, require passing the priv
argument in scanner_init(), instead of initializing it separately.

Signed-off-by: Ran Benita <ran234@gmail.com>

COPYING: add copyright notice from libX11:modules/im/ximcp/imLcPrs.c

We have used some portions of it, so add the notice.

Signed-off-by: Ran Benita <ran234@gmail.com>

scanner-utils: optimize one-line comments

Compose files have a lot of those.

Signed-off-by: Ran Benita <ran234@gmail.com>

bench/compose: add new benchmark

Signed-off-by: Ran Benita <ran234@gmail.com>

test/interactive-evdev: add compose support

To try, do e.g.:
sudo ./test/interactive-evdev -l us -v intl -o compose:ralt -d

Signed-off-by: Ran Benita <ran234@gmail.com>

test/compose: add new test

Some results from the benchmark (compilation of en_US.UTF-8/Compose):

$ grep 'model name' /proc/cpuinfo
model name  : Intel(R) Core(TM)2 Duo CPU     E8400  @ 3.00GHz
model name  : Intel(R) Core(TM)2 Duo CPU     E8400  @ 3.00GHz

$ uname -a
Linux ran 3.16.1-1-ARCH #1 SMP PREEMPT Thu Aug 14 07:40:19 CEST 2014 x86_64 GNU/Linux

$ ./test/compose bench
compiled 1000 compose tables in 7.776488331s

So according to the above benchmark and valgrind --tool=massif, an
xkb_compose_table adds an overhead of about ~8ms time and ~130KB
resident memory.
For contrast, a plain US keymap adds an overhead of ~3ms time and 90KB
resident memory.

Signed-off-by: Ran Benita <ran234@gmail.com>

compose: add xkbcommon-compose - implementation

Signed-off-by: Ran Benita <ran234@gmail.com>

compose: add xkbcommon-compose - API

xkbcommon-compose is a Compose implementation for xkbcommon. It mostly
behaves like libX11's Compose, but the support is somewhat low-level and
is not transparent like in libX11. The user must add some supporting code
in order to utilize it.

The intended audience are users who use xkbcommon but not a full-blown
input method. With this they can add Compose support in a straightforward
manner, so they have a fairly complete keyboard input for Latin-like
languages at least.

See the header documentation for details.

Signed-off-by: Ran Benita <ran234@gmail.com>

scanner-utils: add priv member

For when a user of the scanner wants to pass something along with it.

Signed-off-by: Ran Benita <ran234@gmail.com>

darray: add darray_shrink()

If we have a big array which can be finalized, on average we can give
back 1/4 of its size, which the allocator might be able to use.

Signed-off-by: Ran Benita <ran234@gmail.com>

keysym: add function to test if a keysym is for a modifier

Needed for compose.

Signed-off-by: Ran Benita <ran234@gmail.com>

scanner-utils: add helper for appending an entire string

Signed-off-by: Ran Benita <ran234@gmail.com>

scanner-utils: add helper for hex string escape

Like the already existing oct.

Signed-off-by: Ran Benita <ran234@gmail.com>

Move benchmarks from tests to their own files in bench/

The tests only contain tests, and the benchmarks are more visible.

Signed-off-by: Ran Benita <ran234@gmail.com>

build: don't rebuild everything for libtest.la

We added a -fvisibilty=default to the libtest.la CFLAGS. When automake
sees that the CFLAGS are different from those of libxkbcommon.la, it
figures it should recompile all of the $(libxkbcommon_la_SOURCES),
instead of reusing the already-compiled object files.

But actually, the convenience library is not a shared object, it's just
used as an archive, thus the -fvisibility is entirely pointless. So
avoid the recompilations by just removing it.

Signed-off-by: Ran Benita <ran234@gmail.com>

scanner-utils: optimize str()/lit()

Replace the dog-slow unneeded strncasecmp() with an inlineable memcmp().

Before:
compiled 2500 keymaps in 8.348715629s

After:
compiled 2500 keymaps in 7.872640338s

Signed-off-by: Ran Benita <ran234@gmail.com>

keymap: rename XkbKeyGroupWidth to XkbKeyNumLevels

The "width" terminology comes from the group*width+level layout of the
keysyms in a key, as used in the old implementations. We don't keep all
the keysyms of a key in one array so change it to a more accurate name.

Signed-off-by: Ran Benita <ran234@gmail.com>

symbols: improve FindKeyForSymbol()

A bit more involved, but can short circuit.

Signed-off-by: Ran Benita <ran234@gmail.com>

symbols: use correct max value

xkb_level_index_t was initially uint16_t, now it's 32.

Signed-off-by: Ran Benita <ran234@gmail.com>

doc: disable alphabetical data structure index

It is useless - we have very little data structures.

Signed-off-by: Ran Benita <ran234@gmail.com>

doc: disable BRIEF_MEMBER_DESC

It's easier to quickly go through the functions in a module this way.
The names provide enough "brief description" to get someone to click for
the full description.

Signed-off-by: Ran Benita <ran234@gmail.com>

doc: disable tree view

It is redundant with the header navigation.

Signed-off-by: Ran Benita <ran234@gmail.com>

doc: linkify some references

Signed-off-by: Ran Benita <ran234@gmail.com>

x11, doc: add note about Key{Press,Release}->state field

Signed-off-by: Ran Benita <ran234@gmail.com>

x11, doc: add note about per-client flags like detectable autorepeat

Signed-off-by: Ran Benita <ran234@gmail.com>

keymap-dump: combine modifier_map's with the same modifier

A bit less efficient, but makes for shorter, nicer output.

Signed-off-by: Ran Benita <ran234@gmail.com>

rules: fix mlvo-not-used warning

An mlvo can also be used in an expansion, but we didn't mark them in
this case in commit d8a4f52cb95d989b4. This caused wrongful warnings on
something like -l ch -v fr -- the `fr` is only added via expansion.

Signed-off-by: Ran Benita <ran234@gmail.com>

quick-guide: fix xkb_state_key_get_syms() example

Signed-off-by: Ran Benita <ran234@gmail.com>

quick-guide: fix Java-esque array syntax

Signed-off-by: Ran Benita <ran234@gmail.com>

rules: warn when an RMLVO component isn't used

Due to wildcard matches in the rules file, this is only really useful
for misspelled or missing options, e.g.

$ ./test/rmlvo-to-kccgst -o comprose:ralt > /dev/null
xkbcommon: ERROR: Unrecognized RMLVO option "comprose:ralt" was ignored

Although it is more of a warning, it indicates a misconfiguration which
the user probably wants to see. Therefore the log level is ERROR.

Signed-off-by: Ran Benita <ran234@gmail.com>

parser: use "atom" instead of "sval" in yylval

"sval" is already used for "struct sval".

Signed-off-by: Ran Benita <ran234@gmail.com>

doc: reorder "Keymap Components" functions

Put the general keymap stuff before key-specific functions.

Signed-off-by: Ran Benita <ran234@gmail.com>

doc: move consumed modifier description to its own section

With small edits.

Signed-off-by: Ran Benita <ran234@gmail.com>