Class: RE2::Regexp

Inherits:
Object show all
Defined in:
ext/re2/re2.cc,
lib/re2/regexp.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(pattern) ⇒ RE2::Regexp #initialize(pattern, options) ⇒ RE2::Regexp

Returns a new RE2::Regexp object with a compiled version of pattern stored inside.

Overloads:

  • #initialize(pattern) ⇒ RE2::Regexp

    Returns a new RE2::Regexp object with a compiled version of pattern stored inside with the default options.

    Parameters:

    • pattern (String) —

      the pattern to compile

    Raises:

    • (TypeError) —

      if the given pattern can't be coerced to a String

    • (NoMemoryError) —

      if memory could not be allocated for the compiled pattern

  • #initialize(pattern, options) ⇒ RE2::Regexp

    Returns a new RE2::Regexp object with a compiled version of pattern stored inside with the specified options.

    Parameters:

    • pattern (String) —

      the pattern to compile

    • options (Hash) —

      the options with which to compile the pattern

    Options Hash (options):

    • :utf8 (Boolean) — default: true —

      text and pattern are UTF-8; otherwise Latin-1

    • :posix_syntax (Boolean) — default: false —

      restrict regexps to POSIX egrep syntax

    • :longest_match (Boolean) — default: false —

      search for longest match, not first match

    • :log_errors (Boolean) — default: true —

      log syntax and execution errors to ERROR

    • :max_mem (Integer) —

      approx. max memory footprint of RE2

    • :literal (Boolean) — default: false —

      interpret string as literal, not regexp

    • :never_nl (Boolean) — default: false —

      never match \n, even if it is in regexp

    • :case_sensitive (Boolean) — default: true —

      match is case-sensitive (regexp can override with (?i) unless in posix_syntax mode)

    • :perl_classes (Boolean) — default: false —

      allow Perl's \d \s \w \D \S \W when in posix_syntax mode

    • :word_boundary (Boolean) — default: false —

      allow \b \B (word boundary and not) when in posix_syntax mode

    • :one_line (Boolean) — default: false —

      ^ and $ only match beginning and end of text when in posix_syntax mode

    Raises:

    • (TypeError) —

      if the given pattern can't be coerced to a String

    • (NoMemoryError) —

      if memory could not be allocated for the compiled pattern



1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
 
# File 'ext/re2/re2.cc', line 1362

static VALUE re2_regexp_initialize(int argc, VALUE *argv, VALUE self) {
  VALUE pattern, options;
  re2_pattern *p;

  rb_scan_args(argc, argv, "11", &pattern, &options);

  /* Ensure pattern is a string. */
  StringValue(pattern);

  TypedData_Get_Struct(self, re2_pattern, &re2_regexp_data_type, p);

  RE2::Options re2_options;

  if (RTEST(options)) {
    parse_re2_options(&re2_options, options);
  }

  rb_check_frozen(self);

  p->pattern = new(std::nothrow) RE2(
      re2::StringPiece(RSTRING_PTR(pattern), RSTRING_LEN(pattern)), re2_options);

  if (p->pattern == nullptr) {
    rb_raise(rb_eNoMemError, "not enough memory to allocate RE2 object");
  }

  rb_obj_freeze(self);

  return self;
}

Class Method Details

.initialize(pattern) ⇒ RE2::Regexp .initialize(pattern, options) ⇒ RE2::Regexp

Returns a new RE2::Regexp object with a compiled version of pattern stored inside.

Overloads:

  • .initialize(pattern) ⇒ RE2::Regexp

    Returns a new RE2::Regexp object with a compiled version of pattern stored inside with the default options.

    Parameters:

    • pattern (String) —

      the pattern to compile

    Returns:

    Raises:

    • (TypeError) —

      if the given pattern can't be coerced to a String

    • (NoMemoryError) —

      if memory could not be allocated for the compiled pattern

  • .initialize(pattern, options) ⇒ RE2::Regexp

    Returns a new RE2::Regexp object with a compiled version of pattern stored inside with the specified options.

    Parameters:

    • pattern (String) —

      the pattern to compile

    • options (Hash) —

      the options with which to compile the pattern

    Options Hash (options):

    • :utf8 (Boolean) — default: true —

      text and pattern are UTF-8; otherwise Latin-1

    • :posix_syntax (Boolean) — default: false —

      restrict regexps to POSIX egrep syntax

    • :longest_match (Boolean) — default: false —

      search for longest match, not first match

    • :log_errors (Boolean) — default: true —

      log syntax and execution errors to ERROR

    • :max_mem (Integer) —

      approx. max memory footprint of RE2

    • :literal (Boolean) — default: false —

      interpret string as literal, not regexp

    • :never_nl (Boolean) — default: false —

      never match \n, even if it is in regexp

    • :case_sensitive (Boolean) — default: true —

      match is case-sensitive (regexp can override with (?i) unless in posix_syntax mode)

    • :perl_classes (Boolean) — default: false —

      allow Perl's \d \s \w \D \S \W when in posix_syntax mode

    • :word_boundary (Boolean) — default: false —

      allow \b \B (word boundary and not) when in posix_syntax mode

    • :one_line (Boolean) — default: false —

      ^ and $ only match beginning and end of text when in posix_syntax mode

    Returns:

    Raises:

    • (TypeError) —

      if the given pattern can't be coerced to a String

    • (NoMemoryError) —

      if memory could not be allocated for the compiled pattern

.escape(unquoted) ⇒ String

Returns a version of str with all potentially meaningful regexp characters escaped using `QuoteMeta`. The returned string, used as a regular expression, will exactly match the original string.

Examples:

RE2.escape("1.5-2.0?")         #=> "1\\.5\\-2\\.0\\?"
RE2.quote("1.5-2.0?")          #=> "1\\.5\\-2\\.0\\?"
RE2::Regexp.escape("1.5-2.0?") #=> "1\\.5\\-2\\.0\\?"
RE2::Regexp.quote("1.5-2.0?")  #=> "1\\.5\\-2\\.0\\?"

Parameters:

  • unquoted (String) —

    the unquoted string

Returns:

  • (String) —

    the escaped string

Raises:

  • (TypeError) —

    if the given unquoted string cannot be coerced to a String



2359
2360
2361
2362
2363
2364
2365
2366
 
# File 'ext/re2/re2.cc', line 2359

static VALUE re2_escape(VALUE, VALUE unquoted) {
  StringValue(unquoted);

  std::string quoted_string = RE2::QuoteMeta(
      re2::StringPiece(RSTRING_PTR(unquoted), RSTRING_LEN(unquoted)));

  return rb_str_new(quoted_string.data(), quoted_string.size());
}

.match_has_endpos_argument? ⇒ Boolean

Returns whether the underlying RE2 version supports passing an endpos argument to Match. If not, #match will raise an error if attempting to pass an endpos.

Returns:

  • (Boolean) —

    whether the underlying Match has an endpos argument



2112
2113
2114
2115
2116
2117
2118
 
# File 'ext/re2/re2.cc', line 2112

static VALUE re2_regexp_match_has_endpos_argument_p(VALUE) {
#ifdef HAVE_ENDPOS_ARGUMENT
  return Qtrue;
#else
  return Qfalse;
#endif
}

.quote(unquoted) ⇒ String

Returns a version of str with all potentially meaningful regexp characters escaped using `QuoteMeta`. The returned string, used as a regular expression, will exactly match the original string.

Examples:

RE2.escape("1.5-2.0?")         #=> "1\\.5\\-2\\.0\\?"
RE2.quote("1.5-2.0?")          #=> "1\\.5\\-2\\.0\\?"
RE2::Regexp.escape("1.5-2.0?") #=> "1\\.5\\-2\\.0\\?"
RE2::Regexp.quote("1.5-2.0?")  #=> "1\\.5\\-2\\.0\\?"

Parameters:

  • unquoted (String) —

    the unquoted string

Returns:

  • (String) —

    the escaped string

Raises:

  • (TypeError) —

    if the given unquoted string cannot be coerced to a String



2359
2360
2361
2362
2363
2364
2365
2366
 
# File 'ext/re2/re2.cc', line 2359

static VALUE re2_escape(VALUE, VALUE unquoted) {
  StringValue(unquoted);

  std::string quoted_string = RE2::QuoteMeta(
      re2::StringPiece(RSTRING_PTR(unquoted), RSTRING_LEN(unquoted)));

  return rb_str_new(quoted_string.data(), quoted_string.size());
}

Instance Method Details

#===(text) ⇒ Boolean

Returns true if the pattern matches any substring of the given text using `PartialMatch`.

Parameters:

  • text (String) —

    the text to search

Returns:

  • (Boolean) —

    whether the match was successful

Raises:

  • (TypeError) —

    if text cannot be coerced to a String



2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
 
# File 'ext/re2/re2.cc', line 2027

static VALUE re2_regexp_match_p(const VALUE self, VALUE text) {
  StringValue(text);
  text = rb_str_new_frozen(text);

  re2_pattern *p = unwrap_re2_regexp(self);
  bool matched = re2_match_without_gvl(
      p->pattern, text, 0, RSTRING_LEN(text), RE2::UNANCHORED, 0, 0);
  RB_GC_GUARD(text);

  return BOOL2RUBY(matched);
}

#=~(text) ⇒ Boolean

Returns true if the pattern matches any substring of the given text using `PartialMatch`.

Parameters:

  • text (String) —

    the text to search

Returns:

  • (Boolean) —

    whether the match was successful

Raises:

  • (TypeError) —

    if text cannot be coerced to a String



2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
 
# File 'ext/re2/re2.cc', line 2027

static VALUE re2_regexp_match_p(const VALUE self, VALUE text) {
  StringValue(text);
  text = rb_str_new_frozen(text);

  re2_pattern *p = unwrap_re2_regexp(self);
  bool matched = re2_match_without_gvl(
      p->pattern, text, 0, RSTRING_LEN(text), RE2::UNANCHORED, 0, 0);
  RB_GC_GUARD(text);

  return BOOL2RUBY(matched);
}

#case_insensitive? ⇒ Boolean

Returns whether or not the regular expression was compiled with the case_sensitive option set to false.

Examples:

re2 = RE2::Regexp.new("woo?", case_sensitive: true)
re2.case_insensitive? #=> false
re2.casefold?         #=> false

Returns:

  • (Boolean) —

    the inverse of the case_sensitive option



1604
1605
1606
 
# File 'ext/re2/re2.cc', line 1604

static VALUE re2_regexp_case_insensitive(const VALUE self) {
  return BOOL2RUBY(re2_regexp_case_sensitive(self) != Qtrue);
}

#case_sensitive? ⇒ Boolean

Returns whether or not the regular expression was compiled with the case_sensitive option set to true.

Examples:

re2 = RE2::Regexp.new("woo?", case_sensitive: true)
re2.case_sensitive? #=> true

Returns:

  • (Boolean) —

    the case_sensitive option



1588
1589
1590
1591
1592
 
# File 'ext/re2/re2.cc', line 1588

static VALUE re2_regexp_case_sensitive(const VALUE self) {
  re2_pattern *p = unwrap_re2_regexp(self);

  return BOOL2RUBY(p->pattern->options().case_sensitive());
}

#casefold? ⇒ Boolean

Returns whether or not the regular expression was compiled with the case_sensitive option set to false.

Examples:

re2 = RE2::Regexp.new("woo?", case_sensitive: true)
re2.case_insensitive? #=> false
re2.casefold?         #=> false

