Mercurial > hg > octave-lyh

annotate doc/interpreter/munge-texi.pl @ 17161:96b64a18be13

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Fix building info with new macro fixcontentsmargin. * doc/interpreter/octave.texi: Use @iftex/@end iftex around @fixcontentsmargin call.
author Rik <rik@octave.org>
date Fri, 02 Aug 2013 14:25:24 -0700
parents e7a059a9a644
children 3f4091dddc13
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14611
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
1 #!/usr/bin/perl -w
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
2
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
3 # Validate program call
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
4 die "usage: munge-texi TOP-SRCDIR DOCSTRING-FILE < file" if (@ARGV < 2);
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
5
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
6 $top_srcdir = shift (@ARGV);
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
7
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
8 # Constant patterns
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
9 $doc_delim = qr/^\c_/;
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
10 $tex_delim = qr/\Q-*- texinfo -*-\E/;
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
11 $comment_line = qr/^\s*(?:$|#)/;
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
12 # Pre-declare hash size for efficiency
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
13 keys(%help_text) = 1800;
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
14
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
15 ################################################################################
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
16 # Load DOCSTRINGS into memory while expanding @seealso references
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
17 foreach $DOCSTRING_file (@ARGV)
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
18 {
14744
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
19 open (DOCFH, $DOCSTRING_file) or die "Unable to open $DOCSTRING_file\n";
14611
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
20
14744
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
21 # Skip comments
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
22 while (defined ($_ = <DOCFH>) and /$comment_line/o) {;}
14611
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
23
14744
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
24 # Validate DOCSTRING file format
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
25 die "invalid doc file format\n" if (! /$doc_delim/o);
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
26
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
27 do
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
28 {
15906
1af9fa3d6a0b munge-texi.pl: Strip EOL character(s) in a platform-agnostic way.
Rik <rik@octave.org>
parents: 14744
diff changeset
29 s/\s*$//; # strip EOL character(s)
14744
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
30 $symbol = substr ($_,1);
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
31 $docstring = extract_docstring ();
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
32 if ($help_text{$symbol})
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
33 {
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
34 warn "ignoring duplicate entry for $symbol\n";
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
35 }
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
36 else
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
37 {
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
38 $help_text{$symbol} = $docstring;
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
39 }
14611
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
40
14744
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
41 } while (! eof);
14611
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
42
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
43 }
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
44
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
45 ################################################################################
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
46 # Process .txi to .texi by expanding @DOCSTRING, @EXAMPLEFILE macros
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
47
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
48 # Add warning header
15906
1af9fa3d6a0b munge-texi.pl: Strip EOL character(s) in a platform-agnostic way.
Rik <rik@octave.org>
parents: 14744
diff changeset
49 print '@c DO NOT EDIT! Generated automatically by munge-texi.pl.',"\n\n";
14611
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
50
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
51 TXI_LINE: while (<STDIN>)
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
52 {
14744
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
53 if (/^\s*\@DOCSTRING\((\S+)\)/)
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
54 {
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
55 $func = $1;
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
56 $docstring = $help_text{$func};
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
57 if (! $docstring)
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
58 {
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
59 warn "no docstring entry for $func\n";
14611
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
60 next TXI_LINE;
14744
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
61 }
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
62
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
63 $func =~ s/^@/@@/; # Texinfo uses @@ to produce '@'
17101
e7a059a9a644 doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents: 16772
diff changeset
64 $docstring =~ s/^$tex_delim$/\@anchor{XREF$func}/m;
14744
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
65 print $docstring,"\n";
14611
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
66
14744
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
67 next TXI_LINE;
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
68 }
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
69 if (/^\s*\@EXAMPLEFILE\((\S+)\)/)
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
70 {
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
71 $fname = "$top_srcdir/examples/$1";
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
72 print '@verbatim',"\n";
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
73 open (EXAMPFH, $fname) or die "unable to open example file $fname\n";
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
74 while (<EXAMPFH>)
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
75 {
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
76 print $_;
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
77 print "\n" if (eof and substr ($_, -1) ne "\n");
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
78 }
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
79 close (EXAMPFH);
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
80 print '@end verbatim',"\n\n";
14611
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
81
14744
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
82 next TXI_LINE;
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
83 }
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
84
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
85 # pass ordinary lines straight through to output
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
86 print $_;
14611
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
87 }
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
88
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
89
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
90 ################################################################################
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
91 # Subroutines
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
92 ################################################################################
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
93 sub extract_docstring
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
94 {
14744
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
95 my ($docstring, $arg_list, $func_list, $repl, $rest_of_line);
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
96
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
97 while (defined ($_ = <DOCFH>) and ! /$doc_delim/o)
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
98 {
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
99 # expand any @seealso references
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
100 if (m'^@seealso{')
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
101 {
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
102 # Join multiple lines until full macro body found
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
103 while (! /}/m) { $_ .= <DOCFH>; }
14611
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
104
14744
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
105 ($arg_list, $rest_of_line) = m'^@seealso{(.*)}(.*)?'s;
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
106
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
107 $func_list = $arg_list;
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
108 $func_list =~ s/\s+//gs;
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
109 $repl = "";
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
110 foreach $func (split (/,/, $func_list))
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
111 {
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
112 $func =~ s/^@/@@/; # Texinfo uses @@ to produce '@'
17101
e7a059a9a644 doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents: 16772
diff changeset
113 $repl .= "\@ref{XREF$func,,$func}, ";
14611
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
114 }
14744
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
115 substr($repl,-2) = ""; # Remove last ', '
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
116 $_ = "\@seealso{$repl}$rest_of_line";
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
117 }
14611
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
118
14744
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
119 $docstring .= $_;
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
120 }
14611
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
121
14744
a52b03df22cb maint: Use Octave 2-space indent for helper Perl scripts.
Rik <octave@nomad.inbox5.com>
parents: 14611
diff changeset
122 return $docstring;
14611
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
123 }
f2ed09ae8d3f doc: Produce .texi from .txi files using Perl rather than C++.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
124