#include <GenericGraph.h>

Inheritance diagram for SVF::GenericNode< NodeTy, EdgeTy >:

Public Types
typedef NodeTy	NodeType
typedef EdgeTy	EdgeType
typedef OrderedSet< EdgeType *, typename EdgeType::equalGEdge >	GEdgeSetTy
	Edge kind.

typedef GEdgeSetTy::iterator	iterator
typedef GEdgeSetTy::const_iterator	const_iterator
Public Types inherited from SVF::SVFValue
enum	GNodeK { IntraBlock , GlobalBlock , FunEntryBlock , FunExitBlock , FunCallBlock , FunRetBlock , ValNode , ArgValNode , FunValNode , GepValNode , RetValNode , VarargValNode , GlobalValNode , ConstDataValNode , BlackHoleValNode , ConstFPValNode , ConstIntValNode , ConstNullptrValNode , DummyValNode , IntrinsicValNode , AsmPCValNode , ObjNode , GepObjNode , BaseObjNode , FunObjNode , HeapObjNode , StackObjNode , GlobalObjNode , ConstDataObjNode , ConstFPObjNode , ConstIntObjNode , ConstNullptrObjNode , DummyObjNode , Cmp , BinaryOp , UnaryOp , Branch , DummyVProp , NPtr , FRet , ARet , AParm , FParm , Addr , Copy , Gep , Store , Load , TPhi , TIntraPhi , TInterPhi , FPIN , FPOUT , APIN , APOUT , MPhi , MIntraPhi , MInterPhi , CallNodeKd , CDNodeKd , CFLNodeKd , CHNodeKd , ConstraintNodeKd , TCTNodeKd , BasicBlockKd , OtherKd }

Public Member Functions
	GenericNode (NodeID i, GNodeK k, const SVFType *svfType=nullptr)
	Constructor.
virtual	~GenericNode ()
	Destructor.
bool	hasIncomingEdge () const
	Has incoming/outgoing edge set.
bool	hasOutgoingEdge () const
iterator	OutEdgeBegin ()
	iterators
iterator	OutEdgeEnd ()
iterator	InEdgeBegin ()
iterator	InEdgeEnd ()
const_iterator	OutEdgeBegin () const
const_iterator	OutEdgeEnd () const
const_iterator	InEdgeBegin () const
const_iterator	InEdgeEnd () const
virtual iterator	directOutEdgeBegin ()
	Iterators used for SCC detection, overwrite it in child class if necessary.
virtual iterator	directOutEdgeEnd ()
virtual iterator	directInEdgeBegin ()
virtual iterator	directInEdgeEnd ()
virtual const_iterator	directOutEdgeBegin () const
virtual const_iterator	directOutEdgeEnd () const
virtual const_iterator	directInEdgeBegin () const
virtual const_iterator	directInEdgeEnd () const
bool	addIncomingEdge (EdgeType *inEdge)
	Add incoming and outgoing edges.
bool	addOutgoingEdge (EdgeType *outEdge)
EdgeType *	hasIncomingEdge (EdgeType *edge) const
	Find incoming and outgoing edges.
EdgeType *	hasOutgoingEdge (EdgeType *edge) const

const GEdgeSetTy &	getOutEdges () const
const GEdgeSetTy &	getInEdges () const

u32_t	removeIncomingEdge (EdgeType *edge)
u32_t	removeOutgoingEdge (EdgeType *edge)
Public Member Functions inherited from SVF::SVFValue
	SVFValue (NodeID i, GNodeK k, const SVFType *ty=nullptr)
NodeID	getId () const
	Get ID.
GNodeK	getNodeKind () const
	Get node kind.
virtual const SVFType *	getType () const
virtual void	setName (const std::string &nameInfo)
virtual void	setName (std::string &&nameInfo)
virtual const std::string &	getName () const
virtual void	setSourceLoc (const std::string &sourceCodeInfo)
virtual const std::string	getSourceLoc () const
const std::string	valueOnlyToString () const
const bool	hasLLVMValue () const

