org.jruby.runtime

Class ThreadContext

java.lang.Object

org.jruby.runtime.ThreadContext

public final class ThreadContext
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ThreadContext.RecursiveFunctionEx<T>

Field Summary

Fields

Modifier and Type	Field and Description
int	callNumber
boolean	exceptionRequiresBacktrace
RubyBoolean	fals
IRubyObject	nil
Ruby	runtime
RuntimeCache	runtimeCache
java.security.SecureRandom	secureRandom Deprecated.
JavaSites	sites
RubyBoolean	tru
static com.headius.backport9.stack.StackWalker	WALKER
static com.headius.backport9.stack.StackWalker	WALKER8

Method Summary

Modifier and Type	Method and Description
void	callThreadPoll()
static void	callThreadPoll(ThreadContext context)
IRubyObject	createCallerBacktrace(int level, int length, java.util.stream.Stream<com.headius.backport9.stack.StackWalker.StackFrame> stackStream) Create an Array with backtrace information for Kernel#caller
IRubyObject	createCallerLocations(int level, java.lang.Integer length, java.util.stream.Stream<com.headius.backport9.stack.StackWalker.StackFrame> stackStream) Create an array containing Thread::Backtrace::Location objects for the requested caller trace level and length.
static java.lang.String	createRawBacktraceStringFromThrowable(java.lang.Throwable ex, boolean color)
Binding	currentBinding() Return a binding representing the current call's state
Binding	currentBinding(IRubyObject self) Return a binding representing the current call's state but with a specified self
Binding	currentBinding(IRubyObject self, DynamicScope scope) Return a binding representing the current call's state but with the specified scope and self.
Binding	currentBinding(IRubyObject self, Visibility visibility) Return a binding representing the current call's state but with the specified visibility and self.
Binding	currentBinding(IRubyObject self, Visibility visibility, DynamicScope scope) Return a binding representing the current call's state but with the specified visibility, scope, and self.
org.jcodings.Encoding[]	encodingHolder()
void	exceptionBacktraceOff()
void	exceptionBacktraceOn()
protected void	finalize()
CatchThrow	getActiveCatch(java.lang.Object tag) Find the active Continuation for the given tag.
IRubyObject	getBackRef() Get the value of the $~ (backref) "global".
java.util.stream.Stream<BacktraceElement>	getBacktrace() Create a snapshot Array with current backtrace information.
java.util.stream.Stream<BacktraceElement>	getBacktrace(int level)
IRubyObject	getConstant(java.lang.String internedName) Deprecated.
Frame	getCurrentFrame()
DynamicScope	getCurrentScope()
StaticScope	getCurrentStaticScope()
int	getCurrentTarget()
Visibility	getCurrentVisibility()
IRubyObject	getErrorInfo()
ThreadFiber	getFiber()
RubyThread	getFiberCurrentThread()
java.lang.String	getFile()
Block	getFrameBlock()
RubyModule	getFrameKlazz()
java.lang.String	getFrameName()
IRubyObject	getFrameSelf()
CallType	getLastCallType()
IRubyObject	getLastExitStatus()
IRubyObject	getLastLine() Get the value of the $_ (lastline) "global".
Visibility	getLastVisibility()
int	getLine()
Frame	getNextFrame()
Frame	getPreviousFrame()
ProfileCollection	getProfileCollection() Get the profile collection for this thread (ThreadContext).
java.util.Set<RecursiveComparator.Pair>	getRecursiveSet()
RubyDateFormat	getRubyDateFormat() Deprecated.
RubyDateFormatter	getRubyDateFormatter()
Ruby	getRuntime() Retrieve the runtime associated with this context.
java.lang.Throwable	getSavedExceptionInLambda()
java.security.SecureRandom	getSecureRandom()
RubyStackTraceElement	getSingleBacktrace() Same as calling getSingleBacktrace(0);
RubyStackTraceElement	getSingleBacktrace(int level) Return a single RubyStackTraceElement representing the nearest Ruby stack trace element.
RubyThread	getThread()
boolean	hasAnyScopes()
boolean	isEventHooksEnabled()
boolean	isProfiling()
boolean	isWithinTrace() Is this thread actively tracing at this moment.
IRubyObject	last_match() MRI: rb_reg_last_match
IRubyObject	match_last() MRI: rb_reg_match_last
IRubyObject	match_post() MRI: rb_reg_match_post
IRubyObject	match_pre() MRI: rb_reg_match_pre
static ThreadContext	newContext(Ruby runtime)
void	pollThreadEvents()
static void	popBacktrace(ThreadContext context)
void	popCatch()
void	popFrame()
void	popScope()
void	postBackrefMethod()
void	postBsfApply()
void	postEvalScriptlet()
void	postEvalWithBinding(Binding binding, Frame lastFrame)
void	postExecuteUnder()
void	postMethodBacktraceAndScope()
void	postMethodBacktraceDummyScope()
void	postMethodBacktraceOnly()
void	postMethodFrameAndScope()
void	postMethodFrameOnly()
void	postMethodScopeOnly()
void	postNodeEval()
void	postScopedBody()
void	postTrace()
void	postYield(Binding binding, Frame lastFrame)
void	postYieldNoScope(Frame lastFrame)
void	preAdoptThread()
void	preBackrefMethod()
void	preBsfApply(java.lang.String[] names)
void	preEvalScriptlet(DynamicScope scope)
Frame	preEvalWithBinding(Binding binding)
void	preExecuteUnder(IRubyObject executeUnderObj, RubyModule executeUnderClass, Block block)
void	preExtensionLoad(IRubyObject self)
void	preMethodBacktraceAndScope(java.lang.String name, StaticScope staticScope)
void	preMethodBacktraceDummyScope(java.lang.String name, StaticScope staticScope)
void	preMethodBacktraceOnly(java.lang.String name)
void	preMethodFrameAndDummyScope(RubyModule clazz, java.lang.String name, IRubyObject self, Block block, StaticScope staticScope)
void	preMethodFrameAndScope(RubyModule clazz, java.lang.String name, IRubyObject self, Block block, StaticScope staticScope)
void	preMethodFrameOnly(RubyModule clazz, java.lang.String name, IRubyObject self)
void	preMethodFrameOnly(RubyModule clazz, java.lang.String name, IRubyObject self, Block block)
void	preMethodFrameOnly(RubyModule clazz, java.lang.String name, IRubyObject self, Visibility visiblity, Block block)
void	preMethodNoFrameAndDummyScope(StaticScope staticScope)
void	preMethodScopeOnly(StaticScope staticScope)
void	preNodeEval(IRubyObject self)
void	prepareTopLevel(RubyClass objectClass, IRubyObject topSelf)
void	preScopedBody(DynamicScope scope)
void	preTrace()
Frame	preYieldNoScope(Binding binding)
Frame	preYieldNoScope(Block block)
Frame	preYieldSpecificBlock(Binding binding, StaticScope scope)
void	printScope()
int	profileEnter(int nextMethod)
int	profileEnter(java.lang.String name, DynamicMethod nextMethod)
int	profileExit(int nextMethod, long startTime)
static void	pushBacktrace(ThreadContext context, java.lang.String method, java.lang.String file, int line)
void	pushCatch(CatchThrow catchTarget)
void	pushCatch(RubyContinuation.Continuation catchTarget) Deprecated.
void	pushEvalSimpleFrame(IRubyObject executeObject)
void	pushFrame()
DynamicScope	pushNewScope(StaticScope staticScope)
void	pushScope(DynamicScope scope)
void	renderCurrentBacktrace(java.lang.StringBuilder sb) Render the current backtrace as a string to the given StringBuilder.
<T> IRubyObject	safeRecurse(ThreadContext.RecursiveFunctionEx<T> func, T state, IRubyObject obj, java.lang.String name, boolean outer)
boolean	scopeExistsOnCallStack(DynamicScope scope) Check if a scope is present on the call stack.
IRubyObject	setBackRef(IRubyObject match) Set the $~ (backref) "global" to the given value.
void	setCurrentVisibility(Visibility visibility)
IRubyObject	setErrorInfo(IRubyObject errorInfo)
void	setEventHooksEnabled(boolean flag)
void	setExceptionRequiresBacktrace(boolean exceptionRequiresBacktrace)
void	setFiber(ThreadFiber fiber)
void	setFile(java.lang.String file) Deprecated.
void	setFileAndLine(ISourcePosition position)
void	setFileAndLine(java.lang.String file, int line)
void	setLastCallStatusAndVisibility(CallType callType, Visibility visibility)
void	setLastExitStatus(IRubyObject lastExitStatus)
IRubyObject	setLastLine(IRubyObject last) Set the $_ (lastlne) "global" to the given value.
void	setLine(int line)
void	setRecursiveSet(java.util.Set<RecursiveComparator.Pair> recursiveSet)
void	setRootFiber(ThreadFiber rootFiber)
void	setSavedExceptionInLambda(java.lang.Throwable e)
void	setThread(RubyThread thread)
void	setWithinTrace(boolean isWithinTrace) Set whether we are actively tracing or not on this thread.
void	startProfiling()
void	stopProfiling()
void	trace(RubyEvent event, java.lang.String name, RubyModule implClass)
void	trace(RubyEvent event, java.lang.String name, RubyModule implClass, java.lang.String file, int line)
void	useRecursionGuardsFrom(ThreadContext context) Fibers must use the same recursion guards as their parent thread.

