4 use File::Basename qw(&basename &dirname);
6 # List explicitly here the variables you want Configure to
7 # generate. Metaconfig only looks for shell variables, so you
8 # have to mention them as if they were shell variables, not
9 # %Config entries. Thus you write
11 # to ensure Configure will look for $Config{startperl}.
13 # This forces PL files to create target in same directory as PL file.
14 # This is so that make depend always knows where to find PL derivatives.
16 $file = basename($0, '.PL');
17 $file .= '.com' if $^O eq 'VMS';
19 open OUT,">$file" or die "Can't create $file: $!";
21 print "Extracting $file (with variable substitutions)\n";
23 # In this section, perl variables will be expanded during extraction.
24 # You can use $Config{...} to use Configure variables.
26 print OUT <<"!GROK!THIS!";
28 eval 'exec $Config{perlpath} -S \$0 \${1+"\$@"}'
29 if \$running_under_some_shell;
32 # In the following, perl variables are not expanded during extraction.
34 print OUT <<'!NO!SUBS!';
37 # pod2html - convert pod format to html
39 # usage: pod2html [podfiles]
40 # Will read the cwd and parse all files with .pod extension
41 # if no arguments are given on the command line.
43 # Many helps, suggestions, and fixes from the perl5 porters, and all over.
44 # Bill Middleton - wjm@metronet.com
46 # Please send patches/fixes/features to me
53 ################################################################################
54 # Invoke with various levels of debugging possible
55 ################################################################################
56 while ($ARGV[0] =~ /^-d(.*)/) {
58 $Debug{ lc($1 || shift) }++;
61 # ck for podnames on command line
66 ################################################################################
69 # The beginning of the url for the anchors to the other sections.
70 # Edit $type to suit. It's configured for relative url's now.
71 # Other possibilities are:
72 # $type = '<A HREF="file://localhost/usr/local/htmldir/'; # file url
73 # $type = '<A HREF="http://www.bozo.com/perl/manual/html/' # server
75 ################################################################################
78 $dir = "."; # location of pods
80 # look in these pods for things not found within the current pod
81 # be careful tho, namespace collisions cause stupid links
84 perlfunc perlvar perlrun perlop
86 ################################################################################
88 ################################################################################
90 $A = {}; # The beginning of all things
93 opendir(DIR,$dir) or die "Can't opendir $dir: $ERRNO";
94 @Pods = grep(/\.pod$/,readdir(DIR));
95 closedir(DIR) or die "Can't closedir $dir: $ERRNO";
97 @Pods or die "aak, expected pods";
99 # loop twice through the pods, first to learn the links, then to produce html
101 print STDERR "Scanning pods...\n" unless $count;
102 foreach $podfh ( @Pods ) {
103 ($pod = $podfh) =~ s/\.(?:pod|pm)$//;
104 Debug("files", "opening 2 $podfh" );
105 print "Creating $pod.html from $podfh\n" if $count;
106 $RS = "\n="; # grok pods by item (Nonstandard but effecient)
107 open($podfh,"<".$podfh) || die "can't open $podfh: $ERRNO";
113 for (@all) { s/=$// }
116 $html = $pod.".html";
117 if ($count) { # give us a html and rcs header
118 open(HTML,">$html") || die "can't create $html: $ERRNO";
119 print HTML '<!-- $Id$ -->',"\n",'<HTML><HEAD>',"\n";
120 print HTML "<CENTER>" unless $NO_NS;
121 print HTML "<TITLE>$pod</TITLE>";
122 print HTML "</CENTER>" unless $NO_NS;
123 print HTML "\n</HEAD>\n<BODY>";
125 for ($i = 0; $i <= $#all; $i++) { # decide what to do with each chunk
126 $all[$i] =~ /^(\w+)\s*(.*)\n?([^\0]*)$/ ;
127 ($cmd, $title, $rest) = ($1,$2,$3);
128 if ($cmd eq "item") {
129 if ($count ) { # producing html
130 do_list("over",$all[$i],\$in_list,\$depth) unless $depth;
131 do_item($title,$rest,$in_list);
135 scan_thing("item",$title,$pod);
138 elsif ($cmd =~ /^head([12])/) {
140 if ($count) { # producing html
141 do_hdr($num,$title,$rest,$depth);
145 scan_thing($cmd,$title,$pod); # skip head1
148 elsif ($cmd =~ /^over/) {
149 $count and $depth and do_list("over",$all[$i+1],\$in_list,\$depth);
151 elsif ($cmd =~ /^back/) {
152 if ($count) { # producing html
153 ($depth) or next; # just skip it
154 do_list("back",$all[$i+1],\$in_list,\$depth);
155 do_rest($title.$rest);
158 elsif ($cmd =~ /^cut/) {
161 elsif ($cmd =~ /^for/) { # experimental pragma html
162 if ($count) { # producing html
163 if ($title =~ s/^html//) {
165 do_rest($title.$rest);
169 elsif ($cmd =~ /^begin/) { # experimental pragma html
170 if ($count) { # producing html
171 if ($title =~ s/^html//) {
172 print HTML $title,"\n",$rest;
174 elsif ($title =~ /^end/) {
179 elsif ($Debug{"misc"}) {
180 warn("unrecognized header: $cmd");
183 # close open lists without '=back' stmts
184 if ($count) { # producing html
186 do_list("back",$all[$i+1],\$in_list,\$depth);
188 print HTML "\n</BODY>\n</HTML>\n";
193 sub do_list{ # setup a list type, depending on some grok logic
194 my($which,$next_one,$list_type,$depth) = @_;
196 if ($which eq "over") {
197 unless ($next_one =~ /^item\s+(.*)/) {
198 warn "Bad list, $1\n" if $Debug{"misc"};
202 if ($key =~ /^1\.?/) {
204 } elsif ($key =~ /\*\s*$/) {
206 } elsif ($key =~ /\*?\s*\w/) {
209 warn "unknown list type for item $key" if $Debug{"misc"};
213 print HTML $$list_type eq 'DL' ? qq{<DL COMPACT>} : qq{<$$list_type>};
216 elsif ($which eq "back") {
217 print HTML qq{\n</$$list_type>\n};
222 sub do_hdr{ # headers
223 my($num,$title,$rest,$depth) = @_;
224 print HTML qq{<p><hr>\n} if $num == 1;
225 process_thing(\$title,"NAME");
226 print HTML qq{\n<H$num> };
228 print HTML qq{</H$num>\n};
232 sub do_item{ # list items
233 my($title,$rest,$list_type) = @_;
234 my $bullet_only = $title eq '*' and $list_type eq 'UL';
235 process_thing(\$title,"NAME");
236 if ($list_type eq "DL") {
237 print HTML qq{\n<DT><STRONG>\n};
239 print HTML qq{\n</STRONG>\n};
240 print HTML qq{<DD>\n};
243 print HTML qq{\n<LI>};
244 unless ($bullet_only or $list_type eq "OL") {
245 print HTML $title,"\n";
251 sub do_rest{ # the rest of the chunk handled here
253 my(@lines,$p,$q,$line,,@paras,$inpre);
254 @paras = split(/\n\n\n*/,$rest);
255 for ($p = 0; $p <= $#paras; $p++) {
256 $paras[$p] =~ s/^\n//mg;
257 @lines = split(/\n/,$paras[$p]);
258 if ($in_html) { # handle =for html paragraphs
259 print HTML $paras[0];
263 elsif ($lines[0] =~ /^\s+\w*\t.*/) { # listing or unordered list
265 foreach $line (@lines) {
266 ($line =~ /^\s+(\w*)\t(.*)/) && (($key,$rem) = ($1,$2));
267 print HTML defined($Podnames{$key})
268 ? "<LI>$type$key.html\">$key<\/A>\t$rem</LI>\n"
269 : "<LI>$line</LI>\n";
271 print HTML qq{</UL>\n};
273 elsif ($lines[0] =~ /^\s/) { # preformatted code
274 if ($paras[$p] =~/>>|<</) {
275 print HTML qq{\n<PRE>\n};
278 else { # Still cant beat XMP. Yes, I know
279 print HTML qq{\n<XMP>\n}; # it's been obsoleted... suggestions?
282 while (defined($paras[$p])) {
283 @lines = split(/\n/,$paras[$p]);
284 foreach $q (@lines) { # mind your p's and q's here :-)
285 if ($paras[$p] =~ />>|<</) {
287 process_thing(\$q,"HTML");
290 print HTML qq{\n</XMP>\n};
291 print HTML qq{<PRE>\n};
293 process_thing(\$q,"HTML");
296 1 while $q =~ s/\t+/' 'x (length($&) * 8 - length($`) % 8)/e;
299 last if $paras[$p+1] !~ /^\s/;
302 print HTML ($inpre==1) ? (qq{\n</PRE>\n}) : (qq{\n</XMP>\n});
305 @lines = split(/\n/,$paras[$p]);
306 foreach $line (@lines) {
307 process_thing(\$line,"HTML");
308 print HTML qq{$line\n};
315 sub process_thing{ # process a chunk, order important
316 my($thing,$htype) = @_;
318 find_refs($thing,$htype);
319 post_escapes($thing);
322 sub scan_thing{ # scan a chunk for later references
323 my($cmd,$title,$pod) = @_;
328 # remove any formatting information for the headers
329 s/[SFCBI]<(.*?)>/$1/g;
330 # the "don't format me" thing
332 if ($cmd eq "item") {
333 /^\*/ and return; # skip bullets
334 /^\d+\./ and return; # skip numbers
337 return if defined $A->{$pod}->{"Items"}->{$_};
338 $A->{$pod}->{"Items"}->{$_} = gensym($pod, $_);
339 $A->{$pod}->{"Items"}->{(split(' ',$_))[0]}=$A->{$pod}->{"Items"}->{$_};
340 Debug("items", "item $_");
341 if (!/^-\w$/ && /([%\$\@\w]+)/ && $1 ne $_
342 && !defined($A->{$pod}->{"Items"}->{$_}) && ($_ ne $1))
344 $A->{$pod}->{"Items"}->{$1} = $A->{$pod}->{"Items"}->{$_};
345 Debug("items", "item $1 REF TO $_");
347 if ( m{^(tr|y|s|m|q[qwx])/.*[^/]} ) {
349 $pf .= "/" if $1 eq "tr" || $1 eq "y" || $1 eq "s";
351 $A->{$pod}->{"Items"}->{$pf} = $A->{$pod}->{"Items"}->{$_};
352 Debug("items", "item $pf REF TO $_");
356 elsif ($cmd =~ /^head[12]/) {
357 return if defined($A->{$pod}->{"Headers"}->{$_});
358 $A->{$pod}->{"Headers"}->{$_} = gensym($pod, $_);
359 Debug("headers", "header $_");
362 warn "unrecognized header: $cmd" if $Debug;
368 my($char, $bigkey, $lilkey,$htype) = @_;
369 my($key,$ref,$podname);
370 for $podname ($pod,@inclusions) {
371 for $ref ( "Items", "Headers" ) {
372 if (defined $A->{$podname}->{$ref}->{$bigkey}) {
373 $value = $A->{$podname}->{$ref}->{$key = $bigkey};
374 Debug("subs", "bigkey is $bigkey, value is $value\n");
376 elsif (defined $A->{$podname}->{$ref}->{$lilkey}) {
377 $value = $A->{$podname}->{$ref}->{$key = $lilkey};
378 return "" if $lilkey eq '';
379 Debug("subs", "lilkey is $lilkey, value is $value\n");
383 ($pod2, $num) = $value =~ /^(.*)_(\S+_\d+)$/;
384 if ($htype eq "NAME") {
385 return "\n<A NAME=\"".$value."\">\n$bigkey</A>\n"
388 return "\n$type$pod2.html\#".$value."\">$bigkey<\/A>\n";
392 if ($char =~ /[IF]/) {
393 return "<EM>$bigkey</EM>";
394 } elsif ($char =~ /C/) {
395 return "<CODE>$bigkey</CODE>";
397 return "<STRONG>$bigkey</STRONG>";
402 my($thing,$htype) = @_;
404 # LREF: a manpage(3f) we don't know about
406 #s:L<([a-zA-Z][^\s\/]+)(\([^\)]+\))>:the I<$1>$2 manpage:g;
407 s@(\S+?://\S*[^.,;!?\s])@noremap(qq{<A HREF="$1">$1</A>})@ge;
408 s,([a-z0-9_.-]+\@([a-z0-9_-]+\.)+([a-z0-9_-]+)),noremap(qq{<A HREF="MAILTO:$1">$1</A>}),gie;
409 s/L<([^>]*)>/lrefs($1,$htype)/ge;
410 s/([CIBF])<(\W*?(-?\w*).*?)>/picrefs($1, $2, $3, $htype)/ge;
411 s/(S)<([^\/]\W*?(-?\w*).*?)>/picrefs($1, $2, $3, $htype)/ge;
412 s/((\w+)\(\))/picrefs("I", $1, $2,$htype)/ge;
413 s/([\$\@%](?!&[gl]t)([\w:]+|\W\b))/varrefs($1,$htype)/ge;
415 if ($$thing eq $orig && $htype eq "NAME") {
416 $$thing = picrefs("I", $$thing, "", $htype);
422 my($page, $item) = split(m#/#, $_[0], 2);
425 my($section) = $page =~ /\((.*)\)/;
427 if ($page =~ /^[A-Z]/ && $item) {
429 $item = "$page/$item";
431 } elsif (!$item && $page =~ /[^a-z\-]/ && $page !~ /^\$.$/) {
438 if (!defined $section && defined $Podnames{$page}) {
439 return "\n$type$page.html\">\nthe <EM>$page</EM> manpage<\/A>\n";
441 (warn "Bizarre entry $page/$item") if $Debug;
442 return "the <EM>$_[0]</EM> manpage\n";
446 if ($item =~ s/"(.*)"/$1/ || ($item =~ /[^\w\/\-]/ && $item !~ /^\$.$/)) {
447 $text = "<EM>$item</EM>";
450 $text = "<EM>$item</EM>";
453 for $podname ($pod, @inclusions) {
455 if ($ref eq "Items") {
456 if (defined($value = $A->{$podname}->{$ref}->{$item})) {
457 ($pod2,$num) = split(/_/,$value,2);
458 return (($pod eq $pod2) && ($htype eq "NAME"))
459 ? "\n<A NAME=\"".$value."\">\n$text</A>\n"
460 : "\n$type$pod2.html\#".$value."\">$text<\/A>\n";
463 elsif ($ref eq "Headers") {
464 if (defined($value = $A->{$podname}->{$ref}->{$item})) {
465 ($pod2,$num) = split(/_/,$value,2);
466 return (($pod eq $pod2) && ($htype eq "NAME"))
467 ? "\n<A NAME=\"".$value."\">\n$text</A>\n"
468 : "\n$type$pod2.html\#".$value."\">$text<\/A>\n";
472 warn "No $ref reference for $item (@_)" if $Debug;
477 my ($var,$htype) = @_;
478 for $podname ($pod,@inclusions) {
479 if ($value = $A->{$podname}->{"Items"}->{$var}) {
480 ($pod2,$num) = split(/_/,$value,2);
481 Debug("vars", "way cool -- var ref on $var");
482 return (($pod eq $pod2) && ($htype eq "NAME")) # INHERIT $_, $pod
483 ? "\n<A NAME=\"".$value."\">\n$var</A>\n"
484 : "\n$type$pod2.html\#".$value."\">$var<\/A>\n";
487 Debug( "vars", "bummer, $var not a var");
488 return "<STRONG>$var</STRONG>";
492 my ($podname, $key) = @_;
494 ($key = lc($key)) =~ tr/a-z/_/cs;
495 my $name = "${podname}_${key}_0";
497 while ($sawsym{$name}++) {
498 $name =~ s/_?(\d+)$/'_' . ($1 + 1)/e;
503 sub pre_escapes { # twiddle these, and stay up late :-)
506 s/([\200-\377])/noremap("&#".ord($1).";")/ge;
508 s/&/noremap("&")/ge;
509 s/<</noremap("<<")/eg;
510 s/([^ESIBLCF])</$1\<\;/g;
511 s/E<(\d+)>/\&#$1\;/g; # embedded numeric special
512 s/E<([^\/][^<>]*)>/\&$1\;/g; # embedded special
515 sub noremap { # adding translator for hibit chars soon
517 $hide =~ tr/\000-\177/\200-\377/;
525 s/([^GM])>>/$1\>\;\>\;/g;
526 s/([^D][^"MGA])>/$1\>\;/g;
527 tr/\200-\377/\000-\177/;
533 print STDERR @_,"\n" if $Debug{$level};
538 print STDERR "TABLE DUMP $t\n";
539 foreach $k (sort keys %$t) {
540 printf STDERR "%-20s <%s>\n", $t->{$k}, $k;
551 close OUT or die "Can't close $file: $!";
552 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
553 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';