Xnode (CLAW\ X2T\ (XcodeML\ to\ XcodeML\ Translator))

java.lang.Object
- claw.tatsu.xcodeml.xnode.common.Xnode

Direct Known Subclasses:

AssignStatement, FbasicType, FfunctionDefinition, FfunctionType, FmoduleDefinition, FstructType, XcodeML, XdeclTable, XglobalDeclTable, Xid, XsymbolTable, XtypeTable
```
public class Xnode
extends java.lang.Object
```
XcodeML AST node.

Author:

clementval

Field Summary

Fields
Modifier and Type Field and Description

static int LHS

static int RHS

static int UNDEF_DEPTH

Fields
Modifier and Type	Field and Description
`static int`	`LHS`
`static int`	`RHS`
`static int`	`UNDEF_DEPTH`

Constructor Summary

Constructors
Constructor and Description

Xnode(org.w3c.dom.Element element)
Constructs an Xnode object from an element in the AST.

Constructors
Constructor and Description
`Xnode(org.w3c.dom.Element element)` Constructs an Xnode object from an element in the AST.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Xnode`	`ancestor()` Get ancestor node if any.
`void`	`append(Xnode node)` Append an element ot the children of this element.
`void`	`append(Xnode node, boolean clone)` Append an element ot the children of this element.
`Xnode`	`body()` Get the inner body element.
`Xnode`	`child(int pos)` Get child at position.
`java.util.List<Xnode>`	`children()` Get the list of child elements.
`Xnode`	`cloneNode()` Clone the current element with all its children.
`org.w3c.dom.Node`	`cloneRawNode()` Create an identical copy of the element and its children.
`boolean`	`compareFirstChildValues(Xnode other)` Compare the inner value of the first child of two nodes.
`boolean`	`compareOptionalValues(Xnode other)` Compare the inner values of two optional nodes.
`boolean`	`compareValues(Xnode other)` Compare the inner values of two nodes.
`java.lang.String`	`constructRepresentation(boolean withNamedValue)` Construct string representation of the node.
`void`	`copyAttribute(Xnode to, Xattr attr)` Copy the attribute from the current node to the given node.
`void`	`copyEnhancedInfo(Xnode target)` Copy the enhanced information from the current node to a target node.
`void`	`delete()` Delete the stored root element and all its children.
`void`	`deleteWithSiblings()` Delete this nodes with all its siblings.
`int`	`depth()` Get the depth of the node in the AST.
`org.w3c.dom.Element`	`element()` Get the base element.
`boolean`	`equals(java.lang.Object o)`
`java.lang.String`	`filename()` Get the file attribute value.
`FfunctionDefinition`	`findParentFunction()` Find function definition in the ancestor of the current node.
`FmoduleDefinition`	`findParentModule()` Find module definition node in which the current node is nested if any.
`Xnode`	`firstChild()` Get the first child node.
`java.lang.String`	`getAttribute(Xattr attrCode)` Get the attribute's value.
`boolean`	`getBooleanAttribute(Xattr attrCode)` Get boolean value of an attribute.
`java.lang.String`	`getType()` Return type hash associated with this node if any.
`boolean`	`hasAttribute(Xattr attrCode)` Check whether the element has the corresponding attribute.
`boolean`	`hasBody()` Check whether the current element is an element with body element.
`int`	`hashCode()`
`boolean`	`hasSameParentBlock(Xnode n)` Check if the given node is direct children of the same parent node.
`void`	`insert(Xnode node)` Insert as first child.
`void`	`insert(Xnode node, boolean clone)` Insert as first child.
`void`	`insertAfter(Xnode node)` Insert a node just after this node.
`void`	`insertBefore(Xnode node)` Insert a node just before this node.
`boolean`	`isDeleted()` Check whether the node has been deleted.
`boolean`	`isDirectSibling(Xnode end, java.util.List<Xcode> skippedNodes)` Check whether the end node is a direct sibling of this node.
`boolean`	`isNestedIn(Xnode ancestor)` Check whether a node is nested into another one.
`Xnode`	`lastChild()` Get the last child node.
`int`	`lineNo()` Get the lineno attribute value.
`java.util.List<Xnode>`	`matchAll(Xcode opcode)` Match all nodes with the given opcode in the subtree.
`java.util.List<Xnode>`	`matchAllAncestor(Xcode opcode)` Find nodes with the given opcode in the ancestors of the current node.
`java.util.List<Xnode>`	`matchAllAncestor(Xcode opcode, Xcode stopCode)` Find nodes with the given opcode in the ancestors of the current node.
`Xnode`	`matchAncestor(Xcode opcode)` Find node with the given opcode in the ancestors of the current node.
`Xnode`	`matchDescendant(Xcode opcode)` Find node with the given opcode in the descendants of the current node.
`Xnode`	`matchDirectDescendant(java.util.List<Xcode> opcodes)` Find node with one of the given opcodes in the direct descendants the current node.
`Xnode`	`matchDirectDescendant(Xcode opcode)` Find node with the given opcode in the direct descendants the current node.
`Xnode`	`matchSeq(Xcode... opcodes)` Find node with the given path of opcodes from the current node.
`Xnode`	`matchSibling(Xcode opcode)` Find node with the given opcode in the siblings of the given node.
`Xnode`	`nextSibling()` Get next sibling node.
`Xcode`	`opcode()` Get the element opcode.
`Xnode`	`prevSibling()` Get previous sibling node.
`void`	`removeAttribute(Xattr attrCode)` Remove an attribute from the node.
`void`	`setAttribute(Xattr attrCode, java.lang.String value)` Set attribute value.
`void`	`setBooleanAttribute(Xattr attrCode, boolean value)` Set the value of a boolean attribute.
`void`	`setFilename(java.lang.String value)` Set the file attribute of the element.
`void`	`setLine(int lineno)` Set the lineno attribute in the element.
`void`	`setType(java.lang.String value)` Set the type of the current node.
`void`	`setValue(java.lang.String value)` Set the element value.
`java.lang.String`	`toString()` Return a brief description of the Xnode.
`java.lang.String`	`value()` Get raw node value.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - LHS
```
public static final int LHS
```
    See Also:
    
    Constant Field Values
  - RHS
```
public static final int RHS
```
    See Also:
    
    Constant Field Values
  - UNDEF_DEPTH
```
public static final int UNDEF_DEPTH
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Xnode
```
public Xnode(org.w3c.dom.Element element)
```
    Constructs an Xnode object from an element in the AST.
    
    Parameters:
    
    element - Base element for the Xnode object.
