1 //===--- DependencyGraph.cpp - Generate dependency file -------------------===//
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 code generates a header dependency graph in DOT format, for use
11 // with, e.g., GraphViz.
13 //===----------------------------------------------------------------------===//
15 #include "clang/Frontend/Utils.h"
16 #include "clang/Basic/FileManager.h"
17 #include "clang/Basic/SourceManager.h"
18 #include "clang/Frontend/FrontendDiagnostic.h"
19 #include "clang/Lex/PPCallbacks.h"
20 #include "clang/Lex/Preprocessor.h"
21 #include "llvm/ADT/SetVector.h"
22 #include "llvm/Support/GraphWriter.h"
23 #include "llvm/Support/raw_ostream.h"
25 using namespace clang;
26 namespace DOT = llvm::DOT;
29 class DependencyGraphCallback : public PPCallbacks {
30 const Preprocessor *PP;
31 std::string OutputFile;
33 llvm::SetVector<const FileEntry *> AllFiles;
34 typedef llvm::DenseMap<const FileEntry *,
35 SmallVector<const FileEntry *, 2> > DependencyMap;
37 DependencyMap Dependencies;
40 raw_ostream &writeNodeReference(raw_ostream &OS,
41 const FileEntry *Node);
42 void OutputGraphFile();
45 DependencyGraphCallback(const Preprocessor *_PP, StringRef OutputFile,
47 : PP(_PP), OutputFile(OutputFile.str()), SysRoot(SysRoot.str()) { }
49 virtual void InclusionDirective(SourceLocation HashLoc,
50 const Token &IncludeTok,
53 CharSourceRange FilenameRange,
54 const FileEntry *File,
56 StringRef RelativePath,
57 const Module *Imported);
59 virtual void EndOfMainFile() {
66 void clang::AttachDependencyGraphGen(Preprocessor &PP, StringRef OutputFile,
68 PP.addPPCallbacks(new DependencyGraphCallback(&PP, OutputFile, SysRoot));
71 void DependencyGraphCallback::InclusionDirective(SourceLocation HashLoc,
72 const Token &IncludeTok,
75 CharSourceRange FilenameRange,
76 const FileEntry *File,
78 StringRef RelativePath,
79 const Module *Imported) {
83 SourceManager &SM = PP->getSourceManager();
84 const FileEntry *FromFile
85 = SM.getFileEntryForID(SM.getFileID(SM.getExpansionLoc(HashLoc)));
89 Dependencies[FromFile].push_back(File);
91 AllFiles.insert(File);
92 AllFiles.insert(FromFile);
96 DependencyGraphCallback::writeNodeReference(raw_ostream &OS,
97 const FileEntry *Node) {
98 OS << "header_" << Node->getUID();
102 void DependencyGraphCallback::OutputGraphFile() {
104 llvm::raw_fd_ostream OS(OutputFile.c_str(), Err);
106 PP->getDiagnostics().Report(diag::err_fe_error_opening)
107 << OutputFile << Err;
111 OS << "digraph \"dependencies\" {\n";
114 for (unsigned I = 0, N = AllFiles.size(); I != N; ++I) {
115 // Write the node itself.
117 writeNodeReference(OS, AllFiles[I]);
118 OS << " [ shape=\"box\", label=\"";
119 StringRef FileName = AllFiles[I]->getName();
120 if (FileName.startswith(SysRoot))
121 FileName = FileName.substr(SysRoot.size());
123 OS << DOT::EscapeString(FileName)
128 for (DependencyMap::iterator F = Dependencies.begin(),
129 FEnd = Dependencies.end();
131 for (unsigned I = 0, N = F->second.size(); I != N; ++I) {
133 writeNodeReference(OS, F->first);
135 writeNodeReference(OS, F->second[I]);