関数

このドキュメントでは、meson.buildファイルで使用可能なすべての関数をリストしています。すべての機能の概要については、ルートマニュアルドキュメントを参照してください。

add_global_arguments()

グローバルな引数をコンパイラのコマンドラインに追加します。

# Adds global arguments to the compiler command line
void add_global_arguments(
  str Compiler argument...,  # The compiler arguments to add

  # Keyword arguments:
  language : list[str]  [required]  # Specifies the language(s) that the arguments should be
  native   : bool                   # A boolean specifying whether the arguments should be
)

引数

この関数は、0から無限大の可変引数(Compiler argument...)をstr型で受け取ります。

追加するコンパイラの引数

関数add_global_arguments()は、次のキーワード引数を受け取ります。

add_global_link_arguments()

グローバルな引数をリンカーのコマンドラインに追加します。

add_global_arguments()と同様ですが、引数はリンカーに渡されます。

# Adds global arguments to the linker command line
void add_global_link_arguments(
  str Linker argument...,  # The linker arguments to add

  # Keyword arguments:
  language : list[str]  [required]  # Specifies the language(s) that the arguments should be
  native   : bool                   # A boolean specifying whether the arguments should be
)

引数

この関数は、0から無限大の可変引数(Linker argument...)をstr型で受け取ります。

追加するリンカーの引数

関数add_global_link_arguments()は、次のキーワード引数を受け取ります。

add_languages()

プロジェクトで使用されるプログラミング言語を追加します。

これは、project宣言に言語を含めることと同等です。この関数は通常、特定の条件下でのみ使用される言語を追加するために使用されます。

指定されたすべての言語が見つかった場合はtrue、そうでない場合はfalseを返します。

nativeが省略された場合、言語はビルドマシンまたはホストマシンのいずれかに使用できますが、ビルドマシンには必須ではありません。（つまり、add_languages(*langs*, native: false, required: *required*) and add_languages(*langs*, native: true, required: false)と同等です。このデフォルトの動作は、将来のMesonバージョンでnative: falseに変更される可能性があります。）

# Add programming languages used by the project
bool add_languages(
  str Language...,  # The languages to add

  # Keyword arguments:
  native   : bool            # If set to `true`, the language will be used to compile for the build
  required : bool | feature  # If set to `true`, Meson will halt if any of the languages
)

例

project('foobar', 'c')

if compiling_for_osx
  add_languages('objc')
endif
if add_languages('cpp', required : false)
  executable('cpp-app', 'main.cpp')
endif

# More code...

引数

この関数は、0から無限大の可変引数(Language...)をstr型で受け取ります。

追加する言語

関数add_languages()は、次のキーワード引数を受け取ります。

add_project_arguments()

プロジェクト固有の引数をコンパイラのコマンドラインに追加します。

この関数は、add_global_arguments()と同じように動作しますが、引数は現在のプロジェクトでのみ使用され、他のサブプロジェクトでは使用されません。

# Adds project specific arguments to the compiler command line
void add_project_arguments(
  str Compiler argument...,  # The compiler arguments to add

  # Keyword arguments:
  language : list[str]  [required]  # Specifies the language(s) that the arguments should be
  native   : bool                   # A boolean specifying whether the arguments should be
)

引数

この関数は、0から無限大の可変引数(Compiler argument...)をstr型で受け取ります。

追加するコンパイラの引数

関数add_project_arguments()は、次のキーワード引数を受け取ります。

add_project_dependencies()

コンパイラとリンカーのコマンドラインに引数を追加して、指定された依存関係のセットがこのプロジェクトのすべてのビルド製品に含まれるようにします。

# Adds arguments to the compiler and linker command line, so that the
void add_project_dependencies(
  dep dependencies...,  # The dependencies to add; if internal dependencies are included, they must not include any built object

  # Keyword arguments:
  language : list[str]  [required]  # Specifies the language(s) that the arguments should be
  native   : bool                   # A boolean specifying whether the arguments should be
)

引数

この関数は、0から無限大の可変引数(dependencies...)をdep型で受け取ります。

追加する依存関係。内部依存関係が含まれる場合、ビルドされたオブジェクトを含めてはなりません。

関数add_project_dependencies()は、次のキーワード引数を受け取ります。

add_project_link_arguments()

プロジェクト固有の引数をリンカーのコマンドラインに追加します。

add_project_arguments()と同様ですが、引数はリンカーに渡されます。

# Adds project specific arguments to the linker command line
void add_project_link_arguments(
  str Linker argument...,  # The linker arguments to add

  # Keyword arguments:
  language : list[str]  [required]  # Specifies the language(s) that the arguments should be
  native   : bool                   # A boolean specifying whether the arguments should be
)

引数

この関数は、0から無限大の可変引数(Linker argument...)をstr型で受け取ります。

追加するリンカーの引数

関数add_project_link_arguments()は、次のキーワード引数を受け取ります。

add_test_setup()

カスタムテスト設定を追加します。この設定は、例えばValgrindの下でカスタム設定でテストを実行するために使用できます。

テスト設定を使用するには、ビルドディレクトリ内でmeson test --setup=*name*を実行します。

これらのオプションはすべて、バックエンドに応じてninja testまたはmsbuild RUN_TESTS.vcxprojなどの代わりにテストを実行するためのmeson testスクリプトの実行中にも使用できることに注意してください。

# Add a custom test setup
void add_test_setup(
  str name,     # The name of the test setup

  # Keyword arguments:
  env                : env | list[str] | dict[str]   # environment variables to set
  exclude_suites     : list[str]                     # A list of test suites that should be excluded when using this setup
  exe_wrapper        : list[str | external_program]  # The command or script followed by the arguments to it
  gdb                : bool                          # If `true`, the tests are also run under `gdb`
  is_default         : bool                          # Set whether this is the default test setup
  timeout_multiplier : int                           # A number to multiply the test timeout with
)

引数

関数add_test_setup()は、次の位置引数を受け取ります。

最後に、add_test_setup()は、次のキーワード引数を受け取ります。

alias_target()

