#!/usr/local/bin/perl eval 'exec perl -S $0 ${1+"$@"}' if $running_under_some_shell; require "find.pl"; use Config; # somday when we'll have $Config{installhtmldir}... # # pod2html - convert pod format to html # Version 1.20 # usage: pod2html [podfiles] # Will read the cwd and parse all files with .pod extension # if no arguments are given on the command line. # # Many helps, suggestions, and fixes from the perl5 porters, and all over. # Bill Middleton - wjm@metronet.com # # Please send patches/fixes/features to me # # *RS = */; *ERRNO = *!; ################################################################################ # Invoke with various levels of debugging possible ################################################################################ while ($ARGV[0] =~ /^-d(.*)/) { shift; $Debug{ lc($1 || shift) }++; } # ck for podnames on command line while ($ARGV[0]) { push(@Pods,shift); } ################################################################################ # CONFIGURE - change the following to suit your OS and taste ################################################################################ # The beginning of the url for the anchors to the other sections. # Edit $type to suit. It's configured for relative url's now. # Other possibilities are: # $type = '".$installhtmldir.$sep."index.".$htmlext) or (die "cant open index.$htmlext"); print INDEX "\n\n
Index of all pods for $package
\n\n"; print INDEX "

Index of all pods for $package

\n
\n\n"; sub do_list{ # setup a list type, depending on some grok logic my($which,$next_one,$list_type,$depth) = @_; my($key); if ($which eq "over") { unless ($next_one =~ /^item\s+(.*)/) { warn "Bad list, $1\n" if $Debug{"misc"}; } $key = $1; if ($key =~ /^1\.?/) { $$list_type = "OL"; } elsif ($key =~ /\*\s*$/) { $$list_type = "UL"; } elsif ($key =~ /\*?\s*\w/) { $$list_type = "DL"; } else { warn "unknown list type for item $key" if $Debug{"misc"}; } print HTML qq{\n}; print HTML qq{<$$list_type>}; $$depth++; } elsif ($which eq "back") { print HTML qq{\n\n}; $$depth--; } } sub do_hdr{ # headers my($num,$title,$rest,$depth) = @_; my($savename,$restofname); print HTML qq{

