org.jruby.ir.operands

Class UndefinedValue

java.lang.Object

org.jruby.ir.operands.Operand

org.jruby.ir.operands.UndefinedValue

All Implemented Interfaces:

IRubyObject

public class UndefinedValue
extends Operand
implements IRubyObject

For argument processing. If an opt arg does not exist we will return this so instrs can reason about non-existent arguments. Since this value can be temporarily stored in a binding, we need it to be an IRubyObject as well. But since it can never really participate in any operation, all calls throw a runtime exception.

Field Summary

Fields

Modifier and Type	Field and Description
static UndefinedValue	UNDEFINED

Fields inherited from class org.jruby.ir.operands.Operand

EMPTY_ARRAY

Fields inherited from interface org.jruby.runtime.builtin.IRubyObject

NULL_ARRAY

Method Summary

Methods

Modifier and Type	Method and Description
void	addFinalizer(IRubyObject finalizer)
void	addUsedVariables(List<Variable> l) Append the list of variables used in this operand to the input list -- force every operand to implement this because a missing implementation can cause bad failures.
IRubyObject	anyToString()
String	asJavaString() Convert the object into a symbol name if possible.
RubyString	asString() rb_obj_as_string
IRubyObject	callMethod(ThreadContext context, int methodIndex, String name) Deprecated.
IRubyObject	callMethod(ThreadContext context, int methodIndex, String name, IRubyObject arg) Deprecated.
IRubyObject	callMethod(ThreadContext context, String name)
IRubyObject	callMethod(ThreadContext context, String name, IRubyObject arg)
IRubyObject	callMethod(ThreadContext context, String name, IRubyObject[] args)
IRubyObject	callMethod(ThreadContext context, String name, IRubyObject[] args, Block block)
IRubyObject	callSuper(ThreadContext context, IRubyObject[] args, Block block) Deprecated.
boolean	canCopyPropagate() Can we replace every use of a variable 'v' that contains the value of this operand with the operand itself? This takes importance when there are at least two uses of 'v' within this scope.
IRubyObject	checkArrayType()
IRubyObject	checkCallMethod(ThreadContext context, String name)
IRubyObject	checkStringType()
IRubyObject	checkStringType19()
Operand	cloneForInlining(CloneInfo ii)
RubyArray	convertToArray() Methods which perform to_xxx if the object has such a method
RubyFloat	convertToFloat()
RubyHash	convertToHash()
RubyInteger	convertToInteger()
RubyInteger	convertToInteger(int convertMethodIndex, String convertMethod) Deprecated.
RubyInteger	convertToInteger(String convertMethod)
RubyString	convertToString()
void	copySpecialInstanceVariables(IRubyObject clone)
Object	dataGetStruct() Our version of Data_Get_Struct.
Object	dataGetStructChecked()
void	dataWrapStruct(Object obj) Our version of Data_Wrap_Struct.
IRubyObject	dup() RubyMethod dup.
boolean	eql(IRubyObject other)
InstanceVariables	getInstanceVariables()
InternalVariables	getInternalVariables()
Class	getJavaClass() RubyMethod getJavaClass.
RubyClass	getMetaClass() RubyMethod getRubyClass.
OperandType	getOperandType()
Ruby	getRuntime() RubyMethod getRuntime.
RubyClass	getSingletonClass() RubyMethod getSingletonClass.
RubyClass	getType() RubyMethod getType.
Object	getVariable(int index)
int	getVariableCount()
List<Variable<Object>>	getVariableList()
List<String>	getVariableNameList()
boolean	hasVariables() Returns true if object has any variables, defined as: instance variables class variables constants internal variables, such as those used when marshalling Ranges and Exceptions
IRubyObject	id()
IRubyObject	infectBy(IRubyObject obj) Infect this object using the taint of another object
IRubyObject	inspect() RubyMethod inspect.
boolean	isClass()
boolean	isFrozen() RubyMethod isFrozen.
boolean	isImmediate()
boolean	isModule()
boolean	isNil() RubyMethod isNil.
boolean	isSpecialConst()
boolean	isTaint() RubyMethod isTaint.
boolean	isTrue()
boolean	isUntrusted() RubyMethod isUntrusted.
IRubyObject	op_eqq(ThreadContext context, IRubyObject other)
IRubyObject	op_equal(ThreadContext context, IRubyObject other)
IRubyObject	rbClone() RubyMethod rbClone.
void	removeFinalizers()
boolean	respondsTo(String string) RubyMethod respondsTo.
boolean	respondsToMissing(String string) RubyMethod respondsTo.
boolean	respondsToMissing(String string, boolean priv) RubyMethod respondsTo.
Object	retrieve(ThreadContext context, IRubyObject self, StaticScope currScope, DynamicScope currDynScope, Object[] temp)
void	setFrozen(boolean b) RubyMethod setFrozen.
void	setTaint(boolean b) RubyMethod setTaint.
void	setUntrusted(boolean b) RubyMethod setUntrusted.
void	setVariable(int index, Object value)
void	syncVariables(IRubyObject source) Sets object's variables to those in the supplied object, removing/replacing any previously defined variables of the same name.
void	syncVariables(List<Variable<Object>> variables) Deprecated.
Object	toJava(Class cls) Convert the object to the specified Java class, if possible.
String	toString()
void	visit(IRVisitor visitor)

