Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 1 | # 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 | |
| 9 | package main; |
| 10 | |
| 11 | |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 12 | sub 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 Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 17 | return ($param, $br_id); |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 18 | } |
| 19 | |
| 20 | sub next_argument{ |
| 21 | my ($param,$br_id) = next_argument_id(); |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 22 | return $param; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 23 | } |
| 24 | |
| 25 | sub next_optional_argument{ |
| 26 | my($param,$rx) = ('', "^\\s*(\\[([^]]*)\\])?"); |
Fred Drake | 5ccf330 | 1998-04-17 20:04:09 +0000 | [diff] [blame] | 27 | s/$rx/$param=$2;''/eo; |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 28 | return $param; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 29 | } |
| 30 | |
| 31 | sub swallow_newline{ |
| 32 | s/[\n]?//o; |
| 33 | } |
| 34 | |
Fred Drake | e16f679 | 1998-05-15 04:28:37 +0000 | [diff] [blame] | 35 | |
| 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 Drake | 5b73cdf | 1998-05-15 16:59:38 +0000 | [diff] [blame] | 38 | # Many possible uses of \let aren't supported or aren't supported correctly. |
Fred Drake | e16f679 | 1998-05-15 04:28:37 +0000 | [diff] [blame] | 39 | # |
| 40 | sub do_cmd_let{ |
| 41 | local($_) = @_; |
| 42 | my $matched = 0; |
Fred Drake | 7a4ad0f | 1998-05-15 13:45:54 +0000 | [diff] [blame] | 43 | s/[\\]([a-zA-Z]+)\s*(=\s*)?[\\]([a-zA-Z]*)/$matched=1; ''/e; |
Fred Drake | e16f679 | 1998-05-15 04:28:37 +0000 | [diff] [blame] | 44 | 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 Drake | 7a4ad0f | 1998-05-15 13:45:54 +0000 | [diff] [blame] | 49 | 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 Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 60 | return $_; |
Fred Drake | e16f679 | 1998-05-15 04:28:37 +0000 | [diff] [blame] | 61 | } |
| 62 | |
| 63 | |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 64 | # words typeset in a special way (not in HTML though) |
| 65 | |
| 66 | sub do_cmd_ABC{ 'ABC' . @_[0]; } |
| 67 | sub do_cmd_UNIX{ 'Unix'. @_[0]; } |
| 68 | sub do_cmd_ASCII{ 'ASCII' . @_[0]; } |
| 69 | sub do_cmd_POSIX{ 'POSIX' . @_[0]; } |
| 70 | sub do_cmd_C{ 'C' . @_[0]; } |
| 71 | sub do_cmd_Cpp{ 'C++' . @_[0]; } |
| 72 | sub do_cmd_EOF{ 'EOF' . @_[0]; } |
| 73 | sub do_cmd_NULL{ '<tt>NULL</tt>' . @_[0]; } |
| 74 | |
| 75 | sub do_cmd_e{ '\' . @_[0]; } |
| 76 | |
Fred Drake | d07868a | 1998-05-14 21:00:28 +0000 | [diff] [blame] | 77 | $DEVELOPER_ADDRESS = ''; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 78 | $PYTHON_VERSION = ''; |
| 79 | |
| 80 | sub do_cmd_version{ $PYTHON_VERSION . @_[0]; } |
| 81 | sub do_cmd_release{ |
| 82 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 83 | $PYTHON_VERSION = next_argument(); |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 84 | return $_; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 85 | } |
| 86 | |
| 87 | sub do_cmd_authoraddress{ |
| 88 | local($_) = @_; |
Fred Drake | d07868a | 1998-05-14 21:00:28 +0000 | [diff] [blame] | 89 | $DEVELOPER_ADDRESS = next_argument(); |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 90 | return $_; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 91 | } |
| 92 | |
Fred Drake | e16f679 | 1998-05-15 04:28:37 +0000 | [diff] [blame] | 93 | #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 Drake | d07868a | 1998-05-14 21:00:28 +0000 | [diff] [blame] | 96 | |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 97 | sub do_cmd_hackscore{ |
| 98 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 99 | next_argument(); |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 100 | return '_' . $_; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 101 | } |
| 102 | |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 103 | sub use_wrappers{ |
| 104 | local($_,$before,$after) = @_; |
| 105 | my $stuff = next_argument(); |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 106 | return $before . $stuff . $after . $_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 107 | } |
| 108 | |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 109 | sub use_current{ |
| 110 | return use_wrappers(@_[0], '', ''); |
| 111 | } |
| 112 | sub use_sans_serif{ |
| 113 | return use_wrappers(@_[0], '<font face=sans-serif>', '</font>'); |
| 114 | } |
| 115 | sub use_italics{ |
| 116 | return use_wrappers(@_[0], '<i>', '</i>'); |
| 117 | } |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 118 | |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 119 | sub do_cmd_optional{ |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 120 | return use_wrappers(@_[0], "</var><big>\[</big><var>", |
| 121 | "</var><big>\]</big><var>"); |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 122 | } |
| 123 | |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 124 | # 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 Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 128 | |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 129 | sub do_cmd_pytype{ return use_current(@_); } |
| 130 | sub do_cmd_makevar{ return use_current(@_); } |
| 131 | sub do_cmd_code{ return use_wrappers(@_[0], '<tt>', '</tt>'); } |
| 132 | sub do_cmd_module{ return do_cmd_code(@_); } |
| 133 | sub do_cmd_keyword{ return do_cmd_code(@_); } |
| 134 | sub do_cmd_exception{ return do_cmd_code(@_); } |
| 135 | sub do_cmd_class{ return do_cmd_code(@_); } |
| 136 | sub do_cmd_function{ return do_cmd_code(@_); } |
| 137 | sub do_cmd_constant{ return do_cmd_code(@_); } |
| 138 | sub do_cmd_member{ return do_cmd_code(@_); } |
| 139 | sub do_cmd_method{ return do_cmd_code(@_); } |
| 140 | sub do_cmd_cfunction{ return do_cmd_code(@_); } |
| 141 | sub do_cmd_cdata{ return do_cmd_code(@_); } |
| 142 | sub do_cmd_ctype{ return do_cmd_code(@_); } |
| 143 | sub do_cmd_regexp{ return do_cmd_code(@_); } |
| 144 | sub do_cmd_character{ return do_cmd_samp(@_); } |
| 145 | sub do_cmd_program{ return do_cmd_strong(@_); } |
| 146 | sub do_cmd_email{ return use_sans_serif(@_); } |
| 147 | sub do_cmd_mimetype{ return use_sans_serif(@_); } |
| 148 | sub do_cmd_var{ return use_italics(@_); } |
| 149 | sub do_cmd_dfn{ return use_italics(@_); } # make an index entry? |
| 150 | sub do_cmd_emph{ return use_italics(@_); } |
| 151 | sub do_cmd_file{ return use_wrappers(@_[0], '"<tt>', '</tt>"'); } |
| 152 | sub do_cmd_samp{ return use_wrappers(@_[0], '"<tt>', '</tt>"'); } |
| 153 | sub do_cmd_kbd{ return use_wrappers(@_[0], '<kbd>', '</kbd>'); } |
| 154 | sub do_cmd_strong{ return use_wrappers(@_[0], '<b>', '</b>'); } |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 155 | |
Fred Drake | 1a7af39 | 1998-04-01 22:44:56 +0000 | [diff] [blame] | 156 | sub do_cmd_newsgroup{ |
| 157 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 158 | my $newsgroup = next_argument(); |
Fred Drake | 1a7af39 | 1998-04-01 22:44:56 +0000 | [diff] [blame] | 159 | my $stuff = "<a href=\"news:$newsgroup\"><font face=sans-serif>" |
| 160 | . "$newsgroup</font></a>"; |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 161 | return $stuff . $_; |
Fred Drake | 1a7af39 | 1998-04-01 22:44:56 +0000 | [diff] [blame] | 162 | } |
Fred Drake | fc16e78 | 1998-03-12 21:03:26 +0000 | [diff] [blame] | 163 | |
| 164 | sub do_cmd_envvar{ |
| 165 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 166 | my($envvar,$br_id) = next_argument_id(); |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 167 | my($name,$aname,$ahref) = link_info($br_id); |
Fred Drake | 166abba | 1998-04-08 23:10:54 +0000 | [diff] [blame] | 168 | # 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 Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 172 | add_index_entry("$envvar@\$$envvar", $ahref); |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 173 | return "$aname\$$envvar</a>" . $_; |
Fred Drake | fc16e78 | 1998-03-12 21:03:26 +0000 | [diff] [blame] | 174 | } |
| 175 | |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 176 | |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 177 | sub do_cmd_url{ |
| 178 | # use the URL as both text and hyperlink |
| 179 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 180 | my $url = next_argument(); |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 181 | $url =~ s/~/~/g; |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 182 | return "<a href=\"$url\"><font face=sans-serif>$url</font></a>" . $_; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 183 | } |
| 184 | |
| 185 | sub do_cmd_manpage{ |
| 186 | # two parameters: \manpage{name}{section} |
| 187 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 188 | my $page = next_argument(); |
| 189 | my $section = next_argument(); |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 190 | return "<i>$page</i>($section)" . $_; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 191 | } |
| 192 | |
| 193 | sub do_cmd_rfc{ |
| 194 | local($_) = @_; |
Fred Drake | 32f7ae0 | 1998-12-22 23:41:07 +0000 | [diff] [blame] | 195 | my($rfcnumber,$br_id) = next_argument_id(); |
Fred Drake | 2eff3c5 | 1998-12-22 18:02:25 +0000 | [diff] [blame] | 196 | my $href = |
| 197 | "http://info.internet.isi.edu/in-notes/rfc/files/rfc$rfcnumber.txt"; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 198 | # Save the reference |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 199 | my $nstr = gen_index_id("RFC!RFC $rfcnumber", ''); |
| 200 | $index{$nstr} .= make_half_href("$CURRENT_FILE#$br_id"); |
Fred Drake | 2eff3c5 | 1998-12-22 18:02:25 +0000 | [diff] [blame] | 201 | return "<a name=\"$br_id\"\nhref=\"$href\">RFC $rfcnumber</a>" .$_; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 202 | } |
| 203 | |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 204 | sub do_cmd_deprecated{ |
| 205 | # two parameters: \deprecated{version}{whattodo} |
| 206 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 207 | my $release = next_argument(); |
| 208 | my $reason = next_argument(); |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 209 | return "<b>Deprecated since release $release.</b>\n$reason<p>" . $_; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 210 | } |
| 211 | |
Fred Drake | 897d12b | 1998-07-27 20:33:17 +0000 | [diff] [blame] | 212 | sub do_cmd_versionadded{ |
| 213 | # one parameter: \versionadded{version} |
| 214 | local($_) = @_; |
| 215 | my $release = next_argument(); |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 216 | return "<b>New in version $release.</b><p>" . $_; |
Fred Drake | 897d12b | 1998-07-27 20:33:17 +0000 | [diff] [blame] | 217 | } |
| 218 | |
| 219 | sub do_cmd_versionchanged{ |
| 220 | # one parameter: \versionchanged{version} |
| 221 | local($_) = @_; |
| 222 | my $release = next_argument(); |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 223 | return "<b>Changed in version $release.</b><p>" . $_; |
Fred Drake | 897d12b | 1998-07-27 20:33:17 +0000 | [diff] [blame] | 224 | } |
| 225 | |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 226 | # file and samp are at the end of this file since they screw up fontlock. |
| 227 | |
| 228 | # index commands |
| 229 | |
| 230 | $INDEX_SUBITEM = ""; |
| 231 | |
| 232 | sub get_indexsubitem{ |
Fred Drake | 7d45f6d | 1999-01-05 14:39:27 +0000 | [diff] [blame^] | 233 | return $INDEX_SUBITEM ? " $INDEX_SUBITEM" : ''; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 234 | } |
| 235 | |
| 236 | sub do_cmd_setindexsubitem{ |
| 237 | local($_) = @_; |
Fred Drake | 7d45f6d | 1999-01-05 14:39:27 +0000 | [diff] [blame^] | 238 | my $subitem = next_argument(); |
| 239 | $INDEX_SUBITEM = $subitem; |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 240 | return $_; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 241 | } |
| 242 | |
Fred Drake | fc16e78 | 1998-03-12 21:03:26 +0000 | [diff] [blame] | 243 | sub do_cmd_withsubitem{ |
Fred Drake | 7d45f6d | 1999-01-05 14:39:27 +0000 | [diff] [blame^] | 244 | # We can't really do the right thing, because LaTeX2HTML doesn't |
Fred Drake | fc16e78 | 1998-03-12 21:03:26 +0000 | [diff] [blame] | 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 Drake | 7d45f6d | 1999-01-05 14:39:27 +0000 | [diff] [blame^] | 249 | my $oldsubitem = $INDEX_SUBITEM; |
| 250 | $INDEX_SUBITEM = next_argument(); |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 251 | my $stuff = next_argument(); |
Fred Drake | 7d45f6d | 1999-01-05 14:39:27 +0000 | [diff] [blame^] | 252 | my ($open, $close) = ($O, $C); |
| 253 | return |
| 254 | $stuff |
| 255 | . "\\setindexsubitem${open}1$close$oldsubitem${open}1$close" |
| 256 | . $_; |
Fred Drake | fc16e78 | 1998-03-12 21:03:26 +0000 | [diff] [blame] | 257 | } |
| 258 | |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 259 | # This is the prologue macro which is required to start writing the |
| 260 | # mod\jobname.idx file; we can just ignore it. |
| 261 | # |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 262 | sub do_cmd_makemodindex{ return @_[0]; } |
Fred Drake | fc16e78 | 1998-03-12 21:03:26 +0000 | [diff] [blame] | 263 | |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 264 | # We're in the document subdirectory when this happens! |
Fred Drake | 166abba | 1998-04-08 23:10:54 +0000 | [diff] [blame] | 265 | # |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 266 | open(IDXFILE, '>index.dat') || die "\n$!\n"; |
| 267 | open(INTLABELS, '>intlabels.pl') || die "\n$!\n"; |
Fred Drake | 166abba | 1998-04-08 23:10:54 +0000 | [diff] [blame] | 268 | print INTLABELS "%internal_labels = ();\n"; |
| 269 | print INTLABELS "1; # hack in case there are no entries\n\n"; |
| 270 | |
| 271 | # Using \0 for this is bad because we can't use common tools to work with the |
| 272 | # resulting files. Things like grep can be useful with this stuff! |
| 273 | # |
| 274 | $IDXFILE_FIELD_SEP = "\1"; |
| 275 | |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 276 | |
| 277 | sub gen_target_name{ |
Fred Drake | 2eff3c5 | 1998-12-22 18:02:25 +0000 | [diff] [blame] | 278 | my($stuff) = @_; |
| 279 | return "l2h-" . $stuff; |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 280 | } |
| 281 | |
| 282 | sub gen_target{ |
Fred Drake | 2eff3c5 | 1998-12-22 18:02:25 +0000 | [diff] [blame] | 283 | my($name) = @_; |
| 284 | return '<a name="' . $name . '">'; |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 285 | } |
| 286 | |
| 287 | sub gen_link{ |
| 288 | my($node,$target) = @_; |
| 289 | print INTLABELS "\$internal_labels{\"$target\"} = \"$URL/$node\";\n"; |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 290 | return "<a href=\"$node#$target\">"; |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 291 | } |
| 292 | |
| 293 | sub make_index_entry{ |
| 294 | my($br_id,$str) = @_; |
| 295 | my($name,$aname,$ahref) = link_info($br_id); |
| 296 | add_index_entry($str, $ahref); |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 297 | return "$aname$anchor_invisible_mark</a>"; |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 298 | } |
| 299 | |
| 300 | sub add_index_entry{ |
| 301 | # add an entry to the index structures; ignore the return value |
| 302 | my($str,$ahref) = @_; |
| 303 | $str = gen_index_id($str, ''); |
| 304 | $index{$str} .= $ahref; |
Fred Drake | 166abba | 1998-04-08 23:10:54 +0000 | [diff] [blame] | 305 | print IDXFILE $ahref, $IDXFILE_FIELD_SEP, $str, "\n"; |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 306 | } |
| 307 | |
| 308 | sub link_info{ |
| 309 | my $name = gen_target_name(@_[0]); |
| 310 | my $aname = gen_target($name); |
| 311 | my $ahref = gen_link($CURRENT_FILE, $name); |
| 312 | return ($name, $aname, $ahref); |
| 313 | } |
| 314 | |
| 315 | sub do_cmd_index{ |
| 316 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 317 | my($str,$br_id) = next_argument_id(); |
| 318 | swallow_newline(); |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 319 | # |
| 320 | my($name,$aname,$ahref) = link_info($br_id); |
| 321 | add_index_entry("$str", $ahref); |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 322 | return "$aname$anchor_invisible_mark</a>" . $_; |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 323 | } |
| 324 | |
Fred Drake | 2e7edb8 | 1998-05-11 18:31:17 +0000 | [diff] [blame] | 325 | sub do_cmd_kwindex{ |
| 326 | local($_) = @_; |
| 327 | my($str,$br_id) = next_argument_id(); |
| 328 | # |
| 329 | my($name,$aname,$ahref) = link_info($br_id); |
| 330 | add_index_entry("<tt>$str</tt>!keyword", $ahref); |
| 331 | add_index_entry("keyword!<tt>$str</tt>", $ahref); |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 332 | return "$aname$anchor_invisible_mark</a>" . $_; |
Fred Drake | 2e7edb8 | 1998-05-11 18:31:17 +0000 | [diff] [blame] | 333 | } |
| 334 | |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 335 | sub do_cmd_indexii{ |
| 336 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 337 | my($str1,$br_id) = next_argument_id(); |
| 338 | my $str2 = next_argument(); |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 339 | # |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 340 | my($name,$aname,$ahref) = link_info($br_id); |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 341 | add_index_entry("$str1!$str2", $ahref); |
| 342 | add_index_entry("$str2!$str1", $ahref); |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 343 | return "$aname$anchor_invisible_mark</a>" . $_; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 344 | } |
| 345 | |
| 346 | sub do_cmd_indexiii{ |
| 347 | local($_) = @_; |
Fred Drake | 32f7ae0 | 1998-12-22 23:41:07 +0000 | [diff] [blame] | 348 | my($str1,$br_id) = next_argument_id(); |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 349 | my $str2 = next_argument(); |
| 350 | my $str3 = next_argument(); |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 351 | # |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 352 | my($name,$aname,$ahref) = link_info($br_id); |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 353 | add_index_entry("$str1!$str2 $str3", $ahref); |
| 354 | add_index_entry("$str2!$str3, $str1", $ahref); |
| 355 | add_index_entry("$str3!$str1 $str2", $ahref); |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 356 | return "$aname$anchor_invisible_mark</a>" . $_; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 357 | } |
| 358 | |
| 359 | sub do_cmd_indexiv{ |
| 360 | local($_) = @_; |
Fred Drake | 32f7ae0 | 1998-12-22 23:41:07 +0000 | [diff] [blame] | 361 | my($str1,$br_id) = next_argument_id(); |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 362 | my $str2 = next_argument(); |
| 363 | my $str3 = next_argument(); |
| 364 | my $str4 = next_argument(); |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 365 | # |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 366 | my($name,$aname,$ahref) = link_info($br_id); |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 367 | add_index_entry("$str1!$str2 $str3 $str4", $ahref); |
| 368 | add_index_entry("$str2!$str3 $str4, $str1", $ahref); |
| 369 | add_index_entry("$str3!$str4, $str1 $str2", $ahref); |
| 370 | add_index_entry("$str4!$$str1 $str2 $str3", $ahref); |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 371 | return "$aname$anchor_invisible_mark</a>" . $_; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 372 | } |
| 373 | |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 374 | sub do_cmd_ttindex{ |
| 375 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 376 | my($str,$br_id) = next_argument_id(); |
| 377 | swallow_newline(); |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 378 | return make_index_entry($br_id, $str . get_indexsubitem()) . $_; |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 379 | } |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 380 | |
| 381 | sub my_typed_index_helper{ |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 382 | local($word,$_) = @_; |
Fred Drake | 32f7ae0 | 1998-12-22 23:41:07 +0000 | [diff] [blame] | 383 | my($str,$br_id) = next_argument_id(); |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 384 | swallow_newline(); |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 385 | # |
| 386 | my($name,$aname,$ahref) = link_info($br_id1); |
| 387 | add_index_entry("$str $word", $ahref); |
| 388 | add_index_entry("$word!$str", $ahref); |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 389 | return "$aname$anchor_invisible_mark</a>" . $_; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 390 | } |
| 391 | |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 392 | sub do_cmd_stindex{ return my_typed_index_helper('statement', @_); } |
| 393 | sub do_cmd_opindex{ return my_typed_index_helper('operator', @_); } |
| 394 | sub do_cmd_exindex{ return my_typed_index_helper('exception', @_); } |
| 395 | sub do_cmd_obindex{ return my_typed_index_helper('object', @_); } |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 396 | |
| 397 | sub my_parword_index_helper{ |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 398 | local($word,$_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 399 | my($str,$br_id) = next_argument_id(); |
| 400 | swallow_newline(); |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 401 | return make_index_entry($br_id, "$str ($word)") . $_; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 402 | } |
| 403 | |
| 404 | |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 405 | sub make_mod_index_entry{ |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 406 | my($br_id,$str,$define) = @_; |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 407 | my($name,$aname,$ahref) = link_info($br_id); |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 408 | # equivalent of add_index_entry() using $define instead of '' |
| 409 | $str = gen_index_id($str, $define); |
| 410 | $index{$str} .= $ahref; |
Fred Drake | 166abba | 1998-04-08 23:10:54 +0000 | [diff] [blame] | 411 | print IDXFILE $ahref, $IDXFILE_FIELD_SEP, $str, "\n"; |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 412 | |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 413 | if ($define eq 'DEF') { |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 414 | # add to the module index |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 415 | my($nstr,$garbage) = split / /, $str, 2; |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 416 | $Modules{$nstr} .= $ahref; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 417 | } |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 418 | return "$aname$anchor_invisible_mark</a>"; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 419 | } |
| 420 | |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 421 | $THIS_MODULE = ''; |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 422 | $THIS_CLASS = ''; |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 423 | |
Fred Drake | a0f4c94 | 1998-07-24 22:16:04 +0000 | [diff] [blame] | 424 | sub define_module{ |
| 425 | my($word,$name) = @_; |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 426 | my $section_tag = join('', @curr_sec_id); |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 427 | $word = "$word " if $word; |
Fred Drake | a0f4c94 | 1998-07-24 22:16:04 +0000 | [diff] [blame] | 428 | $THIS_MODULE = "$name"; |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 429 | return make_mod_index_entry("SECTION$section_tag", |
| 430 | "<tt>$name</tt> (${word}module)", 'DEF'); |
Fred Drake | a0f4c94 | 1998-07-24 22:16:04 +0000 | [diff] [blame] | 431 | } |
| 432 | |
| 433 | sub my_module_index_helper{ |
| 434 | local($word, $_) = @_; |
| 435 | my $name = next_argument(); |
| 436 | swallow_newline(); |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 437 | return define_module($word, $name) . $_; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 438 | } |
| 439 | |
| 440 | sub ref_module_index_helper{ |
| 441 | local($word, $_) = @_; |
Fred Drake | 32f7ae0 | 1998-12-22 23:41:07 +0000 | [diff] [blame] | 442 | my($str,$br_id) = next_argument_id(); |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 443 | swallow_newline(); |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 444 | $word = "$word " if $word; |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 445 | return make_mod_index_entry($br_id, |
| 446 | "<tt>$str</tt> (${word}module)", 'REF') . $_; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 447 | } |
| 448 | |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 449 | sub do_cmd_bifuncindex{ |
| 450 | local($_) = @_; |
Fred Drake | 32f7ae0 | 1998-12-22 23:41:07 +0000 | [diff] [blame] | 451 | my($str,$br_id) = next_argument_id(); |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 452 | swallow_newline(); |
| 453 | my $fname = "<tt>$str()</tt>"; |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 454 | return make_index_entry($br_id, "$fname (built-in function)") . $_; |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 455 | } |
| 456 | |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 457 | sub do_cmd_modindex{ return my_module_index_helper('', @_); } |
| 458 | sub do_cmd_bimodindex{ return my_module_index_helper('built-in', @_); } |
| 459 | sub do_cmd_exmodindex{ return my_module_index_helper('extension', @_); } |
| 460 | sub do_cmd_stmodindex{ return my_module_index_helper('standard', @_); } |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 461 | |
| 462 | # these should be adjusted a bit.... |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 463 | sub do_cmd_refmodindex{ return ref_module_index_helper('', @_); } |
| 464 | sub do_cmd_refbimodindex{ return ref_module_index_helper('built-in', @_); } |
| 465 | sub do_cmd_refexmodindex{ return ref_module_index_helper('extension', @_); } |
| 466 | sub do_cmd_refstmodindex{ return ref_module_index_helper('standard', @_); } |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 467 | |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 468 | sub do_cmd_nodename{ return do_cmd_label(@_); } |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 469 | |
| 470 | sub init_myformat{ |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 471 | # $anchor_invisible_mark = ''; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 472 | $anchor_mark = ''; |
| 473 | $icons{'anchor_mark'} = ''; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 474 | } |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 475 | init_myformat(); |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 476 | |
| 477 | # similar to make_index_entry(), but includes the string in the result |
| 478 | # instead of the dummy filler. |
| 479 | # |
| 480 | sub make_str_index_entry{ |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 481 | my($br_id,$str) = @_; |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 482 | my($name,$aname,$ahref) = link_info($br_id); |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 483 | add_index_entry($str, $ahref); |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 484 | return "$aname$str</a>"; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 485 | } |
| 486 | |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 487 | sub do_env_cfuncdesc{ |
| 488 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 489 | my $return_type = next_argument(); |
| 490 | my($function_name,$br_id) = next_argument_id(); |
| 491 | my $arg_list = next_argument(); |
| 492 | my $idx = make_str_index_entry($br_id, |
| 493 | "<tt>$function_name()</tt>" . get_indexsubitem()); |
| 494 | $idx =~ s/ \(.*\)//; |
| 495 | $idx =~ s/\(\)//; # ???? |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 496 | return "<dl><dt>$return_type <b>$idx</b>" |
| 497 | . "(<var>$arg_list</var>)\n<dd>" |
| 498 | . $_ |
| 499 | . '</dl>'; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 500 | } |
| 501 | |
| 502 | sub do_env_ctypedesc{ |
| 503 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 504 | my($type_name,$br_id) = next_argument_id(); |
| 505 | my $idx = make_str_index_entry($br_id, |
| 506 | "<tt>$type_name</tt>" . get_indexsubitem()); |
| 507 | $idx =~ s/ \(.*\)//; |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 508 | return "<dl><dt><b>$idx</b>\n<dd>" |
| 509 | . $_ |
| 510 | . '</dl>' |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 511 | } |
| 512 | |
| 513 | sub do_env_cvardesc{ |
| 514 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 515 | my $var_type = next_argument(); |
| 516 | my($var_name,$br_id) = next_argument_id(); |
| 517 | my $idx = make_str_index_entry($br_id, |
| 518 | "<tt>$var_name</tt>" . get_indexsubitem()); |
| 519 | $idx =~ s/ \(.*\)//; |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 520 | return "<dl><dt>$var_type <b>$idx</b>\n" |
| 521 | . '<dd>' |
| 522 | . $_ |
| 523 | . '</dl>'; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 524 | } |
| 525 | |
| 526 | sub do_env_funcdesc{ |
| 527 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 528 | my $function_name = next_argument(); |
| 529 | my($arg_list,$br_id) = next_argument_id(); |
| 530 | my $idx = make_str_index_entry($br_id, "<tt>$function_name()</tt>" |
| 531 | . get_indexsubitem()); |
| 532 | $idx =~ s/ \(.*\)//; |
| 533 | $idx =~ s/\(\)//; |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 534 | return "<dl><dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_ . '</dl>'; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 535 | } |
| 536 | |
| 537 | sub do_env_funcdescni{ |
| 538 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 539 | my $function_name = next_argument(); |
| 540 | my $arg_list = next_argument(); |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 541 | return "<dl><dt><b><tt>$function_name</tt></b> (<var>$arg_list</var>)\n" |
| 542 | . "<dd>" |
| 543 | . $_ . '</dl>'; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 544 | } |
| 545 | |
| 546 | sub do_cmd_funcline{ |
| 547 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 548 | my $function_name = next_argument(); |
| 549 | my($arg_list,$br_id) = next_argument_id(); |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 550 | my $idx = make_str_index_entry($br_id, "<tt>$function_name()</tt>" |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 551 | . get_indexsubitem()); |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 552 | $idx =~ s/\(\)//; |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 553 | return "<dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 554 | } |
| 555 | |
| 556 | # Change this flag to index the opcode entries. I don't think it's very |
| 557 | # useful to index them, since they're only presented to describe the dis |
| 558 | # module. |
| 559 | # |
| 560 | $INDEX_OPCODES = 0; |
| 561 | |
| 562 | sub do_env_opcodedesc{ |
| 563 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 564 | my $opcode_name = next_argument(); |
| 565 | my($arg_list,$br_id) = next_argument_id(); |
| 566 | my $idx; |
| 567 | if ($INDEX_OPCODES) { |
| 568 | $idx = make_str_index_entry($br_id, |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 569 | "<tt>$opcode_name</tt> (byte code instruction)"); |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 570 | $idx =~ s/ \(byte code instruction\)//; |
| 571 | } |
| 572 | else { |
| 573 | $idx = "<tt>$opcode_name</tt>"; |
| 574 | } |
| 575 | my $stuff = "<dl><dt><b>$idx</b>"; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 576 | if ($arg_list) { |
| 577 | $stuff .= " <var>$arg_list</var>"; |
| 578 | } |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 579 | return $stuff . "\n<dd>" . $_ . '</dl>'; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 580 | } |
| 581 | |
| 582 | sub do_env_datadesc{ |
| 583 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 584 | my($dataname,$br_id) = next_argument_id(); |
| 585 | my $idx = make_str_index_entry($br_id, |
| 586 | "<tt>$dataname</tt>" . get_indexsubitem()); |
| 587 | $idx =~ s/ \(.*\)//; |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 588 | return "<dl><dt><b>$idx</b>\n<dd>" |
| 589 | . $_ |
| 590 | . '</dl>'; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 591 | } |
| 592 | |
| 593 | sub do_env_datadescni{ |
| 594 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 595 | my $idx = next_argument(); |
| 596 | if (! $STRING_INDEX_TT) { |
| 597 | $idx = "<tt>$idx</tt>"; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 598 | } |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 599 | return "<dl><dt><b>$idx</b>\n<dd>" . $_ . '</dl>'; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 600 | } |
| 601 | |
| 602 | sub do_cmd_dataline{ |
| 603 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 604 | my($data_name,$br_id) = next_argument_id(); |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 605 | my $idx = make_str_index_entry($br_id, "<tt>$data_name</tt>" |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 606 | . get_indexsubitem()); |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 607 | $idx =~ s/ \(.*\)//; |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 608 | return "<dt><b>$idx</b><dd>" . $_; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 609 | } |
| 610 | |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 611 | sub do_env_excdesc{ |
| 612 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 613 | my($excname,$br_id) = next_argument_id(); |
Fred Drake | 166abba | 1998-04-08 23:10:54 +0000 | [diff] [blame] | 614 | my $idx = make_str_index_entry($br_id, "<tt>$excname</tt>"); |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 615 | return "<dl><dt><b>$idx</b>\n<dd>" . $_ . '</dl>' |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 616 | } |
| 617 | |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 618 | sub do_env_fulllineitems{ return do_env_itemize(@_); } |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 619 | |
| 620 | |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 621 | sub do_env_classdesc{ |
| 622 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 623 | $THIS_CLASS = next_argument(); |
| 624 | my($arg_list,$br_id) = next_argument_id(); |
| 625 | $idx = make_str_index_entry($br_id, |
| 626 | "<tt>$THIS_CLASS</tt> (class in $THIS_MODULE)" ); |
| 627 | $idx =~ s/ \(.*\)//; |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 628 | return "<dl><dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_ . '</dl>'; |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 629 | } |
| 630 | |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 631 | |
| 632 | sub do_env_methoddesc{ |
| 633 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 634 | my $class_name = next_optional_argument(); |
| 635 | $class_name = $THIS_CLASS |
| 636 | unless $class_name; |
| 637 | my($method_name,$br_id) = next_argument_id(); |
| 638 | my $arg_list = next_argument(); |
| 639 | my $extra = ''; |
| 640 | if ($class_name) { |
| 641 | $extra = " ($class_name method)"; |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 642 | } |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 643 | my $idx = make_str_index_entry($br_id, "<tt>$method_name()</tt>$extra"); |
| 644 | $idx =~ s/ \(.*\)//; |
| 645 | $idx =~ s/\(\)//; |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 646 | return "<dl><dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_ . '</dl>'; |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 647 | } |
| 648 | |
| 649 | |
Fred Drake | 7d45f6d | 1999-01-05 14:39:27 +0000 | [diff] [blame^] | 650 | sub do_cmd_methodline{ |
| 651 | local($_) = @_; |
| 652 | my $class_name = next_optional_argument(); |
| 653 | $class_name = $THIS_CLASS |
| 654 | unless $class_name; |
| 655 | my $method = next_argument(); |
| 656 | my $arg_list = next_argument(); |
| 657 | my $extra = ''; |
| 658 | if ($class_name) { |
| 659 | $extra = " ($class_name method)"; |
| 660 | } |
| 661 | my $idx = make_str_index_entry($br_id, "<tt>$method_name()</tt>$extra"); |
| 662 | $idx =~ s/ \(.*\)//; |
| 663 | $idx =~ s/\(\)//; |
| 664 | return "<dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" |
| 665 | . $_; |
| 666 | } |
| 667 | |
| 668 | |
Fred Drake | d64a40d | 1998-09-10 18:59:13 +0000 | [diff] [blame] | 669 | sub do_cmd_methodlineni{ |
| 670 | local($_) = @_; |
| 671 | next_optional_argument(); |
| 672 | my $method = next_argument(); |
| 673 | my $arg_list = next_argument(); |
| 674 | return "<dt><b>$method</b> (<var>$arg_list</var>)\n<dd>" |
| 675 | . $_; |
| 676 | } |
| 677 | |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 678 | sub do_env_methoddescni{ |
| 679 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 680 | next_optional_argument(); |
| 681 | my $method = next_argument(); |
| 682 | my $arg_list = next_argument(); |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 683 | return "<dl><dt><b>$method</b> (<var>$arg_list</var>)\n<dd>" |
| 684 | . $_ |
| 685 | . '</dl>'; |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 686 | } |
| 687 | |
| 688 | |
| 689 | sub do_env_memberdesc{ |
| 690 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 691 | my $class = next_optional_argument(); |
Fred Drake | 32f7ae0 | 1998-12-22 23:41:07 +0000 | [diff] [blame] | 692 | my($member,$br_id) = next_argument_id(); |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 693 | $class = $THIS_CLASS |
| 694 | unless $class; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 695 | my $extra = ''; |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 696 | $extra = " ($class_name attribute)" |
Fred Drake | a608feb | 1998-04-12 03:58:13 +0000 | [diff] [blame] | 697 | if (!($class eq '')); |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 698 | my $idx = make_str_index_entry($br_id, "<tt>$member</tt>$extra"); |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 699 | $idx =~ s/ \(.*\)//; |
| 700 | $idx =~ s/\(\)//; |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 701 | return "<dl><dt><b>$idx</b>\n<dd>" . $_ . '</dl>'; |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 702 | } |
| 703 | |
| 704 | |
Fred Drake | 5ccf330 | 1998-04-17 20:04:09 +0000 | [diff] [blame] | 705 | sub do_cmd_memberline{ |
| 706 | local($_) = @_; |
| 707 | my $class = next_optional_argument(); |
| 708 | my($member,$br_id) = next_argument_id(); |
| 709 | $class = $THIS_CLASS |
| 710 | unless $class; |
| 711 | my $extra = ''; |
| 712 | $extra = " ($class_name attribute)" |
| 713 | if (!($class eq '')); |
| 714 | my $idx = make_str_index_entry($br_id, "<tt>$member</tt>$extra"); |
| 715 | $idx =~ s/ \(.*\)//; |
| 716 | $idx =~ s/\(\)//; |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 717 | return "<dt><b>$idx</b><dd>" . $_; |
Fred Drake | 5ccf330 | 1998-04-17 20:04:09 +0000 | [diff] [blame] | 718 | } |
| 719 | |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 720 | sub do_env_memberdescni{ |
| 721 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 722 | next_optional_argument(); |
| 723 | my $member = next_argument(); |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 724 | return "<dl><dt><b>$member</b>\n<dd>" . $_ . '</dl>'; |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 725 | } |
| 726 | |
| 727 | |
Fred Drake | 5ccf330 | 1998-04-17 20:04:09 +0000 | [diff] [blame] | 728 | sub do_cmd_memberlineni{ |
| 729 | local($_) = @_; |
| 730 | next_optional_argument(); |
| 731 | my $member = next_argument(); |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 732 | return "<dt><b>$member</b><dd>" . $_; |
Fred Drake | 5ccf330 | 1998-04-17 20:04:09 +0000 | [diff] [blame] | 733 | } |
| 734 | |
Fred Drake | a0f4c94 | 1998-07-24 22:16:04 +0000 | [diff] [blame] | 735 | @col_aligns = ("<td>", "<td>", "<td>", "<td>"); |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 736 | |
| 737 | sub setup_column_alignments{ |
| 738 | local($_) = @_; |
Fred Drake | a0f4c94 | 1998-07-24 22:16:04 +0000 | [diff] [blame] | 739 | my($a1,$a2,$a3,$a4) = split(/[|]/,$_); |
| 740 | my($th1,$th2,$th3,$th4) = ('<th>', '<th>', '<th>', '<th>'); |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 741 | $col_aligns[0] = (($a1 eq 'c') ? '<td align=center>' : '<td>'); |
| 742 | $col_aligns[1] = (($a2 eq 'c') ? '<td align=center>' : '<td>'); |
| 743 | $col_aligns[2] = (($a3 eq 'c') ? '<td align=center>' : '<td>'); |
Fred Drake | a0f4c94 | 1998-07-24 22:16:04 +0000 | [diff] [blame] | 744 | $col_aligns[3] = (($a4 eq 'c') ? '<td align=center>' : '<td>'); |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 745 | # return the aligned header start tags; only used for \begin{tableiii?} |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 746 | $th1 = (($a1 eq 'l') ? '<th align=left>' |
| 747 | : ($a1 eq 'r' ? '<th align=right>' : '<th>')); |
| 748 | $th2 = (($a2 eq 'l') ? '<th align=left>' |
| 749 | : ($a2 eq 'r' ? '<th align=right>' : '<th>')); |
| 750 | $th3 = (($a3 eq 'l') ? '<th align=left>' |
| 751 | : ($a3 eq 'r' ? '<th align=right>' : '<th>')); |
Fred Drake | a0f4c94 | 1998-07-24 22:16:04 +0000 | [diff] [blame] | 752 | $th4 = (($a4 eq 'l') ? '<th align=left>' |
| 753 | : ($a4 eq 'r' ? '<th align=right>' : '<th>')); |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 754 | return ($th1, $th2, $th3, $th4); |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 755 | } |
| 756 | |
| 757 | sub do_env_tableii{ |
| 758 | local($_) = @_; |
Fred Drake | a0f4c94 | 1998-07-24 22:16:04 +0000 | [diff] [blame] | 759 | my($th1,$th2,$th3,$th4) = setup_column_alignments(next_argument()); |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 760 | my $font = next_argument(); |
| 761 | my $h1 = next_argument(); |
| 762 | my $h2 = next_argument(); |
| 763 | $font = '' |
| 764 | if ($font eq 'textrm'); |
| 765 | $globals{'lineifont'} = $font; |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 766 | return '<table border align=center>' |
| 767 | . "\n <tr>$th1<b>$h1</b></th>" |
| 768 | . "\n $th2<b>$h2</b></th>" |
| 769 | . $_ |
| 770 | . "\n</table>"; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 771 | } |
| 772 | |
| 773 | sub do_cmd_lineii{ |
| 774 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 775 | my $c1 = next_argument(); |
| 776 | my $c2 = next_argument(); |
| 777 | my($font,$sfont,$efont) = ($globals{'lineifont'}, '', ''); |
Fred Drake | 58b2bfd | 1998-04-02 20:14:04 +0000 | [diff] [blame] | 778 | if ($font) { |
Fred Drake | 5cca42e | 1998-04-09 17:59:11 +0000 | [diff] [blame] | 779 | $sfont = "<$font>"; |
Fred Drake | 58b2bfd | 1998-04-02 20:14:04 +0000 | [diff] [blame] | 780 | $efont = "</$font>"; |
| 781 | } |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 782 | my($c1align,$c2align) = @col_aligns[0,1]; |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 783 | return "<tr>$c1align$sfont$c1$efont</td>\n" |
| 784 | . " $c2align$c2</td>" |
| 785 | . $_; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 786 | } |
| 787 | |
| 788 | sub do_env_tableiii{ |
| 789 | local($_) = @_; |
Fred Drake | a0f4c94 | 1998-07-24 22:16:04 +0000 | [diff] [blame] | 790 | my($th1,$th2,$th3,$th4) = setup_column_alignments(next_argument()); |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 791 | my $font = next_argument(); |
| 792 | my $h1 = next_argument(); |
| 793 | my $h2 = next_argument(); |
| 794 | my $h3 = next_argument(); |
| 795 | $font = '' |
| 796 | if ($font eq 'textrm'); |
| 797 | $globals{'lineifont'} = $font; |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 798 | return '<table border align=center>' |
| 799 | . "\n <tr>$th1<b>$h1</b></th>" |
| 800 | . "\n $th2<b>$h2</b></th>" |
| 801 | . "\n $th3<b>$h3</b></th>" |
| 802 | . $_ |
| 803 | . "\n</table>"; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 804 | } |
| 805 | |
| 806 | sub do_cmd_lineiii{ |
| 807 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 808 | my $c1 = next_argument(); |
| 809 | my $c2 = next_argument(); |
| 810 | my $c3 = next_argument(); |
| 811 | my($font,$sfont,$efont) = ($globals{'lineifont'}, '', ''); |
Fred Drake | 58b2bfd | 1998-04-02 20:14:04 +0000 | [diff] [blame] | 812 | if ($font) { |
Fred Drake | 5cca42e | 1998-04-09 17:59:11 +0000 | [diff] [blame] | 813 | $sfont = "<$font>"; |
Fred Drake | 58b2bfd | 1998-04-02 20:14:04 +0000 | [diff] [blame] | 814 | $efont = "</$font>"; |
| 815 | } |
Fred Drake | a0f4c94 | 1998-07-24 22:16:04 +0000 | [diff] [blame] | 816 | my($c1align,$c2align,$c3align) = @col_aligns[0,1,2]; |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 817 | return "<tr>$c1align$sfont$c1$efont</td>\n" |
| 818 | . " $c2align$c2</td>\n" |
| 819 | . " $c3align$c3</td>" |
| 820 | . $_; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 821 | } |
| 822 | |
Fred Drake | a0f4c94 | 1998-07-24 22:16:04 +0000 | [diff] [blame] | 823 | sub do_env_tableiv{ |
| 824 | local($_) = @_; |
| 825 | my($th1,$th2,$th3,$th4) = setup_column_alignments(next_argument()); |
| 826 | my $font = next_argument(); |
| 827 | my $h1 = next_argument(); |
| 828 | my $h2 = next_argument(); |
| 829 | my $h3 = next_argument(); |
| 830 | my $h4 = next_argument(); |
| 831 | $font = '' |
| 832 | if ($font eq 'textrm'); |
| 833 | $globals{'lineifont'} = $font; |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 834 | return '<table border align=center>' |
| 835 | . "\n <tr>$th1<b>$h1</b></th>" |
| 836 | . "\n $th2<b>$h2</b></th>" |
| 837 | . "\n $th3<b>$h3</b></th>" |
| 838 | . "\n $th4<b>$h4</b></th>" |
| 839 | . $_ |
| 840 | . "\n</table>"; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 841 | } |
| 842 | |
Fred Drake | a0f4c94 | 1998-07-24 22:16:04 +0000 | [diff] [blame] | 843 | sub do_cmd_lineiv{ |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 844 | local($_) = @_; |
Fred Drake | a0f4c94 | 1998-07-24 22:16:04 +0000 | [diff] [blame] | 845 | my $c1 = next_argument(); |
| 846 | my $c2 = next_argument(); |
| 847 | my $c3 = next_argument(); |
| 848 | my $c4 = next_argument(); |
| 849 | my($font,$sfont,$efont) = ($globals{'lineifont'}, '', ''); |
| 850 | if ($font) { |
| 851 | $sfont = "<$font>"; |
| 852 | $efont = "</$font>"; |
| 853 | } |
| 854 | my($c1align,$c2align,$c3align,$c4align) = @col_aligns; |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 855 | return "<tr>$c1align$sfont$c1$efont</td>\n" |
| 856 | . " $c2align$c2</td>\n" |
| 857 | . " $c3align$c3</td>\n" |
| 858 | . " $c4align$c4</td>" |
| 859 | . $_; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 860 | } |
| 861 | |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 862 | sub do_cmd_maketitle { |
| 863 | local($_) = @_; |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 864 | my $the_title = ''; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 865 | if ($t_title) { |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 866 | $the_title .= "<h1 align=center>$t_title</h1>"; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 867 | } else { write_warnings("\nThis document has no title."); } |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 868 | $the_title .= "\n<center>"; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 869 | if ($t_author) { |
| 870 | if ($t_authorURL) { |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 871 | my $href = translate_commands($t_authorURL); |
| 872 | $href = make_named_href('author', $href, "<strong>${t_author}</strong>"); |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 873 | $the_title .= "\n<p>$href</p>"; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 874 | } else { |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 875 | $the_title .= "\n<p><strong>$t_author</strong></p>"; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 876 | } |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 877 | } else { write_warnings("\nThere is no author for this document."); } |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 878 | if ($t_institute) { |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 879 | $the_title .= "\n<p>$t_institute</p>";} |
Fred Drake | d07868a | 1998-05-14 21:00:28 +0000 | [diff] [blame] | 880 | if ($DEVELOPER_ADDRESS) { |
| 881 | $the_title .= "\n<p>$DEVELOPER_ADDRESS</p>";} |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 882 | if ($t_affil) { |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 883 | $the_title .= "\n<p><i>$t_affil</i></p>";} |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 884 | if ($t_date) { |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 885 | $the_title .= "\n<p><strong>$t_date</strong>"; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 886 | if ($PYTHON_VERSION) { |
| 887 | $the_title .= "<br><strong>Release $PYTHON_VERSION</strong>";} |
| 888 | $the_title .= "</p>" |
| 889 | } |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 890 | $the_title .= "\n</center>"; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 891 | if ($t_address) { |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 892 | $the_title .= "\n<p>$t_address</p>"; |
| 893 | } else { $the_title .= "\n<p>"} |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 894 | if ($t_email) { |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 895 | $the_title .= "\n<p>$t_email</p>"; |
| 896 | }# else { $the_title .= "</p>" } |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 897 | return $the_title . $_ ; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 898 | } |
| 899 | |
| 900 | |
Fred Drake | 885215c | 1998-05-20 21:32:09 +0000 | [diff] [blame] | 901 | # |
Fred Drake | a0f4c94 | 1998-07-24 22:16:04 +0000 | [diff] [blame] | 902 | # Module synopsis support |
| 903 | # |
| 904 | |
| 905 | require SynopsisTable; |
| 906 | |
Fred Drake | f7685d7 | 1998-07-25 03:31:46 +0000 | [diff] [blame] | 907 | sub get_chapter_id(){ |
| 908 | my $id = do_cmd_thechapter(''); |
Fred Drake | 45f2601 | 1998-08-04 22:07:18 +0000 | [diff] [blame] | 909 | $id =~ s/<SPAN CLASS="arabic">(\d+)<\/SPAN>/\1/; |
| 910 | $id =~ s/\.//; |
Fred Drake | f7685d7 | 1998-07-25 03:31:46 +0000 | [diff] [blame] | 911 | return $id; |
Fred Drake | a0f4c94 | 1998-07-24 22:16:04 +0000 | [diff] [blame] | 912 | } |
| 913 | |
Fred Drake | f7685d7 | 1998-07-25 03:31:46 +0000 | [diff] [blame] | 914 | %ModuleSynopses = ('chapter' => 'SynopsisTable instance'); |
| 915 | |
| 916 | sub get_synopsis_table($){ |
| 917 | my($chap) = @_; |
Fred Drake | a0f4c94 | 1998-07-24 22:16:04 +0000 | [diff] [blame] | 918 | my $st = $ModuleSynopses{$chap}; |
Fred Drake | f7685d7 | 1998-07-25 03:31:46 +0000 | [diff] [blame] | 919 | my $key; |
| 920 | foreach $key (keys %ModuleSynopses) { |
| 921 | if ($key eq $chap) { |
| 922 | return $ModuleSynopses{$chap}; |
| 923 | } |
Fred Drake | a0f4c94 | 1998-07-24 22:16:04 +0000 | [diff] [blame] | 924 | } |
Fred Drake | f7685d7 | 1998-07-25 03:31:46 +0000 | [diff] [blame] | 925 | $st = SynopsisTable->new(); |
| 926 | $ModuleSynopses{$chap} = $st; |
Fred Drake | a0f4c94 | 1998-07-24 22:16:04 +0000 | [diff] [blame] | 927 | return $st; |
| 928 | } |
| 929 | |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 930 | sub do_cmd_moduleauthor{ |
| 931 | local($_) = @_; |
| 932 | next_argument(); |
| 933 | next_argument(); |
| 934 | return $_; |
| 935 | } |
| 936 | |
| 937 | sub do_cmd_sectionauthor{ |
| 938 | local($_) = @_; |
| 939 | next_argument(); |
| 940 | next_argument(); |
| 941 | return $_; |
| 942 | } |
| 943 | |
Fred Drake | a0f4c94 | 1998-07-24 22:16:04 +0000 | [diff] [blame] | 944 | sub do_cmd_declaremodule{ |
| 945 | local($_) = @_; |
| 946 | my $key = next_optional_argument(); |
| 947 | my $type = next_argument(); |
| 948 | my $name = next_argument(); |
| 949 | my $st = get_synopsis_table(get_chapter_id()); |
| 950 | # |
| 951 | $key = $name unless $key; |
| 952 | $type = 'built-in' if $type eq 'builtin'; |
| 953 | $st->declare($name, $key, $type); |
| 954 | define_module($type, $name); |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 955 | return anchor_label("module-$key",$CURRENT_FILE,$_) |
Fred Drake | a0f4c94 | 1998-07-24 22:16:04 +0000 | [diff] [blame] | 956 | } |
| 957 | |
| 958 | sub do_cmd_modulesynopsis{ |
| 959 | local($_) = @_; |
| 960 | my $st = get_synopsis_table(get_chapter_id()); |
| 961 | $st->set_synopsis($THIS_MODULE, next_argument()); |
| 962 | swallow_newline(); |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 963 | return $_; |
Fred Drake | a0f4c94 | 1998-07-24 22:16:04 +0000 | [diff] [blame] | 964 | } |
| 965 | |
| 966 | sub do_cmd_localmoduletable{ |
| 967 | local($_) = @_; |
Fred Drake | a0f4c94 | 1998-07-24 22:16:04 +0000 | [diff] [blame] | 968 | my $chap = get_chapter_id(); |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 969 | return "<tex2htmllocalmoduletable><$chap>\\tableofchildlinks[off]" . $_; |
Fred Drake | a0f4c94 | 1998-07-24 22:16:04 +0000 | [diff] [blame] | 970 | } |
| 971 | |
| 972 | sub process_all_localmoduletables{ |
| 973 | while (/<tex2htmllocalmoduletable><(\d+)>/) { |
Fred Drake | f7685d7 | 1998-07-25 03:31:46 +0000 | [diff] [blame] | 974 | my $match = $&; |
Fred Drake | a0f4c94 | 1998-07-24 22:16:04 +0000 | [diff] [blame] | 975 | my $chap = $1; |
| 976 | my $st = get_synopsis_table($chap); |
| 977 | my $data = $st->tohtml(); |
Fred Drake | f7685d7 | 1998-07-25 03:31:46 +0000 | [diff] [blame] | 978 | s/$match/$data/; |
Fred Drake | a0f4c94 | 1998-07-24 22:16:04 +0000 | [diff] [blame] | 979 | } |
| 980 | } |
| 981 | |
| 982 | |
| 983 | # |
| 984 | # "See also:" -- references placed at the end of a \section |
| 985 | # |
| 986 | |
| 987 | sub do_env_seealso{ |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 988 | return "<p><b>See Also:</b></p>\n" . @_[0]; |
Fred Drake | a0f4c94 | 1998-07-24 22:16:04 +0000 | [diff] [blame] | 989 | } |
| 990 | |
| 991 | sub do_cmd_seemodule{ |
| 992 | # Insert the right magic to jump to the module definition. This should |
| 993 | # work most of the time, at least for repeat builds.... |
| 994 | local($_) = @_; |
| 995 | my $key = next_optional_argument(); |
| 996 | my $module = next_argument(); |
| 997 | my $text = next_argument(); |
| 998 | $key = $module |
| 999 | unless $key; |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 1000 | return "<p>Module <tt><b><a href=\"module-$key.html\">$module</a></b></tt>" |
| 1001 | . " ($text)</p>" |
| 1002 | . $_; |
Fred Drake | a0f4c94 | 1998-07-24 22:16:04 +0000 | [diff] [blame] | 1003 | } |
| 1004 | |
| 1005 | sub do_cmd_seetext{ |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 1006 | return '<p>' . @_[0]; |
Fred Drake | a0f4c94 | 1998-07-24 22:16:04 +0000 | [diff] [blame] | 1007 | } |
| 1008 | |
| 1009 | |
| 1010 | # |
Fred Drake | 885215c | 1998-05-20 21:32:09 +0000 | [diff] [blame] | 1011 | # Definition list support. |
| 1012 | # |
| 1013 | |
| 1014 | sub do_env_definitions{ |
| 1015 | local($_) = @_; |
| 1016 | swallow_newline(); |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 1017 | return "<dl>$_</dl>\n"; |
Fred Drake | 885215c | 1998-05-20 21:32:09 +0000 | [diff] [blame] | 1018 | } |
| 1019 | |
| 1020 | sub do_cmd_term{ |
| 1021 | local($_) = @_; |
| 1022 | my($term, $id) = next_argument_id(); |
| 1023 | my($name,$aname,$ahref) = link_info($id); |
| 1024 | swallow_newline(); |
| 1025 | # could easily add an index entry here... |
Fred Drake | 62e4369 | 1998-08-10 19:40:44 +0000 | [diff] [blame] | 1026 | return "<dt><b>$aname" . $term . "</a></b>\n<dd>" . $_; |
Fred Drake | 885215c | 1998-05-20 21:32:09 +0000 | [diff] [blame] | 1027 | } |
| 1028 | |
| 1029 | |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 1030 | 1; # This must be the last line |