Package de.fraunhofer.aisec.cpg.graph.types

Class PointerType

java.lang.Object

de.fraunhofer.aisec.cpg.graph.Node

de.fraunhofer.aisec.cpg.graph.types.Type

de.fraunhofer.aisec.cpg.graph.types.PointerType

All Implemented Interfaces:

Persistable, SecondOrderType, IVisitable<Node>

public class PointerType
extends Type
implements SecondOrderType

PointerTypes represent all references to other Types. For C/CPP this includes pointers, as well as arrays, since technically arrays are pointers. For JAVA the only use case are arrays as there is no such pointer concept.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PointerType.PointerOrigin

Nested classes/interfaces inherited from class de.fraunhofer.aisec.cpg.graph.types.Type

Type.Origin, Type.Qualifier, Type.Storage

Field Summary

Fields inherited from class de.fraunhofer.aisec.cpg.graph.types.Type

origin, primitive, qualifier, storage, superTypes, UNKNOWN_TYPE_STRING

Fields inherited from class de.fraunhofer.aisec.cpg.graph.Node

annotations, code, comment, dummy, EMPTY_NAME, file, implicit, location, log, name, nextCFG, nextDFG, nextEOG, prevDFG, prevEOG, TO_STRING_STYLE, typedefs

Constructor Summary

Constructors

Constructor	Description
PointerType(Type elementType, PointerType.PointerOrigin pointerOrigin)
PointerType(Type type, Type elementType, PointerType.PointerOrigin pointerOrigin)

Method Summary

Modifier and Type	Method	Description
Type	dereference()
Type	duplicate()
boolean	equals(java.lang.Object o)
Type	getElementType()
PointerType.PointerOrigin	getPointerOrigin()
int	getReferenceDepth()
int	hashCode()
boolean	isArray()
boolean	isSimilar(Type t)	Required for possibleSubTypes to check if the new Type should be considered a subtype or not
PointerType	reference(PointerType.PointerOrigin origin)
void	refreshNames()
void	setElementType(Type elementType)
java.lang.String	toString()

Methods inherited from class de.fraunhofer.aisec.cpg.graph.types.Type

getQualifier, getRoot, getStorage, getSuperTypes, getTypeName, getTypeOrigin, isFirstOrderType, isPrimitive, setAdditionalTypeKeywords, setQualifier, setRoot, setStorage, setTypeOrigin

Methods inherited from class de.fraunhofer.aisec.cpg.graph.Node

addAnnotations, addNextCFG, addNextCFG, addNextDFG, addNextEOG, addPrevDFG, addPrevEOG, addTypedef, clearNextEOG, disconnectFromGraph, getAnnotations, getArgumentIndex, getCode, getFile, getId, getLocation, getName, getNextCFG, getNextDFG, getNextEOG, getNextEOGProperties, getNextEOGPropertyEdge, getPrevDFG, getPrevEOG, getPrevEOGProperties, getTypedefs, isDummy, isImplicit, removeNextDFG, removePrevDFG, removePrevEOGEntries, removePrevEOGEntry, setArgumentIndex, setCode, setComment, setDummy, setFile, setImplicit, setLocation, setName, setNextDFG, setNextEOG, setPrevDFG, setPrevEOG, setPrevEOGProperties, setTypedefs

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.fraunhofer.aisec.cpg.processing.IVisitable

accept

Constructor Detail

PointerType

public PointerType(Type elementType,
                   PointerType.PointerOrigin pointerOrigin)

PointerType

public PointerType(Type type,
                   Type elementType,
                   PointerType.PointerOrigin pointerOrigin)

Method Detail

reference

public PointerType reference(PointerType.PointerOrigin origin)

Specified by:

reference in class Type

Parameters:

origin - Reason for the reference (array of pointer)

Returns:

referencing a PointerType results in another PointerType wrapping the first PointerType, e.g. int**

dereference

public Type dereference()

Specified by:

dereference in class Type

Returns:

dereferencing a PointerType yields the type the pointer was pointing towards

refreshNames

public void refreshNames()

Overrides:

refreshNames in class Type

duplicate

public Type duplicate()

Specified by:

duplicate in class Type

Returns:

Creates an exact copy of the current type (chain)

isArray

public boolean isArray()

isSimilar

public boolean isSimilar(Type t)

Description copied from class: Type

Required for possibleSubTypes to check if the new Type should be considered a subtype or not

Overrides:

isSimilar in class Type

Parameters:

t - other type the similarity is checked with

Returns:

True if the parameter t is equal to the current type (this)

getPointerOrigin

public PointerType.PointerOrigin getPointerOrigin()

getElementType

public Type getElementType()

Specified by:

getElementType in interface SecondOrderType

getReferenceDepth

public int getReferenceDepth()

Overrides:

getReferenceDepth in class Type

Returns:

number of steps that are required in order to traverse the type chain until the root is reached

setElementType

public void setElementType(Type elementType)

Specified by:

setElementType in interface SecondOrderType

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class Type

hashCode

public int hashCode()

Overrides:

hashCode in class Type

toString

public java.lang.String toString()

Overrides:

toString in class Type