1 //===--- JSONCompilationDatabase.cpp - ------------------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file contains the implementation of the JSONCompilationDatabase.
12 //===----------------------------------------------------------------------===//
14 #include "clang/Tooling/JSONCompilationDatabase.h"
16 #include "clang/Tooling/CompilationDatabase.h"
17 #include "clang/Tooling/CompilationDatabasePluginRegistry.h"
18 #include "clang/Tooling/Tooling.h"
19 #include "llvm/ADT/SmallString.h"
20 #include "llvm/Support/Path.h"
21 #include "llvm/Support/system_error.h"
28 /// \brief A parser for escaped strings of command line arguments.
30 /// Assumes \-escaping for quoted arguments (see the documentation of
31 /// unescapeCommandLine(...)).
32 class CommandLineArgumentParser {
34 CommandLineArgumentParser(StringRef CommandLine)
35 : Input(CommandLine), Position(Input.begin()-1) {}
37 std::vector<std::string> parse() {
38 bool HasMoreInput = true;
39 while (HasMoreInput && nextNonWhitespace()) {
41 HasMoreInput = parseStringInto(Argument);
42 CommandLine.push_back(Argument);
48 // All private methods return true if there is more input available.
50 bool parseStringInto(std::string &String) {
52 if (*Position == '"') {
53 if (!parseQuotedStringInto(String)) return false;
55 if (!parseFreeStringInto(String)) return false;
57 } while (*Position != ' ');
61 bool parseQuotedStringInto(std::string &String) {
62 if (!next()) return false;
63 while (*Position != '"') {
64 if (!skipEscapeCharacter()) return false;
65 String.push_back(*Position);
66 if (!next()) return false;
71 bool parseFreeStringInto(std::string &String) {
73 if (!skipEscapeCharacter()) return false;
74 String.push_back(*Position);
75 if (!next()) return false;
76 } while (*Position != ' ' && *Position != '"');
80 bool skipEscapeCharacter() {
81 if (*Position == '\\') {
87 bool nextNonWhitespace() {
89 if (!next()) return false;
90 } while (*Position == ' ');
96 return Position != Input.end();
99 const StringRef Input;
100 StringRef::iterator Position;
101 std::vector<std::string> CommandLine;
104 std::vector<std::string> unescapeCommandLine(
105 StringRef EscapedCommandLine) {
106 CommandLineArgumentParser parser(EscapedCommandLine);
107 return parser.parse();
112 class JSONCompilationDatabasePlugin : public CompilationDatabasePlugin {
113 virtual CompilationDatabase *loadFromDirectory(
114 StringRef Directory, std::string &ErrorMessage) {
115 llvm::SmallString<1024> JSONDatabasePath(Directory);
116 llvm::sys::path::append(JSONDatabasePath, "compile_commands.json");
117 llvm::OwningPtr<CompilationDatabase> Database(
118 JSONCompilationDatabase::loadFromFile(JSONDatabasePath, ErrorMessage));
121 return Database.take();
125 // Register the JSONCompilationDatabasePlugin with the
126 // CompilationDatabasePluginRegistry using this statically initialized variable.
127 static CompilationDatabasePluginRegistry::Add<JSONCompilationDatabasePlugin>
128 X("json-compilation-database", "Reads JSON formatted compilation databases");
130 // This anchor is used to force the linker to link in the generated object file
131 // and thus register the JSONCompilationDatabasePlugin.
132 volatile int JSONAnchorSource = 0;
134 JSONCompilationDatabase *
135 JSONCompilationDatabase::loadFromFile(StringRef FilePath,
136 std::string &ErrorMessage) {
137 llvm::OwningPtr<llvm::MemoryBuffer> DatabaseBuffer;
138 llvm::error_code Result =
139 llvm::MemoryBuffer::getFile(FilePath, DatabaseBuffer);
141 ErrorMessage = "Error while opening JSON database: " + Result.message();
144 llvm::OwningPtr<JSONCompilationDatabase> Database(
145 new JSONCompilationDatabase(DatabaseBuffer.take()));
146 if (!Database->parse(ErrorMessage))
148 return Database.take();
151 JSONCompilationDatabase *
152 JSONCompilationDatabase::loadFromBuffer(StringRef DatabaseString,
153 std::string &ErrorMessage) {
154 llvm::OwningPtr<llvm::MemoryBuffer> DatabaseBuffer(
155 llvm::MemoryBuffer::getMemBuffer(DatabaseString));
156 llvm::OwningPtr<JSONCompilationDatabase> Database(
157 new JSONCompilationDatabase(DatabaseBuffer.take()));
158 if (!Database->parse(ErrorMessage))
160 return Database.take();
163 std::vector<CompileCommand>
164 JSONCompilationDatabase::getCompileCommands(StringRef FilePath) const {
165 llvm::SmallString<128> NativeFilePath;
166 llvm::sys::path::native(FilePath, NativeFilePath);
167 std::vector<StringRef> PossibleMatches;
169 llvm::raw_string_ostream ES(Error);
170 StringRef Match = MatchTrie.findEquivalent(NativeFilePath.str(), ES);
173 Error = "No match found.";
174 llvm::outs() << Error << "\n";
175 return std::vector<CompileCommand>();
177 llvm::StringMap< std::vector<CompileCommandRef> >::const_iterator
178 CommandsRefI = IndexByFile.find(Match);
179 if (CommandsRefI == IndexByFile.end())
180 return std::vector<CompileCommand>();
181 const std::vector<CompileCommandRef> &CommandsRef = CommandsRefI->getValue();
182 std::vector<CompileCommand> Commands;
183 for (int I = 0, E = CommandsRef.size(); I != E; ++I) {
184 llvm::SmallString<8> DirectoryStorage;
185 llvm::SmallString<1024> CommandStorage;
186 Commands.push_back(CompileCommand(
187 // FIXME: Escape correctly:
188 CommandsRef[I].first->getValue(DirectoryStorage),
189 unescapeCommandLine(CommandsRef[I].second->getValue(CommandStorage))));
194 std::vector<std::string>
195 JSONCompilationDatabase::getAllFiles() const {
196 std::vector<std::string> Result;
198 llvm::StringMap< std::vector<CompileCommandRef> >::const_iterator
199 CommandsRefI = IndexByFile.begin();
200 const llvm::StringMap< std::vector<CompileCommandRef> >::const_iterator
201 CommandsRefEnd = IndexByFile.end();
202 for (; CommandsRefI != CommandsRefEnd; ++CommandsRefI) {
203 Result.push_back(CommandsRefI->first().str());
209 bool JSONCompilationDatabase::parse(std::string &ErrorMessage) {
210 llvm::yaml::document_iterator I = YAMLStream.begin();
211 if (I == YAMLStream.end()) {
212 ErrorMessage = "Error while parsing YAML.";
215 llvm::yaml::Node *Root = I->getRoot();
217 ErrorMessage = "Error while parsing YAML.";
220 llvm::yaml::SequenceNode *Array =
221 llvm::dyn_cast<llvm::yaml::SequenceNode>(Root);
223 ErrorMessage = "Expected array.";
226 for (llvm::yaml::SequenceNode::iterator AI = Array->begin(),
229 llvm::yaml::MappingNode *Object =
230 llvm::dyn_cast<llvm::yaml::MappingNode>(&*AI);
231 if (Object == NULL) {
232 ErrorMessage = "Expected object.";
235 llvm::yaml::ScalarNode *Directory = NULL;
236 llvm::yaml::ScalarNode *Command = NULL;
237 llvm::yaml::ScalarNode *File = NULL;
238 for (llvm::yaml::MappingNode::iterator KVI = Object->begin(),
241 llvm::yaml::Node *Value = (*KVI).getValue();
243 ErrorMessage = "Expected value.";
246 llvm::yaml::ScalarNode *ValueString =
247 llvm::dyn_cast<llvm::yaml::ScalarNode>(Value);
248 if (ValueString == NULL) {
249 ErrorMessage = "Expected string as value.";
252 llvm::yaml::ScalarNode *KeyString =
253 llvm::dyn_cast<llvm::yaml::ScalarNode>((*KVI).getKey());
254 if (KeyString == NULL) {
255 ErrorMessage = "Expected strings as key.";
258 llvm::SmallString<8> KeyStorage;
259 if (KeyString->getValue(KeyStorage) == "directory") {
260 Directory = ValueString;
261 } else if (KeyString->getValue(KeyStorage) == "command") {
262 Command = ValueString;
263 } else if (KeyString->getValue(KeyStorage) == "file") {
266 ErrorMessage = ("Unknown key: \"" +
267 KeyString->getRawValue() + "\"").str();
272 ErrorMessage = "Missing key: \"file\".";
276 ErrorMessage = "Missing key: \"command\".";
280 ErrorMessage = "Missing key: \"directory\".";
283 llvm::SmallString<8> FileStorage;
284 StringRef FileName = File->getValue(FileStorage);
285 llvm::SmallString<128> NativeFilePath;
286 if (llvm::sys::path::is_relative(FileName)) {
287 llvm::SmallString<8> DirectoryStorage;
288 llvm::SmallString<128> AbsolutePath(
289 Directory->getValue(DirectoryStorage));
290 llvm::sys::path::append(AbsolutePath, FileName);
291 llvm::sys::path::native(AbsolutePath.str(), NativeFilePath);
293 llvm::sys::path::native(FileName, NativeFilePath);
295 IndexByFile[NativeFilePath].push_back(
296 CompileCommandRef(Directory, Command));
297 MatchTrie.insert(NativeFilePath.str());
302 } // end namespace tooling
303 } // end namespace clang