Package de.fraunhofer.aisec.cpg.graph.declarations

Class FunctionDeclaration

java.lang.Object

de.fraunhofer.aisec.cpg.graph.Node

de.fraunhofer.aisec.cpg.graph.declarations.Declaration

de.fraunhofer.aisec.cpg.graph.declarations.ValueDeclaration

de.fraunhofer.aisec.cpg.graph.declarations.FunctionDeclaration

All Implemented Interfaces:

DeclarationHolder, HasType, Persistable, IVisitable<Node>

Direct Known Subclasses:

MethodDeclaration

public class FunctionDeclaration
extends ValueDeclaration
implements DeclarationHolder

Represents the declaration or definition of a function.

Nested Class Summary

Nested classes/interfaces inherited from interface de.fraunhofer.aisec.cpg.graph.HasType

HasType.TypeListener

Field Summary

Fields

Modifier and Type	Field	Description
protected Statement	body	The function body.
protected java.util.List<PropertyEdge<ParamVariableDeclaration>>	parameters	The list of function parameters.
protected java.util.List<PropertyEdge<RecordDeclaration>>	records	Classes and Structs can be declared inside a function and are only valid within the function.
protected java.util.List<PropertyEdge<Type>>	throwsTypes

Fields inherited from class de.fraunhofer.aisec.cpg.graph.declarations.ValueDeclaration

possibleSubTypes, type

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
FunctionDeclaration()

Method Summary

Modifier and Type	Method	Description
void	addDeclaration(@NonNull Declaration declaration)	Adds the specified declaration to this declaration holder.
void	addOverriddenBy(FunctionDeclaration functionDeclaration)
void	addOverriddenBy(java.util.Collection<? extends FunctionDeclaration> c)
void	addOverrides(FunctionDeclaration functionDeclaration)
void	addParameter(ParamVariableDeclaration paramVariableDeclaration)
void	addThrowTypes(Type type)
void	addThrowTypes(java.util.Collection<Type> collection)
boolean	equals(java.lang.Object o)
Statement	getBody()
<T> @Nullable T	getBodyStatementAs(int i, java.lang.Class<T> clazz)
FunctionDeclaration	getDefinition()
java.util.List<FunctionDeclaration>	getOverriddenBy()
java.util.List<PropertyEdge<FunctionDeclaration>>	getOverriddenByPropertyEdge()
java.util.List<FunctionDeclaration>	getOverrides()
java.util.List<PropertyEdge<FunctionDeclaration>>	getOverridesPropertyEdge()
java.util.List<ParamVariableDeclaration>	getParameters()
java.util.List<PropertyEdge<ParamVariableDeclaration>>	getParametersPropertyEdge()
java.util.List<RecordDeclaration>	getRecords()
java.util.List<PropertyEdge<RecordDeclaration>>	getRecordsPropertyEdge()
java.lang.String	getSignature()
java.util.List<Type>	getSignatureTypes()
java.util.List<Type>	getThrowsTypes()
java.util.List<PropertyEdge<Type>>	getThrowsTypesPropertyEdge()
java.util.Optional<VariableDeclaration>	getVariableDeclarationByName(java.lang.String name)	Looks for a variable declaration by the given name.
boolean	hasBody()
int	hashCode()
boolean	hasSignature(java.util.List<Type> targetSignature)
boolean	isDefinition()
boolean	isOverrideCandidate(FunctionDeclaration other)
void	removeParameter(ParamVariableDeclaration paramVariableDeclaration)
void	setBody(Statement body)
void	setDefinition(FunctionDeclaration definition)
void	setIsDefinition(boolean definition)
void	setParameters(java.util.List<ParamVariableDeclaration> parameters)
void	setRecords(java.util.List<RecordDeclaration> records)
void	setThrowsTypes(java.util.List<Type> throwsTypes)
java.lang.String	toString()

Methods inherited from class de.fraunhofer.aisec.cpg.graph.declarations.ValueDeclaration

getPossibleSubTypes, getPropagationType, getType, getTypeListeners, refreshType, registerTypeListener, resetTypes, setPossibleSubTypes, setType, unregisterTypeListener, updatePossibleSubtypes, updateType

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.graph.DeclarationHolder

