10 meson_version : '>= 0.49.0',
12 pkgconfig = import('pkgconfig')
13 cc = meson.get_compiler('c')
15 dir_libexec = get_option('prefix')/get_option('libexecdir')/'xkbcommon'
19 '-fno-strict-aliasing',
20 '-fsanitize-undefined-trap-on-error',
21 '-Wno-unused-parameter',
22 '-Wno-missing-field-initializers',
24 '-Wmissing-declarations',
26 '-Wstrict-prototypes',
27 '-Wmissing-prototypes',
29 '-Wbad-function-cast',
34 '-Wno-documentation-deprecated-sync',
36 add_project_arguments(cc.get_supported_arguments(cflags), language: 'c')
39 # The XKB config root.
40 XKBCONFIGROOT = get_option('xkb-config-root')
41 if XKBCONFIGROOT == ''
42 xkeyboard_config_dep = dependency('xkeyboard-config', required: false)
43 if xkeyboard_config_dep.found()
44 XKBCONFIGROOT = xkeyboard_config_dep.get_pkgconfig_variable('xkb_base')
46 XKBCONFIGROOT = get_option('prefix')/get_option('datadir')/'X11'/'xkb'
50 XKBCONFIGEXTRAPATH = get_option('xkb-config-extra-path')
51 if XKBCONFIGEXTRAPATH == ''
52 XKBCONFIGEXTRAPATH = join_paths(get_option('prefix'), get_option('sysconfdir'), 'xkb')
55 # The X locale directory for compose.
56 XLOCALEDIR = get_option('x-locale-root')
58 XLOCALEDIR = get_option('prefix')/get_option('datadir')/'X11'/'locale'
63 configh_data = configuration_data()
64 configh_data.set('EXIT_INVALID_USAGE', '2')
65 configh_data.set_quoted('LIBXKBCOMMON_VERSION', meson.project_version())
66 configh_data.set_quoted('LIBXKBCOMMON_TOOL_PATH', dir_libexec)
67 # Like AC_USE_SYSTEM_EXTENSIONS, what #define to use to get extensions
68 # beyond the base POSIX function set.
69 if host_machine.system() == 'sunos'
70 system_extensions = '__EXTENSIONS__'
72 system_extensions = '_GNU_SOURCE'
74 configh_data.set(system_extensions, 1)
75 system_ext_define = '#define ' + system_extensions
76 configh_data.set_quoted('DFLT_XKB_CONFIG_ROOT', XKBCONFIGROOT)
77 configh_data.set_quoted('DFLT_XKB_CONFIG_EXTRA_PATH', XKBCONFIGEXTRAPATH)
78 configh_data.set_quoted('XLOCALEDIR', XLOCALEDIR)
79 configh_data.set_quoted('DEFAULT_XKB_RULES', get_option('default-rules'))
80 configh_data.set_quoted('DEFAULT_XKB_MODEL', get_option('default-model'))
81 configh_data.set_quoted('DEFAULT_XKB_LAYOUT', get_option('default-layout'))
82 if get_option('default-variant') != ''
83 configh_data.set_quoted('DEFAULT_XKB_VARIANT', get_option('default-variant'))
85 configh_data.set('DEFAULT_XKB_VARIANT', 'NULL')
87 if get_option('default-options') != ''
88 configh_data.set_quoted('DEFAULT_XKB_OPTIONS', get_option('default-options'))
90 configh_data.set('DEFAULT_XKB_OPTIONS', 'NULL')
92 if cc.links('int main(){if(__builtin_expect(1<0,0)){}}', name: '__builtin_expect')
93 configh_data.set('HAVE___BUILTIN_EXPECT', 1)
95 if cc.has_header_symbol('unistd.h', 'eaccess', prefix: system_ext_define)
96 configh_data.set('HAVE_EACCESS', 1)
98 if cc.has_header_symbol('unistd.h', 'euidaccess', prefix: system_ext_define)
99 configh_data.set('HAVE_EUIDACCESS', 1)
101 if cc.has_header_symbol('sys/mman.h', 'mmap')
102 configh_data.set('HAVE_MMAP', 1)
104 if cc.has_header_symbol('stdlib.h', 'mkostemp', prefix: system_ext_define)
105 configh_data.set('HAVE_MKOSTEMP', 1)
107 if cc.has_header_symbol('fcntl.h', 'posix_fallocate', prefix: system_ext_define)
108 configh_data.set('HAVE_POSIX_FALLOCATE', 1)
110 if cc.has_header_symbol('string.h', 'strndup', prefix: system_ext_define)
111 configh_data.set('HAVE_STRNDUP', 1)
113 if cc.has_header_symbol('stdio.h', 'asprintf', prefix: system_ext_define)
114 configh_data.set('HAVE_ASPRINTF', 1)
115 elif cc.has_header_symbol('stdio.h', 'vasprintf', prefix: system_ext_define)
116 configh_data.set('HAVE_VASPRINTF', 1)
118 if cc.has_header_symbol('stdlib.h', 'secure_getenv', prefix: system_ext_define)
119 configh_data.set('HAVE_SECURE_GETENV', 1)
120 elif cc.has_header_symbol('stdlib.h', '__secure_getenv', prefix: system_ext_define)
121 configh_data.set('HAVE___SECURE_GETENV', 1)
123 message('C library does not support secure_getenv, using getenv instead')
125 have_getopt_long = cc.has_header_symbol('getopt.h', 'getopt_long',
126 prefix: '#define _GNU_SOURCE')
128 # Silence some security & deprecation warnings on MSVC
129 # for some unix/C functions we use.
130 # https://docs.microsoft.com/en-us/cpp/error-messages/compiler-warnings/compiler-warning-level-3-c4996?view=vs-2019
131 configh_data.set('_CRT_SECURE_NO_WARNINGS', 1)
132 configh_data.set('_CRT_NONSTDC_NO_WARNINGS', 1)
133 configh_data.set('_CRT_NONSTDC_NO_DEPRECATE', 1)
134 # Reduce unnecessary includes on MSVC.
135 configh_data.set('WIN32_LEAN_AND_MEAN', 1)
137 # Supports -Wl,--version-script?
138 have_version_script = cc.links(
140 args: '-Wl,--version-script=' + meson.source_root()/'xkbcommon.map',
141 name: '-Wl,--version-script',
146 # Note: we use some yacc extensions, which work with either GNU bison
147 # (preferred) or byacc (with backtracking enabled).
148 bison = find_program('bison', 'win_bison', required: false)
150 yacc_gen = generator(
152 output: ['@BASENAME@.c', '@BASENAME@.h'],
153 arguments: ['--defines=@OUTPUT1@', '-o', '@OUTPUT0@', '-p', '_xkbcommon_', '@INPUT@'],
156 byacc = find_program('byacc', required: false)
158 yacc_gen = generator(
160 output: ['@BASENAME@.c', '@BASENAME@.h'],
161 arguments: ['-H', '@OUTPUT1@', '-o', '@OUTPUT0@', '-p', '_xkbcommon_', '@INPUT@'],
164 error('Could not find a compatible YACC program (bison or byacc)')
167 libxkbcommon_sources = [
168 'src/compose/parser.c',
169 'src/compose/parser.h',
170 'src/compose/paths.c',
171 'src/compose/paths.h',
172 'src/compose/state.c',
173 'src/compose/table.c',
174 'src/compose/table.h',
175 'src/xkbcomp/action.c',
176 'src/xkbcomp/action.h',
178 'src/xkbcomp/ast-build.c',
179 'src/xkbcomp/ast-build.h',
180 'src/xkbcomp/compat.c',
181 'src/xkbcomp/expr.c',
182 'src/xkbcomp/expr.h',
183 'src/xkbcomp/include.c',
184 'src/xkbcomp/include.h',
185 'src/xkbcomp/keycodes.c',
186 'src/xkbcomp/keymap.c',
187 'src/xkbcomp/keymap-dump.c',
188 'src/xkbcomp/keywords.c',
189 yacc_gen.process('src/xkbcomp/parser.y'),
190 'src/xkbcomp/parser-priv.h',
191 'src/xkbcomp/rules.c',
192 'src/xkbcomp/rules.h',
193 'src/xkbcomp/scanner.c',
194 'src/xkbcomp/symbols.c',
195 'src/xkbcomp/types.c',
196 'src/xkbcomp/vmod.c',
197 'src/xkbcomp/vmod.h',
198 'src/xkbcomp/xkbcomp.c',
199 'src/xkbcomp/xkbcomp-priv.h',
204 'src/context-priv.c',
213 'src/scanner-utils.h',
222 libxkbcommon_link_args = []
223 if have_version_script
224 libxkbcommon_link_args += '-Wl,--version-script=' + meson.source_root()/'xkbcommon.map'
226 libxkbcommon = library(
228 'xkbcommon/xkbcommon.h',
229 libxkbcommon_sources,
230 link_args: libxkbcommon_link_args,
231 link_depends: 'xkbcommon.map',
232 gnu_symbol_visibility: 'hidden',
235 include_directories: include_directories('src'),
238 'xkbcommon/xkbcommon.h',
239 'xkbcommon/xkbcommon-compat.h',
240 'xkbcommon/xkbcommon-compose.h',
241 'xkbcommon/xkbcommon-keysyms.h',
242 'xkbcommon/xkbcommon-names.h',
245 libxkbcommon_dep = declare_dependency(
246 link_with: libxkbcommon,
251 filebase: 'xkbcommon',
252 version: meson.project_version(),
253 description: 'XKB API common to servers and clients',
258 if get_option('enable-x11')
259 xcb_dep = dependency('xcb', version: '>=1.10', required: false)
260 xcb_xkb_dep = dependency('xcb-xkb', version: '>=1.10', required: false)
261 if not xcb_dep.found() or not xcb_xkb_dep.found()
262 error('''X11 support requires xcb-xkb >= 1.10 which was not found.
263 You can disable X11 support with -Denable-x11=false.''')
266 libxkbcommon_x11_sources = [
270 'src/x11/x11-priv.h',
272 'src/context-priv.c',
278 libxkbcommon_x11_link_args = []
279 if have_version_script
280 libxkbcommon_x11_link_args += '-Wl,--version-script=' + meson.source_root()/'xkbcommon-x11.map'
282 libxkbcommon_x11 = library(
284 'xkbcommon/xkbcommon-x11.h',
285 libxkbcommon_x11_sources,
286 link_args: libxkbcommon_x11_link_args,
287 link_depends: 'xkbcommon-x11.map',
288 gnu_symbol_visibility: 'hidden',
291 include_directories: include_directories('src'),
292 link_with: libxkbcommon,
299 'xkbcommon/xkbcommon-x11.h',
302 libxkbcommon_x11_dep = declare_dependency(
303 link_with: libxkbcommon_x11,
307 name: 'xkbcommon-x11',
308 filebase: 'xkbcommon-x11',
309 version: meson.project_version(),
310 description: 'XKB API common to servers and clients - X11 support',
311 requires: ['xkbcommon'],
312 requires_private: ['xcb>=1.10', 'xcb-xkb>=1.10'],
317 if get_option('enable-xkbregistry')
318 dep_libxml = dependency('libxml-2.0')
319 deps_libxkbregistry = [dep_libxml]
320 libxkbregistry_sources = [
327 libxkbregistry_link_args = []
328 if have_version_script
329 libxkbregistry_link_args += '-Wl,--version-script=' + meson.source_root()/'xkbregistry.map'
331 libxkbregistry = library(
333 'xkbcommon/xkbregistry.h',
334 libxkbregistry_sources,
335 link_args: libxkbregistry_link_args,
336 link_depends: 'xkbregistry.map',
337 gnu_symbol_visibility: 'hidden',
338 dependencies: deps_libxkbregistry,
341 include_directories: include_directories('src'),
344 'xkbcommon/xkbregistry.h',
350 filebase: 'xkbregistry',
351 version: meson.project_version(),
352 description: 'XKB API to query available rules, models, layouts, variants and options',
355 dep_libxkbregistry = declare_dependency(
356 include_directories: include_directories('xkbcommon'),
357 link_with: libxkbregistry
362 test_env = environment()
363 test_env.set('XKB_LOG_LEVEL', 'debug')
364 test_env.set('XKB_LOG_VERBOSITY', '10')
365 test_env.set('top_srcdir', meson.source_root())
366 test_env.set('top_builddir', meson.build_root())
368 test_configh_data = configuration_data()
369 test_configh_data.set_quoted('TEST_XKB_CONFIG_ROOT', meson.source_root()/'test'/'data')
370 configure_file(output: 'test-config.h', configuration: test_configh_data)
372 # Some tests need to use unexported symbols, so we link them against
373 # an internal copy of libxkbcommon with all symbols exposed.
374 libxkbcommon_test_internal = static_library(
375 'xkbcommon-test-internal',
378 'test/evdev-scancodes.h',
379 libxkbcommon_sources,
380 include_directories: include_directories('src'),
382 test_dep = declare_dependency(
383 include_directories: include_directories('src'),
384 link_with: libxkbcommon_test_internal,
386 if get_option('enable-x11')
387 libxkbcommon_x11_internal = static_library(
388 'xkbcommon-x11-internal',
389 libxkbcommon_x11_sources,
390 include_directories: include_directories('src'),
391 link_with: libxkbcommon_test_internal,
397 x11_test_dep = declare_dependency(
398 link_with: libxkbcommon_x11_internal,
408 executable('test-keysym', 'test/keysym.c', dependencies: test_dep),
413 executable('test-keymap', 'test/keymap.c', dependencies: test_dep),
418 executable('test-filecomp', 'test/filecomp.c', dependencies: test_dep),
421 # TODO: This test currently uses some functions that don't exist on Windows.
422 if cc.get_id() != 'msvc'
425 executable('test-context', 'test/context.c', dependencies: test_dep),
431 executable('test-rules-file', 'test/rules-file.c', dependencies: test_dep),
435 'rules-file-includes',
436 executable('test-rules-file-includes', 'test/rules-file-includes.c', dependencies: test_dep),
441 executable('test-stringcomp', 'test/stringcomp.c', dependencies: test_dep),
446 executable('test-buffercomp', 'test/buffercomp.c', dependencies: test_dep),
451 executable('test-log', 'test/log.c', dependencies: test_dep),
456 executable('test-atom', 'test/atom.c', dependencies: test_dep),
461 executable('test-utf8', 'test/utf8.c', dependencies: test_dep),
466 executable('test-state', 'test/state.c', dependencies: test_dep),
471 executable('test-keyseq', 'test/keyseq.c', dependencies: test_dep),
476 executable('test-rulescomp', 'test/rulescomp.c', dependencies: test_dep),
481 executable('test-compose', 'test/compose.c', dependencies: test_dep),
486 executable('test-utils', 'test/utils.c', dependencies: test_dep),
491 find_program('test/symbols-leak-test.py'),
493 suite: ['python-tests'],
495 if get_option('enable-x11')
498 executable('test-x11', 'test/x11.c', dependencies: x11_test_dep),
501 # test/x11comp is meant to be run, but it is (temporarily?) disabled.
502 # See: https://github.com/xkbcommon/libxkbcommon/issues/30
503 executable('test-x11comp', 'test/x11comp.c', dependencies: x11_test_dep)
505 if get_option('enable-xkbregistry')
508 executable('test-registry', 'test/registry.c',
509 include_directories: include_directories('src'),
510 dependencies: dep_libxkbregistry),
515 valgrind = find_program('valgrind', required: false)
517 add_test_setup('valgrind',
518 exe_wrapper: [valgrind,
520 '--track-origins=yes',
521 '--gen-suppressions=all',
522 '--error-exitcode=99'],
523 timeout_multiplier : 10)
525 message('valgrind not found, disabling valgrind test setup')
529 # Fuzzing target programs.
530 executable('fuzz-keymap', 'fuzz/keymap/target.c', dependencies: test_dep)
531 executable('fuzz-compose', 'fuzz/compose/target.c', dependencies: test_dep)
536 build_tools = have_getopt_long
538 libxkbcommon_tools_internal = static_library(
540 'tools/tools-common.h',
541 'tools/tools-common.c',
542 dependencies: libxkbcommon_dep,
544 tools_dep = declare_dependency(
545 include_directories: [include_directories('tools')],
546 link_with: libxkbcommon_tools_internal,
549 executable('xkbcli', 'tools/xkbcli.c',
550 dependencies: tools_dep, install: true)
551 install_man('tools/xkbcli.1')
553 executable('xkbcli-compile-keymap',
554 'tools/compile-keymap.c',
555 dependencies: tools_dep,
557 install_dir: dir_libexec)
558 install_man('tools/xkbcli-compile-keymap.1')
559 # The same tool again, but with access to some private APIs.
560 executable('compile-keymap',
561 'tools/compile-keymap.c',
562 libxkbcommon_sources,
563 dependencies: [tools_dep],
564 c_args: ['-DENABLE_PRIVATE_APIS'],
565 include_directories: [include_directories('src')],
567 configh_data.set10('HAVE_XKBCLI_COMPILE_KEYMAP', true)
568 executable('xkbcli-how-to-type',
569 'tools/how-to-type.c',
570 dependencies: tools_dep,
572 install_dir: dir_libexec)
573 install_man('tools/xkbcli-how-to-type.1')
574 configh_data.set10('HAVE_XKBCLI_HOW_TO_TYPE', true)
575 if cc.has_header('linux/input.h')
576 executable('xkbcli-interactive-evdev',
577 'tools/interactive-evdev.c',
578 dependencies: tools_dep,
580 install_dir: dir_libexec)
581 configh_data.set10('HAVE_XKBCLI_INTERACTIVE_EVDEV', true)
582 install_man('tools/xkbcli-interactive-evdev.1')
584 if get_option('enable-x11')
585 x11_tools_dep = declare_dependency(
586 link_with: libxkbcommon_x11,
593 executable('xkbcli-interactive-x11',
594 'tools/interactive-x11.c',
595 dependencies: x11_tools_dep,
597 install_dir: dir_libexec)
598 install_man('tools/xkbcli-interactive-x11.1')
599 configh_data.set10('HAVE_XKBCLI_INTERACTIVE_X11', true)
601 if get_option('enable-wayland')
602 wayland_client_dep = dependency('wayland-client', version: '>=1.2.0', required: false)
603 wayland_protocols_dep = dependency('wayland-protocols', version: '>=1.12', required: false)
604 wayland_scanner_dep = dependency('wayland-scanner', required: false, native: true)
605 if not wayland_client_dep.found() or not wayland_protocols_dep.found() or not wayland_scanner_dep.found()
606 error('''The Wayland xkbcli programs require wayland-client >= 1.2.0, wayland-protocols >= 1.7 which were not found.
607 You can disable the Wayland xkbcli programs with -Denable-wayland=false.''')
610 wayland_scanner = find_program(wayland_scanner_dep.get_pkgconfig_variable('wayland_scanner'))
611 wayland_scanner_code_gen = generator(
613 output: '@BASENAME@-protocol.c',
614 arguments: ['code', '@INPUT@', '@OUTPUT@'],
616 wayland_scanner_client_header_gen = generator(
618 output: '@BASENAME@-client-protocol.h',
619 arguments: ['client-header', '@INPUT@', '@OUTPUT@'],
621 wayland_protocols_datadir = wayland_protocols_dep.get_pkgconfig_variable('pkgdatadir')
622 xdg_shell_xml = wayland_protocols_datadir/'stable/xdg-shell/xdg-shell.xml'
623 xdg_shell_sources = [
624 wayland_scanner_code_gen.process(xdg_shell_xml),
625 wayland_scanner_client_header_gen.process(xdg_shell_xml),
627 executable('xkbcli-interactive-wayland',
628 'tools/interactive-wayland.c',
630 dependencies: [tools_dep, wayland_client_dep],
632 install_dir: dir_libexec)
633 install_man('tools/xkbcli-interactive-wayland.1')
634 configh_data.set10('HAVE_XKBCLI_INTERACTIVE_WAYLAND', true)
637 if get_option('enable-xkbregistry')
638 configh_data.set10('HAVE_XKBCLI_LIST', true)
639 executable('xkbcli-list',
640 'tools/registry-list.c',
641 dependencies: dep_libxkbregistry,
643 install_dir: dir_libexec)
644 install_man('tools/xkbcli-list.1')
647 test('tool-option-parsing',
648 find_program('test/tool-option-parsing.py'),
650 suite: ['python-tests'])
654 # xkeyboard-config "verifier"
655 xkct_config = configuration_data()
656 xkct_config.set('MESON_BUILD_ROOT', meson.build_root())
657 xkct_config.set('XKB_CONFIG_ROOT', XKBCONFIGROOT)
658 configure_file(input: 'test/xkeyboard-config-test.py.in',
659 output: 'xkeyboard-config-test',
660 configuration: xkct_config)
664 libxkbcommon_bench_internal = static_library(
665 'xkbcommon-bench-internal',
668 link_with: libxkbcommon_test_internal,
670 bench_dep = declare_dependency(
671 include_directories: include_directories('src'),
672 link_with: libxkbcommon_bench_internal,
674 bench_env = environment()
675 bench_env.set('top_srcdir', meson.source_root())
678 executable('bench-key-proc', 'bench/key-proc.c', dependencies: bench_dep),
683 executable('bench-rules', 'bench/rules.c', dependencies: bench_dep),
688 executable('bench-rulescomp', 'bench/rulescomp.c', dependencies: bench_dep),
693 executable('bench-compose', 'bench/compose.c', dependencies: bench_dep),
699 if get_option('enable-docs')
700 doxygen = find_program('doxygen', required: false)
701 if not doxygen.found()
702 error('''Documentation requires doxygen which was not found.
703 You can disable the documentation with -Denable-docs=false.''')
705 doxygen_wrapper = find_program('scripts/doxygen-wrapper')
709 'doc/doxygen-extra.css',
710 'doc/quick-guide.md',
712 'doc/user-configuration.md',
713 'doc/rules-format.md',
714 'xkbcommon/xkbcommon.h',
715 'xkbcommon/xkbcommon-names.h',
716 'xkbcommon/xkbcommon-x11.h',
717 'xkbcommon/xkbcommon-compose.h',
718 'xkbcommon/xkbregistry.h',
720 doxygen_data = configuration_data()
721 doxygen_data.set('PACKAGE_NAME', meson.project_name())
722 doxygen_data.set('PACKAGE_VERSION', meson.project_version())
723 doxygen_data.set('INPUT', ' '.join(doxygen_input))
724 doxygen_data.set('OUTPUT_DIRECTORY', meson.build_root())
725 doxyfile = configure_file(
726 input: 'doc/Doxyfile.in',
728 configuration: doxygen_data,
730 # TODO: Meson should provide this.
731 docdir = get_option('datadir')/'doc'/meson.project_name()
734 input: [doxyfile] + doxygen_input,
736 command: [doxygen_wrapper, doxygen.path(), meson.build_root()/'Doxyfile', meson.source_root()],
739 build_by_default: true,
743 configure_file(output: 'config.h', configuration: configh_data)