blob: 45d0831b8869f2bf48022d0b4a02072bfb3b9294 [file] [log] [blame]
Daniel Dunbarbf44c3b2010-11-05 07:19:31 +00001//===- CIndexer.h - Clang-C Source Indexing Library -------------*- C++ -*-===//
Ted Kremenekab188932010-01-05 19:32:54 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file defines CIndexer, a subclass of Indexer that provides extra
11// functionality needed by the CIndex library.
12//
13//===----------------------------------------------------------------------===//
14
15#ifndef LLVM_CLANG_CINDEXER_H
16#define LLVM_CLANG_CINDEXER_H
17
18#include "clang-c/Index.h"
Douglas Gregorfc8ea232010-01-26 17:06:03 +000019#include "llvm/ADT/StringRef.h"
Michael J. Spencer03013fa2010-11-29 18:12:39 +000020#include "llvm/Support/Path.h"
Douglas Gregor4db64a42010-01-23 00:14:00 +000021#include <vector>
Ted Kremenekab188932010-01-05 19:32:54 +000022
Daniel Dunbarbf44c3b2010-11-05 07:19:31 +000023namespace llvm {
24 class CrashRecoveryContext;
25}
26
Douglas Gregora030b7c2010-01-22 20:35:53 +000027class CIndexer {
Ted Kremenekab188932010-01-05 19:32:54 +000028 bool OnlyLocalDecls;
Douglas Gregor0a812cf2010-02-18 23:07:20 +000029 bool DisplayDiagnostics;
30
Douglas Gregord1e6fdb2010-10-11 23:17:59 +000031 llvm::sys::Path ResourcesPath;
Argyrios Kyrtzidis389db162010-11-03 22:45:23 +000032 std::string WorkingDir;
33
Ted Kremenekab188932010-01-05 19:32:54 +000034public:
Douglas Gregorb10daed2010-10-11 16:52:23 +000035 CIndexer() : OnlyLocalDecls(false), DisplayDiagnostics(false) { }
Ted Kremenekab188932010-01-05 19:32:54 +000036
Ted Kremenekab188932010-01-05 19:32:54 +000037 /// \brief Whether we only want to see "local" declarations (that did not
38 /// come from a previous precompiled header). If false, we want to see all
39 /// declarations.
40 bool getOnlyLocalDecls() const { return OnlyLocalDecls; }
41 void setOnlyLocalDecls(bool Local = true) { OnlyLocalDecls = Local; }
42
Douglas Gregor0a812cf2010-02-18 23:07:20 +000043 bool getDisplayDiagnostics() const { return DisplayDiagnostics; }
44 void setDisplayDiagnostics(bool Display = true) {
45 DisplayDiagnostics = Display;
46 }
47
Ted Kremenekab188932010-01-05 19:32:54 +000048 /// \brief Get the path of the clang resource files.
49 std::string getClangResourcesPath();
Argyrios Kyrtzidis389db162010-11-03 22:45:23 +000050
51 const std::string &getWorkingDirectory() const { return WorkingDir; }
52 void setWorkingDirectory(const std::string &Dir) { WorkingDir = Dir; }
Ted Kremenekab188932010-01-05 19:32:54 +000053};
54
Douglas Gregor4db64a42010-01-23 00:14:00 +000055namespace clang {
56 /**
57 * \brief Given a set of "unsaved" files, create temporary files and
58 * construct the clang -cc1 argument list needed to perform the remapping.
59 *
60 * \returns true if an error occurred.
61 */
62 bool RemapFiles(unsigned num_unsaved_files,
63 struct CXUnsavedFile *unsaved_files,
64 std::vector<std::string> &RemapArgs,
65 std::vector<llvm::sys::Path> &TemporaryFiles);
Daniel Dunbarbf44c3b2010-11-05 07:19:31 +000066
67 /// \brief Return the current size to request for "safety".
68 unsigned GetSafetyThreadStackSize();
69
70 /// \brief Set the current size to request for "safety" (or 0, if safety
71 /// threads should not be used).
72 void SetSafetyThreadStackSize(unsigned Value);
73
74 /// \brief Execution the given code "safely", using crash recovery or safety
75 /// threads when possible.
76 ///
77 /// \return False if a crash was detected.
78 bool RunSafely(llvm::CrashRecoveryContext &CRC,
Ted Kremenek6c53fdd2010-11-14 17:47:35 +000079 void (*Fn)(void*), void *UserData, unsigned Size = 0);
Douglas Gregor6df78732011-05-05 20:27:22 +000080
81 /// \brief Print libclang's resource usage to standard error.
82 void PrintLibclangResourceUsage(CXTranslationUnit TU);
Douglas Gregor4db64a42010-01-23 00:14:00 +000083}
84
Ted Kremenekab188932010-01-05 19:32:54 +000085#endif