Methods inherited from class java.lang.Object

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

Field Detail

runtime

public final Ruby runtime

nil

public final IRubyObject nil

tru

public final RubyBoolean tru

fals

public final RubyBoolean fals

runtimeCache

public final RuntimeCache runtimeCache

secureRandom

@Deprecated
public transient java.security.SecureRandom secureRandom

Deprecated.

This fields is no longer initialized, is null by default! Use getSecureRandom() instead.

sites

public final JavaSites sites

callNumber

public int callNumber

WALKER

public static final com.headius.backport9.stack.StackWalker WALKER

WALKER8

public static final com.headius.backport9.stack.StackWalker WALKER8

exceptionRequiresBacktrace

public boolean exceptionRequiresBacktrace

Method Detail

newContext

public static ThreadContext newContext(Ruby runtime)

getSecureRandom

public java.security.SecureRandom getSecureRandom()

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

getRuntime

public final Ruby getRuntime()

Retrieve the runtime associated with this context. Note that there's no reason to call this method rather than accessing the runtime field directly.

Returns:

the runtime associated with this context

See Also:

runtime

getErrorInfo

public IRubyObject getErrorInfo()

setErrorInfo

public IRubyObject setErrorInfo(IRubyObject errorInfo)

getSavedExceptionInLambda

