Reference manual

This is the root page of the online Meson reference manual. This manual is also available in a more machine readable format as a JSON documented attached to every release since 0.60.0. See our IDE integration documentation for more information.

All functions and methods are documented in detail in the following subpages:

Elementary types

• any
• bool
  • bool.to_int()
  • bool.to_string()
• dict
  • dict.get()
  • dict.has_key()
  • dict.keys()
• int
  • int.is_even()
  • int.is_odd()
  • int.to_string()
• list
  • list.contains()
  • list.get()
  • list.length()
• str
  • str.contains()
  • str.endswith()
  • str.format()
  • str.join()
  • str.replace()
  • str.split()
  • str.splitlines()
  • str.startswith()
  • str.strip()
  • str.substring()
  • str.to_int()
  • str.to_lower()
  • str.to_upper()
  • str.underscorify()
  • str.version_compare()
• void

Functions

The following functions are available in build files. Click on each to see the description and usage. The objects returned by them are listed here.

• add_global_arguments()
• add_global_link_arguments()
• add_languages()
• add_project_arguments()
• add_project_dependencies()
• add_project_link_arguments()
• add_test_setup()
• alias_target()
• assert()
• benchmark()
• both_libraries()
• build_target()
• configuration_data()
• configure_file()
• custom_target()
• debug()
• declare_dependency()
• dependency()
• disabler()
• environment()
• error()
• executable()
• files()
• find_program()
• generator()
• get_option()
• get_variable()
• import()
• include_directories()
• install_data()
• install_emptydir()
• install_headers()
• install_man()
• install_subdir()
• install_symlink()
• is_disabler()
• is_variable()
• jar()
• join_paths()
• library()
• message()
• project()
• range()
• run_command()
• run_target()
• set_variable()
• shared_library()
• shared_module()
• static_library()
• structured_sources()
• subdir()
• subdir_done()
• subproject()
• summary()
• test()
• unset_variable()
• vcs_tag()
• warning()

Builtin objects

These are built-in objects that are always available.

• build_machine
  • build_machine.cpu()
  • build_machine.cpu_family()
  • build_machine.endian()
  • build_machine.kernel()
  • build_machine.subsystem()
  • build_machine.system()
• host_machine
• meson
  • meson.add_devenv()
  • meson.add_dist_script()
  • meson.add_install_script()
  • meson.add_postconf_script()
  • meson.backend()
  • meson.build_options()
  • meson.build_root()
  • meson.can_run_host_binaries()
  • meson.current_build_dir()
  • meson.current_source_dir()
  • meson.get_compiler()
  • meson.get_cross_property()
  • meson.get_external_property()
  • meson.global_build_root()
  • meson.global_source_root()
  • meson.has_exe_wrapper()
  • meson.has_external_property()
  • meson.install_dependency_manifest()
  • meson.is_cross_build()
  • meson.is_subproject()
  • meson.is_unity()
  • meson.override_dependency()
  • meson.override_find_program()
  • meson.project_build_root()
  • meson.project_license()
  • meson.project_license_files()
  • meson.project_name()
  • meson.project_source_root()
  • meson.project_version()
  • meson.source_root()
  • meson.version()
• target_machine

Returned objects

These are objects that can be returned by functions or other methods.

• alias_tgt
• both_libs
  • both_libs.get_shared_lib()
  • both_libs.get_static_lib()
• build_tgt
  • build_tgt.extract_all_objects()
  • build_tgt.extract_objects()
  • build_tgt.found()
  • build_tgt.full_path()
  • build_tgt.name()
  • build_tgt.path()
  • build_tgt.private_dir_include()
• cfg_data
  • cfg_data.get()
  • cfg_data.get_unquoted()
  • cfg_data.has()
  • cfg_data.keys()
  • cfg_data.merge_from()
  • cfg_data.set()
  • cfg_data.set10()
  • cfg_data.set_quoted()
• compiler
  • compiler.alignment()
  • compiler.check_header()
  • compiler.cmd_array()
  • compiler.compiles()
  • compiler.compute_int()
  • compiler.find_library()
  • compiler.first_supported_argument()
  • compiler.first_supported_link_argument()
  • compiler.get_argument_syntax()
  • compiler.get_define()
  • compiler.get_id()
  • compiler.get_linker_id()
  • compiler.get_supported_arguments()
  • compiler.get_supported_function_attributes()
  • compiler.get_supported_link_arguments()
  • compiler.has_argument()
  • compiler.has_define()
  • compiler.has_function()
  • compiler.has_function_attribute()
  • compiler.has_header()
  • compiler.has_header_symbol()
  • compiler.has_link_argument()
  • compiler.has_member()
  • compiler.has_members()
  • compiler.has_multi_arguments()
  • compiler.has_multi_link_arguments()
  • compiler.has_type()
  • compiler.links()
  • compiler.preprocess()
  • compiler.run()
  • compiler.sizeof()
  • compiler.symbols_have_underscore_prefix()
  • compiler.version()
• custom_idx
  • custom_idx.full_path()
• custom_tgt
  • [[custom_tgt.[index]]]
  • custom_tgt.full_path()
  • custom_tgt.to_list()
• dep
  • dep.as_link_whole()
  • dep.as_shared()
  • dep.as_static()
  • dep.as_system()
  • dep.found()
  • dep.get_configtool_variable()
  • dep.get_pkgconfig_variable()
  • dep.get_variable()
  • dep.include_type()
  • dep.name()
  • dep.partial_dependency()
  • dep.type_name()
  • dep.version()
• disabler
  • disabler.found()
• env
  • env.append()
  • env.prepend()
  • env.set()
  • env.unset()
• exe
• external_program
  • external_program.found()
  • external_program.full_path()
  • external_program.path()
  • external_program.version()
• extracted_obj
• feature
  • feature.allowed()
  • feature.auto()
  • feature.disable_auto_if()
  • feature.disable_if()
  • feature.disabled()
  • feature.enable_auto_if()
  • feature.enable_if()
  • feature.enabled()
  • feature.require()
• file
  • file.full_path()
• generated_list
• generator
  • generator.process()
• inc
• jar
• lib
• module
  • module.found()
• range
• run_tgt
• runresult
  • runresult.compiled()
  • runresult.returncode()
  • runresult.stderr()
  • runresult.stdout()
• structured_src
• subproject
  • subproject.found()
  • subproject.get_variable()
• tgt