Package 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	Description
static final 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

Modifier and Type	Method	Description
void	addFinalizer(IRubyObject finalizer)
IRubyObject	addFinalizer(ThreadContext context, 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()	make this object into a string (hopefully)
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()	is this an array if so return it otherwise nil
IRubyObject	checkCallMethod(ThreadContext context, String name)
IRubyObject	checkCallMethod(ThreadContext context, JavaSites.CheckedSites sites)
IRubyObject	checkStringType()	is this a string if so return it otherwise nil
Operand	cloneForInlining(CloneInfo ii)
RubyArray	convertToArray()	Converts this Ruby object to an Array.
RubyFloat	convertToFloat()	Converts this Ruby object to a Float (using to_f).
RubyHash	convertToHash()	Converts this Ruby object to a Hash.
RubyInteger	convertToInteger()	Converts this Ruby object to an Integer.
RubyInteger	convertToInteger(String convertMethod)	Converts this Ruby object to an Integer.
RubyString	convertToString()	Converts this Ruby object to a String.
void	copySpecialInstanceVariables(IRubyObject clone)
Object	dataGetStruct()	Our version of Data_Get_Struct.
Object	dataGetStructChecked()	Deprecated.
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()	Retrieve self.class.
OperandType	getOperandType()
Ruby	getRuntime()	RubyMethod getRuntime.
RubyClass	getSingletonClass()	Retrieve self.singleton_class.
RubyClass	getType()	RubyMethod getType.
Object	getVariable(int index)
int	getVariableCount()	how many variables?
List<Variable<Object>>	getVariableList()	list of all variables
List<String>	getVariableNameList()	list of all variable names
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()	The id of the object
IRubyObject	infectBy(IRubyObject obj)	Deprecated.
IRubyObject	inspect()	RubyMethod inspect.
boolean	isClass()	If is_a? semantics is required, use (someObject instanceof RubyClass/MetaClass) instead.
boolean	isFrozen()	RubyMethod isFrozen.
boolean	isImmediate()	Is this an immediate object
boolean	isModule()	If is_a? semantics is required, use (someObject instanceof RubyModule) instead.
boolean	isNil()	Check whether this object is nil.
boolean	isSpecialConst()	Is this a special constant
boolean	isTaint()	Deprecated.
boolean	isTrue()	Check whether this object is truthy.
boolean	isUntrusted()	Deprecated.
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)	Deprecated.
void	setUntrusted(boolean b)	Deprecated.
void	setVariable(int index, Object value)
RubyClass	singletonClass(ThreadContext context)
void	syncVariables(List<Variable<Object>> variables)	Deprecated.
void	syncVariables(IRubyObject source)	Sets object's variables to those in the supplied object, removing/replacing any previously defined variables of the same name.
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, isFalseyImmediate, isTruthyImmediate

Methods inherited from class java.lang.Object

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

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

checkStringType19, convertToInteger, dup, getMarshalVariableList, inspect, marshalLiveVariables

Field Details

UNDEFINED

public static final UndefinedValue UNDEFINED

Method Details

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 occurrences 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

checkCallMethod

public IRubyObject checkCallMethod(ThreadContext context,
 JavaSites.CheckedSites sites)

Specified by:

checkCallMethod in interface IRubyObject

isNil

public boolean isNil()

Description copied from interface: IRubyObject

Check whether this object is nil. MRI: NIL_P macro

Specified by:

isNil in interface IRubyObject

Returns:

true for nil only

isTrue

public boolean isTrue()

Description copied from interface: IRubyObject

Check whether this object is truthy.

Specified by:

isTrue in interface IRubyObject

Returns:

false for nil and false, true otherwise

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 -

isImmediate

public boolean isImmediate()

Description copied from interface: IRubyObject

Is this an immediate object

Specified by:

isImmediate in interface IRubyObject

Returns:

boolean

isSpecialConst

public boolean isSpecialConst()

Description copied from interface: IRubyObject

Is this a special constant

Specified by:

isSpecialConst in interface IRubyObject

Returns:

boolean

getMetaClass

public RubyClass getMetaClass()

Description copied from interface: IRubyObject

Retrieve self.class.

Specified by:

getMetaClass in interface IRubyObject

Returns:

the Ruby (meta) class

getSingletonClass

public RubyClass getSingletonClass()

Description copied from interface: IRubyObject

Retrieve self.singleton_class.

Specified by:

getSingletonClass in interface IRubyObject

Returns:

the Ruby singleton class

singletonClass

public RubyClass singletonClass(ThreadContext context)

Specified by:

singletonClass in interface IRubyObject

getType

public RubyClass getType()

Description copied from interface: IRubyObject

RubyMethod getType.

Specified by:

getType in interface IRubyObject

Returns:

RubyClass

respondsTo

public boolean respondsTo(String string)

Description copied from interface: IRubyObject

RubyMethod respondsTo.

Specified by:

respondsTo in interface IRubyObject

Parameters:

string - method name

Returns:

boolean

respondsToMissing

public boolean respondsToMissing(String string)

Description copied from interface: IRubyObject

RubyMethod respondsTo.

Specified by:

respondsToMissing in interface IRubyObject

Parameters:

string - method name

Returns:

boolean

respondsToMissing

public boolean respondsToMissing(String string,
 boolean priv)

Description copied from interface: IRubyObject