public java.lang.Throwable getSavedExceptionInLambda()

setSavedExceptionInLambda

public void setSavedExceptionInLambda(java.lang.Throwable e)

getLastCallType

public CallType getLastCallType()

getLastVisibility

public Visibility getLastVisibility()

setLastCallStatusAndVisibility

public void setLastCallStatusAndVisibility(CallType callType,
                                           Visibility visibility)

getLastExitStatus

public IRubyObject getLastExitStatus()

setLastExitStatus

public void setLastExitStatus(IRubyObject lastExitStatus)

printScope

public void printScope()

getCurrentScope

public DynamicScope getCurrentScope()

getCurrentStaticScope

public StaticScope getCurrentStaticScope()

pushScope

public void pushScope(DynamicScope scope)

pushNewScope

public DynamicScope pushNewScope(StaticScope staticScope)

popScope

public void popScope()

getThread

public RubyThread getThread()

getFiberCurrentThread

public RubyThread getFiberCurrentThread()

getRubyDateFormatter

public RubyDateFormatter getRubyDateFormatter()

setThread

public void setThread(RubyThread thread)

getFiber

public ThreadFiber getFiber()

setFiber

public void setFiber(ThreadFiber fiber)

useRecursionGuardsFrom

public void useRecursionGuardsFrom(ThreadContext context)

Fibers must use the same recursion guards as their parent thread.

setRootFiber

public void setRootFiber(ThreadFiber rootFiber)

pushCatch

