📄 re.pm
字号:
package re;# pragma for controlling the regex engineuse strict;use warnings;our $VERSION = "0.08";our @ISA = qw(Exporter);our @EXPORT_OK = qw(is_regexp regexp_pattern regmust regname regnames regnames_count);our %EXPORT_OK = map { $_ => 1 } @EXPORT_OK;# *** WARNING *** WARNING *** WARNING *** WARNING *** WARNING ***## If you modify these values see comment below!my %bitmask = ( taint => 0x00100000, # HINT_RE_TAINT eval => 0x00200000, # HINT_RE_EVAL);# - File::Basename contains a literal for 'taint' as a fallback. If# taint is changed here, File::Basename must be updated as well.## - ExtUtils::ParseXS uses a hardcoded # BEGIN { $^H |= 0x00200000 } # in it to allow re.xs to be built. So if 'eval' is changed here then# ExtUtils::ParseXS must be changed as well.## *** WARNING *** WARNING *** WARNING *** WARNING *** WARNING ***sub setcolor { eval { # Ignore errors require Term::Cap; my $terminal = Tgetent Term::Cap ({OSPEED => 9600}); # Avoid warning. my $props = $ENV{PERL_RE_TC} || 'md,me,so,se,us,ue'; my @props = split /,/, $props; my $colors = join "\t", map {$terminal->Tputs($_,1)} @props; $colors =~ s/\0//g; $ENV{PERL_RE_COLORS} = $colors; }; if ($@) { $ENV{PERL_RE_COLORS} ||= qq'\t\t> <\t> <\t\t'; }}my %flags = ( COMPILE => 0x0000FF, PARSE => 0x000001, OPTIMISE => 0x000002, TRIEC => 0x000004, DUMP => 0x000008, FLAGS => 0x000010, EXECUTE => 0x00FF00, INTUIT => 0x000100, MATCH => 0x000200, TRIEE => 0x000400, EXTRA => 0xFF0000, TRIEM => 0x010000, OFFSETS => 0x020000, OFFSETSDBG => 0x040000, STATE => 0x080000, OPTIMISEM => 0x100000, STACK => 0x280000, BUFFERS => 0x400000,);$flags{ALL} = -1 & ~($flags{OFFSETS}|$flags{OFFSETSDBG}|$flags{BUFFERS});$flags{All} = $flags{all} = $flags{DUMP} | $flags{EXECUTE};$flags{Extra} = $flags{EXECUTE} | $flags{COMPILE};$flags{More} = $flags{MORE} = $flags{All} | $flags{TRIEC} | $flags{TRIEM} | $flags{STATE};$flags{State} = $flags{DUMP} | $flags{EXECUTE} | $flags{STATE};$flags{TRIE} = $flags{DUMP} | $flags{EXECUTE} | $flags{TRIEC};my $installed;my $installed_error;sub _do_install { if ( ! defined($installed) ) { require XSLoader; $installed = eval { XSLoader::load('re', $VERSION) } || 0; $installed_error = $@; }}sub _load_unload { my ($on)= @_; if ($on) { _do_install(); if ( ! $installed ) { die "'re' not installed!? ($installed_error)"; } else { # We call install() every time, as if we didn't, we wouldn't # "see" any changes to the color environment var since # the last time it was called. # install() returns an integer, which if casted properly # in C resolves to a structure containing the regex # hooks. Setting it to a random integer will guarantee # segfaults. $^H{regcomp} = install(); } } else { delete $^H{regcomp}; }}sub bits { my $on = shift; my $bits = 0; unless (@_) { require Carp; Carp::carp("Useless use of \"re\" pragma"); } foreach my $idx (0..$#_){ my $s=$_[$idx]; if ($s eq 'Debug' or $s eq 'Debugcolor') { setcolor() if $s =~/color/i; ${^RE_DEBUG_FLAGS} = 0 unless defined ${^RE_DEBUG_FLAGS}; for my $idx ($idx+1..$#_) { if ($flags{$_[$idx]}) { if ($on) { ${^RE_DEBUG_FLAGS} |= $flags{$_[$idx]}; } else { ${^RE_DEBUG_FLAGS} &= ~ $flags{$_[$idx]}; } } else { require Carp; Carp::carp("Unknown \"re\" Debug flag '$_[$idx]', possible flags: ", join(", ",sort keys %flags ) ); } } _load_unload($on ? 1 : ${^RE_DEBUG_FLAGS}); last; } elsif ($s eq 'debug' or $s eq 'debugcolor') { setcolor() if $s =~/color/i; _load_unload($on); last; } elsif (exists $bitmask{$s}) { $bits |= $bitmask{$s}; } elsif ($EXPORT_OK{$s}) { _do_install(); require Exporter; re->export_to_level(2, 're', $s); } else { require Carp; Carp::carp("Unknown \"re\" subpragma '$s' (known ones are: ", join(', ', map {qq('$_')} 'debug', 'debugcolor', sort keys %bitmask), ")"); } } $bits;}sub import { shift; $^H |= bits(1, @_);}sub unimport { shift; $^H &= ~ bits(0, @_);}1;__END__=head1 NAMEre - Perl pragma to alter regular expression behaviour=head1 SYNOPSIS use re 'taint'; ($x) = ($^X =~ /^(.*)$/s); # $x is tainted here $pat = '(?{ $foo = 1 })'; use re 'eval'; /foo${pat}bar/; # won't fail (when not under -T switch) { no re 'taint'; # the default ($x) = ($^X =~ /^(.*)$/s); # $x is not tainted here no re 'eval'; # the default /foo${pat}bar/; # disallowed (with or without -T switch) } use re 'debug'; # output debugging info during /^(.*)$/s; # compile and run time use re 'debugcolor'; # same as 'debug', but with colored output ... use re qw(Debug All); # Finer tuned debugging options. use re qw(Debug More); no re qw(Debug ALL); # Turn of all re debugging in this scope use re qw(is_regexp regexp_pattern); # import utility functions my ($pat,$mods)=regexp_pattern(qr/foo/i); if (is_regexp($obj)) { print "Got regexp: ", scalar regexp_pattern($obj); # just as perl would stringify it } # but no hassle with blessed re's.(We use $^X in these examples because it's tainted by default.)=head1 DESCRIPTION=head2 'taint' modeWhen C<use re 'taint'> is in effect, and a tainted string is the targetof a regex, the regex memories (or values returned by the m// operatorin list context) are tainted. This feature is useful when regex operationson tainted data aren't meant to extract safe substrings, but to performother transformations.=head2 'eval' modeWhen C<use re 'eval'> is in effect, a regex is allowed to containC<(?{ ... })> zero-width assertions even if regular expression containsvariable interpolation. That is normally disallowed, since it is apotential security risk. Note that this pragma is ignored when the regularexpression is obtained from tainted data, i.e. evaluation is alwaysdisallowed with tainted regular expressions. See L<perlre/(?{ code })>.For the purpose of this pragma, interpolation of precompiled regularexpressions (i.e., the result of C<qr//>) is I<not> considered variableinterpolation. Thus: /foo${pat}bar/I<is> allowed if $pat is a precompiled regular expression, evenif $pat contains C<(?{ ... })> assertions.=head2 'debug' modeWhen C<use re 'debug'> is in effect, perl emits debugging messages whencompiling and using regular expressions. The output is the same as thatobtained by running a C<-DDEBUGGING>-enabled perl interpreter with theB<-Dr> switch. It may be quite voluminous depending on the complexityof the match. Using C<debugcolor> instead of C<debug> enables aform of output that can be used to get a colorful display on terminalsthat understand termcap color sequences. Set C<$ENV{PERL_RE_TC}> to acomma-separated list of C<termcap> properties to use for highlightingstrings on/off, pre-point part on/off.See L<perldebug/"Debugging regular expressions"> for additional info.As of 5.9.5 the directive C<use re 'debug'> and its equivalents arelexically scoped, as the other directives are. However they have both compile-time and run-time effects.See L<perlmodlib/Pragmatic Modules>.=head2 'Debug' modeSimilarly C<use re 'Debug'> produces debugging output, the differencebeing that it allows the fine tuning of what debugging output will beemitted. Options are divided into three groups, those related tocompilation, those related to execution and those related to specialpurposes. The options are as follows:=over 4=item Compile related options=over 4=item COMPILETurns on all compile related debug options.=item PARSETurns on debug output related to the process of parsing the pattern.=item OPTIMISEEnables output related to the optimisation phase of compilation.=item TRIECDetailed info about trie compilation.=item DUMPDump the final program out after it is compiled and optimised.=back=item Execute related options=over 4=item EXECUTETurns on all execute related debug options.=item MATCHTurns on debugging of the main matching loop.=item TRIEEExtra debugging of how tries execute.=item INTUITEnable debugging of start point optimisations.=back=item Extra debugging options=over 4=item EXTRATurns on all "extra" debugging options.=item BUFFERSEnable debugging the capture buffer storage during match. Warning,this can potentially produce extremely large output.=item TRIEMEnable enhanced TRIE debugging. Enhances both TRIEEand TRIEC.=item STATEEnable debugging of states in the engine.=item STACKEnable debugging of the recursion stack in the engine. Enablingor disabling this option automatically does the same for debuggingstates as well. This output from this can be quite large.=item OPTIMISEMEnable enhanced optimisation debugging and start point optimisations.Probably not useful except when debugging the regex engine itself.=item OFFSETSDump offset information. This can be used to see how regops correlateto the pattern. Output format is NODENUM:POSITION[LENGTH]Where 1 is the position of the first char in the string. Note that positioncan be 0, or larger than the actual length of the pattern, likewise lengthcan be zero.=item OFFSETSDBGEnable debugging of offsets information. This emits copiousamounts of trace information and doesn't mesh well with otherdebug options.Almost definitely only useful to people hackingon the offsets part of the debug engine.=back=item Other useful flagsThese are useful shortcuts to save on the typing.=over 4=item ALLEnable all options at once except OFFSETS, OFFSETSDBG and BUFFERS=item AllEnable DUMP and all execute options. Equivalent to: use re 'debug';=item MORE=item MoreEnable TRIEM and all execute compile and execute options.=back=backAs of 5.9.5 the directive C<use re 'debug'> and its equivalents arelexically scoped, as the other directives are. However they have bothcompile-time and run-time effects.=head2 Exportable FunctionsAs of perl 5.9.5 're' debug contains a number of utility functions thatmay be optionally exported into the caller's namespace. They are listedbelow.=over 4=item is_regexp($ref)Returns true if the argument is a compiled regular expression as returnedby C<qr//>, false if it is not.This function will not be confused by overloading or blessing. Ininternals terms, this extracts the regexp pointer out of thePERL_MAGIC_qr structure so it it cannot be fooled.=item regexp_pattern($ref)If the argument is a compiled regular expression as returned by C<qr//>,then this function returns the pattern.In list context it returns a two element list, the first elementcontaining the pattern and the second containing the modifiers used whenthe pattern was compiled. my ($pat, $mods) = regexp_pattern($ref);In scalar context it returns the same as perl would when strigifying a rawC<qr//> with the same pattern inside. If the argument is not a compiledreference then this routine returns false but defined in scalar context,and the empty list in list context. Thus the following if (regexp_pattern($ref) eq '(?i-xsm:foo)')will be warning free regardless of what $ref actually is.Like C<is_regexp> this function will not be confused by overloadingor blessing of the object.=item regmust($ref)If the argument is a compiled regular expression as returned by C<qr//>,then this function returns what the optimiser consiers to be the longestanchored fixed string and longest floating fixed string in the pattern.A I<fixed string> is defined as being a substring that must appear for thepattern to match. An I<anchored fixed string> is a fixed string that mustappear at a particular offset from the beginning of the match. A I<floatingfixed string> is defined as a fixed string that can appear at any point ina range of positions relative to the start of the match. For example, my $qr = qr/here .* there/x; my ($anchored, $floating) = regmust($qr); print "anchored:'$anchored'\nfloating:'$floating'\n";results in anchored:'here' floating:'there'Because the C<here> is before the C<.*> in the pattern, its positioncan be determined exactly. That's not true, however, for the C<there>;it could appear at any point after where the anchored string appeared.Perl uses both for its optimisations, prefering the longer, or, if they areequal, the floating.B<NOTE:> This may not necessarily be the definitive longest anchored andfloating string. This will be what the optimiser of the Perl that youare using thinks is the longest. If you believe that the result is wrongplease report it via the L<perlbug> utility.=item regname($name,$all)Returns the contents of a named buffer of the last successful match. If$all is true, then returns an array ref containing one entry per buffer,otherwise returns the first defined buffer.=item regnames($all)Returns a list of all of the named buffers defined in the last successfulmatch. If $all is true, then it returns all names defined, if not it returnsonly names which were involved in the match.=item regnames_count()Returns the number of distinct names defined in the pattern usedfor the last successful match.B<Note:> this result is always the actual number of distinctnamed buffers defined, it may not actually match that which isreturned by C<regnames()> and related routines when those routineshave not been called with the $all parameter set.=back=head1 SEE ALSOL<perlmodlib/Pragmatic Modules>.=cut
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -