]>
gcc.gnu.org Git - gcc.git/blob - contrib/texi2pod.pl
3 # This does trivial (and I mean _trivial_) conversion of Texinfo
4 # markup to Perl POD format. It's intended to be used to extract
5 # something suitable for a manpage from a Texinfo document.
27 die "no flag specified for -D\n"
29 die "flags may only contain letters, digits, hyphens, and underscores\n"
30 unless $flag =~ /^[a-zA-Z0-9_-]+$/;
35 $in = $_, next unless defined $in;
36 $out = $_, next unless defined $out;
42 open(STDIN
, $in) or die "opening \"$in\": $!\n";
45 open(STDOUT, ">$out") or die "opening
\"$out\": $!\n";
50 # Certain commands are discarded without further processing.
52 [a-z
]+index # @*index: useful only in complete manual
53 |need
# @need: useful only in printed manual
54 |(?
:end\s
+)?group
# @group .. @end group: ditto
56 |node
# @node: useful only in .info file
61 # Look for filename and title markers.
62 /^\@setfilename\s+([^.]+)/ and $fn = $1, next;
63 /^\@settitle\s+([^.]+)/ and $tl = $1, next;
65 # Look for blocks surrounded by @c man begin SECTION ... @c man end.
66 # This really oughta be @ifman ... @end ifman and the like, but such
67 # would require rev'ing all other Texinfo translators.
68 /^\@c man begin ([A-Z]+)/ and $sect = $1, $output = 1, next;
69 /^\@c man end/ and do {
70 $sects{$sect} = "" unless exists $sects{$sect};
71 $sects{$sect} .= postprocess
($section);
78 # Discard comments. (Can't do it above, because then we'd never see
82 # End-block handler goes up here because it needs to operate even
84 /^\@end\s+([a-z]+)/ and do {
85 # Ignore @end foo, where foo is not an operation which may
86 # cause us to skip, if we are presently skipping.
88 next if $skipping && $ended !~ /^(?:ifset|ifclear|ignore|menu)$/;
90 die "\@end $ended without \@$ended at line $.\n" unless defined $endw;
91 die "\@$endw ended by \@end $ended at line $.\n" unless $ended eq $endw;
93 $endw = pop @endwstack;
95 if ($ended =~ /^(?:ifset|ifclear|ignore|menu)$/) {
96 $skipping = pop @skstack;
98 } elsif ($ended =~ /^(?:example|smallexample)$/) {
100 $_ = ""; # need a paragraph break
101 } elsif ($ended =~ /^(?:itemize|enumerate|table)$/) {
105 die "unknown command \@end $ended at line $.\n";
109 # We must handle commands which can cause skipping even while we
110 # are skipping, otherwise we will not process nested conditionals
112 /^\@ifset\s+([a-zA-Z0-9_-]+)/ and do {
113 push @endwstack, $endw;
114 push @skstack, $skipping;
116 $skipping = 1 unless exists $defs{$1};
120 /^\@ifclear\s+([a-zA-Z0-9_-]+)/ and do {
121 push @endwstack, $endw;
122 push @skstack, $skipping;
124 $skipping = 1 if exists $defs{$1};
128 /^\@(ignore|menu)\b/ and do {
129 push @endwstack, $endw;
130 push @skstack, $skipping;
138 # Character entities. First the ones that can be replaced by raw text
139 # or discarded outright:
140 s/\@copyright\{\}/(c)/g;
142 s/\@enddots\{\}/..../g;
145 s/\@bullet(?:\{\})?/*/g;
148 s/\@minus(?:\{\})?/-/g;
150 # Now the ones that have to be replaced by special escapes
151 # (which will be turned back into text by unmunge())
156 # POD doesn't interpret E<> inside a verbatim block.
165 # Single line command handlers.
166 /^\@set\s+([a-zA-Z0-9_-]+)\s*(.*)$/ and $defs{$1} = $2, next;
167 /^\@clear\s+([a-zA-Z0-9_-]+)/ and delete $defs{$1}, next;
169 /^\@section\s+(.+)$/ and $_ = "\n=head2 $1\n";
170 /^\@subsection\s+(.+)$/ and $_ = "\n=head3 $1\n";
172 # Block command handlers:
173 /^\@itemize\s+(\@[a-z]+|\*|-)/ and do {
174 push @endwstack, $endw;
181 /^\@enumerate(?:\s+([A-Z0-9]+))?/ and do {
182 push @endwstack, $endw;
193 /^\@table\s+(\@[a-z]+)/ and do {
194 push @endwstack, $endw;
197 $ic =~ s/\@(?:samp|strong|key|gcctabopt|env)/B/;
198 $ic =~ s/\@(?:code|kbd)/C/;
199 $ic =~ s/\@(?:dfn|var|emph|cite|i)/I/;
200 $ic =~ s/\@(?:file)/F/;
205 /^\@((?:small)?example)/ and do {
206 push @endwstack, $endw;
209 $_ = ""; # need a paragraph break
212 /^\@itemx?\s*(.+)?$/ and do {
214 # Entity escapes prevent munging by the <> processing below.
215 $_ = "\n=item $ic\<$1\>\n";
217 $_ = "\n=item $ic\n";
218 $ic =~ y/A-Ya-y1-8/B-Zb-z2-9/;
222 $section .= $shift.$_."\n";
225 die "No filename or title\n" unless defined $fn && defined $tl;
227 $sects{NAME
} = "$fn \- $tl\n";
228 $sects{FOOTNOTES
} .= "=back\n" if exists $sects{FOOTNOTES
};
230 for $sect (qw(NAME SYNOPSIS DESCRIPTION OPTIONS ENVIRONMENT FILES
231 BUGS NOTES FOOTNOTES SEEALSO AUTHOR COPYRIGHT)) {
232 if(exists $sects{$sect}) {
234 $head =~ s/SEEALSO/SEE ALSO/;
235 print "=head1 $head\n\n";
236 print scalar unmunge
($sects{$sect});
243 die "usage: $0 [-D toggle...] [infile [outfile]]\n";
250 # @value{foo} is replaced by whatever 'foo' is defined as.
251 s/\@value\{([a-zA-Z0-9_-]+)\}/$defs{$1}/g;
253 # Formatting commands.
254 # Temporary escape for @r.
255 s/\@r\{([^\}]*)\}/R<$1>/g;
256 s/\@(?:dfn|var|emph|cite|i)\{([^\}]*)\}/I<$1>/g;
257 s/\@(?:code|kbd)\{([^\}]*)\}/C<$1>/g;
258 s/\@(?:gccoptlist|samp|strong|key|option|env|command|b)\{([^\}]*)\}/B<$1>/g;
259 s/\@sc\{([^\}]*)\}/\U$1/g;
260 s/\@file\{([^\}]*)\}/F<$1>/g;
261 s/\@w\{([^\}]*)\}/S<$1>/g;
262 s/\@(?:dmn|math)\{([^\}]*)\}/$1/g;
264 # Handle @r inside bold.
265 1 while s/B<((?:[^<>]*|I<[^<>*]*>)*)R<([^>]*)>/B<$1>${2}B</g;
267 # Cross references are thrown away, as are @noindent and @refill.
268 # (@noindent is impossible in .pod, and @refill is unnecessary.)
269 # @* is also impossible in .pod; we discard it and any newline that
270 # follows it. Similarly, our macro @gol must be discarded.
272 s/\(?\@xref\{(?:[^\}]*)\}(?:[^.<]|(?:<[^<>]*>))*\.\)?//g;
273 s/\s+\(\@pxref\{(?:[^\}]*)\}\)//g;
274 s/;\s+\@pxref\{(?:[^\}]*)\}//g;
280 # @uref can take one, two, or three arguments, with different
281 # semantics each time. @url and @email are just like @uref with
282 # one argument, for our purposes.
283 s/\@(?:uref|url|email)\{([^\},]*)\}/<B<$1>>/g;
284 s/\@uref\{([^\},]*),([^\},]*)\}/$2 (C<$1>)/g;
285 s/\@uref\{([^\},]*),([^\},]*),([^\},]*)\}/$3/g;
287 # Turn B<blah I<blah> blah> into B<blah> I<blah> B<blah> to
288 # match Texinfo semantics of @emph inside @samp.
291 1 while (s/B<([^<>]*)I<([^>]+)>/B<$1>I<$2>B</g);
292 1 while (s/I<([^<>]*)B<([^>]+)>/I<$1>B<$2>I</g);
294 s/([BI])<(\s+)([^>]+)>/$2$1<$3>/g;
295 s/([BI])<([^>]+?)(\s+)>/$1<$2>$3/g;
297 # Extract footnotes. This has to be done after all other
298 # processing because otherwise the regexp will choke on formatting
300 while (/\@footnote/g) {
301 s/\@footnote\{([^\}]+)\}/[$fnno]/;
302 add_footnote
($1, $fnno);
311 # Replace escaped symbols with their equivalents.
325 unless (exists $sects{FOOTNOTES
}) {
326 $sects{FOOTNOTES
} = "\n=over 4\n\n";
329 $sects{FOOTNOTES
} .= "=item $fnno.\n\n"; $fnno++;
330 $sects{FOOTNOTES
} .= $_[0];
331 $sects{FOOTNOTES
} .= "\n\n";
This page took 0.061848 seconds and 5 git commands to generate.