claw.tatsu.xcodeml.xnode.common

Class XcodeML

java.lang.Object

claw.tatsu.xcodeml.xnode.common.Xnode

claw.tatsu.xcodeml.xnode.common.XcodeML

Direct Known Subclasses:

FortranModule, XcodeProgram

public class XcodeML
extends Xnode

The XcodeML class represents the basic XcodeML file unit. Both XcodeProgram and FortranModule inherit from this class.

Author:

clementval

Field Summary

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

LHS, RHS, UNDEF_DEPTH

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XcodeML(org.w3c.dom.Document baseElement) Constructs a basic XcodeML object representing the XcodeML file given in input.

Method Summary

Modifier and Type	Method and Description
Xnode	createAndAddParam(java.lang.String nameValue, java.lang.String type, FfunctionType fctType) Create a name node and adds it as a parameter of the given function type.
Xnode	createAndAddParamIfNotExists(java.lang.String nameValue, java.lang.String type, FfunctionType fctType) Create a name node and adds it as a parameter of the given function type if this parameter does not exist yet.
Xnode	createArrayRef(FbasicType type, Xnode var) Create a new FarrayRef node with varRef node as a child with the given Var element.
FbasicType	createBasicType(FortranType type, Intent intent) Constructs a new basicType node with attributes.
FbasicType	createBasicType(java.lang.String type, java.lang.String ref, Intent intent) Constructs a new basicType node with attributes.
Xnode	createDoStmt(Xnode inductionVar, Xnode indexRange) Create a new FdoStatement node with an empty body.
Xnode	createEmptyAssumedShaped() Create an empty assumed shape indexRange node.
Xnode	createFctCall(java.lang.String returnType, java.lang.String fctName, java.lang.String fctType) Create a new functionCall node with name and arguments as children nodes.
FfunctionType	createFunctionType(java.lang.String type) Create a new FfunctionType with empty params child.
Xid	createId(FortranType type, XstorageClass sclass, java.lang.String idValue) Create a new Id node with all the underlying needed node and attributes.
Xid	createId(java.lang.String type, XstorageClass sclass, java.lang.String idValue) Create a new Id node with all the underlying needed node and attributes.
void	createIdAndDecl(java.lang.String name, FortranType type, XstorageClass sclass, FfunctionDefinition fctDef, DeclarationPosition declPos) Create the id and varDecl nodes and add them to the symbol/declaration table.
void	createIdAndDecl(java.lang.String name, java.lang.String type, XstorageClass sclass, FfunctionDefinition fctDef, DeclarationPosition declPos) Create the id and varDecl nodes and add them to the symbol/declaration table.
Xnode	createIfThen() Create a new FifStatement node with an empty condition and then body.
Xnode	createIntConstant(int value) Create a FintConstant node with the given value.
Xnode	createName(java.lang.String value, java.lang.String type) Constructs a new name node with name value and optional type.
Xnode	createNamedValue(java.lang.String value) Create a new namedValue node with its attribute.
Xnode	createNode(Xcode opcode) Create a new node in the current translation unit.
java.util.List<Xnode>	createPragma(java.lang.String value, int maxColumn) Create a list of FpragmaStatement with correct line continuation symbols.
Xnode	createPrintStatement(java.lang.String format, java.lang.String[] charConstants) Create a print statement with the given char constants.
Xnode	createRangeForAssumedShapeArray(Xnode arrayVar, int startIndex, int dimension) Create an indexRange element to loop over an assumed shape array.
Xnode	createVar(FortranType type, java.lang.String value, Xscope scope) Create a new var node.
Xnode	createVar(java.lang.String type, java.lang.String value, Xscope scope) Create a new var node.
Xnode	createVarDecl(FortranType nameType, java.lang.String nameValue) Create a new varDecl node with all the mandatory nodes.
Xnode	createVarDecl(java.lang.String varType, java.lang.String varId) Create a new varDecl node with all the mandatory nodes.
java.util.List<FfunctionDefinition>	getAllFctDef() Retrieve all function definitions in the XcodeProgram unit.
org.w3c.dom.Document	getDocument()
XtypeTable	getTypeTable() Get the type table of the FortranModule module.
Xnode	importConstOrVar(Xnode base, XcodeML xcodemlSrc) Create a copy of a variable element or an integer constant from a XcodeML unit to this unit.
Xnode	importNode(Xnode node) Import node to current XcodeML translation unit.
void	importType(XcodeML src, java.lang.String typeId) Import a type description from one XcodeML unit to the current one.
void	write(java.lang.String outputFile, int indent) Write the XcodeML to file or std out

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

