blob: 08ed98a1b54cb653f3c68f7c2f1e4804b2301f6d [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(@_); }
128sub do_cmd_key{ do_cmd_code(@_); }
129sub do_cmd_character{ do_cmd_samp(@_); }
130sub do_cmd_program{ do_cmd_strong(@_); }
131sub do_cmd_email{ use_sans_serif(@_); }
132sub do_cmd_mimetype{ use_sans_serif(@_); }
133sub do_cmd_var{ use_italics(@_); }
134sub do_cmd_dfn{ use_italics(@_); } # make an index entry?
135sub do_cmd_emph{ use_italics(@_); }
136sub do_cmd_file{ use_wrappers(@_[0], '"<tt>', '</tt>"'); }
137sub do_cmd_samp{ use_wrappers(@_[0], '"<tt>', '</tt>"'); }
138sub do_cmd_kbd{ use_wrappers(@_[0], '<kbd>', '</kbd>'); }
139sub do_cmd_strong{ use_wrappers(@_[0], '<b>', '</b>'); }
Fred Drakec9a44381998-03-17 06:29:13 +0000140
Fred Drake08932051998-04-17 02:15:42 +0000141# \sectcode is obsolete, but keep it around here for a little while;
142# mostly expected to be useful for HOWTO support until that stuff is
143# more stable and checked.
144sub do_cmd_sectcode{ do_cmd_code(@_); }
Fred Drakec9a44381998-03-17 06:29:13 +0000145
Fred Drake1a7af391998-04-01 22:44:56 +0000146sub do_cmd_newsgroup{
147 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000148 my $newsgroup = next_argument();
Fred Drake1a7af391998-04-01 22:44:56 +0000149 my $stuff = "<a href=\"news:$newsgroup\"><font face=sans-serif>"
150 . "$newsgroup</font></a>";
151 $stuff . $_;
152}
Fred Drakefc16e781998-03-12 21:03:26 +0000153
154sub do_cmd_envvar{
155 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000156 my($envvar,$br_id) = next_argument_id();
Fred Drake42b31a51998-03-27 05:16:10 +0000157 my($name,$aname,$ahref) = link_info($br_id);
Fred Drake166abba1998-04-08 23:10:54 +0000158 # The <tt> here is really to keep buildindex.py from making
159 # the variable name case-insensitive.
160 add_index_entry("environment variables!$envvar@<tt>\$$envvar</tt>",
161 $ahref);
Fred Drake42b31a51998-03-27 05:16:10 +0000162 add_index_entry("$envvar@\$$envvar", $ahref);
163 "$aname\$$envvar</a>" . $_;
Fred Drakefc16e781998-03-12 21:03:26 +0000164}
165
Fred Drake08932051998-04-17 02:15:42 +0000166
Fred Drake6659c301998-03-03 22:02:19 +0000167sub do_cmd_url{
168 # use the URL as both text and hyperlink
169 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000170 my $url = next_argument();
Fred Drake6659c301998-03-03 22:02:19 +0000171 $url =~ s/~/&#126;/g;
Fred Drakec9a44381998-03-17 06:29:13 +0000172 "<a href=\"$url\"><font face=sans-serif>$url</font></a>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000173}
174
175sub do_cmd_manpage{
176 # two parameters: \manpage{name}{section}
177 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000178 my $page = next_argument();
179 my $section = next_argument();
180 "<i>$page</i>($section)" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000181}
182
183sub do_cmd_rfc{
184 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000185 my($rfcnumber,$br_id) = next_argument();
Fred Drake6659c301998-03-03 22:02:19 +0000186
187 # Save the reference
Fred Drake08932051998-04-17 02:15:42 +0000188 my $nstr = gen_index_id("RFC!RFC $rfcnumber", '');
189 $index{$nstr} .= make_half_href("$CURRENT_FILE#$br_id");
Fred Drakec9a44381998-03-17 06:29:13 +0000190 "<a name=$br_id>RFC $rfcnumber</a>" .$_;
Fred Drake6659c301998-03-03 22:02:19 +0000191}
192
Fred Drake6659c301998-03-03 22:02:19 +0000193sub do_cmd_deprecated{
194 # two parameters: \deprecated{version}{whattodo}
195 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000196 my $release = next_argument();
197 my $reason = next_argument();
198 "<b>Deprecated since release $release.</b>\n$reason<p>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000199}
200
201# file and samp are at the end of this file since they screw up fontlock.
202
203# index commands
204
205$INDEX_SUBITEM = "";
206
207sub get_indexsubitem{
Fred Drakefc16e781998-03-12 21:03:26 +0000208 #$INDEX_SUBITEM ? " $INDEX_SUBITEM" : '';
209 '';
Fred Drake6659c301998-03-03 22:02:19 +0000210}
211
212sub do_cmd_setindexsubitem{
213 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000214 $INDEX_SUBITEM = next_argument();
Fred Drake6659c301998-03-03 22:02:19 +0000215 $_;
216}
217
Fred Drakefc16e781998-03-12 21:03:26 +0000218sub do_cmd_withsubitem{
219 # We can't really do the right right thing, because LaTeX2HTML doesn't
220 # do things in the right order, but we need to at least strip this stuff
221 # out, and leave anything that the second argument expanded out to.
222 #
223 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000224 next_argument();
225 my $stuff = next_argument();
226 $stuff . $_;
Fred Drakefc16e781998-03-12 21:03:26 +0000227}
228
Fred Drake08932051998-04-17 02:15:42 +0000229# This is the prologue macro which is required to start writing the
230# mod\jobname.idx file; we can just ignore it.
231#
Fred Drakefc16e781998-03-12 21:03:26 +0000232sub do_cmd_makemodindex{ @_[0]; }
233
Fred Drake42b31a51998-03-27 05:16:10 +0000234# We're in the document subdirectory when this happens!
Fred Drake166abba1998-04-08 23:10:54 +0000235#
Fred Drake08932051998-04-17 02:15:42 +0000236open(IDXFILE, '>index.dat') || die "\n$!\n";
237open(INTLABELS, '>intlabels.pl') || die "\n$!\n";
Fred Drake166abba1998-04-08 23:10:54 +0000238print INTLABELS "%internal_labels = ();\n";
239print INTLABELS "1; # hack in case there are no entries\n\n";
240
241# Using \0 for this is bad because we can't use common tools to work with the
242# resulting files. Things like grep can be useful with this stuff!
243#
244$IDXFILE_FIELD_SEP = "\1";
245
Fred Drake42b31a51998-03-27 05:16:10 +0000246
247sub gen_target_name{
248 "l2h-" . @_[0];
249}
250
251sub gen_target{
Fred Drake08932051998-04-17 02:15:42 +0000252 '<a name="' . @_[0] . '">';
Fred Drake42b31a51998-03-27 05:16:10 +0000253}
254
255sub gen_link{
256 my($node,$target) = @_;
257 print INTLABELS "\$internal_labels{\"$target\"} = \"$URL/$node\";\n";
258 "<a href=\"$node#$target\">";
259}
260
261sub make_index_entry{
262 my($br_id,$str) = @_;
263 my($name,$aname,$ahref) = link_info($br_id);
264 add_index_entry($str, $ahref);
265 "$aname$anchor_invisible_mark</a>";
266}
267
268sub add_index_entry{
269 # add an entry to the index structures; ignore the return value
270 my($str,$ahref) = @_;
271 $str = gen_index_id($str, '');
272 $index{$str} .= $ahref;
Fred Drake166abba1998-04-08 23:10:54 +0000273 print IDXFILE $ahref, $IDXFILE_FIELD_SEP, $str, "\n";
Fred Drake42b31a51998-03-27 05:16:10 +0000274}
275
276sub link_info{
277 my $name = gen_target_name(@_[0]);
278 my $aname = gen_target($name);
279 my $ahref = gen_link($CURRENT_FILE, $name);
280 return ($name, $aname, $ahref);
281}
282
283sub do_cmd_index{
284 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000285 my($str,$br_id) = next_argument_id();
286 swallow_newline();
Fred Drake42b31a51998-03-27 05:16:10 +0000287 #
288 my($name,$aname,$ahref) = link_info($br_id);
289 add_index_entry("$str", $ahref);
290 "$aname$anchor_invisible_mark</a>" . $_;
291}
292
Fred Drake6659c301998-03-03 22:02:19 +0000293sub do_cmd_indexii{
294 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000295 my($str1,$br_id) = next_argument_id();
296 my $str2 = next_argument();
Fred Drake42b31a51998-03-27 05:16:10 +0000297 #
Fred Drake08932051998-04-17 02:15:42 +0000298 my($name,$aname,$ahref) = link_info($br_id);
Fred Drake42b31a51998-03-27 05:16:10 +0000299 add_index_entry("$str1!$str2", $ahref);
300 add_index_entry("$str2!$str1", $ahref);
301 "$aname$anchor_invisible_mark</a>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000302}
303
304sub do_cmd_indexiii{
305 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000306 my($str1,$br_id) = next_argument();
307 my $str2 = next_argument();
308 my $str3 = next_argument();
Fred Drake42b31a51998-03-27 05:16:10 +0000309 #
Fred Drake08932051998-04-17 02:15:42 +0000310 my($name,$aname,$ahref) = link_info($br_id);
Fred Drake42b31a51998-03-27 05:16:10 +0000311 add_index_entry("$str1!$str2 $str3", $ahref);
312 add_index_entry("$str2!$str3, $str1", $ahref);
313 add_index_entry("$str3!$str1 $str2", $ahref);
314 "$aname$anchor_invisible_mark</a>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000315}
316
317sub do_cmd_indexiv{
318 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000319 my($str1,$br_id) = next_argument();
320 my $str2 = next_argument();
321 my $str3 = next_argument();
322 my $str4 = next_argument();
Fred Drake42b31a51998-03-27 05:16:10 +0000323 #
Fred Drake08932051998-04-17 02:15:42 +0000324 my($name,$aname,$ahref) = link_info($br_id);
Fred Drake42b31a51998-03-27 05:16:10 +0000325 add_index_entry("$str1!$str2 $str3 $str4", $ahref);
326 add_index_entry("$str2!$str3 $str4, $str1", $ahref);
327 add_index_entry("$str3!$str4, $str1 $str2", $ahref);
328 add_index_entry("$str4!$$str1 $str2 $str3", $ahref);
329 "$aname$anchor_invisible_mark</a>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000330}
331
Fred Drakec9a44381998-03-17 06:29:13 +0000332sub do_cmd_ttindex{
333 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000334 my($str,$br_id) = next_argument_id();
335 swallow_newline();
336 make_index_entry($br_id, $str . get_indexsubitem()) . $_;
Fred Drakec9a44381998-03-17 06:29:13 +0000337}
Fred Drake6659c301998-03-03 22:02:19 +0000338
339sub my_typed_index_helper{
Fred Drakec9a44381998-03-17 06:29:13 +0000340 local($word,$_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000341 my($str,$br_id) = next_argument();
342 swallow_newline();
Fred Drake42b31a51998-03-27 05:16:10 +0000343 #
344 my($name,$aname,$ahref) = link_info($br_id1);
345 add_index_entry("$str $word", $ahref);
346 add_index_entry("$word!$str", $ahref);
347 "$aname$anchor_invisible_mark</a>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000348}
349
Fred Drake08932051998-04-17 02:15:42 +0000350sub do_cmd_stindex{ my_typed_index_helper('statement', @_); }
351sub do_cmd_opindex{ my_typed_index_helper('operator', @_); }
352sub do_cmd_exindex{ my_typed_index_helper('exception', @_); }
353sub do_cmd_obindex{ my_typed_index_helper('object', @_); }
Fred Drake6659c301998-03-03 22:02:19 +0000354
355sub my_parword_index_helper{
Fred Drakec9a44381998-03-17 06:29:13 +0000356 local($word,$_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000357 my($str,$br_id) = next_argument_id();
358 swallow_newline();
Fred Drake42b31a51998-03-27 05:16:10 +0000359 make_index_entry($br_id, "$str ($word)") . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000360}
361
362
Fred Drake6659c301998-03-03 22:02:19 +0000363sub make_mod_index_entry{
Fred Drakec9a44381998-03-17 06:29:13 +0000364 my($br_id,$str,$define) = @_;
Fred Drake42b31a51998-03-27 05:16:10 +0000365 my($name,$aname,$ahref) = link_info($br_id);
Fred Drake42b31a51998-03-27 05:16:10 +0000366 # equivalent of add_index_entry() using $define instead of ''
367 $str = gen_index_id($str, $define);
368 $index{$str} .= $ahref;
Fred Drake166abba1998-04-08 23:10:54 +0000369 print IDXFILE $ahref, $IDXFILE_FIELD_SEP, $str, "\n";
Fred Drake42b31a51998-03-27 05:16:10 +0000370
Fred Drakec9a44381998-03-17 06:29:13 +0000371 if ($define eq 'DEF') {
Fred Drake42b31a51998-03-27 05:16:10 +0000372 # add to the module index
Fred Drakec9a44381998-03-17 06:29:13 +0000373 my($nstr,$garbage) = split / /, $str, 2;
Fred Drake42b31a51998-03-27 05:16:10 +0000374 $Modules{$nstr} .= $ahref;
Fred Drake6659c301998-03-03 22:02:19 +0000375 }
Fred Drake42b31a51998-03-27 05:16:10 +0000376 "$aname$anchor_invisible_mark</a>";
Fred Drake6659c301998-03-03 22:02:19 +0000377}
378
Fred Drakec9a44381998-03-17 06:29:13 +0000379$THIS_MODULE = '';
Fred Drake42b31a51998-03-27 05:16:10 +0000380$THIS_CLASS = '';
Fred Drakec9a44381998-03-17 06:29:13 +0000381
Fred Drake6659c301998-03-03 22:02:19 +0000382sub my_module_index_helper{
383 local($word, $_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000384 my($str,$br_id) = next_argument_id();
385 swallow_newline();
Fred Drakec9a44381998-03-17 06:29:13 +0000386 my $section_tag = join('', @curr_sec_id);
Fred Drake6659c301998-03-03 22:02:19 +0000387 $word = "$word " if $word;
Fred Drakec9a44381998-03-17 06:29:13 +0000388 $THIS_MODULE = "$str";
Fred Drake42b31a51998-03-27 05:16:10 +0000389 make_mod_index_entry("SECTION$section_tag",
390 "<tt>$str</tt> (${word}module)", 'DEF') . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000391}
392
393sub ref_module_index_helper{
394 local($word, $_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000395 my($str,$br_id) = next_argument();
396 swallow_newline();
Fred Drake6659c301998-03-03 22:02:19 +0000397 $word = "$word " if $word;
Fred Drake42b31a51998-03-27 05:16:10 +0000398 make_mod_index_entry($br_id, "<tt>$str</tt> (${word}module)", 'REF') . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000399}
400
Fred Drakec9a44381998-03-17 06:29:13 +0000401sub do_cmd_bifuncindex{
402 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000403 my($str,$br_id) = next_argument();
404 swallow_newline();
405 my $fname = "<tt>$str()</tt>";
Fred Drake42b31a51998-03-27 05:16:10 +0000406 make_index_entry($br_id, "$fname (built-in function)") . $_;
Fred Drakec9a44381998-03-17 06:29:13 +0000407}
408
Fred Drake42b31a51998-03-27 05:16:10 +0000409sub do_cmd_modindex{ my_module_index_helper('', @_); }
410sub do_cmd_bimodindex{ my_module_index_helper('built-in', @_); }
411sub do_cmd_exmodindex{ my_module_index_helper('extension', @_); }
412sub do_cmd_stmodindex{ my_module_index_helper('standard', @_); }
Fred Drake6659c301998-03-03 22:02:19 +0000413
414# these should be adjusted a bit....
Fred Drake42b31a51998-03-27 05:16:10 +0000415sub do_cmd_refmodindex{ ref_module_index_helper('', @_); }
416sub do_cmd_refbimodindex{ ref_module_index_helper('built-in', @_); }
417sub do_cmd_refexmodindex{ ref_module_index_helper('extension', @_); }
418sub do_cmd_refstmodindex{ ref_module_index_helper('standard', @_); }
Fred Drake6659c301998-03-03 22:02:19 +0000419
Fred Drake42b31a51998-03-27 05:16:10 +0000420sub do_cmd_nodename{ do_cmd_label(@_); }
Fred Drake6659c301998-03-03 22:02:19 +0000421
422sub init_myformat{
Fred Drake08932051998-04-17 02:15:42 +0000423# $anchor_invisible_mark = '';
Fred Drake6659c301998-03-03 22:02:19 +0000424 $anchor_mark = '';
425 $icons{'anchor_mark'} = '';
Fred Drake6659c301998-03-03 22:02:19 +0000426}
Fred Drake42b31a51998-03-27 05:16:10 +0000427init_myformat();
Fred Drake6659c301998-03-03 22:02:19 +0000428
429# similar to make_index_entry(), but includes the string in the result
430# instead of the dummy filler.
431#
432sub make_str_index_entry{
Fred Drakec9a44381998-03-17 06:29:13 +0000433 my($br_id,$str) = @_;
Fred Drake42b31a51998-03-27 05:16:10 +0000434 my($name,$aname,$ahref) = link_info($br_id);
Fred Drake42b31a51998-03-27 05:16:10 +0000435 add_index_entry($str, $ahref);
436 "$aname$str</a>";
Fred Drake6659c301998-03-03 22:02:19 +0000437}
438
Fred Drake6659c301998-03-03 22:02:19 +0000439sub do_env_cfuncdesc{
440 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000441 my $return_type = next_argument();
442 my($function_name,$br_id) = next_argument_id();
443 my $arg_list = next_argument();
444 my $idx = make_str_index_entry($br_id,
445 "<tt>$function_name()</tt>" . get_indexsubitem());
446 $idx =~ s/ \(.*\)//;
447 $idx =~ s/\(\)//; # ????
Fred Drake6659c301998-03-03 22:02:19 +0000448 "<dl><dt>$return_type <b>$idx</b>"
Fred Drake08932051998-04-17 02:15:42 +0000449 . "(<var>$arg_list</var>)\n<dd>"
450 . $_
451 . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000452}
453
454sub do_env_ctypedesc{
455 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000456 my($type_name,$br_id) = next_argument_id();
457 my $idx = make_str_index_entry($br_id,
458 "<tt>$type_name</tt>" . get_indexsubitem());
459 $idx =~ s/ \(.*\)//;
460 "<dl><dt><b>$idx</b>\n<dd>"
461 . $_
462 . '</dl>'
Fred Drake6659c301998-03-03 22:02:19 +0000463}
464
465sub do_env_cvardesc{
466 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000467 my $var_type = next_argument();
468 my($var_name,$br_id) = next_argument_id();
469 my $idx = make_str_index_entry($br_id,
470 "<tt>$var_name</tt>" . get_indexsubitem());
471 $idx =~ s/ \(.*\)//;
Fred Drake6659c301998-03-03 22:02:19 +0000472 "<dl><dt>$var_type <b>$idx</b>\n"
Fred Drake08932051998-04-17 02:15:42 +0000473 . '<dd>'
474 . $_
475 . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000476}
477
478sub do_env_funcdesc{
479 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000480 my $function_name = next_argument();
481 my($arg_list,$br_id) = next_argument_id();
482 my $idx = make_str_index_entry($br_id, "<tt>$function_name()</tt>"
483 . get_indexsubitem());
484 $idx =~ s/ \(.*\)//;
485 $idx =~ s/\(\)//;
486 "<dl><dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_ . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000487}
488
489sub do_env_funcdescni{
490 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000491 my $function_name = next_argument();
492 my $arg_list = next_argument();
493 "<dl><dt><b><tt>$function_name</tt></b> (<var>$arg_list</var>)\n<dd>"
494 . $_ . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000495}
496
497sub do_cmd_funcline{
498 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000499 my $function_name = next_argument();
500 my($arg_list,$br_id) = next_argument_id();
Fred Drake42b31a51998-03-27 05:16:10 +0000501 my $idx = make_str_index_entry($br_id, "<tt>$function_name()</tt>"
Fred Drake08932051998-04-17 02:15:42 +0000502 . get_indexsubitem());
Fred Drakec9a44381998-03-17 06:29:13 +0000503 $idx =~ s/\(\)//;
Fred Drake6659c301998-03-03 22:02:19 +0000504 "<dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_;
505}
506
507# Change this flag to index the opcode entries. I don't think it's very
508# useful to index them, since they're only presented to describe the dis
509# module.
510#
511$INDEX_OPCODES = 0;
512
513sub do_env_opcodedesc{
514 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000515 my $opcode_name = next_argument();
516 my($arg_list,$br_id) = next_argument_id();
517 my $idx;
518 if ($INDEX_OPCODES) {
519 $idx = make_str_index_entry($br_id,
Fred Drake6659c301998-03-03 22:02:19 +0000520 "<tt>$opcode_name</tt> (byte code instruction)");
Fred Drake08932051998-04-17 02:15:42 +0000521 $idx =~ s/ \(byte code instruction\)//;
522 }
523 else {
524 $idx = "<tt>$opcode_name</tt>";
525 }
526 my $stuff = "<dl><dt><b>$idx</b>";
Fred Drake6659c301998-03-03 22:02:19 +0000527 if ($arg_list) {
528 $stuff .= "&nbsp;&nbsp;&nbsp;&nbsp;<var>$arg_list</var>";
529 }
Fred Drake08932051998-04-17 02:15:42 +0000530 $stuff . "\n<dd>" . $_ . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000531}
532
533sub do_env_datadesc{
534 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000535 my($dataname,$br_id) = next_argument_id();
536 my $idx = make_str_index_entry($br_id,
537 "<tt>$dataname</tt>" . get_indexsubitem());
538 $idx =~ s/ \(.*\)//;
539 "<dl><dt><b>$idx</b>\n<dd>"
540 . $_
541 . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000542}
543
544sub do_env_datadescni{
545 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000546 my $idx = next_argument();
547 if (! $STRING_INDEX_TT) {
548 $idx = "<tt>$idx</tt>";
Fred Drake6659c301998-03-03 22:02:19 +0000549 }
Fred Drake08932051998-04-17 02:15:42 +0000550 "<dl><dt><b>$idx</b>\n<dd>" . $_ . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000551}
552
553sub do_cmd_dataline{
554 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000555 my($data_name,$br_id) = next_argument_id();
Fred Drake42b31a51998-03-27 05:16:10 +0000556 my $idx = make_str_index_entry($br_id, "<tt>$data_name</tt>"
Fred Drake08932051998-04-17 02:15:42 +0000557 . get_indexsubitem());
Fred Drake6659c301998-03-03 22:02:19 +0000558 $idx =~ s/ \(.*\)//;
Fred Drake42b31a51998-03-27 05:16:10 +0000559 "<dt><b>$idx</b><dd>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000560}
561
Fred Drake42b31a51998-03-27 05:16:10 +0000562sub do_env_excdesc{
563 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000564 my($excname,$br_id) = next_argument_id();
Fred Drake166abba1998-04-08 23:10:54 +0000565 my $idx = make_str_index_entry($br_id, "<tt>$excname</tt>");
Fred Drake08932051998-04-17 02:15:42 +0000566 "<dl><dt><b>$idx</b>\n<dd>" . $_ . '</dl>'
Fred Drake42b31a51998-03-27 05:16:10 +0000567}
568
569sub do_env_fulllineitems{ do_env_itemize(@_); }
Fred Drake6659c301998-03-03 22:02:19 +0000570
571
Fred Drakec9a44381998-03-17 06:29:13 +0000572sub do_env_classdesc{
573 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000574 $THIS_CLASS = next_argument();
575 my($arg_list,$br_id) = next_argument_id();
576 $idx = make_str_index_entry($br_id,
577 "<tt>$THIS_CLASS</tt> (class in $THIS_MODULE)" );
578 $idx =~ s/ \(.*\)//;
579 "<dl><dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_ . '</dl>';
Fred Drakec9a44381998-03-17 06:29:13 +0000580}
581
Fred Drake42b31a51998-03-27 05:16:10 +0000582
583sub do_env_methoddesc{
584 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000585 my $class_name = next_optional_argument();
586 $class_name = $THIS_CLASS
587 unless $class_name;
588 my($method_name,$br_id) = next_argument_id();
589 my $arg_list = next_argument();
590 my $extra = '';
591 if ($class_name) {
592 $extra = " ($class_name method)";
Fred Drake42b31a51998-03-27 05:16:10 +0000593 }
Fred Drake08932051998-04-17 02:15:42 +0000594 my $idx = make_str_index_entry($br_id, "<tt>$method_name()</tt>$extra");
595 $idx =~ s/ \(.*\)//;
596 $idx =~ s/\(\)//;
597 "<dl><dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_ . '</dl>';
Fred Drake42b31a51998-03-27 05:16:10 +0000598}
599
600
601sub do_env_methoddescni{
602 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000603 next_optional_argument();
604 my $method = next_argument();
605 my $arg_list = next_argument();
606 "<dl><dt><b>$method</b> (<var>$arg_list</var>)\n<dd>" . $_ . '</dl>';
Fred Drake42b31a51998-03-27 05:16:10 +0000607}
608
609
610sub do_env_memberdesc{
611 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000612 my $class = next_optional_argument();
613 my($member,$br_id) = next_argument();
Fred Drake42b31a51998-03-27 05:16:10 +0000614 $class = $THIS_CLASS
615 unless $class;
Fred Drake08932051998-04-17 02:15:42 +0000616 my $extra = '';
Fred Drake42b31a51998-03-27 05:16:10 +0000617 $extra = " ($class_name attribute)"
Fred Drakea608feb1998-04-12 03:58:13 +0000618 if (!($class eq ''));
Fred Drake08932051998-04-17 02:15:42 +0000619 my $idx = make_str_index_entry($br_id, "<tt>$member</tt>$extra");
Fred Drake42b31a51998-03-27 05:16:10 +0000620 $idx =~ s/ \(.*\)//;
621 $idx =~ s/\(\)//;
Fred Drake08932051998-04-17 02:15:42 +0000622 "<dl><dt><b>$idx</b>\n<dd>" . $_ . '</dl>';
Fred Drake42b31a51998-03-27 05:16:10 +0000623}
624
625
Fred Drake5ccf3301998-04-17 20:04:09 +0000626sub do_cmd_memberline{
627 local($_) = @_;
628 my $class = next_optional_argument();
629 my($member,$br_id) = next_argument_id();
630 $class = $THIS_CLASS
631 unless $class;
632 my $extra = '';
633 $extra = " ($class_name attribute)"
634 if (!($class eq ''));
635 my $idx = make_str_index_entry($br_id, "<tt>$member</tt>$extra");
636 $idx =~ s/ \(.*\)//;
637 $idx =~ s/\(\)//;
638 "<dt><b>$idx</b><dd>" . $_;
639}
640
Fred Drake42b31a51998-03-27 05:16:10 +0000641sub do_env_memberdescni{
642 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000643 next_optional_argument();
644 my $member = next_argument();
645 "<dl><dt><b>$member</b>\n<dd>" . $_ . '</dl>';
Fred Drake42b31a51998-03-27 05:16:10 +0000646}
647
648
Fred Drake5ccf3301998-04-17 20:04:09 +0000649sub do_cmd_memberlineni{
650 local($_) = @_;
651 next_optional_argument();
652 my $member = next_argument();
653 "<dt><b>$member</b><dd>" . $_;
654}
655
Fred Drake6659c301998-03-03 22:02:19 +0000656@col_aligns = ("<td>", "<td>", "<td>");
657
658sub setup_column_alignments{
659 local($_) = @_;
Fred Drakeee601911998-04-11 20:53:03 +0000660 my($a1,$a2,$a3) = split(/[|]/,$_);
Fred Drakec9a44381998-03-17 06:29:13 +0000661 my($th1,$th2,$th3) = ('<th>', '<th>', '<th>');
Fred Drake08932051998-04-17 02:15:42 +0000662 $col_aligns[0] = (($a1 eq 'c') ? '<td align=center>' : '<td>');
663 $col_aligns[1] = (($a2 eq 'c') ? '<td align=center>' : '<td>');
664 $col_aligns[2] = (($a3 eq 'c') ? '<td align=center>' : '<td>');
Fred Drake6659c301998-03-03 22:02:19 +0000665 # return the aligned header start tags; only used for \begin{tableiii?}
Fred Drake08932051998-04-17 02:15:42 +0000666 $th1 = (($a1 eq 'l') ? '<th align=left>'
667 : ($a1 eq 'r' ? '<th align=right>' : '<th>'));
668 $th2 = (($a2 eq 'l') ? '<th align=left>'
669 : ($a2 eq 'r' ? '<th align=right>' : '<th>'));
670 $th3 = (($a3 eq 'l') ? '<th align=left>'
671 : ($a3 eq 'r' ? '<th align=right>' : '<th>'));
Fred Drake6659c301998-03-03 22:02:19 +0000672 ($th1, $th2, $th3);
673}
674
675sub do_env_tableii{
676 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000677 my($th1,$th2,$th3) = setup_column_alignments(next_argument());
678 my $font = next_argument();
679 my $h1 = next_argument();
680 my $h2 = next_argument();
681 $font = ''
682 if ($font eq 'textrm');
683 $globals{'lineifont'} = $font;
684 '<table border align=center>'
Fred Drake6659c301998-03-03 22:02:19 +0000685 . "\n <tr>$th1<b>$h1</b></th>"
Fred Drake08932051998-04-17 02:15:42 +0000686 . "\n $th2<b>$h2</b></th>"
687 . $_
Fred Drake6659c301998-03-03 22:02:19 +0000688 . "\n</table>";
689}
690
691sub do_cmd_lineii{
692 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000693 my $c1 = next_argument();
694 my $c2 = next_argument();
695 my($font,$sfont,$efont) = ($globals{'lineifont'}, '', '');
Fred Drake58b2bfd1998-04-02 20:14:04 +0000696 if ($font) {
Fred Drake5cca42e1998-04-09 17:59:11 +0000697 $sfont = "<$font>";
Fred Drake58b2bfd1998-04-02 20:14:04 +0000698 $efont = "</$font>";
699 }
Fred Drakec9a44381998-03-17 06:29:13 +0000700 my($c1align,$c2align) = @col_aligns[0,1];
Fred Drake5cca42e1998-04-09 17:59:11 +0000701 "<tr>$c1align$sfont$c1$efont</td>\n"
Fred Drake08932051998-04-17 02:15:42 +0000702 . " $c2align$c2</td>"
703 . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000704}
705
706sub do_env_tableiii{
707 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000708 my($th1,$th2,$th3) = setup_column_alignments(next_argument());
709 my $font = next_argument();
710 my $h1 = next_argument();
711 my $h2 = next_argument();
712 my $h3 = next_argument();
713 $font = ''
714 if ($font eq 'textrm');
715 $globals{'lineifont'} = $font;
716 '<table border align=center>'
Fred Drake6659c301998-03-03 22:02:19 +0000717 . "\n <tr>$th1<b>$h1</b></th>"
718 . "\n $th2<b>$h2</b></th>"
Fred Drake08932051998-04-17 02:15:42 +0000719 . "\n $th3<b>$h3</b></th>"
720 . $_
Fred Drake6659c301998-03-03 22:02:19 +0000721 . "\n</table>";
722}
723
724sub do_cmd_lineiii{
725 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000726 my $c1 = next_argument();
727 my $c2 = next_argument();
728 my $c3 = next_argument();
729 my($font,$sfont,$efont) = ($globals{'lineifont'}, '', '');
Fred Drake58b2bfd1998-04-02 20:14:04 +0000730 if ($font) {
Fred Drake5cca42e1998-04-09 17:59:11 +0000731 $sfont = "<$font>";
Fred Drake58b2bfd1998-04-02 20:14:04 +0000732 $efont = "</$font>";
733 }
Fred Drake08932051998-04-17 02:15:42 +0000734 my($c1align,$c2align,$c3align) = @col_aligns;
Fred Drake5cca42e1998-04-09 17:59:11 +0000735 "<tr>$c1align$sfont$c1$efont</td>\n"
Fred Drake6659c301998-03-03 22:02:19 +0000736 . " $c2align$c2</td>\n"
Fred Drake08932051998-04-17 02:15:42 +0000737 . " $c3align$c3</td>"
738 . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000739}
740
741sub do_env_seealso{
742 "<p><b>See Also:</b></p>\n" . @_[0];
743}
744
745sub do_cmd_seemodule{
746 # Insert the right magic to jump to the module definition. This should
747 # work most of the time, at least for repeat builds....
748 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000749 my $key = next_optional_argument();
750 my $module = next_argument();
751 my $text = next_argument();
752 $key = $module
753 unless $key;
Fred Drakeb3c9bca1998-03-06 21:20:08 +0000754 "<p>Module <tt><b><a href=\"module-$key.html\">$module</a></b></tt>"
Fred Drake6659c301998-03-03 22:02:19 +0000755 . "&nbsp;&nbsp;&nbsp;($text)</p>"
756 . $_;
757}
758
759sub do_cmd_seetext{
Fred Drake08932051998-04-17 02:15:42 +0000760 '<p>' . @_[0];
Fred Drake6659c301998-03-03 22:02:19 +0000761}
762
763
764sub do_cmd_maketitle {
765 local($_) = @_;
Fred Drakec9a44381998-03-17 06:29:13 +0000766 my $the_title = '';
Fred Drake6659c301998-03-03 22:02:19 +0000767 if ($t_title) {
Fred Drakec9a44381998-03-17 06:29:13 +0000768 $the_title .= "<h1 align=center>$t_title</h1>";
Fred Drake08932051998-04-17 02:15:42 +0000769 } else { write_warnings("\nThis document has no title."); }
Fred Drakec9a44381998-03-17 06:29:13 +0000770 $the_title .= "\n<center>";
Fred Drake6659c301998-03-03 22:02:19 +0000771 if ($t_author) {
772 if ($t_authorURL) {
Fred Drake08932051998-04-17 02:15:42 +0000773 my $href = translate_commands($t_authorURL);
774 $href = make_named_href('author', $href, "<strong>${t_author}</strong>");
Fred Drakec9a44381998-03-17 06:29:13 +0000775 $the_title .= "\n<p>$href</p>";
Fred Drake6659c301998-03-03 22:02:19 +0000776 } else {
Fred Drakec9a44381998-03-17 06:29:13 +0000777 $the_title .= "\n<p><strong>$t_author</strong></p>";
Fred Drake6659c301998-03-03 22:02:19 +0000778 }
Fred Drake08932051998-04-17 02:15:42 +0000779 } else { write_warnings("\nThere is no author for this document."); }
Fred Drake6659c301998-03-03 22:02:19 +0000780 if ($t_institute) {
Fred Drakec9a44381998-03-17 06:29:13 +0000781 $the_title .= "\n<p>$t_institute</p>";}
Fred Drake6659c301998-03-03 22:02:19 +0000782 if ($AUTHOR_ADDRESS) {
Fred Drakec9a44381998-03-17 06:29:13 +0000783 $the_title .= "\n<p>$AUTHOR_ADDRESS</p>";}
Fred Drake6659c301998-03-03 22:02:19 +0000784 if ($t_affil) {
Fred Drakec9a44381998-03-17 06:29:13 +0000785 $the_title .= "\n<p><i>$t_affil</i></p>";}
Fred Drake6659c301998-03-03 22:02:19 +0000786 if ($t_date) {
Fred Drakec9a44381998-03-17 06:29:13 +0000787 $the_title .= "\n<p><strong>$t_date</strong>";
Fred Drake6659c301998-03-03 22:02:19 +0000788 if ($PYTHON_VERSION) {
789 $the_title .= "<br><strong>Release $PYTHON_VERSION</strong>";}
790 $the_title .= "</p>"
791 }
Fred Drakec9a44381998-03-17 06:29:13 +0000792 $the_title .= "\n</center>";
Fred Drake6659c301998-03-03 22:02:19 +0000793 if ($t_address) {
Fred Drakec9a44381998-03-17 06:29:13 +0000794 $the_title .= "\n<p>$t_address</p>";
795 } else { $the_title .= "\n<p>"}
Fred Drake6659c301998-03-03 22:02:19 +0000796 if ($t_email) {
Fred Drakec9a44381998-03-17 06:29:13 +0000797 $the_title .= "\n<p>$t_email</p>";
798 }# else { $the_title .= "</p>" }
799 $the_title . "<hr>\n" . $_ ;
Fred Drake6659c301998-03-03 22:02:19 +0000800}
801
802
Fred Drake6659c301998-03-03 22:02:19 +00008031; # This must be the last line