Static Public Member Functions
static bool	classof (const GenericNode< NodeTy, EdgeTy > *)
static bool	classof (const SVFValue *)

Private Attributes
GEdgeSetTy	InEdges
	all incoming edge of this node
GEdgeSetTy	OutEdges
	all outgoing edge of this node

Additional Inherited Members
Static Protected Member Functions inherited from SVF::SVFValue
static bool	isICFGNodeKinds (GNodeK n)
	Helper functions to check node kinds.
static bool	isInterICFGNodeKind (GNodeK n)
static bool	isSVFVarKind (GNodeK n)
static bool	isValVarKinds (GNodeK n)
static bool	isConstantDataValVar (GNodeK n)
static bool	isObjVarKinds (GNodeK n)
static bool	isBaseObjVarKinds (GNodeK n)
static bool	isConstantDataObjVarKinds (GNodeK n)
static bool	isVFGNodeKinds (GNodeK n)
static bool	isArgumentVFGNodeKinds (GNodeK n)
static bool	isStmtVFGNodeKinds (GNodeK n)
static bool	isPHIVFGNodeKinds (GNodeK n)
static bool	isMRSVFGNodeKinds (GNodeK n)
static bool	isMSSAPHISVFGNodeKinds (GNodeK n)
Protected Attributes inherited from SVF::SVFValue
NodeID	id
	Node ID.
GNodeK	nodeKind
	Node kind.
const SVFType *	type
	SVF type.
std::string	name
std::string	sourceLoc
	Source code information of this value.

Detailed Description

template<class NodeTy, class EdgeTy>
class SVF::GenericNode< NodeTy, EdgeTy >

Generic node on the graph as base class

Definition at line 141 of file GenericGraph.h.

Member Typedef Documentation

◆ const_iterator

template<class NodeTy, class EdgeTy>

typedef GEdgeSetTy::const_iterator SVF::GenericNode< NodeTy, EdgeTy >::const_iterator

Definition at line 152 of file GenericGraph.h.

◆ EdgeType

template<class NodeTy, class EdgeTy>

typedef EdgeTy SVF::GenericNode< NodeTy, EdgeTy >::EdgeType

Definition at line 146 of file GenericGraph.h.

◆ GEdgeSetTy

template<class NodeTy, class EdgeTy>

typedef OrderedSet<EdgeType*, typename EdgeType::equalGEdge> SVF::GenericNode< NodeTy, EdgeTy >::GEdgeSetTy

Edge kind.

Definition at line 148 of file GenericGraph.h.

◆ iterator

template<class NodeTy, class EdgeTy>

typedef GEdgeSetTy::iterator SVF::GenericNode< NodeTy, EdgeTy >::iterator

Edge iterator

Definition at line 151 of file GenericGraph.h.

◆ NodeType

template<class NodeTy, class EdgeTy>

typedef NodeTy SVF::GenericNode< NodeTy, EdgeTy >::NodeType

Definition at line 145 of file GenericGraph.h.

Constructor & Destructor Documentation

◆ GenericNode()

template<class NodeTy, class EdgeTy>

SVF::GenericNode< NodeTy, EdgeTy >::GenericNode	(	NodeID	i,
		GNodeK	k,
		const SVFType *	svfType = nullptr )

inline

Constructor.

Definition at line 162 of file GenericGraph.h.

                                                                     : SVFValue(i, k, svfType)
    {
 
    }

◆ ~GenericNode()

template<class NodeTy, class EdgeTy>

virtual SVF::GenericNode< NodeTy, EdgeTy >::~GenericNode ( )

inlinevirtual

Destructor.

Definition at line 168 of file GenericGraph.h.

    {
        for (auto * edge : OutEdges)
            delete edge;
    }

Member Function Documentation

◆ addIncomingEdge()

template<class NodeTy, class EdgeTy>