この関数は、新しいトップレベルターゲットを作成します。すべてのトップレベルターゲットと同様に、これは選択されたバックエンドと統合されます。たとえば、meson compile target_nameとして実行できます。これは、コマンドを実行しないダミーターゲットですが、すべての依存関係がビルドされることを保証します。依存関係は、任意のビルドターゲットにすることができます。0.60.0以降、これにはrun_tgtが含まれます。

1.6.0以降、both_libsオブジェクトを渡すと、共有ライブラリと静的ライブラリの両方がビルドされます。

# This function creates a new top-level target
alias_tgt alias_target(
  str target_name,     # The name of the alias target
  tgt Dep...,          # The targets to depend on
)

引数

関数alias_target()は、次の位置引数を受け取ります。

さらに、この関数は、1から無限大の可変引数(Dep...)をtgt型で受け取ります。

依存するターゲット

assert()

conditionがfalseと評価された場合、エラーメッセージで中止します。

# Abort with an error message if `condition` evaluates to `false`
void assert(
  bool condition,     # Abort if this evaluates to `false`
  str  [message],     # The error message to print
)

引数

関数assert()は、次の位置引数を受け取ります。

benchmark()

ベンチマークターゲットが実行されたときに実行されるベンチマーク項目を作成します。この関数の動作は、次の点を除いてtest()と同じです。

• ベンチマークは並行して実行されないため、benchmark()にはis_parallelキーワードがありません
• benchmark()は、MALLOC_PERTURB_環境変数を自動的に追加しません

定義されたベンチマークは、ビルドディレクトリ内でmeson test --benchmarkを呼び出すか、ninja benchmarkまたはmsbuild RUN_TESTS.vcxprojなどのバックエンド固有のコマンドを使用して、バックエンドに依存しない方法で実行できます。

# Creates a benchmark item that will be run when the benchmark target is
void benchmark(
  str                                                           name,           # The *unique* test id
  exe | jar | external_program | file | custom_tgt | custom_idx executable,     # The program to execute

  # Keyword arguments:
  args        : list[str | file | tgt | external_program]  # Arguments to pass to the executable
  depends     : list[build_tgt | custom_tgt]               # specifies that this test depends on the specified
  env         : env | list[str] | dict[str]                # environment variables to set, such as `['NAME1=value1',
  priority    : int                                        # specifies the priority of a test
  protocol    : str                                        # specifies how the test results are parsed and can
  should_fail : bool                                       # when true the test is considered passed if the
  suite       : str | list[str]                            # `'label'` (or list of labels `['label1', 'label2']`)
  timeout     : int                                        # the amount of seconds the test is allowed to run, a test
  verbose     : bool                                       # if true, forces the test results to be logged as if `--verbose` was passed
  workdir     : str                                        # absolute path that will be used as the working directory
)

引数

関数benchmark()は、次の位置引数を受け取ります。

最後に、benchmark()は、次のキーワード引数を受け取ります。

both_libraries()

指定されたソースから、スタティックライブラリと共有ライブラリの両方をビルドします。位置引数とキーワード引数は、library()と同じです。ソースファイルは1回だけコンパイルされ、オブジェクトファイルは共有ライブラリとスタティックライブラリの両方のビルドに再利用されます。ただし、b_staticpicユーザーオプションまたはpic引数がfalseに設定されている場合は、ソースが2回コンパイルされます。

# Builds both a static and shared library with the given sources
both_libs both_libraries(
  str                                                   target_name,     # The *unique* name of the build target
  str | file | custom_tgt | custom_idx | generated_list source...,       # Input source to compile

  # Keyword arguments:
  <lang>_args                  : list[str]                                                               # compiler flags to use for the given language;
  <lang>_pch                   : str                                                                     # precompiled header file to use for the given language
  <lang>_shared_args           : list[str]                                                               # Arguments that are only passed to a shared library
  <lang>_static_args           : list[str]                                                               # Arguments that are only passed to a static library
  build_by_default             : bool                                                                    # Causes, when set to `true`, to have this target be built by default
  build_rpath                  : str                                                                     # A string to add to target's rpath definition in the build dir,
  d_debug                      : list[str]                                                               # The [D version identifiers](https://dlang
  d_import_dirs                : list[inc | str]                                                         # the directories to add to the string search path (i
  d_module_versions            : list[str | int]                                                         # List of module version identifiers set when compiling D sources
  d_unittest                   : bool                                                                    # When set to true, the D modules are compiled in debug mode
  darwin_versions              : str | int | list[str]                                                   # Defines the `compatibility version` and `current version` for the dylib on macOS
  dependencies                 : list[dep]                                                               # one or more dependency objects
  extra_files                  : str | file | custom_tgt | custom_idx                                    # Not used for the build itself but are shown as source files in IDEs
  gnu_symbol_visibility        : str                                                                     # Specifies how symbols should be exported, see
  gui_app                      : bool                                                                    # When set to true flags this target as a GUI application
  implicit_include_directories : bool                                                                    # Controls whether Meson adds the current source and build directories to the include path
  include_directories          : list[inc | str]                                                         # one or more objects created with the include_directories() function,
  install                      : bool                                                                    # When set to true, this executable should be installed
  install_dir                  : str                                                                     # override install directory for this file
  install_mode                 : list[str | int]                                                         # Specify the file mode in symbolic format
  install_rpath                : str                                                                     # A string to set the target's rpath to after install
  install_tag                  : str                                                                     # A string used by the `meson install --tags` command
  link_args                    : list[str]                                                               # Flags to use during linking
  link_depends                 : str | file | custom_tgt | custom_idx                                    # Strings, files, or custom targets the link step depends on
  link_language                : str                                                                     # Makes the linker for this target be for the specified language
  link_whole                   : list[lib | custom_tgt | custom_idx]                                     # Links all contents of the given static libraries whether they are used or
  link_with                    : list[lib | custom_tgt | custom_idx]                                     # One or more shared or static libraries
  name_prefix                  : str | list[void]                                                        # The string that will be used as the prefix for the
  name_suffix                  : str | list[void]                                                        # The string that will be used as the extension for the
  native                       : bool                                                                    # Controls whether the target is compiled for the build or host machines
  objects                      : list[extracted_obj | file | str]                                        # List of object files that should be linked in this target
  override_options             : list[str] | dict[str | bool | int | list[str]]                            # takes an array of strings in the same format as `project`'s `default_options`
  pic                          : bool                                                                    # Builds the library as positional independent code
  prelink                      : bool                                                                    # If `true` the object files in the target will be prelinked,
  rust_abi                     : str                                                                     # Set the specific ABI to compile (when compiling rust)
  rust_crate_type              : str                                                                     # Set the specific type of rust crate to compile (when compiling rust)
  rust_dependency_map          : dict[str]                                                               # On rust targets this provides a map of library names to the crate name
  sources                      : str | file | custom_tgt | custom_idx | generated_list | structured_src  # Additional source files
  soversion                    : str | int                                                               # A string or integer specifying the soversion of this shared library,
  vala_args                    : list[str | file]                                                        # Compiler flags for Vala
  vala_shared_args             : list[str | file]                                                        # Arguments that are only passed to a shared library
  vala_static_args             : list[str | file]                                                        # Arguments that are only passed to a static library
  version                      : str                                                                     # A string specifying the version of this shared library,
  vs_module_defs               : str | file | custom_tgt | custom_idx                                    # Specify a Microsoft module definition file for controlling symbol exports,
  win_subsystem                : str                                                                     # Specifies the subsystem type to use
)

