org.jruby

Class RubyRegexp

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.RubyRegexp

All Implemented Interfaces:

Serializable, Cloneable, Comparable<IRubyObject>, ReOptions, InstanceVariables, InternalVariables, IRubyObject, EncodingCapable, MarshalEncoding, CoreObjectType

public class RubyRegexp
extends RubyObject
implements ReOptions, EncodingCapable, MarshalEncoding

See Also:

Serialized Form

Nested Class Summary

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 and Description
static int	ARG_ENCODING_FIXED
static int	ARG_ENCODING_NONE

Fields inherited from class org.jruby.RubyObject

FIELD_ALLOCATED_CLASSES, FIELD_ALLOCATORS, IVAR_INSPECTING_OBJECT_ALLOCATOR, OBJECT_ALLOCATOR, OBJECT_VAR0_ALLOCATOR, OBJECT_VAR1_ALLOCATOR, OBJECT_VAR2_ALLOCATOR, OBJECT_VAR3_ALLOCATOR, OBJECT_VAR4_ALLOCATOR, OBJECT_VAR5_ALLOCATOR, OBJECT_VAR6_ALLOCATOR, OBJECT_VAR7_ALLOCATOR, OBJECT_VAR8_ALLOCATOR, OBJECT_VAR9_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.parser.ReOptions

RE_DEFAULT, RE_FIXED, RE_LITERAL, RE_MAY_IGNORECASE, RE_NONE, RE_OPTION_EXTENDED, RE_OPTION_IGNORECASE, RE_OPTION_LONGEST, RE_OPTION_MULTILINE, RE_OPTION_NONE, RE_OPTION_ONCE, RE_OPTION_POSIXLINE, RE_OPTION_SINGLELINE, RE_UNICODE

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

NULL_ARRAY

Method Summary

Methods

Modifier and Type	Method and Description
IRubyObject	casefold_p(ThreadContext context)
void	clearEncodingNone()
void	clearLiteral()
static RubyClass	createRegexpClass(Ruby runtime)
IRubyObject	encoding(ThreadContext context)
IRubyObject	eqq(ThreadContext context, IRubyObject arg) rb_reg_eqq
IRubyObject	eqq19(ThreadContext context, IRubyObject arg)
IRubyObject	fixed_encoding_p(ThreadContext context)
static IRubyObject	getBackRef(ThreadContext context)
org.jcodings.Encoding	getEncoding()
KCode	getKCode()
org.jcodings.Encoding	getMarshalEncoding()
String[]	getNames()
ClassIndex	getNativeClassIndex() This is overridden in the other concrete Java builtins to provide a fast way to determine what type they are.
RegexpOptions	getOptions() rb_reg_options
org.joni.Regex	getPattern()
RubyFixnum	hash() rb_obj_id Will return the hash code of this object.
IRubyObject	initialize_copy(IRubyObject re) rb_reg_init_copy
IRubyObject	initialize_m(IRubyObject arg)
IRubyObject	initialize_m(IRubyObject arg0, IRubyObject arg1)
IRubyObject	initialize_m(IRubyObject arg0, IRubyObject arg1, IRubyObject arg2)
IRubyObject	initialize_m19(IRubyObject arg)
IRubyObject	initialize_m19(IRubyObject arg0, IRubyObject arg1)
IRubyObject	initialize_m19(IRubyObject arg0, IRubyObject arg1, IRubyObject arg2)
IRubyObject	inspect() rb_reg_inspect
IRubyObject	inspect19()
boolean	isEncodingNone()
boolean	isKCodeDefault()
boolean	isLiteral()
static IRubyObject	last_match_s(ThreadContext context, IRubyObject recv) rb_reg_s_last_match / match_getter
static IRubyObject	last_match_s(ThreadContext context, IRubyObject recv, IRubyObject nth) rb_reg_s_last_match
static IRubyObject	last_match(IRubyObject match) rb_reg_last_match
static void	marshalTo(RubyRegexp regexp, MarshalStream output)
static IRubyObject	match_last(IRubyObject match) rb_reg_match_last
IRubyObject	match_m(ThreadContext context, IRubyObject str) rb_reg_match_m
IRubyObject	match_m19(ThreadContext context, IRubyObject str, Block block)
IRubyObject	match_m19(ThreadContext context, IRubyObject str, boolean useBackref, Block block)
IRubyObject	match_m19(ThreadContext context, IRubyObject str, IRubyObject pos, Block block)
static IRubyObject	match_post(IRubyObject match) rb_reg_match_post
static IRubyObject	match_pre(IRubyObject match) rb_reg_match_pre
static int	matcherMatch(Ruby runtime, org.joni.Matcher matcher, int start, int range, int option)
static int	matcherSearch(Ruby runtime, org.joni.Matcher matcher, int start, int range, int option)
IRubyObject	named_captures(ThreadContext context) rb_reg_named_captures
IRubyObject	names(ThreadContext context) rb_reg_names
static RubyRegexp	newDRegexp(Ruby runtime, RubyString pattern, int joniOptions)
static RubyRegexp	newDRegexp(Ruby runtime, RubyString pattern, RegexpOptions options)
static RubyRegexp	newDRegexpEmbedded(Ruby runtime, RubyString pattern, int embeddedOptions)
static RubyRegexp	newDRegexpEmbedded19(Ruby runtime, IRubyObject[] strings, int embeddedOptions)
static RubyRegexp	newRegexp(Ruby runtime, org.jruby.util.ByteList pattern)
static RubyRegexp	newRegexp(Ruby runtime, org.jruby.util.ByteList pattern, int options)
static RubyRegexp	newRegexp(Ruby runtime, org.jruby.util.ByteList pattern, RegexpOptions options)
static RubyRegexp	newRegexp(Ruby runtime, String pattern, RegexpOptions options)
static RubyRegexp	newRegexpFromStr(Ruby runtime, RubyString s, int options)
static IRubyObject	nth_match(int nth, IRubyObject match) rb_reg_nth_match
IRubyObject	op_equal(ThreadContext context, IRubyObject other)
IRubyObject	op_match(ThreadContext context, IRubyObject arg) rb_obj_pattern_match call-seq: obj =~ other => false Pattern Match---Overridden by descendents (notably Regexp and String) to provide meaningful pattern-match semantics.
IRubyObject	op_match19(ThreadContext context, IRubyObject str)
IRubyObject	op_match2_19(ThreadContext context)
IRubyObject	op_match2(ThreadContext context)
IRubyObject	options()
org.joni.Regex	preparePattern(RubyString str)
static void	preprocessCheck(Ruby runtime, org.jruby.util.ByteList bytes)
static RubyString	preprocessDRegexp(Ruby runtime, IRubyObject[] strings, RegexpOptions options)
static RubyString	preprocessDRegexp(Ruby runtime, RubyString[] strings, int embeddedOptions)
static org.jruby.util.ByteList	quote19(org.jruby.util.ByteList bs, boolean asciiOnly)
static IRubyObject	quote19(ThreadContext context, IRubyObject recv, IRubyObject arg) rb_reg_s_quote
int	search(ThreadContext context, RubyString str, int pos, boolean reverse, IRubyObject[] holder) rb_reg_search
int	search19(ThreadContext context, RubyString str, int pos, boolean reverse) MRI: rb_reg_search This version uses current thread context to hold the resulting match data.
int	search19(ThreadContext context, RubyString str, int pos, boolean reverse, boolean setBackrefStr, IRubyObject[] holder) MRI: rb_reg_search0 Holder, if non-null, will receive the backref result rather than setting it into context.
int	search19(ThreadContext context, RubyString str, int pos, boolean reverse, IRubyObject[] holder) MRI: rb_reg_search Holder, if non-null, will receive the backref result rather than setting it into context.
void	setEncoding(org.jcodings.Encoding encoding)
void	setEncodingNone()
void	setLiteral()
boolean	shouldMarshalEncoding()
IRubyObject	source() rb_reg_source
IRubyObject	to_s() rb_any_to_s call-seq: obj.to_s => string Returns a string representing obj.
static IRubyObject	try_convert(ThreadContext context, IRubyObject recv, IRubyObject args)
static IRubyObject	union(ThreadContext context, IRubyObject recv, IRubyObject[] args) rb_reg_s_union
static IRubyObject	union19(ThreadContext context, IRubyObject recv, IRubyObject[] args)
static RubyRegexp	unmarshalFrom(UnmarshalStream input)

