boltbuild 0.1.0

BoltBuild is a programmable build system.
Documentation 
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

---@type Context
local context = ...

context:load_tool('internal/compiler_gnu')

BoltGcc = {}

local function load_gcc_compiler(env, compiler, flags, language, var_name)
    env[var_name .. 'FLAGS'] = { '-x', language, '-c', '-fPIC' }
    env:append(var_name .. 'FLAGS', flags)
    env[var_name .. '_COMPILER_NAME'] = 'gcc'
    env[var_name .. '_TGT_F'] = '-o'
    env[var_name .. '_DEFINE_ST'] = '-D'
    env[var_name .. '_INCLUDE_ST'] = '-I'
    env[var_name .. '_SYSTEM_INCLUDE_ST'] = '-isystem%s'
    env[var_name .. '_IDIRAFTER'] = '-isystem'
    env.LINK = env.GCC
    env.LINKFLAGS = {}
    env.LINK_TGT_F = '-o'
    env.LINK_LIB_F = '-l'
    env.LINK_LIBPATH_F = '-L'
    env.LINKFLAGS_shlib = { '-shared', '-Wl,-z,defs' }

    local defines = BoltGnuCompiler.get_specs(compiler, var_name)
    local version = { 0, 0, 0 }

    for name, value in pairs(defines) do
        if name == '__GNUC__' then
            version[1] = tonumber(value)
        elseif name == '__GNUC_MINOR__' then
            version[2] = tonumber(value)
        elseif name == '__GNUC_PATCHLEVEL__' then
            version[3] = tonumber(value)
        end
    end

    env['GCC_' .. var_name .. '_VERSION'] = table.concat(version, '.')

    context:load_tool('internal/' .. language)
    context:load_tool('internal/link')
end

--- Loads the C compiler settings into the environment.
--- This function configures the environment to use the Gcc compiler for C.
--- It sets the necessary flags and libraries required for C compilation.
--- The function uses `context.env.GCC` as the base compiler command.
---
--- An error is raised if the compiler command returns an error code.
---
--- @param c_flags string[] A table containing extra flags that the C compiler should support.
function BoltGcc.load_c(c_flags)
    local env = context.env
    env.CC = env.GCC
    load_gcc_compiler(env, env.CC, c_flags, 'c', 'C')
end

--- Loads the C++ compiler settings into the environment.
--- This function configures the environment to use the Gcc compiler for C++.
--- It sets the necessary flags and libraries required for C++ compilation.
--- The function uses `context.env.GCC` as the base compiler command.
---
--- An error is raised if the compiler command returns an error code.
---
--- @param cxx_flags string[] A table containing extra flags that the C++ compiler should support.
function BoltGcc.load_cxx(cxx_flags)
    local env = context.env
    env.CXX = env.GCC
    env.LIBS = { 'stdc++' }
    load_gcc_compiler(env, env.CXX, cxx_flags, 'c++', 'CXX')
end

--- Loads the Objective-C compiler settings into the environment.
--- This function configures the environment to use the Gcc compiler for Objective-C.
--- It sets the necessary flags and libraries required for Objective-C compilation.
--- The function uses `context.env.GCC` as the base compiler command.
---
--- An error is raised if the compiler command returns an error code.
---
--- @param objc_flags string[] A table containing extra flags that the Objective-C compiler should support.
function BoltGcc.load_objc(objc_flags)
    local env = context.env
    env.OBJC = env.GCC
    env.LIBS = { 'objc' }
    load_gcc_compiler(env, env.OBJC, objc_flags, 'objc', 'OBJC')
end

--- Loads the Objective-C++ compiler settings into the environment.
--- This function configures the environment to use the Gcc compiler for Objective-C++.
--- It sets the necessary flags and libraries required for Objective-C++ compilation.
--- The function uses `context.env.GCC` as the base compiler command.
---
--- An error is raised if the compiler command returns an error code.
---
--- @param objcxx_flags string[] A table containing extra flags that the Objective-C++ compiler should support.
function BoltGcc.load_objcxx(objcxx_flags)
    local env = context.env
    env.OBJCXX = env.GCC
    env.LIBS = { 'stdc++', 'objc' }
    load_gcc_compiler(env, env.OBJCXX, objcxx_flags, 'objc++', 'OBJCXX')
end

local languages = {
    ['c'] = BoltGcc.load_c,
    ['c++'] = BoltGcc.load_cxx,
    ['objc'] = BoltGcc.load_objc,
    ['objc++'] = BoltGcc.load_objcxx,
}

--- Discovers available GCC compilers and configures the environment for each found compiler.
--- This function searches for GCC compilers in the specified paths, configures the environment
--- for each found compiler, and invokes the callback function with the configured environment.
--- It also supports detecting multilib configurations.
---
--- @param callback fun(env:Environment):(boolean|nil) The function to call with the configured environment.
--- @param language_flags table A table containing flags for each language to pass to the compiler.
--- @param global_flags table A table containing global flags to pass to the compiler.
--- @param detect_multilib boolean Whether to detect and configure multilib environments.
function BoltGcc.discover(callback, language_flags, global_flags, detect_multilib)
    context:try('Looking for Gcc compilers', function()
        local seen = {}
        local paths = context.settings.path

        for _, path in ipairs(paths) do
            for _, crtbegin in ipairs(context:search(path.parent, 'lib/gcc*/*/*/crtbegin.o')) do
                crtbegin = crtbegin:canonicalize()
                if not seen[crtbegin:abs_path()] then
                    local node = crtbegin.parent
                    local version = node:name()
                    node = node.parent
                    local target = node:name()
                    for _, gcc in ipairs(context:search(path, target .. '-gcc-' .. version .. context.settings.exe_suffix)) do
                        seen[crtbegin:abs_path()] = crtbegin
                        if pcall(function()
                            local env = context:derive()
                            context:with(env, function()
                                context.env.GCC = { gcc }
                                context.env:append('GCC', global_flags)
                                context.env.GCC_VERSION = version
                                for lang, flags in pairs(language_flags) do
                                    languages[lang](flags)
                                end
                            end)
                            if callback(env) ~= true then
                                return tostring(gcc)
                            end
                        end) and detect_multilib then
                            for _, multilib in ipairs(context:search(crtbegin.parent, '*/crtbegin.o')) do
                                pcall(function()
                                    local env = context:derive()
                                    context:with(env, function()
                                        context.env.CC = { gcc }
                                        context.env:append('GCC', global_flags)
                                        context.env:append('GCC', '-m' .. multilib.parent:name())
                                        context.env.GCC_VERSION = version
                                        for lang, flags in pairs(language_flags) do
                                            languages[lang](flags)
                                        end
                                    end)
                                    if callback(env) ~= true then
                                        return tostring(gcc)
                                    end
                                end)
                            end
                            break
                        end
                    end
                end
            end
        end
        return 'done'
    end)
end