blob: bffd46f2ddeba8150c4e13288dc699ab4e2ba92b [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 Drake6659c301998-03-03 22:02:19 +0000196
197 # Save the reference
Fred Drake08932051998-04-17 02:15:42 +0000198 my $nstr = gen_index_id("RFC!RFC $rfcnumber", '');
199 $index{$nstr} .= make_half_href("$CURRENT_FILE#$br_id");
Fred Drake62e43691998-08-10 19:40:44 +0000200 return "<a name=$br_id>RFC $rfcnumber</a>" .$_;
Fred Drake6659c301998-03-03 22:02:19 +0000201}
202
Fred Drake6659c301998-03-03 22:02:19 +0000203sub do_cmd_deprecated{
204 # two parameters: \deprecated{version}{whattodo}
205 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000206 my $release = next_argument();
207 my $reason = next_argument();
Fred Drake62e43691998-08-10 19:40:44 +0000208 return "<b>Deprecated since release $release.</b>\n$reason<p>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000209}
210
Fred Drake897d12b1998-07-27 20:33:17 +0000211sub do_cmd_versionadded{
212 # one parameter: \versionadded{version}
213 local($_) = @_;
214 my $release = next_argument();
Fred Drake62e43691998-08-10 19:40:44 +0000215 return "<b>New in version $release.</b><p>" . $_;
Fred Drake897d12b1998-07-27 20:33:17 +0000216}
217
218sub do_cmd_versionchanged{
219 # one parameter: \versionchanged{version}
220 local($_) = @_;
221 my $release = next_argument();
Fred Drake62e43691998-08-10 19:40:44 +0000222 return "<b>Changed in version $release.</b><p>" . $_;
Fred Drake897d12b1998-07-27 20:33:17 +0000223}
224
Fred Drake6659c301998-03-03 22:02:19 +0000225# file and samp are at the end of this file since they screw up fontlock.
226
227# index commands
228
229$INDEX_SUBITEM = "";
230
231sub get_indexsubitem{
Fred Drakefc16e781998-03-12 21:03:26 +0000232 #$INDEX_SUBITEM ? " $INDEX_SUBITEM" : '';
Fred Drake62e43691998-08-10 19:40:44 +0000233 return '';
Fred Drake6659c301998-03-03 22:02:19 +0000234}
235
236sub do_cmd_setindexsubitem{
237 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000238 $INDEX_SUBITEM = next_argument();
Fred Drake62e43691998-08-10 19:40:44 +0000239 return $_;
Fred Drake6659c301998-03-03 22:02:19 +0000240}
241
Fred Drakefc16e781998-03-12 21:03:26 +0000242sub do_cmd_withsubitem{
243 # We can't really do the right right thing, because LaTeX2HTML doesn't
244 # do things in the right order, but we need to at least strip this stuff
245 # out, and leave anything that the second argument expanded out to.
246 #
247 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000248 next_argument();
249 my $stuff = next_argument();
Fred Drake62e43691998-08-10 19:40:44 +0000250 return $stuff . $_;
Fred Drakefc16e781998-03-12 21:03:26 +0000251}
252
Fred Drake08932051998-04-17 02:15:42 +0000253# This is the prologue macro which is required to start writing the
254# mod\jobname.idx file; we can just ignore it.
255#
Fred Drake62e43691998-08-10 19:40:44 +0000256sub do_cmd_makemodindex{ return @_[0]; }
Fred Drakefc16e781998-03-12 21:03:26 +0000257
Fred Drake42b31a51998-03-27 05:16:10 +0000258# We're in the document subdirectory when this happens!
Fred Drake166abba1998-04-08 23:10:54 +0000259#
Fred Drake08932051998-04-17 02:15:42 +0000260open(IDXFILE, '>index.dat') || die "\n$!\n";
261open(INTLABELS, '>intlabels.pl') || die "\n$!\n";
Fred Drake166abba1998-04-08 23:10:54 +0000262print INTLABELS "%internal_labels = ();\n";
263print INTLABELS "1; # hack in case there are no entries\n\n";
264
265# Using \0 for this is bad because we can't use common tools to work with the
266# resulting files. Things like grep can be useful with this stuff!
267#
268$IDXFILE_FIELD_SEP = "\1";
269
Fred Drake42b31a51998-03-27 05:16:10 +0000270
271sub gen_target_name{
Fred Drake62e43691998-08-10 19:40:44 +0000272 return "l2h-" . @_[0];
Fred Drake42b31a51998-03-27 05:16:10 +0000273}
274
275sub gen_target{
Fred Drake62e43691998-08-10 19:40:44 +0000276 return '<a name="' . @_[0] . '">';
Fred Drake42b31a51998-03-27 05:16:10 +0000277}
278
279sub gen_link{
280 my($node,$target) = @_;
281 print INTLABELS "\$internal_labels{\"$target\"} = \"$URL/$node\";\n";
Fred Drake62e43691998-08-10 19:40:44 +0000282 return "<a href=\"$node#$target\">";
Fred Drake42b31a51998-03-27 05:16:10 +0000283}
284
285sub make_index_entry{
286 my($br_id,$str) = @_;
287 my($name,$aname,$ahref) = link_info($br_id);
288 add_index_entry($str, $ahref);
Fred Drake62e43691998-08-10 19:40:44 +0000289 return "$aname$anchor_invisible_mark</a>";
Fred Drake42b31a51998-03-27 05:16:10 +0000290}
291
292sub add_index_entry{
293 # add an entry to the index structures; ignore the return value
294 my($str,$ahref) = @_;
295 $str = gen_index_id($str, '');
296 $index{$str} .= $ahref;
Fred Drake166abba1998-04-08 23:10:54 +0000297 print IDXFILE $ahref, $IDXFILE_FIELD_SEP, $str, "\n";
Fred Drake42b31a51998-03-27 05:16:10 +0000298}
299
300sub link_info{
301 my $name = gen_target_name(@_[0]);
302 my $aname = gen_target($name);
303 my $ahref = gen_link($CURRENT_FILE, $name);
304 return ($name, $aname, $ahref);
305}
306
307sub do_cmd_index{
308 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000309 my($str,$br_id) = next_argument_id();
310 swallow_newline();
Fred Drake42b31a51998-03-27 05:16:10 +0000311 #
312 my($name,$aname,$ahref) = link_info($br_id);
313 add_index_entry("$str", $ahref);
Fred Drake62e43691998-08-10 19:40:44 +0000314 return "$aname$anchor_invisible_mark</a>" . $_;
Fred Drake42b31a51998-03-27 05:16:10 +0000315}
316
Fred Drake2e7edb81998-05-11 18:31:17 +0000317sub do_cmd_kwindex{
318 local($_) = @_;
319 my($str,$br_id) = next_argument_id();
320 #
321 my($name,$aname,$ahref) = link_info($br_id);
322 add_index_entry("<tt>$str</tt>!keyword", $ahref);
323 add_index_entry("keyword!<tt>$str</tt>", $ahref);
Fred Drake62e43691998-08-10 19:40:44 +0000324 return "$aname$anchor_invisible_mark</a>" . $_;
Fred Drake2e7edb81998-05-11 18:31:17 +0000325}
326
Fred Drake6659c301998-03-03 22:02:19 +0000327sub do_cmd_indexii{
328 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000329 my($str1,$br_id) = next_argument_id();
330 my $str2 = next_argument();
Fred Drake42b31a51998-03-27 05:16:10 +0000331 #
Fred Drake08932051998-04-17 02:15:42 +0000332 my($name,$aname,$ahref) = link_info($br_id);
Fred Drake42b31a51998-03-27 05:16:10 +0000333 add_index_entry("$str1!$str2", $ahref);
334 add_index_entry("$str2!$str1", $ahref);
Fred Drake62e43691998-08-10 19:40:44 +0000335 return "$aname$anchor_invisible_mark</a>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000336}
337
338sub do_cmd_indexiii{
339 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000340 my($str1,$br_id) = next_argument();
341 my $str2 = next_argument();
342 my $str3 = next_argument();
Fred Drake42b31a51998-03-27 05:16:10 +0000343 #
Fred Drake08932051998-04-17 02:15:42 +0000344 my($name,$aname,$ahref) = link_info($br_id);
Fred Drake42b31a51998-03-27 05:16:10 +0000345 add_index_entry("$str1!$str2 $str3", $ahref);
346 add_index_entry("$str2!$str3, $str1", $ahref);
347 add_index_entry("$str3!$str1 $str2", $ahref);
Fred Drake62e43691998-08-10 19:40:44 +0000348 return "$aname$anchor_invisible_mark</a>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000349}
350
351sub do_cmd_indexiv{
352 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000353 my($str1,$br_id) = next_argument();
354 my $str2 = next_argument();
355 my $str3 = next_argument();
356 my $str4 = next_argument();
Fred Drake42b31a51998-03-27 05:16:10 +0000357 #
Fred Drake08932051998-04-17 02:15:42 +0000358 my($name,$aname,$ahref) = link_info($br_id);
Fred Drake42b31a51998-03-27 05:16:10 +0000359 add_index_entry("$str1!$str2 $str3 $str4", $ahref);
360 add_index_entry("$str2!$str3 $str4, $str1", $ahref);
361 add_index_entry("$str3!$str4, $str1 $str2", $ahref);
362 add_index_entry("$str4!$$str1 $str2 $str3", $ahref);
Fred Drake62e43691998-08-10 19:40:44 +0000363 return "$aname$anchor_invisible_mark</a>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000364}
365
Fred Drakec9a44381998-03-17 06:29:13 +0000366sub do_cmd_ttindex{
367 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000368 my($str,$br_id) = next_argument_id();
369 swallow_newline();
Fred Drake62e43691998-08-10 19:40:44 +0000370 return make_index_entry($br_id, $str . get_indexsubitem()) . $_;
Fred Drakec9a44381998-03-17 06:29:13 +0000371}
Fred Drake6659c301998-03-03 22:02:19 +0000372
373sub my_typed_index_helper{
Fred Drakec9a44381998-03-17 06:29:13 +0000374 local($word,$_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000375 my($str,$br_id) = next_argument();
376 swallow_newline();
Fred Drake42b31a51998-03-27 05:16:10 +0000377 #
378 my($name,$aname,$ahref) = link_info($br_id1);
379 add_index_entry("$str $word", $ahref);
380 add_index_entry("$word!$str", $ahref);
Fred Drake62e43691998-08-10 19:40:44 +0000381 return "$aname$anchor_invisible_mark</a>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000382}
383
Fred Drake62e43691998-08-10 19:40:44 +0000384sub do_cmd_stindex{ return my_typed_index_helper('statement', @_); }
385sub do_cmd_opindex{ return my_typed_index_helper('operator', @_); }
386sub do_cmd_exindex{ return my_typed_index_helper('exception', @_); }
387sub do_cmd_obindex{ return my_typed_index_helper('object', @_); }
Fred Drake6659c301998-03-03 22:02:19 +0000388
389sub my_parword_index_helper{
Fred Drakec9a44381998-03-17 06:29:13 +0000390 local($word,$_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000391 my($str,$br_id) = next_argument_id();
392 swallow_newline();
Fred Drake62e43691998-08-10 19:40:44 +0000393 return make_index_entry($br_id, "$str ($word)") . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000394}
395
396
Fred Drake6659c301998-03-03 22:02:19 +0000397sub make_mod_index_entry{
Fred Drakec9a44381998-03-17 06:29:13 +0000398 my($br_id,$str,$define) = @_;
Fred Drake42b31a51998-03-27 05:16:10 +0000399 my($name,$aname,$ahref) = link_info($br_id);
Fred Drake42b31a51998-03-27 05:16:10 +0000400 # equivalent of add_index_entry() using $define instead of ''
401 $str = gen_index_id($str, $define);
402 $index{$str} .= $ahref;
Fred Drake166abba1998-04-08 23:10:54 +0000403 print IDXFILE $ahref, $IDXFILE_FIELD_SEP, $str, "\n";
Fred Drake42b31a51998-03-27 05:16:10 +0000404
Fred Drakec9a44381998-03-17 06:29:13 +0000405 if ($define eq 'DEF') {
Fred Drake42b31a51998-03-27 05:16:10 +0000406 # add to the module index
Fred Drakec9a44381998-03-17 06:29:13 +0000407 my($nstr,$garbage) = split / /, $str, 2;
Fred Drake42b31a51998-03-27 05:16:10 +0000408 $Modules{$nstr} .= $ahref;
Fred Drake6659c301998-03-03 22:02:19 +0000409 }
Fred Drake62e43691998-08-10 19:40:44 +0000410 return "$aname$anchor_invisible_mark</a>";
Fred Drake6659c301998-03-03 22:02:19 +0000411}
412
Fred Drakec9a44381998-03-17 06:29:13 +0000413$THIS_MODULE = '';
Fred Drake42b31a51998-03-27 05:16:10 +0000414$THIS_CLASS = '';
Fred Drakec9a44381998-03-17 06:29:13 +0000415
Fred Drakea0f4c941998-07-24 22:16:04 +0000416sub define_module{
417 my($word,$name) = @_;
Fred Drakec9a44381998-03-17 06:29:13 +0000418 my $section_tag = join('', @curr_sec_id);
Fred Drake6659c301998-03-03 22:02:19 +0000419 $word = "$word " if $word;
Fred Drakea0f4c941998-07-24 22:16:04 +0000420 $THIS_MODULE = "$name";
Fred Drake62e43691998-08-10 19:40:44 +0000421 return make_mod_index_entry("SECTION$section_tag",
422 "<tt>$name</tt> (${word}module)", 'DEF');
Fred Drakea0f4c941998-07-24 22:16:04 +0000423}
424
425sub my_module_index_helper{
426 local($word, $_) = @_;
427 my $name = next_argument();
428 swallow_newline();
Fred Drake62e43691998-08-10 19:40:44 +0000429 return define_module($word, $name) . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000430}
431
432sub ref_module_index_helper{
433 local($word, $_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000434 my($str,$br_id) = next_argument();
435 swallow_newline();
Fred Drake6659c301998-03-03 22:02:19 +0000436 $word = "$word " if $word;
Fred Drake62e43691998-08-10 19:40:44 +0000437 return make_mod_index_entry($br_id,
438 "<tt>$str</tt> (${word}module)", 'REF') . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000439}
440
Fred Drakec9a44381998-03-17 06:29:13 +0000441sub do_cmd_bifuncindex{
442 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000443 my($str,$br_id) = next_argument();
444 swallow_newline();
445 my $fname = "<tt>$str()</tt>";
Fred Drake62e43691998-08-10 19:40:44 +0000446 return make_index_entry($br_id, "$fname (built-in function)") . $_;
Fred Drakec9a44381998-03-17 06:29:13 +0000447}
448
Fred Drake62e43691998-08-10 19:40:44 +0000449sub do_cmd_modindex{ return my_module_index_helper('', @_); }
450sub do_cmd_bimodindex{ return my_module_index_helper('built-in', @_); }
451sub do_cmd_exmodindex{ return my_module_index_helper('extension', @_); }
452sub do_cmd_stmodindex{ return my_module_index_helper('standard', @_); }
Fred Drake6659c301998-03-03 22:02:19 +0000453
454# these should be adjusted a bit....
Fred Drake62e43691998-08-10 19:40:44 +0000455sub do_cmd_refmodindex{ return ref_module_index_helper('', @_); }
456sub do_cmd_refbimodindex{ return ref_module_index_helper('built-in', @_); }
457sub do_cmd_refexmodindex{ return ref_module_index_helper('extension', @_); }
458sub do_cmd_refstmodindex{ return ref_module_index_helper('standard', @_); }
Fred Drake6659c301998-03-03 22:02:19 +0000459
Fred Drake62e43691998-08-10 19:40:44 +0000460sub do_cmd_nodename{ return do_cmd_label(@_); }
Fred Drake6659c301998-03-03 22:02:19 +0000461
462sub init_myformat{
Fred Drake08932051998-04-17 02:15:42 +0000463# $anchor_invisible_mark = '';
Fred Drake6659c301998-03-03 22:02:19 +0000464 $anchor_mark = '';
465 $icons{'anchor_mark'} = '';
Fred Drake6659c301998-03-03 22:02:19 +0000466}
Fred Drake42b31a51998-03-27 05:16:10 +0000467init_myformat();
Fred Drake6659c301998-03-03 22:02:19 +0000468
469# similar to make_index_entry(), but includes the string in the result
470# instead of the dummy filler.
471#
472sub make_str_index_entry{
Fred Drakec9a44381998-03-17 06:29:13 +0000473 my($br_id,$str) = @_;
Fred Drake42b31a51998-03-27 05:16:10 +0000474 my($name,$aname,$ahref) = link_info($br_id);
Fred Drake42b31a51998-03-27 05:16:10 +0000475 add_index_entry($str, $ahref);
Fred Drake62e43691998-08-10 19:40:44 +0000476 return "$aname$str</a>";
Fred Drake6659c301998-03-03 22:02:19 +0000477}
478
Fred Drake6659c301998-03-03 22:02:19 +0000479sub do_env_cfuncdesc{
480 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000481 my $return_type = next_argument();
482 my($function_name,$br_id) = next_argument_id();
483 my $arg_list = next_argument();
484 my $idx = make_str_index_entry($br_id,
485 "<tt>$function_name()</tt>" . get_indexsubitem());
486 $idx =~ s/ \(.*\)//;
487 $idx =~ s/\(\)//; # ????
Fred Drake62e43691998-08-10 19:40:44 +0000488 return "<dl><dt>$return_type <b>$idx</b>"
489 . "(<var>$arg_list</var>)\n<dd>"
490 . $_
491 . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000492}
493
494sub do_env_ctypedesc{
495 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000496 my($type_name,$br_id) = next_argument_id();
497 my $idx = make_str_index_entry($br_id,
498 "<tt>$type_name</tt>" . get_indexsubitem());
499 $idx =~ s/ \(.*\)//;
Fred Drake62e43691998-08-10 19:40:44 +0000500 return "<dl><dt><b>$idx</b>\n<dd>"
501 . $_
502 . '</dl>'
Fred Drake6659c301998-03-03 22:02:19 +0000503}
504
505sub do_env_cvardesc{
506 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000507 my $var_type = next_argument();
508 my($var_name,$br_id) = next_argument_id();
509 my $idx = make_str_index_entry($br_id,
510 "<tt>$var_name</tt>" . get_indexsubitem());
511 $idx =~ s/ \(.*\)//;
Fred Drake62e43691998-08-10 19:40:44 +0000512 return "<dl><dt>$var_type <b>$idx</b>\n"
513 . '<dd>'
514 . $_
515 . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000516}
517
518sub do_env_funcdesc{
519 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000520 my $function_name = next_argument();
521 my($arg_list,$br_id) = next_argument_id();
522 my $idx = make_str_index_entry($br_id, "<tt>$function_name()</tt>"
523 . get_indexsubitem());
524 $idx =~ s/ \(.*\)//;
525 $idx =~ s/\(\)//;
Fred Drake62e43691998-08-10 19:40:44 +0000526 return "<dl><dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_ . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000527}
528
529sub do_env_funcdescni{
530 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000531 my $function_name = next_argument();
532 my $arg_list = next_argument();
Fred Drake62e43691998-08-10 19:40:44 +0000533 return "<dl><dt><b><tt>$function_name</tt></b> (<var>$arg_list</var>)\n"
534 . "<dd>"
535 . $_ . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000536}
537
538sub do_cmd_funcline{
539 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000540 my $function_name = next_argument();
541 my($arg_list,$br_id) = next_argument_id();
Fred Drake42b31a51998-03-27 05:16:10 +0000542 my $idx = make_str_index_entry($br_id, "<tt>$function_name()</tt>"
Fred Drake08932051998-04-17 02:15:42 +0000543 . get_indexsubitem());
Fred Drakec9a44381998-03-17 06:29:13 +0000544 $idx =~ s/\(\)//;
Fred Drake62e43691998-08-10 19:40:44 +0000545 return "<dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000546}
547
548# Change this flag to index the opcode entries. I don't think it's very
549# useful to index them, since they're only presented to describe the dis
550# module.
551#
552$INDEX_OPCODES = 0;
553
554sub do_env_opcodedesc{
555 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000556 my $opcode_name = next_argument();
557 my($arg_list,$br_id) = next_argument_id();
558 my $idx;
559 if ($INDEX_OPCODES) {
560 $idx = make_str_index_entry($br_id,
Fred Drake6659c301998-03-03 22:02:19 +0000561 "<tt>$opcode_name</tt> (byte code instruction)");
Fred Drake08932051998-04-17 02:15:42 +0000562 $idx =~ s/ \(byte code instruction\)//;
563 }
564 else {
565 $idx = "<tt>$opcode_name</tt>";
566 }
567 my $stuff = "<dl><dt><b>$idx</b>";
Fred Drake6659c301998-03-03 22:02:19 +0000568 if ($arg_list) {
569 $stuff .= "&nbsp;&nbsp;&nbsp;&nbsp;<var>$arg_list</var>";
570 }
Fred Drake62e43691998-08-10 19:40:44 +0000571 return $stuff . "\n<dd>" . $_ . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000572}
573
574sub do_env_datadesc{
575 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000576 my($dataname,$br_id) = next_argument_id();
577 my $idx = make_str_index_entry($br_id,
578 "<tt>$dataname</tt>" . get_indexsubitem());
579 $idx =~ s/ \(.*\)//;
Fred Drake62e43691998-08-10 19:40:44 +0000580 return "<dl><dt><b>$idx</b>\n<dd>"
581 . $_
582 . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000583}
584
585sub do_env_datadescni{
586 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000587 my $idx = next_argument();
588 if (! $STRING_INDEX_TT) {
589 $idx = "<tt>$idx</tt>";
Fred Drake6659c301998-03-03 22:02:19 +0000590 }
Fred Drake62e43691998-08-10 19:40:44 +0000591 return "<dl><dt><b>$idx</b>\n<dd>" . $_ . '</dl>';
Fred Drake6659c301998-03-03 22:02:19 +0000592}
593
594sub do_cmd_dataline{
595 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000596 my($data_name,$br_id) = next_argument_id();
Fred Drake42b31a51998-03-27 05:16:10 +0000597 my $idx = make_str_index_entry($br_id, "<tt>$data_name</tt>"
Fred Drake08932051998-04-17 02:15:42 +0000598 . get_indexsubitem());
Fred Drake6659c301998-03-03 22:02:19 +0000599 $idx =~ s/ \(.*\)//;
Fred Drake62e43691998-08-10 19:40:44 +0000600 return "<dt><b>$idx</b><dd>" . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000601}
602
Fred Drake42b31a51998-03-27 05:16:10 +0000603sub do_env_excdesc{
604 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000605 my($excname,$br_id) = next_argument_id();
Fred Drake166abba1998-04-08 23:10:54 +0000606 my $idx = make_str_index_entry($br_id, "<tt>$excname</tt>");
Fred Drake62e43691998-08-10 19:40:44 +0000607 return "<dl><dt><b>$idx</b>\n<dd>" . $_ . '</dl>'
Fred Drake42b31a51998-03-27 05:16:10 +0000608}
609
Fred Drake62e43691998-08-10 19:40:44 +0000610sub do_env_fulllineitems{ return do_env_itemize(@_); }
Fred Drake6659c301998-03-03 22:02:19 +0000611
612
Fred Drakec9a44381998-03-17 06:29:13 +0000613sub do_env_classdesc{
614 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000615 $THIS_CLASS = next_argument();
616 my($arg_list,$br_id) = next_argument_id();
617 $idx = make_str_index_entry($br_id,
618 "<tt>$THIS_CLASS</tt> (class in $THIS_MODULE)" );
619 $idx =~ s/ \(.*\)//;
Fred Drake62e43691998-08-10 19:40:44 +0000620 return "<dl><dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_ . '</dl>';
Fred Drakec9a44381998-03-17 06:29:13 +0000621}
622
Fred Drake42b31a51998-03-27 05:16:10 +0000623
624sub do_env_methoddesc{
625 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000626 my $class_name = next_optional_argument();
627 $class_name = $THIS_CLASS
628 unless $class_name;
629 my($method_name,$br_id) = next_argument_id();
630 my $arg_list = next_argument();
631 my $extra = '';
632 if ($class_name) {
633 $extra = " ($class_name method)";
Fred Drake42b31a51998-03-27 05:16:10 +0000634 }
Fred Drake08932051998-04-17 02:15:42 +0000635 my $idx = make_str_index_entry($br_id, "<tt>$method_name()</tt>$extra");
636 $idx =~ s/ \(.*\)//;
637 $idx =~ s/\(\)//;
Fred Drake62e43691998-08-10 19:40:44 +0000638 return "<dl><dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_ . '</dl>';
Fred Drake42b31a51998-03-27 05:16:10 +0000639}
640
641
Fred Draked64a40d1998-09-10 18:59:13 +0000642sub do_cmd_methodlineni{
643 local($_) = @_;
644 next_optional_argument();
645 my $method = next_argument();
646 my $arg_list = next_argument();
647 return "<dt><b>$method</b> (<var>$arg_list</var>)\n<dd>"
648 . $_;
649}
650
Fred Drake42b31a51998-03-27 05:16:10 +0000651sub do_env_methoddescni{
652 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000653 next_optional_argument();
654 my $method = next_argument();
655 my $arg_list = next_argument();
Fred Drake62e43691998-08-10 19:40:44 +0000656 return "<dl><dt><b>$method</b> (<var>$arg_list</var>)\n<dd>"
657 . $_
658 . '</dl>';
Fred Drake42b31a51998-03-27 05:16:10 +0000659}
660
661
662sub do_env_memberdesc{
663 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000664 my $class = next_optional_argument();
665 my($member,$br_id) = next_argument();
Fred Drake42b31a51998-03-27 05:16:10 +0000666 $class = $THIS_CLASS
667 unless $class;
Fred Drake08932051998-04-17 02:15:42 +0000668 my $extra = '';
Fred Drake42b31a51998-03-27 05:16:10 +0000669 $extra = " ($class_name attribute)"
Fred Drakea608feb1998-04-12 03:58:13 +0000670 if (!($class eq ''));
Fred Drake08932051998-04-17 02:15:42 +0000671 my $idx = make_str_index_entry($br_id, "<tt>$member</tt>$extra");
Fred Drake42b31a51998-03-27 05:16:10 +0000672 $idx =~ s/ \(.*\)//;
673 $idx =~ s/\(\)//;
Fred Drake62e43691998-08-10 19:40:44 +0000674 return "<dl><dt><b>$idx</b>\n<dd>" . $_ . '</dl>';
Fred Drake42b31a51998-03-27 05:16:10 +0000675}
676
677
Fred Drake5ccf3301998-04-17 20:04:09 +0000678sub do_cmd_memberline{
679 local($_) = @_;
680 my $class = next_optional_argument();
681 my($member,$br_id) = next_argument_id();
682 $class = $THIS_CLASS
683 unless $class;
684 my $extra = '';
685 $extra = " ($class_name attribute)"
686 if (!($class eq ''));
687 my $idx = make_str_index_entry($br_id, "<tt>$member</tt>$extra");
688 $idx =~ s/ \(.*\)//;
689 $idx =~ s/\(\)//;
Fred Drake62e43691998-08-10 19:40:44 +0000690 return "<dt><b>$idx</b><dd>" . $_;
Fred Drake5ccf3301998-04-17 20:04:09 +0000691}
692
Fred Drake42b31a51998-03-27 05:16:10 +0000693sub do_env_memberdescni{
694 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000695 next_optional_argument();
696 my $member = next_argument();
Fred Drake62e43691998-08-10 19:40:44 +0000697 return "<dl><dt><b>$member</b>\n<dd>" . $_ . '</dl>';
Fred Drake42b31a51998-03-27 05:16:10 +0000698}
699
700
Fred Drake5ccf3301998-04-17 20:04:09 +0000701sub do_cmd_memberlineni{
702 local($_) = @_;
703 next_optional_argument();
704 my $member = next_argument();
Fred Drake62e43691998-08-10 19:40:44 +0000705 return "<dt><b>$member</b><dd>" . $_;
Fred Drake5ccf3301998-04-17 20:04:09 +0000706}
707
Fred Drakea0f4c941998-07-24 22:16:04 +0000708@col_aligns = ("<td>", "<td>", "<td>", "<td>");
Fred Drake6659c301998-03-03 22:02:19 +0000709
710sub setup_column_alignments{
711 local($_) = @_;
Fred Drakea0f4c941998-07-24 22:16:04 +0000712 my($a1,$a2,$a3,$a4) = split(/[|]/,$_);
713 my($th1,$th2,$th3,$th4) = ('<th>', '<th>', '<th>', '<th>');
Fred Drake08932051998-04-17 02:15:42 +0000714 $col_aligns[0] = (($a1 eq 'c') ? '<td align=center>' : '<td>');
715 $col_aligns[1] = (($a2 eq 'c') ? '<td align=center>' : '<td>');
716 $col_aligns[2] = (($a3 eq 'c') ? '<td align=center>' : '<td>');
Fred Drakea0f4c941998-07-24 22:16:04 +0000717 $col_aligns[3] = (($a4 eq 'c') ? '<td align=center>' : '<td>');
Fred Drake6659c301998-03-03 22:02:19 +0000718 # return the aligned header start tags; only used for \begin{tableiii?}
Fred Drake08932051998-04-17 02:15:42 +0000719 $th1 = (($a1 eq 'l') ? '<th align=left>'
720 : ($a1 eq 'r' ? '<th align=right>' : '<th>'));
721 $th2 = (($a2 eq 'l') ? '<th align=left>'
722 : ($a2 eq 'r' ? '<th align=right>' : '<th>'));
723 $th3 = (($a3 eq 'l') ? '<th align=left>'
724 : ($a3 eq 'r' ? '<th align=right>' : '<th>'));
Fred Drakea0f4c941998-07-24 22:16:04 +0000725 $th4 = (($a4 eq 'l') ? '<th align=left>'
726 : ($a4 eq 'r' ? '<th align=right>' : '<th>'));
Fred Drake62e43691998-08-10 19:40:44 +0000727 return ($th1, $th2, $th3, $th4);
Fred Drake6659c301998-03-03 22:02:19 +0000728}
729
730sub do_env_tableii{
731 local($_) = @_;
Fred Drakea0f4c941998-07-24 22:16:04 +0000732 my($th1,$th2,$th3,$th4) = setup_column_alignments(next_argument());
Fred Drake08932051998-04-17 02:15:42 +0000733 my $font = next_argument();
734 my $h1 = next_argument();
735 my $h2 = next_argument();
736 $font = ''
737 if ($font eq 'textrm');
738 $globals{'lineifont'} = $font;
Fred Drake62e43691998-08-10 19:40:44 +0000739 return '<table border align=center>'
740 . "\n <tr>$th1<b>$h1</b></th>"
741 . "\n $th2<b>$h2</b></th>"
742 . $_
743 . "\n</table>";
Fred Drake6659c301998-03-03 22:02:19 +0000744}
745
746sub do_cmd_lineii{
747 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000748 my $c1 = next_argument();
749 my $c2 = next_argument();
750 my($font,$sfont,$efont) = ($globals{'lineifont'}, '', '');
Fred Drake58b2bfd1998-04-02 20:14:04 +0000751 if ($font) {
Fred Drake5cca42e1998-04-09 17:59:11 +0000752 $sfont = "<$font>";
Fred Drake58b2bfd1998-04-02 20:14:04 +0000753 $efont = "</$font>";
754 }
Fred Drakec9a44381998-03-17 06:29:13 +0000755 my($c1align,$c2align) = @col_aligns[0,1];
Fred Drake62e43691998-08-10 19:40:44 +0000756 return "<tr>$c1align$sfont$c1$efont</td>\n"
757 . " $c2align$c2</td>"
758 . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000759}
760
761sub do_env_tableiii{
762 local($_) = @_;
Fred Drakea0f4c941998-07-24 22:16:04 +0000763 my($th1,$th2,$th3,$th4) = setup_column_alignments(next_argument());
Fred Drake08932051998-04-17 02:15:42 +0000764 my $font = next_argument();
765 my $h1 = next_argument();
766 my $h2 = next_argument();
767 my $h3 = next_argument();
768 $font = ''
769 if ($font eq 'textrm');
770 $globals{'lineifont'} = $font;
Fred Drake62e43691998-08-10 19:40:44 +0000771 return '<table border align=center>'
772 . "\n <tr>$th1<b>$h1</b></th>"
773 . "\n $th2<b>$h2</b></th>"
774 . "\n $th3<b>$h3</b></th>"
775 . $_
776 . "\n</table>";
Fred Drake6659c301998-03-03 22:02:19 +0000777}
778
779sub do_cmd_lineiii{
780 local($_) = @_;
Fred Drake08932051998-04-17 02:15:42 +0000781 my $c1 = next_argument();
782 my $c2 = next_argument();
783 my $c3 = next_argument();
784 my($font,$sfont,$efont) = ($globals{'lineifont'}, '', '');
Fred Drake58b2bfd1998-04-02 20:14:04 +0000785 if ($font) {
Fred Drake5cca42e1998-04-09 17:59:11 +0000786 $sfont = "<$font>";
Fred Drake58b2bfd1998-04-02 20:14:04 +0000787 $efont = "</$font>";
788 }
Fred Drakea0f4c941998-07-24 22:16:04 +0000789 my($c1align,$c2align,$c3align) = @col_aligns[0,1,2];
Fred Drake62e43691998-08-10 19:40:44 +0000790 return "<tr>$c1align$sfont$c1$efont</td>\n"
791 . " $c2align$c2</td>\n"
792 . " $c3align$c3</td>"
793 . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000794}
795
Fred Drakea0f4c941998-07-24 22:16:04 +0000796sub do_env_tableiv{
797 local($_) = @_;
798 my($th1,$th2,$th3,$th4) = setup_column_alignments(next_argument());
799 my $font = next_argument();
800 my $h1 = next_argument();
801 my $h2 = next_argument();
802 my $h3 = next_argument();
803 my $h4 = next_argument();
804 $font = ''
805 if ($font eq 'textrm');
806 $globals{'lineifont'} = $font;
Fred Drake62e43691998-08-10 19:40:44 +0000807 return '<table border align=center>'
808 . "\n <tr>$th1<b>$h1</b></th>"
809 . "\n $th2<b>$h2</b></th>"
810 . "\n $th3<b>$h3</b></th>"
811 . "\n $th4<b>$h4</b></th>"
812 . $_
813 . "\n</table>";
Fred Drake6659c301998-03-03 22:02:19 +0000814}
815
Fred Drakea0f4c941998-07-24 22:16:04 +0000816sub do_cmd_lineiv{
Fred Drake6659c301998-03-03 22:02:19 +0000817 local($_) = @_;
Fred Drakea0f4c941998-07-24 22:16:04 +0000818 my $c1 = next_argument();
819 my $c2 = next_argument();
820 my $c3 = next_argument();
821 my $c4 = next_argument();
822 my($font,$sfont,$efont) = ($globals{'lineifont'}, '', '');
823 if ($font) {
824 $sfont = "<$font>";
825 $efont = "</$font>";
826 }
827 my($c1align,$c2align,$c3align,$c4align) = @col_aligns;
Fred Drake62e43691998-08-10 19:40:44 +0000828 return "<tr>$c1align$sfont$c1$efont</td>\n"
829 . " $c2align$c2</td>\n"
830 . " $c3align$c3</td>\n"
831 . " $c4align$c4</td>"
832 . $_;
Fred Drake6659c301998-03-03 22:02:19 +0000833}
834
Fred Drake6659c301998-03-03 22:02:19 +0000835sub do_cmd_maketitle {
836 local($_) = @_;
Fred Drakec9a44381998-03-17 06:29:13 +0000837 my $the_title = '';
Fred Drake6659c301998-03-03 22:02:19 +0000838 if ($t_title) {
Fred Drakec9a44381998-03-17 06:29:13 +0000839 $the_title .= "<h1 align=center>$t_title</h1>";
Fred Drake08932051998-04-17 02:15:42 +0000840 } else { write_warnings("\nThis document has no title."); }
Fred Drakec9a44381998-03-17 06:29:13 +0000841 $the_title .= "\n<center>";
Fred Drake6659c301998-03-03 22:02:19 +0000842 if ($t_author) {
843 if ($t_authorURL) {
Fred Drake08932051998-04-17 02:15:42 +0000844 my $href = translate_commands($t_authorURL);
845 $href = make_named_href('author', $href, "<strong>${t_author}</strong>");
Fred Drakec9a44381998-03-17 06:29:13 +0000846 $the_title .= "\n<p>$href</p>";
Fred Drake6659c301998-03-03 22:02:19 +0000847 } else {
Fred Drakec9a44381998-03-17 06:29:13 +0000848 $the_title .= "\n<p><strong>$t_author</strong></p>";
Fred Drake6659c301998-03-03 22:02:19 +0000849 }
Fred Drake08932051998-04-17 02:15:42 +0000850 } else { write_warnings("\nThere is no author for this document."); }
Fred Drake6659c301998-03-03 22:02:19 +0000851 if ($t_institute) {
Fred Drakec9a44381998-03-17 06:29:13 +0000852 $the_title .= "\n<p>$t_institute</p>";}
Fred Draked07868a1998-05-14 21:00:28 +0000853 if ($DEVELOPER_ADDRESS) {
854 $the_title .= "\n<p>$DEVELOPER_ADDRESS</p>";}
Fred Drake6659c301998-03-03 22:02:19 +0000855 if ($t_affil) {
Fred Drakec9a44381998-03-17 06:29:13 +0000856 $the_title .= "\n<p><i>$t_affil</i></p>";}
Fred Drake6659c301998-03-03 22:02:19 +0000857 if ($t_date) {
Fred Drakec9a44381998-03-17 06:29:13 +0000858 $the_title .= "\n<p><strong>$t_date</strong>";
Fred Drake6659c301998-03-03 22:02:19 +0000859 if ($PYTHON_VERSION) {
860 $the_title .= "<br><strong>Release $PYTHON_VERSION</strong>";}
861 $the_title .= "</p>"
862 }
Fred Drakec9a44381998-03-17 06:29:13 +0000863 $the_title .= "\n</center>";
Fred Drake6659c301998-03-03 22:02:19 +0000864 if ($t_address) {
Fred Drakec9a44381998-03-17 06:29:13 +0000865 $the_title .= "\n<p>$t_address</p>";
866 } else { $the_title .= "\n<p>"}
Fred Drake6659c301998-03-03 22:02:19 +0000867 if ($t_email) {
Fred Drakec9a44381998-03-17 06:29:13 +0000868 $the_title .= "\n<p>$t_email</p>";
869 }# else { $the_title .= "</p>" }
Fred Drake62e43691998-08-10 19:40:44 +0000870 return $the_title . $_ ;
Fred Drake6659c301998-03-03 22:02:19 +0000871}
872
873
Fred Drake885215c1998-05-20 21:32:09 +0000874#
Fred Drakea0f4c941998-07-24 22:16:04 +0000875# Module synopsis support
876#
877
878require SynopsisTable;
879
Fred Drakef7685d71998-07-25 03:31:46 +0000880sub get_chapter_id(){
881 my $id = do_cmd_thechapter('');
Fred Drake45f26011998-08-04 22:07:18 +0000882 $id =~ s/<SPAN CLASS="arabic">(\d+)<\/SPAN>/\1/;
883 $id =~ s/\.//;
Fred Drakef7685d71998-07-25 03:31:46 +0000884 return $id;
Fred Drakea0f4c941998-07-24 22:16:04 +0000885}
886
Fred Drakef7685d71998-07-25 03:31:46 +0000887%ModuleSynopses = ('chapter' => 'SynopsisTable instance');
888
889sub get_synopsis_table($){
890 my($chap) = @_;
Fred Drakea0f4c941998-07-24 22:16:04 +0000891 my $st = $ModuleSynopses{$chap};
Fred Drakef7685d71998-07-25 03:31:46 +0000892 my $key;
893 foreach $key (keys %ModuleSynopses) {
894 if ($key eq $chap) {
895 return $ModuleSynopses{$chap};
896 }
Fred Drakea0f4c941998-07-24 22:16:04 +0000897 }
Fred Drakef7685d71998-07-25 03:31:46 +0000898 $st = SynopsisTable->new();
899 $ModuleSynopses{$chap} = $st;
Fred Drakea0f4c941998-07-24 22:16:04 +0000900 return $st;
901}
902
Fred Drake62e43691998-08-10 19:40:44 +0000903sub do_cmd_moduleauthor{
904 local($_) = @_;
905 next_argument();
906 next_argument();
907 return $_;
908}
909
910sub do_cmd_sectionauthor{
911 local($_) = @_;
912 next_argument();
913 next_argument();
914 return $_;
915}
916
Fred Drakea0f4c941998-07-24 22:16:04 +0000917sub do_cmd_declaremodule{
918 local($_) = @_;
919 my $key = next_optional_argument();
920 my $type = next_argument();
921 my $name = next_argument();
922 my $st = get_synopsis_table(get_chapter_id());
923 #
924 $key = $name unless $key;
925 $type = 'built-in' if $type eq 'builtin';
926 $st->declare($name, $key, $type);
927 define_module($type, $name);
Fred Drake62e43691998-08-10 19:40:44 +0000928 return anchor_label("module-$key",$CURRENT_FILE,$_)
Fred Drakea0f4c941998-07-24 22:16:04 +0000929}
930
931sub do_cmd_modulesynopsis{
932 local($_) = @_;
933 my $st = get_synopsis_table(get_chapter_id());
934 $st->set_synopsis($THIS_MODULE, next_argument());
935 swallow_newline();
Fred Drake62e43691998-08-10 19:40:44 +0000936 return $_;
Fred Drakea0f4c941998-07-24 22:16:04 +0000937}
938
939sub do_cmd_localmoduletable{
940 local($_) = @_;
Fred Drakea0f4c941998-07-24 22:16:04 +0000941 my $chap = get_chapter_id();
Fred Drake62e43691998-08-10 19:40:44 +0000942 return "<tex2htmllocalmoduletable><$chap>\\tableofchildlinks[off]" . $_;
Fred Drakea0f4c941998-07-24 22:16:04 +0000943}
944
945sub process_all_localmoduletables{
946 while (/<tex2htmllocalmoduletable><(\d+)>/) {
Fred Drakef7685d71998-07-25 03:31:46 +0000947 my $match = $&;
Fred Drakea0f4c941998-07-24 22:16:04 +0000948 my $chap = $1;
949 my $st = get_synopsis_table($chap);
950 my $data = $st->tohtml();
Fred Drakef7685d71998-07-25 03:31:46 +0000951 s/$match/$data/;
Fred Drakea0f4c941998-07-24 22:16:04 +0000952 }
953}
954
955
956#
957# "See also:" -- references placed at the end of a \section
958#
959
960sub do_env_seealso{
Fred Drake62e43691998-08-10 19:40:44 +0000961 return "<p><b>See Also:</b></p>\n" . @_[0];
Fred Drakea0f4c941998-07-24 22:16:04 +0000962}
963
964sub do_cmd_seemodule{
965 # Insert the right magic to jump to the module definition. This should
966 # work most of the time, at least for repeat builds....
967 local($_) = @_;
968 my $key = next_optional_argument();
969 my $module = next_argument();
970 my $text = next_argument();
971 $key = $module
972 unless $key;
Fred Drake62e43691998-08-10 19:40:44 +0000973 return "<p>Module <tt><b><a href=\"module-$key.html\">$module</a></b></tt>"
974 . "&nbsp;&nbsp;&nbsp;($text)</p>"
975 . $_;
Fred Drakea0f4c941998-07-24 22:16:04 +0000976}
977
978sub do_cmd_seetext{
Fred Drake62e43691998-08-10 19:40:44 +0000979 return '<p>' . @_[0];
Fred Drakea0f4c941998-07-24 22:16:04 +0000980}
981
982
983#
Fred Drake885215c1998-05-20 21:32:09 +0000984# Definition list support.
985#
986
987sub do_env_definitions{
988 local($_) = @_;
989 swallow_newline();
Fred Drake62e43691998-08-10 19:40:44 +0000990 return "<dl>$_</dl>\n";
Fred Drake885215c1998-05-20 21:32:09 +0000991}
992
993sub do_cmd_term{
994 local($_) = @_;
995 my($term, $id) = next_argument_id();
996 my($name,$aname,$ahref) = link_info($id);
997 swallow_newline();
998 # could easily add an index entry here...
Fred Drake62e43691998-08-10 19:40:44 +0000999 return "<dt><b>$aname" . $term . "</a></b>\n<dd>" . $_;
Fred Drake885215c1998-05-20 21:32:09 +00001000}
1001
1002
Fred Drake6659c301998-03-03 22:02:19 +000010031; # This must be the last line