/usr/share/perl5/HTML/FormatText.pm is in libhtml-format-perl 2.12-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 | package HTML::FormatText;
# ABSTRACT: Format HTML as plaintext
use 5.006_001;
use strict;
use warnings;
# We now use Smart::Comments in place of the old DEBUG framework.
# this should be commented out in release versions....
##use Smart::Comments;
use base 'HTML::Formatter';
our $VERSION = '2.12'; # VERSION
our $AUTHORITY = 'cpan:NIGELM'; # AUTHORITY
# ------------------------------------------------------------------------
sub default_values {
( shift->SUPER::default_values(),
lm => 3, # left margin
rm => 72, # right margin (actually, maximum text width)
);
}
# ------------------------------------------------------------------------
sub configure {
my ( $self, $hash ) = @_;
my $lm = $self->{lm};
my $rm = $self->{rm};
$lm = delete $hash->{lm} if exists $hash->{lm};
$lm = delete $hash->{leftmargin} if exists $hash->{leftmargin};
$rm = delete $hash->{rm} if exists $hash->{rm};
$rm = delete $hash->{rightmargin} if exists $hash->{rightmargin};
my $width = $rm - $lm;
if ( $width < 1 ) {
warn "Bad margins, ignored" if $^W;
return;
}
if ( $width < 20 ) {
warn "Page probably too narrow" if $^W;
}
for ( keys %$hash ) {
warn "Unknown configure option '$_'" if $^W;
}
$self->{lm} = $lm;
$self->{rm} = $rm;
$self;
}
# ------------------------------------------------------------------------
sub begin {
my $self = shift;
$self->SUPER::begin;
$self->{curpos} = 0; # current output position.
$self->{maxpos} = 0; # highest value of $pos (used by header underliner)
$self->{hspace} = 0; # horizontal space pending flag
}
# ------------------------------------------------------------------------
sub end {
shift->collect("\n");
}
# ------------------------------------------------------------------------
sub header_start {
my ( $self, $level ) = @_;
$self->vspace( 1 + ( 6 - $level ) * 0.4 );
$self->{maxpos} = 0;
1;
}
# ------------------------------------------------------------------------
sub header_end {
my ( $self, $level ) = @_;
if ( $level <= 2 ) {
my $line;
$line = '=' if $level == 1;
$line = '-' if $level == 2;
$self->vspace(0);
$self->out( $line x ( $self->{maxpos} - $self->{lm} ) );
}
$self->vspace(1);
1;
}
# ------------------------------------------------------------------------
sub bullet {
my $self = shift;
$self->SUPER::bullet( $_[0] . ' ' );
}
# ------------------------------------------------------------------------
sub hr_start {
my $self = shift;
$self->vspace(1);
$self->out( '-' x ( $self->{rm} - $self->{lm} ) );
$self->vspace(1);
}
# ------------------------------------------------------------------------
sub pre_out {
my $self = shift;
# should really handle bold/italic etc.
if ( defined $self->{vspace} ) {
if ( $self->{out} ) {
$self->nl() while $self->{vspace}-- >= 0;
$self->{vspace} = undef;
}
}
my $indent = ' ' x $self->{lm};
my $pre = shift;
$pre =~ s/^/$indent/mg;
$self->collect($pre);
$self->{out}++;
}
# ------------------------------------------------------------------------
sub out {
my $self = shift;
my $text = shift;
$text =~ tr/\xA0\xAD/ /d;
if ( $text =~ /^\s*$/ ) {
$self->{hspace} = 1;
return;
}
if ( defined $self->{vspace} ) {
if ( $self->{out} ) {
$self->nl while $self->{vspace}-- >= 0;
}
$self->goto_lm;
$self->{vspace} = undef;
$self->{hspace} = 0;
}
if ( $self->{hspace} ) {
if ( $self->{curpos} + length($text) > $self->{rm} ) {
# word will not fit on line; do a line break
$self->nl;
$self->goto_lm;
}
else {
# word fits on line; use a space
$self->collect(' ');
++$self->{curpos};
}
$self->{hspace} = 0;
}
$self->collect($text);
my $pos = $self->{curpos} += length $text;
$self->{maxpos} = $pos if $self->{maxpos} < $pos;
$self->{'out'}++;
}
# ------------------------------------------------------------------------
sub goto_lm {
my $self = shift;
my $pos = $self->{curpos};
my $lm = $self->{lm};
if ( $pos < $lm ) {
$self->{curpos} = $lm;
$self->collect( " " x ( $lm - $pos ) );
}
}
# ------------------------------------------------------------------------
sub nl {
my $self = shift;
$self->{'out'}++;
$self->{curpos} = 0;
$self->collect("\n");
}
# ------------------------------------------------------------------------
sub adjust_lm {
my $self = shift;
$self->{lm} += $_[0];
$self->goto_lm;
}
# ------------------------------------------------------------------------
sub adjust_rm {
shift->{rm} += $_[0];
}
1;
__END__
=pod
=for test_synopsis 1;
__END__
=for stopwords latin1 leftmargin lm plaintext rightmargin rm CPAN homepage
=head1 NAME
HTML::FormatText - Format HTML as plaintext
=head1 VERSION
version 2.12
=head1 SYNOPSIS
use HTML::TreeBuilder;
$tree = HTML::TreeBuilder->new->parse_file("test.html");
use HTML::FormatText;
$formatter = HTML::FormatText->new(leftmargin => 0, rightmargin => 50);
print $formatter->format($tree);
or, more simply:
use HTML::FormatText;
my $string = HTML::FormatText->format_file(
'test.html',
leftmargin => 0, rightmargin => 50
);
=head1 DESCRIPTION
HTML::FormatText is a formatter that outputs plain latin1 text. All character
attributes (bold/italic/underline) are ignored. Formatting of HTML tables and
forms is not implemented.
HTML::FormatText is built on L<HTML::Formatter> and documentation for that
module applies to this - especially L<HTML::Formatter/new>,
L<HTML::Formatter/format_file> and L<HTML::Formatter/format_string>.
You might specify the following parameters when constructing the formatter:
=over 4
=item I<leftmargin> (alias I<lm>)
The column of the left margin. The default is 3.
=item I<rightmargin> (alias I<rm>)
The column of the right margin. The default is 72.
=back
=head1 SEE ALSO
L<HTML::Formatter>
=head1 INSTALLATION
See perlmodinstall for information and options on installing Perl modules.
=head1 BUGS AND LIMITATIONS
You can make new bug reports, and view existing ones, through the
web interface at L<http://rt.cpan.org/Public/Dist/Display.html?Name=HTML-Format>.
=head1 AVAILABILITY
The project homepage is L<https://metacpan.org/release/HTML-Format>.
The latest version of this module is available from the Comprehensive Perl
Archive Network (CPAN). Visit L<http://www.perl.com/CPAN/> to find a CPAN
site near you, or see L<https://metacpan.org/module/HTML::Format/>.
=head1 AUTHORS
=over 4
=item *
Nigel Metheringham <nigelm@cpan.org>
=item *
Sean M Burke <sburke@cpan.org>
=item *
Gisle Aas <gisle@ActiveState.com>
=back
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2015 by Nigel Metheringham, 2002-2005 Sean M Burke, 1999-2002 Gisle Aas.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
|