Merge pull request #31 from bluetech/consumed-modes

Consumed modifiers modes

state: add GTK consumed modifiers mode

This is more or less what is implemented here:
https://git.gnome.org/browse/gtk+/tree/gdk/x11/gdkkeys-x11.c?h=3.19.10#n1131

The implementation here is more technically correct but should provide
the same results.

Try it out with ./test/interactive-evdev -g (modifiers prefixed with "-"
are consumed).

https://bugzilla.gnome.org/show_bug.cgi?id=754110
https://github.com/xkbcommon/libxkbcommon/issues/17

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

state: allow different modes for calculating consumed modifiers

The current functions dealing with consumed modifiers use the
traditional XKB definition of consumed modifiers (see description in the
added documentation). However, for several users of the library (e.g.
GTK) this definition is unsuitable or too eager. This is exacerbated by
some less-than-ideal xkeyboard-config type definitions (CTRL+ALT seems
to cause most grief...).

So, because we
- want to enable alternative interpretations, but
- don't want to expose too much internal details, and
- want to keep things simple for all library users,
we add a high-level "mode" parameter which selects the desired
interpretation. New ones can be added as long as they make some sense.

All of the old consumed-modifiers functions keep using the traditional
("XKB") mode. I mark xkb_state_mod_mask_remove_consumed() and as
deprecated without adding a *2 variant because I don't it is very useful
(or used) in practice.

Alternative modes are added in subsequent commits (this commit only adds
a mode for the existing behavior).

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

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

utils: add popcount function

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

test/state: move wrongly-placed assert

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

bench: fix compilation on hurd

Patch by Samuel Thibault.

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

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

bench/compose: tabs -> spaces

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

README: Add basic build directions

In particular, highlight the use of configure flags to control locating
X11 keyboard stuff when building for Wayland.

Of particular note, if the locale root is not specified, then xkbcommon
will look for them under $prefix (i.e. /usr/local/share/X11/locale).
But unless the user has specifically installed them there, it is better
to look in the standard system location, /usr/share/X11/locale.

Otherwise, xkbcommon will error when it can't find them, e.g.:

  xkbcommon: ERROR: ~/.XCompose:4:9: failed to expand %L to the locale Compose file
  xkbcommon: ERROR: ~/.XCompose:4:12: unterminated string literal

Signed-off-by: Bryce Harrington <bryce@osg.samsung.com>
Signed-off-by: Ran Benita <ran234@gmail.com>

README: Bug *reports* are welcome

Signed-off-by: Bryce Harrington <bryce@osg.samsung.com>
Reviewed-by: Yong Bakos <ybakos@humanoriented.com>
Signed-off-by: Ran Benita <ran234@gmail.com>

bench: Check for errors opening Compose file

Otherwise it can segfault e.g. running ./compose inside the bench
directory.

Signed-off-by: Bryce Harrington <bryce@bryceharrington.org>
Signed-off-by: Ran Benita <ran234@gmail.com>

doc/compat: (! MODIFIER) syntax is parsed but ignored

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

doc/compat.md: xkbcomp ignores multiple-keysyms these days

https://cgit.freedesktop.org/xorg/app/xkbcomp/commit/?id=e119cbec7e750ffc4d4bd08b577db2c697035a30

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

doc: Also mention the wayland test client in the quick guide

Signed-off-by: Bryce Harrington <bryce@osg.samsung.com>

doc: Declare keymap for wayland example

keymap was defined in the X11 example, but also define it in the wayland
example just to make it a bit more standalone

Signed-off-by: Bryce Harrington <bryce@osg.samsung.com>

doc: Fix ctx type in example

xkb_context_new() returns a xkb_context pointer, so change the variable
definition to be consistent.

Signed-off-by: Bryce Harrington <bryce@osg.samsung.com>

PACKAGING: Update for interactive-wayland

Signed-off-by: Daniel Stone <daniels@collabora.com>

test/interactive-wayland: fix control reaches end of non-void function

AFAICS there is nothing that can fail directly in this function, so
change it to void.

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

keymap-dump: use consistent order set/latch/lock (style)

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

src/state: match_mod_masks can return bool instead of int

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

test/symbols-leak-test: use more portable shebang

