1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
|
---
short-description: Build options to configure project properties
...
# Build options
Most non-trivial builds require user-settable options. As an example a
program may have two different data backends that are selectable at
build time. Meson provides for this by having a option definition
file. Its name is `meson_options.txt` and it is placed at the root of
your source tree.
Here is a simple option file.
```meson
option('someoption', type : 'string', value : 'optval', description : 'An option')
option('other_one', type : 'boolean', value : false)
option('combo_opt', type : 'combo', choices : ['one', 'two', 'three'], value : 'three')
option('integer_opt', type : 'integer', min : 0, max : 5, value : 3) # Since 0.45.0
option('free_array_opt', type : 'array', value : ['one', 'two'])
option('array_opt', type : 'array', choices : ['one', 'two', 'three'], value : ['one', 'two'])
```
All types allow a `description` value to be set describing the option,
if no option is set then the name of the option will be used instead.
### Strings
The string type is a free form string. If the default value is not set
then an empty string will be used as the default.
### Booleans
Booleans may have values of either `true` or `false`. If no default
value is supplied then `true` will be used as the default.
### Combos
A combo allows any one of the values in the `choices` parameter to be
selected. If no default value is set then the first value will be the
default.
## Integers
An integer option contains a single integer with optional upper and
lower values that are specified with the `min` and `max` keyword
arguments.
This type is available since Meson version 0.45.0.
### Arrays
Arrays represent an array of strings. By default the array can contain
arbitrary strings. To limit the possible values that can used set the
`choices` parameter. Meson will then only allow the value array to
contain strings that are in the given list. The array may be
empty. The `value` parameter specifies the default value of the option
and if it is unset then the values of `choices` will be used as the
default.
This type is available since version 0.44.0
## Using build options
```meson
optval = get_option('opt_name')
```
This function also allows you to query the value of Meson's built-in
project options. For example, to get the installation prefix you would
issue the following command:
```meson
prefix = get_option('prefix')
```
It should be noted that you can not set option values in your Meson
scripts. They have to be set externally with the `meson configure`
command line tool. Running `meson configure` without arguments in a
build dir shows you all options you can set.
To change their values use the `-D`
option:
```console
$ meson configure -Doption=newvalue
```
Setting the value of arrays is a bit special. If you only pass a
single string, then it is considered to have all values separated by
commas. Thus invoking the following command:
```console
$ meson configure -Darray_opt=foo,bar
```
would set the value to an array of two elements, `foo` and `bar`.
If you need to have commas in your string values, then you need to
pass the value with proper shell quoting like this:
```console
$ meson configure "-Doption=['a,b', 'c,d']"
```
The inner values must always be single quotes and the outer ones
double quotes.
To change values in subprojects prepend the name of the subproject and
a colon:
```console
$ meson configure -Dsubproject:option=newvalue
```
**NOTE:** If you cannot call `meson configure` you likely have a old
version of Meson. In that case you can call `mesonconf` instead, but
that is deprecated in newer versions
## Yielding to superproject option
Suppose you have a master project and a subproject. In some cases it
might be useful to have an option that has the same value in both of
them. This can be achieved with the `yield` keyword. Suppose you have
an option definition like this:
```meson
option('some_option', type : 'string', value : 'value', yield : true)
```
If you build this project on its own, this option behaves like
usual. However if you build this project as a subproject of another
project which also has an option called `some_option`, then calling
`get_option` returns the value of the superproject. If the value of
`yield` is `false`, `get_option` returns the value of the subproject's
option.
|
