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