- Method Detail
  - deleteWithSiblings
```
public void deleteWithSiblings()
```
    Delete this nodes with all its siblings.
  - opcode
```
public Xcode opcode()
```
    Get the element opcode.
    
    Returns:
    
    Opcode.
  - hasAttribute
```
public boolean hasAttribute(Xattr attrCode)
```
    Check whether the element has the corresponding attribute.
    
    Parameters:
    
    attrCode - Attribute code.
    
    Returns:
    
    True if the element has the corresponding attribute.
  - getAttribute
```
public java.lang.String getAttribute(Xattr attrCode)
```
    Get the attribute's value.
    
    Parameters:
    
    attrCode - Attribute code.
    
    Returns:
    
    Attribute's value.
  - getBooleanAttribute
```
public boolean getBooleanAttribute(Xattr attrCode)
```
    Get boolean value of an attribute.
    
    Parameters:
    
    attrCode - Attribute code.
    
    Returns:
    
    Attribute's value. False if attribute doesn't exist.
  - value
```
public java.lang.String value()
```
    Get raw node value.
    
    Returns:
    
    Raw value.
  - setValue
```
public void setValue(java.lang.String value)
```
    Set the element value.
    
    Parameters:
    
    value - The element value.
  - setBooleanAttribute
```
public void setBooleanAttribute(Xattr attrCode,
                                boolean value)
```
    Set the value of a boolean attribute.
    
    Parameters:
    
    attrCode - Attribute code.
    
    value - Boolean value to set.
  - setAttribute
