ModuleManager.h revision d3cf5fba332fc77f7e72ef58077822606718671d
198339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor//===--- ModuleManager.cpp - Module Manager ---------------------*- C++ -*-===// 298339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor// 398339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor// The LLVM Compiler Infrastructure 498339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor// 598339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor// This file is distributed under the University of Illinois Open Source 698339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor// License. See LICENSE.TXT for details. 798339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor// 898339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor//===----------------------------------------------------------------------===// 998339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor// 1098339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor// This file defines the ModuleManager class, which manages a set of loaded 1198339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor// modules for the ASTReader. 1298339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor// 1398339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor//===----------------------------------------------------------------------===// 1498339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor 1598339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor#ifndef LLVM_CLANG_SERIALIZATION_MODULE_MANAGER_H 1698339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor#define LLVM_CLANG_SERIALIZATION_MODULE_MANAGER_H 1798339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor 1898339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor#include "clang/Basic/FileManager.h" 1930a2e16f6c27f888dd11eba6bbbae1e980078fcbChandler Carruth#include "clang/Serialization/Module.h" 2098339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor#include "llvm/ADT/DenseMap.h" 2198339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor 2298339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregornamespace clang { 2398339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor 24188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregorclass GlobalModuleIndex; 25188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor 2698339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregornamespace serialization { 2798339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor 2898339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor/// \brief Manages the set of modules loaded by an AST reader. 2998339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregorclass ModuleManager { 3098339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// \brief The chain of AST files. The first entry is the one named by the 3198339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// user, the last one is the one that doesn't depend on anything further. 32cfa88f893915ceb8ae4ce2f17c46c24a4d67502fDmitri Gribenko SmallVector<ModuleFile *, 2> Chain; 3398339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor 3498339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// \brief All loaded modules, indexed by name. 351a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor llvm::DenseMap<const FileEntry *, ModuleFile *> Modules; 3698339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor 3798339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// \brief FileManager that handles translating between filenames and 3898339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// FileEntry *. 39d64c26f6676eef69d1713f353ca8a3c2fe963f17Argyrios Kyrtzidis FileManager &FileMgr; 4098339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor 4198339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// \brief A lookup of in-memory (virtual file) buffers 4298339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor llvm::DenseMap<const FileEntry *, llvm::MemoryBuffer *> InMemoryBuffers; 43d07865b42dcb32154c75134fded51b38cc55a0c4Douglas Gregor 44d07865b42dcb32154c75134fded51b38cc55a0c4Douglas Gregor /// \brief The visitation order. 45d07865b42dcb32154c75134fded51b38cc55a0c4Douglas Gregor SmallVector<ModuleFile *, 4> VisitOrder; 46d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor 47188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor /// \brief The list of module files that both we and the global module index 48188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor /// know about. 49188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor /// 50188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor /// Either the global index or the module manager may have modules that the 51188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor /// other does not know about, because the global index can be out-of-date 52188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor /// (in which case the module manager could have modules it does not) and 53188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor /// this particular translation unit might not have loaded all of the modules 54188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor /// known to the global index. 55188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor SmallVector<ModuleFile *, 4> ModulesInCommonWithGlobalIndex; 56188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor 57188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor /// \brief The global module index, if one is attached. 58188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor /// 59188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor /// The global module index will actually be owned by the ASTReader; this is 60188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor /// just an non-owning pointer. 61188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor GlobalModuleIndex *GlobalIndex; 62188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor 63188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor /// \brief Update the set of modules files we know about known to the global index. 64188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor void updateModulesInCommonWithGlobalIndex(); 65188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor 66d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor /// \brief State used by the "visit" operation to avoid malloc traffic in 67d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor /// calls to visit(). 68d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor struct VisitState { 69d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor explicit VisitState(unsigned N) 70d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor : VisitNumber(N, 0), NextVisitNumber(1), NextState(0) 71d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor { 72d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor Stack.reserve(N); 73d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor } 74d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor 75d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor ~VisitState() { 76d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor delete NextState; 77d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor } 78d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor 79d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor /// \brief The stack used when marking the imports of a particular module 80d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor /// as not-to-be-visited. 81d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor SmallVector<ModuleFile *, 4> Stack; 82d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor 83d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor /// \brief The visit number of each module file, which indicates when 84d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor /// this module file was last visited. 85d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor SmallVector<unsigned, 4> VisitNumber; 86d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor 87d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor /// \brief The next visit number to use to mark visited module files. 88d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor unsigned NextVisitNumber; 89d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor 90d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor /// \brief The next visit state. 91d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor VisitState *NextState; 92d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor }; 93d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor 94d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor /// \brief The first visit() state in the chain. 95d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor VisitState *FirstVisitState; 96d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor 97d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor VisitState *allocateVisitState(); 98d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor void returnVisitState(VisitState *State); 99d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor 10098339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregorpublic: 1011a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor typedef SmallVector<ModuleFile*, 2>::iterator ModuleIterator; 1021a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor typedef SmallVector<ModuleFile*, 2>::const_iterator ModuleConstIterator; 1031a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor typedef SmallVector<ModuleFile*, 2>::reverse_iterator ModuleReverseIterator; 10498339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor typedef std::pair<uint32_t, StringRef> ModuleOffset; 10598339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor 106d64c26f6676eef69d1713f353ca8a3c2fe963f17Argyrios Kyrtzidis explicit ModuleManager(FileManager &FileMgr); 10798339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor ~ModuleManager(); 10898339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor 10998339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// \brief Forward iterator to traverse all loaded modules. This is reverse 11098339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// source-order. 11198339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor ModuleIterator begin() { return Chain.begin(); } 11298339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// \brief Forward iterator end-point to traverse all loaded modules 11398339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor ModuleIterator end() { return Chain.end(); } 11498339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor 11598339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// \brief Const forward iterator to traverse all loaded modules. This is 11698339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// in reverse source-order. 11798339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor ModuleConstIterator begin() const { return Chain.begin(); } 11898339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// \brief Const forward iterator end-point to traverse all loaded modules 11998339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor ModuleConstIterator end() const { return Chain.end(); } 12098339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor 12198339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// \brief Reverse iterator to traverse all loaded modules. This is in 12298339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// source order. 12398339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor ModuleReverseIterator rbegin() { return Chain.rbegin(); } 12498339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// \brief Reverse iterator end-point to traverse all loaded modules. 12598339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor ModuleReverseIterator rend() { return Chain.rend(); } 12698339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor 12798339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// \brief Returns the primary module associated with the manager, that is, 12898339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// the first module loaded 1291a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor ModuleFile &getPrimaryModule() { return *Chain[0]; } 13098339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor 13198339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// \brief Returns the primary module associated with the manager, that is, 13298339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// the first module loaded. 1331a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor ModuleFile &getPrimaryModule() const { return *Chain[0]; } 13498339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor 13598339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// \brief Returns the module associated with the given index 1361a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor ModuleFile &operator[](unsigned Index) const { return *Chain[Index]; } 13798339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor 13898339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// \brief Returns the module associated with the given name 1391a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor ModuleFile *lookup(StringRef Name); 14098339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor 14198339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// \brief Returns the in-memory (virtual file) buffer with the given name 14298339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor llvm::MemoryBuffer *lookupBuffer(StringRef Name); 14398339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor 14498339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// \brief Number of modules loaded 14598339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor unsigned size() const { return Chain.size(); } 14698339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// \brief Attempts to create a new module and add it to the list of known 14798339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// modules. 14898339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// 14998339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// \param FileName The file name of the module to be loaded. 15098339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// 15198339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// \param Type The kind of module being loaded. 15298339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// 15387e2cfcec7231daaa3f367dc32df74b411251e46Douglas Gregor /// \param ImportLoc The location at which the module is imported. 15487e2cfcec7231daaa3f367dc32df74b411251e46Douglas Gregor /// 15598339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// \param ImportedBy The module that is importing this module, or NULL if 15698339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// this module is imported directly by the user. 15798339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// 158057df20b3107cef764052d271c89b8591b98b3ceDouglas Gregor /// \param Generation The generation in which this module was loaded. 159057df20b3107cef764052d271c89b8591b98b3ceDouglas Gregor /// 16098339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// \param ErrorStr Will be set to a non-empty string if any errors occurred 16198339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// while trying to load the module. 16298339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// 16398339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// \return A pointer to the module that corresponds to this file name, 16498339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// and a boolean indicating whether the module was newly added. 1651a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor std::pair<ModuleFile *, bool> 16687e2cfcec7231daaa3f367dc32df74b411251e46Douglas Gregor addModule(StringRef FileName, ModuleKind Type, SourceLocation ImportLoc, 16787e2cfcec7231daaa3f367dc32df74b411251e46Douglas Gregor ModuleFile *ImportedBy, unsigned Generation, 16887e2cfcec7231daaa3f367dc32df74b411251e46Douglas Gregor std::string &ErrorStr); 1697cdd28162dc7ade4b14bf237e87b4bbc17b2f023Douglas Gregor 1707cdd28162dc7ade4b14bf237e87b4bbc17b2f023Douglas Gregor /// \brief Remove the given set of modules. 1717cdd28162dc7ade4b14bf237e87b4bbc17b2f023Douglas Gregor void removeModules(ModuleIterator first, ModuleIterator last); 1727cdd28162dc7ade4b14bf237e87b4bbc17b2f023Douglas Gregor 17398339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// \brief Add an in-memory buffer the list of known buffers 17498339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor void addInMemoryBuffer(StringRef FileName, llvm::MemoryBuffer *Buffer); 175188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor 176188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor /// \brief Set the global module index. 177188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor void setGlobalIndex(GlobalModuleIndex *Index); 178188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor 17998339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// \brief Visit each of the modules. 18098339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// 18198339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// This routine visits each of the modules, starting with the 18298339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// "root" modules that no other loaded modules depend on, and 18398339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// proceeding to the leaf modules, visiting each module only once 18498339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// during the traversal. 18598339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// 18698339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// This traversal is intended to support various "lookup" 18798339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// operations that can find data in any of the loaded modules. 18898339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// 18998339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// \param Visitor A visitor function that will be invoked with each 19098339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// module and the given user data pointer. The return value must be 19198339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// convertible to bool; when false, the visitation continues to 19298339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// modules that the current module depends on. When true, the 19398339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// visitation skips any modules that the current module depends on. 19498339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// 19598339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// \param UserData User data associated with the visitor object, which 19698339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// will be passed along to the visitor. 197188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor /// 198188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor /// \param ModuleFilesHit If non-NULL, contains the set of module files 199188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor /// that we know we need to visit because the global module index told us to. 200188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor /// Any module that is known to both the global module index and the module 201188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor /// manager that is *not* in this set can be skipped. 202188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor void visit(bool (*Visitor)(ModuleFile &M, void *UserData), void *UserData, 203188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor llvm::SmallPtrSet<const FileEntry *, 4> *ModuleFilesHit = 0); 20498339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor 20598339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// \brief Visit each of the modules with a depth-first traversal. 20698339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// 20798339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// This routine visits each of the modules known to the module 20898339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// manager using a depth-first search, starting with the first 20998339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// loaded module. The traversal invokes the callback both before 21098339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// traversing the children (preorder traversal) and after 21198339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// traversing the children (postorder traversal). 21298339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// 21398339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// \param Visitor A visitor function that will be invoked with each 21498339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// module and given a \c Preorder flag that indicates whether we're 21598339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// visiting the module before or after visiting its children. The 21698339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// visitor may return true at any time to abort the depth-first 21798339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// visitation. 21898339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// 21998339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// \param UserData User data ssociated with the visitor object, 22098339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor /// which will be passed along to the user. 2211a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor void visitDepthFirst(bool (*Visitor)(ModuleFile &M, bool Preorder, 22298339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor void *UserData), 22398339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor void *UserData); 2242492c89882b5c5ce03afb4704fee67b7eff8f5eeDouglas Gregor 2252492c89882b5c5ce03afb4704fee67b7eff8f5eeDouglas Gregor /// \brief View the graphviz representation of the module graph. 2262492c89882b5c5ce03afb4704fee67b7eff8f5eeDouglas Gregor void viewGraph(); 22798339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor}; 22898339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor 22998339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor} } // end namespace clang::serialization 23098339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor 23198339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor#endif 232