@Deprecated
public void pushCatch(RubyContinuation.Continuation catchTarget)

Deprecated.

pushCatch

public void pushCatch(CatchThrow catchTarget)

popCatch

public void popCatch()

getActiveCatch

public CatchThrow getActiveCatch(java.lang.Object tag)

Find the active Continuation for the given tag. Must be called with an interned string.

Parameters:

tag - The interned string to search for

Returns:

The continuation associated with this tag

pushEvalSimpleFrame

public void pushEvalSimpleFrame(IRubyObject executeObject)

pushFrame

public void pushFrame()

popFrame

public void popFrame()

getCurrentFrame

public Frame getCurrentFrame()

getNextFrame

public Frame getNextFrame()

getPreviousFrame

public Frame getPreviousFrame()

setBackRef

public IRubyObject setBackRef(IRubyObject match)

Set the $~ (backref) "global" to the given value.

Parameters:

match - the value to set

Returns:

the value passed in

getBackRef

public IRubyObject getBackRef()

Get the value of the $~ (backref) "global".

Returns:

the value of $~

last_match

public IRubyObject last_match()

MRI: rb_reg_last_match

match_pre

public IRubyObject match_pre()

MRI: rb_reg_match_pre

match_post

public IRubyObject match_post()

MRI: rb_reg_match_post

match_last

public IRubyObject match_last()

MRI: rb_reg_match_last

setLastLine

public IRubyObject setLastLine(IRubyObject last)

Set the $_ (lastlne) "global" to the given value.

Parameters:

last - the value to set

Returns:

the value passed in

getLastLine

public IRubyObject getLastLine()

Get the value of the $_ (lastline) "global".

Returns:

the value of $_

pushBacktrace

public static void pushBacktrace(ThreadContext context,
                                 java.lang.String method,
                                 java.lang.String file,
                                 int line)

popBacktrace

public static void popBacktrace(ThreadContext context)

hasAnyScopes

public boolean hasAnyScopes()

scopeExistsOnCallStack

public boolean scopeExistsOnCallStack(DynamicScope scope)

Check if a scope is present on the call stack. This is the IR equivalent of isJumpTargetAlive

Parameters:

scope - the scope to look for

Returns:

true if it exists. otherwise false.

getFrameName

public java.lang.String getFrameName()

getFrameSelf

public IRubyObject getFrameSelf()

getFrameKlazz

public RubyModule getFrameKlazz()

getFrameBlock

public Block getFrameBlock()

getFile

public java.lang.String getFile()

getLine

public int getLine()

setLine

public void setLine(int line)

setFileAndLine

public void setFileAndLine(java.lang.String file,
                           int line)

setFileAndLine

public void setFileAndLine(ISourcePosition position)

getCurrentVisibility

public Visibility getCurrentVisibility()

setCurrentVisibility

public void setCurrentVisibility(Visibility visibility)

pollThreadEvents

public void pollThreadEvents()

getCurrentTarget

public int getCurrentTarget()

callThreadPoll

public void callThreadPoll()

callThreadPoll

public static void callThreadPoll(ThreadContext context)

trace

public void trace(RubyEvent event,
                  java.lang.String name,
                  RubyModule implClass)

trace

public void trace(RubyEvent event,
                  java.lang.String name,
                  RubyModule implClass,
                  java.lang.String file,
                  int line)

getConstant

@Deprecated
public IRubyObject getConstant(java.lang.String internedName)

Deprecated.

Used by the evaluator and the compiler to look up a constant by name

renderCurrentBacktrace

public void renderCurrentBacktrace(java.lang.StringBuilder sb)

Render the current backtrace as a string to the given StringBuilder. This will honor the currently-configured backtrace format and content.

Parameters:

sb - the StringBuilder to which to render the backtrace

createCallerBacktrace

public IRubyObject createCallerBacktrace(int level,
                                         int length,
                                         java.util.stream.Stream<com.headius.backport9.stack.StackWalker.StackFrame> stackStream)

Create an Array with backtrace information for Kernel#caller

Parameters:

level -

length -

Returns:

an Array with the backtrace

createCallerLocations

