This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldebug: capitalise titles
[perl5.git] / ext / re / re.pm
1 package re;
2
3 # pragma for controlling the regexp engine
4 use strict;
5 use warnings;
6
7 our $VERSION     = "0.16";
8 our @ISA         = qw(Exporter);
9 our @EXPORT_OK   = ('regmust',
10                     qw(is_regexp regexp_pattern
11                        regname regnames regnames_count));
12 our %EXPORT_OK = map { $_ => 1 } @EXPORT_OK;
13
14 my %bitmask = (
15     taint   => 0x00100000, # HINT_RE_TAINT
16     eval    => 0x00200000, # HINT_RE_EVAL
17 );
18
19 my $flags_hint = 0x02000000; # HINT_RE_FLAGS
20 my $PMMOD_SHIFT = 0;
21 my %reflags = (
22     m => 1 << ($PMMOD_SHIFT + 0),
23     s => 1 << ($PMMOD_SHIFT + 1),
24     i => 1 << ($PMMOD_SHIFT + 2),
25     x => 1 << ($PMMOD_SHIFT + 3),
26     p => 1 << ($PMMOD_SHIFT + 4),
27 # special cases:
28     d => 0,
29     l => 1,
30     u => 2,
31     a => 3,
32 );
33
34 sub setcolor {
35  eval {                         # Ignore errors
36   require Term::Cap;
37
38   my $terminal = Tgetent Term::Cap ({OSPEED => 9600}); # Avoid warning.
39   my $props = $ENV{PERL_RE_TC} || 'md,me,so,se,us,ue';
40   my @props = split /,/, $props;
41   my $colors = join "\t", map {$terminal->Tputs($_,1)} @props;
42
43   $colors =~ s/\0//g;
44   $ENV{PERL_RE_COLORS} = $colors;
45  };
46  if ($@) {
47     $ENV{PERL_RE_COLORS} ||= qq'\t\t> <\t> <\t\t';
48  }
49
50 }
51
52 my %flags = (
53     COMPILE         => 0x0000FF,
54     PARSE           => 0x000001,
55     OPTIMISE        => 0x000002,
56     TRIEC           => 0x000004,
57     DUMP            => 0x000008,
58     FLAGS           => 0x000010,
59
60     EXECUTE         => 0x00FF00,
61     INTUIT          => 0x000100,
62     MATCH           => 0x000200,
63     TRIEE           => 0x000400,
64
65     EXTRA           => 0xFF0000,
66     TRIEM           => 0x010000,
67     OFFSETS         => 0x020000,
68     OFFSETSDBG      => 0x040000,
69     STATE           => 0x080000,
70     OPTIMISEM       => 0x100000,
71     STACK           => 0x280000,
72     BUFFERS         => 0x400000,
73     GPOS            => 0x800000,
74 );
75 $flags{ALL} = -1 & ~($flags{OFFSETS}|$flags{OFFSETSDBG}|$flags{BUFFERS});
76 $flags{All} = $flags{all} = $flags{DUMP} | $flags{EXECUTE};
77 $flags{Extra} = $flags{EXECUTE} | $flags{COMPILE} | $flags{GPOS};
78 $flags{More} = $flags{MORE} = $flags{All} | $flags{TRIEC} | $flags{TRIEM} | $flags{STATE};
79 $flags{State} = $flags{DUMP} | $flags{EXECUTE} | $flags{STATE};
80 $flags{TRIE} = $flags{DUMP} | $flags{EXECUTE} | $flags{TRIEC};
81
82 if (defined &DynaLoader::boot_DynaLoader) {
83     require XSLoader;
84     XSLoader::load();
85 }
86 # else we're miniperl
87 # We need to work for miniperl, because the XS toolchain uses Text::Wrap, which
88 # uses re 'taint'.
89
90 sub _load_unload {
91     my ($on)= @_;
92     if ($on) {
93         # We call install() every time, as if we didn't, we wouldn't
94         # "see" any changes to the color environment var since
95         # the last time it was called.
96
97         # install() returns an integer, which if casted properly
98         # in C resolves to a structure containing the regexp
99         # hooks. Setting it to a random integer will guarantee
100         # segfaults.
101         $^H{regcomp} = install();
102     } else {
103         delete $^H{regcomp};
104     }
105 }
106
107 sub bits {
108     my $on = shift;
109     my $bits = 0;
110     unless (@_) {
111         require Carp;
112         Carp::carp("Useless use of \"re\" pragma"); 
113     }
114    ARG:
115     foreach my $idx (0..$#_){
116         my $s=$_[$idx];
117         if ($s eq 'Debug' or $s eq 'Debugcolor') {
118             setcolor() if $s =~/color/i;
119             ${^RE_DEBUG_FLAGS} = 0 unless defined ${^RE_DEBUG_FLAGS};
120             for my $idx ($idx+1..$#_) {
121                 if ($flags{$_[$idx]}) {
122                     if ($on) {
123                         ${^RE_DEBUG_FLAGS} |= $flags{$_[$idx]};
124                     } else {
125                         ${^RE_DEBUG_FLAGS} &= ~ $flags{$_[$idx]};
126                     }
127                 } else {
128                     require Carp;
129                     Carp::carp("Unknown \"re\" Debug flag '$_[$idx]', possible flags: ",
130                                join(", ",sort keys %flags ) );
131                 }
132             }
133             _load_unload($on ? 1 : ${^RE_DEBUG_FLAGS});
134             last;
135         } elsif ($s eq 'debug' or $s eq 'debugcolor') {
136             setcolor() if $s =~/color/i;
137             _load_unload($on);
138             last;
139         } elsif (exists $bitmask{$s}) {
140             $bits |= $bitmask{$s};
141         } elsif ($EXPORT_OK{$s}) {
142             require Exporter;
143             re->export_to_level(2, 're', $s);
144         } elsif ($s =~ s/^\///) {
145             my $reflags = $^H{reflags} || 0;
146             my $seen_charset;
147             for(split//, $s) {
148                 if (/[adul]/) {
149                     if ($on) {
150                         if ($seen_charset && $seen_charset ne $_) {
151                             require Carp;
152                             Carp::carp(
153                               qq 'The "$seen_charset" and "$_" flags '
154                              .qq 'are exclusive'
155                             );
156                         }
157                         $^H{reflags_charset} = $reflags{$_};
158                         $seen_charset = $_;
159                     }
160                     else {
161                         delete $^H{reflags_charset}
162                          if  defined $^H{reflags_charset}
163                           && $^H{reflags_charset} == $reflags{$_};
164                     }
165                 } elsif (exists $reflags{$_}) {
166                     $on
167                       ? $reflags |= $reflags{$_}
168                       : ($reflags &= ~$reflags{$_});
169                 } else {
170                     require Carp;
171                     Carp::carp(
172                      qq'Unknown regular expression flag "$_"'
173                     );
174                     next ARG;
175                 }
176             }
177             ($^H{reflags} = $reflags or defined $^H{reflags_charset})
178              ? $^H |= $flags_hint
179              : ($^H &= ~$flags_hint);
180         } else {
181             require Carp;
182             Carp::carp("Unknown \"re\" subpragma '$s' (known ones are: ",
183                        join(', ', map {qq('$_')} 'debug', 'debugcolor', sort keys %bitmask),
184                        ")");
185         }
186     }
187     $bits;
188 }
189
190 sub import {
191     shift;
192     $^H |= bits(1, @_);
193 }
194
195 sub unimport {
196     shift;
197     $^H &= ~ bits(0, @_);
198 }
199
200 1;
201
202 __END__
203
204 =head1 NAME
205
206 re - Perl pragma to alter regular expression behaviour
207
208 =head1 SYNOPSIS
209
210     use re 'taint';
211     ($x) = ($^X =~ /^(.*)$/s);     # $x is tainted here
212
213     $pat = '(?{ $foo = 1 })';
214     use re 'eval';
215     /foo${pat}bar/;                # won't fail (when not under -T switch)
216
217     {
218         no re 'taint';             # the default
219         ($x) = ($^X =~ /^(.*)$/s); # $x is not tainted here
220
221         no re 'eval';              # the default
222         /foo${pat}bar/;            # disallowed (with or without -T switch)
223     }
224
225     use re '/ix';
226     "FOO" =~ / foo /; # /ix implied
227     no re '/x';
228     "FOO" =~ /foo/; # just /i implied
229
230     use re 'debug';                # output debugging info during
231     /^(.*)$/s;                     #     compile and run time
232
233
234     use re 'debugcolor';           # same as 'debug', but with colored output
235     ...
236
237     use re qw(Debug All);          # Finer tuned debugging options.
238     use re qw(Debug More);
239     no re qw(Debug ALL);           # Turn of all re debugging in this scope
240
241     use re qw(is_regexp regexp_pattern); # import utility functions
242     my ($pat,$mods)=regexp_pattern(qr/foo/i);
243     if (is_regexp($obj)) { 
244         print "Got regexp: ",
245             scalar regexp_pattern($obj); # just as perl would stringify it
246     }                                    # but no hassle with blessed re's.
247
248 (We use $^X in these examples because it's tainted by default.)
249
250 =head1 DESCRIPTION
251
252 =head2 'taint' mode
253
254 When C<use re 'taint'> is in effect, and a tainted string is the target
255 of a regexp, the regexp memories (or values returned by the m// operator
256 in list context) are tainted.  This feature is useful when regexp operations
257 on tainted data aren't meant to extract safe substrings, but to perform
258 other transformations.
259
260 =head2 'eval' mode
261
262 When C<use re 'eval'> is in effect, a regexp is allowed to contain
263 C<(?{ ... })> zero-width assertions and C<(??{ ... })> postponed
264 subexpressions, even if the regular expression contains
265 variable interpolation.  That is normally disallowed, since it is a
266 potential security risk.  Note that this pragma is ignored when the regular
267 expression is obtained from tainted data, i.e.  evaluation is always
268 disallowed with tainted regular expressions.  See L<perlre/(?{ code })> 
269 and L<perlre/(??{ code })>.
270
271 For the purpose of this pragma, interpolation of precompiled regular
272 expressions (i.e., the result of C<qr//>) is I<not> considered variable
273 interpolation.  Thus:
274
275     /foo${pat}bar/
276
277 I<is> allowed if $pat is a precompiled regular expression, even
278 if $pat contains C<(?{ ... })> assertions or C<(??{ ... })> subexpressions.
279
280 =head2 '/flags' mode
281
282 When C<use re '/flags'> is specified, the given flags are automatically
283 added to every regular expression till the end of the lexical scope.
284
285 C<no re '/flags'> will turn off the effect of C<use re '/flags'> for the
286 given flags.
287
288 For example, if you want all your regular expressions to have /msx on by
289 default, simply put
290
291     use re '/msx';
292
293 at the top of your code.
294
295 The character set /adul flags cancel each other out. So, in this example,
296
297     use re "/u";
298     "ss" =~ /\xdf/;
299     use re "/d";
300     "ss" =~ /\xdf/;
301
302 the second C<use re> does an implicit C<no re '/u'>.
303
304 Turning on one of the character set flags with C<use re> takes precedence over the
305 C<locale> pragma and the 'unicode_strings' C<feature>, for regular
306 expressions. Turning off one of these flags when it is active reverts to
307 the behaviour specified by whatever other pragmata are in scope. For
308 example:
309
310     use feature "unicode_strings";
311     no re "/u"; # does nothing
312     use re "/l";
313     no re "/l"; # reverts to unicode_strings behaviour
314
315 =head2 'debug' mode
316
317 When C<use re 'debug'> is in effect, perl emits debugging messages when
318 compiling and using regular expressions.  The output is the same as that
319 obtained by running a C<-DDEBUGGING>-enabled perl interpreter with the
320 B<-Dr> switch. It may be quite voluminous depending on the complexity
321 of the match.  Using C<debugcolor> instead of C<debug> enables a
322 form of output that can be used to get a colorful display on terminals
323 that understand termcap color sequences.  Set C<$ENV{PERL_RE_TC}> to a
324 comma-separated list of C<termcap> properties to use for highlighting
325 strings on/off, pre-point part on/off.
326 See L<perldebug/"Debugging Regular Expressions"> for additional info.
327
328 As of 5.9.5 the directive C<use re 'debug'> and its equivalents are
329 lexically scoped, as the other directives are.  However they have both 
330 compile-time and run-time effects.
331
332 See L<perlmodlib/Pragmatic Modules>.
333
334 =head2 'Debug' mode
335
336 Similarly C<use re 'Debug'> produces debugging output, the difference
337 being that it allows the fine tuning of what debugging output will be
338 emitted. Options are divided into three groups, those related to
339 compilation, those related to execution and those related to special
340 purposes. The options are as follows:
341
342 =over 4
343
344 =item Compile related options
345
346 =over 4
347
348 =item COMPILE
349
350 Turns on all compile related debug options.
351
352 =item PARSE
353
354 Turns on debug output related to the process of parsing the pattern.
355
356 =item OPTIMISE
357
358 Enables output related to the optimisation phase of compilation.
359
360 =item TRIEC
361
362 Detailed info about trie compilation.
363
364 =item DUMP
365
366 Dump the final program out after it is compiled and optimised.
367
368 =back
369
370 =item Execute related options
371
372 =over 4
373
374 =item EXECUTE
375
376 Turns on all execute related debug options.
377
378 =item MATCH
379
380 Turns on debugging of the main matching loop.
381
382 =item TRIEE
383
384 Extra debugging of how tries execute.
385
386 =item INTUIT
387
388 Enable debugging of start point optimisations.
389
390 =back
391
392 =item Extra debugging options
393
394 =over 4
395
396 =item EXTRA
397
398 Turns on all "extra" debugging options.
399
400 =item BUFFERS
401
402 Enable debugging the capture group storage during match. Warning,
403 this can potentially produce extremely large output.
404
405 =item TRIEM
406
407 Enable enhanced TRIE debugging. Enhances both TRIEE
408 and TRIEC.
409
410 =item STATE
411
412 Enable debugging of states in the engine.
413
414 =item STACK
415
416 Enable debugging of the recursion stack in the engine. Enabling
417 or disabling this option automatically does the same for debugging
418 states as well. This output from this can be quite large.
419
420 =item OPTIMISEM
421
422 Enable enhanced optimisation debugging and start point optimisations.
423 Probably not useful except when debugging the regexp engine itself.
424
425 =item OFFSETS
426
427 Dump offset information. This can be used to see how regops correlate
428 to the pattern. Output format is
429
430    NODENUM:POSITION[LENGTH]
431
432 Where 1 is the position of the first char in the string. Note that position
433 can be 0, or larger than the actual length of the pattern, likewise length
434 can be zero.
435
436 =item OFFSETSDBG
437
438 Enable debugging of offsets information. This emits copious
439 amounts of trace information and doesn't mesh well with other
440 debug options.
441
442 Almost definitely only useful to people hacking
443 on the offsets part of the debug engine.
444
445 =back
446
447 =item Other useful flags
448
449 These are useful shortcuts to save on the typing.
450
451 =over 4
452
453 =item ALL
454
455 Enable all options at once except OFFSETS, OFFSETSDBG and BUFFERS
456
457 =item All
458
459 Enable DUMP and all execute options. Equivalent to:
460
461   use re 'debug';
462
463 =item MORE
464
465 =item More
466
467 Enable TRIEM and all execute compile and execute options.
468
469 =back
470
471 =back
472
473 As of 5.9.5 the directive C<use re 'debug'> and its equivalents are
474 lexically scoped, as the other directives are.  However they have both
475 compile-time and run-time effects.
476
477 =head2 Exportable Functions
478
479 As of perl 5.9.5 're' debug contains a number of utility functions that
480 may be optionally exported into the caller's namespace. They are listed
481 below.
482
483 =over 4
484
485 =item is_regexp($ref)
486
487 Returns true if the argument is a compiled regular expression as returned
488 by C<qr//>, false if it is not.
489
490 This function will not be confused by overloading or blessing. In
491 internals terms, this extracts the regexp pointer out of the
492 PERL_MAGIC_qr structure so it cannot be fooled.
493
494 =item regexp_pattern($ref)
495
496 If the argument is a compiled regular expression as returned by C<qr//>,
497 then this function returns the pattern.
498
499 In list context it returns a two element list, the first element
500 containing the pattern and the second containing the modifiers used when
501 the pattern was compiled.
502
503   my ($pat, $mods) = regexp_pattern($ref);
504
505 In scalar context it returns the same as perl would when stringifying a raw
506 C<qr//> with the same pattern inside.  If the argument is not a compiled
507 reference then this routine returns false but defined in scalar context,
508 and the empty list in list context. Thus the following
509
510     if (regexp_pattern($ref) eq '(?^i:foo)')
511
512 will be warning free regardless of what $ref actually is.
513
514 Like C<is_regexp> this function will not be confused by overloading
515 or blessing of the object.
516
517 =item regmust($ref)
518
519 If the argument is a compiled regular expression as returned by C<qr//>,
520 then this function returns what the optimiser considers to be the longest
521 anchored fixed string and longest floating fixed string in the pattern.
522
523 A I<fixed string> is defined as being a substring that must appear for the
524 pattern to match. An I<anchored fixed string> is a fixed string that must
525 appear at a particular offset from the beginning of the match. A I<floating
526 fixed string> is defined as a fixed string that can appear at any point in
527 a range of positions relative to the start of the match. For example,
528
529     my $qr = qr/here .* there/x;
530     my ($anchored, $floating) = regmust($qr);
531     print "anchored:'$anchored'\nfloating:'$floating'\n";
532
533 results in
534
535     anchored:'here'
536     floating:'there'
537
538 Because the C<here> is before the C<.*> in the pattern, its position
539 can be determined exactly. That's not true, however, for the C<there>;
540 it could appear at any point after where the anchored string appeared.
541 Perl uses both for its optimisations, prefering the longer, or, if they are
542 equal, the floating.
543
544 B<NOTE:> This may not necessarily be the definitive longest anchored and
545 floating string. This will be what the optimiser of the Perl that you
546 are using thinks is the longest. If you believe that the result is wrong
547 please report it via the L<perlbug> utility.
548
549 =item regname($name,$all)
550
551 Returns the contents of a named buffer of the last successful match. If
552 $all is true, then returns an array ref containing one entry per buffer,
553 otherwise returns the first defined buffer.
554
555 =item regnames($all)
556
557 Returns a list of all of the named buffers defined in the last successful
558 match. If $all is true, then it returns all names defined, if not it returns
559 only names which were involved in the match.
560
561 =item regnames_count()
562
563 Returns the number of distinct names defined in the pattern used
564 for the last successful match.
565
566 B<Note:> this result is always the actual number of distinct
567 named buffers defined, it may not actually match that which is
568 returned by C<regnames()> and related routines when those routines
569 have not been called with the $all parameter set.
570
571 =back
572
573 =head1 SEE ALSO
574
575 L<perlmodlib/Pragmatic Modules>.
576
577 =cut