ThreadContext (JRuby Core 9.1.5.0 API)

java.lang.Object
- org.jruby.runtime.ThreadContext

public final class ThreadContext
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`callNumber`
`boolean`	`exceptionRequiresBacktrace`
`IRubyObject`	`nil`
`Ruby`	`runtime`
`RuntimeCache`	`runtimeCache`
`SecureRandom`	`secureRandom` Deprecated.
`JavaSites`	`sites`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`callThreadPoll()`
`static void`	`callThreadPoll(ThreadContext context)`
`BacktraceElement[]`	`createBacktrace2(int level, boolean nativeException)` Deprecated.
`IRubyObject`	`createCallerBacktrace(int level, Integer length, StackTraceElement[] stacktrace)` Create an Array with backtrace information for Kernel#caller
`IRubyObject`	`createCallerLocations(int level, Integer length, StackTraceElement[] stacktrace)` Create an array containing Thread::Backtrace::Location objects for the requested caller trace level and length.
`static String`	`createRawBacktraceStringFromThrowable(Throwable ex, boolean color)`
`RubyStackTraceElement[]`	`createWarningBacktrace(Ruby runtime)` Create an Array with backtrace information for a built-in warning
`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()`
`protected void`	`finalize()`
`RubyStackTraceElement[]`	`gatherCallerBacktrace()`
`RubyContinuation.Continuation`	`getActiveCatch(Object tag)` Find the active Continuation for the given tag.
`IRubyObject`	`getBackRef()` Get the value of the $~ (backref) "global".
`BacktraceElement[]`	`getBacktrace()` Create a snapshot Array with current backtrace information.
`BacktraceElement[]`	`getBacktrace(int level)`
`IRubyObject`	`getConstant(String internedName)` Deprecated.
`Block.Type`	`getCurrentBlockType()`
`Frame`	`getCurrentFrame()`
`DynamicScope`	`getCurrentScope()`
`StaticScope`	`getCurrentStaticScope()`
`int`	`getCurrentTarget()`
`Visibility`	`getCurrentVisibility()`
`IRubyObject`	`getErrorInfo()`
`ThreadFiber`	`getFiber()`
`RubyThread`	`getFiberCurrentThread()`
`String`	`getFile()`
`Block`	`getFrameBlock()`
`RubyModule`	`getFrameKlazz()`
`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).
`Set<RecursiveComparator.Pair>`	`getRecursiveSet()`
`RubyDateFormat`	`getRubyDateFormat()` Deprecated.
`RubyDateFormatter`	`getRubyDateFormatter()`
`Ruby`	`getRuntime()` Retrieve the runtime associated with this context.
`Throwable`	`getSavedExceptionInLambda()`
`SecureRandom`	`getSecureRandom()`
`RubyThread`	`getThread()`
`boolean`	`hasAnyScopes()`
`boolean`	`isEventHooksEnabled()`
`boolean`	`isProfiling()`
`boolean`	`isWithinTrace()` Is this thread actively tracing at this moment.
`static ThreadContext`	`newContext(Ruby runtime)`
`void`	`pollThreadEvents()`
`static void`	`popBacktrace(ThreadContext context)`
`void`	`popCatch()`
`void`	`popFrame()`
`void`	`popScope()`
`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`	`preBsfApply(String[] names)`
`void`	`preEvalScriptlet(DynamicScope scope)`
`Frame`	`preEvalWithBinding(Binding binding)`
`void`	`preExecuteUnder(IRubyObject executeUnderObj, RubyModule executeUnderClass, Block block)`
`void`	`preExtensionLoad(IRubyObject self)`
`void`	`preMethodBacktraceAndScope(String name, StaticScope staticScope)`
`void`	`preMethodBacktraceDummyScope(String name, StaticScope staticScope)`
`void`	`preMethodBacktraceOnly(String name)`
`void`	`preMethodFrameAndDummyScope(RubyModule clazz, String name, IRubyObject self, Block block, StaticScope staticScope)`
`void`	`preMethodFrameAndScope(RubyModule clazz, String name, IRubyObject self, Block block, StaticScope staticScope)`
`void`	`preMethodFrameOnly(RubyModule clazz, String name, IRubyObject self)`
`void`	`preMethodFrameOnly(RubyModule clazz, String name, IRubyObject self, 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`	`preYieldSpecificBlock(Binding binding, StaticScope scope)`
`void`	`printScope()`
`int`	`profileEnter(int nextMethod)`
`int`	`profileEnter(String name, DynamicMethod nextMethod)`
`int`	`profileExit(int nextMethod, long startTime)`
`static void`	`pushBacktrace(ThreadContext context, String method, String file, int line)`
`void`	`pushCatch(RubyContinuation.Continuation catchTarget)`
`void`	`pushEvalSimpleFrame(IRubyObject executeObject)`
`void`	`pushFrame()`
`void`	`pushScope(DynamicScope scope)`
`void`	`renderCurrentBacktrace(StringBuilder sb)` Render the current backtrace as a string to the given StringBuilder.
`boolean`	`scopeExistsOnCallStack(DynamicScope scope)` Check if a static scope is present on the call stack.
`IRubyObject`	`setBackRef(IRubyObject match)` Set the $~ (backref) "global" to the given value.
`void`	`setCurrentBlockType(Block.Type type)`
`void`	`setCurrentVisibility(Visibility visibility)`
`IRubyObject`	`setErrorInfo(IRubyObject errorInfo)`
`void`	`setEventHooksEnabled(boolean flag)`
`void`	`setExceptionRequiresBacktrace(boolean exceptionRequiresBacktrace)`
`void`	`setFiber(ThreadFiber fiber)`
`void`	`setFile(String file)` Deprecated.
`void`	`setFileAndLine(ISourcePosition position)`
`void`	`setFileAndLine(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(Set<RecursiveComparator.Pair> recursiveSet)`
`void`	`setRootFiber(ThreadFiber rootFiber)`
`void`	`setSavedExceptionInLambda(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, String name, RubyModule implClass)`
`void`	`trace(RubyEvent event, String name, RubyModule implClass, String file, int line)`

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

runtimeCache
```
public final RuntimeCache runtimeCache
```

secureRandom
```
@Deprecated
public transient 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
```

exceptionRequiresBacktrace

public boolean exceptionRequiresBacktrace

Method Detail

newContext

public static ThreadContext newContext(Ruby runtime)

getSecureRandom
```
public SecureRandom getSecureRandom()
```

finalize

protected void finalize()
                 throws Throwable

Overrides:: finalize in class Object
Throws:: 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)

getCurrentBlockType

public Block.Type getCurrentBlockType()

setCurrentBlockType

public void setCurrentBlockType(Block.Type type)

getSavedExceptionInLambda

public Throwable getSavedExceptionInLambda()

setSavedExceptionInLambda

public void setSavedExceptionInLambda(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)

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)

setRootFiber

public void setRootFiber(ThreadFiber rootFiber)

pushCatch

public void pushCatch(RubyContinuation.Continuation catchTarget)

popCatch
```
public void popCatch()
```

getActiveCatch
```
public RubyContinuation.Continuation getActiveCatch(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 $~

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,
                                 String method,
                                 String file,
                                 int line)

popBacktrace

public static void popBacktrace(ThreadContext context)

hasAnyScopes
```
public boolean hasAnyScopes()
```

scopeExistsOnCallStack
```
public boolean scopeExistsOnCallStack(DynamicScope scope)
```
Check if a static scope is present on the call stack. This is the IR equivalent of isJumpTargetAlive

Parameters:

scope - the static scope to look for

Returns:

true if it exists false if not

getFrameName
```
public String getFrameName()
```

getFrameSelf
```
public IRubyObject getFrameSelf()
```

getFrameKlazz
```
public RubyModule getFrameKlazz()
```

getFrameBlock
```
public Block getFrameBlock()
```

getFile
```
public String getFile()
```

getLine
```
public int getLine()
```

setLine
```
public void setLine(int line)
```

setFileAndLine

public void setFileAndLine(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,
                  String name,
                  RubyModule implClass)

trace

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

getConstant
```
@Deprecated
public IRubyObject getConstant(String internedName)
```
Deprecated.

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

renderCurrentBacktrace
```
public void renderCurrentBacktrace(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,
                                         Integer length,
                                         StackTraceElement[] stacktrace)

Create an Array with backtrace information for Kernel#caller

Parameters:: level -; length -
Returns:: an Array with the backtrace

createCallerLocations

public IRubyObject createCallerLocations(int level,
                                         Integer length,
                                         StackTraceElement[] stacktrace)

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

createWarningBacktrace
```
public RubyStackTraceElement[] createWarningBacktrace(Ruby runtime)
```
Create an Array with backtrace information for a built-in warning

Parameters:

runtime -

Returns:

an Array with the backtrace

gatherCallerBacktrace

public RubyStackTraceElement[] gatherCallerBacktrace()

isEventHooksEnabled
```
public boolean isEventHooksEnabled()
```

setEventHooksEnabled

public void setEventHooksEnabled(boolean flag)

createBacktrace2

@Deprecated
public BacktraceElement[] createBacktrace2(int level,
                                                       boolean nativeException)

Deprecated.

getBacktrace
```
public BacktraceElement[] getBacktrace()
```
Create a snapshot Array with current backtrace information.

Returns:

the backtrace

getBacktrace

public final BacktraceElement[] getBacktrace(int level)

createRawBacktraceStringFromThrowable

public static String createRawBacktraceStringFromThrowable(Throwable ex,
                                                           boolean color)

preAdoptThread
```
public void preAdoptThread()
```

preExtensionLoad

public void preExtensionLoad(IRubyObject self)

preBsfApply

public void preBsfApply(String[] names)

postBsfApply
```
public void postBsfApply()
```

preMethodFrameAndScope

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

preMethodFrameAndDummyScope

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

preMethodNoFrameAndDummyScope

public void preMethodNoFrameAndDummyScope(StaticScope staticScope)

postMethodFrameAndScope
```
public void postMethodFrameAndScope()
```

preMethodFrameOnly

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

preMethodFrameOnly

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

postMethodFrameOnly
```
public void postMethodFrameOnly()
```

preMethodScopeOnly

public void preMethodScopeOnly(StaticScope staticScope)

postMethodScopeOnly
```
public void postMethodScopeOnly()
```

preMethodBacktraceAndScope

public void preMethodBacktraceAndScope(String name,
                                       StaticScope staticScope)

postMethodBacktraceAndScope

public void postMethodBacktraceAndScope()

preMethodBacktraceOnly

public void preMethodBacktraceOnly(String name)

preMethodBacktraceDummyScope

public void preMethodBacktraceDummyScope(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)

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(String name,
                        DynamicMethod nextMethod)

profileExit

public int profileExit(int nextMethod,
                       long startTime)

getRecursiveSet

public Set<RecursiveComparator.Pair> getRecursiveSet()

setRecursiveSet

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

setExceptionRequiresBacktrace

public void setExceptionRequiresBacktrace(boolean exceptionRequiresBacktrace)

encodingHolder

public org.jcodings.Encoding[] encodingHolder()

setFile

@Deprecated
public void setFile(String file)

Deprecated.

getRubyDateFormat

@Deprecated
public RubyDateFormat getRubyDateFormat()

Deprecated.

Class ThreadContext

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

runtime

nil

runtimeCache

secureRandom

sites

callNumber

exceptionRequiresBacktrace

Method Detail

newContext

getSecureRandom

finalize

getRuntime

getErrorInfo

setErrorInfo

getCurrentBlockType

setCurrentBlockType

getSavedExceptionInLambda

setSavedExceptionInLambda

getLastCallType

getLastVisibility

setLastCallStatusAndVisibility

getLastExitStatus

setLastExitStatus

printScope

getCurrentScope

getCurrentStaticScope

pushScope

popScope

getThread

getFiberCurrentThread

getRubyDateFormatter

setThread

getFiber

setFiber

setRootFiber

pushCatch

popCatch

getActiveCatch

pushEvalSimpleFrame

pushFrame

popFrame

getCurrentFrame

getNextFrame

getPreviousFrame

setBackRef

getBackRef

setLastLine

getLastLine

pushBacktrace

popBacktrace

hasAnyScopes

scopeExistsOnCallStack

getFrameName

getFrameSelf

getFrameKlazz

getFrameBlock

getFile

getLine

setLine

setFileAndLine

setFileAndLine

getCurrentVisibility

setCurrentVisibility

pollThreadEvents

getCurrentTarget

callThreadPoll

callThreadPoll

trace

trace

getConstant

renderCurrentBacktrace

createCallerBacktrace

createCallerLocations

createWarningBacktrace

gatherCallerBacktrace