```
public void setAttribute(Xattr attrCode,
                         java.lang.String value)
```
    Set attribute value.
    
    Parameters:
    
    attrCode - Attribute code.
    
    value - Value of the attribute.
  - removeAttribute
```
public void removeAttribute(Xattr attrCode)
```
    Remove an attribute from the node.
    
    Parameters:
    
    attrCode - Attribute code.
  - hasBody
```
public boolean hasBody()
```
    Check whether the current element is an element with body element.
    
    Returns:
    
    True if the element should have a body. False otherwise.
  - body
```
public Xnode body()
```
    Get the inner body element.
    
    Returns:
    
    The body element if found. Null otherwise.
  - child
```
public Xnode child(int pos)
```
    Get child at position.
    
    Parameters:
    
    pos - Position of the child.
    
    Returns:
    
    Child at the corresponding position.
  - children
```
public java.util.List<Xnode> children()
```
    Get the list of child elements.
    
    Returns:
    
    List of children of the current element.
  - firstChild
```
public Xnode firstChild()
```
    Get the first child node.
    
    Returns:
    
    First child or null if no child exists.
  - lastChild
```
public Xnode lastChild()
```
    Get the last child node.
    
    Returns:
    
    Last child or null if no child exists.
  - delete
```
public void delete()
```
    Delete the stored root element and all its children.
  - isDeleted
```
public boolean isDeleted()
```
    Check whether the node has been deleted.
    
    Returns:
    
    True if the node has been deleted. False otherwise.
  - element
```
public org.w3c.dom.Element element()
```
    Get the base element.
    
    Returns:
    
    Element.
  - append
```
public void append(Xnode node,
                   boolean clone)
```
    Append an element ot the children of this element.
    
    Parameters:
    
    node - The element to append.
    
    clone - If true, the element is cloned before being appended. If false, the element is directly appended.
  - append
```
public void append(Xnode node)
```
    Append an element ot the children of this element. Node is not cloned.
    
    Parameters:
    
    node - The element to append.
  - insert
```
public void insert(Xnode node,
                   boolean clone)
```
    Insert as first child.
    
    Parameters:
    
    node - Node to be inserted.
    
    clone - Clone or not the element before insertion.
  - insert
```
public void insert(Xnode node)
```
    Insert as first child.
    
    Parameters:
    
    node - Node to be inserted.
  - setLine
```
public void setLine(int lineno)
```
    Set the lineno attribute in the element.
    
    Parameters:
    
    lineno - Line number.
  - lineNo
```
public int lineNo()
```
    Get the lineno attribute value. This attribute is not defined for every elements.
    
    Returns:
    
    Line number. 0 if the attribute is not defined.
  - filename
```
public java.lang.String filename()
```
    Get the file attribute value. This value represents the original filename from the XcodeML unit. This attribute is not defined for every elements.
    
    Returns:
    
    File path. Empty string if the file attribute is not defined.
  - setFilename
```
public void setFilename(java.lang.String value)
```
    Set the file attribute of the element.
    
    Parameters:
    
    value - File path.
  - cloneNode
```
public Xnode cloneNode()
```
    Clone the current element with all its children.
    
    Returns:
    
    A copy of the current element.
  - cloneRawNode
```
public org.w3c.dom.Node cloneRawNode()
```
    Create an identical copy of the element and its children.
    
    Returns:
    
    A node representing the root element of the clone.
  - nextSibling
```
public Xnode nextSibling()
```
    Get next sibling node.
    
    Returns:
    
    Next sibling node.
  - ancestor
```
public Xnode ancestor()
```
    Get ancestor node if any.
    
    Returns:
    
    Ancestor node if any. Null otherwise.
  - prevSibling
