Package icyllis.arc3d.compiler.tree

Class FunctionDeclaration

java.lang.Object

icyllis.arc3d.compiler.tree.Node

icyllis.arc3d.compiler.tree.Symbol

icyllis.arc3d.compiler.tree.FunctionDeclaration

public final class FunctionDeclaration
extends Symbol

Represents a function declaration (function symbol). If the function is overloaded, it will serve as a singly linked list.

Nested Class Summary

Nested classes/interfaces inherited from class icyllis.arc3d.compiler.tree.Node

Node.ElementKind, Node.ExpressionKind, Node.StatementKind, Node.SymbolKind

Field Summary

Fields inherited from class icyllis.arc3d.compiler.tree.Node

mPosition

Constructor Summary

Constructors

Constructor	Description
FunctionDeclaration(int position, Modifiers modifiers, String name, List<Variable> parameters, Type returnType, boolean builtin, boolean entryPoint, int intrinsicKind)

Method Summary

Modifier and Type	Method	Description
static @Nullable FunctionDeclaration	convert(@NonNull Context context, int pos, @NonNull Modifiers modifiers, @NonNull String name, @NonNull List<Variable> parameters, @NonNull Type returnType)
FunctionDefinition	getDefinition()
int	getIntrinsicKind()
@NonNull Node.SymbolKind	getKind()
@NonNull String	getMangledName()
Modifiers	getModifiers()
@Nullable FunctionDeclaration	getNextOverload()
List<Variable>	getParameters()
@NonNull Type	getReturnType()
@NonNull Type	getType()
boolean	isBuiltin()
boolean	isEntryPoint()
boolean	isIntrinsic()
@Nullable Type	resolveParameterTypes(@NonNull List<Expression> arguments, @NonNull List<Type> outParameterTypes)
void	setDefinition(FunctionDefinition definition)
void	setNextOverload(FunctionDeclaration overload)	Sets the previously defined function symbol with the same function name.
@NonNull String	toString()

Methods inherited from class icyllis.arc3d.compiler.tree.Symbol

accept, getName, setName

Methods inherited from class icyllis.arc3d.compiler.tree.Node

getEndOffset, getStartOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

FunctionDeclaration

public FunctionDeclaration(int position,
 Modifiers modifiers,
 String name,
 List<Variable> parameters,
 Type returnType,
 boolean builtin,
 boolean entryPoint,
 int intrinsicKind)

Method Details

convert

public static @Nullable FunctionDeclaration convert(@NonNull Context context,
 int pos,
 @NonNull Modifiers modifiers,
 @NonNull String name,
 @NonNull List<Variable> parameters,
 @NonNull Type returnType)

getKind

public @NonNull Node.SymbolKind getKind()

Specified by:

getKind in class Symbol

See Also:

• Node.SymbolKind

getType

public @NonNull Type getType()

Specified by:

getType in class Symbol

getReturnType

public @NonNull Type getReturnType()

getIntrinsicKind

public int getIntrinsicKind()

isIntrinsic

public boolean isIntrinsic()

getDefinition

public FunctionDefinition getDefinition()

setDefinition

public void setDefinition(FunctionDefinition definition)

getParameters

public List<Variable> getParameters()

getMangledName

public @NonNull String getMangledName()

getNextOverload

public @Nullable FunctionDeclaration getNextOverload()

setNextOverload

public void setNextOverload(FunctionDeclaration overload)

Sets the previously defined function symbol with the same function name.

getModifiers

public Modifiers getModifiers()

isBuiltin

public boolean isBuiltin()

isEntryPoint

public boolean isEntryPoint()

resolveParameterTypes

public @Nullable Type resolveParameterTypes(@NonNull List<Expression> arguments,
 @NonNull List<Type> outParameterTypes)

toString

public @NonNull String toString()

Specified by:

toString in class Node

Returns:

a string representation of this AST node