Upgrade to 4.2.2
[usit-rt.git] / lib / RT / Shredder / POD.pm
1 # BEGIN BPS TAGGED BLOCK {{{
2 #
3 # COPYRIGHT:
4 #
5 # This software is Copyright (c) 1996-2014 Best Practical Solutions, LLC
6 #                                          <sales@bestpractical.com>
7 #
8 # (Except where explicitly superseded by other copyright notices)
9 #
10 #
11 # LICENSE:
12 #
13 # This work is made available to you under the terms of Version 2 of
14 # the GNU General Public License. A copy of that license should have
15 # been provided with this software, but in any event can be snarfed
16 # from www.gnu.org.
17 #
18 # This work is distributed in the hope that it will be useful, but
19 # WITHOUT ANY WARRANTY; without even the implied warranty of
20 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
21 # General Public License for more details.
22 #
23 # You should have received a copy of the GNU General Public License
24 # along with this program; if not, write to the Free Software
25 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
26 # 02110-1301 or visit their web page on the internet at
27 # http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
28 #
29 #
30 # CONTRIBUTION SUBMISSION POLICY:
31 #
32 # (The following paragraph is not intended to limit the rights granted
33 # to you to modify and distribute this software under the terms of
34 # the GNU General Public License and is only of importance to you if
35 # you choose to contribute your changes and enhancements to the
36 # community by submitting them to Best Practical Solutions, LLC.)
37 #
38 # By intentionally submitting any modifications, corrections or
39 # derivatives to this work, or any other work intended for use with
40 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
41 # you are the copyright holder for those contributions and you grant
42 # Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
43 # royalty-free, perpetual, license to use, copy, create derivative
44 # works based on those contributions, and sublicense and distribute
45 # those contributions and any derivatives thereof.
46 #
47 # END BPS TAGGED BLOCK }}}
48
49 package RT::Shredder::POD;
50
51 use strict;
52 use warnings;
53 use Pod::Select;
54 use Pod::PlainText;
55
56 sub plugin_html
57 {
58     my ($file, $out_fh) = @_;
59     my $parser = RT::Shredder::POD::HTML->new;
60     $parser->select('ARGUMENTS', 'USAGE');
61     $parser->parse_from_file( $file, $out_fh );
62 }
63
64 sub plugin_cli
65 {
66     my ($file, $out_fh, $no_name) = @_;
67     local @Pod::PlainText::ISA = ('Pod::Select', @Pod::PlainText::ISA);
68     my $parser = Pod::PlainText->new();
69     $parser->select('SYNOPSIS', 'ARGUMENTS', 'USAGE');
70     $parser->add_selection('NAME') unless $no_name;
71     $parser->parse_from_file( $file, $out_fh );
72 }
73
74 sub shredder_cli
75 {
76     my ($file, $out_fh) = @_;
77     local @Pod::PlainText::ISA = ('Pod::Select', @Pod::PlainText::ISA);
78     my $parser = Pod::PlainText->new();
79     $parser->select('NAME', 'SYNOPSIS', 'USAGE', 'OPTIONS');
80     $parser->parse_from_file( $file, $out_fh );
81 }
82
83 package RT::Shredder::POD::HTML;
84 use base qw(Pod::Select);
85
86 sub command
87 {
88     my( $self, $command, $paragraph, $line_num ) = @_;
89
90     my $tag;
91     if ($command =~ /^head(\d+)$/) { $tag = "h$1" }
92     my $out_fh = $self->output_handle();
93     my $expansion = $self->interpolate($paragraph, $line_num);
94     $expansion =~ s/^\s+|\s+$//;
95
96     print $out_fh "<$tag>" if $tag;
97     print $out_fh $expansion;
98     print $out_fh "</$tag>" if $tag;
99     print $out_fh "\n";
100 }
101
102 sub verbatim
103 {
104     my ($self, $paragraph, $line_num) = @_;
105     my $out_fh = $self->output_handle();
106     print $out_fh "<pre>";
107     print $out_fh $paragraph;
108     print $out_fh "</pre>";
109     print $out_fh "\n";
110 }
111
112 sub textblock {
113     my ($self, $paragraph, $line_num) = @_;
114     my $out_fh = $self->output_handle();
115     my $expansion = $self->interpolate($paragraph, $line_num);
116     $expansion =~ s/^\s+|\s+$//;
117     print $out_fh "<p>";
118     print $out_fh $expansion;
119     print $out_fh "</p>";
120     print $out_fh "\n";
121 }
122
123 sub interior_sequence {
124     my ($self, $seq_command, $seq_argument) = @_;
125     ## Expand an interior sequence; sample actions might be:
126     return "<b>$seq_argument</b>" if $seq_command eq 'B';
127     return "<i>$seq_argument</i>" if $seq_command eq 'I';
128     return "<span class=\"pod-sequence-$seq_command\">$seq_argument</span>";
129 }
130 1;