Returns:

  • (Boolean) —

    the inverse of the case_sensitive option



1604
1605
1606
 
# File 'ext/re2/re2.cc', line 1604

static VALUE re2_regexp_case_insensitive(const VALUE self) {
  return BOOL2RUBY(re2_regexp_case_sensitive(self) != Qtrue);
}

#error ⇒ String?

If the RE2::Regexp could not be created properly, returns an error string otherwise returns nil.

Returns:

  • (String, nil) —

    the error string or nil



1659
1660
1661
1662
1663
1664
1665
1666
1667
 
# File 'ext/re2/re2.cc', line 1659

static VALUE re2_regexp_error(const VALUE self) {
  re2_pattern *p = unwrap_re2_regexp(self);

  if (p->pattern->ok()) {
    return Qnil;
  } else {
    return rb_str_new(p->pattern->error().data(), p->pattern->error().size());
  }
}

#error_arg ⇒ String?

If the RE2::Regexp could not be created properly, returns the offending portion of the regexp otherwise returns nil.

Note RE2 only supports UTF-8 and ISO-8859-1 encoding so strings will be returned in UTF-8 by default or ISO-8859-1 if the :utf8 option for the RE2::Regexp is set to false (any other encoding's behaviour is undefined).

Returns:

  • (String, nil) —

    the offending portion of the regexp or nil



1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
 
# File 'ext/re2/re2.cc', line 1679

static VALUE re2_regexp_error_arg(const VALUE self) {
  re2_pattern *p = unwrap_re2_regexp(self);

  if (p->pattern->ok()) {
    return Qnil;
  } else {
    return encoded_str_new(p->pattern->error_arg().data(),
        p->pattern->error_arg().size(),
        p->pattern->options().encoding());
  }
}

#full_match(text, options = {}) ⇒ RE2::MatchData, ...

Match the pattern against the given text exactly and return a MatchData instance with the specified number of submatches (defaults to the total number of capturing groups) or a boolean (if no submatches are required).

The number of submatches has a significant impact on performance: requesting one submatch is much faster than requesting more than one and requesting zero submatches is faster still.

Examples:

r = RE2::Regexp.new('w(o)(o)')
r.full_match('woo')                #=> #<RE2::MatchData "woo" 1:"o" 2:"o">
r.full_match('woot')               #=> nil
r.full_match('woo', submatches: 1) #=> #<RE2::MatchData "woo" 1:"o">
r.full_match('woo', submatches: 0) #=> true

Parameters:

  • text (String) —

    the text to search

  • options (Hash) (defaults to: {}) —

    the options with which to perform the match

Options Hash (options):

  • :submatches (Integer) —

    how many submatches to extract (0 is fastest), defaults to the total number of capturing groups

Returns:

  • (RE2::MatchData, nil) —

    if extracting any submatches

  • (Boolean) —

    if not extracting any submatches

Raises:

  • (ArgumentError) —

    if given a negative number of submatches

  • (NoMemoryError) —

    if there was not enough memory to allocate the matches

  • (TypeError) —

    if given non-numeric submatches or non-hash options



68
69
70
 
# File 'lib/re2/regexp.rb', line 68

def full_match(text, options = {})
  match(text, Hash(options).merge(anchor: :anchor_both))
end

#full_match?(text) ⇒ Boolean

Returns true if the pattern matches the given text using `FullMatch`.

Parameters:

  • text (String) —

    the text to search

Returns:

  • (Boolean) —

    whether the match was successful

Raises:

  • (TypeError) —

    if text cannot be coerced to a String



2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
 
# File 'ext/re2/re2.cc', line 2048

static VALUE re2_regexp_full_match_p(const VALUE self, VALUE text) {
  StringValue(text);
  text = rb_str_new_frozen(text);

  re2_pattern *p = unwrap_re2_regexp(self);
  bool matched = re2_match_without_gvl(
      p->pattern, text, 0, RSTRING_LEN(text), RE2::ANCHOR_BOTH, 0, 0);
  RB_GC_GUARD(text);

  return BOOL2RUBY(matched);
}

#initialize_copy(other) ⇒ Object 



1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
 
# File 'ext/re2/re2.cc', line 1393

static VALUE re2_regexp_initialize_copy(VALUE self, VALUE other) {
  re2_pattern *self_p;
  re2_pattern *other_p = unwrap_re2_regexp(other);

  TypedData_Get_Struct(self, re2_pattern, &re2_regexp_data_type, self_p);

  rb_check_frozen(self);

  if (self_p->pattern) {
    delete self_p->pattern;
    self_p->pattern = nullptr;
  }

  self_p->pattern = new(std::nothrow) RE2(other_p->pattern->pattern(),
                                          other_p->pattern->options());
  if (self_p->pattern == nullptr) {
    rb_raise(rb_eNoMemError, "not enough memory to allocate RE2 object");
  }

  rb_obj_freeze(self);

  return self;
}

#inspect ⇒ String

Returns a printable version of the regular expression.

Note RE2 only supports UTF-8 and ISO-8859-1 encoding so strings will be returned in UTF-8 by default or ISO-8859-1 if the :utf8 option for the RE2::Regexp is set to false (any other encoding's behaviour is undefined).

Examples:

re2 = RE2::Regexp.new("woo?")
re2.inspect #=> "#<RE2::Regexp /woo?/>"

Returns:

  • (String) —

    a printable version of the regular expression



1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
 
# File 'ext/re2/re2.cc', line 1430

static VALUE re2_regexp_inspect(const VALUE self) {
  re2_pattern *p = unwrap_re2_regexp(self);

  std::ostringstream output;

  output << "#<RE2::Regexp /" << p->pattern->pattern() << "/>";

  return encoded_str_new(output.str().data(), output.str().length(),
      p->pattern->options().encoding());
}

#literal? ⇒ Boolean

Returns whether or not the regular expression was compiled with the literal option set to true.

Examples:

re2 = RE2::Regexp.new("woo?", literal: true)
re2.literal? #=> true

Returns:

  • (Boolean) —

    the literal option



1558
1559
1560
1561
1562
 
# File 'ext/re2/re2.cc', line 1558

static VALUE re2_regexp_literal(const VALUE self) {
  re2_pattern *p = unwrap_re2_regexp(self);

  return BOOL2RUBY(p->pattern->options().literal());
}

#log_errors? ⇒ Boolean

Returns whether or not the regular expression was compiled with the log_errors option set to true.

Examples:

re2 = RE2::Regexp.new("woo?", log_errors: true)
re2.log_errors? #=> true

Returns:

  • (Boolean) —

    the log_errors option



1529
1530
1531
1532
1533
 
# File 'ext/re2/re2.cc', line 1529

static VALUE re2_regexp_log_errors(const VALUE self) {
  re2_pattern *p = unwrap_re2_regexp(self);

  return BOOL2RUBY(p->pattern->options().log_errors());
}

#longest_match? ⇒ Boolean

Returns whether or not the regular expression was compiled with the longest_match option set to true.

Examples:

re2 = RE2::Regexp.new("woo?", longest_match: true)
re2.longest_match? #=> true

Returns:

  • (Boolean) —

    the longest_match option



1514
1515
1516
1517
1518
 
# File 'ext/re2/re2.cc', line 1514

static VALUE re2_regexp_longest_match(const VALUE self) {
  re2_pattern *p = unwrap_re2_regexp(self);

  return BOOL2RUBY(p->pattern->options().longest_match());
}

#match(text) ⇒ RE2::MatchData, ... #match(text, options) ⇒ RE2::MatchData, ... #match(text, submatches) ⇒ RE2::MatchData, ...

General matching: match the pattern against the given text using `Match` and return a MatchData instance with the specified number of submatches (defaults to the total number of capturing groups) or a boolean (if no submatches are required).

The number of submatches has a significant impact on performance: requesting one submatch is much faster than requesting more than one and requesting zero submatches is faster still.

Overloads:

  • #match(text) ⇒ RE2::MatchData, ...

    Returns a MatchData containing the matching pattern and all submatches resulting from looking for the regexp in text if the pattern contains capturing groups.

    Returns either true or false indicating whether a successful match was made if the pattern contains no capturing groups.

    Examples:

    Matching with capturing groups

    r = RE2::Regexp.new('w(o)(o)')
r.match('woo') #=> #<RE2::MatchData "woo" 1:"o" 2:"o">

    Matching without capturing groups

    r = RE2::Regexp.new('woo')
r.match('woo') #=> true

    Parameters:

    • text (String) —

      the text to search

    Returns:

    • (RE2::MatchData, nil) —

      if the pattern contains capturing groups

    • (Boolean) —

      if the pattern does not contain capturing groups

    Raises:

    • (NoMemoryError) —

      if there was not enough memory to allocate the submatches

    • (TypeError) —

      if given text that cannot be coerced to a String

  • #match(text, options) ⇒ RE2::MatchData, ...

    See match(text) but with customisable offsets for starting and ending matches, optional anchoring to the start or both ends of the text and a specific number of submatches to extract (padded with nils if necessary).

    Examples:

    Matching with capturing groups

    r = RE2::Regexp.new('w(o)(o)')
r.match('woo', submatches: 1) #=> #<RE2::MatchData "woo" 1:"o">
r.match('woo', submatches: 3) #=> #<RE2::MatchData "woo" 1:"o" 2:"o" 3:nil>
r.match('woot', anchor: :anchor_both, submatches: 0)
#=> false
r.match('woot', anchor: :anchor_start, submatches: 0)
#=> true

    Matching without capturing groups

    r = RE2::Regexp.new('wo+')
r.match('woot', anchor: :anchor_both)  #=> false
r.match('woot', anchor: :anchor_start) #=> true

    Parameters:

    • text (String) —

      the text to search

    • options (Hash) —

      the options with which to perform the match

    Options Hash (options):

    • :startpos (Integer) — default: 0 —

      offset at which to start matching

    • :endpos (Integer) —

      offset at which to stop matching, defaults to the text length

    • :anchor (Symbol) — default: :unanchored —

      one of :unanchored, :anchor_start, :anchor_both to anchor the match

    • :submatches (Integer) —

      how many submatches to extract (0 is fastest), defaults to the number of capturing groups

    Returns:

    • (RE2::MatchData, nil) —

      if extracting any submatches

    • (Boolean) —

      if not extracting any submatches

    Raises:

    • (ArgumentError) —

      if given a negative number of submatches, invalid anchor or invalid startpos, endpos pair

    • (NoMemoryError) —

      if there was not enough memory to allocate the matches

    • (TypeError) —

      if given non-String text, non-numeric number of submatches, non-symbol anchor or non-hash options

    • (RE2::Regexp::UnsupportedError) —

      if given an endpos argument on a version of RE2 that does not support it

  • #match(text, submatches) ⇒ RE2::MatchData, ...
    Deprecated.

    Legacy syntax for matching against text with a specific number of submatches to extract. Use match(text, submatches: n) instead.

    Examples:

    r = RE2::Regexp.new('w(o)(o)')
r.match('woo', 0) #=> true
r.match('woo', 1) #=> #<RE2::MatchData "woo" 1:"o">
r.match('woo', 2) #=> #<RE2::MatchData "woo" 1:"o" 2:"o">

    Parameters:

    • text (String) —

      the text to search

    • submatches (Integer) —

      the number of submatches to extract

    Returns:

    • (RE2::MatchData, nil) —

      if extracting any submatches

    • (Boolean) —

      if not extracting any submatches

    Raises:

    • (NoMemoryError) —

      if there was not enough memory to allocate the submatches

    • (TypeError) —

      if given non-numeric number of submatches



1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
 
# File 'ext/re2/re2.cc', line 1870

static VALUE re2_regexp_match(int argc, VALUE *argv, const VALUE self) {
  re2_pattern *p;
  re2_matchdata *m;
  VALUE text, options;

  rb_scan_args(argc, argv, "11", &text, &options);

  /* Coerce and freeze text to prevent mutation. */
  StringValue(text);
  text = rb_str_new_frozen(text);

  p = unwrap_re2_regexp(self);

  int n;
  size_t startpos = 0;
  size_t endpos = RSTRING_LEN(text);
  RE2::Anchor anchor = RE2::UNANCHORED;

  if (RTEST(options)) {
    if (RB_INTEGER_TYPE_P(options)) {
      n = NUM2INT(options);

      if (n < 0) {
        rb_raise(rb_eArgError, "number of matches should be >= 0");
      }
    } else {
      if (TYPE(options) != T_HASH) {
        options = rb_Hash(options);
      }

      VALUE endpos_option = rb_hash_aref(options, ID2SYM(id_endpos));
      if (!NIL_P(endpos_option)) {
#ifdef HAVE_ENDPOS_ARGUMENT
        ssize_t endpos_value = NUM2SSIZET(endpos_option);

        if (endpos_value < 0) {
          rb_raise(rb_eArgError, "endpos should be >= 0");
        }

        endpos = static_cast<size_t>(endpos_value);
#else
        rb_raise(re2_eRegexpUnsupportedError, "current version of RE2::Match() does not support endpos argument");
#endif
      }

      VALUE anchor_option = rb_hash_aref(options, ID2SYM(id_anchor));
      if (!NIL_P(anchor_option)) {
        Check_Type(anchor_option, T_SYMBOL);

        ID id_anchor_option = SYM2ID(anchor_option);
        if (id_anchor_option == id_unanchored) {
          anchor = RE2::UNANCHORED;
        } else if (id_anchor_option == id_anchor_start) {
          anchor = RE2::ANCHOR_START;
        } else if (id_anchor_option == id_anchor_both) {
          anchor = RE2::ANCHOR_BOTH;
        } else {
          rb_raise(rb_eArgError, "anchor should be one of: :unanchored, :anchor_start, :anchor_both");
        }
      }

      VALUE submatches_option = rb_hash_aref(options, ID2SYM(id_submatches));
      if (!NIL_P(submatches_option)) {
        n = NUM2INT(submatches_option);

        if (n < 0) {
          rb_raise(rb_eArgError, "number of matches should be >= 0");
        }
      } else {
        if (!p->pattern->ok()) {
          return Qnil;
        }

        n = p->pattern->NumberOfCapturingGroups();
      }

      VALUE startpos_option = rb_hash_aref(options, ID2SYM(id_startpos));
      if (!NIL_P(startpos_option)) {
        ssize_t startpos_value = NUM2SSIZET(startpos_option);

        if (startpos_value < 0) {
          rb_raise(rb_eArgError, "startpos should be >= 0");
        }

        startpos = static_cast<size_t>(startpos_value);
      }
    }
  } else {
    if (!p->pattern->ok()) {
      return Qnil;
    }

    n = p->pattern->NumberOfCapturingGroups();
  }

  if (startpos > endpos) {
    rb_raise(rb_eArgError, "startpos should be <= endpos");
  }

#ifndef HAVE_ENDPOS_ARGUMENT
  /* Old RE2's Match() takes int startpos. Reject values that would overflow. */
  if (startpos > INT_MAX) {
    rb_raise(rb_eRangeError, "startpos should be <= %d", INT_MAX);
  }
#endif

  if (n == 0) {
    bool matched = re2_match_without_gvl(
        p->pattern, text, startpos, endpos, anchor, 0, 0);
    RB_GC_GUARD(text);

    return BOOL2RUBY(matched);
  } else {
    if (n == INT_MAX) {
      rb_raise(rb_eRangeError, "number of matches should be < %d", INT_MAX);
    }

    /* Because match returns the whole match as well. */
    n += 1;

    re2::StringPiece *matches = new(std::nothrow) re2::StringPiece[n];
    if (matches == nullptr) {
      rb_raise(rb_eNoMemError,
               "not enough memory to allocate StringPieces for matches");
    }

    bool matched = re2_match_without_gvl(
        p->pattern, text, startpos, endpos, anchor, matches, n);
    RB_GC_GUARD(text);

    if (matched) {
      VALUE matchdata = rb_class_new_instance(0, 0, re2_cMatchData);
      TypedData_Get_Struct(matchdata, re2_matchdata, &re2_matchdata_data_type, m);

      RB_OBJ_WRITE(matchdata, &m->regexp, self);
      RB_OBJ_WRITE(matchdata, &m->text, text);
      m->matches = matches;
      m->number_of_matches = n;

      return matchdata;
    } else {
      delete[] matches;

      return Qnil;
    }
  }
}

#match?(text) ⇒ Boolean

Returns true if the pattern matches any substring of the given text using `PartialMatch`.

Parameters:

  • text (String) —

    the text to search

Returns:

  • (Boolean) —

    whether the match was successful

Raises:

  • (TypeError) —

    if text cannot be coerced to a String



2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
 
# File 'ext/re2/re2.cc', line 2027

static VALUE re2_regexp_match_p(const VALUE self, VALUE text) {
  StringValue(text);
  text = rb_str_new_frozen(text);

  re2_pattern *p = unwrap_re2_regexp(self);
  bool matched = re2_match_without_gvl(
      p->pattern, text, 0, RSTRING_LEN(text), RE2::UNANCHORED, 0, 0);
  RB_GC_GUARD(text);

  return BOOL2RUBY(matched);
}

#max_mem ⇒ Integer

Returns the max_mem setting for the regular expression.

Examples:

re2 = RE2::Regexp.new("woo?", max_mem: 1024)
re2.max_mem #=> 1024

Returns:

  • (Integer) —

    the max_mem option



1543
1544
1545
1546
1547
 
# File 'ext/re2/re2.cc', line 1543

static VALUE re2_regexp_max_mem(const VALUE self) {
  re2_pattern *p = unwrap_re2_regexp(self);

  return INT2FIX(p->pattern->options().max_mem());
}

#named_captures ⇒ Hash

Returns a hash of names to capturing indices of groups.

Note RE2 stores capturing group names as UTF-8, even if the RE2::Regexp sets the :utf8 option to false so strings will always be returned in UTF-8.

Returns:

  • (Hash) —

    a hash of names to capturing indices



1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
 
# File 'ext/re2/re2.cc', line 1774

static VALUE re2_regexp_named_capturing_groups(const VALUE self) {
  re2_pattern *p = unwrap_re2_regexp(self);
  const auto& groups = p->pattern->NamedCapturingGroups();
  VALUE capturing_groups = rb_hash_new();

  for (const auto& group : groups) {
    rb_hash_aset(capturing_groups,
        rb_utf8_str_new(group.first.data(), group.first.size()),
        INT2FIX(group.second));
  }

  return capturing_groups;
}

#named_capturing_groups ⇒ Hash

Returns a hash of names to capturing indices of groups.

Note RE2 stores capturing group names as UTF-8, even if the RE2::Regexp sets the :utf8 option to false so strings will always be returned in UTF-8.

Returns:

  • (Hash) —

    a hash of names to capturing indices



1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
 
# File 'ext/re2/re2.cc', line 1774

static VALUE re2_regexp_named_capturing_groups(const VALUE self) {
  re2_pattern *p = unwrap_re2_regexp(self);
  const auto& groups = p->pattern->NamedCapturingGroups();
  VALUE capturing_groups = rb_hash_new();

  for (const auto& group : groups) {
    rb_hash_aset(capturing_groups,
        rb_utf8_str_new(group.first.data(), group.first.size()),
        INT2FIX(group.second));
  }

  return capturing_groups;
}

#names ⇒ Array<String>

Returns an array of names of all named capturing groups. Names are returned in alphabetical order rather than definition order, as RE2 stores named groups internally in a sorted map.

Note RE2 stores capturing group names as UTF-8, even if the RE2::Regexp sets the :utf8 option to false so strings will always be returned in UTF-8.

Examples:

RE2::Regexp.new('(?P<a>\d+) (?P<b>\w+)').names #=> ["a", "b"]

Returns:

  • (Array<String>) —

    an array of names of named capturing groups



431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'ext/re2/re2.cc', line 431

static VALUE re2_regexp_names(const VALUE self) {
  re2_pattern *p = unwrap_re2_regexp(self);

  const auto& groups = p->pattern->NamedCapturingGroups();
  VALUE names = rb_ary_new2(groups.size());

  for (const auto& group : groups) {
    rb_ary_push(names, rb_utf8_str_new(group.first.data(), group.first.size()));
  }

  return names;
}

#never_nl? ⇒ Boolean

Returns whether or not the regular expression was compiled with the never_nl option set to true.

Examples:

re2 = RE2::Regexp.new("woo?", never_nl: true)
re2.never_nl? #=> true

Returns:

  • (Boolean) —

    the never_nl option



1573
1574
1575
1576
1577
 
# File 'ext/re2/re2.cc', line 1573

static VALUE re2_regexp_never_nl(const VALUE self) {
  re2_pattern *p = unwrap_re2_regexp(self);

  return BOOL2RUBY(p->pattern->options().never_nl());
}

#number_of_capturing_groups ⇒ Integer

Returns the number of capturing subpatterns, or -1 if the regexp wasn't valid on construction. The overall match ($0) does not count: if the regexp is "(a)(b)", returns 2.

Returns:

  • (Integer) —

    the number of capturing subpatterns



1759
1760
1761
1762
1763
 
# File 'ext/re2/re2.cc', line 1759

static VALUE re2_regexp_number_of_capturing_groups(const VALUE self) {
  re2_pattern *p = unwrap_re2_regexp(self);

  return INT2FIX(p->pattern->NumberOfCapturingGroups());
}

#ok? ⇒ Boolean

Returns whether or not the regular expression was compiled successfully.

Examples:

re2 = RE2::Regexp.new("woo?")
re2.ok? #=> true

Returns:

  • (Boolean) —

    whether or not compilation was successful



1469
1470
1471
1472
1473
 
# File 'ext/re2/re2.cc', line 1469

static VALUE re2_regexp_ok(const VALUE self) {
  re2_pattern *p = unwrap_re2_regexp(self);

  return BOOL2RUBY(p->pattern->ok());
}

#one_line? ⇒ Boolean

Returns whether or not the regular expression was compiled with the one_line option set to true.

Examples:

re2 = RE2::Regexp.new("woo?", one_line: true)
re2.one_line? #=> true

Returns:

  • (Boolean) —

    the one_line option



1647
1648
1649
1650
1651
 
# File 'ext/re2/re2.cc', line 1647

static VALUE re2_regexp_one_line(const VALUE self) {
  re2_pattern *p = unwrap_re2_regexp(self);

  return BOOL2RUBY(p->pattern->options().one_line());
}

#options ⇒ Hash

Returns a hash of the options currently set for the RE2::Regexp.

Returns:

  • (Hash) —

    the options



1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
 
# File 'ext/re2/re2.cc', line 1709

static VALUE re2_regexp_options(const VALUE self) {
  re2_pattern *p = unwrap_re2_regexp(self);
  VALUE options = rb_hash_new();

  rb_hash_aset(options, ID2SYM(id_utf8),
      BOOL2RUBY(p->pattern->options().encoding() == RE2::Options::EncodingUTF8));

  rb_hash_aset(options, ID2SYM(id_posix_syntax),
      BOOL2RUBY(p->pattern->options().posix_syntax()));

  rb_hash_aset(options, ID2SYM(id_longest_match),
      BOOL2RUBY(p->pattern->options().longest_match()));

  rb_hash_aset(options, ID2SYM(id_log_errors),
      BOOL2RUBY(p->pattern->options().log_errors()));

  rb_hash_aset(options, ID2SYM(id_max_mem),
      INT2FIX(p->pattern->options().max_mem()));

  rb_hash_aset(options, ID2SYM(id_literal),
      BOOL2RUBY(p->pattern->options().literal()));

  rb_hash_aset(options, ID2SYM(id_never_nl),
      BOOL2RUBY(p->pattern->options().never_nl()));

  rb_hash_aset(options, ID2SYM(id_case_sensitive),
      BOOL2RUBY(p->pattern->options().case_sensitive()));

  rb_hash_aset(options, ID2SYM(id_perl_classes),
      BOOL2RUBY(p->pattern->options().perl_classes()));

  rb_hash_aset(options, ID2SYM(id_word_boundary),
      BOOL2RUBY(p->pattern->options().word_boundary()));

  rb_hash_aset(options, ID2SYM(id_one_line),
      BOOL2RUBY(p->pattern->options().one_line()));

  /* This is a read-only hash after all... */
  rb_obj_freeze(options);

  return options;
}

#partial_match(text, options = {}) ⇒ RE2::MatchData, ...

Match the pattern against any substring of the given text and return a MatchData instance with the specified number of submatches (defaults to the total number of capturing groups) or a boolean (if no submatches are required).

The number of submatches has a significant impact on performance: requesting one submatch is much faster than requesting more than one and requesting zero submatches is faster still.

Examples:

r = RE2::Regexp.new('w(o)(o)')
r.partial_match('woot')                #=> #<RE2::MatchData "woo" 1:"o" 2:"o">
r.partial_match('nope')                #=> nil
r.partial_match('woot', submatches: 1) #=> #<RE2::MatchData "woo" 1:"o">
r.partial_match('woot', submatches: 0) #=> true

Parameters:

  • text (String) —

    the text to search

  • options (Hash) (defaults to: {}) —

    the options with which to perform the match

Options Hash (options):

  • :submatches (Integer) —

    how many submatches to extract (0 is fastest), defaults to the total number of capturing groups

Returns:

  • (RE2::MatchData, nil) —

    if extracting any submatches

  • (Boolean) —

    if not extracting any submatches

Raises:

  • (ArgumentError) —

    if given a negative number of submatches

  • (NoMemoryError) —

    if there was not enough memory to allocate the matches

  • (TypeError) —

    if given non-numeric submatches or non-hash options



39
40
41
 
# File 'lib/re2/regexp.rb', line 39

def partial_match(text, options = {})
  match(text, Hash(options).merge(anchor: :unanchored))
end

#partial_match?(text) ⇒ Boolean

Returns true if the pattern matches any substring of the given text using `PartialMatch`.

Parameters:

  • text (String) —

    the text to search

Returns:

  • (Boolean) —

    whether the match was successful

Raises:

  • (TypeError) —

    if text cannot be coerced to a String



2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
 
# File 'ext/re2/re2.cc', line 2027

static VALUE re2_regexp_match_p(const VALUE self, VALUE text) {
  StringValue(text);
  text = rb_str_new_frozen(text);

  re2_pattern *p = unwrap_re2_regexp(self);
  bool matched = re2_match_without_gvl(
      p->pattern, text, 0, RSTRING_LEN(text), RE2::UNANCHORED, 0, 0);
  RB_GC_GUARD(text);

  return BOOL2RUBY(matched);
}

#pattern ⇒ String

Returns a string version of the regular expression.

Note RE2 only supports UTF-8 and ISO-8859-1 encoding so strings will be returned in UTF-8 by default or ISO-8859-1 if the :utf8 option for the RE2::Regexp is set to false (any other encoding's behaviour is undefined).

Examples:

re2 = RE2::Regexp.new("woo?")
re2.to_s #=> "woo?"

Returns:

  • (String) —

    a string version of the regular expression



1453
1454
1455
1456
1457
1458
1459
 
# File 'ext/re2/re2.cc', line 1453

static VALUE re2_regexp_to_s(const VALUE self) {
  re2_pattern *p = unwrap_re2_regexp(self);

  return encoded_str_new(p->pattern->pattern().data(),
      p->pattern->pattern().size(),
      p->pattern->options().encoding());
}

#perl_classes? ⇒ Boolean

Returns whether or not the regular expression was compiled with the perl_classes option set to true.

Examples:

re2 = RE2::Regexp.new("woo?", perl_classes: true)
re2.perl_classes? #=> true

Returns:

  • (Boolean) —

    the perl_classes option



1617
1618
1619
1620
1621
 
# File 'ext/re2/re2.cc', line 1617

static VALUE re2_regexp_perl_classes(const VALUE self) {
  re2_pattern *p = unwrap_re2_regexp(self);

  return BOOL2RUBY(p->pattern->options().perl_classes());
}

#posix_syntax? ⇒ Boolean

Returns whether or not the regular expression was compiled with the posix_syntax option set to true.

Examples:

re2 = RE2::Regexp.new("woo?", posix_syntax: true)
re2.posix_syntax? #=> true

Returns:

  • (Boolean) —

    the posix_syntax option



1499
1500
1501
1502
1503
 
# File 'ext/re2/re2.cc', line 1499

static VALUE re2_regexp_posix_syntax(const VALUE self) {
  re2_pattern *p = unwrap_re2_regexp(self);

  return BOOL2RUBY(p->pattern->options().posix_syntax());
}

#program_size ⇒ Integer

Returns the program size, a very approximate measure of a regexp's "cost". Larger numbers are more expensive than smaller numbers.

Returns:

  • (Integer) —

    the regexp "cost"



1698
1699
1700
1701
1702
 
# File 'ext/re2/re2.cc', line 1698

static VALUE re2_regexp_program_size(const VALUE self) {
  re2_pattern *p = unwrap_re2_regexp(self);

  return INT2FIX(p->pattern->ProgramSize());
}

#scan(text) ⇒ RE2::Scanner

Returns a Scanner for scanning the given text incrementally with `FindAndConsume`.

Examples:

c = RE2::Regexp.new('(\w+)').scan("Foo bar baz")
#=> #<RE2::Scanner:0x0000000000000001>

Parameters:

  • text (text) —

    the text to scan incrementally

Returns:

Raises:

  • (TypeError) —

    if text cannot be coerced to a String



2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
 
# File 'ext/re2/re2.cc', line 2072

static VALUE re2_regexp_scan(const VALUE self, VALUE text) {
  StringValue(text);
  text = rb_str_new_frozen(text);

  re2_pattern *p = unwrap_re2_regexp(self);
  re2_scanner *c;
  VALUE scanner = rb_class_new_instance(0, 0, re2_cScanner);
  TypedData_Get_Struct(scanner, re2_scanner, &re2_scanner_data_type, c);

  RB_OBJ_WRITE(scanner, &c->regexp, self);
  RB_OBJ_WRITE(scanner, &c->text, text);
  c->input = new(std::nothrow) re2::StringPiece(
      RSTRING_PTR(c->text), RSTRING_LEN(c->text));
  if (c->input == nullptr) {
    rb_raise(rb_eNoMemError,
             "not enough memory to allocate StringPiece for input");
  }

  if (p->pattern->ok()) {
    c->number_of_capturing_groups = p->pattern->NumberOfCapturingGroups();
  } else {
    c->number_of_capturing_groups = 0;
  }

  c->eof = false;

  return scanner;
}

#source ⇒ String

Returns a string version of the regular expression.

Note RE2 only supports UTF-8 and ISO-8859-1 encoding so strings will be returned in UTF-8 by default or ISO-8859-1 if the :utf8 option for the RE2::Regexp is set to false (any other encoding's behaviour is undefined).

Examples:

re2 = RE2::Regexp.new("woo?")
re2.to_s #=> "woo?"

Returns:

  • (String) —

    a string version of the regular expression



1453
1454
1455
1456
1457
1458
1459
 
# File 'ext/re2/re2.cc', line 1453

static VALUE re2_regexp_to_s(const VALUE self) {
  re2_pattern *p = unwrap_re2_regexp(self);

  return encoded_str_new(p->pattern->pattern().data(),
      p->pattern->pattern().size(),
      p->pattern->options().encoding());
}

#to_s ⇒ String

Returns a string version of the regular expression.

Note RE2 only supports UTF-8 and ISO-8859-1 encoding so strings will be returned in UTF-8 by default or ISO-8859-1 if the :utf8 option for the RE2::Regexp is set to false (any other encoding's behaviour is undefined).

Examples:

re2 = RE2::Regexp.new("woo?")
re2.to_s #=> "woo?"

Returns:

  • (String) —

    a string version of the regular expression



1453
1454
1455
1456
1457
1458
1459
 
# File 'ext/re2/re2.cc', line 1453

static VALUE re2_regexp_to_s(const VALUE self) {
  re2_pattern *p = unwrap_re2_regexp(self);

  return encoded_str_new(p->pattern->pattern().data(),
      p->pattern->pattern().size(),
      p->pattern->options().encoding());
}

#to_str ⇒ String

Returns a string version of the regular expression.

Note RE2 only supports UTF-8 and ISO-8859-1 encoding so strings will be returned in UTF-8 by default or ISO-8859-1 if the :utf8 option for the RE2::Regexp is set to false (any other encoding's behaviour is undefined).

Examples:

re2 = RE2::Regexp.new("woo?")
re2.to_s #=> "woo?"

Returns:

  • (String) —

    a string version of the regular expression



1453
1454
1455
1456
1457
1458
1459
 
# File 'ext/re2/re2.cc', line 1453

static VALUE re2_regexp_to_s(const VALUE self) {
  re2_pattern *p = unwrap_re2_regexp(self);

  return encoded_str_new(p->pattern->pattern().data(),
      p->pattern->pattern().size(),
      p->pattern->options().encoding());
}

#utf8? ⇒ Boolean

Returns whether or not the regular expression was compiled with the utf8 option set to true.

Examples:

re2 = RE2::Regexp.new("woo?", utf8: true)
re2.utf8? #=> true

Returns:

  • (Boolean) —

    the utf8 option



1484
1485
1486
1487
1488
 
# File 'ext/re2/re2.cc', line 1484

static VALUE re2_regexp_utf8(const VALUE self) {
  re2_pattern *p = unwrap_re2_regexp(self);

  return BOOL2RUBY(p->pattern->options().encoding() == RE2::Options::EncodingUTF8);
}

#word_boundary? ⇒ Boolean

Returns whether or not the regular expression was compiled with the word_boundary option set to true.

Examples:

re2 = RE2::Regexp.new("woo?", word_boundary: true)
re2.word_boundary? #=> true

Returns:

  • (Boolean) —

    the word_boundary option



1632
1633
1634
1635
1636
 
# File 'ext/re2/re2.cc', line 1632

static VALUE re2_regexp_word_boundary(const VALUE self) {
  re2_pattern *p = unwrap_re2_regexp(self);

  return BOOL2RUBY(p->pattern->options().word_boundary());
}