Methods inherited from class org.jruby.RubyObject

attachToObjectSpace, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, convertToType, createObjectClass, eqlInternal, equalInternal, equals, hashCode, initialize, initialize, inspect, op_eqq, puts, specificEval, toString

Methods inherited from class org.jruby.RubyBasicObject

addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkCallMethod, checkFrozen, checkStringType, checkStringType19, compareTo, convertToArray, convertToFloat, convertToHash, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, createBasicObjectClass, dataGetStruct, dataGetStructChecked, dataWrapStruct, display, dup, ensureInstanceVariablesSettable, eql_p, 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, getNativeHandle, getNativeTypeIndex, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hashyInspect, hasInstanceVariable, hasInternalVariable, hasVariables, id, infectBy, 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, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, method_missing19, method, method19, methods, methods, methods19, nil_p, nonFixnumHashCode, OBJ_INIT_COPY, objInitCopy, op_cmp, op_equal_19, op_not_equal, op_not_match, op_not, private_methods, private_methods19, protected_methods, protected_methods19, public_methods, public_methods19, rbClone, rbInspect, remove_instance_variable, removeFinalizers, removeInstanceVariable, removeInternalVariable, 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_added19, singleton_method_removed19, singleton_method_undefined19, singleton_methods, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, taint, tainted_p, testFrozen, testFrozen, to_a, toJava, trust, type_deprecated, type, untaint, untrust, untrusted_p, 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 Detail

ARG_ENCODING_FIXED

public static final int ARG_ENCODING_FIXED

See Also:

Constant Field Values

ARG_ENCODING_NONE

public static final int ARG_ENCODING_NONE

See Also:

Constant Field Values

Method Detail

setLiteral

public void setLiteral()

clearLiteral

public void clearLiteral()

isLiteral

public boolean isLiteral()

isKCodeDefault

public boolean isKCodeDefault()

setEncodingNone

public void setEncodingNone()

clearEncodingNone

public void clearEncodingNone()

isEncodingNone

public boolean isEncodingNone()

getKCode

public KCode getKCode()

getEncoding

public org.jcodings.Encoding getEncoding()

Specified by:

getEncoding in interface EncodingCapable

setEncoding

public void setEncoding(org.jcodings.Encoding encoding)

Specified by:

setEncoding in interface EncodingCapable

shouldMarshalEncoding

public boolean shouldMarshalEncoding()

Specified by:

shouldMarshalEncoding in interface MarshalEncoding

getMarshalEncoding

public org.jcodings.Encoding getMarshalEncoding()

Specified by:

getMarshalEncoding in interface MarshalEncoding

createRegexpClass

public static RubyClass createRegexpClass(Ruby runtime)

matcherSearch

public static int matcherSearch(Ruby runtime,
                org.joni.Matcher matcher,
                int start,
                int range,
                int option)

matcherMatch

public static int matcherMatch(Ruby runtime,
               org.joni.Matcher matcher,
               int start,
               int range,
               int option)

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

newRegexp

public static RubyRegexp newRegexp(Ruby runtime,
                   String pattern,
                   RegexpOptions options)

newRegexp

