Doc/perl/python.perl

   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 use File::Basename;
  12
  13
  14 sub next_argument{
  15     my $param;
  16     $param = missing_braces()
  17       unless ((s/$next_pair_pr_rx/$param=$2;''/eo)
  18               ||(s/$next_pair_rx/$param=$2;''/eo));
  19     return $param;
  20 }
  21
  22 sub next_optional_argument{
  23     my($param,$rx) = ('', "^\\s*(\\[([^]]*)\\])?");
  24     s/$rx/$param=$2;''/eo;
  25     return $param;
  26 }
  27
  28 sub make_icon_filename($){
  29     my($myname, $mydir, $myext) = fileparse(@_[0], '\..*');
  30     chop $mydir;
  31     if ($mydir eq '.') {
  32         $mydir = $ICONSERVER;
  33     }
  34     $myext = ".$IMAGE_TYPE"
  35       unless $myext;
  36     return "$mydir$dd$myname$myext";
  37 }
  38
  39 sub get_link_icon($){
  40     my $url = @_[0];
  41     if ($OFF_SITE_LINK_ICON && ($url =~ /^[-a-zA-Z0-9.]+:/)) {
  42         # absolute URL; assume it points off-site
  43         my $icon = make_icon_filename($OFF_SITE_LINK_ICON);
  44         return (" <img src=\"$icon\"\n"
  45                 . '  border="0" class="offsitelink"'
  46                 . ($OFF_SITE_LINK_ICON_HEIGHT
  47                    ? " height=\"$OFF_SITE_LINK_ICON_HEIGHT\""
  48                    : '')
  49                 . ($OFF_SITE_LINK_ICON_WIDTH
  50                    ? " width=\"$OFF_SITE_LINK_ICON_WIDTH\""
  51                    : '')
  52                 . " alt=\"[off-site link]\"\n"
  53                 . "  >");
  54     }
  55     return '';
  56 }
  57
  58 # This is a fairly simple hack; it supports \let when it is used to create
  59 # (or redefine) a macro to exactly be some other macro: \let\newname=\oldname.
  60 # Many possible uses of \let aren't supported or aren't supported correctly.
  61 #
  62 sub do_cmd_let{
  63     local($_) = @_;
  64     my $matched = 0;
  65     s/[\\]([a-zA-Z]+)\s*(=\s*)?[\\]([a-zA-Z]*)/$matched=1; ''/e;
  66     if ($matched) {
  67         my($new, $old) = ($1, $3);
  68         eval "sub do_cmd_$new { do_cmd_$old" . '(@_); }';
  69         print "\ndefining handler for \\$new using \\$old\n";
  70     }
  71     else {
  72         s/[\\]([a-zA-Z]+)\s*(=\s*)?([^\\])/$matched=1; ''/es;
  73         if ($matched) {
  74             my($new, $char) = ($1, $3);
  75             eval "sub do_cmd_$new { \"\\$char\" . \@_[0]; }";
  76             print "\ndefining handler for \\$new to insert '$char'\n";
  77         }
  78         else {
  79             write_warnings("Could not interpret \\let construct...");
  80         }
  81     }
  82     return $_;
  83 }
  84
  85
  86 # the older version of LaTeX2HTML we use doesn't support this, but we use it:
  87
  88 sub do_cmd_textasciitilde{ '~' . @_[0]; }
  89 sub do_cmd_textasciicircum{ '^' . @_[0]; }
  90 sub do_cmd_textbar{ '|' . @_[0]; }
  91 sub do_cmd_infinity{ '&infin;' . @_[0]; }
  92 sub do_cmd_plusminus{ '&plusmn;' . @_[0]; }
  93 sub do_cmd_menuselection{ @_[0]; }
  94 sub do_cmd_sub{ ' > ' . @_[0]; }
  95
  96
  97 # words typeset in a special way (not in HTML though)
  98
  99 sub do_cmd_ABC{ 'ABC' . @_[0]; }
 100 sub do_cmd_UNIX{ 'Unix'. @_[0]; }
 101 sub do_cmd_ASCII{ 'ASCII' . @_[0]; }
 102 sub do_cmd_POSIX{ 'POSIX' . @_[0]; }
 103 sub do_cmd_C{ 'C' . @_[0]; }
 104 sub do_cmd_Cpp{ 'C++' . @_[0]; }
 105 sub do_cmd_EOF{ 'EOF' . @_[0]; }
 106 sub do_cmd_NULL{ '<tt class="constant">NULL</tt>' . @_[0]; }
 107
 108 sub do_cmd_e{ '&#92;' . @_[0]; }
 109
 110 $DEVELOPER_ADDRESS = '';
 111 $SHORT_VERSION = '';
 112 $RELEASE_INFO = '';
 113 $PACKAGE_VERSION = '';
 114
 115 sub do_cmd_version{ $PACKAGE_VERSION . @_[0]; }
 116 sub do_cmd_shortversion{ $SHORT_VERSION . @_[0]; }
 117 sub do_cmd_release{
 118     local($_) = @_;
 119     $PACKAGE_VERSION = next_argument();
 120     return $_;
 121 }
 122
 123 sub do_cmd_setreleaseinfo{
 124     local($_) = @_;
 125     $RELEASE_INFO = next_argument();
 126     return $_;
 127 }
 128
 129 sub do_cmd_setshortversion{
 130     local($_) = @_;
 131     $SHORT_VERSION = next_argument();
 132     return $_;
 133 }
 134
 135 sub do_cmd_authoraddress{
 136     local($_) = @_;
 137     $DEVELOPER_ADDRESS = next_argument();
 138     return $_;
 139 }
 140
 141 #sub do_cmd_developer{ do_cmd_author(@_[0]); }
 142 #sub do_cmd_developers{ do_cmd_author(@_[0]); }
 143 #sub do_cmd_developersaddress{ do_cmd_authoraddress(@_[0]); }
 144
 145 sub do_cmd_hackscore{
 146     local($_) = @_;
 147     next_argument();
 148     return '_' . $_;
 149 }
 150
 151 sub use_wrappers{
 152     local($_,$before,$after) = @_;
 153     my $stuff = next_argument();
 154     return $before . $stuff . $after . $_;
 155 }
 156
 157 $IN_DESC_HANDLER = 0;
 158 sub do_cmd_optional{
 159     if ($IN_DESC_HANDLER) {
 160         return use_wrappers(@_[0], "</var><big>\[</big><var>",
 161                             "</var><big>\]</big><var>");
 162     }
 163     else {
 164         return use_wrappers(@_[0], "<big>\[</big>", "<big>\]</big>");
 165     }
 166 }
 167
 168 # Logical formatting (some based on texinfo), needs to be converted to
 169 # minimalist HTML.  The "minimalist" is primarily to reduce the size of
 170 # output files for users that read them over the network rather than
 171 # from local repositories.
 172
 173 # \file and \samp are at the end of this file since they screw up fontlock.
 174
 175 sub do_cmd_pytype{ return @_[0]; }
 176 sub do_cmd_makevar{
 177     return use_wrappers(@_[0], '<span class="makevar">', '</span>'); }
 178 sub do_cmd_code{
 179     return use_wrappers(@_[0], '<code>', '</code>'); }
 180 sub do_cmd_module{
 181     return use_wrappers(@_[0], '<tt class="module">', '</tt>'); }
 182 sub do_cmd_keyword{
 183     return use_wrappers(@_[0], '<tt class="keyword">', '</tt>'); }
 184 sub do_cmd_exception{
 185     return use_wrappers(@_[0], '<tt class="exception">', '</tt>'); }
 186 sub do_cmd_class{
 187     return use_wrappers(@_[0], '<tt class="class">', '</tt>'); }
 188 sub do_cmd_function{
 189     return use_wrappers(@_[0], '<tt class="function">', '</tt>'); }
 190 sub do_cmd_constant{
 191     return use_wrappers(@_[0], '<tt class="constant">', '</tt>'); }
 192 sub do_cmd_member{
 193     return use_wrappers(@_[0], '<tt class="member">', '</tt>'); }
 194 sub do_cmd_method{
 195     return use_wrappers(@_[0], '<tt class="method">', '</tt>'); }
 196 sub do_cmd_cfunction{
 197     return use_wrappers(@_[0], '<tt class="cfunction">', '</tt>'); }
 198 sub do_cmd_cdata{
 199     return use_wrappers(@_[0], '<tt class="cdata">', '</tt>'); }
 200 sub do_cmd_ctype{
 201     return use_wrappers(@_[0], '<tt class="ctype">', '</tt>'); }
 202 sub do_cmd_regexp{
 203     return use_wrappers(@_[0], '<tt class="regexp">', '</tt>'); }
 204 sub do_cmd_character{
 205     return use_wrappers(@_[0], '"<tt class="character">', '</tt>"'); }
 206 sub do_cmd_program{
 207     return use_wrappers(@_[0], '<b class="program">', '</b>'); }
 208 sub do_cmd_programopt{
 209     return use_wrappers(@_[0], '<b class="programopt">', '</b>'); }
 210 sub do_cmd_longprogramopt{
 211     # note that the --- will be later converted to -- by LaTeX2HTML
 212     return use_wrappers(@_[0], '<b class="programopt">---', '</b>'); }
 213 sub do_cmd_email{
 214     return use_wrappers(@_[0], '<span class="email">', '</span>'); }
 215 sub do_cmd_mailheader{
 216     return use_wrappers(@_[0], '<tt class="mimeheader">', '</tt>'); }
 217 sub do_cmd_mimetype{
 218     return use_wrappers(@_[0], '<span class="mimetype">', '</span>'); }
 219 sub do_cmd_var{
 220     return use_wrappers(@_[0], "<var>", "</var>"); }
 221 sub do_cmd_dfn{
 222     return use_wrappers(@_[0], '<i class="dfn">', '</i>'); }
 223 sub do_cmd_emph{
 224     return use_wrappers(@_[0], '<i>', '</i>'); }
 225 sub do_cmd_file{
 226     return use_wrappers(@_[0], '<span class="file">', '</span>'); }
 227 sub do_cmd_filenq{
 228     return do_cmd_file(@_[0]); }
 229 sub do_cmd_samp{
 230     return use_wrappers(@_[0], '"<tt class="samp">', '</tt>"'); }
 231 sub do_cmd_kbd{
 232     return use_wrappers(@_[0], '<kbd>', '</kbd>'); }
 233 sub do_cmd_strong{
 234     return use_wrappers(@_[0], '<b>', '</b>'); }
 235 sub do_cmd_textbf{
 236     return use_wrappers(@_[0], '<b>', '</b>'); }
 237 sub do_cmd_textit{
 238     return use_wrappers(@_[0], '<i>', '</i>'); }
 239
 240 sub do_cmd_moreargs{
 241     return '...' . @_[0]; }
 242 sub do_cmd_unspecified{
 243     return '...' . @_[0]; }
 244
 245
 246 sub do_cmd_refmodule{
 247     # Insert the right magic to jump to the module definition.
 248     local($_) = @_;
 249     my $key = next_optional_argument();
 250     my $module = next_argument();
 251     $key = $module
 252         unless $key;
 253     return "<tt class=\"module\"><a href=\"module-$key.html\">$module</a></tt>"
 254       . $_;
 255 }
 256
 257 sub do_cmd_newsgroup{
 258     local($_) = @_;
 259     my $newsgroup = next_argument();
 260     my $icon = get_link_icon("news:$newsgroup");
 261     my $stuff = ("<a class=\"newsgroup\" href=\"news:$newsgroup\">"
 262                  . "$newsgroup$icon</a>");
 263     return $stuff . $_;
 264 }
 265
 266 sub do_cmd_envvar{
 267     local($_) = @_;
 268     my $envvar = next_argument();
 269     my($name,$aname,$ahref) = new_link_info();
 270     # The <tt> here is really to keep buildindex.py from making
 271     # the variable name case-insensitive.
 272     add_index_entry("environment variables!$envvar@<tt>$envvar</tt>",
 273                     $ahref);
 274     add_index_entry("$envvar (environment variable)", $ahref);
 275     $aname =~ s/<a/<a class="envvar"/;
 276     return "$aname$envvar</a>" . $_;
 277 }
 278
 279 sub do_cmd_url{
 280     # use the URL as both text and hyperlink
 281     local($_) = @_;
 282     my $url = next_argument();
 283     my $icon = get_link_icon($url);
 284     $url =~ s/~/&#126;/g;
 285     return "<a class=\"url\" href=\"$url\">$url$icon</a>" . $_;
 286 }
 287
 288 sub do_cmd_manpage{
 289     # two parameters:  \manpage{name}{section}
 290     local($_) = @_;
 291     my $page = next_argument();
 292     my $section = next_argument();
 293     return "<span class=\"manpage\"><i>$page</i>($section)</span>" . $_;
 294 }
 295
 296 $PEP_FORMAT = "http://python.sourceforge.net/peps/pep-%04d.html";
 297 #$RFC_FORMAT = "http://www.ietf.org/rfc/rfc%04d.txt";
 298 $RFC_FORMAT = "http://www.faqs.org/rfcs/rfc%d.html";
 299
 300 sub get_rfc_url($$){
 301     my($rfcnum, $format) = @_;
 302     return sprintf($format, $rfcnum);
 303 }
 304
 305 sub do_cmd_pep{
 306     local($_) = @_;
 307     my $rfcnumber = next_argument();
 308     my $id = "rfcref-" . ++$global{'max_id'};
 309     my $href = get_rfc_url($rfcnumber, $PEP_FORMAT);
 310     my $icon = get_link_icon($href);
 311     # Save the reference
 312     my $nstr = gen_index_id("Python Enhancement Proposals!PEP $rfcnumber", '');
 313     $index{$nstr} .= make_half_href("$CURRENT_FILE#$id");
 314     return ("<a class=\"rfc\" name=\"$id\"\nhref=\"$href\">PEP $rfcnumber"
 315             . "$icon</a>" . $_);
 316 }
 317
 318 sub do_cmd_rfc{
 319     local($_) = @_;
 320     my $rfcnumber = next_argument();
 321     my $id = "rfcref-" . ++$global{'max_id'};
 322     my $href = get_rfc_url($rfcnumber, $RFC_FORMAT);
 323     my $icon = get_link_icon($href);
 324     # Save the reference
 325     my $nstr = gen_index_id("RFC!RFC $rfcnumber", '');
 326     $index{$nstr} .= make_half_href("$CURRENT_FILE#$id");
 327     return ("<a class=\"rfc\" name=\"$id\"\nhref=\"$href\">RFC $rfcnumber"
 328             . "$icon</a>" . $_);
 329 }
 330
 331 sub do_cmd_ulink{
 332     local($_) = @_;
 333     my $text = next_argument();
 334     my $url = next_argument();
 335     return "<a class=\"ulink\" href=\"$url\"\n  >$text</a>" . $_;
 336 }
 337
 338 sub do_cmd_citetitle{
 339     local($_) = @_;
 340     my $url = next_optional_argument();
 341     my $title = next_argument();
 342     my $icon = get_link_icon($url);
 343     my $repl = '';
 344     if ($url) {
 345         $repl = ("<em class=\"citetitle\"><a\n"
 346                  . " href=\"$url\"\n"
 347                  . " title=\"$title\"\n"
 348                  . " >$title$icon</a></em>");
 349     }
 350     else {
 351         $repl = "<em class=\"citetitle\"\n >$title</em>";
 352     }
 353     return $repl . $_;
 354 }
 355
 356 sub do_cmd_deprecated{
 357     # two parameters:  \deprecated{version}{whattodo}
 358     local($_) = @_;
 359     my $release = next_argument();
 360     my $reason = next_argument();
 361     return ('<div class="versionnote">'
 362             . "<b>Deprecated since release $release.</b>"
 363             . "\n$reason</div><p>"
 364             . $_);
 365 }
 366
 367 sub versionnote{
 368     # one or two parameters:  \versionnote[explanation]{version}
 369     my $type = @_[0];
 370     local $_ = @_[1];
 371     my $explanation = next_optional_argument();
 372     my $release = next_argument();
 373     my $text = "$type in version $release.";
 374     if ($explanation) {
 375         $text = "$type in version $release:\n$explanation.";
 376     }
 377     return "\n<span class=\"versionnote\">$text</span>\n" . $_;
 378 }
 379
 380 sub do_cmd_versionadded{
 381     return versionnote('New', @_);
 382 }
 383
 384 sub do_cmd_versionchanged{
 385     return versionnote('Changed', @_);
 386 }
 387
 388 #
 389 # These function handle platform dependency tracking.
 390 #
 391 sub do_cmd_platform{
 392     local($_) = @_;
 393     my $platform = next_argument();
 394     $ModulePlatforms{"<tt class=\"module\">$THIS_MODULE</tt>"} = $platform;
 395     $platform = "Macintosh"
 396       if $platform eq 'Mac';
 397     return "\n<p class=\"availability\">Availability: <span"
 398       . "\n class=\"platform\">$platform</span>.</p>\n" . $_;
 399 }
 400
 401 $IGNORE_PLATFORM_ANNOTATION = '';
 402 sub do_cmd_ignorePlatformAnnotation{
 403     local($_) = @_;
 404     $IGNORE_PLATFORM_ANNOTATION = next_argument();
 405     return $_;
 406 }
 407
 408
 409 # index commands
 410
 411 $INDEX_SUBITEM = "";
 412
 413 sub get_indexsubitem{
 414     return $INDEX_SUBITEM ? " $INDEX_SUBITEM" : '';
 415 }
 416
 417 sub do_cmd_setindexsubitem{
 418     local($_) = @_;
 419     $INDEX_SUBITEM = next_argument();
 420     return $_;
 421 }
 422
 423 sub do_cmd_withsubitem{
 424     # We can't really do the right thing, because LaTeX2HTML doesn't
 425     # do things in the right order, but we need to at least strip this stuff
 426     # out, and leave anything that the second argument expanded out to.
 427     #
 428     local($_) = @_;
 429     my $oldsubitem = $INDEX_SUBITEM;
 430     $INDEX_SUBITEM = next_argument();
 431     my $stuff = next_argument();
 432     my $br_id = ++$globals{'max_id'};
 433     my $marker = "$O$br_id$C";
 434     return
 435       $stuff
 436       . "\\setindexsubitem$marker$oldsubitem$marker"
 437       . $_;
 438 }
 439
 440 # This is the prologue macro which is required to start writing the
 441 # mod\jobname.idx file; we can just ignore it.  (Defining this suppresses
 442 # a warning that \makemodindex is unknown.)
 443 #
 444 sub do_cmd_makemodindex{ return @_[0]; }
 445
 446 # We're in the document subdirectory when this happens!
 447 #
 448 open(IDXFILE, '>index.dat') || die "\n$!\n";
 449 open(INTLABELS, '>intlabels.pl') || die "\n$!\n";
 450 print INTLABELS "%internal_labels = ();\n";
 451 print INTLABELS "1;             # hack in case there are no entries\n\n";
 452
 453 # Using \0 for this is bad because we can't use common tools to work with the
 454 # resulting files.  Things like grep can be useful with this stuff!
 455 #
 456 $IDXFILE_FIELD_SEP = "\1";
 457
 458 sub write_idxfile{
 459     my ($ahref, $str) = @_;
 460     print IDXFILE $ahref, $IDXFILE_FIELD_SEP, $str, "\n";
 461 }
 462
 463
 464 sub gen_link{
 465     my($node,$target) = @_;
 466     print INTLABELS "\$internal_labels{\"$target\"} = \"$URL/$node\";\n";
 467     return "<a href=\"$node#$target\">";
 468 }
 469
 470 sub add_index_entry{
 471     # add an entry to the index structures; ignore the return value
 472     my($str,$ahref) = @_;
 473     $str = gen_index_id($str, '');
 474     $index{$str} .= $ahref;
 475     write_idxfile($ahref, $str);
 476 }
 477
 478 sub new_link_info{
 479     my $name = "l2h-" . ++$globals{'max_id'};
 480     my $aname = "<a name=\"$name\">";
 481     my $ahref = gen_link($CURRENT_FILE, $name);
 482     return ($name, $aname, $ahref);
 483 }
 484
 485 $IndexMacroPattern = '';
 486 sub define_indexing_macro{
 487     my $count = @_;
 488     my $i = 0;
 489     for (; $i < $count; ++$i) {
 490         my $name = @_[$i];
 491         my $cmd = "idx_cmd_$name";
 492         die "\nNo function $cmd() defined!\n"
 493           if (!defined &$cmd);
 494         eval ("sub do_cmd_$name { return process_index_macros("
 495               . "\@_[0], '$name'); }");
 496         if (length($IndexMacroPattern) == 0) {
 497             $IndexMacroPattern = "$name";
 498         }
 499         else {
 500             $IndexMacroPattern .= "|$name";
 501         }
 502     }
 503 }
 504
 505 $DEBUG_INDEXING = 0;
 506 sub process_index_macros{
 507     local($_) = @_;
 508     my $cmdname = @_[1];        # This is what triggered us in the first place;
 509                                 # we know it's real, so just process it.
 510     my($name,$aname,$ahref) = new_link_info();
 511     my $cmd = "idx_cmd_$cmdname";
 512     print "\nIndexing: \\$cmdname"
 513       if $DEBUG_INDEXING;
 514     &$cmd($ahref);              # modifies $_ and adds index entries
 515     while (/^[\s\n]*\\($IndexMacroPattern)</) {
 516         $cmdname = "$1";
 517         print " \\$cmdname"
 518           if $DEBUG_INDEXING;
 519         $cmd = "idx_cmd_$cmdname";
 520         if (!defined &$cmd) {
 521             last;
 522         }
 523         else {
 524             s/^[\s\n]*\\$cmdname//;
 525             &$cmd($ahref);
 526         }
 527     }
 528     if (/^[ \t\r\n]/) {
 529         $_ = substr($_, 1);
 530     }
 531     return "$aname$anchor_invisible_mark</a>" . $_;
 532 }
 533
 534 define_indexing_macro('index');
 535 sub idx_cmd_index{
 536     my $str = next_argument();
 537     add_index_entry("$str", @_[0]);
 538 }
 539
 540 define_indexing_macro('kwindex');
 541 sub idx_cmd_kwindex{
 542     my $str = next_argument();
 543     add_index_entry("<tt>$str</tt>!keyword", @_[0]);
 544     add_index_entry("keyword!<tt>$str</tt>", @_[0]);
 545 }
 546
 547 define_indexing_macro('indexii');
 548 sub idx_cmd_indexii{
 549     my $str1 = next_argument();
 550     my $str2 = next_argument();
 551     add_index_entry("$str1!$str2", @_[0]);
 552     add_index_entry("$str2!$str1", @_[0]);
 553 }
 554
 555 define_indexing_macro('indexiii');
 556 sub idx_cmd_indexiii{
 557     my $str1 = next_argument();
 558     my $str2 = next_argument();
 559     my $str3 = next_argument();
 560     add_index_entry("$str1!$str2 $str3", @_[0]);
 561     add_index_entry("$str2!$str3, $str1", @_[0]);
 562     add_index_entry("$str3!$str1 $str2", @_[0]);
 563 }
 564
 565 define_indexing_macro('indexiv');
 566 sub idx_cmd_indexiv{
 567     my $str1 = next_argument();
 568     my $str2 = next_argument();
 569     my $str3 = next_argument();
 570     my $str4 = next_argument();
 571     add_index_entry("$str1!$str2 $str3 $str4", @_[0]);
 572     add_index_entry("$str2!$str3 $str4, $str1", @_[0]);
 573     add_index_entry("$str3!$str4, $str1 $str2", @_[0]);
 574     add_index_entry("$str4!$$str1 $str2 $str3", @_[0]);
 575 }
 576
 577 define_indexing_macro('ttindex');
 578 sub idx_cmd_ttindex{
 579     my $str = next_argument();
 580     my $entry = $str . get_indexsubitem();
 581     add_index_entry($entry, @_[0]);
 582 }
 583
 584 sub my_typed_index_helper{
 585     my($word,$ahref) = @_;
 586     my $str = next_argument();
 587     add_index_entry("$str $word", $ahref);
 588     add_index_entry("$word!$str", $ahref);
 589 }
 590
 591 define_indexing_macro('stindex', 'opindex', 'exindex', 'obindex');
 592 sub idx_cmd_stindex{ my_typed_index_helper('statement', @_[0]); }
 593 sub idx_cmd_opindex{ my_typed_index_helper('operator', @_[0]); }
 594 sub idx_cmd_exindex{ my_typed_index_helper('exception', @_[0]); }
 595 sub idx_cmd_obindex{ my_typed_index_helper('object', @_[0]); }
 596
 597 define_indexing_macro('bifuncindex');
 598 sub idx_cmd_bifuncindex{
 599     my $str = next_argument();
 600     add_index_entry("<tt class=\"function\">$str()</tt> (built-in function)",
 601                     @_[0]);
 602 }
 603
 604
 605 sub make_mod_index_entry{
 606     my($str,$define) = @_;
 607     my($name,$aname,$ahref) = new_link_info();
 608     # equivalent of add_index_entry() using $define instead of ''
 609     $ahref =~ s/\#[-_a-zA-Z0-9]*\"/\"/
 610       if ($define eq 'DEF');
 611     $str = gen_index_id($str, $define);
 612     $index{$str} .= $ahref;
 613     write_idxfile($ahref, $str);
 614
 615     if ($define eq 'DEF') {
 616         # add to the module index
 617         $str =~ /(<tt.*<\/tt>)/;
 618         my $nstr = $1;
 619         $Modules{$nstr} .= $ahref;
 620     }
 621     return "$aname$anchor_invisible_mark2</a>";
 622 }
 623
 624
 625 $THIS_MODULE = '';
 626 $THIS_CLASS = '';
 627
 628 sub define_module{
 629     my($word,$name) = @_;
 630     my $section_tag = join('', @curr_sec_id);
 631     if ($word ne "built-in" && $word ne "extension"
 632         && $word ne "standard" && $word ne "") {
 633         write_warnings("Bad module type '$word'"
 634                        . " for \\declaremodule (module $name)");
 635         $word = "";
 636     }
 637     $word = "$word " if $word;
 638     $THIS_MODULE = "$name";
 639     $INDEX_SUBITEM = "(in module $name)";
 640     print "[$name]";
 641     return make_mod_index_entry(
 642         "<tt class=\"module\">$name</tt> (${word}module)", 'DEF');
 643 }
 644
 645 sub my_module_index_helper{
 646     local($word, $_) = @_;
 647     my $name = next_argument();
 648     return define_module($word, $name) . $_;
 649 }
 650
 651 sub do_cmd_modindex{ return my_module_index_helper('', @_); }
 652 sub do_cmd_bimodindex{ return my_module_index_helper('built-in', @_); }
 653 sub do_cmd_exmodindex{ return my_module_index_helper('extension', @_); }
 654 sub do_cmd_stmodindex{ return my_module_index_helper('standard', @_); }
 655
 656 sub ref_module_index_helper{
 657     my($word, $ahref) = @_;
 658     my $str = next_argument();
 659     $word = "$word " if $word;
 660     $str = "<tt class=\"module\">$str</tt> (${word}module)";
 661     # can't use add_index_entry() since the 2nd arg to gen_index_id() is used;
 662     # just inline it all here
 663     $str = gen_index_id($str, 'REF');
 664     $index{$str} .= $ahref;
 665     write_idxfile($ahref, $str);
 666 }
 667
 668 # these should be adjusted a bit....
 669 define_indexing_macro('refmodindex', 'refbimodindex',
 670                       'refexmodindex', 'refstmodindex');
 671 sub idx_cmd_refmodindex{ return ref_module_index_helper('', @_); }
 672 sub idx_cmd_refbimodindex{ return ref_module_index_helper('built-in', @_); }
 673 sub idx_cmd_refexmodindex{ return ref_module_index_helper('extension', @_); }
 674 sub idx_cmd_refstmodindex{ return ref_module_index_helper('standard', @_); }
 675
 676 sub do_cmd_nodename{ return do_cmd_label(@_); }
 677
 678 sub init_myformat{
 679     $anchor_invisible_mark = '&nbsp;';
 680     $anchor_invisible_mark2 = '';
 681     $anchor_mark = '';
 682     $icons{'anchor_mark'} = '';
 683 }
 684 init_myformat();
 685
 686 # Create an index entry, but include the string in the target anchor
 687 # instead of the dummy filler.
 688 #
 689 sub make_str_index_entry{
 690     my($str) = @_;
 691     my($name,$aname,$ahref) = new_link_info();
 692     add_index_entry($str, $ahref);
 693     return "$aname$str</a>";
 694 }
 695
 696
 697 %TokenToTargetMapping = ();
 698 %DefinedGrammars = ();
 699 %BackpatchGrammarFiles = ();
 700
 701 sub do_cmd_token{
 702     local($_) = @_;
 703     my $token = next_argument();
 704     my $target = $TokenToTargetMapping{"$CURRENT_GRAMMAR:$token"};
 705     if ($token eq $CURRENT_TOKEN || $CURRENT_GRAMMAR eq '*') {
 706         # recursive definition or display-only productionlist
 707         return "$token";
 708     }
 709     if ($target eq '') {
 710         $target = "<pyGrammarToken><$CURRENT_GRAMMAR><$token>";
 711         if (! $BackpatchGrammarFiles{"$CURRENT_FILE"}) {
 712             print "Adding '$CURRENT_FILE' to back-patch list.\n";
 713         }
 714         $BackpatchGrammarFiles{"$CURRENT_FILE"} = 1;
 715     }
 716     return "<a href=\"$target\">$token</a>" . $_;
 717 }
 718
 719 sub do_cmd_grammartoken{
 720     return do_cmd_token(@_);
 721 }
 722
 723 sub do_env_productionlist{
 724     local($_) = @_;
 725     my $lang = next_optional_argument();
 726     my $filename = "grammar-$lang.txt";
 727     if ($lang eq '') {
 728         $filename = 'grammar.txt';
 729     }
 730     local($CURRENT_GRAMMAR) = $lang;
 731     $DefinedGrammars{$lang} .= $_;
 732     return ("<dl><dd class=\"grammar\">\n"
 733             . "<div class=\"productions\">\n"
 734             . "<table cellpadding=\"2\" valign=\"baseline\">\n"
 735             . translate_commands(translate_environments($_))
 736             . "</table>\n"
 737             . "</div>\n"
 738             . (($lang eq '*')
 739                ? ''
 740                : ("<a class=\"grammar-footer\"\n"
 741                   . "  href=\"$filename\" type=\"text/plain\"\n"
 742                   . "  >Download entire grammar as text.</a>\n"))
 743             . "</dd></dl>");
 744 }
 745
 746 sub do_cmd_production{
 747     local($_) = @_;
 748     my $token = next_argument();
 749     my $defn = next_argument();
 750     my $lang = $CURRENT_GRAMMAR;
 751     local($CURRENT_TOKEN) = $token;
 752     if ($lang eq '*') {
 753         return ("<tr>\n"
 754                 . "    <td><code>$token</code></td>\n"
 755                 . "    <td>&nbsp;::=&nbsp;</td>\n"
 756                 . "    <td><code>"
 757                 . translate_commands($defn)
 758                 . "</code></td></tr>"
 759                 . $_);
 760     }
 761     my $target;
 762     if ($lang eq '') {
 763         $target = "$CURRENT_FILE\#tok-$token";
 764     }
 765     else {
 766         $target = "$CURRENT_FILE\#tok-$lang-$token";
 767     }
 768     $TokenToTargetMapping{"$CURRENT_GRAMMAR:$token"} = $target;
 769     return ("<tr>\n"
 770             . "    <td><code><a name=\"tok-$token\">$token</a></code></td>\n"
 771             . "    <td>&nbsp;::=&nbsp;</td>\n"
 772             . "    <td><code>"
 773             . translate_commands($defn)
 774             . "</code></td></tr>"
 775             . $_);
 776 }
 777
 778 sub process_grammar_files{
 779     my $lang;
 780     my $filename;
 781     local($_);
 782     print "process_grammar_files()\n";
 783     foreach $lang (keys %DefinedGrammars) {
 784         $filename = "grammar-$lang.txt";
 785         if ($lang eq '*') {
 786             next;
 787         }
 788         if ($lang eq '') {
 789             $filename = 'grammar.txt';
 790         }
 791         open(GRAMMAR, ">$filename") || die "\n$!\n";
 792         print GRAMMAR strip_grammar_markup($DefinedGrammars{$lang});
 793         close(GRAMMAR);
 794         print "Wrote grammar file $filename\n";
 795     }
 796     my $PATTERN = '<pyGrammarToken><([^>]*)><([^>]*)>';
 797     foreach $filename (keys %BackpatchGrammarFiles) {
 798         print "\nBack-patching grammar links in $filename\n";
 799         my $buffer;
 800         open(GRAMMAR, "<$filename") || die "\n$!\n";
 801         # read all of the file into the buffer
 802         sysread(GRAMMAR, $buffer, 1024*1024);
 803         close(GRAMMAR);
 804         while ($buffer =~ /$PATTERN/) {
 805             my($lang, $token) = ($1, $2);
 806             my $target = $TokenToTargetMapping{"$lang:$token"};
 807             my $source = "<pyGrammarToken><$lang><$token>";
 808             $buffer =~ s/$source/$target/g;
 809         }
 810         open(GRAMMAR, ">$filename") || die "\n$!\n";
 811         print GRAMMAR $buffer;
 812         close(GRAMMAR);
 813     }
 814 }
 815
 816 sub strip_grammar_markup{
 817     local($_) = @_;
 818     s/\\production(<<\d+>>)(.+)\1/\n\2 ::= /g;
 819     s/\\token(<<\d+>>)(.+)\1/\2/g;
 820     s/\\e([^a-zA-Z])/\\\1/g;
 821     s/<<\d+>>//g;
 822     s/;SPMgt;/>/g;
 823     s/;SPMlt;/</g;
 824     s/;SPMquot;/\"/g;
 825     return $_;
 826 }
 827
 828
 829 $REFCOUNTS_LOADED = 0;
 830
 831 sub load_refcounts{
 832     $REFCOUNTS_LOADED = 1;
 833
 834     my $myname, $mydir, $myext;
 835     ($myname, $mydir, $myext) = fileparse(__FILE__, '\..*');
 836     chop $mydir;                        # remove trailing '/'
 837     ($myname, $mydir, $myext) = fileparse($mydir, '\..*');
 838     chop $mydir;                        # remove trailing '/'
 839     $mydir = getcwd() . "$dd$mydir"
 840       unless $mydir =~ s|^/|/|;
 841     local $_;
 842     my $filename = "$mydir${dd}api${dd}refcounts.dat";
 843     open(REFCOUNT_FILE, "<$filename") || die "\n$!\n";
 844     print "[loading API refcount data]";
 845     while (<REFCOUNT_FILE>) {
 846         if (/([a-zA-Z0-9_]+):PyObject\*:([a-zA-Z0-9_]*):(0|[-+]1|null):(.*)$/) {
 847             my($func, $param, $count, $comment) = ($1, $2, $3, $4);
 848             #print "\n$func($param) --> $count";
 849             $REFCOUNTS{"$func:$param"} = $count;
 850         }
 851     }
 852 }
 853
 854 sub get_refcount{
 855     my ($func, $param) = @_;
 856     load_refcounts()
 857         unless $REFCOUNTS_LOADED;
 858     return $REFCOUNTS{"$func:$param"};
 859 }
 860
 861 sub do_env_cfuncdesc{
 862     local($_) = @_;
 863     my $return_type = next_argument();
 864     my $function_name = next_argument();
 865     my $arg_list = next_argument();
 866     my $idx = make_str_index_entry(
 867         "<tt class=\"cfunction\">$function_name()</tt>" . get_indexsubitem());
 868     $idx =~ s/ \(.*\)//;
 869     $idx =~ s/\(\)//;           # ???? - why both of these?
 870     my $result_rc = get_refcount($function_name, '');
 871     my $rcinfo = '';
 872     if ($result_rc eq '+1') {
 873         $rcinfo = 'New reference';
 874     }
 875     elsif ($result_rc eq '0') {
 876         $rcinfo = 'Borrowed reference';
 877     }
 878     elsif ($result_rc eq 'null') {
 879         $rcinfo = 'Always <tt class="constant">NULL</tt>';
 880     }
 881     if ($rcinfo ne '') {
 882         $rcinfo = (  "\n<div class=\"refcount-info\">"
 883                    . "\n  <span class=\"label\">Return value:</span>"
 884                    . "\n  <span class=\"value\">$rcinfo.</span>"
 885                    . "\n</div>");
 886     }
 887     return "<dl><dt>$return_type <b>$idx</b>(<var>$arg_list</var>)\n<dd>"
 888            . $rcinfo
 889            . $_
 890            . '</dl>';
 891 }
 892
 893 sub do_env_csimplemacrodesc{
 894     local($_) = @_;
 895     my $name = next_argument();
 896     my $idx = make_str_index_entry("<tt class=\"macro\">$name</tt>");
 897     return "<dl><dt><b>$idx</b>\n<dd>"
 898            . $_
 899            . '</dl>'
 900 }
 901
 902 sub do_env_ctypedesc{
 903     local($_) = @_;
 904     my $index_name = next_optional_argument();
 905     my $type_name = next_argument();
 906     $index_name = $type_name
 907       unless $index_name;
 908     my($name,$aname,$ahref) = new_link_info();
 909     add_index_entry("<tt class=\"ctype\">$index_name</tt> (C type)", $ahref);
 910     return "<dl><dt><b><tt class=\"ctype\">$aname$type_name</a></tt></b>\n<dd>"
 911            . $_
 912            . '</dl>'
 913 }
 914
 915 sub do_env_cvardesc{
 916     local($_) = @_;
 917     my $var_type = next_argument();
 918     my $var_name = next_argument();
 919     my $idx = make_str_index_entry("<tt class=\"cdata\">$var_name</tt>"
 920                                    . get_indexsubitem());
 921     $idx =~ s/ \(.*\)//;
 922     return "<dl><dt>$var_type <b>$idx</b>\n"
 923            . '<dd>'
 924            . $_
 925            . '</dl>';
 926 }
 927
 928 sub convert_args($){
 929     local($IN_DESC_HANDLER) = 1;
 930     local($_) = @_;
 931     return translate_commands($_);
 932 }
 933
 934 sub do_env_funcdesc{
 935     local($_) = @_;
 936     my $function_name = next_argument();
 937     my $arg_list = convert_args(next_argument());
 938     my $idx = make_str_index_entry("<tt class=\"function\">$function_name()"
 939                                    . '</tt>'
 940                                    . get_indexsubitem());
 941     $idx =~ s/ \(.*\)//;
 942     $idx =~ s/\(\)<\/tt>/<\/tt>/;
 943     return "<dl><dt><b>$idx</b>(<var>$arg_list</var>)\n<dd>" . $_ . '</dl>';
 944 }
 945
 946 sub do_env_funcdescni{
 947     local($_) = @_;
 948     my $function_name = next_argument();
 949     my $arg_list = convert_args(next_argument());
 950     return "<dl><dt><b><tt class=\"function\">$function_name</tt></b>"
 951       . "(<var>$arg_list</var>)\n"
 952       . '<dd>'
 953       . $_
 954       . '</dl>';
 955 }
 956
 957 sub do_cmd_funcline{
 958     local($_) = @_;
 959     my $function_name = next_argument();
 960     my $arg_list = convert_args(next_argument());
 961     my $prefix = "<tt class=\"function\">$function_name()</tt>";
 962     my $idx = make_str_index_entry($prefix . get_indexsubitem());
 963     $prefix =~ s/\(\)//;
 964
 965     return "<dt><b>$prefix</b>(<var>$arg_list</var>)\n<dd>" . $_;
 966 }
 967
 968 sub do_cmd_funclineni{
 969     local($_) = @_;
 970     my $function_name = next_argument();
 971     my $arg_list = convert_args(next_argument());
 972     my $prefix = "<tt class=\"function\">$function_name</tt>";
 973
 974     return "<dt><b>$prefix</b>(<var>$arg_list</var>)\n<dd>" . $_;
 975 }
 976
 977 # Change this flag to index the opcode entries.  I don't think it's very
 978 # useful to index them, since they're only presented to describe the dis
 979 # module.
 980 #
 981 $INDEX_OPCODES = 0;
 982
 983 sub do_env_opcodedesc{
 984     local($_) = @_;
 985     my $opcode_name = next_argument();
 986     my $arg_list = next_argument();
 987     my $idx;
 988     if ($INDEX_OPCODES) {
 989         $idx = make_str_index_entry("<tt class=\"opcode\">$opcode_name</tt>"
 990                                     . ' (byte code instruction)');
 991         $idx =~ s/ \(byte code instruction\)//;
 992     }
 993     else {
 994         $idx = "<tt class=\"opcode\">$opcode_name</tt>";
 995     }
 996     my $stuff = "<dl><dt><b>$idx</b>";
 997     if ($arg_list) {
 998         $stuff .= "&nbsp;&nbsp;&nbsp;&nbsp;<var>$arg_list</var>";
 999     }
1000     return $stuff . "\n<dd>" . $_ . '</dl>';
1001 }
1002
1003 sub do_env_datadesc{
1004     local($_) = @_;
1005     my $dataname = next_argument();
1006     my $idx = make_str_index_entry("<tt>$dataname</tt>" . get_indexsubitem());
1007     $idx =~ s/ \(.*\)//;
1008     return "<dl><dt><b>$idx</b>\n<dd>"
1009            . $_
1010            . '</dl>';
1011 }
1012
1013 sub do_env_datadescni{
1014     local($_) = @_;
1015     my $idx = next_argument();
1016     if (! $STRING_INDEX_TT) {
1017         $idx = "<tt>$idx</tt>";
1018     }
1019     return "<dl><dt><b>$idx</b>\n<dd>" . $_ . '</dl>';
1020 }
1021
1022 sub do_cmd_dataline{
1023     local($_) = @_;
1024     my $data_name = next_argument();
1025     my $idx = make_str_index_entry("<tt>$data_name</tt>" . get_indexsubitem());
1026     $idx =~ s/ \(.*\)//;
1027     return "<dt><b>$idx</b><dd>" . $_;
1028 }
1029
1030 sub do_cmd_datalineni{
1031     local($_) = @_;
1032     my $data_name = next_argument();
1033     return "<dt><b><tt>$data_name</tt></b><dd>" . $_;
1034 }
1035
1036 sub do_env_excdesc{
1037     local($_) = @_;
1038     my $excname = next_argument();
1039     my $idx = make_str_index_entry("<tt class=\"exception\">$excname</tt>");
1040     return "<dl><dt><b>exception $idx</b>\n<dd>" . $_ . '</dl>'
1041 }
1042
1043 sub do_env_fulllineitems{ return do_env_itemize(@_); }
1044
1045
1046 sub handle_classlike_descriptor{
1047     local($_, $what) = @_;
1048     $THIS_CLASS = next_argument();
1049     my $arg_list = convert_args(next_argument());
1050     $idx = make_str_index_entry(
1051         "<tt class=\"$what\">$THIS_CLASS</tt> ($what in $THIS_MODULE)" );
1052     $idx =~ s/ \(.*\)//;
1053     return ("<dl><dt><b>$what $idx</b>(<var>$arg_list</var>)\n<dd>"
1054             . $_
1055             . '</dl>');
1056 }
1057
1058 sub do_env_classdesc{
1059     return handle_classlike_descriptor(@_[0], "class");
1060 }
1061
1062 sub do_env_classdescstar{
1063     local($_) = @_;
1064     $THIS_CLASS = next_argument();
1065     $idx = make_str_index_entry(
1066         "<tt class=\"class\">$THIS_CLASS</tt> (class in $THIS_MODULE)");
1067     $idx =~ s/ \(.*\)//;
1068     return ("<dl><dt><b>class $idx</b>\n<dd>"
1069             . $_
1070             . '</dl>');
1071 }
1072
1073 sub do_env_excclassdesc{
1074     return handle_classlike_descriptor(@_[0], "exception");
1075 }
1076
1077
1078 sub do_env_methoddesc{
1079     local($_) = @_;
1080     my $class_name = next_optional_argument();
1081     $class_name = $THIS_CLASS
1082         unless $class_name;
1083     my $method = next_argument();
1084     my $arg_list = convert_args(next_argument());
1085     my $extra = '';
1086     if ($class_name) {
1087         $extra = " ($class_name method)";
1088     }
1089     my $idx = make_str_index_entry(
1090         "<tt class=\"method\">$method()</tt>$extra");
1091     $idx =~ s/ \(.*\)//;
1092     $idx =~ s/\(\)//;
1093     return "<dl><dt><b>$idx</b>(<var>$arg_list</var>)\n<dd>" . $_ . '</dl>';
1094 }
1095
1096
1097 sub do_cmd_methodline{
1098     local($_) = @_;
1099     my $class_name = next_optional_argument();
1100     $class_name = $THIS_CLASS
1101         unless $class_name;
1102     my $method = next_argument();
1103     my $arg_list = convert_args(next_argument());
1104     my $extra = '';
1105     if ($class_name) {
1106         $extra = " ($class_name method)";
1107     }
1108     my $idx = make_str_index_entry(
1109         "<tt class=\"method\">$method()</tt>$extra");
1110     $idx =~ s/ \(.*\)//;
1111     $idx =~ s/\(\)//;
1112     return "<dt><b>$idx</b>(<var>$arg_list</var>)\n<dd>"
1113            . $_;
1114 }
1115
1116
1117 sub do_cmd_methodlineni{
1118     local($_) = @_;
1119     next_optional_argument();
1120     my $method = next_argument();
1121     my $arg_list = convert_args(next_argument());
1122     return "<dt><b>$method</b>(<var>$arg_list</var>)\n<dd>"
1123            . $_;
1124 }
1125
1126 sub do_env_methoddescni{
1127     local($_) = @_;
1128     next_optional_argument();
1129     my $method = next_argument();
1130     my $arg_list = convert_args(next_argument());
1131     return "<dl><dt><b>$method</b>(<var>$arg_list</var>)\n<dd>"
1132            . $_
1133            . '</dl>';
1134 }
1135
1136
1137 sub do_env_memberdesc{
1138     local($_) = @_;
1139     my $class = next_optional_argument();
1140     my $member = next_argument();
1141     $class = $THIS_CLASS
1142         unless $class;
1143     my $extra = '';
1144     $extra = " ($class attribute)"
1145         if ($class ne '');
1146     my $idx = make_str_index_entry("<tt class=\"member\">$member</tt>$extra");
1147     $idx =~ s/ \(.*\)//;
1148     $idx =~ s/\(\)//;
1149     return "<dl><dt><b>$idx</b>\n<dd>" . $_ . '</dl>';
1150 }
1151
1152
1153 sub do_cmd_memberline{
1154     local($_) = @_;
1155     my $class = next_optional_argument();
1156     my $member = next_argument();
1157     $class = $THIS_CLASS
1158         unless $class;
1159     my $extra = '';
1160     $extra = " ($class attribute)"
1161         if ($class ne '');
1162     my $idx = make_str_index_entry("<tt class=\"member\">$member</tt>$extra");
1163     $idx =~ s/ \(.*\)//;
1164     $idx =~ s/\(\)//;
1165     return "<dt><b>$idx</b><dd>" . $_;
1166 }
1167
1168
1169 sub do_env_memberdescni{
1170     local($_) = @_;
1171     next_optional_argument();
1172     my $member = next_argument();
1173     return "<dl><dt><b><tt class=\"member\">$member</tt></b>\n<dd>"
1174            . $_
1175            . '</dl>';
1176 }
1177
1178
1179 sub do_cmd_memberlineni{
1180     local($_) = @_;
1181     next_optional_argument();
1182     my $member = next_argument();
1183     return "<dt><b><tt class=\"member\">$member</tt></b><dd>" . $_;
1184 }
1185
1186
1187 @col_aligns = ('<td>', '<td>', '<td>', '<td>', '<td>');
1188
1189 %FontConversions = ('cdata' => 'tt class="cdata"',
1190                     'character' => 'tt class="character"',
1191                     'class' => 'tt class="class"',
1192                     'command' => 'code',
1193                     'constant' => 'tt class="constant"',
1194                     'exception' => 'tt class="exception"',
1195                     'file' => 'tt class="file"',
1196                     'filenq' => 'tt class="file"',
1197                     'kbd' => 'kbd',
1198                     'member' => 'tt class="member"',
1199                     'programopt' => 'b',
1200                     'textrm' => '',
1201                     );
1202
1203 sub fix_font{
1204     # do a little magic on a font name to get the right behavior in the first
1205     # column of the output table
1206     my $font = @_[0];
1207     if (defined $FontConversions{$font}) {
1208         $font = $FontConversions{$font};
1209     }
1210     return $font;
1211 }
1212
1213 sub figure_column_alignment{
1214     my $a = @_[0];
1215     my $mark = substr($a, 0, 1);
1216     my $r = '';
1217     if ($mark eq 'c')
1218       { $r = ' align="center"'; }
1219     elsif ($mark eq 'r')
1220       { $r = ' align="right"'; }
1221     elsif ($mark eq 'l')
1222       { $r = ' align="left"'; }
1223     elsif ($mark eq 'p')
1224       { $r = ' align="left"'; }
1225     return $r;
1226 }
1227
1228 sub setup_column_alignments{
1229     local($_) = @_;
1230     my($s1,$s2,$s3,$s4,$a5) = split(/[|]/,$_);
1231     my $a1 = figure_column_alignment($s1);
1232     my $a2 = figure_column_alignment($s2);
1233     my $a3 = figure_column_alignment($s3);
1234     my $a4 = figure_column_alignment($s4);
1235     my $a5 = figure_column_alignment($s5);
1236     $col_aligns[0] = "<td$a1 valign=\"baseline\">";
1237     $col_aligns[1] = "<td$a2>";
1238     $col_aligns[2] = "<td$a3>";
1239     $col_aligns[3] = "<td$a4>";
1240     $col_aligns[4] = "<td$a5>";
1241     # return the aligned header start tags
1242     return ("<th$a1>", "<th$a2>", "<th$a3>", "<th$a4>", "<th$a5>");
1243 }
1244
1245 sub get_table_col1_fonts{
1246     my $font = $globals{'lineifont'};
1247     my ($sfont,$efont) = ('', '');
1248     if ($font) {
1249         $sfont = "<$font>";
1250         $efont = "</$font>";
1251         $efont =~ s/ .*>/>/;
1252     }
1253     return ($sfont, $efont);
1254 }
1255
1256 sub do_env_tableii{
1257     local($_) = @_;
1258     my($th1,$th2,$th3,$th4,$th5) = setup_column_alignments(next_argument());
1259     my $font = fix_font(next_argument());
1260     my $h1 = next_argument();
1261     my $h2 = next_argument();
1262     s/[\s\n]+//;
1263     $globals{'lineifont'} = $font;
1264     my $a1 = $col_aligns[0];
1265     my $a2 = $col_aligns[1];
1266     s/\\lineii</\\lineii[$a1|$a2]</g;
1267     return '<table border align="center" style="border-collapse: collapse">'
1268            . "\n  <thead>"
1269            . "\n    <tr class=\"tableheader\">"
1270            . "\n      $th1<b>$h1</b>\&nbsp;</th>"
1271            . "\n      $th2<b>$h2</b>\&nbsp;</th>"
1272            . "\n      </tr>"
1273            . "\n    </thead>"
1274            . "\n  <tbody valign=\"baseline\">"
1275            . $_
1276            . "\n    </tbody>"
1277            . "\n</table>";
1278 }
1279
1280 sub do_env_longtableii{
1281     return do_env_tableii(@_);
1282 }
1283
1284 sub do_cmd_lineii{
1285     local($_) = @_;
1286     my $aligns = next_optional_argument();
1287     my $c1 = next_argument();
1288     my $c2 = next_argument();
1289     s/[\s\n]+//;
1290     my($sfont,$efont) = get_table_col1_fonts();
1291     $c2 = '&nbsp;' if ($c2 eq '');
1292     my($c1align,$c2align) = split('\|', $aligns);
1293     my $padding = '';
1294     if ($c1align =~ /align="right"/ || $c1 eq '') {
1295         $padding = '&nbsp;';
1296     }
1297     return "\n    <tr>$c1align$sfont$c1$efont$padding</td>\n"
1298            . "        $c2align$c2</td>"
1299            . $_;
1300 }
1301
1302 sub do_env_tableiii{
1303     local($_) = @_;
1304     my($th1,$th2,$th3,$th4,$th5) = setup_column_alignments(next_argument());
1305     my $font = fix_font(next_argument());
1306     my $h1 = next_argument();
1307     my $h2 = next_argument();
1308     my $h3 = next_argument();
1309     s/[\s\n]+//;
1310     $globals{'lineifont'} = $font;
1311     my $a1 = $col_aligns[0];
1312     my $a2 = $col_aligns[1];
1313     my $a3 = $col_aligns[2];
1314     s/\\lineiii</\\lineiii[$a1|$a2|$a3]</g;
1315     return '<table border align="center" style="border-collapse: collapse">'
1316            . "\n  <thead>"
1317            . "\n    <tr class=\"tableheader\">"
1318            . "\n      $th1<b>$h1</b>\&nbsp;</th>"
1319            . "\n      $th2<b>$h2</b>\&nbsp;</th>"
1320            . "\n      $th3<b>$h3</b>\&nbsp;</th>"
1321            . "\n      </tr>"
1322            . "\n    </thead>"
1323            . "\n  <tbody valign=\"baseline\">"
1324            . $_
1325            . "\n    </tbody>"
1326            . "\n</table>";
1327 }
1328
1329 sub do_env_longtableiii{
1330     return do_env_tableiii(@_);
1331 }
1332
1333 sub do_cmd_lineiii{
1334     local($_) = @_;
1335     my $aligns = next_optional_argument();
1336     my $c1 = next_argument();
1337     my $c2 = next_argument();
1338     my $c3 = next_argument();
1339     s/[\s\n]+//;
1340     my($sfont,$efont) = get_table_col1_fonts();
1341     $c3 = '&nbsp;' if ($c3 eq '');
1342     my($c1align,$c2align,$c3align) = split('\|', $aligns);
1343     my $padding = '';
1344     if ($c1align =~ /align="right"/ || $c1 eq '') {
1345         $padding = '&nbsp;';
1346     }
1347     return "\n    <tr>$c1align$sfont$c1$efont$padding</td>\n"
1348            . "        $c2align$c2</td>\n"
1349            . "        $c3align$c3</td>"
1350            . $_;
1351 }
1352
1353 sub do_env_tableiv{
1354     local($_) = @_;
1355     my($th1,$th2,$th3,$th4,$th5) = setup_column_alignments(next_argument());
1356     my $font = fix_font(next_argument());
1357     my $h1 = next_argument();
1358     my $h2 = next_argument();
1359     my $h3 = next_argument();
1360     my $h4 = next_argument();
1361     s/[\s\n]+//;
1362     $globals{'lineifont'} = $font;
1363     my $a1 = $col_aligns[0];
1364     my $a2 = $col_aligns[1];
1365     my $a3 = $col_aligns[2];
1366     my $a4 = $col_aligns[3];
1367     s/\\lineiv</\\lineiv[$a1|$a2|$a3|$a4]</g;
1368     return '<table border align="center" style="border-collapse: collapse">'
1369            . "\n  <thead>"
1370            . "\n    <tr class=\"tableheader\">"
1371            . "\n      $th1<b>$h1</b>\&nbsp;</th>"
1372            . "\n      $th2<b>$h2</b>\&nbsp;</th>"
1373            . "\n      $th3<b>$h3</b>\&nbsp;</th>"
1374            . "\n      $th4<b>$h4</b>\&nbsp;</th>"
1375            . "\n      </tr>"
1376            . "\n    </thead>"
1377            . "\n  <tbody valign=\"baseline\">"
1378            . $_
1379            . "\n    </tbody>"
1380            . "\n</table>";
1381 }
1382
1383 sub do_env_longtableiv{
1384     return do_env_tableiv(@_);
1385 }
1386
1387 sub do_cmd_lineiv{
1388     local($_) = @_;
1389     my $aligns = next_optional_argument();
1390     my $c1 = next_argument();
1391     my $c2 = next_argument();
1392     my $c3 = next_argument();
1393     my $c4 = next_argument();
1394     s/[\s\n]+//;
1395     my($sfont,$efont) = get_table_col1_fonts();
1396     $c4 = '&nbsp;' if ($c4 eq '');
1397     my($c1align,$c2align,$c3align,$c4align) = split('\|', $aligns);
1398     my $padding = '';
1399     if ($c1align =~ /align="right"/ || $c1 eq '') {
1400         $padding = '&nbsp;';
1401     }
1402     return "\n    <tr>$c1align$sfont$c1$efont$padding</td>\n"
1403            . "        $c2align$c2</td>\n"
1404            . "        $c3align$c3</td>\n"
1405            . "        $c4align$c4</td>"
1406            . $_;
1407 }
1408
1409 sub do_env_tablev{
1410     local($_) = @_;
1411     my($th1,$th2,$th3,$th4,$th5) = setup_column_alignments(next_argument());
1412     my $font = fix_font(next_argument());
1413     my $h1 = next_argument();
1414     my $h2 = next_argument();
1415     my $h3 = next_argument();
1416     my $h4 = next_argument();
1417     my $h5 = next_argument();
1418     s/[\s\n]+//;
1419     $globals{'lineifont'} = $font;
1420     my $a1 = $col_aligns[0];
1421     my $a2 = $col_aligns[1];
1422     my $a3 = $col_aligns[2];
1423     my $a4 = $col_aligns[3];
1424     my $a5 = $col_aligns[4];
1425     s/\\linev</\\linev[$a1|$a2|$a3|$a4|$a5]</g;
1426     return '<table border align="center" style="border-collapse: collapse">'
1427            . "\n  <thead>"
1428            . "\n    <tr class=\"tableheader\">"
1429            . "\n      $th1<b>$h1</b>\&nbsp;</th>"
1430            . "\n      $th2<b>$h2</b>\&nbsp;</th>"
1431            . "\n      $th3<b>$h3</b>\&nbsp;</th>"
1432            . "\n      $th4<b>$h4</b>\&nbsp;</th>"
1433            . "\n      $th5<b>$h5</b>\&nbsp;</th>"
1434            . "\n      </tr>"
1435            . "\n    </thead>"
1436            . "\n  <tbody valign=\"baseline\">"
1437            . $_
1438            . "\n    </tbody>"
1439            . "\n</table>";
1440 }
1441
1442 sub do_env_longtablev{
1443     return do_env_tablev(@_);
1444 }
1445
1446 sub do_cmd_linev{
1447     local($_) = @_;
1448     my $aligns = next_optional_argument();
1449     my $c1 = next_argument();
1450     my $c2 = next_argument();
1451     my $c3 = next_argument();
1452     my $c4 = next_argument();
1453     my $c5 = next_argument();
1454     s/[\s\n]+//;
1455     my($sfont,$efont) = get_table_col1_fonts();
1456     $c5 = '&nbsp;' if ($c5 eq '');
1457     my($c1align,$c2align,$c3align,$c4align,$c5align) = split('\|', $aligns);
1458     my $padding = '';
1459     if ($c1align =~ /align="right"/ || $c1 eq '') {
1460         $padding = '&nbsp;';
1461     }
1462     return "\n    <tr>$c1align$sfont$c1$efont$padding</td>\n"
1463            . "        $c2align$c2</td>\n"
1464            . "        $c3align$c3</td>\n"
1465            . "        $c4align$c4</td>\n"
1466            . "        $c5align$c5</td>"
1467            . $_;
1468 }
1469
1470
1471 # These can be used to control the title page appearance;
1472 # they need a little bit of documentation.
1473 #
1474 # If $TITLE_PAGE_GRAPHIC is set, it should be the name of a file in the
1475 # $ICONSERVER directory, or include path information (other than "./").  The
1476 # default image type will be assumed if an extension is not provided.
1477 #
1478 # If specified, the "title page" will contain two colums: one containing the
1479 # title/author/etc., and the other containing the graphic.  Use the other
1480 # four variables listed here to control specific details of the layout; all
1481 # are optional.
1482 #
1483 # $TITLE_PAGE_GRAPHIC = "my-company-logo";
1484 # $TITLE_PAGE_GRAPHIC_COLWIDTH = "30%";
1485 # $TITLE_PAGE_GRAPHIC_WIDTH = 150;
1486 # $TITLE_PAGE_GRAPHIC_HEIGHT = 150;
1487 # $TITLE_PAGE_GRAPHIC_ON_RIGHT = 0;
1488
1489 sub make_my_titlepage() {
1490     my $the_title = "";
1491     if ($t_title) {
1492         $the_title .= "\n<h1>$t_title</h1>";
1493     }
1494     else {
1495         write_warnings("\nThis document has no title.");
1496     }
1497     if ($t_author) {
1498         if ($t_authorURL) {
1499             my $href = translate_commands($t_authorURL);
1500             $href = make_named_href('author', $href,
1501                                     "<b><font size=\"+2\">$t_author"
1502                                     . '</font></b>');
1503             $the_title .= "\n<p>$href</p>";
1504         }
1505         else {
1506             $the_title .= ("\n<p><b><font size=\"+2\">$t_author"
1507                            . '</font></b></p>');
1508         }
1509     }
1510     else {
1511         write_warnings("\nThere is no author for this document.");
1512     }
1513     if ($t_institute) {
1514         $the_title .= "\n<p>$t_institute</p>";
1515     }
1516     if ($DEVELOPER_ADDRESS) {
1517         $the_title .= "\n<p>$DEVELOPER_ADDRESS</p>";
1518     }
1519     if ($t_affil) {
1520         $the_title .= "\n<p><i>$t_affil</i></p>";
1521     }
1522     if ($t_date) {
1523         $the_title .= "\n<p>";
1524         if ($PACKAGE_VERSION) {
1525             $the_title .= ('<strong>Release '
1526                            . "$PACKAGE_VERSION$RELEASE_INFO</strong><br>\n");
1527         }
1528         $the_title .= "<strong>$t_date</strong></p>"
1529     }
1530     if ($t_address) {
1531         $the_title .= "\n<p>$t_address</p>";
1532     }
1533     else {
1534         $the_title .= "\n<p>";
1535     }
1536     if ($t_email) {
1537         $the_title .= "\n<p>$t_email</p>";
1538     }
1539     return $the_title;
1540 }
1541
1542 sub make_my_titlegraphic() {
1543     my $filename = make_icon_filename($TITLE_PAGE_GRAPHIC);
1544     my $graphic = "<td class=\"titlegraphic\"";
1545     $graphic .= " width=\"$TITLE_PAGE_GRAPHIC_COLWIDTH\""
1546       if ($TITLE_PAGE_GRAPHIC_COLWIDTH);
1547     $graphic .= "><img";
1548     $graphic .= " width=\"$TITLE_PAGE_GRAPHIC_WIDTH\""
1549       if ($TITLE_PAGE_GRAPHIC_WIDTH);
1550     $graphic .= " height=\"$TITLE_PAGE_GRAPHIC_HEIGHT\""
1551       if ($TITLE_PAGE_GRAPHIC_HEIGHT);
1552     $graphic .= "\n  src=\"$filename\"></td>\n";
1553     return $graphic;
1554 }
1555
1556 sub do_cmd_maketitle {
1557     local($_) = @_;
1558     my $the_title = "\n<div class=\"titlepage\">";
1559     if ($TITLE_PAGE_GRAPHIC) {
1560         if ($TITLE_PAGE_GRAPHIC_ON_RIGHT) {
1561             $the_title .= ("\n<table border=\"0\" width=\"100%\">"
1562                            . "<tr align=\"right\">\n<td>"
1563                            . make_my_titlepage()
1564                            . "</td>\n"
1565                            . make_my_titlegraphic()
1566                            . "</tr>\n</table>");
1567         }
1568         else {
1569             $the_title .= ("\n<table border=\"0\" width=\"100%\"><tr>\n"
1570                            . make_my_titlegraphic()
1571                            . "<td>"
1572                            . make_my_titlepage()
1573                            . "</td></tr>\n</table>");
1574         }
1575     }
1576     else {
1577         $the_title .= ("\n<center>"
1578                        . make_my_titlepage()
1579                        . "\n</center>");
1580     }
1581     $the_title .= "\n</div>";
1582     return $the_title . $_;
1583     $the_title .= "\n</center></div>";
1584     return $the_title . $_ ;
1585 }
1586
1587
1588 #
1589 #  Module synopsis support
1590 #
1591
1592 require SynopsisTable;
1593
1594 sub get_chapter_id(){
1595     my $id = do_cmd_thechapter('');
1596     $id =~ s/<SPAN CLASS="arabic">(\d+)<\/SPAN>/\1/;
1597     $id =~ s/\.//;
1598     return $id;
1599 }
1600
1601 # 'chapter' => 'SynopsisTable instance'
1602 %ModuleSynopses = ();
1603
1604 sub get_synopsis_table($){
1605     my($chap) = @_;
1606     my $key;
1607     foreach $key (keys %ModuleSynopses) {
1608         if ($key eq $chap) {
1609             return $ModuleSynopses{$chap};
1610         }
1611     }
1612     my $st = SynopsisTable->new();
1613     $ModuleSynopses{$chap} = $st;
1614     return $st;
1615 }
1616
1617 sub do_cmd_moduleauthor{
1618     local($_) = @_;
1619     next_argument();
1620     next_argument();
1621     return $_;
1622 }
1623
1624 sub do_cmd_sectionauthor{
1625     local($_) = @_;
1626     next_argument();
1627     next_argument();
1628     return $_;
1629 }
1630
1631 sub do_cmd_declaremodule{
1632     local($_) = @_;
1633     my $key = next_optional_argument();
1634     my $type = next_argument();
1635     my $name = next_argument();
1636     my $st = get_synopsis_table(get_chapter_id());
1637     #
1638     $key = $name unless $key;
1639     $type = 'built-in' if $type eq 'builtin';
1640     $st->declare($name, $key, $type);
1641     define_module($type, $name);
1642     return anchor_label("module-$key",$CURRENT_FILE,$_)
1643 }
1644
1645 sub do_cmd_modulesynopsis{
1646     local($_) = @_;
1647     my $st = get_synopsis_table(get_chapter_id());
1648     $st->set_synopsis($THIS_MODULE, translate_commands(next_argument()));
1649     return $_;
1650 }
1651
1652 sub do_cmd_localmoduletable{
1653     local($_) = @_;
1654     my $chap = get_chapter_id();
1655     my $st = get_synopsis_table($chap);
1656     $st->set_file("$CURRENT_FILE");
1657     return "<tex2html-localmoduletable><$chap>\\tableofchildlinks[off]" . $_;
1658 }
1659
1660 sub process_all_localmoduletables{
1661     my $key;
1662     my $st, $file;
1663     foreach $key (keys %ModuleSynopses) {
1664         $st = $ModuleSynopses{$key};
1665         $file = $st->get_file();
1666         if ($file) {
1667             process_localmoduletables_in_file($file);
1668         }
1669         else {
1670             print "\nsynopsis table $key has no file association\n";
1671         }
1672     }
1673 }
1674
1675 sub process_localmoduletables_in_file{
1676     my $file = @_[0];
1677     open(MYFILE, "<$file");
1678     local($_);
1679     sysread(MYFILE, $_, 1024*1024);
1680     close(MYFILE);
1681     # need to get contents of file in $_
1682     while (/<tex2html-localmoduletable><(\d+)>/) {
1683         my $match = $&;
1684         my $chap = $1;
1685         my $st = get_synopsis_table($chap);
1686         my $data = $st->tohtml();
1687         s/$match/$data/;
1688     }
1689     open(MYFILE,">$file");
1690     print MYFILE $_;
1691     close(MYFILE);
1692 }
1693 sub process_python_state{
1694     process_all_localmoduletables();
1695     process_grammar_files();
1696 }
1697
1698
1699 #
1700 #  "See also:" -- references placed at the end of a \section
1701 #
1702
1703 sub do_env_seealso{
1704     return ("<div class=\"seealso\">\n  "
1705             . "<p class=\"heading\"><b>See Also:</b></p>\n"
1706             . @_[0]
1707             . '</div>');
1708 }
1709
1710 sub do_cmd_seemodule{
1711     # Insert the right magic to jump to the module definition.  This should
1712     # work most of the time, at least for repeat builds....
1713     local($_) = @_;
1714     my $key = next_optional_argument();
1715     my $module = next_argument();
1716     my $text = next_argument();
1717     my $period = '.';
1718     $key = $module
1719         unless $key;
1720     if ($text =~ /\.$/) {
1721         $period = '';
1722     }
1723     return ('<dl compact class="seemodule">'
1724             . "\n    <dt>Module <b><tt class=\"module\">"
1725             . "<a href=\"module-$key.html\">$module</a></tt>:</b>"
1726             . "\n    <dd>$text$period\n  </dl>"
1727             . $_);
1728 }
1729
1730 sub strip_html_markup($){
1731     my $str = @_[0];
1732     my $s = "$str";
1733     $s =~ s/<[a-zA-Z0-9]+(\s+[a-zA-Z0-9]+(\s*=\s*(\'[^\']*\'|\"[^\"]*\"|[a-zA-Z0-9]+))?)*\s*>//g;
1734     $s =~ s/<\/[a-zA-Z0-9]+>//g;
1735     return $s;
1736 }
1737
1738 sub handle_rfclike_reference{
1739     local($_, $what, $format) = @_;
1740     my $rfcnum = next_argument();
1741     my $title = next_argument();
1742     my $text = next_argument();
1743     my $url = get_rfc_url($rfcnum, $format);
1744     my $icon = get_link_icon($url);
1745     my $attrtitle = strip_html_markup($title);
1746     return '<dl compact class="seerfc">'
1747       . "\n    <dt><a href=\"$url\""
1748       . "\n        title=\"$attrtitle\""
1749       . "\n        >$what $rfcnum, <em>$title</em>$icon</a>"
1750       . "\n    <dd>$text\n  </dl>"
1751       . $_;
1752 }
1753
1754 sub do_cmd_seepep{
1755     return handle_rfclike_reference(@_[0], "PEP", $PEP_FORMAT);
1756 }
1757
1758 sub do_cmd_seerfc{
1759     return handle_rfclike_reference(@_[0], "RFC", $RFC_FORMAT);
1760 }
1761
1762 sub do_cmd_seetitle{
1763     local($_) = @_;
1764     my $url = next_optional_argument();
1765     my $title = next_argument();
1766     my $text = next_argument();
1767     if ($url) {
1768         my $icon = get_link_icon($url);
1769         return '<dl compact class="seetitle">'
1770           . "\n    <dt><em class=\"citetitle\"><a href=\"$url\""
1771           . "\n        >$title$icon</a></em>"
1772           . "\n    <dd>$text\n  </dl>"
1773           . $_;
1774     }
1775     return '<dl compact class="seetitle">'
1776       . "\n    <dt><em class=\"citetitle\""
1777       . "\n        >$title</em>"
1778       . "\n    <dd>$text\n  </dl>"
1779       . $_;
1780 }
1781
1782 sub do_cmd_seeurl{
1783     local($_) = @_;
1784     my $url = next_argument();
1785     my $text = next_argument();
1786     my $icon = get_link_icon($url);
1787     return '<dl compact class="seeurl">'
1788       . "\n    <dt><a href=\"$url\""
1789       . "\n        class=\"url\">$url$icon</a>"
1790       . "\n    <dd>$text\n  </dl>"
1791       . $_;
1792 }
1793
1794 sub do_cmd_seetext{
1795     local($_) = @_;
1796     my $content = next_argument();
1797     return '<div class="seetext"><p>' . $content . '</div>' . $_;
1798 }
1799
1800
1801 #
1802 #  Definition list support.
1803 #
1804
1805 sub do_env_definitions{
1806     return "<dl class=\"definitions\">" . @_[0] . "</dl>\n";
1807 }
1808
1809 sub do_cmd_term{
1810     local($_) = @_;
1811     my $term = next_argument();
1812     my($name,$aname,$ahref) = new_link_info();
1813     # could easily add an index entry here...
1814     return "<dt><b>$aname" . $term . "</a></b>\n<dd>" . $_;
1815 }
1816
1817
1818 # I don't recall exactly why this was needed, but it was very much needed.
1819 # We'll see if anything breaks when I move the "code" line out -- some
1820 # things broke with it in.
1821
1822 #code # {}
1823 process_commands_wrap_deferred(<<_RAW_ARG_DEFERRED_CMDS_);
1824 declaremodule # [] # {} # {}
1825 memberline # [] # {}
1826 methodline # [] # {} # {}
1827 modulesynopsis # {}
1828 platform # {}
1829 samp # {}
1830 setindexsubitem # {}
1831 withsubitem # {} # {}
1832 _RAW_ARG_DEFERRED_CMDS_
1833
1834
1835 $alltt_start = '<dl><dd><pre class="verbatim">';
1836 $alltt_end = '</pre></dl>';
1837
1838 sub do_env_alltt {
1839     local ($_) = @_;
1840     local($closures,$reopens,@open_block_tags);
1841
1842     # get the tag-strings for all open tags
1843     local(@keep_open_tags) = @$open_tags_R;
1844     ($closures,$reopens) = &preserve_open_tags() if (@$open_tags_R);
1845
1846     # get the tags for text-level tags only
1847     $open_tags_R = [ @keep_open_tags ];
1848     local($local_closures, $local_reopens);
1849     ($local_closures, $local_reopens,@open_block_tags)
1850       = &preserve_open_block_tags
1851         if (@$open_tags_R);
1852
1853     $open_tags_R = [ @open_block_tags ];
1854
1855     do {
1856         local($open_tags_R) = [ @open_block_tags ];
1857         local(@save_open_tags) = ();
1858
1859         local($cnt) = ++$global{'max_id'};
1860         $_ = join('',"$O$cnt$C\\tt$O", ++$global{'max_id'}, $C
1861                 , $_ , $O, $global{'max_id'}, "$C$O$cnt$C");
1862
1863         $_ = &translate_environments($_);
1864         $_ = &translate_commands($_) if (/\\/);
1865
1866         # preserve space-runs, using &nbsp;
1867         while (s/(\S) ( +)/$1$2;SPMnbsp;/g){};
1868         s/(<BR>) /$1;SPMnbsp;/g;
1869
1870         $_ = join('', $closures, $alltt_start, $local_reopens
1871                 , $_
1872                 , &balance_tags() #, $local_closures
1873                 , $alltt_end, $reopens);
1874         undef $open_tags_R; undef @save_open_tags;
1875     };
1876     $open_tags_R = [ @keep_open_tags ];
1877     $_;
1878 }
1879
1880 sub do_cmd_verbatiminput{
1881     local($_) = @_;
1882     my $fname = next_argument();
1883     my $file;
1884     my $found = 0;
1885     my $texpath;
1886     # Search TEXINPUTS for the input file, the way we're supposed to:
1887     foreach $texpath (split /$envkey/, $TEXINPUTS) {
1888         $file = "$texpath$dd$fname";
1889         last if ($found = (-f $file));
1890     }
1891     my $srcname;
1892     my $text;
1893     if ($found) {
1894         open(MYFILE, "<$file") || die "\n$!\n";
1895         read(MYFILE, $text, 1024*1024);
1896         close(MYFILE);
1897         use File::Basename;
1898         my $srcdir, $srcext;
1899         ($srcname, $srcdir, $srcext) = fileparse($file, '\..*');
1900         open(MYFILE, ">$srcname.txt");
1901         print MYFILE $text;
1902         close(MYFILE);
1903         #
1904         # These rewrites convert the raw text to something that will
1905         # be properly visible as HTML and also will pass through the
1906         # vagaries of conversion through LaTeX2HTML.  The order in
1907         # which the specific rewrites are performed is significant.
1908         #
1909         $text =~ s/\&/\&amp;/g;
1910         # These need to happen before the normal < and > re-writes,
1911         # since we need to avoid LaTeX2HTML's attempt to perform
1912         # ligature processing without regard to context (since it
1913         # doesn't have font information).
1914         $text =~ s/--/-&\#45;/g;
1915         $text =~ s/<</\&lt;\&\#60;/g;
1916         $text =~ s/>>/\&gt;\&\#62;/g;
1917         # Just normal re-writes...
1918         $text =~ s/</\&lt;/g;
1919         $text =~ s/>/\&gt;/g;
1920         # These last isn't needed for the HTML, but is needed to get
1921         # past LaTeX2HTML processing TeX macros.  We use &#92; instead
1922         # of &sol; since many browsers don't support that.
1923         $text =~ s/\\/\&\#92;/g;
1924     }
1925     else {
1926         $text = '<b>Could not locate requested file <i>$fname</i>!</b>\n';
1927     }
1928     return ('<dl><dd><pre class="verbatim">'
1929             . $text
1930             . "</pre>\n<div class=\"verbatiminput-footer\">\n"
1931             . "<a href=\"$srcname.txt\" type=\"text/plain\""
1932             . ">Download as text.</a>"
1933             . "\n</div>\n</dd></dl>"
1934             . $_);
1935 }
1936
1937 1;                              # This must be the last line