1 //===--- StmtViz.cpp - Graphviz visualization for Stmt ASTs -----*- C++ -*-===//
2 //
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 implements Stmt::viewAST, which generates a Graphviz DOT file
11 //  that depicts the AST and then calls Graphviz/dot+gv on it.
12 //
13 //===----------------------------------------------------------------------===//
14 
15 #include "clang/AST/StmtGraphTraits.h"
16 #include "clang/AST/Decl.h"
17 #include "llvm/Support/GraphWriter.h"
18 
19 using namespace clang;
20 
viewAST() const21 void Stmt::viewAST() const {
22 #ifndef NDEBUG
23   llvm::ViewGraph(this,"AST");
24 #else
25   llvm::errs() << "Stmt::viewAST is only available in debug builds on "
26                << "systems with Graphviz or gv!\n";
27 #endif
28 }
29 
30 namespace llvm {
31 template<>
32 struct DOTGraphTraits<const Stmt*> : public DefaultDOTGraphTraits {
DOTGraphTraitsllvm::DOTGraphTraits33   DOTGraphTraits (bool isSimple=false) : DefaultDOTGraphTraits(isSimple) {}
34 
getNodeLabelllvm::DOTGraphTraits35   static std::string getNodeLabel(const Stmt* Node, const Stmt* Graph) {
36 
37 #ifndef NDEBUG
38     std::string OutSStr;
39     llvm::raw_string_ostream Out(OutSStr);
40 
41     if (Node)
42       Out << Node->getStmtClassName();
43     else
44       Out << "<NULL>";
45 
46     std::string OutStr = Out.str();
47     if (OutStr[0] == '\n') OutStr.erase(OutStr.begin());
48 
49     // Process string output to make it nicer...
50     for (unsigned i = 0; i != OutStr.length(); ++i)
51       if (OutStr[i] == '\n') {                            // Left justify
52         OutStr[i] = '\\';
53         OutStr.insert(OutStr.begin()+i+1, 'l');
54       }
55 
56     return OutStr;
57 #else
58     return "";
59 #endif
60   }
61 };
62 } // end namespace llvm
63