Xobject

java.lang.Object
- exc.object.PropObject
- - exc.object.Xobject

All Implemented Interfaces:

IVarContainer, XobjectVisitable, IXobject

Direct Known Subclasses:

Ident, XobjConst, XobjList
```
public class Xobject
extends PropObject
implements IXobject, XobjectVisitable, IVarContainer
```
Abstract class of expression tree objects in Xobject.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`OPT_ATOMIC_STMT`
`static int`	`OPT_DELAYED_DECL`
`static int`	`OPT_F_MODULE_VAR`
`static int`	`OPT_GCC_EXTENSION`
`static int`	`OPT_GCC_SYNTAX`
`static int`	`OPT_GCC_THREAD`
`static int`	`OPT_GLOBAL`
`static int`	`OPT_INDUCTION_VAR`
`static int`	`OPT_PARSED`
`static int`	`OPT_REWRITTED_XMP`
`static int`	`OPT_SYNTAX_MODIFIED`
`static int`	`OPT_TO_BE_FCOMMON`
`static int`	`OPT_USED_IN_ARRAY_SIZE`
`protected IXobject`	`parent`

Fields inherited from class exc.object.PropObject
id

Fields inherited from interface xcodeml.util.IXobject
FINDKIND_ANY, FINDKIND_COMMON, FINDKIND_TAGNAME, FINDKIND_TYPEDEF_NAME, FINDKIND_VAR

Constructor Summary

