meson-reference(3) Library Functions Manual meson-reference(3) NAME meson-reference 1.7.99 - a reference for meson functions and objects DESCRIPTION This manual is divided into three sections, KERNEL FUNCTIONS, OBJECT METH- ODS, and MODULE FUNCTIONS. KERNEL FUNCTIONS contains all builtin meson functions and methods. Methods and module functions are denoted by [object / module name].[methodname]. KERNEL FUNCTIONS add_global_arguments() SYNOPSIS add_global_arguments( glob[str], language listify[str]:, native bool:, ) POSARGS 0 glob[str] KWARGS language listify[str] native bool add_global_link_arguments() SYNOPSIS add_global_link_arguments( glob[str], language listify[str]:, native bool:, ) POSARGS 0 glob[str] KWARGS language listify[str] native bool add_languages() SYNOPSIS add_languages( glob[str], native bool:, required bool|feature:, toolchain compiler:, ) -> bool POSARGS 0 glob[str] KWARGS native bool required bool|feature toolchain compiler Instead of detecting a toolchain, use the compiler toolchain for this language. add_project_arguments() SYNOPSIS add_project_arguments( glob[str], language listify[str]:, native bool:, ) POSARGS 0 glob[str] KWARGS language listify[str] native bool add_project_dependencies() SYNOPSIS add_project_dependencies( glob[dep], language listify[str]:, native bool:, ) POSARGS 0 glob[dep] KWARGS language listify[str] native bool add_project_link_arguments() SYNOPSIS add_project_link_arguments( glob[str], language listify[str]:, native bool:, ) POSARGS 0 glob[str] KWARGS language listify[str] native bool add_test_setup() SYNOPSIS add_test_setup( str, env dict|env|list|str:, exclude_suites listify[str]:, exe_wrapper listify[exe]:, gdb bool:, is_default bool:, timeout_multiplier int:, ) POSARGS 0 str KWARGS env dict|env|list|str exclude_suites listify[str] exe_wrapper listify[exe] gdb bool is_default bool timeout_multiplier int alias_target() SYNOPSIS alias_target( str, glob[alias_tgt|both_libs|build_tgt|custom_tgt], ) -> alias_tgt POSARGS 0 str 1 glob[alias_tgt|both_libs|build_tgt|custom_tgt] assert() SYNOPSIS assert( bool, str, ) POSARGS 0 bool 1 str benchmark() SYNOPSIS benchmark( str, build_tgt|custom_tgt|external_program|file|python_installation, args listify[exe]:, depends listify[both_libs|build_tgt|custom_tgt|file]:, env dict|env|list|str:, priority int:, protocol str:, should_fail bool:, suite listify[str]:, timeout int:, workdir str:, ) POSARGS 0 str 1 build_tgt|custom_tgt|external_program|file|python_installation KWARGS args listify[exe] depends listify[both_libs|build_tgt|custom_tgt|file] env dict|env|list|str priority int protocol str should_fail bool suite listify[str] timeout int workdir str both_libraries() SYNOPSIS both_libraries( glob[both_libs|build_tgt|custom_tgt|file|generated_list|str], <lang>_args listify[str]:, <lang>_pch build_tgt|file|list|str:, <lang>_shared_args listify[str]:, <lang>_static_args listify[str]:, build_by_default bool:, build_rpath str:, darwin_versions listify[int|str]:, dependencies listify[dep]:, export_dynamic bool:, extra_files listify[both_libs|build_tgt|custom_tgt|file|str]:, gnu_symbol_visibility str:, gui_app bool:, implib bool|str:, implicit_include_directories bool:, include_directories listify[inc|str]:, install bool:, install_dir str:, install_mode listify[bool|int|str]:, install_rpath str:, install_tag str:, link_args listify[str]:, link_depends listify[build_tgt|custom_tgt|file|str]:, link_language str:, link_whole listify[both_libs|build_tgt|custom_tgt|file]:, link_with listify[both_libs|build_tgt|custom_tgt|file]:, name_prefix list|str:, name_suffix list|str:, native bool:, objects listify[file|str]:, override_options dict[bool|int|list|str]|list[str]|str:, pic bool:, pie bool:, sources listify[both_libs|build_tgt|custom_tgt|file|gener- ated_list|str]:, soversion int|str:, target_type str:, version str:, vs_module_defs custom_tgt|file|str:, win_subsystem str:, ) -> both_libs POSARGS 0 glob[both_libs|build_tgt|custom_tgt|file|generated_list|str] The name for this build target, followed by an optional list of sources. KWARGS <lang>_args listify[str] <lang>_pch build_tgt|file|list|str <lang>_shared_args listify[str] <lang>_static_args listify[str] build_by_default bool build_rpath str darwin_versions listify[int|str] dependencies listify[dep] export_dynamic bool extra_files listify[both_libs|build_tgt|custom_tgt|file|str] gnu_symbol_visibility str gui_app bool implib bool|str implicit_include_directories bool include_directories listify[inc|str] install bool install_dir str install_mode listify[bool|int|str] install_rpath str install_tag str link_args listify[str] link_depends listify[build_tgt|custom_tgt|file|str] link_language str link_whole listify[both_libs|build_tgt|custom_tgt|file] link_with listify[both_libs|build_tgt|custom_tgt|file] name_prefix list|str name_suffix list|str native bool objects listify[file|str] override_options dict[bool|int|list|str]|list[str]|str pic bool pie bool sources listify[both_libs|build_tgt|custom_tgt|file|generated_list|str] soversion int|str target_type str version str vs_module_defs custom_tgt|file|str win_subsystem str build_target() SYNOPSIS build_target( glob[both_libs|build_tgt|custom_tgt|file|generated_list|str], <lang>_args listify[str]:, <lang>_pch build_tgt|file|list|str:, <lang>_shared_args listify[str]:, <lang>_static_args listify[str]:, build_by_default bool:, build_rpath str:, darwin_versions listify[int|str]:, dependencies listify[dep]:, export_dynamic bool:, extra_files listify[both_libs|build_tgt|custom_tgt|file|str]:, gnu_symbol_visibility str:, gui_app bool:, implib bool|str:, implicit_include_directories bool:, include_directories listify[inc|str]:, install bool:, install_dir str:, install_mode listify[bool|int|str]:, install_rpath str:, install_tag str:, link_args listify[str]:, link_depends listify[build_tgt|custom_tgt|file|str]:, link_language str:, link_whole listify[both_libs|build_tgt|custom_tgt|file]:, link_with listify[both_libs|build_tgt|custom_tgt|file]:, name_prefix list|str:, name_suffix list|str:, native bool:, objects listify[file|str]:, override_options dict[bool|int|list|str]|list[str]|str:, pic bool:, pie bool:, sources listify[both_libs|build_tgt|custom_tgt|file|gener- ated_list|str]:, soversion int|str:, target_type str:, version str:, vs_module_defs custom_tgt|file|str:, win_subsystem str:, ) -> both_libs|build_tgt POSARGS 0 glob[both_libs|build_tgt|custom_tgt|file|generated_list|str] The name for this build target, followed by an optional list of sources. KWARGS <lang>_args listify[str] <lang>_pch build_tgt|file|list|str <lang>_shared_args listify[str] <lang>_static_args listify[str] build_by_default bool build_rpath str darwin_versions listify[int|str] dependencies listify[dep] export_dynamic bool extra_files listify[both_libs|build_tgt|custom_tgt|file|str] gnu_symbol_visibility str gui_app bool implib bool|str implicit_include_directories bool include_directories listify[inc|str] install bool install_dir str install_mode listify[bool|int|str] install_rpath str install_tag str link_args listify[str] link_depends listify[build_tgt|custom_tgt|file|str] link_language str link_whole listify[both_libs|build_tgt|custom_tgt|file] link_with listify[both_libs|build_tgt|custom_tgt|file] name_prefix list|str name_suffix list|str native bool objects listify[file|str] override_options dict[bool|int|list|str]|list[str]|str pic bool pie bool sources listify[both_libs|build_tgt|custom_tgt|file|generated_list|str] soversion int|str target_type str version str vs_module_defs custom_tgt|file|str win_subsystem str configuration_data() SYNOPSIS configuration_data( dict, ) -> cfg_data POSARGS 0 dict configure_file() SYNOPSIS configure_file( capture bool:, command list:, configuration cfg_data|dict:, copy bool:, depfile str:, encoding str:, format str:, input listify[both_libs|build_tgt|custom_tgt|file|str]:, install bool:, install_dir str:, install_mode listify[bool|int|str]:, install_tag str:, macro_name str:, output str:, output_format str:, ) -> file KWARGS capture bool command list configuration cfg_data|dict copy bool depfile str encoding str format str input listify[both_libs|build_tgt|custom_tgt|file|str] install bool install_dir str install_mode listify[bool|int|str] install_tag str macro_name str output str output_format str custom_target() SYNOPSIS custom_target( str, build_always bool:, build_always_stale bool:, build_by_default bool:, capture bool:, command listify[exe]:, console bool:, depend_files listify[file|str]:, depends listify[both_libs|build_tgt|custom_tgt|file]:, depfile str:, env dict|env|list|str:, feed bool:, input listify[both_libs|build_tgt|custom_tgt|file|gener- ated_list|str]:, install bool:, install_dir listify[bool|str]:, install_mode listify[bool|int|str]:, install_tag str:, output listify[str]:, ) -> custom_tgt POSARGS 0 str KWARGS build_always bool build_always_stale bool build_by_default bool capture bool command listify[exe] console bool depend_files listify[file|str] depends listify[both_libs|build_tgt|custom_tgt|file] depfile str env dict|env|list|str feed bool input listify[both_libs|build_tgt|custom_tgt|file|generated_list|str] install bool install_dir listify[bool|str] install_mode listify[bool|int|str] install_tag str output listify[str] debug() SYNOPSIS debug( glob[bool|dict|feature|file|int|list|str], ) POSARGS 0 glob[bool|dict|feature|file|int|list|str] declare_dependency() SYNOPSIS declare_dependency( compile_args listify[str]:, dependencies listify[dep]:, extra_files listify[both_libs|build_tgt|custom_tgt|file|str]:, include_directories listify[inc|str]:, link_args listify[str]:, link_whole listify[both_libs|build_tgt|custom_tgt|file]:, link_with listify[both_libs|build_tgt|custom_tgt|file]:, link_with_raw listify[str]:, objects listify[file|str]:, sources listify[both_libs|build_tgt|custom_tgt|file|gener- ated_list|str]:, variables dict|list|str:, version str:, ) -> dep KWARGS compile_args listify[str] dependencies listify[dep] extra_files listify[both_libs|build_tgt|custom_tgt|file|str] include_directories listify[inc|str] link_args listify[str] link_whole listify[both_libs|build_tgt|custom_tgt|file] link_with listify[both_libs|build_tgt|custom_tgt|file] link_with_raw listify[str] objects listify[file|str] sources listify[both_libs|build_tgt|custom_tgt|file|generated_list|str] variables dict|list|str version str dependency() SYNOPSIS dependency( glob[str], allow_fallback bool:, components listify[str]:, default_options dict[bool|int|list|str]|list[str]|str:, disabler bool:, fallback listify[str]:, include_type str:, language str:, main bool:, method str:, modules listify[str]:, native bool:, not_found_message str:, optional_modules listify[str]:, required bool|feature:, static bool:, version listify[str]:, ) -> dep POSARGS 0 glob[str] KWARGS allow_fallback bool components listify[str] Ignored default_options dict[bool|int|list|str]|list[str]|str disabler bool fallback listify[str] include_type str language str Ignored main bool Ignored method str modules listify[str] A list of sub-dependencies for this dependency. Only supported by certain dependencies. native bool not_found_message str optional_modules listify[str] Ignored required bool|feature static bool version listify[str] disabler() SYNOPSIS disabler( ) -> disabler environment() SYNOPSIS environment( dict[str]|list[str]|str, method str:, separator str:, ) -> env POSARGS 0 dict[str]|list[str]|str KWARGS method str separator str error() SYNOPSIS error( glob[bool|dict|feature|file|int|list|str], ) POSARGS 0 glob[bool|dict|feature|file|int|list|str] executable() SYNOPSIS executable( glob[both_libs|build_tgt|custom_tgt|file|generated_list|str], <lang>_args listify[str]:, <lang>_pch build_tgt|file|list|str:, <lang>_shared_args listify[str]:, <lang>_static_args listify[str]:, build_by_default bool:, build_rpath str:, darwin_versions listify[int|str]:, dependencies listify[dep]:, export_dynamic bool:, extra_files listify[both_libs|build_tgt|custom_tgt|file|str]:, gnu_symbol_visibility str:, gui_app bool:, implib bool|str:, implicit_include_directories bool:, include_directories listify[inc|str]:, install bool:, install_dir str:, install_mode listify[bool|int|str]:, install_rpath str:, install_tag str:, link_args listify[str]:, link_depends listify[build_tgt|custom_tgt|file|str]:, link_language str:, link_whole listify[both_libs|build_tgt|custom_tgt|file]:, link_with listify[both_libs|build_tgt|custom_tgt|file]:, name_prefix list|str:, name_suffix list|str:, native bool:, objects listify[file|str]:, override_options dict[bool|int|list|str]|list[str]|str:, pic bool:, pie bool:, sources listify[both_libs|build_tgt|custom_tgt|file|gener- ated_list|str]:, soversion int|str:, target_type str:, version str:, vs_module_defs custom_tgt|file|str:, win_subsystem str:, ) -> build_tgt POSARGS 0 glob[both_libs|build_tgt|custom_tgt|file|generated_list|str] The name for this build target, followed by an optional list of sources. KWARGS <lang>_args listify[str] <lang>_pch build_tgt|file|list|str <lang>_shared_args listify[str] <lang>_static_args listify[str] build_by_default bool build_rpath str darwin_versions listify[int|str] dependencies listify[dep] export_dynamic bool extra_files listify[both_libs|build_tgt|custom_tgt|file|str] gnu_symbol_visibility str gui_app bool implib bool|str implicit_include_directories bool include_directories listify[inc|str] install bool install_dir str install_mode listify[bool|int|str] install_rpath str install_tag str link_args listify[str] link_depends listify[build_tgt|custom_tgt|file|str] link_language str link_whole listify[both_libs|build_tgt|custom_tgt|file] link_with listify[both_libs|build_tgt|custom_tgt|file] name_prefix list|str name_suffix list|str native bool objects listify[file|str] override_options dict[bool|int|list|str]|list[str]|str pic bool pie bool sources listify[both_libs|build_tgt|custom_tgt|file|generated_list|str] soversion int|str target_type str version str vs_module_defs custom_tgt|file|str win_subsystem str files() SYNOPSIS files( glob[str], ) -> list POSARGS 0 glob[str] find_program() SYNOPSIS find_program( glob[file|str], default_options dict[bool|int|list|str]|list[str]|str:, dirs listify[str]:, disabler bool:, native bool:, required bool|feature:, version listify[str]:, version_argument str:, ) -> external_program POSARGS 0 glob[file|str] KWARGS default_options dict[bool|int|list|str]|list[str]|str dirs listify[str] disabler bool native bool required bool|feature version listify[str] version_argument str generator() SYNOPSIS generator( exe, arguments list:, capture bool:, depends listify[both_libs|build_tgt|custom_tgt|file]:, depfile str:, output listify[str]:, ) -> generator POSARGS 0 exe KWARGS arguments list capture bool depends listify[both_libs|build_tgt|custom_tgt|file] depfile str output listify[str] get_option() SYNOPSIS get_option( str, ) -> bool|feature|int|list|str POSARGS 0 str get_variable() SYNOPSIS get_variable( any, any, ) -> any POSARGS 0 any 1 any import() SYNOPSIS import( str, disabler bool:, required bool|feature:, ) -> module POSARGS 0 str KWARGS disabler bool required bool|feature include_directories() SYNOPSIS include_directories( glob[inc|str], is_system bool:, ) -> list POSARGS 0 glob[inc|str] KWARGS is_system bool install_data() SYNOPSIS install_data( glob[file|str], follow_symlinks bool:, install_dir str:, install_mode listify[bool|int|str]:, install_tag str:, preserve_path bool:, rename listify[str]:, sources listify[file|str]:, ) POSARGS 0 glob[file|str] KWARGS follow_symlinks bool install_dir str install_mode listify[bool|int|str] install_tag str preserve_path bool rename listify[str] sources listify[file|str] install_emptydir() SYNOPSIS install_emptydir( glob[str], install_mode listify[bool|int|str]:, install_tag str:, ) POSARGS 0 glob[str] KWARGS install_mode listify[bool|int|str] install_tag str install_headers() SYNOPSIS install_headers( glob[file|str], follow_symlinks bool:, install_dir str:, install_mode listify[bool|int|str]:, preserve_path bool:, subdir str:, ) POSARGS 0 glob[file|str] KWARGS follow_symlinks bool install_dir str install_mode listify[bool|int|str] preserve_path bool subdir str install_man() SYNOPSIS install_man( glob[both_libs|build_tgt|custom_tgt|file|str], install_dir str:, install_mode listify[bool|int|str]:, locale str:, ) POSARGS 0 glob[both_libs|build_tgt|custom_tgt|file|str] KWARGS install_dir str install_mode listify[bool|int|str] locale str install_subdir() SYNOPSIS install_subdir( str, exclude_directories listify[str]:, exclude_files listify[str]:, follow_symlinks bool:, install_dir str:, install_mode listify[bool|int|str]:, install_tag str:, strip_directory bool:, ) POSARGS 0 str KWARGS exclude_directories listify[str] exclude_files listify[str] follow_symlinks bool install_dir str install_mode listify[bool|int|str] install_tag str strip_directory bool install_symlink() SYNOPSIS install_symlink( str, install_dir str:, install_tag str:, pointing_to str:, ) POSARGS 0 str KWARGS install_dir str install_tag str pointing_to str is_disabler() SYNOPSIS is_disabler( any, ) -> bool POSARGS 0 any is_null() SYNOPSIS is_null( any, ) -> bool POSARGS 0 any is_variable() SYNOPSIS is_variable( str, ) -> bool POSARGS 0 str join_paths() SYNOPSIS join_paths( glob[str], ) -> str POSARGS 0 glob[str] library() SYNOPSIS library( glob[both_libs|build_tgt|custom_tgt|file|generated_list|str], <lang>_args listify[str]:, <lang>_pch build_tgt|file|list|str:, <lang>_shared_args listify[str]:, <lang>_static_args listify[str]:, build_by_default bool:, build_rpath str:, darwin_versions listify[int|str]:, dependencies listify[dep]:, export_dynamic bool:, extra_files listify[both_libs|build_tgt|custom_tgt|file|str]:, gnu_symbol_visibility str:, gui_app bool:, implib bool|str:, implicit_include_directories bool:, include_directories listify[inc|str]:, install bool:, install_dir str:, install_mode listify[bool|int|str]:, install_rpath str:, install_tag str:, link_args listify[str]:, link_depends listify[build_tgt|custom_tgt|file|str]:, link_language str:, link_whole listify[both_libs|build_tgt|custom_tgt|file]:, link_with listify[both_libs|build_tgt|custom_tgt|file]:, name_prefix list|str:, name_suffix list|str:, native bool:, objects listify[file|str]:, override_options dict[bool|int|list|str]|list[str]|str:, pic bool:, pie bool:, sources listify[both_libs|build_tgt|custom_tgt|file|gener- ated_list|str]:, soversion int|str:, target_type str:, version str:, vs_module_defs custom_tgt|file|str:, win_subsystem str:, ) -> both_libs|build_tgt POSARGS 0 glob[both_libs|build_tgt|custom_tgt|file|generated_list|str] The name for this build target, followed by an optional list of sources. KWARGS <lang>_args listify[str] <lang>_pch build_tgt|file|list|str <lang>_shared_args listify[str] <lang>_static_args listify[str] build_by_default bool build_rpath str darwin_versions listify[int|str] dependencies listify[dep] export_dynamic bool extra_files listify[both_libs|build_tgt|custom_tgt|file|str] gnu_symbol_visibility str gui_app bool implib bool|str implicit_include_directories bool include_directories listify[inc|str] install bool install_dir str install_mode listify[bool|int|str] install_rpath str install_tag str link_args listify[str] link_depends listify[build_tgt|custom_tgt|file|str] link_language str link_whole listify[both_libs|build_tgt|custom_tgt|file] link_with listify[both_libs|build_tgt|custom_tgt|file] name_prefix list|str name_suffix list|str native bool objects listify[file|str] override_options dict[bool|int|list|str]|list[str]|str pic bool pie bool sources listify[both_libs|build_tgt|custom_tgt|file|generated_list|str] soversion int|str target_type str version str vs_module_defs custom_tgt|file|str win_subsystem str message() SYNOPSIS message( glob[bool|dict|feature|file|int|list|str], ) POSARGS 0 glob[bool|dict|feature|file|int|list|str] option() SYNOPSIS option( str, choices list:, deprecated bool|str|dict[str]|list[str]:, description str:, max int:, min int:, type str:, value any:, yield bool:, ) POSARGS 0 str KWARGS choices list deprecated bool|str|dict[str]|list[str] description str max int min int type str value any yield bool p() SYNOPSIS p( any, inspect bool:, pretty bool:, ) -> any POSARGS 0 any KWARGS inspect bool pretty bool print() SYNOPSIS print( str, ) -> any POSARGS 0 str project() SYNOPSIS project( str, glob[str], default_options dict[bool|int|list|str]|list[str]|str:, license listify[str]:, license_files listify[str]:, meson_version str:, module_dir str:, subproject_dir str:, version file|str:, ) POSARGS 0 str 1 glob[str] KWARGS default_options dict[bool|int|list|str]|list[str]|str license listify[str] license_files listify[str] meson_version str module_dir str Specify a directory to search for .meson files in when import()-ing modules subproject_dir str version file|str range() SYNOPSIS range( int, int, int, ) -> list POSARGS 0 int 1 int 2 int run_command() SYNOPSIS run_command( glob[compiler|external_program|file|python_installation|str], capture bool:, check bool:, env dict|env|list|str:, feed both_libs|build_tgt|custom_tgt|file|str:, ) -> runresult POSARGS 0 glob[compiler|external_program|file|python_installation|str] KWARGS capture bool check bool env dict|env|list|str feed both_libs|build_tgt|custom_tgt|file|str Specify a file to be used for stdin run_target() SYNOPSIS run_target( str, command listify[exe]:, depends listify[both_libs|build_tgt|custom_tgt|file]:, env dict|env|list|str:, ) -> custom_tgt POSARGS 0 str KWARGS command listify[exe] depends listify[both_libs|build_tgt|custom_tgt|file] env dict|env|list|str set_variable() SYNOPSIS set_variable( str, any, ) POSARGS 0 str 1 any shared_library() SYNOPSIS shared_library( glob[both_libs|build_tgt|custom_tgt|file|generated_list|str], <lang>_args listify[str]:, <lang>_pch build_tgt|file|list|str:, <lang>_shared_args listify[str]:, <lang>_static_args listify[str]:, build_by_default bool:, build_rpath str:, darwin_versions listify[int|str]:, dependencies listify[dep]:, export_dynamic bool:, extra_files listify[both_libs|build_tgt|custom_tgt|file|str]:, gnu_symbol_visibility str:, gui_app bool:, implib bool|str:, implicit_include_directories bool:, include_directories listify[inc|str]:, install bool:, install_dir str:, install_mode listify[bool|int|str]:, install_rpath str:, install_tag str:, link_args listify[str]:, link_depends listify[build_tgt|custom_tgt|file|str]:, link_language str:, link_whole listify[both_libs|build_tgt|custom_tgt|file]:, link_with listify[both_libs|build_tgt|custom_tgt|file]:, name_prefix list|str:, name_suffix list|str:, native bool:, objects listify[file|str]:, override_options dict[bool|int|list|str]|list[str]|str:, pic bool:, pie bool:, sources listify[both_libs|build_tgt|custom_tgt|file|gener- ated_list|str]:, soversion int|str:, target_type str:, version str:, vs_module_defs custom_tgt|file|str:, win_subsystem str:, ) -> build_tgt POSARGS 0 glob[both_libs|build_tgt|custom_tgt|file|generated_list|str] The name for this build target, followed by an optional list of sources. KWARGS <lang>_args listify[str] <lang>_pch build_tgt|file|list|str <lang>_shared_args listify[str] <lang>_static_args listify[str] build_by_default bool build_rpath str darwin_versions listify[int|str] dependencies listify[dep] export_dynamic bool extra_files listify[both_libs|build_tgt|custom_tgt|file|str] gnu_symbol_visibility str gui_app bool implib bool|str implicit_include_directories bool include_directories listify[inc|str] install bool install_dir str install_mode listify[bool|int|str] install_rpath str install_tag str link_args listify[str] link_depends listify[build_tgt|custom_tgt|file|str] link_language str link_whole listify[both_libs|build_tgt|custom_tgt|file] link_with listify[both_libs|build_tgt|custom_tgt|file] name_prefix list|str name_suffix list|str native bool objects listify[file|str] override_options dict[bool|int|list|str]|list[str]|str pic bool pie bool sources listify[both_libs|build_tgt|custom_tgt|file|generated_list|str] soversion int|str target_type str version str vs_module_defs custom_tgt|file|str win_subsystem str shared_module() SYNOPSIS shared_module( glob[both_libs|build_tgt|custom_tgt|file|generated_list|str], <lang>_args listify[str]:, <lang>_pch build_tgt|file|list|str:, <lang>_shared_args listify[str]:, <lang>_static_args listify[str]:, build_by_default bool:, build_rpath str:, darwin_versions listify[int|str]:, dependencies listify[dep]:, export_dynamic bool:, extra_files listify[both_libs|build_tgt|custom_tgt|file|str]:, gnu_symbol_visibility str:, gui_app bool:, implib bool|str:, implicit_include_directories bool:, include_directories listify[inc|str]:, install bool:, install_dir str:, install_mode listify[bool|int|str]:, install_rpath str:, install_tag str:, link_args listify[str]:, link_depends listify[build_tgt|custom_tgt|file|str]:, link_language str:, link_whole listify[both_libs|build_tgt|custom_tgt|file]:, link_with listify[both_libs|build_tgt|custom_tgt|file]:, name_prefix list|str:, name_suffix list|str:, native bool:, objects listify[file|str]:, override_options dict[bool|int|list|str]|list[str]|str:, pic bool:, pie bool:, sources listify[both_libs|build_tgt|custom_tgt|file|gener- ated_list|str]:, soversion int|str:, target_type str:, version str:, vs_module_defs custom_tgt|file|str:, win_subsystem str:, ) -> build_tgt POSARGS 0 glob[both_libs|build_tgt|custom_tgt|file|generated_list|str] The name for this build target, followed by an optional list of sources. KWARGS <lang>_args listify[str] <lang>_pch build_tgt|file|list|str <lang>_shared_args listify[str] <lang>_static_args listify[str] build_by_default bool build_rpath str darwin_versions listify[int|str] dependencies listify[dep] export_dynamic bool extra_files listify[both_libs|build_tgt|custom_tgt|file|str] gnu_symbol_visibility str gui_app bool implib bool|str implicit_include_directories bool include_directories listify[inc|str] install bool install_dir str install_mode listify[bool|int|str] install_rpath str install_tag str link_args listify[str] link_depends listify[build_tgt|custom_tgt|file|str] link_language str link_whole listify[both_libs|build_tgt|custom_tgt|file] link_with listify[both_libs|build_tgt|custom_tgt|file] name_prefix list|str name_suffix list|str native bool objects listify[file|str] override_options dict[bool|int|list|str]|list[str]|str pic bool pie bool sources listify[both_libs|build_tgt|custom_tgt|file|generated_list|str] soversion int|str target_type str version str vs_module_defs custom_tgt|file|str win_subsystem str static_library() SYNOPSIS static_library( glob[both_libs|build_tgt|custom_tgt|file|generated_list|str], <lang>_args listify[str]:, <lang>_pch build_tgt|file|list|str:, <lang>_shared_args listify[str]:, <lang>_static_args listify[str]:, build_by_default bool:, build_rpath str:, darwin_versions listify[int|str]:, dependencies listify[dep]:, export_dynamic bool:, extra_files listify[both_libs|build_tgt|custom_tgt|file|str]:, gnu_symbol_visibility str:, gui_app bool:, implib bool|str:, implicit_include_directories bool:, include_directories listify[inc|str]:, install bool:, install_dir str:, install_mode listify[bool|int|str]:, install_rpath str:, install_tag str:, link_args listify[str]:, link_depends listify[build_tgt|custom_tgt|file|str]:, link_language str:, link_whole listify[both_libs|build_tgt|custom_tgt|file]:, link_with listify[both_libs|build_tgt|custom_tgt|file]:, name_prefix list|str:, name_suffix list|str:, native bool:, objects listify[file|str]:, override_options dict[bool|int|list|str]|list[str]|str:, pic bool:, pie bool:, sources listify[both_libs|build_tgt|custom_tgt|file|gener- ated_list|str]:, soversion int|str:, target_type str:, version str:, vs_module_defs custom_tgt|file|str:, win_subsystem str:, ) -> build_tgt POSARGS 0 glob[both_libs|build_tgt|custom_tgt|file|generated_list|str] The name for this build target, followed by an optional list of sources. KWARGS <lang>_args listify[str] <lang>_pch build_tgt|file|list|str <lang>_shared_args listify[str] <lang>_static_args listify[str] build_by_default bool build_rpath str darwin_versions listify[int|str] dependencies listify[dep] export_dynamic bool extra_files listify[both_libs|build_tgt|custom_tgt|file|str] gnu_symbol_visibility str gui_app bool implib bool|str implicit_include_directories bool include_directories listify[inc|str] install bool install_dir str install_mode listify[bool|int|str] install_rpath str install_tag str link_args listify[str] link_depends listify[build_tgt|custom_tgt|file|str] link_language str link_whole listify[both_libs|build_tgt|custom_tgt|file] link_with listify[both_libs|build_tgt|custom_tgt|file] name_prefix list|str name_suffix list|str native bool objects listify[file|str] override_options dict[bool|int|list|str]|list[str]|str pic bool pie bool sources listify[both_libs|build_tgt|custom_tgt|file|generated_list|str] soversion int|str target_type str version str vs_module_defs custom_tgt|file|str win_subsystem str subdir() SYNOPSIS subdir( str, if_found listify[dep]:, ) POSARGS 0 str KWARGS if_found listify[dep] subdir_done() SYNOPSIS subdir_done( ) subproject() SYNOPSIS subproject( str, default_options dict[bool|int|list|str]|list[str]|str:, required bool|feature:, version listify[str]:, ) -> subproject POSARGS 0 str KWARGS default_options dict[bool|int|list|str]|list[str]|str required bool|feature version listify[str] summary() SYNOPSIS summary( dict[bool|dep|external_program|feature|int|str|list[bool|dep|exter- nal_program|feature|int|str]]|str, bool|dep|external_program|feature|int|str|list[bool|dep|exter- nal_program|feature|int|str], bool_yn bool:, list_sep str:, section str:, ) POSARGS 0 dict[bool|dep|external_program|feature|int|str|list[bool|dep|exter- nal_program|feature|int|str]]|str 1 bool|dep|external_program|feature|int|str|list[bool|dep|external_pro- gram|feature|int|str] KWARGS bool_yn bool list_sep str section str test() SYNOPSIS test( str, build_tgt|custom_tgt|external_program|file|python_installation, args listify[exe]:, depends listify[both_libs|build_tgt|custom_tgt|file]:, env dict|env|list|str:, is_parallel bool:, priority int:, protocol str:, should_fail bool:, suite listify[str]:, timeout int:, verbose bool:, workdir str:, ) POSARGS 0 str 1 build_tgt|custom_tgt|external_program|file|python_installation KWARGS args listify[exe] depends listify[both_libs|build_tgt|custom_tgt|file] env dict|env|list|str is_parallel bool priority int protocol str should_fail bool suite listify[str] timeout int verbose bool workdir str typeof() SYNOPSIS typeof( any, ) -> str POSARGS 0 any unset_variable() SYNOPSIS unset_variable( str, ) POSARGS 0 str vcs_tag() SYNOPSIS vcs_tag( command listify[exe]:, fallback str:, input listify[both_libs|build_tgt|custom_tgt|file|str]:, install bool:, install_dir listify[bool|str]:, install_mode listify[bool|int|str]:, install_tag str:, output str:, replace_string str:, ) -> custom_tgt KWARGS command listify[exe] fallback str input listify[both_libs|build_tgt|custom_tgt|file|str] install bool install_dir listify[bool|str] install_mode listify[bool|int|str] install_tag str output str replace_string str warning() SYNOPSIS warning( glob[bool|dict|feature|file|int|list|str], ) POSARGS 0 glob[bool|dict|feature|file|int|list|str] OBJECT METHODS bool bool.to_int() SYNOPSIS to_int( ) -> int bool.to_string() SYNOPSIS to_string( str, str, ) -> str POSARGS 0 str 1 str both_libs both_libs.extract_all_objects() SYNOPSIS extract_all_objects( recursive bool:, ) -> list KWARGS recursive bool both_libs.extract_objects() SYNOPSIS extract_objects( glob[custom_tgt|file|generated_list|str], ) -> list POSARGS 0 glob[custom_tgt|file|generated_list|str] both_libs.found() SYNOPSIS found( ) -> bool both_libs.full_path() SYNOPSIS full_path( ) -> str both_libs.get_shared_lib() SYNOPSIS get_shared_lib( ) -> build_tgt both_libs.get_static_lib() SYNOPSIS get_static_lib( ) -> build_tgt both_libs.name() SYNOPSIS name( ) -> str both_libs.path() SYNOPSIS path( ) -> str both_libs.private_dir_include() SYNOPSIS private_dir_include( ) -> str build_machine build_machine.address_bits() SYNOPSIS address_bits( ) -> int build_machine.cpu() SYNOPSIS cpu( ) -> str build_machine.cpu_family() SYNOPSIS cpu_family( ) -> str build_machine.endian() SYNOPSIS endian( ) -> str[big|little] build_machine.kernel() SYNOPSIS kernel( ) -> str build_machine.set_properties() SYNOPSIS set_properties( dict, ) POSARGS 0 dict accepted properties: .nf { cpu?: str, cpu_family?: str, endian?: big|lit- tle, system?: unknown|dragon- fly|freebsd|gnu|haiku|linux|netbsd|openbsd|sunos|android|em- scripten|windows|cygwin|msys2|darwin, subsystem?: un- known|dragon- fly|freebsd|gnu|haiku|linux|netbsd|openbsd|sunos|android|em- scripten|windows|cygwin|msys2|darwin|macos|ios|tvos|visionos } str build_machine.set_props() SYNOPSIS set_props( dict, ) POSARGS 0 dict accepted properties: .nf { cpu?: str, cpu_family?: str, endian?: big|lit- tle, system?: unknown|dragon- fly|freebsd|gnu|haiku|linux|netbsd|openbsd|sunos|android|em- scripten|windows|cygwin|msys2|darwin, subsystem?: un- known|dragon- fly|freebsd|gnu|haiku|linux|netbsd|openbsd|sunos|android|em- scripten|windows|cygwin|msys2|darwin|macos|ios|tvos|visionos } setproperties build_machine.subsystem() SYNOPSIS subsystem( ) -> str[android|cygwin|darwin|dragonfly|em- scripten|freebsd|gnu|haiku|ios|linux|ma- cos|msys2|netbsd|openbsd|sunos|tvos|unknown|visionos|windows] build_machine.system() SYNOPSIS system( ) -> str[android|cygwin|darwin|dragonfly|em- scripten|freebsd|gnu|haiku|linux|msys2|netbsd|openbsd|sunos|un- known|windows] build_tgt build_tgt.extract_all_objects() SYNOPSIS extract_all_objects( recursive bool:, ) -> list KWARGS recursive bool build_tgt.extract_objects() SYNOPSIS extract_objects( glob[custom_tgt|file|generated_list|str], ) -> list POSARGS 0 glob[custom_tgt|file|generated_list|str] build_tgt.found() SYNOPSIS found( ) -> bool build_tgt.full_path() SYNOPSIS full_path( ) -> str build_tgt.name() SYNOPSIS name( ) -> str build_tgt.path() SYNOPSIS path( ) -> str build_tgt.private_dir_include() SYNOPSIS private_dir_include( ) -> str cfg_data cfg_data.get() SYNOPSIS get( str, any, ) -> any POSARGS 0 str 1 any cfg_data.get_unquoted() SYNOPSIS get_unquoted( str, any, ) -> any POSARGS 0 str 1 any cfg_data.has() SYNOPSIS has( str, ) -> bool POSARGS 0 str cfg_data.keys() SYNOPSIS keys( ) -> list cfg_data.merge_from() SYNOPSIS merge_from( cfg_data, ) POSARGS 0 cfg_data cfg_data.set() SYNOPSIS set( str, bool|int|str, description str:, ) POSARGS 0 str 1 bool|int|str KWARGS description str cfg_data.set10() SYNOPSIS set10( str, bool, description str:, ) POSARGS 0 str 1 bool KWARGS description str cfg_data.set_quoted() SYNOPSIS set_quoted( str, str, description str:, ) POSARGS 0 str 1 str KWARGS description str compiler compiler.alignment() SYNOPSIS alignment( str, args listify[str]:, dependencies listify[dep]:, guess int:, high int:, include_directories listify[inc|str]:, low int:, name str:, prefix listify[str]:, required bool|feature:, werror bool:, ) -> int POSARGS 0 str KWARGS args listify[str] dependencies listify[dep] guess int high int include_directories listify[inc|str] low int name str prefix listify[str] required bool|feature werror bool compiler.check_header() SYNOPSIS check_header( str, args listify[str]:, dependencies listify[dep]:, guess int:, high int:, include_directories listify[inc|str]:, low int:, name str:, prefix listify[str]:, required bool|feature:, werror bool:, ) -> bool POSARGS 0 str KWARGS args listify[str] dependencies listify[dep] guess int high int include_directories listify[inc|str] low int name str prefix listify[str] required bool|feature werror bool compiler.cmd_array() SYNOPSIS cmd_array( ) -> list compiler.compiles() SYNOPSIS compiles( file|str, args listify[str]:, dependencies listify[dep]:, guess int:, high int:, include_directories listify[inc|str]:, low int:, name str:, prefix listify[str]:, required bool|feature:, werror bool:, ) -> bool POSARGS 0 file|str KWARGS args listify[str] dependencies listify[dep] guess int high int include_directories listify[inc|str] low int name str prefix listify[str] required bool|feature werror bool compiler.compute_int() SYNOPSIS compute_int( str, args listify[str]:, dependencies listify[dep]:, guess int:, high int:, include_directories listify[inc|str]:, low int:, name str:, prefix listify[str]:, required bool|feature:, werror bool:, ) -> int POSARGS 0 str KWARGS args listify[str] dependencies listify[dep] guess int high int include_directories listify[inc|str] low int name str prefix listify[str] required bool|feature werror bool compiler.configure() SYNOPSIS configure( str[archiver|compiler|linker], cmd_array listify[str]:, handlers dict[bool|function|list[str]]:, libdirs listify[str]:, overwrite bool:, version str:, ) POSARGS 0 str[archiver|compiler|linker] KWARGS cmd_array listify[str] handlers dict[bool|function|list[str]] libdirs listify[str] overwrite bool version str compiler.find_library() SYNOPSIS find_library( str, dirs listify[str]:, disabler bool:, has_headers listify[str]:, header_args listify[str]:, header_dependencies listify[dep]:, header_include_directories listify[inc|str]:, header_no_builtin_args null:, header_prefix null:, header_required bool:, required bool|feature:, static bool:, ) -> dep POSARGS 0 str KWARGS dirs listify[str] disabler bool has_headers listify[str] header_args listify[str] header_dependencies listify[dep] header_include_directories listify[inc|str] header_no_builtin_args null header_prefix null header_required bool required bool|feature static bool compiler.first_supported_argument() SYNOPSIS first_supported_argument( glob[str], ) -> list POSARGS 0 glob[str] compiler.first_supported_link_argument() SYNOPSIS first_supported_link_argument( glob[str], ) -> list POSARGS 0 glob[str] compiler.get_argument_syntax() SYNOPSIS get_argument_syntax( ) -> str compiler.get_define() SYNOPSIS get_define( str, args listify[str]:, dependencies listify[dep]:, guess int:, high int:, include_directories listify[inc|str]:, low int:, name str:, prefix listify[str]:, required bool|feature:, werror bool:, ) -> str POSARGS 0 str KWARGS args listify[str] dependencies listify[dep] guess int high int include_directories listify[inc|str] low int name str prefix listify[str] required bool|feature werror bool compiler.get_id() SYNOPSIS get_id( ) -> str compiler.get_internal_archiver_id() SYNOPSIS get_internal_archiver_id( ) -> str compiler.get_internal_id() SYNOPSIS get_internal_id( ) -> str compiler.get_internal_linker_id() SYNOPSIS get_internal_linker_id( ) -> str compiler.get_linker_id() SYNOPSIS get_linker_id( ) -> str compiler.get_supported_arguments() SYNOPSIS get_supported_arguments( glob[str], ) -> list POSARGS 0 glob[str] compiler.get_supported_function_attributes() SYNOPSIS get_supported_function_attributes( glob[str], ) -> list POSARGS 0 glob[str] compiler.get_supported_link_arguments() SYNOPSIS get_supported_link_arguments( glob[str], ) -> list POSARGS 0 glob[str] compiler.has_argument() SYNOPSIS has_argument( str, required bool|feature:, ) -> bool POSARGS 0 str KWARGS required bool|feature compiler.has_define() SYNOPSIS has_define( str, args listify[str]:, dependencies listify[dep]:, guess int:, high int:, include_directories listify[inc|str]:, low int:, name str:, prefix listify[str]:, required bool|feature:, werror bool:, ) -> bool POSARGS 0 str KWARGS args listify[str] dependencies listify[dep] guess int high int include_directories listify[inc|str] low int name str prefix listify[str] required bool|feature werror bool compiler.has_function() SYNOPSIS has_function( str, args listify[str]:, dependencies listify[dep]:, guess int:, high int:, include_directories listify[inc|str]:, low int:, name str:, prefix listify[str]:, required bool|feature:, werror bool:, ) -> bool POSARGS 0 str KWARGS args listify[str] dependencies listify[dep] guess int high int include_directories listify[inc|str] low int name str prefix listify[str] required bool|feature werror bool compiler.has_function_attribute() SYNOPSIS has_function_attribute( str, required bool|feature:, ) -> bool POSARGS 0 str KWARGS required bool|feature compiler.has_header() SYNOPSIS has_header( str, args listify[str]:, dependencies listify[dep]:, guess int:, high int:, include_directories listify[inc|str]:, low int:, name str:, prefix listify[str]:, required bool|feature:, werror bool:, ) -> bool POSARGS 0 str KWARGS args listify[str] dependencies listify[dep] guess int high int include_directories listify[inc|str] low int name str prefix listify[str] required bool|feature werror bool compiler.has_header_symbol() SYNOPSIS has_header_symbol( str, str, args listify[str]:, dependencies listify[dep]:, guess int:, high int:, include_directories listify[inc|str]:, low int:, name str:, prefix listify[str]:, required bool|feature:, werror bool:, ) -> bool POSARGS 0 str 1 str KWARGS args listify[str] dependencies listify[dep] guess int high int include_directories listify[inc|str] low int name str prefix listify[str] required bool|feature werror bool compiler.has_link_argument() SYNOPSIS has_link_argument( str, required bool|feature:, ) -> bool POSARGS 0 str KWARGS required bool|feature compiler.has_member() SYNOPSIS has_member( str, str, args listify[str]:, dependencies listify[dep]:, guess int:, high int:, include_directories listify[inc|str]:, low int:, name str:, prefix listify[str]:, required bool|feature:, werror bool:, ) -> bool POSARGS 0 str 1 str KWARGS args listify[str] dependencies listify[dep] guess int high int include_directories listify[inc|str] low int name str prefix listify[str] required bool|feature werror bool compiler.has_members() SYNOPSIS has_members( str, glob[str], args listify[str]:, dependencies listify[dep]:, guess int:, high int:, include_directories listify[inc|str]:, low int:, name str:, prefix listify[str]:, required bool|feature:, werror bool:, ) -> bool POSARGS 0 str 1 glob[str] KWARGS args listify[str] dependencies listify[dep] guess int high int include_directories listify[inc|str] low int name str prefix listify[str] required bool|feature werror bool compiler.has_multi_arguments() SYNOPSIS has_multi_arguments( glob[str], required bool|feature:, ) -> bool POSARGS 0 glob[str] KWARGS required bool|feature compiler.has_multi_link_arguments() SYNOPSIS has_multi_link_arguments( glob[str], required bool|feature:, ) -> bool POSARGS 0 glob[str] KWARGS required bool|feature compiler.has_type() SYNOPSIS has_type( str, args listify[str]:, dependencies listify[dep]:, guess int:, high int:, include_directories listify[inc|str]:, low int:, name str:, prefix listify[str]:, required bool|feature:, werror bool:, ) -> bool POSARGS 0 str KWARGS args listify[str] dependencies listify[dep] guess int high int include_directories listify[inc|str] low int name str prefix listify[str] required bool|feature werror bool compiler.links() SYNOPSIS links( file|str, args listify[str]:, dependencies listify[dep]:, guess int:, high int:, include_directories listify[inc|str]:, low int:, name str:, prefix listify[str]:, required bool|feature:, werror bool:, ) -> bool POSARGS 0 file|str KWARGS args listify[str] dependencies listify[dep] guess int high int include_directories listify[inc|str] low int name str prefix listify[str] required bool|feature werror bool compiler.machine() SYNOPSIS machine( ) -> build_machine compiler.preprocess() SYNOPSIS preprocess( glob[custom_tgt|file|generated_list|str], compile_args listify[str]:, dependencies listify[dep]:, depends listify[both_libs|build_tgt|custom_tgt|file]:, include_directories listify[inc|str]:, output str:, ) -> list POSARGS 0 glob[custom_tgt|file|generated_list|str] KWARGS compile_args listify[str] dependencies listify[dep] depends listify[both_libs|build_tgt|custom_tgt|file] include_directories listify[inc|str] output str compiler.run() SYNOPSIS run( file|str, args listify[str]:, dependencies listify[dep]:, guess int:, high int:, include_directories listify[inc|str]:, low int:, name str:, prefix listify[str]:, required bool|feature:, werror bool:, ) -> runresult POSARGS 0 file|str KWARGS args listify[str] dependencies listify[dep] guess int high int include_directories listify[inc|str] low int name str prefix listify[str] required bool|feature werror bool compiler.sizeof() SYNOPSIS sizeof( str, args listify[str]:, dependencies listify[dep]:, guess int:, high int:, include_directories listify[inc|str]:, low int:, name str:, prefix listify[str]:, required bool|feature:, werror bool:, ) -> int POSARGS 0 str KWARGS args listify[str] dependencies listify[dep] guess int high int include_directories listify[inc|str] low int name str prefix listify[str] required bool|feature werror bool compiler.symbols_have_underscore_prefix() SYNOPSIS symbols_have_underscore_prefix( ) -> bool compiler.target_triple() SYNOPSIS target_triple( ) -> dict compiler.version() SYNOPSIS version( ) -> str compiler.version_raw() SYNOPSIS version_raw( ) -> str custom_tgt custom_tgt.full_path() SYNOPSIS full_path( ) -> str custom_tgt.to_list() SYNOPSIS to_list( ) -> list dep dep.as_link_whole() SYNOPSIS as_link_whole( ) -> dep dep.as_shared() SYNOPSIS as_shared( recursive bool:, ) -> dep KWARGS recursive bool dep.as_static() SYNOPSIS as_static( recursive bool:, ) -> dep KWARGS recursive bool dep.as_system() SYNOPSIS as_system( str, ) -> dep POSARGS 0 str dep.found() SYNOPSIS found( ) -> bool dep.get_configtool_variable() SYNOPSIS get_configtool_variable( str, ) -> str POSARGS 0 str dep.get_pkgconfig_variable() SYNOPSIS get_pkgconfig_variable( str, default str:, ) -> str POSARGS 0 str KWARGS default str dep.get_variable() SYNOPSIS get_variable( str, default_value str:, internal str:, pkgconfig str:, pkgconfig_define listify[str]:, system str:, ) -> str POSARGS 0 str KWARGS default_value str internal str pkgconfig str pkgconfig_define listify[str] system str dep.include_type() SYNOPSIS include_type( ) -> str dep.name() SYNOPSIS name( ) -> str dep.partial_dependency() SYNOPSIS partial_dependency( compile_args bool:, includes bool:, link_args bool:, links bool:, sources bool:, ) -> dep KWARGS compile_args bool includes bool link_args bool links bool sources bool dep.type_name() SYNOPSIS type_name( ) -> str dep.version() SYNOPSIS version( ) -> str dict dict.delete() SYNOPSIS delete( str, ) DESCRIPTION Delete a key from a dictionary. Note that this mutates the underlying dictionary and also may reorder its keys. POSARGS 0 str dict.get() SYNOPSIS get( str, any, ) -> any POSARGS 0 str 1 any dict.has_key() SYNOPSIS has_key( str, ) -> bool POSARGS 0 str dict.keys() SYNOPSIS keys( ) -> list dict.set() SYNOPSIS set( str, any, ) POSARGS 0 str 1 any disabler disabler.found() SYNOPSIS found( ) -> bool env env.append() SYNOPSIS append( str, glob[str], separator str:, ) POSARGS 0 str 1 glob[str] KWARGS separator str env.prepend() SYNOPSIS prepend( str, glob[str], separator str:, ) POSARGS 0 str 1 glob[str] KWARGS separator str env.set() SYNOPSIS set( str, glob[str], separator str:, ) POSARGS 0 str 1 glob[str] KWARGS separator str env.unset() SYNOPSIS unset( str, ) POSARGS 0 str The name to unset external_program external_program.found() SYNOPSIS found( ) -> bool external_program.full_path() SYNOPSIS full_path( ) -> str external_program.path() SYNOPSIS path( ) -> str external_program.version() SYNOPSIS version( ) -> str feature feature.allowed() SYNOPSIS allowed( ) -> bool feature.auto() SYNOPSIS auto( ) -> bool feature.disable_auto_if() SYNOPSIS disable_auto_if( bool, ) -> feature POSARGS 0 bool feature.disable_if() SYNOPSIS disable_if( bool, error_message str:, ) -> feature POSARGS 0 bool KWARGS error_message str feature.disabled() SYNOPSIS disabled( ) -> bool feature.enable_auto_if() SYNOPSIS enable_auto_if( bool, ) -> feature POSARGS 0 bool feature.enable_if() SYNOPSIS enable_if( bool, error_message str:, ) -> feature POSARGS 0 bool KWARGS error_message str feature.enabled() SYNOPSIS enabled( ) -> bool feature.require() SYNOPSIS require( bool, error_message str:, ) -> feature POSARGS 0 bool KWARGS error_message str file file.full_path() SYNOPSIS full_path( ) -> str generator generator.process() SYNOPSIS process( glob[both_libs|build_tgt|custom_tgt|file|generated_list|str], env dict|env|list|str:, extra_args listify[str]:, preserve_path_from str:, ) -> generated_list POSARGS 0 glob[both_libs|build_tgt|custom_tgt|file|generated_list|str] KWARGS env dict|env|list|str extra_args listify[str] preserve_path_from str inc inc.full_path() SYNOPSIS full_path( ) -> str int int.is_even() SYNOPSIS is_even( ) -> bool int.is_odd() SYNOPSIS is_odd( ) -> bool int.to_string() SYNOPSIS to_string( fill int:, ) -> str KWARGS fill int list list.clear() SYNOPSIS clear( ) list.contains() SYNOPSIS contains( any, ) -> bool POSARGS 0 any list.dedup() SYNOPSIS dedup( ) -> list list.delete() SYNOPSIS delete( int, ) POSARGS 0 int list.flatten() SYNOPSIS flatten( ) -> list list.get() SYNOPSIS get( int, any, ) -> any POSARGS 0 int 1 any list.length() SYNOPSIS length( ) -> int list.slice() SYNOPSIS slice( int, int, ) -> list POSARGS 0 int 1 int meson meson.add_devenv() SYNOPSIS add_devenv( any, ) POSARGS 0 any meson.add_dist_script() SYNOPSIS add_dist_script( glob[exe], ) POSARGS 0 glob[exe] meson.add_install_script() SYNOPSIS add_install_script( glob[exe], dry_run bool:, install_tag str:, skip_if_destdir bool:, ) POSARGS 0 glob[exe] KWARGS dry_run bool install_tag str skip_if_destdir bool meson.add_postconf_script() SYNOPSIS add_postconf_script( glob[exe], ) POSARGS 0 glob[exe] meson.argv0() SYNOPSIS argv0( ) -> str DESCRIPTION returns the argv[0] that was used to invoke muon itself meson.backend() SYNOPSIS backend( ) -> str meson.build_options() SYNOPSIS build_options( ) -> str meson.build_root() SYNOPSIS build_root( ) -> str meson.can_run_host_binaries() SYNOPSIS can_run_host_binaries( ) -> bool meson.current_build_dir() SYNOPSIS current_build_dir( ) -> str meson.current_source_dir() SYNOPSIS current_source_dir( ) -> str meson.export_module() SYNOPSIS export_module( str, module, ) POSARGS 0 str 1 module meson.get_compiler() SYNOPSIS get_compiler( str, native bool:, ) -> compiler POSARGS 0 str KWARGS native bool meson.get_cross_property() SYNOPSIS get_cross_property( str, any, ) -> any POSARGS 0 str 1 any meson.get_external_property() SYNOPSIS get_external_property( str, any, native bool:, ) -> any POSARGS 0 str 1 any KWARGS native bool meson.global_build_root() SYNOPSIS global_build_root( ) -> str meson.global_source_root() SYNOPSIS global_source_root( ) -> str meson.has_compiler() SYNOPSIS has_compiler( str, native bool:, ) -> bool DESCRIPTION returns whether or not a compiler for the given language has been con- figured POSARGS 0 str KWARGS native bool meson.has_exe_wrapper() SYNOPSIS has_exe_wrapper( ) -> bool meson.is_cross_build() SYNOPSIS is_cross_build( ) -> bool meson.is_subproject() SYNOPSIS is_subproject( ) -> bool meson.is_unity() SYNOPSIS is_unity( ) -> bool meson.override_dependency() SYNOPSIS override_dependency( str, dep, native bool:, static bool:, ) POSARGS 0 str 1 dep KWARGS native bool static bool meson.override_find_program() SYNOPSIS override_find_program( str, build_tgt|custom_tgt|external_program|file|python_installa- tion|list[str], native bool:, ) POSARGS 0 str 1 build_tgt|custom_tgt|external_program|file|python_installa- tion|list[str] KWARGS native bool meson.private_dir() SYNOPSIS private_dir( ) -> str DESCRIPTION returns the path to muon's private directory in the build folder meson.project() SYNOPSIS project( ) -> dict DESCRIPTION return a dict containing read-only properties of the current project meson.project_build_root() SYNOPSIS project_build_root( ) -> str meson.project_license() SYNOPSIS project_license( ) -> list meson.project_license_files() SYNOPSIS project_license_files( ) -> list meson.project_name() SYNOPSIS project_name( ) -> str meson.project_source_root() SYNOPSIS project_source_root( ) -> str meson.project_version() SYNOPSIS project_version( ) -> str meson.register_dependency_handler() SYNOPSIS register_dependency_handler( str, builtin function:, config_tool function:, order listify[str]:, pkgconfig function:, system function:, ) DESCRIPTION register custom callbacks to run when a specific dependency lookup is invoked POSARGS 0 str KWARGS builtin function config_tool function order listify[str] pkgconfig function system function meson.set_external_properties() SYNOPSIS set_external_properties( dict[str], native bool:, ) DESCRIPTION set properties to be accessed by meson.getcrossproperty() and meson.ge- texternalproperty() POSARGS 0 dict[str] KWARGS native bool meson.set_option() SYNOPSIS set_option( str, bool|feature|int|list|str, ) DESCRIPTION set the value of an option as if it were set on the commandline POSARGS 0 str 1 bool|feature|int|list|str meson.source_root() SYNOPSIS source_root( ) -> str meson.version() SYNOPSIS version( ) -> str module module.found() SYNOPSIS found( ) -> bool python_installation python_installation.dependency() SYNOPSIS dependency( allow_fallback bool:, components listify[str]:, default_options dict[bool|int|list|str]|list[str]|str:, disabler bool:, embed bool:, fallback listify[str]:, include_type str:, language str:, main bool:, method str:, modules listify[str]:, native bool:, not_found_message str:, optional_modules listify[str]:, required bool|feature:, static bool:, version listify[str]:, ) -> dep KWARGS allow_fallback bool components listify[str] Ignored default_options dict[bool|int|list|str]|list[str]|str disabler bool embed bool fallback listify[str] include_type str language str Ignored main bool Ignored method str modules listify[str] A list of sub-dependencies for this dependency. Only supported by certain dependencies. native bool not_found_message str optional_modules listify[str] Ignored required bool|feature static bool version listify[str] python_installation.extension_module() SYNOPSIS extension_module( str, glob[both_libs|build_tgt|custom_tgt|file|generated_list|str], <lang>_args listify[str]:, <lang>_pch build_tgt|file|list|str:, <lang>_shared_args listify[str]:, <lang>_static_args listify[str]:, build_by_default bool:, build_rpath str:, darwin_versions listify[int|str]:, dependencies listify[dep]:, export_dynamic bool:, extra_files listify[both_libs|build_tgt|custom_tgt|file|str]:, gnu_symbol_visibility str:, gui_app bool:, implib bool|str:, implicit_include_directories bool:, include_directories listify[inc|str]:, install bool:, install_dir str:, install_mode listify[bool|int|str]:, install_rpath str:, install_tag str:, limited_api str:, link_args listify[str]:, link_depends listify[build_tgt|custom_tgt|file|str]:, link_language str:, link_whole listify[both_libs|build_tgt|custom_tgt|file]:, link_with listify[both_libs|build_tgt|custom_tgt|file]:, native bool:, objects listify[file|str]:, override_options dict[bool|int|list|str]|list[str]|str:, pic bool:, pie bool:, sources listify[both_libs|build_tgt|custom_tgt|file|gener- ated_list|str]:, soversion int|str:, subdir str:, target_type str:, version str:, vs_module_defs custom_tgt|file|str:, win_subsystem str:, ) -> build_tgt POSARGS 0 str 1 glob[both_libs|build_tgt|custom_tgt|file|generated_list|str] KWARGS <lang>_args listify[str] <lang>_pch build_tgt|file|list|str <lang>_shared_args listify[str] <lang>_static_args listify[str] build_by_default bool build_rpath str darwin_versions listify[int|str] dependencies listify[dep] export_dynamic bool extra_files listify[both_libs|build_tgt|custom_tgt|file|str] gnu_symbol_visibility str gui_app bool implib bool|str implicit_include_directories bool include_directories listify[inc|str] install bool install_dir str install_mode listify[bool|int|str] install_rpath str install_tag str limited_api str link_args listify[str] link_depends listify[build_tgt|custom_tgt|file|str] link_language str link_whole listify[both_libs|build_tgt|custom_tgt|file] link_with listify[both_libs|build_tgt|custom_tgt|file] native bool objects listify[file|str] override_options dict[bool|int|list|str]|list[str]|str pic bool pie bool sources listify[both_libs|build_tgt|custom_tgt|file|generated_list|str] soversion int|str subdir str target_type str version str vs_module_defs custom_tgt|file|str win_subsystem str python_installation.found() SYNOPSIS found( ) -> bool python_installation.full_path() SYNOPSIS full_path( ) -> str python_installation.get_install_dir() SYNOPSIS get_install_dir( pure bool:, subdir str:, ) -> str KWARGS pure bool subdir str python_installation.get_path() SYNOPSIS get_path( str, str, ) -> str POSARGS 0 str 1 str python_installation.get_variable() SYNOPSIS get_variable( str, str, ) -> str POSARGS 0 str 1 str python_installation.has_path() SYNOPSIS has_path( str, ) -> bool POSARGS 0 str python_installation.has_variable() SYNOPSIS has_variable( str, ) -> bool POSARGS 0 str python_installation.install_sources() SYNOPSIS install_sources( glob[file|str], follow_symlinks bool:, install_dir str:, install_mode listify[bool|int|str]:, install_tag str:, preserve_path bool:, pure bool:, rename listify[str]:, sources listify[file|str]:, subdir str:, ) POSARGS 0 glob[file|str] KWARGS follow_symlinks bool install_dir str install_mode listify[bool|int|str] install_tag str preserve_path bool pure bool rename listify[str] sources listify[file|str] subdir str python_installation.language_version() SYNOPSIS language_version( ) -> str python_installation.path() SYNOPSIS path( ) -> str python_installation.version() SYNOPSIS version( ) -> str runresult runresult.compiled() SYNOPSIS compiled( ) -> bool runresult.returncode() SYNOPSIS returncode( ) -> int runresult.stderr() SYNOPSIS stderr( ) -> str runresult.stdout() SYNOPSIS stdout( ) -> str source_configuration source_configuration.dependencies() SYNOPSIS dependencies( ) -> list source_configuration.sources() SYNOPSIS sources( ) -> list source_set source_set.add() SYNOPSIS add( glob[custom_tgt|dep|file|generated_list|str], if_false listify[custom_tgt|file|generated_list|str]:, if_true listify[custom_tgt|dep|file|generated_list|str]:, when listify[dep|str]:, ) POSARGS 0 glob[custom_tgt|dep|file|generated_list|str] KWARGS if_false listify[custom_tgt|file|generated_list|str] if_true listify[custom_tgt|dep|file|generated_list|str] when listify[dep|str] source_set.add_all() SYNOPSIS add_all( glob[source_set], if_true listify[source_set]:, when listify[dep|str]:, ) POSARGS 0 glob[source_set] KWARGS if_true listify[source_set] when listify[dep|str] source_set.all_dependencies() SYNOPSIS all_dependencies( ) -> list source_set.all_sources() SYNOPSIS all_sources( ) -> list source_set.apply() SYNOPSIS apply( cfg_data|dict, strict bool:, ) -> source_configuration POSARGS 0 cfg_data|dict KWARGS strict bool str str.contains() SYNOPSIS contains( str, ) -> bool POSARGS 0 str str.endswith() SYNOPSIS endswith( str, ) -> bool POSARGS 0 str str.format() SYNOPSIS format( glob[bool|dict|feature|file|int|list|str], ) -> str POSARGS 0 glob[bool|dict|feature|file|int|list|str] str.full_path() SYNOPSIS full_path( ) -> str str.join() SYNOPSIS join( glob[str], ) -> str POSARGS 0 glob[str] str.length() SYNOPSIS length( ) -> int str.percent_decode() SYNOPSIS percent_decode( ) -> str str.percent_encode() SYNOPSIS percent_encode( ) -> str str.replace() SYNOPSIS replace( str, str, ) -> str POSARGS 0 str 1 str str.shell_quote() SYNOPSIS shell_quote( shell str[cmd|posix]:, ) -> str KWARGS shell str[cmd|posix] str.shell_split() SYNOPSIS shell_split( shell str[cmd|posix]:, ) -> list KWARGS shell str[cmd|posix] str.split() SYNOPSIS split( str, ) -> list POSARGS 0 str str.splitlines() SYNOPSIS splitlines( ) -> list str.startswith() SYNOPSIS startswith( str, ) -> bool POSARGS 0 str str.strip() SYNOPSIS strip( str, ) -> str POSARGS 0 str str.substring() SYNOPSIS substring( int, int, ) -> str POSARGS 0 int 1 int str.to_int() SYNOPSIS to_int( ) -> int str.to_lower() SYNOPSIS to_lower( ) -> str str.to_upper() SYNOPSIS to_upper( ) -> str str.underscorify() SYNOPSIS underscorify( ) -> str str.version_compare() SYNOPSIS version_compare( str, ) -> bool POSARGS 0 str subproject subproject.found() SYNOPSIS found( ) -> bool subproject.get_variable() SYNOPSIS get_variable( str, any, ) -> any POSARGS 0 str 1 any subproject.import() SYNOPSIS import( str, required bool|feature:, ) -> module POSARGS 0 str KWARGS required bool|feature MODULE FUNCTIONS private/curl private/curl.fetch() SYNOPSIS fetch( list[str]|str, batch_size int:, progress bool|feature:, ) -> str DESCRIPTION Fetch url(s) using libcurl. Only available if libcurl support is en- abeld. POSARGS 0 list[str]|str the url(s) to fetch KWARGS batch_size int Batch size progress bool|feature Show progress output private/getopt private/getopt.getopt() SYNOPSIS getopt( listify[str], dict[dict], ) -> list DESCRIPTION Parse command line arguments using getopt. Returns the array of trail- ing positional args. POSARGS 0 listify[str] the array of arguments to parse 1 dict[dict] A dict of opt -> handler. * opt must be a single character. * handler is a dict that may contain the following keys: - required - defaults to false, causes this option to be required - action - required, a function that will be called to handle this option If the function accepts a single argument then the option will be required to supply a value - desc - required, a string to show in the help message. private/json private/json.parse() SYNOPSIS parse( str, check bool:, ) -> dict|list DESCRIPTION Parse a json string into an object POSARGS 0 str the json to parse KWARGS check bool private/json.stringify() SYNOPSIS stringify( bool|dict|feature|file|int|list|str, ) -> any DESCRIPTION Convert an object into a json string POSARGS 0 bool|dict|feature|file|int|list|str the object to stringify private/subprojects private/subprojects.clean() SYNOPSIS clean( listify[str], force bool:, ) DESCRIPTION Clean subprojects with .wrap files POSARGS 0 listify[str] A list of subprojects to operate on. KWARGS force bool Force the operation. private/subprojects.fetch() SYNOPSIS fetch( str, str, ) DESCRIPTION Fetch a project using a .wrap file POSARGS 0 str The wrap file to fetch. 1 str The directory to fetch into private/subprojects.list() SYNOPSIS list( listify[str], print bool:, ) -> list DESCRIPTION List subprojects with .wrap files and their status. POSARGS 0 listify[str] A list of subprojects to operate on. KWARGS print bool Print out a formatted list of subprojects as well as returning it. private/subprojects.load_wrap() SYNOPSIS load_wrap( str, ) DESCRIPTION Load a wrap file into a dict POSARGS 0 str The wrap file to load. private/subprojects.update() SYNOPSIS update( listify[str], required bool|feature:, ) DESCRIPTION Update subprojects with .wrap files POSARGS 0 listify[str] A list of subprojects to operate on. KWARGS required bool|feature Fail if any update would have been skipped (e.g. if the destination is dirty). private/time private/time.nanosleep() SYNOPSIS nanosleep( int, ) POSARGS 0 int private/time.timer_read() SYNOPSIS timer_read( int, ) -> int POSARGS 0 int private/time.timer_start() SYNOPSIS timer_start( ) -> int private/toolchain private/toolchain.create() SYNOPSIS create( inherit compiler:, inherit_archiver compiler|str:, inherit_compiler compiler|str:, inherit_linker compiler|str:, inherit_static_linker compiler|str:, ) -> compiler DESCRIPTION Creates a new compiler object that can be passed in to the toolchain keyword on add_languages or inherited from when coreating a new tool- chain. The toolchain object is reffered to as a compiler for histori- cal reasons, although it also contains other information required to compile programs such as linker metadata. KWARGS inherit compiler A toolchain to inherit from inherit_archiver compiler|str The archiver component to inherit from. Can be either a compiler object or static linker type name. inherit_compiler compiler|str The compiler component to inherit from. Can be either a compiler object or compiler type name. inherit_linker compiler|str The linker component to inherit from. Can be either a compiler ob- ject or linker type name. inherit_static_linker compiler|str Deprecated. Please use inheritarchiver instead private/toolchain.handler() SYNOPSIS handler( str, str, str, ) -> function|list DESCRIPTION Retrieve a previously defined handler POSARGS 0 str 1 str 2 str private/toolchain.parse_triple() SYNOPSIS parse_triple( str, ) -> dict DESCRIPTION parse a target triple POSARGS 0 str private/toolchain.register_archiver() SYNOPSIS register_archiver( str, detect function:, exe str:, handlers dict[bool|function|list[str]]:, inherit str:, public_id str:, ) -> dict DESCRIPTION Register a new static linker type POSARGS 0 str The id of this component KWARGS detect function If set, defines a function (str) -> int that will be called with the version output. This function is passed a string containing the combined stdout and stderr resulting from executing the candidate exe with this components version argument. If no version argument is defined then the empty string is passed. The return value should be a number indicating the confidence of a match, anything <= 0 will be skipped. If no detect function is specified the default score of 1 will be applied. After all candidate's detections are executed, the candidate with the highest score will be selected. exe str The exe_name is used to bootstrap toolchain detection when no exe- cutable is explicitly defined (e.g. using CC=clang). handlers dict[bool|function|list[str]] A dict mapping handler names to functions. If the handler returns a constant value, then that may be used instead of a function. The full list of supported handlers for this component are listed in the table below. For some handlers, the description shows a common value for that handler. For examples of toolchain definitons, see src/script/runtime/toolchains.meson in muon's source tree. |name|signature|description| |---|---|---| always|(compiler) -> list[str]|Arguments that are almost always passed, except in spe- cial cases such as detection. base|(compiler) -> list[str]|Argu- ments used to create an archive, e.g. csr for ar-posix. inputout- put|(compiler, str, str) -> list[str]|Passed in input and output and orders them properly, optionally adding additional flags. needswipe|(compiler) -> bool|true if this archiver cannot overwrite old archives and needs muon to remove them for it. version|(com- piler) -> list[str]|--version inherit str If set, inherit properties from a previously defined component. public_id str Returned by compiler.get_id() and compiler.get_linker_id(). De- faults to id if not set. private/toolchain.register_compiler() SYNOPSIS register_compiler( str, archiver function|str:, detect function:, exe dict[str]:, handlers dict[bool|function|list[str]]:, inherit str:, linker function|str:, public_id str:, ) -> dict DESCRIPTION Register a new compiler type POSARGS 0 str The id of this component KWARGS archiver function|str If set, defines a string or function (compiler) -> str that will be used to determine the archiver id for this compiler. detect function If set, defines a function (str) -> int that will be called with the version output. This function is passed a string containing the combined stdout and stderr resulting from executing the candidate exe with this components version argument. If no version argument is defined then the empty string is passed. The return value should be a number indicating the confidence of a match, anything <= 0 will be skipped. If no detect function is specified the default score of 1 will be applied. After all candidate's detections are executed, the candidate with the highest score will be selected. exe dict[str] A dict mapping langage -> exe_name, e.g. {'c': 'clang', 'cpp': 'clang++'}. The exe_name is used to bootstrap toolchain detection when no executable is explicitly defined (e.g. using CC=clang). handlers dict[bool|function|list[str]] A dict mapping handler names to functions. If the handler returns a constant value, then that may be used instead of a function. The full list of supported handlers for this component are listed in the table below. For some handlers, the description shows a common value for that handler. For examples of toolchain definitons, see src/script/runtime/toolchains.meson in muon's source tree. |name|signature|description| |---|---|---| always|(compiler) -> list[str]|Arguments that are almost always passed, except in spe- cial cases such as detection. argumentsyntax|(compiler) -> list[str]|Defines the return value of compiler.getargumentsyntax(). cancompilellvmir|(compiler) -> bool|True if this compiler can com- pile llvmir, e.g. clang. checkignoredoption|(compiler, str) -> bool|Called for compiler.hasargument() with the compiler's output. Useful if the compiler exits 0 but indicates on stderr or stdout that an option was ignored. coloroutput|(compiler, str) -> list[str]|-fdiagnostics-color compileonly|(compiler) -> list[str]|-c coverage|(compiler) -> list[str]|--coverage crt|(com- piler, str, bool) -> list[str]|Determine the C-runtime, e.g. for msvc. debug|(compiler) -> list[str]|-g debugfile|(compiler, str) -> list[str]|Used to tell msvc where to put pdb files. define|(com- piler, str) -> list[str]|-D deps|(compiler, str, str) -> list[str]|Arguments that instruct the compiler to output extra de- pendencies such as headers. depstype|(compiler) -> list[str]|Deter- mines deps type that ninja to uses doarchiverpassthrough|(compiler) -> bool|true if the archiver is the same executable as the compiler (e.g. tcc) dolinkerpassthrough|(compiler) -> bool|true if the linker should only be invoked through the compiler driver, or false if the linker should be invoked directly. dumpmachine|(compiler) -> list[str]|Argument to output the compiler's target triple. emit- pch|(compiler) -> list[str]| enablelto|(compiler) -> list[str]|-flto forcelanguage|(compiler, str) -> list[str]|-x in- clude|(compiler, str) -> list[str]|-I includedirafter|(compiler, str) -> list[str]|-idirafter includepch|(compiler, str) -> list[str]| includesystem|(compiler, str) -> list[str]|-isystem linkerdelimiter|(compiler) -> list[str]|/link linker- passthrough|(compiler, list[str]) -> list[str]|Handles properly us- ing -Wl, to pass arguments to the linker. objectext|(compiler) -> list[str]|e.g. .o or .obj optimization|(compiler, str[0 / 1 / 2 / 3 / g / none / s]) -> list[str]| output|(compiler, str) -> list[str]|-o pchext|(compiler) -> list[str]| permissive|(compiler) -> list[str]|-fpermissive pgo|(compiler, str[generate / use]) -> list[str]| pic|(compiler) -> list[str]|-fPIC pie|(compiler) -> list[str]|-fPIE preprocessonly|(compiler) -> list[str]|-E printsearchdirs|(compiler) -> list[str]|Instruct the compilerArgu- ment to output the compiler's internal search directories. sani- tize|(compiler, str) -> list[str]|-fsanitize setstd|(compiler, str) -> list[str]|-std stdunsupported|(compiler, str) -> bool|Return true if the passed in std is unsupported by the current compiler. version|(compiler) -> list[str]|--version visibility|(compiler, str[default / hidden / inlineshidden / internal / protected]) -> list[str]| warneverything|(compiler) -> list[str]|-Weverything warninglvl|(compiler, str[0 / 1 / 2 / 3 / everything]) -> list[str]| werror|(compiler) -> list[str]|-Werror winvalidpch|(com- piler) -> list[str]| asanlundefwarning|(compiler) -> bool|whether to warn if blundef is used alongside sanitizers inherit str If set, inherit properties from a previously defined component. linker function|str If set, defines a string or function (compiler) -> str that will be used to determine the linker id for this compiler. public_id str Returned by compiler.get_id() and compiler.get_linker_id(). De- faults to id if not set. private/toolchain.register_linker() SYNOPSIS register_linker( str, detect function:, exe str:, handlers dict[bool|function|list[str]]:, inherit str:, public_id str:, ) -> dict DESCRIPTION Register a new linker type POSARGS 0 str The id of this component KWARGS detect function If set, defines a function (str) -> int that will be called with the version output. This function is passed a string containing the combined stdout and stderr resulting from executing the candidate exe with this components version argument. If no version argument is defined then the empty string is passed. The return value should be a number indicating the confidence of a match, anything <= 0 will be skipped. If no detect function is specified the default score of 1 will be applied. After all candidate's detections are executed, the candidate with the highest score will be selected. exe str The exe_name is used to bootstrap toolchain detection when no exe- cutable is explicitly defined (e.g. using CC=clang). handlers dict[bool|function|list[str]] A dict mapping handler names to functions. If the handler returns a constant value, then that may be used instead of a function. The full list of supported handlers for this component are listed in the table below. For some handlers, the description shows a common value for that handler. For examples of toolchain definitons, see src/script/runtime/toolchains.meson in muon's source tree. |name|signature|description| |---|---|---| allowshlibunde- fined|(compiler) -> list[str]|Allow undefined symbols always|(com- piler) -> list[str]|Arguments that are almost always passed, except in special cases such as detection. asneeded|(compiler) -> list[str]| checkignoredoption|(compiler, str) -> bool|Called for compiler.haslinkargument() with the linker's output. Useful if the linker exits 0 but indicates on stderr or stdout that an option was ignored. coverage|(compiler) -> list[str]|--coverage debug|(com- piler) -> list[str]|/DEBUG def|(compiler, str) -> list[str]|/DEF enablelto|(compiler) -> list[str]|-flto endgroup|(compiler) -> list[str]|--end-group exportdynamic|(compiler) -> list[str]|-ex- port-dynamic fatalwarnings|(compiler) -> list[str]|--fatal-warnings fuseld|(compiler) -> list[str]|-fuse-ld= implib|(compiler, str) -> list[str]|/IMPLIB implibsuffix|(compiler) -> list[str]|Linker spe- cific import library suffix for DLLs. Defaults to '-implib.lib' if not provided. inputoutput|(compiler, str, str) -> list[str]|Passed in input and output and orders them properly, optionally adding ad- ditional flags. lib|(compiler, str) -> list[str]|-l nounde- fined|(compiler) -> list[str]|--no-undefined pgo|(compiler, str[generate / use]) -> list[str]| rpath|(compiler, str) -> list[str]|-rpath sanitize|(compiler, str) -> list[str]|-fsanitize shared|(compiler) -> list[str]|-shared sharedmodule|(compiler) -> list[str]| soname|(compiler, str) -> list[str]|-soname start- group|(compiler) -> list[str]|--start-group version|(compiler) -> list[str]|-v wholearchive|(compiler, str) -> list[str]|--whole- archive inherit str If set, inherit properties from a previously defined component. public_id str Returned by compiler.get_id() and compiler.get_linker_id(). De- faults to id if not set. private/util private/util.exit() SYNOPSIS exit( int, ) POSARGS 0 int private/util.repr() SYNOPSIS repr( any, ) -> str DESCRIPTION return a string representing the passed object POSARGS 0 any private/util.serial_dump() SYNOPSIS serial_dump( file|str, any, ) POSARGS 0 file|str 1 any private/util.serial_load() SYNOPSIS serial_load( file|str, ) -> any POSARGS 0 file|str public/fs public/fs.add_suffix() SYNOPSIS add_suffix( str, str, ) -> str DESCRIPTION Append a suffix to a path POSARGS 0 str 1 str public/fs.as_posix() SYNOPSIS as_posix( str, ) -> str DESCRIPTION Convert backslashes to / POSARGS 0 str public/fs.canonicalize() SYNOPSIS canonicalize( str, ) -> str DESCRIPTION Make a path absolute and replace .. POSARGS 0 str public/fs.copy() SYNOPSIS copy( file|str, str, force bool:, ) DESCRIPTION Copy a file to a destination at configure time POSARGS 0 file|str 1 str KWARGS force bool public/fs.copyfile() SYNOPSIS copyfile( file|str, str, install bool:, install_dir listify[bool|str]:, install_mode listify[bool|int|str]:, install_tag str:, ) -> custom_tgt DESCRIPTION Creates a custom target that copies a file at build time POSARGS 0 file|str 1 str KWARGS install bool install_dir listify[bool|str] install_mode listify[bool|int|str] install_tag str public/fs.cwd() SYNOPSIS cwd( ) -> str DESCRIPTION Return the muon's current working directory public/fs.delete_with_suffix() SYNOPSIS delete_with_suffix( str, str, ) -> list DESCRIPTION Recursively delete all files with a matching suffix POSARGS 0 str 1 str public/fs.executable() SYNOPSIS executable( str, ) -> str DESCRIPTION Prepend ./ to a path if it is a basename POSARGS 0 str public/fs.exists() SYNOPSIS exists( str, ) -> bool DESCRIPTION Check if a file or directory exists POSARGS 0 str public/fs.expanduser() SYNOPSIS expanduser( str, ) -> str DESCRIPTION Expand a path that starts with a ~ into an absolute path POSARGS 0 str public/fs.glob() SYNOPSIS glob( str, ) -> list DESCRIPTION Gather a list of files matching a glob expression POSARGS 0 str public/fs.hash() SYNOPSIS hash( file|str, str, ) -> str DESCRIPTION Calculate the content hash of a file POSARGS 0 file|str 1 str public/fs.is_absolute() SYNOPSIS is_absolute( file|str, ) -> bool DESCRIPTION Check if a path is absolute POSARGS 0 file|str public/fs.is_basename() SYNOPSIS is_basename( str, ) -> bool DESCRIPTION Check if a path is a basename POSARGS 0 str public/fs.is_dir() SYNOPSIS is_dir( str, ) -> bool DESCRIPTION Check if a directory exists POSARGS 0 str public/fs.is_file() SYNOPSIS is_file( str, ) -> bool DESCRIPTION Check if a file exists POSARGS 0 str public/fs.is_samepath() SYNOPSIS is_samepath( file|str, file|str, ) -> bool DESCRIPTION Check if two paths point to the same object POSARGS 0 file|str 1 file|str public/fs.is_subpath() SYNOPSIS is_subpath( str, str, ) -> bool DESCRIPTION Check if a path is a subpath of another path POSARGS 0 str 1 str public/fs.is_symlink() SYNOPSIS is_symlink( file|str, ) -> bool DESCRIPTION Check if a symlink exists POSARGS 0 file|str public/fs.make_absolute() SYNOPSIS make_absolute( str, ) -> str DESCRIPTION Make a path absolute by prepending the current working directory POSARGS 0 str public/fs.mkdir() SYNOPSIS mkdir( str, make_parents bool:, ) DESCRIPTION Create a directory POSARGS 0 str KWARGS make_parents bool public/fs.name() SYNOPSIS name( both_libs|build_tgt|custom_tgt|file|str, ) -> str DESCRIPTION Get the basename of a path POSARGS 0 both_libs|build_tgt|custom_tgt|file|str public/fs.parent() SYNOPSIS parent( both_libs|build_tgt|custom_tgt|file|str, ) -> str DESCRIPTION Get the dirname of a path POSARGS 0 both_libs|build_tgt|custom_tgt|file|str public/fs.read() SYNOPSIS read( file|str, encoding str:, ) -> str DESCRIPTION Read a file from disk POSARGS 0 file|str KWARGS encoding str public/fs.relative_to() SYNOPSIS relative_to( both_libs|build_tgt|custom_tgt|file|str, both_libs|build_tgt|custom_tgt|file|str, ) -> str DESCRIPTION Get a path relative to another path POSARGS 0 both_libs|build_tgt|custom_tgt|file|str 1 both_libs|build_tgt|custom_tgt|file|str public/fs.replace_suffix() SYNOPSIS replace_suffix( both_libs|build_tgt|custom_tgt|file|str, str, ) -> str DESCRIPTION Replace a path's suffix POSARGS 0 both_libs|build_tgt|custom_tgt|file|str 1 str public/fs.rmdir() SYNOPSIS rmdir( str, force bool:, recursive bool:, ) -> list DESCRIPTION Remove a directory POSARGS 0 str KWARGS force bool recursive bool public/fs.size() SYNOPSIS size( file|str, ) -> int DESCRIPTION Get a file's size in bytes POSARGS 0 file|str public/fs.stem() SYNOPSIS stem( both_libs|build_tgt|custom_tgt|file|str, ) -> str DESCRIPTION Get the basename of a path with its extension removed POSARGS 0 both_libs|build_tgt|custom_tgt|file|str public/fs.without_ext() SYNOPSIS without_ext( str, ) -> str DESCRIPTION Get a path with its extension removed POSARGS 0 str public/fs.write() SYNOPSIS write( file|str, str, ) DESCRIPTION Write a file POSARGS 0 file|str 1 str public/gnome public/gnome.compile_resources() SYNOPSIS compile_resources( str, choices list:, deprecated bool|str|dict[str]|list[str]:, description str:, max int:, min int:, type str:, value any:, yield bool:, ) -> list[custom_tgt] POSARGS 0 str KWARGS choices list deprecated bool|str|dict[str]|list[str] description str max int min int type str value any yield bool public/gnome.compile_schemas() SYNOPSIS compile_schemas( str, choices list:, deprecated bool|str|dict[str]|list[str]:, description str:, max int:, min int:, type str:, value any:, yield bool:, ) -> custom_tgt POSARGS 0 str KWARGS choices list deprecated bool|str|dict[str]|list[str] description str max int min int type str value any yield bool public/gnome.gdbus_codegen() SYNOPSIS gdbus_codegen( str, choices list:, deprecated bool|str|dict[str]|list[str]:, description str:, max int:, min int:, type str:, value any:, yield bool:, ) -> list[custom_tgt] POSARGS 0 str KWARGS choices list deprecated bool|str|dict[str]|list[str] description str max int min int type str value any yield bool public/gnome.generate_gir() SYNOPSIS generate_gir( str, choices list:, deprecated bool|str|dict[str]|list[str]:, description str:, max int:, min int:, type str:, value any:, yield bool:, ) -> list[custom_tgt] POSARGS 0 str KWARGS choices list deprecated bool|str|dict[str]|list[str] description str max int min int type str value any yield bool public/gnome.genmarshal() SYNOPSIS genmarshal( str, choices list:, deprecated bool|str|dict[str]|list[str]:, description str:, max int:, min int:, type str:, value any:, yield bool:, ) -> list[custom_tgt] POSARGS 0 str KWARGS choices list deprecated bool|str|dict[str]|list[str] description str max int min int type str value any yield bool public/gnome.mkenums() SYNOPSIS mkenums( str, choices list:, deprecated bool|str|dict[str]|list[str]:, description str:, max int:, min int:, type str:, value any:, yield bool:, ) -> list[custom_tgt] POSARGS 0 str KWARGS choices list deprecated bool|str|dict[str]|list[str] description str max int min int type str value any yield bool public/gnome.mkenums_simple() SYNOPSIS mkenums_simple( str, choices list:, deprecated bool|str|dict[str]|list[str]:, description str:, max int:, min int:, type str:, value any:, yield bool:, ) -> list[custom_tgt] POSARGS 0 str KWARGS choices list deprecated bool|str|dict[str]|list[str] description str max int min int type str value any yield bool public/gnome.post_install() SYNOPSIS post_install( str, choices list:, deprecated bool|str|dict[str]|list[str]:, description str:, max int:, min int:, type str:, value any:, yield bool:, ) POSARGS 0 str KWARGS choices list deprecated bool|str|dict[str]|list[str] description str max int min int type str value any yield bool public/i18n public/i18n.gettext() SYNOPSIS gettext( str, choices list:, deprecated bool|str|dict[str]|list[str]:, description str:, max int:, min int:, type str:, value any:, yield bool:, ) -> list[any] DESCRIPTION Sets up gettext localisation so that translations are built and placed into their proper locations during install. This function also defines targets for maintainers to use: Note: These output to the source directory - <project_id>-pot: runs xgettext to re- generate the pot file - <project_id>-update-po: regenerates the .po files from current .pot file - <project_id>-gmo: builds the transla- tions without installing Returns a list containing: - a list of built .mo files - the maintainer -pot target - the maintainer -update-po target POSARGS 0 str KWARGS choices list deprecated bool|str|dict[str]|list[str] description str max int min int type str value any yield bool public/i18n.itstool_join() SYNOPSIS itstool_join( str, choices list:, deprecated bool|str|dict[str]|list[str]:, description str:, max int:, min int:, type str:, value any:, yield bool:, ) -> custom_tgt DESCRIPTION This joins translations into a XML file using itstool POSARGS 0 str KWARGS choices list deprecated bool|str|dict[str]|list[str] description str max int min int type str value any yield bool public/i18n.merge_file() SYNOPSIS merge_file( str, choices list:, deprecated bool|str|dict[str]|list[str]:, description str:, max int:, min int:, type str:, value any:, yield bool:, ) -> custom_tgt DESCRIPTION This merges translations into a text file using msgfmt. POSARGS 0 str KWARGS choices list deprecated bool|str|dict[str]|list[str] description str max int min int type str value any yield bool public/keyval public/keyval.load() SYNOPSIS load( file|str, ) -> dict POSARGS 0 file|str public/pkgconfig public/pkgconfig.generate() SYNOPSIS generate( both_libs|build_tgt, conflicts listify[str]:, dataonly bool:, description str:, extra_cflags listify[str]:, filebase str:, install_dir str:, libraries listify[both_libs|build_tgt|custom_tgt|dep|file|str]:, libraries_private listify[both_libs|build_tgt|cus- tom_tgt|dep|file|str]:, name str:, requires listify[both_libs|build_tgt|dep|str]:, requires_private listify[both_libs|build_tgt|dep|str]:, subdirs listify[str]:, unescaped_uninstalled_variables dict|list|str:, unescaped_variables dict|list|str:, uninstalled_variables dict|list|str:, url str:, variables dict|list|str:, version str:, ) -> file POSARGS 0 both_libs|build_tgt KWARGS conflicts listify[str] dataonly bool description str extra_cflags listify[str] filebase str install_dir str libraries listify[both_libs|build_tgt|custom_tgt|dep|file|str] libraries_private listify[both_libs|build_tgt|custom_tgt|dep|file|str] name str requires listify[both_libs|build_tgt|dep|str] requires_private listify[both_libs|build_tgt|dep|str] subdirs listify[str] unescaped_uninstalled_variables dict|list|str unescaped_variables dict|list|str uninstalled_variables dict|list|str url str variables dict|list|str version str public/pkgconfig.parse_fragments() SYNOPSIS parse_fragments( listify[str], compiler compiler:, flags_key str:, static bool:, ) -> dict POSARGS 0 listify[str] KWARGS compiler compiler flags_key str static bool public/python public/python.find_installation() SYNOPSIS find_installation( str, disabler bool:, modules listify[str]:, pure bool:, required bool|feature:, ) -> python_installation POSARGS 0 str KWARGS disabler bool modules listify[str] pure bool required bool|feature public/python3 public/python3.find_python() SYNOPSIS find_python( str, ) -> external_program POSARGS 0 str public/sourceset public/sourceset.source_set() SYNOPSIS source_set( ) -> source_set public/wayland public/wayland.find_protocol() SYNOPSIS find_protocol( str, choices list:, deprecated bool|str|dict[str]|list[str]:, description str:, max int:, min int:, type str:, value any:, yield bool:, ) -> file DESCRIPTION Find a wayland protocol file POSARGS 0 str KWARGS choices list deprecated bool|str|dict[str]|list[str] description str max int min int type str value any yield bool public/wayland.scan_xml() SYNOPSIS scan_xml( str, choices list:, deprecated bool|str|dict[str]|list[str]:, description str:, max int:, min int:, type str:, value any:, yield bool:, ) -> list[custom_tgt] DESCRIPTION Run wayland scanner to generate files based on a protocol POSARGS 0 str KWARGS choices list deprecated bool|str|dict[str]|list[str] description str max int min int type str value any yield bool public/windows public/windows.compile_resources() SYNOPSIS compile_resources( str, choices list:, deprecated bool|str|dict[str]|list[str]:, description str:, max int:, min int:, type str:, value any:, yield bool:, ) -> list[custom_tgt] DESCRIPTION Compiles Windows rc files specified in the positional arguments. Re- turns a list of custom_tgt objects that you put in the list of sources for the target you want to have the resources in. POSARGS 0 str KWARGS choices list deprecated bool|str|dict[str]|list[str] description str max int min int type str value any yield bool COPYRIGHT Documentation comes from muon (https://muon.build/) and the meson project (https://mesonbuild.com) and is released under Attribution-ShareAlike 4.0 International (CC BY-SA 4.0). Code samples are released under CC0 1.0 Uni- versal (CC0 1.0). Meson is a registered trademark of Jussi Pakkanen. muon 0.6.0- meson-reference(3)
NAME | DESCRIPTION | KERNEL FUNCTIONS | OBJECT METHODS | bool | both_libs | build_machine | build_tgt | cfg_data | compiler | custom_tgt | dep | dict | disabler | env | external_program | feature | file | generator | inc | int | list | meson | module | python_installation | runresult | source_configuration | source_set | str | subproject | MODULE FUNCTIONS | private/curl | private/getopt | private/json | private/subprojects | private/time | private/toolchain | private/util | public/fs | public/gnome | public/i18n | public/keyval | public/pkgconfig | public/python | public/python3 | public/sourceset | public/wayland | public/windows | COPYRIGHT
Want to link to this manual page? Use this URL:
<https://man.FreeBSD.org/cgi/man.cgi?query=meson-reference&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>