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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
#!/usr/bin/perl
# File: api2man.pl
# Description: Convert the PLplot API chapter (file api.xml of the DocBook
# manual) into a swig documentation file.
# $Id: api2text.pl 11276 2010-10-27 01:39:26Z airwin $
#
# Copyright (C) 2000, 2003 Rafael Laboissiere
# Copyright (C) 2010 Alan W. Irwin
#
# This script relies on the present structure of the API chapter (file
# ../src/api.xml), where each API function is documented in its own
# section. Here is the typical structure of a section:
#
# <sect1 id="NAME">
# <title><function>NAME</function>: DESCRIPTION</title>
#
# <para>
# <funcsynopsis>
# <funcprototype>
# <funcdef>
# <function>NAME</function>
# </funcdef>
# <paramdef><parameter>ARG1</parameter></paramdef>
# <paramdef><parameter>ARG2</parameter></paramdef>
# ...
# </funcprototype>
# </funcsynopsis>
# </para>
#
# <para>
# DESCRIPTION
# </para>
#
# <variablelist>
# <varlistentry>
# <term>
# <parameter>ARG1</parameter>
# TYPE
# </term>
# <listitem>
# <para>
# ARG1 DESCRIPTION
# </para>
# </listitem>
# </varlistentry>
# ...
# </variablelist>
#
# <para>
# REDACTED FORM
# </para>
# <para>
# EXAMPLES LIST
# </para>
# </sect1>
# Call this script by giving the master file (typically
# plplotdoc.xml) as the first argument, the API chapter file
# (typically api.xml) as the second argument, and output file
# (typically swig_documentation.i) as third.
use XML::Parser;
use XML::DOM;
use Text::Wrap;
$Text::Wrap::columns = 75;
use Text::Tabs;
$tabstop = 4;
$api = "";
open (MASTER, "< $ARGV[0]");
while (<MASTER>) {
if (/^(<!DOCTYPE.*)\[/) {
$api .= "$1 [\n";
}
elsif (/^<\?xml/) {
$api .= '<?xml version="1.0" standalone="yes"?>
';
}
elsif (/^<!ENTITY pl/) {
$api .= $_;
}
}
$api .= "<!ENTITY amp '#38;#38;'>
<!ENTITY deg ' degrees'>
<!ENTITY gt '>'>
<!ENTITY leq '&#60;='>
<!ENTITY lt '&#60;'>
<!ENTITY ndash '--'>
]>\n";
close MASTER;
open (API, "< $ARGV[1]");
$/ = undef;
$api .= <API>;
close API;
sub process_node {
my $ret = "";
my $t = shift;
my $c = $t->getChildNodes;
my $m = $c->getLength;
for (my $j = 0; $j < $m; $j++) {
my $e = $c->item($j);
my $nt = $e->getNodeType;
if ($nt == TEXT_NODE) {
my $a = $e->getData;
$a =~ s/^\s+/ /;
$a =~ s/^\s+$//;
$a =~ s/\n\s+/ /g;
$ret .= $a;
}
elsif ($nt == ELEMENT_NODE) {
my $tag = $e->getTagName;
if ($tag eq "parameter") {
$ret .= "\n" . process_node ($e);
}
elsif ($tag eq "function") {
$ret .= process_node ($e);
}
elsif ($tag eq "link") {
$ret .= process_node ($e) ;
}
elsif ($tag eq "funcprototype") {
$startproto = 1;
my $p = process_node ($e);
$p =~ s/ +$//;
$ret .= $p . ")";
}
elsif ($tag eq "paramdef") {
my $p = process_node ($e);
$p =~ s/ +$//;
$ret .= ($startproto ? "(" : ", ") . $p;
$startproto = 0;
}
elsif ($tag eq "term") {
$ret .= "\n" . process_node ($e) . ":";
}
elsif ($tag eq "listitem") {
$ret .= "\t" . process_node ($e) . "\n";
}
elsif ($tag eq "xref") {
$ret .= "the PLplot documentation";
}
elsif ($tag eq "simplelist") {
my $ncols = $e->getAttributeNode ("columns")->getValue;
my $children = $e->getElementsByTagName ("member");
my $nc = $children->getLength;
$ret .= join ("", map {
($_ % $ncols ? "\t" : "\n")
. process_node ($children->item ($_))
. " ";
} (0 .. ($nc - 1))) . "\n\n";
}
elsif ($tag eq "varlistentry") {
$ret .= "\n" . process_node ($e);
}
else {
$ret .= process_node ($e);
}
}
else {
$ret .= process_node ($e);
}
}
$ret =~ s/^\s+//;
return $ret;
}
$p = new XML::DOM::Parser;
$sects = $p->parse ($api)->getElementsByTagName ("sect1");
my $ns = $sects->getLength;
$titles = "";
open (MAN, "> $ARGV[2]");
print MAN "// This file is generated by doc/docbook/src/api2swigdoc.pl from\n";
print MAN "// doc/docbook/src/api.xml. Do not modify by hand since this file\n";
print MAN "// will be overwritten. Edit doc/docbook/src/api.xml instead.\n\n";
for ($i = 0; $i < $ns; $i++) {
$fun = $sects->item ($i);
$name = $fun->getAttribute ("id");
$c = $fun->getChildNodes;
$nc = $c->getLength;
$desc = "";
$varlist = "";
$got_synopsis = 0;
$indent = ' ';
for ($j = 0; $j < $nc; $j++) {
$part = $c->item($j);
if ($part->getNodeType == ELEMENT_NODE) {
$contents = process_node ($part);
$node = $part->getTagName;
if ($node eq "title") {
$title = $contents;
}
elsif ($node eq "para") {
if ($got_synopsis) {
$desc .= wrap ($indent, $indent, split(/\n\s*\n/, $contents)) . "\n\n";
}
else {
$synopsis = $contents;
$got_synopsis = 1;
}
}
elsif ($node eq "variablelist") {
$varlist = $contents;
}
}
}
$varlist = join ("\n", map {
s/\t/ /g;
/(^\s+)/;
$_ = wrap ($indent . $1,
$indent . $1 . $indent, $_);
s/\t/ /g;
$_;
} split ("\n", $varlist));
# Get rid of preceding name identifier followed by ":" that is normally
# part of the raw title in api.xml.
$title =~s/^.*: //;
# Escape double quotes in description and arguments
$desc =~ s/\"/\\"/g;
$varlist =~ s/\"/\\"/g;
print MAN "%feature( \"docstring\", \"$title\n";
print MAN "\nDESCRIPTION:\n\n$desc\n";
print MAN "\nSYNOPSIS:\n\n$synopsis\n";
print MAN "\nARGUMENTS:\n\n$varlist\n"
if not $varlist eq "";
print MAN "\")\n$name;\n\n";
}
close MAN;
|