Some BSDs don't want to give bash the honor of /bin and put it
elsewhere. So look it up in PATH instead.

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

test/interactive-wayland: don't ignore asprintf return value

Fixes warn_unused_result warning.

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

test: use termios instead of system() for disabling terminal echo

Takes care of GCC's annoyingly persistent warn_unused_result warnings.
But it's better to avoid system() I suppose.

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

gitignore: ignore generated wayland protocol stubs

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

interactive-wayland: Valgrind-proofing

More meticulously free everything we create, including hooking up the
buffer-release callback so we actually free those when required. Make
sure seats are actually in the display's seat list.

The xkbcommon object-unref functions don't actually require
NULL-checking, so we can elide those.

Signed-off-by: Daniel Stone <daniels@collabora.com>

test: Add interactive-wayland

interactive-wayland is very similar to x11/xev, and dumps out as much
state as possible.

It provides no titlebar and a completely random cursor, but such is
life.

Signed-off-by: Daniel Stone <daniels@collabora.com>

Bump version to 0.6.1

Our most minor release yet.

Signed-off-by: Daniel Stone <daniels@collabora.com>

Add LICENSE to distributed files

Signed-off-by: Daniel Stone <daniels@collabora.com>

doc: update reference to compat symbol to its new name

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

Bump version to 0.6.0

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

test: assert/ignore some warn_unused_result's

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

Merge pull request #33 from bluetech/travis-enable-x11

travis: remove --disable-x11

travis: remove --disable-x11

Looks like the CI machines can use Ubuntu 14.04, which has libxcb 1.10,
which is new enough. Lets see if it works.

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

Merge pull request #32 from fooishbar/master

doc: Fix Doxygen include for srcdir != builddir

travis: Enable documentation build

Make sure Doxygen is installed before we build.

Signed-off-by: Daniel Stone <daniels@collabora.com>

doc: Fix Doxygen include for srcdir != builddir

Instead of giving Doxygen a series of absolute paths to the source
files and a relative path to the output directory, run it from the
source directory with purely relative paths to the source files, and
give it an absolute path to the build directory.

This fixes the parsing of README.md with a separate build directory,
since the relative includes for doc/quick-guide.md and doc/compat.md
don't resolve otherwise. Doxygen's INCLUDE_PATH turns out not to fix
this either, since that's just a set of paths to open and parse, rather
than an analogue to cpp's -I.

Signed-off-by: Daniel Stone <daniels@collabora.com>

Update NEWS

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

NEWS: add some spacing

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

build: don't run test/x11comp in make check for now

For some reason, the dumped keymap started repeating the two key types
FOUR_LEVEL_PLUS_LOCK and FOUR_LEVEL_KEYPAD. I need to investigate, but
let's disable it for now until I do (the problem would likely not be in
the xkbcommon - at most in the test itself).

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

test/x11comp: fix memory leak

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

test: add a test that all symbol version file is updated

It is easy to forget to update these files when adding new symbols.

Stolen with slight changes from libinput (commit by Marek Chalupa):
https://cgit.freedesktop.org/wayland/libinput/commit/?id=a9f216ab47ea2f643f20ed741b741a2b5766eba3

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

Add symbol versions forgotten in 0ce17ef3ea3722c1cfe7af3

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

build: make it easier to add non-built (e.g. script) tests

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

src/utils: check if fileno() failed in map_file

fileno() can fail, if called on e.g. fmemopen() FILEs which are not
backed by a file descriptor. This functions uses mmap to map the entire
file to memory, so using such FILEs will not work.

(There is actually no change of behavior here, since the following fstat
would have already failed with EBADF. But lets make it clear.)

Another possibility is to fall back to the !HAVE_MMAP case; but it
sounds like a better idea to leave it to the programmer to use the
new_from_string/new_from_buffer functions instead, instead of doing
double allocation behind their back.

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

keymap: share LevelsSameSyms()

The function is generic enough.

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

state: factor out get_entry_for_mods()

Will be useful later.

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

state: factor out entry_is_active() check

Makes the code slightly cleaner and I plan to use the function in
another place.

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

build: fix distcheck

File was renamed in 4266402.

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

doc: add environment variables index

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

doc: some notes about key names and aliases

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

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>