```
public Xnode prevSibling()
```
    Get previous sibling node.
    
    Returns:
    
    Previous sibling node.
  - isDirectSibling
```
public boolean isDirectSibling(Xnode end,
                               java.util.List<Xcode> skippedNodes)
```
    Check whether the end node is a direct sibling of this node. If other nodes are between the two nodes and their opcode is not listed in the skippedNodes list, the nodes are not direct siblings.
    
    Parameters:
    
    end - Node to be check to be a direct sibling.
    
    skippedNodes - List of opcode that are allowed between the two nodes.
    
    Returns:
    
    True if the nodes are direct siblings.
  - matchAncestor
```
public Xnode matchAncestor(Xcode opcode)
```
    Find node with the given opcode in the ancestors of the current node.
    
    Parameters:
    
    opcode - Opcode of the node to be matched.
    
    Returns:
    
    The matched node. Null if nothing matched.
  - matchSibling
```
public Xnode matchSibling(Xcode opcode)
```
    Find node with the given opcode in the siblings of the given node.
    
    Parameters:
    
    opcode - Opcode of the node to be matched.
    
    Returns:
    
    The matched node. Null if no node found.
  - matchAllAncestor
```
public java.util.List<Xnode> matchAllAncestor(Xcode opcode)
```
    Find nodes with the given opcode in the ancestors of the current node.
    
    Parameters:
    
    opcode - Opcode of the node to be matched.
    
    Returns:
    
    List of matched node. Empty list if nothing matched.
  - matchAllAncestor
```
public java.util.List<Xnode> matchAllAncestor(Xcode opcode,
                                              Xcode stopCode)
```
    Find nodes with the given opcode in the ancestors of the current node.
    
    Parameters:
    
    opcode - Opcode of the node to be matched.
    
    stopCode - Stop searching if given opcode is reached. If null, search until root node.
    
    Returns:
    
    List of matched node. Empty list if nothing matched.
  - matchDescendant
```
public Xnode matchDescendant(Xcode opcode)
```
    Find node with the given opcode in the descendants of the current node.
    
    Parameters:
    
    opcode - Opcode of the node to be matched.
    
    Returns:
    
    The matched node. Null if nothing matched.
  - matchDirectDescendant
```
public Xnode matchDirectDescendant(Xcode opcode)
```
    Find node with the given opcode in the direct descendants the current node.
    
    Parameters:
    
    opcode - Opcode of the node to be matched.
    
    Returns:
    
    The matched node. Null if nothing matched.
  - matchDirectDescendant
```
public Xnode matchDirectDescendant(java.util.List<Xcode> opcodes)
```
    Find node with one of the given opcodes in the direct descendants the current node.
    
    Parameters:
    
    opcodes - List of opcodes to be searched.
    
    Returns:
    
    The matched node. Null if no node found.
  - matchSeq
```
public Xnode matchSeq(Xcode... opcodes)
```
    Find node with the given path of opcodes from the current node.
    
    Parameters:
    
    opcodes - Sequence of opcode to reach the node.
    
    Returns:
    
    The matched node. Null if no node found.
  - matchAll
```
public java.util.List<Xnode> matchAll(Xcode opcode)
```
    Match all nodes with the given opcode in the subtree.
    
    Parameters:
    
    opcode - Opcode of the nodes to be matched.
    
    Returns:
    
    List of all nodes matched in the subtree.
  - depth
```
public int depth()
```
    Get the depth of the node in the AST.
    
    Returns:
    
    A depth value greater or equal to 0.
  - insertAfter
```
public void insertAfter(Xnode node)
```
    Insert a node just after this node.
    
    Parameters:
    
    node - The node to be inserted after the current one.
  - compareFirstChildValues
```
public boolean compareFirstChildValues(Xnode other)
```
    Compare the inner value of the first child of two nodes.
    
    Parameters:
    
    other - Node to compare with
    
    Returns:
    
    True if the value if first childs are identical. False otherwise.
  - compareOptionalValues