引数

関数both_libraries()は、以下の位置引数を受け付けます。

さらに、関数は0から無限の可変長引数（source...）を、str | file | custom_tgt | custom_idx | generated_list型で受け付けます。

コンパイルする入力ソース。以下の型がサポートされています。

• 現在のソースディレクトリからの相対パスを表す文字列
• 先行するビルドファイルで定義されたfileオブジェクト
• configure_file()などの設定時ジェネレーターの戻り値
• custom_target()やgenerator.process()などのビルド時ジェネレーターの戻り値

これらの入力ファイルは、ソース、オブジェクト、ライブラリ、その他のファイルにすることができます。Mesonは、拡張子に基づいて自動的に分類し、それに応じて使用します。たとえば、ソース（.c、.cpp、.vala、.rsなど）はコンパイルされ、オブジェクト（.o、.obj）とライブラリ（.so、.dllなど）はリンクされます。

Ninjaバックエンドでは、Mesonは、不明なファイルを含め、すべての生成された入力ファイルに対するビルド時順序のみの依存関係を作成します。これは、コンパイラーによって生成されたdepfileで実際の依存関係の生成をブートストラップし、ソースをいつリビルドするかを判断するために必要です。Ninjaは、生成されたファイルと生成されていないファイルの両方について、すべての入力ファイルに対してこの依存関係ファイルを使用します。この動作は他のバックエンドでも同様です。

最後に、both_libraries()は以下のキーワード引数を受け付けます。

build_target()

target_typeキーワード引数を使用して、型を動的に設定できるビルドターゲットを作成します。

target_typeは、次のいずれかに設定できます。

• executable（executable()を参照）
• shared_library（shared_library()を参照）
• shared_module（shared_module()を参照）
• static_library（static_library()を参照）
• both_libraries（both_libraries()を参照）
• library（library()を参照）
• jar（jar()を参照）*

この宣言

executable(<arguments and keyword arguments>)

はこれと同等です

build_target(<arguments and keyword arguments>, target_type : 'executable')

kwargs（sources、objects、dependenciesなど）のリストは常に平坦化されます。つまり、最終的なリストを作成する際に、自由にリストをネストおよび追加できます。

返されたオブジェクトには、build_tgtで説明されているメソッドもあります。

*「jar」は、他のbuild_targetタイプとは根本的に異なるため、非推奨になりました。

# Creates a build target whose type can be set dynamically with the
build_tgt build_target(
  str                                                   target_name,     # The *unique* name of the build target
  str | file | custom_tgt | custom_idx | generated_list source...,       # Input source to compile

  # Keyword arguments:
  <lang>_args                  : list[str]                                                               # compiler flags to use for the given language;
  <lang>_pch                   : str                                                                     # precompiled header file to use for the given language
  <lang>_shared_args           : list[str]                                                               # Arguments that are only passed to a shared library
  <lang>_static_args           : list[str]                                                               # Arguments that are only passed to a static library
  build_by_default             : bool                                                                    # Causes, when set to `true`, to have this target be built by default
  build_rpath                  : str                                                                     # A string to add to target's rpath definition in the build dir,
  d_debug                      : list[str]                                                               # The [D version identifiers](https://dlang
  d_import_dirs                : list[inc | str]                                                         # the directories to add to the string search path (i
  d_module_versions            : list[str | int]                                                         # List of module version identifiers set when compiling D sources
  d_unittest                   : bool                                                                    # When set to true, the D modules are compiled in debug mode
  darwin_versions              : str | int | list[str]                                                   # Defines the `compatibility version` and `current version` for the dylib on macOS
  dependencies                 : list[dep]                                                               # one or more dependency objects
  export_dynamic               : bool                                                                    # when set to true causes the target's symbols to be
  extra_files                  : str | file | custom_tgt | custom_idx                                    # Not used for the build itself but are shown as source files in IDEs
  gnu_symbol_visibility        : str                                                                     # Specifies how symbols should be exported, see
  gui_app                      : bool                                                                    # When set to true flags this target as a GUI application
  implib                       : bool | str                                                              # When set to true, an import library is generated for the
  implicit_include_directories : bool                                                                    # Controls whether Meson adds the current source and build directories to the include path
  include_directories          : list[inc | str]                                                         # one or more objects created with the include_directories() function,
  install                      : bool                                                                    # When set to true, this executable should be installed
  install_dir                  : str                                                                     # override install directory for this file
  install_mode                 : list[str | int]                                                         # Specify the file mode in symbolic format
  install_rpath                : str                                                                     # A string to set the target's rpath to after install
  install_tag                  : str                                                                     # A string used by the `meson install --tags` command
  java_resources               : structured_src                                                          # Resources to be added to the jar
  link_args                    : list[str]                                                               # Flags to use during linking
  link_depends                 : str | file | custom_tgt | custom_idx                                    # Strings, files, or custom targets the link step depends on
  link_language                : str                                                                     # Makes the linker for this target be for the specified language
  link_whole                   : list[lib | custom_tgt | custom_idx]                                     # Links all contents of the given static libraries whether they are used or
  link_with                    : list[lib | custom_tgt | custom_idx]                                     # One or more shared or static libraries
  main_class                   : str                                                                     # Main class for running the built jar
  name_prefix                  : str | list[void]                                                        # The string that will be used as the prefix for the
  name_suffix                  : str | list[void]                                                        # The string that will be used as the extension for the
  native                       : bool                                                                    # Controls whether the target is compiled for the build or host machines
  objects                      : list[extracted_obj | file | str]                                        # List of object files that should be linked in this target
  override_options             : list[str] | dict[str | bool | int | list[str]]                            # takes an array of strings in the same format as `project`'s `default_options`
  pic                          : bool                                                                    # Builds the library as positional independent code
  pie                          : bool                                                                    # Build a position-independent executable
  prelink                      : bool                                                                    # If `true` the object files in the target will be prelinked,
  rust_abi                     : str                                                                     # Set the specific ABI to compile (when compiling rust)
  rust_crate_type              : str                                                                     # Set the specific type of rust crate to compile (when compiling rust)
  rust_dependency_map          : dict[str]                                                               # On rust targets this provides a map of library names to the crate name
  sources                      : str | file | custom_tgt | custom_idx | generated_list | structured_src  # Additional source files
  soversion                    : str | int                                                               # A string or integer specifying the soversion of this shared library,
  target_type                  : str                                                                     # The actual target type to build
  vala_args                    : list[str | file]                                                        # Compiler flags for Vala
  vala_shared_args             : list[str | file]                                                        # Arguments that are only passed to a shared library
  vala_static_args             : list[str | file]                                                        # Arguments that are only passed to a static library
  version                      : str                                                                     # A string specifying the version of this shared library,
  vs_module_defs               : str | file | custom_tgt | custom_idx                                    # Specify a Microsoft module definition file for controlling symbol exports,
  win_subsystem                : str                                                                     # Specifies the subsystem type to use
)

