18 #include "llvm/ADT/Optional.h"
19 #include "llvm/ADT/STLExtras.h"
20 #include "llvm/ADT/SmallString.h"
21 #include "llvm/ADT/SmallVector.h"
22 #include "llvm/ADT/StringRef.h"
23 #include "llvm/ADT/Triple.h"
24 #include "llvm/Support/Allocator.h"
25 #include "llvm/Support/Casting.h"
26 #include "llvm/Support/CommandLine.h"
27 #include "llvm/Support/ErrorOr.h"
28 #include "llvm/Support/Host.h"
29 #include "llvm/Support/MemoryBuffer.h"
30 #include "llvm/Support/Path.h"
31 #include "llvm/Support/StringSaver.h"
32 #include "llvm/Support/VirtualFileSystem.h"
33 #include "llvm/Support/YAMLParser.h"
34 #include "llvm/Support/raw_ostream.h"
38 #include <system_error>
43 using namespace clang;
44 using namespace tooling;
52 class CommandLineArgumentParser {
54 CommandLineArgumentParser(StringRef CommandLine)
55 : Input(CommandLine), Position(Input.begin()-1) {}
57 std::vector<std::string> parse() {
58 bool HasMoreInput =
true;
59 while (HasMoreInput && nextNonWhitespace()) {
61 HasMoreInput = parseStringInto(Argument);
62 CommandLine.push_back(Argument);
70 bool parseStringInto(std::string &String) {
72 if (*Position ==
'"') {
73 if (!parseDoubleQuotedStringInto(String))
return false;
74 }
else if (*Position ==
'\'') {
75 if (!parseSingleQuotedStringInto(String))
return false;
77 if (!parseFreeStringInto(String))
return false;
79 }
while (*Position !=
' ');
83 bool parseDoubleQuotedStringInto(std::string &String) {
84 if (!next())
return false;
85 while (*Position !=
'"') {
86 if (!skipEscapeCharacter())
return false;
87 String.push_back(*Position);
88 if (!next())
return false;
93 bool parseSingleQuotedStringInto(std::string &String) {
94 if (!next())
return false;
95 while (*Position !=
'\'') {
96 String.push_back(*Position);
97 if (!next())
return false;
102 bool parseFreeStringInto(std::string &String) {
104 if (!skipEscapeCharacter())
return false;
105 String.push_back(*Position);
106 if (!next())
return false;
107 }
while (*Position !=
' ' && *Position !=
'"' && *Position !=
'\'');
111 bool skipEscapeCharacter() {
112 if (*Position ==
'\\') {
118 bool nextNonWhitespace() {
120 if (!next())
return false;
121 }
while (*Position ==
' ');
127 return Position != Input.end();
130 const StringRef Input;
131 StringRef::iterator Position;
132 std::vector<std::string> CommandLine;
136 StringRef EscapedCommandLine) {
139 llvm::Triple Triple(llvm::sys::getProcessTriple());
140 if (Triple.getOS() == llvm::Triple::OSType::Win32) {
143 if (!Triple.hasEnvironment() ||
144 Triple.getEnvironment() == llvm::Triple::EnvironmentType::MSVC)
150 llvm::BumpPtrAllocator Alloc;
151 llvm::StringSaver Saver(Alloc);
153 llvm::cl::TokenizeWindowsCommandLine(EscapedCommandLine, Saver, T);
154 std::vector<std::string> Result(T.begin(), T.end());
158 CommandLineArgumentParser parser(EscapedCommandLine);
159 return parser.parse();
164 class JSONCompilationDatabasePlugin :
public CompilationDatabasePlugin {
165 std::unique_ptr<CompilationDatabase>
166 loadFromDirectory(StringRef Directory, std::string &ErrorMessage)
override {
168 llvm::sys::path::append(JSONDatabasePath,
"compile_commands.json");
173 std::move(
Base), llvm::vfs::getRealFileSystem())))
182 static CompilationDatabasePluginRegistry::Add<JSONCompilationDatabasePlugin>
183 X(
"json-compilation-database",
"Reads JSON formatted compilation databases");
195 std::unique_ptr<JSONCompilationDatabase>
197 std::string &ErrorMessage,
200 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> DatabaseBuffer =
201 llvm::MemoryBuffer::getFile(FilePath, -1,
204 if (std::error_code Result = DatabaseBuffer.getError()) {
205 ErrorMessage =
"Error while opening JSON database: " + Result.message();
208 std::unique_ptr<JSONCompilationDatabase> Database(
210 if (!Database->parse(ErrorMessage))
215 std::unique_ptr<JSONCompilationDatabase>
217 std::string &ErrorMessage,
219 std::unique_ptr<llvm::MemoryBuffer> DatabaseBuffer(
220 llvm::MemoryBuffer::getMemBufferCopy(DatabaseString));
221 std::unique_ptr<JSONCompilationDatabase> Database(
223 if (!Database->parse(ErrorMessage))
228 std::vector<CompileCommand>
231 llvm::sys::path::native(FilePath, NativeFilePath);
234 llvm::raw_string_ostream ES(
Error);
238 const auto CommandsRefI = IndexByFile.find(Match);
239 if (CommandsRefI == IndexByFile.end())
241 std::vector<CompileCommand> Commands;
242 getCommands(CommandsRefI->getValue(), Commands);
246 std::vector<std::string>
248 std::vector<std::string> Result;
249 for (
const auto &CommandRef : IndexByFile)
250 Result.push_back(CommandRef.first().str());
254 std::vector<CompileCommand>
256 std::vector<CompileCommand> Commands;
257 getCommands(AllCommands, Commands);
262 Name.consume_back(
".exe");
275 if (Wrapper ==
"distcc" || Wrapper ==
"gomacc" || Wrapper ==
"ccache" ||
276 Wrapper ==
"sccache") {
289 (Args[1][0] !=
'-') &&
292 Args.erase(Args.begin());
300 static std::vector<std::string>
302 const std::vector<llvm::yaml::ScalarNode *> &
Nodes) {
304 std::vector<std::string> Arguments;
305 if (
Nodes.size() == 1)
306 Arguments = unescapeCommandLine(Syntax,
Nodes[0]->
getValue(Storage));
309 Arguments.push_back(std::string(
Node->getValue(Storage)));
316 void JSONCompilationDatabase::getCommands(
318 std::vector<CompileCommand> &Commands)
const {
319 for (
const auto &CommandRef : CommandsRef) {
323 auto Output = std::get<3>(CommandRef);
324 Commands.emplace_back(
325 std::get<0>(CommandRef)->
getValue(DirectoryStorage),
326 std::get<1>(CommandRef)->
getValue(FilenameStorage),
328 Output ? Output->getValue(OutputStorage) :
"");
332 bool JSONCompilationDatabase::parse(std::string &ErrorMessage) {
333 llvm::yaml::document_iterator I = YAMLStream.begin();
334 if (I == YAMLStream.end()) {
335 ErrorMessage =
"Error while parsing YAML.";
340 ErrorMessage =
"Error while parsing YAML.";
343 auto *Array = dyn_cast<llvm::yaml::SequenceNode>(Root);
345 ErrorMessage =
"Expected array.";
348 for (
auto &NextObject : *Array) {
349 auto *
Object = dyn_cast<llvm::yaml::MappingNode>(&NextObject);
351 ErrorMessage =
"Expected object.";
354 llvm::yaml::ScalarNode *Directory =
nullptr;
356 llvm::yaml::ScalarNode *
File =
nullptr;
357 llvm::yaml::ScalarNode *Output =
nullptr;
358 for (
auto& NextKeyValue : *Object) {
359 auto *KeyString = dyn_cast<llvm::yaml::ScalarNode>(NextKeyValue.getKey());
361 ErrorMessage =
"Expected strings as key.";
365 StringRef KeyValue = KeyString->getValue(KeyStorage);
368 ErrorMessage =
"Expected value.";
371 auto *ValueString = dyn_cast<llvm::yaml::ScalarNode>(
Value);
372 auto *SequenceString = dyn_cast<llvm::yaml::SequenceNode>(
Value);
373 if (KeyValue ==
"arguments") {
374 if (!SequenceString) {
375 ErrorMessage =
"Expected sequence as value.";
378 Command = std::vector<llvm::yaml::ScalarNode *>();
379 for (
auto &Argument : *SequenceString) {
380 auto *Scalar = dyn_cast<llvm::yaml::ScalarNode>(&Argument);
382 ErrorMessage =
"Only strings are allowed in 'arguments'.";
385 Command->push_back(Scalar);
389 ErrorMessage =
"Expected string as value.";
392 if (KeyValue ==
"directory") {
393 Directory = ValueString;
394 }
else if (KeyValue ==
"command") {
396 Command = std::vector<llvm::yaml::ScalarNode *>(1, ValueString);
397 }
else if (KeyValue ==
"file") {
399 }
else if (KeyValue ==
"output") {
400 Output = ValueString;
403 (
"Unknown key: \"" + KeyString->getRawValue() +
"\"").str();
409 ErrorMessage =
"Missing key: \"file\".";
413 ErrorMessage =
"Missing key: \"command\" or \"arguments\".";
417 ErrorMessage =
"Missing key: \"directory\".";
421 StringRef FileName =
File->getValue(FileStorage);
423 if (llvm::sys::path::is_relative(FileName)) {
426 Directory->getValue(DirectoryStorage));
427 llvm::sys::path::append(AbsolutePath, FileName);
428 llvm::sys::path::remove_dots(AbsolutePath,
true);
429 llvm::sys::path::native(AbsolutePath, NativeFilePath);
431 llvm::sys::path::native(FileName, NativeFilePath);
433 auto Cmd = CompileCommandRef(Directory, File, *Command, Output);
434 IndexByFile[NativeFilePath].push_back(
Cmd);
435 AllCommands.push_back(
Cmd);
436 MatchTrie.
insert(NativeFilePath);