Methods inherited from class org.jruby.ir.operands.Operand

encode, getSimplifiedOperand, getValue, hasKnownValue

Methods inherited from class java.lang.Object

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

Field Detail

UNDEFINED

public static final UndefinedValue UNDEFINED

Method Detail

getOperandType

public OperandType getOperandType()

Specified by:

getOperandType in class Operand

addUsedVariables

public void addUsedVariables(List<Variable> l)

Description copied from class: Operand

Append the list of variables used in this operand to the input list -- force every operand to implement this because a missing implementation can cause bad failures.

Specified by:

addUsedVariables in class Operand

cloneForInlining

public Operand cloneForInlining(CloneInfo ii)

Specified by:

cloneForInlining in class Operand

canCopyPropagate

public boolean canCopyPropagate()

Description copied from class: Operand

Can we replace every use of a variable 'v' that contains the value of this operand with the operand itself? This takes importance when there are at least two uses of 'v' within this scope. Ex: v = [1,2,3]; x = v; y = v In this case, we cannot replace the occurences of 'v' because we would then get x = [1,2,3]; y = [1,2,3] which would then result in two different array objects being constructed instead of a single one.

Overrides:

canCopyPropagate in class Operand

Returns:

true if it is safe to copy-propagate the operand.

retrieve

public Object retrieve(ThreadContext context,
              IRubyObject self,
              StaticScope currScope,
              DynamicScope currDynScope,
              Object[] temp)

Overrides:

retrieve in class Operand

callSuper

@Deprecated
public IRubyObject callSuper(ThreadContext context,
                               IRubyObject[] args,
                               Block block)

Deprecated.

Specified by:

callSuper in interface IRubyObject

callMethod

public IRubyObject callMethod(ThreadContext context,
                     String name)

Specified by:

callMethod in interface IRubyObject

callMethod

public IRubyObject callMethod(ThreadContext context,
                     String name,
                     IRubyObject arg)

Specified by:

callMethod in interface IRubyObject

callMethod

public IRubyObject callMethod(ThreadContext context,
                     String name,
                     IRubyObject[] args)

Specified by:

callMethod in interface IRubyObject

callMethod

public IRubyObject callMethod(ThreadContext context,
                     String name,
                     IRubyObject[] args,
                     Block block)

Specified by:

callMethod in interface IRubyObject

callMethod

@Deprecated
public IRubyObject callMethod(ThreadContext context,
                                int methodIndex,
                                String name)

Deprecated.

Specified by:

callMethod in interface IRubyObject

callMethod

@Deprecated
public IRubyObject callMethod(ThreadContext context,
                                int methodIndex,
                                String name,
                                IRubyObject arg)

Deprecated.

Specified by:

callMethod in interface IRubyObject

checkCallMethod

public IRubyObject checkCallMethod(ThreadContext context,
                          String name)

Specified by:

checkCallMethod in interface IRubyObject

isNil

public boolean isNil()

Description copied from interface: IRubyObject

RubyMethod isNil.

Specified by:

isNil in interface IRubyObject

Returns:

boolean

isTrue

public boolean isTrue()

Specified by:

isTrue in interface IRubyObject

Returns:

isTaint

public boolean isTaint()

RubyMethod isTaint.

Specified by:

isTaint in interface IRubyObject

Returns:

boolean

setTaint

public void setTaint(boolean b)

RubyMethod setTaint.

Specified by:

setTaint in interface IRubyObject

Parameters:

b -

infectBy

