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
|
#line 1
# vim: set ts=4 sts=4 sw=4 expandtab smarttab:
#
# This file is part of Pod-Markdown
#
# This software is copyright (c) 2004 by Marcel Gruenauer.
#
# This is free software; you can redistribute it and/or modify it under
# the same terms as the Perl 5 programming language system itself.
#
use 5.008;
use strict;
use warnings;
package Pod::Markdown;
{
$Pod::Markdown::VERSION = '1.200000';
}
BEGIN {
$Pod::Markdown::AUTHORITY = 'cpan:RWSTAUNER';
}
# ABSTRACT: Convert POD to Markdown
use parent qw(Pod::Parser);
use Pod::ParseLink (); # core
sub initialize {
my $self = shift;
$self->SUPER::initialize(@_);
$self->_private;
$self;
}
sub _private {
my $self = shift;
$self->{_MyParser} ||= {
Text => [], # final text
Indent => 0, # list indent levels counter
ListType => '-', # character on every item
searching => '' , # what are we searching for? (title, author etc.)
Title => undef, # page title
Author => undef, # page author
};
}
sub as_markdown {
my ($parser, %args) = @_;
my $data = $parser->_private;
my $lines = $data->{Text};
my @header;
if ($args{with_meta}) {
@header = $parser->_build_markdown_head;
}
join("\n" x 2, @header, @{$lines});
}
sub _build_markdown_head {
my $parser = shift;
my $data = $parser->_private;
return join "\n",
map { qq![[meta \l$_="$data->{$_}"]]! }
grep { defined $data->{$_} }
qw( Title Author );
}
sub _save {
my ($parser, $text) = @_;
my $data = $parser->_private;
$text = $parser->_indent_text($text);
push @{ $data->{Text} }, $text;
return;
}
sub _unsave {
my $parser = shift;
my $data = $parser->_private;
return pop @{ $data->{Text} };
}
sub _indent_text {
my ($parser, $text) = @_;
my $data = $parser->_private;
my $level = $data->{Indent};
my $indent = undef;
if ($level > 0) {
$level--;
}
$indent = ' ' x ($level * 4);
my @lines = map { $indent . $_; } split(/\n/, $text);
return wantarray ? @lines : join("\n", @lines);
}
sub _clean_text {
my $text = $_[1];
my @trimmed = grep { $_; } split(/\n/, $text);
return wantarray ? @trimmed : join("\n", @trimmed);
}
sub command {
my ($parser, $command, $paragraph, $line_num) = @_;
my $data = $parser->_private;
# cleaning the text
$paragraph = $parser->_clean_text($paragraph);
# is it a header ?
if ($command =~ m{head(\d)}xms) {
my $level = $1;
$paragraph = $parser->interpolate($paragraph, $line_num);
# the headers never are indented
$parser->_save($parser->format_header($level, $paragraph));
if ($level == 1) {
if ($paragraph =~ m{NAME}xmsi) {
$data->{searching} = 'title';
} elsif ($paragraph =~ m{AUTHOR}xmsi) {
$data->{searching} = 'author';
} else {
$data->{searching} = '';
}
}
}
# opening a list ?
elsif ($command =~ m{over}xms) {
# update indent level
$data->{Indent}++;
# closing a list ?
} elsif ($command =~ m{back}xms) {
# decrement indent level
$data->{Indent}--;
$data->{searching} = '';
} elsif ($command =~ m{item}xms) {
$paragraph = $parser->interpolate($paragraph, $line_num);
$paragraph =~ s{^[ \t]* \* [ \t]*}{}xms;
if ($data->{searching} eq 'listpara') {
$data->{searching} = 'listheadhuddled';
}
else {
$data->{searching} = 'listhead';
}
if (length $paragraph) {
$parser->textblock($paragraph, $line_num);
}
}
# ignore other commands
return;
}
sub verbatim {
my ($parser, $paragraph) = @_;
# NOTE: perlpodspec says parsers should expand tabs by default
# NOTE: Apparently Pod::Parser does not. should we?
# NOTE: this might be s/^\t/" " x 8/e, but what about tabs inside the para?
# POD verbatim can start with any number of spaces (or tabs)
# markdown should be 4 spaces (or a tab)
# so indent any paragraphs so that all lines start with at least 4 spaces
my @lines = split /\n/, $paragraph;
my $indent = ' ' x 4;
foreach my $line ( @lines ){
next unless $line =~ m/^( +)/;
# find the smallest indentation
$indent = $1 if length($1) < length($indent);
}
if( (my $smallest = length($indent)) < 4 ){
# invert to get what needs to be prepended
$indent = ' ' x (4 - $smallest);
# leave tabs alone
$paragraph = join "\n", map { /^\t/ ? $_ : $indent . $_ } @lines;
}
$parser->_save($paragraph);
}
sub textblock {
my ($parser, $paragraph, $line_num) = @_;
my $data = $parser->_private;
# interpolate the paragraph for embebed sequences
$paragraph = $parser->interpolate($paragraph, $line_num);
# clean the empty lines
$paragraph = $parser->_clean_text($paragraph);
# searching ?
if ($data->{searching} =~ m{title|author}xms) {
$data->{ ucfirst $data->{searching} } = $paragraph;
$data->{searching} = '';
} elsif ($data->{searching} =~ m{listhead(huddled)?$}xms) {
my $is_huddled = $1;
$paragraph = sprintf '%s %s', $data->{ListType}, $paragraph;
if ($is_huddled) {
$paragraph = $parser->_unsave() . "\n" . $paragraph;
}
$data->{searching} = 'listpara';
} elsif ($data->{searching} eq 'listpara') {
$data->{searching} = '';
}
# save the text
$parser->_save($paragraph);
}
sub interior_sequence {
my ($self, $seq_command, $seq_argument, $pod_seq) = @_;
# nested links are not allowed
return sprintf '%s<%s>', $seq_command, $seq_argument
if $seq_command eq 'L' && $self->_private->{InsideLink};
my $i = 2;
my %interiors = (
'I' => sub { return '_' . $_[$i] . '_' }, # italic
'B' => sub { return '__' . $_[$i] . '__' }, # bold
'C' => sub { return '`' . $_[$i] . '`' }, # monospace
'F' => sub { return '`' . $_[$i] . '`' }, # system path
# non-breaking space
'S' => sub {
(my $s = $_[$i]) =~ s/ / /g;
return $s;
},
'E' => sub {
my $charname = $_[$i];
return '<' if $charname eq 'lt';
return '>' if $charname eq 'gt';
return '|' if $charname eq 'verbar';
return '/' if $charname eq 'sol';
# convert legacy charnames to more modern ones (see perlpodspec)
$charname =~ s/\A([lr])chevron\z/${1}aquo/;
return "&#$1;" if $charname =~ /^0(x[0-9a-fA-Z]+)$/;
$charname = oct($charname) if $charname =~ /^0\d+$/;
return "&#$charname;" if $charname =~ /^\d+$/;
return "&$charname;";
},
'L' => \&_resolv_link,
'X' => sub { '' },
'Z' => sub { '' },
);
if (exists $interiors{$seq_command}) {
my $code = $interiors{$seq_command};
return $code->($self, $seq_command, $seq_argument, $pod_seq);
} else {
return sprintf '%s<%s>', $seq_command, $seq_argument;
}
}
sub _resolv_link {
my ($self, $cmd, $arg) = @_;
local $self->_private->{InsideLink} = 1;
my ($text, $inferred, $name, $section, $type) =
# perlpodspec says formatting codes can occur in all parts of an L<>
map { $_ && $self->interpolate($_, 1) }
Pod::ParseLink::parselink($arg);
my $url = '';
# TODO: make url prefixes configurable
if ($type eq 'url') {
$url = $name;
} elsif ($type eq 'man') {
# stolen from Pod::Simple::(X)HTML
my ($page, $part) = $name =~ /\A([^(]+)(?:[(](\S*)[)])?/;
$url = 'http://man.he.net/man' . ($part || 1) . '/' . ($page || $name);
} else {
if ($name) {
$url = 'http://search.cpan.org/perldoc?' . $name;
}
if ($section){
# TODO: sites/pod formatters differ on how to transform the section
# TODO: we could do it according to specified url prefix or pod formatter
# TODO: or allow a coderef?
# TODO: (Pod::Simple::XHTML:idify() for metacpan)
# TODO: (Pod::Simple::HTML section_escape/unicode_escape_url/section_url_escape for s.c.o.)
$url .= '#' . $section;
}
}
# if we don't know how to handle the url just print the pod back out
if (!$url) {
return sprintf '%s<%s>', $cmd, $arg;
}
return sprintf '[%s](%s)', ($text || $inferred), $url;
}
sub format_header {
my ($level, $paragraph) = @_[1,2];
sprintf '%s %s', '#' x $level, $paragraph;
}
1;
__END__
#line 481
|