SVF::GraphWriter< GraphType > Class Template Reference

#include <GraphWriter.h>

Public Member Functions
	GraphWriter (std::ofstream &o, const GraphType &g, bool SN)
void	writeGraph (const std::string &Title="")
void	writeHeader (const std::string &Title)
void	writeFooter ()
void	writeNodes ()
bool	isNodeHidden (NodeRef Node)
void	writeNode (NodeRef Node)
void	writeEdge (NodeRef Node, unsigned edgeidx, child_iterator EI)
void	emitSimpleNode (const void *ID, const std::string &Attr, const std::string &Label, unsigned NumEdgeSources=0, const std::vector< std::string > *EdgeSourceLabels=nullptr)
	emitSimpleNode - Outputs a simple (non-record) node
void	emitEdge (const void *SrcNodeID, int SrcNodePort, const void *DestNodeID, int DestNodePort, const std::string &Attrs)
	emitEdge - Output an edge from a simple node into the graph...
std::ofstream &	getOStream ()

Private Types
using	DOTTraits = DOTGraphTraits< GraphType >
using	GTraits = GenericGraphTraits< GraphType >
using	NodeRef = typename GTraits::NodeRef
using	node_iterator = typename GTraits::nodes_iterator
using	child_iterator = typename GTraits::ChildIteratorType

Private Member Functions
bool	getEdgeSourceLabels (std::stringstream &O2, NodeRef Node)

Private Attributes
std::ofstream &	O
const GraphType &	G
DOTTraits	DTraits

Detailed Description

template<typename GraphType>
class SVF::GraphWriter< GraphType >

Definition at line 62 of file GraphWriter.h.

Member Typedef Documentation

child_iterator

template<typename GraphType >

using SVF::GraphWriter< GraphType >::child_iterator = typename GTraits::ChildIteratorType

private

Definition at line 71 of file GraphWriter.h.

DOTTraits

template<typename GraphType >

using SVF::GraphWriter< GraphType >::DOTTraits = DOTGraphTraits<GraphType>

private

Definition at line 67 of file GraphWriter.h.

GTraits

template<typename GraphType >

using SVF::GraphWriter< GraphType >::GTraits = GenericGraphTraits<GraphType>

private

Definition at line 68 of file GraphWriter.h.

node_iterator

template<typename GraphType >

using SVF::GraphWriter< GraphType >::node_iterator = typename GTraits::nodes_iterator

private

Definition at line 70 of file GraphWriter.h.

NodeRef

template<typename GraphType >

using SVF::GraphWriter< GraphType >::NodeRef = typename GTraits::NodeRef

private

Definition at line 69 of file GraphWriter.h.

Constructor & Destructor Documentation

GraphWriter()

template<typename GraphType >

SVF::GraphWriter< GraphType >::GraphWriter ( std::ofstream &  o, const GraphType &  g, bool  SN  )

inline

Definition at line 109 of file GraphWriter.h.

                                                             : O(o), G(g)
    {
        DTraits = DOTTraits(SN);
    }

Member Function Documentation

emitEdge()

template<typename GraphType >

void SVF::GraphWriter< GraphType >::emitEdge ( const void *  SrcNodeID, int  SrcNodePort, const void *  DestNodeID, int  DestNodePort, const std::string &  Attrs  )

inline

emitEdge - Output an edge from a simple node into the graph...

Definition at line 300 of file GraphWriter.h.

    {
        if (SrcNodePort  > 64) return;             // Emanating from truncated part?
        if (DestNodePort > 64) DestNodePort = 64;  // Targeting the truncated part?
 
        O << "\tNode" << SrcNodeID;
        if (SrcNodePort >= 0)
            O << ":s" << SrcNodePort;
        O << " -> Node" << DestNodeID;
        if (DestNodePort >= 0 && DTraits.hasEdgeDestLabels())
            O << ":d" << DestNodePort;
 
        if (!Attrs.empty())
            O << "[" << Attrs << "]";
        O << ";\n";
    }

emitSimpleNode()

template<typename GraphType >

void SVF::GraphWriter< GraphType >::emitSimpleNode ( const void *  ID, const std::string &  Attr, const std::string &  Label, unsigned  NumEdgeSources = 0, const std::vector< std::string > *  EdgeSourceLabels = nullptr  )

inline

emitSimpleNode - Outputs a simple (non-record) node

