blob: 4c9d86d8600bbc697f2a9e2b809f347e620116bf [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
71$AUTHOR_ADDRESS = '';
72$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 Drake08932051998-04-17 02:15:42 +000083 $AUTHOR_ADDRESS = next_argument();
Fred Drake6659c301998-03-03 22:02:19 +000084 $_;
85}
86
87sub do_cmd_hackscore{
88 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +000089 next_argument();
90 '_' . $_;
Fred Drake6659c301998-03-03 22:02:19 +000091}
92
Fred Drake08932051998-04-17 02:15:42 +000093sub use_wrappers{
94 local($_,$before,$after) = @_;
95 my $stuff = next_argument();
96 $before . $stuff . $after . $_;
97}
98
99sub use_current{ use_wrappers(@_[0], '', ''); }
100sub use_sans_serif{ use_wrappers(@_[0], '<font face=sans-serif>', '</font>'); }
101sub use_italics{ use_wrappers(@_[0], '<i>', '</i>'); }
102
Fred Drake6659c301998-03-03 22:02:19 +0000103sub do_cmd_optional{
Fred Drake08932051998-04-17 02:15:42 +0000104 use_wrappers(@_[0], "</var><big>\[</big><var>",
105 "</var><big>\]</big><var>");
Fred Drake6659c301998-03-03 22:02:19 +0000106}
107
Fred Drakec9a44381998-03-17 06:29:13 +0000108# Logical formatting (some based on texinfo), needs to be converted to
109# minimalist HTML. The "minimalist" is primarily to reduce the size of
110# output files for users that read them over the network rather than
111# from local repositories.
Fred Drake6659c301998-03-03 22:02:19 +0000112
Fred Drake08932051998-04-17 02:15:42 +0000113sub do_cmd_pytype{ use_current(@_); }
114sub do_cmd_makevar{ use_current(@_); }
115sub do_cmd_code{ use_wrappers(@_[0], '<tt>', '</tt>'); }
116sub do_cmd_module{ do_cmd_code(@_); }
117sub do_cmd_keyword{ do_cmd_code(@_); }
118sub do_cmd_exception{ do_cmd_code(@_); }
119sub do_cmd_class{ do_cmd_code(@_); }
120sub do_cmd_function{ do_cmd_code(@_); }
121sub do_cmd_constant{ do_cmd_code(@_); }
122sub do_cmd_member{ do_cmd_code(@_); }
123sub do_cmd_method{ do_cmd_code(@_); }
124sub do_cmd_cfunction{ do_cmd_code(@_); }
125sub do_cmd_cdata{ do_cmd_code(@_); }
126sub do_cmd_ctype{ do_cmd_code(@_); }
127sub do_cmd_regexp{ do_cmd_code(@_); }
Fred Drake08932051998-04-17 02:15:42 +0000128sub do_cmd_character{ do_cmd_samp(@_); }
129sub do_cmd_program{ do_cmd_strong(@_); }
130sub do_cmd_email{ use_sans_serif(@_); }
131sub do_cmd_mimetype{ use_sans_serif(@_); }
132sub do_cmd_var{ use_italics(@_); }
133sub do_cmd_dfn{ use_italics(@_); } # make an index entry?
134sub do_cmd_emph{ use_italics(@_); }
135sub do_cmd_file{ use_wrappers(@_[0], '"<tt>', '</tt>"'); }
136sub do_cmd_samp{ use_wrappers(@_[0], '"<tt>', '</tt>"'); }
137sub do_cmd_kbd{ use_wrappers(@_[0], '<kbd>', '</kbd>'); }
138sub do_cmd_strong{ use_wrappers(@_[0], '<b>', '</b>'); }
Fred Drakec9a44381998-03-17 06:29:13 +0000139
Fred Drake1a7af391998-04-01 22:44:56 +0000140sub do_cmd_newsgroup{
141 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000142 my $newsgroup = next_argument();
Fred Drake1a7af391998-04-01 22:44:56 +0000143 my $stuff = "<a href=\"news:$newsgroup\"><font face=sans-serif>"
144 . "$newsgroup</font></a>";
145 $stuff . $_;
146}
Fred Drakefc16e781998-03-12 21:03:26 +0000147
148sub do_cmd_envvar{
149 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000150 my($envvar,$br_id) = next_argument_id();
Fred Drake42b31a51998-03-27 05:16:10 +0000151 my($name,$aname,$ahref) = link_info($br_id);
Fred Drake166abba1998-04-08 23:10:54 +0000152 # The <tt> here is really to keep buildindex.py from making
153 # the variable name case-insensitive.
154 add_index_entry("environment variables!$envvar@<tt>\$$envvar</tt>",
155 $ahref);
Fred Drake42b31a51998-03-27 05:16:10 +0000156 add_index_entry("$envvar@\$$envvar", $ahref);
157 "$aname\$$envvar</a>" . $_;
Fred Drakefc16e781998-03-12 21:03:26 +0000158}
159
Fred Drake08932051998-04-17 02:15:42 +0000160
Fred Drake6659c301998-03-03 22:02:19 +0000161sub do_cmd_url{
162 # use the URL as both text and hyperlink
163 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000164 my $url = next_argument();
Fred Drake6659c301998-03-03 22:02:19 +0000165 $url =~ s/~/&#126;/g;
Fred Drakec9a44381998-03-17 06:29:13 +0000166 "<a href=\"$url\"><font face=sans-serif>$url</font></a>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000167}
168
169sub do_cmd_manpage{
170 # two parameters: \manpage{name}{section}
171 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000172 my $page = next_argument();
173 my $section = next_argument();
174 "<i>$page</i>($section)" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000175}
176
177sub do_cmd_rfc{
178 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000179 my($rfcnumber,$br_id) = next_argument();
Fred Drake6659c301998-03-03 22:02:19 +0000180
181 # Save the reference
Fred Drake08932051998-04-17 02:15:42 +0000182 my $nstr = gen_index_id("RFC!RFC $rfcnumber", '');
183 $index{$nstr} .= make_half_href("$CURRENT_FILE#$br_id");
Fred Drakec9a44381998-03-17 06:29:13 +0000184 "<a name=$br_id>RFC $rfcnumber</a>" .$_;
Fred Drake6659c301998-03-03 22:02:19 +0000185}
186
Fred Drake6659c301998-03-03 22:02:19 +0000187sub do_cmd_deprecated{
188 # two parameters: \deprecated{version}{whattodo}
189 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000190 my $release = next_argument();
191 my $reason = next_argument();
192 "<b>Deprecated since release $release.</b>\n$reason<p>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000193}
194
195# file and samp are at the end of this file since they screw up fontlock.
196
197# index commands
198
199$INDEX_SUBITEM = "";
200
201sub get_indexsubitem{
Fred Drakefc16e781998-03-12 21:03:26 +0000202 #$INDEX_SUBITEM ? " $INDEX_SUBITEM" : '';
203 '';
Fred Drake6659c301998-03-03 22:02:19 +0000204}
205
206sub do_cmd_setindexsubitem{
207 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000208 $INDEX_SUBITEM = next_argument();
Fred Drake6659c301998-03-03 22:02:19 +0000209 $_;
210}
211
Fred Drakefc16e781998-03-12 21:03:26 +0000212sub do_cmd_withsubitem{
213 # We can't really do the right right thing, because LaTeX2HTML doesn't
214 # do things in the right order, but we need to at least strip this stuff
215 # out, and leave anything that the second argument expanded out to.
216 #
217 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000218 next_argument();
219 my $stuff = next_argument();
220 $stuff . $_;
Fred Drakefc16e781998-03-12 21:03:26 +0000221}
222
Fred Drake08932051998-04-17 02:15:42 +0000223# This is the prologue macro which is required to start writing the
224# mod\jobname.idx file; we can just ignore it.
225#
Fred Drakefc16e781998-03-12 21:03:26 +0000226sub do_cmd_makemodindex{ @_[0]; }
227
Fred Drake42b31a51998-03-27 05:16:10 +0000228# We're in the document subdirectory when this happens!
Fred Drake166abba1998-04-08 23:10:54 +0000229#
Fred Drake08932051998-04-17 02:15:42 +0000230open(IDXFILE, '>index.dat') || die "\n$!\n";
231open(INTLABELS, '>intlabels.pl') || die "\n$!\n";
Fred Drake166abba1998-04-08 23:10:54 +0000232print INTLABELS "%internal_labels = ();\n";
233print INTLABELS "1; # hack in case there are no entries\n\n";
234
235# Using \0 for this is bad because we can't use common tools to work with the
236# resulting files. Things like grep can be useful with this stuff!
237#
238$IDXFILE_FIELD_SEP = "\1";
239
Fred Drake42b31a51998-03-27 05:16:10 +0000240
241sub gen_target_name{
242 "l2h-" . @_[0];
243}
244
245sub gen_target{
Fred Drake08932051998-04-17 02:15:42 +0000246 '<a name="' . @_[0] . '">';
Fred Drake42b31a51998-03-27 05:16:10 +0000247}
248
249sub gen_link{
250 my($node,$target) = @_;
251 print INTLABELS "\$internal_labels{\"$target\"} = \"$URL/$node\";\n";
252 "<a href=\"$node#$target\">";
253}
254
255sub make_index_entry{
256 my($br_id,$str) = @_;
257 my($name,$aname,$ahref) = link_info($br_id);
258 add_index_entry($str, $ahref);
259 "$aname$anchor_invisible_mark</a>";
260}
261
262sub add_index_entry{
263 # add an entry to the index structures; ignore the return value
264 my($str,$ahref) = @_;
265 $str = gen_index_id($str, '');
266 $index{$str} .= $ahref;
Fred Drake166abba1998-04-08 23:10:54 +0000267 print IDXFILE $ahref, $IDXFILE_FIELD_SEP, $str, "\n";
Fred Drake42b31a51998-03-27 05:16:10 +0000268}
269
270sub link_info{
271 my $name = gen_target_name(@_[0]);
272 my $aname = gen_target($name);
273 my $ahref = gen_link($CURRENT_FILE, $name);
274 return ($name, $aname, $ahref);
275}
276
277sub do_cmd_index{
278 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000279 my($str,$br_id) = next_argument_id();
280 swallow_newline();
Fred Drake42b31a51998-03-27 05:16:10 +0000281 #
282 my($name,$aname,$ahref) = link_info($br_id);
283 add_index_entry("$str", $ahref);
284 "$aname$anchor_invisible_mark</a>" . $_;
285}
286
Fred Drake6659c301998-03-03 22:02:19 +0000287sub do_cmd_indexii{
288 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000289 my($str1,$br_id) = next_argument_id();
290 my $str2 = next_argument();
Fred Drake42b31a51998-03-27 05:16:10 +0000291 #
Fred Drake08932051998-04-17 02:15:42 +0000292 my($name,$aname,$ahref) = link_info($br_id);
Fred Drake42b31a51998-03-27 05:16:10 +0000293 add_index_entry("$str1!$str2", $ahref);
294 add_index_entry("$str2!$str1", $ahref);
295 "$aname$anchor_invisible_mark</a>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000296}
297
298sub do_cmd_indexiii{
299 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000300 my($str1,$br_id) = next_argument();
301 my $str2 = next_argument();
302 my $str3 = next_argument();
Fred Drake42b31a51998-03-27 05:16:10 +0000303 #
Fred Drake08932051998-04-17 02:15:42 +0000304 my($name,$aname,$ahref) = link_info($br_id);
Fred Drake42b31a51998-03-27 05:16:10 +0000305 add_index_entry("$str1!$str2 $str3", $ahref);
306 add_index_entry("$str2!$str3, $str1", $ahref);
307 add_index_entry("$str3!$str1 $str2", $ahref);
308 "$aname$anchor_invisible_mark</a>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000309}
310
311sub do_cmd_indexiv{
312 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000313 my($str1,$br_id) = next_argument();
314 my $str2 = next_argument();
315 my $str3 = next_argument();
316 my $str4 = 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 $str4", $ahref);
320 add_index_entry("$str2!$str3 $str4, $str1", $ahref);
321 add_index_entry("$str3!$str4, $str1 $str2", $ahref);
322 add_index_entry("$str4!$$str1 $str2 $str3", $ahref);
323 "$aname$anchor_invisible_mark</a>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000324}
325
Fred Drakec9a44381998-03-17 06:29:13 +0000326sub do_cmd_ttindex{
327 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000328 my($str,$br_id) = next_argument_id();
329 swallow_newline();
330 make_index_entry($br_id, $str . get_indexsubitem()) . $_;
Fred Drakec9a44381998-03-17 06:29:13 +0000331}
Fred Drake6659c301998-03-03 22:02:19 +0000332
333sub my_typed_index_helper{
Fred Drakec9a44381998-03-17 06:29:13 +0000334 local($word,$_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000335 my($str,$br_id) = next_argument();
336 swallow_newline();
Fred Drake42b31a51998-03-27 05:16:10 +0000337 #
338 my($name,$aname,$ahref) = link_info($br_id1);
339 add_index_entry("$str $word", $ahref);
340 add_index_entry("$word!$str", $ahref);
341 "$aname$anchor_invisible_mark</a>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000342}
343
Fred Drake08932051998-04-17 02:15:42 +0000344sub do_cmd_stindex{ my_typed_index_helper('statement', @_); }
345sub do_cmd_opindex{ my_typed_index_helper('operator', @_); }
346sub do_cmd_exindex{ my_typed_index_helper('exception', @_); }
347sub do_cmd_obindex{ my_typed_index_helper('object', @_); }
Fred Drake6659c301998-03-03 22:02:19 +0000348
349sub my_parword_index_helper{
Fred Drakec9a44381998-03-17 06:29:13 +0000350 local($word,$_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000351 my($str,$br_id) = next_argument_id();
352 swallow_newline();
Fred Drake42b31a51998-03-27 05:16:10 +0000353 make_index_entry($br_id, "$str ($word)") . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000354}
355
356
Fred Drake6659c301998-03-03 22:02:19 +0000357sub make_mod_index_entry{
Fred Drakec9a44381998-03-17 06:29:13 +0000358 my($br_id,$str,$define) = @_;
Fred Drake42b31a51998-03-27 05:16:10 +0000359 my($name,$aname,$ahref) = link_info($br_id);
Fred Drake42b31a51998-03-27 05:16:10 +0000360 # equivalent of add_index_entry() using $define instead of ''
361 $str = gen_index_id($str, $define);
362 $index{$str} .= $ahref;
Fred Drake166abba1998-04-08 23:10:54 +0000363 print IDXFILE $ahref, $IDXFILE_FIELD_SEP, $str, "\n";
Fred Drake42b31a51998-03-27 05:16:10 +0000364
Fred Drakec9a44381998-03-17 06:29:13 +0000365 if ($define eq 'DEF') {
Fred Drake42b31a51998-03-27 05:16:10 +0000366 # add to the module index
Fred Drakec9a44381998-03-17 06:29:13 +0000367 my($nstr,$garbage) = split / /, $str, 2;
Fred Drake42b31a51998-03-27 05:16:10 +0000368 $Modules{$nstr} .= $ahref;
Fred Drake6659c301998-03-03 22:02:19 +0000369 }
Fred Drake42b31a51998-03-27 05:16:10 +0000370 "$aname$anchor_invisible_mark</a>";
Fred Drake6659c301998-03-03 22:02:19 +0000371}
372
Fred Drakec9a44381998-03-17 06:29:13 +0000373$THIS_MODULE = '';
Fred Drake42b31a51998-03-27 05:16:10 +0000374$THIS_CLASS = '';
Fred Drakec9a44381998-03-17 06:29:13 +0000375
Fred Drake6659c301998-03-03 22:02:19 +0000376sub my_module_index_helper{
377 local($word, $_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000378 my($str,$br_id) = next_argument_id();
379 swallow_newline();
Fred Drakec9a44381998-03-17 06:29:13 +0000380 my $section_tag = join('', @curr_sec_id);
Fred Drake6659c301998-03-03 22:02:19 +0000381 $word = "$word " if $word;
Fred Drakec9a44381998-03-17 06:29:13 +0000382 $THIS_MODULE = "$str";
Fred Drake42b31a51998-03-27 05:16:10 +0000383 make_mod_index_entry("SECTION$section_tag",
384 "<tt>$str</tt> (${word}module)", 'DEF') . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000385}
386
387sub ref_module_index_helper{
388 local($word, $_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000389 my($str,$br_id) = next_argument();
390 swallow_newline();
Fred Drake6659c301998-03-03 22:02:19 +0000391 $word = "$word " if $word;
Fred Drake42b31a51998-03-27 05:16:10 +0000392 make_mod_index_entry($br_id, "<tt>$str</tt> (${word}module)", 'REF') . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000393}
394
Fred Drakec9a44381998-03-17 06:29:13 +0000395sub do_cmd_bifuncindex{
396 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000397 my($str,$br_id) = next_argument();
398 swallow_newline();
399 my $fname = "<tt>$str()</tt>";
Fred Drake42b31a51998-03-27 05:16:10 +0000400 make_index_entry($br_id, "$fname (built-in function)") . $_;
Fred Drakec9a44381998-03-17 06:29:13 +0000401}
402
Fred Drake42b31a51998-03-27 05:16:10 +0000403sub do_cmd_modindex{ my_module_index_helper('', @_); }
404sub do_cmd_bimodindex{ my_module_index_helper('built-in', @_); }
405sub do_cmd_exmodindex{ my_module_index_helper('extension', @_); }
406sub do_cmd_stmodindex{ my_module_index_helper('standard', @_); }
Fred Drake6659c301998-03-03 22:02:19 +0000407
408# these should be adjusted a bit....
Fred Drake42b31a51998-03-27 05:16:10 +0000409sub do_cmd_refmodindex{ ref_module_index_helper('', @_); }
410sub do_cmd_refbimodindex{ ref_module_index_helper('built-in', @_); }
411sub do_cmd_refexmodindex{ ref_module_index_helper('extension', @_); }
412sub do_cmd_refstmodindex{ ref_module_index_helper('standard', @_); }
Fred Drake6659c301998-03-03 22:02:19 +0000413
Fred Drake42b31a51998-03-27 05:16:10 +0000414sub do_cmd_nodename{ do_cmd_label(@_); }
Fred Drake6659c301998-03-03 22:02:19 +0000415
416sub init_myformat{
Fred Drake08932051998-04-17 02:15:42 +0000417# $anchor_invisible_mark = '';
Fred Drake6659c301998-03-03 22:02:19 +0000418 $anchor_mark = '';
419 $icons{'anchor_mark'} = '';
Fred Drake6659c301998-03-03 22:02:19 +0000420}
Fred Drake42b31a51998-03-27 05:16:10 +0000421init_myformat();
Fred Drake6659c301998-03-03 22:02:19 +0000422
423# similar to make_index_entry(), but includes the string in the result
424# instead of the dummy filler.
425#
426sub make_str_index_entry{
Fred Drakec9a44381998-03-17 06:29:13 +0000427 my($br_id,$str) = @_;
Fred Drake42b31a51998-03-27 05:16:10 +0000428 my($name,$aname,$ahref) = link_info($br_id);
Fred Drake42b31a51998-03-27 05:16:10 +0000429 add_index_entry($str, $ahref);
430 "$aname$str</a>";
Fred Drake6659c301998-03-03 22:02:19 +0000431}
432
Fred Drake6659c301998-03-03 22:02:19 +0000433sub do_env_cfuncdesc{
434 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000435 my $return_type = next_argument();
436 my($function_name,$br_id) = next_argument_id();
437 my $arg_list = next_argument();
438 my $idx = make_str_index_entry($br_id,
439 "<tt>$function_name()</tt>" . get_indexsubitem());
440 $idx =~ s/ \(.*\)//;
441 $idx =~ s/\(\)//; # ????
Fred Drake6659c301998-03-03 22:02:19 +0000442 "<dl><dt>$return_type <b>$idx</b>"
Fred Drake08932051998-04-17 02:15:42 +0000443 . "(<var>$arg_list</var>)\n<dd>"
444 . $_
445 . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000446}
447
448sub do_env_ctypedesc{
449 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000450 my($type_name,$br_id) = next_argument_id();
451 my $idx = make_str_index_entry($br_id,
452 "<tt>$type_name</tt>" . get_indexsubitem());
453 $idx =~ s/ \(.*\)//;
454 "<dl><dt><b>$idx</b>\n<dd>"
455 . $_
456 . '</dl>'
Fred Drake6659c301998-03-03 22:02:19 +0000457}
458
459sub do_env_cvardesc{
460 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000461 my $var_type = next_argument();
462 my($var_name,$br_id) = next_argument_id();
463 my $idx = make_str_index_entry($br_id,
464 "<tt>$var_name</tt>" . get_indexsubitem());
465 $idx =~ s/ \(.*\)//;
Fred Drake6659c301998-03-03 22:02:19 +0000466 "<dl><dt>$var_type <b>$idx</b>\n"
Fred Drake08932051998-04-17 02:15:42 +0000467 . '<dd>'
468 . $_
469 . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000470}
471
472sub do_env_funcdesc{
473 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000474 my $function_name = next_argument();
475 my($arg_list,$br_id) = next_argument_id();
476 my $idx = make_str_index_entry($br_id, "<tt>$function_name()</tt>"
477 . get_indexsubitem());
478 $idx =~ s/ \(.*\)//;
479 $idx =~ s/\(\)//;
480 "<dl><dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_ . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000481}
482
483sub do_env_funcdescni{
484 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000485 my $function_name = next_argument();
486 my $arg_list = next_argument();
487 "<dl><dt><b><tt>$function_name</tt></b> (<var>$arg_list</var>)\n<dd>"
488 . $_ . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000489}
490
491sub do_cmd_funcline{
492 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000493 my $function_name = next_argument();
494 my($arg_list,$br_id) = next_argument_id();
Fred Drake42b31a51998-03-27 05:16:10 +0000495 my $idx = make_str_index_entry($br_id, "<tt>$function_name()</tt>"
Fred Drake08932051998-04-17 02:15:42 +0000496 . get_indexsubitem());
Fred Drakec9a44381998-03-17 06:29:13 +0000497 $idx =~ s/\(\)//;
Fred Drake6659c301998-03-03 22:02:19 +0000498 "<dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_;
499}
500
501# Change this flag to index the opcode entries. I don't think it's very
502# useful to index them, since they're only presented to describe the dis
503# module.
504#
505$INDEX_OPCODES = 0;
506
507sub do_env_opcodedesc{
508 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000509 my $opcode_name = next_argument();
510 my($arg_list,$br_id) = next_argument_id();
511 my $idx;
512 if ($INDEX_OPCODES) {
513 $idx = make_str_index_entry($br_id,
Fred Drake6659c301998-03-03 22:02:19 +0000514 "<tt>$opcode_name</tt> (byte code instruction)");
Fred Drake08932051998-04-17 02:15:42 +0000515 $idx =~ s/ \(byte code instruction\)//;
516 }
517 else {
518 $idx = "<tt>$opcode_name</tt>";
519 }
520 my $stuff = "<dl><dt><b>$idx</b>";
Fred Drake6659c301998-03-03 22:02:19 +0000521 if ($arg_list) {
522 $stuff .= "&nbsp;&nbsp;&nbsp;&nbsp;<var>$arg_list</var>";
523 }
Fred Drake08932051998-04-17 02:15:42 +0000524 $stuff . "\n<dd>" . $_ . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000525}
526
527sub do_env_datadesc{
528 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000529 my($dataname,$br_id) = next_argument_id();
530 my $idx = make_str_index_entry($br_id,
531 "<tt>$dataname</tt>" . get_indexsubitem());
532 $idx =~ s/ \(.*\)//;
533 "<dl><dt><b>$idx</b>\n<dd>"
534 . $_
535 . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000536}
537
538sub do_env_datadescni{
539 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000540 my $idx = next_argument();
541 if (! $STRING_INDEX_TT) {
542 $idx = "<tt>$idx</tt>";
Fred Drake6659c301998-03-03 22:02:19 +0000543 }
Fred Drake08932051998-04-17 02:15:42 +0000544 "<dl><dt><b>$idx</b>\n<dd>" . $_ . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000545}
546
547sub do_cmd_dataline{
548 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000549 my($data_name,$br_id) = next_argument_id();
Fred Drake42b31a51998-03-27 05:16:10 +0000550 my $idx = make_str_index_entry($br_id, "<tt>$data_name</tt>"
Fred Drake08932051998-04-17 02:15:42 +0000551 . get_indexsubitem());
Fred Drake6659c301998-03-03 22:02:19 +0000552 $idx =~ s/ \(.*\)//;
Fred Drake42b31a51998-03-27 05:16:10 +0000553 "<dt><b>$idx</b><dd>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000554}
555
Fred Drake42b31a51998-03-27 05:16:10 +0000556sub do_env_excdesc{
557 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000558 my($excname,$br_id) = next_argument_id();
Fred Drake166abba1998-04-08 23:10:54 +0000559 my $idx = make_str_index_entry($br_id, "<tt>$excname</tt>");
Fred Drake08932051998-04-17 02:15:42 +0000560 "<dl><dt><b>$idx</b>\n<dd>" . $_ . '</dl>'
Fred Drake42b31a51998-03-27 05:16:10 +0000561}
562
563sub do_env_fulllineitems{ do_env_itemize(@_); }
Fred Drake6659c301998-03-03 22:02:19 +0000564
565
Fred Drakec9a44381998-03-17 06:29:13 +0000566sub do_env_classdesc{
567 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000568 $THIS_CLASS = next_argument();
569 my($arg_list,$br_id) = next_argument_id();
570 $idx = make_str_index_entry($br_id,
571 "<tt>$THIS_CLASS</tt> (class in $THIS_MODULE)" );
572 $idx =~ s/ \(.*\)//;
573 "<dl><dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_ . '</dl>';
Fred Drakec9a44381998-03-17 06:29:13 +0000574}
575
Fred Drake42b31a51998-03-27 05:16:10 +0000576
577sub do_env_methoddesc{
578 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000579 my $class_name = next_optional_argument();
580 $class_name = $THIS_CLASS
581 unless $class_name;
582 my($method_name,$br_id) = next_argument_id();
583 my $arg_list = next_argument();
584 my $extra = '';
585 if ($class_name) {
586 $extra = " ($class_name method)";
Fred Drake42b31a51998-03-27 05:16:10 +0000587 }
Fred Drake08932051998-04-17 02:15:42 +0000588 my $idx = make_str_index_entry($br_id, "<tt>$method_name()</tt>$extra");
589 $idx =~ s/ \(.*\)//;
590 $idx =~ s/\(\)//;
591 "<dl><dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_ . '</dl>';
Fred Drake42b31a51998-03-27 05:16:10 +0000592}
593
594
595sub do_env_methoddescni{
596 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000597 next_optional_argument();
598 my $method = next_argument();
599 my $arg_list = next_argument();
600 "<dl><dt><b>$method</b> (<var>$arg_list</var>)\n<dd>" . $_ . '</dl>';
Fred Drake42b31a51998-03-27 05:16:10 +0000601}
602
603
604sub do_env_memberdesc{
605 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000606 my $class = next_optional_argument();
607 my($member,$br_id) = next_argument();
Fred Drake42b31a51998-03-27 05:16:10 +0000608 $class = $THIS_CLASS
609 unless $class;
Fred Drake08932051998-04-17 02:15:42 +0000610 my $extra = '';
Fred Drake42b31a51998-03-27 05:16:10 +0000611 $extra = " ($class_name attribute)"
Fred Drakea608feb1998-04-12 03:58:13 +0000612 if (!($class eq ''));
Fred Drake08932051998-04-17 02:15:42 +0000613 my $idx = make_str_index_entry($br_id, "<tt>$member</tt>$extra");
Fred Drake42b31a51998-03-27 05:16:10 +0000614 $idx =~ s/ \(.*\)//;
615 $idx =~ s/\(\)//;
Fred Drake08932051998-04-17 02:15:42 +0000616 "<dl><dt><b>$idx</b>\n<dd>" . $_ . '</dl>';
Fred Drake42b31a51998-03-27 05:16:10 +0000617}
618
619
Fred Drake5ccf3301998-04-17 20:04:09 +0000620sub do_cmd_memberline{
621 local($_) = @_;
622 my $class = next_optional_argument();
623 my($member,$br_id) = next_argument_id();
624 $class = $THIS_CLASS
625 unless $class;
626 my $extra = '';
627 $extra = " ($class_name attribute)"
628 if (!($class eq ''));
629 my $idx = make_str_index_entry($br_id, "<tt>$member</tt>$extra");
630 $idx =~ s/ \(.*\)//;
631 $idx =~ s/\(\)//;
632 "<dt><b>$idx</b><dd>" . $_;
633}
634
Fred Drake42b31a51998-03-27 05:16:10 +0000635sub do_env_memberdescni{
636 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000637 next_optional_argument();
638 my $member = next_argument();
639 "<dl><dt><b>$member</b>\n<dd>" . $_ . '</dl>';
Fred Drake42b31a51998-03-27 05:16:10 +0000640}
641
642
Fred Drake5ccf3301998-04-17 20:04:09 +0000643sub do_cmd_memberlineni{
644 local($_) = @_;
645 next_optional_argument();
646 my $member = next_argument();
647 "<dt><b>$member</b><dd>" . $_;
648}
649
Fred Drake6659c301998-03-03 22:02:19 +0000650@col_aligns = ("<td>", "<td>", "<td>");
651
652sub setup_column_alignments{
653 local($_) = @_;
Fred Drakeee601911998-04-11 20:53:03 +0000654 my($a1,$a2,$a3) = split(/[|]/,$_);
Fred Drakec9a44381998-03-17 06:29:13 +0000655 my($th1,$th2,$th3) = ('<th>', '<th>', '<th>');
Fred Drake08932051998-04-17 02:15:42 +0000656 $col_aligns[0] = (($a1 eq 'c') ? '<td align=center>' : '<td>');
657 $col_aligns[1] = (($a2 eq 'c') ? '<td align=center>' : '<td>');
658 $col_aligns[2] = (($a3 eq 'c') ? '<td align=center>' : '<td>');
Fred Drake6659c301998-03-03 22:02:19 +0000659 # return the aligned header start tags; only used for \begin{tableiii?}
Fred Drake08932051998-04-17 02:15:42 +0000660 $th1 = (($a1 eq 'l') ? '<th align=left>'
661 : ($a1 eq 'r' ? '<th align=right>' : '<th>'));
662 $th2 = (($a2 eq 'l') ? '<th align=left>'
663 : ($a2 eq 'r' ? '<th align=right>' : '<th>'));
664 $th3 = (($a3 eq 'l') ? '<th align=left>'
665 : ($a3 eq 'r' ? '<th align=right>' : '<th>'));
Fred Drake6659c301998-03-03 22:02:19 +0000666 ($th1, $th2, $th3);
667}
668
669sub do_env_tableii{
670 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000671 my($th1,$th2,$th3) = setup_column_alignments(next_argument());
672 my $font = next_argument();
673 my $h1 = next_argument();
674 my $h2 = next_argument();
675 $font = ''
676 if ($font eq 'textrm');
677 $globals{'lineifont'} = $font;
678 '<table border align=center>'
Fred Drake6659c301998-03-03 22:02:19 +0000679 . "\n <tr>$th1<b>$h1</b></th>"
Fred Drake08932051998-04-17 02:15:42 +0000680 . "\n $th2<b>$h2</b></th>"
681 . $_
Fred Drake6659c301998-03-03 22:02:19 +0000682 . "\n</table>";
683}
684
685sub do_cmd_lineii{
686 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000687 my $c1 = next_argument();
688 my $c2 = next_argument();
689 my($font,$sfont,$efont) = ($globals{'lineifont'}, '', '');
Fred Drake58b2bfd1998-04-02 20:14:04 +0000690 if ($font) {
Fred Drake5cca42e1998-04-09 17:59:11 +0000691 $sfont = "<$font>";
Fred Drake58b2bfd1998-04-02 20:14:04 +0000692 $efont = "</$font>";
693 }
Fred Drakec9a44381998-03-17 06:29:13 +0000694 my($c1align,$c2align) = @col_aligns[0,1];
Fred Drake5cca42e1998-04-09 17:59:11 +0000695 "<tr>$c1align$sfont$c1$efont</td>\n"
Fred Drake08932051998-04-17 02:15:42 +0000696 . " $c2align$c2</td>"
697 . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000698}
699
700sub do_env_tableiii{
701 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000702 my($th1,$th2,$th3) = setup_column_alignments(next_argument());
703 my $font = next_argument();
704 my $h1 = next_argument();
705 my $h2 = next_argument();
706 my $h3 = next_argument();
707 $font = ''
708 if ($font eq 'textrm');
709 $globals{'lineifont'} = $font;
710 '<table border align=center>'
Fred Drake6659c301998-03-03 22:02:19 +0000711 . "\n <tr>$th1<b>$h1</b></th>"
712 . "\n $th2<b>$h2</b></th>"
Fred Drake08932051998-04-17 02:15:42 +0000713 . "\n $th3<b>$h3</b></th>"
714 . $_
Fred Drake6659c301998-03-03 22:02:19 +0000715 . "\n</table>";
716}
717
718sub do_cmd_lineiii{
719 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000720 my $c1 = next_argument();
721 my $c2 = next_argument();
722 my $c3 = next_argument();
723 my($font,$sfont,$efont) = ($globals{'lineifont'}, '', '');
Fred Drake58b2bfd1998-04-02 20:14:04 +0000724 if ($font) {
Fred Drake5cca42e1998-04-09 17:59:11 +0000725 $sfont = "<$font>";
Fred Drake58b2bfd1998-04-02 20:14:04 +0000726 $efont = "</$font>";
727 }
Fred Drake08932051998-04-17 02:15:42 +0000728 my($c1align,$c2align,$c3align) = @col_aligns;
Fred Drake5cca42e1998-04-09 17:59:11 +0000729 "<tr>$c1align$sfont$c1$efont</td>\n"
Fred Drake6659c301998-03-03 22:02:19 +0000730 . " $c2align$c2</td>\n"
Fred Drake08932051998-04-17 02:15:42 +0000731 . " $c3align$c3</td>"
732 . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000733}
734
735sub do_env_seealso{
736 "<p><b>See Also:</b></p>\n" . @_[0];
737}
738
739sub do_cmd_seemodule{
740 # Insert the right magic to jump to the module definition. This should
741 # work most of the time, at least for repeat builds....
742 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000743 my $key = next_optional_argument();
744 my $module = next_argument();
745 my $text = next_argument();
746 $key = $module
747 unless $key;
Fred Drakeb3c9bca1998-03-06 21:20:08 +0000748 "<p>Module <tt><b><a href=\"module-$key.html\">$module</a></b></tt>"
Fred Drake6659c301998-03-03 22:02:19 +0000749 . "&nbsp;&nbsp;&nbsp;($text)</p>"
750 . $_;
751}
752
753sub do_cmd_seetext{
Fred Drake08932051998-04-17 02:15:42 +0000754 '<p>' . @_[0];
Fred Drake6659c301998-03-03 22:02:19 +0000755}
756
757
758sub do_cmd_maketitle {
759 local($_) = @_;
Fred Drakec9a44381998-03-17 06:29:13 +0000760 my $the_title = '';
Fred Drake6659c301998-03-03 22:02:19 +0000761 if ($t_title) {
Fred Drakec9a44381998-03-17 06:29:13 +0000762 $the_title .= "<h1 align=center>$t_title</h1>";
Fred Drake08932051998-04-17 02:15:42 +0000763 } else { write_warnings("\nThis document has no title."); }
Fred Drakec9a44381998-03-17 06:29:13 +0000764 $the_title .= "\n<center>";
Fred Drake6659c301998-03-03 22:02:19 +0000765 if ($t_author) {
766 if ($t_authorURL) {
Fred Drake08932051998-04-17 02:15:42 +0000767 my $href = translate_commands($t_authorURL);
768 $href = make_named_href('author', $href, "<strong>${t_author}</strong>");
Fred Drakec9a44381998-03-17 06:29:13 +0000769 $the_title .= "\n<p>$href</p>";
Fred Drake6659c301998-03-03 22:02:19 +0000770 } else {
Fred Drakec9a44381998-03-17 06:29:13 +0000771 $the_title .= "\n<p><strong>$t_author</strong></p>";
Fred Drake6659c301998-03-03 22:02:19 +0000772 }
Fred Drake08932051998-04-17 02:15:42 +0000773 } else { write_warnings("\nThere is no author for this document."); }
Fred Drake6659c301998-03-03 22:02:19 +0000774 if ($t_institute) {
Fred Drakec9a44381998-03-17 06:29:13 +0000775 $the_title .= "\n<p>$t_institute</p>";}
Fred Drake6659c301998-03-03 22:02:19 +0000776 if ($AUTHOR_ADDRESS) {
Fred Drakec9a44381998-03-17 06:29:13 +0000777 $the_title .= "\n<p>$AUTHOR_ADDRESS</p>";}
Fred Drake6659c301998-03-03 22:02:19 +0000778 if ($t_affil) {
Fred Drakec9a44381998-03-17 06:29:13 +0000779 $the_title .= "\n<p><i>$t_affil</i></p>";}
Fred Drake6659c301998-03-03 22:02:19 +0000780 if ($t_date) {
Fred Drakec9a44381998-03-17 06:29:13 +0000781 $the_title .= "\n<p><strong>$t_date</strong>";
Fred Drake6659c301998-03-03 22:02:19 +0000782 if ($PYTHON_VERSION) {
783 $the_title .= "<br><strong>Release $PYTHON_VERSION</strong>";}
784 $the_title .= "</p>"
785 }
Fred Drakec9a44381998-03-17 06:29:13 +0000786 $the_title .= "\n</center>";
Fred Drake6659c301998-03-03 22:02:19 +0000787 if ($t_address) {
Fred Drakec9a44381998-03-17 06:29:13 +0000788 $the_title .= "\n<p>$t_address</p>";
789 } else { $the_title .= "\n<p>"}
Fred Drake6659c301998-03-03 22:02:19 +0000790 if ($t_email) {
Fred Drakec9a44381998-03-17 06:29:13 +0000791 $the_title .= "\n<p>$t_email</p>";
792 }# else { $the_title .= "</p>" }
793 $the_title . "<hr>\n" . $_ ;
Fred Drake6659c301998-03-03 22:02:19 +0000794}
795
796
Fred Drake6659c301998-03-03 22:02:19 +00007971; # This must be the last line