\n} if $num == 1; ($savename = $title) =~ s/^(\w+)([\s,]+.*)/$1/; $restofname = $2; (defined($Podnames{$savename})) ? ($savename = $savename) : ($savename = 0); process_thing(\$title,"NAME"); print HTML qq{\n }; if($savename){ print HTML "$savename$restofname"; } else{ print HTML $title; } print HTML qq{\n}; do_rest($rest); } sub do_item{ # list items my($title,$rest,$list_type) = @_; my $bullet_only; $bullet_only = ($title eq '*' and $list_type eq 'UL') ? 1 : 0; my($savename); $savename = $title; (defined($Podnames{$savename})) ? ($savename = $savename) : ($savename = 0); process_thing(\$title,"NAME"); if ($list_type eq "DL") { print HTML qq{\n
\n}; if($savename){ print HTML "$savename $rest\n
"; } else{ (print HTML qq{\n\n}) unless ($title =~ /STRONG/); print HTML $title; (print HTML qq{\n\n}) unless ($title =~ /STRONG/); } print HTML qq{
\n}; } else { print HTML qq{\n
  • }; unless ($bullet_only or $list_type eq "OL") { if($savename){ print HTML "$savename"; } else{ print HTML $title,"\n"; } } } do_rest($rest); } sub do_rest{ # the rest of the chunk handled here my($rest) = @_; my(@lines,$p,$q,$line,,@paras,$inpre); @paras = split(/\n\n\n*/,$rest); for ($p = 0; $p <= $#paras; $p++) { $paras[$p] =~ s/^\n//mg; @lines = split(/\n/,$paras[$p]); if ($in_html) { # handle =for html paragraphs print HTML $paras[0]; $in_html = 0; next; } elsif ($lines[0] =~ /^\s+\w*\t.*/) { # listing or unordered list print HTML qq{\n}; } elsif ($lines[0] =~ /^\s/) { # preformatted code if ($paras[$p] =~/>>|<\n}; $inpre=1; } else { # Still cant beat XMP. Yes, I know print HTML qq{\n\n}; # it's been obsoleted... suggestions? $inpre = 0; } while (defined($paras[$p])) { @lines = split(/\n/,$paras[$p]); foreach $q (@lines) { # mind your p's and q's here :-) if ($paras[$p] =~ />>|<</) { if ($inpre) { process_thing(\$q,"HTML"); } else { print HTML qq{\n\n}; print HTML qq{
    \n};
			    $inpre=1;
			    process_thing(\$q,"HTML");
			}
		    }
		    1 while $q =~  s/\t+/' 'x (length($&) * 8 - length($`) % 8)/e;
		    print HTML  $q,"\n";
		}
		last if $paras[$p+1] !~ /^\s/;
		$p++;
	    }
	    print HTML ($inpre==1) ? (qq{\n
    \n}) : (qq{\n\n}); } else { # other text @lines = split(/\n/,$paras[$p]); foreach $line (@lines) { process_thing(\$line,"HTML"); $line =~ s/STRONG([^>])/STRONG>$1/; print HTML qq{$line\n}; } } print HTML qq{

    }; } } sub process_thing{ # process a chunk, order important my($thing,$htype) = @_; pre_escapes($thing); find_refs($thing,$htype); post_escapes($thing); } sub scan_thing{ # scan a chunk for later references my($cmd,$title,$pod) = @_; $_ = $title; s/\n$//; s/E<(.*?)>/&$1;/g; # remove any formatting information for the headers s/[SFCBI]<(.*?)>/$1/g; # the "don't format me" thing s/Z<>//g; if ($cmd eq "item") { /^\*/ and return; # skip bullets /^\d+\./ and return; # skip numbers s/(-[a-z]).*/$1/i; trim($_); return if defined $A->{$pod}->{"Items"}->{$_}; $A->{$pod}->{"Items"}->{$_} = gensym($pod, $_); $A->{$pod}->{"Items"}->{(split(' ',$_))[0]}=$A->{$pod}->{"Items"}->{$_}; Debug("items", "item $_"); if (!/^-\w$/ && /([%\$\@\w]+)/ && $1 ne $_ && !defined($A->{$pod}->{"Items"}->{$_}) && ($_ ne $1)) { $A->{$pod}->{"Items"}->{$1} = $A->{$pod}->{"Items"}->{$_}; Debug("items", "item $1 REF TO $_"); } if ( m{^(tr|y|s|m|q[qwx])/.*[^/]} ) { my $pf = $1 . '//'; $pf .= "/" if $1 eq "tr" || $1 eq "y" || $1 eq "s"; if ($pf ne $_) { $A->{$pod}->{"Items"}->{$pf} = $A->{$pod}->{"Items"}->{$_}; Debug("items", "item $pf REF TO $_"); } } } elsif ($cmd =~ /^head[12]/) { return if defined($A->{$pod}->{"Headers"}->{$_}); $A->{$pod}->{"Headers"}->{$_} = gensym($pod, $_); Debug("headers", "header $_"); } else { warn "unrecognized header: $cmd" if $Debug; } } sub picrefs { my($char, $bigkey, $lilkey,$htype) = @_; my($key,$ref,$podname); for $podname ($pod,@inclusions) { for $ref ( "Items", "Headers" ) { if (defined $A->{$podname}->{$ref}->{$bigkey}) { $value = $A->{$podname}->{$ref}->{$key = $bigkey}; Debug("subs", "bigkey is $bigkey, value is $value\n"); } elsif (defined $A->{$podname}->{$ref}->{$lilkey}) { $value = $A->{$podname}->{$ref}->{$key = $lilkey}; return "" if $lilkey eq ''; Debug("subs", "lilkey is $lilkey, value is $value\n"); } } if (length($key)) { ($pod2,$num) = split(/_/,$value,2); if ($htype eq "NAME") { return "\n\n$bigkey\n" } else { 1; # break here return "\n$type$Podnames{$pod2}\#".$value."\">$bigkey<\/A>\n"; } } } if ($char =~ /[IF]/) { return "$bigkey"; } elsif ($char =~ /C/) { return "$bigkey"; } else { if($bigkey =~ /STRONG/){ return $bigkey; } else{ return "$bigkey"; } } } sub find_refs { my($thing,$htype) = @_; my($orig) = $$thing; # LREF: a manpage(3f) we don't know about for ($$thing) { #s:L<([a-zA-Z][^\s\/]+)(\([^\)]+\))>:the I<$1>$2 manpage:g; s@(\S+?://\S*[^.,;!?\s])@noremap(qq{$1})@ge; s,([a-z0-9_.-]+\@([a-z0-9_-]+\.)+([a-z0-9_-]+)),noremap(qq{$1}),gie; s/L<([^>]*)>/lrefs($1,$htype)/ge; s/([CIBF])<(\W*?(-?\w*).*?)>/picrefs($1, $2, $3, $htype)/ge; s/(S)<([^\/]\W*?(-?\w*).*?)>/picrefs($1, $2, $3, $htype)/ge; s/((\w+)\(\))/picrefs("I", $1, $2,$htype)/ge; s/([\$\@%](?!&[gl]t)([\w:]+|\W\b))/varrefs($1,$htype)/ge; } if ($$thing eq $orig && $htype eq "NAME") { $$thing = picrefs("I", $$thing, "", $htype); } } sub lrefs { my($page, $item) = split(m#/#, $_[0], 2); my($htype) = $_[1]; my($podname); my($section) = $page =~ /\((.*)\)/; my $selfref; if ($page =~ /^[A-Z]/ && $item) { $selfref++; $item = "$page/$item"; $page = $pod; } elsif (!$item && $page =~ /[^a-z\-]/ && $page !~ /^\$.$/) { $selfref++; $item = $page; $page = $pod; } $item =~ s/\(\)$//; if (!$item) { if (!defined $section && defined $Podnames{$page}) { return "\n$type$Podnames{$page}\">\nthe $page manpage<\/A>\n"; } else { (warn "Bizarre entry $page/$item") if $Debug; return "the $_[0] manpage\n"; } } if ($item =~ s/"(.*)"/$1/ || ($item =~ /[^\w\/\-]/ && $item !~ /^\$.$/)) { $text = "$item"; $ref = "Headers"; } else { $text = "$item"; $ref = "Items"; } for $podname ($pod, @inclusions) { undef $value; if ($ref eq "Items") { if (defined($value = $A->{$podname}->{$ref}->{$item})) { ($pod2,$num) = split(/_/,$value,2); # break here return (($pod eq $pod2) && ($htype eq "NAME")) ? "\n\n$text\n" : "\n$type$Podnames{$pod2}\#".$value."\">$text<\/A>\n"; } } elsif ($ref eq "Headers") { if (defined($value = $A->{$podname}->{$ref}->{$item})) { ($pod2,$num) = split(/_/,$value,2); # break here return (($pod eq $pod2) && ($htype eq "NAME")) ? "\n\n$text\n" : "\n$type$Podnames{$pod2}\#".$value."\">$text<\/A>\n"; } } } warn "No $ref reference for $item (@_)" if $Debug; return $text; } sub varrefs { my ($var,$htype) = @_; for $podname ($pod,@inclusions) { if ($value = $A->{$podname}->{"Items"}->{$var}) { ($pod2,$num) = split(/_/,$value,2); Debug("vars", "way cool -- var ref on $var"); return (($pod eq $pod2) && ($htype eq "NAME")) # INHERIT $_, $pod ? "\n\n$var\n" : "\n$type$Podnames{$pod2}\#".$value."\">$var<\/A>\n"; } } Debug( "vars", "bummer, $var not a var"); if($var =~ /STRONG/){ return $var; } else{ return "$var"; } } sub gensym { my ($podname, $key) = @_; $key =~ s/\s.*//; ($key = lc($key)) =~ tr/a-z/_/cs; my $name = "${podname}_${key}_0"; $name =~ s/__/_/g; while ($sawsym{$name}++) { $name =~ s/_?(\d+)$/'_' . ($1 + 1)/e; } return $name; } sub pre_escapes { # twiddle these, and stay up late :-) my($thing) = @_; for ($$thing) { s/"(.*?)"/``$1''/gs; s/&/noremap("&")/ge; s/<]*)>/\&$1\;/g; # embedded special } } sub noremap { # adding translator for hibit chars soon my $hide = $_[0]; $hide =~ tr/\000-\177/\200-\377/; $hide; } sub post_escapes { my($thing) = @_; for ($$thing) { s/([^GM])>>/$1\>\;\>\;/g; s/([^D][^"MGA])>/$1\>\;/g; tr/\200-\377/\000-\177/; } } sub Debug { my $level = shift; print STDERR @_,"\n" if $Debug{$level}; } sub dumptable { my $t = shift; print STDERR "TABLE DUMP $t\n"; foreach $k (sort keys %$t) { printf STDERR "%-20s <%s>\n", $t->{$k}, $k; } } sub trim { for (@_) { s/^\s+//; s/\s\n?$//; } } sub wanted { my $name = $name; if (-f $_) { if ($name =~ /\.p(m|od)$/){ push(@modpods, $name) if ($name =~ /\.p(m|od)$/); } } }