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   template<typename GraphType>
  34   static std::string getGraphName(GraphType Graph) { return ""; }
  35
  36   /// getGraphProperties - Return any custom properties that should be included
  37   /// in the top level graph structure for dot.
  38   ///
  39   template<typename GraphType>
  40   static std::string getGraphProperties(GraphType Graph) {
  41     return "";
  42   }
  43
  44   /// renderGraphFromBottomUp - If this function returns true, the graph is
  45   /// emitted bottom-up instead of top-down.  This requires graphviz 2.0 to work
  46   /// though.
  47   static bool renderGraphFromBottomUp() {
  48     return false;
  49   }
  50
  51   /// getNodeLabel - Given a node and a pointer to the top level graph, return
  52   /// the label to print in the node.
  53   template<typename GraphType>
  54   static std::string getNodeLabel(const void *Node, GraphType Graph) {
  55     return "";
  56   }
  57
  58   /// hasNodeAddressLabel - If this method returns true, the address of the node
  59   /// is added to the label of the node.
  60   template<typename GraphType>
  61   static bool hasNodeAddressLabel(const void *Node, GraphType Graph) {
  62     return false;
  63   }
  64
  65   /// If you want to specify custom node attributes, this is the place to do so
  66   ///
  67   template<typename GraphType>
  68   static std::string getNodeAttributes(const void *Node, GraphType Graph) {
  69     return "";
  70   }
  71
  72   /// If you want to override the dot attributes printed for a particular edge,
  73   /// override this method.
  74   template<typename EdgeIter>
  75   static std::string getEdgeAttributes(const void *Node, EdgeIter EI) {
  76     return "";
  77   }
  78
  79   /// getEdgeSourceLabel - If you want to label the edge source itself,
  80   /// implement this method.
  81   template<typename EdgeIter>
  82   static std::string getEdgeSourceLabel(const void *Node, EdgeIter I) {
  83     return "";
  84   }
  85
  86   /// edgeTargetsEdgeSource - This method returns true if this outgoing edge
  87   /// should actually target another edge source, not a node.  If this method is
  88   /// implemented, getEdgeTarget should be implemented.
  89   template<typename EdgeIter>
  90   static bool edgeTargetsEdgeSource(const void *Node, EdgeIter I) {
  91     return false;
  92   }
  93
  94   /// getEdgeTarget - If edgeTargetsEdgeSource returns true, this method is
  95   /// called to determine which outgoing edge of Node is the target of this
  96   /// edge.
  97   template<typename EdgeIter>
  98   static EdgeIter getEdgeTarget(const void *Node, EdgeIter I) {
  99     return I;
 100   }
 101
 102   /// addCustomGraphFeatures - If a graph is made up of more than just
 103   /// straight-forward nodes and edges, this is the place to put all of the
 104   /// custom stuff necessary.  The GraphWriter object, instantiated with your
 105   /// GraphType is passed in as an argument.  You may call arbitrary methods on
 106   /// it to add things to the output graph.
 107   ///
 108   template<typename GraphType, typename GraphWriter>
 109   static void addCustomGraphFeatures(GraphType Graph, GraphWriter &GW) {}
 110 };
 111
 112
 113 /// DOTGraphTraits - Template class that can be specialized to customize how
 114 /// graphs are converted to 'dot' graphs.  When specializing, you may inherit
 115 /// from DefaultDOTGraphTraits if you don't need to override everything.
 116 ///
 117 template <typename Ty>
 118 struct DOTGraphTraits : public DefaultDOTGraphTraits {};
 119
 120 } // End llvm namespace
 121
 122 #endif