public IRubyObject infectBy(IRubyObject obj)

Infect this object using the taint of another object

Specified by:

infectBy in interface IRubyObject

Parameters:

obj -

Returns:

isFrozen

public boolean isFrozen()

RubyMethod isFrozen.

Specified by:

isFrozen in interface IRubyObject

Returns:

boolean

setFrozen

public void setFrozen(boolean b)

RubyMethod setFrozen.

Specified by:

setFrozen in interface IRubyObject

Parameters:

b -

isUntrusted

public boolean isUntrusted()

RubyMethod isUntrusted.

Specified by:

isUntrusted in interface IRubyObject

Returns:

boolean

setUntrusted

public void setUntrusted(boolean b)

RubyMethod setUntrusted.

Specified by:

setUntrusted in interface IRubyObject

Parameters:

b -

isImmediate

public boolean isImmediate()

Specified by:

isImmediate in interface IRubyObject

Returns:

isSpecialConst

public boolean isSpecialConst()

Specified by:

isSpecialConst in interface IRubyObject

Returns:

getMetaClass

public RubyClass getMetaClass()

RubyMethod getRubyClass.

Specified by:

getMetaClass in interface IRubyObject

Returns:

getSingletonClass

public RubyClass getSingletonClass()

RubyMethod getSingletonClass.

Specified by:

getSingletonClass in interface IRubyObject

Returns:

RubyClass

getType

public RubyClass getType()

RubyMethod getType.

Specified by:

getType in interface IRubyObject

Returns:

RubyClass

respondsTo

public boolean respondsTo(String string)

RubyMethod respondsTo.

Specified by:

respondsTo in interface IRubyObject

Parameters:

string -

Returns:

boolean

respondsToMissing

public boolean respondsToMissing(String string)

RubyMethod respondsTo.

Specified by:

respondsToMissing in interface IRubyObject

Parameters:

string -

Returns:

boolean

respondsToMissing

public boolean respondsToMissing(String string,
                        boolean priv)

RubyMethod respondsTo.

Specified by:

respondsToMissing in interface IRubyObject

Parameters:

string -

Returns:

boolean

getRuntime

public Ruby getRuntime()

RubyMethod getRuntime.

Specified by:

getRuntime in interface IRubyObject

Returns:

getJavaClass

public Class getJavaClass()

RubyMethod getJavaClass.

Specified by:

getJavaClass in interface IRubyObject

Returns:

Class

asJavaString

public String asJavaString()

Convert the object into a symbol name if possible.

Specified by:

asJavaString in interface IRubyObject

Returns:

String the symbol name

asString

public RubyString asString()

rb_obj_as_string

Specified by:

asString in interface IRubyObject

Returns:

convertToArray

public RubyArray convertToArray()

Methods which perform to_xxx if the object has such a method

Specified by:

convertToArray in interface IRubyObject

Returns:

convertToHash

public RubyHash convertToHash()

Specified by:

convertToHash in interface IRubyObject

Returns:

convertToFloat

public RubyFloat convertToFloat()

Specified by:

convertToFloat in interface IRubyObject

Returns:

convertToInteger

public RubyInteger convertToInteger()

Specified by:

convertToInteger in interface IRubyObject

Returns:

convertToInteger

@Deprecated
public RubyInteger convertToInteger(int convertMethodIndex,
                                      String convertMethod)

Deprecated.

Specified by:

convertToInteger in interface IRubyObject

Returns:

convertToInteger

public RubyInteger convertToInteger(String convertMethod)

Specified by:

convertToInteger in interface IRubyObject

Returns:

convertToString

public RubyString convertToString()

Specified by:

convertToString in interface IRubyObject

Returns:

anyToString

public IRubyObject anyToString()

Specified by:

anyToString in interface IRubyObject

Returns:

checkStringType

public IRubyObject checkStringType()

Specified by:

checkStringType in interface IRubyObject

Returns:

checkStringType19

public IRubyObject checkStringType19()

Specified by:

checkStringType19 in interface IRubyObject

Returns:

checkArrayType

public IRubyObject checkArrayType()

Specified by:

checkArrayType in interface IRubyObject

Returns:

toJava

public Object toJava(Class cls)

Convert the object to the specified Java class, if possible.

Specified by:

toJava in interface IRubyObject

Parameters:

cls - The target type to which the object should be converted.

dup

public IRubyObject dup()

RubyMethod dup.

Specified by:

dup in interface IRubyObject

Returns:

inspect

public IRubyObject inspect()

RubyMethod inspect.

Specified by:

inspect in interface IRubyObject

Returns:

String

rbClone

public IRubyObject rbClone()

RubyMethod rbClone.

Specified by:

rbClone in interface IRubyObject

Returns:

IRubyObject

isModule

public boolean isModule()

Specified by:

isModule in interface IRubyObject

Returns:

true if an object is Ruby Module instance (note that it will return false for Ruby Classes). If is_a? semantics is required, use (someObject instanceof RubyModule) instead.

isClass

public boolean isClass()

Specified by:

isClass in interface IRubyObject

Returns:

true if an object is Ruby Class instance (note that it will return false for Ruby singleton classes). If is_a? semantics is required, use (someObject instanceof RubyClass/MetaClass) instead.

dataWrapStruct

public void dataWrapStruct(Object obj)

Our version of Data_Wrap_Struct. This method will just set a private pointer to the object provided. This pointer is transient and will not be accessible from Ruby.

Specified by:

dataWrapStruct in interface IRubyObject

Parameters:

obj - the object to wrap

dataGetStruct

public Object dataGetStruct()

Our version of Data_Get_Struct. Returns a wrapped data value if there is one, otherwise returns null.

Specified by:

dataGetStruct in interface IRubyObject

Returns:

the object wrapped.

dataGetStructChecked

public Object dataGetStructChecked()

Specified by:

dataGetStructChecked in interface IRubyObject

id

public IRubyObject id()

Specified by:

id in interface IRubyObject

Returns:

op_equal

public IRubyObject op_equal(ThreadContext context,
                   IRubyObject other)

Specified by:

op_equal in interface IRubyObject

op_eqq

public IRubyObject op_eqq(ThreadContext context,
                 IRubyObject other)

Specified by:

op_eqq in interface IRubyObject

eql

public boolean eql(IRubyObject other)

Specified by:

eql in interface IRubyObject

addFinalizer

public void addFinalizer(IRubyObject finalizer)

Specified by:

addFinalizer in interface IRubyObject

removeFinalizers

public void removeFinalizers()

Specified by:

removeFinalizers in interface IRubyObject

hasVariables

public boolean hasVariables()

Returns true if object has any variables, defined as:

• instance variables
• class variables
• constants
• internal variables, such as those used when marshalling Ranges and Exceptions

Specified by:

hasVariables in interface IRubyObject

Returns:

true if object has any variables, else false

getVariableCount

public int getVariableCount()

Specified by:

getVariableCount in interface IRubyObject

Returns:

the count of all variables (ivar/cvar/constant/internal)

syncVariables

@Deprecated
public void syncVariables(List<Variable<Object>> variables)

Deprecated.

Sets object's variables to those in the supplied list, removing/replacing any previously defined variables. Applies to all variable types (ivar/cvar/constant/internal).

Specified by:

syncVariables in interface IRubyObject

Parameters:

variables - the variables to be set for object

syncVariables

public void syncVariables(IRubyObject source)

Sets object's variables to those in the supplied object, removing/replacing any previously defined variables of the same name. Applies to all variable types (ivar/cvar/constant/internal).

Specified by:

syncVariables in interface IRubyObject

Parameters:

source - the source object containing the variables to sync

getVariableList

public List<Variable<Object>> getVariableList()

Specified by:

getVariableList in interface IRubyObject

Returns:

a list of all variables (ivar/cvar/constant/internal)

getInstanceVariables

public InstanceVariables getInstanceVariables()

Specified by:

getInstanceVariables in interface IRubyObject

getInternalVariables

public InternalVariables getInternalVariables()

Specified by:

getInternalVariables in interface IRubyObject

getVariableNameList

public List<String> getVariableNameList()

Specified by:

getVariableNameList in interface IRubyObject

Returns:

a list of all variable names (ivar/cvar/constant/internal)

copySpecialInstanceVariables

public void copySpecialInstanceVariables(IRubyObject clone)

Specified by:

copySpecialInstanceVariables in interface IRubyObject

getVariable

public Object getVariable(int index)

Specified by:

getVariable in interface IRubyObject

setVariable

public void setVariable(int index,
               Object value)

Specified by:

setVariable in interface IRubyObject

toString

public String toString()

Overrides:

toString in class Object

visit

public void visit(IRVisitor visitor)

Overrides:

visit in class Operand