WebSVN – QNX 8.QNX8 LLVM/Clang compiler suite – Blame – /llvm-build/x86_64/include/llvm/Support/DOTGraphTraits.h

Rev	Author	Line No.	Line
14	pmbaty	1	//===-- llvm/Support/DOTGraphTraits.h - Customize .dot output ---- C++ --===//
		2	//
		3	// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
		4	// See https://llvm.org/LICENSE.txt for license information.
		5	// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
		6	//
		7	//===----------------------------------------------------------------------===//
		8	//
		9	// This file defines a template class that can be used to customize dot output
		10	// graphs generated by the GraphWriter.h file. The default implementation of
		11	// this file will produce a simple, but not very polished graph. By
		12	// specializing this template, lots of customization opportunities are possible.
		13	//
		14	//===----------------------------------------------------------------------===//
		15
		16	#ifndef LLVM_SUPPORT_DOTGRAPHTRAITS_H
		17	#define LLVM_SUPPORT_DOTGRAPHTRAITS_H
		18
		19	#include <string>
		20
		21	namespace llvm {
		22
		23	/// DefaultDOTGraphTraits - This class provides the default implementations of
		24	/// all of the DOTGraphTraits methods. If a specialization does not need to
		25	/// override all methods here it should inherit so that it can get the default
		26	/// implementations.
		27	///
		28	struct DefaultDOTGraphTraits {
		29	private:
		30	bool IsSimple;
		31
		32	protected:
		33	bool isSimple() {
		34	return IsSimple;
		35	}
		36
		37	public:
		38	explicit DefaultDOTGraphTraits(bool simple=false) : IsSimple (simple) {}
		39
		40	/// getGraphName - Return the label for the graph as a whole. Printed at the
		41	/// top of the graph.
		42	///
		43	template<typename GraphType>
		44	static std::string getGraphName(const GraphType &) { return ""; }
		45
		46	/// getGraphProperties - Return any custom properties that should be included
		47	/// in the top level graph structure for dot.
		48	///
		49	template<typename GraphType>
		50	static std::string getGraphProperties(const GraphType &) {
		51	return "";
		52	}
		53
		54	/// renderGraphFromBottomUp - If this function returns true, the graph is
		55	/// emitted bottom-up instead of top-down. This requires graphviz 2.0 to work
		56	/// though.
		57	static bool renderGraphFromBottomUp() {
		58	return false;
		59	}
		60
		61	/// isNodeHidden - If the function returns true, the given node is not
		62	/// displayed in the graph.
		63	template <typename GraphType>
		64	static bool isNodeHidden(const void *, const GraphType &) {
		65	return false;
		66	}
		67
		68	// renderNodesUsingHTML - If the function returns true, nodes will be
		69	// rendered using HTML-like labels which allows colors, etc in the nodes
		70	// and the edge source labels.
		71	static bool renderNodesUsingHTML() { return false; }
		72
		73	/// getNodeLabel - Given a node and a pointer to the top level graph, return
		74	/// the label to print in the node.
		75	template<typename GraphType>
		76	std::string getNodeLabel(const void *, const GraphType &) {
		77	return "";
		78	}
		79
		80	// getNodeIdentifierLabel - Returns a string representing the
		81	// address or other unique identifier of the node. (Only used if
		82	// non-empty.)
		83	template <typename GraphType>
		84	static std::string getNodeIdentifierLabel(const void *, const GraphType &) {
		85	return "";
		86	}
		87
		88	template<typename GraphType>
		89	static std::string getNodeDescription(const void *, const GraphType &) {
		90	return "";
		91	}
		92
		93	/// If you want to specify custom node attributes, this is the place to do so
		94	///
		95	template<typename GraphType>
		96	static std::string getNodeAttributes(const void *,
		97	const GraphType &) {
		98	return "";
		99	}
		100
		101	/// If you want to override the dot attributes printed for a particular edge,
		102	/// override this method.
		103	template<typename EdgeIter, typename GraphType>
		104	static std::string getEdgeAttributes(const void *, EdgeIter,
		105	const GraphType &) {
		106	return "";
		107	}
		108
		109	/// getEdgeSourceLabel - If you want to label the edge source itself,
		110	/// implement this method.
		111	template<typename EdgeIter>
		112	static std::string getEdgeSourceLabel(const void *, EdgeIter) {
		113	return "";
		114	}
		115
		116	/// edgeTargetsEdgeSource - This method returns true if this outgoing edge
		117	/// should actually target another edge source, not a node. If this method is
		118	/// implemented, getEdgeTarget should be implemented.
		119	template<typename EdgeIter>
		120	static bool edgeTargetsEdgeSource(const void *, EdgeIter) {
		121	return false;
		122	}
		123
		124	/// getEdgeTarget - If edgeTargetsEdgeSource returns true, this method is
		125	/// called to determine which outgoing edge of Node is the target of this
		126	/// edge.
		127	template<typename EdgeIter>
		128	static EdgeIter getEdgeTarget(const void *, EdgeIter I) {
		129	return I;
		130	}
		131
		132	/// hasEdgeDestLabels - If this function returns true, the graph is able
		133	/// to provide labels for edge destinations.
		134	static bool hasEdgeDestLabels() {
		135	return false;
		136	}
		137
		138	/// numEdgeDestLabels - If hasEdgeDestLabels, this function returns the
		139	/// number of incoming edge labels the given node has.
		140	static unsigned numEdgeDestLabels(const void *) {
		141	return 0;
		142	}
		143
		144	/// getEdgeDestLabel - If hasEdgeDestLabels, this function returns the
		145	/// incoming edge label with the given index in the given node.
		146	static std::string getEdgeDestLabel(const void *, unsigned) {
		147	return "";
		148	}
		149
		150	/// addCustomGraphFeatures - If a graph is made up of more than just
		151	/// straight-forward nodes and edges, this is the place to put all of the
		152	/// custom stuff necessary. The GraphWriter object, instantiated with your
		153	/// GraphType is passed in as an argument. You may call arbitrary methods on
		154	/// it to add things to the output graph.
		155	///
		156	template<typename GraphType, typename GraphWriter>
		157	static void addCustomGraphFeatures(const GraphType &, GraphWriter &) {}
		158	};
		159
		160
		161	/// DOTGraphTraits - Template class that can be specialized to customize how
		162	/// graphs are converted to 'dot' graphs. When specializing, you may inherit
		163	/// from DefaultDOTGraphTraits if you don't need to override everything.
		164	///
		165	template <typename Ty>
		166	struct DOTGraphTraits : public DefaultDOTGraphTraits {
		167	DOTGraphTraits (bool simple=false) : DefaultDOTGraphTraits (simple) {}
		168	};
		169
		170	} // End llvm namespace
		171
		172	#endif

Subversion Repositories QNX 8.QNX8 LLVM/Clang compiler suite

QNX 8.QNX8 LLVM/Clang compiler suite/llvm-build/x86_64/include/llvm/Support/DOTGraphTraits.h – Rev 14