Constructors
Constructor and Description
`Xobject(Xcode code, Xtype type)`
`Xobject(Xcode code, Xtype type, int optional_flags)` Constructs an Xobject with code and type.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(Xobject a)` Dummy method at base class, it causes exception.
`bottomupXobjectIterator`	`bottomupIterator()`
`boolean`	`canGetInt()`
`Xobject`	`cfold(Block block)`
`Xobject`	`copy()` Dummy method at base class, it causes exception.
`protected Xobject`	`copyTo(Xobject o)`
`boolean`	`enter(XobjectVisitor visitor)`
`boolean`	`equals(java.lang.Object x)` check the equality of two objects
`boolean`	`equals(Xobject x)`
`Xobject`	`extent(int dim)`
`Xobject`	`extent(int dim, Block block)`
`Xobject[]`	`extents()`
`Xobject[]`	`extents(Block block)`
`Ident`	`find(java.lang.String name, int find_kind)` find symbol object.
`Ident`	`findCommonIdent(java.lang.String name)`
`Ident`	`findVarIdent(java.lang.String name)`
`Xobject`	`getArg(int i)` Return argument list in XobjArgs.
`Xobject`	`getArgOrNull(int i)` Get the i-th argument or null if no i-th argument.
`XobjArgs`	`getArgs()` Get an argument list XobjArgs.
`double`	`getFloat()` Returns floating value if XobjLong.
`java.lang.String`	`getFloatString()`
`int`	`getFrank(Block block)` Get rank in the term of Fortran.
`XobjList`	`getIdentList()` Get argument of 1 as XobjList.
`int`	`getInt()` Returns integer value in XobjInt.
`LineNo`	`getLineNo()` Dummy method at base class, it returns null.
`long`	`getLong()` Returns long value (64bits) if XobjLong.
`long`	`getLongHigh()` Returns high part of long value if XobjLong.
`long`	`getLongLow()` Returns low part of long value if XobjLong.
`Ident`	`getMember(java.lang.String name)`
`java.lang.String`	`getName()` Returns Name of Xobject.
`protected boolean`	`getOptionalFlag(int flag)`
`int`	`getOptionalFlags()`
`IXobject`	`getParent()` get parent IXobject.
`VarScope`	`getScope()`
`java.lang.String`	`getString()` Returns string in XobjString.
`Xobject`	`getSubscripts()`
`java.lang.String`	`getSym()` Returns Symbol name in XobjString.
`Xobject`	`getTail()` Dummy method at base class, it causes exception.
`boolean`	`hasNullArg()`
`void`	`insert(Xobject a)` Dummy method at base class, it causes exception.
`boolean`	`isArray()`
`boolean`	`isArrayAddr()`
`boolean`	`isAsgOp()` return ture if this object is an assignment with binary operation
`boolean`	`isAtomicStmt()`
`boolean`	`isBinaryOp()` return true if this object is binary operation.
`boolean`	`isCglobalVarOrFvar()`
`boolean`	`isConstant()` return true if this is an constant object
`boolean`	`isDelayedDecl()`
`boolean`	`isEmpty()` Returns true if no argument in XobjArgs.
`boolean`	`isEmptyList()`
`boolean`	`isExternalCode()`
`boolean`	`isFmoduleVar()`
`boolean`	`isGccExtension()`
`boolean`	`isGccSyntax()`
`boolean`	`isGccThread()`
`boolean`	`isIndexRange()`
`boolean`	`isInductionVar()`
`boolean`	`isIntConstant()` return true if this object is integer constant
`boolean`	`isLocalOrParamVar()`
`boolean`	`isLocalOrParamVarAddr()`
`boolean`	`isLogicalOp()` return true if this object is a logical operation.
`boolean`	`isOneConstant()` return true if this object is one integer constant.
`boolean`	`isParsed()`
`boolean`	`isPragma()`
`boolean`	`isRewrittedByXmp()`
`boolean`	`isScopeGlobal()`
`boolean`	`isScopeLocal()`
`boolean`	`isScopeParam()`
`boolean`	`isSet()` return ture if this object is an assignment.
`boolean`	`isSyntaxModified()`
`boolean`	`isTempVar()`
`boolean`	`isTerminal()` return true if this object is a terminal object
`boolean`	`isToBeFcommon()`
`boolean`	`isUnaryOp()` return true if this object is unary operation.
`boolean`	`isVarAddr()`
`boolean`	`isVariable()` Return true if the Xobject is a variable.
`boolean`	`isVarRef()`
`boolean`	`isZeroConstant()` return true if this object is zero integer constant.
`Xobject`	`lbound(int dim)`
`Xobject`	`lbound(int dim, Block block)`
`Xobject[]`	`lbounds()`
`Xobject[]`	`lbounds(Block block)`
`Xobject`	`left()` Dummy method at base class, it causes exception.
`int`	`Nargs()` Get number of argument in XobjArgs.
`static Xcode`	`newCode()`
`Xcode`	`Opcode()` Returns the code of this Xobject
`java.lang.String`	`OpcodeName()`
`Xobject`	`operand()` Dummy method at base class, it causes exception.
`Xobject`	`removeArgs(XobjArgs a)` Remove the specified argument in XobjArgs Dummy method at base class, it causes exception.
`Xobject`	`removeFirstArgs()` Remove the first argument in XobjArgs Dummy method at base class, it causes exception.
`Xobject`	`removeLastArgs()` Remove the last argument in XobjArgs Dummy method at base class, it causes exception.
`Xobject`	`right()` Dummy method at base class, it causes exception.
`void`	`setArg(int i, Xobject x)` Set argument list in XobjArg.
`void`	`setArgs(XobjArgs l)` Set an argument list in XobjArgs.
`void`	`setIsAtomicStmt(boolean enabled)`
`void`	`setIsDelayedDecl(boolean enabled)`
`void`	`setIsFmoduleVar(boolean enabled)`
`void`	`setIsGccExtension(boolean enabled)`
`void`	`setIsGccSyntax(boolean enabled)`
`void`	`setIsGccThread(boolean enabled)`
`void`	`setIsGlobal(boolean enabled)`
`void`	`setIsInductionVar(boolean enabled)`
`void`	`setIsParsed(boolean enabled)`
`void`	`setIsRewrittedByXmp(boolean enabled)`
`void`	`setIsSyntaxModified(boolean enabled)`
`void`	`setIsToBeFcommon(boolean enabled)`
`void`	`setLeft(Xobject x)` Dummy method at base class, it causes exception.
`void`	`setLineNo(LineNo ln)` Dummy method at base class, it causes exception.
`void`	`setName(java.lang.String name)` Returns Name of Xobject.
`void`	`setOperand(Xobject x)` Dummy method at base class, it causes exception.
`protected void`	`setOptionalFlag(int flag, boolean enabled)`
`void`	`setOptionalFlags(int optional_flags)`
`void`	`setParentRecursively(IXobject parent)` set parent IXobject.
`void`	`setRight(Xobject x)` Dummy method at base class, it causes exception.
`void`	`setScope(VarScope scope)`
`void`	`setType(Xtype type)` Sets the type of this Xobject
`topdownXobjectIterator`	`topdownIterator()`
`java.lang.String`	`toString()`
`Xtype`	`Type()` Returns the type of this Xobject
`Xobject`	`ubound(int dim)`
`Xobject`	`ubound(int dim, Block block)`
`Xobject[]`	`ubounds()`
`Xobject[]`	`ubounds(Block block)`

Methods inherited from class exc.object.PropObject
getProp, getProperties, Id, remProp, remProperties, setId, setProp, setProperties

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

- Field Detail
  - parent
```
protected IXobject parent
```
  - OPT_GCC_THREAD
```
public static final int OPT_GCC_THREAD
```
    See Also:
    
    Constant Field Values
  - OPT_GCC_EXTENSION
```
public static final int OPT_GCC_EXTENSION
```
    See Also:
    
    Constant Field Values
  - OPT_GCC_SYNTAX
```
public static final int OPT_GCC_SYNTAX
```
    See Also:
    
    Constant Field Values
  - OPT_SYNTAX_MODIFIED
```
public static final int OPT_SYNTAX_MODIFIED
```
    See Also:
    
    Constant Field Values
  - OPT_PARSED
```
public static final int OPT_PARSED
```
    See Also:
    
    Constant Field Values
  - OPT_USED_IN_ARRAY_SIZE
```
public static final int OPT_USED_IN_ARRAY_SIZE
```
    See Also:
    
    Constant Field Values
  - OPT_TO_BE_FCOMMON
```
public static final int OPT_TO_BE_FCOMMON
```
    See Also:
    
    Constant Field Values
  - OPT_DELAYED_DECL
```
public static final int OPT_DELAYED_DECL
```
    See Also:
    
    Constant Field Values
  - OPT_GLOBAL
```
public static final int OPT_GLOBAL
```
    See Also:
    
    Constant Field Values
  - OPT_ATOMIC_STMT
```
public static final int OPT_ATOMIC_STMT
```
    See Also:
    
    Constant Field Values
  - OPT_F_MODULE_VAR
```
public static final int OPT_F_MODULE_VAR
```
    See Also:
    
    Constant Field Values
  - OPT_INDUCTION_VAR
```
public static final int OPT_INDUCTION_VAR
```
    See Also:
    
    Constant Field Values
  - OPT_REWRITTED_XMP
```
public static final int OPT_REWRITTED_XMP
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Xobject
```
public Xobject(Xcode code,
               Xtype type,
               int optional_flags)
```
    Constructs an Xobject with code and type. This constructor is usually called superclass.
  - Xobject