引数

関数build_target()は、次の位置引数を受け入れます

さらに、関数は0から無限の可変長引数（source...）を、str | file | custom_tgt | custom_idx | generated_list型で受け付けます。

コンパイルする入力ソース。以下の型がサポートされています。

• 現在のソースディレクトリからの相対パスを表す文字列
• 先行するビルドファイルで定義されたfileオブジェクト
• configure_file()などの設定時ジェネレーターの戻り値
• custom_target()やgenerator.process()などのビルド時ジェネレーターの戻り値

これらの入力ファイルは、ソース、オブジェクト、ライブラリ、その他のファイルにすることができます。Mesonは、拡張子に基づいて自動的に分類し、それに応じて使用します。たとえば、ソース（.c、.cpp、.vala、.rsなど）はコンパイルされ、オブジェクト（.o、.obj）とライブラリ（.so、.dllなど）はリンクされます。

Ninjaバックエンドでは、Mesonは、不明なファイルを含め、すべての生成された入力ファイルに対するビルド時順序のみの依存関係を作成します。これは、コンパイラーによって生成されたdepfileで実際の依存関係の生成をブートストラップし、ソースをいつリビルドするかを判断するために必要です。Ninjaは、生成されたファイルと生成されていないファイルの両方について、すべての入力ファイルに対してこの依存関係ファイルを使用します。この動作は他のバックエンドでも同様です。

最後に、build_target()は次のキーワード引数を受け入れます

configuration_data()

空の構成オブジェクトを作成します。構成はcfg_dataメソッド呼び出しで追加し、最後にconfigure_file()の呼び出しで使用する必要があります。

# Creates an empty configuration object
cfg_data configuration_data(
  dict[str | bool | int] [data],   # Optional dictionary to specify an initial data set
)

引数

関数configuration_data()は、以下の位置引数を受け取ります。

configure_file()

この関数は、渡されるキーワード引数に応じて3つのモードで実行できます。

cfg_dataオブジェクトがconfiguration:キーワード引数に渡されると、input:（オプション）としてテンプレートファイルを受け取り、構成ファイルドキュメントで詳述されているように、構成データからの値を置換することで、output:（必須）を生成します。(0.49.0以降) cfg_dataオブジェクトの代わりに辞書を渡すことができます。

文字列のリストがcommand:キーワード引数に渡されると、任意のソースファイルまたは構成済みファイルをinput:として受け取り、指定されたコマンドが実行されたときにoutput:が生成されると想定します。

(0.47.0以降) copy:キーワード引数がtrueに設定されている場合、この関数は、input:で提供されたファイルを、現在のディレクトリのビルドディレクトリ内のoutput:という名前のファイルにコピーします。

# This function can run in three modes depending on the keyword arguments
file configure_file(
  capture       : bool                               # When this argument is set to true,
  command       : list[str | file]                   # As explained above, if specified, Meson does not create
  configuration : cfg_data | dict[str | int | bool]  # As explained above, when passed this will provide the replacement
  copy          : bool                               # As explained above, if specified Meson only
  depfile       : str                                # A dependency file that the command can write listing
  encoding      : str                                # Set the file encoding for the input and output file
  format        : str                                # The format of defines
  input         : str | file                         # The input file name
  install       : bool                               # When true, this generated file is installed during
  install_dir   : str                                # The subdirectory to install the generated file to
  install_mode  : list[str | int]                    # Specify the file mode in symbolic format
  install_tag   : str                                # A string used by the `meson install --tags` command
  macro_name    : str                                # When specified, macro guards will be used instead of '#pragma once'
  output        : str                                # The output file name
  output_format : str                                # The format of the output to generate when no input
)

引数

関数configure_file()は、以下のキーワード引数を受け取ります。

custom_target()

