home *** CD-ROM | disk | FTP | other *** search
/ PC World 2003 March / PCWorld_2003-03_cd.bin / Software / Topware / activeperl / ActivePerl / Perl / bin / splain.bat < prev    next >
Encoding:
DOS Batch File  |  2002-12-01  |  15.6 KB  |  598 lines
  1. @rem = '--*-Perl-*--
  2. @echo off
  3. if "%OS%" == "Windows_NT" goto WinNT
  4. perl -x -S "%0" %1 %2 %3 %4 %5 %6 %7 %8 %9
  5. goto endofperl
  6. :WinNT
  7. perl -x -S %0 %*
  8. if NOT "%COMSPEC%" == "%SystemRoot%\system32\cmd.exe" goto endofperl
  9. if %errorlevel% == 9009 echo You do not have Perl in your PATH.
  10. if errorlevel 1 goto script_failed_so_exit_with_non_zero_val 2>nul
  11. goto endofperl
  12. @rem ';
  13. #!perl
  14. #line 15
  15.     eval 'exec D:\p4\Apps\Gecko\MSI\data\ActivePerl\Perl\bin\perl.exe -S $0 ${1+"$@"}'
  16.     if $running_under_some_shell;
  17.  
  18. =head1 NAME
  19.  
  20. diagnostics - Perl compiler pragma to force verbose warning diagnostics
  21.  
  22. splain - standalone program to do the same thing
  23.  
  24. =head1 SYNOPSIS
  25.  
  26. As a pragma:
  27.  
  28.     use diagnostics;
  29.     use diagnostics -verbose;
  30.  
  31.     enable  diagnostics;
  32.     disable diagnostics;
  33.  
  34. Aa a program:
  35.  
  36.     perl program 2>diag.out
  37.     splain [-v] [-p] diag.out
  38.  
  39.  
  40. =head1 DESCRIPTION
  41.  
  42. =head2 The C<diagnostics> Pragma
  43.  
  44. This module extends the terse diagnostics normally emitted by both the
  45. perl compiler and the perl interpreter, augmenting them with the more
  46. explicative and endearing descriptions found in L<perldiag>.  Like the
  47. other pragmata, it affects the compilation phase of your program rather
  48. than merely the execution phase.
  49.  
  50. To use in your program as a pragma, merely invoke
  51.  
  52.     use diagnostics;
  53.  
  54. at the start (or near the start) of your program.  (Note 
  55. that this I<does> enable perl's B<-w> flag.)  Your whole
  56. compilation will then be subject(ed :-) to the enhanced diagnostics.
  57. These still go out B<STDERR>.
  58.  
  59. Due to the interaction between runtime and compiletime issues,
  60. and because it's probably not a very good idea anyway,
  61. you may not use C<no diagnostics> to turn them off at compiletime.
  62. However, you may control their behaviour at runtime using the 
  63. disable() and enable() methods to turn them off and on respectively.
  64.  
  65. The B<-verbose> flag first prints out the L<perldiag> introduction before
  66. any other diagnostics.  The $diagnostics::PRETTY variable can generate nicer
  67. escape sequences for pagers.
  68.  
  69. Warnings dispatched from perl itself (or more accurately, those that match
  70. descriptions found in L<perldiag>) are only displayed once (no duplicate
  71. descriptions).  User code generated warnings ala warn() are unaffected,
  72. allowing duplicate user messages to be displayed.
  73.  
  74. =head2 The I<splain> Program
  75.  
  76. While apparently a whole nuther program, I<splain> is actually nothing
  77. more than a link to the (executable) F<diagnostics.pm> module, as well as
  78. a link to the F<diagnostics.pod> documentation.  The B<-v> flag is like
  79. the C<use diagnostics -verbose> directive.
  80. The B<-p> flag is like the
  81. $diagnostics::PRETTY variable.  Since you're post-processing with 
  82. I<splain>, there's no sense in being able to enable() or disable() processing.
  83.  
  84. Output from I<splain> is directed to B<STDOUT>, unlike the pragma.
  85.  
  86. =head1 EXAMPLES
  87.  
  88. The following file is certain to trigger a few errors at both
  89. runtime and compiletime:
  90.  
  91.     use diagnostics;
  92.     print NOWHERE "nothing\n";
  93.     print STDERR "\n\tThis message should be unadorned.\n";
  94.     warn "\tThis is a user warning";
  95.     print "\nDIAGNOSTIC TESTER: Please enter a <CR> here: ";
  96.     my $a, $b = scalar <STDIN>;
  97.     print "\n";
  98.     print $x/$y;
  99.  
  100. If you prefer to run your program first and look at its problem
  101. afterwards, do this:
  102.  
  103.     perl -w test.pl 2>test.out
  104.     ./splain < test.out
  105.  
  106. Note that this is not in general possible in shells of more dubious heritage, 
  107. as the theoretical 
  108.  
  109.     (perl -w test.pl >/dev/tty) >& test.out
  110.     ./splain < test.out
  111.  
  112. Because you just moved the existing B<stdout> to somewhere else.
  113.  
  114. If you don't want to modify your source code, but still have on-the-fly
  115. warnings, do this:
  116.  
  117.     exec 3>&1; perl -w test.pl 2>&1 1>&3 3>&- | splain 1>&2 3>&- 
  118.  
  119. Nifty, eh?
  120.  
  121. If you want to control warnings on the fly, do something like this.
  122. Make sure you do the C<use> first, or you won't be able to get
  123. at the enable() or disable() methods.
  124.  
  125.     use diagnostics; # checks entire compilation phase 
  126.     print "\ntime for 1st bogus diags: SQUAWKINGS\n";
  127.     print BOGUS1 'nada';
  128.     print "done with 1st bogus\n";
  129.  
  130.     disable diagnostics; # only turns off runtime warnings
  131.     print "\ntime for 2nd bogus: (squelched)\n";
  132.     print BOGUS2 'nada';
  133.     print "done with 2nd bogus\n";
  134.  
  135.     enable diagnostics; # turns back on runtime warnings
  136.     print "\ntime for 3rd bogus: SQUAWKINGS\n";
  137.     print BOGUS3 'nada';
  138.     print "done with 3rd bogus\n";
  139.  
  140.     disable diagnostics;
  141.     print "\ntime for 4th bogus: (squelched)\n";
  142.     print BOGUS4 'nada';
  143.     print "done with 4th bogus\n";
  144.  
  145. =head1 INTERNALS
  146.  
  147. Diagnostic messages derive from the F<perldiag.pod> file when available at
  148. runtime.  Otherwise, they may be embedded in the file itself when the
  149. splain package is built.   See the F<Makefile> for details.
  150.  
  151. If an extant $SIG{__WARN__} handler is discovered, it will continue
  152. to be honored, but only after the diagnostics::splainthis() function 
  153. (the module's $SIG{__WARN__} interceptor) has had its way with your
  154. warnings.
  155.  
  156. There is a $diagnostics::DEBUG variable you may set if you're desperately
  157. curious what sorts of things are being intercepted.
  158.  
  159.     BEGIN { $diagnostics::DEBUG = 1 } 
  160.  
  161.  
  162. =head1 BUGS
  163.  
  164. Not being able to say "no diagnostics" is annoying, but may not be
  165. insurmountable.
  166.  
  167. The C<-pretty> directive is called too late to affect matters.
  168. You have to do this instead, and I<before> you load the module.
  169.  
  170.     BEGIN { $diagnostics::PRETTY = 1 } 
  171.  
  172. I could start up faster by delaying compilation until it should be
  173. needed, but this gets a "panic: top_level" when using the pragma form
  174. in Perl 5.001e.
  175.  
  176. While it's true that this documentation is somewhat subserious, if you use
  177. a program named I<splain>, you should expect a bit of whimsy.
  178.  
  179. =head1 AUTHOR
  180.  
  181. Tom Christiansen <F<tchrist@mox.perl.com>>, 25 June 1995.
  182.  
  183. =cut
  184.  
  185. use strict;
  186. use 5.006;
  187. use Carp;
  188.  
  189. our $VERSION = 1.1;
  190. our $DEBUG;
  191. our $VERBOSE;
  192. our $PRETTY;
  193.  
  194. use Config;
  195. my($privlib, $archlib) = @Config{qw(privlibexp archlibexp)};
  196. if ($^O eq 'VMS') {
  197.     require VMS::Filespec;
  198.     $privlib = VMS::Filespec::unixify($privlib);
  199.     $archlib = VMS::Filespec::unixify($archlib);
  200. }
  201. my @trypod = (
  202.        "$archlib/pod/perldiag.pod",
  203.        "$privlib/pod/perldiag-$Config{version}.pod",
  204.        "$privlib/pod/perldiag.pod",
  205.        "$archlib/pods/perldiag.pod",
  206.        "$privlib/pods/perldiag-$Config{version}.pod",
  207.        "$privlib/pods/perldiag.pod",
  208.       );
  209. # handy for development testing of new warnings etc
  210. unshift @trypod, "./pod/perldiag.pod" if -e "pod/perldiag.pod";
  211. (my $PODFILE) = ((grep { -e } @trypod), $trypod[$#trypod])[0];
  212.  
  213. if ($^O eq 'MacOS') {
  214.     # just updir one from each lib dir, we'll find it ...
  215.     ($PODFILE) = grep { -e } map { "$_:pod:perldiag.pod" } @INC;
  216. }
  217.  
  218.  
  219. $DEBUG ||= 0;
  220. my $WHOAMI = ref bless [];  # nobody's business, prolly not even mine
  221.  
  222. local $| = 1;
  223. local $_;
  224.  
  225. my $standalone;
  226. my(%HTML_2_Troff, %HTML_2_Latin_1, %HTML_2_ASCII_7);
  227.  
  228. CONFIG: {
  229.     our $opt_p = our $opt_d = our $opt_v = our $opt_f = '';
  230.  
  231.     unless (caller) {
  232.     $standalone++;
  233.     require Getopt::Std;
  234.     Getopt::Std::getopts('pdvf:')
  235.         or die "Usage: $0 [-v] [-p] [-f splainpod]";
  236.     $PODFILE = $opt_f if $opt_f;
  237.     $DEBUG = 2 if $opt_d;
  238.     $VERBOSE = $opt_v;
  239.     $PRETTY = $opt_p;
  240.     }
  241.  
  242.     if (open(POD_DIAG, $PODFILE)) {
  243.     warn "Happy happy podfile from real $PODFILE\n" if $DEBUG;
  244.     last CONFIG;
  245.     } 
  246.  
  247.     if (caller) {
  248.     INCPATH: {
  249.         for my $file ( (map { "$_/$WHOAMI.pm" } @INC), $0) {
  250.         warn "Checking $file\n" if $DEBUG;
  251.         if (open(POD_DIAG, $file)) {
  252.             while (<POD_DIAG>) {
  253.             next unless
  254.                 /^__END__\s*# wish diag dbase were more accessible/;
  255.             print STDERR "podfile is $file\n" if $DEBUG;
  256.             last INCPATH;
  257.             }
  258.         }
  259.         } 
  260.     }
  261.     } else { 
  262.     print STDERR "podfile is <DATA>\n" if $DEBUG;
  263.     *POD_DIAG = *main::DATA;
  264.     }
  265. }
  266. if (eof(POD_DIAG)) { 
  267.     die "couldn't find diagnostic data in $PODFILE @INC $0";
  268. }
  269.  
  270.  
  271. %HTML_2_Troff = (
  272.     'amp'    =>    '&',    #   ampersand
  273.     'lt'    =>    '<',    #   left chevron, less-than
  274.     'gt'    =>    '>',    #   right chevron, greater-than
  275.     'quot'    =>    '"',    #   double quote
  276.  
  277.     "Aacute"    =>    "A\\*'",    #   capital A, acute accent
  278.     # etc
  279.  
  280. );
  281.  
  282. %HTML_2_Latin_1 = (
  283.     'amp'    =>    '&',    #   ampersand
  284.     'lt'    =>    '<',    #   left chevron, less-than
  285.     'gt'    =>    '>',    #   right chevron, greater-than
  286.     'quot'    =>    '"',    #   double quote
  287.  
  288.     "Aacute"    =>    "\xC1"    #   capital A, acute accent
  289.  
  290.     # etc
  291. );
  292.  
  293. %HTML_2_ASCII_7 = (
  294.     'amp'    =>    '&',    #   ampersand
  295.     'lt'    =>    '<',    #   left chevron, less-than
  296.     'gt'    =>    '>',    #   right chevron, greater-than
  297.     'quot'    =>    '"',    #   double quote
  298.  
  299.     "Aacute"    =>    "A"    #   capital A, acute accent
  300.     # etc
  301. );
  302.  
  303. our %HTML_Escapes;
  304. *HTML_Escapes = do {
  305.     if ($standalone) {
  306.     $PRETTY ? \%HTML_2_Latin_1 : \%HTML_2_ASCII_7; 
  307.     } else {
  308.     \%HTML_2_Latin_1; 
  309.     }
  310. }; 
  311.  
  312. *THITHER = $standalone ? *STDOUT : *STDERR;
  313.  
  314. my $transmo = <<EOFUNC;
  315. sub transmo {
  316.     #local \$^W = 0;  # recursive warnings we do NOT need!
  317.     study;
  318. EOFUNC
  319.  
  320. my %msg;
  321. {
  322.     print STDERR "FINISHING COMPILATION for $_\n" if $DEBUG;
  323.     local $/ = '';
  324.     local $_;
  325.     my $header;
  326.     my $for_item;
  327.     while (<POD_DIAG>) {
  328.  
  329.     unescape();
  330.     if ($PRETTY) {
  331.         sub noop   { return $_[0] }  # spensive for a noop
  332.         sub bold   { my $str =$_[0];  $str =~ s/(.)/$1\b$1/g; return $str; } 
  333.         sub italic { my $str = $_[0]; $str =~ s/(.)/_\b$1/g;  return $str; } 
  334.         s/[BC]<(.*?)>/bold($1)/ges;
  335.         s/[LIF]<(.*?)>/italic($1)/ges;
  336.     } else {
  337.         s/[BC]<(.*?)>/$1/gs;
  338.         s/[LIF]<(.*?)>/$1/gs;
  339.     } 
  340.     unless (/^=/) {
  341.         if (defined $header) { 
  342.         if ( $header eq 'DESCRIPTION' && 
  343.             (   /Optional warnings are enabled/ 
  344.              || /Some of these messages are generic./
  345.             ) )
  346.         {
  347.             next;
  348.         } 
  349.         s/^/    /gm;
  350.         $msg{$header} .= $_;
  351.          undef $for_item;    
  352.         }
  353.         next;
  354.     } 
  355.     unless ( s/=item (.*?)\s*\z//) {
  356.  
  357.         if ( s/=head1\sDESCRIPTION//) {
  358.         $msg{$header = 'DESCRIPTION'} = '';
  359.         undef $for_item;
  360.         }
  361.         elsif( s/^=for\s+diagnostics\s*\n(.*?)\s*\z// ) {
  362.         $for_item = $1;
  363.         } 
  364.         next;
  365.     }
  366.  
  367.     if( $for_item ) { $header = $for_item; undef $for_item } 
  368.     else {
  369.         $header = $1;
  370.         while( $header =~ /[;,]\z/ ) {
  371.         <POD_DIAG> =~ /^\s*(.*?)\s*\z/;
  372.         $header .= ' '.$1;
  373.         }
  374.     }
  375.  
  376.     # strip formatting directives in =item line
  377.     $header =~ s/[A-Z]<(.*?)>/$1/g;
  378.  
  379.     if ($header =~ /%[csd]/) {
  380.         my $rhs = my $lhs = $header;
  381.         if ($lhs =~ s/(.*?)%d(?!%d)(.*)/\Q$1\E-?\\d+\Q$2\E/g)  {
  382.         $lhs =~ s/\\%s/.*?/g;
  383.         } else {
  384.         # if i had lookbehind negations,
  385.         # i wouldn't have to do this \377 noise
  386.         $lhs =~ s/(.*?)%s/\Q$1\E.*?\377/g;
  387.         $lhs =~ s/\377([^\377]*)$/\Q$1\E/;
  388.         $lhs =~ s/\377//g;
  389.         $lhs =~ s/\.\*\?$/.*/; # Allow %s at the end to eat it all
  390.         } 
  391.         $lhs =~ s/\\%c/./g;
  392.         $transmo .= "    s{^$lhs}\n     {\Q$rhs\E}s\n\t&& return 1;\n";
  393.     } else {
  394.         $transmo .= "    m{^\Q$header\E} && return 1;\n";
  395.     } 
  396.  
  397.     print STDERR "$WHOAMI: Duplicate entry: \"$header\"\n"
  398.         if $msg{$header};
  399.  
  400.     $msg{$header} = '';
  401.     } 
  402.  
  403.  
  404.     close POD_DIAG unless *main::DATA eq *POD_DIAG;
  405.  
  406.     die "No diagnostics?" unless %msg;
  407.  
  408.     $transmo .= "    return 0;\n}\n";
  409.     print STDERR $transmo if $DEBUG;
  410.     eval $transmo;
  411.     die $@ if $@;
  412. }
  413.  
  414. if ($standalone) {
  415.     if (!@ARGV and -t STDIN) { print STDERR "$0: Reading from STDIN\n" } 
  416.     while (defined (my $error = <>)) {
  417.     splainthis($error) || print THITHER $error;
  418.     } 
  419.     exit;
  420. } 
  421.  
  422. my $olddie;
  423. my $oldwarn;
  424.  
  425. sub import {
  426.     shift;
  427.     $^W = 1; # yup, clobbered the global variable; 
  428.          # tough, if you want diags, you want diags.
  429.     return if defined $SIG{__WARN__} && ($SIG{__WARN__} eq \&warn_trap);
  430.  
  431.     for (@_) {
  432.  
  433.     /^-d(ebug)?$/            && do {
  434.                     $DEBUG++;
  435.                     next;
  436.                    };
  437.  
  438.     /^-v(erbose)?$/     && do {
  439.                     $VERBOSE++;
  440.                     next;
  441.                    };
  442.  
  443.     /^-p(retty)?$/         && do {
  444.                     print STDERR "$0: I'm afraid it's too late for prettiness.\n";
  445.                     $PRETTY++;
  446.                     next;
  447.                    };
  448.  
  449.     warn "Unknown flag: $_";
  450.     } 
  451.  
  452.     $oldwarn = $SIG{__WARN__};
  453.     $olddie = $SIG{__DIE__};
  454.     $SIG{__WARN__} = \&warn_trap;
  455.     $SIG{__DIE__} = \&death_trap;
  456. } 
  457.  
  458. sub enable { &import }
  459.  
  460. sub disable {
  461.     shift;
  462.     return unless $SIG{__WARN__} eq \&warn_trap;
  463.     $SIG{__WARN__} = $oldwarn || '';
  464.     $SIG{__DIE__} = $olddie || '';
  465. } 
  466.  
  467. sub warn_trap {
  468.     my $warning = $_[0];
  469.     if (caller eq $WHOAMI or !splainthis($warning)) {
  470.     print STDERR $warning;
  471.     } 
  472.     &$oldwarn if defined $oldwarn and $oldwarn and $oldwarn ne \&warn_trap;
  473. };
  474.  
  475. sub death_trap {
  476.     my $exception = $_[0];
  477.  
  478.     # See if we are coming from anywhere within an eval. If so we don't
  479.     # want to explain the exception because it's going to get caught.
  480.     my $in_eval = 0;
  481.     my $i = 0;
  482.     while (1) {
  483.       my $caller = (caller($i++))[3] or last;
  484.       if ($caller eq '(eval)') {
  485.     $in_eval = 1;
  486.     last;
  487.       }
  488.     }
  489.  
  490.     splainthis($exception) unless $in_eval;
  491.     if (caller eq $WHOAMI) { print STDERR "INTERNAL EXCEPTION: $exception"; } 
  492.     &$olddie if defined $olddie and $olddie and $olddie ne \&death_trap;
  493.  
  494.     return if $in_eval;
  495.  
  496.     # We don't want to unset these if we're coming from an eval because
  497.     # then we've turned off diagnostics.
  498.  
  499.     # Switch off our die/warn handlers so we don't wind up in our own
  500.     # traps.
  501.     $SIG{__DIE__} = $SIG{__WARN__} = '';
  502.  
  503.     # Have carp skip over death_trap() when showing the stack trace.
  504.     local($Carp::CarpLevel) = 1;
  505.  
  506.     confess "Uncaught exception from user code:\n\t$exception";
  507.     # up we go; where we stop, nobody knows, but i think we die now
  508.     # but i'm deeply afraid of the &$olddie guy reraising and us getting
  509.     # into an indirect recursion loop
  510. };
  511.  
  512. my %exact_duplicate;
  513. my %old_diag;
  514. my $count;
  515. my $wantspace;
  516. sub splainthis {
  517.     local $_ = shift;
  518.     local $\;
  519.     ### &finish_compilation unless %msg;
  520.     s/\.?\n+$//;
  521.     my $orig = $_;
  522.     # return unless defined;
  523.     s/, <.*?> (?:line|chunk).*$//;
  524.     my $real = s/(.*?) at .*? (?:line|chunk) \d+.*/$1/;
  525.     s/^\((.*)\)$/$1/;
  526.     if ($exact_duplicate{$orig}++) {
  527.     return &transmo;
  528.     }
  529.     else {
  530.     return 0 unless &transmo;
  531.     }
  532.     $orig = shorten($orig);
  533.     if ($old_diag{$_}) {
  534.     autodescribe();
  535.     print THITHER "$orig (#$old_diag{$_})\n";
  536.     $wantspace = 1;
  537.     } else {
  538.     autodescribe();
  539.     $old_diag{$_} = ++$count;
  540.     print THITHER "\n" if $wantspace;
  541.     $wantspace = 0;
  542.     print THITHER "$orig (#$old_diag{$_})\n";
  543.     if ($msg{$_}) {
  544.         print THITHER $msg{$_};
  545.     } else {
  546.         if (0 and $standalone) { 
  547.         print THITHER "    **** Error #$old_diag{$_} ",
  548.             ($real ? "is" : "appears to be"),
  549.             " an unknown diagnostic message.\n\n";
  550.         }
  551.         return 0;
  552.     } 
  553.     }
  554.     return 1;
  555. } 
  556.  
  557. sub autodescribe {
  558.     if ($VERBOSE and not $count) {
  559.     print THITHER &{$PRETTY ? \&bold : \&noop}("DESCRIPTION OF DIAGNOSTICS"),
  560.         "\n$msg{DESCRIPTION}\n";
  561.     } 
  562. } 
  563.  
  564. sub unescape { 
  565.     s {
  566.             E<  
  567.             ( [A-Za-z]+ )       
  568.             >   
  569.     } { 
  570.          do {   
  571.              exists $HTML_Escapes{$1}
  572.                 ? do { $HTML_Escapes{$1} }
  573.                 : do {
  574.                     warn "Unknown escape: E<$1> in $_";
  575.                     "E<$1>";
  576.                 } 
  577.          } 
  578.     }egx;
  579. }
  580.  
  581. sub shorten {
  582.     my $line = $_[0];
  583.     if (length($line) > 79 and index($line, "\n") == -1) {
  584.     my $space_place = rindex($line, ' ', 79);
  585.     if ($space_place != -1) {
  586.         substr($line, $space_place, 1) = "\n\t";
  587.     } 
  588.     } 
  589.     return $line;
  590. } 
  591.  
  592.  
  593. 1 unless $standalone;  # or it'll complain about itself
  594. __END__ # wish diag dbase were more accessible
  595.  
  596. __END__
  597. :endofperl
  598.