Regexp::From::String - Convert '/.../' or 'qr(...)' into Regexp object
This document describes version 0.002 of Regexp::From::String (from Perl distribution Regexp-From-String), released on 2022-07-09.
use Regexp::From::String qw(str_maybe_to_re str_to_re); my $re1 = str_maybe_to_re('foo'); # stays as string 'foo' my $re2 = str_maybe_to_re('/foo'); # stays as string '/foo' my $re3 = str_maybe_to_re('/foo/'); # compiled to Regexp object qr(foo) my $re4 = str_maybe_to_re('qr(foo)i'); # compiled to Regexp object qr(foo)i my $re5 = str_maybe_to_re('qr(foo[)i'); # dies, invalid regex syntax my $re1 = str_to_re('foo'); # compiled to Regexp object qr(foo) my $re2 = str_to_re('/foo'); # compiled to Regexp object qr(/foo) my $re2 = str_to_re({case_insensitive=>1}, 'foo[]'); # compiled to Regexp object qr(foo\[\])i my $re2 = str_to_re({anchored=>1}, 'foo[]'); # compiled to Regexp object qr(\Afoo\[\]\z) my $re3 = str_to_re('/foo/'); # compiled to Regexp object qr(foo) my $re4 = str_to_re('qr(foo)i'); # compiled to Regexp object qr(foo)i my $re5 = str_to_re('qr(foo[)i'); # dies, invalid regex syntax
Maybe convert string to Regexp object.
Usage:
$str_or_re = str_maybe_to_re($str);
Check if string $str is in the form of /.../ or qr(...)' and if so, compile the inside regex (currently simply using stringy eval) and return the resulting Regexp object. Otherwise, will simply return the argument unmodified.
$str
/.../
qr(...)'
eval
Will die if compilation fails, e.g. when the regexp syntax is invalid.
For the qr(...) form, unlike in Perl, currently only the () delimiter characters are recognized and not others.
qr(...)
()
Optional modifiers i, m, and s are currently allowed at the end.
i
m
s
Convert string to Regexp object.
$str_or_re = str_to_re([ \%opts , ] $str);
This function is similar to "str_maybe_to_re" except that when string is not in the form of /.../ or qr(...), the string is quotemeta()'ed then converted to a Regexp object anyway. There are some options available to specify in first argument hashref \%opts:
quotemeta()
\%opts
Bool. If set to true will compile to Regexp object with i regexp modifier.
Bool. If set to true will anchor the pattern with \A and \z.
\A
\z
Please visit the project's homepage at https://metacpan.org/release/Regexp-From-String.
Source repository is at https://github.com/perlancar/perl-Regexp-From-String.
Sah::Schema::str_or_re
perlancar <perlancar@cpan.org>
To contribute, you can send patches by email/via RT, or send pull requests on GitHub.
Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:
% prove -l
If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.
This software is copyright (c) 2022 by perlancar <perlancar@cpan.org>.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Regexp-From-String
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
To install Regexp::From::String, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Regexp::From::String
CPAN shell
perl -MCPAN -e shell install Regexp::From::String
For more information on module installation, please visit the detailed CPAN module installation guide.