RubyMethod respondsTo.

Specified by:

respondsToMissing in interface IRubyObject

Parameters:

string - method name

priv - private?

Returns:

boolean

getRuntime

public Ruby getRuntime()

Description copied from interface: IRubyObject

RubyMethod getRuntime.

Specified by:

getRuntime in interface IRubyObject

Returns:

the Ruby runtime this belongs to

getJavaClass

public Class getJavaClass()

Description copied from interface: IRubyObject

RubyMethod getJavaClass.

Specified by:

getJavaClass in interface IRubyObject

Returns:

Class

asJavaString

public String asJavaString()

Description copied from interface: IRubyObject

Convert the object into a symbol name if possible.

Specified by:

asJavaString in interface IRubyObject

Returns:

String the symbol name

asString

public RubyString asString()

Description copied from interface: IRubyObject

rb_obj_as_string

Specified by:

asString in interface IRubyObject

Returns:

string representation

convertToArray

public RubyArray convertToArray()

Description copied from interface: IRubyObject

Converts this Ruby object to an Array.

Specified by:

convertToArray in interface IRubyObject

Returns:

an array value

convertToHash

public RubyHash convertToHash()

Description copied from interface: IRubyObject

Converts this Ruby object to a Hash.

Specified by:

convertToHash in interface IRubyObject

Returns:

a hash value

convertToFloat

public RubyFloat convertToFloat()

Description copied from interface: IRubyObject

Converts this Ruby object to a Float (using to_f).

Specified by:

convertToFloat in interface IRubyObject

Returns:

a float value

convertToInteger

public RubyInteger convertToInteger()

Description copied from interface: IRubyObject

Converts this Ruby object to an Integer. Uses the default conversion method (to_int).

Specified by:

convertToInteger in interface IRubyObject

Returns:

an integer value

convertToInteger

public RubyInteger convertToInteger(String convertMethod)

Description copied from interface: IRubyObject

Converts this Ruby object to an Integer.

Specified by:

convertToInteger in interface IRubyObject

Parameters:

convertMethod - method to use e.g. to_i

Returns:

an integer value

convertToString

public RubyString convertToString()

Description copied from interface: IRubyObject

Converts this Ruby object to a String.

Specified by:

convertToString in interface IRubyObject

Returns:

a string value

anyToString

public IRubyObject anyToString()

Description copied from interface: IRubyObject

make this object into a string (hopefully)

Specified by:

anyToString in interface IRubyObject

Returns:

a string value

checkStringType

public IRubyObject checkStringType()

Description copied from interface: IRubyObject

is this a string if so return it otherwise nil

Specified by:

checkStringType in interface IRubyObject

Returns:

nil if type check failed

checkArrayType

public IRubyObject checkArrayType()

Description copied from interface: IRubyObject

is this an array if so return it otherwise nil

Specified by:

checkArrayType in interface IRubyObject

Returns:

nil if type check failed

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.

Returns:

java type

dup

public IRubyObject dup()

Description copied from interface: IRubyObject

RubyMethod dup.

Specified by:

dup in interface IRubyObject

Returns:

a dup-ed object

inspect

public IRubyObject inspect()

Description copied from interface: IRubyObject

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()

Description copied from interface: IRubyObject

If is_a? semantics is required, use (someObject instanceof RubyModule) instead.

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()

Description copied from interface: IRubyObject

If is_a? semantics is required, use (someObject instanceof RubyClass/MetaClass) instead.

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.

id

public IRubyObject id()

Description copied from interface: IRubyObject

The id of the object

Specified by:

id in interface IRubyObject

Returns:

the object id

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

addFinalizer

public IRubyObject addFinalizer(ThreadContext context,
 IRubyObject finalizer)

Specified by:

addFinalizer in interface IRubyObject

removeFinalizers

public void removeFinalizers()

Specified by:

removeFinalizers in interface IRubyObject

hasVariables

public boolean hasVariables()

Description copied from interface: IRubyObject

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()

Description copied from interface: IRubyObject

how many variables?

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.

Description copied from interface: IRubyObject

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)

Description copied from interface: IRubyObject

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()

Description copied from interface: IRubyObject

list of all variables

Specified by:

getVariableList in interface IRubyObject

Returns:

a list of all variables (ivar/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()

Description copied from interface: IRubyObject

list of all variable names

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

dataGetStructChecked

@Deprecated
public Object dataGetStructChecked()

Deprecated.

Specified by:

dataGetStructChecked in interface IRubyObject

isTaint

@Deprecated
public boolean isTaint()

Deprecated.

Specified by:

isTaint in interface IRubyObject

setTaint

@Deprecated
public void setTaint(boolean b)

Deprecated.

Specified by:

setTaint in interface IRubyObject

infectBy

@Deprecated
public IRubyObject infectBy(IRubyObject obj)

Deprecated.

Specified by:

infectBy in interface IRubyObject

isUntrusted

@Deprecated
public boolean isUntrusted()

Deprecated.

Description copied from interface: IRubyObject

RubyMethod isUntrusted.

Specified by:

isUntrusted in interface IRubyObject

Returns:

boolean

setUntrusted

@Deprecated
public void setUntrusted(boolean b)

Deprecated.

Description copied from interface: IRubyObject

RubyMethod setUntrusted.

Specified by:

setUntrusted in interface IRubyObject

Parameters:

b - boolean