aboutsummaryrefslogtreecommitdiff
path: root/lib/Tooling/CustomCompilationDatabase.h
diff options
context:
space:
mode:
authorDaniel Jasper <djasper@google.com>2012-07-11 19:13:13 +0000
committerDaniel Jasper <djasper@google.com>2012-07-11 19:13:13 +0000
commit068040ede2b2e6449d84273cc16e62fcd5e7e541 (patch)
treecbedd00519fe4f46f9d9dda77852a23f09905877 /lib/Tooling/CustomCompilationDatabase.h
parent0337efdba2b9477c2655cbb176d59c492a823aa4 (diff)
Add a hook to supply a custom CompilationDatabase. To add a custom CompilationDatabase, make it implement findCompilationDatabaseForDirectory in CustomCompilationDatabase.h and set USE_COSTUM_COMPILATION_DATABASE.
Differential Revision: http://llvm-reviews.chandlerc.com/D4 git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@160061 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'lib/Tooling/CustomCompilationDatabase.h')
-rw-r--r--lib/Tooling/CustomCompilationDatabase.h37
1 files changed, 37 insertions, 0 deletions
diff --git a/lib/Tooling/CustomCompilationDatabase.h b/lib/Tooling/CustomCompilationDatabase.h
new file mode 100644
index 0000000000..a24915a08f
--- /dev/null
+++ b/lib/Tooling/CustomCompilationDatabase.h
@@ -0,0 +1,37 @@
+//===--- CustomCompilationDatabase.h --------------------------------------===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+//
+// This file contains a hook to supply a custom \c CompilationDatabase
+// implementation.
+//
+// The mechanism can be used by IDEs or non-public code bases to integrate with
+// their build system. Currently we support statically linking in an
+// implementation of \c findCompilationDatabaseForDirectory and enabling it
+// with -DUSE_CUSTOM_COMPILATION_DATABASE when compiling the Tooling library.
+//
+// FIXME: The strategy forward is to provide a plugin system that can load
+// custom compilation databases and make enabling that a build option.
+//
+//===----------------------------------------------------------------------===//
+
+#include "llvm/ADT/StringRef.h"
+
+namespace clang {
+namespace tooling {
+class CompilationDatabase;
+}
+}
+
+/// \brief Returns a CompilationDatabase for the given \c Directory.
+///
+/// \c Directory can be any directory within a project. This methods will
+/// then try to find compilation database files in \c Directory or any of its
+/// parents. If a compilation database cannot be found or loaded, returns NULL.
+clang::tooling::CompilationDatabase *findCompilationDatabaseForDirectory(
+ llvm::StringRef Directory);