| 1 |
name: external_program |
| 2 |
long_name: External program |
| 3 |
description: Opaque object representing an external program |
| 4 |
|
| 5 |
methods: |
| 6 |
- name: found |
| 7 |
returns: bool |
| 8 |
description: Returns whether the executable was found. |
| 9 |
|
| 10 |
- name: path |
| 11 |
returns: str |
| 12 |
deprecated: 0.55.0 |
| 13 |
description: | |
| 14 |
*Deprecated:* Use [[external_program.full_path]] instead. |
| 15 |
|
| 16 |
Returns a string pointing to the script or executable. |
| 17 |
|
| 18 |
**NOTE:** You should not usually need to use this method. Passing the |
| 19 |
object itself should work in most contexts where a program can appear, |
| 20 |
and allows Meson to setup inter-target dependencies correctly (for |
| 21 |
example in cases where a program might be overridden by a [[@build_tgt]]). |
| 22 |
Only use this if you specifically need a string, such as when embedding |
| 23 |
a program path into a header file, or storing it into an environment |
| 24 |
variable. |
| 25 |
|
| 26 |
For example: |
| 27 |
|
| 28 |
```meson |
| 29 |
run_command(find_program('foo'), 'arg1', 'arg2') |
| 30 |
``` |
| 31 |
|
| 32 |
- name: version |
| 33 |
returns: str |
| 34 |
since: 0.62.0 |
| 35 |
description: | |
| 36 |
The version number as a string, for example `1.2.8`. |
| 37 |
|
| 38 |
`unknown` if the program cannot determine the version via a `--version` argument. |
| 39 |
|
| 40 |
- name: full_path |
| 41 |
returns: str |
| 42 |
since: 0.55.0 |
| 43 |
description: | |
| 44 |
Returns a string pointing to the script or executable. |
| 45 |
|
| 46 |
**NOTE:** You should not usually need to use this method. Passing the |
| 47 |
object itself should work in most contexts where a program can appear, |
| 48 |
and allows Meson to setup inter-target dependencies correctly (for |
| 49 |
example in cases where a program might be overridden by a [[@build_tgt]]). |
| 50 |
Only use this if you specifically need a string, such as when embedding |
| 51 |
a program path into a header file, or storing it into an environment |
| 52 |
variable. |
| 53 |
|
| 54 |
For example: |
| 55 |
|
| 56 |
```meson |
| 57 |
run_command(find_program('foo'), 'arg1', 'arg2') |
| 58 |
``` |