blob: 8b0ee66de6b3c8c3f7292288cf8e4958323e29d7 [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));
Fred Drake62e43691998-08-10 19:40:44 +000017 return ($param, $br_id);
Fred Drake08932051998-04-17 02:15:42 +000018}
19
20sub next_argument{
21 my ($param,$br_id) = next_argument_id();
Fred Drake62e43691998-08-10 19:40:44 +000022 return $param;
Fred Drake08932051998-04-17 02:15:42 +000023}
24
25sub next_optional_argument{
26 my($param,$rx) = ('', "^\\s*(\\[([^]]*)\\])?");
Fred Drake5ccf3301998-04-17 20:04:09 +000027 s/$rx/$param=$2;''/eo;
Fred Drake62e43691998-08-10 19:40:44 +000028 return $param;
Fred Drake08932051998-04-17 02:15:42 +000029}
30
31sub swallow_newline{
32 s/[\n]?//o;
33}
34
Fred Drakee16f6791998-05-15 04:28:37 +000035
36# This is a fairly simple hack; it supports \let when it is used to create
37# (or redefine) a macro to exactly be some other macro: \let\newname=\oldname.
Fred Drake5b73cdf1998-05-15 16:59:38 +000038# Many possible uses of \let aren't supported or aren't supported correctly.
Fred Drakee16f6791998-05-15 04:28:37 +000039#
40sub do_cmd_let{
41 local($_) = @_;
42 my $matched = 0;
Fred Drake7a4ad0f1998-05-15 13:45:54 +000043 s/[\\]([a-zA-Z]+)\s*(=\s*)?[\\]([a-zA-Z]*)/$matched=1; ''/e;
Fred Drakee16f6791998-05-15 04:28:37 +000044 if ($matched) {
45 my($new, $old) = ($1, $3);
46 eval "sub do_cmd_$new { do_cmd_$old" . '(@_); }';
47 print "\ndefining handler for \\$new using \\$old\n";
48 }
Fred Drake7a4ad0f1998-05-15 13:45:54 +000049 else {
50 s/[\\]([a-zA-Z]+)\s*(=\s*)?([^\\])/$matched=1; ''/es;
51 if ($matched) {
52 my($new, $char) = ($1, $3);
53 eval "sub do_cmd_$new { \"\\$char\" . \@_[0]; }";
54 print "\ndefining handler for \\$new to insert '$char'\n";
55 }
56 else {
57 write_warnings("Could not interpret \\let construct...");
58 }
59 }
Fred Drake62e43691998-08-10 19:40:44 +000060 return $_;
Fred Drakee16f6791998-05-15 04:28:37 +000061}
62
63
Fred Drake6659c301998-03-03 22:02:19 +000064# words typeset in a special way (not in HTML though)
65
66sub do_cmd_ABC{ 'ABC' . @_[0]; }
67sub do_cmd_UNIX{ 'Unix'. @_[0]; }
68sub do_cmd_ASCII{ 'ASCII' . @_[0]; }
69sub do_cmd_POSIX{ 'POSIX' . @_[0]; }
70sub do_cmd_C{ 'C' . @_[0]; }
71sub do_cmd_Cpp{ 'C++' . @_[0]; }
72sub do_cmd_EOF{ 'EOF' . @_[0]; }
73sub do_cmd_NULL{ '<tt>NULL</tt>' . @_[0]; }
74
75sub do_cmd_e{ '&#92;' . @_[0]; }
76
Fred Draked07868a1998-05-14 21:00:28 +000077$DEVELOPER_ADDRESS = '';
Fred Drake6659c301998-03-03 22:02:19 +000078$PYTHON_VERSION = '';
79
80sub do_cmd_version{ $PYTHON_VERSION . @_[0]; }
81sub do_cmd_release{
82 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +000083 $PYTHON_VERSION = next_argument();
Fred Drake62e43691998-08-10 19:40:44 +000084 return $_;
Fred Drake6659c301998-03-03 22:02:19 +000085}
86
87sub do_cmd_authoraddress{
88 local($_) = @_;
Fred Draked07868a1998-05-14 21:00:28 +000089 $DEVELOPER_ADDRESS = next_argument();
Fred Drake62e43691998-08-10 19:40:44 +000090 return $_;
Fred Drake6659c301998-03-03 22:02:19 +000091}
92
Fred Drakee16f6791998-05-15 04:28:37 +000093#sub do_cmd_developer{ do_cmd_author(@_[0]); }
94#sub do_cmd_developers{ do_cmd_author(@_[0]); }
95#sub do_cmd_developersaddress{ do_cmd_authoraddress(@_[0]); }
Fred Draked07868a1998-05-14 21:00:28 +000096
Fred Drake6659c301998-03-03 22:02:19 +000097sub do_cmd_hackscore{
98 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +000099 next_argument();
Fred Drake62e43691998-08-10 19:40:44 +0000100 return '_' . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000101}
102
Fred Drake08932051998-04-17 02:15:42 +0000103sub use_wrappers{
104 local($_,$before,$after) = @_;
105 my $stuff = next_argument();
Fred Drake62e43691998-08-10 19:40:44 +0000106 return $before . $stuff . $after . $_;
Fred Drake08932051998-04-17 02:15:42 +0000107}
108
Fred Drake62e43691998-08-10 19:40:44 +0000109sub use_current{
110 return use_wrappers(@_[0], '', '');
111}
112sub use_sans_serif{
113 return use_wrappers(@_[0], '<font face=sans-serif>', '</font>');
114}
115sub use_italics{
116 return use_wrappers(@_[0], '<i>', '</i>');
117}
Fred Drake08932051998-04-17 02:15:42 +0000118
Fred Drake6659c301998-03-03 22:02:19 +0000119sub do_cmd_optional{
Fred Drake62e43691998-08-10 19:40:44 +0000120 return use_wrappers(@_[0], "</var><big>\[</big><var>",
121 "</var><big>\]</big><var>");
Fred Drake6659c301998-03-03 22:02:19 +0000122}
123
Fred Drakec9a44381998-03-17 06:29:13 +0000124# Logical formatting (some based on texinfo), needs to be converted to
125# minimalist HTML. The "minimalist" is primarily to reduce the size of
126# output files for users that read them over the network rather than
127# from local repositories.
Fred Drake6659c301998-03-03 22:02:19 +0000128
Fred Drake62e43691998-08-10 19:40:44 +0000129sub do_cmd_pytype{ return use_current(@_); }
130sub do_cmd_makevar{ return use_current(@_); }
131sub do_cmd_code{ return use_wrappers(@_[0], '<tt>', '</tt>'); }
132sub do_cmd_module{ return do_cmd_code(@_); }
133sub do_cmd_keyword{ return do_cmd_code(@_); }
134sub do_cmd_exception{ return do_cmd_code(@_); }
135sub do_cmd_class{ return do_cmd_code(@_); }
136sub do_cmd_function{ return do_cmd_code(@_); }
137sub do_cmd_constant{ return do_cmd_code(@_); }
138sub do_cmd_member{ return do_cmd_code(@_); }
139sub do_cmd_method{ return do_cmd_code(@_); }
140sub do_cmd_cfunction{ return do_cmd_code(@_); }
141sub do_cmd_cdata{ return do_cmd_code(@_); }
142sub do_cmd_ctype{ return do_cmd_code(@_); }
143sub do_cmd_regexp{ return do_cmd_code(@_); }
144sub do_cmd_character{ return do_cmd_samp(@_); }
145sub do_cmd_program{ return do_cmd_strong(@_); }
146sub do_cmd_email{ return use_sans_serif(@_); }
147sub do_cmd_mimetype{ return use_sans_serif(@_); }
148sub do_cmd_var{ return use_italics(@_); }
149sub do_cmd_dfn{ return use_italics(@_); } # make an index entry?
150sub do_cmd_emph{ return use_italics(@_); }
151sub do_cmd_file{ return use_wrappers(@_[0], '"<tt>', '</tt>"'); }
152sub do_cmd_samp{ return use_wrappers(@_[0], '"<tt>', '</tt>"'); }
153sub do_cmd_kbd{ return use_wrappers(@_[0], '<kbd>', '</kbd>'); }
154sub do_cmd_strong{ return use_wrappers(@_[0], '<b>', '</b>'); }
Fred Drakec9a44381998-03-17 06:29:13 +0000155
Fred Drake1a7af391998-04-01 22:44:56 +0000156sub do_cmd_newsgroup{
157 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000158 my $newsgroup = next_argument();
Fred Drake1a7af391998-04-01 22:44:56 +0000159 my $stuff = "<a href=\"news:$newsgroup\"><font face=sans-serif>"
160 . "$newsgroup</font></a>";
Fred Drake62e43691998-08-10 19:40:44 +0000161 return $stuff . $_;
Fred Drake1a7af391998-04-01 22:44:56 +0000162}
Fred Drakefc16e781998-03-12 21:03:26 +0000163
164sub do_cmd_envvar{
165 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000166 my($envvar,$br_id) = next_argument_id();
Fred Drake42b31a51998-03-27 05:16:10 +0000167 my($name,$aname,$ahref) = link_info($br_id);
Fred Drake166abba1998-04-08 23:10:54 +0000168 # The <tt> here is really to keep buildindex.py from making
169 # the variable name case-insensitive.
170 add_index_entry("environment variables!$envvar@<tt>\$$envvar</tt>",
171 $ahref);
Fred Drake42b31a51998-03-27 05:16:10 +0000172 add_index_entry("$envvar@\$$envvar", $ahref);
Fred Drake62e43691998-08-10 19:40:44 +0000173 return "$aname\$$envvar</a>" . $_;
Fred Drakefc16e781998-03-12 21:03:26 +0000174}
175
Fred Drake08932051998-04-17 02:15:42 +0000176
Fred Drake6659c301998-03-03 22:02:19 +0000177sub do_cmd_url{
178 # use the URL as both text and hyperlink
179 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000180 my $url = next_argument();
Fred Drake6659c301998-03-03 22:02:19 +0000181 $url =~ s/~/&#126;/g;
Fred Drake62e43691998-08-10 19:40:44 +0000182 return "<a href=\"$url\"><font face=sans-serif>$url</font></a>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000183}
184
185sub do_cmd_manpage{
186 # two parameters: \manpage{name}{section}
187 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000188 my $page = next_argument();
189 my $section = next_argument();
Fred Drake62e43691998-08-10 19:40:44 +0000190 return "<i>$page</i>($section)" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000191}
192
193sub do_cmd_rfc{
194 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000195 my($rfcnumber,$br_id) = next_argument();
Fred Drake2eff3c51998-12-22 18:02:25 +0000196 my $href =
197 "http://info.internet.isi.edu/in-notes/rfc/files/rfc$rfcnumber.txt";
Fred Drake6659c301998-03-03 22:02:19 +0000198 # Save the reference
Fred Drake08932051998-04-17 02:15:42 +0000199 my $nstr = gen_index_id("RFC!RFC $rfcnumber", '');
200 $index{$nstr} .= make_half_href("$CURRENT_FILE#$br_id");
Fred Drake2eff3c51998-12-22 18:02:25 +0000201 return "<a name=\"$br_id\"\nhref=\"$href\">RFC $rfcnumber</a>" .$_;
Fred Drake6659c301998-03-03 22:02:19 +0000202}
203
Fred Drake6659c301998-03-03 22:02:19 +0000204sub do_cmd_deprecated{
205 # two parameters: \deprecated{version}{whattodo}
206 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000207 my $release = next_argument();
208 my $reason = next_argument();
Fred Drake62e43691998-08-10 19:40:44 +0000209 return "<b>Deprecated since release $release.</b>\n$reason<p>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000210}
211
Fred Drake897d12b1998-07-27 20:33:17 +0000212sub do_cmd_versionadded{
213 # one parameter: \versionadded{version}
214 local($_) = @_;
215 my $release = next_argument();
Fred Drake62e43691998-08-10 19:40:44 +0000216 return "<b>New in version $release.</b><p>" . $_;
Fred Drake897d12b1998-07-27 20:33:17 +0000217}
218
219sub do_cmd_versionchanged{
220 # one parameter: \versionchanged{version}
221 local($_) = @_;
222 my $release = next_argument();
Fred Drake62e43691998-08-10 19:40:44 +0000223 return "<b>Changed in version $release.</b><p>" . $_;
Fred Drake897d12b1998-07-27 20:33:17 +0000224}
225
Fred Drake6659c301998-03-03 22:02:19 +0000226# file and samp are at the end of this file since they screw up fontlock.
227
228# index commands
229
230$INDEX_SUBITEM = "";
231
232sub get_indexsubitem{
Fred Drakefc16e781998-03-12 21:03:26 +0000233 #$INDEX_SUBITEM ? " $INDEX_SUBITEM" : '';
Fred Drake62e43691998-08-10 19:40:44 +0000234 return '';
Fred Drake6659c301998-03-03 22:02:19 +0000235}
236
237sub do_cmd_setindexsubitem{
238 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000239 $INDEX_SUBITEM = next_argument();
Fred Drake62e43691998-08-10 19:40:44 +0000240 return $_;
Fred Drake6659c301998-03-03 22:02:19 +0000241}
242
Fred Drakefc16e781998-03-12 21:03:26 +0000243sub do_cmd_withsubitem{
244 # We can't really do the right right thing, because LaTeX2HTML doesn't
245 # do things in the right order, but we need to at least strip this stuff
246 # out, and leave anything that the second argument expanded out to.
247 #
248 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000249 next_argument();
250 my $stuff = next_argument();
Fred Drake62e43691998-08-10 19:40:44 +0000251 return $stuff . $_;
Fred Drakefc16e781998-03-12 21:03:26 +0000252}
253
Fred Drake08932051998-04-17 02:15:42 +0000254# This is the prologue macro which is required to start writing the
255# mod\jobname.idx file; we can just ignore it.
256#
Fred Drake62e43691998-08-10 19:40:44 +0000257sub do_cmd_makemodindex{ return @_[0]; }
Fred Drakefc16e781998-03-12 21:03:26 +0000258
Fred Drake42b31a51998-03-27 05:16:10 +0000259# We're in the document subdirectory when this happens!
Fred Drake166abba1998-04-08 23:10:54 +0000260#
Fred Drake08932051998-04-17 02:15:42 +0000261open(IDXFILE, '>index.dat') || die "\n$!\n";
262open(INTLABELS, '>intlabels.pl') || die "\n$!\n";
Fred Drake166abba1998-04-08 23:10:54 +0000263print INTLABELS "%internal_labels = ();\n";
264print INTLABELS "1; # hack in case there are no entries\n\n";
265
266# Using \0 for this is bad because we can't use common tools to work with the
267# resulting files. Things like grep can be useful with this stuff!
268#
269$IDXFILE_FIELD_SEP = "\1";
270
Fred Drake42b31a51998-03-27 05:16:10 +0000271
272sub gen_target_name{
Fred Drake2eff3c51998-12-22 18:02:25 +0000273 my($stuff) = @_;
274 return "l2h-" . $stuff;
Fred Drake42b31a51998-03-27 05:16:10 +0000275}
276
277sub gen_target{
Fred Drake2eff3c51998-12-22 18:02:25 +0000278 my($name) = @_;
279 return '<a name="' . $name . '">';
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";
Fred Drake62e43691998-08-10 19:40:44 +0000285 return "<a href=\"$node#$target\">";
Fred Drake42b31a51998-03-27 05:16:10 +0000286}
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);
Fred Drake62e43691998-08-10 19:40:44 +0000292 return "$aname$anchor_invisible_mark</a>";
Fred Drake42b31a51998-03-27 05:16:10 +0000293}
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);
Fred Drake62e43691998-08-10 19:40:44 +0000317 return "$aname$anchor_invisible_mark</a>" . $_;
Fred Drake42b31a51998-03-27 05:16:10 +0000318}
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);
Fred Drake62e43691998-08-10 19:40:44 +0000327 return "$aname$anchor_invisible_mark</a>" . $_;
Fred Drake2e7edb81998-05-11 18:31:17 +0000328}
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);
Fred Drake62e43691998-08-10 19:40:44 +0000338 return "$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);
Fred Drake62e43691998-08-10 19:40:44 +0000351 return "$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);
Fred Drake62e43691998-08-10 19:40:44 +0000366 return "$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();
Fred Drake62e43691998-08-10 19:40:44 +0000373 return 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);
Fred Drake62e43691998-08-10 19:40:44 +0000384 return "$aname$anchor_invisible_mark</a>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000385}
386
Fred Drake62e43691998-08-10 19:40:44 +0000387sub do_cmd_stindex{ return my_typed_index_helper('statement', @_); }
388sub do_cmd_opindex{ return my_typed_index_helper('operator', @_); }
389sub do_cmd_exindex{ return my_typed_index_helper('exception', @_); }
390sub do_cmd_obindex{ return 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 Drake62e43691998-08-10 19:40:44 +0000396 return 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 Drake62e43691998-08-10 19:40:44 +0000413 return "$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 Drake62e43691998-08-10 19:40:44 +0000424 return make_mod_index_entry("SECTION$section_tag",
425 "<tt>$name</tt> (${word}module)", 'DEF');
Fred Drakea0f4c941998-07-24 22:16:04 +0000426}
427
428sub my_module_index_helper{
429 local($word, $_) = @_;
430 my $name = next_argument();
431 swallow_newline();
Fred Drake62e43691998-08-10 19:40:44 +0000432 return 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 Drake62e43691998-08-10 19:40:44 +0000440 return make_mod_index_entry($br_id,
441 "<tt>$str</tt> (${word}module)", 'REF') . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000442}
443
Fred Drakec9a44381998-03-17 06:29:13 +0000444sub do_cmd_bifuncindex{
445 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000446 my($str,$br_id) = next_argument();
447 swallow_newline();
448 my $fname = "<tt>$str()</tt>";
Fred Drake62e43691998-08-10 19:40:44 +0000449 return make_index_entry($br_id, "$fname (built-in function)") . $_;
Fred Drakec9a44381998-03-17 06:29:13 +0000450}
451
Fred Drake62e43691998-08-10 19:40:44 +0000452sub do_cmd_modindex{ return my_module_index_helper('', @_); }
453sub do_cmd_bimodindex{ return my_module_index_helper('built-in', @_); }
454sub do_cmd_exmodindex{ return my_module_index_helper('extension', @_); }
455sub do_cmd_stmodindex{ return my_module_index_helper('standard', @_); }
Fred Drake6659c301998-03-03 22:02:19 +0000456
457# these should be adjusted a bit....
Fred Drake62e43691998-08-10 19:40:44 +0000458sub do_cmd_refmodindex{ return ref_module_index_helper('', @_); }
459sub do_cmd_refbimodindex{ return ref_module_index_helper('built-in', @_); }
460sub do_cmd_refexmodindex{ return ref_module_index_helper('extension', @_); }
461sub do_cmd_refstmodindex{ return ref_module_index_helper('standard', @_); }
Fred Drake6659c301998-03-03 22:02:19 +0000462
Fred Drake62e43691998-08-10 19:40:44 +0000463sub do_cmd_nodename{ return do_cmd_label(@_); }
Fred Drake6659c301998-03-03 22:02:19 +0000464
465sub init_myformat{
Fred Drake08932051998-04-17 02:15:42 +0000466# $anchor_invisible_mark = '';
Fred Drake6659c301998-03-03 22:02:19 +0000467 $anchor_mark = '';
468 $icons{'anchor_mark'} = '';
Fred Drake6659c301998-03-03 22:02:19 +0000469}
Fred Drake42b31a51998-03-27 05:16:10 +0000470init_myformat();
Fred Drake6659c301998-03-03 22:02:19 +0000471
472# similar to make_index_entry(), but includes the string in the result
473# instead of the dummy filler.
474#
475sub make_str_index_entry{
Fred Drakec9a44381998-03-17 06:29:13 +0000476 my($br_id,$str) = @_;
Fred Drake42b31a51998-03-27 05:16:10 +0000477 my($name,$aname,$ahref) = link_info($br_id);
Fred Drake42b31a51998-03-27 05:16:10 +0000478 add_index_entry($str, $ahref);
Fred Drake62e43691998-08-10 19:40:44 +0000479 return "$aname$str</a>";
Fred Drake6659c301998-03-03 22:02:19 +0000480}
481
Fred Drake6659c301998-03-03 22:02:19 +0000482sub do_env_cfuncdesc{
483 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000484 my $return_type = next_argument();
485 my($function_name,$br_id) = next_argument_id();
486 my $arg_list = next_argument();
487 my $idx = make_str_index_entry($br_id,
488 "<tt>$function_name()</tt>" . get_indexsubitem());
489 $idx =~ s/ \(.*\)//;
490 $idx =~ s/\(\)//; # ????
Fred Drake62e43691998-08-10 19:40:44 +0000491 return "<dl><dt>$return_type <b>$idx</b>"
492 . "(<var>$arg_list</var>)\n<dd>"
493 . $_
494 . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000495}
496
497sub do_env_ctypedesc{
498 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000499 my($type_name,$br_id) = next_argument_id();
500 my $idx = make_str_index_entry($br_id,
501 "<tt>$type_name</tt>" . get_indexsubitem());
502 $idx =~ s/ \(.*\)//;
Fred Drake62e43691998-08-10 19:40:44 +0000503 return "<dl><dt><b>$idx</b>\n<dd>"
504 . $_
505 . '</dl>'
Fred Drake6659c301998-03-03 22:02:19 +0000506}
507
508sub do_env_cvardesc{
509 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000510 my $var_type = next_argument();
511 my($var_name,$br_id) = next_argument_id();
512 my $idx = make_str_index_entry($br_id,
513 "<tt>$var_name</tt>" . get_indexsubitem());
514 $idx =~ s/ \(.*\)//;
Fred Drake62e43691998-08-10 19:40:44 +0000515 return "<dl><dt>$var_type <b>$idx</b>\n"
516 . '<dd>'
517 . $_
518 . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000519}
520
521sub do_env_funcdesc{
522 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000523 my $function_name = next_argument();
524 my($arg_list,$br_id) = next_argument_id();
525 my $idx = make_str_index_entry($br_id, "<tt>$function_name()</tt>"
526 . get_indexsubitem());
527 $idx =~ s/ \(.*\)//;
528 $idx =~ s/\(\)//;
Fred Drake62e43691998-08-10 19:40:44 +0000529 return "<dl><dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_ . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000530}
531
532sub do_env_funcdescni{
533 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000534 my $function_name = next_argument();
535 my $arg_list = next_argument();
Fred Drake62e43691998-08-10 19:40:44 +0000536 return "<dl><dt><b><tt>$function_name</tt></b> (<var>$arg_list</var>)\n"
537 . "<dd>"
538 . $_ . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000539}
540
541sub do_cmd_funcline{
542 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000543 my $function_name = next_argument();
544 my($arg_list,$br_id) = next_argument_id();
Fred Drake42b31a51998-03-27 05:16:10 +0000545 my $idx = make_str_index_entry($br_id, "<tt>$function_name()</tt>"
Fred Drake08932051998-04-17 02:15:42 +0000546 . get_indexsubitem());
Fred Drakec9a44381998-03-17 06:29:13 +0000547 $idx =~ s/\(\)//;
Fred Drake62e43691998-08-10 19:40:44 +0000548 return "<dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000549}
550
551# Change this flag to index the opcode entries. I don't think it's very
552# useful to index them, since they're only presented to describe the dis
553# module.
554#
555$INDEX_OPCODES = 0;
556
557sub do_env_opcodedesc{
558 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000559 my $opcode_name = next_argument();
560 my($arg_list,$br_id) = next_argument_id();
561 my $idx;
562 if ($INDEX_OPCODES) {
563 $idx = make_str_index_entry($br_id,
Fred Drake6659c301998-03-03 22:02:19 +0000564 "<tt>$opcode_name</tt> (byte code instruction)");
Fred Drake08932051998-04-17 02:15:42 +0000565 $idx =~ s/ \(byte code instruction\)//;
566 }
567 else {
568 $idx = "<tt>$opcode_name</tt>";
569 }
570 my $stuff = "<dl><dt><b>$idx</b>";
Fred Drake6659c301998-03-03 22:02:19 +0000571 if ($arg_list) {
572 $stuff .= "&nbsp;&nbsp;&nbsp;&nbsp;<var>$arg_list</var>";
573 }
Fred Drake62e43691998-08-10 19:40:44 +0000574 return $stuff . "\n<dd>" . $_ . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000575}
576
577sub do_env_datadesc{
578 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000579 my($dataname,$br_id) = next_argument_id();
580 my $idx = make_str_index_entry($br_id,
581 "<tt>$dataname</tt>" . get_indexsubitem());
582 $idx =~ s/ \(.*\)//;
Fred Drake62e43691998-08-10 19:40:44 +0000583 return "<dl><dt><b>$idx</b>\n<dd>"
584 . $_
585 . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000586}
587
588sub do_env_datadescni{
589 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000590 my $idx = next_argument();
591 if (! $STRING_INDEX_TT) {
592 $idx = "<tt>$idx</tt>";
Fred Drake6659c301998-03-03 22:02:19 +0000593 }
Fred Drake62e43691998-08-10 19:40:44 +0000594 return "<dl><dt><b>$idx</b>\n<dd>" . $_ . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000595}
596
597sub do_cmd_dataline{
598 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000599 my($data_name,$br_id) = next_argument_id();
Fred Drake42b31a51998-03-27 05:16:10 +0000600 my $idx = make_str_index_entry($br_id, "<tt>$data_name</tt>"
Fred Drake08932051998-04-17 02:15:42 +0000601 . get_indexsubitem());
Fred Drake6659c301998-03-03 22:02:19 +0000602 $idx =~ s/ \(.*\)//;
Fred Drake62e43691998-08-10 19:40:44 +0000603 return "<dt><b>$idx</b><dd>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000604}
605
Fred Drake42b31a51998-03-27 05:16:10 +0000606sub do_env_excdesc{
607 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000608 my($excname,$br_id) = next_argument_id();
Fred Drake166abba1998-04-08 23:10:54 +0000609 my $idx = make_str_index_entry($br_id, "<tt>$excname</tt>");
Fred Drake62e43691998-08-10 19:40:44 +0000610 return "<dl><dt><b>$idx</b>\n<dd>" . $_ . '</dl>'
Fred Drake42b31a51998-03-27 05:16:10 +0000611}
612
Fred Drake62e43691998-08-10 19:40:44 +0000613sub do_env_fulllineitems{ return do_env_itemize(@_); }
Fred Drake6659c301998-03-03 22:02:19 +0000614
615
Fred Drakec9a44381998-03-17 06:29:13 +0000616sub do_env_classdesc{
617 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000618 $THIS_CLASS = next_argument();
619 my($arg_list,$br_id) = next_argument_id();
620 $idx = make_str_index_entry($br_id,
621 "<tt>$THIS_CLASS</tt> (class in $THIS_MODULE)" );
622 $idx =~ s/ \(.*\)//;
Fred Drake62e43691998-08-10 19:40:44 +0000623 return "<dl><dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_ . '</dl>';
Fred Drakec9a44381998-03-17 06:29:13 +0000624}
625
Fred Drake42b31a51998-03-27 05:16:10 +0000626
627sub do_env_methoddesc{
628 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000629 my $class_name = next_optional_argument();
630 $class_name = $THIS_CLASS
631 unless $class_name;
632 my($method_name,$br_id) = next_argument_id();
633 my $arg_list = next_argument();
634 my $extra = '';
635 if ($class_name) {
636 $extra = " ($class_name method)";
Fred Drake42b31a51998-03-27 05:16:10 +0000637 }
Fred Drake08932051998-04-17 02:15:42 +0000638 my $idx = make_str_index_entry($br_id, "<tt>$method_name()</tt>$extra");
639 $idx =~ s/ \(.*\)//;
640 $idx =~ s/\(\)//;
Fred Drake62e43691998-08-10 19:40:44 +0000641 return "<dl><dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_ . '</dl>';
Fred Drake42b31a51998-03-27 05:16:10 +0000642}
643
644
Fred Draked64a40d1998-09-10 18:59:13 +0000645sub do_cmd_methodlineni{
646 local($_) = @_;
647 next_optional_argument();
648 my $method = next_argument();
649 my $arg_list = next_argument();
650 return "<dt><b>$method</b> (<var>$arg_list</var>)\n<dd>"
651 . $_;
652}
653
Fred Drake42b31a51998-03-27 05:16:10 +0000654sub do_env_methoddescni{
655 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000656 next_optional_argument();
657 my $method = next_argument();
658 my $arg_list = next_argument();
Fred Drake62e43691998-08-10 19:40:44 +0000659 return "<dl><dt><b>$method</b> (<var>$arg_list</var>)\n<dd>"
660 . $_
661 . '</dl>';
Fred Drake42b31a51998-03-27 05:16:10 +0000662}
663
664
665sub do_env_memberdesc{
666 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000667 my $class = next_optional_argument();
668 my($member,$br_id) = next_argument();
Fred Drake42b31a51998-03-27 05:16:10 +0000669 $class = $THIS_CLASS
670 unless $class;
Fred Drake08932051998-04-17 02:15:42 +0000671 my $extra = '';
Fred Drake42b31a51998-03-27 05:16:10 +0000672 $extra = " ($class_name attribute)"
Fred Drakea608feb1998-04-12 03:58:13 +0000673 if (!($class eq ''));
Fred Drake08932051998-04-17 02:15:42 +0000674 my $idx = make_str_index_entry($br_id, "<tt>$member</tt>$extra");
Fred Drake42b31a51998-03-27 05:16:10 +0000675 $idx =~ s/ \(.*\)//;
676 $idx =~ s/\(\)//;
Fred Drake62e43691998-08-10 19:40:44 +0000677 return "<dl><dt><b>$idx</b>\n<dd>" . $_ . '</dl>';
Fred Drake42b31a51998-03-27 05:16:10 +0000678}
679
680
Fred Drake5ccf3301998-04-17 20:04:09 +0000681sub do_cmd_memberline{
682 local($_) = @_;
683 my $class = next_optional_argument();
684 my($member,$br_id) = next_argument_id();
685 $class = $THIS_CLASS
686 unless $class;
687 my $extra = '';
688 $extra = " ($class_name attribute)"
689 if (!($class eq ''));
690 my $idx = make_str_index_entry($br_id, "<tt>$member</tt>$extra");
691 $idx =~ s/ \(.*\)//;
692 $idx =~ s/\(\)//;
Fred Drake62e43691998-08-10 19:40:44 +0000693 return "<dt><b>$idx</b><dd>" . $_;
Fred Drake5ccf3301998-04-17 20:04:09 +0000694}
695
Fred Drake42b31a51998-03-27 05:16:10 +0000696sub do_env_memberdescni{
697 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000698 next_optional_argument();
699 my $member = next_argument();
Fred Drake62e43691998-08-10 19:40:44 +0000700 return "<dl><dt><b>$member</b>\n<dd>" . $_ . '</dl>';
Fred Drake42b31a51998-03-27 05:16:10 +0000701}
702
703
Fred Drake5ccf3301998-04-17 20:04:09 +0000704sub do_cmd_memberlineni{
705 local($_) = @_;
706 next_optional_argument();
707 my $member = next_argument();
Fred Drake62e43691998-08-10 19:40:44 +0000708 return "<dt><b>$member</b><dd>" . $_;
Fred Drake5ccf3301998-04-17 20:04:09 +0000709}
710
Fred Drakea0f4c941998-07-24 22:16:04 +0000711@col_aligns = ("<td>", "<td>", "<td>", "<td>");
Fred Drake6659c301998-03-03 22:02:19 +0000712
713sub setup_column_alignments{
714 local($_) = @_;
Fred Drakea0f4c941998-07-24 22:16:04 +0000715 my($a1,$a2,$a3,$a4) = split(/[|]/,$_);
716 my($th1,$th2,$th3,$th4) = ('<th>', '<th>', '<th>', '<th>');
Fred Drake08932051998-04-17 02:15:42 +0000717 $col_aligns[0] = (($a1 eq 'c') ? '<td align=center>' : '<td>');
718 $col_aligns[1] = (($a2 eq 'c') ? '<td align=center>' : '<td>');
719 $col_aligns[2] = (($a3 eq 'c') ? '<td align=center>' : '<td>');
Fred Drakea0f4c941998-07-24 22:16:04 +0000720 $col_aligns[3] = (($a4 eq 'c') ? '<td align=center>' : '<td>');
Fred Drake6659c301998-03-03 22:02:19 +0000721 # return the aligned header start tags; only used for \begin{tableiii?}
Fred Drake08932051998-04-17 02:15:42 +0000722 $th1 = (($a1 eq 'l') ? '<th align=left>'
723 : ($a1 eq 'r' ? '<th align=right>' : '<th>'));
724 $th2 = (($a2 eq 'l') ? '<th align=left>'
725 : ($a2 eq 'r' ? '<th align=right>' : '<th>'));
726 $th3 = (($a3 eq 'l') ? '<th align=left>'
727 : ($a3 eq 'r' ? '<th align=right>' : '<th>'));
Fred Drakea0f4c941998-07-24 22:16:04 +0000728 $th4 = (($a4 eq 'l') ? '<th align=left>'
729 : ($a4 eq 'r' ? '<th align=right>' : '<th>'));
Fred Drake62e43691998-08-10 19:40:44 +0000730 return ($th1, $th2, $th3, $th4);
Fred Drake6659c301998-03-03 22:02:19 +0000731}
732
733sub do_env_tableii{
734 local($_) = @_;
Fred Drakea0f4c941998-07-24 22:16:04 +0000735 my($th1,$th2,$th3,$th4) = setup_column_alignments(next_argument());
Fred Drake08932051998-04-17 02:15:42 +0000736 my $font = next_argument();
737 my $h1 = next_argument();
738 my $h2 = next_argument();
739 $font = ''
740 if ($font eq 'textrm');
741 $globals{'lineifont'} = $font;
Fred Drake62e43691998-08-10 19:40:44 +0000742 return '<table border align=center>'
743 . "\n <tr>$th1<b>$h1</b></th>"
744 . "\n $th2<b>$h2</b></th>"
745 . $_
746 . "\n</table>";
Fred Drake6659c301998-03-03 22:02:19 +0000747}
748
749sub do_cmd_lineii{
750 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000751 my $c1 = next_argument();
752 my $c2 = next_argument();
753 my($font,$sfont,$efont) = ($globals{'lineifont'}, '', '');
Fred Drake58b2bfd1998-04-02 20:14:04 +0000754 if ($font) {
Fred Drake5cca42e1998-04-09 17:59:11 +0000755 $sfont = "<$font>";
Fred Drake58b2bfd1998-04-02 20:14:04 +0000756 $efont = "</$font>";
757 }
Fred Drakec9a44381998-03-17 06:29:13 +0000758 my($c1align,$c2align) = @col_aligns[0,1];
Fred Drake62e43691998-08-10 19:40:44 +0000759 return "<tr>$c1align$sfont$c1$efont</td>\n"
760 . " $c2align$c2</td>"
761 . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000762}
763
764sub do_env_tableiii{
765 local($_) = @_;
Fred Drakea0f4c941998-07-24 22:16:04 +0000766 my($th1,$th2,$th3,$th4) = setup_column_alignments(next_argument());
Fred Drake08932051998-04-17 02:15:42 +0000767 my $font = next_argument();
768 my $h1 = next_argument();
769 my $h2 = next_argument();
770 my $h3 = next_argument();
771 $font = ''
772 if ($font eq 'textrm');
773 $globals{'lineifont'} = $font;
Fred Drake62e43691998-08-10 19:40:44 +0000774 return '<table border align=center>'
775 . "\n <tr>$th1<b>$h1</b></th>"
776 . "\n $th2<b>$h2</b></th>"
777 . "\n $th3<b>$h3</b></th>"
778 . $_
779 . "\n</table>";
Fred Drake6659c301998-03-03 22:02:19 +0000780}
781
782sub do_cmd_lineiii{
783 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000784 my $c1 = next_argument();
785 my $c2 = next_argument();
786 my $c3 = next_argument();
787 my($font,$sfont,$efont) = ($globals{'lineifont'}, '', '');
Fred Drake58b2bfd1998-04-02 20:14:04 +0000788 if ($font) {
Fred Drake5cca42e1998-04-09 17:59:11 +0000789 $sfont = "<$font>";
Fred Drake58b2bfd1998-04-02 20:14:04 +0000790 $efont = "</$font>";
791 }
Fred Drakea0f4c941998-07-24 22:16:04 +0000792 my($c1align,$c2align,$c3align) = @col_aligns[0,1,2];
Fred Drake62e43691998-08-10 19:40:44 +0000793 return "<tr>$c1align$sfont$c1$efont</td>\n"
794 . " $c2align$c2</td>\n"
795 . " $c3align$c3</td>"
796 . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000797}
798
Fred Drakea0f4c941998-07-24 22:16:04 +0000799sub do_env_tableiv{
800 local($_) = @_;
801 my($th1,$th2,$th3,$th4) = setup_column_alignments(next_argument());
802 my $font = next_argument();
803 my $h1 = next_argument();
804 my $h2 = next_argument();
805 my $h3 = next_argument();
806 my $h4 = next_argument();
807 $font = ''
808 if ($font eq 'textrm');
809 $globals{'lineifont'} = $font;
Fred Drake62e43691998-08-10 19:40:44 +0000810 return '<table border align=center>'
811 . "\n <tr>$th1<b>$h1</b></th>"
812 . "\n $th2<b>$h2</b></th>"
813 . "\n $th3<b>$h3</b></th>"
814 . "\n $th4<b>$h4</b></th>"
815 . $_
816 . "\n</table>";
Fred Drake6659c301998-03-03 22:02:19 +0000817}
818
Fred Drakea0f4c941998-07-24 22:16:04 +0000819sub do_cmd_lineiv{
Fred Drake6659c301998-03-03 22:02:19 +0000820 local($_) = @_;
Fred Drakea0f4c941998-07-24 22:16:04 +0000821 my $c1 = next_argument();
822 my $c2 = next_argument();
823 my $c3 = next_argument();
824 my $c4 = next_argument();
825 my($font,$sfont,$efont) = ($globals{'lineifont'}, '', '');
826 if ($font) {
827 $sfont = "<$font>";
828 $efont = "</$font>";
829 }
830 my($c1align,$c2align,$c3align,$c4align) = @col_aligns;
Fred Drake62e43691998-08-10 19:40:44 +0000831 return "<tr>$c1align$sfont$c1$efont</td>\n"
832 . " $c2align$c2</td>\n"
833 . " $c3align$c3</td>\n"
834 . " $c4align$c4</td>"
835 . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000836}
837
Fred Drake6659c301998-03-03 22:02:19 +0000838sub do_cmd_maketitle {
839 local($_) = @_;
Fred Drakec9a44381998-03-17 06:29:13 +0000840 my $the_title = '';
Fred Drake6659c301998-03-03 22:02:19 +0000841 if ($t_title) {
Fred Drakec9a44381998-03-17 06:29:13 +0000842 $the_title .= "<h1 align=center>$t_title</h1>";
Fred Drake08932051998-04-17 02:15:42 +0000843 } else { write_warnings("\nThis document has no title."); }
Fred Drakec9a44381998-03-17 06:29:13 +0000844 $the_title .= "\n<center>";
Fred Drake6659c301998-03-03 22:02:19 +0000845 if ($t_author) {
846 if ($t_authorURL) {
Fred Drake08932051998-04-17 02:15:42 +0000847 my $href = translate_commands($t_authorURL);
848 $href = make_named_href('author', $href, "<strong>${t_author}</strong>");
Fred Drakec9a44381998-03-17 06:29:13 +0000849 $the_title .= "\n<p>$href</p>";
Fred Drake6659c301998-03-03 22:02:19 +0000850 } else {
Fred Drakec9a44381998-03-17 06:29:13 +0000851 $the_title .= "\n<p><strong>$t_author</strong></p>";
Fred Drake6659c301998-03-03 22:02:19 +0000852 }
Fred Drake08932051998-04-17 02:15:42 +0000853 } else { write_warnings("\nThere is no author for this document."); }
Fred Drake6659c301998-03-03 22:02:19 +0000854 if ($t_institute) {
Fred Drakec9a44381998-03-17 06:29:13 +0000855 $the_title .= "\n<p>$t_institute</p>";}
Fred Draked07868a1998-05-14 21:00:28 +0000856 if ($DEVELOPER_ADDRESS) {
857 $the_title .= "\n<p>$DEVELOPER_ADDRESS</p>";}
Fred Drake6659c301998-03-03 22:02:19 +0000858 if ($t_affil) {
Fred Drakec9a44381998-03-17 06:29:13 +0000859 $the_title .= "\n<p><i>$t_affil</i></p>";}
Fred Drake6659c301998-03-03 22:02:19 +0000860 if ($t_date) {
Fred Drakec9a44381998-03-17 06:29:13 +0000861 $the_title .= "\n<p><strong>$t_date</strong>";
Fred Drake6659c301998-03-03 22:02:19 +0000862 if ($PYTHON_VERSION) {
863 $the_title .= "<br><strong>Release $PYTHON_VERSION</strong>";}
864 $the_title .= "</p>"
865 }
Fred Drakec9a44381998-03-17 06:29:13 +0000866 $the_title .= "\n</center>";
Fred Drake6659c301998-03-03 22:02:19 +0000867 if ($t_address) {
Fred Drakec9a44381998-03-17 06:29:13 +0000868 $the_title .= "\n<p>$t_address</p>";
869 } else { $the_title .= "\n<p>"}
Fred Drake6659c301998-03-03 22:02:19 +0000870 if ($t_email) {
Fred Drakec9a44381998-03-17 06:29:13 +0000871 $the_title .= "\n<p>$t_email</p>";
872 }# else { $the_title .= "</p>" }
Fred Drake62e43691998-08-10 19:40:44 +0000873 return $the_title . $_ ;
Fred Drake6659c301998-03-03 22:02:19 +0000874}
875
876
Fred Drake885215c1998-05-20 21:32:09 +0000877#
Fred Drakea0f4c941998-07-24 22:16:04 +0000878# Module synopsis support
879#
880
881require SynopsisTable;
882
Fred Drakef7685d71998-07-25 03:31:46 +0000883sub get_chapter_id(){
884 my $id = do_cmd_thechapter('');
Fred Drake45f26011998-08-04 22:07:18 +0000885 $id =~ s/<SPAN CLASS="arabic">(\d+)<\/SPAN>/\1/;
886 $id =~ s/\.//;
Fred Drakef7685d71998-07-25 03:31:46 +0000887 return $id;
Fred Drakea0f4c941998-07-24 22:16:04 +0000888}
889
Fred Drakef7685d71998-07-25 03:31:46 +0000890%ModuleSynopses = ('chapter' => 'SynopsisTable instance');
891
892sub get_synopsis_table($){
893 my($chap) = @_;
Fred Drakea0f4c941998-07-24 22:16:04 +0000894 my $st = $ModuleSynopses{$chap};
Fred Drakef7685d71998-07-25 03:31:46 +0000895 my $key;
896 foreach $key (keys %ModuleSynopses) {
897 if ($key eq $chap) {
898 return $ModuleSynopses{$chap};
899 }
Fred Drakea0f4c941998-07-24 22:16:04 +0000900 }
Fred Drakef7685d71998-07-25 03:31:46 +0000901 $st = SynopsisTable->new();
902 $ModuleSynopses{$chap} = $st;
Fred Drakea0f4c941998-07-24 22:16:04 +0000903 return $st;
904}
905
Fred Drake62e43691998-08-10 19:40:44 +0000906sub do_cmd_moduleauthor{
907 local($_) = @_;
908 next_argument();
909 next_argument();
910 return $_;
911}
912
913sub do_cmd_sectionauthor{
914 local($_) = @_;
915 next_argument();
916 next_argument();
917 return $_;
918}
919
Fred Drakea0f4c941998-07-24 22:16:04 +0000920sub do_cmd_declaremodule{
921 local($_) = @_;
922 my $key = next_optional_argument();
923 my $type = next_argument();
924 my $name = next_argument();
925 my $st = get_synopsis_table(get_chapter_id());
926 #
927 $key = $name unless $key;
928 $type = 'built-in' if $type eq 'builtin';
929 $st->declare($name, $key, $type);
930 define_module($type, $name);
Fred Drake62e43691998-08-10 19:40:44 +0000931 return anchor_label("module-$key",$CURRENT_FILE,$_)
Fred Drakea0f4c941998-07-24 22:16:04 +0000932}
933
934sub do_cmd_modulesynopsis{
935 local($_) = @_;
936 my $st = get_synopsis_table(get_chapter_id());
937 $st->set_synopsis($THIS_MODULE, next_argument());
938 swallow_newline();
Fred Drake62e43691998-08-10 19:40:44 +0000939 return $_;
Fred Drakea0f4c941998-07-24 22:16:04 +0000940}
941
942sub do_cmd_localmoduletable{
943 local($_) = @_;
Fred Drakea0f4c941998-07-24 22:16:04 +0000944 my $chap = get_chapter_id();
Fred Drake62e43691998-08-10 19:40:44 +0000945 return "<tex2htmllocalmoduletable><$chap>\\tableofchildlinks[off]" . $_;
Fred Drakea0f4c941998-07-24 22:16:04 +0000946}
947
948sub process_all_localmoduletables{
949 while (/<tex2htmllocalmoduletable><(\d+)>/) {
Fred Drakef7685d71998-07-25 03:31:46 +0000950 my $match = $&;
Fred Drakea0f4c941998-07-24 22:16:04 +0000951 my $chap = $1;
952 my $st = get_synopsis_table($chap);
953 my $data = $st->tohtml();
Fred Drakef7685d71998-07-25 03:31:46 +0000954 s/$match/$data/;
Fred Drakea0f4c941998-07-24 22:16:04 +0000955 }
956}
957
958
959#
960# "See also:" -- references placed at the end of a \section
961#
962
963sub do_env_seealso{
Fred Drake62e43691998-08-10 19:40:44 +0000964 return "<p><b>See Also:</b></p>\n" . @_[0];
Fred Drakea0f4c941998-07-24 22:16:04 +0000965}
966
967sub do_cmd_seemodule{
968 # Insert the right magic to jump to the module definition. This should
969 # work most of the time, at least for repeat builds....
970 local($_) = @_;
971 my $key = next_optional_argument();
972 my $module = next_argument();
973 my $text = next_argument();
974 $key = $module
975 unless $key;
Fred Drake62e43691998-08-10 19:40:44 +0000976 return "<p>Module <tt><b><a href=\"module-$key.html\">$module</a></b></tt>"
977 . "&nbsp;&nbsp;&nbsp;($text)</p>"
978 . $_;
Fred Drakea0f4c941998-07-24 22:16:04 +0000979}
980
981sub do_cmd_seetext{
Fred Drake62e43691998-08-10 19:40:44 +0000982 return '<p>' . @_[0];
Fred Drakea0f4c941998-07-24 22:16:04 +0000983}
984
985
986#
Fred Drake885215c1998-05-20 21:32:09 +0000987# Definition list support.
988#
989
990sub do_env_definitions{
991 local($_) = @_;
992 swallow_newline();
Fred Drake62e43691998-08-10 19:40:44 +0000993 return "<dl>$_</dl>\n";
Fred Drake885215c1998-05-20 21:32:09 +0000994}
995
996sub do_cmd_term{
997 local($_) = @_;
998 my($term, $id) = next_argument_id();
999 my($name,$aname,$ahref) = link_info($id);
1000 swallow_newline();
1001 # could easily add an index entry here...
Fred Drake62e43691998-08-10 19:40:44 +00001002 return "<dt><b>$aname" . $term . "</a></b>\n<dd>" . $_;
Fred Drake885215c1998-05-20 21:32:09 +00001003}
1004
1005
Fred Drake6659c301998-03-03 22:02:19 +000010061; # This must be the last line