claw.tatsu.xcodeml.xnode

Class XnodeUtil

java.lang.Object

claw.tatsu.xcodeml.xnode.XnodeUtil

public class XnodeUtil
extends java.lang.Object

The class XnodeUtil contains only static method to help manipulating the raw Elements in the XcodeML representation by using the abstracted Xnode.

Author:

clementval

Constructor Summary

Constructors

Constructor and Description
XnodeUtil()

Method Summary

Modifier and Type	Method and Description
static void	deleteBetween(Xnode start, Xnode end) Delete all the elements between the two given elements.
static java.util.List<Xnode>	findAllReferences(Xnode parent) Find all the var elements that are real references to a variable.
static java.util.List<Xnode>	findAllReferences(Xnode parent, java.lang.String id) Find all the var elements that are real references to a variable.
static java.util.List<HoistedNestedDoStatement>	findDoStatementForHoisting(Xnode from, Xnode endPragma, java.util.List<java.lang.String> inductionVars) Find all the nested do statement groups following the inductions iterations define in inductionVars and being located between the "from" element and the end pragma.
static java.util.List<Xnode>	findIndexes(Xnode parent) Find all the index elements (arrayIndex and indexRange) in an element.
static java.util.List<java.lang.String>	gatherArguments(XcodeProgram xcodeml, Xnode fctCall, Intent intent, boolean arrayOnly) Gather arguments of a function call.
static java.util.List<Xnode>	getAllArrayReferences(Xnode parent, java.lang.String arrayName) Find all array references elements in a given body and give var name.
static java.util.List<Xnode>	getAllArrayReferencesByOffsets(Xnode from, java.lang.String identifier, java.util.List<java.lang.Integer> offsets) Find all array references in the next children that match the given criteria.
static java.util.List<Xnode>	getAllArrayReferencesInSiblings(Xnode from, java.lang.String identifier) Get all array references in the siblings of the given element.
static java.util.List<Xnode>	getAllVarReferences(Xnode parent, java.lang.String varName) Find all var references elements in a given body and give var name.
static java.util.List<Xnode>	getArrayAssignInBlock(Xnode from, java.lang.String endPragma) Find all assignment statement from a node until the end pragma.
static Xnode	getFirstArrayAssign(Xnode from, java.lang.String arrayName) Get the first assignment statement for an array reference.
static java.util.List<Xnode>	getIdxRangesFromArrayRef(Xnode arrayRef) Retrieve the index ranges of an array notation.
static java.util.Set<java.lang.String>	getNamesFromReferences(java.util.List<Xnode> nodes) Get all the variables names from a list of var elements.
static java.util.List<Xnode>	getNodes(Xnode root, java.util.List<Xcode> nodeOpcodes) Get given statements in the subtree.
static java.util.List<Xnode>	getNodes(Xnode from, Xnode to, java.util.List<Xcode> nodeOpcodes) Get given statements in between from and to included.
static boolean	isInductionIndex(Xnode arrayIndex, java.util.List<java.lang.String> inductionVariables) Check whether the index of an arrayIndex element is an induction variable given in the list.
static org.w3c.dom.Document	readXmlFile(java.lang.String input) Read XML file.
static void	safeDelete(Xnode node) Delete a node in the ast.

Methods inherited from class java.lang.Object

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

Constructor Detail

XnodeUtil

public XnodeUtil()

Method Detail

getAllArrayReferences

public static java.util.List<Xnode> getAllArrayReferences(Xnode parent,
                                                          java.lang.String arrayName)

Find all array references elements in a given body and give var name.

Parameters:

parent - The body element to search for the array references.

arrayName - Name of the array for the array reference to be found.

Returns:

A list of all array references found.

getAllVarReferences

public static java.util.List<Xnode> getAllVarReferences(Xnode parent,
                                                        java.lang.String varName)

Find all var references elements in a given body and give var name.

Parameters:

parent - The body element to search for the array references.

varName - Name of the var for the reference to be found.

Returns:

A list of all references found.

getIdxRangesFromArrayRef

public static java.util.List<Xnode> getIdxRangesFromArrayRef(Xnode arrayRef)

Retrieve the index ranges of an array notation.

Parameters:

arrayRef - The array reference statements to extract the ranges from.

Returns:

A list if indexRanges elements.

getArrayAssignInBlock

public static java.util.List<Xnode> getArrayAssignInBlock(Xnode from,
                                                          java.lang.String endPragma)

 Find all assignment statement from a node until the end pragma.

 We intersect all assign statements which are next siblings of
 the "from" element with all the assign statements which are previous
 siblings of the ending pragma.
 

Parameters:

from - The element from which the search is initiated.

endPragma - Value of the end pragma. Search will be performed until there.

Returns:

A list of all assign statements found. List is empty if no statements are found.

getAllArrayReferencesInSiblings

public static java.util.List<Xnode> getAllArrayReferencesInSiblings(Xnode from,
                                                                    java.lang.String identifier)

