-//===-- Support/DotGraphTraits.h - Customize .dot output --------*- C++ -*-===//
-//
+//===-- llvm/Support/DotGraphTraits.h - Customize .dot output ---*- C++ -*-===//
+//
// The LLVM Compiler Infrastructure
//
-// This file was developed by the LLVM research group and is distributed under
-// the University of Illinois Open Source License. See LICENSE.TXT for details.
-//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
//===----------------------------------------------------------------------===//
//
// This file defines a template class that can be used to customize dot output
//
//===----------------------------------------------------------------------===//
-#ifndef SUPPORT_DOTGRAPHTRAITS_H
-#define SUPPORT_DOTGRAPHTRAITS_H
+#ifndef LLVM_SUPPORT_DOTGRAPHTRAITS_H
+#define LLVM_SUPPORT_DOTGRAPHTRAITS_H
#include <string>
/// implementations.
///
struct DefaultDOTGraphTraits {
+private:
+ bool IsSimple;
+
+protected:
+ bool isSimple() {
+ return IsSimple;
+ }
+
+public:
+ explicit DefaultDOTGraphTraits(bool simple=false) : IsSimple (simple) {}
+
/// getGraphName - Return the label for the graph as a whole. Printed at the
/// top of the graph.
///
- static std::string getGraphName(const void *Graph) { return ""; }
+ template<typename GraphType>
+ static std::string getGraphName(const GraphType& Graph) { return ""; }
/// getGraphProperties - Return any custom properties that should be included
- /// in the top level graph structure for dot. By default, we resize the graph
- /// to fit on a letter size page.
+ /// in the top level graph structure for dot.
///
- static std::string getGraphProperties(const void *Graph) {
- return "\tsize=\"7.5,10\";\n"; // Size to fit on a page
+ template<typename GraphType>
+ static std::string getGraphProperties(const GraphType& Graph) {
+ return "";
+ }
+
+ /// renderGraphFromBottomUp - If this function returns true, the graph is
+ /// emitted bottom-up instead of top-down. This requires graphviz 2.0 to work
+ /// though.
+ static bool renderGraphFromBottomUp() {
+ return false;
+ }
+
+ /// isNodeHidden - If the function returns true, the given node is not
+ /// displayed in the graph.
+ static bool isNodeHidden(const void *Node) {
+ return false;
}
/// getNodeLabel - Given a node and a pointer to the top level graph, return
/// the label to print in the node.
- static std::string getNodeLabel(const void *Node, const void *Graph) {
+ template<typename GraphType>
+ std::string getNodeLabel(const void *Node, const GraphType& Graph) {
return "";
}
+ /// hasNodeAddressLabel - If this method returns true, the address of the node
+ /// is added to the label of the node.
+ template<typename GraphType>
+ static bool hasNodeAddressLabel(const void *Node, const GraphType& Graph) {
+ return false;
+ }
+
/// If you want to specify custom node attributes, this is the place to do so
///
- static std::string getNodeAttributes(const void *Node) { return ""; }
+ template<typename GraphType>
+ static std::string getNodeAttributes(const void *Node,
+ const GraphType& Graph) {
+ return "";
+ }
/// If you want to override the dot attributes printed for a particular edge,
/// override this method.
return I;
}
+ /// hasEdgeDestLabels - If this function returns true, the graph is able
+ /// to provide labels for edge destinations.
+ static bool hasEdgeDestLabels() {
+ return false;
+ }
+
+ /// numEdgeDestLabels - If hasEdgeDestLabels, this function returns the
+ /// number of incoming edge labels the given node has.
+ static unsigned numEdgeDestLabels(const void *Node) {
+ return 0;
+ }
+
+ /// getEdgeDestLabel - If hasEdgeDestLabels, this function returns the
+ /// incoming edge label with the given index in the given node.
+ static std::string getEdgeDestLabel(const void *Node, unsigned i) {
+ return "";
+ }
+
/// addCustomGraphFeatures - If a graph is made up of more than just
/// straight-forward nodes and edges, this is the place to put all of the
/// custom stuff necessary. The GraphWriter object, instantiated with your
/// GraphType is passed in as an argument. You may call arbitrary methods on
/// it to add things to the output graph.
///
- template<typename GraphWriter>
- static void addCustomGraphFeatures(const void *Graph, GraphWriter &GW) {}
+ template<typename GraphType, typename GraphWriter>
+ static void addCustomGraphFeatures(const GraphType& Graph, GraphWriter &GW) {}
};
/// from DefaultDOTGraphTraits if you don't need to override everything.
///
template <typename Ty>
-class DOTGraphTraits : public DefaultDOTGraphTraits {};
+struct DOTGraphTraits : public DefaultDOTGraphTraits {
+ DOTGraphTraits (bool simple=false) : DefaultDOTGraphTraits (simple) {}
+};
} // End llvm namespace