public IRubyObject createCallerLocations(int level,
                                         java.lang.Integer length,
                                         java.util.stream.Stream<com.headius.backport9.stack.StackWalker.StackFrame> stackStream)

Create an array containing Thread::Backtrace::Location objects for the requested caller trace level and length.

Parameters:

level - the level at which the trace should start

length - the length of the trace

Returns:

an Array with the backtrace locations

getSingleBacktrace

public RubyStackTraceElement getSingleBacktrace(int level)

Return a single RubyStackTraceElement representing the nearest Ruby stack trace element. Used for warnings and Kernel#__dir__.

Returns:

the nearest stack trace element

getSingleBacktrace

public RubyStackTraceElement getSingleBacktrace()

Same as calling getSingleBacktrace(0);

See Also:

getSingleBacktrace(int)

isEventHooksEnabled

public boolean isEventHooksEnabled()

setEventHooksEnabled

public void setEventHooksEnabled(boolean flag)

getBacktrace

public java.util.stream.Stream<BacktraceElement> getBacktrace()

Create a snapshot Array with current backtrace information.

Returns:

the backtrace

getBacktrace

public final java.util.stream.Stream<BacktraceElement> getBacktrace(int level)

createRawBacktraceStringFromThrowable

public static java.lang.String createRawBacktraceStringFromThrowable(java.lang.Throwable ex,
                                                                     boolean color)

preAdoptThread

public void preAdoptThread()

preExtensionLoad

public void preExtensionLoad(IRubyObject self)

preBsfApply

public void preBsfApply(java.lang.String[] names)

postBsfApply

public void postBsfApply()

preMethodFrameAndScope

public void preMethodFrameAndScope(RubyModule clazz,
                                   java.lang.String name,
                                   IRubyObject self,
                                   Block block,
                                   StaticScope staticScope)

preMethodFrameAndDummyScope

public void preMethodFrameAndDummyScope(RubyModule clazz,
                                        java.lang.String name,
                                        IRubyObject self,
                                        Block block,
                                        StaticScope staticScope)

preMethodNoFrameAndDummyScope

public void preMethodNoFrameAndDummyScope(StaticScope staticScope)

postMethodFrameAndScope

public void postMethodFrameAndScope()

preMethodFrameOnly

public void preMethodFrameOnly(RubyModule clazz,
                               java.lang.String name,
                               IRubyObject self,
                               Block block)

preMethodFrameOnly

public void preMethodFrameOnly(RubyModule clazz,
                               java.lang.String name,
                               IRubyObject self,
                               Visibility visiblity,
                               Block block)

preMethodFrameOnly

public void preMethodFrameOnly(RubyModule clazz,
                               java.lang.String name,
                               IRubyObject self)

preBackrefMethod

public void preBackrefMethod()

postMethodFrameOnly

public void postMethodFrameOnly()

postBackrefMethod

public void postBackrefMethod()

preMethodScopeOnly

public void preMethodScopeOnly(StaticScope staticScope)

postMethodScopeOnly

public void postMethodScopeOnly()

preMethodBacktraceAndScope

public void preMethodBacktraceAndScope(java.lang.String name,
                                       StaticScope staticScope)

postMethodBacktraceAndScope

public void postMethodBacktraceAndScope()

preMethodBacktraceOnly

public void preMethodBacktraceOnly(java.lang.String name)

preMethodBacktraceDummyScope

public void preMethodBacktraceDummyScope(java.lang.String name,
                                         StaticScope staticScope)

postMethodBacktraceOnly

public void postMethodBacktraceOnly()

postMethodBacktraceDummyScope

public void postMethodBacktraceDummyScope()

prepareTopLevel

public void prepareTopLevel(RubyClass objectClass,
                            IRubyObject topSelf)

preNodeEval

public void preNodeEval(IRubyObject self)

postNodeEval

public void postNodeEval()

preExecuteUnder

public void preExecuteUnder(IRubyObject executeUnderObj,
                            RubyModule executeUnderClass,
                            Block block)

postExecuteUnder

public void postExecuteUnder()

preTrace

public void preTrace()

