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)); |
| 17 | ($param, $br_id); |
| 18 | } |
| 19 | |
| 20 | sub next_argument{ |
| 21 | my ($param,$br_id) = next_argument_id(); |
| 22 | $param; |
| 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 | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 28 | $param; |
| 29 | } |
| 30 | |
| 31 | sub swallow_newline{ |
| 32 | s/[\n]?//o; |
| 33 | } |
| 34 | |
Fred Drake | 5ccf330 | 1998-04-17 20:04:09 +0000 | [diff] [blame] | 35 | sub ArabictoRoman { |
| 36 | # Written by Robert Donohue <donahue@cfassp48.harvard.edu>, |
| 37 | # fixed by Fred Drake <fdrake@acm.org>, |
| 38 | # kept around in case it becomes useful. |
| 39 | my $a = @_; |
| 40 | my($b,@c,$i); |
| 41 | my(@D0,@D1,@D2); |
| 42 | |
| 43 | @D0 = ("", "I", "II", "III", "IV", "V", "VI", "VII", "VIII", "IX"); |
| 44 | @D1 = ("", "X", "XX", "XXX", "XL", "L", "LX", "LXX", "LXXX", "XC"); |
| 45 | @D2 = ("", "C", "CC", "CCC", "CD", "D", "DC", "DCC", "DCCC", "CM"); |
| 46 | |
| 47 | $b = $a; |
| 48 | $i = 0; |
| 49 | while($b > 0) { |
| 50 | $c[$i] = ($b % 10); |
| 51 | $b -= ($b % 10); |
| 52 | $b /= 10; |
| 53 | $i++; |
| 54 | } |
| 55 | $D2[$c[2]] . $D1[$c[1]] . $D0[$c[0]]; |
| 56 | } |
| 57 | |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 58 | # words typeset in a special way (not in HTML though) |
| 59 | |
| 60 | sub do_cmd_ABC{ 'ABC' . @_[0]; } |
| 61 | sub do_cmd_UNIX{ 'Unix'. @_[0]; } |
| 62 | sub do_cmd_ASCII{ 'ASCII' . @_[0]; } |
| 63 | sub do_cmd_POSIX{ 'POSIX' . @_[0]; } |
| 64 | sub do_cmd_C{ 'C' . @_[0]; } |
| 65 | sub do_cmd_Cpp{ 'C++' . @_[0]; } |
| 66 | sub do_cmd_EOF{ 'EOF' . @_[0]; } |
| 67 | sub do_cmd_NULL{ '<tt>NULL</tt>' . @_[0]; } |
| 68 | |
| 69 | sub do_cmd_e{ '\' . @_[0]; } |
| 70 | |
Fred Drake | d07868a | 1998-05-14 21:00:28 +0000 | [diff] [blame^] | 71 | $DEVELOPER_ADDRESS = ''; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 72 | $PYTHON_VERSION = ''; |
| 73 | |
| 74 | sub do_cmd_version{ $PYTHON_VERSION . @_[0]; } |
| 75 | sub do_cmd_release{ |
| 76 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 77 | $PYTHON_VERSION = next_argument(); |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 78 | $_; |
| 79 | } |
| 80 | |
| 81 | sub do_cmd_authoraddress{ |
| 82 | local($_) = @_; |
Fred Drake | d07868a | 1998-05-14 21:00:28 +0000 | [diff] [blame^] | 83 | $DEVELOPER_ADDRESS = next_argument(); |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 84 | $_; |
| 85 | } |
| 86 | |
Fred Drake | d07868a | 1998-05-14 21:00:28 +0000 | [diff] [blame^] | 87 | sub do_cmd_developer{ do_cmd_author(@_[0]); } |
| 88 | sub do_cmd_developers{ do_cmd_author(@_[0]); } |
| 89 | sub do_cmd_developersaddress{ do_cmd_authoraddress(@_[0]); } |
| 90 | |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 91 | sub do_cmd_hackscore{ |
| 92 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 93 | next_argument(); |
| 94 | '_' . $_; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 95 | } |
| 96 | |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 97 | sub use_wrappers{ |
| 98 | local($_,$before,$after) = @_; |
| 99 | my $stuff = next_argument(); |
| 100 | $before . $stuff . $after . $_; |
| 101 | } |
| 102 | |
| 103 | sub use_current{ use_wrappers(@_[0], '', ''); } |
| 104 | sub use_sans_serif{ use_wrappers(@_[0], '<font face=sans-serif>', '</font>'); } |
| 105 | sub use_italics{ use_wrappers(@_[0], '<i>', '</i>'); } |
| 106 | |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 107 | sub do_cmd_optional{ |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 108 | use_wrappers(@_[0], "</var><big>\[</big><var>", |
| 109 | "</var><big>\]</big><var>"); |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 110 | } |
| 111 | |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 112 | # Logical formatting (some based on texinfo), needs to be converted to |
| 113 | # minimalist HTML. The "minimalist" is primarily to reduce the size of |
| 114 | # output files for users that read them over the network rather than |
| 115 | # from local repositories. |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 116 | |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 117 | sub do_cmd_pytype{ use_current(@_); } |
| 118 | sub do_cmd_makevar{ use_current(@_); } |
| 119 | sub do_cmd_code{ use_wrappers(@_[0], '<tt>', '</tt>'); } |
| 120 | sub do_cmd_module{ do_cmd_code(@_); } |
| 121 | sub do_cmd_keyword{ do_cmd_code(@_); } |
| 122 | sub do_cmd_exception{ do_cmd_code(@_); } |
| 123 | sub do_cmd_class{ do_cmd_code(@_); } |
| 124 | sub do_cmd_function{ do_cmd_code(@_); } |
| 125 | sub do_cmd_constant{ do_cmd_code(@_); } |
| 126 | sub do_cmd_member{ do_cmd_code(@_); } |
| 127 | sub do_cmd_method{ do_cmd_code(@_); } |
| 128 | sub do_cmd_cfunction{ do_cmd_code(@_); } |
| 129 | sub do_cmd_cdata{ do_cmd_code(@_); } |
| 130 | sub do_cmd_ctype{ do_cmd_code(@_); } |
| 131 | sub do_cmd_regexp{ do_cmd_code(@_); } |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 132 | sub do_cmd_character{ do_cmd_samp(@_); } |
| 133 | sub do_cmd_program{ do_cmd_strong(@_); } |
| 134 | sub do_cmd_email{ use_sans_serif(@_); } |
| 135 | sub do_cmd_mimetype{ use_sans_serif(@_); } |
| 136 | sub do_cmd_var{ use_italics(@_); } |
| 137 | sub do_cmd_dfn{ use_italics(@_); } # make an index entry? |
| 138 | sub do_cmd_emph{ use_italics(@_); } |
| 139 | sub do_cmd_file{ use_wrappers(@_[0], '"<tt>', '</tt>"'); } |
| 140 | sub do_cmd_samp{ use_wrappers(@_[0], '"<tt>', '</tt>"'); } |
| 141 | sub do_cmd_kbd{ use_wrappers(@_[0], '<kbd>', '</kbd>'); } |
| 142 | sub do_cmd_strong{ use_wrappers(@_[0], '<b>', '</b>'); } |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 143 | |
Fred Drake | 1a7af39 | 1998-04-01 22:44:56 +0000 | [diff] [blame] | 144 | sub do_cmd_newsgroup{ |
| 145 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 146 | my $newsgroup = next_argument(); |
Fred Drake | 1a7af39 | 1998-04-01 22:44:56 +0000 | [diff] [blame] | 147 | my $stuff = "<a href=\"news:$newsgroup\"><font face=sans-serif>" |
| 148 | . "$newsgroup</font></a>"; |
| 149 | $stuff . $_; |
| 150 | } |
Fred Drake | fc16e78 | 1998-03-12 21:03:26 +0000 | [diff] [blame] | 151 | |
| 152 | sub do_cmd_envvar{ |
| 153 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 154 | my($envvar,$br_id) = next_argument_id(); |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 155 | my($name,$aname,$ahref) = link_info($br_id); |
Fred Drake | 166abba | 1998-04-08 23:10:54 +0000 | [diff] [blame] | 156 | # The <tt> here is really to keep buildindex.py from making |
| 157 | # the variable name case-insensitive. |
| 158 | add_index_entry("environment variables!$envvar@<tt>\$$envvar</tt>", |
| 159 | $ahref); |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 160 | add_index_entry("$envvar@\$$envvar", $ahref); |
| 161 | "$aname\$$envvar</a>" . $_; |
Fred Drake | fc16e78 | 1998-03-12 21:03:26 +0000 | [diff] [blame] | 162 | } |
| 163 | |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 164 | |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 165 | sub do_cmd_url{ |
| 166 | # use the URL as both text and hyperlink |
| 167 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 168 | my $url = next_argument(); |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 169 | $url =~ s/~/~/g; |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 170 | "<a href=\"$url\"><font face=sans-serif>$url</font></a>" . $_; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 171 | } |
| 172 | |
| 173 | sub do_cmd_manpage{ |
| 174 | # two parameters: \manpage{name}{section} |
| 175 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 176 | my $page = next_argument(); |
| 177 | my $section = next_argument(); |
| 178 | "<i>$page</i>($section)" . $_; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 179 | } |
| 180 | |
| 181 | sub do_cmd_rfc{ |
| 182 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 183 | my($rfcnumber,$br_id) = next_argument(); |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 184 | |
| 185 | # Save the reference |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 186 | my $nstr = gen_index_id("RFC!RFC $rfcnumber", ''); |
| 187 | $index{$nstr} .= make_half_href("$CURRENT_FILE#$br_id"); |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 188 | "<a name=$br_id>RFC $rfcnumber</a>" .$_; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 189 | } |
| 190 | |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 191 | sub do_cmd_deprecated{ |
| 192 | # two parameters: \deprecated{version}{whattodo} |
| 193 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 194 | my $release = next_argument(); |
| 195 | my $reason = next_argument(); |
| 196 | "<b>Deprecated since release $release.</b>\n$reason<p>" . $_; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 197 | } |
| 198 | |
| 199 | # file and samp are at the end of this file since they screw up fontlock. |
| 200 | |
| 201 | # index commands |
| 202 | |
| 203 | $INDEX_SUBITEM = ""; |
| 204 | |
| 205 | sub get_indexsubitem{ |
Fred Drake | fc16e78 | 1998-03-12 21:03:26 +0000 | [diff] [blame] | 206 | #$INDEX_SUBITEM ? " $INDEX_SUBITEM" : ''; |
| 207 | ''; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 208 | } |
| 209 | |
| 210 | sub do_cmd_setindexsubitem{ |
| 211 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 212 | $INDEX_SUBITEM = next_argument(); |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 213 | $_; |
| 214 | } |
| 215 | |
Fred Drake | fc16e78 | 1998-03-12 21:03:26 +0000 | [diff] [blame] | 216 | sub do_cmd_withsubitem{ |
| 217 | # We can't really do the right right thing, because LaTeX2HTML doesn't |
| 218 | # do things in the right order, but we need to at least strip this stuff |
| 219 | # out, and leave anything that the second argument expanded out to. |
| 220 | # |
| 221 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 222 | next_argument(); |
| 223 | my $stuff = next_argument(); |
| 224 | $stuff . $_; |
Fred Drake | fc16e78 | 1998-03-12 21:03:26 +0000 | [diff] [blame] | 225 | } |
| 226 | |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 227 | # This is the prologue macro which is required to start writing the |
| 228 | # mod\jobname.idx file; we can just ignore it. |
| 229 | # |
Fred Drake | fc16e78 | 1998-03-12 21:03:26 +0000 | [diff] [blame] | 230 | sub do_cmd_makemodindex{ @_[0]; } |
| 231 | |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 232 | # We're in the document subdirectory when this happens! |
Fred Drake | 166abba | 1998-04-08 23:10:54 +0000 | [diff] [blame] | 233 | # |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 234 | open(IDXFILE, '>index.dat') || die "\n$!\n"; |
| 235 | open(INTLABELS, '>intlabels.pl') || die "\n$!\n"; |
Fred Drake | 166abba | 1998-04-08 23:10:54 +0000 | [diff] [blame] | 236 | print INTLABELS "%internal_labels = ();\n"; |
| 237 | print INTLABELS "1; # hack in case there are no entries\n\n"; |
| 238 | |
| 239 | # Using \0 for this is bad because we can't use common tools to work with the |
| 240 | # resulting files. Things like grep can be useful with this stuff! |
| 241 | # |
| 242 | $IDXFILE_FIELD_SEP = "\1"; |
| 243 | |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 244 | |
| 245 | sub gen_target_name{ |
| 246 | "l2h-" . @_[0]; |
| 247 | } |
| 248 | |
| 249 | sub gen_target{ |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 250 | '<a name="' . @_[0] . '">'; |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 251 | } |
| 252 | |
| 253 | sub gen_link{ |
| 254 | my($node,$target) = @_; |
| 255 | print INTLABELS "\$internal_labels{\"$target\"} = \"$URL/$node\";\n"; |
| 256 | "<a href=\"$node#$target\">"; |
| 257 | } |
| 258 | |
| 259 | sub make_index_entry{ |
| 260 | my($br_id,$str) = @_; |
| 261 | my($name,$aname,$ahref) = link_info($br_id); |
| 262 | add_index_entry($str, $ahref); |
| 263 | "$aname$anchor_invisible_mark</a>"; |
| 264 | } |
| 265 | |
| 266 | sub add_index_entry{ |
| 267 | # add an entry to the index structures; ignore the return value |
| 268 | my($str,$ahref) = @_; |
| 269 | $str = gen_index_id($str, ''); |
| 270 | $index{$str} .= $ahref; |
Fred Drake | 166abba | 1998-04-08 23:10:54 +0000 | [diff] [blame] | 271 | print IDXFILE $ahref, $IDXFILE_FIELD_SEP, $str, "\n"; |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 272 | } |
| 273 | |
| 274 | sub link_info{ |
| 275 | my $name = gen_target_name(@_[0]); |
| 276 | my $aname = gen_target($name); |
| 277 | my $ahref = gen_link($CURRENT_FILE, $name); |
| 278 | return ($name, $aname, $ahref); |
| 279 | } |
| 280 | |
| 281 | sub do_cmd_index{ |
| 282 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 283 | my($str,$br_id) = next_argument_id(); |
| 284 | swallow_newline(); |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 285 | # |
| 286 | my($name,$aname,$ahref) = link_info($br_id); |
| 287 | add_index_entry("$str", $ahref); |
| 288 | "$aname$anchor_invisible_mark</a>" . $_; |
| 289 | } |
| 290 | |
Fred Drake | 2e7edb8 | 1998-05-11 18:31:17 +0000 | [diff] [blame] | 291 | sub do_cmd_kwindex{ |
| 292 | local($_) = @_; |
| 293 | my($str,$br_id) = next_argument_id(); |
| 294 | # |
| 295 | my($name,$aname,$ahref) = link_info($br_id); |
| 296 | add_index_entry("<tt>$str</tt>!keyword", $ahref); |
| 297 | add_index_entry("keyword!<tt>$str</tt>", $ahref); |
| 298 | "$aname$anchor_invisible_mark</a>" . $_; |
| 299 | } |
| 300 | |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 301 | sub do_cmd_indexii{ |
| 302 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 303 | my($str1,$br_id) = next_argument_id(); |
| 304 | my $str2 = next_argument(); |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 305 | # |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 306 | my($name,$aname,$ahref) = link_info($br_id); |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 307 | add_index_entry("$str1!$str2", $ahref); |
| 308 | add_index_entry("$str2!$str1", $ahref); |
| 309 | "$aname$anchor_invisible_mark</a>" . $_; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 310 | } |
| 311 | |
| 312 | sub do_cmd_indexiii{ |
| 313 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 314 | my($str1,$br_id) = next_argument(); |
| 315 | my $str2 = next_argument(); |
| 316 | my $str3 = next_argument(); |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 317 | # |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 318 | my($name,$aname,$ahref) = link_info($br_id); |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 319 | add_index_entry("$str1!$str2 $str3", $ahref); |
| 320 | add_index_entry("$str2!$str3, $str1", $ahref); |
| 321 | add_index_entry("$str3!$str1 $str2", $ahref); |
| 322 | "$aname$anchor_invisible_mark</a>" . $_; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 323 | } |
| 324 | |
| 325 | sub do_cmd_indexiv{ |
| 326 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 327 | my($str1,$br_id) = next_argument(); |
| 328 | my $str2 = next_argument(); |
| 329 | my $str3 = next_argument(); |
| 330 | my $str4 = next_argument(); |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 331 | # |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 332 | my($name,$aname,$ahref) = link_info($br_id); |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 333 | add_index_entry("$str1!$str2 $str3 $str4", $ahref); |
| 334 | add_index_entry("$str2!$str3 $str4, $str1", $ahref); |
| 335 | add_index_entry("$str3!$str4, $str1 $str2", $ahref); |
| 336 | add_index_entry("$str4!$$str1 $str2 $str3", $ahref); |
| 337 | "$aname$anchor_invisible_mark</a>" . $_; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 338 | } |
| 339 | |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 340 | sub do_cmd_ttindex{ |
| 341 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 342 | my($str,$br_id) = next_argument_id(); |
| 343 | swallow_newline(); |
| 344 | make_index_entry($br_id, $str . get_indexsubitem()) . $_; |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 345 | } |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 346 | |
| 347 | sub my_typed_index_helper{ |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 348 | local($word,$_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 349 | my($str,$br_id) = next_argument(); |
| 350 | swallow_newline(); |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 351 | # |
| 352 | my($name,$aname,$ahref) = link_info($br_id1); |
| 353 | add_index_entry("$str $word", $ahref); |
| 354 | add_index_entry("$word!$str", $ahref); |
| 355 | "$aname$anchor_invisible_mark</a>" . $_; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 356 | } |
| 357 | |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 358 | sub do_cmd_stindex{ my_typed_index_helper('statement', @_); } |
| 359 | sub do_cmd_opindex{ my_typed_index_helper('operator', @_); } |
| 360 | sub do_cmd_exindex{ my_typed_index_helper('exception', @_); } |
| 361 | sub do_cmd_obindex{ my_typed_index_helper('object', @_); } |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 362 | |
| 363 | sub my_parword_index_helper{ |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 364 | local($word,$_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 365 | my($str,$br_id) = next_argument_id(); |
| 366 | swallow_newline(); |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 367 | make_index_entry($br_id, "$str ($word)") . $_; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 368 | } |
| 369 | |
| 370 | |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 371 | sub make_mod_index_entry{ |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 372 | my($br_id,$str,$define) = @_; |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 373 | my($name,$aname,$ahref) = link_info($br_id); |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 374 | # equivalent of add_index_entry() using $define instead of '' |
| 375 | $str = gen_index_id($str, $define); |
| 376 | $index{$str} .= $ahref; |
Fred Drake | 166abba | 1998-04-08 23:10:54 +0000 | [diff] [blame] | 377 | print IDXFILE $ahref, $IDXFILE_FIELD_SEP, $str, "\n"; |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 378 | |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 379 | if ($define eq 'DEF') { |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 380 | # add to the module index |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 381 | my($nstr,$garbage) = split / /, $str, 2; |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 382 | $Modules{$nstr} .= $ahref; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 383 | } |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 384 | "$aname$anchor_invisible_mark</a>"; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 385 | } |
| 386 | |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 387 | $THIS_MODULE = ''; |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 388 | $THIS_CLASS = ''; |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 389 | |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 390 | sub my_module_index_helper{ |
| 391 | local($word, $_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 392 | my($str,$br_id) = next_argument_id(); |
| 393 | swallow_newline(); |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 394 | my $section_tag = join('', @curr_sec_id); |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 395 | $word = "$word " if $word; |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 396 | $THIS_MODULE = "$str"; |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 397 | make_mod_index_entry("SECTION$section_tag", |
| 398 | "<tt>$str</tt> (${word}module)", 'DEF') . $_; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 399 | } |
| 400 | |
| 401 | sub ref_module_index_helper{ |
| 402 | local($word, $_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 403 | my($str,$br_id) = next_argument(); |
| 404 | swallow_newline(); |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 405 | $word = "$word " if $word; |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 406 | make_mod_index_entry($br_id, "<tt>$str</tt> (${word}module)", 'REF') . $_; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 407 | } |
| 408 | |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 409 | sub do_cmd_bifuncindex{ |
| 410 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 411 | my($str,$br_id) = next_argument(); |
| 412 | swallow_newline(); |
| 413 | my $fname = "<tt>$str()</tt>"; |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 414 | make_index_entry($br_id, "$fname (built-in function)") . $_; |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 415 | } |
| 416 | |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 417 | sub do_cmd_modindex{ my_module_index_helper('', @_); } |
| 418 | sub do_cmd_bimodindex{ my_module_index_helper('built-in', @_); } |
| 419 | sub do_cmd_exmodindex{ my_module_index_helper('extension', @_); } |
| 420 | sub do_cmd_stmodindex{ my_module_index_helper('standard', @_); } |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 421 | |
| 422 | # these should be adjusted a bit.... |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 423 | sub do_cmd_refmodindex{ ref_module_index_helper('', @_); } |
| 424 | sub do_cmd_refbimodindex{ ref_module_index_helper('built-in', @_); } |
| 425 | sub do_cmd_refexmodindex{ ref_module_index_helper('extension', @_); } |
| 426 | sub do_cmd_refstmodindex{ ref_module_index_helper('standard', @_); } |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 427 | |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 428 | sub do_cmd_nodename{ do_cmd_label(@_); } |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 429 | |
| 430 | sub init_myformat{ |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 431 | # $anchor_invisible_mark = ''; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 432 | $anchor_mark = ''; |
| 433 | $icons{'anchor_mark'} = ''; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 434 | } |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 435 | init_myformat(); |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 436 | |
| 437 | # similar to make_index_entry(), but includes the string in the result |
| 438 | # instead of the dummy filler. |
| 439 | # |
| 440 | sub make_str_index_entry{ |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 441 | my($br_id,$str) = @_; |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 442 | my($name,$aname,$ahref) = link_info($br_id); |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 443 | add_index_entry($str, $ahref); |
| 444 | "$aname$str</a>"; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 445 | } |
| 446 | |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 447 | sub do_env_cfuncdesc{ |
| 448 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 449 | my $return_type = next_argument(); |
| 450 | my($function_name,$br_id) = next_argument_id(); |
| 451 | my $arg_list = next_argument(); |
| 452 | my $idx = make_str_index_entry($br_id, |
| 453 | "<tt>$function_name()</tt>" . get_indexsubitem()); |
| 454 | $idx =~ s/ \(.*\)//; |
| 455 | $idx =~ s/\(\)//; # ???? |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 456 | "<dl><dt>$return_type <b>$idx</b>" |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 457 | . "(<var>$arg_list</var>)\n<dd>" |
| 458 | . $_ |
| 459 | . '</dl>'; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 460 | } |
| 461 | |
| 462 | sub do_env_ctypedesc{ |
| 463 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 464 | my($type_name,$br_id) = next_argument_id(); |
| 465 | my $idx = make_str_index_entry($br_id, |
| 466 | "<tt>$type_name</tt>" . get_indexsubitem()); |
| 467 | $idx =~ s/ \(.*\)//; |
| 468 | "<dl><dt><b>$idx</b>\n<dd>" |
| 469 | . $_ |
| 470 | . '</dl>' |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 471 | } |
| 472 | |
| 473 | sub do_env_cvardesc{ |
| 474 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 475 | my $var_type = next_argument(); |
| 476 | my($var_name,$br_id) = next_argument_id(); |
| 477 | my $idx = make_str_index_entry($br_id, |
| 478 | "<tt>$var_name</tt>" . get_indexsubitem()); |
| 479 | $idx =~ s/ \(.*\)//; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 480 | "<dl><dt>$var_type <b>$idx</b>\n" |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 481 | . '<dd>' |
| 482 | . $_ |
| 483 | . '</dl>'; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 484 | } |
| 485 | |
| 486 | sub do_env_funcdesc{ |
| 487 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 488 | my $function_name = next_argument(); |
| 489 | my($arg_list,$br_id) = next_argument_id(); |
| 490 | my $idx = make_str_index_entry($br_id, "<tt>$function_name()</tt>" |
| 491 | . get_indexsubitem()); |
| 492 | $idx =~ s/ \(.*\)//; |
| 493 | $idx =~ s/\(\)//; |
| 494 | "<dl><dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_ . '</dl>'; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 495 | } |
| 496 | |
| 497 | sub do_env_funcdescni{ |
| 498 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 499 | my $function_name = next_argument(); |
| 500 | my $arg_list = next_argument(); |
| 501 | "<dl><dt><b><tt>$function_name</tt></b> (<var>$arg_list</var>)\n<dd>" |
| 502 | . $_ . '</dl>'; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 503 | } |
| 504 | |
| 505 | sub do_cmd_funcline{ |
| 506 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 507 | my $function_name = next_argument(); |
| 508 | my($arg_list,$br_id) = next_argument_id(); |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 509 | my $idx = make_str_index_entry($br_id, "<tt>$function_name()</tt>" |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 510 | . get_indexsubitem()); |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 511 | $idx =~ s/\(\)//; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 512 | "<dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_; |
| 513 | } |
| 514 | |
| 515 | # Change this flag to index the opcode entries. I don't think it's very |
| 516 | # useful to index them, since they're only presented to describe the dis |
| 517 | # module. |
| 518 | # |
| 519 | $INDEX_OPCODES = 0; |
| 520 | |
| 521 | sub do_env_opcodedesc{ |
| 522 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 523 | my $opcode_name = next_argument(); |
| 524 | my($arg_list,$br_id) = next_argument_id(); |
| 525 | my $idx; |
| 526 | if ($INDEX_OPCODES) { |
| 527 | $idx = make_str_index_entry($br_id, |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 528 | "<tt>$opcode_name</tt> (byte code instruction)"); |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 529 | $idx =~ s/ \(byte code instruction\)//; |
| 530 | } |
| 531 | else { |
| 532 | $idx = "<tt>$opcode_name</tt>"; |
| 533 | } |
| 534 | my $stuff = "<dl><dt><b>$idx</b>"; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 535 | if ($arg_list) { |
| 536 | $stuff .= " <var>$arg_list</var>"; |
| 537 | } |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 538 | $stuff . "\n<dd>" . $_ . '</dl>'; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 539 | } |
| 540 | |
| 541 | sub do_env_datadesc{ |
| 542 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 543 | my($dataname,$br_id) = next_argument_id(); |
| 544 | my $idx = make_str_index_entry($br_id, |
| 545 | "<tt>$dataname</tt>" . get_indexsubitem()); |
| 546 | $idx =~ s/ \(.*\)//; |
| 547 | "<dl><dt><b>$idx</b>\n<dd>" |
| 548 | . $_ |
| 549 | . '</dl>'; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 550 | } |
| 551 | |
| 552 | sub do_env_datadescni{ |
| 553 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 554 | my $idx = next_argument(); |
| 555 | if (! $STRING_INDEX_TT) { |
| 556 | $idx = "<tt>$idx</tt>"; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 557 | } |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 558 | "<dl><dt><b>$idx</b>\n<dd>" . $_ . '</dl>'; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 559 | } |
| 560 | |
| 561 | sub do_cmd_dataline{ |
| 562 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 563 | my($data_name,$br_id) = next_argument_id(); |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 564 | my $idx = make_str_index_entry($br_id, "<tt>$data_name</tt>" |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 565 | . get_indexsubitem()); |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 566 | $idx =~ s/ \(.*\)//; |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 567 | "<dt><b>$idx</b><dd>" . $_; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 568 | } |
| 569 | |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 570 | sub do_env_excdesc{ |
| 571 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 572 | my($excname,$br_id) = next_argument_id(); |
Fred Drake | 166abba | 1998-04-08 23:10:54 +0000 | [diff] [blame] | 573 | my $idx = make_str_index_entry($br_id, "<tt>$excname</tt>"); |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 574 | "<dl><dt><b>$idx</b>\n<dd>" . $_ . '</dl>' |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 575 | } |
| 576 | |
| 577 | sub do_env_fulllineitems{ do_env_itemize(@_); } |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 578 | |
| 579 | |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 580 | sub do_env_classdesc{ |
| 581 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 582 | $THIS_CLASS = next_argument(); |
| 583 | my($arg_list,$br_id) = next_argument_id(); |
| 584 | $idx = make_str_index_entry($br_id, |
| 585 | "<tt>$THIS_CLASS</tt> (class in $THIS_MODULE)" ); |
| 586 | $idx =~ s/ \(.*\)//; |
| 587 | "<dl><dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_ . '</dl>'; |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 588 | } |
| 589 | |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 590 | |
| 591 | sub do_env_methoddesc{ |
| 592 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 593 | my $class_name = next_optional_argument(); |
| 594 | $class_name = $THIS_CLASS |
| 595 | unless $class_name; |
| 596 | my($method_name,$br_id) = next_argument_id(); |
| 597 | my $arg_list = next_argument(); |
| 598 | my $extra = ''; |
| 599 | if ($class_name) { |
| 600 | $extra = " ($class_name method)"; |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 601 | } |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 602 | my $idx = make_str_index_entry($br_id, "<tt>$method_name()</tt>$extra"); |
| 603 | $idx =~ s/ \(.*\)//; |
| 604 | $idx =~ s/\(\)//; |
| 605 | "<dl><dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_ . '</dl>'; |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 606 | } |
| 607 | |
| 608 | |
| 609 | sub do_env_methoddescni{ |
| 610 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 611 | next_optional_argument(); |
| 612 | my $method = next_argument(); |
| 613 | my $arg_list = next_argument(); |
| 614 | "<dl><dt><b>$method</b> (<var>$arg_list</var>)\n<dd>" . $_ . '</dl>'; |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 615 | } |
| 616 | |
| 617 | |
| 618 | sub do_env_memberdesc{ |
| 619 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 620 | my $class = next_optional_argument(); |
| 621 | my($member,$br_id) = next_argument(); |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 622 | $class = $THIS_CLASS |
| 623 | unless $class; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 624 | my $extra = ''; |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 625 | $extra = " ($class_name attribute)" |
Fred Drake | a608feb | 1998-04-12 03:58:13 +0000 | [diff] [blame] | 626 | if (!($class eq '')); |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 627 | my $idx = make_str_index_entry($br_id, "<tt>$member</tt>$extra"); |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 628 | $idx =~ s/ \(.*\)//; |
| 629 | $idx =~ s/\(\)//; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 630 | "<dl><dt><b>$idx</b>\n<dd>" . $_ . '</dl>'; |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 631 | } |
| 632 | |
| 633 | |
Fred Drake | 5ccf330 | 1998-04-17 20:04:09 +0000 | [diff] [blame] | 634 | sub do_cmd_memberline{ |
| 635 | local($_) = @_; |
| 636 | my $class = next_optional_argument(); |
| 637 | my($member,$br_id) = next_argument_id(); |
| 638 | $class = $THIS_CLASS |
| 639 | unless $class; |
| 640 | my $extra = ''; |
| 641 | $extra = " ($class_name attribute)" |
| 642 | if (!($class eq '')); |
| 643 | my $idx = make_str_index_entry($br_id, "<tt>$member</tt>$extra"); |
| 644 | $idx =~ s/ \(.*\)//; |
| 645 | $idx =~ s/\(\)//; |
| 646 | "<dt><b>$idx</b><dd>" . $_; |
| 647 | } |
| 648 | |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 649 | sub do_env_memberdescni{ |
| 650 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 651 | next_optional_argument(); |
| 652 | my $member = next_argument(); |
| 653 | "<dl><dt><b>$member</b>\n<dd>" . $_ . '</dl>'; |
Fred Drake | 42b31a5 | 1998-03-27 05:16:10 +0000 | [diff] [blame] | 654 | } |
| 655 | |
| 656 | |
Fred Drake | 5ccf330 | 1998-04-17 20:04:09 +0000 | [diff] [blame] | 657 | sub do_cmd_memberlineni{ |
| 658 | local($_) = @_; |
| 659 | next_optional_argument(); |
| 660 | my $member = next_argument(); |
| 661 | "<dt><b>$member</b><dd>" . $_; |
| 662 | } |
| 663 | |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 664 | @col_aligns = ("<td>", "<td>", "<td>"); |
| 665 | |
| 666 | sub setup_column_alignments{ |
| 667 | local($_) = @_; |
Fred Drake | ee60191 | 1998-04-11 20:53:03 +0000 | [diff] [blame] | 668 | my($a1,$a2,$a3) = split(/[|]/,$_); |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 669 | my($th1,$th2,$th3) = ('<th>', '<th>', '<th>'); |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 670 | $col_aligns[0] = (($a1 eq 'c') ? '<td align=center>' : '<td>'); |
| 671 | $col_aligns[1] = (($a2 eq 'c') ? '<td align=center>' : '<td>'); |
| 672 | $col_aligns[2] = (($a3 eq 'c') ? '<td align=center>' : '<td>'); |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 673 | # return the aligned header start tags; only used for \begin{tableiii?} |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 674 | $th1 = (($a1 eq 'l') ? '<th align=left>' |
| 675 | : ($a1 eq 'r' ? '<th align=right>' : '<th>')); |
| 676 | $th2 = (($a2 eq 'l') ? '<th align=left>' |
| 677 | : ($a2 eq 'r' ? '<th align=right>' : '<th>')); |
| 678 | $th3 = (($a3 eq 'l') ? '<th align=left>' |
| 679 | : ($a3 eq 'r' ? '<th align=right>' : '<th>')); |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 680 | ($th1, $th2, $th3); |
| 681 | } |
| 682 | |
| 683 | sub do_env_tableii{ |
| 684 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 685 | my($th1,$th2,$th3) = setup_column_alignments(next_argument()); |
| 686 | my $font = next_argument(); |
| 687 | my $h1 = next_argument(); |
| 688 | my $h2 = next_argument(); |
| 689 | $font = '' |
| 690 | if ($font eq 'textrm'); |
| 691 | $globals{'lineifont'} = $font; |
| 692 | '<table border align=center>' |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 693 | . "\n <tr>$th1<b>$h1</b></th>" |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 694 | . "\n $th2<b>$h2</b></th>" |
| 695 | . $_ |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 696 | . "\n</table>"; |
| 697 | } |
| 698 | |
| 699 | sub do_cmd_lineii{ |
| 700 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 701 | my $c1 = next_argument(); |
| 702 | my $c2 = next_argument(); |
| 703 | my($font,$sfont,$efont) = ($globals{'lineifont'}, '', ''); |
Fred Drake | 58b2bfd | 1998-04-02 20:14:04 +0000 | [diff] [blame] | 704 | if ($font) { |
Fred Drake | 5cca42e | 1998-04-09 17:59:11 +0000 | [diff] [blame] | 705 | $sfont = "<$font>"; |
Fred Drake | 58b2bfd | 1998-04-02 20:14:04 +0000 | [diff] [blame] | 706 | $efont = "</$font>"; |
| 707 | } |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 708 | my($c1align,$c2align) = @col_aligns[0,1]; |
Fred Drake | 5cca42e | 1998-04-09 17:59:11 +0000 | [diff] [blame] | 709 | "<tr>$c1align$sfont$c1$efont</td>\n" |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 710 | . " $c2align$c2</td>" |
| 711 | . $_; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 712 | } |
| 713 | |
| 714 | sub do_env_tableiii{ |
| 715 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 716 | my($th1,$th2,$th3) = setup_column_alignments(next_argument()); |
| 717 | my $font = next_argument(); |
| 718 | my $h1 = next_argument(); |
| 719 | my $h2 = next_argument(); |
| 720 | my $h3 = next_argument(); |
| 721 | $font = '' |
| 722 | if ($font eq 'textrm'); |
| 723 | $globals{'lineifont'} = $font; |
| 724 | '<table border align=center>' |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 725 | . "\n <tr>$th1<b>$h1</b></th>" |
| 726 | . "\n $th2<b>$h2</b></th>" |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 727 | . "\n $th3<b>$h3</b></th>" |
| 728 | . $_ |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 729 | . "\n</table>"; |
| 730 | } |
| 731 | |
| 732 | sub do_cmd_lineiii{ |
| 733 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 734 | my $c1 = next_argument(); |
| 735 | my $c2 = next_argument(); |
| 736 | my $c3 = next_argument(); |
| 737 | my($font,$sfont,$efont) = ($globals{'lineifont'}, '', ''); |
Fred Drake | 58b2bfd | 1998-04-02 20:14:04 +0000 | [diff] [blame] | 738 | if ($font) { |
Fred Drake | 5cca42e | 1998-04-09 17:59:11 +0000 | [diff] [blame] | 739 | $sfont = "<$font>"; |
Fred Drake | 58b2bfd | 1998-04-02 20:14:04 +0000 | [diff] [blame] | 740 | $efont = "</$font>"; |
| 741 | } |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 742 | my($c1align,$c2align,$c3align) = @col_aligns; |
Fred Drake | 5cca42e | 1998-04-09 17:59:11 +0000 | [diff] [blame] | 743 | "<tr>$c1align$sfont$c1$efont</td>\n" |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 744 | . " $c2align$c2</td>\n" |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 745 | . " $c3align$c3</td>" |
| 746 | . $_; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 747 | } |
| 748 | |
| 749 | sub do_env_seealso{ |
| 750 | "<p><b>See Also:</b></p>\n" . @_[0]; |
| 751 | } |
| 752 | |
| 753 | sub do_cmd_seemodule{ |
| 754 | # Insert the right magic to jump to the module definition. This should |
| 755 | # work most of the time, at least for repeat builds.... |
| 756 | local($_) = @_; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 757 | my $key = next_optional_argument(); |
| 758 | my $module = next_argument(); |
| 759 | my $text = next_argument(); |
| 760 | $key = $module |
| 761 | unless $key; |
Fred Drake | b3c9bca | 1998-03-06 21:20:08 +0000 | [diff] [blame] | 762 | "<p>Module <tt><b><a href=\"module-$key.html\">$module</a></b></tt>" |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 763 | . " ($text)</p>" |
| 764 | . $_; |
| 765 | } |
| 766 | |
| 767 | sub do_cmd_seetext{ |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 768 | '<p>' . @_[0]; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 769 | } |
| 770 | |
| 771 | |
| 772 | sub do_cmd_maketitle { |
| 773 | local($_) = @_; |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 774 | my $the_title = ''; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 775 | if ($t_title) { |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 776 | $the_title .= "<h1 align=center>$t_title</h1>"; |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 777 | } else { write_warnings("\nThis document has no title."); } |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 778 | $the_title .= "\n<center>"; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 779 | if ($t_author) { |
| 780 | if ($t_authorURL) { |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 781 | my $href = translate_commands($t_authorURL); |
| 782 | $href = make_named_href('author', $href, "<strong>${t_author}</strong>"); |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 783 | $the_title .= "\n<p>$href</p>"; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 784 | } else { |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 785 | $the_title .= "\n<p><strong>$t_author</strong></p>"; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 786 | } |
Fred Drake | 0893205 | 1998-04-17 02:15:42 +0000 | [diff] [blame] | 787 | } else { write_warnings("\nThere is no author for this document."); } |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 788 | if ($t_institute) { |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 789 | $the_title .= "\n<p>$t_institute</p>";} |
Fred Drake | d07868a | 1998-05-14 21:00:28 +0000 | [diff] [blame^] | 790 | if ($DEVELOPER_ADDRESS) { |
| 791 | $the_title .= "\n<p>$DEVELOPER_ADDRESS</p>";} |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 792 | if ($t_affil) { |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 793 | $the_title .= "\n<p><i>$t_affil</i></p>";} |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 794 | if ($t_date) { |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 795 | $the_title .= "\n<p><strong>$t_date</strong>"; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 796 | if ($PYTHON_VERSION) { |
| 797 | $the_title .= "<br><strong>Release $PYTHON_VERSION</strong>";} |
| 798 | $the_title .= "</p>" |
| 799 | } |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 800 | $the_title .= "\n</center>"; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 801 | if ($t_address) { |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 802 | $the_title .= "\n<p>$t_address</p>"; |
| 803 | } else { $the_title .= "\n<p>"} |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 804 | if ($t_email) { |
Fred Drake | c9a4438 | 1998-03-17 06:29:13 +0000 | [diff] [blame] | 805 | $the_title .= "\n<p>$t_email</p>"; |
| 806 | }# else { $the_title .= "</p>" } |
| 807 | $the_title . "<hr>\n" . $_ ; |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 808 | } |
| 809 | |
| 810 | |
Fred Drake | 6659c30 | 1998-03-03 22:02:19 +0000 | [diff] [blame] | 811 | 1; # This must be the last line |