public static RubyRegexp newRegexp(Ruby runtime,
                   org.jruby.util.ByteList pattern,
                   int options)

newRegexp

public static RubyRegexp newRegexp(Ruby runtime,
                   org.jruby.util.ByteList pattern,
                   RegexpOptions options)

newDRegexp

public static RubyRegexp newDRegexp(Ruby runtime,
                    RubyString pattern,
                    RegexpOptions options)

newDRegexp

public static RubyRegexp newDRegexp(Ruby runtime,
                    RubyString pattern,
                    int joniOptions)

newDRegexpEmbedded

public static RubyRegexp newDRegexpEmbedded(Ruby runtime,
                            RubyString pattern,
                            int embeddedOptions)

newDRegexpEmbedded19

public static RubyRegexp newDRegexpEmbedded19(Ruby runtime,
                              IRubyObject[] strings,
                              int embeddedOptions)

newRegexp

public static RubyRegexp newRegexp(Ruby runtime,
                   org.jruby.util.ByteList pattern)

newRegexpFromStr

public static RubyRegexp newRegexpFromStr(Ruby runtime,
                          RubyString s,
                          int options)

getOptions

public RegexpOptions getOptions()

rb_reg_options

getPattern

public final org.joni.Regex getPattern()

preparePattern

public final org.joni.Regex preparePattern(RubyString str)

preprocessCheck

public static void preprocessCheck(Ruby runtime,
                   org.jruby.util.ByteList bytes)

preprocessDRegexp

public static RubyString preprocessDRegexp(Ruby runtime,
                           RubyString[] strings,
                           int embeddedOptions)

preprocessDRegexp

public static RubyString preprocessDRegexp(Ruby runtime,
                           IRubyObject[] strings,
                           RegexpOptions options)

try_convert

public static IRubyObject try_convert(ThreadContext context,
                      IRubyObject recv,
                      IRubyObject args)

quote19

public static IRubyObject quote19(ThreadContext context,
                  IRubyObject recv,
                  IRubyObject arg)

rb_reg_s_quote

quote19

public static org.jruby.util.ByteList quote19(org.jruby.util.ByteList bs,
                              boolean asciiOnly)

last_match_s

public static IRubyObject last_match_s(ThreadContext context,
                       IRubyObject recv)

rb_reg_s_last_match / match_getter

getBackRef

public static IRubyObject getBackRef(ThreadContext context)

last_match_s

public static IRubyObject last_match_s(ThreadContext context,
                       IRubyObject recv,
                       IRubyObject nth)

rb_reg_s_last_match

union

public static IRubyObject union(ThreadContext context,
                IRubyObject recv,
                IRubyObject[] args)

rb_reg_s_union

union19

public static IRubyObject union19(ThreadContext context,
                  IRubyObject recv,
                  IRubyObject[] args)

initialize_copy

public IRubyObject initialize_copy(IRubyObject re)

rb_reg_init_copy

Overrides:

initialize_copy in class RubyBasicObject

initialize_m

public IRubyObject initialize_m(IRubyObject arg)

initialize_m

public IRubyObject initialize_m(IRubyObject arg0,
                       IRubyObject arg1)

initialize_m

public IRubyObject initialize_m(IRubyObject arg0,
                       IRubyObject arg1,
                       IRubyObject arg2)

initialize_m19

public IRubyObject initialize_m19(IRubyObject arg)

initialize_m19

public IRubyObject initialize_m19(IRubyObject arg0,
                         IRubyObject arg1)

initialize_m19

public IRubyObject initialize_m19(IRubyObject arg0,
                         IRubyObject arg1,
                         IRubyObject arg2)

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

op_equal

public IRubyObject op_equal(ThreadContext context,
                   IRubyObject other)

Specified by:

op_equal in interface IRubyObject

Overrides:

op_equal in class RubyBasicObject

op_match2

public IRubyObject op_match2(ThreadContext context)

op_match2_19

