3 # Copyright (C) 1999, 2000, 2001 Free Software Foundation, Inc.
5 # This file is part of GNU CC.
7 # GNU CC is free software; you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 2, or (at your option)
12 # GNU CC is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with GNU CC; see the file COPYING. If not, write to
19 # the Free Software Foundation, 59 Temple Place - Suite 330,
20 # Boston MA 02111-1307, USA.
22 # This does trivial (and I mean _trivial_) conversion of Texinfo
23 # markup to Perl POD format. It's intended to be used to extract
24 # something suitable for a manpage from a Texinfo document.
44 die "no flag specified for -D\n"
46 die "flags may only contain letters, digits, hyphens, and underscores\n"
47 unless $flag =~ /^[a-zA-Z0-9_-]+$/;
52 $in = $_, next unless defined $in;
53 $out = $_, next unless defined $out;
59 open(STDIN
, $in) or die "opening \"$in\": $!\n";
62 open(STDOUT
, ">$out") or die "opening \"$out\": $!\n";
67 # Certain commands are discarded without further processing.
69 [a
-z
]+index # @*index: useful only in complete manual
70 |need
# @need: useful only in printed manual
71 |(?
:end\s
+)?group
# @group .. @end group: ditto
73 |node
# @node: useful only in .info file
74 |(?
:end\s
+)?ifnottex
# @ifnottex .. @end ifnottex: use contents
79 # Look for filename and title markers.
80 /^\@setfilename\s+([^.]+)/ and $fn = $1, next;
81 /^\@settitle\s+([^.]+)/ and $tl = $1, next;
83 # Look for blocks surrounded by @c man begin SECTION ... @c man end.
84 # This really oughta be @ifman ... @end ifman and the like, but such
85 # would require rev'ing all other Texinfo translators.
86 /^\@c man begin ([A-Z]+)/ and $sect = $1, $output = 1, next;
87 /^\@c man end/ and do {
88 $sects{$sect} = "" unless exists $sects{$sect};
89 $sects{$sect} .= postprocess
($section);
96 # Discard comments. (Can't do it above, because then we'd never see
100 # End-block handler goes up here because it needs to operate even
101 # if we are skipping.
102 /^\@end\s+([a-z]+)/ and do {
103 # Ignore @end foo, where foo is not an operation which may
104 # cause us to skip, if we are presently skipping.
106 next if $skipping && $ended !~ /^(?:ifset|ifclear|ignore|menu|iftex)$/;
108 die "\@end $ended without \@$ended at line $.\n" unless defined $endw;
109 die "\@$endw ended by \@end $ended at line $.\n" unless $ended eq $endw;
111 $endw = pop @endwstack;
113 if ($ended =~ /^(?:ifset|ifclear|ignore|menu|iftex)$/) {
114 $skipping = pop @skstack;
116 } elsif ($ended =~ /^(?:example|smallexample|display)$/) {
118 $_ = ""; # need a paragraph break
119 } elsif ($ended =~ /^(?:itemize|enumerate|table)$/) {
123 die "unknown command \@end $ended at line $.\n";
127 # We must handle commands which can cause skipping even while we
128 # are skipping, otherwise we will not process nested conditionals
130 /^\@ifset\s+([a-zA-Z0-9_-]+)/ and do {
131 push @endwstack, $endw;
132 push @skstack, $skipping;
134 $skipping = 1 unless exists $defs{$1};
138 /^\@ifclear\s+([a-zA-Z0-9_-]+)/ and do {
139 push @endwstack, $endw;
140 push @skstack, $skipping;
142 $skipping = 1 if exists $defs{$1};
146 /^\@(ignore|menu|iftex)\b/ and do {
147 push @endwstack, $endw;
148 push @skstack, $skipping;
156 # Character entities. First the ones that can be replaced by raw text
157 # or discarded outright:
158 s/\@copyright\{\}/(c)/g;
160 s/\@enddots\{\}/..../g;
163 s/\@bullet(?:\{\})?/*/g;
166 s/\@minus(?:\{\})?/-/g;
169 # Now the ones that have to be replaced by special escapes
170 # (which will be turned back into text by unmunge())
176 # Inside a verbatim block, handle @var specially.
178 s/\@var\{([^\}]*)\}/<$1>/g;
181 # POD doesn't interpret E<> inside a verbatim block.
190 # Single line command handlers.
191 /^\@set\s+([a-zA-Z0-9_-]+)\s*(.*)$/ and $defs{$1} = $2, next;
192 /^\@clear\s+([a-zA-Z0-9_-]+)/ and delete $defs{$1}, next;
194 /^\@(?:section|unnumbered|unnumberedsec|center)\s+(.+)$/ and $_ = "\n=head2 $1\n";
195 /^\@subsection\s+(.+)$/ and $_ = "\n=head3 $1\n";
197 # Block command handlers:
198 /^\@itemize\s+(\@[a-z]+|\*|-)/ and do {
199 push @endwstack, $endw;
206 /^\@enumerate(?:\s+([a-zA-Z0-9]+))?/ and do {
207 push @endwstack, $endw;
218 /^\@table\s+(\@[a-z]+)/ and do {
219 push @endwstack, $endw;
222 $ic =~ s/\@(?:samp|strong|key|gcctabopt|env)/B/;
223 $ic =~ s/\@(?:code|kbd)/C/;
224 $ic =~ s/\@(?:dfn|var|emph|cite|i)/I/;
225 $ic =~ s/\@(?:file)/F/;
230 /^\@((?:small)?example|display)/ and do {
231 push @endwstack, $endw;
234 $_ = ""; # need a paragraph break
237 /^\@itemx?\s*(.+)?$/ and do {
239 # Entity escapes prevent munging by the <> processing below.
240 $_ = "\n=item $ic\<$1\>\n";
242 $_ = "\n=item $ic\n";
243 $ic =~ y/A-Ya-y/B-Zb-z/;
244 $ic =~ s/(\d+)/$1 + 1/eg;
248 $section .= $shift.$_."\n";
251 die "No filename or title\n" unless defined $fn && defined $tl;
253 $sects{NAME
} = "$fn \- $tl\n";
254 $sects{FOOTNOTES
} .= "=back\n" if exists $sects{FOOTNOTES
};
256 for $sect (qw(NAME SYNOPSIS DESCRIPTION OPTIONS ENVIRONMENT FILES
257 BUGS NOTES FOOTNOTES SEEALSO AUTHOR COPYRIGHT)) {
258 if(exists $sects{$sect}) {
260 $head =~ s/SEEALSO/SEE ALSO/;
261 print "=head1 $head\n\n";
262 print scalar unmunge
($sects{$sect});
269 die "usage: $0 [-D toggle...] [infile [outfile]]\n";
276 # @value{foo} is replaced by whatever 'foo' is defined as.
277 s/\@value\{([a-zA-Z0-9_-]+)\}/$defs{$1}/g;
279 # Formatting commands.
280 # Temporary escape for @r.
281 s/\@r\{([^\}]*)\}/R<$1>/g;
282 s/\@(?:dfn|var|emph|cite|i)\{([^\}]*)\}/I<$1>/g;
283 s/\@(?:code|kbd)\{([^\}]*)\}/C<$1>/g;
284 s/\@(?:gccoptlist|samp|strong|key|option|env|command|b)\{([^\}]*)\}/B<$1>/g;
285 s/\@sc\{([^\}]*)\}/\U$1/g;
286 s/\@file\{([^\}]*)\}/F<$1>/g;
287 s/\@w\{([^\}]*)\}/S<$1>/g;
288 s/\@(?:dmn|math)\{([^\}]*)\}/$1/g;
290 # Cross references are thrown away, as are @noindent and @refill.
291 # (@noindent is impossible in .pod, and @refill is unnecessary.)
292 # @* is also impossible in .pod; we discard it and any newline that
293 # follows it. Similarly, our macro @gol must be discarded.
295 s/\(?\@xref\{(?:[^\}]*)\}(?:[^.<]|(?:<[^<>]*>))*\.\)?//g;
296 s/\s+\(\@pxref\{(?:[^\}]*)\}\)//g;
297 s/;\s+\@pxref\{(?:[^\}]*)\}//g;
303 # @uref can take one, two, or three arguments, with different
304 # semantics each time. @url and @email are just like @uref with
305 # one argument, for our purposes.
306 s/\@(?:uref|url|email)\{([^\},]*)\}/<B<$1>>/g;
307 s/\@uref\{([^\},]*),([^\},]*)\}/$2 (C<$1>)/g;
308 s/\@uref\{([^\},]*),([^\},]*),([^\},]*)\}/$3/g;
310 # Turn B<blah I<blah> blah> into B<blah> I<blah> B<blah> to
311 # match Texinfo semantics of @emph inside @samp. Also handle @r
315 1 while s/B<((?:[^<>]|I<[^<>]*>)*)R<([^>]*)>/B<$1>${2}B</g;
316 1 while (s/B<([^<>]*)I<([^>]+)>/B<$1>I<$2>B</g);
317 1 while (s/I<([^<>]*)B<([^>]+)>/I<$1>B<$2>I</g);
319 s/([BI])<(\s+)([^>]+)>/$2$1<$3>/g;
320 s/([BI])<([^>]+?)(\s+)>/$1<$2>$3/g;
322 # Extract footnotes. This has to be done after all other
323 # processing because otherwise the regexp will choke on formatting
325 while (/\@footnote/g) {
326 s/\@footnote\{([^\}]+)\}/[$fnno]/;
327 add_footnote
($1, $fnno);
336 # Replace escaped symbols with their equivalents.
350 unless (exists $sects{FOOTNOTES
}) {
351 $sects{FOOTNOTES
} = "\n=over 4\n\n";
354 $sects{FOOTNOTES
} .= "=item $fnno.\n\n"; $fnno++;
355 $sects{FOOTNOTES
} .= $_[0];
356 $sects{FOOTNOTES
} .= "\n\n";