カスタムのトップレベルのビルドターゲットを作成します。唯一の位置引数は、このターゲットの名前であり、パス区切り文字（/または\）を含めることはできません。カスタムターゲットの名前は、すべてのバックエンドで使用されるとは限りません。たとえば、Ninjaバックエンドでは、以下の例を含むsubdir/meson.build、ninja -C builddir fooまたはninja -C builddir subdir/fooは機能しません。代わりに、ninja -C builddir subdir/file.txtになります。ただし、meson compile subdir/fooは受け入れられます。

custom_target('foo', output: 'file.txt', ...)

0.60.0以降、名前引数はオプションであり、最初の出力のベース名（上記の例ではfile.txt）がデフォルトになります。

commandキーワード引数に渡される文字列のリストは、以下の特別な文字列置換を受け入れます。

• @INPUT@：inputに渡された入力のフルパス。複数の入力が指定されている場合、コマンドがスタンドアロン引数として'@INPUT@'を使用する場合にのみ、それらすべてが個別の引数として置換されます。たとえば、command : ['cp', './@INPUT@']は機能しませんが、command : ['cp', '@INPUT@']は機能します。
• @OUTPUT@：outputに渡された出力のフルパス。複数の出力が指定されている場合、動作は@INPUT@と同じです。
• @INPUT0@ @INPUT1@ ...：inputで指定された配列インデックスを持つ入力のフルパス
• @OUTPUT0@ @OUTPUT1@ ...：outputで指定された配列インデックスを持つ出力のフルパス
• @OUTDIR@：出力が書き込まれるディレクトリのフルパス
• @DEPFILE@：depfileに渡された依存関係ファイルのフルパス
• @PLAINNAME@：パスなしの入力ファイル名
• @PLAINNAME0@ @PLAINNAME1@ ... (1.5.0以降)：パスなしの入力ファイル名、inputで指定された配列インデックスを持つ
• @BASENAME@：拡張子を削除した入力ファイル名
• @BASENAME0@ @BASENAME1@ ... (1.5.0以降)：拡張子を削除した入力ファイル名、inputで指定された配列インデックスを持つ
• @PRIVATE_DIR@ (0.50.1以降)：カスタムターゲットがすべての中間ファイルを格納する必要があるディレクトリへのパス。
• @SOURCE_ROOT@：ソースツリーのルートへのパス。バックエンドによっては、これは絶対パスであるか、現在の作業ディレクトリへの相対パスである可能性があります。
• @BUILD_ROOT@：ビルドツリーのルートへのパス。バックエンドによっては、これは絶対パスであるか、現在の作業ディレクトリへの相対パスである可能性があります。
• @CURRENT_SOURCE_DIR@：これは現在処理されているmeson.buildがあるディレクトリです。バックエンドによっては、これは絶対パスであるか、現在の作業ディレクトリへの相対パスである可能性があります。

(0.47.0以降) depfileキーワード引数も、@BASENAME@および@PLAINNAME@置換を受け入れます。

返されるオブジェクトには、custom_tgtで説明されているメソッドもあります。

# Create a custom top level build target
custom_tgt custom_target(
  str [name],   # The *unique* id of the custom target

  # Keyword arguments:
  build_always       : bool                                       # If `true` this target is always considered out of
  build_always_stale : bool                                       # If `true` the target is always considered out of date
  build_by_default   : bool                                       # Causes, when set to true, to
  capture            : bool                                       # There are some compilers that can't be told to write
  command            : list[str | file | exe | external_program]  # Command to run to create outputs from inputs
  console            : bool                                       # Keyword argument conflicts with `capture`, and is meant
  depend_files       : list[str | file]                           # files (str,
  depends            : list[build_tgt | custom_tgt | custom_idx]  # Specifies that this target depends on the specified
  depfile            : str                                        # A dependency file that the command can write listing
  env                : env | list[str] | dict[str]                # environment variables to set, such as
  feed               : bool                                       # There are some compilers that can't be told to read
  input              : list[str | file]                           # List of source files
  install            : bool                                       # When true, one or more files of this target are installed during the install step (see `install_dir` for details)
  install_dir        : str | list[str | bool]                     # If only one install_dir is provided, all outputs are installed there
  install_mode       : list[str | int]                            # The file mode and optionally the owner/uid and group/gid
  install_tag        : list[str]                                  # A list of strings, one per output, used by the `meson install --tags` command
  output             : list[str]                                  # List of output files
)

引数

関数custom_target()は、以下の位置引数を受け取ります。

最後に、custom_target()は以下のキーワード引数を受け取ります。

custom_target('different-install-dirs',
  output : ['first.file', 'second.file'],
  install : true,
  install_dir : ['somedir', 'otherdir'])

    custom_target('only-install-second',
      output : ['first.file', 'second.file'],
      install : true,
      install_dir : [false, 'otherdir'])

debug()

引数文字列をMesonビルドログに書き込みます。

# Write the argument string to the meson build log
void debug(
  str | int | bool | list[str | int | bool] | dict[str | int | bool] message,     # The message to print
  str | int | bool | list[str | int | bool] | dict[str | int | bool] msg...,      # Additional parameters will be separated by spaces
)

引数

関数debug()は、次の位置引数を受け入れます

さらに、関数は0から無限までの可変長引数（msg...）をstr | int | bool | list[str | int | bool] | dict[str | int | bool]の型で受け入れます。

追加のパラメーターはスペースで区切られます

declare_dependency()

この関数は、dependency()の戻り値のように動作するが、現在のビルド内部のdepオブジェクトを返します。これの主なユースケースはサブプロジェクトです。これにより、サブプロジェクトは、どのように使用されるべきかを簡単に指定できます。これにより、システムによって外部から提供される同じ依存関係と相互に交換可能になります。

