blob: 107ed54d5f064be53510950e4f85359b6be4f829 [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 Drakee16f6791998-05-15 04:28:37 +000058
59# This is a fairly simple hack; it supports \let when it is used to create
60# (or redefine) a macro to exactly be some other macro: \let\newname=\oldname.
Fred Drake5b73cdf1998-05-15 16:59:38 +000061# Many possible uses of \let aren't supported or aren't supported correctly.
Fred Drakee16f6791998-05-15 04:28:37 +000062#
63sub do_cmd_let{
64 local($_) = @_;
65 my $matched = 0;
Fred Drake7a4ad0f1998-05-15 13:45:54 +000066 s/[\\]([a-zA-Z]+)\s*(=\s*)?[\\]([a-zA-Z]*)/$matched=1; ''/e;
Fred Drakee16f6791998-05-15 04:28:37 +000067 if ($matched) {
68 my($new, $old) = ($1, $3);
69 eval "sub do_cmd_$new { do_cmd_$old" . '(@_); }';
70 print "\ndefining handler for \\$new using \\$old\n";
71 }
Fred Drake7a4ad0f1998-05-15 13:45:54 +000072 else {
73 s/[\\]([a-zA-Z]+)\s*(=\s*)?([^\\])/$matched=1; ''/es;
74 if ($matched) {
75 my($new, $char) = ($1, $3);
76 eval "sub do_cmd_$new { \"\\$char\" . \@_[0]; }";
77 print "\ndefining handler for \\$new to insert '$char'\n";
78 }
79 else {
80 write_warnings("Could not interpret \\let construct...");
81 }
82 }
Fred Drakee16f6791998-05-15 04:28:37 +000083 $_;
84}
85
86
Fred Drake6659c301998-03-03 22:02:19 +000087# words typeset in a special way (not in HTML though)
88
89sub do_cmd_ABC{ 'ABC' . @_[0]; }
90sub do_cmd_UNIX{ 'Unix'. @_[0]; }
91sub do_cmd_ASCII{ 'ASCII' . @_[0]; }
92sub do_cmd_POSIX{ 'POSIX' . @_[0]; }
93sub do_cmd_C{ 'C' . @_[0]; }
94sub do_cmd_Cpp{ 'C++' . @_[0]; }
95sub do_cmd_EOF{ 'EOF' . @_[0]; }
96sub do_cmd_NULL{ '<tt>NULL</tt>' . @_[0]; }
97
98sub do_cmd_e{ '&#92;' . @_[0]; }
99
Fred Draked07868a1998-05-14 21:00:28 +0000100$DEVELOPER_ADDRESS = '';
Fred Drake6659c301998-03-03 22:02:19 +0000101$PYTHON_VERSION = '';
102
103sub do_cmd_version{ $PYTHON_VERSION . @_[0]; }
104sub do_cmd_release{
105 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000106 $PYTHON_VERSION = next_argument();
Fred Drake6659c301998-03-03 22:02:19 +0000107 $_;
108}
109
110sub do_cmd_authoraddress{
111 local($_) = @_;
Fred Draked07868a1998-05-14 21:00:28 +0000112 $DEVELOPER_ADDRESS = next_argument();
Fred Drake6659c301998-03-03 22:02:19 +0000113 $_;
114}
115
Fred Drakee16f6791998-05-15 04:28:37 +0000116#sub do_cmd_developer{ do_cmd_author(@_[0]); }
117#sub do_cmd_developers{ do_cmd_author(@_[0]); }
118#sub do_cmd_developersaddress{ do_cmd_authoraddress(@_[0]); }
Fred Draked07868a1998-05-14 21:00:28 +0000119
Fred Drake6659c301998-03-03 22:02:19 +0000120sub do_cmd_hackscore{
121 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000122 next_argument();
123 '_' . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000124}
125
Fred Drake08932051998-04-17 02:15:42 +0000126sub use_wrappers{
127 local($_,$before,$after) = @_;
128 my $stuff = next_argument();
129 $before . $stuff . $after . $_;
130}
131
132sub use_current{ use_wrappers(@_[0], '', ''); }
133sub use_sans_serif{ use_wrappers(@_[0], '<font face=sans-serif>', '</font>'); }
134sub use_italics{ use_wrappers(@_[0], '<i>', '</i>'); }
135
Fred Drake6659c301998-03-03 22:02:19 +0000136sub do_cmd_optional{
Fred Drake08932051998-04-17 02:15:42 +0000137 use_wrappers(@_[0], "</var><big>\[</big><var>",
138 "</var><big>\]</big><var>");
Fred Drake6659c301998-03-03 22:02:19 +0000139}
140
Fred Drakec9a44381998-03-17 06:29:13 +0000141# Logical formatting (some based on texinfo), needs to be converted to
142# minimalist HTML. The "minimalist" is primarily to reduce the size of
143# output files for users that read them over the network rather than
144# from local repositories.
Fred Drake6659c301998-03-03 22:02:19 +0000145
Fred Drake08932051998-04-17 02:15:42 +0000146sub do_cmd_pytype{ use_current(@_); }
147sub do_cmd_makevar{ use_current(@_); }
148sub do_cmd_code{ use_wrappers(@_[0], '<tt>', '</tt>'); }
149sub do_cmd_module{ do_cmd_code(@_); }
150sub do_cmd_keyword{ do_cmd_code(@_); }
151sub do_cmd_exception{ do_cmd_code(@_); }
152sub do_cmd_class{ do_cmd_code(@_); }
153sub do_cmd_function{ do_cmd_code(@_); }
154sub do_cmd_constant{ do_cmd_code(@_); }
155sub do_cmd_member{ do_cmd_code(@_); }
156sub do_cmd_method{ do_cmd_code(@_); }
157sub do_cmd_cfunction{ do_cmd_code(@_); }
158sub do_cmd_cdata{ do_cmd_code(@_); }
159sub do_cmd_ctype{ do_cmd_code(@_); }
160sub do_cmd_regexp{ do_cmd_code(@_); }
Fred Drake08932051998-04-17 02:15:42 +0000161sub do_cmd_character{ do_cmd_samp(@_); }
162sub do_cmd_program{ do_cmd_strong(@_); }
163sub do_cmd_email{ use_sans_serif(@_); }
164sub do_cmd_mimetype{ use_sans_serif(@_); }
165sub do_cmd_var{ use_italics(@_); }
166sub do_cmd_dfn{ use_italics(@_); } # make an index entry?
167sub do_cmd_emph{ use_italics(@_); }
168sub do_cmd_file{ use_wrappers(@_[0], '"<tt>', '</tt>"'); }
169sub do_cmd_samp{ use_wrappers(@_[0], '"<tt>', '</tt>"'); }
170sub do_cmd_kbd{ use_wrappers(@_[0], '<kbd>', '</kbd>'); }
171sub do_cmd_strong{ use_wrappers(@_[0], '<b>', '</b>'); }
Fred Drakec9a44381998-03-17 06:29:13 +0000172
Fred Drake1a7af391998-04-01 22:44:56 +0000173sub do_cmd_newsgroup{
174 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000175 my $newsgroup = next_argument();
Fred Drake1a7af391998-04-01 22:44:56 +0000176 my $stuff = "<a href=\"news:$newsgroup\"><font face=sans-serif>"
177 . "$newsgroup</font></a>";
178 $stuff . $_;
179}
Fred Drakefc16e781998-03-12 21:03:26 +0000180
181sub do_cmd_envvar{
182 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000183 my($envvar,$br_id) = next_argument_id();
Fred Drake42b31a51998-03-27 05:16:10 +0000184 my($name,$aname,$ahref) = link_info($br_id);
Fred Drake166abba1998-04-08 23:10:54 +0000185 # The <tt> here is really to keep buildindex.py from making
186 # the variable name case-insensitive.
187 add_index_entry("environment variables!$envvar@<tt>\$$envvar</tt>",
188 $ahref);
Fred Drake42b31a51998-03-27 05:16:10 +0000189 add_index_entry("$envvar@\$$envvar", $ahref);
190 "$aname\$$envvar</a>" . $_;
Fred Drakefc16e781998-03-12 21:03:26 +0000191}
192
Fred Drake08932051998-04-17 02:15:42 +0000193
Fred Drake6659c301998-03-03 22:02:19 +0000194sub do_cmd_url{
195 # use the URL as both text and hyperlink
196 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000197 my $url = next_argument();
Fred Drake6659c301998-03-03 22:02:19 +0000198 $url =~ s/~/&#126;/g;
Fred Drakec9a44381998-03-17 06:29:13 +0000199 "<a href=\"$url\"><font face=sans-serif>$url</font></a>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000200}
201
202sub do_cmd_manpage{
203 # two parameters: \manpage{name}{section}
204 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000205 my $page = next_argument();
206 my $section = next_argument();
207 "<i>$page</i>($section)" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000208}
209
210sub do_cmd_rfc{
211 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000212 my($rfcnumber,$br_id) = next_argument();
Fred Drake6659c301998-03-03 22:02:19 +0000213
214 # Save the reference
Fred Drake08932051998-04-17 02:15:42 +0000215 my $nstr = gen_index_id("RFC!RFC $rfcnumber", '');
216 $index{$nstr} .= make_half_href("$CURRENT_FILE#$br_id");
Fred Drakec9a44381998-03-17 06:29:13 +0000217 "<a name=$br_id>RFC $rfcnumber</a>" .$_;
Fred Drake6659c301998-03-03 22:02:19 +0000218}
219
Fred Drake6659c301998-03-03 22:02:19 +0000220sub do_cmd_deprecated{
221 # two parameters: \deprecated{version}{whattodo}
222 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000223 my $release = next_argument();
224 my $reason = next_argument();
225 "<b>Deprecated since release $release.</b>\n$reason<p>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000226}
227
228# file and samp are at the end of this file since they screw up fontlock.
229
230# index commands
231
232$INDEX_SUBITEM = "";
233
234sub get_indexsubitem{
Fred Drakefc16e781998-03-12 21:03:26 +0000235 #$INDEX_SUBITEM ? " $INDEX_SUBITEM" : '';
236 '';
Fred Drake6659c301998-03-03 22:02:19 +0000237}
238
239sub do_cmd_setindexsubitem{
240 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000241 $INDEX_SUBITEM = next_argument();
Fred Drake6659c301998-03-03 22:02:19 +0000242 $_;
243}
244
Fred Drakefc16e781998-03-12 21:03:26 +0000245sub do_cmd_withsubitem{
246 # We can't really do the right right thing, because LaTeX2HTML doesn't
247 # do things in the right order, but we need to at least strip this stuff
248 # out, and leave anything that the second argument expanded out to.
249 #
250 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000251 next_argument();
252 my $stuff = next_argument();
253 $stuff . $_;
Fred Drakefc16e781998-03-12 21:03:26 +0000254}
255
Fred Drake08932051998-04-17 02:15:42 +0000256# This is the prologue macro which is required to start writing the
257# mod\jobname.idx file; we can just ignore it.
258#
Fred Drakefc16e781998-03-12 21:03:26 +0000259sub do_cmd_makemodindex{ @_[0]; }
260
Fred Drake42b31a51998-03-27 05:16:10 +0000261# We're in the document subdirectory when this happens!
Fred Drake166abba1998-04-08 23:10:54 +0000262#
Fred Drake08932051998-04-17 02:15:42 +0000263open(IDXFILE, '>index.dat') || die "\n$!\n";
264open(INTLABELS, '>intlabels.pl') || die "\n$!\n";
Fred Drake166abba1998-04-08 23:10:54 +0000265print INTLABELS "%internal_labels = ();\n";
266print INTLABELS "1; # hack in case there are no entries\n\n";
267
268# Using \0 for this is bad because we can't use common tools to work with the
269# resulting files. Things like grep can be useful with this stuff!
270#
271$IDXFILE_FIELD_SEP = "\1";
272
Fred Drake42b31a51998-03-27 05:16:10 +0000273
274sub gen_target_name{
275 "l2h-" . @_[0];
276}
277
278sub gen_target{
Fred Drake08932051998-04-17 02:15:42 +0000279 '<a name="' . @_[0] . '">';
Fred Drake42b31a51998-03-27 05:16:10 +0000280}
281
282sub gen_link{
283 my($node,$target) = @_;
284 print INTLABELS "\$internal_labels{\"$target\"} = \"$URL/$node\";\n";
285 "<a href=\"$node#$target\">";
286}
287
288sub make_index_entry{
289 my($br_id,$str) = @_;
290 my($name,$aname,$ahref) = link_info($br_id);
291 add_index_entry($str, $ahref);
292 "$aname$anchor_invisible_mark</a>";
293}
294
295sub add_index_entry{
296 # add an entry to the index structures; ignore the return value
297 my($str,$ahref) = @_;
298 $str = gen_index_id($str, '');
299 $index{$str} .= $ahref;
Fred Drake166abba1998-04-08 23:10:54 +0000300 print IDXFILE $ahref, $IDXFILE_FIELD_SEP, $str, "\n";
Fred Drake42b31a51998-03-27 05:16:10 +0000301}
302
303sub link_info{
304 my $name = gen_target_name(@_[0]);
305 my $aname = gen_target($name);
306 my $ahref = gen_link($CURRENT_FILE, $name);
307 return ($name, $aname, $ahref);
308}
309
310sub do_cmd_index{
311 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000312 my($str,$br_id) = next_argument_id();
313 swallow_newline();
Fred Drake42b31a51998-03-27 05:16:10 +0000314 #
315 my($name,$aname,$ahref) = link_info($br_id);
316 add_index_entry("$str", $ahref);
317 "$aname$anchor_invisible_mark</a>" . $_;
318}
319
Fred Drake2e7edb81998-05-11 18:31:17 +0000320sub do_cmd_kwindex{
321 local($_) = @_;
322 my($str,$br_id) = next_argument_id();
323 #
324 my($name,$aname,$ahref) = link_info($br_id);
325 add_index_entry("<tt>$str</tt>!keyword", $ahref);
326 add_index_entry("keyword!<tt>$str</tt>", $ahref);
327 "$aname$anchor_invisible_mark</a>" . $_;
328}
329
Fred Drake6659c301998-03-03 22:02:19 +0000330sub do_cmd_indexii{
331 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000332 my($str1,$br_id) = next_argument_id();
333 my $str2 = next_argument();
Fred Drake42b31a51998-03-27 05:16:10 +0000334 #
Fred Drake08932051998-04-17 02:15:42 +0000335 my($name,$aname,$ahref) = link_info($br_id);
Fred Drake42b31a51998-03-27 05:16:10 +0000336 add_index_entry("$str1!$str2", $ahref);
337 add_index_entry("$str2!$str1", $ahref);
338 "$aname$anchor_invisible_mark</a>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000339}
340
341sub do_cmd_indexiii{
342 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000343 my($str1,$br_id) = next_argument();
344 my $str2 = next_argument();
345 my $str3 = next_argument();
Fred Drake42b31a51998-03-27 05:16:10 +0000346 #
Fred Drake08932051998-04-17 02:15:42 +0000347 my($name,$aname,$ahref) = link_info($br_id);
Fred Drake42b31a51998-03-27 05:16:10 +0000348 add_index_entry("$str1!$str2 $str3", $ahref);
349 add_index_entry("$str2!$str3, $str1", $ahref);
350 add_index_entry("$str3!$str1 $str2", $ahref);
351 "$aname$anchor_invisible_mark</a>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000352}
353
354sub do_cmd_indexiv{
355 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000356 my($str1,$br_id) = next_argument();
357 my $str2 = next_argument();
358 my $str3 = next_argument();
359 my $str4 = next_argument();
Fred Drake42b31a51998-03-27 05:16:10 +0000360 #
Fred Drake08932051998-04-17 02:15:42 +0000361 my($name,$aname,$ahref) = link_info($br_id);
Fred Drake42b31a51998-03-27 05:16:10 +0000362 add_index_entry("$str1!$str2 $str3 $str4", $ahref);
363 add_index_entry("$str2!$str3 $str4, $str1", $ahref);
364 add_index_entry("$str3!$str4, $str1 $str2", $ahref);
365 add_index_entry("$str4!$$str1 $str2 $str3", $ahref);
366 "$aname$anchor_invisible_mark</a>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000367}
368
Fred Drakec9a44381998-03-17 06:29:13 +0000369sub do_cmd_ttindex{
370 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000371 my($str,$br_id) = next_argument_id();
372 swallow_newline();
373 make_index_entry($br_id, $str . get_indexsubitem()) . $_;
Fred Drakec9a44381998-03-17 06:29:13 +0000374}
Fred Drake6659c301998-03-03 22:02:19 +0000375
376sub my_typed_index_helper{
Fred Drakec9a44381998-03-17 06:29:13 +0000377 local($word,$_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000378 my($str,$br_id) = next_argument();
379 swallow_newline();
Fred Drake42b31a51998-03-27 05:16:10 +0000380 #
381 my($name,$aname,$ahref) = link_info($br_id1);
382 add_index_entry("$str $word", $ahref);
383 add_index_entry("$word!$str", $ahref);
384 "$aname$anchor_invisible_mark</a>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000385}
386
Fred Drake08932051998-04-17 02:15:42 +0000387sub do_cmd_stindex{ my_typed_index_helper('statement', @_); }
388sub do_cmd_opindex{ my_typed_index_helper('operator', @_); }
389sub do_cmd_exindex{ my_typed_index_helper('exception', @_); }
390sub do_cmd_obindex{ my_typed_index_helper('object', @_); }
Fred Drake6659c301998-03-03 22:02:19 +0000391
392sub my_parword_index_helper{
Fred Drakec9a44381998-03-17 06:29:13 +0000393 local($word,$_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000394 my($str,$br_id) = next_argument_id();
395 swallow_newline();
Fred Drake42b31a51998-03-27 05:16:10 +0000396 make_index_entry($br_id, "$str ($word)") . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000397}
398
399
Fred Drake6659c301998-03-03 22:02:19 +0000400sub make_mod_index_entry{
Fred Drakec9a44381998-03-17 06:29:13 +0000401 my($br_id,$str,$define) = @_;
Fred Drake42b31a51998-03-27 05:16:10 +0000402 my($name,$aname,$ahref) = link_info($br_id);
Fred Drake42b31a51998-03-27 05:16:10 +0000403 # equivalent of add_index_entry() using $define instead of ''
404 $str = gen_index_id($str, $define);
405 $index{$str} .= $ahref;
Fred Drake166abba1998-04-08 23:10:54 +0000406 print IDXFILE $ahref, $IDXFILE_FIELD_SEP, $str, "\n";
Fred Drake42b31a51998-03-27 05:16:10 +0000407
Fred Drakec9a44381998-03-17 06:29:13 +0000408 if ($define eq 'DEF') {
Fred Drake42b31a51998-03-27 05:16:10 +0000409 # add to the module index
Fred Drakec9a44381998-03-17 06:29:13 +0000410 my($nstr,$garbage) = split / /, $str, 2;
Fred Drake42b31a51998-03-27 05:16:10 +0000411 $Modules{$nstr} .= $ahref;
Fred Drake6659c301998-03-03 22:02:19 +0000412 }
Fred Drake42b31a51998-03-27 05:16:10 +0000413 "$aname$anchor_invisible_mark</a>";
Fred Drake6659c301998-03-03 22:02:19 +0000414}
415
Fred Drakec9a44381998-03-17 06:29:13 +0000416$THIS_MODULE = '';
Fred Drake42b31a51998-03-27 05:16:10 +0000417$THIS_CLASS = '';
Fred Drakec9a44381998-03-17 06:29:13 +0000418
Fred Drakea0f4c941998-07-24 22:16:04 +0000419sub define_module{
420 my($word,$name) = @_;
Fred Drakec9a44381998-03-17 06:29:13 +0000421 my $section_tag = join('', @curr_sec_id);
Fred Drake6659c301998-03-03 22:02:19 +0000422 $word = "$word " if $word;
Fred Drakea0f4c941998-07-24 22:16:04 +0000423 $THIS_MODULE = "$name";
Fred Drake42b31a51998-03-27 05:16:10 +0000424 make_mod_index_entry("SECTION$section_tag",
Fred Drakea0f4c941998-07-24 22:16:04 +0000425 "<tt>$name</tt> (${word}module)", 'DEF');
426}
427
428sub my_module_index_helper{
429 local($word, $_) = @_;
430 my $name = next_argument();
431 swallow_newline();
432 define_module($word, $name) . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000433}
434
435sub ref_module_index_helper{
436 local($word, $_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000437 my($str,$br_id) = next_argument();
438 swallow_newline();
Fred Drake6659c301998-03-03 22:02:19 +0000439 $word = "$word " if $word;
Fred Drake42b31a51998-03-27 05:16:10 +0000440 make_mod_index_entry($br_id, "<tt>$str</tt> (${word}module)", 'REF') . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000441}
442
Fred Drakec9a44381998-03-17 06:29:13 +0000443sub do_cmd_bifuncindex{
444 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000445 my($str,$br_id) = next_argument();
446 swallow_newline();
447 my $fname = "<tt>$str()</tt>";
Fred Drake42b31a51998-03-27 05:16:10 +0000448 make_index_entry($br_id, "$fname (built-in function)") . $_;
Fred Drakec9a44381998-03-17 06:29:13 +0000449}
450
Fred Drake42b31a51998-03-27 05:16:10 +0000451sub do_cmd_modindex{ my_module_index_helper('', @_); }
452sub do_cmd_bimodindex{ my_module_index_helper('built-in', @_); }
453sub do_cmd_exmodindex{ my_module_index_helper('extension', @_); }
454sub do_cmd_stmodindex{ my_module_index_helper('standard', @_); }
Fred Drake6659c301998-03-03 22:02:19 +0000455
456# these should be adjusted a bit....
Fred Drake42b31a51998-03-27 05:16:10 +0000457sub do_cmd_refmodindex{ ref_module_index_helper('', @_); }
458sub do_cmd_refbimodindex{ ref_module_index_helper('built-in', @_); }
459sub do_cmd_refexmodindex{ ref_module_index_helper('extension', @_); }
460sub do_cmd_refstmodindex{ ref_module_index_helper('standard', @_); }
Fred Drake6659c301998-03-03 22:02:19 +0000461
Fred Drake42b31a51998-03-27 05:16:10 +0000462sub do_cmd_nodename{ do_cmd_label(@_); }
Fred Drake6659c301998-03-03 22:02:19 +0000463
464sub init_myformat{
Fred Drake08932051998-04-17 02:15:42 +0000465# $anchor_invisible_mark = '';
Fred Drake6659c301998-03-03 22:02:19 +0000466 $anchor_mark = '';
467 $icons{'anchor_mark'} = '';
Fred Drake6659c301998-03-03 22:02:19 +0000468}
Fred Drake42b31a51998-03-27 05:16:10 +0000469init_myformat();
Fred Drake6659c301998-03-03 22:02:19 +0000470
471# similar to make_index_entry(), but includes the string in the result
472# instead of the dummy filler.
473#
474sub make_str_index_entry{
Fred Drakec9a44381998-03-17 06:29:13 +0000475 my($br_id,$str) = @_;
Fred Drake42b31a51998-03-27 05:16:10 +0000476 my($name,$aname,$ahref) = link_info($br_id);
Fred Drake42b31a51998-03-27 05:16:10 +0000477 add_index_entry($str, $ahref);
478 "$aname$str</a>";
Fred Drake6659c301998-03-03 22:02:19 +0000479}
480
Fred Drake6659c301998-03-03 22:02:19 +0000481sub do_env_cfuncdesc{
482 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000483 my $return_type = next_argument();
484 my($function_name,$br_id) = next_argument_id();
485 my $arg_list = next_argument();
486 my $idx = make_str_index_entry($br_id,
487 "<tt>$function_name()</tt>" . get_indexsubitem());
488 $idx =~ s/ \(.*\)//;
489 $idx =~ s/\(\)//; # ????
Fred Drake6659c301998-03-03 22:02:19 +0000490 "<dl><dt>$return_type <b>$idx</b>"
Fred Drake08932051998-04-17 02:15:42 +0000491 . "(<var>$arg_list</var>)\n<dd>"
492 . $_
493 . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000494}
495
496sub do_env_ctypedesc{
497 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000498 my($type_name,$br_id) = next_argument_id();
499 my $idx = make_str_index_entry($br_id,
500 "<tt>$type_name</tt>" . get_indexsubitem());
501 $idx =~ s/ \(.*\)//;
502 "<dl><dt><b>$idx</b>\n<dd>"
503 . $_
504 . '</dl>'
Fred Drake6659c301998-03-03 22:02:19 +0000505}
506
507sub do_env_cvardesc{
508 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000509 my $var_type = next_argument();
510 my($var_name,$br_id) = next_argument_id();
511 my $idx = make_str_index_entry($br_id,
512 "<tt>$var_name</tt>" . get_indexsubitem());
513 $idx =~ s/ \(.*\)//;
Fred Drake6659c301998-03-03 22:02:19 +0000514 "<dl><dt>$var_type <b>$idx</b>\n"
Fred Drake08932051998-04-17 02:15:42 +0000515 . '<dd>'
516 . $_
517 . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000518}
519
520sub do_env_funcdesc{
521 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000522 my $function_name = next_argument();
523 my($arg_list,$br_id) = next_argument_id();
524 my $idx = make_str_index_entry($br_id, "<tt>$function_name()</tt>"
525 . get_indexsubitem());
526 $idx =~ s/ \(.*\)//;
527 $idx =~ s/\(\)//;
528 "<dl><dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_ . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000529}
530
531sub do_env_funcdescni{
532 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000533 my $function_name = next_argument();
534 my $arg_list = next_argument();
535 "<dl><dt><b><tt>$function_name</tt></b> (<var>$arg_list</var>)\n<dd>"
536 . $_ . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000537}
538
539sub do_cmd_funcline{
540 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000541 my $function_name = next_argument();
542 my($arg_list,$br_id) = next_argument_id();
Fred Drake42b31a51998-03-27 05:16:10 +0000543 my $idx = make_str_index_entry($br_id, "<tt>$function_name()</tt>"
Fred Drake08932051998-04-17 02:15:42 +0000544 . get_indexsubitem());
Fred Drakec9a44381998-03-17 06:29:13 +0000545 $idx =~ s/\(\)//;
Fred Drake6659c301998-03-03 22:02:19 +0000546 "<dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_;
547}
548
549# Change this flag to index the opcode entries. I don't think it's very
550# useful to index them, since they're only presented to describe the dis
551# module.
552#
553$INDEX_OPCODES = 0;
554
555sub do_env_opcodedesc{
556 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000557 my $opcode_name = next_argument();
558 my($arg_list,$br_id) = next_argument_id();
559 my $idx;
560 if ($INDEX_OPCODES) {
561 $idx = make_str_index_entry($br_id,
Fred Drake6659c301998-03-03 22:02:19 +0000562 "<tt>$opcode_name</tt> (byte code instruction)");
Fred Drake08932051998-04-17 02:15:42 +0000563 $idx =~ s/ \(byte code instruction\)//;
564 }
565 else {
566 $idx = "<tt>$opcode_name</tt>";
567 }
568 my $stuff = "<dl><dt><b>$idx</b>";
Fred Drake6659c301998-03-03 22:02:19 +0000569 if ($arg_list) {
570 $stuff .= "&nbsp;&nbsp;&nbsp;&nbsp;<var>$arg_list</var>";
571 }
Fred Drake08932051998-04-17 02:15:42 +0000572 $stuff . "\n<dd>" . $_ . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000573}
574
575sub do_env_datadesc{
576 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000577 my($dataname,$br_id) = next_argument_id();
578 my $idx = make_str_index_entry($br_id,
579 "<tt>$dataname</tt>" . get_indexsubitem());
580 $idx =~ s/ \(.*\)//;
581 "<dl><dt><b>$idx</b>\n<dd>"
582 . $_
583 . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000584}
585
586sub do_env_datadescni{
587 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000588 my $idx = next_argument();
589 if (! $STRING_INDEX_TT) {
590 $idx = "<tt>$idx</tt>";
Fred Drake6659c301998-03-03 22:02:19 +0000591 }
Fred Drake08932051998-04-17 02:15:42 +0000592 "<dl><dt><b>$idx</b>\n<dd>" . $_ . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000593}
594
595sub do_cmd_dataline{
596 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000597 my($data_name,$br_id) = next_argument_id();
Fred Drake42b31a51998-03-27 05:16:10 +0000598 my $idx = make_str_index_entry($br_id, "<tt>$data_name</tt>"
Fred Drake08932051998-04-17 02:15:42 +0000599 . get_indexsubitem());
Fred Drake6659c301998-03-03 22:02:19 +0000600 $idx =~ s/ \(.*\)//;
Fred Drake42b31a51998-03-27 05:16:10 +0000601 "<dt><b>$idx</b><dd>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000602}
603
Fred Drake42b31a51998-03-27 05:16:10 +0000604sub do_env_excdesc{
605 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000606 my($excname,$br_id) = next_argument_id();
Fred Drake166abba1998-04-08 23:10:54 +0000607 my $idx = make_str_index_entry($br_id, "<tt>$excname</tt>");
Fred Drake08932051998-04-17 02:15:42 +0000608 "<dl><dt><b>$idx</b>\n<dd>" . $_ . '</dl>'
Fred Drake42b31a51998-03-27 05:16:10 +0000609}
610
611sub do_env_fulllineitems{ do_env_itemize(@_); }
Fred Drake6659c301998-03-03 22:02:19 +0000612
613
Fred Drakec9a44381998-03-17 06:29:13 +0000614sub do_env_classdesc{
615 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000616 $THIS_CLASS = next_argument();
617 my($arg_list,$br_id) = next_argument_id();
618 $idx = make_str_index_entry($br_id,
619 "<tt>$THIS_CLASS</tt> (class in $THIS_MODULE)" );
620 $idx =~ s/ \(.*\)//;
621 "<dl><dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_ . '</dl>';
Fred Drakec9a44381998-03-17 06:29:13 +0000622}
623
Fred Drake42b31a51998-03-27 05:16:10 +0000624
625sub do_env_methoddesc{
626 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000627 my $class_name = next_optional_argument();
628 $class_name = $THIS_CLASS
629 unless $class_name;
630 my($method_name,$br_id) = next_argument_id();
631 my $arg_list = next_argument();
632 my $extra = '';
633 if ($class_name) {
634 $extra = " ($class_name method)";
Fred Drake42b31a51998-03-27 05:16:10 +0000635 }
Fred Drake08932051998-04-17 02:15:42 +0000636 my $idx = make_str_index_entry($br_id, "<tt>$method_name()</tt>$extra");
637 $idx =~ s/ \(.*\)//;
638 $idx =~ s/\(\)//;
639 "<dl><dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_ . '</dl>';
Fred Drake42b31a51998-03-27 05:16:10 +0000640}
641
642
643sub do_env_methoddescni{
644 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000645 next_optional_argument();
646 my $method = next_argument();
647 my $arg_list = next_argument();
648 "<dl><dt><b>$method</b> (<var>$arg_list</var>)\n<dd>" . $_ . '</dl>';
Fred Drake42b31a51998-03-27 05:16:10 +0000649}
650
651
652sub do_env_memberdesc{
653 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000654 my $class = next_optional_argument();
655 my($member,$br_id) = next_argument();
Fred Drake42b31a51998-03-27 05:16:10 +0000656 $class = $THIS_CLASS
657 unless $class;
Fred Drake08932051998-04-17 02:15:42 +0000658 my $extra = '';
Fred Drake42b31a51998-03-27 05:16:10 +0000659 $extra = " ($class_name attribute)"
Fred Drakea608feb1998-04-12 03:58:13 +0000660 if (!($class eq ''));
Fred Drake08932051998-04-17 02:15:42 +0000661 my $idx = make_str_index_entry($br_id, "<tt>$member</tt>$extra");
Fred Drake42b31a51998-03-27 05:16:10 +0000662 $idx =~ s/ \(.*\)//;
663 $idx =~ s/\(\)//;
Fred Drake08932051998-04-17 02:15:42 +0000664 "<dl><dt><b>$idx</b>\n<dd>" . $_ . '</dl>';
Fred Drake42b31a51998-03-27 05:16:10 +0000665}
666
667
Fred Drake5ccf3301998-04-17 20:04:09 +0000668sub do_cmd_memberline{
669 local($_) = @_;
670 my $class = next_optional_argument();
671 my($member,$br_id) = next_argument_id();
672 $class = $THIS_CLASS
673 unless $class;
674 my $extra = '';
675 $extra = " ($class_name attribute)"
676 if (!($class eq ''));
677 my $idx = make_str_index_entry($br_id, "<tt>$member</tt>$extra");
678 $idx =~ s/ \(.*\)//;
679 $idx =~ s/\(\)//;
680 "<dt><b>$idx</b><dd>" . $_;
681}
682
Fred Drake42b31a51998-03-27 05:16:10 +0000683sub do_env_memberdescni{
684 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000685 next_optional_argument();
686 my $member = next_argument();
687 "<dl><dt><b>$member</b>\n<dd>" . $_ . '</dl>';
Fred Drake42b31a51998-03-27 05:16:10 +0000688}
689
690
Fred Drake5ccf3301998-04-17 20:04:09 +0000691sub do_cmd_memberlineni{
692 local($_) = @_;
693 next_optional_argument();
694 my $member = next_argument();
695 "<dt><b>$member</b><dd>" . $_;
696}
697
Fred Drakea0f4c941998-07-24 22:16:04 +0000698@col_aligns = ("<td>", "<td>", "<td>", "<td>");
Fred Drake6659c301998-03-03 22:02:19 +0000699
700sub setup_column_alignments{
701 local($_) = @_;
Fred Drakea0f4c941998-07-24 22:16:04 +0000702 my($a1,$a2,$a3,$a4) = split(/[|]/,$_);
703 my($th1,$th2,$th3,$th4) = ('<th>', '<th>', '<th>', '<th>');
Fred Drake08932051998-04-17 02:15:42 +0000704 $col_aligns[0] = (($a1 eq 'c') ? '<td align=center>' : '<td>');
705 $col_aligns[1] = (($a2 eq 'c') ? '<td align=center>' : '<td>');
706 $col_aligns[2] = (($a3 eq 'c') ? '<td align=center>' : '<td>');
Fred Drakea0f4c941998-07-24 22:16:04 +0000707 $col_aligns[3] = (($a4 eq 'c') ? '<td align=center>' : '<td>');
Fred Drake6659c301998-03-03 22:02:19 +0000708 # return the aligned header start tags; only used for \begin{tableiii?}
Fred Drake08932051998-04-17 02:15:42 +0000709 $th1 = (($a1 eq 'l') ? '<th align=left>'
710 : ($a1 eq 'r' ? '<th align=right>' : '<th>'));
711 $th2 = (($a2 eq 'l') ? '<th align=left>'
712 : ($a2 eq 'r' ? '<th align=right>' : '<th>'));
713 $th3 = (($a3 eq 'l') ? '<th align=left>'
714 : ($a3 eq 'r' ? '<th align=right>' : '<th>'));
Fred Drakea0f4c941998-07-24 22:16:04 +0000715 $th4 = (($a4 eq 'l') ? '<th align=left>'
716 : ($a4 eq 'r' ? '<th align=right>' : '<th>'));
717 ($th1, $th2, $th3, $th4);
Fred Drake6659c301998-03-03 22:02:19 +0000718}
719
720sub do_env_tableii{
721 local($_) = @_;
Fred Drakea0f4c941998-07-24 22:16:04 +0000722 my($th1,$th2,$th3,$th4) = setup_column_alignments(next_argument());
Fred Drake08932051998-04-17 02:15:42 +0000723 my $font = next_argument();
724 my $h1 = next_argument();
725 my $h2 = next_argument();
726 $font = ''
727 if ($font eq 'textrm');
728 $globals{'lineifont'} = $font;
729 '<table border align=center>'
Fred Drake6659c301998-03-03 22:02:19 +0000730 . "\n <tr>$th1<b>$h1</b></th>"
Fred Drake08932051998-04-17 02:15:42 +0000731 . "\n $th2<b>$h2</b></th>"
732 . $_
Fred Drake6659c301998-03-03 22:02:19 +0000733 . "\n</table>";
734}
735
736sub do_cmd_lineii{
737 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000738 my $c1 = next_argument();
739 my $c2 = next_argument();
740 my($font,$sfont,$efont) = ($globals{'lineifont'}, '', '');
Fred Drake58b2bfd1998-04-02 20:14:04 +0000741 if ($font) {
Fred Drake5cca42e1998-04-09 17:59:11 +0000742 $sfont = "<$font>";
Fred Drake58b2bfd1998-04-02 20:14:04 +0000743 $efont = "</$font>";
744 }
Fred Drakec9a44381998-03-17 06:29:13 +0000745 my($c1align,$c2align) = @col_aligns[0,1];
Fred Drake5cca42e1998-04-09 17:59:11 +0000746 "<tr>$c1align$sfont$c1$efont</td>\n"
Fred Drake08932051998-04-17 02:15:42 +0000747 . " $c2align$c2</td>"
748 . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000749}
750
751sub do_env_tableiii{
752 local($_) = @_;
Fred Drakea0f4c941998-07-24 22:16:04 +0000753 my($th1,$th2,$th3,$th4) = setup_column_alignments(next_argument());
Fred Drake08932051998-04-17 02:15:42 +0000754 my $font = next_argument();
755 my $h1 = next_argument();
756 my $h2 = next_argument();
757 my $h3 = next_argument();
758 $font = ''
759 if ($font eq 'textrm');
760 $globals{'lineifont'} = $font;
761 '<table border align=center>'
Fred Drake6659c301998-03-03 22:02:19 +0000762 . "\n <tr>$th1<b>$h1</b></th>"
763 . "\n $th2<b>$h2</b></th>"
Fred Drake08932051998-04-17 02:15:42 +0000764 . "\n $th3<b>$h3</b></th>"
765 . $_
Fred Drake6659c301998-03-03 22:02:19 +0000766 . "\n</table>";
767}
768
769sub do_cmd_lineiii{
770 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000771 my $c1 = next_argument();
772 my $c2 = next_argument();
773 my $c3 = next_argument();
774 my($font,$sfont,$efont) = ($globals{'lineifont'}, '', '');
Fred Drake58b2bfd1998-04-02 20:14:04 +0000775 if ($font) {
Fred Drake5cca42e1998-04-09 17:59:11 +0000776 $sfont = "<$font>";
Fred Drake58b2bfd1998-04-02 20:14:04 +0000777 $efont = "</$font>";
778 }
Fred Drakea0f4c941998-07-24 22:16:04 +0000779 my($c1align,$c2align,$c3align) = @col_aligns[0,1,2];
Fred Drake5cca42e1998-04-09 17:59:11 +0000780 "<tr>$c1align$sfont$c1$efont</td>\n"
Fred Drake6659c301998-03-03 22:02:19 +0000781 . " $c2align$c2</td>\n"
Fred Drake08932051998-04-17 02:15:42 +0000782 . " $c3align$c3</td>"
783 . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000784}
785
Fred Drakea0f4c941998-07-24 22:16:04 +0000786sub do_env_tableiv{
787 local($_) = @_;
788 my($th1,$th2,$th3,$th4) = setup_column_alignments(next_argument());
789 my $font = next_argument();
790 my $h1 = next_argument();
791 my $h2 = next_argument();
792 my $h3 = next_argument();
793 my $h4 = next_argument();
794 $font = ''
795 if ($font eq 'textrm');
796 $globals{'lineifont'} = $font;
797 '<table border align=center>'
798 . "\n <tr>$th1<b>$h1</b></th>"
799 . "\n $th2<b>$h2</b></th>"
800 . "\n $th3<b>$h3</b></th>"
801 . "\n $th4<b>$h4</b></th>"
802 . $_
803 . "\n</table>";
Fred Drake6659c301998-03-03 22:02:19 +0000804}
805
Fred Drakea0f4c941998-07-24 22:16:04 +0000806sub do_cmd_lineiv{
Fred Drake6659c301998-03-03 22:02:19 +0000807 local($_) = @_;
Fred Drakea0f4c941998-07-24 22:16:04 +0000808 my $c1 = next_argument();
809 my $c2 = next_argument();
810 my $c3 = next_argument();
811 my $c4 = next_argument();
812 my($font,$sfont,$efont) = ($globals{'lineifont'}, '', '');
813 if ($font) {
814 $sfont = "<$font>";
815 $efont = "</$font>";
816 }
817 my($c1align,$c2align,$c3align,$c4align) = @col_aligns;
818 "<tr>$c1align$sfont$c1$efont</td>\n"
819 . " $c2align$c2</td>\n"
820 . " $c3align$c3</td>\n"
821 . " $c4align$c4</td>"
Fred Drake6659c301998-03-03 22:02:19 +0000822 . $_;
823}
824
Fred Drake6659c301998-03-03 22:02:19 +0000825sub do_cmd_maketitle {
826 local($_) = @_;
Fred Drakec9a44381998-03-17 06:29:13 +0000827 my $the_title = '';
Fred Drake6659c301998-03-03 22:02:19 +0000828 if ($t_title) {
Fred Drakec9a44381998-03-17 06:29:13 +0000829 $the_title .= "<h1 align=center>$t_title</h1>";
Fred Drake08932051998-04-17 02:15:42 +0000830 } else { write_warnings("\nThis document has no title."); }
Fred Drakec9a44381998-03-17 06:29:13 +0000831 $the_title .= "\n<center>";
Fred Drake6659c301998-03-03 22:02:19 +0000832 if ($t_author) {
833 if ($t_authorURL) {
Fred Drake08932051998-04-17 02:15:42 +0000834 my $href = translate_commands($t_authorURL);
835 $href = make_named_href('author', $href, "<strong>${t_author}</strong>");
Fred Drakec9a44381998-03-17 06:29:13 +0000836 $the_title .= "\n<p>$href</p>";
Fred Drake6659c301998-03-03 22:02:19 +0000837 } else {
Fred Drakec9a44381998-03-17 06:29:13 +0000838 $the_title .= "\n<p><strong>$t_author</strong></p>";
Fred Drake6659c301998-03-03 22:02:19 +0000839 }
Fred Drake08932051998-04-17 02:15:42 +0000840 } else { write_warnings("\nThere is no author for this document."); }
Fred Drake6659c301998-03-03 22:02:19 +0000841 if ($t_institute) {
Fred Drakec9a44381998-03-17 06:29:13 +0000842 $the_title .= "\n<p>$t_institute</p>";}
Fred Draked07868a1998-05-14 21:00:28 +0000843 if ($DEVELOPER_ADDRESS) {
844 $the_title .= "\n<p>$DEVELOPER_ADDRESS</p>";}
Fred Drake6659c301998-03-03 22:02:19 +0000845 if ($t_affil) {
Fred Drakec9a44381998-03-17 06:29:13 +0000846 $the_title .= "\n<p><i>$t_affil</i></p>";}
Fred Drake6659c301998-03-03 22:02:19 +0000847 if ($t_date) {
Fred Drakec9a44381998-03-17 06:29:13 +0000848 $the_title .= "\n<p><strong>$t_date</strong>";
Fred Drake6659c301998-03-03 22:02:19 +0000849 if ($PYTHON_VERSION) {
850 $the_title .= "<br><strong>Release $PYTHON_VERSION</strong>";}
851 $the_title .= "</p>"
852 }
Fred Drakec9a44381998-03-17 06:29:13 +0000853 $the_title .= "\n</center>";
Fred Drake6659c301998-03-03 22:02:19 +0000854 if ($t_address) {
Fred Drakec9a44381998-03-17 06:29:13 +0000855 $the_title .= "\n<p>$t_address</p>";
856 } else { $the_title .= "\n<p>"}
Fred Drake6659c301998-03-03 22:02:19 +0000857 if ($t_email) {
Fred Drakec9a44381998-03-17 06:29:13 +0000858 $the_title .= "\n<p>$t_email</p>";
859 }# else { $the_title .= "</p>" }
860 $the_title . "<hr>\n" . $_ ;
Fred Drake6659c301998-03-03 22:02:19 +0000861}
862
863
Fred Drake885215c1998-05-20 21:32:09 +0000864#
Fred Drakea0f4c941998-07-24 22:16:04 +0000865# Module synopsis support
866#
867
868require SynopsisTable;
869
Fred Drakef7685d71998-07-25 03:31:46 +0000870sub get_chapter_id(){
871 my $id = do_cmd_thechapter('');
872 $id =~ s/<SPAN CLASS="arabic">(\d+)<\/SPAN>\./\1/;
873 return $id;
Fred Drakea0f4c941998-07-24 22:16:04 +0000874}
875
Fred Drakef7685d71998-07-25 03:31:46 +0000876%ModuleSynopses = ('chapter' => 'SynopsisTable instance');
877
878sub get_synopsis_table($){
879 my($chap) = @_;
Fred Drakea0f4c941998-07-24 22:16:04 +0000880 my $st = $ModuleSynopses{$chap};
Fred Drakef7685d71998-07-25 03:31:46 +0000881 my $key;
882 foreach $key (keys %ModuleSynopses) {
883 if ($key eq $chap) {
884 return $ModuleSynopses{$chap};
885 }
Fred Drakea0f4c941998-07-24 22:16:04 +0000886 }
Fred Drakef7685d71998-07-25 03:31:46 +0000887 $st = SynopsisTable->new();
888 $ModuleSynopses{$chap} = $st;
Fred Drakea0f4c941998-07-24 22:16:04 +0000889 return $st;
890}
891
892sub do_cmd_declaremodule{
893 local($_) = @_;
894 my $key = next_optional_argument();
895 my $type = next_argument();
896 my $name = next_argument();
897 my $st = get_synopsis_table(get_chapter_id());
898 #
899 $key = $name unless $key;
900 $type = 'built-in' if $type eq 'builtin';
901 $st->declare($name, $key, $type);
902 define_module($type, $name);
903 anchor_label("module-$key",$CURRENT_FILE,$_)
904}
905
906sub do_cmd_modulesynopsis{
907 local($_) = @_;
908 my $st = get_synopsis_table(get_chapter_id());
909 $st->set_synopsis($THIS_MODULE, next_argument());
910 swallow_newline();
911 $_;
912}
913
914sub do_cmd_localmoduletable{
915 local($_) = @_;
Fred Drakea0f4c941998-07-24 22:16:04 +0000916 my $chap = get_chapter_id();
917 "<tex2htmllocalmoduletable><$chap>" . $_;
918}
919
920sub process_all_localmoduletables{
921 while (/<tex2htmllocalmoduletable><(\d+)>/) {
Fred Drakef7685d71998-07-25 03:31:46 +0000922 my $match = $&;
Fred Drakea0f4c941998-07-24 22:16:04 +0000923 my $chap = $1;
924 my $st = get_synopsis_table($chap);
925 my $data = $st->tohtml();
Fred Drakef7685d71998-07-25 03:31:46 +0000926 s/$match/$data/;
Fred Drakea0f4c941998-07-24 22:16:04 +0000927 }
928}
929
930
931#
932# "See also:" -- references placed at the end of a \section
933#
934
935sub do_env_seealso{
936 "<p><b>See Also:</b></p>\n" . @_[0];
937}
938
939sub do_cmd_seemodule{
940 # Insert the right magic to jump to the module definition. This should
941 # work most of the time, at least for repeat builds....
942 local($_) = @_;
943 my $key = next_optional_argument();
944 my $module = next_argument();
945 my $text = next_argument();
946 $key = $module
947 unless $key;
948 "<p>Module <tt><b><a href=\"module-$key.html\">$module</a></b></tt>"
949 . "&nbsp;&nbsp;&nbsp;($text)</p>"
950 . $_;
951}
952
953sub do_cmd_seetext{
954 '<p>' . @_[0];
955}
956
957
958#
Fred Drake885215c1998-05-20 21:32:09 +0000959# Definition list support.
960#
961
962sub do_env_definitions{
963 local($_) = @_;
964 swallow_newline();
965 "<dl>$_</dl>\n";
966}
967
968sub do_cmd_term{
969 local($_) = @_;
970 my($term, $id) = next_argument_id();
971 my($name,$aname,$ahref) = link_info($id);
972 swallow_newline();
973 # could easily add an index entry here...
974 "<dt><b>$aname" . $term . "</a></b>\n<dd>" . $_;
975}
976
977
Fred Drake6659c301998-03-03 22:02:19 +00009781; # This must be the last line