NAME

SPVM::Regex - Regular expression

SYNOPSYS

use SPVM::Regex;

# Pattern match
{
  my $re = SPVM::Regex->new("ab*c");
  my $target = "zabcz";
  my $match = $re->match($target, 0);
}

# Pattern match with captures
{
  my $re = SPVM::Regex->new("^(\w+) (\w+) (\w+)$");
  my $target = "abc1 abc2 abc3";
  my $match = $re->match($target, 0);
  
  my $cap1 = $re->caps->[0];
  my $cap2 = $re->caps->[1];
  my $cpa3 = $re->caps->[2];
}

# Replace
{
  my $re = SPVM::Regex->new("abc");
  my $target = "ppzabcz";
  
  # "ppzABCz"
  my $result = $re->replace($target, 0, "ABC");
  
  my $replace_count = $re->replace_count;
}

# Replace with a callback and capture
{
  my $re = SPVM::Regex->new("a(bc)");
  my $target = "ppzabcz";
  
  # "ppzABbcCz"
  my $result = $re->replace_cb($target, 0, sub : string ($self : self, $re : SPVM::Regex) {
    return "AB" . $re->caps->[0] . "C";
  });
}

# Replace all
{
  my $re = SPVM::Regex->new("abc");
  my $target = "ppzabczabcz";
  
  # "ppzABCzABCz"
  my $result = $re->replace_all($target, 0, "ABC");
}

# Replace all with a callback and capture
{
  my $re = SPVM::Regex->new("a(bc)");
  my $target = "ppzabczabcz";
  
  # "ppzABCbcPQRSzABCbcPQRSz"
  my $result = $re->replace_all_cb($target, 0, sub : string ($self : self, $re : SPVM::Regex) {
    return "ABC" . $re->caps->[0] . "PQRS";
  });
}

DESCRIPTION

SPVM::Regex provides regular expression functions.

REGULAR EXPRESSION SYNTAX

SPVM::Regex provides subset of Perl regular expression.

# Quantifier
+     more than or equals to 1 repeats
*     more than or equals to 0 repeats
?     0 or 1 repeats
{m,n} repeats between m and n

# Regular expression character
^  first of string
$  last of string
\d [0-9]
\D not \d
\s " ", "\t", "\f", "\r", "\n"
\S not \s
\w [a-zA-Z0-9_]
\W not \w

# Character class
[a-z0-9]

# Capture
(foo)

Subset support only linear execution of pattern matching.

SPVM::Regex do not support the following regular expression

# Do not support
. any character except for \n
| or

SPVM::Regex do not support the same set of characters after quantifier.

# Compile error
SPVM::Regex->new("a*a");
SPVM::Regex->new("a?a");
SPVM::Regex->new("a+a");
SPVM::Regex->new("a{1,3}a")
    

If 0 width quantifir is between two same set of characters after quantifier, it is invalid.

# Compile error
SPVM::Regex->new("\d+\D*\d+");
SPVM::Regex->new("\d+\D?\d+");

STATIC METHODS

my $re = SPVM::Regex->new("^ab+c");

Create a new SPVM::Regex object and compile the specific regex.

INSTANCE METHODS

caps

sub caps : string[] ()

Get the strings captured by "match" method.

match_start

sub match_start : int ()

Get the start byte offset of the string matched by "match" method or "match_offset" method.

match_length

sub match_length : int ()

Get the byte length of the string matched by "match" method or "match_offset" method.

replace_count

sub replace_count : int ();

Get the replace count of the strings replaced by "replace" or "replace_all" method.

match

sub match : int ($self : self, $target : string, $target_offset : int)

Execute pattern matching to the specific string and the start byte offset of the string.

If the pattern match succeeds, 1 is returned, otherwise 0 is returned.

You can get captured strings using "caps" method, and get the byte offset of the matched whole string using "match_start" method, and get the length of the matched whole string using "match_length" method.

replace

sub replace  : string ($self : self, $target : string, $target_offset : int, $replace : string)

Replace the target string specified with the start byte offset with replace string.

replace_cb

sub replace_cb  : string ($self : self, $target : string, $target_offset : int, $replace_cb : SPVM::Regex::Replacer)

Replace the target string specified with the start byte offset with replace callback. The callback must have "replace_to" method defined in SPVM::Regex::Replacer.

replace_all

sub replace_all  : string ($self : self, $target : string, $target_offset : int, $replace : string)

Replace all of the target strings specified with the start byte offset with replace string.

replace_all_cb

sub replace_all_cb  : string ($self : self, $target : string, $target_offset : int, $replace_cb : SPVM::Regex::Replacer)

Replace all of the target strings specified with the start byte offset with replace callback. The callback must have "replace_to" method defined in SPVM::Regex::Replacer.

cpanm SPVM

perl -MCPAN -e shell
install SPVM