ancestor, append, append, body, child, children, cloneNode, 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, toString, value

Methods inherited from class java.lang.Object

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

Constructor Detail

XcodeML

protected XcodeML(org.w3c.dom.Document baseElement)

Constructs a basic XcodeML object representing the XcodeML file given in input.

Parameters:

baseElement - Document representing the XcodeML file.

Method Detail

createNode

public Xnode createNode(Xcode opcode)

Create a new node in the current translation unit.

Parameters:

opcode - Opcode of the new node.

Returns:

Newly created node.

getDocument

public org.w3c.dom.Document getDocument()

Returns:

The XML Document representing the XcodeML file.

getTypeTable

public XtypeTable getTypeTable()

Get the type table of the FortranModule module.

Returns:

The types table.

getAllFctDef

public java.util.List<FfunctionDefinition> getAllFctDef()

Retrieve all function definitions in the XcodeProgram unit.

Returns:

A list of all function definitions in the XcodeProgram unit.

importConstOrVar

public Xnode importConstOrVar(Xnode base,
                              XcodeML xcodemlSrc)
                       throws IllegalTransformationException

Create a copy of a variable element or an integer constant from a XcodeML unit to this unit.

Parameters:

base - Base element to be copied.

xcodemlSrc - Source XcodeML unit.

Returns:

The newly created element in the current XcodeML unit.

Throws:

IllegalTransformationException - If the variable element doesn't meet the criteria.

importType

public void importType(XcodeML src,
                       java.lang.String typeId)

Import a type description from one XcodeML unit to the current one. If the type id is not present in the source XcodeML unit, nothing is done.

Parameters:

src - Source XcodeML unit.

typeId - Type id to be imported.

importNode

public Xnode importNode(Xnode node)

Import node to current XcodeML translation unit.

Parameters:

node - Node to import.

Returns:

Imported node.

write

public void write(java.lang.String outputFile,
                  int indent)
           throws IllegalTransformationException

Write the XcodeML to file or std out

Parameters:

outputFile - Path of the output file or null to output on std out

indent - Number of spaces used for the indentation

Throws:

IllegalTransformationException - if XML file cannot be written.

createName

public Xnode createName(java.lang.String value,
                        java.lang.String type)

Constructs a new name node with name value and optional type. <name type="type">value</name>

Parameters:

value - Name value.

type - Optional type value.

Returns:

The newly created node detached in the current XcodeML unit.

createIdAndDecl

public void createIdAndDecl(java.lang.String name,
                            FortranType type,
                            XstorageClass sclass,
                            FfunctionDefinition fctDef,
                            DeclarationPosition declPos)

Create the id and varDecl nodes and add them to the symbol/declaration table.

Parameters:

name - Name of the variable.

type - Type of the variable.

sclass - Scope class of the variable (from Xname).

fctDef - Function definition in which id and decl are created.

declPos - Position of the newly inserted declaration.

createIdAndDecl

public void createIdAndDecl(java.lang.String name,
                            java.lang.String type,
                            XstorageClass sclass,
                            FfunctionDefinition fctDef,
                            DeclarationPosition declPos)

Create the id and varDecl nodes and add them to the symbol/declaration table.

Parameters:

name - Name of the variable.

type - Type of the variable.

sclass - Scope class of the variable (from Xname).

fctDef - Function definition in which id and decl are created.

declPos - Position of the newly inserted declaration.

createNamedValue