```
public boolean compareOptionalValues(Xnode other)
```
    Compare the inner values of two optional nodes.
    
    Parameters:
    
    other - Node to compare with
    
    Returns:
    
    True if the values are identical or elements are null. False otherwise.
  - compareValues
```
public boolean compareValues(Xnode other)
```
    Compare the inner values of two nodes.
    
    Parameters:
    
    other - Node to compare with
    
    Returns:
    
    True if the values are identical. False otherwise.
  - insertBefore
```
public void insertBefore(Xnode node)
```
    Insert a node just before this node.
    
    Parameters:
    
    node - The node to be inserted before the current one.
  - findParentModule
```
public FmoduleDefinition findParentModule()
```
    Find module definition node in which the current node is nested if any.
    
    Returns:
    
    A FmoduleDefinition node if found. Null otherwise.
  - isNestedIn
```
public boolean isNestedIn(Xnode ancestor)
```
    Check whether a node is nested into another one.
    
    Parameters:
    
    ancestor - Node in which the current node is supposed to be nested.
    
    Returns:
    
    True if the current node is nested in the ancestor node. False otherwise.
  - getType
```
public java.lang.String getType()
```
    Return type hash associated with this node if any.
    
    Returns:
    
    Type hash. Empty string if there is no type hash associated.
  - setType
```
public void setType(java.lang.String value)
```
    Set the type of the current node.
    
    Parameters:
    
    value - Type value.
  - constructRepresentation
```
public java.lang.String constructRepresentation(boolean withNamedValue)
```
    Construct string representation of the node. Only for variable or constant.
    
    Parameters:
    
    withNamedValue - If true, keeps the named value, otherwise, just constructs the argument.
    
    Returns:
    
    String representation. Null if node is null.
  - copyEnhancedInfo
```
public void copyEnhancedInfo(Xnode target)
```
    Copy the enhanced information from the current node to a target node. Enhanced information include line number and original file name.
    
    Parameters:
    
    target - Target node to copy information to.
  - hasSameParentBlock
```
public boolean hasSameParentBlock(Xnode n)
```
    Check if the given node is direct children of the same parent node.
    
    Parameters:
    
    n - Node to be compared to.
    
    Returns:
    
    True if the given node is direct children of the same parent. False otherwise.
  - findParentFunction
```
public FfunctionDefinition findParentFunction()
```
    Find function definition in the ancestor of the current node.
    
    Returns:
    
    The function definition found. Null if nothing found.
  - copyAttribute
```
public void copyAttribute(Xnode to,
                          Xattr attr)
```
    Copy the attribute from the current node to the given node.
    
    Parameters:
    
    to - Xnode to copy to.
    
    attr - Attribute code to be copied.
  - toString
```
public java.lang.String toString()
```
    Return a brief description of the Xnode.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    String description of the Xnode as "Opcode (children: n)".
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object

Class Xnode

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LHS

RHS

UNDEF_DEPTH

Constructor Detail

Xnode

Method Detail

deleteWithSiblings

opcode

hasAttribute

getAttribute

getBooleanAttribute

value

setValue

setBooleanAttribute

setAttribute

removeAttribute

hasBody

body

child

children

firstChild

lastChild

delete

isDeleted

element

append

append

insert

insert

setLine

lineNo

filename

setFilename

cloneNode

cloneRawNode

nextSibling

ancestor

prevSibling

isDirectSibling

matchAncestor

matchSibling

matchAllAncestor

matchAllAncestor

matchDescendant

matchDirectDescendant

matchDirectDescendant

matchSeq

matchAll

depth

insertAfter

compareFirstChildValues

compareOptionalValues

compareValues

insertBefore

findParentModule

isNestedIn

getType

setType

constructRepresentation

copyEnhancedInfo

hasSameParentBlock

findParentFunction

copyAttribute

toString

hashCode

equals