bool SVF::GenericNode< NodeTy, EdgeTy >::addIncomingEdge ( EdgeType * inEdge )

inline

Add incoming and outgoing edges.

Definition at line 273 of file GenericGraph.h.

    {
        return InEdges.insert(inEdge).second;
    }

◆ addOutgoingEdge()

template<class NodeTy, class EdgeTy>

bool SVF::GenericNode< NodeTy, EdgeTy >::addOutgoingEdge ( EdgeType * outEdge )

inline

Definition at line 277 of file GenericGraph.h.

    {
        return OutEdges.insert(outEdge).second;
    }

◆ classof() [1/2]

template<class NodeTy, class EdgeTy>

bool SVF::GenericNode< NodeTy, EdgeTy >::classof ( const GenericNode< NodeTy, EdgeTy > * )

inlinestatic

Definition at line 321 of file GenericGraph.h.

    {
        return true;
    }

◆ classof() [2/2]

template<class NodeTy, class EdgeTy>

bool SVF::GenericNode< NodeTy, EdgeTy >::classof ( const SVFValue * )

inlinestatic

Definition at line 326 of file GenericGraph.h.

    {
        return true;
    }

◆ directInEdgeBegin() [1/2]

template<class NodeTy, class EdgeTy>

virtual iterator SVF::GenericNode< NodeTy, EdgeTy >::directInEdgeBegin ( )

inlinevirtual

Reimplemented in SVF::ConstraintNode.

Definition at line 244 of file GenericGraph.h.

    {
        return InEdges.begin();
    }

◆ directInEdgeBegin() [2/2]

template<class NodeTy, class EdgeTy>

virtual const_iterator SVF::GenericNode< NodeTy, EdgeTy >::directInEdgeBegin ( ) const

inlinevirtual

Reimplemented in SVF::ConstraintNode.

Definition at line 261 of file GenericGraph.h.

    {
        return InEdges.begin();
    }

◆ directInEdgeEnd() [1/2]

template<class NodeTy, class EdgeTy>

virtual iterator SVF::GenericNode< NodeTy, EdgeTy >::directInEdgeEnd ( )

inlinevirtual

Reimplemented in SVF::ConstraintNode.

Definition at line 248 of file GenericGraph.h.

    {
        return InEdges.end();
    }

◆ directInEdgeEnd() [2/2]

template<class NodeTy, class EdgeTy>

virtual const_iterator SVF::GenericNode< NodeTy, EdgeTy >::directInEdgeEnd ( ) const

inlinevirtual

Reimplemented in SVF::ConstraintNode.

Definition at line 265 of file GenericGraph.h.

    {
        return InEdges.end();
    }

◆ directOutEdgeBegin() [1/2]

template<class NodeTy, class EdgeTy>

virtual iterator SVF::GenericNode< NodeTy, EdgeTy >::directOutEdgeBegin ( )

inlinevirtual

Iterators used for SCC detection, overwrite it in child class if necessary.

Reimplemented in SVF::ConstraintNode.

Definition at line 236 of file GenericGraph.h.

    {
        return OutEdges.begin();
    }

◆ directOutEdgeBegin() [2/2]

template<class NodeTy, class EdgeTy>

virtual const_iterator SVF::GenericNode< NodeTy, EdgeTy >::directOutEdgeBegin ( ) const

inlinevirtual

Reimplemented in SVF::ConstraintNode.

Definition at line 253 of file GenericGraph.h.

    {
        return OutEdges.begin();
    }

◆ directOutEdgeEnd() [1/2]

template<class NodeTy, class EdgeTy>

virtual iterator SVF::GenericNode< NodeTy, EdgeTy >::directOutEdgeEnd ( )

inlinevirtual

Reimplemented in SVF::ConstraintNode.

Definition at line 240 of file GenericGraph.h.

    {
        return OutEdges.end();
    }

◆ directOutEdgeEnd() [2/2]

template<class NodeTy, class EdgeTy>

