include/llvm/Support/DOTGraphTraits.h

   1 //===-- llvm/Support/DotGraphTraits.h - Customize .dot output ---*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines a template class that can be used to customize dot output
  11 // graphs generated by the GraphWriter.h file.  The default implementation of
  12 // this file will produce a simple, but not very polished graph.  By
  13 // specializing this template, lots of customization opportunities are possible.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #ifndef LLVM_SUPPORT_DOTGRAPHTRAITS_H
  18 #define LLVM_SUPPORT_DOTGRAPHTRAITS_H
  19
  20 #include <string>
  21
  22 namespace llvm {
  23
  24 /// DefaultDOTGraphTraits - This class provides the default implementations of
  25 /// all of the DOTGraphTraits methods.  If a specialization does not need to
  26 /// override all methods here it should inherit so that it can get the default
  27 /// implementations.
  28 ///
  29 struct DefaultDOTGraphTraits {
  30   /// getGraphName - Return the label for the graph as a whole.  Printed at the
  31   /// top of the graph.
  32   ///
  33   static std::string getGraphName(const void *Graph) { return ""; }
  34
  35   /// getGraphProperties - Return any custom properties that should be included
  36   /// in the top level graph structure for dot.
  37   ///
  38   static std::string getGraphProperties(const void *Graph) {
  39     return "";
  40   }
  41
  42   /// renderGraphFromBottomUp - If this function returns true, the graph is
  43   /// emitted bottom-up instead of top-down.  This requires graphviz 2.0 to work
  44   /// though.
  45   static bool renderGraphFromBottomUp() {
  46     return false;
  47   }
  48
  49   /// getNodeLabel - Given a node and a pointer to the top level graph, return
  50   /// the label to print in the node.
  51   static std::string getNodeLabel(const void *Node, const void *Graph) {
  52     return "";
  53   }
  54
  55   /// hasNodeAddressLabel - If this method returns true, the address of the node
  56   /// is added to the label of the node.
  57   static bool hasNodeAddressLabel(const void *Node, const void *Graph) {
  58     return false;
  59   }
  60
  61   /// If you want to specify custom node attributes, this is the place to do so
  62   ///
  63   static std::string getNodeAttributes(const void *Node, const void *Graph) {
  64     return "";
  65   }
  66
  67   /// If you want to override the dot attributes printed for a particular edge,
  68   /// override this method.
  69   template<typename EdgeIter>
  70   static std::string getEdgeAttributes(const void *Node, EdgeIter EI) {
  71     return "";
  72   }
  73
  74   /// getEdgeSourceLabel - If you want to label the edge source itself,
  75   /// implement this method.
  76   template<typename EdgeIter>
  77   static std::string getEdgeSourceLabel(const void *Node, EdgeIter I) {
  78     return "";
  79   }
  80
  81   /// edgeTargetsEdgeSource - This method returns true if this outgoing edge
  82   /// should actually target another edge source, not a node.  If this method is
  83   /// implemented, getEdgeTarget should be implemented.
  84   template<typename EdgeIter>
  85   static bool edgeTargetsEdgeSource(const void *Node, EdgeIter I) {
  86     return false;
  87   }
  88
  89   /// getEdgeTarget - If edgeTargetsEdgeSource returns true, this method is
  90   /// called to determine which outgoing edge of Node is the target of this
  91   /// edge.
  92   template<typename EdgeIter>
  93   static EdgeIter getEdgeTarget(const void *Node, EdgeIter I) {
  94     return I;
  95   }
  96
  97   /// addCustomGraphFeatures - If a graph is made up of more than just
  98   /// straight-forward nodes and edges, this is the place to put all of the
  99   /// custom stuff necessary.  The GraphWriter object, instantiated with your
 100   /// GraphType is passed in as an argument.  You may call arbitrary methods on
 101   /// it to add things to the output graph.
 102   ///
 103   template<typename GraphWriter>
 104   static void addCustomGraphFeatures(const void *Graph, GraphWriter &GW) {}
 105 };
 106
 107
 108 /// DOTGraphTraits - Template class that can be specialized to customize how
 109 /// graphs are converted to 'dot' graphs.  When specializing, you may inherit
 110 /// from DefaultDOTGraphTraits if you don't need to override everything.
 111 ///
 112 template <typename Ty>
 113 struct DOTGraphTraits : public DefaultDOTGraphTraits {};
 114
 115 } // End llvm namespace
 116
 117 #endif