Allow NULL rmlvo for xkb_keymap_new_from_names

Previously we allowed you to pass a names struct with five NULL members,
but not just pass NULL for the struct itself.  This was pretty dumb. :(

Signed-off-by: Daniel Stone <daniel@fooishbar.org>

test: Add environment checking to rulescomp

To ensure that overriding RMLVO from the environment works.

Signed-off-by: Daniel Stone <daniel@fooishbar.org>

test: Suppress RMLVO environment inheritance by default

But add a flag to allow it for later usage.

Signed-off-by: Daniel Stone <daniel@fooishbar.org>

Add environment overrides for default RMLVO

You can now set default values in the environment, as well as a context
option to ignore the environment, e.g. for tests.

Signed-off-by: Daniel Stone <daniel@fooishbar.org>

test: Use test_get_context() in log.c

Since the only behavioural change is overriding default includes.

Signed-off-by: Daniel Stone <daniel@fooishbar.org>

test: Add flags argument to test_get_context()

Allowing overriding of environment suppression, at first.

Signed-off-by: Daniel Stone <daniel@fooishbar.org>

test: Move test_key_seq to common.c

Signed-off-by: Daniel Stone <daniel@fooishbar.org>

rules: be more paranoid in scanner

This can't happen, but better safe than sorry. The optimizations were
noticeable but negligible.

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

rules: quiet a gcc warning

src/xkbcomp/rules.c:620:36: error: 'idx' may be used uninitialized in this function [-Werror=maybe-uninitialized]

Can't happen but no harm done.

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

keyseq: add a couple of tests

Tests the filter refcounting.

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

state: use stdbool in filters

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

doc: use README as doxygen main page overview

The doxygen page looked a bit dead, the README fills it nicely, and is
already written in the markdown format which doxygen uses (I think?).

Unfortunately the USE_MDFILE_AS_MAINPAGE doxygen config doesn't seem to
do anything.. So we just add a {#mainpage} tag at the top of the README
which isn't so bad. BUT we still need some config option (the
no_extension=md part) so that doxygen will accept README instead of
README.md or somesuch. And that requires an even newer release, 1.8.3.1,
released 2013-01. But if an older version is used, it doesn't spew out
warnings but just skips the README, which is fine.

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

doc: update Doxyfile template to one from newer version

We want to use the USE_MDFILE_AS_MAINPAGE option which was introduced in
doxygen 1.8.3 (released 2012-12).

Right now the new options are commented, otherwise older doxygen spews
these these warnings, which can be ignored:

warning: ignoring unsupported tag `USE_MDFILE_AS_MAINPAGE =' at line 794, file doc/Doxyfile
warning: ignoring unsupported tag `MATHJAX_FORMAT         =' at line 1210, file doc/Doxyfile
warning: ignoring unsupported tag `EXTERNAL_SEARCH        =' at line 1257, file doc/Doxyfile
warning: ignoring unsupported tag `SEARCHENGINE_URL       =' at line 1265, file doc/Doxyfile
warning: ignoring unsupported tag `SEARCHDATA_FILE        =' at line 1271, file doc/Doxyfile
warning: ignoring unsupported tag `EXTERNAL_SEARCH_ID     =' at line 1278, file doc/Doxyfile
warning: ignoring unsupported tag `EXTRA_SEARCH_MAPPINGS  =' at line 1287, file doc/Doxyfile

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

doc: some improvements

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

keymap: rename xkb_kt_map_entry to xkb_key_type_entry

That's a better name and fits more nicely.
Also change type->map to type->entries.

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

Fix pointer style nit

(I really dislike this one for some reason..)

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

Remove file_id entirely

It is not used anymore.

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

symbols: remove file_id

See previous commits.

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

compat: remove file_id

See previous commit.

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

types: remove file_id

See previous commit.

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

types: put all copy-to-keymap code in one function

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

keycodes: remove KeyNamesInfo::merge

Not used.

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

keycodes: unwrap KeyNameInfo

We don't need the struct any more, it only contains one field now.

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

keycodes: remove file_id

The file_id thing is used to identify the XkbFile some statement
originally came from. This is needed to avoid spurious warnings; for
example, if you write the same alias twice in a file, that's redundant,
and you'd want a warning about it. However if intentionally override it
from another file, that's fine, and you shouldn't get a warning. So by
comparing the file_id's the needed log verbosity is changed.

However, the file_id mechanism is really not needed, because we already
have that info! Each KeyNamesInfo corresponds to one XkbFile, so if the
conflict occurred while handling that one file -> same_file = true, and
if it occurs while merging two Info's -> same_file = false.

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

keymap: don't use darray for key aliases

With a little tweak to the copy-to-keymap routine in keycodes.c we can
use a normal array.

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

keycodes: don't do unnecessary copies while merging

If 'into' in empty we can just steal 'from'.

Also move the alias-merging into the big function, it's nicer this way.

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

state: small style fix

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

Move a couple of general keymap functions from keycodes.c

To get a key by name and resolve an alias - this makes sense for
everyone.

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

keycodes: remove unneeded alias conflict check

This is already checked when adding a new alias and merging aliases, so
it can never happen when we get to copying to the keymap.

Also the log verbosity decision there is quite useless, we should just
warn always and be done with it. So we can remove the file_id from
AliasInfo, and collapse the alias functions together.

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

xkbcomp: handle XKB file include's better

The 'merge_mode' situation is quite messy, and we've introduced a
regression compared to original xkbcomp: when handling a composite
include statement, such as
    replace "foo(bar)+baz(bla)|doo:dee"
and merging the entire resulting *Info back into the including *Info,
we actually use the merge mode that is set by the last part (here it is
"augment" because of the '|'), when we should be using the one set for
the whole statement (here "replace").

We also take the opportunity to clean up a bit.

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

Build cleanly with clang

clang doesn't like the use of typeof with out default flags, so just
don't use it.

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

Don't try to build linux-specific tests on non-linux

Some tests use linux/input.h (and epoll), but we're building on some
other kernels (e.g. debian freebsd). We could just copy the file but
it's GPL. We could also skip the tests (exit code 77) but it doesn't
really matter.

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

keymap: abstract a bit over the keymap format

Make it a bit easier to experiment with other formats.

Add a struct xkb_keymap_format_operations, which currently contains the
keymap compilation and _get_as_string functions. Each format can
implement whatever it wants from these.

The current public entry points become wrappers which do some error
reporting, allocation etc., and calling to the specific format. The
wrappers are all moved to src/keymap.c, so there are no XKB_EXPORT's
under src/xkbcomp/ anymore.

The only format available now is normal text_v1.

This is all not very KISS, and adds some indirection, but it is helpful
and somewhat cleaner.

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

text: some style changes

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

text: clean up and fix the *MaskText functions

The snprintf trick that LedStateText and ControlMaskText do cannot work,
because you can't use the buffer as an argument to write to itself!
(posix at least has 'restrict' there). So those two actually never
worked for more than one value (i.e. with a +).

Fix that, and do the same cleanup to ModMaskText. Now we have 3
functions which look exactly the same, oh well.

Also increase the context text buffer size, you never know.

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

More spelling errors

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

test/rmlvo-to-kccgst: free memory before exit

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

parser: also skip 'section' ELEMENT

It's for geometry only.

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

ast-build: remove malloc_or_die

This should be fixed properly.

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

keycodes: fix spelling in error message

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

Remove list.h

We don't use it anymore and it's easy to add back if needed.

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

Makefile.am: don't create INSTALL and ChangeLog

It may be xorg standard but it's completely useless and clutter the
directory.

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

keymap-dump: move writing 'key {}' in symbols to its own function

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

keymap-dump: remove some ugly empty lines

xkbcomp prints them too, but that's just annoying. Also xkb_keycodes
doesn't have it already.

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

keymap-dump: don't indent after xkb_keymap {

xkbcomp doesn't indent there, so it's easier to diff.
Also saves some horizontal space which is sorely needed when looking at
these files (especially the xkb_symbols).

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

keymap-dump: style cleanups

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

ast: add error handling to XkbFileFromComponents

And try to not repeat ourselves.

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

Fix dead assignments

"Value stored to 'stmt' is never read"
"Value stored to 'grp_to_use' is never read"

And change 'grp' to 'group' if we're here.

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

keysym: print unicode keysyms uppercase and 0-padded

Use the same format as XKeysymToString.

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

Change some log functions to take ctx instead of keymap

They don't need the keymap, only the context.

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

keycodes: some minor style

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

action: s/hndlrType/handler_type

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

compat: make it clear which 'dflt' is meant

Also s/dflt/default.

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

symbols: make it clear which 'dflt' is meant

A bit easier at a glance. Also, vowels are cool, so just say 'default'.

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

ast: constify argument

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

symbols: fix bad 'merge' assignment

Bug introduced in 2a5b0c9dc1ad1488ecc6b139fd70e464eb687da6, was causing
some keys to be merged incorrectly.

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

Change 'indicator' to 'led' everywhere possible

The code currently uses the two names interchangeably.
Settle on 'led', because it is shorter, more recognizable, and what we
use in our API (though of course the parser still uses 'indicator').

In camel case we make it 'Led'.
We change 'xkb_indicator_map' to just 'xkb_led' and the variables of
this type are 'led'. This mimics 'xkb_key' and 'key'.
IndicatorNameInfo and LEDInfo are changed to 'LedNameInfo' and
'LedInfo', and the variables are 'ledi' (like 'keyi' etc.). This is
instead of 'ii' and 'im'.

This might make a few places a bit confusing, but less than before I
think. It's also shorter.

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

test/interactive: change variable name for 'xkb' to 'keymap'

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

state: fix unbound virtual modifier bug

Recent xkeyboard-config introduced the following line in symbols/level3:
    vmods = LevelThree,
However, the XKM format which xkbcomp produces for the X server can't
handle explicit virtual modifiers such as this:
https://bugs.freedesktop.org/show_bug.cgi?id=4927

So by doing the following, for example:

setxkbmap -layout de (or another 3-level layouts)
xkbcomp $DISPLAY out.xkb
xkbcomp out.xkb $DISPLAY

The modifier is lost and can't be used for switching to Level3 (see the
included test).

We, however, are affected worse by this bug when we load the out.xkb
keymap. First, the FOUR_LEVEL_ALPHABETIC key type has these entries:
    map[None] = Level1;
    map[Shift] = Level2;
    map[Lock]  = Level2;
    map[LevelThree] = Level3;
    [...]
Now, because the LevelThree virtual modifier is not bound to anything,
the effective mask of the "map[LevelThree]" entry is just 0. So when
the modifier state is empty (initial state), this entry is chosen, and
we get Level3, instead of failing to match any entry and getting the
default Level1.

The difference in behavior from the xserver stems from this commit:
acdad6058d52dc8a3e724dc95448300850d474f2
Which removed the entry->active field. Without bugs, this would be
correct; however, it seems in this case we should just follow the
server's behavior.

The server sets the entry->active field like so in XKBMisc.c:
    /* entry is active if vmods are bound */
    entry->active = (mask != 0);
The xkblib spec explains this field, but does not specify how to
initialize it. This commit does the same as above but more directly.

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

test/interactive: also print the level

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

test/keyseq: re-add de(neo) level5 test

See:
https://bugs.freedesktop.org/show_bug.cgi?id=50935
This works now after syncing with recent xkeyboard-config.

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

Sync test data from xkeyboard-config

Sync the files again from xkeyboard-config 2.8, since there have been
some changes we should test against.

Also added a script test/data/sync.sh if we want to do it again in the
future.

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

configure.ac: add xkbcommon.com url to AC_INIT

Why not.
Also forgot to update the xorg-utils error message when bumping the
requirement.

Signed-off-by: Ran Benita <ran234@gmail.com>
[daniels: Changed to xkbcommon.org.]

Parser: Initialise geometry elements for VarDecl

We were using uninitialised memory whilst parsing geometry, leaving
random contents as the return for shape/overlay/etc sections.  Somehow
this actually worked everywhere but under Java.

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

Signed-off-by: Daniel Stone <daniel@fooishbar.org>

state: rename state->cur to state->components

'cur' doesn't make sense anymore. 'components' is a bit long for this,
but not too bad, and nothing better comes to mind.

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

state: don't keep the previous state components in xkb_state

There is really no need to keep this in the struct, we can just allocate
it on the stack when we need to.
Don't know why I did it this way.

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

keymap: wrap the layout parameter if it is out of range for the key

The functions num_levels_for_key() and get_syms_by_level() have a
'layout' parameter. Currently it is expected that this value is always
legal for the key, as determined by num_layouts_for_key(). However,
there are legitimate use cases for passing an out-of-range layout there,
most probably passing the effective layout, and expecting to get the
keysyms/levels for just this layout. So we wrap it just as we do in the
xkb_state_* functions.

This is also useful for stuff like this:
http://developer.gnome.org/gdk/stable/gdk-Keyboard-Handling.html#gdk-keymap-lookup-key

If this behavior is not desired, the user has the option to check
against num_layouts_for_key herself.

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

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

Only distribute .tar.xz archives

We definitely don't need .gz anymore, and .bz2 seems on its way out.
Mirror what Wayland does, and move to .xz exclusively.

Signed-off-by: Daniel Stone <daniel@fooishbar.org>

Don't use trailing enum comma in public headers

Pretty annoying, but C89 doesn't support that (officially), and it might
cause warning with -pedantic, etc. (though you need -Wsystem-headers to
see them usually). Removing them is not a big deal.

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

test/keysym: '\e' is non-standard

test/keysym.c:139:43: warning: non-ISO-standard escape sequence, '\e'
Didn't warn about it before..

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

doc: clarify that keysym_to_utf8 returns size including '\0'

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

keysym-utf: mark keysymtab array as static

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

keysym-utf: also translate special keysyms like Tab and Return

The keysym2ucs.c file apparently leaves out some keysyms, which libX11
deals with separately (like in _XkbHandleSpecialSym()).
The problematic keysyms are the keypad ones (for which we already added
some support) and keysyms which use 0xff** instead of 0x00** < 0x20.
This code should fix them properly, as much as I could gather from
libX11 and http://www.cl.cam.ac.uk/~mgk25/ucs/keysym2ucs.c and other
sources (which are not aware of locale).

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

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

Add some explanations on consumed modifiers

This should hopefully clarify this somewhat subtle point to the
uninitiated users.

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

action: don't allow private actions with a known type

Some obscure bug having to do with Private actions; see the comments.
This was prompted by:
https://bugs.freedesktop.org/show_bug.cgi?id=56491

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

build: Require xorg macros 1.16

For XORG_TESTSET_CFLAG and XORG_MEMORY_CHECK_FLAGS.

Signed-off-by: Damien Lespiau <damien.lespiau@intel.com>
Cc: Daniel Stone <daniel@fooishbar.org>

build: Make autoreconf honour ACLOCAL_FLAGS

When running autoreconf, it's possible to give flags to the underlying
aclocal by declaring a ACLOCAL_AMFLAGS variable in the top level
Makefile.am.

Putting ${ACLOCAL_FLAGS} there allows the user to set an environment
variable up before running autogen.sh and pull in the right directories
to look for m4 macros, say an up-to-date version of the xorg-util macros.

Signed-off-by: Damien Lespiau <damien.lespiau@intel.com>
Cc: Daniel Stone <daniel@fooishbar.org>

test/keyseq: add test for setting depressed group

Tests the SetGroup action is working properly.

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

state, context: allow passing NULL to *_unref()

For error handling code, it's nice to be able to pass NULL to these
function without worrying about segfaults ensuing. free() sets the
precedent here.

Also document this fact.

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

state: don't use xkb_keymap_num_layouts internally

Clearer and more greppable this way.

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

doc: fix wrong comment

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

state: don't use xkb_state_serialize_* internally

The code in these cases is clearer when done directly.

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

Makefile.am: move test.h to libtest_la_SOURCES

Rather than EXTRA_DIST, where it doesn't belong.

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

Makefile.am: split sed script into multiple lines

To make it visible on one screen.

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

configure.ac: don't tramp on user's CFLAGS

The configure test shouldn't touch CFLAGS, because they come last on the
command line and allow to users to override settings if needed.

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

configure.ac: add explicit PKG_PROG_PKG_CONFIG

We still use pkg-config to get the xkb_base variable from
xkeyboard-config, but we removed all of the other PKG_ macro calls. This
still works now, because XORG_DEFAULT_OPTIONS runs it somehow. But we
shouldn't rely on it.

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

test: add key processing benchmark

This runs a bunch of random keys against xkb_state_update_key() and
xkb_state_key_get_one_sym(), in a fairly unintelligent way.

It might be nice to check when modifying this code path, or changing it,
to see things haven't slowed down considerably. However, given the
numbers this benchmark gives, it is pretty clear that we are not going
to be the bottleneck for anything. So this can more-or-less be ignored.

Incidentally, this also turned out to be a poor man's fuzzer, because it
turned up the fix in the previous commit. Maybe we should consider
beefing it up with an actual 'break stuff' intention and running it as
part of 'make check'.

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

state: fix possible index-out-of-bounds in action dispatch table

The current code assumes that action->type always falls in the range of
the xkb_action_type enum. But keymaps can also have Private actions,
which are allowed to set their own type number.

So with a default xkeyboard-config keymap, keycode 86 at level 4, which
triggers such an action, causes us to crash.

Fix it by always checking the bounds.

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

More README

Signed-off-by: Daniel Stone <daniel@fooishbar.org>

README updates

Good thing I didn't check this before I made a release.

Signed-off-by: Daniel Stone <daniel@fooishbar.org>

Bump to 0.2.0

Signed-off-by: Daniel Stone <daniel@fooishbar.org>

doc: various fixes

Just moving around / fixing syntax / grammar.

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

doc: move include_path functions to a separate group

These are 'special intrest' function, like the logging functions, so
it's nice to have them in their own logical group.

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

test/interactive: use num_layouts_for_key()

This is the more appropriate for a specific key (also considering the
num_layouts() is a bit of a made-up value).

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

keymap: use plain array for keymap->group_names

Again it is not resized.

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

state: fix typo in state component copying

Gladly no-one should have been fast enough to hit this.

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

autogen: use --force instead of --symlink

--force copies and installs all the autotools support files, rather than
making symlinks, which can sometimes break things when upgrading your
system autotools.  This is what xserver does.

Signed-off-by: Daniel Stone <daniel@fooishbar.org>

Change update_mask arguments to read 'depressed' instead of 'base'

Just to be consistent, as we use 'depressed' everywhere else in the API.

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

test/interactive: add option to show state changes

Pass -c to see.

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

Report which components of the state have changed

We add a return value to the xkb_state_update_key and
xkb_state_update_mask, which reports to the caller which of the state
components have changed as a result.

This restores the XKB functionality of the XkbStateNotify and
XkbIndicatorsStateNotify events. See:
http://www.x.org/releases/current/doc/kbproto/xkbproto.html#Events
It is quite useful in some situations. For example, it allows an
application to avoid doing some work if nothing of relevance in the
state has changed. Say, a keyboard layout applet. Also useful for
debugging.

The deltas themselves are not provided, because I can't see a use case.
If needed, it should be possible to add some API for that.

In xkbcommon, keymaps are immutable, so all of the other *Notify events
from XKB are irrelevant.

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