include/Support/DOTGraphTraits.h

   1 //===-- 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 SUPPORT_DOTGRAPHTRAITS_H
  18 #define SUPPORT_DOTGRAPHTRAITS_H
  19
  20 #include <string>
  21
  22 /// DefaultDOTGraphTraits - This class provides the default implementations of
  23 /// all of the DOTGraphTraits methods.  If a specialization does not need to
  24 /// override all methods here it should inherit so that it can get the default
  25 /// implementations.
  26 ///
  27 struct DefaultDOTGraphTraits {
  28   /// getGraphName - Return the label for the graph as a whole.  Printed at the
  29   /// top of the graph.
  30   ///
  31   static std::string getGraphName(const void *Graph) { return ""; }
  32
  33   /// getGraphProperties - Return any custom properties that should be included
  34   /// in the top level graph structure for dot.  By default, we resize the graph
  35   /// to fit on a letter size page.
  36   ///
  37   static std::string getGraphProperties(const void *Graph) {
  38     return "\tsize=\"7.5,10\";\n";    // Size to fit on a page
  39   }
  40
  41   /// getNodeLabel - Given a node and a pointer to the top level graph, return
  42   /// the label to print in the node.
  43   static std::string getNodeLabel(const void *Node, const void *Graph) {
  44     return "";
  45   }
  46
  47   /// If you want to specify custom node attributes, this is the place to do so
  48   ///
  49   static std::string getNodeAttributes(const void *Node) { return ""; }
  50
  51   /// If you want to override the dot attributes printed for a particular edge,
  52   /// override this method.
  53   template<typename EdgeIter>
  54   static std::string getEdgeAttributes(const void *Node, EdgeIter EI) {
  55     return "";
  56   }
  57
  58   /// getEdgeSourceLabel - If you want to label the edge source itself,
  59   /// implement this method.
  60   template<typename EdgeIter>
  61   static std::string getEdgeSourceLabel(const void *Node, EdgeIter I) {
  62     return "";
  63   }
  64
  65   /// edgeTargetsEdgeSource - This method returns true if this outgoing edge
  66   /// should actually target another edge source, not a node.  If this method is
  67   /// implemented, getEdgeTarget should be implemented.
  68   template<typename EdgeIter>
  69   static bool edgeTargetsEdgeSource(const void *Node, EdgeIter I) {
  70     return false;
  71   }
  72
  73   /// getEdgeTarget - If edgeTargetsEdgeSource returns true, this method is
  74   /// called to determine which outgoing edge of Node is the target of this
  75   /// edge.
  76   template<typename EdgeIter>
  77   static EdgeIter getEdgeTarget(const void *Node, EdgeIter I) {
  78     return I;
  79   }
  80
  81   /// addCustomGraphFeatures - If a graph is made up of more than just
  82   /// straight-forward nodes and edges, this is the place to put all of the
  83   /// custom stuff necessary.  The GraphWriter object, instantiated with your
  84   /// GraphType is passed in as an argument.  You may call arbitrary methods on
  85   /// it to add things to the output graph.
  86   ///
  87   template<typename GraphWriter>
  88   static void addCustomGraphFeatures(const void *Graph, GraphWriter &GW) {}
  89 };
  90
  91
  92 /// DOTGraphTraits - Template class that can be specialized to customize how
  93 /// graphs are converted to 'dot' graphs.  When specializing, you may inherit
  94 /// from DefaultDOTGraphTraits if you don't need to override everything.
  95 ///
  96 template <typename Ty>
  97 class DOTGraphTraits : public DefaultDOTGraphTraits {};
  98
  99 #endif