```
public Xobject(Xcode code,
               Xtype type)
```
- Method Detail
  - Opcode
```
public final Xcode Opcode()
```
    Returns the code of this Xobject
  - Type
```
public final Xtype Type()
```
    Returns the type of this Xobject
  - setType
```
public final void setType(Xtype type)
```
    Sets the type of this Xobject
  - getOptionalFlags
```
public final int getOptionalFlags()
```
  - setOptionalFlags
```
public final void setOptionalFlags(int optional_flags)
```
  - setOptionalFlag
```
protected void setOptionalFlag(int flag,
                               boolean enabled)
```
  - getOptionalFlag
```
protected boolean getOptionalFlag(int flag)
```
  - isGccThread
```
public final boolean isGccThread()
```
  - setIsGccThread
```
public final void setIsGccThread(boolean enabled)
```
  - isGccExtension
```
public final boolean isGccExtension()
```
  - setIsGccExtension
```
public final void setIsGccExtension(boolean enabled)
```
  - isGccSyntax
```
public final boolean isGccSyntax()
```
  - setIsGccSyntax
```
public final void setIsGccSyntax(boolean enabled)
```
  - isSyntaxModified
```
public final boolean isSyntaxModified()
```
  - setIsSyntaxModified
```
public final void setIsSyntaxModified(boolean enabled)
```
  - isParsed