virtual const_iterator SVF::GenericNode< NodeTy, EdgeTy >::directOutEdgeEnd ( ) const

inlinevirtual

Reimplemented in SVF::ConstraintNode.

Definition at line 257 of file GenericGraph.h.

    {
        return OutEdges.end();
    }

◆ getInEdges()

template<class NodeTy, class EdgeTy>

const GEdgeSetTy & SVF::GenericNode< NodeTy, EdgeTy >::getInEdges ( ) const

inline

Definition at line 180 of file GenericGraph.h.

    {
        return InEdges;
    }

◆ getOutEdges()

template<class NodeTy, class EdgeTy>

const GEdgeSetTy & SVF::GenericNode< NodeTy, EdgeTy >::getOutEdges ( ) const

inline

Get incoming/outgoing edge set

Definition at line 176 of file GenericGraph.h.

    {
        return OutEdges;
    }

◆ hasIncomingEdge() [1/2]

template<class NodeTy, class EdgeTy>

bool SVF::GenericNode< NodeTy, EdgeTy >::hasIncomingEdge ( ) const

inline

Has incoming/outgoing edge set.

Definition at line 188 of file GenericGraph.h.

    {
        return (InEdges.empty() == false);
    }

◆ hasIncomingEdge() [2/2]

template<class NodeTy, class EdgeTy>

EdgeType * SVF::GenericNode< NodeTy, EdgeTy >::hasIncomingEdge ( EdgeType * edge ) const

inline

Find incoming and outgoing edges.

Definition at line 303 of file GenericGraph.h.

    {
        const_iterator it = InEdges.find(edge);
        if (it != InEdges.end())
            return *it;
        else
            return nullptr;
    }

◆ hasOutgoingEdge() [1/2]

template<class NodeTy, class EdgeTy>

bool SVF::GenericNode< NodeTy, EdgeTy >::hasOutgoingEdge ( ) const

inline

Definition at line 192 of file GenericGraph.h.

    {
        return (OutEdges.empty() == false);
    }

◆ hasOutgoingEdge() [2/2]

template<class NodeTy, class EdgeTy>

EdgeType * SVF::GenericNode< NodeTy, EdgeTy >::hasOutgoingEdge ( EdgeType * edge ) const

inline

Definition at line 311 of file GenericGraph.h.

    {
        const_iterator it = OutEdges.find(edge);
        if (it != OutEdges.end())
            return *it;
        else
            return nullptr;
    }

◆ InEdgeBegin() [1/2]

template<class NodeTy, class EdgeTy>

iterator SVF::GenericNode< NodeTy, EdgeTy >::InEdgeBegin ( )

inline

Definition at line 208 of file GenericGraph.h.

    {
        return InEdges.begin();
    }

◆ InEdgeBegin() [2/2]

template<class NodeTy, class EdgeTy>

const_iterator SVF::GenericNode< NodeTy, EdgeTy >::InEdgeBegin ( ) const

inline

Definition at line 224 of file GenericGraph.h.

    {
        return InEdges.begin();
    }

◆ InEdgeEnd() [1/2]

template<class NodeTy, class EdgeTy>

iterator SVF::GenericNode< NodeTy, EdgeTy >::InEdgeEnd ( )

inline

Definition at line 212 of file GenericGraph.h.

    {
        return InEdges.end();
    }

◆ InEdgeEnd() [2/2]

template<class NodeTy, class EdgeTy>

const_iterator SVF::GenericNode< NodeTy, EdgeTy >::InEdgeEnd ( ) const

inline

Definition at line 228 of file GenericGraph.h.

    {
        return InEdges.end();
    }

◆ OutEdgeBegin() [1/2]

template<class NodeTy, class EdgeTy>

iterator SVF::GenericNode< NodeTy, EdgeTy >::OutEdgeBegin ( )

inline

iterators

Definition at line 200 of file GenericGraph.h.

    {
        return OutEdges.begin();
    }

