This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Re: [PATCH] lib/Pod/Html.pm plus a funky UT8-8 regex bug
[perl5.git] / lib / Pod / Html.pm
CommitLineData
54310121 1package Pod::Html;
0e4548d5 2use strict;
54310121 3require Exporter;
0e4548d5 4
776d31fe 5use vars qw($VERSION @ISA @EXPORT @EXPORT_OK);
5d05e460 6$VERSION = 1.08;
0e4548d5 7@ISA = qw(Exporter);
54310121 8@EXPORT = qw(pod2html htmlify);
776d31fe 9@EXPORT_OK = qw(anchorify);
54310121
PP
10
11use Carp;
0e4548d5
GS
12use Config;
13use Cwd;
af75be11 14use File::Spec;
0e4548d5
GS
15use File::Spec::Unix;
16use Getopt::Long;
54310121 17
3ec07288
FK
18use locale; # make \w work right in non-ASCII lands
19
54310121
PP
20=head1 NAME
21
7b8d334a 22Pod::Html - module to convert pod files to HTML
54310121
PP
23
24=head1 SYNOPSIS
25
7b8d334a 26 use Pod::Html;
54310121
PP
27 pod2html([options]);
28
29=head1 DESCRIPTION
30
31Converts files from pod format (see L<perlpod>) to HTML format. It
32can automatically generate indexes and cross-references, and it keeps
33a cache of things it knows how to cross-reference.
34
95fb620e 35=head1 FUNCTIONS
54310121 36
95fb620e
SP
37=head2 pod2html
38
39 pod2html("pod2html",
40 "--podpath=lib:ext:pod:vms",
41 "--podroot=/usr/src/perl",
42 "--htmlroot=/perl/nmanual",
43 "--libpods=perlfunc:perlguts:perlvar:perlrun:perlop",
44 "--recurse",
45 "--infile=foo.pod",
46 "--outfile=/perl/nmanual/foo.html");
47
48pod2html takes the following arguments:
54310121
PP
49
50=over 4
51
0e4548d5
GS
52=item backlink
53
54 --backlink="Back to Top"
55
59ecbafa
VS
56Adds "Back to Top" links in front of every C<head1> heading (except for
57the first). By default, no backlinks are generated.
0e4548d5 58
b42210d7
RV
59=item cachedir
60
61 --cachedir=name
62
63Creates the item and directory caches in the given directory.
64
0e4548d5
GS
65=item css
66
67 --css=stylesheet
68
59ecbafa
VS
69Specify the URL of a cascading style sheet. Also disables all HTML/CSS
70C<style> attributes that are output by default (to avoid conflicts).
0e4548d5
GS
71
72=item flush
73
74 --flush
75
76Flushes the item and directory caches.
77
78=item header
79
80 --header
81 --noheader
82
59ecbafa
VS
83Creates header and footer blocks containing the text of the C<NAME>
84section. By default, no headers are generated.
0e4548d5 85
54310121
PP
86=item help
87
88 --help
89
90Displays the usage message.
91
99a6169d
AJ
92=item hiddendirs
93
94 --hiddendirs
95 --nohiddendirs
96
97Include hidden directories in the search for POD's in podpath if recurse
98is set.
99The default is not to traverse any directory whose name begins with C<.>.
100See L</"podpath"> and L</"recurse">.
101
102[This option is for backward compatibility only.
103It's hard to imagine that one would usefully create a module with a
104name component beginning with C<.>.]
105
5a039dd3
BS
106=item htmldir
107
108 --htmldir=name
109
110Sets the directory in which the resulting HTML file is placed. This
29f227c9
BS
111is used to generate relative links to other files. Not passing this
112causes all links to be absolute, since this is the value that tells
113Pod::Html the root of the documentation tree.
5a039dd3 114
54310121
PP
115=item htmlroot
116
117 --htmlroot=name
118
119Sets the base URL for the HTML files. When cross-references are made,
120the HTML root is prepended to the URL.
121
0e4548d5
GS
122=item index
123
124 --index
125 --noindex
126
127Generate an index at the top of the HTML file. This is the default
128behaviour.
129
54310121
PP
130=item infile
131
132 --infile=name
133
134Specify the pod file to convert. Input is taken from STDIN if no
135infile is specified.
136
54310121
PP
137=item libpods
138
139 --libpods=name:...:name
140
141List of page names (eg, "perlfunc") which contain linkable C<=item>s.
142
143=item netscape
144
145 --netscape
0e4548d5 146 --nonetscape
54310121 147
59ecbafa 148B<Deprecated>, has no effect. For backwards compatibility only.
54310121 149
0e4548d5 150=item outfile
54310121 151
0e4548d5 152 --outfile=name
54310121 153
0e4548d5
GS
154Specify the HTML file to create. Output goes to STDOUT if no outfile
155is specified.
54310121 156
0e4548d5 157=item podpath
54310121 158
0e4548d5 159 --podpath=name:...:name
54310121 160
0e4548d5 161Specify which subdirectories of the podroot contain pod files whose
59ecbafa 162HTML converted forms can be linked to in cross references.
54310121 163
0e4548d5 164=item podroot
54310121 165
0e4548d5 166 --podroot=name
54310121 167
0e4548d5 168Specify the base directory for finding library pods.
54310121 169
0e4548d5 170=item quiet
54310121 171
0e4548d5
GS
172 --quiet
173 --noquiet
54310121 174
0e4548d5
GS
175Don't display I<mostly harmless> warning messages. These messages
176will be displayed by default. But this is not the same as C<verbose>
177mode.
54310121 178
0e4548d5 179=item recurse
54310121 180
0e4548d5 181 --recurse
54310121
PP
182 --norecurse
183
0e4548d5 184Recurse into subdirectories specified in podpath (default behaviour).
54310121
PP
185
186=item title
187
188 --title=title
189
190Specify the title of the resulting HTML file.
191
192=item verbose
193
194 --verbose
0e4548d5 195 --noverbose
54310121 196
0e4548d5 197Display progress messages. By default, they won't be displayed.
34db337b 198
54310121
PP
199=back
200
95fb620e 201=head2 htmlify
54310121 202
95fb620e
SP
203 htmlify($heading);
204
205Converts a pod section specification to a suitable section specification
206for HTML. Note that we keep spaces and special characters except
207C<", ?> (Netscape problem) and the hyphen (writer's problem...).
208
209=head2 anchorify
210
211 anchorify(@heading);
212
213Similar to C<htmlify()>, but turns non-alphanumerics into underscores. Note
214that C<anchorify()> is not exported by default.
54310121 215
34db337b
JD
216=head1 ENVIRONMENT
217
59ecbafa 218Uses C<$Config{pod2html}> to setup default options.
34db337b 219
54310121
PP
220=head1 AUTHOR
221
222Tom Christiansen, E<lt>tchrist@perl.comE<gt>.
223
54310121
PP
224=head1 SEE ALSO
225
226L<perlpod>
227
228=head1 COPYRIGHT
229
230This program is distributed under the Artistic License.
231
232=cut
233
69348ecf
MS
234my($Cachedir);
235my($Dircache, $Itemcache);
236my @Begin_Stack;
237my @Libpods;
238my($Htmlroot, $Htmldir, $Htmlfile, $Htmlfileurl);
239my($Podfile, @Podpath, $Podroot);
240my $Css;
54310121 241
69348ecf
MS
242my $Recurse;
243my $Quiet;
99a6169d 244my $HiddenDirs;
69348ecf
MS
245my $Verbose;
246my $Doindex;
54310121 247
69348ecf
MS
248my $Backlink;
249my($Listlevel, @Listend);
250my $After_Lpar;
251use vars qw($Ignore); # need to localize it later.
99cb6bd8 252
69348ecf
MS
253my(%Items_Named, @Items_Seen);
254my($Title, $Header);
99cb6bd8 255
69348ecf
MS
256my $Top;
257my $Paragraph;
99cb6bd8 258
69348ecf 259my %Sections;
99cb6bd8
MS
260
261# Caches
69348ecf 262my %Pages = (); # associative array used to find the location
54310121 263 # of pages referenced by L<> links.
69348ecf 264my %Items = (); # associative array used to find the location
54310121 265 # of =item directives referenced by C<> links
99cb6bd8 266
69348ecf 267my %Local_Items;
99cb6bd8 268my $Is83;
99cb6bd8
MS
269
270my $Curdir = File::Spec->curdir;
271
272init_globals();
39e571d4 273
54310121 274sub init_globals {
69348ecf 275 $Cachedir = "."; # The directory to which item and directory
99cb6bd8
MS
276 # caches will be written.
277
69348ecf
MS
278 $Dircache = "pod2htmd.tmp";
279 $Itemcache = "pod2htmi.tmp";
54310121 280
69348ecf 281 @Begin_Stack = (); # begin/end stack
54310121 282
69348ecf
MS
283 @Libpods = (); # files to search for links from C<> directives
284 $Htmlroot = "/"; # http-server base directory from which all
54310121 285 # relative paths in $podpath stem.
69348ecf 286 $Htmldir = ""; # The directory to which the html pages
67398a75 287 # will (eventually) be written.
69348ecf
MS
288 $Htmlfile = ""; # write to stdout by default
289 $Htmlfileurl = "" ; # The url that other files would use to
99cb6bd8
MS
290 # refer to this file. This is only used
291 # to make relative urls that point to
292 # other files.
293
69348ecf
MS
294 $Podfile = ""; # read from stdin by default
295 @Podpath = (); # list of directories containing library pods.
296 $Podroot = $Curdir; # filesystem base directory from which all
54310121 297 # relative paths in $podpath stem.
69348ecf
MS
298 $Css = ''; # Cascading style sheet
299 $Recurse = 1; # recurse on subdirectories in $podpath.
300 $Quiet = 0; # not quiet by default
301 $Verbose = 0; # not verbose by default
302 $Doindex = 1; # non-zero if we should generate an index
303 $Backlink = ''; # text for "back to top" links
304 $Listlevel = 0; # current list depth
305 @Listend = (); # the text to use to end the list.
306 $After_Lpar = 0; # set to true after a par in an =item
307 $Ignore = 1; # whether or not to format text. we don't
54310121
PP
308 # format text until we hit our first pod
309 # directive.
310
69348ecf
MS
311 @Items_Seen = (); # for multiples of the same item in perlfunc
312 %Items_Named = ();
313 $Header = 0; # produce block header/footer
314 $Title = ''; # title to give the pod(s)
315 $Top = 1; # true if we are at the top of the doc. used
59ecbafa 316 # to prevent the first <hr /> directive.
69348ecf 317 $Paragraph = ''; # which paragraph we're processing (used
54310121 318 # for error messages)
69348ecf 319 %Sections = (); # sections within this page
3e3baf6d 320
69348ecf 321 %Local_Items = ();
99cb6bd8 322 $Is83 = $^O eq 'dos'; # Is it an 8.3 filesystem?
54310121
PP
323}
324
2a28b791
GS
325#
326# clean_data: global clean-up of pod data
327#
328sub clean_data($){
329 my( $dataref ) = @_;
bf202ccd 330 for my $i ( 0..$#{$dataref} ) {
2a28b791
GS
331 ${$dataref}[$i] =~ s/\s+\Z//;
332
333 # have a look for all-space lines
4135c0a0 334 if( ${$dataref}[$i] =~ /^\s+$/m and $dataref->[$i] !~ /^\s/ ){
2a28b791
GS
335 my @chunks = split( /^\s+$/m, ${$dataref}[$i] );
336 splice( @$dataref, $i, 1, @chunks );
337 }
338 }
339}
340
341
54310121
PP
342sub pod2html {
343 local(@ARGV) = @_;
344 local($/);
345 local $_;
346
347 init_globals();
348
39e571d4
ML
349 $Is83 = 0 if (defined (&Dos::UseLFN) && Dos::UseLFN());
350
69348ecf 351 # cache of %Pages and %Items from last time we ran pod2html
54310121
PP
352
353 #undef $opt_help if defined $opt_help;
354
355 # parse the command-line parameters
356 parse_command_line();
357
59ecbafa 358 # escape the backlink argument (same goes for title but is done later...)
69348ecf 359 $Backlink = html_escape($Backlink) if defined $Backlink;
59ecbafa 360
54310121
PP
361 # set some variables to their default values if necessary
362 local *POD;
59ecbafa 363 unless (@ARGV && $ARGV[0]) {
69348ecf
MS
364 $Podfile = "-" unless $Podfile; # stdin
365 open(POD, "<$Podfile")
366 || die "$0: cannot open $Podfile file for input: $!\n";
54310121 367 } else {
69348ecf 368 $Podfile = $ARGV[0]; # XXX: might be more filenames
54310121 369 *POD = *ARGV;
59ecbafa 370 }
69348ecf
MS
371 $Htmlfile = "-" unless $Htmlfile; # stdout
372 $Htmlroot = "" if $Htmlroot eq "/"; # so we don't get a //
373 $Htmldir =~ s#/\z## ; # so we don't get a //
374 if ( $Htmlroot eq ''
375 && defined( $Htmldir )
376 && $Htmldir ne ''
377 && substr( $Htmlfile, 0, length( $Htmldir ) ) eq $Htmldir
59ecbafa 378 )
5a039dd3 379 {
29f227c9 380 # Set the 'base' url for this file, so that we can use it
59ecbafa 381 # as the location from which to calculate relative links
29f227c9
BS
382 # to other files. If this is '', then absolute links will
383 # be used throughout.
69348ecf 384 $Htmlfileurl= "$Htmldir/" . substr( $Htmlfile, length( $Htmldir ) + 1);
5a039dd3 385 }
54310121
PP
386
387 # read the pod a paragraph at a time
69348ecf 388 warn "Scanning for sections in input file(s)\n" if $Verbose;
54310121
PP
389 $/ = "";
390 my @poddata = <POD>;
391 close(POD);
bbed45f6
JH
392
393 # be eol agnostic
394 for (@poddata) {
5551e547
JH
395 if (/\r/) {
396 if (/\r\n/) {
397 @poddata = map { s/\r\n/\n/g;
bbed45f6
JH
398 /\n\n/ ?
399 map { "$_\n\n" } split /\n\n/ :
400 $_ } @poddata;
401 } else {
5551e547 402 @poddata = map { s/\r/\n/g;
bbed45f6
JH
403 /\n\n/ ?
404 map { "$_\n\n" } split /\n\n/ :
405 $_ } @poddata;
406 }
407 last;
408 }
409 }
410
2a28b791 411 clean_data( \@poddata );
54310121
PP
412
413 # scan the pod for =head[1-6] directives and build an index
69348ecf 414 my $index = scan_headings(\%Sections, @poddata);
54310121 415
3e3baf6d 416 unless($index) {
69348ecf 417 warn "No headings in $Podfile\n" if $Verbose;
3e3baf6d
TB
418 }
419
54310121 420 # open the output file
69348ecf
MS
421 open(HTML, ">$Htmlfile")
422 || die "$0: cannot open $Htmlfile file for output: $!\n";
54310121 423
d011ffae 424 # put a title in the HTML file if one wasn't specified
69348ecf 425 if ($Title eq '') {
d011ffae 426 TITLE_SEARCH: {
59ecbafa 427 for (my $i = 0; $i < @poddata; $i++) {
d011ffae 428 if ($poddata[$i] =~ /^=head1\s*NAME\b/m) {
59ecbafa 429 for my $para ( @poddata[$i, $i+1] ) {
d011ffae 430 last TITLE_SEARCH
69348ecf 431 if ($Title) = $para =~ /(\S+\s+-+.*\S)/s;
d011ffae 432 }
59ecbafa 433 }
54310121 434
59ecbafa 435 }
d011ffae
GS
436 }
437 }
69348ecf 438 if (!$Title and $Podfile =~ /\.pod\z/) {
3e3baf6d 439 # probably a split pod so take first =head[12] as title
59ecbafa 440 for (my $i = 0; $i < @poddata; $i++) {
69348ecf 441 last if ($Title) = $poddata[$i] =~ /^=head[12]\s*(.*)/;
59ecbafa 442 }
69348ecf
MS
443 warn "adopted '$Title' as title for $Podfile\n"
444 if $Verbose and $Title;
59ecbafa 445 }
69348ecf
MS
446 if ($Title) {
447 $Title =~ s/\s*\(.*\)//;
7b8d334a 448 } else {
69348ecf
MS
449 warn "$0: no title for $Podfile.\n" unless $Quiet;
450 $Podfile =~ /^(.*)(\.[^.\/]+)?\z/s;
451 $Title = ($Podfile eq "-" ? 'No Title' : $1);
452 warn "using $Title" if $Verbose;
54310121 453 }
69348ecf 454 $Title = html_escape($Title);
59ecbafa
VS
455
456 my $csslink = '';
457 my $bodystyle = ' style="background-color: white"';
458 my $tdstyle = ' style="background-color: #cccccc"';
459
69348ecf
MS
460 if ($Css) {
461 $csslink = qq(\n<link rel="stylesheet" href="$Css" type="text/css" />);
59ecbafa
VS
462 $csslink =~ s,\\,/,g;
463 $csslink =~ s,(/.):,$1|,;
464 $bodystyle = '';
465 $tdstyle = '';
466 }
467
69348ecf 468 my $block = $Header ? <<END_OF_BLOCK : '';
59ecbafa
VS
469<table border="0" width="100%" cellspacing="0" cellpadding="3">
470<tr><td class="block"$tdstyle valign="middle">
69348ecf 471<big><strong><span class="block">&nbsp;$Title</span></strong></big>
59ecbafa
VS
472</td></tr>
473</table>
34db337b
JD
474END_OF_BLOCK
475
54310121 476 print HTML <<END_OF_HEAD;
ae021980 477<?xml version="1.0" ?>
59ecbafa
VS
478<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
479<html xmlns="http://www.w3.org/1999/xhtml">
8d481ee5 480<head>
69348ecf 481<title>$Title</title>$csslink
ae021980 482<meta http-equiv="content-type" content="text/html; charset=utf-8" />
59ecbafa
VS
483<link rev="made" href="mailto:$Config{perladmin}" />
484</head>
485
486<body$bodystyle>
34db337b 487$block
54310121
PP
488END_OF_HEAD
489
69348ecf
MS
490 # load/reload/validate/cache %Pages and %Items
491 get_cache($Dircache, $Itemcache, \@Podpath, $Podroot, $Recurse);
54310121
PP
492
493 # scan the pod for =item directives
69348ecf 494 scan_items( \%Local_Items, "", @poddata);
54310121 495
69348ecf 496 # put an index at the top of the file. note, if $Doindex is 0 we
54310121
PP
497 # still generate an index, but surround it with an html comment.
498 # that way some other program can extract it if desired.
499 $index =~ s/--+/-/g;
25ff0154
JA
500
501 my $hr = ($Doindex and $index) ? qq(<hr name="index" />) : "";
502
503 unless ($Doindex)
504 {
505 $index = qq(<!--\n$index\n-->\n);
506 }
507
508 print HTML << "END_OF_INDEX";
509
510<!-- INDEX BEGIN -->
511<div name="index">
512<p><a name=\"__index__\"></a></p>
513$index
514$hr
515</div>
516<!-- INDEX END -->
517
518END_OF_INDEX
54310121
PP
519
520 # now convert this file
2a28b791 521 my $after_item; # set to true after an =item
59ecbafa 522 my $need_dd = 0;
69348ecf 523 warn "Converting input file $Podfile\n" if $Verbose;
2a28b791 524 foreach my $i (0..$#poddata){
54310121 525 $_ = $poddata[$i];
69348ecf 526 $Paragraph = $i+1;
54310121 527 if (/^(=.*)/s) { # is it a pod directive?
69348ecf 528 $Ignore = 0;
2a28b791 529 $after_item = 0;
59ecbafa 530 $need_dd = 0;
54310121
PP
531 $_ = $1;
532 if (/^=begin\s+(\S+)\s*(.*)/si) {# =begin
533 process_begin($1, $2);
534 } elsif (/^=end\s+(\S+)\s*(.*)/si) {# =end
535 process_end($1, $2);
536 } elsif (/^=cut/) { # =cut
537 process_cut();
538 } elsif (/^=pod/) { # =pod
539 process_pod();
540 } else {
69348ecf 541 next if @Begin_Stack && $Begin_Stack[-1] ne 'html';
54310121 542
7b8d334a 543 if (/^=(head[1-6])\s+(.*\S)/s) { # =head[1-6] heading
69348ecf 544 process_head( $1, $2, $Doindex && $index );
2a28b791 545 } elsif (/^=item\s*(.*\S)?/sm) { # =item text
59ecbafa 546 $need_dd = process_item( $1 );
2a28b791 547 $after_item = 1;
54310121
PP
548 } elsif (/^=over\s*(.*)/) { # =over N
549 process_over();
550 } elsif (/^=back/) { # =back
945ffa4f 551 process_back($need_dd);
a45bd81d 552 } elsif (/^=for\s+(\S+)\s*(.*)/si) {# =for
54310121
PP
553 process_for($1,$2);
554 } else {
555 /^=(\S*)\s*/;
69348ecf 556 warn "$0: $Podfile: unknown pod directive '$1' in "
ac094485 557 . "paragraph $Paragraph. ignoring.\n" unless $Quiet;
54310121
PP
558 }
559 }
69348ecf 560 $Top = 0;
54310121
PP
561 }
562 else {
69348ecf
MS
563 next if $Ignore;
564 next if @Begin_Stack && $Begin_Stack[-1] ne 'html';
565 print HTML and next if @Begin_Stack && $Begin_Stack[-1] eq 'html';
59ecbafa 566 print HTML "<dd>\n" if $need_dd;
54310121 567 my $text = $_;
2a28b791
GS
568 if( $text =~ /\A\s+/ ){
569 process_pre( \$text );
59ecbafa 570 print HTML "<pre>\n$text</pre>\n";
2a28b791
GS
571
572 } else {
573 process_text( \$text );
574
575 # experimental: check for a paragraph where all lines
576 # have some ...\t...\t...\n pattern
577 if( $text =~ /\t/ ){
578 my @lines = split( "\n", $text );
579 if( @lines > 1 ){
580 my $all = 2;
581 foreach my $line ( @lines ){
582 if( $line =~ /\S/ && $line !~ /\t/ ){
583 $all--;
584 last if $all == 0;
585 }
586 }
587 if( $all > 0 ){
59ecbafa
VS
588 $text =~ s/\t+/<td>/g;
589 $text =~ s/^/<tr><td>/gm;
590 $text = '<table cellspacing="0" cellpadding="0">' .
591 $text . '</table>';
2a28b791
GS
592 }
593 }
594 }
595 ## end of experimental
596
597 if( $after_item ){
69348ecf 598 $After_Lpar = 1;
2a28b791 599 }
945ffa4f 600 print HTML "<p>$text</p>\n";
2a28b791 601 }
59ecbafa 602 print HTML "</dd>\n" if $need_dd;
2a28b791 603 $after_item = 0;
54310121
PP
604 }
605 }
606
607 # finish off any pending directives
608 finish_list();
2a28b791
GS
609
610 # link to page index
69348ecf
MS
611 print HTML "<p><a href=\"#__index__\"><small>$Backlink</small></a></p>\n"
612 if $Doindex and $index and $Backlink;
2a28b791 613
54310121 614 print HTML <<END_OF_TAIL;
34db337b 615$block
59ecbafa 616</body>
54310121 617
59ecbafa 618</html>
54310121
PP
619END_OF_TAIL
620
621 # close the html file
622 close(HTML);
623
69348ecf 624 warn "Finished\n" if $Verbose;
54310121
PP
625}
626
627##############################################################################
628
54310121
PP
629sub usage {
630 my $podfile = shift;
631 warn "$0: $podfile: @_\n" if @_;
69348ecf 632 die <<END_OF_USAGE;
54310121
PP
633Usage: $0 --help --htmlroot=<name> --infile=<name> --outfile=<name>
634 --podpath=<name>:...:<name> --podroot=<name>
635 --libpods=<name>:...:<name> --recurse --verbose --index
b42210d7 636 --netscape --norecurse --noindex --cachedir=<name>
54310121 637
0e4548d5 638 --backlink - set text for "back to top" links (default: none).
b42210d7 639 --cachedir - directory for the item and directory cache files.
0e4548d5
GS
640 --css - stylesheet URL
641 --flush - flushes the item and directory caches.
642 --[no]header - produce block header/footer (default is no headers).
643 --help - prints this message.
99a6169d 644 --hiddendirs - search hidden directories in podpath
0e4548d5
GS
645 --htmldir - directory for resulting HTML files.
646 --htmlroot - http-server base directory from which all relative paths
647 in podpath stem (default is /).
648 --[no]index - generate an index at the top of the resulting html
649 (default behaviour).
650 --infile - filename for the pod to convert (input taken from stdin
651 by default).
652 --libpods - colon-separated list of pages to search for =item pod
653 directives in as targets of C<> and implicit links (empty
654 by default). note, these are not filenames, but rather
655 page names like those that appear in L<> links.
0e4548d5
GS
656 --outfile - filename for the resulting html file (output sent to
657 stdout by default).
658 --podpath - colon-separated list of directories containing library
659 pods (empty by default).
660 --podroot - filesystem base directory from which all relative paths
661 in podpath stem (default is .).
3c4b39be 662 --[no]quiet - suppress some benign warning messages (default is off).
0e4548d5
GS
663 --[no]recurse - recurse on those subdirectories listed in podpath
664 (default behaviour).
665 --title - title that will appear in resulting html file.
666 --[no]verbose - self-explanatory (off by default).
59ecbafa 667 --[no]netscape - deprecated, has no effect. for backwards compatibility only.
54310121
PP
668
669END_OF_USAGE
670
69348ecf
MS
671}
672
54310121 673sub parse_command_line {
b42210d7
RV
674 my ($opt_backlink,$opt_cachedir,$opt_css,$opt_flush,$opt_header,$opt_help,
675 $opt_htmldir,$opt_htmlroot,$opt_index,$opt_infile,$opt_libpods,
676 $opt_netscape,$opt_outfile,$opt_podpath,$opt_podroot,$opt_quiet,
99a6169d 677 $opt_recurse,$opt_title,$opt_verbose,$opt_hiddendirs);
0e4548d5 678
34db337b 679 unshift @ARGV, split ' ', $Config{pod2html} if $Config{pod2html};
54310121 680 my $result = GetOptions(
0e4548d5 681 'backlink=s' => \$opt_backlink,
b42210d7 682 'cachedir=s' => \$opt_cachedir,
0e4548d5 683 'css=s' => \$opt_css,
29f227c9 684 'flush' => \$opt_flush,
0e4548d5 685 'header!' => \$opt_header,
29f227c9 686 'help' => \$opt_help,
99a6169d 687 'hiddendirs!'=> \$opt_hiddendirs,
29f227c9 688 'htmldir=s' => \$opt_htmldir,
54310121 689 'htmlroot=s' => \$opt_htmlroot,
29f227c9 690 'index!' => \$opt_index,
54310121
PP
691 'infile=s' => \$opt_infile,
692 'libpods=s' => \$opt_libpods,
693 'netscape!' => \$opt_netscape,
694 'outfile=s' => \$opt_outfile,
695 'podpath=s' => \$opt_podpath,
696 'podroot=s' => \$opt_podroot,
0e4548d5 697 'quiet!' => \$opt_quiet,
54310121
PP
698 'recurse!' => \$opt_recurse,
699 'title=s' => \$opt_title,
0e4548d5 700 'verbose!' => \$opt_verbose,
54310121
PP
701 );
702 usage("-", "invalid parameters") if not $result;
703
704 usage("-") if defined $opt_help; # see if the user asked for help
705 $opt_help = ""; # just to make -w shut-up.
706
69348ecf
MS
707 @Podpath = split(":", $opt_podpath) if defined $opt_podpath;
708 @Libpods = split(":", $opt_libpods) if defined $opt_libpods;
709
710 $Backlink = $opt_backlink if defined $opt_backlink;
711 $Cachedir = $opt_cachedir if defined $opt_cachedir;
712 $Css = $opt_css if defined $opt_css;
713 $Header = $opt_header if defined $opt_header;
714 $Htmldir = $opt_htmldir if defined $opt_htmldir;
715 $Htmlroot = $opt_htmlroot if defined $opt_htmlroot;
716 $Doindex = $opt_index if defined $opt_index;
717 $Podfile = $opt_infile if defined $opt_infile;
99a6169d 718 $HiddenDirs = $opt_hiddendirs if defined $opt_hiddendirs;
69348ecf
MS
719 $Htmlfile = $opt_outfile if defined $opt_outfile;
720 $Podroot = $opt_podroot if defined $opt_podroot;
721 $Quiet = $opt_quiet if defined $opt_quiet;
722 $Recurse = $opt_recurse if defined $opt_recurse;
723 $Title = $opt_title if defined $opt_title;
724 $Verbose = $opt_verbose if defined $opt_verbose;
0e4548d5 725
54310121
PP
726 warn "Flushing item and directory caches\n"
727 if $opt_verbose && defined $opt_flush;
69348ecf
MS
728 $Dircache = "$Cachedir/pod2htmd.tmp";
729 $Itemcache = "$Cachedir/pod2htmi.tmp";
383e43c7 730 if (defined $opt_flush) {
69348ecf 731 1 while unlink($Dircache, $Itemcache);
383e43c7 732 }
54310121
PP
733}
734
3e3baf6d 735
69348ecf 736my $Saved_Cache_Key;
3e3baf6d
TB
737
738sub get_cache {
739 my($dircache, $itemcache, $podpath, $podroot, $recurse) = @_;
740 my @cache_key_args = @_;
741
742 # A first-level cache:
743 # Don't bother reading the cache files if they still apply
744 # and haven't changed since we last read them.
745
746 my $this_cache_key = cache_key(@cache_key_args);
747
69348ecf 748 return if $Saved_Cache_Key and $this_cache_key eq $Saved_Cache_Key;
3e3baf6d 749
69348ecf 750 # load the cache of %Pages and %Items if possible. $tests will be
3e3baf6d
TB
751 # non-zero if successful.
752 my $tests = 0;
753 if (-f $dircache && -f $itemcache) {
69348ecf 754 warn "scanning for item cache\n" if $Verbose;
3e3baf6d
TB
755 $tests = load_cache($dircache, $itemcache, $podpath, $podroot);
756 }
757
758 # if we didn't succeed in loading the cache then we must (re)build
69348ecf 759 # %Pages and %Items.
3e3baf6d 760 if (!$tests) {
69348ecf 761 warn "scanning directories in pod-path\n" if $Verbose;
3e3baf6d
TB
762 scan_podpath($podroot, $recurse, 0);
763 }
69348ecf 764 $Saved_Cache_Key = cache_key(@cache_key_args);
3e3baf6d
TB
765}
766
767sub cache_key {
768 my($dircache, $itemcache, $podpath, $podroot, $recurse) = @_;
769 return join('!', $dircache, $itemcache, $recurse,
29f227c9 770 @$podpath, $podroot, stat($dircache), stat($itemcache));
3e3baf6d
TB
771}
772
54310121 773#
3e3baf6d 774# load_cache - tries to find if the caches stored in $dircache and $itemcache
69348ecf 775# are valid caches of %Pages and %Items. if they are valid then it loads
54310121
PP
776# them and returns a non-zero value.
777#
3e3baf6d 778sub load_cache {
54310121
PP
779 my($dircache, $itemcache, $podpath, $podroot) = @_;
780 my($tests);
781 local $_;
782
783 $tests = 0;
784
785 open(CACHE, "<$itemcache") ||
786 die "$0: error opening $itemcache for reading: $!\n";
787 $/ = "\n";
788
789 # is it the same podpath?
790 $_ = <CACHE>;
791 chomp($_);
3e3baf6d 792 $tests++ if (join(":", @$podpath) eq $_);
54310121
PP
793
794 # is it the same podroot?
795 $_ = <CACHE>;
796 chomp($_);
797 $tests++ if ($podroot eq $_);
798
799 # load the cache if its good
800 if ($tests != 2) {
801 close(CACHE);
54310121
PP
802 return 0;
803 }
804
69348ecf 805 warn "loading item cache\n" if $Verbose;
54310121
PP
806 while (<CACHE>) {
807 /(.*?) (.*)$/;
69348ecf 808 $Items{$1} = $2;
54310121
PP
809 }
810 close(CACHE);
811
69348ecf 812 warn "scanning for directory cache\n" if $Verbose;
54310121
PP
813 open(CACHE, "<$dircache") ||
814 die "$0: error opening $dircache for reading: $!\n";
815 $/ = "\n";
816 $tests = 0;
817
818 # is it the same podpath?
819 $_ = <CACHE>;
820 chomp($_);
3e3baf6d 821 $tests++ if (join(":", @$podpath) eq $_);
54310121
PP
822
823 # is it the same podroot?
824 $_ = <CACHE>;
825 chomp($_);
826 $tests++ if ($podroot eq $_);
827
828 # load the cache if its good
829 if ($tests != 2) {
830 close(CACHE);
54310121
PP
831 return 0;
832 }
833
69348ecf 834 warn "loading directory cache\n" if $Verbose;
54310121
PP
835 while (<CACHE>) {
836 /(.*?) (.*)$/;
69348ecf 837 $Pages{$1} = $2;
54310121
PP
838 }
839
840 close(CACHE);
841
842 return 1;
843}
844
845#
846# scan_podpath - scans the directories specified in @podpath for directories,
847# .pod files, and .pm files. it also scans the pod files specified in
69348ecf 848# @Libpods for =item directives.
54310121
PP
849#
850sub scan_podpath {
3e3baf6d 851 my($podroot, $recurse, $append) = @_;
54310121
PP
852 my($pwd, $dir);
853 my($libpod, $dirname, $pod, @files, @poddata);
854
3e3baf6d 855 unless($append) {
69348ecf
MS
856 %Items = ();
857 %Pages = ();
3e3baf6d
TB
858 }
859
69348ecf 860 # scan each directory listed in @Podpath
54310121
PP
861 $pwd = getcwd();
862 chdir($podroot)
863 || die "$0: error changing to directory $podroot: $!\n";
69348ecf 864 foreach $dir (@Podpath) {
54310121
PP
865 scan_dir($dir, $recurse);
866 }
867
69348ecf
MS
868 # scan the pods listed in @Libpods for =item directives
869 foreach $libpod (@Libpods) {
54310121
PP
870 # if the page isn't defined then we won't know where to find it
871 # on the system.
69348ecf 872 next unless defined $Pages{$libpod} && $Pages{$libpod};
54310121
PP
873
874 # if there is a directory then use the .pod and .pm files within it.
29f227c9 875 # NOTE: Only finds the first so-named directory in the tree.
69348ecf
MS
876# if ($Pages{$libpod} =~ /([^:]*[^(\.pod|\.pm)]):/) {
877 if ($Pages{$libpod} =~ /([^:]*(?<!\.pod)(?<!\.pm)):/) {
54310121
PP
878 # find all the .pod and .pm files within the directory
879 $dirname = $1;
880 opendir(DIR, $dirname) ||
881 die "$0: error opening directory $dirname: $!\n";
fe6f1558 882 @files = grep(/(\.pod|\.pm)\z/ && ! -d $_, readdir(DIR));
54310121
PP
883 closedir(DIR);
884
885 # scan each .pod and .pm file for =item directives
886 foreach $pod (@files) {
887 open(POD, "<$dirname/$pod") ||
888 die "$0: error opening $dirname/$pod for input: $!\n";
889 @poddata = <POD>;
890 close(POD);
2a28b791 891 clean_data( \@poddata );
54310121 892
69348ecf 893 scan_items( \%Items, "$dirname/$pod", @poddata);
54310121
PP
894 }
895
896 # use the names of files as =item directives too.
2a28b791
GS
897### Don't think this should be done this way - confuses issues.(WL)
898### foreach $pod (@files) {
899### $pod =~ /^(.*)(\.pod|\.pm)$/;
69348ecf 900### $Items{$1} = "$dirname/$1.html" if $1;
2a28b791 901### }
69348ecf
MS
902 } elsif ($Pages{$libpod} =~ /([^:]*\.pod):/ ||
903 $Pages{$libpod} =~ /([^:]*\.pm):/) {
54310121
PP
904 # scan the .pod or .pm file for =item directives
905 $pod = $1;
906 open(POD, "<$pod") ||
907 die "$0: error opening $pod for input: $!\n";
908 @poddata = <POD>;
909 close(POD);
2a28b791 910 clean_data( \@poddata );
54310121 911
69348ecf 912 scan_items( \%Items, "$pod", @poddata);
54310121 913 } else {
ac094485 914 warn "$0: shouldn't be here (line ".__LINE__."\n" unless $Quiet;
54310121
PP
915 }
916 }
917 @poddata = (); # clean-up a bit
918
919 chdir($pwd)
920 || die "$0: error changing to directory $pwd: $!\n";
921
922 # cache the item list for later use
69348ecf
MS
923 warn "caching items for later use\n" if $Verbose;
924 open(CACHE, ">$Itemcache") ||
925 die "$0: error open $Itemcache for writing: $!\n";
54310121 926
69348ecf
MS
927 print CACHE join(":", @Podpath) . "\n$podroot\n";
928 foreach my $key (keys %Items) {
929 print CACHE "$key $Items{$key}\n";
54310121
PP
930 }
931
932 close(CACHE);
933
934 # cache the directory list for later use
69348ecf
MS
935 warn "caching directories for later use\n" if $Verbose;
936 open(CACHE, ">$Dircache") ||
937 die "$0: error open $Dircache for writing: $!\n";
54310121 938
69348ecf
MS
939 print CACHE join(":", @Podpath) . "\n$podroot\n";
940 foreach my $key (keys %Pages) {
941 print CACHE "$key $Pages{$key}\n";
54310121
PP
942 }
943
944 close(CACHE);
945}
946
947#
948# scan_dir - scans the directory specified in $dir for subdirectories, .pod
949# files, and .pm files. notes those that it finds. this information will
950# be used later in order to figure out where the pages specified in L<>
951# links are on the filesystem.
952#
953sub scan_dir {
954 my($dir, $recurse) = @_;
955 my($t, @subdirs, @pods, $pod, $dirname, @dirs);
956 local $_;
957
958 @subdirs = ();
959 @pods = ();
960
961 opendir(DIR, $dir) ||
962 die "$0: error opening directory $dir: $!\n";
963 while (defined($_ = readdir(DIR))) {
99a6169d
AJ
964 if (-d "$dir/$_" && $_ ne "." && $_ ne ".."
965 && ($HiddenDirs || !/^\./)
966 ) { # directory
69348ecf
MS
967 $Pages{$_} = "" unless defined $Pages{$_};
968 $Pages{$_} .= "$dir/$_:";
54310121 969 push(@subdirs, $_);
fe6f1558
GS
970 } elsif (/\.pod\z/) { # .pod
971 s/\.pod\z//;
69348ecf
MS
972 $Pages{$_} = "" unless defined $Pages{$_};
973 $Pages{$_} .= "$dir/$_.pod:";
54310121 974 push(@pods, "$dir/$_.pod");
d3f9d0fb
SB
975 } elsif (/\.html\z/) { # .html
976 s/\.html\z//;
69348ecf
MS
977 $Pages{$_} = "" unless defined $Pages{$_};
978 $Pages{$_} .= "$dir/$_.pod:";
fe6f1558
GS
979 } elsif (/\.pm\z/) { # .pm
980 s/\.pm\z//;
69348ecf
MS
981 $Pages{$_} = "" unless defined $Pages{$_};
982 $Pages{$_} .= "$dir/$_.pm:";
54310121 983 push(@pods, "$dir/$_.pm");
945ffa4f
EH
984 } elsif (-T "$dir/$_") { # script(?)
985 local *F;
986 if (open(F, "$dir/$_")) {
987 my $line;
988 while (defined($line = <F>)) {
989 if ($line =~ /^=(?:pod|head1)/) {
990 $Pages{$_} = "" unless defined $Pages{$_};
991 $Pages{$_} .= "$dir/$_.pod:";
992 last;
993 }
994 }
995 close(F);
996 }
54310121
PP
997 }
998 }
999 closedir(DIR);
1000
1001 # recurse on the subdirectories if necessary
1002 if ($recurse) {
1003 foreach my $subdir (@subdirs) {
1004 scan_dir("$dir/$subdir", $recurse);
1005 }
1006 }
1007}
1008
1009#
1010# scan_headings - scan a pod file for head[1-6] tags, note the tags, and
1011# build an index.
1012#
1013sub scan_headings {
1014 my($sections, @data) = @_;
2a28b791 1015 my($tag, $which_head, $otitle, $listdepth, $index);
54310121 1016
69348ecf 1017 local $Ignore = 0;
be173d55 1018
54310121
PP
1019 $listdepth = 0;
1020 $index = "";
1021
1022 # scan for =head directives, note their name, and build an index
1023 # pointing to each of them.
1024 foreach my $line (@data) {
59ecbafa
VS
1025 if ($line =~ /^=(head)([1-6])\s+(.*)/) {
1026 ($tag, $which_head, $otitle) = ($1,$2,$3);
2a28b791 1027
59ecbafa 1028 my $title = depod( $otitle );
2beb85b7 1029 my $name = anchorify( $title );
59ecbafa 1030 $$sections{$name} = 1;
59ecbafa 1031 $title = process_text( \$otitle );
54310121 1032
102c538a
DS
1033 while ($which_head != $listdepth) {
1034 if ($which_head > $listdepth) {
59ecbafa 1035 $index .= "\n" . ("\t" x $listdepth) . "<ul>\n";
102c538a
DS
1036 $listdepth++;
1037 } elsif ($which_head < $listdepth) {
1038 $listdepth--;
59ecbafa 1039 $index .= "\n" . ("\t" x $listdepth) . "</ul>\n";
102c538a 1040 }
54310121 1041 }
54310121 1042
59ecbafa
VS
1043 $index .= "\n" . ("\t" x $listdepth) . "<li>" .
1044 "<a href=\"#" . $name . "\">" .
1045 $title . "</a></li>";
54310121
PP
1046 }
1047 }
1048
1049 # finish off the lists
1050 while ($listdepth--) {
59ecbafa 1051 $index .= "\n" . ("\t" x $listdepth) . "</ul>\n";
54310121
PP
1052 }
1053
1054 # get rid of bogus lists
59ecbafa 1055 $index =~ s,\t*<ul>\s*</ul>\n,,g;
54310121
PP
1056
1057 return $index;
1058}
1059
1060#
1061# scan_items - scans the pod specified by $pod for =item directives. we
1062# will use this information later on in resolving C<> links.
1063#
1064sub scan_items {
2a28b791 1065 my( $itemref, $pod, @poddata ) = @_;
54310121
PP
1066 my($i, $item);
1067 local $_;
1068
fe6f1558 1069 $pod =~ s/\.pod\z//;
54310121
PP
1070 $pod .= ".html" if $pod;
1071
1072 foreach $i (0..$#poddata) {
2a28b791
GS
1073 my $txt = depod( $poddata[$i] );
1074
1075 # figure out what kind of item it is.
1076 # Build string for referencing this item.
1077 if ( $txt =~ /\A=item\s+\*\s*(.*)\Z/s ) { # bullet
1078 next unless $1;
1079 $item = $1;
1080 } elsif( $txt =~ /\A=item\s+(?>\d+\.?)\s*(.*)\Z/s ) { # numbered list
1081 $item = $1;
1082 } elsif( $txt =~ /\A=item\s+(.*)\Z/s ) { # plain item
1083 $item = $1;
1084 } else {
1085 next;
54310121 1086 }
2a28b791
GS
1087 my $fid = fragment_id( $item );
1088 $$itemref{$fid} = "$pod" if $fid;
54310121
PP
1089 }
1090}
1091
1092#
1093# process_head - convert a pod head[1-6] tag and convert it to HTML format.
1094#
1095sub process_head {
2a28b791 1096 my($tag, $heading, $hasindex) = @_;
54310121
PP
1097
1098 # figure out the level of the =head
1099 $tag =~ /head([1-6])/;
1100 my $level = $1;
1101
69348ecf 1102 if( $Listlevel ){
ac094485 1103 warn "$0: $Podfile: unterminated list at =head in paragraph $Paragraph. ignoring.\n" unless $Quiet;
69348ecf 1104 while( $Listlevel ){
2a28b791
GS
1105 process_back();
1106 }
1107 }
1108
59ecbafa 1109 print HTML "<p>\n";
69348ecf
MS
1110 if( $level == 1 && ! $Top ){
1111 print HTML "<a href=\"#__index__\"><small>$Backlink</small></a>\n"
1112 if $hasindex and $Backlink;
59ecbafa
VS
1113 print HTML "</p>\n<hr />\n"
1114 } else {
1115 print HTML "</p>\n";
2a28b791
GS
1116 }
1117
0d396dd4 1118 my $name = anchorify( depod( $heading ) );
2a28b791 1119 my $convert = process_text( \$heading );
59ecbafa 1120 print HTML "<h$level><a name=\"$name\">$convert</a></h$level>\n";
54310121
PP
1121}
1122
2a28b791 1123
54310121 1124#
2a28b791
GS
1125# emit_item_tag - print an =item's text
1126# Note: The global $EmittedItem is used for inhibiting self-references.
54310121 1127#
2a28b791
GS
1128my $EmittedItem;
1129
1130sub emit_item_tag($$$){
1131 my( $otext, $text, $compact ) = @_;
bc75160c 1132 my $item = fragment_id( $text , -generate);
54310121 1133
2a28b791
GS
1134 $EmittedItem = $item;
1135 ### print STDERR "emit_item_tag=$item ($text)\n";
54310121 1136
59ecbafa 1137 print HTML '<strong>';
69348ecf 1138 if ($Items_Named{$item}++) {
2a28b791
GS
1139 print HTML process_text( \$otext );
1140 } else {
bc75160c 1141 my $name = $item;
0d396dd4 1142 $name = anchorify($name);
bc75160c 1143 print HTML qq{<a name="$name" class="item">}, process_text( \$otext ), '</a>';
2a28b791 1144 }
945ffa4f 1145 print HTML "</strong>\n";
2a28b791
GS
1146 undef( $EmittedItem );
1147}
1148
1149sub emit_li {
1150 my( $tag ) = @_;
69348ecf
MS
1151 if( $Items_Seen[$Listlevel]++ == 0 ){
1152 push( @Listend, "</$tag>" );
2a28b791
GS
1153 print HTML "<$tag>\n";
1154 }
59ecbafa
VS
1155 my $emitted = $tag eq 'dl' ? 'dt' : 'li';
1156 print HTML "<$emitted>";
1157 return $emitted;
2a28b791
GS
1158}
1159
1160#
1161# process_item - convert a pod item tag and convert it to HTML format.
1162#
1163sub process_item {
1164 my( $otext ) = @_;
59ecbafa 1165 my $need_dd = 0; # set to 1 if we need a <dd></dd> after an item
54310121
PP
1166
1167 # lots of documents start a list without doing an =over. this is
1168 # bad! but, the proper thing to do seems to be to just assume
1169 # they did do an =over. so warn them once and then continue.
69348ecf 1170 if( $Listlevel == 0 ){
ac094485 1171 warn "$0: $Podfile: unexpected =item directive in paragraph $Paragraph. ignoring.\n" unless $Quiet;
2a28b791
GS
1172 process_over();
1173 }
54310121 1174
2a28b791 1175 # formatting: insert a paragraph if preceding item has >1 paragraph
69348ecf 1176 if( $After_Lpar ){
945ffa4f 1177 print HTML $need_dd ? "</dd>\n" : "</li>\n" if $After_Lpar;
69348ecf 1178 $After_Lpar = 0;
2a28b791 1179 }
54310121
PP
1180
1181 # remove formatting instructions from the text
2a28b791
GS
1182 my $text = depod( $otext );
1183
59ecbafa
VS
1184 my $emitted; # the tag actually emitted, used for closing
1185
2a28b791
GS
1186 # all the list variants:
1187 if( $text =~ /\A\*/ ){ # bullet
59ecbafa
VS
1188 $emitted = emit_li( 'ul' );
1189 if ($text =~ /\A\*\s+(.+)\Z/s ) { # with additional text
1190 my $tag = $1;
1191 $otext =~ s/\A\*\s+//;
1192 emit_item_tag( $otext, $tag, 1 );
1193 }
54310121 1194
2a28b791 1195 } elsif( $text =~ /\A\d+/ ){ # numbered list
59ecbafa
VS
1196 $emitted = emit_li( 'ol' );
1197 if ($text =~ /\A(?>\d+\.?)\s*(.+)\Z/s ) { # with additional text
1198 my $tag = $1;
1199 $otext =~ s/\A\d+\.?\s*//;
1200 emit_item_tag( $otext, $tag, 1 );
1201 }
54310121 1202
2a28b791 1203 } else { # definition list
59ecbafa
VS
1204 $emitted = emit_li( 'dl' );
1205 if ($text =~ /\A(.+)\Z/s ){ # should have text
1206 emit_item_tag( $otext, $text, 1 );
1207 }
1208 $need_dd = 1;
54310121 1209 }
54310121 1210 print HTML "\n";
59ecbafa 1211 return $need_dd;
54310121
PP
1212}
1213
1214#
2a28b791 1215# process_over - process a pod over tag and start a corresponding HTML list.
54310121
PP
1216#
1217sub process_over {
1218 # start a new list
69348ecf
MS
1219 $Listlevel++;
1220 push( @Items_Seen, 0 );
1221 $After_Lpar = 0;
54310121
PP
1222}
1223
1224#
1225# process_back - process a pod back tag and convert it to HTML format.
1226#
1227sub process_back {
945ffa4f 1228 my $need_dd = shift;
69348ecf 1229 if( $Listlevel == 0 ){
ac094485 1230 warn "$0: $Podfile: unexpected =back directive in paragraph $Paragraph. ignoring.\n" unless $Quiet;
2a28b791
GS
1231 return;
1232 }
54310121 1233
69348ecf 1234 # close off the list. note, I check to see if $Listend[$Listlevel] is
54310121 1235 # defined because an =item directive may have never appeared and thus
69348ecf
MS
1236 # $Listend[$Listlevel] may have never been initialized.
1237 $Listlevel--;
1238 if( defined $Listend[$Listlevel] ){
945ffa4f 1239 print HTML $need_dd ? "</dd>\n" : "</li>\n" if $After_Lpar;
69348ecf 1240 print HTML $Listend[$Listlevel];
2a28b791 1241 print HTML "\n";
69348ecf 1242 pop( @Listend );
2a28b791 1243 }
69348ecf 1244 $After_Lpar = 0;
54310121 1245
2a28b791 1246 # clean up item count
69348ecf 1247 pop( @Items_Seen );
54310121
PP
1248}
1249
1250#
2a28b791 1251# process_cut - process a pod cut tag, thus start ignoring pod directives.
54310121
PP
1252#
1253sub process_cut {
69348ecf 1254 $Ignore = 1;
54310121
PP
1255}
1256
1257#
d1be9408 1258# process_pod - process a pod tag, thus stop ignoring pod directives
2a28b791 1259# until we see a corresponding cut.
54310121
PP
1260#
1261sub process_pod {
69348ecf 1262 # no need to set $Ignore to 0 cause the main loop did it
54310121
PP
1263}
1264
1265#
2a28b791 1266# process_for - process a =for pod tag. if it's for html, spit
c4d9b39d 1267# it out verbatim, if illustration, center it, otherwise ignore it.
54310121
PP
1268#
1269sub process_for {
1270 my($whom, $text) = @_;
1271 if ( $whom =~ /^(pod2)?html$/i) {
1272 print HTML $text;
c4d9b39d
IZ
1273 } elsif ($whom =~ /^illustration$/i) {
1274 1 while chomp $text;
1275 for my $ext (qw[.png .gif .jpeg .jpg .tga .pcl .bmp]) {
1276 $text .= $ext, last if -r "$text$ext";
1277 }
59ecbafa 1278 print HTML qq{<p align="center"><img src="$text" alt="$text illustration" /></p>};
c4d9b39d 1279 }
54310121
PP
1280}
1281
1282#
1283# process_begin - process a =begin pod tag. this pushes
1284# whom we're beginning on the begin stack. if there's a
1285# begin stack, we only print if it us.
1286#
1287sub process_begin {
1288 my($whom, $text) = @_;
1289 $whom = lc($whom);
69348ecf 1290 push (@Begin_Stack, $whom);
54310121
PP
1291 if ( $whom =~ /^(pod2)?html$/) {
1292 print HTML $text if $text;
1293 }
1294}
1295
1296#
1297# process_end - process a =end pod tag. pop the
1298# begin stack. die if we're mismatched.
1299#
1300sub process_end {
1301 my($whom, $text) = @_;
1302 $whom = lc($whom);
69348ecf
MS
1303 if ($Begin_Stack[-1] ne $whom ) {
1304 die "Unmatched begin/end at chunk $Paragraph\n"
59ecbafa 1305 }
69348ecf 1306 pop( @Begin_Stack );
54310121
PP
1307}
1308
1309#
59ecbafa 1310# process_pre - indented paragraph, made into <pre></pre>
54310121 1311#
2a28b791
GS
1312sub process_pre {
1313 my( $text ) = @_;
1314 my( $rest );
69348ecf 1315 return if $Ignore;
54310121 1316
54310121
PP
1317 $rest = $$text;
1318
2a28b791 1319 # insert spaces in place of tabs
24e08cba
JF
1320 $rest =~ s#(.+)#
1321 my $line = $1;
1322 1 while $line =~ s/(\t+)/' ' x ((length($1) * 8) - $-[0] % 8)/e;
be173d55
UC
1323 $line;
1324 #eg;
54310121 1325
2a28b791 1326 # convert some special chars to HTML escapes
59ecbafa 1327 $rest = html_escape($rest);
2a28b791
GS
1328
1329 # try and create links for all occurrences of perl.* within
1330 # the preformatted text.
1331 $rest =~ s{
1332 (\s*)(perl\w+)
1333 }{
69348ecf
MS
1334 if ( defined $Pages{$2} ){ # is a link
1335 qq($1<a href="$Htmlroot/$Pages{$2}">$2</a>);
1336 } elsif (defined $Pages{dosify($2)}) { # is a link
1337 qq($1<a href="$Htmlroot/$Pages{dosify($2)}">$2</a>);
2a28b791
GS
1338 } else {
1339 "$1$2";
1340 }
1341 }xeg;
1342 $rest =~ s{
59ecbafa 1343 (<a\ href="?) ([^>:]*:)? ([^>:]*) \.pod: ([^>:]*:)?
2a28b791
GS
1344 }{
1345 my $url ;
69348ecf 1346 if ( $Htmlfileurl ne '' ){
59ecbafa 1347 # Here, we take advantage of the knowledge
69348ecf
MS
1348 # that $Htmlfileurl ne '' implies $Htmlroot eq ''.
1349 # Since $Htmlroot eq '', we need to prepend $Htmldir
2a28b791
GS
1350 # on the fron of the link to get the absolute path
1351 # of the link's target. We check for a leading '/'
1352 # to avoid corrupting links that are #, file:, etc.
1353 my $old_url = $3 ;
69348ecf
MS
1354 $old_url = "$Htmldir$old_url" if $old_url =~ m{^\/};
1355 $url = relativize_url( "$old_url.html", $Htmlfileurl );
2a28b791
GS
1356 } else {
1357 $url = "$3.html" ;
1358 }
1359 "$1$url" ;
1360 }xeg;
1361
1362 # Look for embedded URLs and make them into links. We don't
1363 # relativize them since they are best left as the author intended.
1364
1365 my $urls = '(' . join ('|', qw{
54310121
PP
1366 http
1367 telnet
1368 mailto
1369 news
1370 gopher
1371 file
1372 wais
1373 ftp
59ecbafa 1374 } )
54310121 1375 . ')';
59ecbafa 1376
2a28b791
GS
1377 my $ltrs = '\w';
1378 my $gunk = '/#~:.?+=&%@!\-';
add5afb0 1379 my $punc = '.:!?\-;';
2a28b791 1380 my $any = "${ltrs}${gunk}${punc}";
54310121 1381
2a28b791 1382 $rest =~ s{
69e2f044
D
1383 \b # start at word boundary
1384 ( # begin $1 {
1385 $urls : # need resource and a colon
1386 (?!:) # Ignore File::, among others.
1387 [$any] +? # followed by one or more of any valid
1388 # character, but be conservative and
1389 # take only what you need to....
1390 ) # end $1 }
1391 (?=
1392 &quot; &gt; # maybe pre-quoted '<a href="...">'
1393 | # or:
1394 [$punc]* # 0 or more punctuation
1395 (?: # followed
1396 [^$any] # by a non-url char
1397 | # or
1398 $ # end of the string
1399 ) #
1400 | # or else
1401 $ # then end of the string
54310121 1402 )
59ecbafa 1403 }{<a href="$1">$1</a>}igox;
54310121 1404
2a28b791
GS
1405 # text should be as it is (verbatim)
1406 $$text = $rest;
1407}
54310121 1408
54310121 1409
2a28b791
GS
1410#
1411# pure text processing
1412#
1413# pure_text/inIS_text: differ with respect to automatic C<> recognition.
1414# we don't want this to happen within IS
1415#
1416sub pure_text($){
1417 my $text = shift();
03b1081f 1418 process_puretext( $text, 1 );
54310121
PP
1419}
1420
2a28b791
GS
1421sub inIS_text($){
1422 my $text = shift();
03b1081f 1423 process_puretext( $text, 0 );
2a28b791 1424}
54310121
PP
1425
1426#
1427# process_puretext - process pure text (without pod-escapes) converting
1428# double-quotes and handling implicit C<> links.
1429#
1430sub process_puretext {
03b1081f 1431 my($text, $notinIS) = @_;
54310121 1432
fab416db 1433 ## Guessing at func() or [\$\@%&]*var references in plain text is destined
2a28b791
GS
1434 ## to produce some strange looking ref's. uncomment to disable:
1435 ## $notinIS = 0;
1436
1437 my(@words, $lead, $trail);
54310121 1438
54310121 1439 # keep track of leading and trailing white-space
2a28b791
GS
1440 $lead = ($text =~ s/\A(\s+)//s ? $1 : "");
1441 $trail = ($text =~ s/(\s+)\Z//s ? $1 : "");
54310121 1442
2a28b791
GS
1443 # split at space/non-space boundaries
1444 @words = split( /(?<=\s)(?=\S)|(?<=\S)(?=\s)/, $text );
54310121
PP
1445
1446 # process each word individually
1447 foreach my $word (@words) {
2a28b791
GS
1448 # skip space runs
1449 next if $word =~ /^\s*$/;
54310121 1450 # see if we can infer a link
02369fa5 1451 if( $notinIS && $word =~ /^(\w+)\((.*)\)$/ ) {
54310121 1452 # has parenthesis so should have been a C<> ref
2a28b791 1453 ## try for a pagename (perlXXX(1))?
02369fa5
GS
1454 my( $func, $args ) = ( $1, $2 );
1455 if( $args =~ /^\d+$/ ){
2a28b791
GS
1456 my $url = page_sect( $word, '' );
1457 if( defined $url ){
59ecbafa 1458 $word = "<a href=\"$url\">the $word manpage</a>";
2a28b791
GS
1459 next;
1460 }
1461 }
02369fa5
GS
1462 ## try function name for a link, append tt'ed argument list
1463 $word = emit_C( $func, '', "($args)");
2a28b791
GS
1464
1465#### disabled. either all (including $\W, $\w+{.*} etc.) or nothing.
1466## } elsif( $notinIS && $word =~ /^[\$\@%&*]+\w+$/) {
1467## # perl variables, should be a C<> ref
1468## $word = emit_C( $word );
1469
54310121
PP
1470 } elsif ($word =~ m,^\w+://\w,) {
1471 # looks like a URL
5a039dd3 1472 # Don't relativize it: leave it as the author intended
59ecbafa 1473 $word = qq(<a href="$word">$word</a>);
af47ee55 1474 } elsif ($word =~ /[\w.-]+\@[\w-]+\.\w/) {
54310121 1475 # looks like an e-mail address
7b8d334a
GS
1476 my ($w1, $w2, $w3) = ("", $word, "");
1477 ($w1, $w2, $w3) = ("(", $1, ")$2") if $word =~ /^\((.*?)\)(,?)/;
1478 ($w1, $w2, $w3) = ("&lt;", $1, "&gt;$2") if $word =~ /^<(.*?)>(,?)/;
59ecbafa
VS
1479 $word = qq($w1<a href="mailto:$w2">$w2</a>$w3);
1480 } else {
7b8d334a 1481 $word = html_escape($word) if $word =~ /["&<>]/;
54310121
PP
1482 }
1483 }
1484
2a28b791
GS
1485 # put everything back together
1486 return $lead . join( '', @words ) . $trail;
1487}
1488
54310121 1489
2a28b791
GS
1490#
1491# process_text - handles plaintext that appears in the input pod file.
1492# there may be pod commands embedded within the text so those must be
1493# converted to html commands.
1494#
7ba65c74 1495
c68ea5d1
GS
1496sub process_text1($$;$$);
1497sub pattern ($) { $_[0] ? '[^\S\n]+'.('>' x ($_[0] + 1)) : '>' }
1498sub closing ($) { local($_) = shift; (defined && s/\s+$//) ? length : 0 }
7ba65c74 1499
2a28b791 1500sub process_text {
69348ecf 1501 return if $Ignore;
2a28b791
GS
1502 my( $tref ) = @_;
1503 my $res = process_text1( 0, $tref );
066b3271 1504 $res =~ s/\s+$//s;
2a28b791
GS
1505 $$tref = $res;
1506}
1507
f9568fed
JA
1508sub process_text_rfc_links {
1509 my $text = shift;
1510
5d05e460
JA
1511 # For every "RFCnnnn" or "RFC nnn", link it to the authoritative
1512 # ource. Do not use the /i modifier here. Require "RFC" to be written in
f9568fed
JA
1513 # in capital letters.
1514
1515 $text =~ s{
5d05e460
JA
1516 (?<=[^<>[:alpha:]]) # Make sure this is not an URL already
1517 (RFC\s*([0-9]{1,5}))(?![0-9]) # max 5 digits
f9568fed 1518 }
5d05e460 1519 {<a href="http://www.ietf.org/rfc/rfc$3.txt" class="rfc">$1</a>}gx;
f9568fed
JA
1520
1521 $text;
1522}
1523
c68ea5d1
GS
1524sub process_text1($$;$$){
1525 my( $lev, $rstr, $func, $closing ) = @_;
2a28b791
GS
1526 my $res = '';
1527
60a48b2d
GS
1528 unless (defined $func) {
1529 $func = '';
1530 $lev++;
1531 }
1532
2a28b791
GS
1533 if( $func eq 'B' ){
1534 # B<text> - boldface
59ecbafa 1535 $res = '<strong>' . process_text1( $lev, $rstr ) . '</strong>';
2a28b791
GS
1536
1537 } elsif( $func eq 'C' ){
59ecbafa 1538 # C<code> - can be a ref or <code></code>
2a28b791 1539 # need to extract text
c68ea5d1 1540 my $par = go_ahead( $rstr, 'C', $closing );
2a28b791
GS
1541
1542 ## clean-up of the link target
1543 my $text = depod( $par );
1544
1545 ### my $x = $par =~ /[BI]</ ? 'yes' : 'no' ;
59ecbafa 1546 ### print STDERR "-->call emit_C($par) lev=$lev, par with BI=$x\n";
2a28b791
GS
1547
1548 $res = emit_C( $text, $lev > 1 || ($par =~ /[BI]</) );
1549
1550 } elsif( $func eq 'E' ){
1551 # E<x> - convert to character
be3174d2
GS
1552 $$rstr =~ s/^([^>]*)>//;
1553 my $escape = $1;
1554 $escape =~ s/^(\d+|X[\dA-F]+)$/#$1/i;
1555 $res = "&$escape;";
2a28b791
GS
1556
1557 } elsif( $func eq 'F' ){
8e3df7c8
JA
1558 # F<filename> - italicize
1559 $res = '<em class="file">' . process_text1( $lev, $rstr ) . '</em>';
2a28b791
GS
1560
1561 } elsif( $func eq 'I' ){
8e3df7c8 1562 # I<text> - italicize
59ecbafa 1563 $res = '<em>' . process_text1( $lev, $rstr ) . '</em>';
2a28b791
GS
1564
1565 } elsif( $func eq 'L' ){
1566 # L<link> - link
59ecbafa 1567 ## L<text|cross-ref> => produce text, use cross-ref for linking
2a28b791
GS
1568 ## L<cross-ref> => make text from cross-ref
1569 ## need to extract text
c68ea5d1 1570 my $par = go_ahead( $rstr, 'L', $closing );
2a28b791
GS
1571
1572 # some L<>'s that shouldn't be:
1573 # a) full-blown URL's are emitted as-is
1574 if( $par =~ m{^\w+://}s ){
1575 return make_URL_href( $par );
1576 }
1577 # b) C<...> is stripped and treated as C<>
1578 if( $par =~ /^C<(.*)>$/ ){
1579 my $text = depod( $1 );
1580 return emit_C( $text, $lev > 1 || ($par =~ /[BI]</) );
1581 }
1582
1583 # analyze the contents
1584 $par =~ s/\n/ /g; # undo word-wrapped tags
1585 my $opar = $par;
1586 my $linktext;
1587 if( $par =~ s{^([^|]+)\|}{} ){
1588 $linktext = $1;
1589 }
59ecbafa 1590
2a28b791
GS
1591 # make sure sections start with a /
1592 $par =~ s{^"}{/"};
1593
1594 my( $page, $section, $ident );
1595
1596 # check for link patterns
1597 if( $par =~ m{^([^/]+?)/(?!")(.*?)$} ){ # name/ident
59ecbafa 1598 # we've got a name/ident (no quotes)
2a28b791
GS
1599 ( $page, $ident ) = ( $1, $2 );
1600 ### print STDERR "--> L<$par> to page $page, ident $ident\n";
1601
1602 } elsif( $par =~ m{^(.*?)/"?(.*?)"?$} ){ # [name]/"section"
1603 # even though this should be a "section", we go for ident first
1604 ( $page, $ident ) = ( $1, $2 );
1605 ### print STDERR "--> L<$par> to page $page, section $section\n";
1606
1607 } elsif( $par =~ /\s/ ){ # this must be a section with missing quotes
1608 ( $page, $section ) = ( '', $par );
1609 ### print STDERR "--> L<$par> to void page, section $section\n";
1610
1611 } else {
1612 ( $page, $section ) = ( $par, '' );
1613 ### print STDERR "--> L<$par> to page $par, void section\n";
1614 }
1615
1616 # now, either $section or $ident is defined. the convoluted logic
1617 # below tries to resolve L<> according to what the user specified.
1618 # failing this, we try to find the next best thing...
1619 my( $url, $ltext, $fid );
1620
1621 RESOLVE: {
1622 if( defined $ident ){
1623 ## try to resolve $ident as an item
1624 ( $url, $fid ) = coderef( $page, $ident );
1625 if( $url ){
1626 if( ! defined( $linktext ) ){
1627 $linktext = $ident;
1628 $linktext .= " in " if $ident && $page;
1629 $linktext .= "the $page manpage" if $page;
1630 }
1631 ### print STDERR "got coderef url=$url\n";
1632 last RESOLVE;
1633 }
1634 ## no luck: go for a section (auto-quoting!)
1635 $section = $ident;
1636 }
1637 ## now go for a section
1638 my $htmlsection = htmlify( $section );
1639 $url = page_sect( $page, $htmlsection );
1640 if( $url ){
1641 if( ! defined( $linktext ) ){
1642 $linktext = $section;
1643 $linktext .= " in " if $section && $page;
1644 $linktext .= "the $page manpage" if $page;
1645 }
1646 ### print STDERR "got page/section url=$url\n";
1647 last RESOLVE;
1648 }
59ecbafa 1649 ## no luck: go for an ident
2a28b791
GS
1650 if( $section ){
1651 $ident = $section;
1652 } else {
1653 $ident = $page;
1654 $page = undef();
1655 }
1656 ( $url, $fid ) = coderef( $page, $ident );
1657 if( $url ){
1658 if( ! defined( $linktext ) ){
1659 $linktext = $ident;
1660 $linktext .= " in " if $ident && $page;
1661 $linktext .= "the $page manpage" if $page;
1662 }
1663 ### print STDERR "got section=>coderef url=$url\n";
1664 last RESOLVE;
1665 }
1666
1667 # warning; show some text.
1668 $linktext = $opar unless defined $linktext;
ac094485 1669 warn "$0: $Podfile: cannot resolve L<$opar> in paragraph $Paragraph.\n" unless $Quiet;
2a28b791
GS
1670 }
1671
d1be9408 1672 # now we have a URL or just plain code
2a28b791
GS
1673 $$rstr = $linktext . '>' . $$rstr;
1674 if( defined( $url ) ){
59ecbafa 1675 $res = "<a href=\"$url\">" . process_text1( $lev, $rstr ) . '</a>';
2a28b791 1676 } else {
59ecbafa 1677 $res = '<em>' . process_text1( $lev, $rstr ) . '</em>';
2a28b791
GS
1678 }
1679
1680 } elsif( $func eq 'S' ){
1681 # S<text> - non-breaking spaces
1682 $res = process_text1( $lev, $rstr );
1683 $res =~ s/ /&nbsp;/g;
1684
1685 } elsif( $func eq 'X' ){
1686 # X<> - ignore
1687 $$rstr =~ s/^[^>]*>//;
1688
1689 } elsif( $func eq 'Z' ){
59ecbafa 1690 # Z<> - empty
69348ecf 1691 warn "$0: $Podfile: invalid X<> in paragraph $Paragraph.\n"
ac094485 1692 unless $$rstr =~ s/^>// or $Quiet;
2a28b791
GS
1693
1694 } else {
c68ea5d1
GS
1695 my $term = pattern $closing;
1696 while( $$rstr =~ s/\A(.*?)(([BCEFILSXZ])<(<+[^\S\n]+)?|$term)//s ){
2a28b791 1697 # all others: either recurse into new function or
c68ea5d1 1698 # terminate at closing angle bracket(s)
2a28b791 1699 my $pt = $1;
c68ea5d1 1700 $pt .= $2 if !$3 && $lev == 1;
2a28b791 1701 $res .= $lev == 1 ? pure_text( $pt ) : inIS_text( $pt );
c68ea5d1
GS
1702 return $res if !$3 && $lev > 1;
1703 if( $3 ){
1704 $res .= process_text1( $lev, $rstr, $3, closing $4 );
1705 }
2a28b791
GS
1706 }
1707 if( $lev == 1 ){
1708 $res .= pure_text( $$rstr );
54310121 1709 } else {
ac094485 1710 warn "$0: $Podfile: undelimited $func<> in paragraph $Paragraph.\n" unless $Quiet;
54310121 1711 }
f9568fed 1712 $res = process_text_rfc_links($res);
54310121 1713 }
2a28b791
GS
1714 return $res;
1715}
54310121 1716
2a28b791
GS
1717#
1718# go_ahead: extract text of an IS (can be nested)
1719#
c68ea5d1
GS
1720sub go_ahead($$$){
1721 my( $rstr, $func, $closing ) = @_;
2a28b791 1722 my $res = '';
c68ea5d1
GS
1723 my @closing = ($closing);
1724 while( $$rstr =~
1725 s/\A(.*?)(([BCEFILSXZ])<(<+[^\S\n]+)?|@{[pattern $closing[0]]})//s ){
2a28b791 1726 $res .= $1;
c68ea5d1
GS
1727 unless( $3 ){
1728 shift @closing;
1729 return $res unless @closing;
2a28b791 1730 } else {
c68ea5d1 1731 unshift @closing, closing $4;
2a28b791
GS
1732 }
1733 $res .= $2;
1734 }
ac094485 1735 warn "$0: $Podfile: undelimited $func<> in paragraph $Paragraph.\n" unless $Quiet;
2a28b791 1736 return $res;
54310121
PP
1737}
1738
1739#
2a28b791
GS
1740# emit_C - output result of C<text>
1741# $text is the depod-ed text
54310121 1742#
02369fa5
GS
1743sub emit_C($;$$){
1744 my( $text, $nocode, $args ) = @_;
60a48b2d 1745 $args = '' unless defined $args;
2a28b791
GS
1746 my $res;
1747 my( $url, $fid ) = coderef( undef(), $text );
1748
1749 # need HTML-safe text
02369fa5 1750 my $linktext = html_escape( "$text$args" );
2a28b791
GS
1751
1752 if( defined( $url ) &&
1753 (!defined( $EmittedItem ) || $EmittedItem ne $fid ) ){
59ecbafa 1754 $res = "<a href=\"$url\"><code>$linktext</code></a>";
2a28b791
GS
1755 } elsif( 0 && $nocode ){
1756 $res = $linktext;
1757 } else {
59ecbafa 1758 $res = "<code>$linktext</code>";
2a28b791
GS
1759 }
1760 return $res;
54310121
PP
1761}
1762
1763#
2a28b791
GS
1764# html_escape: make text safe for HTML
1765#
1766sub html_escape {
1767 my $rest = $_[0];
1768 $rest =~ s/&/&amp;/g;
1769 $rest =~ s/</&lt;/g;
1770 $rest =~ s/>/&gt;/g;
1771 $rest =~ s/"/&quot;/g;
5b25816d
RS
1772 # &apos; is only in XHTML, not HTML4. Be conservative
1773 #$rest =~ s/'/&apos;/g;
2a28b791 1774 return $rest;
59ecbafa 1775}
2a28b791
GS
1776
1777
1778#
39e571d4
ML
1779# dosify - convert filenames to 8.3
1780#
1781sub dosify {
1782 my($str) = @_;
fe4c6be1 1783 return lc($str) if $^O eq 'VMS'; # VMS just needs casing
39e571d4
ML
1784 if ($Is83) {
1785 $str = lc $str;
1786 $str =~ s/(\.\w+)/substr ($1,0,4)/ge;
1787 $str =~ s/(\w+)/substr ($1,0,8)/ge;
1788 }
1789 return $str;
1790}
1791
1792#
d1be9408 1793# page_sect - make a URL from the text of a L<>
54310121 1794#
2a28b791
GS
1795sub page_sect($$) {
1796 my( $page, $section ) = @_;
1797 my( $linktext, $page83, $link); # work strings
1798
1799 # check if we know that this is a section in this page
69348ecf 1800 if (!defined $Pages{$page} && defined $Sections{$page}) {
2a28b791
GS
1801 $section = $page;
1802 $page = "";
1803 ### print STDERR "reset page='', section=$section\n";
54310121
PP
1804 }
1805
39e571d4 1806 $page83=dosify($page);
69348ecf 1807 $page=$page83 if (defined $Pages{$page83});
54310121 1808 if ($page eq "") {
0d396dd4 1809 $link = "#" . anchorify( $section );
350ccacd 1810 } elsif ( $page =~ /::/ ) {
350ccacd 1811 $page =~ s,::,/,g;
29f227c9
BS
1812 # Search page cache for an entry keyed under the html page name,
1813 # then look to see what directory that page might be in. NOTE:
1814 # this will only find one page. A better solution might be to produce
1815 # an intermediate page that is an index to all such pages.
1816 my $page_name = $page ;
fe6f1558 1817 $page_name =~ s,^.*/,,s ;
69348ecf
MS
1818 if ( defined( $Pages{ $page_name } ) &&
1819 $Pages{ $page_name } =~ /([^:]*$page)\.(?:pod|pm):/
29f227c9
BS
1820 ) {
1821 $page = $1 ;
1822 }
1823 else {
1824 # NOTE: This branch assumes that all A::B pages are located in
69348ecf
MS
1825 # $Htmlroot/A/B.html . This is often incorrect, since they are
1826 # often in $Htmlroot/lib/A/B.html or such like. Perhaps we could
1827 # analyze the contents of %Pages and figure out where any
29f227c9
BS
1828 # cousins of A::B are, then assume that. So, if A::B isn't found,
1829 # but A::C is found in lib/A/C.pm, then A::B is assumed to be in
1830 # lib/A/B.pm. This is also limited, but it's an improvement.
1831 # Maybe a hints file so that the links point to the correct places
2a28b791
GS
1832 # nonetheless?
1833
29f227c9 1834 }
69348ecf 1835 $link = "$Htmlroot/$page.html";
0d396dd4 1836 $link .= "#" . anchorify( $section ) if ($section);
69348ecf 1837 } elsif (!defined $Pages{$page}) {
54310121 1838 $link = "";
54310121 1839 } else {
0d396dd4 1840 $section = anchorify( $section ) if $section ne "";
2a28b791 1841 ### print STDERR "...section=$section\n";
54310121
PP
1842
1843 # if there is a directory by the name of the page, then assume that an
1844 # appropriate section will exist in the subdirectory
69348ecf
MS
1845# if ($section ne "" && $Pages{$page} =~ /([^:]*[^(\.pod|\.pm)]):/) {
1846 if ($section ne "" && $Pages{$page} =~ /([^:]*(?<!\.pod)(?<!\.pm)):/) {
1847 $link = "$Htmlroot/$1/$section.html";
2a28b791 1848 ### print STDERR "...link=$link\n";
54310121
PP
1849
1850 # since there is no directory by the name of the page, the section will
1851 # have to exist within a .html of the same name. thus, make sure there
1852 # is a .pod or .pm that might become that .html
1853 } else {
2a28b791
GS
1854 $section = "#$section" if $section;
1855 ### print STDERR "...section=$section\n";
1856
61743a65
ST
1857 # check if there is a .pod with the page name.
1858 # for L<Foo>, Foo.(pod|pm) is preferred to A/Foo.(pod|pm)
1859 if ($Pages{$page} =~ /([^:]*)\.(?:pod|pm):/) {
69348ecf 1860 $link = "$Htmlroot/$1.html$section";
54310121 1861 } else {
54310121 1862 $link = "";
54310121
PP
1863 }
1864 }
1865 }
1866
54310121 1867 if ($link) {
69348ecf
MS
1868 # Here, we take advantage of the knowledge that $Htmlfileurl ne ''
1869 # implies $Htmlroot eq ''. This means that the link in question
1870 # needs a prefix of $Htmldir if it begins with '/'. The test for
29f227c9
BS
1871 # the initial '/' is done to avoid '#'-only links, and to allow
1872 # for other kinds of links, like file:, ftp:, etc.
1873 my $url ;
69348ecf
MS
1874 if ( $Htmlfileurl ne '' ) {
1875 $link = "$Htmldir$link" if $link =~ m{^/}s;
1876 $url = relativize_url( $link, $Htmlfileurl );
1877# print( " b: [$link,$Htmlfileurl,$url]\n" );
29f227c9
BS
1878 }
1879 else {
1880 $url = $link ;
1881 }
2a28b791 1882 return $url;
29f227c9 1883
54310121 1884 } else {
2a28b791 1885 return undef();
54310121 1886 }
54310121
PP
1887}
1888
1889#
29f227c9
BS
1890# relativize_url - convert an absolute URL to one relative to a base URL.
1891# Assumes both end in a filename.
1892#
1893sub relativize_url {
1894 my ($dest,$source) = @_ ;
1895
59ecbafa 1896 my ($dest_volume,$dest_directory,$dest_file) =
29f227c9
BS
1897 File::Spec::Unix->splitpath( $dest ) ;
1898 $dest = File::Spec::Unix->catpath( $dest_volume, $dest_directory, '' ) ;
1899
59ecbafa 1900 my ($source_volume,$source_directory,$source_file) =
29f227c9
BS
1901 File::Spec::Unix->splitpath( $source ) ;
1902 $source = File::Spec::Unix->catpath( $source_volume, $source_directory, '' ) ;
1903
1904 my $rel_path = '' ;
1905 if ( $dest ne '' ) {
1906 $rel_path = File::Spec::Unix->abs2rel( $dest, $source ) ;
1907 }
1908
59ecbafa 1909 if ( $rel_path ne '' &&
29f227c9 1910 substr( $rel_path, -1 ) ne '/' &&
59ecbafa 1911 substr( $dest_file, 0, 1 ) ne '#'
29f227c9
BS
1912 ) {
1913 $rel_path .= "/$dest_file" ;
1914 }
1915 else {
1916 $rel_path .= "$dest_file" ;
1917 }
1918
1919 return $rel_path ;
1920}
1921
54310121
PP
1922
1923#
2a28b791 1924# coderef - make URL from the text of a C<>
54310121 1925#
2a28b791
GS
1926sub coderef($$){
1927 my( $page, $item ) = @_;
1928 my( $url );
1929
1930 my $fid = fragment_id( $item );
6e38a594 1931 if( defined( $page ) && $page ne "" ){
2a28b791
GS
1932 # we have been given a $page...
1933 $page =~ s{::}{/}g;
1934
1935 # Do we take it? Item could be a section!
69348ecf 1936 my $base = $Items{$fid} || "";
2a28b791
GS
1937 $base =~ s{[^/]*/}{};
1938 if( $base ne "$page.html" ){
69348ecf 1939 ### print STDERR "coderef( $page, $item ): items{$fid} = $Items{$fid} = $base => discard page!\n";
2a28b791
GS
1940 $page = undef();
1941 }
54310121 1942
2a28b791
GS
1943 } else {
1944 # no page - local items precede cached items
67398a75 1945 if( defined( $fid ) ){
69348ecf
MS
1946 if( exists $Local_Items{$fid} ){
1947 $page = $Local_Items{$fid};
67398a75 1948 } else {
69348ecf 1949 $page = $Items{$fid};
67398a75 1950 }
2a28b791
GS
1951 }
1952 }
54310121
PP
1953
1954 # if there was a pod file that we found earlier with an appropriate
1955 # =item directive, then create a link to that page.
2a28b791
GS
1956 if( defined $page ){
1957 if( $page ){
69348ecf 1958 if( exists $Pages{$page} and $Pages{$page} =~ /([^:.]*)\.[^:]*:/){
2a28b791 1959 $page = $1 . '.html';
29f227c9 1960 }
69348ecf 1961 my $link = "$Htmlroot/$page#item_" . anchorify($fid);
54310121 1962
69348ecf
MS
1963 # Here, we take advantage of the knowledge that $Htmlfileurl
1964 # ne '' implies $Htmlroot eq ''.
1965 if ( $Htmlfileurl ne '' ) {
1966 $link = "$Htmldir$link" ;
1967 $url = relativize_url( $link, $Htmlfileurl ) ;
2a28b791
GS
1968 } else {
1969 $url = $link ;
1970 }
1971 } else {
2beb85b7 1972 $url = "#item_" . anchorify($fid);
2a28b791 1973 }
54310121 1974
2a28b791 1975 confess "url has space: $url" if $url =~ /"[^"]*\s[^"]*"/;
59ecbafa 1976 }
2a28b791 1977 return( $url, $fid );
54310121
PP
1978}
1979
54310121
PP
1980
1981
1982#
29f227c9
BS
1983# Adapted from Nick Ing-Simmons' PodToHtml package.
1984sub relative_url {
1985 my $source_file = shift ;
1986 my $destination_file = shift;
1987
1988 my $source = URI::file->new_abs($source_file);
1989 my $uo = URI::file->new($destination_file,$source)->abs;
1990 return $uo->rel->as_string;
1991}
1992
1993
1994#
54310121
PP
1995# finish_list - finish off any pending HTML lists. this should be called
1996# after the entire pod file has been read and converted.
1997#
1998sub finish_list {
69348ecf 1999 while ($Listlevel > 0) {
59ecbafa 2000 print HTML "</dl>\n";
69348ecf 2001 $Listlevel--;
54310121
PP
2002 }
2003}
2004
2005#
2006# htmlify - converts a pod section specification to a suitable section
2a28b791
GS
2007# specification for HTML. Note that we keep spaces and special characters
2008# except ", ? (Netscape problem) and the hyphen (writer's problem...).
54310121
PP
2009#
2010sub htmlify {
2a28b791
GS
2011 my( $heading) = @_;
2012 $heading =~ s/(\s+)/ /g;
2013 $heading =~ s/\s+\Z//;
2014 $heading =~ s/\A\s+//;
2015 # The hyphen is a disgrace to the English language.
bc75160c
JA
2016 # $heading =~ s/[-"?]//g;
2017 $heading =~ s/["?]//g;
2a28b791
GS
2018 $heading = lc( $heading );
2019 return $heading;
2020}
54310121 2021
2a28b791 2022#
776d31fe 2023# similar to htmlify, but turns non-alphanumerics into underscores
0d396dd4
SB
2024#
2025sub anchorify {
2026 my ($anchor) = @_;
2027 $anchor = htmlify($anchor);
776d31fe 2028 $anchor =~ s/\W/_/g;
0d396dd4
SB
2029 return $anchor;
2030}
2031
2032#
2a28b791
GS
2033# depod - convert text by eliminating all interior sequences
2034# Note: can be called with copy or modify semantics
2035#
2036my %E2c;
67398a75
GS
2037$E2c{lt} = '<';
2038$E2c{gt} = '>';
2039$E2c{sol} = '/';
2a28b791 2040$E2c{verbar} = '|';
67398a75 2041$E2c{amp} = '&'; # in Tk's pods
2a28b791 2042
c68ea5d1 2043sub depod1($;$$);
7ba65c74 2044
2a28b791
GS
2045sub depod($){
2046 my $string;
2047 if( ref( $_[0] ) ){
2048 $string = ${$_[0]};
2049 ${$_[0]} = depod1( \$string );
2050 } else {
2051 $string = $_[0];
2052 depod1( \$string );
59ecbafa 2053 }
2a28b791 2054}
54310121 2055
c68ea5d1
GS
2056sub depod1($;$$){
2057 my( $rstr, $func, $closing ) = @_;
2a28b791 2058 my $res = '';
228a48a5 2059 return $res unless defined $$rstr;
2a28b791
GS
2060 if( ! defined( $func ) ){
2061 # skip to next begin of an interior sequence
d0ff30b5 2062 while( $$rstr =~ s/\A(.*?)([BCEFILSXZ])<(<+[^\S\n]+)?//s ){
2a28b791 2063 # recurse into its text
c68ea5d1 2064 $res .= $1 . depod1( $rstr, $2, closing $3);
2a28b791
GS
2065 }
2066 $res .= $$rstr;
2067 } elsif( $func eq 'E' ){
2068 # E<x> - convert to character
be3174d2 2069 $$rstr =~ s/^([^>]*)>//;
228a48a5 2070 $res .= $E2c{$1} || "";
2a28b791
GS
2071 } elsif( $func eq 'X' ){
2072 # X<> - ignore
2073 $$rstr =~ s/^[^>]*>//;
2074 } elsif( $func eq 'Z' ){
59ecbafa 2075 # Z<> - empty
2a28b791
GS
2076 $$rstr =~ s/^>//;
2077 } else {
2078 # all others: either recurse into new function or
2079 # terminate at closing angle bracket
c68ea5d1 2080 my $term = pattern $closing;
d0ff30b5 2081 while( $$rstr =~ s/\A(.*?)(([BCEFILSXZ])<(<+[^\S\n]+)?|$term)//s ){
2a28b791 2082 $res .= $1;
c68ea5d1
GS
2083 last unless $3;
2084 $res .= depod1( $rstr, $3, closing $4 );
2a28b791
GS
2085 }
2086 ## If we're here and $2 ne '>': undelimited interior sequence.
2087 ## Ignored, as this is called without proper indication of where we are.
2088 ## Rely on process_text to produce diagnostics.
2089 }
2090 return $res;
2091}
54310121 2092
bc75160c
JA
2093{
2094 my %seen; # static fragment record hash
2095
2096sub fragment_id_readable {
2097 my $text = shift;
2098 my $generate = shift; # optional flag
2099
2100 my $orig = $text;
2101
c24033b9
JH
2102 # leave the words for the fragment identifier,
2103 # change everything else to underbars.
2104 $text =~ s/[^A-Za-z0-9_]+/_/g; # do not use \W to avoid locale dependency.
2105 $text =~ s/_{2,}/_/g;
2106 $text =~ s/\A_//;
2107 $text =~ s/_\Z//;
bc75160c
JA
2108
2109 unless ($text)
2110 {
2111 # Nothing left after removing punctuation, so leave it as is
2112 # E.g. if option is named: "=item -#"
2113
2114 $text = $orig;
2115 }
2116
2117 if ($generate) {
2118 if ( exists $seen{$text} ) {
2119 # This already exists, make it unique
2120 $seen{$text}++;
2121 $text = $text . $seen{$text};
2122 } else {
2123 $seen{$text} = 1; # first time seen this fragment
2124 }
2125 }
2126
2127 $text;
2128}}
2129
2130my @HC;
c24033b9 2131sub fragment_id_obfuscated { # This was the old "_2d_2d__"
bc75160c
JA
2132 my $text = shift;
2133 my $generate = shift; # optional flag
2134
c24033b9 2135 # text? Normalize by obfuscating the fragment id to make it unique
bc75160c
JA
2136 $text =~ s/\s+/_/sg;
2137
2138 $text =~ s{(\W)}{
2139 defined( $HC[ord($1)] ) ? $HC[ord($1)]
2140 : ( $HC[ord($1)] = sprintf( "%%%02X", ord($1) ) ) }gxe;
2141 $text = substr( $text, 0, 50 );
2142
2143 $text;
2144}
2145
2a28b791
GS
2146#
2147# fragment_id - construct a fragment identifier from:
2148# a) =item text
2149# b) contents of C<...>
2150#
bc75160c 2151
2a28b791 2152sub fragment_id {
bc75160c
JA
2153 my $text = shift;
2154 my $generate = shift; # optional flag
2155
2a28b791
GS
2156 $text =~ s/\s+\Z//s;
2157 if( $text ){
2158 # a method or function?
2159 return $1 if $text =~ /(\w+)\s*\(/;
2160 return $1 if $text =~ /->\s*(\w+)\s*\(?/;
2161
2162 # a variable name?
fab416db 2163 return $1 if $text =~ /^([\$\@%*]\S+)/;
2a28b791
GS
2164
2165 # some pattern matching operator?
2166 return $1 if $text =~ m|^(\w+/).*/\w*$|;
2167
2168 # fancy stuff... like "do { }"
2169 return $1 if $text =~ m|^(\w+)\s*{.*}$|;
2170
2171 # honour the perlfunc manpage: func [PAR[,[ ]PAR]...]
2172 # and some funnies with ... Module ...
bee6d115 2173 return $1 if $text =~ m{^([a-z\d_]+)(\s+[A-Z,/& ][A-Z\d,/& ]*)?$};
2a28b791
GS
2174 return $1 if $text =~ m{^([a-z\d]+)\s+Module(\s+[A-Z\d,/& ]+)?$};
2175
c24033b9 2176 return fragment_id_readable($text, $generate);
2a28b791 2177 } else {
c24033b9 2178 return;
2a28b791 2179 }
54310121
PP
2180}
2181
2a28b791
GS
2182#
2183# make_URL_href - generate HTML href from URL
2184# Special treatment for CGI queries.
2185#
2186sub make_URL_href($){
2187 my( $url ) = @_;
59ecbafa
VS
2188 if( $url !~
2189 s{^(http:[-\w/#~:.+=&%@!]+)(\?.*)$}{<a href="$1$2">$1</a>}i ){
2190 $url = "<a href=\"$url\">$url</a>";
2a28b791
GS
2191 }
2192 return $url;
54310121
PP
2193}
2194
21951;