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 '-fvisibility=hidden',
20 '-fno-strict-aliasing',
21 '-fsanitize-undefined-trap-on-error',
22 '-Wno-unused-parameter',
23 '-Wno-missing-field-initializers',
25 '-Wmissing-declarations',
27 '-Wstrict-prototypes',
28 '-Wmissing-prototypes',
30 '-Wbad-function-cast',
35 '-Wno-documentation-deprecated-sync',
37 add_project_arguments(cc.get_supported_arguments(cflags), language: 'c')
40 # The XKB config root.
41 XKBCONFIGROOT = get_option('xkb-config-root')
42 if XKBCONFIGROOT == ''
43 xkeyboard_config_dep = dependency('xkeyboard-config', required: false)
44 if xkeyboard_config_dep.found()
45 XKBCONFIGROOT = xkeyboard_config_dep.get_pkgconfig_variable('xkb_base')
47 XKBCONFIGROOT = get_option('prefix')/get_option('datadir')/'X11'/'xkb'
52 # The X locale directory for compose.
53 XLOCALEDIR = get_option('x-locale-root')
55 XLOCALEDIR = get_option('prefix')/get_option('datadir')/'X11'/'locale'
60 configh_data = configuration_data()
61 configh_data.set('EXIT_INVALID_USAGE', '2')
62 configh_data.set_quoted('LIBXKBCOMMON_VERSION', meson.project_version())
63 configh_data.set_quoted('LIBXKBCOMMON_TOOL_PATH', dir_libexec)
64 # Like AC_USE_SYSTEM_EXTENSIONS, what #define to use to get extensions
65 # beyond the base POSIX function set.
66 if host_machine.system() == 'sunos'
67 system_extensions = '__EXTENSIONS__'
69 system_extensions = '_GNU_SOURCE'
71 configh_data.set(system_extensions, 1)
72 system_ext_define = '#define ' + system_extensions
73 configh_data.set_quoted('DFLT_XKB_CONFIG_ROOT', XKBCONFIGROOT)
74 configh_data.set_quoted('XLOCALEDIR', XLOCALEDIR)
75 configh_data.set_quoted('DEFAULT_XKB_RULES', get_option('default-rules'))
76 configh_data.set_quoted('DEFAULT_XKB_MODEL', get_option('default-model'))
77 configh_data.set_quoted('DEFAULT_XKB_LAYOUT', get_option('default-layout'))
78 if get_option('default-variant') != ''
79 configh_data.set_quoted('DEFAULT_XKB_VARIANT', get_option('default-variant'))
81 configh_data.set('DEFAULT_XKB_VARIANT', 'NULL')
83 if get_option('default-options') != ''
84 configh_data.set_quoted('DEFAULT_XKB_OPTIONS', get_option('default-options'))
86 configh_data.set('DEFAULT_XKB_OPTIONS', 'NULL')
88 if cc.links('int main(){if(__builtin_expect(1<0,0)){}}', name: '__builtin_expect')
89 configh_data.set('HAVE___BUILTIN_EXPECT', 1)
91 if cc.has_header_symbol('unistd.h', 'eaccess', prefix: system_ext_define)
92 configh_data.set('HAVE_EACCESS', 1)
94 if cc.has_header_symbol('unistd.h', 'euidaccess', prefix: system_ext_define)
95 configh_data.set('HAVE_EUIDACCESS', 1)
97 if cc.has_header_symbol('sys/mman.h', 'mmap')
98 configh_data.set('HAVE_MMAP', 1)
100 if cc.has_header_symbol('stdlib.h', 'mkostemp', prefix: system_ext_define)
101 configh_data.set('HAVE_MKOSTEMP', 1)
103 if cc.has_header_symbol('fcntl.h', 'posix_fallocate', prefix: system_ext_define)
104 configh_data.set('HAVE_POSIX_FALLOCATE', 1)
106 if cc.has_header_symbol('string.h', 'strndup', prefix: system_ext_define)
107 configh_data.set('HAVE_STRNDUP', 1)
109 if cc.has_header_symbol('stdio.h', 'asprintf', prefix: system_ext_define)
110 configh_data.set('HAVE_ASPRINTF', 1)
111 elif cc.has_header_symbol('stdio.h', 'vasprintf', prefix: system_ext_define)
112 configh_data.set('HAVE_VASPRINTF', 1)
114 if cc.has_header_symbol('stdlib.h', 'secure_getenv', prefix: system_ext_define)
115 configh_data.set('HAVE_SECURE_GETENV', 1)
116 elif cc.has_header_symbol('stdlib.h', '__secure_getenv', prefix: system_ext_define)
117 configh_data.set('HAVE___SECURE_GETENV', 1)
119 message('C library does not support secure_getenv, using getenv instead')
121 have_getopt_long = cc.has_header_symbol('getopt.h', 'getopt_long',
122 prefix: '#define _GNU_SOURCE')
124 # Silence some security & deprecation warnings on MSVC
125 # for some unix/C functions we use.
126 # https://docs.microsoft.com/en-us/cpp/error-messages/compiler-warnings/compiler-warning-level-3-c4996?view=vs-2019
127 configh_data.set('_CRT_SECURE_NO_WARNINGS', 1)
128 configh_data.set('_CRT_NONSTDC_NO_WARNINGS', 1)
129 configh_data.set('_CRT_NONSTDC_NO_DEPRECATE', 1)
130 # Reduce unnecessary includes on MSVC.
131 configh_data.set('WIN32_LEAN_AND_MEAN', 1)
133 # Supports -Wl,--version-script?
134 have_version_script = cc.links(
136 args: '-Wl,--version-script=' + meson.source_root()/'xkbcommon.map',
137 name: '-Wl,--version-script',
142 # Note: we use some yacc extensions, which work with either GNU bison
143 # (preferred) or byacc (with backtracking enabled).
144 bison = find_program('bison', 'win_bison', required: false)
146 yacc_gen = generator(
148 output: ['@BASENAME@.c', '@BASENAME@.h'],
149 arguments: ['@INPUT@', '--defines=@OUTPUT1@', '--output=@OUTPUT0@', '-p _xkbcommon_'],
152 byacc = find_program('byacc', required: false)
154 yacc_gen = generator(
156 output: ['@BASENAME@.c', '@BASENAME@.h'],
157 arguments: ['@INPUT@', '-H', '@OUTPUT1@', '-o', '@OUTPUT0@', '-p _xkbcommon_'],
160 error('Could not find a compatible YACC program (bison or byacc)')
163 libxkbcommon_sources = [
164 'src/compose/parser.c',
165 'src/compose/parser.h',
166 'src/compose/paths.c',
167 'src/compose/paths.h',
168 'src/compose/state.c',
169 'src/compose/table.c',
170 'src/compose/table.h',
171 'src/xkbcomp/action.c',
172 'src/xkbcomp/action.h',
174 'src/xkbcomp/ast-build.c',
175 'src/xkbcomp/ast-build.h',
176 'src/xkbcomp/compat.c',
177 'src/xkbcomp/expr.c',
178 'src/xkbcomp/expr.h',
179 'src/xkbcomp/include.c',
180 'src/xkbcomp/include.h',
181 'src/xkbcomp/keycodes.c',
182 'src/xkbcomp/keymap.c',
183 'src/xkbcomp/keymap-dump.c',
184 'src/xkbcomp/keywords.c',
185 yacc_gen.process('src/xkbcomp/parser.y'),
186 'src/xkbcomp/parser-priv.h',
187 'src/xkbcomp/rules.c',
188 'src/xkbcomp/rules.h',
189 'src/xkbcomp/scanner.c',
190 'src/xkbcomp/symbols.c',
191 'src/xkbcomp/types.c',
192 'src/xkbcomp/vmod.c',
193 'src/xkbcomp/vmod.h',
194 'src/xkbcomp/xkbcomp.c',
195 'src/xkbcomp/xkbcomp-priv.h',
200 'src/context-priv.c',
209 'src/scanner-utils.h',
218 libxkbcommon_link_args = []
219 if have_version_script
220 libxkbcommon_link_args += '-Wl,--version-script=' + meson.source_root()/'xkbcommon.map'
222 libxkbcommon = library(
224 'xkbcommon/xkbcommon.h',
225 libxkbcommon_sources,
226 link_args: libxkbcommon_link_args,
227 link_depends: 'xkbcommon.map',
230 include_directories: include_directories('src'),
233 'xkbcommon/xkbcommon.h',
234 'xkbcommon/xkbcommon-compat.h',
235 'xkbcommon/xkbcommon-compose.h',
236 'xkbcommon/xkbcommon-keysyms.h',
237 'xkbcommon/xkbcommon-names.h',
240 libxkbcommon_dep = declare_dependency(
241 link_with: libxkbcommon,
246 filebase: 'xkbcommon',
247 version: meson.project_version(),
248 description: 'XKB API common to servers and clients',
253 if get_option('enable-x11')
254 xcb_dep = dependency('xcb', version: '>=1.10', required: false)
255 xcb_xkb_dep = dependency('xcb-xkb', version: '>=1.10', required: false)
256 if not xcb_dep.found() or not xcb_xkb_dep.found()
257 error('''X11 support requires xcb-xkb >= 1.10 which was not found.
258 You can disable X11 support with -Denable-x11=false.''')
261 libxkbcommon_x11_sources = [
265 'src/x11/x11-priv.h',
267 'src/context-priv.c',
273 libxkbcommon_x11_link_args = []
274 if have_version_script
275 libxkbcommon_x11_link_args += '-Wl,--version-script=' + meson.source_root()/'xkbcommon-x11.map'
277 libxkbcommon_x11 = library(
279 'xkbcommon/xkbcommon-x11.h',
280 libxkbcommon_x11_sources,
281 link_args: libxkbcommon_x11_link_args,
282 link_depends: 'xkbcommon-x11.map',
285 include_directories: include_directories('src'),
286 link_with: libxkbcommon,
293 'xkbcommon/xkbcommon-x11.h',
296 libxkbcommon_x11_dep = declare_dependency(
297 link_with: libxkbcommon_x11,
301 name: 'xkbcommon-x11',
302 filebase: 'xkbcommon-x11',
303 version: meson.project_version(),
304 description: 'XKB API common to servers and clients - X11 support',
305 requires: ['xkbcommon'],
306 requires_private: ['xcb>=1.10', 'xcb-xkb>=1.10'],
311 if get_option('enable-xkbregistry')
312 dep_libxml = dependency('libxml-2.0')
313 deps_libxkbregistry = [dep_libxml]
314 libxkbregistry_sources = [
321 libxkbregistry_link_args = []
322 if have_version_script
323 libxkbregistry_link_args += '-Wl,--version-script=' + meson.source_root()/'xkbregistry.map'
325 libxkbregistry = library(
327 'xkbcommon/xkbregistry.h',
328 libxkbregistry_sources,
329 link_args: libxkbregistry_link_args,
330 link_depends: 'xkbregistry.map',
331 dependencies: deps_libxkbregistry,
334 include_directories: include_directories('src'),
337 'xkbcommon/xkbregistry.h',
343 filebase: 'xkbregistry',
344 version: meson.project_version(),
345 description: 'XKB API to query available rules, models, layouts, variants and options',
348 dep_libxkbregistry = declare_dependency(
349 include_directories: include_directories('xkbcommon'),
350 link_with: libxkbregistry
355 test_env = environment()
356 test_env.set('XKB_LOG_LEVEL', 'debug')
357 test_env.set('XKB_LOG_VERBOSITY', '10')
358 test_env.set('top_srcdir', meson.source_root())
359 test_env.set('top_builddir', meson.build_root())
361 test_configh_data = configuration_data()
362 test_configh_data.set_quoted('TEST_XKB_CONFIG_ROOT', meson.source_root()/'test'/'data')
363 configure_file(output: 'test-config.h', configuration: test_configh_data)
365 # Some tests need to use unexported symbols, so we link them against
366 # an internal copy of libxkbcommon with all symbols exposed.
367 libxkbcommon_test_internal = static_library(
368 'xkbcommon-test-internal',
371 'test/evdev-scancodes.h',
372 libxkbcommon_sources,
373 include_directories: include_directories('src'),
375 test_dep = declare_dependency(
376 include_directories: include_directories('src'),
377 link_with: libxkbcommon_test_internal,
379 if get_option('enable-x11')
380 libxkbcommon_x11_internal = static_library(
381 'xkbcommon-x11-internal',
382 libxkbcommon_x11_sources,
383 include_directories: include_directories('src'),
384 link_with: libxkbcommon_test_internal,
390 x11_test_dep = declare_dependency(
391 link_with: libxkbcommon_x11_internal,
401 executable('test-keysym', 'test/keysym.c', dependencies: test_dep),
406 executable('test-keymap', 'test/keymap.c', dependencies: test_dep),
411 executable('test-filecomp', 'test/filecomp.c', dependencies: test_dep),
414 # TODO: This test currently uses some functions that don't exist on Windows.
415 if cc.get_id() != 'msvc'
418 executable('test-context', 'test/context.c', dependencies: test_dep),
424 executable('test-rules-file', 'test/rules-file.c', dependencies: test_dep),
428 'rules-file-includes',
429 executable('test-rules-file-includes', 'test/rules-file-includes.c', dependencies: test_dep),
434 executable('test-stringcomp', 'test/stringcomp.c', dependencies: test_dep),
439 executable('test-buffercomp', 'test/buffercomp.c', dependencies: test_dep),
444 executable('test-log', 'test/log.c', dependencies: test_dep),
449 executable('test-atom', 'test/atom.c', dependencies: test_dep),
454 executable('test-utf8', 'test/utf8.c', dependencies: test_dep),
459 executable('test-state', 'test/state.c', dependencies: test_dep),
464 executable('test-keyseq', 'test/keyseq.c', dependencies: test_dep),
469 executable('test-rulescomp', 'test/rulescomp.c', dependencies: test_dep),
474 executable('test-compose', 'test/compose.c', dependencies: test_dep),
479 executable('test-utils', 'test/utils.c', dependencies: test_dep),
484 find_program('test/symbols-leak-test.py'),
486 suite: ['python-tests'],
488 if get_option('enable-x11')
491 executable('test-x11', 'test/x11.c', dependencies: x11_test_dep),
494 # test/x11comp is meant to be run, but it is (temporarily?) disabled.
495 # See: https://github.com/xkbcommon/libxkbcommon/issues/30
496 executable('test-x11comp', 'test/x11comp.c', dependencies: x11_test_dep)
498 if get_option('enable-xkbregistry')
501 executable('test-registry', 'test/registry.c',
502 include_directories: include_directories('src'),
503 dependencies: dep_libxkbregistry),
508 valgrind = find_program('valgrind', required: false)
510 add_test_setup('valgrind',
511 exe_wrapper: [valgrind,
513 '--track-origins=yes',
514 '--gen-suppressions=all',
515 '--error-exitcode=99'],
516 timeout_multiplier : 10)
518 message('valgrind not found, disabling valgrind test setup')
522 # Fuzzing target programs.
523 executable('fuzz-keymap', 'fuzz/keymap/target.c', dependencies: test_dep)
524 executable('fuzz-compose', 'fuzz/compose/target.c', dependencies: test_dep)
529 build_tools = have_getopt_long
531 libxkbcommon_tools_internal = static_library(
533 'tools/tools-common.h',
534 'tools/tools-common.c',
535 dependencies: libxkbcommon_dep,
537 tools_dep = declare_dependency(
538 include_directories: [include_directories('tools')],
539 link_with: libxkbcommon_tools_internal,
542 executable('xkbcli', 'tools/xkbcli.c',
543 dependencies: tools_dep, install: true)
544 install_man('tools/xkbcli.1')
546 executable('xkbcli-compile-keymap',
547 'tools/compile-keymap.c',
548 dependencies: tools_dep,
550 install_dir: dir_libexec)
551 install_man('tools/xkbcli-compile-keymap.1')
552 # The same tool again, but with access to some private APIs.
553 executable('compile-keymap',
554 'tools/compile-keymap.c',
555 libxkbcommon_sources,
556 dependencies: [tools_dep],
557 c_args: ['-DENABLE_PRIVATE_APIS'],
558 include_directories: [include_directories('src')],
560 configh_data.set10('HAVE_XKBCLI_COMPILE_KEYMAP', true)
561 executable('xkbcli-how-to-type',
562 'tools/how-to-type.c',
563 dependencies: tools_dep,
565 install_dir: dir_libexec)
566 install_man('tools/xkbcli-how-to-type.1')
567 configh_data.set10('HAVE_XKBCLI_HOW_TO_TYPE', true)
568 if cc.has_header('linux/input.h')
569 executable('xkbcli-interactive-evdev',
570 'tools/interactive-evdev.c',
571 dependencies: tools_dep,
573 install_dir: dir_libexec)
574 configh_data.set10('HAVE_XKBCLI_INTERACTIVE_EVDEV', true)
575 install_man('tools/xkbcli-interactive-evdev.1')
577 if get_option('enable-x11')
578 x11_tools_dep = declare_dependency(
579 link_with: libxkbcommon_x11,
586 executable('xkbcli-interactive-x11',
587 'tools/interactive-x11.c',
588 dependencies: x11_tools_dep,
590 install_dir: dir_libexec)
591 install_man('tools/xkbcli-interactive-x11.1')
592 configh_data.set10('HAVE_XKBCLI_INTERACTIVE_X11', true)
594 if get_option('enable-wayland')
595 wayland_client_dep = dependency('wayland-client', version: '>=1.2.0', required: false)
596 wayland_protocols_dep = dependency('wayland-protocols', version: '>=1.12', required: false)
597 wayland_scanner_dep = dependency('wayland-scanner', required: false, native: true)
598 if not wayland_client_dep.found() or not wayland_protocols_dep.found() or not wayland_scanner_dep.found()
599 error('''The Wayland xkbcli programs require wayland-client >= 1.2.0, wayland-protocols >= 1.7 which were not found.
600 You can disable the Wayland xkbcli programs with -Denable-wayland=false.''')
603 wayland_scanner = find_program(wayland_scanner_dep.get_pkgconfig_variable('wayland_scanner'))
604 wayland_scanner_code_gen = generator(
606 output: '@BASENAME@-protocol.c',
607 arguments: ['code', '@INPUT@', '@OUTPUT@'],
609 wayland_scanner_client_header_gen = generator(
611 output: '@BASENAME@-client-protocol.h',
612 arguments: ['client-header', '@INPUT@', '@OUTPUT@'],
614 wayland_protocols_datadir = wayland_protocols_dep.get_pkgconfig_variable('pkgdatadir')
615 xdg_shell_xml = wayland_protocols_datadir/'stable/xdg-shell/xdg-shell.xml'
616 xdg_shell_sources = [
617 wayland_scanner_code_gen.process(xdg_shell_xml),
618 wayland_scanner_client_header_gen.process(xdg_shell_xml),
620 executable('xkbcli-interactive-wayland',
621 'tools/interactive-wayland.c',
623 dependencies: [tools_dep, wayland_client_dep],
625 install_dir: dir_libexec)
626 install_man('tools/xkbcli-interactive-wayland.1')
627 configh_data.set10('HAVE_XKBCLI_INTERACTIVE_WAYLAND', true)
630 if get_option('enable-xkbregistry')
631 configh_data.set10('HAVE_XKBCLI_LIST', true)
632 executable('xkbcli-list',
633 'tools/registry-list.c',
634 dependencies: dep_libxkbregistry,
636 install_dir: dir_libexec)
637 install_man('tools/xkbcli-list.1')
640 # pytest finds files named test_foo_bar.py but not
641 # test-foo-bar.py, let's rename the source file so it only ever finds the
643 config_tool_option_test = configuration_data()
644 config_tool_option_test.set('MESON_BUILD_ROOT', meson.current_build_dir())
645 tool_option_test = configure_file(input: 'tools/test-tool-option-parsing.py',
646 output: 'test_tool_option_parsing.py',
647 configuration : config_tool_option_test)
648 test('tool-option-parsing',
650 args: [tool_option_test, '-n', 'auto'])
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)