claw.tatsu.xcodeml.xnode.fortran

Class FfunctionType

java.lang.Object

claw.tatsu.xcodeml.xnode.common.Xnode

claw.tatsu.xcodeml.xnode.fortran.FfunctionType

public class FfunctionType
extends Xnode

The FfunctionType represents the FfunctionType (3.4) element in XcodeML intermediate representation. Elements: (params?) - Optional: - params Attributes: - Required: type (text), return_type (text) - Optional: result_name (text), is_recursive (bool), is_program (bool), is_internal (bool), is_elemental (bool), is_pure (bool), bind (text), bind_name (text)

Author:

clementval

Field Summary

Fields inherited from class claw.tatsu.xcodeml.xnode.common.Xnode

LHS, RHS, UNDEF_DEPTH

Constructor Summary

Constructors

Constructor and Description
FfunctionType(Xnode node) Basic ctor from Xnode.

Method Summary

Modifier and Type	Method and Description
void	addParameters(Xnode name) Add a name element to the parameters list.
void	addParameters(Xnode ref, Xnode name) Add a name element to the parameters list before the referenced element.
FfunctionType	cloneNode() A new object FfunctionType that is the clone of the current object.
java.util.List<Xnode>	getParameters() Get the list of all parameters name node.
java.util.List<java.lang.String>	getParamsNames() Get a list of string representing the function parameters.
java.lang.String	getResultName() Get the function result name.
java.lang.String	getReturnType() Get the function return type.
boolean	hasParam(java.lang.String paramName) Check if a parameter is part of the function definition.
boolean	isElemental() Check whether function has the elemental attribute set to true.
boolean	isInternal() Check whether function is internal.
boolean	isProgram() Check whether function is the program function.
boolean	isPure() Check whether function has the pure attribute set to true.
boolean	isRecursive() Check whether function is recursive.
java.lang.String	toString() Return a brief description of the Xnode.

Methods inherited from class claw.tatsu.xcodeml.xnode.common.Xnode

ancestor, append, append, body, child, children, cloneRawNode, compareFirstChildValues, compareOptionalValues, compareValues, constructRepresentation, copyAttribute, copyEnhancedInfo, delete, deleteWithSiblings, depth, element, equals, filename, findParentFunction, findParentModule, firstChild, getAttribute, getBooleanAttribute, getType, hasAttribute, hasBody, hashCode, hasSameParentBlock, insert, insert, insertAfter, insertBefore, isDeleted, isDirectSibling, isNestedIn, lastChild, lineNo, matchAll, matchAllAncestor, matchAllAncestor, matchAncestor, matchDescendant, matchDirectDescendant, matchDirectDescendant, matchSeq, matchSibling, nextSibling, opcode, prevSibling, removeAttribute, setAttribute, setBooleanAttribute, setFilename, setLine, setType, setValue, value

Methods inherited from class java.lang.Object

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

Constructor Detail

FfunctionType

public FfunctionType(Xnode node)

Basic ctor from Xnode.

Parameters:

node - Raw node.

Method Detail

getResultName

public java.lang.String getResultName()

Get the function result name.

Returns:

Result name value.

isRecursive

public boolean isRecursive()

Check whether function is recursive.

Returns:

True if the function is recursive. False otherwise.

isInternal

public boolean isInternal()

Check whether function is internal.

Returns:

True if the function is internal. False otherwise.

getReturnType

public java.lang.String getReturnType()

Get the function return type.

Returns:

The function's return type as String.

isProgram

public boolean isProgram()

Check whether function is the program function.

Returns:

True if the function is the program function. False otherwise.

isPure

public boolean isPure()

Check whether function has the pure attribute set to true.

Returns:

True if the function has the pure attribute set to true. False otherwise.

isElemental

public boolean isElemental()

Check whether function has the elemental attribute set to true.

Returns:

True if the function has the elemental attribute set to true. False otherwise.

getParameters

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

Get the list of all parameters name node.

Returns:

List of parameters Xnode objects.

addParameters

public void addParameters(Xnode name)

Add a name element to the parameters list.

Parameters:

name - The name element to add.

addParameters

public void addParameters(Xnode ref,
                          Xnode name)

Add a name element to the parameters list before the referenced element.

Parameters:

ref - Referenced element. New element will be added before.

name - The name element to add.

getParamsNames

public java.util.List<java.lang.String> getParamsNames()

Get a list of string representing the function parameters.

Returns:

List of string.

cloneNode

public FfunctionType cloneNode()

A new object FfunctionType that is the clone of the current object.

Overrides:

cloneNode in class Xnode

Returns:

A new FfunctionType that is a clone of the current one.

hasParam

public boolean hasParam(java.lang.String paramName)

Check if a parameter is part of the function definition.

Parameters:

paramName - Parameter's name.

Returns:

True if the parameter is found in the function definition. False otherwise.

toString

public java.lang.String toString()

Description copied from class: Xnode

Return a brief description of the Xnode.

Overrides:

toString in class Xnode

Returns:

String description of the Xnode as "Opcode (children: n)".