···

       
1
       
 
       
# Meson {#meson}

     

       
2
       
 
       


     

       
3
       
-
       
Overrides the configure phase to run meson to generate Ninja files. To run these files, you should accompany Meson with ninja. By default, `enableParallelBuilding` is enabled as Meson supports parallel building almost everywhere.

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
4
       
 
       


     

       
5
       
 
       
## Variables controlling Meson {#variables-controlling-meson}

     

       
6
       
 
       


     

       
7
       
 
       
### `mesonFlags` {#mesonflags}

     

       
8
       
 
       


     

       
9
       
-
       
Controls the flags passed to meson.

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
10
       
 
       


     

       
11
       
 
       
### `mesonBuildType` {#mesonbuildtype}

     

       
12
       
 
       


     

       
13
       
-
       
Which [`--buildtype`](https://mesonbuild.com/Builtin-options.html#core-options) to pass to Meson. We default to `plain`.

     

       
14
       
 
       


     

       
15
       
 
       
### `mesonAutoFeatures` {#mesonautofeatures}

     

       
16
       
 
       


     
···

       
23
       
 
       
### `dontUseMesonConfigure` {#dontusemesonconfigure}

     

       
24
       
 
       


     

       
25
       
 
       
Disables using Meson’s `configurePhase`.

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

···

       
1
       
 
       
# Meson {#meson}

     

       
2
       
 
       


     

       
3
       
+
       
Overrides the configure, check, and install phases to run `meson setup`, `meson test`, and `meson install`.

     

       
4
       
+
       


     

       
5
       
+
       
Meson is a meta-build system so you will need a secondary build system to run the generated build files in build phase. In Nixpkgs context, you will want to accompany Meson with ninja, which provides a [setup hook](#ninja) registering a ninja-based build phase.

     

       
6
       
+
       


     

       
7
       
+
       
By default, `enableParallelBuilding` is enabled as Meson supports parallel building almost everywhere.

     

       
8
       
 
       


     

       
9
       
 
       
## Variables controlling Meson {#variables-controlling-meson}

     

       
10
       
 
       


     

       
11
       
 
       
### `mesonFlags` {#mesonflags}

     

       
12
       
 
       


     

       
13
       
+
       
Controls the flags passed to `meson setup`.

     

       
14
       
+
       


     

       
15
       
+
       
##### `mesonCheckFlags` {#mesoncheckflags}

     

       
16
       
+
       


     

       
17
       
+
       
Controls the flags passed to `meson test`.

     

       
18
       
+
       


     

       
19
       
+
       
##### `mesonInstallFlags` {#mesoninstallflags}

     

       
20
       
+
       


     

       
21
       
+
       
Controls the flags passed to `meson install`.

     

       
22
       
 
       


     

       
23
       
 
       
### `mesonBuildType` {#mesonbuildtype}

     

       
24
       
 
       


     

       
25
       
+
       
Which [`--buildtype`](https://mesonbuild.com/Builtin-options.html#core-options) to pass to `meson setup`. We default to `plain`.

     

       
26
       
 
       


     

       
27
       
 
       
### `mesonAutoFeatures` {#mesonautofeatures}

     

       
28
       
 
       


     
···

       
35
       
 
       
### `dontUseMesonConfigure` {#dontusemesonconfigure}

     

       
36
       
 
       


     

       
37
       
 
       
Disables using Meson’s `configurePhase`.

     

       
38
       
+
       


     

       
39
       
+
       
##### `dontUseMesonCheck` {#dontusemesoncheck}

     

       
40
       
+
       


     

       
41
       
+
       
Disables using Meson’s `checkPhase`.

     

       
42
       
+
       


     

       
43
       
+
       
##### `dontUseMesonInstall` {#dontusemesoninstall}

     

       
44
       
+
       


     

       
45
       
+
       
Disables using Meson’s `installPhase`.

     

···

       
1
       
 
       
# ninja {#ninja}

     

       
2
       
 
       


     

       
3
       
 
       
Overrides the build, install, and check phase to run ninja instead of make. You can disable this behavior with the `dontUseNinjaBuild`, `dontUseNinjaInstall`, and `dontUseNinjaCheck`, respectively. Parallel building is enabled by default in Ninja.

     

       
0
       
 
       

     

       
0
       
 
       

     

···

       
1
       
 
       
# ninja {#ninja}

     

       
2
       
 
       


     

       
3
       
 
       
Overrides the build, install, and check phase to run ninja instead of make. You can disable this behavior with the `dontUseNinjaBuild`, `dontUseNinjaInstall`, and `dontUseNinjaCheck`, respectively. Parallel building is enabled by default in Ninja.

     

       
4
       
+
       


     

       
5
       
+
       
Note that if the [Meson setup hook](#meson) is also active, Ninja's install and check phases will be disabled in favor of Meson's.

     

···

       
28
       
 
       
        echo "meson: enabled parallel building"

     

       
29
       
 
       
    fi

     

       
30
       
 
       


     

       
31
       
-
       
    if ! [[ -v enableParallelInstalling ]]; then

     

       
32
       
-
       
        enableParallelInstalling=1

     

       
33
       
-
       
        echo "meson: enabled parallel installing"

     

       
0
       
 
       

     

       
0
       
 
       

     

       
34
       
 
       
    fi

     

       
35
       
 
       


     

       
36
       
 
       
    runHook postConfigure

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
37
       
 
       
}

     

       
38
       
 
       


     

       
39
       
 
       
if [ -z "${dontUseMesonConfigure-}" -a -z "${configurePhase-}" ]; then

     

···

       
28
       
 
       
        echo "meson: enabled parallel building"

     

       
29
       
 
       
    fi

     

       
30
       
 
       


     

       
31
       
+
       
    if [[ ${checkPhase-ninjaCheckPhase} = ninjaCheckPhase && -z $dontUseMesonCheck ]]; then

     

       
32
       
+
       
        checkPhase=mesonCheckPhase

     

       
33
       
+
       
    fi

     

       
34
       
+
       
    if [[ ${installPhase-ninjaInstallPhase} = ninjaInstallPhase && -z $dontUseMesonInstall ]]; then

     

       
35
       
+
       
        installPhase=mesonInstallPhase

     

       
36
       
 
       
    fi

     

       
37
       
 
       


     

       
38
       
 
       
    runHook postConfigure

     

       
39
       
+
       
}

     

       
40
       
+
       


     

       
41
       
+
       
mesonCheckPhase() {

     

       
42
       
+
       
    runHook preCheck

     

       
43
       
+
       


     

       
44
       
+
       
    local flagsArray=($mesonCheckFlags "${mesonCheckFlagsArray[@]}")

     

       
45
       
+
       


     

       
46
       
+
       
    echoCmd 'check flags' "${flagsArray[@]}"

     

       
47
       
+
       
    meson test --no-rebuild "${flagsArray[@]}"

     

       
48
       
+
       


     

       
49
       
+
       
    runHook postCheck

     

       
50
       
+
       
}

     

       
51
       
+
       


     

       
52
       
+
       
mesonInstallPhase() {

     

       
53
       
+
       
    runHook preInstall

     

       
54
       
+
       


     

       
55
       
+
       
    # shellcheck disable=SC2086

     

       
56
       
+
       
    local flagsArray=($mesonInstallFlags "${mesonInstallFlagsArray[@]}")

     

       
57
       
+
       


     

       
58
       
+
       
    echoCmd 'install flags' "${flagsArray[@]}"

     

       
59
       
+
       
    meson install --no-rebuild "${flagsArray[@]}"

     

       
60
       
+
       


     

       
61
       
+
       
    runHook postInstall

     

       
62
       
 
       
}

     

       
63
       
 
       


     

       
64
       
 
       
if [ -z "${dontUseMesonConfigure-}" -a -z "${configurePhase-}" ]; then