1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
#!/usr/bin/perl -w
########################################################################
##
## Copyright (C) 2012-2025 The Octave Project Developers
##
## See the file COPYRIGHT.md in the top-level directory of this
## distribution or <https://octave.org/copyright/>.
##
## This file is part of Octave.
##
## Octave is free software: you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the file COPYING. If not, see
## <https://www.gnu.org/licenses/>.
##
########################################################################
# Validate program call
die "usage: munge-texi TOP-SRCDIR DOCSTRING-FILE < file" if (@ARGV < 2);
$top_srcdir = shift (@ARGV);
# Constant patterns
$doc_delim = qr/^\x{1d}/;
$tex_delim = qr/\Q-*- texinfo -*-\E/;
$comment_line = qr/^\s*(?:$|#)/;
# Pre-declare hash size for efficiency
keys(%help_text) = 1800;
################################################################################
# Load DOCSTRINGS into memory while expanding @seealso references
foreach $DOCSTRING_file (@ARGV)
{
## DOCSTRINGS files may exist in the current (build) directory OR
## in the source directory when building from a release.
$DOCSTRING_file_srcdir = "$top_srcdir/$DOCSTRING_file";
open (DOCFH, $DOCSTRING_file) or open (DOCFH, $DOCSTRING_file_srcdir)
or die "Unable to open $DOCSTRING_file\n";
# Skip comments
while (defined ($_ = <DOCFH>) and /$comment_line/o) {;}
# Validate DOCSTRING file format
die "invalid doc file format\n" if (! /$doc_delim/o);
do
{
s/\s*$//; # strip EOL character(s)
$symbol = substr ($_, 1);
$docstring = extract_docstring ();
if ($help_text{$symbol})
{
warn "$DOCSTRING_file:$.:warning: ignoring duplicate entry for $symbol\n";
}
else
{
$help_text{$symbol} = $docstring;
}
} while (! eof);
}
################################################################################
# Process .txi to .texi by expanding @DOCSTRING, @EXAMPLEFILE macros
# Add warning header
print '@c DO NOT EDIT! Generated automatically by munge-texi.pl.',"\n\n";
TXI_LINE: while (<STDIN>)
{
s'@seealso'@xseealso'g;
if (/^\s*\@DOCSTRING\((\S+)\)/)
{
$func = $1;
$docstring = $help_text{$func};
if (! $docstring)
{
warn "warning: no DOCSTRING entry for $func\n";
next TXI_LINE;
}
$func =~ s/^@/@@/; # Texinfo uses @@ to produce '@'
$func =~ s/\./_/g; # Texinfo doesn't like '.' in node names
# Replace texinfo start tag by an anchor. QtHelp requires a string
# directly following the anchor. Adding a in html mode adds an
# additional vertical space which is compensated by span-tag with
# negativ top margin
$docstring =~ s/^$tex_delim$/\@anchor{XREF$func}\n\@html\n<span style=\"display:block; margin-top:-4.5ex;\"> <\/span>\n\@end html\n\n/m;
print $docstring,"\n";
next TXI_LINE;
}
if (/^\s*\@EXAMPLEFILE\((\S+)\)/)
{
$fname = "$top_srcdir/examples/code/$1";
print '@verbatim',"\n";
open (EXAMPFH, $fname) or die "unable to open example file $fname\n";
while (<EXAMPFH>)
{
print $_;
print "\n" if (eof and substr ($_, -1) ne "\n");
}
close (EXAMPFH);
print '@end verbatim',"\n";
next TXI_LINE;
}
# pass ordinary lines straight through to output
print $_;
}
################################################################################
# Subroutines
################################################################################
sub extract_docstring
{
my ($docstring, $arg_list, $func_list, $repl, $rest_of_line);
while (defined ($_ = <DOCFH>) and ! /$doc_delim/o)
{
# expand any @seealso references
if (m'^@seealso\{')
{
# join multiple lines until full macro body found
while (! /}/m) { $_ .= <DOCFH>; }
($arg_list, $rest_of_line) = m'^@seealso\{(.*)\}(.*)?'s;
$func_list = $arg_list;
$func_list =~ s/\s+//gs;
$repl = "";
foreach $func (split (/,/, $func_list))
{
$func =~ s/^@/@@/; # Texinfo uses @@ to produce '@'
$node = $func;
$node =~ s/\./_/g; # Texinfo doesn't like '.' in node names
$repl .= "\@ref{XREF$node,,$func}, ";
}
substr($repl,-2) = ""; # Remove last ', '
# write out @xseealso because we have our own macro that conflicts
# with the one introduced in Texinfo 6.
$_ = "\@xseealso{$repl}$rest_of_line";
}
$docstring .= $_;
}
return $docstring;
}
|