Definition at line 274 of file GraphWriter.h.

    {
        O << "\tNode" << ID << "[ ";
        if (!Attr.empty())
            O << Attr << ",";
        O << " label =\"";
        if (NumEdgeSources) O << "{";
        O << DOT::EscapeStr(Label);
        if (NumEdgeSources)
        {
            O << "|{";
 
            for (unsigned i = 0; i != NumEdgeSources; ++i)
            {
                if (i) O << "|";
                O << "<s" << i << ">";
                if (EdgeSourceLabels) O << DOT::EscapeStr((*EdgeSourceLabels)[i]);
            }
            O << "}}";
        }
        O << "\"];\n";
    }

getEdgeSourceLabels()

template<typename GraphType >

bool SVF::GraphWriter< GraphType >::getEdgeSourceLabels ( std::stringstream &  O2, NodeRef  Node  )

inlineprivate

Definition at line 81 of file GraphWriter.h.

    {
        child_iterator EI = GTraits::child_begin(Node);
        child_iterator EE = GTraits::child_end(Node);
        bool hasEdgeSourceLabels = false;
 
        for (unsigned i = 0; EI != EE && i != 64; ++EI, ++i)
        {
            std::string label = DTraits.getEdgeSourceLabel(Node, EI);
 
            if (label.empty())
                continue;
 
            hasEdgeSourceLabels = true;
 
            if (i)
                O2 << "|";
 
            O2 << "<s" << i << ">" << DOT::EscapeStr(label);
        }
 
        if (EI != EE && hasEdgeSourceLabels)
            O2 << "|<s64>truncated...";
 
        return hasEdgeSourceLabels;
    }

getOStream()

template<typename GraphType >

std::ofstream & SVF::GraphWriter< GraphType >::getOStream ( )

inline

getOStream - Get the raw output stream into the graph file. Useful to write fancy things using addCustomGraphFeatures().

Definition at line 321 of file GraphWriter.h.

    {
        return O;
    }

isNodeHidden()

template<typename GraphType >

bool SVF::GraphWriter< GraphType >::isNodeHidden ( NodeRef  Node )

inline

Definition at line 165 of file GraphWriter.h.

    {
        return DTraits.isNodeHidden(Node, G);
    }

writeEdge()

template<typename GraphType >

void SVF::GraphWriter< GraphType >::writeEdge ( NodeRef  Node, unsigned  edgeidx, child_iterator  EI  )

inline

Definition at line 249 of file GraphWriter.h.

    {
        if (NodeRef TargetNode = *EI)
        {
            int DestPort = -1;
            if (DTraits.edgeTargetsEdgeSource(Node, EI))
            {
                child_iterator TargetIt = DTraits.getEdgeTarget(Node, EI);
 
                // Figure out which edge this targets...
                unsigned Offset =
                    (unsigned)std::distance(GTraits::child_begin(TargetNode), TargetIt);
                DestPort = static_cast<int>(Offset);
            }
 
            if (DTraits.getEdgeSourceLabel(Node, EI).empty())
                edgeidx = -1;
 
            emitEdge(static_cast<const void*>(Node), edgeidx,
                     static_cast<const void*>(TargetNode), DestPort,
                     DTraits.getEdgeAttributes(Node, EI, G));
        }
    }

writeFooter()

template<typename GraphType >

void SVF::GraphWriter< GraphType >::writeFooter ( )

inline

Definition at line 151 of file GraphWriter.h.

    {
        // Finish off the graph
        O << "}\n";
    }

writeGraph()

template<typename GraphType >

void SVF::GraphWriter< GraphType >::writeGraph ( const std::string &  Title = "" )

inline

Definition at line 114 of file GraphWriter.h.

    {
        // Output the header for the graph...
        writeHeader(Title);
 
        // Emit all of the nodes in the graph...
        writeNodes();
 
        // Output any customizations on the graph
        DOTGraphTraits<GraphType>::addCustomGraphFeatures(G, *this);
 
        // Output the end of the graph
        writeFooter();
    }

writeHeader()

template<typename GraphType >

void SVF::GraphWriter< GraphType >::writeHeader ( const std::string &  Title )

inline

Definition at line 129 of file GraphWriter.h.

    {
        std::string GraphName(DTraits.getGraphName(G));
 
        if (!Title.empty())
            O << "digraph \"" << DOT::EscapeStr(Title) << "\" {\n";
        else if (!GraphName.empty())
            O << "digraph \"" << DOT::EscapeStr(GraphName) << "\" {\n";
        else
            O << "digraph unnamed {\n";
 
        if (DTraits.renderGraphFromBottomUp())
            O << "\trankdir=\"BT\";\n";
 
        if (!Title.empty())
            O << "\tlabel=\"" << DOT::EscapeStr(Title) << "\";\n";
        else if (!GraphName.empty())
            O << "\tlabel=\"" << DOT::EscapeStr(GraphName) << "\";\n";
        O << DTraits.getGraphProperties(G);
        O << "\n";
    }