addIfNotContains, addIfNotContains, addIfNotContains

Methods inherited from interface de.fraunhofer.aisec.cpg.graph.HasType

setPossibleSubTypes, setType

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

accept

Field Detail

body

protected Statement body

The function body. Usually a CompoundStatement.

records

protected java.util.List<PropertyEdge<RecordDeclaration>> records

Classes and Structs can be declared inside a function and are only valid within the function.

parameters

protected java.util.List<PropertyEdge<ParamVariableDeclaration>> parameters

The list of function parameters.

throwsTypes

protected java.util.List<PropertyEdge<Type>> throwsTypes

Constructor Detail

FunctionDeclaration

public FunctionDeclaration()

Method Detail

hasBody

public boolean hasBody()

getSignature

public java.lang.String getSignature()

hasSignature

public boolean hasSignature(java.util.List<Type> targetSignature)

isOverrideCandidate

public boolean isOverrideCandidate(FunctionDeclaration other)

getOverriddenBy

public java.util.List<FunctionDeclaration> getOverriddenBy()

getOverriddenByPropertyEdge

public java.util.List<PropertyEdge<FunctionDeclaration>> getOverriddenByPropertyEdge()

addOverriddenBy

public void addOverriddenBy(java.util.Collection<? extends FunctionDeclaration> c)

addOverriddenBy

public void addOverriddenBy(FunctionDeclaration functionDeclaration)

getOverrides

public java.util.List<FunctionDeclaration> getOverrides()

getOverridesPropertyEdge

public java.util.List<PropertyEdge<FunctionDeclaration>> getOverridesPropertyEdge()

addOverrides

public void addOverrides(FunctionDeclaration functionDeclaration)

getThrowsTypes

public java.util.List<Type> getThrowsTypes()

getThrowsTypesPropertyEdge

public java.util.List<PropertyEdge<Type>> getThrowsTypesPropertyEdge()

setThrowsTypes

public void setThrowsTypes(java.util.List<Type> throwsTypes)

addThrowTypes

public void addThrowTypes(Type type)

addThrowTypes

public void addThrowTypes(java.util.Collection<Type> collection)

getBody

public Statement getBody()

getBodyStatementAs

public <T> @Nullable T getBodyStatementAs(int i,
                                          java.lang.Class<T> clazz)

setBody

public void setBody(Statement body)

getParameters

public java.util.List<ParamVariableDeclaration> getParameters()

getSignatureTypes

public java.util.List<Type> getSignatureTypes()

getParametersPropertyEdge

public java.util.List<PropertyEdge<ParamVariableDeclaration>> getParametersPropertyEdge()

addParameter

public void addParameter(ParamVariableDeclaration paramVariableDeclaration)

removeParameter

public void removeParameter(ParamVariableDeclaration paramVariableDeclaration)

setParameters

public void setParameters(java.util.List<ParamVariableDeclaration> parameters)

getVariableDeclarationByName

public java.util.Optional<VariableDeclaration> getVariableDeclarationByName(java.lang.String name)

Looks for a variable declaration by the given name.

Parameters:

name - the name of the variable

Returns:

an optional value containing the variable declaration if found

toString

public java.lang.String toString()

Overrides:

toString in class ValueDeclaration

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class ValueDeclaration

hashCode

public int hashCode()

Overrides:

hashCode in class ValueDeclaration

getDefinition

public FunctionDeclaration getDefinition()

isDefinition

public boolean isDefinition()

setIsDefinition

public void setIsDefinition(boolean definition)

setDefinition

public void setDefinition(FunctionDeclaration definition)

getRecords

public java.util.List<RecordDeclaration> getRecords()

getRecordsPropertyEdge

public java.util.List<PropertyEdge<RecordDeclaration>> getRecordsPropertyEdge()

setRecords

public void setRecords(java.util.List<RecordDeclaration> records)

addDeclaration

public void addDeclaration(@NonNull Declaration declaration)

Description copied from interface: DeclarationHolder

Adds the specified declaration to this declaration holder. Ideally, the declaration holder should use the DeclarationHolder.addIfNotContains(Collection, Declaration) method to consistently add declarations.

Specified by:

addDeclaration in interface DeclarationHolder

Parameters:

declaration - the declaration