1*e5dd7070Spatrick //===--- StmtViz.cpp - Graphviz visualization for Stmt ASTs -----*- C++ -*-===// 2*e5dd7070Spatrick // 3*e5dd7070Spatrick // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4*e5dd7070Spatrick // See https://llvm.org/LICENSE.txt for license information. 5*e5dd7070Spatrick // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6*e5dd7070Spatrick // 7*e5dd7070Spatrick //===----------------------------------------------------------------------===// 8*e5dd7070Spatrick // 9*e5dd7070Spatrick // This file implements Stmt::viewAST, which generates a Graphviz DOT file 10*e5dd7070Spatrick // that depicts the AST and then calls Graphviz/dot+gv on it. 11*e5dd7070Spatrick // 12*e5dd7070Spatrick //===----------------------------------------------------------------------===// 13*e5dd7070Spatrick 14*e5dd7070Spatrick #include "clang/AST/StmtGraphTraits.h" 15*e5dd7070Spatrick #include "clang/AST/Decl.h" 16*e5dd7070Spatrick #include "llvm/Support/GraphWriter.h" 17*e5dd7070Spatrick 18*e5dd7070Spatrick using namespace clang; 19*e5dd7070Spatrick viewAST() const20*e5dd7070Spatrickvoid Stmt::viewAST() const { 21*e5dd7070Spatrick #ifndef NDEBUG 22*e5dd7070Spatrick llvm::ViewGraph(this,"AST"); 23*e5dd7070Spatrick #else 24*e5dd7070Spatrick llvm::errs() << "Stmt::viewAST is only available in debug builds on " 25*e5dd7070Spatrick << "systems with Graphviz or gv!\n"; 26*e5dd7070Spatrick #endif 27*e5dd7070Spatrick } 28*e5dd7070Spatrick 29*e5dd7070Spatrick namespace llvm { 30*e5dd7070Spatrick template<> 31*e5dd7070Spatrick struct DOTGraphTraits<const Stmt*> : public DefaultDOTGraphTraits { DOTGraphTraitsllvm::DOTGraphTraits32*e5dd7070Spatrick DOTGraphTraits (bool isSimple=false) : DefaultDOTGraphTraits(isSimple) {} 33*e5dd7070Spatrick getNodeLabelllvm::DOTGraphTraits34*e5dd7070Spatrick static std::string getNodeLabel(const Stmt* Node, const Stmt* Graph) { 35*e5dd7070Spatrick 36*e5dd7070Spatrick #ifndef NDEBUG 37*e5dd7070Spatrick std::string OutSStr; 38*e5dd7070Spatrick llvm::raw_string_ostream Out(OutSStr); 39*e5dd7070Spatrick 40*e5dd7070Spatrick if (Node) 41*e5dd7070Spatrick Out << Node->getStmtClassName(); 42*e5dd7070Spatrick else 43*e5dd7070Spatrick Out << "<NULL>"; 44*e5dd7070Spatrick 45*e5dd7070Spatrick std::string OutStr = Out.str(); 46*e5dd7070Spatrick if (OutStr[0] == '\n') OutStr.erase(OutStr.begin()); 47*e5dd7070Spatrick 48*e5dd7070Spatrick // Process string output to make it nicer... 49*e5dd7070Spatrick for (unsigned i = 0; i != OutStr.length(); ++i) 50*e5dd7070Spatrick if (OutStr[i] == '\n') { // Left justify 51*e5dd7070Spatrick OutStr[i] = '\\'; 52*e5dd7070Spatrick OutStr.insert(OutStr.begin()+i+1, 'l'); 53*e5dd7070Spatrick } 54*e5dd7070Spatrick 55*e5dd7070Spatrick return OutStr; 56*e5dd7070Spatrick #else 57*e5dd7070Spatrick return ""; 58*e5dd7070Spatrick #endif 59*e5dd7070Spatrick } 60*e5dd7070Spatrick }; 61*e5dd7070Spatrick } // end namespace llvm 62