blob: 536f324011f23234210104ebae0817cb04cc5056 [file] [log] [blame]
Fred Drake6659c301998-03-03 22:02:19 +00001# python.perl by Fred L. Drake, Jr. <fdrake@acm.org> -*- perl -*-
2#
3# Heavily based on Guido van Rossum's myformat.perl (now obsolete).
4#
5# Extension to LaTeX2HTML for documents using myformat.sty.
6# Subroutines of the form do_cmd_<name> here define translations
7# for LaTeX commands \<name> defined in the corresponding .sty file.
8
9package main;
10
11
Fred Drake08932051998-04-17 02:15:42 +000012sub next_argument_id{
13 my ($param,$br_id);
14 $param = missing_braces()
15 unless ((s/$next_pair_pr_rx/$br_id=$1;$param=$2;''/eo)
16 ||(s/$next_pair_rx/$br_id=$1;$param=$2;''/eo));
17 ($param, $br_id);
18}
19
20sub next_argument{
21 my ($param,$br_id) = next_argument_id();
22 $param;
23}
24
25sub next_optional_argument{
26 my($param,$rx) = ('', "^\\s*(\\[([^]]*)\\])?");
Fred Drake5ccf3301998-04-17 20:04:09 +000027 s/$rx/$param=$2;''/eo;
Fred Drake08932051998-04-17 02:15:42 +000028 $param;
29}
30
31sub swallow_newline{
32 s/[\n]?//o;
33}
34
Fred Drake5ccf3301998-04-17 20:04:09 +000035sub ArabictoRoman {
36 # Written by Robert Donohue <donahue@cfassp48.harvard.edu>,
37 # fixed by Fred Drake <fdrake@acm.org>,
38 # kept around in case it becomes useful.
39 my $a = @_;
40 my($b,@c,$i);
41 my(@D0,@D1,@D2);
42
43 @D0 = ("", "I", "II", "III", "IV", "V", "VI", "VII", "VIII", "IX");
44 @D1 = ("", "X", "XX", "XXX", "XL", "L", "LX", "LXX", "LXXX", "XC");
45 @D2 = ("", "C", "CC", "CCC", "CD", "D", "DC", "DCC", "DCCC", "CM");
46
47 $b = $a;
48 $i = 0;
49 while($b > 0) {
50 $c[$i] = ($b % 10);
51 $b -= ($b % 10);
52 $b /= 10;
53 $i++;
54 }
55 $D2[$c[2]] . $D1[$c[1]] . $D0[$c[0]];
56}
57
Fred Drake6659c301998-03-03 22:02:19 +000058# words typeset in a special way (not in HTML though)
59
60sub do_cmd_ABC{ 'ABC' . @_[0]; }
61sub do_cmd_UNIX{ 'Unix'. @_[0]; }
62sub do_cmd_ASCII{ 'ASCII' . @_[0]; }
63sub do_cmd_POSIX{ 'POSIX' . @_[0]; }
64sub do_cmd_C{ 'C' . @_[0]; }
65sub do_cmd_Cpp{ 'C++' . @_[0]; }
66sub do_cmd_EOF{ 'EOF' . @_[0]; }
67sub do_cmd_NULL{ '<tt>NULL</tt>' . @_[0]; }
68
69sub do_cmd_e{ '&#92;' . @_[0]; }
70
Fred Draked07868a1998-05-14 21:00:28 +000071$DEVELOPER_ADDRESS = '';
Fred Drake6659c301998-03-03 22:02:19 +000072$PYTHON_VERSION = '';
73
74sub do_cmd_version{ $PYTHON_VERSION . @_[0]; }
75sub do_cmd_release{
76 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +000077 $PYTHON_VERSION = next_argument();
Fred Drake6659c301998-03-03 22:02:19 +000078 $_;
79}
80
81sub do_cmd_authoraddress{
82 local($_) = @_;
Fred Draked07868a1998-05-14 21:00:28 +000083 $DEVELOPER_ADDRESS = next_argument();
Fred Drake6659c301998-03-03 22:02:19 +000084 $_;
85}
86
Fred Draked07868a1998-05-14 21:00:28 +000087sub do_cmd_developer{ do_cmd_author(@_[0]); }
88sub do_cmd_developers{ do_cmd_author(@_[0]); }
89sub do_cmd_developersaddress{ do_cmd_authoraddress(@_[0]); }
90
Fred Drake6659c301998-03-03 22:02:19 +000091sub do_cmd_hackscore{
92 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +000093 next_argument();
94 '_' . $_;
Fred Drake6659c301998-03-03 22:02:19 +000095}
96
Fred Drake08932051998-04-17 02:15:42 +000097sub use_wrappers{
98 local($_,$before,$after) = @_;
99 my $stuff = next_argument();
100 $before . $stuff . $after . $_;
101}
102
103sub use_current{ use_wrappers(@_[0], '', ''); }
104sub use_sans_serif{ use_wrappers(@_[0], '<font face=sans-serif>', '</font>'); }
105sub use_italics{ use_wrappers(@_[0], '<i>', '</i>'); }
106
Fred Drake6659c301998-03-03 22:02:19 +0000107sub do_cmd_optional{
Fred Drake08932051998-04-17 02:15:42 +0000108 use_wrappers(@_[0], "</var><big>\[</big><var>",
109 "</var><big>\]</big><var>");
Fred Drake6659c301998-03-03 22:02:19 +0000110}
111
Fred Drakec9a44381998-03-17 06:29:13 +0000112# Logical formatting (some based on texinfo), needs to be converted to
113# minimalist HTML. The "minimalist" is primarily to reduce the size of
114# output files for users that read them over the network rather than
115# from local repositories.
Fred Drake6659c301998-03-03 22:02:19 +0000116
Fred Drake08932051998-04-17 02:15:42 +0000117sub do_cmd_pytype{ use_current(@_); }
118sub do_cmd_makevar{ use_current(@_); }
119sub do_cmd_code{ use_wrappers(@_[0], '<tt>', '</tt>'); }
120sub do_cmd_module{ do_cmd_code(@_); }
121sub do_cmd_keyword{ do_cmd_code(@_); }
122sub do_cmd_exception{ do_cmd_code(@_); }
123sub do_cmd_class{ do_cmd_code(@_); }
124sub do_cmd_function{ do_cmd_code(@_); }
125sub do_cmd_constant{ do_cmd_code(@_); }
126sub do_cmd_member{ do_cmd_code(@_); }
127sub do_cmd_method{ do_cmd_code(@_); }
128sub do_cmd_cfunction{ do_cmd_code(@_); }
129sub do_cmd_cdata{ do_cmd_code(@_); }
130sub do_cmd_ctype{ do_cmd_code(@_); }
131sub do_cmd_regexp{ do_cmd_code(@_); }
Fred Drake08932051998-04-17 02:15:42 +0000132sub do_cmd_character{ do_cmd_samp(@_); }
133sub do_cmd_program{ do_cmd_strong(@_); }
134sub do_cmd_email{ use_sans_serif(@_); }
135sub do_cmd_mimetype{ use_sans_serif(@_); }
136sub do_cmd_var{ use_italics(@_); }
137sub do_cmd_dfn{ use_italics(@_); } # make an index entry?
138sub do_cmd_emph{ use_italics(@_); }
139sub do_cmd_file{ use_wrappers(@_[0], '"<tt>', '</tt>"'); }
140sub do_cmd_samp{ use_wrappers(@_[0], '"<tt>', '</tt>"'); }
141sub do_cmd_kbd{ use_wrappers(@_[0], '<kbd>', '</kbd>'); }
142sub do_cmd_strong{ use_wrappers(@_[0], '<b>', '</b>'); }
Fred Drakec9a44381998-03-17 06:29:13 +0000143
Fred Drake1a7af391998-04-01 22:44:56 +0000144sub do_cmd_newsgroup{
145 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000146 my $newsgroup = next_argument();
Fred Drake1a7af391998-04-01 22:44:56 +0000147 my $stuff = "<a href=\"news:$newsgroup\"><font face=sans-serif>"
148 . "$newsgroup</font></a>";
149 $stuff . $_;
150}
Fred Drakefc16e781998-03-12 21:03:26 +0000151
152sub do_cmd_envvar{
153 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000154 my($envvar,$br_id) = next_argument_id();
Fred Drake42b31a51998-03-27 05:16:10 +0000155 my($name,$aname,$ahref) = link_info($br_id);
Fred Drake166abba1998-04-08 23:10:54 +0000156 # The <tt> here is really to keep buildindex.py from making
157 # the variable name case-insensitive.
158 add_index_entry("environment variables!$envvar@<tt>\$$envvar</tt>",
159 $ahref);
Fred Drake42b31a51998-03-27 05:16:10 +0000160 add_index_entry("$envvar@\$$envvar", $ahref);
161 "$aname\$$envvar</a>" . $_;
Fred Drakefc16e781998-03-12 21:03:26 +0000162}
163
Fred Drake08932051998-04-17 02:15:42 +0000164
Fred Drake6659c301998-03-03 22:02:19 +0000165sub do_cmd_url{
166 # use the URL as both text and hyperlink
167 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000168 my $url = next_argument();
Fred Drake6659c301998-03-03 22:02:19 +0000169 $url =~ s/~/&#126;/g;
Fred Drakec9a44381998-03-17 06:29:13 +0000170 "<a href=\"$url\"><font face=sans-serif>$url</font></a>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000171}
172
173sub do_cmd_manpage{
174 # two parameters: \manpage{name}{section}
175 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000176 my $page = next_argument();
177 my $section = next_argument();
178 "<i>$page</i>($section)" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000179}
180
181sub do_cmd_rfc{
182 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000183 my($rfcnumber,$br_id) = next_argument();
Fred Drake6659c301998-03-03 22:02:19 +0000184
185 # Save the reference
Fred Drake08932051998-04-17 02:15:42 +0000186 my $nstr = gen_index_id("RFC!RFC $rfcnumber", '');
187 $index{$nstr} .= make_half_href("$CURRENT_FILE#$br_id");
Fred Drakec9a44381998-03-17 06:29:13 +0000188 "<a name=$br_id>RFC $rfcnumber</a>" .$_;
Fred Drake6659c301998-03-03 22:02:19 +0000189}
190
Fred Drake6659c301998-03-03 22:02:19 +0000191sub do_cmd_deprecated{
192 # two parameters: \deprecated{version}{whattodo}
193 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000194 my $release = next_argument();
195 my $reason = next_argument();
196 "<b>Deprecated since release $release.</b>\n$reason<p>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000197}
198
199# file and samp are at the end of this file since they screw up fontlock.
200
201# index commands
202
203$INDEX_SUBITEM = "";
204
205sub get_indexsubitem{
Fred Drakefc16e781998-03-12 21:03:26 +0000206 #$INDEX_SUBITEM ? " $INDEX_SUBITEM" : '';
207 '';
Fred Drake6659c301998-03-03 22:02:19 +0000208}
209
210sub do_cmd_setindexsubitem{
211 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000212 $INDEX_SUBITEM = next_argument();
Fred Drake6659c301998-03-03 22:02:19 +0000213 $_;
214}
215
Fred Drakefc16e781998-03-12 21:03:26 +0000216sub do_cmd_withsubitem{
217 # We can't really do the right right thing, because LaTeX2HTML doesn't
218 # do things in the right order, but we need to at least strip this stuff
219 # out, and leave anything that the second argument expanded out to.
220 #
221 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000222 next_argument();
223 my $stuff = next_argument();
224 $stuff . $_;
Fred Drakefc16e781998-03-12 21:03:26 +0000225}
226
Fred Drake08932051998-04-17 02:15:42 +0000227# This is the prologue macro which is required to start writing the
228# mod\jobname.idx file; we can just ignore it.
229#
Fred Drakefc16e781998-03-12 21:03:26 +0000230sub do_cmd_makemodindex{ @_[0]; }
231
Fred Drake42b31a51998-03-27 05:16:10 +0000232# We're in the document subdirectory when this happens!
Fred Drake166abba1998-04-08 23:10:54 +0000233#
Fred Drake08932051998-04-17 02:15:42 +0000234open(IDXFILE, '>index.dat') || die "\n$!\n";
235open(INTLABELS, '>intlabels.pl') || die "\n$!\n";
Fred Drake166abba1998-04-08 23:10:54 +0000236print INTLABELS "%internal_labels = ();\n";
237print INTLABELS "1; # hack in case there are no entries\n\n";
238
239# Using \0 for this is bad because we can't use common tools to work with the
240# resulting files. Things like grep can be useful with this stuff!
241#
242$IDXFILE_FIELD_SEP = "\1";
243
Fred Drake42b31a51998-03-27 05:16:10 +0000244
245sub gen_target_name{
246 "l2h-" . @_[0];
247}
248
249sub gen_target{
Fred Drake08932051998-04-17 02:15:42 +0000250 '<a name="' . @_[0] . '">';
Fred Drake42b31a51998-03-27 05:16:10 +0000251}
252
253sub gen_link{
254 my($node,$target) = @_;
255 print INTLABELS "\$internal_labels{\"$target\"} = \"$URL/$node\";\n";
256 "<a href=\"$node#$target\">";
257}
258
259sub make_index_entry{
260 my($br_id,$str) = @_;
261 my($name,$aname,$ahref) = link_info($br_id);
262 add_index_entry($str, $ahref);
263 "$aname$anchor_invisible_mark</a>";
264}
265
266sub add_index_entry{
267 # add an entry to the index structures; ignore the return value
268 my($str,$ahref) = @_;
269 $str = gen_index_id($str, '');
270 $index{$str} .= $ahref;
Fred Drake166abba1998-04-08 23:10:54 +0000271 print IDXFILE $ahref, $IDXFILE_FIELD_SEP, $str, "\n";
Fred Drake42b31a51998-03-27 05:16:10 +0000272}
273
274sub link_info{
275 my $name = gen_target_name(@_[0]);
276 my $aname = gen_target($name);
277 my $ahref = gen_link($CURRENT_FILE, $name);
278 return ($name, $aname, $ahref);
279}
280
281sub do_cmd_index{
282 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000283 my($str,$br_id) = next_argument_id();
284 swallow_newline();
Fred Drake42b31a51998-03-27 05:16:10 +0000285 #
286 my($name,$aname,$ahref) = link_info($br_id);
287 add_index_entry("$str", $ahref);
288 "$aname$anchor_invisible_mark</a>" . $_;
289}
290
Fred Drake2e7edb81998-05-11 18:31:17 +0000291sub do_cmd_kwindex{
292 local($_) = @_;
293 my($str,$br_id) = next_argument_id();
294 #
295 my($name,$aname,$ahref) = link_info($br_id);
296 add_index_entry("<tt>$str</tt>!keyword", $ahref);
297 add_index_entry("keyword!<tt>$str</tt>", $ahref);
298 "$aname$anchor_invisible_mark</a>" . $_;
299}
300
Fred Drake6659c301998-03-03 22:02:19 +0000301sub do_cmd_indexii{
302 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000303 my($str1,$br_id) = next_argument_id();
304 my $str2 = next_argument();
Fred Drake42b31a51998-03-27 05:16:10 +0000305 #
Fred Drake08932051998-04-17 02:15:42 +0000306 my($name,$aname,$ahref) = link_info($br_id);
Fred Drake42b31a51998-03-27 05:16:10 +0000307 add_index_entry("$str1!$str2", $ahref);
308 add_index_entry("$str2!$str1", $ahref);
309 "$aname$anchor_invisible_mark</a>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000310}
311
312sub do_cmd_indexiii{
313 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000314 my($str1,$br_id) = next_argument();
315 my $str2 = next_argument();
316 my $str3 = next_argument();
Fred Drake42b31a51998-03-27 05:16:10 +0000317 #
Fred Drake08932051998-04-17 02:15:42 +0000318 my($name,$aname,$ahref) = link_info($br_id);
Fred Drake42b31a51998-03-27 05:16:10 +0000319 add_index_entry("$str1!$str2 $str3", $ahref);
320 add_index_entry("$str2!$str3, $str1", $ahref);
321 add_index_entry("$str3!$str1 $str2", $ahref);
322 "$aname$anchor_invisible_mark</a>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000323}
324
325sub do_cmd_indexiv{
326 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000327 my($str1,$br_id) = next_argument();
328 my $str2 = next_argument();
329 my $str3 = next_argument();
330 my $str4 = next_argument();
Fred Drake42b31a51998-03-27 05:16:10 +0000331 #
Fred Drake08932051998-04-17 02:15:42 +0000332 my($name,$aname,$ahref) = link_info($br_id);
Fred Drake42b31a51998-03-27 05:16:10 +0000333 add_index_entry("$str1!$str2 $str3 $str4", $ahref);
334 add_index_entry("$str2!$str3 $str4, $str1", $ahref);
335 add_index_entry("$str3!$str4, $str1 $str2", $ahref);
336 add_index_entry("$str4!$$str1 $str2 $str3", $ahref);
337 "$aname$anchor_invisible_mark</a>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000338}
339
Fred Drakec9a44381998-03-17 06:29:13 +0000340sub do_cmd_ttindex{
341 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000342 my($str,$br_id) = next_argument_id();
343 swallow_newline();
344 make_index_entry($br_id, $str . get_indexsubitem()) . $_;
Fred Drakec9a44381998-03-17 06:29:13 +0000345}
Fred Drake6659c301998-03-03 22:02:19 +0000346
347sub my_typed_index_helper{
Fred Drakec9a44381998-03-17 06:29:13 +0000348 local($word,$_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000349 my($str,$br_id) = next_argument();
350 swallow_newline();
Fred Drake42b31a51998-03-27 05:16:10 +0000351 #
352 my($name,$aname,$ahref) = link_info($br_id1);
353 add_index_entry("$str $word", $ahref);
354 add_index_entry("$word!$str", $ahref);
355 "$aname$anchor_invisible_mark</a>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000356}
357
Fred Drake08932051998-04-17 02:15:42 +0000358sub do_cmd_stindex{ my_typed_index_helper('statement', @_); }
359sub do_cmd_opindex{ my_typed_index_helper('operator', @_); }
360sub do_cmd_exindex{ my_typed_index_helper('exception', @_); }
361sub do_cmd_obindex{ my_typed_index_helper('object', @_); }
Fred Drake6659c301998-03-03 22:02:19 +0000362
363sub my_parword_index_helper{
Fred Drakec9a44381998-03-17 06:29:13 +0000364 local($word,$_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000365 my($str,$br_id) = next_argument_id();
366 swallow_newline();
Fred Drake42b31a51998-03-27 05:16:10 +0000367 make_index_entry($br_id, "$str ($word)") . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000368}
369
370
Fred Drake6659c301998-03-03 22:02:19 +0000371sub make_mod_index_entry{
Fred Drakec9a44381998-03-17 06:29:13 +0000372 my($br_id,$str,$define) = @_;
Fred Drake42b31a51998-03-27 05:16:10 +0000373 my($name,$aname,$ahref) = link_info($br_id);
Fred Drake42b31a51998-03-27 05:16:10 +0000374 # equivalent of add_index_entry() using $define instead of ''
375 $str = gen_index_id($str, $define);
376 $index{$str} .= $ahref;
Fred Drake166abba1998-04-08 23:10:54 +0000377 print IDXFILE $ahref, $IDXFILE_FIELD_SEP, $str, "\n";
Fred Drake42b31a51998-03-27 05:16:10 +0000378
Fred Drakec9a44381998-03-17 06:29:13 +0000379 if ($define eq 'DEF') {
Fred Drake42b31a51998-03-27 05:16:10 +0000380 # add to the module index
Fred Drakec9a44381998-03-17 06:29:13 +0000381 my($nstr,$garbage) = split / /, $str, 2;
Fred Drake42b31a51998-03-27 05:16:10 +0000382 $Modules{$nstr} .= $ahref;
Fred Drake6659c301998-03-03 22:02:19 +0000383 }
Fred Drake42b31a51998-03-27 05:16:10 +0000384 "$aname$anchor_invisible_mark</a>";
Fred Drake6659c301998-03-03 22:02:19 +0000385}
386
Fred Drakec9a44381998-03-17 06:29:13 +0000387$THIS_MODULE = '';
Fred Drake42b31a51998-03-27 05:16:10 +0000388$THIS_CLASS = '';
Fred Drakec9a44381998-03-17 06:29:13 +0000389
Fred Drake6659c301998-03-03 22:02:19 +0000390sub my_module_index_helper{
391 local($word, $_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000392 my($str,$br_id) = next_argument_id();
393 swallow_newline();
Fred Drakec9a44381998-03-17 06:29:13 +0000394 my $section_tag = join('', @curr_sec_id);
Fred Drake6659c301998-03-03 22:02:19 +0000395 $word = "$word " if $word;
Fred Drakec9a44381998-03-17 06:29:13 +0000396 $THIS_MODULE = "$str";
Fred Drake42b31a51998-03-27 05:16:10 +0000397 make_mod_index_entry("SECTION$section_tag",
398 "<tt>$str</tt> (${word}module)", 'DEF') . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000399}
400
401sub ref_module_index_helper{
402 local($word, $_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000403 my($str,$br_id) = next_argument();
404 swallow_newline();
Fred Drake6659c301998-03-03 22:02:19 +0000405 $word = "$word " if $word;
Fred Drake42b31a51998-03-27 05:16:10 +0000406 make_mod_index_entry($br_id, "<tt>$str</tt> (${word}module)", 'REF') . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000407}
408
Fred Drakec9a44381998-03-17 06:29:13 +0000409sub do_cmd_bifuncindex{
410 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000411 my($str,$br_id) = next_argument();
412 swallow_newline();
413 my $fname = "<tt>$str()</tt>";
Fred Drake42b31a51998-03-27 05:16:10 +0000414 make_index_entry($br_id, "$fname (built-in function)") . $_;
Fred Drakec9a44381998-03-17 06:29:13 +0000415}
416
Fred Drake42b31a51998-03-27 05:16:10 +0000417sub do_cmd_modindex{ my_module_index_helper('', @_); }
418sub do_cmd_bimodindex{ my_module_index_helper('built-in', @_); }
419sub do_cmd_exmodindex{ my_module_index_helper('extension', @_); }
420sub do_cmd_stmodindex{ my_module_index_helper('standard', @_); }
Fred Drake6659c301998-03-03 22:02:19 +0000421
422# these should be adjusted a bit....
Fred Drake42b31a51998-03-27 05:16:10 +0000423sub do_cmd_refmodindex{ ref_module_index_helper('', @_); }
424sub do_cmd_refbimodindex{ ref_module_index_helper('built-in', @_); }
425sub do_cmd_refexmodindex{ ref_module_index_helper('extension', @_); }
426sub do_cmd_refstmodindex{ ref_module_index_helper('standard', @_); }
Fred Drake6659c301998-03-03 22:02:19 +0000427
Fred Drake42b31a51998-03-27 05:16:10 +0000428sub do_cmd_nodename{ do_cmd_label(@_); }
Fred Drake6659c301998-03-03 22:02:19 +0000429
430sub init_myformat{
Fred Drake08932051998-04-17 02:15:42 +0000431# $anchor_invisible_mark = '';
Fred Drake6659c301998-03-03 22:02:19 +0000432 $anchor_mark = '';
433 $icons{'anchor_mark'} = '';
Fred Drake6659c301998-03-03 22:02:19 +0000434}
Fred Drake42b31a51998-03-27 05:16:10 +0000435init_myformat();
Fred Drake6659c301998-03-03 22:02:19 +0000436
437# similar to make_index_entry(), but includes the string in the result
438# instead of the dummy filler.
439#
440sub make_str_index_entry{
Fred Drakec9a44381998-03-17 06:29:13 +0000441 my($br_id,$str) = @_;
Fred Drake42b31a51998-03-27 05:16:10 +0000442 my($name,$aname,$ahref) = link_info($br_id);
Fred Drake42b31a51998-03-27 05:16:10 +0000443 add_index_entry($str, $ahref);
444 "$aname$str</a>";
Fred Drake6659c301998-03-03 22:02:19 +0000445}
446
Fred Drake6659c301998-03-03 22:02:19 +0000447sub do_env_cfuncdesc{
448 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000449 my $return_type = next_argument();
450 my($function_name,$br_id) = next_argument_id();
451 my $arg_list = next_argument();
452 my $idx = make_str_index_entry($br_id,
453 "<tt>$function_name()</tt>" . get_indexsubitem());
454 $idx =~ s/ \(.*\)//;
455 $idx =~ s/\(\)//; # ????
Fred Drake6659c301998-03-03 22:02:19 +0000456 "<dl><dt>$return_type <b>$idx</b>"
Fred Drake08932051998-04-17 02:15:42 +0000457 . "(<var>$arg_list</var>)\n<dd>"
458 . $_
459 . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000460}
461
462sub do_env_ctypedesc{
463 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000464 my($type_name,$br_id) = next_argument_id();
465 my $idx = make_str_index_entry($br_id,
466 "<tt>$type_name</tt>" . get_indexsubitem());
467 $idx =~ s/ \(.*\)//;
468 "<dl><dt><b>$idx</b>\n<dd>"
469 . $_
470 . '</dl>'
Fred Drake6659c301998-03-03 22:02:19 +0000471}
472
473sub do_env_cvardesc{
474 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000475 my $var_type = next_argument();
476 my($var_name,$br_id) = next_argument_id();
477 my $idx = make_str_index_entry($br_id,
478 "<tt>$var_name</tt>" . get_indexsubitem());
479 $idx =~ s/ \(.*\)//;
Fred Drake6659c301998-03-03 22:02:19 +0000480 "<dl><dt>$var_type <b>$idx</b>\n"
Fred Drake08932051998-04-17 02:15:42 +0000481 . '<dd>'
482 . $_
483 . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000484}
485
486sub do_env_funcdesc{
487 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000488 my $function_name = next_argument();
489 my($arg_list,$br_id) = next_argument_id();
490 my $idx = make_str_index_entry($br_id, "<tt>$function_name()</tt>"
491 . get_indexsubitem());
492 $idx =~ s/ \(.*\)//;
493 $idx =~ s/\(\)//;
494 "<dl><dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_ . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000495}
496
497sub do_env_funcdescni{
498 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000499 my $function_name = next_argument();
500 my $arg_list = next_argument();
501 "<dl><dt><b><tt>$function_name</tt></b> (<var>$arg_list</var>)\n<dd>"
502 . $_ . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000503}
504
505sub do_cmd_funcline{
506 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000507 my $function_name = next_argument();
508 my($arg_list,$br_id) = next_argument_id();
Fred Drake42b31a51998-03-27 05:16:10 +0000509 my $idx = make_str_index_entry($br_id, "<tt>$function_name()</tt>"
Fred Drake08932051998-04-17 02:15:42 +0000510 . get_indexsubitem());
Fred Drakec9a44381998-03-17 06:29:13 +0000511 $idx =~ s/\(\)//;
Fred Drake6659c301998-03-03 22:02:19 +0000512 "<dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_;
513}
514
515# Change this flag to index the opcode entries. I don't think it's very
516# useful to index them, since they're only presented to describe the dis
517# module.
518#
519$INDEX_OPCODES = 0;
520
521sub do_env_opcodedesc{
522 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000523 my $opcode_name = next_argument();
524 my($arg_list,$br_id) = next_argument_id();
525 my $idx;
526 if ($INDEX_OPCODES) {
527 $idx = make_str_index_entry($br_id,
Fred Drake6659c301998-03-03 22:02:19 +0000528 "<tt>$opcode_name</tt> (byte code instruction)");
Fred Drake08932051998-04-17 02:15:42 +0000529 $idx =~ s/ \(byte code instruction\)//;
530 }
531 else {
532 $idx = "<tt>$opcode_name</tt>";
533 }
534 my $stuff = "<dl><dt><b>$idx</b>";
Fred Drake6659c301998-03-03 22:02:19 +0000535 if ($arg_list) {
536 $stuff .= "&nbsp;&nbsp;&nbsp;&nbsp;<var>$arg_list</var>";
537 }
Fred Drake08932051998-04-17 02:15:42 +0000538 $stuff . "\n<dd>" . $_ . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000539}
540
541sub do_env_datadesc{
542 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000543 my($dataname,$br_id) = next_argument_id();
544 my $idx = make_str_index_entry($br_id,
545 "<tt>$dataname</tt>" . get_indexsubitem());
546 $idx =~ s/ \(.*\)//;
547 "<dl><dt><b>$idx</b>\n<dd>"
548 . $_
549 . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000550}
551
552sub do_env_datadescni{
553 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000554 my $idx = next_argument();
555 if (! $STRING_INDEX_TT) {
556 $idx = "<tt>$idx</tt>";
Fred Drake6659c301998-03-03 22:02:19 +0000557 }
Fred Drake08932051998-04-17 02:15:42 +0000558 "<dl><dt><b>$idx</b>\n<dd>" . $_ . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000559}
560
561sub do_cmd_dataline{
562 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000563 my($data_name,$br_id) = next_argument_id();
Fred Drake42b31a51998-03-27 05:16:10 +0000564 my $idx = make_str_index_entry($br_id, "<tt>$data_name</tt>"
Fred Drake08932051998-04-17 02:15:42 +0000565 . get_indexsubitem());
Fred Drake6659c301998-03-03 22:02:19 +0000566 $idx =~ s/ \(.*\)//;
Fred Drake42b31a51998-03-27 05:16:10 +0000567 "<dt><b>$idx</b><dd>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000568}
569
Fred Drake42b31a51998-03-27 05:16:10 +0000570sub do_env_excdesc{
571 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000572 my($excname,$br_id) = next_argument_id();
Fred Drake166abba1998-04-08 23:10:54 +0000573 my $idx = make_str_index_entry($br_id, "<tt>$excname</tt>");
Fred Drake08932051998-04-17 02:15:42 +0000574 "<dl><dt><b>$idx</b>\n<dd>" . $_ . '</dl>'
Fred Drake42b31a51998-03-27 05:16:10 +0000575}
576
577sub do_env_fulllineitems{ do_env_itemize(@_); }
Fred Drake6659c301998-03-03 22:02:19 +0000578
579
Fred Drakec9a44381998-03-17 06:29:13 +0000580sub do_env_classdesc{
581 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000582 $THIS_CLASS = next_argument();
583 my($arg_list,$br_id) = next_argument_id();
584 $idx = make_str_index_entry($br_id,
585 "<tt>$THIS_CLASS</tt> (class in $THIS_MODULE)" );
586 $idx =~ s/ \(.*\)//;
587 "<dl><dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_ . '</dl>';
Fred Drakec9a44381998-03-17 06:29:13 +0000588}
589
Fred Drake42b31a51998-03-27 05:16:10 +0000590
591sub do_env_methoddesc{
592 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000593 my $class_name = next_optional_argument();
594 $class_name = $THIS_CLASS
595 unless $class_name;
596 my($method_name,$br_id) = next_argument_id();
597 my $arg_list = next_argument();
598 my $extra = '';
599 if ($class_name) {
600 $extra = " ($class_name method)";
Fred Drake42b31a51998-03-27 05:16:10 +0000601 }
Fred Drake08932051998-04-17 02:15:42 +0000602 my $idx = make_str_index_entry($br_id, "<tt>$method_name()</tt>$extra");
603 $idx =~ s/ \(.*\)//;
604 $idx =~ s/\(\)//;
605 "<dl><dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_ . '</dl>';
Fred Drake42b31a51998-03-27 05:16:10 +0000606}
607
608
609sub do_env_methoddescni{
610 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000611 next_optional_argument();
612 my $method = next_argument();
613 my $arg_list = next_argument();
614 "<dl><dt><b>$method</b> (<var>$arg_list</var>)\n<dd>" . $_ . '</dl>';
Fred Drake42b31a51998-03-27 05:16:10 +0000615}
616
617
618sub do_env_memberdesc{
619 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000620 my $class = next_optional_argument();
621 my($member,$br_id) = next_argument();
Fred Drake42b31a51998-03-27 05:16:10 +0000622 $class = $THIS_CLASS
623 unless $class;
Fred Drake08932051998-04-17 02:15:42 +0000624 my $extra = '';
Fred Drake42b31a51998-03-27 05:16:10 +0000625 $extra = " ($class_name attribute)"
Fred Drakea608feb1998-04-12 03:58:13 +0000626 if (!($class eq ''));
Fred Drake08932051998-04-17 02:15:42 +0000627 my $idx = make_str_index_entry($br_id, "<tt>$member</tt>$extra");
Fred Drake42b31a51998-03-27 05:16:10 +0000628 $idx =~ s/ \(.*\)//;
629 $idx =~ s/\(\)//;
Fred Drake08932051998-04-17 02:15:42 +0000630 "<dl><dt><b>$idx</b>\n<dd>" . $_ . '</dl>';
Fred Drake42b31a51998-03-27 05:16:10 +0000631}
632
633
Fred Drake5ccf3301998-04-17 20:04:09 +0000634sub do_cmd_memberline{
635 local($_) = @_;
636 my $class = next_optional_argument();
637 my($member,$br_id) = next_argument_id();
638 $class = $THIS_CLASS
639 unless $class;
640 my $extra = '';
641 $extra = " ($class_name attribute)"
642 if (!($class eq ''));
643 my $idx = make_str_index_entry($br_id, "<tt>$member</tt>$extra");
644 $idx =~ s/ \(.*\)//;
645 $idx =~ s/\(\)//;
646 "<dt><b>$idx</b><dd>" . $_;
647}
648
Fred Drake42b31a51998-03-27 05:16:10 +0000649sub do_env_memberdescni{
650 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000651 next_optional_argument();
652 my $member = next_argument();
653 "<dl><dt><b>$member</b>\n<dd>" . $_ . '</dl>';
Fred Drake42b31a51998-03-27 05:16:10 +0000654}
655
656
Fred Drake5ccf3301998-04-17 20:04:09 +0000657sub do_cmd_memberlineni{
658 local($_) = @_;
659 next_optional_argument();
660 my $member = next_argument();
661 "<dt><b>$member</b><dd>" . $_;
662}
663
Fred Drake6659c301998-03-03 22:02:19 +0000664@col_aligns = ("<td>", "<td>", "<td>");
665
666sub setup_column_alignments{
667 local($_) = @_;
Fred Drakeee601911998-04-11 20:53:03 +0000668 my($a1,$a2,$a3) = split(/[|]/,$_);
Fred Drakec9a44381998-03-17 06:29:13 +0000669 my($th1,$th2,$th3) = ('<th>', '<th>', '<th>');
Fred Drake08932051998-04-17 02:15:42 +0000670 $col_aligns[0] = (($a1 eq 'c') ? '<td align=center>' : '<td>');
671 $col_aligns[1] = (($a2 eq 'c') ? '<td align=center>' : '<td>');
672 $col_aligns[2] = (($a3 eq 'c') ? '<td align=center>' : '<td>');
Fred Drake6659c301998-03-03 22:02:19 +0000673 # return the aligned header start tags; only used for \begin{tableiii?}
Fred Drake08932051998-04-17 02:15:42 +0000674 $th1 = (($a1 eq 'l') ? '<th align=left>'
675 : ($a1 eq 'r' ? '<th align=right>' : '<th>'));
676 $th2 = (($a2 eq 'l') ? '<th align=left>'
677 : ($a2 eq 'r' ? '<th align=right>' : '<th>'));
678 $th3 = (($a3 eq 'l') ? '<th align=left>'
679 : ($a3 eq 'r' ? '<th align=right>' : '<th>'));
Fred Drake6659c301998-03-03 22:02:19 +0000680 ($th1, $th2, $th3);
681}
682
683sub do_env_tableii{
684 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000685 my($th1,$th2,$th3) = setup_column_alignments(next_argument());
686 my $font = next_argument();
687 my $h1 = next_argument();
688 my $h2 = next_argument();
689 $font = ''
690 if ($font eq 'textrm');
691 $globals{'lineifont'} = $font;
692 '<table border align=center>'
Fred Drake6659c301998-03-03 22:02:19 +0000693 . "\n <tr>$th1<b>$h1</b></th>"
Fred Drake08932051998-04-17 02:15:42 +0000694 . "\n $th2<b>$h2</b></th>"
695 . $_
Fred Drake6659c301998-03-03 22:02:19 +0000696 . "\n</table>";
697}
698
699sub do_cmd_lineii{
700 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000701 my $c1 = next_argument();
702 my $c2 = next_argument();
703 my($font,$sfont,$efont) = ($globals{'lineifont'}, '', '');
Fred Drake58b2bfd1998-04-02 20:14:04 +0000704 if ($font) {
Fred Drake5cca42e1998-04-09 17:59:11 +0000705 $sfont = "<$font>";
Fred Drake58b2bfd1998-04-02 20:14:04 +0000706 $efont = "</$font>";
707 }
Fred Drakec9a44381998-03-17 06:29:13 +0000708 my($c1align,$c2align) = @col_aligns[0,1];
Fred Drake5cca42e1998-04-09 17:59:11 +0000709 "<tr>$c1align$sfont$c1$efont</td>\n"
Fred Drake08932051998-04-17 02:15:42 +0000710 . " $c2align$c2</td>"
711 . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000712}
713
714sub do_env_tableiii{
715 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000716 my($th1,$th2,$th3) = setup_column_alignments(next_argument());
717 my $font = next_argument();
718 my $h1 = next_argument();
719 my $h2 = next_argument();
720 my $h3 = next_argument();
721 $font = ''
722 if ($font eq 'textrm');
723 $globals{'lineifont'} = $font;
724 '<table border align=center>'
Fred Drake6659c301998-03-03 22:02:19 +0000725 . "\n <tr>$th1<b>$h1</b></th>"
726 . "\n $th2<b>$h2</b></th>"
Fred Drake08932051998-04-17 02:15:42 +0000727 . "\n $th3<b>$h3</b></th>"
728 . $_
Fred Drake6659c301998-03-03 22:02:19 +0000729 . "\n</table>";
730}
731
732sub do_cmd_lineiii{
733 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000734 my $c1 = next_argument();
735 my $c2 = next_argument();
736 my $c3 = next_argument();
737 my($font,$sfont,$efont) = ($globals{'lineifont'}, '', '');
Fred Drake58b2bfd1998-04-02 20:14:04 +0000738 if ($font) {
Fred Drake5cca42e1998-04-09 17:59:11 +0000739 $sfont = "<$font>";
Fred Drake58b2bfd1998-04-02 20:14:04 +0000740 $efont = "</$font>";
741 }
Fred Drake08932051998-04-17 02:15:42 +0000742 my($c1align,$c2align,$c3align) = @col_aligns;
Fred Drake5cca42e1998-04-09 17:59:11 +0000743 "<tr>$c1align$sfont$c1$efont</td>\n"
Fred Drake6659c301998-03-03 22:02:19 +0000744 . " $c2align$c2</td>\n"
Fred Drake08932051998-04-17 02:15:42 +0000745 . " $c3align$c3</td>"
746 . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000747}
748
749sub do_env_seealso{
750 "<p><b>See Also:</b></p>\n" . @_[0];
751}
752
753sub do_cmd_seemodule{
754 # Insert the right magic to jump to the module definition. This should
755 # work most of the time, at least for repeat builds....
756 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000757 my $key = next_optional_argument();
758 my $module = next_argument();
759 my $text = next_argument();
760 $key = $module
761 unless $key;
Fred Drakeb3c9bca1998-03-06 21:20:08 +0000762 "<p>Module <tt><b><a href=\"module-$key.html\">$module</a></b></tt>"
Fred Drake6659c301998-03-03 22:02:19 +0000763 . "&nbsp;&nbsp;&nbsp;($text)</p>"
764 . $_;
765}
766
767sub do_cmd_seetext{
Fred Drake08932051998-04-17 02:15:42 +0000768 '<p>' . @_[0];
Fred Drake6659c301998-03-03 22:02:19 +0000769}
770
771
772sub do_cmd_maketitle {
773 local($_) = @_;
Fred Drakec9a44381998-03-17 06:29:13 +0000774 my $the_title = '';
Fred Drake6659c301998-03-03 22:02:19 +0000775 if ($t_title) {
Fred Drakec9a44381998-03-17 06:29:13 +0000776 $the_title .= "<h1 align=center>$t_title</h1>";
Fred Drake08932051998-04-17 02:15:42 +0000777 } else { write_warnings("\nThis document has no title."); }
Fred Drakec9a44381998-03-17 06:29:13 +0000778 $the_title .= "\n<center>";
Fred Drake6659c301998-03-03 22:02:19 +0000779 if ($t_author) {
780 if ($t_authorURL) {
Fred Drake08932051998-04-17 02:15:42 +0000781 my $href = translate_commands($t_authorURL);
782 $href = make_named_href('author', $href, "<strong>${t_author}</strong>");
Fred Drakec9a44381998-03-17 06:29:13 +0000783 $the_title .= "\n<p>$href</p>";
Fred Drake6659c301998-03-03 22:02:19 +0000784 } else {
Fred Drakec9a44381998-03-17 06:29:13 +0000785 $the_title .= "\n<p><strong>$t_author</strong></p>";
Fred Drake6659c301998-03-03 22:02:19 +0000786 }
Fred Drake08932051998-04-17 02:15:42 +0000787 } else { write_warnings("\nThere is no author for this document."); }
Fred Drake6659c301998-03-03 22:02:19 +0000788 if ($t_institute) {
Fred Drakec9a44381998-03-17 06:29:13 +0000789 $the_title .= "\n<p>$t_institute</p>";}
Fred Draked07868a1998-05-14 21:00:28 +0000790 if ($DEVELOPER_ADDRESS) {
791 $the_title .= "\n<p>$DEVELOPER_ADDRESS</p>";}
Fred Drake6659c301998-03-03 22:02:19 +0000792 if ($t_affil) {
Fred Drakec9a44381998-03-17 06:29:13 +0000793 $the_title .= "\n<p><i>$t_affil</i></p>";}
Fred Drake6659c301998-03-03 22:02:19 +0000794 if ($t_date) {
Fred Drakec9a44381998-03-17 06:29:13 +0000795 $the_title .= "\n<p><strong>$t_date</strong>";
Fred Drake6659c301998-03-03 22:02:19 +0000796 if ($PYTHON_VERSION) {
797 $the_title .= "<br><strong>Release $PYTHON_VERSION</strong>";}
798 $the_title .= "</p>"
799 }
Fred Drakec9a44381998-03-17 06:29:13 +0000800 $the_title .= "\n</center>";
Fred Drake6659c301998-03-03 22:02:19 +0000801 if ($t_address) {
Fred Drakec9a44381998-03-17 06:29:13 +0000802 $the_title .= "\n<p>$t_address</p>";
803 } else { $the_title .= "\n<p>"}
Fred Drake6659c301998-03-03 22:02:19 +0000804 if ($t_email) {
Fred Drakec9a44381998-03-17 06:29:13 +0000805 $the_title .= "\n<p>$t_email</p>";
806 }# else { $the_title .= "</p>" }
807 $the_title . "<hr>\n" . $_ ;
Fred Drake6659c301998-03-03 22:02:19 +0000808}
809
810
Fred Drake6659c301998-03-03 22:02:19 +00008111; # This must be the last line