# This function returns a dep object that
dep declare_dependency(
  compile_args        : list[str]                                                    # Compile arguments to use
  d_import_dirs       : list[inc | str]                                              # the directories to add to the string search path (i
  d_module_versions   : str | int | list[str | int]                                  # The [D version identifiers](https://dlang
  dependencies        : list[dep]                                                    # Other dependencies needed to use this dependency
  extra_files         : list[str | file]                                             # extra files to add to targets
  include_directories : list[inc | str]                                              # the directories to add to header search path,
  link_args           : list[str]                                                    # Link arguments to use
  link_whole          : list[lib]                                                    # Libraries to link fully, same as executable().
  link_with           : list[lib]                                                    # Libraries to link against
  objects             : list[extracted_obj]                                          # a list of object files, to be linked directly into the targets that use the
  sources             : list[str | file | custom_tgt | custom_idx | generated_list]  # sources to add to targets
  variables           : dict[str] | list[str]                                        # a dictionary of arbitrary strings,
  version             : str                                                          # the version of this dependency,
)

引数

関数declare_dependency()は、次のキーワード引数を受け入れます

dependency()

pkg-configを使用し、pkg-configが失敗した場合はCMakeを使用して、指定された名前の外部依存関係（通常はシステムにインストールされているライブラリ）を検索します。さらに、フレームワーク（OSXのみ）とライブラリ固有のフォールバック検出ロジックもサポートされています。

0.60.0以降複数の名前を指定できます。それらは順番に試行され、最初に見つかった名前が使用されます。システムで名前が見つからない場合にのみ、フォールバックサブプロジェクトが使用されます。名前のいずれかが見つかると、他のすべての名前がキャッシュに追加されるため、それらの名前に対する後続の呼び出しは同じ値を返します。これは、依存関係にpngやlibpngなどの異なる名前がある場合に役立ちます。

• 0.64.0以降WrapDBから依存関係のフォールバックを提供できます。meson wrap update-dbコマンドを使用してデータベースをローカルにダウンロードするだけで、依存関係がシステムで見つからず、プロジェクトに独自の.wrapファイルが付属していない場合、MesonはWrapDBによって提供されるサブプロジェクトに自動的にフォールバックします。

依存関係は、他の2つの方法でも解決できます

• dependencyの呼び出しの前にmeson.override_dependencyで同じ名前が使用された場合、オーバーライド依存関係は無条件に返されます。つまり、オーバーライド依存関係は、外部依存関係がシステムにインストールされているかどうかに関係なく使用されます。通常、meson.override_dependencyはサブプロジェクトによって使用されています。

• フォールバックサブプロジェクトによって、必要に応じて、あたかもsubproject()が呼び出されたかのように現在のビルド仕様に組み込まれます。サブプロジェクトは、fallback引数で指定できます。または、fallback引数が存在しない場合、0.55.0以降、Mesonは、ラップファイルが依存関係を提供している場合、またはサブプロジェクトが依存関係と同じ名前を持っている場合、サブプロジェクトをフォールバックとして自動的に識別できます。後者の場合、サブプロジェクトは、置換を指定するためにmeson.override_dependencyを使用する必要があります。そうしないと、Mesonはハードエラーを報告します。詳細については、ラップドキュメントを参照してください。この自動検索は、allow_fallbackキーワード引数を使用して制御できます。

dependency_nameが''の場合、依存関係は常に検出されません。したがって、required: falseの場合、これは常にfound()メソッドがfalseを返し、build_targetのdependencies:キーワード引数に他の依存関係と同様に渡すことができる依存関係オブジェクトを返します。これは、条件分岐の一部など、時々必要とされない依存関係を実装するために使用できます。または、fallback: kwargとともに、指定されたサブプロジェクトのみを検索し、--wrap-modeで許可されている場合にのみ検索するオプションの依存関係を宣言するために使用できます。

返されたオブジェクトdepには、追加のメソッドもあります。

# Finds an external dependency (usually a library installed on your
dep dependency(
  str names...,  # The names of the dependency to look up

  # Keyword arguments:
  allow_fallback    : bool                                          # Specifies whether Meson should automatically pick a fallback subproject
  default_options   : list[str] | dict[str | bool | int | list[str]]  # An array of default option values
  disabler          : bool                                          # Returns a disabler() object instead of a not-found dependency
  fallback          : list[str] | str                               # Manually specifies a subproject fallback
  include_type      : str                                           # An enum flag, marking how the dependency
  language          : str                                           # Defines what language-specific dependency to find
  method            : str                                           # Defines the way the dependency is detected, the default is
  native            : bool                                          # If set to `true`, causes Meson to find the dependency on
  not_found_message : str                                           # An optional string that will be printed as a message() if the dependency was not found.
  required          : bool | feature                                # When set to `false`, Meson will proceed with the build
  static            : bool                                          # Tells the dependency provider to try to get static
  version           : list[str] | str                               # Specifies the required version,
)

引数

関数は、型strの1から無限大までの可変引数（names...）を受け入れます。

ルックアップする依存関係の名前。依存関係は、ここに指定された順序でルックアップされます。最初に見つかった依存関係が使用されます。フォールバックサブプロジェクトは、システム上で名前が見つからない場合にのみ使用されます。名前の1つが見つかると、他のすべての名前がキャッシュに追加されるため、それらの名前に対する後続の呼び出しは同じ値を返します。これは、依存関係にpngやlibpngのように異なる名前がある場合に役立ちます。

注：0.60.0より前は、単一の依存関係名のみが許可されていました。

関数dependency()は、次のキーワード引数を受け入れます。

disabler()

disablerオブジェクトを返します。

disabler disabler()

environment()

空のenvオブジェクトを返します。

# Returns an empty env object.
env environment(
  str | list[str] | dict[str] | dict[list[str]] [env],   # If provided, each key/value pair is added into the env object

  # Keyword arguments:
  method    : str  # Must be one of 'set', 'prepend', or 'append'
  separator : str  # The separator to use for the initial values defined in
)

引数

引数の平坦化は、この関数ではサポートされていません。

関数environment()は、次の位置引数を受け入れます。

最後に、environment()は、次のキーワード引数を受け入れます。

error()

引数文字列を出力し、ビルドプロセスを停止します。

# Print the argument string and halts the build process
void error(
  str message,     # The message to print
  str msg...,      # Additional parameters will be separated by spaces
)

引数

引数の平坦化は、この関数ではサポートされていません。

関数error()は、次の位置引数を受け入れます。