postTrace

public void postTrace()

preYieldSpecificBlock

public Frame preYieldSpecificBlock(Binding binding,
                                   StaticScope scope)

preYieldNoScope

public Frame preYieldNoScope(Binding binding)

preYieldNoScope

public Frame preYieldNoScope(Block block)

preEvalScriptlet

public void preEvalScriptlet(DynamicScope scope)

postEvalScriptlet

public void postEvalScriptlet()

preEvalWithBinding

public Frame preEvalWithBinding(Binding binding)

postEvalWithBinding

public void postEvalWithBinding(Binding binding,
                                Frame lastFrame)

postYield

public void postYield(Binding binding,
                      Frame lastFrame)

postYieldNoScope

public void postYieldNoScope(Frame lastFrame)

preScopedBody

public void preScopedBody(DynamicScope scope)

postScopedBody

public void postScopedBody()

isWithinTrace

public boolean isWithinTrace()

Is this thread actively tracing at this moment.

Returns:

true if so

See Also:

Ruby.callEventHooks(ThreadContext, RubyEvent, String, int, String, org.jruby.runtime.builtin.IRubyObject)

setWithinTrace

public void setWithinTrace(boolean isWithinTrace)

Set whether we are actively tracing or not on this thread.

Parameters:

isWithinTrace - true is so

See Also:

Ruby.callEventHooks(ThreadContext, RubyEvent, String, int, String, org.jruby.runtime.builtin.IRubyObject)

currentBinding

public Binding currentBinding()

Return a binding representing the current call's state

Returns:

the current binding

currentBinding

public Binding currentBinding(IRubyObject self)

Return a binding representing the current call's state but with a specified self

Parameters:

self - the self object to use

Returns:

the current binding, using the specified self

currentBinding

public Binding currentBinding(IRubyObject self,
                              Visibility visibility)

Return a binding representing the current call's state but with the specified visibility and self.

Parameters:

self - the self object to use

visibility - the visibility to use

Returns:

the current binding using the specified self and visibility

currentBinding

public Binding currentBinding(IRubyObject self,
                              DynamicScope scope)

Return a binding representing the current call's state but with the specified scope and self.

Parameters:

self - the self object to use

scope - the scope to use

Returns:

the current binding using the specified self and scope

currentBinding

public Binding currentBinding(IRubyObject self,
                              Visibility visibility,
                              DynamicScope scope)

Return a binding representing the current call's state but with the specified visibility, scope, and self. For shared-scope binding consumers like for loops.

Parameters:

self - the self object to use

visibility - the visibility to use

scope - the scope to use

Returns:

the current binding using the specified self, scope, and visibility

getProfileCollection

public ProfileCollection getProfileCollection()

Get the profile collection for this thread (ThreadContext).

Returns:

the thread's profile collection

startProfiling

public void startProfiling()

stopProfiling

public void stopProfiling()

isProfiling

public boolean isProfiling()

profileEnter

public int profileEnter(int nextMethod)

profileEnter

public int profileEnter(java.lang.String name,
                        DynamicMethod nextMethod)

profileExit

public int profileExit(int nextMethod,
                       long startTime)

getRecursiveSet

public java.util.Set<RecursiveComparator.Pair> getRecursiveSet()

setRecursiveSet

public void setRecursiveSet(java.util.Set<RecursiveComparator.Pair> recursiveSet)

setExceptionRequiresBacktrace

public void setExceptionRequiresBacktrace(boolean exceptionRequiresBacktrace)

exceptionBacktraceOn

public void exceptionBacktraceOn()

exceptionBacktraceOff

public void exceptionBacktraceOff()

safeRecurse

public <T> IRubyObject safeRecurse(ThreadContext.RecursiveFunctionEx<T> func,
                                   T state,
                                   IRubyObject obj,
                                   java.lang.String name,
                                   boolean outer)

encodingHolder

public org.jcodings.Encoding[] encodingHolder()

setFile

@Deprecated
public void setFile(java.lang.String file)

Deprecated.

getRubyDateFormat

@Deprecated
public RubyDateFormat getRubyDateFormat()

Deprecated.