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, 51 Franklin Street, Fifth Floor,
20 # Boston, MA 02110-1301 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.
31 @chapters_sequence = ();
51 ($flag, $value) = ($flag =~ /^([^=]+)(?:=(.+))?/);
52 die "no flag specified for -D\n"
54 die "flags may only contain letters, digits, hyphens, dashes and underscores\n"
55 unless $flag =~ /^[a-zA-Z0-9_-]+$/;
56 $defs{$flag} = $value;
57 } elsif (/^-I(.*)$/) {
58 push @ibase, $1 ne "" ? $1 : shift;
62 $in = $_, next unless defined $in;
63 $out = $_, next unless defined $out;
72 open($inf, "<$in") or die "opening \"$in\": $!\n";
73 push @ibase, $1 if $in =~ m|^(.+)/[^/]+$|;
79 open(STDOUT, ">$out") or die "opening \"$out\": $!\n";
84 # Certain commands are discarded without further processing.
86 [a-z]+index # @*index: useful only in complete manual
87 |need # @need: useful only in printed manual
88 |(?:end\s+)?group # @group .. @end group: ditto
90 |node # @node: useful only in .info file
91 |(?:end\s+)?ifnottex # @ifnottex .. @end ifnottex: use contents
96 # Look for filename and title markers.
97 /^\@setfilename\s+([^.]+)/ and $fn = $1, next;
98 /^\@settitle\s+([^.]+)/ and $tl = postprocess($1), next;
100 # Identify a man title but keep only the one we are interested in.
101 /^\@c\s+man\s+title\s+([A-Za-z0-9-]+)\s+(.+)/ and do {
102 if (exists $defs{$1}) {
104 $tl = postprocess($2);
109 /^\@include\s+(.+)$/ and do {
114 open($inf, "<" . $_ . "/" . $1) and next INF;
116 die "cannot open $1: $!\n";
119 /^\@chapter\s+([A-Za-z ]+)/ and do {
121 $chapters{$chapter_name} .= postprocess($chapter) if ($chapter_name);
124 $chapter_name = $1, push (@chapters_sequence, $chapter_name) unless $skipping;
125 $chapters{$chapter_name} = "" unless exists $chapters{$chapter_name};
133 $chapters{$chapter_name} .= postprocess($chapter) if ($chapter_name);
138 /^\@set\s+([a-zA-Z0-9_-]+)\s*(.*)$/ and do {
142 /^\@clear\s+([a-zA-Z0-9_-]+)/ and do {
149 # Discard comments. (Can't do it above, because then we'd never see
153 # End-block handler goes up here because it needs to operate even
154 # if we are skipping.
155 /^\@end\s+([a-z]+)/ and do {
156 # Ignore @end foo, where foo is not an operation which may
157 # cause us to skip, if we are presently skipping.
159 next if $skipping && $ended !~ /^(?:ifset|ifclear|ignore|menu|iftex|ifhtml|ifnothtml)$/;
161 die "\@end $ended without \@$ended at line $.\n" unless defined $endw;
162 die "\@$endw ended by \@end $ended at line $.\n" unless $ended eq $endw;
164 $endw = pop @endwstack;
166 if ($ended =~ /^(?:ifset|ifclear|ignore|menu|iftex|ifhtml|ifnothtml)$/) {
167 $skipping = pop @skstack;
169 } elsif ($ended =~ /^(?:example|smallexample|verbatim|display)$/) {
171 $_ = ""; # need a paragraph break
172 } elsif ($ended =~ /^(?:itemize|enumerate|(?:multi|[fv])?table)$/) {
175 } elsif ($ended =~ /^float$/) {
179 die "unknown command \@end $ended at line $.\n";
183 # We must handle commands which can cause skipping even while we
184 # are skipping, otherwise we will not process nested conditionals
186 /^\@ifset\s+([a-zA-Z0-9_-]+)/ and do {
187 push @endwstack, $endw;
188 push @skstack, $skipping;
190 $skipping = 1 unless exists $defs{$1};
194 /^\@ifclear\s+([a-zA-Z0-9_-]+)/ and do {
195 push @endwstack, $endw;
196 push @skstack, $skipping;
198 $skipping = 1 if exists $defs{$1};
202 /^\@(ignore|menu|iftex|ifhtml|ifnothtml)\b/ and do {
203 push @endwstack, $endw;
204 push @skstack, $skipping;
206 $skipping = $endw !~ /ifnothtml/;
212 # Character entities. First the ones that can be replaced by raw text
213 # or discarded outright:
214 s/\@copyright\{\}/(c)/g;
216 s/\@enddots\{\}/..../g;
219 s/\@bullet(?:\{\})?/*/g;
222 s/\@minus(?:\{\})?/-/g;
224 # Now the ones that have to be replaced by special escapes
225 # (which will be turned back into text by unmunge())
231 # Inside a verbatim block, handle @var specially.
233 s/\@var\{([^\}]*)\}/<$1>/g;
236 # POD doesn't interpret E<> inside a verbatim block.
245 # Single line command handlers.
247 /^\@(?:section|unnumbered|unnumberedsec|center|heading)\s+(.+)$/
248 and $_ = "\n=head2 $1\n";
249 /^\@(?:subsection|subheading)\s+(.+)$/
250 and $_ = "\n=head3 $1\n";
251 /^\@(?:subsubsection|subsubheading)\s+(.+)$/
252 and $_ = "\n=head4 $1\n";
254 # Block command handlers:
255 /^\@itemize\s*(\@[a-z]+|\*|-)?/ and do {
256 push @endwstack, $endw;
263 /^\@enumerate(?:\s+([a-zA-Z0-9]+))?/ and do {
264 push @endwstack, $endw;
275 /^\@((?:multi|[fv])?table)\s+(\@[a-z]+)/ and do {
276 push @endwstack, $endw;
280 $ic =~ s/\@(?:samp|strong|key|gcctabopt|option|env|command)/B/;
281 $ic =~ s/\@(?:code|kbd)/C/;
282 $ic =~ s/\@(?:dfn|var|emph|cite|i)/I/;
283 $ic =~ s/\@(?:file)/F/;
284 $ic =~ s/\@(?:columnfractions)//;
288 /^\@(multitable)\s+{.*/ and do {
289 push @endwstack, $endw;
296 /^\@((?:small)?example|verbatim|display)/ and do {
297 push @endwstack, $endw;
300 $_ = ""; # need a paragraph break
303 /^\@(float)\s+\w+/ and do {
304 push @endwstack, $endw;
309 /^\@item\s+(.*\S)\s*$/ and $endw eq "multitable" and do {
311 $columns =~ s/\@tab/ : /;
313 $_ = "\n=item B<". $columns .">\n";
316 /^\@tab\s+(.*\S)\s*$/ and $endw eq "multitable" and do {
318 $columns =~ s/\@tab//;
324 /^\@itemx?\s*(.+)?$/ and do {
326 # Entity escapes prevent munging by the <> processing below.
327 $_ = "\n=item $ic\<$1\>\n";
329 $_ = "\n=item $ic\n";
330 $ic =~ y/A-Ya-y/B-Zb-z/;
331 $ic =~ s/(\d+)/$1 + 1/eg;
335 $chapter .= $shift.$_."\n";
337 # End of current file.
342 die "No filename or title\n" unless defined $fn && defined $tl;
345 print "=encoding utf8\n\n";
347 $chapters{NAME} = "$fn \- $tl\n";
348 $chapters{FOOTNOTES} .= "=back\n" if exists $chapters{FOOTNOTES};
350 unshift @chapters_sequence, "NAME";
351 for $chapter (@chapters_sequence) {
352 if (exists $chapters{$chapter}) {
353 $head = uc($chapter);
354 print "=head1 $head\n\n";
355 print scalar unmunge ($chapters{$chapter});
362 die "usage: $0 [-D toggle...] [infile [outfile]]\n";
369 # @value{foo} is replaced by whatever 'foo' is defined as.
370 while (m/(\@value\{([a-zA-Z0-9_-]+)\})/g) {
371 if (! exists $defs{$2}) {
372 print STDERR "Option $2 not defined\n";
380 # Formatting commands.
381 # Temporary escape for @r.
382 s/\@r\{([^\}]*)\}/R<$1>/g;
383 s/\@(?:dfn|var|emph|cite|i)\{([^\}]*)\}/I<$1>/g;
384 s/\@(?:code|kbd)\{([^\}]*)\}/C<$1>/g;
385 s/\@(?:gccoptlist|samp|strong|key|option|env|command|b)\{([^\}]*)\}/B<$1>/g;
386 s/\@sc\{([^\}]*)\}/\U$1/g;
387 s/\@file\{([^\}]*)\}/F<$1>/g;
388 s/\@w\{([^\}]*)\}/S<$1>/g;
389 s/\@(?:dmn|math)\{([^\}]*)\}/$1/g;
391 # Cross references are thrown away, as are @noindent and @refill.
392 # (@noindent is impossible in .pod, and @refill is unnecessary.)
393 # @* is also impossible in .pod; we discard it and any newline that
394 # follows it. Similarly, our macro @gol must be discarded.
396 s/\@anchor\{(?:[^\}]*)\}//g;
397 s/\(?\@xref\{(?:[^\}]*)\}(?:[^.<]|(?:<[^<>]*>))*\.\)?//g;
398 s/\s+\(\@pxref\{(?:[^\}]*)\}\)//g;
399 s/;\s+\@pxref\{(?:[^\}]*)\}//g;
400 s/\@ref\{(?:[^,\}]*,)(?:[^,\}]*,)([^,\}]*).*\}/B<$1>/g;
401 s/\@ref\{([^\}]*)\}/B<$1>/g;
407 # @uref can take one, two, or three arguments, with different
408 # semantics each time. @url and @email are just like @uref with
409 # one argument, for our purposes.
410 s/\@(?:uref|url|email)\{([^\},]*),?[^\}]*\}/<B<$1>>/g;
411 s/\@uref\{([^\},]*),([^\},]*)\}/$2 (C<$1>)/g;
412 s/\@uref\{([^\},]*),([^\},]*),([^\},]*)\}/$3/g;
414 # Turn B<blah I<blah> blah> into B<blah> I<blah> B<blah> to
415 # match Texinfo semantics of @emph inside @samp. Also handle @r
419 1 while s/B<((?:[^<>]|I<[^<>]*>)*)R<([^>]*)>/B<$1>${2}B</g;
420 1 while (s/B<([^<>]*)I<([^>]+)>/B<$1>I<$2>B</g);
421 1 while (s/I<([^<>]*)B<([^>]+)>/I<$1>B<$2>I</g);
423 s/([BI])<(\s+)([^>]+)>/$2$1<$3>/g;
424 s/([BI])<([^>]+?)(\s+)>/$1<$2>$3/g;
426 # Extract footnotes. This has to be done after all other
427 # processing because otherwise the regexp will choke on formatting
429 while (/\@footnote/g) {
430 s/\@footnote\{([^\}]+)\}/[$fnno]/;
431 add_footnote($1, $fnno);
440 # Replace escaped symbols with their equivalents.
454 unless (exists $chapters{FOOTNOTES}) {
455 $chapters{FOOTNOTES} = "\n=over 4\n\n";
458 $chapters{FOOTNOTES} .= "=item $fnno.\n\n"; $fnno++;
459 $chapters{FOOTNOTES} .= $_[0];
460 $chapters{FOOTNOTES} .= "\n\n";
463 # stolen from Symbol.pm
468 my $name = "GEN" . $genseq++;