summaryrefslogtreecommitdiff
path: root/xmake/rules/c++/modules/xmake.lua
blob: 2c7eaedff87a0ea91ee9e98a43a7b1c448a6a6aa (plain)
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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
--!A cross-platform build utility based on Lua
--
-- 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.
--
-- Copyright (C) 2015-present, TBOOX Open Source Group.
--
-- @author      ruki, Arthapz
-- @file        xmake.lua
--

-- define rule: c++.build.modules
rule("c++.build.modules")

    -- @note common.contains_modules() need it
    set_extensions(".cppm", ".ccm", ".cxxm", ".c++m", ".mpp", ".mxx", ".ixx")

    add_deps("c++.build.modules.builder")
    add_deps("c++.build.modules.install")

    on_config(function (target)
        import("support")

        -- we disable to build across targets in parallel, because the source files may depend on other target modules
        -- @see https://github.com/xmake-io/xmake/issues/1858
        if support.contains_modules(target) then
            -- @note this will cause cross-parallel builds to be disabled for all sub-dependent targets,
            -- even if some sub-targets do not contain C++ modules.
            --
            -- maybe we will have a more fine-grained configuration strategy to disable it in the future.
            target:set("policy", "build.fence", true)

            -- disable ccache for this target
            --
            -- Caching can affect incremental compilation, for example
            -- by interfering with the results of depfile generation for msvc.
            --
            -- @see https://github.com/xmake-io/xmake/issues/3000
            target:set("policy", "build.ccache", false)

            -- load compiler support
            support.load(target)

            -- mark this target with modules
            target:data_set("cxx.has_modules", true)

            -- moduleonly modules are implicitly public
            if target:is_moduleonly() then
                local sourcebatch = target:sourcebatches()["c++.build.modules.builder"]
                if sourcebatch then
                    for _, sourcefile in ipairs(sourcebatch.sourcefiles) do
                        target:fileconfig_add(sourcefile, {public = true})
                    end
                end
            end
        end
    end)

-- build modules
rule("c++.build.modules.builder")
    set_sourcekinds("cxx")
    set_extensions(".mpp", ".mxx", ".cppm", ".ixx")

    -- generate module dependencies
    on_prepare_files(function (target, jobgraph, sourcebatch, opt)
        if target:data("cxx.has_modules") then
            import("builder")
            import("scanner")

            -- patch sourcebatch
            builder.patch_sourcebatch(target, sourcebatch)

            -- generate module dependencies
            scanner.generate_module_dependencies(target, jobgraph, sourcebatch, opt)
        end
    end, {jobgraph = true})

    -- parallel build support to accelerate `xmake build` to build modules
    before_build_files(function(target, jobgraph, sourcebatch, opt)
        if target:data("cxx.has_modules") then
            import("support")
            import("scanner")
            import("builder")

            -- get module dependencies
            local modules = scanner.get_module_dependencies(target, sourcebatch)
            if not target:is_moduleonly() then
                -- avoid building non referenced modules
                local build_objectfiles, link_objectfiles = scanner.sort_modules_by_dependencies(target, sourcebatch.objectfiles, modules)
                sourcebatch.objectfiles = build_objectfiles

                -- build modules and headerunits
                builder.build_modules_and_headerunits(target, jobgraph, sourcebatch, modules, opt)
                sourcebatch.objectfiles = link_objectfiles
            else
                sourcebatch.objectfiles = {}
            end

            support.localcache():set2(target:fullname(), "c++.modules", modules)
            support.localcache():save()
        else
            -- avoid duplicate linking of object files of non-module programs
            sourcebatch.objectfiles = {}
        end
    end, {jobgraph = true, batch = true})

    -- serial compilation only, usually used to support project generator
    before_buildcmd_files(function(target, batchcmds, sourcebatch, opt)
        if target:data("cxx.has_modules") then
            import("support")
            import("scanner")
            import("builder")

            -- get module dependencies
            local modules = scanner.get_module_dependencies(target, sourcebatch)
            if not target:is_moduleonly() then
                -- avoid building non referenced modules
                local build_objectfiles, link_objectfiles = scanner.sort_modules_by_dependencies(target, sourcebatch.objectfiles, modules)
                sourcebatch.objectfiles = build_objectfiles

                -- build headerunits and modules
                builder.build_modules_and_headerunits(target, batchcmds, sourcebatch, modules, opt)
                sourcebatch.objectfiles = link_objectfiles
            else
                -- avoid duplicate linking of object files of non-module programs
                sourcebatch.objectfiles = {}
            end

            support.localcache():set2(target:fullname(), "c++.modules", modules)
            support.localcache():save()
        else
            sourcebatch.sourcefiles = {}
            sourcebatch.objectfiles = {}
            sourcebatch.dependfiles = {}
        end
    end)

    after_clean(function (target)
        import("core.base.option")
        import("support")
        import("private.action.clean.remove_files")

        -- we cannot use target:data("cxx.has_modules"),
        -- because on_config will be not called when cleaning targets
        if support.contains_modules(target) then
            remove_files(support.modules_cachedir(target))
            if option.get("all") then
                remove_files(support.stlmodules_cachedir(target))
                support.localcache():clear()
                support.localcache():save()
            end
        end
    end)

-- install modules
rule("c++.build.modules.install")
    set_extensions(".mpp", ".mxx", ".cppm", ".ixx")

    before_install(function (target)
        import("support")
        import("builder")

        -- we cannot use target:data("cxx.has_modules"),
        -- because on_config will be not called when installing targets
        if support.contains_modules(target) then
            local modules = support.localcache():get2(target:fullname(), "c++.modules")
            builder.generate_metadata(target, modules)

            support.add_installfiles_for_modules(target)
        end
    end)

    before_uninstall(function (target)
        import("support")
        if support.contains_modules(target) then
            support.add_installfiles_for_modules(target)
        end
    end)