This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
remove the rest of pod/perlcompile.pod
[perl5.git] / ext / B / B / Terse.pm
CommitLineData
a798dbf2 1package B::Terse;
28b605d8 2
baccf54f 3our $VERSION = '1.05';
28b605d8 4
ad4997d3 5use strict;
baccf54f 6use B qw(class @specialsv_name);
8ec8fbef 7use B::Concise qw(concise_subref set_style_standard);
31b49ad4 8use Carp;
ad4997d3
JH
9
10sub terse {
8ec8fbef 11 my ($order, $subref) = @_;
31b49ad4 12 set_style_standard("terse");
ad4997d3 13 if ($order eq "exec") {
8ec8fbef 14 concise_subref('exec', $subref);
ad4997d3 15 } else {
8ec8fbef 16 concise_subref('basic', $subref);
ad4997d3
JH
17 }
18}
a798dbf2
MB
19
20sub compile {
31b49ad4
SM
21 my @args = @_;
22 my $order = @args ? shift(@args) : "";
23 $order = "-exec" if $order eq "exec";
24 unshift @args, $order if $order ne "";
25 B::Concise::compile("-terse", @args);
ad4997d3
JH
26}
27
28sub indent {
cc02ea56 29 my ($level) = @_ ? shift : 0;
ad4997d3
JH
30 return " " x $level;
31}
32
31b49ad4
SM
33# Don't use this, at least on OPs in subroutines: it has no way of
34# getting to the pad, and will give wrong answers or crash.
ad4997d3 35sub B::OP::terse {
31b49ad4
SM
36 carp "B::OP::terse is deprecated; use B::Concise instead";
37 B::Concise::b_terse(@_);
ad4997d3
JH
38}
39
31b49ad4
SM
40sub B::SV::terse {
41 my($sv, $level) = (@_, 0);
42 my %info;
43 B::Concise::concise_sv($sv, \%info);
cc02ea56
JC
44 my $s = indent($level)
45 . B::Concise::fmt_line(\%info, $sv,
46 "#svclass~(?((#svaddr))?)~#svval", 0);
47 chomp $s;
48 print "$s\n" unless defined wantarray;
49 $s;
d333a217
RGS
50}
51
ad4997d3 52sub B::NULL::terse {
5638aaac 53 my ($sv, $level) = (@_, 0);
cc02ea56
JC
54 my $s = indent($level) . sprintf "%s (0x%lx)", class($sv), $$sv;
55 print "$s\n" unless defined wantarray;
56 $s;
ad4997d3 57}
31b49ad4 58
ad4997d3 59sub B::SPECIAL::terse {
5638aaac 60 my ($sv, $level) = (@_, 0);
cc02ea56
JC
61 my $s = indent($level)
62 . sprintf( "%s #%d %s", class($sv), $$sv, $specialsv_name[$$sv]);
63 print "$s\n" unless defined wantarray;
64 $s;
a798dbf2
MB
65}
66
671;
7f20e9dd
GS
68
69__END__
70
71=head1 NAME
72
73B::Terse - Walk Perl syntax tree, printing terse info about ops
74
75=head1 SYNOPSIS
76
ad4997d3 77 perl -MO=Terse[,OPTIONS] foo.pl
7f20e9dd
GS
78
79=head1 DESCRIPTION
80
31b49ad4
SM
81This version of B::Terse is really just a wrapper that calls B::Concise
82with the B<-terse> option. It is provided for compatibility with old scripts
83(and habits) but using B::Concise directly is now recommended instead.
84
3c4b39be 85For compatibility with the old B::Terse, this module also adds a
31b49ad4
SM
86method named C<terse> to B::OP and B::SV objects. The B::SV method is
87largely compatible with the old one, though authors of new software
88might be advised to choose a more user-friendly output format. The
89B::OP C<terse> method, however, doesn't work well. Since B::Terse was
90first written, much more information in OPs has migrated to the
91scratchpad datastructure, but the C<terse> interface doesn't have any
92way of getting to the correct pad. As a kludge, the new version will
93always use the pad for the main program, but for OPs in subroutines
94this will give the wrong answer or crash.
7f20e9dd
GS
95
96=head1 AUTHOR
97
31b49ad4
SM
98The original version of B::Terse was written by Malcolm Beattie,
99E<lt>mbeattie@sable.ox.ac.ukE<gt>. This wrapper was written by Stephen
100McCamant, E<lt>smcc@MIT.EDUE<gt>.
7f20e9dd
GS
101
102=cut