```
public final boolean isParsed()
```
  - setIsParsed
```
public final void setIsParsed(boolean enabled)
```
  - isToBeFcommon
```
public final boolean isToBeFcommon()
```
  - setIsToBeFcommon
```
public final void setIsToBeFcommon(boolean enabled)
```
  - isDelayedDecl
```
public final boolean isDelayedDecl()
```
  - setIsDelayedDecl
```
public final void setIsDelayedDecl(boolean enabled)
```
  - isCglobalVarOrFvar
```
public final boolean isCglobalVarOrFvar()
```
  - setIsGlobal
```
public final void setIsGlobal(boolean enabled)
```
  - isAtomicStmt
```
public final boolean isAtomicStmt()
```
  - setIsAtomicStmt
```
public final void setIsAtomicStmt(boolean enabled)
```
  - isFmoduleVar
```
public final boolean isFmoduleVar()
```
  - setIsFmoduleVar
```
public final void setIsFmoduleVar(boolean enabled)
```
  - isInductionVar
```
public final boolean isInductionVar()
```
  - setIsInductionVar
```
public final void setIsInductionVar(boolean enabled)
```
  - isRewrittedByXmp
```
public final boolean isRewrittedByXmp()
```
  - setIsRewrittedByXmp
```
public final void setIsRewrittedByXmp(boolean enabled)
```
  - getScope
```
public VarScope getScope()
```
  - setScope
```
public final void setScope(VarScope scope)
```
  - isScopeGlobal
```
public final boolean isScopeGlobal()
```
  - isScopeLocal
```
public final boolean isScopeLocal()
```
  - isScopeParam
```
public final boolean isScopeParam()
```
  - getInt
```
public int getInt()
```
    Returns integer value in XobjInt. Dummy method at base class, it causes exception.
  - canGetInt
```
public boolean canGetInt()
```
  - getString
```
public java.lang.String getString()
```
    Returns string in XobjString. Dummy method at base class, it causes exception.
  - getSym
```
public java.lang.String getSym()
```
    Returns Symbol name in XobjString. it is equal to getString. Dummy method at base class, it causes exception.
  - getName
```
public java.lang.String getName()
```
    Returns Name of Xobject. Dummy method at base class, it causes exception.
  - setName
```
public void setName(java.lang.String name)
```
    Returns Name of Xobject. Dummy method at base class, it causes exception.
  - getFloat
```
public double getFloat()
```
    Returns floating value if XobjLong. Dummy method at base class, it causes exception.
  - getFloatString
```
public java.lang.String getFloatString()
```
  - getLong
```
public long getLong()
```
    Returns long value (64bits) if XobjLong. Dummy method at base class, it causes exception.
  - getLongHigh
```
public long getLongHigh()
```
    Returns high part of long value if XobjLong. Dummy method at base class, it causes exception.
  - getLongLow
```
public long getLongLow()
```
    Returns low part of long value if XobjLong. Dummy method at base class, it causes exception.
  - getFrank
```
public int getFrank(Block block)
```
    Get rank in the term of Fortran. Eg: Rank of a scalar expr is 0. Rank of a subarray is equal to or less than the rank of the host array.
  - getSubscripts
```
public Xobject getSubscripts()
```
  - getArg
```
public Xobject getArg(int i)
```
    Return argument list in XobjArgs. Dummy method at base class, it causes exception.
  - getArgOrNull
```
public Xobject getArgOrNull(int i)
```
    Get the i-th argument or null if no i-th argument. Dummy method at base class, it causes exception.
  - setArg
```
public void setArg(int i,
                   Xobject x)
```
    Set argument list in XobjArg. Dummy method at base class, it causes exception.
  - Nargs
```
public int Nargs()
```
    Get number of argument in XobjArgs. Dummy method at base class, it causes exception.
  - getIdentList
```
public XobjList getIdentList()
```
    Get argument of 1 as XobjList.
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if no argument in XobjArgs. Dummy method at base class, it causes exception.
  - getArgs
```
public XobjArgs getArgs()
```
    Get an argument list XobjArgs. Dummy method at base class, it causes exception.
  - setArgs
```
public void setArgs(XobjArgs l)
```
    Set an argument list in XobjArgs. Dummy method at base class, it causes exception.
  - removeArgs
```
public Xobject removeArgs(XobjArgs a)
```
    Remove the specified argument in XobjArgs Dummy method at base class, it causes exception.
  - removeFirstArgs
```
public Xobject removeFirstArgs()
```
    Remove the first argument in XobjArgs Dummy method at base class, it causes exception.
  - removeLastArgs
```
public Xobject removeLastArgs()
```
    Remove the last argument in XobjArgs Dummy method at base class, it causes exception.
  - operand
```
public Xobject operand()
```
    Dummy method at base class, it causes exception.
  - left
```
public Xobject left()
```
    Dummy method at base class, it causes exception.
  - right
```
public Xobject right()
```
    Dummy method at base class, it causes exception.
  - setOperand
```
public void setOperand(Xobject x)
```
    Dummy method at base class, it causes exception.
  - setLeft
```
public void setLeft(Xobject x)
```
    Dummy method at base class, it causes exception.
  - setRight
```
public void setRight(Xobject x)
```
    Dummy method at base class, it causes exception.
  - add
```
public void add(Xobject a)
```
    Dummy method at base class, it causes exception.
  - getTail
```
public Xobject getTail()
```
    Dummy method at base class, it causes exception.
  - insert
```
public void insert(Xobject a)
```
    Dummy method at base class, it causes exception.
  - copy
```
public Xobject copy()
```
    Dummy method at base class, it causes exception.
  - copyTo
```
protected Xobject copyTo(Xobject o)
```
  - setLineNo
```
public void setLineNo(LineNo ln)
```
    Dummy method at base class, it causes exception.
  - getLineNo
```
public LineNo getLineNo()
```
    Dummy method at base class, it returns null.
    
    Specified by:
    
    getLineNo in interface IXobject
  - equals
```
public boolean equals(java.lang.Object x)
```
    check the equality of two objects
    
    Overrides:
    
    equals in class java.lang.Object
  - equals
```
public boolean equals(Xobject x)
```
  - OpcodeName
```
public final java.lang.String OpcodeName()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - isVariable
```
public boolean isVariable()
```
    Return true if the Xobject is a variable.
  - isLocalOrParamVar
```
public boolean isLocalOrParamVar()
```
  - isTempVar
```
public boolean isTempVar()
```
  - isVarAddr
```
public boolean isVarAddr()
```
  - isLocalOrParamVarAddr
```
public boolean isLocalOrParamVarAddr()
```
  - isArray
```
public boolean isArray()
```
  - isArrayAddr
```
public boolean isArrayAddr()
```
  - isConstant
```
public boolean isConstant()
```
    return true if this is an constant object
  - isVarRef
```
public boolean isVarRef()
```
  - isZeroConstant
```
public boolean isZeroConstant()
```
    return true if this object is zero integer constant.
  - isOneConstant
```
public boolean isOneConstant()
```
    return true if this object is one integer constant.
  - isIntConstant
```
public boolean isIntConstant()
```
    return true if this object is integer constant
  - isSet
```
public boolean isSet()
```
    return ture if this object is an assignment.
  - isBinaryOp
```
public boolean isBinaryOp()
```
    return true if this object is binary operation.
  - isUnaryOp
```
public boolean isUnaryOp()
```
    return true if this object is unary operation.
  - isAsgOp
```
public boolean isAsgOp()
```
    return ture if this object is an assignment with binary operation
  - isTerminal
```
public boolean isTerminal()
```
    return true if this object is a terminal object
  - isLogicalOp
```
public boolean isLogicalOp()
```
    return true if this object is a logical operation. EQ, NEQ, GE, GT, LE, LT, AND, OR, NOT
  - isPragma
```
public boolean isPragma()
```
  - enter
```
public boolean enter(XobjectVisitor visitor)
```
    Specified by:
    
    enter in interface XobjectVisitable
  - newCode
```
public static Xcode newCode()
                     throws XmException
