blob: 3a1eaa1c0fb788a013660b125679722d45c36d29 [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 Drake2e7edb81998-05-11 18:31:17 +0000287sub do_cmd_kwindex{
288 local($_) = @_;
289 my($str,$br_id) = next_argument_id();
290 #
291 my($name,$aname,$ahref) = link_info($br_id);
292 add_index_entry("<tt>$str</tt>!keyword", $ahref);
293 add_index_entry("keyword!<tt>$str</tt>", $ahref);
294 "$aname$anchor_invisible_mark</a>" . $_;
295}
296
Fred Drake6659c301998-03-03 22:02:19 +0000297sub do_cmd_indexii{
298 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000299 my($str1,$br_id) = next_argument_id();
300 my $str2 = next_argument();
Fred Drake42b31a51998-03-27 05:16:10 +0000301 #
Fred Drake08932051998-04-17 02:15:42 +0000302 my($name,$aname,$ahref) = link_info($br_id);
Fred Drake42b31a51998-03-27 05:16:10 +0000303 add_index_entry("$str1!$str2", $ahref);
304 add_index_entry("$str2!$str1", $ahref);
305 "$aname$anchor_invisible_mark</a>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000306}
307
308sub do_cmd_indexiii{
309 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000310 my($str1,$br_id) = next_argument();
311 my $str2 = next_argument();
312 my $str3 = next_argument();
Fred Drake42b31a51998-03-27 05:16:10 +0000313 #
Fred Drake08932051998-04-17 02:15:42 +0000314 my($name,$aname,$ahref) = link_info($br_id);
Fred Drake42b31a51998-03-27 05:16:10 +0000315 add_index_entry("$str1!$str2 $str3", $ahref);
316 add_index_entry("$str2!$str3, $str1", $ahref);
317 add_index_entry("$str3!$str1 $str2", $ahref);
318 "$aname$anchor_invisible_mark</a>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000319}
320
321sub do_cmd_indexiv{
322 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000323 my($str1,$br_id) = next_argument();
324 my $str2 = next_argument();
325 my $str3 = next_argument();
326 my $str4 = next_argument();
Fred Drake42b31a51998-03-27 05:16:10 +0000327 #
Fred Drake08932051998-04-17 02:15:42 +0000328 my($name,$aname,$ahref) = link_info($br_id);
Fred Drake42b31a51998-03-27 05:16:10 +0000329 add_index_entry("$str1!$str2 $str3 $str4", $ahref);
330 add_index_entry("$str2!$str3 $str4, $str1", $ahref);
331 add_index_entry("$str3!$str4, $str1 $str2", $ahref);
332 add_index_entry("$str4!$$str1 $str2 $str3", $ahref);
333 "$aname$anchor_invisible_mark</a>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000334}
335
Fred Drakec9a44381998-03-17 06:29:13 +0000336sub do_cmd_ttindex{
337 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000338 my($str,$br_id) = next_argument_id();
339 swallow_newline();
340 make_index_entry($br_id, $str . get_indexsubitem()) . $_;
Fred Drakec9a44381998-03-17 06:29:13 +0000341}
Fred Drake6659c301998-03-03 22:02:19 +0000342
343sub my_typed_index_helper{
Fred Drakec9a44381998-03-17 06:29:13 +0000344 local($word,$_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000345 my($str,$br_id) = next_argument();
346 swallow_newline();
Fred Drake42b31a51998-03-27 05:16:10 +0000347 #
348 my($name,$aname,$ahref) = link_info($br_id1);
349 add_index_entry("$str $word", $ahref);
350 add_index_entry("$word!$str", $ahref);
351 "$aname$anchor_invisible_mark</a>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000352}
353
Fred Drake08932051998-04-17 02:15:42 +0000354sub do_cmd_stindex{ my_typed_index_helper('statement', @_); }
355sub do_cmd_opindex{ my_typed_index_helper('operator', @_); }
356sub do_cmd_exindex{ my_typed_index_helper('exception', @_); }
357sub do_cmd_obindex{ my_typed_index_helper('object', @_); }
Fred Drake6659c301998-03-03 22:02:19 +0000358
359sub my_parword_index_helper{
Fred Drakec9a44381998-03-17 06:29:13 +0000360 local($word,$_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000361 my($str,$br_id) = next_argument_id();
362 swallow_newline();
Fred Drake42b31a51998-03-27 05:16:10 +0000363 make_index_entry($br_id, "$str ($word)") . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000364}
365
366
Fred Drake6659c301998-03-03 22:02:19 +0000367sub make_mod_index_entry{
Fred Drakec9a44381998-03-17 06:29:13 +0000368 my($br_id,$str,$define) = @_;
Fred Drake42b31a51998-03-27 05:16:10 +0000369 my($name,$aname,$ahref) = link_info($br_id);
Fred Drake42b31a51998-03-27 05:16:10 +0000370 # equivalent of add_index_entry() using $define instead of ''
371 $str = gen_index_id($str, $define);
372 $index{$str} .= $ahref;
Fred Drake166abba1998-04-08 23:10:54 +0000373 print IDXFILE $ahref, $IDXFILE_FIELD_SEP, $str, "\n";
Fred Drake42b31a51998-03-27 05:16:10 +0000374
Fred Drakec9a44381998-03-17 06:29:13 +0000375 if ($define eq 'DEF') {
Fred Drake42b31a51998-03-27 05:16:10 +0000376 # add to the module index
Fred Drakec9a44381998-03-17 06:29:13 +0000377 my($nstr,$garbage) = split / /, $str, 2;
Fred Drake42b31a51998-03-27 05:16:10 +0000378 $Modules{$nstr} .= $ahref;
Fred Drake6659c301998-03-03 22:02:19 +0000379 }
Fred Drake42b31a51998-03-27 05:16:10 +0000380 "$aname$anchor_invisible_mark</a>";
Fred Drake6659c301998-03-03 22:02:19 +0000381}
382
Fred Drakec9a44381998-03-17 06:29:13 +0000383$THIS_MODULE = '';
Fred Drake42b31a51998-03-27 05:16:10 +0000384$THIS_CLASS = '';
Fred Drakec9a44381998-03-17 06:29:13 +0000385
Fred Drake6659c301998-03-03 22:02:19 +0000386sub my_module_index_helper{
387 local($word, $_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000388 my($str,$br_id) = next_argument_id();
389 swallow_newline();
Fred Drakec9a44381998-03-17 06:29:13 +0000390 my $section_tag = join('', @curr_sec_id);
Fred Drake6659c301998-03-03 22:02:19 +0000391 $word = "$word " if $word;
Fred Drakec9a44381998-03-17 06:29:13 +0000392 $THIS_MODULE = "$str";
Fred Drake42b31a51998-03-27 05:16:10 +0000393 make_mod_index_entry("SECTION$section_tag",
394 "<tt>$str</tt> (${word}module)", 'DEF') . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000395}
396
397sub ref_module_index_helper{
398 local($word, $_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000399 my($str,$br_id) = next_argument();
400 swallow_newline();
Fred Drake6659c301998-03-03 22:02:19 +0000401 $word = "$word " if $word;
Fred Drake42b31a51998-03-27 05:16:10 +0000402 make_mod_index_entry($br_id, "<tt>$str</tt> (${word}module)", 'REF') . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000403}
404
Fred Drakec9a44381998-03-17 06:29:13 +0000405sub do_cmd_bifuncindex{
406 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000407 my($str,$br_id) = next_argument();
408 swallow_newline();
409 my $fname = "<tt>$str()</tt>";
Fred Drake42b31a51998-03-27 05:16:10 +0000410 make_index_entry($br_id, "$fname (built-in function)") . $_;
Fred Drakec9a44381998-03-17 06:29:13 +0000411}
412
Fred Drake42b31a51998-03-27 05:16:10 +0000413sub do_cmd_modindex{ my_module_index_helper('', @_); }
414sub do_cmd_bimodindex{ my_module_index_helper('built-in', @_); }
415sub do_cmd_exmodindex{ my_module_index_helper('extension', @_); }
416sub do_cmd_stmodindex{ my_module_index_helper('standard', @_); }
Fred Drake6659c301998-03-03 22:02:19 +0000417
418# these should be adjusted a bit....
Fred Drake42b31a51998-03-27 05:16:10 +0000419sub do_cmd_refmodindex{ ref_module_index_helper('', @_); }
420sub do_cmd_refbimodindex{ ref_module_index_helper('built-in', @_); }
421sub do_cmd_refexmodindex{ ref_module_index_helper('extension', @_); }
422sub do_cmd_refstmodindex{ ref_module_index_helper('standard', @_); }
Fred Drake6659c301998-03-03 22:02:19 +0000423
Fred Drake42b31a51998-03-27 05:16:10 +0000424sub do_cmd_nodename{ do_cmd_label(@_); }
Fred Drake6659c301998-03-03 22:02:19 +0000425
426sub init_myformat{
Fred Drake08932051998-04-17 02:15:42 +0000427# $anchor_invisible_mark = '';
Fred Drake6659c301998-03-03 22:02:19 +0000428 $anchor_mark = '';
429 $icons{'anchor_mark'} = '';
Fred Drake6659c301998-03-03 22:02:19 +0000430}
Fred Drake42b31a51998-03-27 05:16:10 +0000431init_myformat();
Fred Drake6659c301998-03-03 22:02:19 +0000432
433# similar to make_index_entry(), but includes the string in the result
434# instead of the dummy filler.
435#
436sub make_str_index_entry{
Fred Drakec9a44381998-03-17 06:29:13 +0000437 my($br_id,$str) = @_;
Fred Drake42b31a51998-03-27 05:16:10 +0000438 my($name,$aname,$ahref) = link_info($br_id);
Fred Drake42b31a51998-03-27 05:16:10 +0000439 add_index_entry($str, $ahref);
440 "$aname$str</a>";
Fred Drake6659c301998-03-03 22:02:19 +0000441}
442
Fred Drake6659c301998-03-03 22:02:19 +0000443sub do_env_cfuncdesc{
444 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000445 my $return_type = next_argument();
446 my($function_name,$br_id) = next_argument_id();
447 my $arg_list = next_argument();
448 my $idx = make_str_index_entry($br_id,
449 "<tt>$function_name()</tt>" . get_indexsubitem());
450 $idx =~ s/ \(.*\)//;
451 $idx =~ s/\(\)//; # ????
Fred Drake6659c301998-03-03 22:02:19 +0000452 "<dl><dt>$return_type <b>$idx</b>"
Fred Drake08932051998-04-17 02:15:42 +0000453 . "(<var>$arg_list</var>)\n<dd>"
454 . $_
455 . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000456}
457
458sub do_env_ctypedesc{
459 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000460 my($type_name,$br_id) = next_argument_id();
461 my $idx = make_str_index_entry($br_id,
462 "<tt>$type_name</tt>" . get_indexsubitem());
463 $idx =~ s/ \(.*\)//;
464 "<dl><dt><b>$idx</b>\n<dd>"
465 . $_
466 . '</dl>'
Fred Drake6659c301998-03-03 22:02:19 +0000467}
468
469sub do_env_cvardesc{
470 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000471 my $var_type = next_argument();
472 my($var_name,$br_id) = next_argument_id();
473 my $idx = make_str_index_entry($br_id,
474 "<tt>$var_name</tt>" . get_indexsubitem());
475 $idx =~ s/ \(.*\)//;
Fred Drake6659c301998-03-03 22:02:19 +0000476 "<dl><dt>$var_type <b>$idx</b>\n"
Fred Drake08932051998-04-17 02:15:42 +0000477 . '<dd>'
478 . $_
479 . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000480}
481
482sub do_env_funcdesc{
483 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000484 my $function_name = next_argument();
485 my($arg_list,$br_id) = next_argument_id();
486 my $idx = make_str_index_entry($br_id, "<tt>$function_name()</tt>"
487 . get_indexsubitem());
488 $idx =~ s/ \(.*\)//;
489 $idx =~ s/\(\)//;
490 "<dl><dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_ . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000491}
492
493sub do_env_funcdescni{
494 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000495 my $function_name = next_argument();
496 my $arg_list = next_argument();
497 "<dl><dt><b><tt>$function_name</tt></b> (<var>$arg_list</var>)\n<dd>"
498 . $_ . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000499}
500
501sub do_cmd_funcline{
502 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000503 my $function_name = next_argument();
504 my($arg_list,$br_id) = next_argument_id();
Fred Drake42b31a51998-03-27 05:16:10 +0000505 my $idx = make_str_index_entry($br_id, "<tt>$function_name()</tt>"
Fred Drake08932051998-04-17 02:15:42 +0000506 . get_indexsubitem());
Fred Drakec9a44381998-03-17 06:29:13 +0000507 $idx =~ s/\(\)//;
Fred Drake6659c301998-03-03 22:02:19 +0000508 "<dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_;
509}
510
511# Change this flag to index the opcode entries. I don't think it's very
512# useful to index them, since they're only presented to describe the dis
513# module.
514#
515$INDEX_OPCODES = 0;
516
517sub do_env_opcodedesc{
518 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000519 my $opcode_name = next_argument();
520 my($arg_list,$br_id) = next_argument_id();
521 my $idx;
522 if ($INDEX_OPCODES) {
523 $idx = make_str_index_entry($br_id,
Fred Drake6659c301998-03-03 22:02:19 +0000524 "<tt>$opcode_name</tt> (byte code instruction)");
Fred Drake08932051998-04-17 02:15:42 +0000525 $idx =~ s/ \(byte code instruction\)//;
526 }
527 else {
528 $idx = "<tt>$opcode_name</tt>";
529 }
530 my $stuff = "<dl><dt><b>$idx</b>";
Fred Drake6659c301998-03-03 22:02:19 +0000531 if ($arg_list) {
532 $stuff .= "&nbsp;&nbsp;&nbsp;&nbsp;<var>$arg_list</var>";
533 }
Fred Drake08932051998-04-17 02:15:42 +0000534 $stuff . "\n<dd>" . $_ . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000535}
536
537sub do_env_datadesc{
538 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000539 my($dataname,$br_id) = next_argument_id();
540 my $idx = make_str_index_entry($br_id,
541 "<tt>$dataname</tt>" . get_indexsubitem());
542 $idx =~ s/ \(.*\)//;
543 "<dl><dt><b>$idx</b>\n<dd>"
544 . $_
545 . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000546}
547
548sub do_env_datadescni{
549 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000550 my $idx = next_argument();
551 if (! $STRING_INDEX_TT) {
552 $idx = "<tt>$idx</tt>";
Fred Drake6659c301998-03-03 22:02:19 +0000553 }
Fred Drake08932051998-04-17 02:15:42 +0000554 "<dl><dt><b>$idx</b>\n<dd>" . $_ . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000555}
556
557sub do_cmd_dataline{
558 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000559 my($data_name,$br_id) = next_argument_id();
Fred Drake42b31a51998-03-27 05:16:10 +0000560 my $idx = make_str_index_entry($br_id, "<tt>$data_name</tt>"
Fred Drake08932051998-04-17 02:15:42 +0000561 . get_indexsubitem());
Fred Drake6659c301998-03-03 22:02:19 +0000562 $idx =~ s/ \(.*\)//;
Fred Drake42b31a51998-03-27 05:16:10 +0000563 "<dt><b>$idx</b><dd>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000564}
565
Fred Drake42b31a51998-03-27 05:16:10 +0000566sub do_env_excdesc{
567 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000568 my($excname,$br_id) = next_argument_id();
Fred Drake166abba1998-04-08 23:10:54 +0000569 my $idx = make_str_index_entry($br_id, "<tt>$excname</tt>");
Fred Drake08932051998-04-17 02:15:42 +0000570 "<dl><dt><b>$idx</b>\n<dd>" . $_ . '</dl>'
Fred Drake42b31a51998-03-27 05:16:10 +0000571}
572
573sub do_env_fulllineitems{ do_env_itemize(@_); }
Fred Drake6659c301998-03-03 22:02:19 +0000574
575
Fred Drakec9a44381998-03-17 06:29:13 +0000576sub do_env_classdesc{
577 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000578 $THIS_CLASS = next_argument();
579 my($arg_list,$br_id) = next_argument_id();
580 $idx = make_str_index_entry($br_id,
581 "<tt>$THIS_CLASS</tt> (class in $THIS_MODULE)" );
582 $idx =~ s/ \(.*\)//;
583 "<dl><dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_ . '</dl>';
Fred Drakec9a44381998-03-17 06:29:13 +0000584}
585
Fred Drake42b31a51998-03-27 05:16:10 +0000586
587sub do_env_methoddesc{
588 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000589 my $class_name = next_optional_argument();
590 $class_name = $THIS_CLASS
591 unless $class_name;
592 my($method_name,$br_id) = next_argument_id();
593 my $arg_list = next_argument();
594 my $extra = '';
595 if ($class_name) {
596 $extra = " ($class_name method)";
Fred Drake42b31a51998-03-27 05:16:10 +0000597 }
Fred Drake08932051998-04-17 02:15:42 +0000598 my $idx = make_str_index_entry($br_id, "<tt>$method_name()</tt>$extra");
599 $idx =~ s/ \(.*\)//;
600 $idx =~ s/\(\)//;
601 "<dl><dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_ . '</dl>';
Fred Drake42b31a51998-03-27 05:16:10 +0000602}
603
604
605sub do_env_methoddescni{
606 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000607 next_optional_argument();
608 my $method = next_argument();
609 my $arg_list = next_argument();
610 "<dl><dt><b>$method</b> (<var>$arg_list</var>)\n<dd>" . $_ . '</dl>';
Fred Drake42b31a51998-03-27 05:16:10 +0000611}
612
613
614sub do_env_memberdesc{
615 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000616 my $class = next_optional_argument();
617 my($member,$br_id) = next_argument();
Fred Drake42b31a51998-03-27 05:16:10 +0000618 $class = $THIS_CLASS
619 unless $class;
Fred Drake08932051998-04-17 02:15:42 +0000620 my $extra = '';
Fred Drake42b31a51998-03-27 05:16:10 +0000621 $extra = " ($class_name attribute)"
Fred Drakea608feb1998-04-12 03:58:13 +0000622 if (!($class eq ''));
Fred Drake08932051998-04-17 02:15:42 +0000623 my $idx = make_str_index_entry($br_id, "<tt>$member</tt>$extra");
Fred Drake42b31a51998-03-27 05:16:10 +0000624 $idx =~ s/ \(.*\)//;
625 $idx =~ s/\(\)//;
Fred Drake08932051998-04-17 02:15:42 +0000626 "<dl><dt><b>$idx</b>\n<dd>" . $_ . '</dl>';
Fred Drake42b31a51998-03-27 05:16:10 +0000627}
628
629
Fred Drake5ccf3301998-04-17 20:04:09 +0000630sub do_cmd_memberline{
631 local($_) = @_;
632 my $class = next_optional_argument();
633 my($member,$br_id) = next_argument_id();
634 $class = $THIS_CLASS
635 unless $class;
636 my $extra = '';
637 $extra = " ($class_name attribute)"
638 if (!($class eq ''));
639 my $idx = make_str_index_entry($br_id, "<tt>$member</tt>$extra");
640 $idx =~ s/ \(.*\)//;
641 $idx =~ s/\(\)//;
642 "<dt><b>$idx</b><dd>" . $_;
643}
644
Fred Drake42b31a51998-03-27 05:16:10 +0000645sub do_env_memberdescni{
646 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000647 next_optional_argument();
648 my $member = next_argument();
649 "<dl><dt><b>$member</b>\n<dd>" . $_ . '</dl>';
Fred Drake42b31a51998-03-27 05:16:10 +0000650}
651
652
Fred Drake5ccf3301998-04-17 20:04:09 +0000653sub do_cmd_memberlineni{
654 local($_) = @_;
655 next_optional_argument();
656 my $member = next_argument();
657 "<dt><b>$member</b><dd>" . $_;
658}
659
Fred Drake6659c301998-03-03 22:02:19 +0000660@col_aligns = ("<td>", "<td>", "<td>");
661
662sub setup_column_alignments{
663 local($_) = @_;
Fred Drakeee601911998-04-11 20:53:03 +0000664 my($a1,$a2,$a3) = split(/[|]/,$_);
Fred Drakec9a44381998-03-17 06:29:13 +0000665 my($th1,$th2,$th3) = ('<th>', '<th>', '<th>');
Fred Drake08932051998-04-17 02:15:42 +0000666 $col_aligns[0] = (($a1 eq 'c') ? '<td align=center>' : '<td>');
667 $col_aligns[1] = (($a2 eq 'c') ? '<td align=center>' : '<td>');
668 $col_aligns[2] = (($a3 eq 'c') ? '<td align=center>' : '<td>');
Fred Drake6659c301998-03-03 22:02:19 +0000669 # return the aligned header start tags; only used for \begin{tableiii?}
Fred Drake08932051998-04-17 02:15:42 +0000670 $th1 = (($a1 eq 'l') ? '<th align=left>'
671 : ($a1 eq 'r' ? '<th align=right>' : '<th>'));
672 $th2 = (($a2 eq 'l') ? '<th align=left>'
673 : ($a2 eq 'r' ? '<th align=right>' : '<th>'));
674 $th3 = (($a3 eq 'l') ? '<th align=left>'
675 : ($a3 eq 'r' ? '<th align=right>' : '<th>'));
Fred Drake6659c301998-03-03 22:02:19 +0000676 ($th1, $th2, $th3);
677}
678
679sub do_env_tableii{
680 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000681 my($th1,$th2,$th3) = setup_column_alignments(next_argument());
682 my $font = next_argument();
683 my $h1 = next_argument();
684 my $h2 = next_argument();
685 $font = ''
686 if ($font eq 'textrm');
687 $globals{'lineifont'} = $font;
688 '<table border align=center>'
Fred Drake6659c301998-03-03 22:02:19 +0000689 . "\n <tr>$th1<b>$h1</b></th>"
Fred Drake08932051998-04-17 02:15:42 +0000690 . "\n $th2<b>$h2</b></th>"
691 . $_
Fred Drake6659c301998-03-03 22:02:19 +0000692 . "\n</table>";
693}
694
695sub do_cmd_lineii{
696 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000697 my $c1 = next_argument();
698 my $c2 = next_argument();
699 my($font,$sfont,$efont) = ($globals{'lineifont'}, '', '');
Fred Drake58b2bfd1998-04-02 20:14:04 +0000700 if ($font) {
Fred Drake5cca42e1998-04-09 17:59:11 +0000701 $sfont = "<$font>";
Fred Drake58b2bfd1998-04-02 20:14:04 +0000702 $efont = "</$font>";
703 }
Fred Drakec9a44381998-03-17 06:29:13 +0000704 my($c1align,$c2align) = @col_aligns[0,1];
Fred Drake5cca42e1998-04-09 17:59:11 +0000705 "<tr>$c1align$sfont$c1$efont</td>\n"
Fred Drake08932051998-04-17 02:15:42 +0000706 . " $c2align$c2</td>"
707 . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000708}
709
710sub do_env_tableiii{
711 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000712 my($th1,$th2,$th3) = setup_column_alignments(next_argument());
713 my $font = next_argument();
714 my $h1 = next_argument();
715 my $h2 = next_argument();
716 my $h3 = next_argument();
717 $font = ''
718 if ($font eq 'textrm');
719 $globals{'lineifont'} = $font;
720 '<table border align=center>'
Fred Drake6659c301998-03-03 22:02:19 +0000721 . "\n <tr>$th1<b>$h1</b></th>"
722 . "\n $th2<b>$h2</b></th>"
Fred Drake08932051998-04-17 02:15:42 +0000723 . "\n $th3<b>$h3</b></th>"
724 . $_
Fred Drake6659c301998-03-03 22:02:19 +0000725 . "\n</table>";
726}
727
728sub do_cmd_lineiii{
729 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000730 my $c1 = next_argument();
731 my $c2 = next_argument();
732 my $c3 = next_argument();
733 my($font,$sfont,$efont) = ($globals{'lineifont'}, '', '');
Fred Drake58b2bfd1998-04-02 20:14:04 +0000734 if ($font) {
Fred Drake5cca42e1998-04-09 17:59:11 +0000735 $sfont = "<$font>";
Fred Drake58b2bfd1998-04-02 20:14:04 +0000736 $efont = "</$font>";
737 }
Fred Drake08932051998-04-17 02:15:42 +0000738 my($c1align,$c2align,$c3align) = @col_aligns;
Fred Drake5cca42e1998-04-09 17:59:11 +0000739 "<tr>$c1align$sfont$c1$efont</td>\n"
Fred Drake6659c301998-03-03 22:02:19 +0000740 . " $c2align$c2</td>\n"
Fred Drake08932051998-04-17 02:15:42 +0000741 . " $c3align$c3</td>"
742 . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000743}
744
745sub do_env_seealso{
746 "<p><b>See Also:</b></p>\n" . @_[0];
747}
748
749sub do_cmd_seemodule{
750 # Insert the right magic to jump to the module definition. This should
751 # work most of the time, at least for repeat builds....
752 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000753 my $key = next_optional_argument();
754 my $module = next_argument();
755 my $text = next_argument();
756 $key = $module
757 unless $key;
Fred Drakeb3c9bca1998-03-06 21:20:08 +0000758 "<p>Module <tt><b><a href=\"module-$key.html\">$module</a></b></tt>"
Fred Drake6659c301998-03-03 22:02:19 +0000759 . "&nbsp;&nbsp;&nbsp;($text)</p>"
760 . $_;
761}
762
763sub do_cmd_seetext{
Fred Drake08932051998-04-17 02:15:42 +0000764 '<p>' . @_[0];
Fred Drake6659c301998-03-03 22:02:19 +0000765}
766
767
768sub do_cmd_maketitle {
769 local($_) = @_;
Fred Drakec9a44381998-03-17 06:29:13 +0000770 my $the_title = '';
Fred Drake6659c301998-03-03 22:02:19 +0000771 if ($t_title) {
Fred Drakec9a44381998-03-17 06:29:13 +0000772 $the_title .= "<h1 align=center>$t_title</h1>";
Fred Drake08932051998-04-17 02:15:42 +0000773 } else { write_warnings("\nThis document has no title."); }
Fred Drakec9a44381998-03-17 06:29:13 +0000774 $the_title .= "\n<center>";
Fred Drake6659c301998-03-03 22:02:19 +0000775 if ($t_author) {
776 if ($t_authorURL) {
Fred Drake08932051998-04-17 02:15:42 +0000777 my $href = translate_commands($t_authorURL);
778 $href = make_named_href('author', $href, "<strong>${t_author}</strong>");
Fred Drakec9a44381998-03-17 06:29:13 +0000779 $the_title .= "\n<p>$href</p>";
Fred Drake6659c301998-03-03 22:02:19 +0000780 } else {
Fred Drakec9a44381998-03-17 06:29:13 +0000781 $the_title .= "\n<p><strong>$t_author</strong></p>";
Fred Drake6659c301998-03-03 22:02:19 +0000782 }
Fred Drake08932051998-04-17 02:15:42 +0000783 } else { write_warnings("\nThere is no author for this document."); }
Fred Drake6659c301998-03-03 22:02:19 +0000784 if ($t_institute) {
Fred Drakec9a44381998-03-17 06:29:13 +0000785 $the_title .= "\n<p>$t_institute</p>";}
Fred Drake6659c301998-03-03 22:02:19 +0000786 if ($AUTHOR_ADDRESS) {
Fred Drakec9a44381998-03-17 06:29:13 +0000787 $the_title .= "\n<p>$AUTHOR_ADDRESS</p>";}
Fred Drake6659c301998-03-03 22:02:19 +0000788 if ($t_affil) {
Fred Drakec9a44381998-03-17 06:29:13 +0000789 $the_title .= "\n<p><i>$t_affil</i></p>";}
Fred Drake6659c301998-03-03 22:02:19 +0000790 if ($t_date) {
Fred Drakec9a44381998-03-17 06:29:13 +0000791 $the_title .= "\n<p><strong>$t_date</strong>";
Fred Drake6659c301998-03-03 22:02:19 +0000792 if ($PYTHON_VERSION) {
793 $the_title .= "<br><strong>Release $PYTHON_VERSION</strong>";}
794 $the_title .= "</p>"
795 }
Fred Drakec9a44381998-03-17 06:29:13 +0000796 $the_title .= "\n</center>";
Fred Drake6659c301998-03-03 22:02:19 +0000797 if ($t_address) {
Fred Drakec9a44381998-03-17 06:29:13 +0000798 $the_title .= "\n<p>$t_address</p>";
799 } else { $the_title .= "\n<p>"}
Fred Drake6659c301998-03-03 22:02:19 +0000800 if ($t_email) {
Fred Drakec9a44381998-03-17 06:29:13 +0000801 $the_title .= "\n<p>$t_email</p>";
802 }# else { $the_title .= "</p>" }
803 $the_title . "<hr>\n" . $_ ;
Fred Drake6659c301998-03-03 22:02:19 +0000804}
805
806
Fred Drake6659c301998-03-03 22:02:19 +00008071; # This must be the last line