Package org.jruby

Class RubyMatchData

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.RubyMatchData

All Implemented Interfaces:

Serializable, Cloneable, Comparable<IRubyObject>, InstanceVariables, InternalVariables, IRubyObject, CoreObjectType

public class RubyMatchData
extends RubyObject

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	RubyMatchData.Pair

Nested classes/interfaces inherited from class org.jruby.RubyObject

RubyObject.Data

Nested classes/interfaces inherited from class org.jruby.RubyBasicObject

RubyBasicObject.Finalizer

Field Summary

Fields

Modifier and Type	Field	Description
(package private) int	begin
private org.joni.Region	charOffsets
private boolean	charOffsetUpdated
(package private) int	end
private static final int	MATCH_BUSY
private Object	pattern
(package private) RubyRegexp	regexp
(package private) org.joni.Region	regs
(package private) RubyString	str

Fields inherited from class org.jruby.RubyObject

IVAR_INSPECTING_OBJECT_ALLOCATOR, OBJECT_ALLOCATOR, REIFYING_OBJECT_ALLOCATOR

Fields inherited from class org.jruby.RubyBasicObject

ALL_F, BASICOBJECT_ALLOCATOR, COMPARE_BY_IDENTITY_F, ERR_INSECURE_SET_INST_VAR, FALSE_F, FL_USHIFT, flags, FROZEN_F, IS_OVERLAID_F, metaClass, NEVER, NIL_F, REFINED_MODULE_F, STAMP_OFFSET, TAINTED_F, UNDEF, UNTRUST_F, USER0_F, USER1_F, USER2_F, USER3_F, USER4_F, USER5_F, USER6_F, USER7_F, USER8_F, USER9_F, USERA_F, VAR_TABLE_OFFSET, varTable, varTableStamp

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

NULL_ARRAY

Constructor Summary

Constructors

Constructor	Description
RubyMatchData(Ruby runtime)
RubyMatchData(Ruby runtime, RubyClass metaClass)

Method Summary

