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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
|
--!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
-- @file compile_commands.lua
--
-- imports
import("core.tool.compiler")
import("core.project.rule")
import("core.project.project")
import("core.language.language")
import("private.utils.batchcmds")
-- escape path
function _escape_path(p)
return os.args(p, {escape = true, nowrap = true})
end
-- translate external/system include flags, because some tools (vscode) do not support them yet.
-- https://github.com/xmake-io/xmake/issues/1050
function _translate_arguments(arguments)
local args = {}
local is_msvc = path.basename(arguments[1]):lower() == "cl"
for _, arg in ipairs(arguments) do
if arg:find("-isystem", 1, true) then
arg = arg:replace("-isystem", "-I")
elseif arg:find("[%-/]external:I") then
arg = arg:gsub("[%-/]external:I", "-I")
elseif arg:find("[%-/]external:W") or arg:find("[%-/]experimental:external") then
arg = nil
-- escape '"' for the defines
-- https://github.com/xmake-io/xmake/issues/1506
elseif arg:find("^-D") then
arg = arg:gsub("\"", "\\\"")
end
-- @see use msvc-style flags for msvc to support language-server better
-- https://github.com/xmake-io/xmake/issues/1284
if is_msvc and arg and arg:startswith("-") then
arg = arg:gsub("^%-", "/")
end
if arg then
table.insert(args, arg)
end
end
return args
end
-- make command
function _make_arguments(jsonfile, arguments, sourcefile)
-- attempt to get source file from arguments
if not sourcefile then
for _, arg in ipairs(arguments) do
local sourcekind = try {function () return language.sourcekind_of(path.filename(arg)) end}
if sourcekind and os.isfile(arg) then
sourcefile = arg
break
end
end
if not sourcefile then
return
end
end
-- translate some unsupported arguments
arguments = _translate_arguments(arguments)
-- escape '"', '\'
local arguments_escape = {}
for _, arg in ipairs(arguments) do
table.insert(arguments_escape, _escape_path(arg))
end
-- make body
jsonfile:printf(
[[%s{
"directory": "%s",
"arguments": ["%s"],
"file": "%s"
}]], (_g.firstline and "" or ",\n"), _escape_path(os.projectdir()), table.concat(arguments_escape, "\", \""), _escape_path(sourcefile))
-- clear first line marks
_g.firstline = false
end
-- make commands for object rules
function _make_commands_for_objectrules(jsonfile, target, sourcebatch, suffix)
-- get rule
local rulename = assert(sourcebatch.rulename, "unknown rule for sourcebatch!")
local ruleinst = assert(project.rule(rulename) or rule.rule(rulename), "unknown rule: %s", rulename)
-- generate commands for xx_buildcmd_files
local scriptname = "buildcmd_files" .. (suffix and ("_" .. suffix) or "")
local script = ruleinst:script(scriptname)
if script then
local batchcmds_ = batchcmds.new({target = target})
script(target, batchcmds_, sourcebatch, {})
if not batchcmds_:empty() then
for _, cmd in ipairs(batchcmds_:cmds()) do
if cmd.program then
_make_arguments(jsonfile, table.join(cmd.program, cmd.argv))
end
end
end
end
-- generate commands for xx_buildcmd_file
if not script then
scriptname = "buildcmd_file" .. (suffix and ("_" .. suffix) or "")
script = ruleinst:script(scriptname)
if script then
local sourcekind = sourcebatch.sourcekind
for _, sourcefile in ipairs(sourcebatch.sourcefiles) do
local batchcmds_ = batchcmds.new({target = target})
script(target, batchcmds_, sourcefile, {})
if not batchcmds_:empty() then
for _, cmd in ipairs(batchcmds_:cmds()) do
if cmd.program then
_make_arguments(jsonfile, table.join(cmd.program, cmd.argv))
end
end
end
end
end
end
end
-- make commands for objects
function _make_commands_for_objects(jsonfile, target, sourcebatch)
local sourcekind = sourcebatch.sourcekind
if sourcekind then
for index, sourcefile in ipairs(sourcebatch.sourcefiles) do
local objectfile = sourcebatch.objectfiles[index]
local arguments = table.join(compiler.compargv(sourcefile, objectfile, {target = target, sourcekind = sourcekind}))
_make_arguments(jsonfile, arguments, sourcefile)
end
return true
end
end
-- make objects
function _make_objects(jsonfile, target, sourcebatch)
_make_commands_for_objectrules(jsonfile, target, sourcebatch, "before")
if not _make_commands_for_objects(jsonfile, target, sourcebatch) then
_make_commands_for_objectrules(jsonfile, target, sourcebatch)
end
_make_commands_for_objectrules(jsonfile, target, sourcebatch, "after")
end
-- make target
function _make_target(jsonfile, target)
-- enter package environments
local oldenvs = os.addenvs(target:pkgenvs())
-- TODO
-- disable precompiled header first
target:set("pcheader", nil)
target:set("pcxxheader", nil)
-- build source batches
for _, sourcebatch in pairs(target:sourcebatches()) do
_make_objects(jsonfile, target, sourcebatch)
end
-- restore package environments
os.setenvs(oldenvs)
end
-- make all
function _make_all(jsonfile)
-- make header
jsonfile:print("[")
-- make commands
_g.firstline = true
for _, target in pairs(project.targets()) do
if not target:is_phony() then
_make_target(jsonfile, target)
end
end
-- make tailer
jsonfile:print("]")
end
-- generate compilation databases for clang-based tools(compile_commands.json)
--
-- references:
-- - https://clang.llvm.org/docs/JSONCompilationDatabase.html
-- - https://sarcasm.github.io/notes/dev/compilation-database.html
-- - http://eli.thegreenplace.net/2014/05/21/compilation-databases-for-clang-based-tools
--
function make(outputdir)
-- enter project directory
local oldir = os.cd(os.projectdir())
-- open the jsonfile
local jsonfile = io.open(path.join(outputdir, "compile_commands.json"), "w")
-- make all
_make_all(jsonfile)
-- close the jsonfile
jsonfile:close()
-- leave project directory
os.cd(oldir)
end
|