```
    Throws:
    
    XmException
  - isExternalCode
```
public boolean isExternalCode()
```
  - topdownIterator
```
public topdownXobjectIterator topdownIterator()
```
  - bottomupIterator
```
public bottomupXobjectIterator bottomupIterator()
```
  - getMember
```
public Ident getMember(java.lang.String name)
```
  - getParent
```
public IXobject getParent()
```
    Description copied from interface: IXobject
    
    get parent IXobject.
    
    Specified by:
    
    getParent in interface IXobject
  - setParentRecursively
```
public void setParentRecursively(IXobject parent)
```
    Description copied from interface: IXobject
    
    set parent IXobject.
    
    Specified by:
    
    setParentRecursively in interface IXobject
  - find
```
public Ident find(java.lang.String name,
                  int find_kind)
```
    Description copied from interface: IXobject
    
    find symbol object.
    
    Specified by:
    
    find in interface IXobject
    
    Parameters:
    
    name - symbol name
    
    find_kind - FINDKIND_*
  - cfold
```
public Xobject cfold(Block block)
```
  - lbound
```
public Xobject lbound(int dim)
```
  - lbound
```
public Xobject lbound(int dim,
                      Block block)
```
  - lbounds
```
public Xobject[] lbounds()
```
  - lbounds
```
public Xobject[] lbounds(Block block)
```
  - ubound
```
public Xobject ubound(int dim)
```
  - ubound
```
public Xobject ubound(int dim,
                      Block block)
```
  - ubounds
```
public Xobject[] ubounds()
```
  - ubounds
```
public Xobject[] ubounds(Block block)
```
  - extent
```
public Xobject extent(int dim)
```
  - extent
```
public Xobject extent(int dim,
                      Block block)
```
  - extents
```
public Xobject[] extents()
```
  - extents
```
public Xobject[] extents(Block block)
```
  - findVarIdent
```
public Ident findVarIdent(java.lang.String name)
```
    Specified by:
    
    findVarIdent in interface IVarContainer
  - findCommonIdent
```
public Ident findCommonIdent(java.lang.String name)
```
    Specified by:
    
    findCommonIdent in interface IVarContainer
  - isEmptyList
```
public boolean isEmptyList()
```
  - hasNullArg
```
public boolean hasNullArg()
```
  - isIndexRange
```
public boolean isIndexRange()
```

Class Xobject

Field Summary

Fields inherited from class exc.object.PropObject

Fields inherited from interface xcodeml.util.IXobject

Constructor Summary

Method Summary

Methods inherited from class exc.object.PropObject

Methods inherited from class java.lang.Object

Field Detail

parent

OPT_GCC_THREAD

OPT_GCC_EXTENSION

OPT_GCC_SYNTAX

OPT_SYNTAX_MODIFIED

OPT_PARSED

OPT_USED_IN_ARRAY_SIZE

OPT_TO_BE_FCOMMON

OPT_DELAYED_DECL

OPT_GLOBAL

OPT_ATOMIC_STMT

OPT_F_MODULE_VAR

OPT_INDUCTION_VAR

OPT_REWRITTED_XMP

Constructor Detail

Xobject

Xobject

Method Detail

Opcode

Type

setType

getOptionalFlags

setOptionalFlags

setOptionalFlag

getOptionalFlag

isGccThread

setIsGccThread

isGccExtension

setIsGccExtension

isGccSyntax

setIsGccSyntax

isSyntaxModified

setIsSyntaxModified

isParsed

setIsParsed

isToBeFcommon

setIsToBeFcommon

isDelayedDecl

setIsDelayedDecl

isCglobalVarOrFvar

setIsGlobal

isAtomicStmt

setIsAtomicStmt

isFmoduleVar

setIsFmoduleVar

isInductionVar

setIsInductionVar

isRewrittedByXmp

setIsRewrittedByXmp

getScope

setScope

isScopeGlobal

isScopeLocal

isScopeParam

getInt

canGetInt

getString

getSym

getName

setName

getFloat

getFloatString

getLong

getLongHigh

getLongLow

getFrank

getSubscripts

getArg

getArgOrNull

setArg

Nargs