◆ OutEdgeBegin() [2/2]

template<class NodeTy, class EdgeTy>

const_iterator SVF::GenericNode< NodeTy, EdgeTy >::OutEdgeBegin ( ) const

inline

Definition at line 216 of file GenericGraph.h.

    {
        return OutEdges.begin();
    }

◆ OutEdgeEnd() [1/2]

template<class NodeTy, class EdgeTy>

iterator SVF::GenericNode< NodeTy, EdgeTy >::OutEdgeEnd ( )

inline

Definition at line 204 of file GenericGraph.h.

    {
        return OutEdges.end();
    }

◆ OutEdgeEnd() [2/2]

template<class NodeTy, class EdgeTy>

const_iterator SVF::GenericNode< NodeTy, EdgeTy >::OutEdgeEnd ( ) const

inline

Definition at line 220 of file GenericGraph.h.

    {
        return OutEdges.end();
    }

◆ removeIncomingEdge()

template<class NodeTy, class EdgeTy>

u32_t SVF::GenericNode< NodeTy, EdgeTy >::removeIncomingEdge ( EdgeType * edge )

inline

Remove incoming and outgoing edges

Definition at line 285 of file GenericGraph.h.

    {
        iterator it = InEdges.find(edge);
        assert(it != InEdges.end() && "can not find in edge in SVFG node");
        InEdges.erase(it);
        return 1;
    }

◆ removeOutgoingEdge()

template<class NodeTy, class EdgeTy>

u32_t SVF::GenericNode< NodeTy, EdgeTy >::removeOutgoingEdge ( EdgeType * edge )

inline

Definition at line 292 of file GenericGraph.h.

    {
        iterator it = OutEdges.find(edge);
        assert(it != OutEdges.end() && "can not find out edge in SVFG node");
        OutEdges.erase(it);
        return 1;
    }

Member Data Documentation

◆ InEdges

template<class NodeTy, class EdgeTy>

GEdgeSetTy SVF::GenericNode< NodeTy, EdgeTy >::InEdges

private

all incoming edge of this node

Definition at line 157 of file GenericGraph.h.

◆ OutEdges

template<class NodeTy, class EdgeTy>

GEdgeSetTy SVF::GenericNode< NodeTy, EdgeTy >::OutEdges

private

all outgoing edge of this node

Definition at line 158 of file GenericGraph.h.

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

/home/runner/work/SVF/SVF/svf/include/Graphs/GenericGraph.h

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ EdgeType

◆ GEdgeSetTy

◆ iterator

◆ NodeType

Constructor & Destructor Documentation

◆ GenericNode()

◆ ~GenericNode()

Member Function Documentation

◆ addIncomingEdge()

◆ addOutgoingEdge()

◆ classof() [1/2]

◆ classof() [2/2]

◆ directInEdgeBegin() [1/2]

◆ directInEdgeBegin() [2/2]

◆ directInEdgeEnd() [1/2]

◆ directInEdgeEnd() [2/2]

◆ directOutEdgeBegin() [1/2]

◆ directOutEdgeBegin() [2/2]

◆ directOutEdgeEnd() [1/2]

◆ directOutEdgeEnd() [2/2]

◆ getInEdges()

◆ getOutEdges()

◆ hasIncomingEdge() [1/2]

◆ hasIncomingEdge() [2/2]

◆ hasOutgoingEdge() [1/2]

◆ hasOutgoingEdge() [2/2]

◆ InEdgeBegin() [1/2]

◆ InEdgeBegin() [2/2]

◆ InEdgeEnd() [1/2]

◆ InEdgeEnd() [2/2]

◆ OutEdgeBegin() [1/2]

◆ OutEdgeBegin() [2/2]

◆ OutEdgeEnd() [1/2]

◆ OutEdgeEnd() [2/2]

◆ removeIncomingEdge()

◆ removeOutgoingEdge()

Member Data Documentation

◆ InEdges

◆ OutEdges