18#include "llvm/ADT/STLExtras.h"
19#include "llvm/ADT/SmallString.h"
20#include "llvm/ADT/SmallVector.h"
21#include "llvm/ADT/StringRef.h"
22#include "llvm/Support/Allocator.h"
23#include "llvm/Support/Casting.h"
24#include "llvm/Support/CommandLine.h"
25#include "llvm/Support/ErrorOr.h"
26#include "llvm/Support/MemoryBuffer.h"
27#include "llvm/Support/Path.h"
28#include "llvm/Support/StringSaver.h"
29#include "llvm/Support/VirtualFileSystem.h"
30#include "llvm/Support/YAMLParser.h"
31#include "llvm/Support/raw_ostream.h"
32#include "llvm/TargetParser/Host.h"
33#include "llvm/TargetParser/Triple.h"
38#include <system_error>
44using namespace tooling;
52class 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) {
137 if (Syntax == JSONCommandLineSyntax::AutoDetect) {
140 Syntax = JSONCommandLineSyntax::Windows;
142 Syntax = JSONCommandLineSyntax::Gnu;
146 if (Syntax == JSONCommandLineSyntax::Windows) {
147 llvm::BumpPtrAllocator Alloc;
148 llvm::StringSaver Saver(Alloc);
150 llvm::cl::TokenizeWindowsCommandLine(EscapedCommandLine, Saver, T);
151 std::vector<std::string> Result(T.begin(), T.end());
154 assert(Syntax == JSONCommandLineSyntax::Gnu);
155 CommandLineArgumentParser parser(EscapedCommandLine);
156 return parser.parse();
162 std::unique_ptr<CompilationDatabase>
165 llvm::sys::path::append(JSONDatabasePath,
"compile_commands.json");
167 JSONDatabasePath, ErrorMessage, JSONCommandLineSyntax::AutoDetect);
170 std::move(
Base), llvm::vfs::getRealFileSystem())))
179static CompilationDatabasePluginRegistry::Add<JSONCompilationDatabasePlugin>
180X(
"json-compilation-database",
"Reads JSON formatted compilation databases");
192std::unique_ptr<JSONCompilationDatabase>
194 std::string &ErrorMessage,
197 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> DatabaseBuffer =
198 llvm::MemoryBuffer::getFile(FilePath,
false,
201 if (std::error_code
Result = DatabaseBuffer.getError()) {
202 ErrorMessage =
"Error while opening JSON database: " +
Result.message();
205 std::unique_ptr<JSONCompilationDatabase> Database(
207 if (!Database->parse(ErrorMessage))
212std::unique_ptr<JSONCompilationDatabase>
214 std::string &ErrorMessage,
216 std::unique_ptr<llvm::MemoryBuffer> DatabaseBuffer(
217 llvm::MemoryBuffer::getMemBufferCopy(DatabaseString));
218 std::unique_ptr<JSONCompilationDatabase> Database(
220 if (!Database->parse(ErrorMessage))
225std::vector<CompileCommand>
228 llvm::sys::path::native(FilePath, NativeFilePath);
231 llvm::raw_string_ostream ES(
Error);
235 const auto CommandsRefI = IndexByFile.find(Match);
236 if (CommandsRefI == IndexByFile.end())
238 std::vector<CompileCommand> Commands;
239 getCommands(CommandsRefI->getValue(), Commands);
243std::vector<std::string>
245 std::vector<std::string>
Result;
246 for (
const auto &CommandRef : IndexByFile)
247 Result.push_back(CommandRef.first().str());
251std::vector<CompileCommand>
253 std::vector<CompileCommand> Commands;
254 getCommands(AllCommands, Commands);
259 Name.consume_back(
".exe");
272 if (Wrapper ==
"distcc" || Wrapper ==
"gomacc" || Wrapper ==
"ccache" ||
273 Wrapper ==
"sccache") {
286 (Args[1][0] !=
'-') &&
289 Args.erase(Args.begin());
297static std::vector<std::string>
299 const std::vector<llvm::yaml::ScalarNode *> &
Nodes) {
301 std::vector<std::string> Arguments;
302 if (
Nodes.size() == 1)
303 Arguments = unescapeCommandLine(Syntax,
Nodes[0]->getValue(Storage));
306 Arguments.push_back(std::string(
Node->getValue(Storage)));
313void JSONCompilationDatabase::getCommands(
315 std::vector<CompileCommand> &Commands)
const {
316 for (
const auto &CommandRef : CommandsRef) {
320 auto Output = std::get<3>(CommandRef);
321 Commands.emplace_back(
322 std::get<0>(CommandRef)->getValue(DirectoryStorage),
323 std::get<1>(CommandRef)->getValue(FilenameStorage),
325 Output ? Output->getValue(OutputStorage) :
"");
329bool JSONCompilationDatabase::parse(std::string &ErrorMessage) {
330 llvm::yaml::document_iterator I = YAMLStream.begin();
331 if (I == YAMLStream.end()) {
332 ErrorMessage =
"Error while parsing YAML.";
335 llvm::yaml::Node *Root = I->getRoot();
337 ErrorMessage =
"Error while parsing YAML.";
340 auto *Array = dyn_cast<llvm::yaml::SequenceNode>(Root);
342 ErrorMessage =
"Expected array.";
345 for (
auto &NextObject : *Array) {
346 auto *
Object = dyn_cast<llvm::yaml::MappingNode>(&NextObject);
348 ErrorMessage =
"Expected object.";
351 llvm::yaml::ScalarNode *Directory =
nullptr;
352 std::optional<std::vector<llvm::yaml::ScalarNode *>> Command;
353 llvm::yaml::ScalarNode *
File =
nullptr;
354 llvm::yaml::ScalarNode *Output =
nullptr;
355 for (
auto& NextKeyValue : *Object) {
356 auto *KeyString = dyn_cast<llvm::yaml::ScalarNode>(NextKeyValue.getKey());
358 ErrorMessage =
"Expected strings as key.";
362 StringRef KeyValue = KeyString->getValue(KeyStorage);
363 llvm::yaml::Node *
Value = NextKeyValue.getValue();
365 ErrorMessage =
"Expected value.";
368 auto *ValueString = dyn_cast<llvm::yaml::ScalarNode>(
Value);
369 auto *SequenceString = dyn_cast<llvm::yaml::SequenceNode>(
Value);
370 if (KeyValue ==
"arguments") {
371 if (!SequenceString) {
372 ErrorMessage =
"Expected sequence as value.";
375 Command = std::vector<llvm::yaml::ScalarNode *>();
376 for (
auto &Argument : *SequenceString) {
377 auto *
Scalar = dyn_cast<llvm::yaml::ScalarNode>(&Argument);
379 ErrorMessage =
"Only strings are allowed in 'arguments'.";
382 Command->push_back(Scalar);
386 ErrorMessage =
"Expected string as value.";
389 if (KeyValue ==
"directory") {
390 Directory = ValueString;
391 }
else if (KeyValue ==
"command") {
393 Command = std::vector<llvm::yaml::ScalarNode *>(1, ValueString);
394 }
else if (KeyValue ==
"file") {
396 }
else if (KeyValue ==
"output") {
397 Output = ValueString;
400 (
"Unknown key: \"" + KeyString->getRawValue() +
"\"").str();
406 ErrorMessage =
"Missing key: \"file\".";
410 ErrorMessage =
"Missing key: \"command\" or \"arguments\".";
414 ErrorMessage =
"Missing key: \"directory\".";
418 StringRef FileName =
File->getValue(FileStorage);
420 if (llvm::sys::path::is_relative(FileName)) {
423 llvm::sys::path::append(AbsolutePath, FileName);
424 llvm::sys::path::native(AbsolutePath, NativeFilePath);
426 llvm::sys::path::native(FileName, NativeFilePath);
428 llvm::sys::path::remove_dots(NativeFilePath,
true);
429 auto Cmd = CompileCommandRef(Directory,
File, *Command, Output);
430 IndexByFile[NativeFilePath].push_back(
Cmd);
431 AllCommands.push_back(
Cmd);
432 MatchTrie.
insert(NativeFilePath);
BoundNodesTreeBuilder Nodes
static std::vector< std::string > nodeToCommandLine(JSONCommandLineSyntax Syntax, const std::vector< llvm::yaml::ScalarNode * > &Nodes)
static bool unwrapCommand(std::vector< std::string > &Args)
static llvm::StringRef stripExecutableExtension(llvm::StringRef Name)
Forward-declares and imports various common LLVM datatypes that clang wants to use unqualified.
@ Result
The result type of a method or function.