/usr/share/perl5/PPI/Token/Pod.pm is in libppi-perl 1.220-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 | package PPI::Token::Pod;
=pod
=head1 NAME
PPI::Token::Pod - Sections of POD in Perl documents
=head1 INHERITANCE
PPI::Token::Pod
isa PPI::Token
isa PPI::Element
=head1 DESCRIPTION
A single C<PPI::Token::Pod> object represents a complete section of POD
documentation within a Perl document.
=head1 METHODS
This class provides some additional methods beyond those provided by its
L<PPI::Token> and L<PPI::Element> parent classes.
=cut
use strict;
use Params::Util qw{_INSTANCE};
use PPI::Token ();
use vars qw{$VERSION @ISA};
BEGIN {
$VERSION = '1.220';
@ISA = 'PPI::Token';
}
#####################################################################
# PPI::Token::Pod Methods
=pod
=head2 merge @podtokens
The C<merge> constructor takes a number of C<PPI::Token::Pod> objects,
and returns a new object that represents one combined POD block with
the content of all of them.
Returns a new C<PPI::Token::Pod> object, or C<undef> on error.
=cut
sub merge {
my $class = (! ref $_[0]) ? shift : return undef;
# Check there are no bad arguments
if ( grep { ! _INSTANCE($_, 'PPI::Token::Pod') } @_ ) {
return undef;
}
# Get the tokens, and extract the lines
my @content = ( map { [ $_->lines ] } @_ ) or return undef;
# Remove the leading =pod tags, trailing =cut tags, and any empty lines
# between them and the pod contents.
foreach my $pod ( @content ) {
# Leading =pod tag
if ( @$pod and $pod->[0] =~ /^=pod\b/o ) {
shift @$pod;
}
# Trailing =cut tag
if ( @$pod and $pod->[-1] =~ /^=cut\b/o ) {
pop @$pod;
}
# Leading and trailing empty lines
while ( @$pod and $pod->[0] eq '' ) { shift @$pod }
while ( @$pod and $pod->[-1] eq '' ) { pop @$pod }
}
# Remove any empty pod sections, and add the =pod and =cut tags
# for the merged pod back to it.
@content = ( [ '=pod' ], grep { @$_ } @content, [ '=cut' ] );
# Create the new object
$class->new( join "\n", map { join( "\n", @$_ ) . "\n" } @content );
}
=pod
=head2 lines
The C<lines> method takes the string of POD and breaks it into lines,
returning them as a list.
=cut
sub lines {
split /(?:\015{1,2}\012|\015|\012)/, $_[0]->{content};
}
#####################################################################
# PPI::Element Methods
### XS -> PPI/XS.xs:_PPI_Token_Pod__significant 0.900+
sub significant() { '' }
#####################################################################
# Tokenizer Methods
sub __TOKENIZER__on_line_start {
my $t = $_[1];
# Add the line to the token first
$t->{token}->{content} .= $t->{line};
# Check the line to see if it is a =cut line
if ( $t->{line} =~ /^=(\w+)/ ) {
# End of the token
$t->_finalize_token if $1 eq 'cut';
}
0;
}
1;
=pod
=head1 SUPPORT
See the L<support section|PPI/SUPPORT> in the main module.
=head1 AUTHOR
Adam Kennedy E<lt>adamk@cpan.orgE<gt>
=head1 COPYRIGHT
Copyright 2001 - 2011 Adam Kennedy.
This program is free software; you can redistribute
it and/or modify it under the same terms as Perl itself.
The full text of the license can be found in the
LICENSE file included with this module.
=cut
|