meson-docs/0000755000175000017500000000000014656633773012533 5ustar lattislattismeson-docs/meson.build0000644000175000017500000000115014656633773014672 0ustar lattislattisproject('meson') genrefman = find_program('docs/genrefman.py') meson_reference_3 = custom_target( 'meson_reference.3', output: 'meson-reference.3', command: [ genrefman, '-q', '-l', 'fastyaml', '-g', 'man', '-o', '@OUTPUT@', '--no-modules', ], install: true, install_dir: get_option('mandir') / 'man3', ) signatures = custom_target( 'signatures.txt', output: 'signatures.txt', command: [ genrefman, '-q', '-l', 'fastyaml', '-g', 'types', '-o', '@OUTPUT@', '--no-modules', ], ) meson-docs/COPYING0000644000175000017500000002613614656633773013576 0ustar lattislattis Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. meson-docs/docs/0000755000175000017500000000000014656633773013463 5ustar lattislattismeson-docs/docs/refman/0000755000175000017500000000000014656633773014733 5ustar lattislattismeson-docs/docs/refman/generatorbase.py0000644000175000017500000000420414656633773020126 0ustar lattislattis# SPDX-License-Identifier: Apache-2.0 # Copyright 2021 The Meson development team from abc import ABCMeta, abstractmethod import typing as T from .model import ReferenceManual, Function, Method, Object, ObjectType, NamedObject _N = T.TypeVar('_N', bound=NamedObject) class GeneratorBase(metaclass=ABCMeta): def __init__(self, manual: ReferenceManual) -> None: self.manual = manual @abstractmethod def generate(self) -> None: pass @staticmethod def brief(raw: _N) -> str: desc_lines = raw.description.split('\n') brief = desc_lines[0] if '.' in brief and '[[' not in brief: brief = brief[:brief.index('.')] return brief.strip() @staticmethod def sorted_and_filtered(raw: T.List[_N]) -> T.List[_N]: def key_fn(fn: NamedObject) -> str: if isinstance(fn, Method): return f'1_{fn.obj.name}.{fn.name}' return f'0_{fn.name}' return sorted([x for x in raw if not x.hidden], key=key_fn) @staticmethod def _extract_meson_version() -> str: from mesonbuild.coredata import version return version @property def functions(self) -> T.List[Function]: return GeneratorBase.sorted_and_filtered(self.manual.functions) @property def objects(self) -> T.List[Object]: return GeneratorBase.sorted_and_filtered(self.manual.objects) @property def elementary(self) -> T.List[Object]: return [x for x in self.objects if x.obj_type == ObjectType.ELEMENTARY] @property def builtins(self) -> T.List[Object]: return [x for x in self.objects if x.obj_type == ObjectType.BUILTIN] @property def returned(self) -> T.List[Object]: return [x for x in self.objects if x.obj_type == ObjectType.RETURNED and x.defined_by_module is None] @property def modules(self) -> T.List[Object]: return [x for x in self.objects if x.obj_type == ObjectType.MODULE] def extract_returned_by_module(self, module: Object) -> T.List[Object]: return [x for x in self.objects if x.obj_type == ObjectType.RETURNED and x.defined_by_module is module] meson-docs/docs/refman/generatorvim.py0000644000175000017500000000225414656633773020012 0ustar lattislattis# SPDX-License-Identifier: Apache-2.0 # Copyright 2023 The Meson development team from __future__ import annotations from pathlib import Path from .generatorbase import GeneratorBase from .model import ReferenceManual class GeneratorVim(GeneratorBase): def __init__(self, manual: ReferenceManual, out_dir: Path) -> None: super().__init__(manual) self.out_dir = out_dir def generate(self) -> None: template_dir = Path(__file__).resolve().parent / 'templates' outname = 'meson.vim' template_name = f'{outname}.mustache' template_file = template_dir / template_name builtin_funcs = [f.name for f in self.sorted_and_filtered(self.functions)] data = { 'builtin_funcs': '\n \\ '.join(builtin_funcs) } # Import here, so that other generators don't also depend on it import chevron result = chevron.render( template=template_file.read_text(encoding='utf-8'), data=data, warn=True, ) self.out_dir.mkdir(parents=True, exist_ok=True) out_file = self.out_dir / outname out_file.write_text(result, encoding='utf-8') meson-docs/docs/refman/jsonschema.py0000644000175000017500000000730414656633773017443 0ustar lattislattis# SPDX-License-Identifier: Apache-2.0 # Copyright 2021 The Meson development team import typing as T # The following variables define the current version of # the JSON documentation format. This is different from # the Meson version VERSION_MAJOR = 1 # Changes here indicate breaking format changes (changes to existing keys) VERSION_MINOR = 1 # Changes here indicate non-breaking changes (only new keys are added to the existing structure) if T.TYPE_CHECKING: from typing_extensions import TypedDict class BaseObject(TypedDict): ''' Base object for most dicts in the JSON doc. All objects inheriting from BaseObject will support the keys specified here: ''' name: str description: str since: T.Optional[str] deprecated: T.Optional[str] notes: T.List[str] warnings: T.List[str] class Type(TypedDict): obj: str # References an object from `root.objects` holds: T.Sequence[object] # Mypy does not support recursive dicts, but this should be T.List[Type]... class Argument(BaseObject): ''' Object that represents any type of a single function or method argument. ''' type: T.List[Type] # A non-empty list of types that are supported. type_str: str # Formatted version of `type`. Is guaranteed to not contain any whitespaces. required: bool default: T.Optional[str] min_varargs: T.Optional[int] # Only relevant for varargs, must be `null` for all other types of arguments max_varargs: T.Optional[int] # Only relevant for varargs, must be `null` for all other types of arguments class Function(BaseObject): ''' Represents a function or method. ''' returns: T.List[Type] # A non-empty list of types that are supported. returns_str: str # Formatted version of `returns`. Is guaranteed to not contain any whitespaces. example: T.Optional[str] posargs: T.Dict[str, Argument] optargs: T.Dict[str, Argument] kwargs: T.Dict[str, Argument] varargs: T.Optional[Argument] arg_flattening: bool class Object(BaseObject): ''' Represents all types of Meson objects. The specific object type is stored in the `object_type` field. ''' example: T.Optional[str] object_type: str # Defines the object type: Must be one of: ELEMENTARY, BUILTIN, MODULE, RETURNED methods: T.Dict[str, Function] is_container: bool extends: T.Optional[str] returned_by: T.List[str] extended_by: T.List[str] defined_by_module: T.Optional[str] class ObjectsByType(TypedDict): ''' References to other objects are stored here for ease of navigation / filtering ''' elementary: T.List[str] builtins: T.List[str] returned: T.List[str] modules: T.Dict[str, T.List[str]] class Root(TypedDict): ''' The root object of the JSON reference manual ''' version_major: int # See the description above for version_minor: int # VERSION_MAJOR and VERSION_MINOR meson_version: str functions: T.Dict[str, Function] # A mapping of to a `Function` object for *all* Meson functions objects: T.Dict[str, Object] # A mapping of to a `Object` object for *all* Meson objects (including modules, elementary, etc.) objects_by_type: ObjectsByType meson-docs/docs/refman/loaderpickle.py0000644000175000017500000000116614656633773017747 0ustar lattislattis# SPDX-License-Identifier: Apache-2.0 # Copyright 2021 The Meson development team from pathlib import Path import pickle from .loaderbase import LoaderBase from .model import ReferenceManual class LoaderPickle(LoaderBase): def __init__(self, in_file: Path) -> None: super().__init__() self.in_file = in_file def load_impl(self) -> ReferenceManual: res = pickle.loads(self.in_file.read_bytes()) assert isinstance(res, ReferenceManual) return res # Assume that the pickled data is OK and skip validation def load(self) -> ReferenceManual: return self.load_impl() meson-docs/docs/refman/__init__.py0000644000175000017500000000000014656633773017032 0ustar lattislattismeson-docs/docs/refman/generatorjson.py0000644000175000017500000001127214656633773020170 0ustar lattislattis# SPDX-License-Identifier: Apache-2.0 # Copyright 2021 The Meson development team from __future__ import annotations from pathlib import Path import json import re from .generatorbase import GeneratorBase from . import jsonschema as J from .model import ( ReferenceManual, Function, Object, Type, PosArg, VarArgs, Kwarg, ) import typing as T class GeneratorJSON(GeneratorBase): def __init__(self, manual: ReferenceManual, out: Path, enable_modules: bool) -> None: super().__init__(manual) self.out = out self.enable_modules = enable_modules def _generate_type(self, typ: Type) -> T.List[J.Type]: return [ { 'obj': x.data_type.name, 'holds': self._generate_type(x.holds) if x.holds else [], } for x in typ.resolved ] def _generate_type_str(self, typ: Type) -> str: # Remove all whitespaces return re.sub(r'[ \n\r\t]', '', typ.raw) def _generate_arg(self, arg: T.Union[PosArg, VarArgs, Kwarg], isOptarg: bool = False) -> J.Argument: return { 'name': arg.name, 'description': arg.description, 'since': arg.since if arg.since else None, 'deprecated': arg.deprecated if arg.deprecated else None, 'type': self._generate_type(arg.type), 'type_str': self._generate_type_str(arg.type), 'required': arg.required if isinstance(arg, Kwarg) else not isOptarg and not isinstance(arg, VarArgs), 'default': arg.default if isinstance(arg, (PosArg, Kwarg)) else None, 'min_varargs': arg.min_varargs if isinstance(arg, VarArgs) and arg.min_varargs > 0 else None, 'max_varargs': arg.max_varargs if isinstance(arg, VarArgs) and arg.max_varargs > 0 else None, # Not yet supported 'notes': [], 'warnings': [], } def _generate_function(self, func: Function) -> J.Function: return { 'name': func.name, 'description': func.description, 'since': func.since if func.since else None, 'deprecated': func.deprecated if func.deprecated else None, 'notes': func.notes, 'warnings': func.warnings, 'example': func.example if func.example else None, 'returns': self._generate_type(func.returns), 'returns_str': self._generate_type_str(func.returns), 'posargs': {x.name: self._generate_arg(x) for x in func.posargs}, 'optargs': {x.name: self._generate_arg(x, True) for x in func.optargs}, 'kwargs': {x.name: self._generate_arg(x) for x in self.sorted_and_filtered(list(func.kwargs.values()))}, 'varargs': self._generate_arg(func.varargs) if func.varargs else None, 'arg_flattening': func.arg_flattening, } def _generate_objects(self, obj: Object) -> J.Object: return { 'name': obj.name, 'description': obj.description, 'since': obj.since if obj.since else None, 'deprecated': obj.deprecated if obj.deprecated else None, 'notes': obj.notes, 'warnings': obj.warnings, 'defined_by_module': obj.defined_by_module.name if obj.defined_by_module else None, 'object_type': obj.obj_type.name, 'is_container': obj.is_container, 'example': obj.example if obj.example else None, 'extends': obj.extends if obj.extends else None, 'returned_by': [x.name for x in self.sorted_and_filtered(obj.returned_by)], 'extended_by': [x.name for x in self.sorted_and_filtered(obj.extended_by)], 'methods': {x.name: self._generate_function(x) for x in self.sorted_and_filtered(obj.methods)}, } def generate(self) -> None: data: J.Root = { 'version_major': J.VERSION_MAJOR, 'version_minor': J.VERSION_MINOR, 'meson_version': self._extract_meson_version(), 'functions': {x.name: self._generate_function(x) for x in self.sorted_and_filtered(self.functions)}, 'objects': {x.name: self._generate_objects(x) for x in self.sorted_and_filtered(self.objects)}, 'objects_by_type': { 'elementary': [x.name for x in self.elementary], 'builtins': [x.name for x in self.builtins], 'returned': [x.name for x in self.returned], 'modules': { x.name: [y.name for y in self.sorted_and_filtered(self.extract_returned_by_module(x))] for x in self.modules }, }, } self.out.write_text(json.dumps(data), encoding='utf-8') meson-docs/docs/refman/model.py0000644000175000017500000000404214656633773016405 0ustar lattislattis# SPDX-License-Identifier: Apache-2.0 # Copyright 2021 The Meson development team from dataclasses import dataclass, field from enum import Enum import typing as T # Utils @dataclass class NamedObject: name: str description: str @property def hidden(self) -> bool: return self.name.startswith('_') @dataclass class FetureCheck: since: str deprecated: str @dataclass class DataTypeInfo: data_type: 'Object' holds: T.Optional['Type'] @dataclass class Type: raw: str resolved: T.List[DataTypeInfo] = field(init=False, default_factory=list) # Arguments @dataclass class ArgBase(NamedObject, FetureCheck): type: Type @dataclass class PosArg(ArgBase): default: str @dataclass class VarArgs(ArgBase): min_varargs: int max_varargs: int @dataclass class Kwarg(ArgBase): required: bool default: str # Function @dataclass class Function(NamedObject, FetureCheck): notes: T.List[str] warnings: T.List[str] returns: Type example: str posargs: T.List[PosArg] optargs: T.List[PosArg] varargs: T.Optional[VarArgs] kwargs: T.Dict[str, Kwarg] posargs_inherit: str optargs_inherit: str varargs_inherit: str kwargs_inherit: T.List[str] arg_flattening: bool @dataclass class Method(Function): obj: 'Object' # Types and objects class ObjectType(Enum): ELEMENTARY = 0 BUILTIN = 1 MODULE = 2 RETURNED = 3 @dataclass class Object(NamedObject, FetureCheck): notes: T.List[str] warnings: T.List[str] long_name: str example: str obj_type: ObjectType methods: T.List[Method] is_container: bool extends: str extends_obj: T.Optional['Object'] = None defined_by_module: T.Optional['Object'] = None returned_by: T.List[T.Union[Function, Method]] = field(default_factory=list) extended_by: T.List['Object'] = field(default_factory=list) inherited_methods: T.List[Method] = field(default_factory=list) # ROOT @dataclass class ReferenceManual: functions: T.List[Function] objects: T.List[Object] meson-docs/docs/refman/loaderyaml.py0000644000175000017500000002401414656633773017437 0ustar lattislattis# SPDX-License-Identifier: Apache-2.0 # Copyright 2021 The Meson development team from .loaderbase import LoaderBase from .model import ( Type, PosArg, VarArgs, Kwarg, Function, Method, ObjectType, Object, ReferenceManual, ) from mesonbuild import mlog from mesonbuild import mesonlib from pathlib import Path import typing as T class Template: d_feature_check: T.Dict[str, T.Any] = {} s_posarg: T.Dict[str, T.Any] = {} s_varargs: T.Dict[str, T.Any] = {} s_kwarg: T.Dict[str, T.Any] = {} s_function: T.Dict[str, T.Any] = {} s_object: T.Dict[str, T.Any] = {} class StrictTemplate(Template): def __init__(self) -> None: from strictyaml import Map, MapPattern, Optional, Str, Seq, Int, Bool, EmptyList, OrValidator # type: ignore[import-untyped] d_named_object = { 'name': Str(), 'description': Str(), } d_feture_check = { Optional('since', default=''): Str(), Optional('deprecated', default=''): Str(), } self.s_posarg = Map({ **d_feture_check, 'description': Str(), 'type': Str(), Optional('default', default=''): Str(), }) self.s_varargs = Map({ **d_named_object, **d_feture_check, 'type': Str(), Optional('min_varargs', default=-1): Int(), Optional('max_varargs', default=-1): Int(), }) self.s_kwarg = Map({ **d_feture_check, 'type': Str(), 'description': Str(), Optional('required', default=False): Bool(), Optional('default', default=''): Str(), }) self.s_function = Map({ **d_named_object, **d_feture_check, 'returns': Str(), Optional('notes', default=[]): OrValidator(Seq(Str()), EmptyList()), Optional('warnings', default=[]): OrValidator(Seq(Str()), EmptyList()), Optional('example', default=''): Str(), Optional('posargs'): MapPattern(Str(), self.s_posarg), Optional('optargs'): MapPattern(Str(), self.s_posarg), Optional('varargs'): self.s_varargs, Optional('posargs_inherit', default=''): Str(), Optional('optargs_inherit', default=''): Str(), Optional('varargs_inherit', default=''): Str(), Optional('kwargs'): MapPattern(Str(), self.s_kwarg), Optional('kwargs_inherit', default=[]): OrValidator(OrValidator(Seq(Str()), EmptyList()), Str()), Optional('arg_flattening', default=True): Bool(), }) self.s_object = Map({ **d_named_object, **d_feture_check, 'long_name': Str(), Optional('extends', default=''): Str(), Optional('notes', default=[]): OrValidator(Seq(Str()), EmptyList()), Optional('warnings', default=[]): OrValidator(Seq(Str()), EmptyList()), Optional('example', default=''): Str(), Optional('methods'): Seq(self.s_function), Optional('is_container', default=False): Bool() }) class FastTemplate(Template): d_feature_check: T.Dict[str, T.Any] = { 'since': '', 'deprecated': '', } s_posarg = { **d_feature_check, 'default': '', } s_varargs: T.Dict[str, T.Any] = { **d_feature_check, 'min_varargs': -1, 'max_varargs': -1, } s_kwarg = { **d_feature_check, 'required': False, 'default': '', } s_function = { **d_feature_check, 'notes': [], 'warnings': [], 'example': '', 'posargs': {}, 'optargs': {}, 'varargs': None, 'posargs_inherit': '', 'optargs_inherit': '', 'varargs_inherit': '', 'kwargs': {}, 'kwargs_inherit': [], 'arg_flattening': True, } s_object = { **d_feature_check, 'extends': '', 'notes': [], 'warnings': [], 'example': '', 'methods': [], 'is_container': False, } class LoaderYAML(LoaderBase): def __init__(self, yaml_dir: Path, strict: bool=True) -> None: super().__init__() self.yaml_dir = yaml_dir self.func_dir = self.yaml_dir / 'functions' self.elem_dir = self.yaml_dir / 'elementary' self.objs_dir = self.yaml_dir / 'objects' self.builtin_dir = self.yaml_dir / 'builtins' self.modules_dir = self.yaml_dir / 'modules' self.strict = strict template: Template if self.strict: import strictyaml def loader(file: str, template: T.Any, label: str) -> T.Dict: r: T.Dict = strictyaml.load(file, template, label=label).data return r self._load = loader template = StrictTemplate() else: import yaml from yaml import CLoader def loader(file: str, template: T.Any, label: str) -> T.Dict: return {**template, **yaml.load(file, Loader=CLoader)} self._load = loader template = FastTemplate() self.template = template def _fix_default(self, v: T.Dict) -> None: if v["default"] is False: v["default"] = "false" elif v["default"] is True: v["default"] = "true" else: v["default"] = str(v["default"]) def _process_function_base(self, raw: T.Dict, obj: T.Optional[Object] = None) -> Function: # Handle arguments posargs = raw.pop('posargs', {}) optargs = raw.pop('optargs', {}) varargs = raw.pop('varargs', None) kwargs = raw.pop('kwargs', {}) # Fix kwargs_inherit if isinstance(raw['kwargs_inherit'], str): raw['kwargs_inherit'] = [raw['kwargs_inherit']] # Parse args posargs_mapped: T.List[PosArg] = [] optargs_mapped: T.List[PosArg] = [] varargs_mapped: T.Optional[VarArgs] = None kwargs_mapped: T.Dict[str, Kwarg] = {} for k, v in posargs.items(): if not self.strict: v = {**self.template.s_posarg, **v} self._fix_default(v) v['type'] = Type(v['type']) posargs_mapped += [PosArg(name=k, **v)] for k, v in optargs.items(): if not self.strict: v = {**self.template.s_posarg, **v} self._fix_default(v) v['type'] = Type(v['type']) optargs_mapped += [PosArg(name=k, **v)] for k, v in kwargs.items(): if not self.strict: v = {**self.template.s_kwarg, **v} self._fix_default(v) v['type'] = Type(v['type']) kwargs_mapped[k] = Kwarg(name=k, **v) if varargs is not None: if not self.strict: varargs = {**self.template.s_varargs, **varargs} varargs['type'] = Type(varargs['type']) varargs_mapped = VarArgs(**varargs) raw['returns'] = Type(raw['returns']) # Build function object if obj is not None: return Method( posargs=posargs_mapped, optargs=optargs_mapped, varargs=varargs_mapped, kwargs=kwargs_mapped, obj=obj, **raw, ) return Function( posargs=posargs_mapped, optargs=optargs_mapped, varargs=varargs_mapped, kwargs=kwargs_mapped, **raw, ) def _load_function(self, path: Path, obj: T.Optional[Object] = None) -> Function: path_label = path.relative_to(self.yaml_dir).as_posix() mlog.log('Loading', mlog.bold(path_label)) raw = self._load(self.read_file(path), self.template.s_function, label=path_label) return self._process_function_base(raw) def _load_object(self, obj_type: ObjectType, path: Path) -> Object: path_label = path.relative_to(self.yaml_dir).as_posix() mlog.log(f'Loading', mlog.bold(path_label)) raw = self._load(self.read_file(path), self.template.s_object, label=path_label) def as_methods(mlist: T.List[Function]) -> T.List[Method]: res: T.List[Method] = [] for i in mlist: assert isinstance(i, Method) res += [i] return res methods = raw.pop('methods', []) obj = Object(methods=[], obj_type=obj_type, **raw) newmethods = [] for x in methods: if not self.strict: x = {**self.template.s_function, **x} newmethods += [self._process_function_base(x, obj)] obj.methods = as_methods(newmethods) return obj def _load_module(self, path: Path) -> T.List[Object]: assert path.is_dir() module = self._load_object(ObjectType.MODULE, path / 'module.yaml') objs = [] for p in path.iterdir(): if p.name == 'module.yaml': continue obj = self._load_object(ObjectType.RETURNED, p) obj.defined_by_module = module objs += [obj] return [module, *objs] def load_impl(self) -> ReferenceManual: mlog.log('Loading YAML reference manual') with mlog.nested(): manual = ReferenceManual( functions=[self._load_function(x) for x in self.func_dir.iterdir()], objects=mesonlib.listify([ [self._load_object(ObjectType.ELEMENTARY, x) for x in self.elem_dir.iterdir()], [self._load_object(ObjectType.RETURNED, x) for x in self.objs_dir.iterdir()], [self._load_object(ObjectType.BUILTIN, x) for x in self.builtin_dir.iterdir()], [self._load_module(x) for x in self.modules_dir.iterdir()] ], flatten=True) ) if not self.strict: mlog.warning('YAML reference manual loaded using the best-effort fastyaml loader. Results are not guaranteed to be stable or correct.') return manual meson-docs/docs/refman/generatorprint.py0000644000175000017500000000626014656633773020354 0ustar lattislattis# SPDX-License-Identifier: Apache-2.0 # Copyright 2021 The Meson development team from .generatorbase import GeneratorBase from .model import ReferenceManual, Object, Function, DataTypeInfo, Type, ObjectType from mesonbuild import mlog import typing as T def my_nested() -> T.ContextManager[None]: prefix = '|' * mlog.get_log_depth() return mlog.nested(prefix) class GeneratorPrint(GeneratorBase): def _types_to_string(self, typ: Type) -> str: def _data_type_to_str(dt: DataTypeInfo) -> str: if dt.holds: return f'{dt.data_type.name}[{self._types_to_string(dt.holds)}]' return dt.data_type.name return ' | '.join([_data_type_to_str(x) for x in typ.resolved]) def _generate_function(self, func: Function) -> None: mlog.log() mlog.log('Function', mlog.bold(func.name)) with my_nested(): desc = func.description if '\n' in desc: desc = desc[:desc.index('\n')] mlog.log('Description:', mlog.bold(desc)) mlog.log('Return type:', mlog.bold(self._types_to_string(func.returns))) mlog.log('Pos args: ', mlog.bold(str([x.name for x in func.posargs]))) mlog.log('Opt args: ', mlog.bold(str([x.name for x in func.optargs]))) mlog.log('Varargs: ', mlog.bold(func.varargs.name if func.varargs is not None else 'null')) mlog.log('Kwargs: ', mlog.bold(str(list(func.kwargs.keys())))) def _generate_object(self, obj: Object) -> None: tags = [] tags += [{ ObjectType.ELEMENTARY: mlog.yellow('[elementary]'), ObjectType.BUILTIN: mlog.green('[builtin]'), ObjectType.MODULE: mlog.blue('[module]'), ObjectType.RETURNED: mlog.cyan('[returned]'), }[obj.obj_type]] if obj.is_container: tags += [mlog.red('[container]')] mlog.log() mlog.log('Object', mlog.bold(obj.name), *tags) with my_nested(): desc = obj.description if '\n' in desc: desc = desc[:desc.index('\n')] mlog.log('Description:', mlog.bold(desc)) mlog.log('Returned by:', mlog.bold(str([x.name for x in obj.returned_by]))) mlog.log('Methods:') with my_nested(): for m in obj.methods: self._generate_function(m) def generate(self) -> None: mlog.log('\n\n', mlog.bold('=== Functions ==='), '\n') for f in self.functions: self._generate_function(f) mlog.log('\n\n', mlog.bold('=== Elementary ==='), '\n') for obj in self.elementary: self._generate_object(obj) mlog.log('\n\n', mlog.bold('=== Builtins ==='), '\n') for obj in self.builtins: self._generate_object(obj) mlog.log('\n\n', mlog.bold('=== Returned objects ==='), '\n') for obj in self.returned: self._generate_object(obj) mlog.log('\n\n', mlog.bold('=== Modules ==='), '\n') for obj in self.modules: self._generate_object(obj) for mod_obj in self.extract_returned_by_module(obj): self._generate_object(mod_obj) meson-docs/docs/refman/main.py0000644000175000017500000000711314656633773016233 0ustar lattislattis# SPDX-License-Identifier: Apache-2.0 # Copyright 2021 The Meson development team from pathlib import Path import argparse import typing as T from mesonbuild import mlog from .loaderbase import LoaderBase from .loaderpickle import LoaderPickle from .loaderyaml import LoaderYAML from .generatorbase import GeneratorBase from .generatorjson import GeneratorJSON from .generatorprint import GeneratorPrint from .generatorpickle import GeneratorPickle from .generatormd import GeneratorMD from .generatorman import GeneratorMan from .generatorvim import GeneratorVim from .generatortypes import GeneratorTypes meson_root = Path(__file__).absolute().parents[2] def main() -> int: parser = argparse.ArgumentParser(description='Meson reference manual generator') parser.add_argument('-l', '--loader', type=str, default='yaml', choices=['yaml', 'fastyaml', 'pickle'], help='Information loader backend') parser.add_argument('-g', '--generator', type=str, choices=['print', 'pickle', 'md', 'json', 'man', 'vim', 'types'], required=True, help='Generator backend') parser.add_argument('-s', '--sitemap', type=Path, default=meson_root / 'docs' / 'sitemap.txt', help='Path to the input sitemap.txt') parser.add_argument('-o', '--out', type=Path, required=True, help='Output directory for generated files') parser.add_argument('-i', '--input', type=Path, default=meson_root / 'docs' / 'yaml', help='Input path for the selected loader') parser.add_argument('--link-defs', type=Path, help='Output file for the MD generator link definition file') parser.add_argument('--depfile', type=Path, default=None, help='Set to generate a depfile') parser.add_argument('-q', '--quiet', action='store_true', help='Suppress verbose output') parser.add_argument('--force-color', action='store_true', help='Force enable colors') parser.add_argument('--no-modules', action='store_true', help='Disable building modules') args = parser.parse_args() if args.quiet: mlog.set_quiet() if args.force_color: mlog.colorize_console = lambda: True loaders: T.Dict[str, T.Callable[[], LoaderBase]] = { 'yaml': lambda: LoaderYAML(args.input), 'fastyaml': lambda: LoaderYAML(args.input, strict=False), 'pickle': lambda: LoaderPickle(args.input), } loader = loaders[args.loader]() refMan = loader.load() generators: T.Dict[str, T.Callable[[], GeneratorBase]] = { 'print': lambda: GeneratorPrint(refMan), 'pickle': lambda: GeneratorPickle(refMan, args.out), 'md': lambda: GeneratorMD(refMan, args.out, args.sitemap, args.link_defs, not args.no_modules), 'json': lambda: GeneratorJSON(refMan, args.out, not args.no_modules), 'man': lambda: GeneratorMan(refMan, args.out, not args.no_modules), 'vim': lambda: GeneratorVim(refMan, args.out), 'types': lambda: GeneratorTypes(refMan, args.out, not args.no_modules), } generator = generators[args.generator]() # Generate the depfile if required if args.depfile is not None: assert isinstance(args.depfile, Path) assert isinstance(args.out, Path) # Also add all files of this package script_files = list(Path(__file__).resolve().parent.glob('**/*.py')) templates = list(Path(__file__).resolve().parent.glob('**/*.mustache')) out_text = f'{args.out.resolve().as_posix()}: \\\n' for input in loader.input_files + script_files + templates: out_text += f' {input.resolve().as_posix():<93} \\\n' args.depfile.write_text(out_text, encoding='utf-8') generator.generate() return 0 meson-docs/docs/refman/generatormd.py0000644000175000017500000004106214656633773017617 0ustar lattislattis# SPDX-License-Identifier: Apache-2.0 # Copyright 2021 The Meson development team from .generatorbase import GeneratorBase import re import json from .model import ( ReferenceManual, Function, Method, Object, ObjectType, Type, DataTypeInfo, ArgBase, PosArg, VarArgs, Kwarg, ) from pathlib import Path from textwrap import dedent import typing as T from mesonbuild import mlog PlaceholderTypes = T.Union[None, str, bool] FunctionDictType = T.Dict[ str, T.Union[ PlaceholderTypes, T.Dict[str, PlaceholderTypes], T.Dict[str, T.Dict[str, PlaceholderTypes]], T.Dict[str, T.List[T.Dict[str, PlaceholderTypes]]], T.List[T.Dict[str, PlaceholderTypes]], T.List[str], ] ] _ROOT_BASENAME = 'Reference-manual' _OBJ_ID_MAP = { ObjectType.ELEMENTARY: 'elementary', ObjectType.BUILTIN: 'builtin', ObjectType.MODULE: 'module', ObjectType.RETURNED: 'returned', } # Indent all but the first line with 4*depth spaces. # This function is designed to be used with `dedent` # and fstrings where multiline strings are used during # the string interpolation. def smart_indent(raw: str, depth: int = 3) -> str: lines = raw.split('\n') first_line = lines[0] lines = [' ' * (4 * depth) + x for x in lines] lines[0] = first_line # Do not indent the first line return '\n'.join(lines) def code_block(code: str) -> str: code = dedent(code) return f'
{code}
' class GeneratorMD(GeneratorBase): def __init__(self, manual: ReferenceManual, sitemap_out: Path, sitemap_in: Path, link_def_out: Path, enable_modules: bool) -> None: super().__init__(manual) self.sitemap_out = sitemap_out.resolve() self.sitemap_in = sitemap_in.resolve() self.link_def_out = link_def_out.resolve() self.out_dir = self.sitemap_out.parent self.enable_modules = enable_modules self.generated_files: T.Dict[str, str] = {} # Utility functions def _gen_filename(self, file_id: str, *, extension: str = 'md') -> str: parts = file_id.split('.') assert parts[0] == 'root' assert all([x for x in parts]) parts[0] = _ROOT_BASENAME parts = [re.sub(r'[0-9]+_', '', x) for x in parts] return f'{"_".join(parts)}.{extension}' def _gen_object_file_id(self, obj: Object) -> str: ''' Deterministically generate a unique file ID for the Object. This ID determines where the object will be inserted in the sitemap. ''' if obj.obj_type == ObjectType.RETURNED and obj.defined_by_module is not None: base = self._gen_object_file_id(obj.defined_by_module) return f'{base}.{obj.name}' return f'root.{_OBJ_ID_MAP[obj.obj_type]}.{obj.name}' def _link_to_object(self, obj: T.Union[Function, Object], in_code_block: bool = False) -> str: ''' Generate a palaceholder tag for the function/method/object documentation. This tag is then replaced in the custom hotdoc plugin. ''' prefix = '#' if in_code_block else '' if isinstance(obj, Object): return f'[[{prefix}@{obj.name}]]' elif isinstance(obj, Method): return f'[[{prefix}{obj.obj.name}.{obj.name}]]' elif isinstance(obj, Function): return f'[[{prefix}{obj.name}]]' else: raise RuntimeError(f'Invalid argument {obj}') def _write_file(self, data: str, file_id: str) -> None:# ''' Write the data to disk and store the id for the generated data ''' self.generated_files[file_id] = self._gen_filename(file_id) out_file = self.out_dir / self.generated_files[file_id] out_file.write_text(data, encoding='ascii') mlog.log('Generated', mlog.bold(out_file.name)) def _write_template(self, data: T.Dict[str, T.Any], file_id: str, template_name: T.Optional[str] = None) -> None: ''' Render the template mustache files and write the result ''' template_dir = Path(__file__).resolve().parent / 'templates' template_name = template_name or file_id template_name = f'{template_name}.mustache' template_file = template_dir / template_name # Import here, so that other generators don't also depend on it import chevron result = chevron.render( template=template_file.read_text(encoding='utf-8'), data=data, partials_path=template_dir.as_posix(), warn=True, ) self._write_file(result, file_id) # Actual generator functions def _gen_func_or_method(self, func: Function) -> FunctionDictType: def render_type(typ: Type, in_code_block: bool = False) -> str: def data_type_to_str(dt: DataTypeInfo) -> str: base = self._link_to_object(dt.data_type, in_code_block) if dt.holds: return f'{base}[{render_type(dt.holds, in_code_block)}]' return base assert typ.resolved return ' | '.join([data_type_to_str(x) for x in typ.resolved]) def len_stripped(s: str) -> int: s = s.replace(']]', '') # I know, this regex is ugly but it works. return len(re.sub(r'\[\[(#|@)*([^\[])', r'\2', s)) def arg_anchor(arg: ArgBase) -> str: return f'{func.name}_{arg.name.replace("<", "_").replace(">", "_")}' def render_signature() -> str: # Skip a lot of computations if the function does not take any arguments if not any([func.posargs, func.optargs, func.kwargs, func.varargs]): return f'{render_type(func.returns, True)} {func.name}()' signature = dedent(f'''\ # {self.brief(func)} {render_type(func.returns, True)} {func.name}( ''') # Calculate maximum lengths of the type and name all_args: T.List[ArgBase] = [] all_args += func.posargs all_args += func.optargs all_args += [func.varargs] if func.varargs else [] max_type_len = 0 max_name_len = 0 if all_args: max_type_len = max([len_stripped(render_type(x.type)) for x in all_args]) max_name_len = max([len(x.name) for x in all_args]) # Generate some common strings def prepare(arg: ArgBase, link: bool = True) -> T.Tuple[str, str, str, str]: type_str = render_type(arg.type, True) type_len = len_stripped(type_str) type_space = ' ' * (max_type_len - type_len) name_space = ' ' * (max_name_len - len(arg.name)) name_str = f'{arg.name.replace("<", "<").replace(">", ">")}' if link: name_str = f'{name_str}' return type_str, type_space, name_str, name_space for i in func.posargs: type_str, type_space, name_str, name_space = prepare(i) signature += f' {type_str}{type_space} {name_str},{name_space} # {self.brief(i)}\n' for i in func.optargs: type_str, type_space, name_str, name_space = prepare(i) signature += f' {type_str}{type_space} [{name_str}],{name_space} # {self.brief(i)}\n' if func.varargs: type_str, type_space, name_str, name_space = prepare(func.varargs, link=False) signature += f' {type_str}{type_space} {name_str}...,{name_space} # {self.brief(func.varargs)}\n' # Abort if there are no kwargs if not func.kwargs: return signature + ')' # Only add this separator if there are any posargs if all_args: signature += '\n # Keyword arguments:\n' # Recalculate lengths for kwargs all_args = list(func.kwargs.values()) max_type_len = max([len_stripped(render_type(x.type)) for x in all_args]) max_name_len = max([len(x.name) for x in all_args]) for kwarg in self.sorted_and_filtered(list(func.kwargs.values())): type_str, type_space, name_str, name_space = prepare(kwarg) required = ' [required] ' if kwarg.required else ' ' required = required if any([x.required for x in func.kwargs.values()]) else '' signature += f' {name_str}{name_space} : {type_str}{type_space} {required} # {self.brief(kwarg)}\n' return signature + ')' def gen_arg_data(arg: T.Union[PosArg, Kwarg, VarArgs], *, optional: bool = False) -> T.Dict[str, PlaceholderTypes]: data: T.Dict[str, PlaceholderTypes] = { 'row-id': arg_anchor(arg), 'name': arg.name, 'type': render_type(arg.type), 'description': arg.description, 'since': arg.since or None, 'deprecated': arg.deprecated or None, 'optional': optional, 'default': None, } if isinstance(arg, VarArgs): data.update({ 'min': str(arg.min_varargs) if arg.min_varargs > 0 else '0', 'max': str(arg.max_varargs) if arg.max_varargs > 0 else 'infinity', }) if isinstance(arg, (Kwarg, PosArg)): data.update({'default': arg.default or None}) if isinstance(arg, Kwarg): data.update({'required': arg.required}) return data mname = f'\\{func.name}' if func.name == '[index]' else func.name data: FunctionDictType = { 'name': f'{func.obj.name}.{mname}' if isinstance(func, Method) else func.name, 'base_level': '##' if isinstance(func, Method) else '#', 'type_name_upper': 'Method' if isinstance(func, Method) else 'Function', 'type_name': 'method' if isinstance(func, Method) else 'function', 'description': func.description, 'notes': func.notes, 'warnings': func.warnings, 'example': func.example or None, 'signature_level': 'h4' if isinstance(func, Method) else 'h3', 'signature': render_signature(), 'has_args': bool(func.posargs or func.optargs or func.kwargs or func.varargs), # Merge posargs and optargs by generating the *[optional]* tag for optargs 'posargs': { 'args': [gen_arg_data(x) for x in func.posargs] + [gen_arg_data(x, optional=True) for x in func.optargs] } if func.posargs or func.optargs else None, 'kwargs': {'args': [gen_arg_data(x) for x in self.sorted_and_filtered(list(func.kwargs.values()))]} if func.kwargs else None, 'varargs': gen_arg_data(func.varargs) if func.varargs else None, 'arg_flattening': func.arg_flattening, # For the feature taggs template 'since': func.since or None, 'deprecated': func.deprecated or None, 'optional': False, 'default': None } return data def _write_object(self, obj: Object) -> None: data = { 'name': obj.name, 'title': obj.long_name if obj.obj_type == ObjectType.RETURNED else obj.name, 'description': obj.description, 'notes': obj.notes, 'warnings': obj.warnings, 'long_name': obj.long_name, 'obj_type_name': _OBJ_ID_MAP[obj.obj_type].capitalize(), 'example': obj.example or None, 'has_methods': bool(obj.methods), 'has_inherited_methods': bool(obj.inherited_methods), 'has_subclasses': bool(obj.extended_by), 'is_returned': bool(obj.returned_by), 'extends': obj.extends_obj.name if obj.extends_obj else None, 'returned_by': [self._link_to_object(x) for x in self.sorted_and_filtered(obj.returned_by)], 'extended_by': [self._link_to_object(x) for x in self.sorted_and_filtered(obj.extended_by)], 'methods': [self._gen_func_or_method(m) for m in self.sorted_and_filtered(obj.methods)], 'inherited_methods': [self._gen_func_or_method(m) for m in self.sorted_and_filtered(obj.inherited_methods)], } self._write_template(data, self._gen_object_file_id(obj), 'object') def _write_functions(self) -> None: data = {'functions': [self._gen_func_or_method(x) for x in self.functions]} self._write_template(data, 'root.functions') def _root_refman_docs(self) -> None: def gen_obj_links(objs: T.List[Object]) -> T.List[T.Dict[str, str]]: ret: T.List[T.Dict[str, str]] = [] for o in objs: ret += [{'indent': '', 'link': self._link_to_object(o), 'brief': self.brief(o)}] for m in self.sorted_and_filtered(o.methods): ret += [{'indent': ' ', 'link': self._link_to_object(m), 'brief': self.brief(m)}] if o.obj_type == ObjectType.MODULE and self.extract_returned_by_module(o): tmp = gen_obj_links(self.extract_returned_by_module(o)) tmp = [{**x, 'indent': ' ' + x['indent']} for x in tmp] ret += [{'indent': ' ', 'link': '**New objects:**', 'brief': ''}] ret += [*tmp] return ret data = { 'root': self._gen_filename('root'), 'elementary': gen_obj_links(self.elementary), 'returned': gen_obj_links(self.returned), 'builtins': gen_obj_links(self.builtins), 'modules': gen_obj_links(self.modules), 'functions': [{'indent': '', 'link': self._link_to_object(x), 'brief': self.brief(x)} for x in self.functions], 'enable_modules': self.enable_modules, } dummy = {'root': self._gen_filename('root')} self._write_template(data, 'root') self._write_template({**dummy, 'name': 'Elementary types'}, f'root.{_OBJ_ID_MAP[ObjectType.ELEMENTARY]}', 'dummy') self._write_template({**dummy, 'name': 'Builtin objects'}, f'root.{_OBJ_ID_MAP[ObjectType.BUILTIN]}', 'dummy') self._write_template({**dummy, 'name': 'Returned objects'}, f'root.{_OBJ_ID_MAP[ObjectType.RETURNED]}', 'dummy') if self.enable_modules: self._write_template({**dummy, 'name': 'Modules'}, f'root.{_OBJ_ID_MAP[ObjectType.MODULE]}', 'dummy') def generate(self) -> None: mlog.log('Generating markdown files...') with mlog.nested(): self._write_functions() for obj in self.objects: if not self.enable_modules and (obj.obj_type == ObjectType.MODULE or obj.defined_by_module is not None): continue self._write_object(obj) self._root_refman_docs() self._configure_sitemap() self._generate_link_def() def _configure_sitemap(self) -> None: ''' Replaces the `@REFMAN_PLACEHOLDER@` placeholder with the reference manual sitemap. The structure of the sitemap is derived from the file IDs. ''' raw = self.sitemap_in.read_text(encoding='utf-8') out = '' for l in raw.split('\n'): if '@REFMAN_PLACEHOLDER@' not in l: out += f'{l}\n' continue mlog.log('Generating', mlog.bold(self.sitemap_out.as_posix())) base_indent = l.replace('@REFMAN_PLACEHOLDER@', '') for k in sorted(self.generated_files.keys()): indent = base_indent + '\t' * k.count('.') out += f'{indent}{self.generated_files[k]}\n' self.sitemap_out.write_text(out, encoding='utf-8') def _generate_link_def(self) -> None: ''' Generate the link definition file for the refman_links hotdoc plugin. The plugin is then responsible for replacing the [[tag]] tags with custom HTML elements. ''' data: T.Dict[str, str] = {} # Objects and methods for obj in self.objects: obj_file = self._gen_filename(self._gen_object_file_id(obj), extension='html') data[f'@{obj.name}'] = obj_file for m in obj.methods: data[f'{obj.name}.{m.name}'] = f'{obj_file}#{obj.name}{m.name}' # Functions funcs_file = self._gen_filename('root.functions', extension='html') for fn in self.functions: data[fn.name] = f'{funcs_file}#{fn.name}' self.link_def_out.write_text(json.dumps(data, indent=2), encoding='utf-8') meson-docs/docs/refman/generatorman.py0000644000175000017500000002657314656633773020004 0ustar lattislattisimport re from pathlib import Path from .generatorbase import GeneratorBase from .model import ( ReferenceManual, Function, Object, PosArg, VarArgs, Kwarg, ) import typing as T class ManPage: def __init__(self, path: Path): self.path = path self.text = "" def reset_font(self) -> None: self.text += ".P\n" def title(self, name: str, section: int) -> None: import datetime date = datetime.date.today() self.reset_font() self.text += f'.TH "{name}" "{section}" "{date}"\n' def section(self, name: str) -> None: self.reset_font() self.text += f".SH {name}\n" def subsection(self, name: str) -> None: self.reset_font() self.text += f".SS {name}\n" def par(self, text: str) -> None: self.reset_font() self.text += f"{text}\n" def indent(self, amount: int = 4) -> None: self.text += f".RS {amount}\n" def unindent(self) -> None: self.text += ".RE\n" def br(self) -> None: self.text += ".br\n" def nl(self) -> None: self.text += "\n" def line(self, text: str) -> None: if text and text[0] in [".", "'"]: self.text += "\\" self.text += f"{text}\n" def inline(self, text: str) -> None: self.text += f"{text}" def write(self) -> None: self.path.write_text(self.text, encoding="utf-8") @staticmethod def bold(text: str) -> str: return f"\\fB{text}\\fR" @staticmethod def italic(text: str) -> str: return f"\\fI{text}\\fR" class GeneratorMan(GeneratorBase): def __init__( self, manual: ReferenceManual, out: Path, enable_modules: bool ) -> None: super().__init__(manual) self.out = out self.enable_modules = enable_modules self.links: T.List[str] = [] def generate_description(self, page: ManPage, desc: str) -> None: def italicise(match: T.Match[str]) -> str: v = match.group(1) if v[0] == "@": v = v[1:] return ManPage.italic(v) desc = re.sub(re.compile(r"\[\[(.*?)\]\]", re.DOTALL), italicise, desc) def linkify(match: T.Match[str]) -> str: replacement = ManPage.italic(match.group(1)) if match.group(2)[0] != "#": if match.group(2) in self.links: num = self.links.index(match.group(2)) else: self.links.append(match.group(2)) num = len(self.links) replacement += f"[{num}]" return replacement desc = re.sub(re.compile(r"\[(.*?)\]\((.*?)\)", re.DOTALL), linkify, desc) def bold(match: T.Match[str]) -> str: return ManPage.bold(match.group(1)) desc = re.sub(re.compile(r"\*(.*?)\*"), bold, desc) isCode = False for chunk in desc.split("```"): if isCode: page.indent() lines = chunk.strip().split("\n") if lines[0] == "meson": lines = lines[1:] for line in lines: page.line(line) page.br() page.unindent() else: inList = False for line in chunk.strip().split("\n"): if len(line) == 0: page.nl() if inList: page.nl() inList = False elif line[0:2] in ["- ", "* "]: if inList: page.nl() page.br() else: inList = True page.inline(line.strip() + " ") elif inList and line[0] == " ": page.inline(line.strip() + " ") else: inList = False page.line(line) if inList: page.nl() isCode = not isCode def function_name(self, f: Function, o: Object = None) -> str: name = "" if o is not None: name += f"{o.name}." name += f.name return name def generate_function_signature( self, page: ManPage, f: Function, o: Object = None ) -> None: args = [] if f.posargs: args += [arg.name for arg in f.posargs] if f.varargs: args += [f.varargs.name + "..."] if f.optargs: args += [f"[{arg.name}]" for arg in f.optargs] for kwarg in self.sorted_and_filtered(list(f.kwargs.values())): kw = kwarg.name + ":" if kwarg.default: kw += " " + ManPage.bold(kwarg.default) args += [kw] ret = ManPage.italic(f.returns.raw) + " " prefix = f"{ret}{self.function_name(f, o)}(" sig = ", ".join(args) suffix = ")" if len(prefix) + len(sig) + len(suffix) > 70: page.line(prefix) page.br() page.indent() for arg in args: page.line(arg + ",") page.br() page.unindent() page.line(suffix) else: page.line(prefix + sig + suffix) def base_info( self, x: T.Union[PosArg, VarArgs, Kwarg, Function, Object] ) -> T.List[str]: info = [] if x.deprecated: info += [ManPage.bold("deprecated") + f" since {x.deprecated}"] if x.since: info += [f"since {x.since}"] return info def generate_function_arg( self, page: ManPage, arg: T.Union[PosArg, VarArgs, Kwarg], isOptarg: bool = False, ) -> None: required = ( arg.required if isinstance(arg, Kwarg) else not isOptarg and not isinstance(arg, VarArgs) ) page.line(ManPage.bold(arg.name)) info = [ManPage.italic(arg.type.raw)] if required: info += [ManPage.bold("required")] if isinstance(arg, (PosArg, Kwarg)) and arg.default: info += [f"default: {arg.default}"] if isinstance(arg, VarArgs): mn = 0 if arg.min_varargs < 0 else arg.min_varargs mx = "N" if arg.max_varargs < 0 else arg.max_varargs info += [f"{mn}...{mx} times"] info += self.base_info(arg) page.line(", ".join(info)) page.br() page.indent(2) self.generate_description(page, arg.description.strip()) page.unindent() page.nl() def generate_function_argument_section( self, page: ManPage, name: str, args: T.Sequence[T.Union[PosArg, VarArgs, Kwarg]], isOptarg: bool = False, ) -> None: if not args: return page.line(ManPage.bold(name)) page.indent() for arg in args: self.generate_function_arg(page, arg, isOptarg) page.unindent() def generate_sub_sub_section( self, page: ManPage, name: str, text: T.List[str], process: bool = True ) -> None: page.line(ManPage.bold(name)) page.indent() if process: for line in text: self.generate_description(page, line.strip()) else: page.line("\n\n".join([line.strip() for line in text])) page.unindent() def generate_function(self, page: ManPage, f: Function, obj: Object = None) -> None: page.subsection(self.function_name(f, obj) + "()") page.indent(0) page.line(ManPage.bold("SYNOPSIS")) page.indent() self.generate_function_signature(page, f, obj) info = self.base_info(f) if info: page.nl() page.line(", ".join(info)) page.unindent() page.nl() self.generate_sub_sub_section(page, "DESCRIPTION", [f.description]) page.nl() self.generate_function_argument_section(page, "POSARGS", f.posargs) if f.varargs: self.generate_function_argument_section(page, "VARARGS", [f.varargs]) self.generate_function_argument_section(page, "OPTARGS", f.optargs, True) self.generate_function_argument_section( page, "KWARGS", self.sorted_and_filtered(list(f.kwargs.values())) ) if f.notes: self.generate_sub_sub_section(page, "NOTES", f.notes) if f.warnings: self.generate_sub_sub_section(page, "WARNINGS", f.warnings) if f.example: self.generate_sub_sub_section(page, "EXAMPLE", [f.example]) page.unindent() def generate_object(self, page: ManPage, obj: Object) -> None: page.subsection(obj.name) page.indent(2) info = self.base_info(obj) if info: page.line(", ".join(info)) page.br() if obj.extends: page.line(ManPage.bold("extends: ") + obj.extends) page.br() ret = [x.name for x in self.sorted_and_filtered(obj.returned_by)] if ret: page.line(ManPage.bold("returned_by: ") + ", ".join(ret)) page.br() ext = [x.name for x in self.sorted_and_filtered(obj.extended_by)] if ext: page.line(ManPage.bold("extended_by: ") + ", ".join(ext)) page.br() page.nl() self.generate_description(page, obj.description.strip()) page.nl() if obj.notes: self.generate_sub_sub_section(page, "NOTES", obj.notes) if obj.warnings: self.generate_sub_sub_section(page, "WARNINGS", obj.warnings) if obj.example: self.generate_sub_sub_section(page, "EXAMPLE", [obj.example]) page.unindent() def generate(self) -> None: page = ManPage(self.out) page.title("meson-reference", 3) page.section("NAME") page.par( f"meson-reference v{self._extract_meson_version()}" + " - a reference for meson functions and objects" ) page.section("DESCRIPTION") self.generate_description( page, """This manual is divided into two sections, *FUNCTIONS* and *OBJECTS*. *FUNCTIONS* contains a reference for all meson functions and methods. Methods are denoted by [[object_name]].[[method_name]](). *OBJECTS* contains additional information about each object.""", ) page.section("FUNCTIONS") for f in self.sorted_and_filtered(self.functions): self.generate_function(page, f) for obj in self.sorted_and_filtered(self.objects): for f in self.sorted_and_filtered(obj.methods): self.generate_function(page, f, obj) page.section("OBJECTS") for obj in self.sorted_and_filtered(self.objects): self.generate_object(page, obj) page.section("SEE ALSO") for i in range(len(self.links)): link = self.links[i] page.line(f"[{i + 1}] {link}") page.br() page.section("COPYRIGHT") page.par("Documentation comes from 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 Universal (CC0 1.0).") page.par("Meson is a registered trademark of Jussi Pakkanen.") page.write() meson-docs/docs/refman/generatortypes.py0000644000175000017500000000727514656633773020373 0ustar lattislattisimport re from pathlib import Path from .generatorbase import GeneratorBase from .model import ( ReferenceManual, Function, Object, PosArg, VarArgs, Kwarg, ObjectType, ) import typing as T class GeneratorTypes(GeneratorBase): def __init__( self, manual: ReferenceManual, out: Path, enable_modules: bool ) -> None: super().__init__(manual) self.out = out self.enable_modules = enable_modules def _parse_type(self, t, in_container=False): parsed = [] name = "" i = 0 while i < len(t): c = t[i] if c == '[': (n, sub) = self._parse_type(t[i+1:], in_container=True) parsed.append((name, sub,)) name = "" i += n + 1 continue elif c == ']': if name: parsed.append(name) return (i+1, parsed) elif c == ' ': i += 1 continue elif c == '|': if name: parsed.append(name) name = "" else: name += c i += 1 if name: parsed.append(name) return (i, parsed) def parse_type(self, t): (_, parsed) = self._parse_type(t) return parsed def assemble_type(self, t): if type(t) is list: def sort_func(v): assert type(v) is not list if type(v) is tuple: return v[0] else: return v t.sort(key=sort_func) return "|".join(self.assemble_type(x) for x in t) elif type(t) is tuple: return t[0] + '[' + self.assemble_type(t[1]) + ']' else: return t def print_types(self, args): args = [args] if not isinstance(args, list) else args res = [] for arg in args: t = self.assemble_type(self.parse_type(arg.type.raw)) res.append(f" {t}") return res def function_name(self, f: Function, o: Object = None) -> str: name = "" if o is not None: name += f"{o.name}." name += f.name return name def generate_function(self, f: Function, obj: Object = None): res = [] res.append(self.function_name(f, obj)) if f.posargs: res.append(' posargs:') res.extend(self.print_types(f.posargs)) if f.varargs: res.append(' varargs:') res.extend(self.print_types(f.varargs)) if f.optargs: res.append(' optargs:') res.extend(self.print_types(f.optargs)) kwargs = self.sorted_and_filtered(list(f.kwargs.values())) if kwargs: res.append(' kwargs:') for kwarg in kwargs: k = kwarg.name t = self.assemble_type(self.parse_type(kwarg.type.raw)) res.append(f" {k}: {t}") res.append(' returns:') res.append(' ' + self.assemble_type(self.parse_type(f.returns.raw))) return res def generate(self): lines = [] for f in self.sorted_and_filtered(self.functions): lines.extend(self.generate_function(f, None)) for obj in self.sorted_and_filtered(self.objects): for f in self.sorted_and_filtered(obj.methods): if not self.enable_modules and (obj.obj_type == ObjectType.MODULE or obj.defined_by_module is not None): continue lines.extend(self.generate_function(f, obj)) self.out.write_text("\n".join(lines) + "\n", encoding="utf-8") meson-docs/docs/refman/generatorpickle.py0000644000175000017500000000071214656633773020463 0ustar lattislattis# SPDX-License-Identifier: Apache-2.0 # Copyright 2021 The Meson development team import pickle from pathlib import Path from .generatorbase import GeneratorBase from .model import ReferenceManual class GeneratorPickle(GeneratorBase): def __init__(self, manual: ReferenceManual, outpath: Path) -> None: self.out = outpath super().__init__(manual) def generate(self) -> None: self.out.write_bytes(pickle.dumps(self.manual)) meson-docs/docs/refman/loaderbase.py0000644000175000017500000001706714656633773017421 0ustar lattislattis# SPDX-License-Identifier: Apache-2.0 # Copyright 2021 The Meson development team from abc import ABCMeta, abstractmethod from pathlib import Path import re import typing as T from .model import ( NamedObject, FetureCheck, ArgBase, PosArg, DataTypeInfo, Type, Function, Method, Object, ObjectType, ReferenceManual, ) from mesonbuild import mlog class _Resolver: def __init__(self) -> None: self.type_map: T.Dict[str, Object] = {} self.func_map: T.Dict[str, T.Union[Function, Method]] = {} self.processed_funcs: T.Set[str] = set() def _validate_named_object(self, obj: NamedObject) -> None: name_regex = re.compile(r'[a-zA-Z0-9_]+') obj.name = obj.name.strip() obj.description = obj.description.strip() assert obj.name and obj.description, 'Both name and description must be set' assert obj.name.islower(), f'Object names must be lower case ({obj.name})' assert name_regex.match(obj.name) or obj.name == '[index]', f'Invalid name {obj.name}' def _validate_feature_check(self, obj: FetureCheck) -> None: meson_version_reg = re.compile(r'[0-9]+\.[0-9]+\.[0-9]+') obj.since = obj.since.strip() obj.deprecated = obj.deprecated.strip() if obj.since: assert meson_version_reg.match(obj.since) if obj.deprecated: assert meson_version_reg.match(obj.deprecated) def _resolve_type(self, raw: str) -> Type: typ = Type(raw) # We can't use `types = raw.split('|')`, because of `list[str | env]` types: T.List[str] = [''] stack = 0 for c in raw: if stack == 0 and c == '|': types += [''] continue if c == '[': stack += 1 if c == ']': stack -= 1 types[-1] += c types = [x.strip() for x in types] for t in types: t = t.strip() idx = t.find('[') base_type = t held_type = None if idx > 0: base_type = t[:idx] held_type = self._resolve_type(t[idx+1:-1]) assert base_type in self.type_map, f'No known object {t}' obj = self.type_map[base_type] typ.resolved += [DataTypeInfo(obj, held_type)] return typ def _validate_func(self, func: T.Union[Function, Method]) -> None: # Always run basic checks, since they also slightly post-process (strip) some strings self._validate_named_object(func) self._validate_feature_check(func) func_id = f'{func.obj.name}.{func.name}' if isinstance(func, Method) else func.name if func_id in self.processed_funcs: return func.returns = self._resolve_type(func.returns.raw) all_args: T.List[ArgBase] = [] all_args += func.posargs all_args += func.optargs all_args += func.kwargs.values() all_args += [func.varargs] if func.varargs else [] for arg in all_args: arg.type = self._resolve_type(arg.type.raw) # Handle returned_by for obj in func.returns.resolved: obj.data_type.returned_by += [func] # Handle kwargs inheritance for base_name in func.kwargs_inherit: base_name = base_name.strip() assert base_name in self.func_map, f'Unknown base function `{base_name}` for {func.name}' base = self.func_map[base_name] if base_name not in self.processed_funcs: self._validate_func(base) curr_keys = set(func.kwargs.keys()) base_keys = set(base.kwargs.keys()) # Calculate the missing kwargs from the current set missing = {k: v for k, v in base.kwargs.items() if k in base_keys - curr_keys} func.kwargs.update(missing) # Handle other args inheritance _T = T.TypeVar('_T', bound=T.Union[ArgBase, T.List[PosArg]]) def resolve_inherit(name: str, curr: _T, resolver: T.Callable[[Function], _T]) -> _T: if name and not curr: name = name.strip() assert name in self.func_map, f'Unknown base function `{name}` for {func.name}' if name not in self.processed_funcs: self._validate_func(self.func_map[name]) ref_args = resolver(self.func_map[name]) assert ref_args is not None, f'Inherited function `{name}` does not have inherited args set' return ref_args return curr func.posargs = resolve_inherit(func.posargs_inherit, func.posargs, lambda x: x.posargs) func.optargs = resolve_inherit(func.optargs_inherit, func.optargs, lambda x: x.optargs) func.varargs = resolve_inherit(func.varargs_inherit, func.varargs, lambda x: x.varargs) self.processed_funcs.add(func_id) def validate_and_resolve(self, manual: ReferenceManual) -> ReferenceManual: mlog.log('Validating loaded manual...') # build type map and func map for methods for obj in manual.objects: assert obj.name not in self.type_map, f'Duplicate object name {obj.name}' self.type_map[obj.name] = obj for m in obj.methods: mid = f'{obj.name}.{m.name}' assert mid not in self.type_map, f'Duplicate method {mid}' self.func_map[mid] = m # Build func map for functions for func in manual.functions: assert func.name not in [*self.func_map.keys()], f'Duplicate function {func.name}' self.func_map[func.name] = func mlog.log('Validating functions...') for func in manual.functions: mlog.log(' -- validating', mlog.bold(func.name)) self._validate_func(func) mlog.log('Validating objects...') for obj in manual.objects: mlog.log(' -- validating', mlog.bold(obj.name)) self._validate_named_object(obj) self._validate_feature_check(obj) # Resolve and validate inheritance if obj.extends: assert obj.extends in self.type_map, f'Unknown extends object {obj.extends} in {obj.name}' obj.extends_obj = self.type_map[obj.extends] obj.extends_obj.extended_by += [obj] # Only returned objects can be associated with module if obj.obj_type is not ObjectType.RETURNED: assert obj.defined_by_module is None for m in obj.methods: assert m.obj is obj self._validate_func(m) # Resolve inherited methods for obj in manual.objects: inherited_methods = obj.inherited_methods curr = obj.extends_obj while curr is not None: inherited_methods += curr.methods curr = curr.extends_obj return manual class LoaderBase(metaclass=ABCMeta): def __init__(self) -> None: self._input_files: T.List[Path] = [] @property def input_files(self) -> T.List[Path]: return list(self._input_files) def read_file(self, f: Path) -> str: assert f.exists() assert f.is_file() self._input_files += [f.resolve()] return f.read_text(encoding='utf-8') @abstractmethod def load_impl(self) -> ReferenceManual: pass def load(self) -> ReferenceManual: self._input_files = [] # Reset input files manual = self.load_impl() resolver = _Resolver() with mlog.nested(): return resolver.validate_and_resolve(manual) meson-docs/docs/yaml/0000755000175000017500000000000014656633773014425 5ustar lattislattismeson-docs/docs/yaml/elementary/0000755000175000017500000000000014656633773016572 5ustar lattislattismeson-docs/docs/yaml/elementary/dict.yml0000644000175000017500000000246614656633773020250 0ustar lattislattisname: dict long_name: Dict since: 0.47.0 is_container: true description: | Stores a mapping of strings to other objects. See [dictionaries](Syntax.md#dictionaries). You can also iterate over dictionaries with the [`foreach` statement](Syntax.md#foreach-statements). *(since 0.48.0)*: Dictionaries can be added (e.g. `d1 = d2 + d3` and `d1 += d2`). Values from the second dictionary overrides values from the first. *(since 0.62.0)*: Dictionary order is guaranteed to be insertion order. methods: - name: has_key returns: bool description: Returns `true` if the dictionary contains the key given as argument, `false` otherwise. posargs: key: type: str description: The key to query. - name: get returns: any description: | returns the value for the key given as first argument if it is present in the dictionary, or the optional fallback value given as the second argument. If a single argument was given and the key was not found, causes a fatal error arg_flattening: false posargs: key: type: str description: The key to query. optargs: fallback: type: any description: Fallback value that is returned if the key is not in the [[@dict]]. - name: keys returns: list[str] description: Returns an array of keys in the dictionary. meson-docs/docs/yaml/elementary/int.yml0000644000175000017500000000145214656633773020111 0ustar lattislattisname: int long_name: Integer description: All integer numbers. See [Numbers](Syntax.md#numbers) for more information. methods: - name: is_even returns: bool description: Returns true if the number is even. - name: is_odd returns: bool description: Returns true if the number is odd - name: to_string returns: str description: Returns the value of the number as a string. optargs: fill: type: int description: | Left fill the string with zeros until it reaches the length specified by this argument. A leading negative sign counts towards the length, and is handled by inserting the padding after the `-` character rather than before. The original string is returned if the value provided is less than or equal to the former's length. meson-docs/docs/yaml/elementary/str.yml0000644000175000017500000002040314656633773020124 0ustar lattislattisname: str long_name: String description: | All [strings](Syntax.md#strings) have the following methods. Strings are immutable, all operations return their results as a new string. methods: # str.format(fmt, value...) - name: format returns: str description: | Strings can be built using the string formatting functionality. See [the Meson syntax entry](Syntax.md#string-formatting) for more information. *Since 1.3.0* values other than strings, integers, bools, options, dictionaries and lists thereof are deprecated. They were previously printing the internal representation of the raw Python object. example: | ```meson template = 'string: @0@, number: @1@, bool: @2@' res = template.format('text', 1, true) # res now has value 'string: text, number: 1, bool: true' ``` arg_flattening: false posargs: fmt: description: | The string to format. The formatting works by replacing placeholders of type `@number@` with the corresponding varargs. type: str varargs: name: value description: The values to replace the @number@ placeholders in the format string. type: int | bool | str # str.replace(old, new) - name: replace description: Search all occurrences of `old` and replace it with `new` returns: str since: 0.58.0 example: | ```meson # Replaces all instances of one substring with another s = 'semicolons;as;separators' s = s.replace('as', 'are') # 's' now has the value of 'semicolons;are;separators' ``` posargs: old: description: The substring to search type: str new: description: The replacement string type: str # str.strip() - name: strip description: | Removes leading/ending characters from the string. By default the characters to remove are spaces and newlines. returns: str example: | ```meson # Similar to the Python str.strip(). Removes leading/ending spaces and newlines define = ' -Dsomedefine ' stripped_define = define.strip() # 'stripped_define' now has the value '-Dsomedefine' ``` optargs: strip_chars: type: str since: 0.43.0 description: Instead of whitespace, strip all the characters in this string. # str.to_lower() - name: to_lower description: Converts all characters to lower case returns: str example: | ```meson target = 'x86_FreeBSD' lower = target.to_lower() # t now has the value 'x86_freebsd' ``` # str.to_upper() - name: to_upper description: Converts all characters to upper case returns: str example: | ```meson target = 'x86_FreeBSD' upper = target.to_upper() # t now has the value 'X86_FREEBSD' ``` # str.to_int() - name: to_int description: Converts the string to an int and throws an error if it can't be returns: int example: | ```meson version = '1' # Converts the string to an int and throws an error if it can't be ver_int = version.to_int() ``` # str.contains() - name: contains returns: bool description: Returns `true` if string contains the string specified as the argument. example: | ```meson target = 'x86_FreeBSD' is_fbsd = target.to_lower().contains('freebsd') # is_fbsd now has the boolean value 'true' ``` posargs: fragment: type: str description: The string fragment to check # str.startswith() - name: startswith returns: bool description: Returns true if string starts with the string specified as the argument. posargs_inherit: str.contains example: | ```meson target = 'x86_FreeBSD' is_x86 = target.startswith('x86') # boolean value 'true' ``` # str.endswith() - name: endswith returns: bool description: Returns true if string ends with the string specified as the argument. posargs_inherit: str.contains example: | ```meson target = 'x86_FreeBSD' is_bsd = target.to_lower().endswith('bsd') # boolean value 'true' ``` # str.substring() - name: substring returns: str since: 0.56.0 description: | Returns a substring specified from `start` to `end`. Both `start` and `end` arguments are optional, so, for example, `'foobar'.substring()` will return `'foobar'`. The method accepts negative values where negative `start` is relative to the end of string `len(string) - start` as well as negative `end`. If `start` or `end` are out of bounds, the position of the closest character will be used. If `start` is bigger than `end`, the result will be an empty substring. example: | ```meson # Similar to the Python str[start:end] syntax target = 'x86_FreeBSD' platform = target.substring(0, 3) # prefix string value 'x86' system = target.substring(4) # suffix string value 'FreeBSD' ``` Example with negative values: ```meson string = 'foobar' string.substring(-5, -3) # => 'oo' string.substring(1, -1) # => 'ooba' ``` Example with out of bound values: ```meson string = 'foobar' string.substring(64) # => '' string.substring(0, 64) # => 'foobar' string.substring(64, 0) # => '' ``` optargs: start: type: int description: The start position end: type: int description: The end position # str.split - name: split returns: list[str] description: | Splits the string at the specified character (or whitespace if not set) and returns the parts in an array. example: | ```meson # Similar to the Python str.split() components = 'a b c d '.split() # components now has the value ['a', 'b', 'c', 'd'] components = 'a b c d '.split(' ') # components now has the value ['a', 'b', '', '', 'c', 'd', ''] ``` optargs: split_string: type: str description: Specifies the character / substring where to split the string. - name: splitlines returns: list[str] since: 1.2.0 description: | Splits the string into an array of lines. Unlike .split('\n'), the empty string produced an empty array, and if the string ends in a newline, splitlines() doesn't split on that last newline. '\n', '\r' and '\r\n' are all considered newlines. example: | ```meson output = 'hello\nworld\n'.splitlines() # Output value is ['hello', 'world'] output = ''.splitlines() # Output value is [] fs = import('fs') paths = fs.read('my_paths.list').splitlines() # paths is now the paths listed in 'my_paths.list', or an empty list # if 'my_paths.list' is empty ``` # str.join() - name: join returns: str description: | The opposite of split, for example `'.'.join(['a', 'b', 'c']` yields `'a.b.c'`. example: | ```meson # Similar to the Python str.join() output = ' '.join(['foo', 'bar']) # Output value is 'foo bar' pathsep = ':' path = pathsep.join(['/usr/bin', '/bin', '/usr/local/bin']) # path now has the value '/usr/bin:/bin:/usr/local/bin' ``` varargs: name: strings type: str since: 0.60.0 description: | The strings to join with the current string. Before Meson *0.60.0* this function only accepts a single positional argument of the type [[list[str]]]. # str.underscorify - name: underscorify returns: str description: Creates a string where every non-alphabetical non-number character is replaced with `_`. example: | ```meson name = 'Meson Docs.txt#Reference-manual' # Replaces all characters other than `a-zA-Z0-9` with `_` (underscore) # Useful for substituting into #defines, filenames, etc. underscored = name.underscorify() # underscored now has the value 'Meson_Docs_txt_Reference_manual' ``` # str.version_compare - name: version_compare returns: bool description: Does semantic version comparison. example: | ```meson version = '1.2.3' # Compare version numbers semantically is_new = version.version_compare('>=2.0') # is_new now has the boolean value false # Supports the following operators: '>', '<', '>=', '<=', '!=', '==', '=' ``` Meson version comparison conventions include: ```meson '3.6'.version_compare('>=3.6.0') == false ``` It is best to be unambiguous and specify the full revision level to compare. posargs: compare_string: type: str description: The string to compare to. meson-docs/docs/yaml/elementary/void.yml0000644000175000017500000000020314656633773020251 0ustar lattislattisname: void long_name: void description: | Indicates that the function does not return anything. Similar to `void` in C and C++ meson-docs/docs/yaml/elementary/bool.yml0000644000175000017500000000144314656633773020252 0ustar lattislattisname: bool long_name: Boolean description: A boolean object which is either `true` or `false` methods: - name: to_int returns: int description: Returns `1` if `true` and `0` if `false` - name: to_string returns: str description: | Returns the string `'true'` if the boolean is true or `'false'` otherwise. You can also pass it two strings as positional arguments to specify what to return for true/false. For instance, `bool.to_string('yes', 'no')` will return `yes` if the boolean is true and `no` if it is false. optargs: true_str: type: str default: "'true'" description: The string to return when the boolean is `true` false_str: type: str default: "'false'" description: The string to return when the boolean is `false` meson-docs/docs/yaml/elementary/list.yml0000644000175000017500000000176714656633773020303 0ustar lattislattisname: list long_name: List description: An array of elements. See [arrays](Syntax.md#arrays). is_container: true methods: - name: contains returns: bool description: | Returns `true` if the array contains the object given as argument, `false` otherwise arg_flattening: false posargs: item: type: any description: The item to check - name: get returns: any description: | returns the object at the given index, negative indices count from the back of the array, indexing out of bounds returns the `fallback` value *(since 0.38.0)* or, if it is not specified, causes a fatal error arg_flattening: false posargs: index: type: int description: Index of the list position to query. Negative values start at the end of the list optargs: fallback: type: any description: Fallback value that is returned if the index is out of range. - name: length returns: int description: Returns the current size of the array / list. meson-docs/docs/yaml/elementary/any.yaml0000644000175000017500000000020614656633773020243 0ustar lattislattisname: any long_name: Any description: | A placeholder representing all types. This includes builtin, as well as returned objects. meson-docs/docs/yaml/objects/0000755000175000017500000000000014656633773016056 5ustar lattislattismeson-docs/docs/yaml/objects/dep.yaml0000644000175000017500000001547414656633773017525 0ustar lattislattisname: dep long_name: Dependency object description: Abstract representation of a dependency methods: - name: found returns: bool description: Returns whether the dependency was found. - name: name since: 0.48.0 returns: str description: | Returns the name of the dependency that was searched. Returns `'internal'` for dependencies created with [[declare_dependency]]. NOTE: This was not implemented for dep objects returned by [[compiler.find_library]] until Meson 1.5.0 - name: get_pkgconfig_variable since: 0.36.0 deprecated: 0.56.0 returns: str description: | Gets the pkg-config variable specified, or, if invoked on a non pkg-config dependency, error out. posargs: var_name: type: str description: Name of the variable to query kwargs: define_variable: type: list[str] since: 0.44.0 description: | You can also redefine a variable by passing a list to this kwarg that can affect the retrieved variable: `['prefix', '/'])`. *(Since 1.3.0)* Multiple variables can be specified in pairs. default: type: str since: 0.45.0 description: | The value to return if the variable was not found. A warning is issued if the variable is not defined and this kwarg is not set. - name: get_configtool_variable since: 0.44.0 deprecated: 0.56.0 returns: str description: | Gets the command line argument from the config tool (with `--` prepended), or, if invoked on a non config-tool dependency, error out. posargs: var_name: type: str description: Name of the variable to query - name: type_name returns: str description: | Returns a string describing the type of the dependency, the most common values are `internal` for deps created with [[declare_dependency]] and `pkgconfig` for system dependencies obtained with Pkg-config. - name: version returns: str description: | the version number as a string, for example `1.2.8`. `unknown` if the dependency provider doesn't support determining the version. - name: include_type returns: str since: 0.52.0 description: Returns the value set by the `include_type` kwarg. - name: as_system returns: dep since: 0.52.0 description: | Returns a copy of the dependency object, which has changed the value of `include_type` to `value`. The `value` argument is optional and defaults to `'system'`. optargs: value: type: str description: The new value. See [[dependency]] for supported values. - name: as_link_whole returns: dep since: 0.56.0 description: | Only dependencies created with [[declare_dependency]], returns a copy of the dependency object with all link_with arguments changed to link_whole. This is useful for example for fallback dependency from a subproject built with `default_library=static`. Note that all `link_with` objects must be static libraries otherwise an error will be raised when trying to `link_whole` a shared library. - name: partial_dependency returns: dep since: 0.46.0 description: | Returns a new dependency object with the same name, version, found status, type name, and methods as the object that called it. This new object will only inherit other attributes from its parent as controlled by keyword arguments. If the parent has any dependencies, those will be applied to the new partial dependency with the same rules. So, given: ```meson dep1 = declare_dependency(compile_args : '-Werror=foo', link_with : 'libfoo') dep2 = declare_dependency(compile_args : '-Werror=bar', dependencies : dep1) dep3 = dep2.partial_dependency(compile_args : true) ``` dep3 will add `['-Werror=foo', '-Werror=bar']` to the compiler args of any target it is added to, but libfoo will not be added to the link_args. The following arguments will add the following attributes: - compile_args: any arguments passed to the compiler - link_args: any arguments passed to the linker - links: anything passed via link_with or link_whole - includes: any include_directories - sources: any compiled or static sources the dependency has warnings: - A bug present until 0.50.1 results in the above behavior not working correctly. kwargs: compile_args: type: bool default: false description: Whether to include compile_args link_args: type: bool default: false description: Whether to include link_args links: type: bool default: false description: Whether to include links includes: type: bool default: false description: Whether to include includes sources: type: bool default: false description: Whether to include sources - name: get_variable returns: str since: 0.51.0 description: | A generic variable getter method, which replaces the `get_*type*_variable` methods. This allows one to get the variable from a dependency without knowing specifically how that dependency was found. If `default_value` is set and the value cannot be gotten from the object then `default_value` is returned, if it is not set then an error is raised. warnings: - Before 1.3.0, specifying multiple pkgconfig_define pairs would silently malform the results. Only the first variable would be redefined, but its value would contain both the second variable name, as well as its value. optargs: varname: type: str since: 0.58.0 description: | This argument is used as a default value for `cmake`, `pkgconfig`, `configtool` and `internal` keyword arguments. It is useful in the common case where `pkgconfig` and `internal` use the same variable name, in which case it's easier to write `dep.get_variable('foo')` instead of `dep.get_variable(pkgconfig: 'foo', internal: 'foo')`. kwargs: cmake: type: str description: The CMake variable name pkgconfig: type: str description: The pkgconfig variable name configtool: type: str description: The configtool variable name internal: type: str since: 0.54.0 description: The internal variable name default_value: type: str description: The default value to return when the variable does not exist pkgconfig_define: type: list[str] description: See [[dep.get_pkgconfig_variable]] meson-docs/docs/yaml/objects/runresult.yaml0000644000175000017500000000132514656633773021006 0ustar lattislattisname: runresult long_name: Run result object description: | This object encapsulates the result of trying to compile and run a sample piece of code with [[compiler.run]] or [[run_command]]. methods: - name: compiled returns: bool description: | If `true`, the compilation succeeded, if `false` it did not and the other methods return unspecified data. This is only available for `compiler.run()` results. - name: returncode returns: int description: The return code of executing the compiled binary - name: stderr returns: str description: The standard error produced when the command was run. - name: stdout returns: str description: The standard out produced when the command was run. meson-docs/docs/yaml/objects/lib.yaml0000644000175000017500000000016114656633773017506 0ustar lattislattisname: lib long_name: Library target extends: build_tgt description: Represents either a shared or static library meson-docs/docs/yaml/objects/custom_tgt.yaml0000644000175000017500000000236514656633773021140 0ustar lattislattisname: custom_tgt long_name: Custom target extends: tgt description: | This object is returned by [[custom_target]] and contains a target with the following methods: methods: - name: full_path returns: str description: | Returns a full path pointing to the result target file NOTE: In most cases using the object itself will do the same job as this and will also allow Meson to setup inter-target dependencies correctly. Please file a bug if that doesn't work for you. *(since 0.54.0)* It can be also called on indexes objects: `custom_targets[i].full_path()`. - name: "[index]" returns: custom_idx description: | Returns an opaque object that references this target, and can be used as a source in other targets. When it is used as such it will make that target depend on this custom target, but the only source added will be the one that corresponds to the index of the custom target's output argument. - name: to_list returns: list[custom_idx] since: 0.54.0 description: | Returns a list of opaque objects that references this target, and can be used as a source in other targets. This can be used to iterate outputs with `foreach` loop. meson-docs/docs/yaml/objects/external_program.yaml0000644000175000017500000000346414656633773022322 0ustar lattislattisname: external_program long_name: External program description: Opaque object representing an external program methods: - name: found returns: bool description: Returns whether the executable was found. - name: path returns: str deprecated: 0.55.0 description: | *Deprecated:* Use [[external_program.full_path]] instead. Returns a string pointing to the script or executable. **NOTE:** You should not usually need to use this method. Passing the object itself should work in most contexts where a program can appear, and allows Meson to setup inter-target dependencies correctly (for example in cases where a program might be overridden by a [[@build_tgt]]). Only use this if you specifically need a string, such as when embedding a program path into a header file, or storing it into an environment variable. For example: ```meson run_command(find_program('foo'), 'arg1', 'arg2') ``` - name: version returns: str since: 0.62.0 description: | The version number as a string, for example `1.2.8`. `unknown` if the program cannot determine the version via a `--version` argument. - name: full_path returns: str since: 0.55.0 description: | Returns a string pointing to the script or executable. **NOTE:** You should not usually need to use this method. Passing the object itself should work in most contexts where a program can appear, and allows Meson to setup inter-target dependencies correctly (for example in cases where a program might be overridden by a [[@build_tgt]]). Only use this if you specifically need a string, such as when embedding a program path into a header file, or storing it into an environment variable. For example: ```meson run_command(find_program('foo'), 'arg1', 'arg2') ``` meson-docs/docs/yaml/objects/inc.yaml0000644000175000017500000000014514656633773017513 0ustar lattislattisname: inc long_name: Include directories description: Opaque wrapper for storing include directories meson-docs/docs/yaml/objects/tgt.yaml0000644000175000017500000000013014656633773017532 0ustar lattislattisname: tgt long_name: Meson Target description: Opaque base object for all Meson targets meson-docs/docs/yaml/objects/feature.yaml0000644000175000017500000001265714656633773020410 0ustar lattislattisname: feature long_name: Feature option object since: 0.47.0 description: Meson object representing a [`feature` options](Build-options.md#features) methods: - name: enabled returns: bool description: Returns whether the feature was set to `'enabled'` - name: disabled returns: bool description: Returns whether the feature was set to `'disabled'` - name: auto returns: bool description: Returns whether the feature was set to `'auto'` - name: allowed since: 0.59.0 returns: bool description: Returns whether the feature was set to `'enabled'` or `'auto'` - name: disable_auto_if since: 0.59.0 returns: feature description: | Returns the feature, with `'auto'` converted to `'disabled'` if value is true. | Feature | `value = true` | `value = false` | | -------- | -------------- | --------------- | | Auto | Disabled | Auto | | Enabled | Enabled | Enabled | | Disabled | Disabled | Disabled | example: | `disable_auto_if` is useful to give precedence to mutually exclusive dependencies (that provide the same API) if either or both are available: ``` # '-Dfoo=auto -Dbar=enabled' will not pick foo even if installed. use_bar = get_option('bar') use_foo = get_option('foo').disable_auto_if(use_bar.enabled()) dep_foo = dependency('foo', required: use_foo) if not dep_foo.found() dep_foo = dependency('bar', required: use_bar) endif ``` posargs: value: type: bool description: See the table above - name: enable_auto_if since: 1.1.0 returns: feature description: | Returns the feature, with `'auto'` converted to `'enabled'` if value is true. | Feature | `value = true` | `value = false` | | -------- | -------------- | --------------- | | Auto | Enabled | Auto | | Enabled | Enabled | Enabled | | Disabled | Disabled | Disabled | posargs: value: type: bool description: See the table above - name: require returns: feature since: 0.59.0 description: | Returns the object itself if the value is true; an error if the object is `'enabled'` and the value is false; a disabled feature if the object is `'auto'` or `'disabled'` and the value is false. | Feature | `value = true` | `value = false` | | -------- | -------------- | --------------- | | Auto | Auto | Disabled | | Enabled | Enabled | Error | | Disabled | Disabled | Disabled | example: | `require` is useful to restrict the applicability of `'auto'` features, for example based on other features or on properties of the host machine: ``` if get_option('directx').require(host_machine.system() == 'windows', error_message: 'DirectX only available on Windows').allowed() then src += ['directx.c'] config.set10('HAVE_DIRECTX', true) endif ``` posargs: value: type: bool description: The value to check kwargs: error_message: type: str default: "''" description: The error message to print if the check fails - name: enable_if returns: feature since: 1.1.0 description: | Returns the object itself if the value is false; an error if the object is `'disabled'` and the value is true; an enabled feature if the object is `'auto'` or `'enabled'` and the value is true. | Feature | `value = true` | `value = false` | | -------- | -------------- | --------------- | | Auto | Enabled | Auto | | Enabled | Enabled | Enabled | | Disabled | Error | Disabled | example: | `enable_if` is useful to restrict the applicability of `'auto'` features, particularly when passing them to [[dependency]]: ``` use_llvm = get_option('llvm').enable_if(with_clang).enable_if(with_llvm_libs) dep_llvm = dependency('llvm', required: use_llvm) ``` posargs: value: type: bool description: The value to check kwargs: error_message: type: str default: "''" description: The error message to print if the check fails - name: disable_if returns: feature since: 1.1.0 description: | Returns the object itself if the value is false; an error if the object is `'enabled'` and the value is true; a disabled feature if the object is `'auto'` or `'disabled'` and the value is true. | Feature | `value = true` | `value = false` | | -------- | -------------- | --------------- | | Auto | Disabled | Auto | | Enabled | Error | Enabled | | Disabled | Disabled | Disabled | This is equivalent to `feature_opt.require(not condition)`, but may make code easier to reason about, especially when mixed with `enable_if` example: | `disable_if` is useful to restrict the applicability of `'auto'` features, particularly when passing them to [[dependency]]: ``` use_os_feature = get_option('foo') \ .disable_if(host_machine.system() == 'darwin', error_message : 'os feature not supported on MacOS') dep_os_feature = dependency('os_feature', required: use_os_feature) ``` posargs: value: type: bool description: The value to check kwargs: error_message: type: str default: "''" description: The error message to print if the check fails meson-docs/docs/yaml/objects/custom_idx.yaml0000644000175000017500000000100414656633773021113 0ustar lattislattisname: custom_idx long_name: Custom target index description: References a specific output file of a [[@custom_tgt]] object. methods: - name: full_path returns: str since: 0.54.0 description: | Returns a full path pointing to the result target file NOTE: In most cases using the object itself will do the same job as this and will also allow Meson to setup inter-target dependencies correctly. Please file a bug if that doesn't work for you. See [[custom_tgt.full_path]] meson-docs/docs/yaml/objects/extracted_obj.yaml0000644000175000017500000000020714656633773021556 0ustar lattislattisname: extracted_obj long_name: Extracted object file description: Opaque object representing extracted object files from build targets meson-docs/docs/yaml/objects/env.yaml0000644000175000017500000000435714656633773017543 0ustar lattislattisname: env long_name: Environment description: | This object is returned by [[environment]] and stores detailed information about how environment variables should be set. It should be passed as the `env` keyword argument to tests and other functions. *Since 0.58.0* [[env.append]] and [[env.prepend]] can be called multiple times on the same `varname`. Earlier Meson versions would warn and only the last operation took effect. example: | ```meson env = environment() # MY_PATH will be '0:1:2:3' env.set('MY_PATH', '1') env.append('MY_PATH', '2') env.append('MY_PATH', '3') env.prepend('MY_PATH', '0') ``` methods: - name: append returns: void description: | appends the given values to the old value of the environment variable, e.g. `env.append('FOO', 'BAR', 'BAZ', separator : ';')` produces `BOB;BAR;BAZ` if `FOO` had the value `BOB` and plain `BAR;BAZ` if the value was not defined. posargs: variable: type: str description: The variable to modify varargs: type: str name: Value description: The values to append kwargs: separator: type: str description: | The separator to use. If not explicitly specified, the default path separator for the host operating system will be used, i.e. ';' for Windows and ':' for UNIX/POSIX systems. - name: prepend returns: void description: Same as `append` except that it writes to the beginning of the variable. posargs: variable: type: str description: The variable to modify varargs: type: str name: Value description: The values to prepend kwargs_inherit: env.append - name: set returns: void description: | Sets the environment variable specified in the first argument to the values in the varargs joined by the separator. For instance, `env.set('FOO', 'BAR'),` sets envvar `FOO` to value `BAR`. posargs: variable: type: str description: The variable to modify varargs: type: str name: Value description: The values to set kwargs_inherit: env.append - name: unset returns: void since: 1.4.0 description: | Unset the specified environment variable. If this variable does not exist, nothing happens. meson-docs/docs/yaml/objects/generator.yaml0000644000175000017500000000324114656633773020730 0ustar lattislattisname: generator long_name: Generator object description: | This object is returned by [[generator]] and contains a generator that is used to transform files from one type to another by an executable (e.g. `idl` files into source code and headers). methods: - name: process returns: generated_list description: | Takes a list of files, causes them to be processed and returns an object containing the result which can then, for example, be passed into a build target definition. varargs: name: source min_varargs: 1 type: str | file | custom_tgt | custom_idx | generated_list description: List of sources to process. kwargs: extra_args: type: list[str] description: | If present, will be used to replace an entry `@EXTRA_ARGS@` in the argument list. preserve_path_from: type: str since: 0.45.0 description: | If given, specifies that the output files need to maintain their directory structure inside the target temporary directory. The most common value for this is `meson.current_source_dir()`. With this value when a file called `subdir/one.input` is processed it generates a file `{target private directory}/subdir/one.out` as opposed to `{target private directory}/one.out`. env: type: env | list[str] | dict[str] since: 1.3.0 description: | environment variables to set, such as `{'NAME1': 'value1', 'NAME2': 'value2'}` or `['NAME1=value1', 'NAME2=value2']`, or an [[@env]] object which allows more sophisticated environment juggling. meson-docs/docs/yaml/objects/build_tgt.yaml0000644000175000017500000000602314656633773020720 0ustar lattislattisname: build_tgt long_name: Build target extends: tgt description: | A build target is either an executable, shared library, static library, both shared and static library or shared module. methods: - name: extract_objects returns: extracted_obj description: | Returns an opaque value representing the object files generated for those source files. This is typically used to take single object files and link them to unit tests or to compile some source files with custom flags. To use the object file(s) in another build target, use the `objects:` keyword argument to a [[build_target]] or [[declare_dependency]], or include them in the command line of a [[custom_target]]. varargs: name: source type: str | file | custom_tgt | custom_idx | generated_list description: | Source filenames for which the built objects should be extracted. min_varargs: 1 - name: extract_all_objects returns: extracted_obj description: | Acts the same as `extract_objects`, but returns all object files generated by this target. By default only objects built for this target are returned to maintain backward compatibility with previous versions. The default value for the `recursive` kwarg will eventually be changed to `true` in a future version. kwargs: recursive: type: bool description: | Also return objects passed to the `objects` argument of this target. since: 0.46.0 default: true - name: full_path returns: str description: | Returns a full path pointing to the result target file. **NOTE:** In most cases using the object itself will do the same job as this and will also allow Meson to setup inter-target dependencies correctly. Please file a bug if that doesn't work for you. - name: path returns: str since: 0.59.0 deprecated: 0.59.0 description: | Does the exact same as [[build_tgt.full_path]]. **NOTE**: This function is solely kept for compatibility with [[@external_program]] objects. It will be removed once the, also deprecated, corresponding `path()` function in the [[@external_program]] object is removed. - name: private_dir_include returns: inc description: | Returns a value that works like [[include_directories]], but points to the private directory of this target. Usually only needed if an another target needs to access some generated internal headers of this target. - name: name returns: str since: 0.54.0 description: Returns the name of the target. - name: get_id returns: str since: 0.26.0 description: Returns a unique id for the target - name: outdir returns: str since: 0.26.0 description: Returns the output directory relative to the build root of the target - name: found returns: bool since: 0.59.0 description: | Always returns `true`. This function is meant to make executables objects feature compatible with [[@external_program]] objects. This simplifies use-cases where an executable is used instead of an [[@external_program]]. meson-docs/docs/yaml/objects/structured_src.yaml0000644000175000017500000000016114656633773022013 0ustar lattislattisname: structured_src long_name: Structured Source description: Opaque object returned by [[structured_sources]]. meson-docs/docs/yaml/objects/alias_tgt.yaml0000644000175000017500000000015614656633773020713 0ustar lattislattisname: alias_tgt long_name: Alias target description: Opaque object returned by [[alias_target]]. extends: tgt meson-docs/docs/yaml/objects/compiler.yaml0000644000175000017500000005313514656633773020563 0ustar lattislattisname: compiler long_name: Compiler object description: | This object is returned by [[meson.get_compiler]]. It represents a compiler for a given language and allows you to query its properties. notes: - | These compiler checks do not use compiler arguments added with `add_*_arguments()`, via `-Dlang_args` on the command-line, or through `CFLAGS`/`LDFLAGS`, etc in the environment. Hence, you can trust that the tests will be fully self-contained, and won't fail because of custom flags added by other parts of the build file or by users. - | Note that if you have a single prefix with all your dependencies, you might find it easier to append to the environment variables `C_INCLUDE_PATH` with GCC/Clang and `INCLUDE` with MSVC to expand the default include path, and `LIBRARY_PATH` with GCC/Clang and `LIB` with MSVC to expand the default library search path. However, with GCC, these variables will be ignored when cross-compiling. In that case you need to use a specs file. See: http://www.mingw.org/wiki/SpecsFileHOWTO methods: # Helper methods to pre-define common posargs - name: _code returns: void description: You have found a bug if you can see this! posargs: code: type: str | file description: | The source code to check. If a string is passed, the code is used directly. If a [[@file]] object is passed, its content is used for the compiler check. # Helper methods to pre-define common kwargs - name: _args returns: void description: You have found a bug if you can see this! kwargs: args: type: list[str] description: | Used to pass a list of compiler arguments. Defining include paths for headers not in the default include path via `-Isome/path/to/header` is generally supported, however, usually not recommended. This is because include directories can also be specified via the `include_directories` or the `dependency` kwarg (if present). The same is also true for passing libraries to link with `-lfoo`. - name: _include_directories returns: void description: You have found a bug if you can see this! kwargs: include_directories: type: inc | list[inc] since: 0.38.0 description: Extra directories for header searches. - name: _dependencies returns: void description: You have found a bug if you can see this! kwargs: dependencies: type: dep | list[dep] description: Additionally dependencies required for compiling and / or linking. - name: _prefix returns: void description: You have found a bug if you can see this! kwargs: prefix: type: str | list[str] description: | Used to add `#include`s and other things that are required for the symbol to be declared. Since 1.0.0 an array is accepted too. When an array is passed, the items are concatenated together separated by a newline. System definitions should be passed via compiler args (eg: `_GNU_SOURCE` is often required for some symbols to be exposed on Linux, and it should be passed via `args` keyword argument). - name: _no_builtin_args returns: void description: You have found a bug if you can see this! kwargs: no_builtin_args: type: bool default: false description: When set to `true`, the compiler arguments controlled by built-in configuration options are not added. - name: _name returns: void description: You have found a bug if you can see this! kwargs: name: type: str description: | The name to use for printing a message about the compiler check. If this keyword argument is not passed, no message will be printed about the check. # Even more convenient - name: _common returns: void description: You have found a bug if you can see this! kwargs_inherit: - compiler._args - compiler._include_directories - compiler._dependencies - compiler._no_builtin_args - compiler._prefix - name: _compiles returns: void description: You have found a bug if you can see this! kwargs: required: type: bool | feature default: false since: 1.5.0 description: When set to `true`, Meson will halt if the check fails. When set to a [`feature`](Build-options.md#features) option, the feature will control if it is searched and whether to fail if not found. kwargs_inherit: - compiler._args - compiler._include_directories - compiler._dependencies - compiler._no_builtin_args - compiler._name - compiler._werror - name: _header returns: void description: You have found a bug if you can see this! kwargs_inherit: compiler._common kwargs: required: type: bool | feature default: false since: 0.50.0 description: When set to `true`, Meson will halt if the header check fails. When set to a [`feature`](Build-options.md#features) option, the feature will control if it is searched and whether to fail if not found. - name: _required returns: void description: You have found a bug if you can see this! kwargs: required: type: bool | feature default: false since: 1.3.0 description: When set to `true`, Meson will halt if the check fails. When set to a [`feature`](Build-options.md#features) option, the feature will control if it is searched and whether to fail if not found. - name: _werror returns: void description: You have found a bug if you can see this! kwargs: werror: type: bool default: false description: When set to `true`, compiler warnings are treated as error. since: 1.3.0 # Star of the actual functions - name: version returns: str description: Returns the compiler's version number as a string. - name: cmd_array returns: list[str] description: Returns an array containing the command(s) for the compiler. - name: alignment returns: int description: | Returns the alignment of the specified type. For C-like languages, For C-like languages, the header `stddef.h` and `stdio.h` are included implicitly for native compilation, only `stddef.h` is included when cross-compiling. posargs: typename: type: str description: The name of the type to check. kwargs_inherit: - compiler._args - compiler._prefix - compiler._dependencies # TODO: why not also allow passing `include_directories`? - name: run returns: runresult description: Attempts to compile and execute the given code fragment. posargs_inherit: compiler._code kwargs_inherit: compiler._compiles - name: get_id returns: str description: | Returns a string identifying the compiler. For example, `gcc`, `msvc`, [and more](Reference-tables.md#compiler-ids). - name: get_linker_id returns: str since: 0.53.0 description: | Returns a string identifying the linker. For example, `ld.bfd`, `link`, [and more](Reference-tables.md#linker-ids). - name: symbols_have_underscore_prefix returns: bool since: 0.37.0 description: Returns `true` if the C symbol mangling is one underscore (`_`) prefixed to the symbol. - name: has_member returns: bool description: Returns true if the type has the specified member. kwargs_inherit: - compiler._common - compiler._required posargs: typename: type: str description: The type to check. membername: type: str description: The member to check. - name: has_members returns: bool description: Returns `true` if the type has *all* the specified members. kwargs_inherit: - compiler._common - compiler._required posargs: typename: type: str description: The type to check. varargs: name: member type: str min_varargs: 1 description: The members to check - name: has_function returns: bool description: | Returns true if the given function is provided by the standard library or a library passed in with the `args` keyword. kwargs_inherit: - compiler._common - compiler._required posargs: funcname: type: str description: The function to check. - name: has_type returns: bool description: Returns `true` if the specified token is a type. kwargs_inherit: - compiler._common - compiler._required posargs: typename: type: str description: The type to check. - name: compute_int returns: int since: 0.40.0 kwargs_inherit: compiler._common description: | Computes the value of the given expression (as an example `1 + 2`). When cross compiling this is evaluated with an iterative algorithm, you can specify keyword arguments `low` (defaults to -1024), `high` (defaults to 1024) and `guess` to specify max and min values for the search and the value to try first. For C-like languages, the header `stddef.h` and `stdio.h` are included implicitly for native compilation, only `stddef.h` is included when cross-compiling. posargs: expr: type: str description: The expression to compute. kwargs: low: type: int default: -1024 description: The min value. high: type: int default: 1024 description: The max value. guess: type: int description: The value to try first. - name: sizeof returns: int description: | returns the size of the given type (e.g. `'int'`) or -1 if the type is unknown. For C-like languages, the header `stddef.h` and `stdio.h` are included implicitly for native compilation, only `stddef.h` is included when cross-compiling. kwargs_inherit: compiler._common posargs: typename: type: str description: The type to compute. - name: get_define returns: str since: 0.40.0 description: | Returns the given preprocessor symbol's value as a string or empty string if it is not defined. *(since 0.47.0)* This method will concatenate string literals as the compiler would. E.g. `"a" "b"` will become `"ab"`. kwargs_inherit: compiler._common posargs: definename: type: str description: The define to check. - name: has_define returns: bool since: 1.3.0 description: | Returns true if the given preprocessor symbol is *defined*. kwargs_inherit: compiler._common posargs: definename: type: str description: The define to check. - name: compiles returns: bool description: Returns true if the code compiles. posargs_inherit: compiler._code kwargs_inherit: compiler._compiles - name: links returns: bool description: | Returns true if the code compiles and links. *Since 0.60.0*, if the `file` object's suffix does not match the compiler object's language, the compiler corresponding to the suffix is used to compile the source, while the target of the `links` method is used to link the resulting object file. posargs_inherit: compiler._code kwargs_inherit: compiler._compiles - name: check_header returns: bool since: 0.47.0 description: | Returns true if the specified header is *usable* with the specified prefix, dependencies, and arguments. kwargs_inherit: compiler._header posargs: header_name: type: str description: The header to check. - name: has_header returns: bool description: | Returns true if the specified header is *exists* with the specified prefix, dependencies, and arguments. This method is faster than [[compiler.check_header]] since it only does a pre-processor check. kwargs_inherit: compiler._header posargs_inherit: compiler.check_header - name: has_header_symbol returns: bool description: | Detects whether a particular symbol is declared in the specified header. Symbols here include function, variable, `#define`, type definition, etc. kwargs_inherit: compiler._header posargs: header: type: str description: The header to check. symbol: type: str description: The symbol to check. - name: find_library returns: dep description: Tries to find the library specified in the positional argument. posargs: libname: type: str description: The library to find. kwargs: required: type: bool | feature default: true description: | If set `true`, Meson will abort with an error if the library could not be found. Otherwise, Meson will continue and the found method of the returned object will return `false`. When set to a [`feature`](Build-options.md#features) option, the feature will control if it is searched and whether to fail if not found. *(since 0.47.0)* The value of a `feature` option can also be passed here. has_headers: type: list[str] since: 0.50.0 description: | List of headers that must be found as well. This check is equivalent to checking each header with a [[compiler.has_header]] call. When used, kwargs that [[compiler.has_header]] would accept can be passed here prefixed with `header_`, and will have the same effect on the header check. header_required: type: bool | feature since: 0.50.0 description: | When used in conjunction with the has_headers keyword, set the requirement of the headers. static: type: bool default: false since: 0.51.0 description: | If `true`, the search is limited to static libraries only. Setting this value to `false` (the default) will search for both shared *and* static libraries. disabler: type: bool default: false since: 0.49.0 description: If `true`, this method will return a [[@disabler]] on a failed check. dirs: type: list[str] description: | Additional directories to search in. By default the library is searched for in the system library directory (e.g. /usr/lib). Specifying more directories here, causes Meson to search in those directories as well as the system directories. # does not work, since all _common kwargs need to be prefixed `header_` here # kwargs_inherit: compiler._common header_args: type: list[str] since: 0.51.0 description: | When the `has_headers` kwarg is also used, this argument is passed to [[compiler.has_header]] as `args`. header_include_directories: type: inc | list[inc] since: 0.51.0 description: | When the `has_headers` kwarg is also used, this argument is passed to [[compiler.has_header]] as `include_directories`. header_dependencies: type: dep | list[dep] since: 0.51.0 description: | When the `has_headers` kwarg is also used, this argument is passed to [[compiler.has_header]] as `dependencies`. header_no_builtin_args: type: bool default: false since: 0.51.0 description: | When the `has_headers` kwarg is also used, this argument is passed to [[compiler.has_header]] as `no_builtin_args`. header_prefix: type: str since: 0.51.0 description: | When the `has_headers` kwarg is also used, this argument is passed to [[compiler.has_header]] as `prefix`. # Compiler arguments - name: has_argument returns: bool description: | Returns `true` if the compiler accepts the specified command line argument, that is, can compile code without erroring out or printing a warning about an unknown flag. posargs: argument: type: str description: The argument to check. kwargs_inherit: - compiler._required - name: has_multi_arguments since: 0.37.0 returns: bool description: | the same as [[compiler.has_argument]] but takes multiple arguments and uses them all in a single compiler invocation. varargs: name: arg type: str description: The arguments to check. kwargs_inherit: - compiler._required - name: get_supported_arguments returns: list[str] since: 0.43.0 varargs_inherit: compiler.has_multi_arguments description: | Returns an array containing only the arguments supported by the compiler, as if [[compiler.has_argument]] were called on them individually. kwargs: checked: type: str since: 0.59.0 default: "'off'" description: | Supported values: - `'off'`: Quietly ignore unsupported arguments - `'warn'`: Print a warning for unsupported arguments - `'require'`: Abort if at least one argument is not supported - name: first_supported_argument returns: list[str] since: 0.43.0 varargs_inherit: compiler.has_multi_arguments description: | Given a list of strings, returns a single-element list containing the first argument that passes the [[compiler.has_argument]] test or an empty array if none pass. # Linker arguments - name: has_link_argument since: 0.46.0 returns: bool description: | Returns `true` if the linker accepts the specified command line argument, that is, can compile and link code without erroring out or printing a warning about an unknown flag. Link arguments will be passed to the compiler, so should usually have the `-Wl,` prefix. On VisualStudio a `/link` argument will be prepended. posargs: argument: type: str description: The argument to check. kwargs_inherit: - compiler._required - name: has_multi_link_arguments since: 0.46.0 returns: bool description: | the same as [[compiler.has_link_argument]] but takes multiple arguments and uses them all in a single compiler invocation. varargs: name: arg type: str description: The link arguments to check. kwargs_inherit: - compiler._required - name: get_supported_link_arguments returns: list[str] since: 0.46.0 varargs_inherit: compiler.has_multi_link_arguments description: | Returns an array containing only the arguments supported by the compiler, as if [[compiler.has_link_argument]] were called on them individually. # TODO: why is this not present here? # kwargs: # checked: # type: str # sinec: 0.59.0 # default: "'off'" # description: | # Supported values: # - `'off'`: Quietly ignore unsupported arguments # - `'warn'`: Print a warning for unsupported arguments # - `'require'`: Abort if at least one argument is not supported - name: first_supported_link_argument returns: list[str] since: 0.46.0 varargs_inherit: compiler.has_multi_link_arguments description: | Given a list of strings, returns the first argument that passes the [[compiler.has_link_argument]] test or an empty array if none pass. - name: has_function_attribute returns: bool since: 0.48.0 description: | Returns `true` if the compiler supports the GNU style (`__attribute__(...)`) `name`. This is preferable to manual compile checks as it may be optimized for compilers that do not support such attributes. [This table](Reference-tables.md#gcc-__attribute__) lists all of the supported attributes. posargs: name: type: str description: The attribute name to check. kwargs_inherit: - compiler._required - name: get_supported_function_attributes varargs: name: name type: str min_varargs: 1 description: The attribute names to check. returns: list[str] since: 0.48.0 description: | Returns an array containing any names that are supported GCC style attributes. Equivalent to [[compiler.has_function_attribute]] was called on each of them individually. # TODO: Again why doesn't this function have the checked kwarg? - name: get_argument_syntax returns: str since: 0.49.0 description: | returns a string identifying the type of arguments the compiler takes. Can be one of `gcc`, `msvc`, or an undefined string value. This method is useful for identifying compilers that are not gcc or msvc, but use the same argument syntax as one of those two compilers such as clang or icc, especially when they use different syntax on different operating systems. - name: preprocess returns: list[custom_idx] since: 0.64.0 description: | Preprocess a list of source files but do not compile them. The preprocessor will receive the same arguments (include directories, defines, etc) as with normal compilation. That includes for example args added with `add_project_arguments()`, or on the command line with `-Dc_args=-DFOO`. varargs: name: source type: str | file | custom_tgt | custom_idx | generated_list description: | Input source to preprocess. The following types are supported: - Strings relative to the current source directory - [[@file]] objects defined in any preceding build file - The return value of configure-time generators such as [[configure_file]] - The return value of build-time generators such as [[custom_target]] or [[generator.process]] kwargs_inherit: - compiler._include_directories kwargs: output: type: str description: | Template for name of preprocessed files: `@PLAINNAME@` is replaced by the source filename and `@BASENAME@` is replaced by the source filename without its extension. compile_args: type: list[str] description: | Extra flags to pass to the preprocessor dependencies: type: dep | list[dep] description: Additionally dependencies required. since: 1.1.0 depends: type: list[build_tgt | custom_tgt] description: | Specifies that this target depends on the specified target(s). These targets should be built before starting to preprocess an input. since: 1.4.0 meson-docs/docs/yaml/objects/exe.yaml0000644000175000017500000000012514656633773017521 0ustar lattislattisname: exe long_name: Executable target description: An executable extends: build_tgt meson-docs/docs/yaml/objects/jar.yaml0000644000175000017500000000013614656633773017516 0ustar lattislattisname: jar long_name: JAR build target description: A Java JAR build target extends: build_tgt meson-docs/docs/yaml/objects/run_tgt.yaml0000644000175000017500000000015014656633773020420 0ustar lattislattisname: run_tgt long_name: Run target description: Opaque object returned by [[run_target]]. extends: tgt meson-docs/docs/yaml/objects/range.yaml0000644000175000017500000000020214656633773020030 0ustar lattislattisname: range long_name: Range object since: 0.58.0 description: Opaque object that can be used in a loop and accessed via `[num]`. meson-docs/docs/yaml/objects/module.yaml0000644000175000017500000000053414656633773020231 0ustar lattislattisname: module long_name: Imported module object description: | Base type for all modules. Modules provide their own specific implementation methods, but all modules provide the following methods: methods: - name: found returns: bool since: 0.59.0 description: Returns `true` if the module was successfully imported, otherwise `false`. meson-docs/docs/yaml/objects/cfg_data.yaml0000644000175000017500000000717614656633773020505 0ustar lattislattisname: cfg_data long_name: Configuration data object description: | This object encapsulates configuration values to be used for generating configuration files. A more in-depth description can be found in the [the configuration wiki page](Configuration.md). methods: - name: set returns: void description: Sets a variable to a given value posargs: varname: type: str description: The name of the variable to set value: type: str | int | bool description: The value to set kwargs: description: type: str description: | Message / Comment that will be written in the result file. The replacement assumes a file with C syntax. If your generated file is source code in some other language, you probably don't want to add a description field because it most likely will cause a syntax error. - name: set10 returns: void description: | Is the same as [[cfg_data.set]] but the value is either `true` or `false` and will be written as 1 or 0, respectively posargs: varname: type: str description: The name of the variable to set value: type: bool | int description: | The value to set as either `1` or `0` Passing numbers was never intended to work, and since 0.62 it has been deprecated. It will be removed in a future version of Meson. If you need to pass numbers use the `.set` method. warnings: - numeric values < 0 have the surprising behavior of being converted to `true`, values > 1 have the more expected but unintentional behavior of being interpreted as `true`. kwargs_inherit: cfg_data.set - name: set_quoted returns: void description: Is same as [[cfg_data.set]] but quotes the value in double quotes (`"`) posargs: varname: type: str description: The name of the variable to set value: type: str | int | bool description: The value to set kwargs_inherit: cfg_data.set - name: get returns: str | int | bool since: 0.38.0 description: | Returns the value of `varname`, if the value has not been set returns `default_value` if it is defined *(since 0.38.0)* and errors out if not posargs: varname: type: str description: The name of the variable to query optargs: default_value: type: str | int | bool description: The default value to return when `varname` does not exist - name: get_unquoted returns: str | int | bool since: 0.44.0 description: | Returns the value of `varname` but without surrounding double quotes (`"`). If the value has not been set returns `default_value` if it is defined and errors out if not. posargs: varname: type: str description: The name of the variable to query optargs: default_value: type: str | int | bool description: The default value to return when `varname` does not exist - name: has returns: bool description: returns `true` if the specified variable is set posargs: varname: type: str description: The name of the variable to query - name: keys returns: list[str] since: 0.57.0 description: | Returns an array of keys of the configuration data object. You can iterate over this array with the [`foreach` statement](Syntax.md#foreach-statements). - name: merge_from returns: void since: 0.42.0 description: | Takes as argument a different configuration data object and copies all entries from that object to the current. posargs: other: type: cfg_data description: The other [[@cfg_data]] object to merge into this one. meson-docs/docs/yaml/objects/disabler.yaml0000644000175000017500000000067614656633773020540 0ustar lattislattisname: disabler long_name: Disabler description: | A disabler object is an object that behaves in much the same way as NaN numbers do in floating point math. That is when used in any statement (function call, logical op, etc) they will cause the statement evaluation to immediately short circuit to return a disabler object. A disabler object has one method: methods: - name: found returns: bool description: Always returns `false` meson-docs/docs/yaml/objects/file.yaml0000644000175000017500000000067714656633773017673 0ustar lattislattisname: file long_name: File description: Object that stores the path to an existing file methods: - name: full_path returns: str since: 1.4.0 description: | Returns a full path pointing to the file. This is useful for printing the path with e.g [[message]] function for debugging purpose. **NOTE:** In most cases using the object itself will do the same job as this and will also allow Meson to setup dependencies correctly. meson-docs/docs/yaml/objects/subproject.yaml0000644000175000017500000000163214656633773021124 0ustar lattislattisname: subproject long_name: Subproject object description: This object is returned by [[subproject]] and is an opaque object representing it. methods: - name: found returns: bool since: 0.48.0 description: Returns whether the subproject was successfully setup. - name: get_variable returns: any description: | fetches the specified variable from inside the subproject. This is useful to, for instance, get a [[declare_dependency]] from the [subproject](Subprojects.md). If the variable does not exist, the variable `fallback` is returned. If a fallback is not specified, then attempting to read a non-existing variable will cause a fatal error. arg_flattening: false posargs: var_name: type: str description: The name of the variable to query optargs: fallback: type: any description: The fallback value to return if `var_name` does not exist. meson-docs/docs/yaml/objects/both_libs.yaml0000644000175000017500000000051614656633773020711 0ustar lattislattisname: both_libs long_name: Both libraries object extends: lib description: Container for both a static and shared library. since: 0.46.0 methods: - name: get_shared_lib returns: lib description: Returns the stored shared library - name: get_static_lib returns: lib description: Returns the stored static library meson-docs/docs/yaml/objects/generated_list.yaml0000644000175000017500000000021214656633773021726 0ustar lattislattisname: generated_list long_name: Generated list object description: Opaque object representing the result of a [[generator.process]] call. meson-docs/docs/yaml/builtins/0000755000175000017500000000000014656633773016256 5ustar lattislattismeson-docs/docs/yaml/builtins/build_machine.yaml0000644000175000017500000000261214656633773021726 0ustar lattislattisname: build_machine long_name: Build machine information description: | Provides information about the build machine -- the machine that is doing the actual compilation. See [Cross-compilation](Cross-compilation.md). Currently, these values are populated using [`platform.system()`](https://docs.python.org/3.7/library/platform.html#platform.system) and [`platform.machine()`](https://docs.python.org/3.7/library/platform.html#platform.machine). If you think the returned values for any of these are incorrect for your system or CPU, or if your OS is not in the linked table, please [file a bug](https://github.com/mesonbuild/meson/issues/new) report with details and we'll look into it. methods: - name: cpu_family returns: str description: | Returns the CPU family name. [This table](Reference-tables.md#cpu-families) contains all known CPU families. These are guaranteed to continue working. - name: cpu returns: str description: Returns a more specific CPU name, such as `i686`, `amd64`, etc. - name: system returns: str description: | Returns the operating system name. [This table](Reference-tables.md#operating-system-names) Lists all of the currently known Operating System names, these are guaranteed to continue working. - name: endian returns: str description: returns `'big'` on big-endian systems and `'little'` on little-endian systems. meson-docs/docs/yaml/builtins/host_machine.yaml0000644000175000017500000000102514656633773021601 0ustar lattislattisname: host_machine long_name: Host machine information extends: build_machine description: | Provides information about the host machine -- the machine on which the compiled binary will run. See [Cross-compilation](Cross-compilation.md). It has the same methods as [[@build_machine]]. When not cross-compiling, all the methods return the same values as [[@build_machine]] (because the build machine is the host machine) Note that while cross-compiling, it simply returns the values defined in the cross-info file. meson-docs/docs/yaml/builtins/target_machine.yaml0000644000175000017500000000140214656633773022111 0ustar lattislattisname: target_machine long_name: Target machine information extends: build_machine description: | Provides information about the target machine -- the machine on which the compiled binary's output will run. Hence, this object should only be used while cross-compiling a compiler. See [Cross-compilation](Cross-compilation.md). It has the same methods as [[@build_machine]]. When all compilation is 'native', all the methods return the same values as [[@build_machine]] (because the build machine is the host machine and the target machine). Note that while cross-compiling, it simply returns the values defined in the cross-info file. If `target_machine` values are not defined in the cross-info file, `host_machine` values are returned instead. meson-docs/docs/yaml/builtins/meson.yaml0000644000175000017500000004645514656633773020301 0ustar lattislattisname: meson long_name: Meson object description: | The `meson` object allows you to introspect various properties of the system. This object is always mapped in the `meson` variable. methods: - name: add_dist_script returns: void since: 0.48.0 description: | Causes the script given as argument to run during `dist` operation after the distribution source has been generated but before it is archived. Note that this runs the script file that is in the _staging_ directory, not the one in the source directory. If the script file cannot be found in the staging directory, it is a hard error. The `MESON_DIST_ROOT` environment variables is set when dist scripts is run. *(since 0.54.0)* The `MESON_SOURCE_ROOT` and `MESON_BUILD_ROOT` environment variables are set when dist scripts are run. They are path to the root source and build directory of the main project, even when the script comes from a subproject. *(since 0.58.0)* This command can be invoked from a subproject, it was a hard error in earlier versions. Subproject dist scripts will only be executed when running `meson dist --include-subprojects`. `MESON_PROJECT_SOURCE_ROOT`, `MESON_PROJECT_BUILD_ROOT` and `MESON_PROJECT_DIST_ROOT` environment variables are set when dist scripts are run. They are identical to `MESON_SOURCE_ROOT`, `MESON_BUILD_ROOT` and `MESON_DIST_ROOT` for main project scripts, but for subproject scripts they have the path to the root of the subproject appended, usually `subprojects/`. *(since 1.4.0)* The `MESONREWRITE` environment variable contains the path to the rewrite command that corresponds to the `meson` executable that was used to configure the build. (This might be a different path than the first executable found in `PATH`.) It can be used to remove or replace any [[run_command]] that depends on the revision control system from the build configuration. Note that the value will contain many parts. For example, it may be `python3 /path/to/meson.py introspect`. The user is responsible for splitting the string to an array if needed by splitting lexically like a UNIX shell would. If your script uses Python, `shlex.split()` is the easiest correct way to do this. posargs: script_name: type: str | file | external_program description: | The script to execute. *(since 0.55.0)* The output of [[find_program]] as well as strings are accepted. *(since 0.57.0)* [[@file]] objects and the output of [[configure_file]] may be used. varargs: name: arg type: str | file | external_program since: 0.49.0 description: | Additional arguments *(since 0.55.0)* The output of [[configure_file]], [[files]], and [[find_program]] as well as strings are accepted. - name: add_install_script returns: void description: | Causes the script given as an argument to be run during the install step, this script will have the environment variables `MESON_SOURCE_ROOT`, `MESON_BUILD_ROOT`, `MESON_INSTALL_PREFIX`, `MESON_INSTALL_DESTDIR_PREFIX`, and `MESONINTROSPECT` set. All positional arguments are passed as parameters. *(since 0.54.0)* If `meson install` is called with the `--quiet` option, the environment variable `MESON_INSTALL_QUIET` will be set. *(since 1.1.0)* If `meson install` is called with the `--dry-run` option, the environment variable `MESON_INSTALL_DRY_RUN` will be set. Meson uses the `DESTDIR` environment variable as set by the inherited environment to determine the (temporary) installation location for files. Your install script must be aware of this while manipulating and installing files. The correct way to handle this is with the `MESON_INSTALL_DESTDIR_PREFIX` variable which is always set and contains `DESTDIR` (if set) and `prefix` joined together. This is useful because both are usually absolute paths and there are platform-specific edge-cases in joining two absolute paths. In case it is needed, `MESON_INSTALL_PREFIX` is also always set and has the value of the `prefix` option passed to Meson. `MESONINTROSPECT` contains the path to the introspect command that corresponds to the `meson` executable that was used to configure the build. (This might be a different path than the first executable found in `PATH`.) It can be used to query build configuration. Note that the value will contain many parts, f.ex., it may be `python3 /path/to/meson.py introspect`. The user is responsible for splitting the string to an array if needed by splitting lexically like a UNIX shell would. If your script uses Python, `shlex.split()` is the easiest correct way to do this. posargs: script_name: type: str | file | external_program | exe description: | The script to execute. *(since 0.55.0)* The output of [[find_program]], [[executable]], [[custom_target]], as well as strings are accepted. *(since 0.57.0)* [[@file]] objects and the output of [[configure_file]] may be used. varargs: name: arg type: str | file | external_program | exe | custom_tgt | custom_idx since: 0.49.0 description: | Additional arguments *(since 0.55.0)* The output of [[find_program]], [[executable]], [[custom_target]], as well as strings are accepted. kwargs: skip_if_destdir: type: bool since: 0.57.0 default: false description: | If `true` the script will not be run if DESTDIR is set during installation. This is useful in the case the script updates system wide cache that is only needed when copying files into final destination. install_tag: type: str since: 0.60.0 description: | A string used by the `meson install --tags` command to install only a subset of the files. By default the script has no install tag which means it is not being run when `meson install --tags` argument is specified. dry_run: type: bool since: 1.1.0 default: false description: | If `true` the script will be run even if `--dry-run` option is provided to the `meson install` command. The script can use the `MESON_INSTALL_DRY_RUN` variable to determine if it is in dry run mode or not. - name: add_postconf_script returns: void description: | Runs the given command after all project files have been generated. This script will have the environment variables `MESON_SOURCE_ROOT` and `MESON_BUILD_ROOT` set. posargs_inherit: meson.add_dist_script varargs_inherit: meson.add_dist_script - name: backend returns: str since: 0.37.0 description: | Returns a string representing the current backend: - `ninja` - `vs2010` - `vs2012` - `vs2013` - `vs2015` - `vs2017` - `vs2019` - `vs2022` - `xcode` - name: build_options returns: str since: 1.1.0 description: | Returns a string with the configuration line used to set the current project up. notes: - | **Do not try to parse this string!** You should use [[cfg_data.set_quoted]] to safely escape any embedded quotes prior to storing it into e.g. a C header macro. The contents returned by this function are the same as the "Build Options:" line reported in `/meson-logs/meson-log.txt`. - name: build_root returns: str deprecated: 0.56.0 description: | Returns a string with the absolute path to the build root directory. This function will return the build root of the parent project if called from a subproject, which is usually not what you want. Try using [[meson.current_build_dir]] or [[meson.project_build_root]]. In the rare cases where the root of the main project is needed, use [[meson.global_build_root]] that has the same behaviour but with a more explicit name. - name: source_root returns: str deprecated: 0.56.0 description: | Returns a string with the absolute path to the source root directory. This function will return the source root of the parent project if called from a subproject, which is usually not what you want. Try using [[meson.current_source_dir]] or [[meson.project_source_root]]. In the rare cases where the root of the main project is needed, use [[meson.global_source_root]] that has the same behaviour but with a more explicit name. notes: - | You should use the [[files]] function to refer to files in the root source directory instead of constructing paths manually with [[meson.source_root]]. - name: project_build_root returns: str since: 0.56.0 description: Returns a string with the absolute path to the build root directory of the current (sub)project. - name: project_source_root returns: str since: 0.56.0 description: Returns a string with the absolute path to the source root directory of the current (sub)project. - name: global_build_root returns: str since: 0.58.0 description: | Returns a string with the absolute path to the build root directory. This function will return the build root of the main project if called from a subproject, which is usually not what you want. It is usually preferable to use [[meson.current_build_dir]] or [[meson.project_build_root]]. - name: global_source_root returns: str since: 0.58.0 description: | Returns a string with the absolute path to the source root directory. This function will return the source root of the main project if called from a subproject, which is usually not what you want. It is usually preferable to use [[meson.current_source_dir]] or [[meson.project_source_root]]. - name: current_build_dir returns: str description: Returns a string with the absolute path to the current build directory. - name: current_source_dir returns: str description: Returns a string to the current source directory. notes: - | **You do not need to use this function!** When passing files from the current source directory to a function since that is the default. Also, you can use the [[files]] function to refer to files in the current or any other source directory instead of constructing paths manually with [[meson.current_source_dir]]. - name: get_compiler returns: compiler description: Returns a [[@compiler]] object describing a compiler. posargs: language: type: str description: | The language of the compiler to return. See our [list of supported languages](Reference-tables.md#language-arguments-parameter-names). kwargs: native: type: bool default: false description: | When set to `true` Meson returns the compiler for the build machine (the "native" compiler) and when `false` it returns the host compiler (the "cross" compiler). If `native` is omitted, Meson returns the "cross" compiler if we're currently cross-compiling and the "native" compiler if we're not. - name: get_cross_property returns: any deprecated: 0.58.0 description: | Returns the given property from a cross file, the optional fallback_value is returned if not cross compiling or the given property is not found. This method is replaced by [[meson.get_external_property]]. arg_flattening: false posargs_inherit: meson.get_external_property optargs_inherit: meson.get_external_property - name: get_external_property returns: any since: 0.54.0 description: | Returns the given property from a native or cross file. The optional fallback_value is returned if the given property is not found. arg_flattening: false posargs: propname: type: str description: Name of the property in the cross / native file. optargs: fallback_value: type: any description: Value to return if `propname` is not set in the machine file. kwargs: native: type: bool description: | Setting `native` to `true` forces retrieving a variable from the native file, even when cross-compiling. If `native: false` or not specified, the variable is retrieved from the cross-file if cross-compiling, and from the native-file when not cross-compiling. - name: has_external_property returns: bool since: 0.58.0 description: Checks whether the given property exist in a native or cross file. posargs_inherit: meson.get_external_property kwargs_inherit: meson.get_external_property - name: can_run_host_binaries returns: bool since: 0.55.0 description: | Returns true if the build machine can run binaries compiled for the host. This returns `true` unless you are cross compiling, need a helper to run host binaries, and don't have one. For example when cross compiling from Linux to Windows, one can use `wine` as the helper. - name: has_exe_wrapper returns: bool deprecated: 0.55.0 description: Use [[meson.can_run_host_binaries]] instead. - name: install_dependency_manifest returns: void description: | Installs a manifest file containing a list of all subprojects, their versions and license names to the file name given as the argument. If license files are defined as well, they will be copied next to the manifest and referenced in it. If this function is not used, the builtin option `licensedir` can be used to install the manifest to a given directory with the name `depmf.json`. posargs: output_name: type: str description: Name of the manifest file to install - name: override_find_program returns: void since: 0.46.0 description: | specifies that whenever [[find_program]] is used to find a program named `progname`, Meson should not look it up on the system but instead return `program`, which may either be the result of [[find_program]], [[configure_file]] or [[executable]]. *(since 0.55.0)* If a version check is passed to [[find_program]] for a program that has been overridden with an executable, the current project version is used. posargs: progname: type: str description: The name of the program to override. program: type: exe | file | external_program description: The program to set as the override for `progname`. - name: override_dependency returns: void since: 0.54.0 description: | Specifies that whenever [[dependency]] with `name` is used, Meson should not look it up on the system but instead return `dep_object`, which may either be the result of [[dependency]] or [[declare_dependency]]. Doing this in a subproject allows the parent project to retrieve the dependency without having to know the dependency variable name: `dependency(name, fallback : subproject_name)`. posargs: name: type: str description: The name of the dependency to override. dep_object: type: dep description: The dependency to set as the override for `name`. kwargs: native: type: bool default: false description: | If set to `true`, the dependency is always overwritten for the build machine. Otherwise, the dependency is overwritten for the host machine, which differs from the build machine when cross-compiling. static: type: bool since: 0.60.0 description: | Used to override static and/or shared dependencies separately. If not specified it is assumed `dep_object` follows `default_library` option value. - name: is_cross_build returns: bool description: Returns `true` if the current build is a [cross build](Cross-compilation.md) and `false` otherwise. - name: is_subproject returns: bool description: Returns `true` if the current project is being built as a subproject of some other project and `false` otherwise. - name: is_unity returns: bool description: Returns `true` when doing a [unity build](Unity-builds.md) (multiple sources are combined before compilation to reduce build time) and `false` otherwise. - name: project_version returns: str description: Returns the version string specified in [[project]] function call. - name: project_license returns: list[str] since: 0.45.0 description: Returns the array of licenses specified in [[project]] function call. - name: project_license_files returns: list[file] since: 1.1.0 description: Returns the array of license files specified in the [[project]] function call. - name: project_name returns: str description: Returns the project name specified in the [[project]] function call. - name: version returns: str description: Return a string with the version of Meson. - name: add_devenv returns: void since: 0.58.0 description: | add an [[@env]] object (returned by [[environment]]) to the list of environments that will be applied when using [`meson devenv`](Commands.md#devenv) command line. This is useful for developers who wish to use the project without installing it, it is often needed to set for example the path to plugins directory, etc. Alternatively, a list or dictionary can be passed as first argument. ``` meson devenv = environment() devenv.set('PLUGINS_PATH', meson.current_build_dir()) ... meson.add_devenv(devenv) ``` After configuring and compiling that project, a terminal can be opened with the environment set: ```sh $ meson devenv -C $ echo $PLUGINS_PATH /path/to/source/subdir ``` See [`meson devenv`](Commands.md#devenv) command documentation for a list of environment variables that are set by default by Meson. posargs: env: type: env | str | list[str] | dict[str] | dict[list[str]] description: | The [[@env]] object to add. Since *0.62.0* list of strings is allowed in dictionary values. In that case values are joined using the separator. kwargs: separator: type: str since: 0.62.0 description: | The separator to use for the initial values defined in the first positional argument. If not explicitly specified, the default path separator for the host operating system will be used, i.e. ';' for Windows and ':' for UNIX/POSIX systems. method: type: str since: 0.62.0 description: | Must be one of 'set', 'prepend', or 'append' (defaults to 'set'). Controls if initial values defined in the first positional argument are prepended, appended or replace the current value of the environment variable. meson-docs/docs/yaml/modules/0000755000175000017500000000000014656633773016075 5ustar lattislattismeson-docs/docs/yaml/modules/cmake/0000755000175000017500000000000014656633773017155 5ustar lattislattismeson-docs/docs/yaml/modules/cmake/options.yaml0000644000175000017500000000060714656633773021537 0ustar lattislattisname: cmake_options long_name: CMake subproject options description: Central configuration object for CMake subprojects since: 0.55.0 methods: - name: add_cmake_defines returns: void description: Add CMake defines (`-D=`) to the CMake commandline varargs: name: defines description: A `key` `value` map of CMake defines to add (`-D=`) type: dict[str] meson-docs/docs/yaml/modules/cmake/module.yaml0000644000175000017500000000027014656633773021325 0ustar lattislattisname: cmake long_name: CMake module description: The CMake module methods: - name: subproject_options description: Returns an empty `cmake_options` object. returns: cmake_options meson-docs/docs/yaml/functions/0000755000175000017500000000000014656633773016435 5ustar lattislattismeson-docs/docs/yaml/functions/is_disabler.yaml0000644000175000017500000000027614656633773021606 0ustar lattislattisname: is_disabler returns: bool since: 0.52.0 description: Returns true if a variable is a disabler and false otherwise. posargs: var: type: any description: The variable to test meson-docs/docs/yaml/functions/shared_library.yaml0000644000175000017500000000415114656633773022314 0ustar lattislattisname: shared_library returns: lib description: Builds a shared library with the given sources. posargs_inherit: _build_target_base varargs_inherit: _build_target_base kwargs_inherit: _build_target_base kwargs: version: type: str description: | A string specifying the version of this shared library, such as `1.1.0`. On Linux and OS X, this is used to set the shared library version in the filename, such as `libfoo.so.1.1.0` and `libfoo.1.1.0.dylib`. If this is not specified, `soversion` is used instead (see above). soversion: type: str | int description: | A string or integer specifying the soversion of this shared library, such as `0`. On Linux and Windows this is used to set the soversion (or equivalent) in the filename. For example, if `soversion` is `4`, a Windows DLL will be called `foo-4.dll` and one of the aliases of the Linux shared library would be `libfoo.so.4`. If this is not specified, the first part of `version` is used instead (see below). For example, if `version` is `3.6.0` and `soversion` is not defined, it is set to `3`. darwin_versions: type: str | int | list[str] since: 0.48.0 description: | Defines the `compatibility version` and `current version` for the dylib on macOS. If a list is specified, it must be either zero, one, or two elements. If only one element is specified or if it's not a list, the specified value will be used for setting both compatibility version and current version. If unspecified, the `soversion` will be used as per the aforementioned rules. vs_module_defs: type: str | file | custom_tgt | custom_idx description: | Specify a Microsoft module definition file for controlling symbol exports, etc., on platforms where that is possible (e.g. Windows). *(Since 1.3.0)* [[@custom_idx]] are supported rust_abi: type: str since: 1.3.0 description: | Set the specific ABI to compile (when compiling rust). - 'rust' (default): Create a "dylib" crate. - 'c': Create a "cdylib" crate. meson-docs/docs/yaml/functions/add_global_arguments.yaml0000644000175000017500000000256414656633773023465 0ustar lattislattisname: add_global_arguments returns: void description: Adds global arguments to the compiler command line. notes: - Usually you should use [[add_project_arguments]] instead, because that works even when you project is used as a subproject. - You must pass always arguments individually `arg1, arg2, ...` rather than as a string `'arg1 arg2', ...` varargs: type: str name: Compiler argument description: The compiler arguments to add kwargs: language: type: list[str] required: true description: | Specifies the language(s) that the arguments should be applied to. If a list of languages is given, the arguments are added to each of the corresponding compiler command lines. Note that there is no way to remove an argument set in this way. If you have an argument that is only used in a subset of targets, you have to specify it in per-target flags. native: type: bool default: false since: 0.48.0 description: | A boolean specifying whether the arguments should be applied to the native or cross compilation. If `true` the arguments will only be used for native compilations. If `false` the arguments will only be used in cross compilations. If omitted, the flags are added to native compilations if compiling natively and cross compilations (only) when cross compiling. meson-docs/docs/yaml/functions/join_paths.yaml0000644000175000017500000000137114656633773021461 0ustar lattislattisname: join_paths returns: str since: 0.36.0 description: | Joins the given strings into a file system path segment. For example `join_paths('foo', 'bar')` results in `foo/bar`. If any one of the individual segments is an absolute path, all segments before it are dropped. That means that `join_paths('foo', '/bar')` returns `/bar`. *(since 0.49.0)* Using the `/` operator on strings is equivalent to calling [[join_paths]]. ```meson # res1 and res2 will have identical values res1 = join_paths(foo, bar) res2 = foo / bar ``` warnings: - Don't use [[join_paths]] for sources in [[library]] and [[executable]]. You should use [[files]] instead. varargs: name: part type: str description: The path parts to join. min_varargs: 1 meson-docs/docs/yaml/functions/shared_module.yaml0000644000175000017500000000376514656633773022147 0ustar lattislattisname: shared_module returns: build_tgt since: 0.37.0 description: | Builds a shared module with the given sources. This is useful for building modules that will be `dlopen()`ed and hence may contain undefined symbols that will be provided by the library that is loading it. If you want the shared module to be able to refer to functions and variables defined in the [[executable]] it is loaded by, you will need to set the `export_dynamic` argument of the executable to `true`. notes: - | *Linking to a shared module on platforms other than Android is deprecated, and will be an error in the future*. It was previously allowed because it was the only way to have a shared-library-like target that contained references to undefined symbols. However, since 0.40.0, the `override_options:` [[build_target]] keyword argument can be used to create such a [[shared_library]] by passing `override_options: 'b_lundef=false'`. Shared modules have other characteristics that make them incompatible with linking, such as a lack of SONAME. On macOS and iOS, linking to shared modules is disallowed by the linker, so we disallow it at configure time. On Android, if a shared module `foo` uses symbols from another shared module `bar`, `foo` must also be linked to `bar`. Hence, linking one shared module to another will always be allowed when building for Android. posargs_inherit: _build_target_base varargs_inherit: _build_target_base kwargs_inherit: _build_target_base kwargs: vs_module_defs: type: str | file | custom_tgt | custom_idx since: 0.52.0 description: | Specify a Microsoft module definition file for controlling symbol exports, etc., on platforms where that is possible (e.g. Windows). *(Since 1.3.0)* [[@custom_idx]] are supported rust_abi: type: str since: 1.3.0 description: | Set the specific ABI to compile (when compiling rust). - 'rust' (default): Create a "dylib" crate. - 'c': Create a "cdylib" crate. meson-docs/docs/yaml/functions/run_command.yaml0000644000175000017500000000315714656633773021631 0ustar lattislattisname: run_command returns: runresult description: | Runs the command specified in positional arguments. `command` can be a string, or the output of [[find_program]], [[files]] or [[configure_file]], or [a compiler object](#compiler-object). Returns a [[@runresult]] object containing the result of the invocation. The command is run from an *unspecified* directory, and Meson will set three environment variables `MESON_SOURCE_ROOT`, `MESON_BUILD_ROOT` and `MESON_SUBDIR` that specify the source directory, build directory and subdirectory the target was defined in, respectively. See also [External commands](External-commands.md). varargs: name: command type: str | file | external_program | compiler description: The command to execute during the setup process. kwargs: check: type: bool since: 0.47.0 default: false description: | If `true`, the exit status code of the command will be checked, and the configuration will fail if it is non-zero. Note that the default value will be `true` in future releases. capture: type: bool since: 0.47.0 default: true description: | If `true`, any output generated on stdout will be captured and returned by the `.stdout()` method. If it is false, then `.stdout()` will return an empty string. env: type: env | list[str] | dict[str] since: 0.50.0 description: | environment variables to set, such as `['NAME1=value1', 'NAME2=value2']`, or an [[@env]] object which allows more sophisticated environment juggling. *(Since 0.52.0)* A dictionary is also accepted. meson-docs/docs/yaml/functions/install_symlink.yaml0000644000175000017500000000177414656633773022546 0ustar lattislattisname: install_symlink returns: void since: 0.61.0 description: | Installs a symbolic link to `pointing_to` target under install_dir. posargs: link_name: type: str description: | Name of the created link under `install_dir`. It cannot contain path separators. Those should go in `install_dir`. kwargs: pointing_to: type: str required: true description: | Target to point the link to. Can be absolute or relative and that will be respected when creating the link. install_dir: type: str required: true description: | The absolute or relative path to the installation directory for the links. If this is a relative path, it is assumed to be relative to the prefix. install_tag: type: str description: | A string used by the `meson install --tags` command to install only a subset of the files. By default these files have no install tag which means they are not being installed when `--tags` argument is specified. meson-docs/docs/yaml/functions/static_library.yaml0000644000175000017500000000171014656633773022333 0ustar lattislattisname: static_library returns: lib description: Builds a static library with the given sources. posargs_inherit: _build_target_base varargs_inherit: _build_target_base kwargs_inherit: _build_target_base kwargs: pic: type: bool since: 0.36.0 description: | Builds the library as positional independent code (so it can be linked into a shared library). This option has no effect on Windows and OS X since it doesn't make sense on Windows and PIC cannot be disabled on OS X. prelink: type: bool since: 0.57.0 description: | If `true` the object files in the target will be prelinked, meaning that it will contain only one prelinked object file rather than the individual object files. rust_abi: type: str since: 1.3.0 description: | Set the specific ABI to compile (when compiling rust). - 'rust' (default): Create a "rlib" crate. - 'c': Create a "staticlib" crate. meson-docs/docs/yaml/functions/declare_dependency.yaml0000644000175000017500000000473414656633773023126 0ustar lattislattisname: declare_dependency returns: dep description: | This function returns a [[@dep]] object that behaves like the return value of [[dependency]] but is internal to the current build. The main use case for this is in subprojects. This allows a subproject to easily specify how it should be used. This makes it interchangeable with the same dependency that is provided externally by the system. kwargs: compile_args: type: list[str] description: Compile arguments to use. dependencies: type: list[dep] description: Other dependencies needed to use this dependency. include_directories: type: list[inc | str] description: | the directories to add to header search path, must be [[@inc]] objects or *(since 0.50.0)* plain strings. link_args: type: list[str] description: Link arguments to use. link_with: type: list[lib] description: Libraries to link against. link_whole: type: list[lib] since: 0.46.0 description: Libraries to link fully, same as [[executable]]. sources: type: list[str | file | custom_tgt | custom_idx | generated_list] description: | sources to add to targets (or generated header files that should be built before sources including them are built) extra_files: type: list[str | file] since: 1.2.0 description: | extra files to add to targets. mostly used for IDE integration. version: type: str description: | the version of this dependency, such as `1.2.3`. Defaults to the project version. variables: type: dict[str] | list[str] since: 0.54.0 description: | a dictionary of arbitrary strings, this is meant to be used in subprojects where special variables would be provided via cmake or pkg-config. *since 0.56.0* it can also be a list of `'key=value'` strings. d_module_versions: type: str | int | list[str | int] since: 0.62.0 description: | The [D version identifiers](https://dlang.org/spec/version.html#version) to add during the compilation of D source files. d_import_dirs: type: list[inc | str] since: 0.62.0 description: | the directories to add to the string search path (i.e. `-J` switch for DMD). Must be [[@inc]] objects or plain strings. objects: type: list[extracted_obj] since: 1.1.0 description: | a list of object files, to be linked directly into the targets that use the dependency. meson-docs/docs/yaml/functions/custom_target.yaml0000644000175000017500000002344714656633773022213 0ustar lattislattisname: custom_target returns: custom_tgt description: | Create a custom top level build target. The only positional argument is the name of this target and cannot contain path separators (`/` or `\`). The name of custom target might not be used by every backends, for instance with the Ninja backend, `subdir/meson.build` containing the example below, `ninja -C builddir foo` or `ninja -C builddir subdir/foo` won't work, it is instead `ninja -C builddir subdir/file.txt`. However, `meson compile subdir/foo` is accepted. ```meson custom_target('foo', output: 'file.txt', ...) ``` *Since 0.60.0* the name argument is optional and defaults to the basename of the first output (`file.txt` in the example above). The list of strings passed to the `command` keyword argument accept the following special string substitutions: - `@INPUT@`: the full path to the input passed to `input`. If more than one input is specified, all of them will be substituted as separate arguments only if the command uses `'@INPUT@'` as a standalone-argument. For instance, this would not work: `command : ['cp', './@INPUT@']`, but this would: `command : ['cp', '@INPUT@']`. - `@OUTPUT@`: the full path to the output passed to `output`. If more than one outputs are specified, the behavior is the same as `@INPUT@`. - `@INPUT0@` `@INPUT1@` `...`: the full path to the input with the specified array index in `input` - `@OUTPUT0@` `@OUTPUT1@` `...`: the full path to the output with the specified array index in `output` - `@OUTDIR@`: the full path to the directory where the output(s) must be written - `@DEPFILE@`: the full path to the dependency file passed to `depfile` - `@PLAINNAME@`: the input filename, without a path - `@PLAINNAME0@` `@PLAINNAME1@` `...` *(since 1.5.0)*: the input filename without a path, with the specified array index in `input` - `@BASENAME@`: the input filename, with extension removed - `@BASENAME0@` `@BASENAME1@` `...` *(since 1.5.0)*: the input filename with extension removed, with the specified array index in `input` - `@PRIVATE_DIR@` *(since 0.50.1)*: path to a directory where the custom target must store all its intermediate files. - `@SOURCE_ROOT@`: the path to the root of the source tree. Depending on the backend, this may be an absolute or a relative to current workdir path. - `@BUILD_ROOT@`: the path to the root of the build tree. Depending on the backend, this may be an absolute or a relative to current workdir path. - `@CURRENT_SOURCE_DIR@`: this is the directory where the currently processed meson.build is located in. Depending on the backend, this may be an absolute or a relative to current workdir path. *(since 0.47.0)* The `depfile` keyword argument also accepts the `@BASENAME@` and `@PLAINNAME@` substitutions. The returned object also has methods that are documented in [[@custom_tgt]]. notes: - | Assuming that `command:` is executed by a POSIX `sh` shell is not portable, notably to Windows. Instead, consider using a `native: true` [[executable]], or a python script. warnings: - the `install_mode` kwarg ignored integer values between 0.60.0 -- 1.1.0. optargs: name: type: str description: | The *unique* id of the custom target This posarg is optional *since 0.60.0*. It defaults to the basename of the first output. kwargs: build_by_default: type: bool since: 0.38.0 description: | Causes, when set to true, to have this target be built by default. This means it will be built when `meson compile` is called without any arguments. The default value is `false`. *(since 0.50.0)* If `build_by_default` is explicitly set to false, `install` will no longer override it. If `build_by_default` is not set, `install` will still determine its default. build_always: type: bool deprecated: 0.47.0 description: | If `true` this target is always considered out of date and is rebuilt every time. Equivalent to setting both `build_always_stale` and `build_by_default` to true. build_always_stale: type: bool since: 0.47.0 default: false description: | If `true` the target is always considered out of date. Useful for things such as build timestamps or revision control tags. The associated command is run even if the outputs are up to date. capture: type: bool default: false description: | There are some compilers that can't be told to write their output to a file but instead write it to standard output. When this argument is set to true, Meson captures `stdout` and writes it to the target file. Note that your command argument list may not contain `@OUTPUT@` when capture mode is active. console: type: bool since: 0.48.0 description: | Keyword argument conflicts with `capture`, and is meant for commands that are resource-intensive and take a long time to finish. With the Ninja backend, setting this will add this target to [Ninja's `console` pool](https://ninja-build.org/manual.html#_the_literal_console_literal_pool), which has special properties such as not buffering stdout and serializing all targets in this pool. command: type: list[str | file | exe | external_program | custom_tgt | build_tgt | custom_idx] description: | Command to run to create outputs from inputs. The command may be strings or the return value of functions that return file-like objects such as [[find_program]], [[executable]], [[configure_file]], [[files]], [[custom_target]], etc. Meson will automatically insert the appropriate dependencies on targets and files listed in this keyword argument. Note: always specify commands in array form `['commandname', '-arg1', '-arg2']` rather than as a string `'commandname -arg1 -arg2'` as the latter will *not* work. depend_files: type: list[str | file] description: | files ([[@str]], [[@file]], or the return value of [[configure_file]] that this target depends on but are not listed in the `command` keyword argument. Useful for adding regen dependencies. depends: type: list[build_tgt | custom_tgt | custom_idx] description: | Specifies that this target depends on the specified target(s), even though it does not take any of them as a command line argument. This is meant for cases where you have a tool that e.g. does globbing internally. Usually you should just put the generated sources as inputs and Meson will set up all dependencies automatically (custom_idx was unavailable as a type between 0.60 and 1.4.0). depfile: type: str description: | A dependency file that the command can write listing all the additional files this target depends on, for example a C compiler would list all the header files it included, and a change in any one of these files triggers a recompilation. *(since 0.47.0)* the `@BASENAME@` and `@PLAINNAME@` substitutions are also accepted. input: type: list[str | file | build_tgt | custom_idx | custom_tgt | external_program | extracted_obj | generated_list] description: List of source files. *(since 0.41.0)* the list is flattened. install: type: bool description: When true, one or more files of this target are installed during the install step (see `install_dir` for details). install_dir: type: bool | str | list[bool | str] description: | If only one install_dir is provided, all outputs are installed there. *Since 0.40.0* Allows you to specify the installation directory for each corresponding output. For example: ```meson custom_target('different-install-dirs', output : ['first.file', 'second.file'], install : true, install_dir : ['somedir', 'otherdir']) ``` This would install `first.file` to `somedir` and `second.file` to `otherdir`. To only install some outputs, pass `false` for the outputs that you don't want installed. For example: ```meson custom_target('only-install-second', output : ['first.file', 'second.file'], install : true, install_dir : [false, 'otherdir']) ``` This would install `second.file` to `otherdir` and not install `first.file`. install_mode: type: list[str | int | bool] since: 0.47.0 description: | The file mode and optionally the owner/uid and group/gid. See the `install_mode` kwarg of [[install_data]] for more information. install_tag: type: list[str | bool] since: 0.60.0 description: | A list of strings, one per output, used by the `meson install --tags` command to install only a subset of the files. By default all outputs have no install tag which means they are not being installed when `--tags` argument is specified. If only one tag is specified, it is assumed that all outputs have the same tag. `false` can be used for outputs that have no tag or are not installed. output: type: list[str] description: List of output files. env: since: 0.57.0 type: env | list[str] | dict[str] description: | environment variables to set, such as `{'NAME1': 'value1', 'NAME2': 'value2'}` or `['NAME1=value1', 'NAME2=value2']`, or an [[@env]] object which allows more sophisticated environment juggling. feed: type: bool since: 0.59.0 default: false description: | There are some compilers that can't be told to read their input from a file and instead read it from standard input. When this argument is set to `true`, Meson feeds the input file to `stdin`. Note that your argument list may not contain `@INPUT@` when feed mode is active. meson-docs/docs/yaml/functions/add_test_setup.yaml0000644000175000017500000000347614656633773022342 0ustar lattislattisname: add_test_setup returns: void description: | Add a custom test setup. This setup can be used to run the tests with a custom setup, for example under Valgrind. To use the test setup, run `meson test --setup=*name*` inside the build dir. Note that all these options are also available while running the `meson test` script for running tests instead of `ninja test` or `msbuild RUN_TESTS.vcxproj`, etc depending on the backend. posargs: name: type: str description: The name of the test setup kwargs: env: type: env | list[str] | dict[str] description: | environment variables to set , such as `['NAME1=value1', 'NAME2=value2']`, or an [[@env]] object which allows more sophisticated environment juggling. *(Since 0.52.0)* A dictionary is also accepted. exe_wrapper: type: list[str | external_program] description: The command or script followed by the arguments to it gdb: type: bool default: false description: If `true`, the tests are also run under `gdb` timeout_multiplier: type: int default: 1 description: | A number to multiply the test timeout with. *Since 0.57* if timeout_multiplier is `<= 0` the test has infinite duration, in previous versions of Meson the test would fail with a timeout immediately. is_default: type: bool since: 0.49.0 default: false description: | Set whether this is the default test setup. If `true`, the setup will be used whenever `meson test` is run without the `--setup` option. exclude_suites: type: list[str] since: 0.57.0 description: A list of test suites that should be excluded when using this setup. Suites specified in the `--suite` option to `meson test` will always run, overriding `add_test_setup` if necessary.meson-docs/docs/yaml/functions/find_program.yaml0000644000175000017500000001220114656633773021764 0ustar lattislattisname: find_program returns: external_program | exe description: | `program_name` here is a string that can be an executable or script to be searched for in `PATH` or other places inside the project. The search order is: 1. Program overrides set via [[meson.override_find_program]] 1. [`[provide]` sections](Wrap-dependency-system-manual.md#provide-section) in subproject wrap files, if [`wrap_mode`](Builtin-options.md#core-options) is set to `forcefallback` 1. [`[binaries]` section](Machine-files.md#binaries) in your machine files 1. Directories provided using the `dirs:` kwarg (see below) 1. Project's source tree relative to the current subdir - If you use the return value of [[configure_file]], the current subdir inside the build tree is used instead 1. `PATH` environment variable 1. [`[provide]` sections](Wrap-dependency-system-manual.md#provide-section) in subproject wrap files, if [`wrap_mode`](Builtin-options.md#core-options) is set to anything other than `nofallback` Meson will also autodetect scripts with a shebang line and run them with the executable/interpreter specified in it both on Windows (because the command invocator will reject the command otherwise) and Unixes (if the script file does not have the executable bit set). Hence, you *must not* manually add the interpreter while using this script as part of a list of commands. Since *0.50.0* if the "python3" program is requested and it is not found in the system, Meson will return its current interpreter. If you need to check for a program in a non-standard location, you can just pass an absolute path to `find_program`, e.g. ```meson setcap = find_program('setcap', '/usr/sbin/setcap', '/sbin/setcap', required : false) ``` It is also possible to pass an array to `find_program` in case you need to construct the set of paths to search on the fly: ```meson setcap = find_program(['setcap', '/usr/sbin/setcap', '/sbin/setcap'], required : false) ``` *Since 1.2.0* `find_program('meson')` is automatically overridden to the Meson command used to execute the build script. The returned [[@external_program]] object also has documented methods. posargs: program_name: type: str | file description: | The name of the program to search, or a [[@file]] object to be used without searching. varargs: name: fallback type: str | file since: 0.37.0 description: | These parameters are used as fallback names to search for. This is meant to be used for cases where the program may have many alternative names, such as `foo` and `foo.py`. The function will check for the arguments one by one and the first one that is found is returned. kwargs: required: type: bool | feature default: true description: | When `true`, Meson will abort if no program can be found. If `required` is set to `false`, Meson continue even if none of the programs can be found. You can then use the `.found()` method on the returned [[@external_program]] to check whether it was found or not. *(since 0.47.0)* The value of a [`feature`](Build-options.md#features) option can also be passed to the `required` keyword argument. native: type: bool default: false since: 0.43.0 description: | Defines how this executable should be searched. By default it is set to `false`, which causes Meson to first look for the executable in the cross file (when cross building) and if it is not defined there, then from the system. If set to `true`, the cross file is ignored and the program is only searched from the system. disabler: type: bool since: 0.49.0 default: false description: | If `true` and the program couldn't be found, return a [[@disabler]] object instead of a not-found object. version: type: list[str] since: 0.52.0 description: | Specifies the required version, see [[dependency]] for argument format. By default, the version of the program is determined by running `program_name --version` command. If stdout is empty it fallbacks to stderr. If the output contains more text than simply a version number, only the first occurrence of numbers separated by dots is kept. If the output is more complicated than that, the version checking will have to be done manually using [[run_command]]. version_argument: type: str since: 1.5.0 description: | Specifies the argument to pass when trying to find the version of the program. If this is unspecified, `program_name --version` will be used. dirs: type: list[str] since: 0.53.0 description: extra list of absolute paths where to look for program names. default_options: type: list[str] | dict[str | bool | int | list[str]] since: 1.3.0 description: | An array of default option values that override those set in the subproject's `meson.options` (like `default_options` in [[project]], they only have effect when Meson is run for the first time, and command line arguments override any default options in build files) meson-docs/docs/yaml/functions/add_project_arguments.yaml0000644000175000017500000000105314656633773023663 0ustar lattislattisname: add_project_arguments returns: void description: | Adds project specific arguments to the compiler command line. This function behaves in the same way as [[add_global_arguments]] except that the arguments are only used for the current project, they won't be used in any other subproject. notes: - You must pass always arguments individually `arg1, arg2, ...` rather than as a string `'arg1 arg2', ...` varargs: type: str name: Compiler argument description: The compiler arguments to add kwargs_inherit: add_global_arguments meson-docs/docs/yaml/functions/files.yaml0000644000175000017500000000150714656633773020426 0ustar lattislattisname: files returns: list[file] description: | This command takes the strings given to it in arguments and returns corresponding File objects that you can use as sources for build targets. The difference is that file objects remember the subdirectory they were defined in and can be used anywhere in the source tree. example: | As an example suppose you have source file `foo.cpp` in subdirectory `bar1` and you would like to use it in a build target that is defined in `bar2`. To make this happen you first create the object in `bar1` like this: ```meson foofile = files('foo.cpp') ``` Then you can use it in `bar2` like this: ```meson executable('myprog', 'myprog.cpp', foofile, ...) ``` Meson will then do the right thing. varargs: name: file type: str description: Path to the file. meson-docs/docs/yaml/functions/install_headers.yaml0000644000175000017500000000445514656633773022472 0ustar lattislattisname: install_headers returns: void description: | Installs the specified header files from the source tree into the system header directory (usually `/{prefix}/include`) during the install step. This directory can be overridden by specifying it with the `install_dir` keyword argument. If you just want to install into a subdirectory of the system header directory, then use the `subdir` argument. As an example if this has the value `myproj` then the headers would be installed to `/{prefix}/include/myproj`. example: | For example, this will install `common.h` and `kola.h` into `/{prefix}/include`: ```meson install_headers('common.h', 'proj/kola.h') ``` This will install `common.h` and `kola.h` into `/{prefix}/include/myproj`: ```meson install_headers('common.h', 'proj/kola.h', subdir : 'myproj') ``` This will install `common.h` and `kola.h` into `/{prefix}/cust/myproj`: ```meson install_headers('common.h', 'proj/kola.h', install_dir : 'cust', subdir : 'myproj') ``` This will install `common.h` into `/{prefix}/include` and `kola.h` into `/{prefix}/include/proj/`: ```meson install_headers('common.h, 'proj/kola.h', preserve_path : true) ``` varargs: name: file type: file | str description: Header files to install. warnings: - the `install_mode` kwarg ignored integer values between 0.59.0 -- 1.1.0. kwargs: install_dir: type: str description: Where to install to. subdir: type: str description: | Install to the `subdir` subdirectory of the default includedir. Incompatible with the `install_dir` kwarg. install_mode: type: list[str | int | bool] since: 0.47.0 description: | Specify the file mode in symbolic format and optionally the owner/uid and group/gid for the installed files. See the `install_mode` kwarg of [[install_data]] for more information. preserve_path: type: bool since: 0.63.0 default: false description: | Disable stripping child-directories from header files when installing. This is equivalent to GNU Automake's `nobase` option. follow_symlinks: type: bool since: 1.3.0 default: true description: | If true, dereferences links and copies their target instead. The default value will become false in the future. meson-docs/docs/yaml/functions/unset_variable.yaml0000644000175000017500000000036714656633773022332 0ustar lattislattisname: unset_variable returns: void since: 0.60.0 description: | Unsets a variable. Referencing a variable which has been unset is an error until it has been set again. posargs: varname: type: str description: The variable to unset. meson-docs/docs/yaml/functions/message.yaml0000644000175000017500000000066314656633773020752 0ustar lattislattisname: message returns: void description: This function prints its argument to stdout. arg_flattening: false posargs: text: type: str | int | bool | list[str | int | bool] | dict[str | int | bool] description: The message to print. varargs: name: more_text since: 0.54.0 type: str | int | bool | list[str | int | bool] | dict[str | int | bool] description: Additional text that will be printed separated by spaces. meson-docs/docs/yaml/functions/add_languages.yaml0000644000175000017500000000267614656633773022112 0ustar lattislattisname: add_languages returns: bool description: | Add programming languages used by the project. This is equivalent to having them in the `project` declaration. This function is usually used to add languages that are only used under some conditions. Returns `true` if all languages specified were found and `false` otherwise. If `native` is omitted, the languages may be used for either build or host machine, but are never required for the build machine. (i.e. it is equivalent to `add_languages(*langs*, native: false, required: *required*) and add_languages(*langs*, native: true, required: false)`. This default behaviour may change to `native: false` in a future Meson version. example: | ```meson 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... ``` varargs: type: str name: Language description: The languages to add kwargs: required: type: bool | feature default: true description: | If set to `true`, Meson will halt if any of the languages specified are not found. *(since 0.47.0)* The value of a [`feature`](Build-options.md#features) option can also be passed. native: type: bool since: 0.54.0 description: | If set to `true`, the language will be used to compile for the build machine, if `false`, for the host machine. meson-docs/docs/yaml/functions/add_project_dependencies.yaml0000644000175000017500000000065714656633773024315 0ustar lattislattisname: add_project_dependencies since: 0.63.0 returns: void description: | Adds arguments to the compiler and linker command line, so that the given set of dependencies is included in all build products for this project. varargs: type: dep name: dependencies description: The dependencies to add; if internal dependencies are included, they must not include any built object. kwargs_inherit: add_global_arguments meson-docs/docs/yaml/functions/subdir_done.yaml0000644000175000017500000000144514656633773021622 0ustar lattislattisname: subdir_done returns: void since: 0.46.0 description: | Stops further interpretation of the Meson script file from the point of the invocation. All steps executed up to this point are valid and will be executed by Meson. This means that all targets defined before the call of [[subdir_done]] will be build. If the current script was called by `subdir` the execution returns to the calling directory and continues as if the script had reached the end. If the current script is the top level script Meson configures the project as defined up to this point. example: | ```meson project('example exit', 'cpp') executable('exe1', 'exe1.cpp') subdir_done() executable('exe2', 'exe2.cpp') ``` The executable `exe1` will be build, while the executable `exe2` is not build. meson-docs/docs/yaml/functions/install_data.yaml0000644000175000017500000000467314656633773021772 0ustar lattislattisname: install_data returns: void description: | Installs files from the source tree that are listed as positional arguments. See [Installing](Installing.md) for more examples. varargs: name: file type: file | str description: Files to install. warnings: - the `install_mode` kwarg ignored integer values between 0.59.0 -- 1.1.0. - an omitted `install_dir` kwarg did not work correctly inside of a subproject until 1.3.0. - an omitted `install_dir` kwarg did not work correctly when combined with the `preserve_path` kwarg untill 1.3.0. kwargs: install_dir: type: str description: | The absolute or relative path to the installation directory. If this is a relative path, it is assumed to be relative to the prefix. If omitted, the directory defaults to `{datadir}/{projectname}` *(since 0.45.0)*. install_mode: type: list[str | int | bool] since: 0.38.0 description: | specify the file mode in symbolic format and optionally the owner/uid and group/gid for the installed files. For example: `install_mode: 'rw-r--r--'` for just the file mode `install_mode: ['rw-r--r--', 'nobody', 'nogroup']` for the file mode and the user/group `install_mode: ['rw-r-----', 0, 0]` for the file mode and uid/gid To leave any of these three as the default, specify `false`. install_tag: type: str since: 0.60.0 description: | A string used by the `meson install --tags` command to install only a subset of the files. By default these files have no install tag which means they are not being installed when `--tags` argument is specified. preserve_path: type: bool since: 0.64.0 default: false description: | Disable stripping child-directories from data files when installing. This is equivalent to GNU Automake's `nobase` option. rename: type: list[str] since: 0.46.0 description: | If specified renames each source file into corresponding file from `rename` list. Nested paths are allowed and they are joined with `install_dir`. Length of `rename` list must be equal to the number of sources. sources: type: list[file | str] description: Additional files to install. follow_symlinks: type: bool since: 1.3.0 default: true description: | If true, dereferences links and copies their target instead. The default value will become false in the future. meson-docs/docs/yaml/functions/_build_target_base.yaml0000644000175000017500000002755214656633773023132 0ustar lattislattisname: _build_target_base returns: void description: PRIVATE posargs: target_name: description: The *unique* name of the build target type: str varargs: name: source type: str | file | custom_tgt | custom_idx | generated_list description: | Input source to compile. The following types are supported: - Strings relative to the current source directory - [[@file]] objects defined in any preceding build file - The return value of configure-time generators such as [[configure_file]] - The return value of build-time generators such as [[custom_target]] or [[generator.process]] These input files can be sources, objects, libraries, or any other file. Meson will automatically categorize them based on the extension and use them accordingly. For instance, sources (`.c`, `.cpp`, `.vala`, `.rs`, etc) will be compiled and objects (`.o`, `.obj`) and libraries (`.so`, `.dll`, etc) will be linked. With the Ninja backend, Meson will create a build-time [order-only dependency](https://ninja-build.org/manual.html#ref_dependencies) on all generated input files, including unknown files. This is needed to bootstrap the generation of the real dependencies in the [depfile](https://ninja-build.org/manual.html#ref_headers) generated by your compiler to determine when to rebuild sources. Ninja relies on this dependency file for all input files, generated and non-generated. The behavior is similar for other backends. warnings: - The `link_language` kwarg was broken until 0.55.0 kwargs: _pch: type: str description: precompiled header file to use for the given language _args: type: list[str] description: | compiler flags to use for the given language; eg: `cpp_args` for C++ vala_args: type: list[str | file] description: | Compiler flags for Vala. Unlike other languages this may contain Files sources: type: str | file | custom_tgt | custom_idx | generated_list | structured_src description: Additional source files. Same as the source varargs. build_by_default: type: bool default: true since: 0.38.0 description: | Causes, when set to `true`, to have this target be built by default. This means it will be built when `meson compile` is called without any arguments. The default value is `true` for all built target types. build_rpath: type: str since: 0.42.0 description: | A string to add to target's rpath definition in the build dir, but which will be removed on install dependencies: type: list[dep] description: | one or more dependency objects created with [[dependency]] or [[compiler.find_library]] (for external deps) or [[declare_dependency]] (for deps built by the project) extra_files: type: str | file | custom_tgt | custom_idx description: | Not used for the build itself but are shown as source files in IDEs that group files by targets (such as Visual Studio) gui_app: type: bool deprecated: 0.56.0 default: false description: | When set to true flags this target as a GUI application on platforms where this makes a difference, **deprecated** since 0.56.0, use `win_subsystem` instead. link_args: type: list[str] description: | Flags to use during linking. You can use UNIX-style flags here for all platforms. link_depends: type: str | file | custom_tgt | custom_idx description: | Strings, files, or custom targets the link step depends on such as a symbol visibility map. The purpose is to automatically trigger a re-link (but not a re-compile) of the target when this file changes. link_language: type: str since: 0.51.0 description: | Makes the linker for this target be for the specified language. It is generally unnecessary to set this, as Meson will detect the right linker to use in most cases. There are only two cases where this is needed. One, your main function in an executable is not in the language Meson picked, or second you want to force a library to use only one ABI. *(broken until 0.55.0)* link_whole: type: list[lib | custom_tgt | custom_idx] since: 0.40.0 description: | Links all contents of the given static libraries whether they are used or not, equivalent to the `-Wl,--whole-archive` argument flag of GCC, or the '/WHOLEARCHIVE' MSVC linker option. This allows the linked target to re-export symbols from all objects in the static libraries. *(since 0.41.0)* If passed a list that list will be flattened. *(since 0.51.0)* This argument also accepts outputs produced by custom targets. The user must ensure that the output is a library in the correct format. link_with: type: list[lib | custom_tgt | custom_idx] description: | One or more shared or static libraries (built by this project) that this target should be linked with. *(since 0.41.0)* If passed a list this list will be flattened. *(since 0.51.0)* The arguments can also be custom targets. In this case Meson will assume that merely adding the output file in the linker command line is sufficient to make linking work. If this is not sufficient, then the build system writer must write all other steps manually. implicit_include_directories: type: bool since: 0.42.0 default: true description: Controls whether Meson adds the current source and build directories to the include path include_directories: type: list[inc | str] description: | one or more objects created with the [[include_directories]] function, or *(since 0.50.0)* strings, which will be transparently expanded to include directory objects install: type: bool default: false description: When set to true, this executable should be installed. install_dir: type: str description: | override install directory for this file. If the value is a relative path, it will be considered relative the `prefix` option. For example, if you want to install plugins into a subdir, you'd use something like this: `install_dir : get_option('libdir') / 'projectname-1.0'`. install_mode: type: list[str | int] since: 0.47.0 description: | Specify the file mode in symbolic format and optionally the owner/uid and group/gid for the installed files. See the `install_mode` kwarg of [[install_data]] for more information. install_tag: type: str since: 0.60.0 description: | A string used by the `meson install --tags` command to install only a subset of the files. By default all build targets have the tag `runtime` except for static libraries that have the `devel` tag. install_rpath: type: str description: | A string to set the target's rpath to after install (but *not* before that). On Windows, this argument has no effect. objects: type: list[extracted_obj | file | str] description: | List of object files that should be linked in this target. **Since 1.1.0** this can include generated files in addition to object files that you don't have source to or that object files produced by other build targets. In earlier release, generated object files had to be placed in `sources`. name_prefix: type: str | list[void] description: | The string that will be used as the prefix for the target output filename by overriding the default (only used for libraries). By default this is `lib` on all platforms and compilers, except for MSVC shared libraries where it is omitted to follow convention, and Cygwin shared libraries where it is `cyg`. Set this to `[]`, or omit the keyword argument for the default behaviour. name_suffix: type: str | list[void] description: | The string that will be used as the extension for the target by overriding the default. By default on Windows this is `exe` for executables and on other platforms it is omitted. For shared libraries, the default value is `dylib` on macOS, `dll` on Windows, and `so` everywhere else. For static libraries, it is `a` everywhere. By convention MSVC static libraries use the `lib` suffix, but we use `a` to avoid a potential name clash with shared libraries which also generate import libraries with a `lib` suffix. Set this to `[]`, or omit the keyword argument for the default behaviour. override_options: type: list[str] | dict[str | bool | int | list[str]] since: 0.40.0 description: | takes an array of strings in the same format as `project`'s `default_options` overriding the values of these options for this target only. *(since 1.2.0)*: A dictionary may now be passed. gnu_symbol_visibility: type: str since: 0.48.0 description: | Specifies how symbols should be exported, see e.g [the GCC Wiki](https://gcc.gnu.org/wiki/Visibility) for more information. This value can either be an empty string or one of `default`, `internal`, `hidden`, `protected` or `inlineshidden`, which is the same as `hidden` but also includes things like C++ implicit constructors as specified in the GCC manual. Ignored on compilers that do not support GNU visibility arguments. d_import_dirs: type: list[str] description: List of directories to look in for string imports used in the D programming language. d_unittest: type: bool default: false description: When set to true, the D modules are compiled in debug mode. d_module_versions: type: list[str | int] description: List of module version identifiers set when compiling D sources. d_debug: type: list[str] description: | The [D version identifiers](https://dlang.org/spec/version.html#version) to add during the compilation of D source files. native: type: bool default: false description: Controls whether the target is compiled for the build or host machines. win_subsystem: type: str default: "'console'" since: 0.56.0 description: | Specifies the subsystem type to use on the Windows platform. Typical values include `console` for text mode programs and `windows` for gui apps. The value can also contain version specification such as `windows,6.0`. See [MSDN documentation](https://docs.microsoft.com/en-us/cpp/build/reference/subsystem-specify-subsystem) for the full list. rust_crate_type: type: str since: 0.42.0 deprecated: 1.3.0 description: | Set the specific type of rust crate to compile (when compiling rust). If the target is an [[executable]] this defaults to "bin", the only allowed value. If it is a [[static_library]] it defaults to "lib", and may be "lib", "staticlib", or "rlib". If "lib" then Rustc will pick a default, "staticlib" means a C ABI library, "rlib" means a Rust ABI. If it is a [[shared_library]] it defaults to "lib", and may be "lib", "dylib", "cdylib", or "proc-macro". If "lib" then Rustc will pick a default, "cdylib" means a C ABI library, "dylib" means a Rust ABI, and "proc-macro" is a special rust procedural macro crate. "proc-macro" is new in 0.62.0. *Since 1.3.0* this is deprecated and replaced by "rust_abi" keyword argument. `proc_macro` crates are now handled by the [`rust.proc_macro()`](Rust-module.md#proc_macro) method. rust_dependency_map: type: dict[str] since: 1.2.0 description: | On rust targets this provides a map of library names to the crate name with which it would be available inside the rust code. This allows renaming similar to the dependency renaming feature of cargo or `extern crate foo as bar` inside rust code. meson-docs/docs/yaml/functions/dependency.yaml0000644000175000017500000002232514656633773021443 0ustar lattislattisname: dependency returns: dep description: | Finds an external dependency (usually a library installed on your system) with the given name with `pkg-config` and [with CMake](Dependencies.md#cmake) if `pkg-config` fails. Additionally, frameworks (OSX only) and [library-specific fallback detection logic](Dependencies.md#dependencies-with-custom-lookup-functionality) are also supported. *Since 0.60.0* more than one name can be provided, they will be tried in order and the first name to be found will be used. The fallback subproject will be used only if none of the names are found on the system. Once one of the name has been found, all other names are added into the cache so subsequent calls for any of those name will return the same value. This is useful in case a dependency could have different names, such as `png` and `libpng`. * Since *0.64.0* a dependency fallback can be provided by WrapDB. Simply download the database locally using `meson wrap update-db` command and Meson will automatically fallback to subprojects provided by WrapDB if the dependency is not found on the system and the project does not ship their own `.wrap` file. Dependencies can also be resolved in two other ways: * if the same name was used in a `meson.override_dependency` prior to the call to `dependency`, the overriding dependency will be returned unconditionally; that is, the overriding dependency will be used independent of whether an external dependency is installed in the system. Typically, `meson.override_dependency` will have been used by a subproject. * by a fallback subproject which, if needed, will be brought into the current build specification as if [`subproject()`](#subproject) had been called. The subproject can be specified with the `fallback` argument. Alternatively, if the `fallback` argument is absent, *since 0.55.0* Meson can automatically identify a subproject as a fallback if a wrap file [provides](Wrap-dependency-system-manual.md#provide-section) the dependency, or if a subproject has the same name as the dependency. In the latter case, the subproject must use `meson.override_dependency` to specify the replacement, or Meson will report a hard error. See the [Wrap documentation](Wrap-dependency-system-manual.md#provide-section) for more details. This automatic search can be controlled using the `allow_fallback` keyword argument. If `dependency_name` is `''`, the dependency is always not found. So with `required: false`, this always returns a dependency object for which the `found()` method returns `false`, and which can be passed like any other dependency to the `dependencies:` keyword argument of a `build_target`. This can be used to implement a dependency which is sometimes not required e.g. in some branches of a conditional, or with a `fallback:` kwarg, can be used to declare an optional dependency that only looks in the specified subproject, and only if that's allowed by `--wrap-mode`. The returned object [[@dep]] also has additional methods. notes: - This function supports additional [library-specific](Dependencies.md#dependencies-with-custom-lookup-functionality) keyword arguments that may also be accepted (e.g. `modules` specifies submodules to use for dependencies such as Qt5 or Boost. `components` allows the user to manually add CMake `COMPONENTS` for the `find_package` lookup) varargs: name: names type: str since: 0.60.0 min_varargs: 1 description: | The names of the dependency to look up. The dependencies are looked up in the order they are provided here. The first found dependency will then be used. The fallback subproject will be used only if none of the names are found on the system. Once one of the name has been found, all other names are added into the cache so subsequent calls for any of those name will return the same value. This is useful in case a dependency could have different names, such as `png` and `libpng`. **NOTE:** Before *0.60.0* only a single dependency name was allowed. kwargs: default_options: type: list[str] | dict[str | bool | int | list[str]] since: 0.38.0 description: | An array of default option values that override those set in the subproject's `meson.options` (like `default_options` in [[project]], they only have effect when Meson is run for the first time, and command line arguments override any default options in build files) *(since 1.2.0)*: A dictionary may now be passed. allow_fallback: type: bool since: 0.56.0 description: | Specifies whether Meson should automatically pick a fallback subproject in case the dependency is not found in the system. If `true` and the dependency is not found on the system, Meson will fallback to a subproject that provides this dependency. If `false`, Meson will not fallback even if a subproject provides this dependency. By default, Meson will do so if `required` is `true` or [`enabled`](Build-options.md#features); see the [Wrap documentation](Wrap-dependency-system-manual.md#provide-section) for more details. fallback: type: list[str] | str description: | Manually specifies a subproject fallback to use in case the dependency is not found in the system. This is useful if the automatic search is not applicable or if you want to support versions of Meson older than 0.55.0. If the value is an array `['subproj_name', 'subproj_dep']`, the first value is the name of the subproject and the second is the variable name in that subproject that contains a dependency object such as the return value of [[declare_dependency]] or [[dependency]], etc. Note that this means the fallback dependency may be a not-found dependency, in which case the value of the `required:` kwarg will be obeyed. *Since 0.54.0* the value can be a single string, the subproject name; in this case the subproject must use `meson.override_dependency('dependency_name', subproj_dep)` to specify the dependency object used in the superproject. If the value is an empty list, it has the same effect as `allow_fallback: false`. language: type: str since: 0.42.0 description: | Defines what language-specific dependency to find if it's available for multiple languages. method: type: str since: 0.40.0 default: "'auto'" description: | Defines the way the dependency is detected, the default is `auto` but can be overridden to be e.g. `qmake` for Qt development, and [different dependencies support different values]( Dependencies.md#dependencies-with-custom-lookup-functionality) for this (though `auto` will work on all of them) native: type: bool default: false description: | If set to `true`, causes Meson to find the dependency on the build machine system rather than the host system (i.e. where the cross compiled binary will run on), usually only needed if you build a tool to be used during compilation. not_found_message: type: str since: 0.50.0 description: An optional string that will be printed as a [[message]] if the dependency was not found. required: type: bool | feature default: true description: | When set to `false`, Meson will proceed with the build even if the dependency is not found. When set to a [`feature`](Build-options.md#features) option, the feature will control if it is searched and whether to fail if not found. *(since 0.47.0)* The value of a `feature` option can also be passed. static: type: bool default: false description: | Tells the dependency provider to try to get static libraries instead of dynamic ones (note that this is not supported by all dependency backends) *Since 0.60.0* it also sets `default_library` option accordingly on the fallback subproject if it was not set explicitly in `default_options` keyword argument. version: type: list[str] | str since: 0.37.0 description: | Specifies the required version, a string containing a comparison operator followed by the version string, examples include `>1.0.0`, `<=2.3.5` or `3.1.4` for exact matching. You can also specify multiple restrictions by passing a list to this keyword argument, such as: `['>=3.14.0', '<=4.1.0']`. These requirements are never met if the version is unknown. include_type: type: str default: "'preserve'" since: 0.52.0 description: | An enum flag, marking how the dependency flags should be converted. Supported values are `'preserve'`, `'system'` and `'non-system'`. System dependencies may be handled differently on some platforms, for instance, using `-isystem` instead of `-I`, where possible. If `include_type` is set to `'preserve'`, no additional conversion will be performed. disabler: type: bool default: false since: 0.49.0 description: | Returns a [[disabler]] object instead of a not-found dependency if this kwarg is set to `true` and the dependency couldn't be found. meson-docs/docs/yaml/functions/subdir.yaml0000644000175000017500000000144114656633773020611 0ustar lattislattisname: subdir returns: void description: | Enters the specified subdirectory and executes the `meson.build` file in it. Once that is done, it returns and execution continues on the line following this `subdir()` command. Variables defined in that `meson.build` file are then available for use in later parts of the current build file and in all subsequent build files executed with `subdir()`. Note that this means that each `meson.build` file in a source tree can and must only be executed once. posargs: dir_name: type: str description: | Directory relative to the current `meson.build` to enter. Cannot contain `..` kwargs: if_found: type: list[dep] since: 0.44.0 description: Only enter the subdir if all [[dep.found]] methods return `true`. meson-docs/docs/yaml/functions/library.yaml0000644000175000017500000000423114656633773020765 0ustar lattislattisname: library returns: lib description: | Builds a library that is either static, shared or both depending on the value of `default_library` user [option](https://mesonbuild.com/Builtin-options.html). You should use this instead of [[shared_library]], [[static_library]] or [[both_libraries]] most of the time. This allows you to toggle your entire project (including subprojects) from shared to static with only one option. This option applies to libraries being built internal to the entire project. For external dependencies, the default library type preferred is shared. This can be adapted on a per library basis using the [[dependency]] `static` keyword. The keyword arguments for this are the same as for [[build_target]] warnings: - using _shared_args and/or _static_args may lead to much higher compilation times with both_library, as object files cannot be shared between the static and shared targets. It is guaranteed to not duplicate the build if these arguments are empty arrays posargs_inherit: _build_target_base varargs_inherit: _build_target_base kwargs_inherit: - shared_library - static_library kwargs: rust_abi: type: str since: 1.3.0 description: | Set the specific ABI to compile (when compiling rust). - 'rust' (default): Create a "rlib" or "dylib" crate depending on the library type being build. - 'c': Create a "cdylib" or "staticlib" crate depending on the library type being build. _static_args: type: list[str] since: 1.3.0 description: Arguments that are only passed to a static library vala_static_args: type: list[str | file] since: 1.3.0 description: Arguments that are only passed to a static library Like `vala_args`, [[files]] is allowed in addition to string _shared_args: type: list[str] since: 1.3.0 description: Arguments that are only passed to a shared library vala_shared_args: type: list[str | file] since: 1.3.0 description: Arguments that are only passed to a shared library Like `vala_args`, [[files]] is allowed in addition to string meson-docs/docs/yaml/functions/assert.yaml0000644000175000017500000000060214656633773020620 0ustar lattislattisname: assert returns: void description: Abort with an error message if `condition` evaluates to `false`. notes: - The `message` argument is optional since 0.53.0 and defaults to print the condition statement. posargs: condition: type: bool description: Abort if this evaluates to `false` optargs: message: type: str description: The error message to print. meson-docs/docs/yaml/functions/add_global_link_arguments.yaml0000644000175000017500000000107714656633773024500 0ustar lattislattisname: add_global_link_arguments returns: void description: | Adds global arguments to the linker command line. Like [[add_global_arguments]] but the arguments are passed to the linker. notes: - Usually you should use [[add_project_link_arguments]] instead, because that works even when you project is used as a subproject. - You must pass always arguments individually `arg1, arg2, ...` rather than as a string `'arg1 arg2', ...` varargs: type: str name: Linker argument description: The linker arguments to add kwargs_inherit: add_global_arguments meson-docs/docs/yaml/functions/run_target.yaml0000644000175000017500000000477314656633773021506 0ustar lattislattisname: run_target returns: run_tgt description: | This function creates a new top-level target that runs a specified command with the specified arguments. Like all top-level targets, this integrates with the selected backend. For instance, you can run it as `meson compile target_name`. Note that a run target produces no output as far as Meson is concerned. It is only meant for tasks such as running a code formatter or flashing an external device's firmware with a built file. The command is run from an *unspecified* directory, and Meson will set three environment variables `MESON_SOURCE_ROOT`, `MESON_BUILD_ROOT` and `MESON_SUBDIR` that specify the source directory, build directory and subdirectory the target was defined in, respectively. *Since 0.57.0* The template strings passed to `command` keyword arguments accept the following special substitutions: - `@SOURCE_ROOT@`: the path to the root of the source tree. Depending on the backend, this may be an absolute or a relative to current workdir path. - `@BUILD_ROOT@`: the path to the root of the build tree. Depending on the backend, this may be an absolute or a relative to current workdir path. - `@CURRENT_SOURCE_DIR@` *Since 0.57.1*: this is the directory where the currently processed meson.build is located in. Depending on the backend, this may be an absolute or a relative to current workdir path. posargs: target_name: type: str description: The name of the run target kwargs: command: type: list[exe| external_program | custom_tgt | file | str] description: | A list containing the command to run and the arguments to pass to it. Each list item may be a string or a target. For instance, passing the return value of [[executable]] as the first item will run that executable, or passing a string as the first item will find that command in `PATH` and run it. depends: type: list[build_tgt | custom_tgt | custom_idx] description: | A list of targets that this target depends on but which are not listed in the command array (because, for example, the script does file globbing internally, custom_idx was not possible as a type between 0.60 and 1.4.0). env: since: 0.57.0 type: env | list[str] | dict[str] description: | environment variables to set, such as `{'NAME1': 'value1', 'NAME2': 'value2'}` or `['NAME1=value1', 'NAME2=value2']`, or an [[@env]] object which allows more sophisticated environment juggling. meson-docs/docs/yaml/functions/get_variable.yaml0000644000175000017500000000123614656633773021747 0ustar lattislattisname: get_variable returns: any description: | This function can be used to dynamically obtain a variable. `res = get_variable(varname, fallback)` takes the value of `varname` (which must be a string) and stores the variable of that name into `res`. If the variable does not exist, the variable `fallback` is stored to `res`instead. If a fallback is not specified, then attempting to read a non-existing variable will cause a fatal error. arg_flattening: false posargs: variable_name: type: str description: Name of the variable to get optargs: default: type: any description: Fallback value to return when the variable does not exist meson-docs/docs/yaml/functions/get_option.yaml0000644000175000017500000000204314656633773021467 0ustar lattislattisname: get_option returns: str | int | bool | feature | list[str | int | bool] description: | Obtains the value of the [project build option](Build-options.md) specified in the positional argument. Note that the value returned for built-in options that end in `dir` such as `bindir` and `libdir` is usually a path relative to (and inside) the `prefix` but you should not rely on that, as it can also be an absolute path [in some cases](Builtin-options.md#universal-options). [`install_dir` arguments](Installing.md) handle that as expected but if you need an absolute path, e.g. to use in a define etc., you should use the path concatenation operator like this: `get_option('prefix') / get_option('localstatedir')`. Never manually join paths as if they were strings. For options of type `feature` a [[@feature]] option object is returned instead of a string. See [`feature` options](Build-options.md#features) documentation for more details. posargs: option_name: type: str description: Name of the option to query meson-docs/docs/yaml/functions/both_libraries.yaml0000644000175000017500000000101614656633773022307 0ustar lattislattisname: both_libraries returns: both_libs since: 0.46.0 description: | Builds both a static and shared library with the given sources. Positional and keyword arguments are otherwise the same as for [[library]]. Source files will be compiled only once and object files will be reused to build both shared and static libraries, unless `b_staticpic` user option or `pic` argument are set to false in which case sources will be compiled twice. posargs_inherit: library varargs_inherit: library kwargs_inherit: library meson-docs/docs/yaml/functions/structured_sources.yaml0000644000175000017500000000144514656633773023274 0ustar lattislattisname: structured_sources returns: structured_src since: 0.62.0 description: | Create a StructuredSource object, which is opaque and may be passed as a source to any build_target (including static_library, shared_library, executable, etc.). This is useful for languages like Rust, which use the filesystem layout to determine import names. This is only allowed in Rust targets, and cannot be mixed with non structured inputs. posargs: root: type: list[str | file | custom_tgt | custom_idx | generated_list] description: Sources to put at the root of the generated structure optargs: additional: type: dict[str | file | custom_tgt | custom_idx | generated_list] description: | Additional sources, where the key is the directory under the root to place the values meson-docs/docs/yaml/functions/install_subdir.yaml0000644000175000017500000000571214656633773022344 0ustar lattislattisname: install_subdir returns: void description: | Installs the entire given subdirectory and its contents from the source tree to the location specified by the keyword argument `install_dir`. *(since 0.45.0, deprecated since 0.60.0)* If the subdirectory does not exist in the source tree, an empty directory is created in the specified location. A newly created subdirectory may only be created in the keyword argument `install_dir`. There are a number of flaws with this method, and it was never intentionally designed to work this way, please use [[install_emptydir]] instead. example: | For a given directory `foo`: ```text foo/ bar/ file1 file2 ``` `install_subdir('foo', install_dir : 'share', strip_directory : false)` creates ```text share/ foo/ bar/ file1 file2 ``` `install_subdir('foo', install_dir : 'share', strip_directory : true)` creates ```text share/ bar/ file1 file2 ``` `install_subdir('foo/bar', install_dir : 'share', strip_directory : false)` creates ```text share/ bar/ file1 ``` `install_subdir('foo/bar', install_dir : 'share', strip_directory : true)` creates ```text share/ file1 ``` `install_subdir('new_directory', install_dir : 'share')` creates ```text share/ new_directory/ ``` warnings: - the `install_mode` kwarg ignored integer values between 0.59.0 -- 1.1.0. posargs: subdir_name: type: str description: The sub-directory to install kwargs: install_mode: type: list[str | int | bool] since: 0.47.0 description: | Specify the file mode in symbolic format and optionally the owner/uid and group/gid for the installed files. See the `install_mode` kwarg of [[install_data]] for more information. install_tag: type: str since: 0.60.0 description: | A string used by the `meson install --tags` command to install only a subset of the files. By default these files have no install tag which means they are not being installed when `--tags` argument is specified. exclude_files: type: list[str] description: | A list of file names that should not be installed. Names are interpreted as paths relative to the `subdir_name` location. exclude_directories: type: list[str] since: 0.47.0 description: | A list of directory names that should not be installed. Names are interpreted as paths relative to the `subdir_name` location. install_dir: type: str description: Where to install to. strip_directory: type: bool since: 0.45.0 default: false description: | Install directory contents. If `strip_directory=true` only the last component of the source path is used. follow_symlinks: type: bool since: 1.3.0 default: true description: | If true, dereferences links and copies their target instead. The default value will become false in the future. meson-docs/docs/yaml/functions/install_emptydir.yaml0000644000175000017500000000167314656633773022713 0ustar lattislattisname: install_emptydir returns: void since: 0.60.0 description: | Installs a new directory entry to the location specified by the positional argument. If the directory exists and is not empty, the contents are left in place. warnings: - the `install_mode` kwarg ignored integer values before 1.1.0. varargs: name: dirpath type: str description: Directory to create during installation. kwargs: install_mode: type: list[str | int | bool] description: | Specify the file mode in symbolic format and optionally the owner/uid and group/gid for the created directory. See the `install_mode` kwarg of [[install_data]] for more information. install_tag: type: str description: | A string used by the `meson install --tags` command to install only a subset of the files. By default this directory has no install tag which means it is not installed when the `--tags` argument is specified. meson-docs/docs/yaml/functions/test.yaml0000644000175000017500000000521614656633773020304 0ustar lattislattisname: test returns: void description: | Defines a test to run with the test harness. Takes two positional arguments, the first is the name of the test and the second is the executable to run. The executable can be an [[@exe]] object returned by [[executable]] or an [[@external_program]] object] returned by [[find_program]]. *(since 0.55.0)* When cross compiling, if an exe_wrapper is needed and defined the environment variable `MESON_EXE_WRAPPER` will be set to the string value of that wrapper (implementation detail: using `mesonlib.join_args`). Test scripts may use this to run cross built binaries. If your test needs `MESON_EXE_WRAPPER` in cross build situations it is your responsibility to return code 77 to tell the harness to report "skip". By default, environment variable [`MALLOC_PERTURB_`](http://man7.org/linux/man-pages/man3/mallopt.3.html) is automatically set by `meson test` to a random value between 1..255. This can help find memory leaks on configurations using glibc, including with non-GCC compilers. However, this can have a performance impact, and may fail a test due to external libraries whose internals are out of the user's control. To check if this feature is causing an expected runtime crash, disable the feature by temporarily setting environment variable `MALLOC_PERTURB_=0`. While it's preferable to only temporarily disable this check, if a project requires permanent disabling of this check in meson.build do like: ```meson nomalloc = environment({'MALLOC_PERTURB_': '0'}) test(..., env: nomalloc, ...) ``` By default, the environment variables `ASAN_OPTIONS`, `UBSAN_OPTIONS`, and `MSAN_OPTIONS` are set to enable aborting on detected violations and to give a backtrace. To suppress this, `ASAN_OPTIONS`, `UBSAN_OPTIONS`, or `MSAN_OPTIONS` can be set in the environment. In addition to running individual executables as test cases, `test()` can also be used to invoke an external test harness. In this case, it is best to use `verbose: true` *(since 0.62.0)* and, if supported by the external harness, `protocol: 'tap'` *(since 0.50.0)*. This will ensure that Meson logs each subtest as it runs, instead of including the whole log at the end of the run. Defined tests can be run in a backend-agnostic way by calling `meson test` inside the build dir, or by using backend-specific commands, such as `ninja test` or `msbuild RUN_TESTS.vcxproj`. posargs_inherit: benchmark kwargs_inherit: benchmark kwargs: is_parallel: type: bool default: true description: | when false, specifies that no other test must be running at the same time as this test meson-docs/docs/yaml/functions/generator.yaml0000644000175000017500000000631514656633773021314 0ustar lattislattisname: generator returns: generator description: | See also: [[custom_target]] This function creates a [[@generator]] object that can be used to run custom compilation commands. The only positional argument is the executable to use. It can either be a self-built executable or one returned by find_program. The template strings passed to all the keyword arguments accept the following special substitutions: - `@PLAINNAME@`: the complete input file name, e.g: `foo.c` becomes `foo.c` (unchanged) - `@BASENAME@`: the base of the input filename, e.g.: `foo.c.y` becomes `foo.c` (extension is removed) Each string passed to the `output` keyword argument *must* be constructed using one or both of these two substitutions. In addition to the above substitutions, the `arguments` keyword argument also accepts the following: - `@OUTPUT@`: the full path to the output file - `@INPUT@`: the full path to the input file - `@DEPFILE@`: the full path to the depfile - `@SOURCE_DIR@`: the full path to the root of the source tree - `@CURRENT_SOURCE_DIR@`: this is the directory where the currently processed meson.build is located in - `@BUILD_DIR@`: the full path to the root of the build dir where the output will be placed NOTE: Generators should only be used for outputs that will ***only*** be used as inputs for a [[build_target]] or a [[custom_target]]. When you use the processed output of a generator in multiple targets, the generator will be run multiple times to create outputs for each target. Each output will be created in a target-private directory `@BUILD_DIR@`. If you want to generate files for general purposes such as for generating headers to be used by several sources, or data that will be installed, and so on, use a [[custom_target]] instead. posargs: exe: type: exe | external_program description: Executable for the command to run kwargs: arguments: type: list[str] description: A list of template strings that will be the command line arguments passed to the executable. depends: # Not sure why this is not just `target` type: list[build_tgt | custom_tgt | custom_idx] since: 0.51.0 description: | An array of build targets that must be built before this generator can be run. This is used if you have a generator that calls a second executable that is built in this project (custom_idx was not available between 0.60 and 1.4.0). depfile: type: str description: | A template string pointing to a dependency file that a generator can write listing all the additional files this target depends on, for example a C compiler would list all the header files it included, and a change in any one of these files triggers a recompilation, output: type: list[str] description: | Template string (or list of template strings) defining how an output file name is (or multiple output names are) generated from a single source file name. capture: type: bool default: false since: 0.43.0 description: | When this argument is set to true, Meson captures `stdout` of the `executable` and writes it to the target file specified as `output`. meson-docs/docs/yaml/functions/vcs_tag.yaml0000644000175000017500000000401614656633773020750 0ustar lattislattisname: vcs_tag returns: custom_tgt description: | This command detects revision control commit information at build time and places it in the specified output file. This file is guaranteed to be up to date on every build. Keywords are similar to [[custom_target]]. Meson will read the contents of `input`, substitute the `replace_string` with the detected revision number, and write the result to `output`. This method returns a [[@custom_tgt]] object that (as usual) should be used to signal dependencies if other targets use the file outputted by this. For example, if you generate a header with this and want to use that in a build target, you must add the return value to the sources of that build target. Without that, Meson will not know the order in which to build the targets. If you desire more specific behavior than what this command provides, you should use [[custom_target]]. kwargs: command: type: list[exe | external_program | custom_tgt | file | str] description: | The command to execute, see [[custom_target]] for details on how this command must be specified. This parameter is optional. If it is absent, Meson will try its best to find a suitable default command. *(since 0.62.0)* [[@file]] is accepted. *(since 0.63.0)* [[@custom_tgt]], [[@exe]], and [[@external_program]] are accepted. input: type: list[build_tgt | custom_idx | custom_tgt | external_program | extracted_obj | file | generated_list | str] required: true description: File to modify (e.g. `version.c.in`). output: type: str required: true description: File to write the results to (e.g. `version.c`). fallback: type: str default: "[[meson.project_version]]" description: | Version number to use when no revision control information is present, such as when building from a release tarball. replace_string: type: str default: "'@VCS_TAG@'" description: String in the input file to substitute with the commit information. meson-docs/docs/yaml/functions/configuration_data.yaml0000644000175000017500000000100614656633773023156 0ustar lattislattisname: configuration_data returns: cfg_data description: | Creates an empty configuration object. You should add your configuration with the [[@cfg_data]] method calls and finally use it in a call to [[configure_file]]. optargs: data: type: dict[str | bool | int] since: 0.49.0 description: | Optional dictionary to specify an initial data set. If provided, each key/value pair is added into the [[@cfg_data]] object as if the [[cfg_data.set]] method was called for each of them. meson-docs/docs/yaml/functions/configure_file.yaml0000644000175000017500000001273214656633773022306 0ustar lattislattisname: configure_file returns: file description: | This function can run in three modes depending on the keyword arguments passed to it. When a [[@cfg_data]] object is passed to the `configuration:` keyword argument, it takes a template file as the `input:` (optional) and produces the `output:` (required) by substituting values from the configuration data as detailed in [the configuration file documentation](Configuration.md). *(since 0.49.0)* A dictionary can be passed instead of a [[@cfg_data]] object. When a list of strings is passed to the `command:` keyword argument, it takes any source or configured file as the `input:` and assumes that the `output:` is produced when the specified command is run. *(since 0.47.0)* When the `copy:` keyword argument is set to `true`, this function will copy the file provided in `input:` to a file in the build directory with the name `output:` in the current directory. warnings: - the `install_mode` kwarg ignored integer values between 0.62 -- 1.1.0. kwargs: capture: type: bool since: 0.41.0 default: false description: | When this argument is set to true, Meson captures `stdout` of the `command` and writes it to the target file specified as `output`. command: type: list[str | file | compiler | external_program | exe] description: | As explained above, if specified, Meson does not create the file itself but rather runs the specified command, which allows you to do fully custom file generation. *(since 0.52.0)* The command can contain file objects and more than one file can be passed to the `input` keyword argument, see [[custom_target]] for details about string substitutions. configuration: type: "cfg_data | dict[str | int | bool]" description: | As explained above, when passed this will provide the replacement data for the input file (if provided) or key value pairs to be written to the output. copy: type: bool default: false since: 0.47.0 description: | As explained above, if specified Meson only copies the file from input to output. depfile: type: str since: 0.52.0 description: | A dependency file that the command can write listing all the additional files this target depends on. A change in any one of these files triggers a reconfiguration. format: type: str since: 0.46.0 default: "'meson'" description: | The format of defines. It defaults to `'meson'`, and so substitutes `#mesondefine` statements and variables surrounded by `@` characters, you can also use `'cmake'` to replace `#cmakedefine` statements and variables with the `${variable}` syntax. Finally you can use `'cmake@'` in which case substitutions will apply on `#cmakedefine` statements and variables with the `@variable@` syntax. input: type: str | file description: | The input file name. If it's not specified in configuration mode, all the variables in the `configuration:` object (see above) are written to the `output:` file. install: type: bool default: false since: 0.50.0 description: | When true, this generated file is installed during the install step, and `install_dir` must be set and not empty. When false, this generated file is not installed regardless of the value of `install_dir`. When omitted it defaults to true when `install_dir` is set and not empty, false otherwise. install_dir: type: str | bool description: | The subdirectory to install the generated file to (e.g. `share/myproject`), if omitted or given the value of empty string, the file is not installed. install_mode: type: list[str | int | bool] since: 0.47.0 description: | Specify the file mode in symbolic format and optionally the owner/uid and group/gid for the installed files. See the `install_mode` kwarg of [[install_data]] for more information. install_tag: type: str since: 0.60.0 description: | A string used by the `meson install --tags` command to install only a subset of the files. By default the file has no install tag which means it is not being installed when `--tags` argument is specified. output: type: str description: | The output file name. *(since 0.41.0)* may contain `@PLAINNAME@` or `@BASENAME@` substitutions, as well as *(since 1.5.0)* their indexed versions, like `@PLAINNAME0@` or `@BASENAME0@`. In configuration mode, the permissions of the input file (if it is specified) are copied to the output file. output_format: type: str since: 0.47.0 description: | The format of the output to generate when no input was specified. It defaults to `c`, in which case preprocessor directives will be prefixed with `#`, you can also use `nasm`, in which case the prefix will be `%`. *(since 1.3.0)* `json` format can also be used. encoding: type: str default: "'utf-8'" since: 0.47.0 description: | Set the file encoding for the input and output file. The supported encodings are those of python3, see [standard-encodings](https://docs.python.org/3/library/codecs.html#standard-encodings). macro_name: type: str since: 1.3.0 description: | When specified, macro guards will be used instead of '#pragma once'. The macro guard name will be the specified name. meson-docs/docs/yaml/functions/is_variable.yaml0000644000175000017500000000031114656633773021574 0ustar lattislattisname: is_variable returns: bool since: 0.52.0 description: Returns true if a variable of the given name exists and false otherwise. posargs: var: type: str description: The variable to test meson-docs/docs/yaml/functions/environment.yaml0000644000175000017500000000214414656633773021666 0ustar lattislattisname: environment returns: env since: 0.35.0 description: Returns an empty [[@env]] object. arg_flattening: false optargs: env: type: str | list[str] | dict[str] | dict[list[str]] since: 0.52.0 description: | If provided, each key/value pair is added into the [[@env]] object as if [[env.set]] method was called for each of them. Since *0.62.0* list of strings is allowed in dictionary values. In that case values are joined using the separator. kwargs: separator: type: str since: 0.62.0 description: | The separator to use for the initial values defined in the first positional argument. If not explicitly specified, the default path separator for the host operating system will be used, i.e. ';' for Windows and ':' for UNIX/POSIX systems. method: type: str since: 0.62.0 description: | Must be one of 'set', 'prepend', or 'append' (defaults to 'set'). Controls if initial values defined in the first positional argument are prepended, appended or replace the current value of the environment variable. meson-docs/docs/yaml/functions/warning.yaml0000644000175000017500000000030514656633773020764 0ustar lattislattisname: warning returns: void since: 0.44.0 description: This function prints its argument to stdout prefixed with WARNING:. arg_flattening: false posargs_inherit: message varargs_inherit: message meson-docs/docs/yaml/functions/jar.yaml0000644000175000017500000000110614656633773020073 0ustar lattislattisname: jar returns: jar description: | Build a jar from the specified Java source files. Keyword arguments are the same as [[executable]]'s, with the addition of `main_class` which specifies the main class to execute when running the jar with `java -jar file.jar`. posargs_inherit: _build_target_base varargs_inherit: _build_target_base kwargs_inherit: _build_target_base kwargs: main_class: type: str description: Main class for running the built jar java_resources: type: structured_src since: 0.62.0 description: Resources to be added to the jar meson-docs/docs/yaml/functions/error.yaml0000644000175000017500000000046114656633773020453 0ustar lattislattisname: error returns: void description: Print the argument string and halts the build process. arg_flattening: false posargs: message: type: str description: The message to print varargs: name: msg since: 0.58.0 type: str description: Additional parameters will be separated by spaces meson-docs/docs/yaml/functions/build_target.yaml0000644000175000017500000000235414656633773021772 0ustar lattislattisname: build_target returns: build_tgt description: | Creates a build target whose type can be set dynamically with the `target_type` keyword argument. `target_type` may be set to one of: - `executable` (see [[executable]]) - `shared_library` (see [[shared_library]]) - `shared_module` (see [[shared_module]]) - `static_library` (see [[static_library]]) - `both_libraries` (see [[both_libraries]]) - `library` (see [[library]]) - `jar` (see [[jar]])* This declaration: ```meson executable() ``` is equivalent to this: ```meson build_target(, target_type : 'executable') ``` The lists for the kwargs (such as `sources`, `objects`, and `dependencies`) are always flattened, which means you can freely nest and add lists while creating the final list. The returned object also has methods that are documented in [[@build_tgt]]. *"jar" is deprecated because it is fundementally a different thing than the other build_target types. posargs_inherit: _build_target_base varargs_inherit: _build_target_base kwargs_inherit: - executable - library - jar kwargs: target_type: type: str description: The actual target type to build meson-docs/docs/yaml/functions/range.yaml0000644000175000017500000000213414656633773020415 0ustar lattislattisname: range returns: range since: 0.58.0 description: | Return an opaque object that can be only be used in `foreach` statements. 
[[@range]] range([[@int]] stop)
  [[@range]] range([[@int]] start, [[@int]] stop[, [[@int]] step])