Get all array references in the siblings of the given element.

Parameters:

from - Element to start from.

identifier - Array name value.

Returns:

List of all array references found. List is empty if nothing is found.

getFirstArrayAssign

public static Xnode getFirstArrayAssign(Xnode from,
                                        java.lang.String arrayName)

Get the first assignment statement for an array reference.

Parameters:

from - Statement to look from.

arrayName - Identifier of the array.

Returns:

The assignment statement if found. Null otherwise.

findDoStatementForHoisting

public static java.util.List<HoistedNestedDoStatement> findDoStatementForHoisting(Xnode from,
                                                                                  Xnode endPragma,
                                                                                  java.util.List<java.lang.String> inductionVars)

Find all the nested do statement groups following the inductions iterations define in inductionVars and being located between the "from" element and the end pragma.

Parameters:

from - Element from which the search is started.

endPragma - End pragma that terminates the search block.

inductionVars - Induction variables that define the nested group to locates.

Returns:

List of do statements elements (outer most loops for each nested group) found between the "from" element and the end pragma.

getAllArrayReferencesByOffsets

public static java.util.List<Xnode> getAllArrayReferencesByOffsets(Xnode from,
                                                                   java.lang.String identifier,
                                                                   java.util.List<java.lang.Integer> offsets)

Find all array references in the next children that match the given criteria. This methods use powerful Xpath expression to locate the correct nodes in the AST Here is an example of such a query that return all node that are array references for the array "array6" with an offset of 0 -1 //FarrayRef[varRef[Var[text()="array6"]] and arrayIndex and arrayIndex[minusExpr[Var and FintConstant[text()="1"]]]]

Parameters:

from - The element from which the search is initiated.

identifier - Identifier of the array.

offsets - List of offsets to be search for.

Returns:

A list of all array references found.

findIndexes

public static java.util.List<Xnode> findIndexes(Xnode parent)

Find all the index elements (arrayIndex and indexRange) in an element.

Parameters:

parent - Root element to search from.

Returns:

A list of all index ranges found.

findAllReferences

public static java.util.List<Xnode> findAllReferences(Xnode parent)

Find all the var elements that are real references to a variable. Var element nested in an arrayIndex element are excluded.

Parameters:

parent - Root element to search from.

Returns:

A list of all var elements found.

getNamesFromReferences

public static java.util.Set<java.lang.String> getNamesFromReferences(java.util.List<Xnode> nodes)

Get all the variables names from a list of var elements.

Parameters:

nodes - List containing var element.

Returns:

A set of all variable's name.

findAllReferences

public static java.util.List<Xnode> findAllReferences(Xnode parent,
                                                      java.lang.String id)

Find all the var elements that are real references to a variable. Var element nested in an arrayIndex element are excluded.

Parameters:

parent - Root element to search from.

id - Identifier of the var to be found.

Returns:

A list of all var elements found.

isInductionIndex

public static boolean isInductionIndex(Xnode arrayIndex,
                                       java.util.List<java.lang.String> inductionVariables)

Check whether the index of an arrayIndex element is an induction variable given in the list.

Parameters:

arrayIndex - arrayIndex to be checked.

inductionVariables - List of potential induction variables.

Returns:

True if the arrayIndex uses a var from induction variables list. False in any other cases.

getNodes

public static java.util.List<Xnode> getNodes(Xnode root,
                                             java.util.List<Xcode> nodeOpcodes)

Get given statements in the subtree.

Parameters:

root - Root of the subtree.

nodeOpcodes - List of statements to look for.

Returns:

List of statement found.

getNodes

public static java.util.List<Xnode> getNodes(Xnode from,
                                             Xnode to,
                                             java.util.List<Xcode> nodeOpcodes)

Get given statements in between from and to included.

Parameters:

from - Node from.

to - Node to.

nodeOpcodes - List of statements to look for.

Returns:

List of statement found.

deleteBetween

public static void deleteBetween(Xnode start,
                                 Xnode end)

Delete all the elements between the two given elements.

Parameters:

start - The start element. Deletion start from next element.

end - The end element. Deletion end just before this element.

readXmlFile

public static org.w3c.dom.Document readXmlFile(java.lang.String input)

Read XML file.

Parameters:

input - Xml file path.

Returns:

Document if the XML file could be read. Null otherwise.

safeDelete

public static void safeDelete(Xnode node)

Delete a node in the ast.

Parameters:

node - Node to be deleted.

gatherArguments

public static java.util.List<java.lang.String> gatherArguments(XcodeProgram xcodeml,
                                                               Xnode fctCall,
                                                               Intent intent,
                                                               boolean arrayOnly)

Gather arguments of a function call.

Parameters:

xcodeml - Current XcodeML translation unit.

fctCall - functionCall node in which the arguments are retrieved.

intent - Intent to use for gathering.

arrayOnly - If true, gather only arrays arguments.

Returns:

List of arguments as their string representation.