writeNode()

template<typename GraphType >

void SVF::GraphWriter< GraphType >::writeNode ( NodeRef  Node )

inline

Definition at line 170 of file GraphWriter.h.

    {
        std::string NodeAttributes = DTraits.getNodeAttributes(Node, G);
 
        O << "\tNode" << static_cast<const void*>(Node) << " [shape=record,";
        if (!NodeAttributes.empty()) O << NodeAttributes << ",";
        O << "label=\"{";
 
        if (!DTraits.renderGraphFromBottomUp())
        {
            O << DOT::EscapeStr(DTraits.getNodeLabel(Node, G));
 
            // If we should include the address of the node in the label, do so now.
            std::string Id = DTraits.getNodeIdentifierLabel(Node, G);
            if (!Id.empty())
                O << "|" << DOT::EscapeStr(Id);
 
            std::string NodeDesc = DTraits.getNodeDescription(Node, G);
            if (!NodeDesc.empty())
                O << "|" << DOT::EscapeStr(NodeDesc);
        }
 
        std::string edgeSourceLabels;
        std::stringstream EdgeSourceLabels(edgeSourceLabels);
        bool hasEdgeSourceLabels = getEdgeSourceLabels(EdgeSourceLabels, Node);
 
        if (hasEdgeSourceLabels)
        {
            if (!DTraits.renderGraphFromBottomUp()) O << "|";
 
            O << "{" << EdgeSourceLabels.str() << "}";
 
            if (DTraits.renderGraphFromBottomUp()) O << "|";
        }
 
        if (DTraits.renderGraphFromBottomUp())
        {
            O << DOT::EscapeStr(DTraits.getNodeLabel(Node, G));
 
            // If we should include the address of the node in the label, do so now.
            std::string Id = DTraits.getNodeIdentifierLabel(Node, G);
            if (!Id.empty())
                O << "|" << DOT::EscapeStr(Id);
 
            std::string NodeDesc = DTraits.getNodeDescription(Node, G);
            if (!NodeDesc.empty())
                O << "|" << DOT::EscapeStr(NodeDesc);
        }
 
        if (DTraits.hasEdgeDestLabels())
        {
            O << "|{";
 
            unsigned i = 0, e = DTraits.numEdgeDestLabels(Node);
            for (; i != e && i != 64; ++i)
            {
                if (i) O << "|";
                O << "<d" << i << ">"
                  << DOT::EscapeStr(DTraits.getEdgeDestLabel(Node, i));
            }
 
            if (i != e)
                O << "|<d64>truncated...";
            O << "}";
        }
 
        O << "}\"];\n";   // Finish printing the "node" line
 
        // Output all of the edges now
        child_iterator EI = GTraits::child_begin(Node);
        child_iterator EE = GTraits::child_end(Node);
        for (unsigned i = 0; EI != EE && i != 64; ++EI, ++i)
            if (!DTraits.isNodeHidden(*EI, G))
                writeEdge(Node, i, EI);
        for (; EI != EE; ++EI)
            if (!DTraits.isNodeHidden(*EI, G))
                writeEdge(Node, 64, EI);
    }

writeNodes()

template<typename GraphType >

void SVF::GraphWriter< GraphType >::writeNodes ( )

inline

Definition at line 157 of file GraphWriter.h.

    {
        // Loop over the graph, printing it out...
        for (const auto Node : nodes<GraphType>(G))
            if (!isNodeHidden(Node))
                writeNode(Node);
    }

Member Data Documentation

DTraits

template<typename GraphType >

DOTTraits SVF::GraphWriter< GraphType >::DTraits

private

Definition at line 72 of file GraphWriter.h.

G

template<typename GraphType >

const GraphType& SVF::GraphWriter< GraphType >::G

private

Definition at line 65 of file GraphWriter.h.

O

template<typename GraphType >

std::ofstream& SVF::GraphWriter< GraphType >::O

private

Definition at line 64 of file GraphWriter.h.

---

The documentation for this class was generated from the following file:

• /home/runner/work/SVF/SVF/svf/include/Graphs/GraphWriter.h