さらに、関数は、型strの0から無限大までの可変引数（msg...）を受け入れます。

追加のパラメーターはスペースで区切られます

executable()

新しい実行可能ファイルを作成します。最初の引数はその名前を指定し、残りの位置引数は使用する入力ファイルを定義します。

kwargs（sources、objects、dependenciesなど）のリストは常に平坦化されます。つまり、最終的なリストを作成する際に、自由にリストをネストおよび追加できます。

返されたオブジェクトには、exeにドキュメント化されているメソッドもあります。

1.3.0以降、各ターゲットに異なるname_suffixがある限り、実行可能ファイル名は複数のターゲットで同じにすることができます。

# Creates a new executable
exe executable(
  str                                                   target_name,     # The *unique* name of the build target
  str | file | custom_tgt | custom_idx | generated_list source...,       # Input source to compile

  # Keyword arguments:
  <lang>_args                  : list[str]                                                               # compiler flags to use for the given language;
  <lang>_pch                   : str                                                                     # precompiled header file to use for the given language
  build_by_default             : bool                                                                    # Causes, when set to `true`, to have this target be built by default
  build_rpath                  : str                                                                     # A string to add to target's rpath definition in the build dir,
  d_debug                      : list[str]                                                               # The [D version identifiers](https://dlang
  d_import_dirs                : list[inc | str]                                                         # the directories to add to the string search path (i
  d_module_versions            : list[str | int]                                                         # List of module version identifiers set when compiling D sources
  d_unittest                   : bool                                                                    # When set to true, the D modules are compiled in debug mode
  dependencies                 : list[dep]                                                               # one or more dependency objects
  export_dynamic               : bool                                                                    # when set to true causes the target's symbols to be
  extra_files                  : str | file | custom_tgt | custom_idx                                    # Not used for the build itself but are shown as source files in IDEs
  gnu_symbol_visibility        : str                                                                     # Specifies how symbols should be exported, see
  gui_app                      : bool                                                                    # When set to true flags this target as a GUI application
  implib                       : bool | str                                                              # When set to true, an import library is generated for the
  implicit_include_directories : bool                                                                    # Controls whether Meson adds the current source and build directories to the include path
  include_directories          : list[inc | str]                                                         # one or more objects created with the include_directories() function,
  install                      : bool                                                                    # When set to true, this executable should be installed
  install_dir                  : str                                                                     # override install directory for this file
  install_mode                 : list[str | int]                                                         # Specify the file mode in symbolic format
  install_rpath                : str                                                                     # A string to set the target's rpath to after install
  install_tag                  : str                                                                     # A string used by the `meson install --tags` command
  link_args                    : list[str]                                                               # Flags to use during linking
  link_depends                 : str | file | custom_tgt | custom_idx                                    # Strings, files, or custom targets the link step depends on
  link_language                : str                                                                     # Makes the linker for this target be for the specified language
  link_whole                   : list[lib | custom_tgt | custom_idx]                                     # Links all contents of the given static libraries whether they are used or
  link_with                    : list[lib | custom_tgt | custom_idx]                                     # One or more shared or static libraries
  name_prefix                  : str | list[void]                                                        # The string that will be used as the prefix for the
  name_suffix                  : str | list[void]                                                        # The string that will be used as the extension for the
  native                       : bool                                                                    # Controls whether the target is compiled for the build or host machines
  objects                      : list[extracted_obj | file | str]                                        # List of object files that should be linked in this target
  override_options             : list[str] | dict[str | bool | int | list[str]]                            # takes an array of strings in the same format as `project`'s `default_options`
  pie                          : bool                                                                    # Build a position-independent executable
  rust_crate_type              : str                                                                     # Set the specific type of rust crate to compile (when compiling rust)
  rust_dependency_map          : dict[str]                                                               # On rust targets this provides a map of library names to the crate name
  sources                      : str | file | custom_tgt | custom_idx | generated_list | structured_src  # Additional source files
  vala_args                    : list[str | file]                                                        # Compiler flags for Vala
  vs_module_defs               : str | file | custom_tgt | custom_idx                                    # Specify a Microsoft module definition file for controlling symbol exports,
  win_subsystem                : str                                                                     # Specifies the subsystem type to use
)

引数

関数executable()は、次の位置引数を受け入れます。

さらに、関数は0から無限の可変長引数（source...）を、str | file | custom_tgt | custom_idx | generated_list型で受け付けます。

コンパイルする入力ソース。以下の型がサポートされています。

• 現在のソースディレクトリからの相対パスを表す文字列
• 先行するビルドファイルで定義されたfileオブジェクト
• configure_file()などの設定時ジェネレーターの戻り値
• custom_target()やgenerator.process()などのビルド時ジェネレーターの戻り値

これらの入力ファイルは、ソース、オブジェクト、ライブラリ、その他のファイルにすることができます。Mesonは、拡張子に基づいて自動的に分類し、それに応じて使用します。たとえば、ソース（.c、.cpp、.vala、.rsなど）はコンパイルされ、オブジェクト（.o、.obj）とライブラリ（.so、.dllなど）はリンクされます。

Ninjaバックエンドでは、Mesonは、不明なファイルを含め、すべての生成された入力ファイルに対するビルド時順序のみの依存関係を作成します。これは、コンパイラーによって生成されたdepfileで実際の依存関係の生成をブートストラップし、ソースをいつリビルドするかを判断するために必要です。Ninjaは、生成されたファイルと生成されていないファイルの両方について、すべての入力ファイルに対してこの依存関係ファイルを使用します。この動作は他のバックエンドでも同様です。

最後に、executable()は、次のキーワード引数を受け入れます。

files()

このコマンドは、引数で与えられた文字列を取得し、ビルドターゲットのソースとして使用できる対応するファイルオブジェクトを返します。違いは、ファイルオブジェクトは定義されたサブディレクトリを記憶し、ソースツリーのどこでも使用できることです。

# This command takes the strings given to it in arguments and returns
list[file] files(
  str file...,  # Path to the file
)

例

