CIndexer.h revision bf44c3b099602c9c967f1b20995919fb4ef39a51
1bf44c3b099602c9c967f1b20995919fb4ef39a51Daniel Dunbar//===- CIndexer.h - Clang-C Source Indexing Library -------------*- C++ -*-===// 2ab1889321f6f8f200f2b318ac26883ac18e49d03Ted Kremenek// 3ab1889321f6f8f200f2b318ac26883ac18e49d03Ted Kremenek// The LLVM Compiler Infrastructure 4ab1889321f6f8f200f2b318ac26883ac18e49d03Ted Kremenek// 5ab1889321f6f8f200f2b318ac26883ac18e49d03Ted Kremenek// This file is distributed under the University of Illinois Open Source 6ab1889321f6f8f200f2b318ac26883ac18e49d03Ted Kremenek// License. See LICENSE.TXT for details. 7ab1889321f6f8f200f2b318ac26883ac18e49d03Ted Kremenek// 8ab1889321f6f8f200f2b318ac26883ac18e49d03Ted Kremenek//===----------------------------------------------------------------------===// 9ab1889321f6f8f200f2b318ac26883ac18e49d03Ted Kremenek// 10ab1889321f6f8f200f2b318ac26883ac18e49d03Ted Kremenek// This file defines CIndexer, a subclass of Indexer that provides extra 11ab1889321f6f8f200f2b318ac26883ac18e49d03Ted Kremenek// functionality needed by the CIndex library. 12ab1889321f6f8f200f2b318ac26883ac18e49d03Ted Kremenek// 13ab1889321f6f8f200f2b318ac26883ac18e49d03Ted Kremenek//===----------------------------------------------------------------------===// 14ab1889321f6f8f200f2b318ac26883ac18e49d03Ted Kremenek 15ab1889321f6f8f200f2b318ac26883ac18e49d03Ted Kremenek#ifndef LLVM_CLANG_CINDEXER_H 16ab1889321f6f8f200f2b318ac26883ac18e49d03Ted Kremenek#define LLVM_CLANG_CINDEXER_H 17ab1889321f6f8f200f2b318ac26883ac18e49d03Ted Kremenek 18ab1889321f6f8f200f2b318ac26883ac18e49d03Ted Kremenek#include "clang-c/Index.h" 19fc8ea23eb6cbaaa5046f2abb4c033e24c8659efdDouglas Gregor#include "llvm/ADT/StringRef.h" 20ab1889321f6f8f200f2b318ac26883ac18e49d03Ted Kremenek#include "llvm/System/Path.h" 214db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor#include <vector> 22ab1889321f6f8f200f2b318ac26883ac18e49d03Ted Kremenek 23bf44c3b099602c9c967f1b20995919fb4ef39a51Daniel Dunbarnamespace llvm { 24bf44c3b099602c9c967f1b20995919fb4ef39a51Daniel Dunbar class CrashRecoveryContext; 25bf44c3b099602c9c967f1b20995919fb4ef39a51Daniel Dunbar} 26bf44c3b099602c9c967f1b20995919fb4ef39a51Daniel Dunbar 27ee4db4fccbcab7e6bd614fe8757c5453e7ad0e86Ted Kremeneknamespace clang { 28ee4db4fccbcab7e6bd614fe8757c5453e7ad0e86Ted Kremeneknamespace cxstring { 29ee4db4fccbcab7e6bd614fe8757c5453e7ad0e86Ted Kremenek CXString createCXString(const char *String, bool DupString = false); 30ee4db4fccbcab7e6bd614fe8757c5453e7ad0e86Ted Kremenek CXString createCXString(llvm::StringRef String, bool DupString = true); 31ee4db4fccbcab7e6bd614fe8757c5453e7ad0e86Ted Kremenek} 32ee4db4fccbcab7e6bd614fe8757c5453e7ad0e86Ted Kremenek} 33ee4db4fccbcab7e6bd614fe8757c5453e7ad0e86Ted Kremenek 34a030b7cf5e6aad5889b1b662b6979840bc75f87fDouglas Gregorclass CIndexer { 35ab1889321f6f8f200f2b318ac26883ac18e49d03Ted Kremenek bool OnlyLocalDecls; 360a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor bool DisplayDiagnostics; 370a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 38d1e6fdb4c5325c61fedfa62751f70ee373880a52Douglas Gregor llvm::sys::Path ResourcesPath; 39389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis std::string WorkingDir; 40389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 41ab1889321f6f8f200f2b318ac26883ac18e49d03Ted Kremenekpublic: 42b10daedb8fc4c6f70a66dbc1a6eea01684bb4e77Douglas Gregor CIndexer() : OnlyLocalDecls(false), DisplayDiagnostics(false) { } 43ab1889321f6f8f200f2b318ac26883ac18e49d03Ted Kremenek 44ab1889321f6f8f200f2b318ac26883ac18e49d03Ted Kremenek /// \brief Whether we only want to see "local" declarations (that did not 45ab1889321f6f8f200f2b318ac26883ac18e49d03Ted Kremenek /// come from a previous precompiled header). If false, we want to see all 46ab1889321f6f8f200f2b318ac26883ac18e49d03Ted Kremenek /// declarations. 47ab1889321f6f8f200f2b318ac26883ac18e49d03Ted Kremenek bool getOnlyLocalDecls() const { return OnlyLocalDecls; } 48ab1889321f6f8f200f2b318ac26883ac18e49d03Ted Kremenek void setOnlyLocalDecls(bool Local = true) { OnlyLocalDecls = Local; } 49ab1889321f6f8f200f2b318ac26883ac18e49d03Ted Kremenek 500a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor bool getDisplayDiagnostics() const { return DisplayDiagnostics; } 510a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor void setDisplayDiagnostics(bool Display = true) { 520a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor DisplayDiagnostics = Display; 530a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor } 540a812cf707da15dadd19fdeb0178b9707f4e01a6Douglas Gregor 55ab1889321f6f8f200f2b318ac26883ac18e49d03Ted Kremenek /// \brief Get the path of the clang resource files. 56ab1889321f6f8f200f2b318ac26883ac18e49d03Ted Kremenek std::string getClangResourcesPath(); 57389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 58389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis const std::string &getWorkingDirectory() const { return WorkingDir; } 59389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis void setWorkingDirectory(const std::string &Dir) { WorkingDir = Dir; } 60ab1889321f6f8f200f2b318ac26883ac18e49d03Ted Kremenek}; 61ab1889321f6f8f200f2b318ac26883ac18e49d03Ted Kremenek 624db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregornamespace clang { 634db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor /** 644db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor * \brief Given a set of "unsaved" files, create temporary files and 654db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor * construct the clang -cc1 argument list needed to perform the remapping. 664db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor * 674db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor * \returns true if an error occurred. 684db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor */ 694db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor bool RemapFiles(unsigned num_unsaved_files, 704db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor struct CXUnsavedFile *unsaved_files, 714db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor std::vector<std::string> &RemapArgs, 724db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor std::vector<llvm::sys::Path> &TemporaryFiles); 73bf44c3b099602c9c967f1b20995919fb4ef39a51Daniel Dunbar 74bf44c3b099602c9c967f1b20995919fb4ef39a51Daniel Dunbar /// \brief Return the current size to request for "safety". 75bf44c3b099602c9c967f1b20995919fb4ef39a51Daniel Dunbar unsigned GetSafetyThreadStackSize(); 76bf44c3b099602c9c967f1b20995919fb4ef39a51Daniel Dunbar 77bf44c3b099602c9c967f1b20995919fb4ef39a51Daniel Dunbar /// \brief Set the current size to request for "safety" (or 0, if safety 78bf44c3b099602c9c967f1b20995919fb4ef39a51Daniel Dunbar /// threads should not be used). 79bf44c3b099602c9c967f1b20995919fb4ef39a51Daniel Dunbar void SetSafetyThreadStackSize(unsigned Value); 80bf44c3b099602c9c967f1b20995919fb4ef39a51Daniel Dunbar 81bf44c3b099602c9c967f1b20995919fb4ef39a51Daniel Dunbar /// \brief Execution the given code "safely", using crash recovery or safety 82bf44c3b099602c9c967f1b20995919fb4ef39a51Daniel Dunbar /// threads when possible. 83bf44c3b099602c9c967f1b20995919fb4ef39a51Daniel Dunbar /// 84bf44c3b099602c9c967f1b20995919fb4ef39a51Daniel Dunbar /// \return False if a crash was detected. 85bf44c3b099602c9c967f1b20995919fb4ef39a51Daniel Dunbar bool RunSafely(llvm::CrashRecoveryContext &CRC, 86bf44c3b099602c9c967f1b20995919fb4ef39a51Daniel Dunbar void (*Fn)(void*), void *UserData); 874db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor} 884db64a461cb3442934afe43c83ed3f17f7c11c1dDouglas Gregor 89ab1889321f6f8f200f2b318ac26883ac18e49d03Ted Kremenek#endif 90