public Xnode createNamedValue(java.lang.String value)

Create a new namedValue node with its attribute. <namedValue name="value"></namedValue>

Parameters:

value - Value of the name attribute.

Returns:

The newly created node detached in the current XcodeML unit.

createVar

public Xnode createVar(FortranType type,
                       java.lang.String value,
                       Xscope scope)

Create a new var node. <Var type="type" scope="scope">value</Var>

Parameters:

type - Value of the type attribute.

value - Value of the var.

scope - Value of the scope attribute.

Returns:

The newly created node detached in the current XcodeML unit.

createVar

public Xnode createVar(java.lang.String type,
                       java.lang.String value,
                       Xscope scope)

Create a new var node. <Var type="type" scope="scope">value</Var>

Parameters:

type - Value of the type attribute.

value - Value of the var.

scope - Value of the scope attribute.

Returns:

The newly created node detached in the current XcodeML unit.

createFctCall

public Xnode createFctCall(java.lang.String returnType,
                           java.lang.String fctName,
                           java.lang.String fctType)

Create a new functionCall node with name and arguments as children nodes. <functionCall type="returnType"> <name type="fctType">fctName</name> <arguments></arguments> </functionCall>

Parameters:

returnType - Value of the type attribute for the functionCall node.

fctName - Value of the name node.

fctType - Value of the type attribute for the name node.

Returns:

The newly created node detached in the current XcodeML unit.

createFunctionType

public FfunctionType createFunctionType(java.lang.String type)

Create a new FfunctionType with empty params child. <functionCall type="returnType"> <name type="fctType">fctName</name> <arguments></arguments> </functionCall>

Parameters:

type - Type hash of the FfunctionType node.

Returns:

The newly created node detached in the current XcodeML unit.

createArrayRef

public Xnode createArrayRef(FbasicType type,
                            Xnode var)

Create a new FarrayRef node with varRef node as a child with the given Var element. <FarrayRef type="type"> <varRef type=""> <Var/> <!-- var argument --> </varRef> </FarrayRef>

Parameters:

type - Value of the type attribute for the FarrayRef node.

var - Var node nested in the varRef element.

Returns:

The newly created node detached in the current XcodeML unit.

createId

public Xid createId(FortranType type,
                    XstorageClass sclass,
                    java.lang.String idValue)

Create a new Id node with all the underlying needed node and attributes. <id type="type" sclass="sclass">idValue</id>

Parameters:

type - Value for the attribute type.

sclass - Value for the attribute sclass.

idValue - Value of the name inner element.

Returns:

The newly created node detached in the current XcodeML unit.

createId

public Xid createId(java.lang.String type,
                    XstorageClass sclass,
                    java.lang.String idValue)

Create a new Id node with all the underlying needed node and attributes. <id type="type" sclass="sclass">idValue</id>

Parameters:

type - Value for the attribute type.

sclass - Value for the attribute sclass.

idValue - Value of the name inner element.

Returns:

The newly created node detached in the current XcodeML unit.

createVarDecl

public Xnode createVarDecl(FortranType nameType,
                           java.lang.String nameValue)

Create a new varDecl node with all the mandatory nodes. <varDecl> <name type="varType">varId</name> </varDecl>

Parameters:

nameType - Value for the attribute type of the name node.

nameValue - Value of the name inner node.

Returns:

The newly created node detached in the current XcodeML unit.

createVarDecl

public Xnode createVarDecl(java.lang.String varType,
                           java.lang.String varId)

Create a new varDecl node with all the mandatory nodes. <varDecl> <name type="varType">varId</name> </varDecl>

Parameters:

varType - Value for the attribute type of the name node.

varId - Value of the name inner node.

Returns:

The newly created node detached in the current XcodeML unit.

createBasicType

public FbasicType createBasicType(FortranType type,
                                  Intent intent)

Constructs a new basicType node with attributes. <FbasicType type="type" ref="ref" intent="intent"/>

Parameters:

type - Reference built-in type.

intent - Optional intent value.

Returns:

Newly create FbasicType with a corresponding generated type hash value.

createBasicType

public FbasicType createBasicType(java.lang.String type,
                                  java.lang.String ref,
                                  Intent intent)

Constructs a new basicType node with attributes. <FbasicType type="type" ref="ref" intent="intent"/>

Parameters:

type - Type attribute value.

ref - Reference attribute value.

intent - Optional intent value.

Returns:

The newly created node detached in the current XcodeML unit.

createEmptyAssumedShaped

public Xnode createEmptyAssumedShaped()

Create an empty assumed shape indexRange node. <indexRange is_assumed_shape="true"></indexRange>

Returns:

The newly created node detached in the current XcodeML unit.

createDoStmt

public Xnode createDoStmt(Xnode inductionVar,
                          Xnode indexRange)

Create a new FdoStatement node with an empty body.

 
 <FdoStatement>
 <Var></Var> <!-- provided as argument -->
 <indexRange></indexRange> <!-- provided as argument -->
 <body></body>
 </FdoStatement>
 
 

Parameters:

inductionVar - Var element for the induction variable.

indexRange - indexRange element for the iteration range.

Returns:

The newly created node detached in the current XcodeML unit.

createIfThen

public Xnode createIfThen()

Create a new FifStatement node with an empty condition and then body.

 
 <FifStatement>
 <condition></condition>
 <then>
 <body></body>
 </then>
 </FifStatement>
 
 

Returns:

The newly created node detached in the current XcodeML unit.

createRangeForAssumedShapeArray

public Xnode createRangeForAssumedShapeArray(Xnode arrayVar,
                                             int startIndex,
                                             int dimension)

Create an indexRange element to loop over an assumed shape array.

Parameters:

arrayVar - Var element representing the array variable.

startIndex - Lower bound index value.

dimension - Dimension index for the upper bound value.

Returns:

The newly created node detached in the current XcodeML unit.

createAndAddParam

public Xnode createAndAddParam(java.lang.String nameValue,
                               java.lang.String type,
                               FfunctionType fctType)

Create a name node and adds it as a parameter of the given function type. If the function has optional parameters, the newly created parameter is added before the optional ones.

Parameters:

nameValue - Value of the name node to create.

type - Type of the name node to create.

fctType - Function type in which the node will be added as a parameter.

Returns:

newly created name element.

createAndAddParamIfNotExists

public Xnode createAndAddParamIfNotExists(java.lang.String nameValue,
                                          java.lang.String type,
                                          FfunctionType fctType)

Create a name node and adds it as a parameter of the given function type if this parameter does not exist yet.

Parameters:

nameValue - Value of the name node to create.

type - Type of the name node to create.

fctType - Function type in which the node will be added as a parameter.

Returns:

newly created name element or null if not created.

createPrintStatement

public Xnode createPrintStatement(java.lang.String format,
                                  java.lang.String[] charConstants)

Create a print statement with the given char constants. <FprintStatement format="format"> <valueList> <value> <!-- a value node by element in charConstants --> <!-- FcharacterConstant type are created on the fly --> <FcharacterConstant type="cType">charConstants</FcharacterConstant> </value> </valueList> </FprintStatement>

Parameters:

format - Format for the print statement.

charConstants - Array of char constants to be created.

Returns:

The print statement node created.

createIntConstant

public Xnode createIntConstant(int value)

Create a FintConstant node with the given value. <FintConstant type="Fint">value</FintConstant>

Parameters:

value - Value assigned to the int constant.

Returns:

Newly created node.

createPragma

public java.util.List<Xnode> createPragma(java.lang.String value,
                                          int maxColumn)

Create a list of FpragmaStatement with correct line continuation symbols. Initial value is splitted according to the max column information. This is done as the OMNI Compiler backend doesn't split the FpragmaElement. Supports acc, omp and claw prefix

Parameters:

value - Value of the FpragmaStatement.

maxColumn - Maximum column value. Split is based on this value.

Returns:

List of FpragmaStatement representing the splitted value.