- `start` must be integer greater or equal to 0. Defaults to 0. - `stop` must be integer greater or equal to `start`. - `step` must be integer greater or equal to 1. Defaults to 1. It cause the `foreach` loop to be called with the value from `start` included to `stop` excluded with an increment of `step` after each loop. example: | ```meson # Loop 15 times with i from 0 to 14 included. foreach i : range(15) ... endforeach ``` The range object can also be assigned to a variable and indexed. ```meson r = range(5, 10, 2) assert(r[2] == 9) ``` optargs: start: type: int default: 0 description: The start of the range stop: type: int description: The end of the range step: type: int default: 1 description: The loop increment meson-docs/docs/yaml/functions/set_variable.yaml0000644000175000017500000000063414656633773021764 0ustar lattislattisname: set_variable returns: void description: | Assigns a value to the given variable name. Calling `set_variable('foo', bar)` is equivalent to `foo = bar`. *(since 0.46.1)* The `value` parameter can be an array type. arg_flattening: false posargs: variable_name: type: str description: The name of the variable to set value: type: any description: The value to set the variable to meson-docs/docs/yaml/functions/import.yaml0000644000175000017500000000150314656633773020632 0ustar lattislattisname: import returns: module description: | Imports the given extension module. Returns an object that can be used to call the methods of the module. Here's an example for a hypothetical `testmod` module. example: | ```meson tmod = import('testmod') tmod.do_something() ``` posargs: module_name: type: str description: Name of the module to import. kwargs: required: type: bool | feature default: true since: 0.59.0 description: When set to `false`, Meson will proceed with the build even if the module is not found. When set to a [`feature`](Build-options.md#features) option, the feature will control if it is searched and whether to fail if not found. disabler: type: bool since: 0.59.0 description: Returns a [[@disabler]] object when not found. meson-docs/docs/yaml/functions/add_project_link_arguments.yaml0000644000175000017500000000070314656633773024701 0ustar lattislattisname: add_project_link_arguments returns: void description: | Adds project specific arguments to the linker command line. Like [[add_project_arguments]] but the arguments are passed to the linker. notes: - You must pass always arguments individually `arg1, arg2, ...` rather than as a string `'arg1 arg2', ...` varargs: type: str name: Linker argument description: The linker arguments to add kwargs_inherit: add_project_arguments meson-docs/docs/yaml/functions/disabler.yaml0000644000175000017500000000013414656633773021104 0ustar lattislattisname: disabler returns: disabler description: Returns a [[@disabler]] object. since: 0.44.0 meson-docs/docs/yaml/functions/project.yaml0000644000175000017500000001200114656633773020761 0ustar lattislattisname: project returns: void description: | The first function called in each project, to initialize Meson. The first argument to this function must be a string defining the name of this project. The project name can be any string you want, it's not used for anything except descriptive purposes. However since it is written to e.g. the dependency manifest is usually makes sense to have it be the same as the project tarball or pkg-config name. So for example you would probably want to use the name _libfoobar_ instead of _The Foobar Library_. It may be followed by the list of programming languages that the project uses. *(since 0.40.0)* The list of languages is optional. These languages may be used both for `native: false` (the default) (host machine) targets and for `native: true` (build machine) targets. *(since 0.56.0)* The build machine compilers for the specified languages are not required. Supported values for languages are `c`, `cpp` (for `C++`), `cuda`, `cython`, `d`, `objc`, `objcpp`, `fortran`, `java`, `cs` (for `C#`), `vala` and `rust`. posargs: project_name: type: str description: The name of the project. varargs: name: language type: str description: The languages that Meson should initialize. kwargs: default_options: type: list[str] | dict[str | bool | int | list[str]] description: | Accepts strings in the form `key=value` which have the same format as options to `meson configure`. For example to set the default project type you would set this: `default_options : ['buildtype=debugoptimized']`. Note that these settings are only used when running Meson for the first time. Global options such as `buildtype` can only be specified in the master project, settings in subprojects are ignored. Project specific options are used normally even in subprojects. Note that some options can override the default behavior; for example, using `c_args` here means that the `CFLAGS` environment variable is not used. Consider using [[add_project_arguments()]] instead. *(since 1.2.0)*: A dictionary may now be passed. version: type: str | file description: | A free form string describing the version of this project. You can access the value in your Meson build files with [[meson.project_version]]. *(Since 0.57.0)* this can also be a [[@file]] object pointing to a file that contains exactly one line of text. meson_version: type: str description: | Takes a string describing which Meson version the project requires. Usually something like `>=0.28.0`. license: type: str | list[str] description: | Takes a string or array of strings describing the license(s) the code is under. This *should* be an [SPDX license expression](https://spdx.dev/ids/), using the standardized license identifier from the [SPDX license list](https://spdx.org/licenses/). Usually this would be something like `license : 'GPL-2.0-or-later'`. If there are multiple licenses you can use the `AND` and `OR` operators to join them: `license : 'Apache-2.0 OR GPL-2.0'`. For backwards compatibility reasons you can also pass an array of licenses here. This is not recommended, as it is ambiguous: `license : ['Apache-2.0', 'GPL-2.0-only']` instead use an SPDX expression: `license : 'Apache-2.0 OR GPL-2.0-only'`, which makes it clear that the license mean OR, not AND. Note that the text is informal and is only written to the dependency manifest. Meson does not do any license validation, you are responsible for verifying that you abide by all licensing terms. You can access the value in your Meson build files with `meson.project_license()`. license_files: type: str | list[str] since: 1.1.0 description: | Takes a string or array of strings with the paths to the license file(s) the code is under. This enhances the value of the `license` kwarg by allowing to specify both the short license name and the full license text. Usually this would be something like `license_files: ['COPYING']`. Note that the files are informal and are only installed with the dependency manifest. Meson does not do any license validation, you are responsible for verifying that you abide by all licensing terms. You can access the value in your Meson build files with [[meson.project_license_files]]. subproject_dir: type: str default: "'subprojects'" description: | Specifies the top level directory name that holds Meson subprojects. This is only meant as a compatibility option for existing code bases that house their embedded source code in a custom directory. All new projects should not set this but instead use the default value. It should be noted that this keyword argument is ignored inside subprojects. There can be only one subproject dir and it is set in the top level Meson file. meson-docs/docs/yaml/functions/debug.yaml0000644000175000017500000000062114656633773020406 0ustar lattislattisname: debug returns: void since: 0.63.0 description: Write the argument string to the meson build log. posargs: message: type: str | int | bool | list[str | int | bool] | dict[str | int | bool] description: The message to print varargs: name: msg type: str | int | bool | list[str | int | bool] | dict[str | int | bool] description: Additional parameters will be separated by spaces meson-docs/docs/yaml/functions/executable.yaml0000644000175000017500000000407614656633773021451 0ustar lattislattisname: executable returns: exe description: | Creates a new executable. The first argument specifies its name and the remaining positional arguments define the input files to use. The lists for the kwargs (such as `sources`, `objects`, and `dependencies`) are always flattened, which means you can freely nest and add lists while creating the final list. The returned object also has methods that are documented in [[@exe]]. *Since 1.3.0* executable names can be the same across multiple targets as long as they each have a different `name_suffix`. warnings: - The `link_language` kwarg was broken until 0.55.0 posargs_inherit: _build_target_base varargs_inherit: _build_target_base kwargs_inherit: _build_target_base kwargs: export_dynamic: type: bool since: 0.45.0 description: | when set to true causes the target's symbols to be dynamically exported, allowing modules built using the [[shared_module]] function to refer to functions, variables and other symbols defined in the executable itself. Implies the `implib` argument. implib: type: bool | str since: 0.42.0 description: | When set to true, an import library is generated for the executable (the name of the import library is based on *exe_name*). Alternatively, when set to a string, that gives the base name for the import library. The import library is used when the returned build target object appears in `link_with:` elsewhere. Only has any effect on platforms where that is meaningful (e.g. Windows). Implies the `export_dynamic` argument. pie: type: bool since: 0.49.0 description: Build a position-independent executable. vs_module_defs: type: str | file | custom_tgt | custom_idx since: 1.3.0 description: | Specify a Microsoft module definition file for controlling symbol exports, etc., on platforms where that is possible (e.g. Windows). This can be used to expose which functions a shared_module loaded by an executable will be allowed to use. meson-docs/docs/yaml/functions/alias_target.yaml0000644000175000017500000000115514656633773021762 0ustar lattislattisname: alias_target since: 0.52.0 returns: alias_tgt description: | This function creates a new top-level target. Like all top-level targets, this integrates with the selected backend. For instance, with you can run it as `meson compile target_name`. This is a dummy target that does not execute any command, but ensures that all dependencies are built. Dependencies can be any build target. Since 0.60.0, this includes [[@run_tgt]]. posargs: target_name: type: str description: The name of the alias target varargs: name: Dep type: tgt min_varargs: 1 description: The targets to depend on meson-docs/docs/yaml/functions/summary.yaml0000644000175000017500000000614014656633773021017 0ustar lattislattisname: summary returns: void since: 0.53.0 description: | This function is used to summarize build configuration at the end of the build process. This function provides a way for projects (and subprojects) to report this information in a clear way. The content is a series of key/value pairs grouped into sections. If the section keyword argument is omitted, those key/value pairs are implicitly grouped into a section with no title. key/value pairs can optionally be grouped into a dictionary, but keep in mind that dictionaries do not guarantee ordering. `key` must be string, `value` can be: - an integer, boolean or string - *since 0.57.0* an external program or a dependency - *since 0.58.0* a feature option - a list of those. Instead of calling summary as `summary(key, value)`, it is also possible to directly pass a dictionary to the [[summary]] function, as seen in the example below. `summary()` can be called multiple times as long as the same section/key pair doesn't appear twice. All sections will be collected and printed at the end of the configuration in the same order as they have been called. example: | Example `meson.build`: ```meson project('My Project', version : '1.0') summary({'bindir': get_option('bindir'), 'libdir': get_option('libdir'), 'datadir': get_option('datadir'), }, section: 'Directories') summary({'Some boolean': false, 'Another boolean': true, 'Some string': 'Hello World', 'A list': ['string', 1, true], }, section: 'Configuration') ``` Output: ``` My Project 1.0 Directories prefix : /opt/gnome bindir : bin libdir : lib/x86_64-linux-gnu datadir : share Configuration Some boolean : False Another boolean: True Some string : Hello World A list : string 1 True ``` arg_flattening: false posargs: key_or_dict: type: str | dict[str | bool | int | dep | external_program | list[str | bool | int | dep | external_program]] description: | The name of the new entry, or a dict containing multiple entries. If a dict is passed it is equivalent to calling summary() once for each key-value pair. Keep in mind that dictionaries do not guarantee ordering. optargs: value: type: str | bool | int | dep | external_program | list[str | bool | int | dep | external_program] description: | The value to print for the `key`. Only valid if `key_or_dict` is a str. kwargs: bool_yn: type: bool default: false description: Convert bool values to yes and no section: type: str description: The section to put this summary information under. If the section keyword argument is omitted, key/value pairs are implicitly grouped into a section with no title. list_sep: type: str since: 0.54.0 description: | The separator to use when printing list values in this summary. If no separator is given, each list item will be printed on its own line. meson-docs/docs/yaml/functions/subproject.yaml0000644000175000017500000000540214656633773021502 0ustar lattislattisname: subproject returns: subproject description: | Takes the project specified in the positional argument and brings that in the current build specification by returning a [[@subproject]] object. Subprojects must always be placed inside the `subprojects` directory at the top source directory. So for example a subproject called `foo` must be located in `${MESON_SOURCE_ROOT}/subprojects/foo`. - `default_options` *(since 0.37.0)*: an array of default option values that override those set in the subproject's `meson.options` (like `default_options` in `project`, they only have effect when Meson is run for the first time, and command line arguments override any default options in build files). *(since 0.54.0)*: `default_library` built-in option can also be overridden. *(since 1.2.0)*: A dictionary may be passed instead of array. - `version`: works just like the same as in `dependency`. It specifies what version the subproject should be, as an example `>=1.0.1` - `required` *(since 0.48.0)*: By default, `required` is `true` and Meson will abort if the subproject could not be setup. You can set this to `false` and then use the `.found()` method on the [[@subproject]] object. You may also pass the value of a [`feature`](Build-options.md#features) option, same as [[dependency]]. Note that you can use the returned [[@subproject]] object to access any variable in the subproject. However, if you want to use a dependency object from inside a subproject, an easier way is to use the `fallback:` keyword argument to [[dependency]]. [See additional documentation](Subprojects.md). posargs: subproject_name: type: str description: | Name of the subproject. The subproject must exist in the `subprojects` directory (or the directory specified in the `subproject_dir` of [[project]]) as a directory or wrap file. kwargs: default_options: type: list[str] | dict[str | bool | int | list[str]] since: 0.37.0 description: | An array of default option values that override those set in the subproject's `meson.options` (like `default_options` in [[project]], they only have effect when Meson is run for the first time, and command line arguments override any default options in build files). *(since 0.54.0)*: `default_library` built-in option can also be overridden. *(since 1.2.0)*: A dictionary may now be passed. version: type: str | list[str] description: | Works just like the same as in [[dependency]]. It specifies what version the subproject should be, as an example `>=1.0.1`. required: type: bool | feature since: 0.48.0 default: true description: | Works just the same as in [[dependency]]. meson-docs/docs/yaml/functions/install_man.yaml0000644000175000017500000000245614656633773021631 0ustar lattislattisname: install_man returns: void description: | Installs the specified man files from the source tree into system's man directory during the install step. This directory can be overridden by specifying it with the `install_dir` keyword argument. *(since 0.49.0)* [manpages are no longer compressed implicitly][install_man_49]. [install_man_49]: https://mesonbuild.com/Release-notes-for-0-49-0.html#manpages-are-no-longer-compressed-implicitly varargs: name: file type: file | str description: Man pages to install. warnings: - the `install_mode` kwarg ignored integer values between 0.59.0 -- 1.1.0. kwargs: install_mode: type: list[str | int | bool] since: 0.47.0 description: | Specify the file mode in symbolic format and optionally the owner/uid and group/gid for the installed files. See the `install_mode` kwarg of [[install_data]] for more information. install_dir: type: str description: Where to install to. locale: type: str since: 0.58.0 description: | Can be used to specify the locale into which the man page will be installed within the manual page directory tree. An example manual might be `foo.fr.1` with a locale of `fr`, such that `{mandir}/{locale}/man{num}/foo.1` becomes the installed file. meson-docs/docs/yaml/functions/include_directories.yaml0000644000175000017500000000361014656633773023340 0ustar lattislattisname: include_directories returns: inc description: | Returns an opaque object which contains the directories (relative to the current directory) given in the positional arguments. The result can then be passed to the `include_directories:` keyword argument when building executables or libraries. You can use the returned object in any subdirectory you want, Meson will make the paths work automatically. Note that this function call itself does not add the directories into the search path, since there is no global search path. For something like that, see [`add_project_arguments()`](#add_project_arguments). See also `implicit_include_directories` parameter of [[executable]], which adds current source and build directories to include path. Each directory given is converted to two include paths: one that is relative to the source root and one relative to the build root. example: | For example, with the following source tree layout in `/home/user/project.git`: `meson.build`: ```meson project(...) subdir('include') subdir('src') ... ``` `include/meson.build`: ```meson inc = include_directories('.') ... ``` `src/meson.build`: ```meson sources = [...] executable('some-tool', sources, include_directories : inc, ...) ... ``` If the build tree is `/tmp/build-tree`, the following include paths will be added to the `executable()` call: `-I/tmp/build-tree/include -I/home/user/project.git/include`. varargs: name: includes type: str description: Include paths to add. kwargs: is_system: type: bool default: false description: | If set to `true`, flags the specified directories as system directories. This means that they will be used with the `-isystem` compiler argument rather than `-I` on compilers that support this flag (in practice everything except Visual Studio). meson-docs/docs/yaml/functions/benchmark.yaml0000644000175000017500000000771414656633773021264 0ustar lattislattisname: benchmark returns: void description: | Creates a benchmark item that will be run when the benchmark target is run. The behavior of this function is identical to [[test]] except for: * benchmark() has no `is_parallel` keyword because benchmarks are not run in parallel * benchmark() does not automatically add the `MALLOC_PERTURB_` environment variable Defined benchmarks can be run in a backend-agnostic way by calling `meson test --benchmark` inside the build dir, or by using backend-specific commands, such as `ninja benchmark` or `msbuild RUN_TESTS.vcxproj`. notes: - Prior to 0.52.0 benchmark would warn that `depends` and `priority` were unsupported, this is incorrect. posargs: name: type: str description: The *unique* test id executable: type: exe | jar | external_program | file | custom_tgt | custom_idx description: | The program to execute. *(Since 1.4.0)* A CustomTarget is also accepted. kwargs: args: type: list[str | file | build_tgt | custom_tgt | custom_idx] description: Arguments to pass to the executable env: type: env | list[str] | dict[str] description: | environment variables to set, such as `['NAME1=value1', 'NAME2=value2']`, or an [[@env]] object which allows more sophisticated environment juggling. *(Since 0.52.0)* A dictionary is also accepted. should_fail: type: bool default: false description: | when true the test is considered passed if the executable returns a non-zero return value (i.e. reports an error) suite: type: str | list[str] description: | `'label'` (or list of labels `['label1', 'label2']`) attached to this test. The suite name is qualified by a (sub)project name resulting in `(sub)project_name:label`. In the case of a list of strings, the suite names will be `(sub)project_name:label1`, `(sub)project_name:label2`, etc. timeout: type: int default: 30 description: | the amount of seconds the test is allowed to run, a test that exceeds its time limit is always considered failed, defaults to 30 seconds. *Since 0.57* if timeout is `<= 0` the test has infinite duration, in previous versions of Meson the test would fail with a timeout immediately. workdir: type: str description: | absolute path that will be used as the working directory for the test depends: type: list[build_tgt | custom_tgt] since: 0.46.0 description: | specifies that this test depends on the specified target(s), even though it does not take any of them as a command line argument. This is meant for cases where test finds those targets internally, e.g. plugins or globbing. Those targets are built before test is executed even if they have `build_by_default : false`. protocol: type: str since: 0.50.0 default: "'exitcode'" description: | specifies how the test results are parsed and can be one of `exitcode`, `tap`, or `gtest`. For more information about test harness protocol read [Unit Tests](Unit-tests.md). The following values are accepted: - `exitcode`: the executable's exit code is used by the test harness to record the outcome of the test). - `tap`: [Test Anything Protocol](https://www.testanything.org/). - `gtest` *(since 0.55.0)*: for Google Tests. - `rust` *(since 0.56.0)*: for native rust tests priority: type: int since: 0.52.0 default: 0 description: | specifies the priority of a test. Tests with a higher priority are *started* before tests with a lower priority. The starting order of tests with identical priorities is implementation-defined. The default priority is 0, negative numbers are permitted. verbose: type: bool since: 0.62.0 default: false description: | if true, forces the test results to be logged as if `--verbose` was passed to `meson test`. meson-docs/docs/genrefman.py0000755000175000017500000000057214656633773016006 0ustar lattislattis#!/usr/bin/env python3 # SPDX-License-Identifier: Apache-2.0 # Copyright 2021 The Meson development team # Hack to make relative imports to mlog possible from pathlib import Path import sys root = Path(__file__).absolute().parents[1] sys.path.insert(0, str(root)) # Now run the actual code from refman.main import main if __name__ == '__main__': raise SystemExit(main()) meson-docs/mesonbuild/0000755000175000017500000000000014656633773014674 5ustar lattislattismeson-docs/mesonbuild/mlog.py0000644000175000017500000004637614656633773016224 0ustar lattislattis# SPDX-License-Identifier: Apache-2.0 # Copyright 2013-2014 The Meson development team """This is (mostly) a standalone module used to write logging information about Meson runs. Some output goes to screen, some to logging dir and some goes to both.""" from __future__ import annotations import enum import os import io import sys import time import platform import shlex import subprocess import shutil import typing as T from contextlib import contextmanager from dataclasses import dataclass, field from pathlib import Path if T.TYPE_CHECKING: from ._typing import StringProtocol, SizedStringProtocol from .mparser import BaseNode TV_Loggable = T.Union[str, 'AnsiDecorator', StringProtocol] TV_LoggableList = T.List[TV_Loggable] def is_windows() -> bool: platname = platform.system().lower() return platname == 'windows' def _windows_ansi() -> bool: # windll only exists on windows, so mypy will get mad from ctypes import windll, byref # type: ignore from ctypes.wintypes import DWORD kernel = windll.kernel32 stdout = kernel.GetStdHandle(-11) mode = DWORD() if not kernel.GetConsoleMode(stdout, byref(mode)): return False # ENABLE_VIRTUAL_TERMINAL_PROCESSING == 0x4 # If the call to enable VT processing fails (returns 0), we fallback to # original behavior return bool(kernel.SetConsoleMode(stdout, mode.value | 0x4) or os.environ.get('ANSICON')) def colorize_console() -> bool: _colorize_console: bool = getattr(sys.stdout, 'colorize_console', None) if _colorize_console is not None: return _colorize_console try: if is_windows(): _colorize_console = os.isatty(sys.stdout.fileno()) and _windows_ansi() else: _colorize_console = os.isatty(sys.stdout.fileno()) and os.environ.get('TERM', 'dumb') != 'dumb' except Exception: _colorize_console = False sys.stdout.colorize_console = _colorize_console # type: ignore[attr-defined] return _colorize_console def setup_console() -> None: # on Windows, a subprocess might call SetConsoleMode() on the console # connected to stdout and turn off ANSI escape processing. Call this after # running a subprocess to ensure we turn it on again. if is_windows(): try: delattr(sys.stdout, 'colorize_console') except AttributeError: pass _in_ci = 'CI' in os.environ class _Severity(enum.Enum): NOTICE = enum.auto() WARNING = enum.auto() ERROR = enum.auto() DEPRECATION = enum.auto() @dataclass class _Logger: log_dir: T.Optional[str] = None log_depth: T.List[str] = field(default_factory=list) log_file: T.Optional[T.TextIO] = None log_timestamp_start: T.Optional[float] = None log_fatal_warnings = False log_disable_stdout = False log_errors_only = False logged_once: T.Set[T.Tuple[str, ...]] = field(default_factory=set) log_warnings_counter = 0 log_pager: T.Optional['subprocess.Popen'] = None _LOG_FNAME: T.ClassVar[str] = 'meson-log.txt' @contextmanager def no_logging(self) -> T.Iterator[None]: self.log_disable_stdout = True try: yield finally: self.log_disable_stdout = False @contextmanager def force_logging(self) -> T.Iterator[None]: restore = self.log_disable_stdout self.log_disable_stdout = False try: yield finally: self.log_disable_stdout = restore def set_quiet(self) -> None: self.log_errors_only = True def set_verbose(self) -> None: self.log_errors_only = False def set_timestamp_start(self, start: float) -> None: self.log_timestamp_start = start def shutdown(self) -> T.Optional[str]: if self.log_file is not None: path = self.log_file.name exception_around_goer = self.log_file self.log_file = None exception_around_goer.close() return path self.stop_pager() return None def start_pager(self) -> None: if not colorize_console(): return pager_cmd = [] if 'PAGER' in os.environ: pager_cmd = shlex.split(os.environ['PAGER']) else: less = shutil.which('less') if not less and is_windows(): git = shutil.which('git') if git: path = Path(git).parents[1] / 'usr' / 'bin' less = shutil.which('less', path=str(path)) if less: pager_cmd = [less] if not pager_cmd: return try: # Set 'LESS' environment variable, rather than arguments in # pager_cmd, to also support the case where the user has 'PAGER' # set to 'less'. Arguments set are: # "R" : support color # "X" : do not clear the screen when leaving the pager # "F" : skip the pager if content fits into the screen env = os.environ.copy() if 'LESS' not in env: env['LESS'] = 'RXF' # Set "-c" for lv to support color if 'LV' not in env: env['LV'] = '-c' self.log_pager = subprocess.Popen(pager_cmd, stdin=subprocess.PIPE, text=True, encoding='utf-8', env=env) except Exception as e: # Ignore errors, unless it is a user defined pager. if 'PAGER' in os.environ: from .mesonlib import MesonException raise MesonException(f'Failed to start pager: {str(e)}') def stop_pager(self) -> None: if self.log_pager: try: self.log_pager.stdin.flush() self.log_pager.stdin.close() except OSError: pass self.log_pager.wait() self.log_pager = None def initialize(self, logdir: str, fatal_warnings: bool = False) -> None: self.log_dir = logdir self.log_file = open(os.path.join(logdir, self._LOG_FNAME), 'w', encoding='utf-8') self.log_fatal_warnings = fatal_warnings def process_markup(self, args: T.Sequence[TV_Loggable], keep: bool, display_timestamp: bool = True) -> T.List[str]: arr: T.List[str] = [] if self.log_timestamp_start is not None and display_timestamp: arr = ['[{:.3f}]'.format(time.monotonic() - self.log_timestamp_start)] for arg in args: if arg is None: continue if isinstance(arg, str): arr.append(arg) elif isinstance(arg, AnsiDecorator): arr.append(arg.get_text(keep)) else: arr.append(str(arg)) return arr def force_print(self, *args: str, nested: bool, sep: T.Optional[str] = None, end: T.Optional[str] = None) -> None: if self.log_disable_stdout: return iostr = io.StringIO() print(*args, sep=sep, end=end, file=iostr) raw = iostr.getvalue() if self.log_depth: prepend = self.log_depth[-1] + '| ' if nested else '' lines = [] for l in raw.split('\n'): l = l.strip() lines.append(prepend + l if l else '') raw = '\n'.join(lines) # _Something_ is going to get printed. try: output = self.log_pager.stdin if self.log_pager else None print(raw, end='', file=output) except UnicodeEncodeError: cleaned = raw.encode('ascii', 'replace').decode('ascii') print(cleaned, end='') def debug(self, *args: TV_Loggable, sep: T.Optional[str] = None, end: T.Optional[str] = None, display_timestamp: bool = True) -> None: arr = process_markup(args, False, display_timestamp) if self.log_file is not None: print(*arr, file=self.log_file, sep=sep, end=end) self.log_file.flush() def _log(self, *args: TV_Loggable, is_error: bool = False, nested: bool = True, sep: T.Optional[str] = None, end: T.Optional[str] = None, display_timestamp: bool = True) -> None: arr = process_markup(args, False, display_timestamp) if self.log_file is not None: print(*arr, file=self.log_file, sep=sep, end=end) self.log_file.flush() if colorize_console(): arr = process_markup(args, True, display_timestamp) if not self.log_errors_only or is_error: force_print(*arr, nested=nested, sep=sep, end=end) def _debug_log_cmd(self, cmd: str, args: T.List[str]) -> None: if not _in_ci: return args = [f'"{x}"' for x in args] # Quote all args, just in case self.debug('!meson_ci!/{} {}'.format(cmd, ' '.join(args))) def cmd_ci_include(self, file: str) -> None: self._debug_log_cmd('ci_include', [file]) def log(self, *args: TV_Loggable, is_error: bool = False, once: bool = False, nested: bool = True, sep: T.Optional[str] = None, end: T.Optional[str] = None, display_timestamp: bool = True) -> None: if once: self._log_once(*args, is_error=is_error, nested=nested, sep=sep, end=end, display_timestamp=display_timestamp) else: self._log(*args, is_error=is_error, nested=nested, sep=sep, end=end, display_timestamp=display_timestamp) def log_timestamp(self, *args: TV_Loggable) -> None: if self.log_timestamp_start: self.log(*args) def _log_once(self, *args: TV_Loggable, is_error: bool = False, nested: bool = True, sep: T.Optional[str] = None, end: T.Optional[str] = None, display_timestamp: bool = True) -> None: """Log variant that only prints a given message one time per meson invocation. This considers ansi decorated values by the values they wrap without regard for the AnsiDecorator itself. """ def to_str(x: TV_Loggable) -> str: if isinstance(x, str): return x if isinstance(x, AnsiDecorator): return x.text return str(x) t = tuple(to_str(a) for a in args) if t in self.logged_once: return self.logged_once.add(t) self._log(*args, is_error=is_error, nested=nested, sep=sep, end=end, display_timestamp=display_timestamp) def _log_error(self, severity: _Severity, *rargs: TV_Loggable, once: bool = False, fatal: bool = True, location: T.Optional[BaseNode] = None, nested: bool = True, sep: T.Optional[str] = None, end: T.Optional[str] = None, is_error: bool = True) -> None: from .mesonlib import MesonException, relpath # The typing requirements here are non-obvious. Lists are invariant, # therefore T.List[A] and T.List[T.Union[A, B]] are not able to be joined if severity is _Severity.NOTICE: label: TV_LoggableList = [bold('NOTICE:')] elif severity is _Severity.WARNING: label = [yellow('WARNING:')] elif severity is _Severity.ERROR: label = [red('ERROR:')] elif severity is _Severity.DEPRECATION: label = [red('DEPRECATION:')] # rargs is a tuple, not a list args = label + list(rargs) if location is not None: location_file = relpath(location.filename, os.getcwd()) location_str = get_error_location_string(location_file, location.lineno) # Unions are frankly awful, and we have to T.cast here to get mypy # to understand that the list concatenation is safe location_list = T.cast('TV_LoggableList', [location_str]) args = location_list + args log(*args, once=once, nested=nested, sep=sep, end=end, is_error=is_error) self.log_warnings_counter += 1 if self.log_fatal_warnings and fatal: raise MesonException("Fatal warnings enabled, aborting") def error(self, *args: TV_Loggable, once: bool = False, fatal: bool = True, location: T.Optional[BaseNode] = None, nested: bool = True, sep: T.Optional[str] = None, end: T.Optional[str] = None) -> None: return self._log_error(_Severity.ERROR, *args, once=once, fatal=fatal, location=location, nested=nested, sep=sep, end=end, is_error=True) def warning(self, *args: TV_Loggable, once: bool = False, fatal: bool = True, location: T.Optional[BaseNode] = None, nested: bool = True, sep: T.Optional[str] = None, end: T.Optional[str] = None) -> None: return self._log_error(_Severity.WARNING, *args, once=once, fatal=fatal, location=location, nested=nested, sep=sep, end=end, is_error=True) def deprecation(self, *args: TV_Loggable, once: bool = False, fatal: bool = True, location: T.Optional[BaseNode] = None, nested: bool = True, sep: T.Optional[str] = None, end: T.Optional[str] = None) -> None: return self._log_error(_Severity.DEPRECATION, *args, once=once, fatal=fatal, location=location, nested=nested, sep=sep, end=end, is_error=True) def notice(self, *args: TV_Loggable, once: bool = False, fatal: bool = True, location: T.Optional[BaseNode] = None, nested: bool = True, sep: T.Optional[str] = None, end: T.Optional[str] = None) -> None: return self._log_error(_Severity.NOTICE, *args, once=once, fatal=fatal, location=location, nested=nested, sep=sep, end=end, is_error=False) def exception(self, e: Exception, prefix: T.Optional[AnsiDecorator] = None) -> None: if prefix is None: prefix = red('ERROR:') self.log() args: T.List[T.Union[AnsiDecorator, str]] = [] if all(getattr(e, a, None) is not None for a in ['file', 'lineno', 'colno']): # Mypy doesn't follow hasattr, and it's pretty easy to visually inspect # that this is correct, so we'll just ignore it. path = get_relative_path(Path(e.file), Path(os.getcwd())) # type: ignore args.append(f'{path}:{e.lineno}:{e.colno}:') # type: ignore if prefix: args.append(prefix) args.append(str(e)) with self.force_logging(): self.log(*args, is_error=True) @contextmanager def nested(self, name: str = '') -> T.Generator[None, None, None]: self.log_depth.append(name) try: yield finally: self.log_depth.pop() def get_log_dir(self) -> str: return self.log_dir def get_log_depth(self) -> int: return len(self.log_depth) @contextmanager def nested_warnings(self) -> T.Iterator[None]: old = self.log_warnings_counter self.log_warnings_counter = 0 try: yield finally: self.log_warnings_counter = old def get_warning_count(self) -> int: return self.log_warnings_counter _logger = _Logger() cmd_ci_include = _logger.cmd_ci_include debug = _logger.debug deprecation = _logger.deprecation error = _logger.error exception = _logger.exception force_print = _logger.force_print get_log_depth = _logger.get_log_depth get_log_dir = _logger.get_log_dir get_warning_count = _logger.get_warning_count initialize = _logger.initialize log = _logger.log log_timestamp = _logger.log_timestamp nested = _logger.nested nested_warnings = _logger.nested_warnings no_logging = _logger.no_logging notice = _logger.notice process_markup = _logger.process_markup set_quiet = _logger.set_quiet set_timestamp_start = _logger.set_timestamp_start set_verbose = _logger.set_verbose shutdown = _logger.shutdown start_pager = _logger.start_pager stop_pager = _logger.stop_pager warning = _logger.warning class AnsiDecorator: plain_code = "\033[0m" def __init__(self, text: str, code: str, quoted: bool = False): self.text = text self.code = code self.quoted = quoted def get_text(self, with_codes: bool) -> str: text = self.text if with_codes and self.code: text = self.code + self.text + AnsiDecorator.plain_code if self.quoted: text = f'"{text}"' return text def __len__(self) -> int: return len(self.text) def __str__(self) -> str: return self.get_text(colorize_console()) class AnsiText: def __init__(self, *args: 'SizedStringProtocol'): self.args = args def __len__(self) -> int: return sum(len(x) for x in self.args) def __str__(self) -> str: return ''.join(str(x) for x in self.args) def bold(text: str, quoted: bool = False) -> AnsiDecorator: return AnsiDecorator(text, "\033[1m", quoted=quoted) def italic(text: str, quoted: bool = False) -> AnsiDecorator: return AnsiDecorator(text, "\033[3m", quoted=quoted) def plain(text: str) -> AnsiDecorator: return AnsiDecorator(text, "") def red(text: str) -> AnsiDecorator: return AnsiDecorator(text, "\033[1;31m") def green(text: str) -> AnsiDecorator: return AnsiDecorator(text, "\033[1;32m") def yellow(text: str) -> AnsiDecorator: return AnsiDecorator(text, "\033[1;33m") def blue(text: str) -> AnsiDecorator: return AnsiDecorator(text, "\033[1;34m") def cyan(text: str) -> AnsiDecorator: return AnsiDecorator(text, "\033[1;36m") def normal_red(text: str) -> AnsiDecorator: return AnsiDecorator(text, "\033[31m") def normal_green(text: str) -> AnsiDecorator: return AnsiDecorator(text, "\033[32m") def normal_yellow(text: str) -> AnsiDecorator: return AnsiDecorator(text, "\033[33m") def normal_blue(text: str) -> AnsiDecorator: return AnsiDecorator(text, "\033[34m") def normal_cyan(text: str) -> AnsiDecorator: return AnsiDecorator(text, "\033[36m") def get_error_location_string(fname: StringProtocol, lineno: int) -> str: return f'{fname}:{lineno}:' def get_relative_path(target: Path, current: Path) -> Path: """Get the path to target from current""" # Go up "current" until we find a common ancestor to target acc = ['.'] for part in [current, *current.parents]: try: path = target.relative_to(part) return Path(*acc, path) except ValueError: pass acc += ['..'] # we failed, should not get here return target # Format a list for logging purposes as a string. It separates # all but the last item with commas, and the last with 'and'. def format_list(input_list: T.List[str]) -> str: l = len(input_list) if l > 2: return ' and '.join([', '.join(input_list[:-1]), input_list[-1]]) elif l == 2: return ' and '.join(input_list) elif l == 1: return input_list[0] else: return '' def code_line(text: str, line: str, colno: int) -> str: """Print a line with a caret pointing to the colno :param text: A message to display before the line :param line: The line of code to be pointed to :param colno: The column number to point at :return: A formatted string of the text, line, and a caret """ return f'{text}\n{line}\n{" " * colno}^' meson-docs/mesonbuild/coredata.py0000644000175000017500000000002214656633773017022 0ustar lattislattisversion = '1.5.1' meson-docs/mesonbuild/mesonlib.py0000644000175000017500000000232714656633773017062 0ustar lattislattisimport typing as T def listify(item: T.Any, flatten: bool = True) -> T.List[T.Any]: """ Returns a list with all args embedded in a list if they are not a list. This function preserves order. @flatten: Convert lists of lists to a flat list """ if not isinstance(item, list): return [item] result = [] # type: T.List[T.Any] for i in item: if flatten and isinstance(i, list): result += listify(i, flatten=True) else: result.append(i) return result class MesonException(Exception): """Exceptions thrown by Meson""" def __init__( self, *args: object, file: T.Optional[str] = None, lineno: T.Optional[int] = None, colno: T.Optional[int] = None ): super().__init__(*args) self.file = file self.lineno = lineno self.colno = colno def relpath(path: str, start: str) -> str: # On Windows a relative path can't be evaluated for paths on two different # drives (i.e. c:\foo and f:\bar). The only thing left to do is to use the # original absolute path. try: return os.path.relpath(path, start) except (TypeError, ValueError): return path