Module: RE2

Defined in:

ext/re2/re2.cc,
lib/re2/string.rb,
lib/re2/scanner.rb,
lib/re2/version.rb

Defined Under Namespace

Modules: String Classes: MatchData, Regexp, Scanner, Set

Constant Summary

VERSION =

"2.4.3"

Class Method Summary

• .GlobalReplace(str, pattern, rewrite) ⇒ String

  Return a copy of str with pattern replaced by rewrite.

• .QuoteMeta(unquoted) ⇒ String

  Returns a version of str with all potentially meaningful regexp characters escaped.

• .Replace(str, pattern, rewrite) ⇒ String

  Returns a copy of str with the first occurrence pattern replaced with rewrite.

Class Method Details

.GlobalReplace(str, pattern, rewrite) ⇒ String

Return a copy of str with pattern replaced by rewrite.

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("oo?")
RE2.GlobalReplace("whoops-doops", re2, "e")  #=> "wheps-deps"
RE2.GlobalReplace("hello there", "e", "i")   #=> "hillo thiri"

Parameters:

• str (String) —

  the string to modify

• pattern (String, RE2::Regexp) —

  a regexp matching text to be replaced

• rewrite (String) —

  the string to replace with

Returns:

• (String) —

  the resulting string

# File 'ext/re2/re2.cc', line 1546

static VALUE re2_GlobalReplace(VALUE, VALUE str, VALUE pattern,
                               VALUE rewrite) {
  /* Ensure rewrite is a string. */
  StringValue(rewrite);

  /* Take a copy of str so it can be modified in-place by
   * RE2::GlobalReplace.
   */
  re2_pattern *p;
  std::string str_as_string(StringValuePtr(str));

  /* Do the replacement. */
  if (rb_obj_is_kind_of(pattern, re2_cRegexp)) {
    TypedData_Get_Struct(pattern, re2_pattern, &re2_regexp_data_type, p);
    RE2::GlobalReplace(&str_as_string, *p->pattern, RSTRING_PTR(rewrite));

    return encoded_str_new(str_as_string.data(), str_as_string.size(),
        p->pattern->options().encoding());
  } else {
    /* Ensure pattern is a string. */
    StringValue(pattern);

    RE2::GlobalReplace(&str_as_string, RSTRING_PTR(pattern),
        RSTRING_PTR(rewrite));

    return encoded_str_new(str_as_string.data(), str_as_string.size(), RE2::Options::EncodingUTF8);
  }
}

.QuoteMeta(unquoted) ⇒ String

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

Examples:

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

Parameters:

• unquoted (String) —

  the unquoted string

Returns:

• (String) —

  the escaped string

# File 'ext/re2/re2.cc', line 1585

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

  std::string quoted_string = RE2::QuoteMeta(RSTRING_PTR(unquoted));

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

.Replace(str, pattern, rewrite) ⇒ String

Returns a copy of str with the first occurrence pattern replaced with rewrite.

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.Replace("hello there", "hello", "howdy") #=> "howdy there"
re2 = RE2::Regexp.new("hel+o")
RE2.Replace("hello there", re2, "yo")        #=> "yo there"

Parameters:

• str (String) —

  the string to modify

• pattern (String, RE2::Regexp) —

  a regexp matching text to be replaced

• rewrite (String) —

  the string to replace with

Returns:

• (String) —

  the resulting string

# File 'ext/re2/re2.cc', line 1501

static VALUE re2_Replace(VALUE, VALUE str, VALUE pattern,
    VALUE rewrite) {
  /* Ensure rewrite is a string. */
  StringValue(rewrite);

  re2_pattern *p;

  /* Take a copy of str so it can be modified in-place by
   * RE2::Replace.
   */
  std::string str_as_string(StringValuePtr(str));

  /* Do the replacement. */
  if (rb_obj_is_kind_of(pattern, re2_cRegexp)) {
    TypedData_Get_Struct(pattern, re2_pattern, &re2_regexp_data_type, p);
    RE2::Replace(&str_as_string, *p->pattern, RSTRING_PTR(rewrite));

    return encoded_str_new(str_as_string.data(), str_as_string.size(),
        p->pattern->options().encoding());
  } else {
    /* Ensure pattern is a string. */
    StringValue(pattern);

    RE2::Replace(&str_as_string, RSTRING_PTR(pattern), RSTRING_PTR(rewrite));

    return encoded_str_new(str_as_string.data(), str_as_string.size(), RE2::Options::EncodingUTF8);
  }
}