Modifier and Type	Method	Description
final IRubyObject	at(int nth)
static int	backrefNumber(Ruby runtime, org.joni.Regex pattern, org.joni.Region regs, IRubyObject obj)
final int	backrefNumber(Ruby runtime, IRubyObject obj)
int	begin(int i)	Get the begin offset of the given region, or -1 if the region does not exist.
IRubyObject	begin(ThreadContext context, IRubyObject index)	MRI: match_begin
IRubyObject	captures(ThreadContext context)	match_captures
(package private) final void	check()
void	copySpecialInstanceVariables(IRubyObject clone)	Lots of MRI objects keep their state in non-lookupable ivars (e:g.
static RubyClass	createMatchDataClass(Ruby runtime)
int	end(int i)	Get the end offset of the given region, or -1 if the region does not exist.
IRubyObject	end(ThreadContext context, IRubyObject index)	match_end
IRubyObject	eql_p(IRubyObject obj)	rb_obj_equal Just like "==" and "equal?", "eql?" will use identity equality for Object.
boolean	equals(Object other)	This override does not do a "checked" dispatch.
IRubyObject[]	getNamedBackrefValues(Ruby runtime)
int	getNameToBackrefNumber(String name)
ClassIndex	getNativeClassIndex()	This is overridden in the other concrete Java builtins to provide a fast way to determine what type they are.
(package private) final org.joni.Regex	getPattern()
private RubyRegexp	getRegexp()
IRubyObject	group(int n)
IRubyObject	group(long n)
RubyFixnum	hash()	rb_obj_id Will return the hash code of this object.
int	hashCode()	This override does not do "checked" dispatch since Object usually has #hash defined.
IRubyObject	initialize_copy(IRubyObject original)	rb_obj_init_copy Initializes this object as a copy of the original, that is the parameter to this object.
(package private) final void	initMatchData(RubyString str, int beg, RubyString pattern)
(package private) final void	initMatchData(RubyString str, org.joni.Matcher matcher, org.joni.Regex pattern)
RubyString	inspect()	rb_obj_inspect call-seq: obj.inspect => string Returns a string containing a human-readable representation of obj.
private static RubyString	makeShared(Ruby runtime, RubyString str, int index, int length)
private RubyArray	match_array(Ruby runtime, int start)
private IRubyObject	matchAryAref(ThreadContext context, IRubyObject index, RubyArray result)
private IRubyObject	matchArySubseq(ThreadContext context, int beg, int len, RubyArray result)
RubyHash	named_captures(ThreadContext context)
IRubyObject	names(ThreadContext context, Block block)
private int	nameToBackrefError(Ruby runtime, String name)
private static int	nameToBackrefNumber(Ruby runtime, org.joni.Regex pattern, org.joni.Region regs, ByteListHolder str)
private int	nameToBackrefNumber(RubyString str)
private int	namevToBacktraceNumber(ThreadContext context, IRubyObject name)
int	numRegs()	Fetch the number of regions in this match.
IRubyObject	offset(ThreadContext context, IRubyObject index)	match_offset
IRubyObject	offset19(ThreadContext context, IRubyObject index)
IRubyObject	op_aref(IRubyObject idx)	Deprecated.
IRubyObject	op_aref(IRubyObject idx, IRubyObject rest)	Deprecated.
IRubyObject	op_aref(ThreadContext context, IRubyObject idx)	match_aref
IRubyObject	op_aref(ThreadContext context, IRubyObject idx, IRubyObject rest)	match_aref
IRubyObject	op_aref19(IRubyObject idx, IRubyObject rest)	Deprecated.
private IRubyObject	op_arefCommon(IRubyObject idx)
IRubyObject	post_match(ThreadContext context)	match_post_match
IRubyObject	pre_match(ThreadContext context)	match_pre_match
RubyRegexp	regexp(ThreadContext context, Block block)
IRubyObject	size(ThreadContext context)	match_size
IRubyObject	string()	match_string
RubyArray	to_a()	Deprecated.
RubyArray	to_a(ThreadContext context)	match_to_a
IRubyObject	to_s()	match_to_s
private void	updateCharOffset()
private void	updateCharOffsetManyRegs(ByteList value, org.jcodings.Encoding encoding)
private void	updateCharOffsetOnlyOneReg(ByteList value, org.jcodings.Encoding encoding)
private static void	updatePairs(ByteList value, org.jcodings.Encoding encoding, RubyMatchData.Pair[] pairs)
final void	use()
final boolean	used()
IRubyObject	values_at(IRubyObject[] args)
IRubyObject	values_at(ThreadContext context, IRubyObject[] args)

Methods inherited from class org.jruby.RubyObject

attachToObjectSpace, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, convertToType, createObjectClass, dig, dig1, dig2, eqlInternal, equalInternal, inspect, op_eqq, puts, specificEval, toRubyString, toString

Methods inherited from class org.jruby.RubyBasicObject

addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkCallMethod, checkCallMethod, checkFrozen, checkStringType, checkStringType19, compareTo, convertToArray, convertToFloat, convertToHash, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, createBasicObjectClass, dataGetStruct, dataGetStructChecked, dataWrapStruct, decode, defaultToJava, display, dup, ensureInstanceVariablesSettable, eql, equal_p, equal_p19, evalUnder, extend, fastGetInstanceVariable, fastGetInternalVariable, fastHasInstanceVariable, fastHasInternalVariable, fastSetInstanceVariable, fastSetInternalVariable, freeze, frozen_p, getFFIHandle, getFlag, getInstanceEvalClass, getInstanceVariable, getInstanceVariableList, getInstanceVariableNameList, getInstanceVariables, getInternalVariable, getInternalVariables, getJavaClass, getMetaClass, getMetaClass, getNativeHandle, getNativeTypeIndex, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getSingletonClassCloneAndAttach, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hashyInspect, hasInstanceVariable, hasInstanceVariables, hasInternalVariable, hasVariables, id, infectBy, infectBy, infectBy, initialize, initialize19, inspectHashCode, instance_eval, instance_eval, instance_eval, instance_eval, instance_eval19, instance_eval19, instance_eval19, instance_eval19, instance_exec, instance_exec19, instance_of_p, instance_variable_defined_p, instance_variable_get, instance_variable_set, instance_variables, instance_variables19, isBuiltin, isClass, isFalse, isFrozen, isImmediate, isModule, isNil, isSpecialConst, isSpecialObject, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, method, method_missing, method_missing19, method19, methods, methods, methods19, methodsImpl, nil_p, nonFixnumHashCode, OBJ_INIT_COPY, objInitCopy, op_cmp, op_equal, op_equal_19, op_match, op_match19, op_not, op_not_equal, op_not_match, private_methods, private_methods19, protected_methods, protected_methods19, public_methods, public_methods19, rbClone, rbClone, rbInspect, recacheBuiltinMethods, remove_instance_variable, removeFinalizers, removeInstanceVariable, removeInternalVariable, respond_to_p, respond_to_p, respond_to_p, respond_to_p19, respond_to_p19, respondsTo, respondsToMissing, respondsToMissing, send, send, send, send, send, send19, send19, send19, send19, setFFIHandle, setFlag, setFrozen, setInstanceVariable, setInternalVariable, setMetaClass, setNativeHandle, setTaint, setUntrusted, setVariable, singleton_method, singleton_method_added, singleton_method_added19, singleton_method_removed, singleton_method_removed19, singleton_method_undefined, singleton_method_undefined19, singleton_methods, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, taint, tainted, tainted_p, testFrozen, testFrozen, toJava, trust, type, type_deprecated, untaint, untrust, untrusted_p, validateInstanceVariable, validateInstanceVariable, validateInstanceVariable, variableTableContains, variableTableFastContains, variableTableFastFetch, variableTableFastStore, variableTableFetch, variableTableRemove, variableTableStore, variableTableSync, yieldUnder, yieldUnder

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

regs

org.joni.Region regs

begin

int begin

end

int end

str

RubyString str

pattern

private Object pattern

regexp

transient RubyRegexp regexp

charOffsetUpdated

private boolean charOffsetUpdated

charOffsets

private org.joni.Region charOffsets

MATCH_BUSY

private static final int MATCH_BUSY

Constructor Details

RubyMatchData

public RubyMatchData(Ruby runtime)

RubyMatchData

public RubyMatchData(Ruby runtime,
 RubyClass metaClass)

Method Details

createMatchDataClass

public static RubyClass createMatchDataClass(Ruby runtime)

initMatchData

final void initMatchData(RubyString str,
 org.joni.Matcher matcher,
 org.joni.Regex pattern)

initMatchData

final void initMatchData(RubyString str,
 int beg,
 RubyString pattern)

copySpecialInstanceVariables

public void copySpecialInstanceVariables(IRubyObject clone)

Description copied from class: RubyBasicObject

Lots of MRI objects keep their state in non-lookupable ivars (e:g. Range, Struct, etc). This method is responsible for dupping our java field equivalents

Specified by:

copySpecialInstanceVariables in interface IRubyObject

Overrides:

copySpecialInstanceVariables in class RubyBasicObject

getNativeClassIndex

public ClassIndex getNativeClassIndex()

Description copied from class: RubyObject

This is overridden in the other concrete Java builtins to provide a fast way to determine what type they are. Will generally return a value from org.jruby.runtime.ClassIndex

Specified by:

getNativeClassIndex in interface CoreObjectType

Overrides:

getNativeClassIndex in class RubyObject

See Also:

• ClassIndex

updatePairs

private static void updatePairs(ByteList value,
 org.jcodings.Encoding encoding,
 RubyMatchData.Pair[] pairs)

updateCharOffsetOnlyOneReg

private void updateCharOffsetOnlyOneReg(ByteList value,
 org.jcodings.Encoding encoding)

updateCharOffsetManyRegs

private void updateCharOffsetManyRegs(ByteList value,
 org.jcodings.Encoding encoding)

updateCharOffset

private void updateCharOffset()

use

public final void use()

used

public final boolean used()

check

final void check()

getPattern

final org.joni.Regex getPattern()

getRegexp

private RubyRegexp getRegexp()

makeShared

private static RubyString makeShared(Ruby runtime,
 RubyString str,
 int index,
 int length)

match_array

private RubyArray match_array(Ruby runtime,
 int start)

group

public IRubyObject group(long n)

group

public IRubyObject group(int n)

getNameToBackrefNumber

public int getNameToBackrefNumber(String name)

getNamedBackrefValues

public IRubyObject[] getNamedBackrefValues(Ruby runtime)

inspect

public RubyString inspect()

Description copied from class: RubyBasicObject

rb_obj_inspect call-seq: obj.inspect => string Returns a string containing a human-readable representation of obj. If not overridden, uses the to_s method to generate the string. [ 1, 2, 3..4, 'five' ].inspect #=> "[1, 2, 3..4, \"five\"]" Time.new.inspect #=> "Wed Apr 09 08:54:39 CDT 2003"

Specified by:

inspect in interface IRubyObject

Overrides:

inspect in class RubyBasicObject

Returns:

String

regexp

public RubyRegexp regexp(ThreadContext context,
 Block block)

names

public IRubyObject names(ThreadContext context,
 Block block)

to_a

public RubyArray to_a(ThreadContext context)

match_to_a

Overrides:

to_a in class RubyBasicObject

values_at

public IRubyObject values_at(ThreadContext context,
 IRubyObject[] args)

values_at

public IRubyObject values_at(IRubyObject[] args)

captures

public IRubyObject captures(ThreadContext context)

match_captures

nameToBackrefNumber

private int nameToBackrefNumber(RubyString str)

nameToBackrefNumber

private static int nameToBackrefNumber(Ruby runtime,
 org.joni.Regex pattern,
 org.joni.Region regs,
 ByteListHolder str)

backrefNumber

public final int backrefNumber(Ruby runtime,
 IRubyObject obj)

backrefNumber

public static int backrefNumber(Ruby runtime,
 org.joni.Regex pattern,
 org.joni.Region regs,
 IRubyObject obj)

namevToBacktraceNumber

private int namevToBacktraceNumber(ThreadContext context,
 IRubyObject name)

nameToBackrefError

private int nameToBackrefError(Ruby runtime,
 String name)

matchArySubseq

private IRubyObject matchArySubseq(ThreadContext context,
 int beg,
 int len,
 RubyArray result)

matchAryAref

private IRubyObject matchAryAref(ThreadContext context,
 IRubyObject index,
 RubyArray result)

op_aref19

@Deprecated
public IRubyObject op_aref19(IRubyObject idx,
 IRubyObject rest)

Deprecated.

op_aref

public IRubyObject op_aref(ThreadContext context,
 IRubyObject idx)

match_aref

op_aref

public IRubyObject op_aref(ThreadContext context,
 IRubyObject idx,
 IRubyObject rest)

match_aref

op_arefCommon

private IRubyObject op_arefCommon(IRubyObject idx)

at

public final IRubyObject at(int nth)

size

public IRubyObject size(ThreadContext context)

match_size

begin

public IRubyObject begin(ThreadContext context,
 IRubyObject index)

MRI: match_begin

end

public IRubyObject end(ThreadContext context,
 IRubyObject index)

match_end

offset

public IRubyObject offset(ThreadContext context,
 IRubyObject index)

match_offset

offset19

public IRubyObject offset19(ThreadContext context,
 IRubyObject index)

pre_match

public IRubyObject pre_match(ThreadContext context)

match_pre_match

post_match

public IRubyObject post_match(ThreadContext context)

match_post_match

to_s

public IRubyObject to_s()

match_to_s

Overrides:

to_s in class RubyBasicObject

string

public IRubyObject string()

match_string

initialize_copy

public IRubyObject initialize_copy(IRubyObject original)

Description copied from class: RubyBasicObject

rb_obj_init_copy Initializes this object as a copy of the original, that is the parameter to this object. Will make sure that the argument actually has the same real class as this object. It shouldn't be possible to initialize an object with something totally different.

Overrides:

initialize_copy in class RubyBasicObject

equals

public boolean equals(Object other)

Description copied from class: RubyObject

This override does not do a "checked" dispatch.

Overrides:

equals in class RubyObject

See Also:

• RubyBasicObject.equals(Object)

eql_p

public IRubyObject eql_p(IRubyObject obj)

Description copied from class: RubyBasicObject

rb_obj_equal Just like "==" and "equal?", "eql?" will use identity equality for Object.

Overrides:

eql_p in class RubyBasicObject

hashCode

public int hashCode()

Description copied from class: RubyObject

This override does not do "checked" dispatch since Object usually has #hash defined.

Overrides:

hashCode in class RubyObject

See Also:

• RubyBasicObject.hashCode()

hash

public RubyFixnum hash()

Description copied from class: RubyBasicObject

rb_obj_id Will return the hash code of this object. In comparison to MRI, this method will use the Java identity hash code instead of using rb_obj_id, since the usage of id in JRuby will incur the cost of some. ObjectSpace maintenance.

Overrides:

hash in class RubyBasicObject

named_captures

public RubyHash named_captures(ThreadContext context)

begin

public int begin(int i)

Get the begin offset of the given region, or -1 if the region does not exist.

Parameters:

i - the region for which to fetch the begin offset

Returns:

the begin offset for the region

end

public int end(int i)

Get the end offset of the given region, or -1 if the region does not exist.

Parameters:

i - the region for which to fetch the end offset

Returns:

the end offset for the region

numRegs

public int numRegs()

Fetch the number of regions in this match.

Returns:

the number of regions in this match

to_a

@Deprecated
public RubyArray to_a()

Deprecated.

Overrides:

to_a in class RubyBasicObject

op_aref

@Deprecated
public IRubyObject op_aref(IRubyObject idx)

Deprecated.

op_aref

@Deprecated
public IRubyObject op_aref(IRubyObject idx,
 IRubyObject rest)

Deprecated.