public IRubyObject op_match2_19(ThreadContext context)

eqq

public IRubyObject eqq(ThreadContext context,
              IRubyObject arg)

rb_reg_eqq

eqq19

public IRubyObject eqq19(ThreadContext context,
                IRubyObject arg)

op_match

public IRubyObject op_match(ThreadContext context,
                   IRubyObject arg)

Description copied from class: RubyBasicObject

rb_obj_pattern_match call-seq: obj =~ other => false Pattern Match---Overridden by descendents (notably Regexp and String) to provide meaningful pattern-match semantics.

Overrides:

op_match in class RubyBasicObject

op_match19

public IRubyObject op_match19(ThreadContext context,
                     IRubyObject str)

Overrides:

op_match19 in class RubyBasicObject

match_m

public IRubyObject match_m(ThreadContext context,
                  IRubyObject str)

rb_reg_match_m

match_m19

public IRubyObject match_m19(ThreadContext context,
                    IRubyObject str,
                    Block block)

match_m19

public IRubyObject match_m19(ThreadContext context,
                    IRubyObject str,
                    boolean useBackref,
                    Block block)

match_m19

public IRubyObject match_m19(ThreadContext context,
                    IRubyObject str,
                    IRubyObject pos,
                    Block block)

search

public final int search(ThreadContext context,
         RubyString str,
         int pos,
         boolean reverse,
         IRubyObject[] holder)

rb_reg_search

search19

public final int search19(ThreadContext context,
           RubyString str,
           int pos,
           boolean reverse)

MRI: rb_reg_search This version uses current thread context to hold the resulting match data.

search19

public final int search19(ThreadContext context,
           RubyString str,
           int pos,
           boolean reverse,
           IRubyObject[] holder)

MRI: rb_reg_search Holder, if non-null, will receive the backref result rather than setting it into context.

search19

public final int search19(ThreadContext context,
           RubyString str,
           int pos,
           boolean reverse,
           boolean setBackrefStr,
           IRubyObject[] holder)

MRI: rb_reg_search0 Holder, if non-null, will receive the backref result rather than setting it into context.

options

public IRubyObject options()

casefold_p

public IRubyObject casefold_p(ThreadContext context)

source

public IRubyObject source()

rb_reg_source

inspect

public IRubyObject inspect()

rb_reg_inspect

Specified by:

inspect in interface IRubyObject

Overrides:

inspect in class RubyBasicObject

Returns:

String

inspect19

public IRubyObject inspect19()

to_s

public IRubyObject to_s()

Description copied from class: RubyBasicObject

rb_any_to_s call-seq: obj.to_s => string Returns a string representing obj. The default to_s prints the object's class and an encoding of the object id. As a special case, the top-level object that is the initial execution context of Ruby programs returns ``main.''

Overrides:

to_s in class RubyBasicObject

getNames

public String[] getNames()

names

public IRubyObject names(ThreadContext context)

rb_reg_names

named_captures

public IRubyObject named_captures(ThreadContext context)

rb_reg_named_captures

encoding

public IRubyObject encoding(ThreadContext context)

fixed_encoding_p

public IRubyObject fixed_encoding_p(ThreadContext context)

nth_match

public static IRubyObject nth_match(int nth,
                    IRubyObject match)

rb_reg_nth_match

last_match

public static IRubyObject last_match(IRubyObject match)

rb_reg_last_match

match_pre

public static IRubyObject match_pre(IRubyObject match)

rb_reg_match_pre

match_post

public static IRubyObject match_post(IRubyObject match)

rb_reg_match_post

match_last

public static IRubyObject match_last(IRubyObject match)

rb_reg_match_last

unmarshalFrom

public static RubyRegexp unmarshalFrom(UnmarshalStream input)
                                throws IOException

Throws:

IOException

marshalTo

public static void marshalTo(RubyRegexp regexp,
             MarshalStream output)
                      throws IOException

Throws:

IOException