例として、サブディレクトリbar1にソースファイルfoo.cppがあり、bar2で定義されたビルドターゲットで使用したいとします。これを行うには、最初にbar1に次のようにオブジェクトを作成します。

    foofile = files('foo.cpp')

次に、次のようにbar2で使用できます。

    executable('myprog', 'myprog.cpp', foofile, ...)

Mesonはその後、適切な処理を行います。

引数

関数は、型strの0から無限大までの可変引数（file...）を受け入れます。

ファイルへのパス。

find_program()

ここでのprogram_nameは、PATHまたはプロジェクト内の他の場所で検索される実行可能ファイルまたはスクリプトにすることができる文字列です。検索順序は次のとおりです。

1. meson.override_find_program()を介して設定されたプログラムのオーバーライド。
2. wrap_modeがforcefallbackに設定されている場合、サブプロジェクトのラップファイルの[provide]セクション。
3. マシンファイルの[binaries]セクション。
4. dirs: kwargを使用して提供されるディレクトリ（下記参照）。
5. 現在のサブディレクトリを基準としたプロジェクトのソースツリー。
   • configure_file()の戻り値を使用する場合、ビルドツリー内の現在のサブディレクトリが代わりに使用されます。
6. PATH環境変数。
7. wrap_modeがnofallback以外の何かに設定されている場合、サブプロジェクトのラップファイルの[provide]セクション。

また、Mesonは、Windows（コマンドインボーカーがそれ以外の場合コマンドを拒否するため）とUnix系（スクリプトファイルに実行可能ビットが設定されていない場合）の両方で、シェバン行を持つスクリプトを自動検出して、その中で指定された実行可能ファイル/インタープリターで実行します。したがって、このスクリプトをコマンドのリストの一部として使用している間は、インタープリターを手動で追加してはいけません。0.50.0以降、システムで「python3」プログラムが要求されていて見つからない場合、Mesonは現在のインタープリターを返します。

標準的な場所以外にあるプログラムをチェックする必要がある場合は、find_program に絶対パスを渡すだけで済みます。例:

setcap = find_program('setcap', '/usr/sbin/setcap', '/sbin/setcap', required : false)

検索パスのセットを動的に構築する必要がある場合は、find_program に配列を渡すことも可能です。

setcap = find_program(['setcap', '/usr/sbin/setcap', '/sbin/setcap'], required : false)

1.2.0 以降 find_program('meson') は、ビルドスクリプトの実行に使用される Meson コマンドに自動的にオーバーライドされます。

返される external_program オブジェクトには、ドキュメント化されたメソッドもあります。

# `program_name` here is a string that can be an executable or script
external_program find_program(
  str | file program_name,     # The name of the program to search, or a file object to be used
  str | file fallback...,      # These parameters are used as fallback names to search for

  # Keyword arguments:
  default_options  : list[str] | dict[str | bool | int | list[str]]  # An array of default option values
  dirs             : list[str]                                     # extra list of absolute paths where to look for program names
  disabler         : bool                                          # If `true` and the program couldn't be found, return a disabler object
  native           : bool                                          # Defines how this executable should be searched
  required         : bool | feature                                # When `true`, Meson will abort if no program can be found
  version          : str | list[str]                               # Specifies the required version, see
  version_argument : str                                           # Specifies the argument to pass when trying to find the version of the program
)

引数

関数 find_program() は、次の位置引数を受け入れます。

さらに、関数は 0 から infinity までの可変長引数 (fallback...) を、型 str | file で受け入れます。

これらのパラメータは、検索するフォールバック名として使用されます。これは、プログラムに foo や foo.py など、多くの代替名がある場合に使用することを意図しています。関数は引数を1つずつチェックし、最初に見つかったものが返されます。

最後に、find_program() は次のキーワード引数を受け入れます。

generator()

こちらも参照: custom_target()

この関数は、カスタムコンパイルコマンドを実行するために使用できる generator オブジェクトを作成します。唯一の位置引数は、使用する実行可能ファイルです。これは、自己構築された実行可能ファイル、または find_program によって返された実行可能ファイルのいずれかです。

すべてのキーワード引数に渡されるテンプレート文字列は、次の特別な置換を受け入れます。

• @PLAINNAME@: 完全な入力ファイル名。例: foo.c は foo.c (変更なし) になります
• @BASENAME@: 入力ファイル名のベース。例: foo.c.y は foo.c (拡張子が削除される) になります

output キーワード引数に渡される各文字列は、これらの2つの置換の1つ以上を使用して構築する必要があります。

上記の置換に加えて、arguments キーワード引数は次のものも受け入れます。

• @OUTPUT@: 出力ファイルへのフルパス
• @INPUT@: 入力ファイルへのフルパス
• @DEPFILE@: depfile へのフルパス
• @SOURCE_DIR@: ソースツリーのルートへのフルパス
• @CURRENT_SOURCE_DIR@: これは、現在処理されている meson.build があるディレクトリです
• @BUILD_DIR@: 出力が配置されるビルドディレクトリのルートへのフルパス

注: ジェネレーターは、build_target() または custom_target() の入力としてのみ使用される出力に対してのみ使用する必要があります。ジェネレーターの処理済み出力を複数のターゲットで使用する場合、ジェネレーターは各ターゲットの出力を生成するために複数回実行されます。各出力は、ターゲット固有のディレクトリ @BUILD_DIR@ に作成されます。

複数のソースで使用されるヘッダーの生成や、インストールされるデータの生成など、一般的な目的でファイルを生成する場合は、代わりに custom_target() を使用してください。

# See also: custom_target()
generator generator(
  exe | external_program exe,     # Executable for the command to run

  # Keyword arguments:
  arguments : list[str]                                  # A list of template strings that will be the command line arguments passed to the executable
  capture   : bool                                       # When this argument is set to true, Meson captures `stdout`
  depends   : list[build_tgt | custom_tgt | custom_idx]  # An array of build targets that must be built before
  depfile   : str                                        # A template string pointing to a dependency file that a
  output    : list[str]                                  # Template string (or list of template strings) defining
)

引数

関数 generator() は、次の位置引数を受け入れます。

最後に、generator() は次のキーワード引数を受け入れます。