#!/usr/bin/perl

# TODO:
# - add non-int constant values
# - interface names referenced in classes should be modified to be classes, and/or point to
#   interfaces directory
# - interfaces in methods in classes need to always be links regardless of source interface name
# - c_download1.html has an iframe in its content

# Set $OUTPUTFORLOCAL to 1 to output for local filesystem. This is useful when
# debugging because links are not absolute

# The follwing files are used by this script:
#   xpcomhead.txt - page header (for local output only)
#   xpcomfoot.txt - page footer (for local output only)
#   objmap.txt - mapping of Mozilla types to more common names (such as PRBool to boolean)
#   groups.txt - list of all interfaces organized into groups
#   ctoi.txt - list of components and which interfaces they implement
#   index.html - index page, copied to output directory
#   creatingcomps.html - page about creating components
#   scriptables.html - index page for the object references, copied to $OUTPUTDIR/objref/index.html

# flags may be disabled to only perform certain steps, useful when debugging this script
my $PARSE_IDL = 1;
my $PARSE_INTERFACES = 1;
my $PARSE_COMPONENTS = 1;
my $GENERATE_INDEX = 1;
my $OUTPUTFORLOCAL = 0;

# path to xpidl
my $XPIDL = "/builds/trunk-working/mozilla/output/dist/bin/xpidl";

# working source directory (the directory that this script is in)
my $SRCDIR = "/xulplanet/xultu/xpcom";

# pointer to a directory that will store object reference links. I don't think this
# is really used.
my $ELEMREFQUICKDIR = "/xulplanet/xultu/xpcom/elemrefquick";

# directory where idl files are
my $IDLDIR = "/builds/trunk-working/mozilla/output/dist/idl";

# override directory. IDL files in here will override those in $IDLDIR
my $OVERRIDEIDLDIR = "/xulplanet/xultu/xpcom/overrideidl";

# output directory, must already exist
my $OUTPUTDIR = "/xulplanet/xultu/output/xpcomref";

my $XPCOMREFURL ="http://www.xulplanet.com/references/xpcomref";
my $OBJREFURL ="http://www.xulplanet.com/references/objref";

my %allInterfaces;
my %interfaceFiles;
my %frozenInterfaces;
my %usedInterfaceList;
my %interfaceObjectMap;
my %interfaceCreationMap;
my %crossRefMap;
my @filesToParse = ();
my %groups;
my %groupData;
my %components;
my $interfacename;
my %keys;
my @consts;
my %attributes;
my %methods;
my %allNamesForInterface;

my $localHeader = "", $localFooter = "";

my $maxifacelength = 0;
my $maxnamelength = 0;
my $maxdesclength = 0;

if ($OUTPUTFORLOCAL){
  open HEADFILE, "$SRCDIR/xpcomhead.txt";
  while($ln = <HEADFILE>){
    $localHeader .= $ln;
  }
  close HEADFILE;
}

if ($OUTPUTFORLOCAL){
  open FOOTFILE, "$SRCDIR/xpcomfoot.txt";
  while($ln = <FOOTFILE>){
    $localFooter .= $ln;
  }
  close FOOTFILE;
}

# printInnerInterfacesList();

loadObjectMap();

if (! -e "$OUTPUTDIR/objref") { mkdir "$OUTPUTDIR/objref"; }
if (! -e "$OUTPUTDIR/ifaces") { mkdir "$OUTPUTDIR/ifaces"; }
if (! -e "$OUTPUTDIR/comps") { mkdir "$OUTPUTDIR/comps"; }

if ($GENERATE_INDEX){
  generateMainIndex();
}

parseComponents();

if ($PARSE_INTERFACES){

chdir $IDLDIR;

if ($PARSE_IDL){
  parseIDLFiles();
}

my $fl;
while ($fl = <*.html>)
{
  if (($fl !~ /^rpI/) && ($fl !~ /xpctest/)){
    push(@filesToParse,$fl);
  }
}

generateCrossIndex();

print "Outputting interface descriptions...\n";

for (my $tidx = 0; $tidx<scalar(@filesToParse); $tidx++)
{
  open INFILE, $filesToParse[$tidx];

  my $ln = <INFILE>;
  while ($ln =~ /^\s+$/){ $ln = <INFILE>; }

  INFILEITER: while ($ln){

    %keys = ();
    @consts = ();
    %attributes = ();
    %methods = ();

    $interfacename = "";

    my $comment = parseComment($ln);
    if ($comment){
      $ln = <INFILE>;
      if ($ln =~ /\/\*/){
        my $ctmp = $keys{'comment'};
        $comment = parseComment($ln);
        $keys{'comment'} = $ctmp . $keys{'comment'};
        $ln = <INFILE>;
      }
    }

    my $interface = parseInterface($ln);
    if ($interface){
      if ($keys{"status"} =~ /FROZEN/i){
        $frozenInterfaces{$interfacename} = $interfacename;
      }

      if (!$comment){
        $comment = parseComment($ln);
      }

      if (!$allInterfaces{$interfacename}){
        $changesLog .= "ADDED: $interfacename \n";
      }

      $interfaceFiles{$interfacename} = $filesToParse[$tidx];
    }

    print $filesToParse[$tidx] . " - " . $keys{'name'} . "\n";

    open OUTFILE, ">$OUTPUTDIR/ifaces/" . $keys{'name'} . ".html";
    print OUTFILE getHeader("Interface Reference - $interfacename","xpcomref","xpcomref", "../");

    outputInterface();

    MEMBERSITER: while ($ln = <INFILE>){
    #  if ($ln == undef){ last INFILEITER; }
      if ($ln =~ /^\s+$/){ next MEMBERSITER; }
      my $comment = parseComment($ln);
      if ($comment){
        $ln = <INFILE>;
        if ($ln =~ /\/\*/){
          parseComment($ln);
          $ln = <INFILE>;
        }
      }

      if ($ln =~ /^interface/){ 
        delete $allInterfaces{$interfacename};
        next INFILEITER;
      }
      if ($ln =~ /^const/){ parseConst($ln); }
      elsif ($ln =~ /^attribute/){ parseAttribute($ln); }
      elsif ($ln =~ /^method/){ parseMethod($ln,0); }
      %keys=();
    }
  }
  continue {
    if (scalar @consts){ outputConsts(0,0); }
    if (scalar keys %attributes){ outputAttributes(0,0); }
    if (scalar keys %methods){ outputMethods(0); }

    outputCrossRefs($interfacename);

    print OUTFILE getFooter("../");
    close OUTFILE;
  }

  delete $allInterfaces{$interfacename};

  close INFILE;
}

outputFrozenInterfaces();

}

foreach $iface (keys %allInterfaces) {
  print "MISSING: " . $iface . "\n";
}

if ($PARSE_COMPONENTS){
  outputComponents();
}

print "Maximum Interface length is $maxifacelength\n";
print "Maximum Name length is $maxnamelength\n";
print "Maximum Description length is $maxdesclength\n";

system ("cp $SRCDIR/index.html $OUTPUTDIR");
system ("cp $SRCDIR/creatingcomps.html $OUTPUTDIR");
system ("cp $SRCDIR/scriptables.html $OUTPUTDIR/objref/index.html");

print $changesLog;

chdir $SRCDIR;

sub parseIDLFiles
{
  print "Parsing idl files...\n";

  my $fl;
  while ($fl = <*.idl>)
  {
    if (-e "$OVERRIDEIDLDIR/$fl"){
      system ("$XPIDL -m doc $OVERRIDEIDLDIR/$fl");
    }
    else {
      system ("$XPIDL -m doc $fl");
    }
  }
}

sub loadObjectMap
{
  open OBJMAP, "objmap.txt" or die $!;

  my $ln;
  while ($ln = <OBJMAP>){
    $ln =~ /^(.*)\->(.*)\s*$/;
    $interfaceObjectMap{$1}=$2;
  }

  close OBJMAP;
}

sub convertType
{
  my $type, $rest;

  my $typespec = $_[0];
  my $makelink = $_[1];
  my $objname = $_[2];

  $typespec =~ s/\&//;
  $typespec =~ s/Star(\*?)$/$1/;
  $typespec =~ s/\s\*/*/;

  $typespecmod = $typespec;
  $typespecmod =~ s/\s|\*//g;

  if ($objname && $interfaceObjectMap{$typespecmod}){
    $typespec = $interfaceObjectMap{$typespecmod};
    if ($makelink && (index($typespecmod,"nsI") == 0) && ($typespec ne $objname)){
      my $path = "";
#      if ($makelink == 2){ $path = "$XPCOMREFURL/ifaces/"; }
      $typespec = "<a href='$path$typespec.html'>$typespec</a>";
    }
  }
  else {
    if ($typespec =~ /nsIID/){
      $typespec =~ s/\*//;
      $makelink=0;
    }
    if ($typespec =~ /((nsI|inI|ipcI)[A-Za-z0-9_]*)(\s*.*)/){
      $type=$1;
      $rest=$3;
      $rest =~ s/\s*\*//;
      my $path = "";
      if ($objname || ($makelink == 2)){ $path = "$XPCOMREFURL/ifaces/"; }
      if ($makelink && ($type ne $interfacename)){ $typespec = "<a href='$path$type.html'>$type</a>$rest"; }
      else { $typespec = $type . $rest; }
    }
  }
  return $typespec;
}

sub convertArgName
{
  my $argname = $_[0];
  if (!($argname =~ s/a([A-Z])([a-z])/\l$1$2/)){
    $argname =~ s/a([A-Z])([A-Z])/$1$2/;
  }
  return $argname;
}

sub parseInterface
{
  my $ln = $_[0];
  if ($ln =~ /interface\s*(noscript)*\s*([A-Za-z0-9_]*)/){
    $keys{"noscript"} = $1;
    $keys{"name"} = $2;
    $interfacename = $2;
    if ($ln = <INFILE>){
      if ($ln =~ /iid\s*(.*)$/){
        $keys{"iid"} = $1;
      }
    }
    if ($ln = <INFILE>){
      if ($ln =~ /inheritsfrom\s*(.*)$/){
        $keys{"inheritsInterface"} = $1;
        $keys{"inherits"} = convertType($1,1,0);
      }
    }
    return 1;
  }
  else { return 0; }
}

sub parseConst
{
  my $ln = $_[0];
  my $val="";
  $ln =~ s/^const\s*//;
  if ($ln =~ s/\s=\s(.*)$//){ $val = "= $1"; }
  $ln =~ s/([A-Za-z0-9_]*)$//;
  chomp $ln;
  push @consts, [$1 , $ln, $keys{'comment'}, $val, $interfacename];
}

sub parseAttribute
{
  my $ln = $_[0];
  my $readonly=0, $notxpcom=0, $noscript=0;
  $ln =~ s/^attribute\s*//;
  if ($ln =~ s/^readonly\s*//){ $readonly=1; }
  if ($ln =~ s/^notxpcom\s*//){ $notxpcom=1; }
  if ($ln =~ s/^unscriptable\s*//){ $noscript=1; }
  $ln =~ s/([A-Za-z0-9_]*)$//;
  chomp $ln;
  if ($readonly){ $attributes{$1 . ":readonly"} = 1; }
  $attributes{$1} = $ln;
  $attributes{$1 . ":comment"} = $keys{'comment'};
  $attributes{$1 . ":interface"} = $interfacename;
  my $extra = "";
  if ($notxpcom){ $extra .= "[notxpcom] "; }
  if ($noscript){ $extra .= "[noscript] "; }
  $attributes{$1 . ":extraflags"} = $extra;
}

sub parseMethod
{
  my $ln = $_[0];
  my $objname = $_[1];

  my $unscriptable = ($ln =~ /unscriptable/);
  $ln =~ /([A-Za-z0-9_]*)$/;
  my $name = $1;

  $methods{$name} = $keys{'comment'};
  $methods{$name . ':unscriptable'} = $unscriptable;
  $methods{$name . ':interface'} = $interfacename;

  my $argspec;
  my @args;
  my @argsdesc;
  while ($ln = <INFILE>){
    if ($ln =~ /^\s+$/){ last; }
    if ($ln =~ s/^\s*argument\s*([inout]*(retval)*)\s*//){
      chomp $ln;
      if ($argspec){ $argspec .= " , "; }
      if ($1 eq "outretval"){ $argspec .= "retval "; }
      elsif ($1 ne "in"){ $argspec .= "$1 "; }
      $ln =~ /^(.*)\s+([A-Za-z0-9_]*)$/;
      $argname = convertArgName($2);
      $argspec .= convertType($1,1,$objname) . " " . $argname;
      push @args, $argname;
      if ($keys{"param:" . $argname}){
        $methods{$name . ":argsdesc:" . $argname} = "<strong>$argname:</strong> " .
                 $keys{"param:" . $argname};
      }
    }
    elsif ($ln =~ s/^\s*returns\s*//){
      $ln =~ s/\s//g;
      $methods{$name . ":returns"} = $ln;
      if ($keys{'return'}){
        $methods{$name . ":returnsdesc"} = $keys{'return'};
      }
    }
    elsif ($ln =~ s/^\s*notxpcom\s*//){
      $methods{$name . ":extraflags"} .= "[notxpcom]";
    }
  }

  if (scalar @args){
    $methods{$name . ":args"} = \@args;
    $methods{$name . ":argspec"} = $argspec;
  }
}

sub parseComment
{
  my $ln = $_[0];
  my $multikey="";
  $keys{"comment"} = "";
  if ($ln !~ /\/\*/){ return 0; }
  ITER: while ($ln) {
    if ($ln =~ /\*\//){
      if ($interfacename !~ /^nsIUR[IL]$/){
        $keys{'comment'} =~ s/(http\:[^\s]*)\s/<a href='$1'>$1<\/a>\n/g;
      }
      $keys{'comment'} =~ s/<p>([a-z])/<p>\u$1/g;
      if ($keys{'comment'} !~ /^nsI/){
        $keys{'comment'} =~ s/^([a-z])/\u$1/;
      }
      return 1;
    }
    $ln =~ s/^[\/\*\s]*//;
    if ((length $ln) == 0){
      if ($keys{"comment"}){ $keys{"comment"} .= "</p><p>"; }
      $multikey="";
    }
    if ($multikey){
      if ($ln =~ /\@[A-Za-z0-9_]/){
        $multikey="";
      }
      else {
        $keys{$multikey} .= " " . $ln;
        next ITER;
      }
    }
    if ($ln =~ /^\@([A-Za-z]*)\s*(.*)$/){
      my $key = lc($1);
      if ($key eq "param"){
        $2 =~ /^([A-Za-z0-9_]*)\s*(.*)$/;
        $multikey="param:" . convertArgName($1);
        $keys{$multikey} = $2;
      }
      else {
        $multikey=$key;
        $keys{$key} = $2;
      }
    }
    else {
      $ln =~ s/\|//g;
      $keys{"comment"} .= $ln;
    }
  }
  continue { $ln = <INFILE>; }
  $keys{'comment'} =~ s/(http[^\s]*)\s/<a href='$1'>$1<\/a>\n/g;
  $keys{'comment'} =~ s/<p>([a-z])/<p>\u$1/g;
  if ($keys{'comment'} !~ /^nsI/){
    $keys{'comment'} =~ s/^([a-z])/\u$1/;
  }

  return 1;
}

sub outputInterface
{
  my $ioutput = "<h2>" . $keys{'name'} . "</h2>\n\n";
  $ioutput .= "<div class='interfaceblock'>\n";
  $ioutput .= "<table class='interfaceinfo'>\n";
  if ($keys{'iid'}){ $ioutput .= "  <tr><td>IID:</td><td>" . $keys{'iid'} . "</td></tr>\n"; }
  if ($keys{'module'}){ $ioutput .= "  <tr><td>Group:</td><td>" . $keys{'module'} . "</td></tr>\n"; }
  if ($keys{'inherits'}){
    $ioutput .= "  <tr><td>Inherits From:</td><td>" . $keys{'inherits'} . "</td></tr>\n";
  }
  if ($keys{'name'} eq "nsISupports"){ $keys{'status'} = "FROZEN"; }
  if ($dirsToParseIdx == 1){
    $ioutput .= "  <tr><td>Status:</td>";
    $ioutput .= "<td class='removed'>This interface has been removed from newer versions</td></tr>\n";
  }
  elsif ($keys{'status'}){
    $ioutput .= "  <tr><td>Status:</td><td>" . $keys{'status'} . "</td></tr>\n";
  }
  if (index($allInterfaces{$interfacename},"~") != -1){
    $ioutput .= "  <tr><td>Added:</td><td>New since Mozilla 1.7</td></tr>\n";
  }

  $ioutput .= "</table>\n\n";
  if ($keys{'scriptable'}){
    $ioutput .= "  <p>This interface is not scriptable.</p>\n";
  }
  $keys{'comment'} =~ s/^$keys{'name'}\s*\n//i;
  $keys{'comment'} =~ s/^<\/p><p>//;
  $keys{'comment'} =~ s/<param>/&lt;param&gt;/g;

  if ($keys{'comment'}){
    if (($keys{'name'} eq "nsIURI") || ($keys{'name'} eq "nsIURL")){
      $ioutput .= "<div class='keepspaces'><p>\n" . $keys{'comment'} . "</p></div>\n\n";
    }
    else {
      $ioutput .= "<p>\n" . $keys{'comment'} . "</p>\n\n";
    }
  }

  my $creationDetail = $interfaceCreationMap{$keys{'name'}};
  if ($creationDetail =~ /SERVICE\s*(.*)$/) {
    my $compname = $1;
    $ioutput .= "<p>This interface is intended to be used as a service.";
    if ($compname) {
      $ioutput .= " To create an object implementing this interface:\n";
      $ioutput .= "<pre>var obj = Components.classes[\"$compname\"].\n" ;
      $ioutput .= "            getService(Components.interfaces." . $keys{'name'} . ");</pre>";
    }
    else { $ioutput .= "</p>"; }
  }
  elsif ($creationDetail =~ /INSTANCE\s*(.*)$/) {
    my $compname = $1;
    $ioutput .= "<p>This interface is intended to be used as an instance.";
    if ($compname) {
      $ioutput .= " To create an object implementing this interface:\n";
      $ioutput .= "<pre>var obj = Components.classes[\"$compname\"].\n" ;
      $ioutput .= "            createInstance(Components.interfaces." . $keys{'name'} . ");</pre>";
    }
    else { $ioutput .= "</p>"; }
  }
  elsif ($creationDetail =~ /OTHERSTRONG\s*(.*)$/) {
    my $compname = $1;
    if ($compname) {
      $ioutput .= "<p>An object of this interface must be created in the following way:</p>";
      $ioutput .= "<pre>$1</pre>\n" ;
    }
  }
  elsif ($creationDetail =~ /OTHER\s*(.*)$/) {
    my $compname = $1;
    if ($compname) {
      $ioutput .= "<p>An object of this interface should be created in the following way:</p>";
      $ioutput .= "<pre>$1</pre>\n" ;
    }
  }

  if ($components{$keys{'name'}}){
    $ioutput .= "<p>This interface is implemented by the following components:</p>\n\n<ul>\n";
    $ioutput .= $components{$keys{'name'}} . "</ul>\n\n";
  }
  $ioutput .= "</div>\n\n<hr>\n\n";

  print OUTFILE $ioutput;
}

sub outputConsts
{
  my $showInterfaces = $_[0];
  my $objname = $_[1];

  print OUTFILE "<h3>Constants</h3>\n\n";
  print OUTFILE "<table class='constblocks'>\n";
  foreach $constarr (@consts){
    my $cmtext = @{$constarr}[2];
    $cmtext =~ s/<iframe>/iframe/g;

    if ($cmtext && ($interfacename ne "nsIPromptService")){
      print OUTFILE "  <tr><td colspan='3'>" . $cmtext . "</td></tr>\n\n";
    }
    @{$constarr}[1] = convertType(@{$constarr}[1],1,$objname);
    print OUTFILE "  <tr>\n    <td>" . @{$constarr}[1] . "</td>\n";
    print OUTFILE "    <td><a name='const_" . @{$constarr}[0] . "'></a> ";
    if ($showInterfaces){ print OUTFILE @{$constarr}[4] . "."; }
    print OUTFILE "<strong>" . @{$constarr}[0] . "</strong></td>\n";
    if (@{$constarr}[3]){
      print OUTFILE "    <td>" . @{$constarr}[3] . "</td>\n";
    }
    else { print OUTFILE "    <td>&nbsp;</td>\n"; }
    print OUTFILE "  </tr>\n";
  }
  print OUTFILE "</table>\n\n";

}

sub outputAttributes
{
  my $showInterfaces = $_[0];
  my $objname = $_[1];

  if (((scalar @consts) > 0) && ((scalar keys %attributes) > 0)){ print OUTFILE "<hr>\n\n"; }

  print OUTFILE "<h3>Properties</h3>\n\n";
  foreach $attribute (sort { uc($a) cmp uc($b) } keys %attributes){
    if ($attribute !~ /\:/){
      print OUTFILE "<a name='prop_" . $attribute . "'></a>\n";
      print OUTFILE "<div class='attributeblock'>\n\n<p>\n";
      if ($attributes{$attribute . ":extraflags"}){ print OUTFILE $attributes{$attribute . ":extraflags"} };
      if ($attributes{$attribute . ':readonly'}){ print OUTFILE "readonly "; }
      print OUTFILE "  " . convertType($attributes{$attribute},2,$objname) . " ";
      if ($showInterfaces){ print OUTFILE $attributes{$attribute . ':interface'} . "."; }
      print OUTFILE "<strong>$attribute</strong>\n</p>\n";
      if ($attributes{$attribute . ':comment'}){
        print OUTFILE "<p class='attrcomment'>\n" . $attributes{$attribute . ':comment'} . "</p>\n\n";
      }
      print OUTFILE "</div>\n";
    }
  }
}

sub outputMethods
{
  my $objname = $_[0];

  if ((((scalar @consts) > 0) || ((scalar keys %attributes) > 0)) &&
      ((scalar keys %methods) > 0)){
    print OUTFILE "<hr>\n\n";
  }

  print OUTFILE "<h3>Methods</h3>\n\n";
  print OUTFILE "<p class='dblock'>\n";

  foreach $method (sort { uc($a) cmp uc($b) } keys %methods){
    if ($method !~ /\:/){
      print OUTFILE "  <code>\n";
      if ($methods{$method . ":unscriptable"}){ print OUTFILE "[noscript]"; };
      if ($methods{$method . ":extraflags"}){ print OUTFILE $methods{$method . ":extraflags"} };
      print OUTFILE "    " . convertType($methods{$method . ':returns'},0,$objname) . " ";
      print OUTFILE "<strong><a href='#method_" . $method . "'>" . $method . "</a></strong>";
      print OUTFILE " ( " . $methods{$method . ':argspec'} . " )\n";
      print OUTFILE "  </code>\n";
    }
  }
  print OUTFILE "</p>\n\n";

  my $hasmethod = 0 ;
  foreach $method (sort { uc($a) cmp uc($b) } keys %methods){
    if ($method !~ /\:/){
      if ($hasmethod){ print OUTFILE "<hr>\n\n"; }
      $hasmethod = 1 ;
      print OUTFILE "<div class='methodblock'>\n<p>\n";
      print OUTFILE "  <a name='method_" . $method . "'></a>\n";
      if ($methods{$method . 'unscriptable'}){ print OUTFILE "[noscript]"; };
      if ($methods{$method . ":extraflags"}){ print OUTFILE $methods{$method . ":extraflags"} };
      print OUTFILE "    " . convertType($methods{$method . ':returns'},1,$objname);
      print OUTFILE " <strong>$method</strong>";
      print OUTFILE " ( " . $methods{$method . ':argspec'} . " )\n";
      print OUTFILE "</p>\n";
      if ($methods{$method}){
        $methods{$method} =~ s/^$method\s*\n//i;            # remove method name at start of comment
        $methods{$method} =~ s/^$method\[Native\]\s*\n//i;  # special case for nsIFile
        $methods{$method} =~ s/^<\/p><p>//;
        $methods{$method} =~ s/([\s\|\[])a([A-Z])([A-Za-z])/$1\l$2$3/g;  # convert aValue -> value
        print OUTFILE "<p>\n" . $methods{$method} . "</p>\n\n";
      }

      if ($methods{$method . ':args'} || $methods{$method . ':returnsdesc'}){
        print OUTFILE "<dl>\n";
        if ($methods{$method . ':args'}){
          print OUTFILE "  <dt>Arguments:</dt>\n";
          foreach $arg (@{$methods{$method . ':args'}}){
            if ($methods{$method . ":argsdesc:" . $arg}){
              my $argcomment = $methods{$method . ":argsdesc:" . $arg};
                $argcomment =~ s/([\s\|\[])a([A-Z])([A-Za-z])/$1\l$2$3/g;
                print OUTFILE "  <dd>$argcomment</dd>\n";
            }
            else {
              print OUTFILE "  <dd><strong>$arg</strong></dd>\n";
            }
          }
        }
        if ($methods{$method . ':returnsdesc'}){
          print OUTFILE "  <dt>Returns:</dt>\n";
          print OUTFILE "  <dd>" . convertType($methods{$method . ':returnsdesc'},0,$objname) . "</dd>\n";
        }
        print OUTFILE "</dl>\n";
      }
      print OUTFILE "</div>\n\n";
    }
  }
}

sub outputMethodsInTable
{
  my $objname = $_[0];

  print OUTFILE "<h3>Methods</h3>\n\n";
  print OUTFILE "<table class='dcblock' border=1>\n";
  print OUTFILE "<thead><tr><th>Interface</th><th>Method</th></thead>\n";
  print OUTFILE "<tbody>\n";

  foreach $method (sort { uc($a) cmp uc($b) } keys %methods){
    if ($method !~ /\:/){
      my $ifacename = $methods{$method . ':interface'};
      print OUTFILE "  <tr><td>" . $methods{$method . ':interface'} . "</td><td><code>\n";
      if ($methods{$method . ":unscriptable"}){ print OUTFILE "[noscript]"; };
      if ($methods{$method . ":extraflags"}){ print OUTFILE $methods{$method . ":extraflags"} };
      print OUTFILE "    " . convertType($methods{$method . ':returns'},0,$objname) . " ";
      print OUTFILE "<strong><a href='../ifaces/$ifacename.html#method_" . $method . "'>" .
                    $method . "</a></strong>";
      my $argspec = $methods{$method . ':argspec'};
      $argspec =~ s/<a href='/<a href='..\/ifaces\//g;
      print OUTFILE " ( $argspec )\n";
      print OUTFILE "  </code></td></tr>\n";
    }
  }

  print OUTFILE "</tbody>\n";
  print OUTFILE "</table>\n\n";
}

sub outputFrozenInterfaces
{
  open FROZEN, ">$OUTPUTDIR/" . "frozen.html";

  $frozenInterfaces{"nsISupports"} = "nsISupports";

  print FROZEN getHeader("Frozen Interfaces","xpcomref","xpcomref", "");
  print FROZEN "<h2>Frozen Interfaces</h2>\n\n";
  print FROZEN "<p>\n" .
               "The following are all of the frozen interfaces. Frozen " .
               "interfaces are those that are stable and are not going " .
               "to change.\n" .
               "</p>\n\n";

  print FROZEN "<p>\n";
  foreach $iface (sort keys %frozenInterfaces){
    print FROZEN "<a href='ifaces/" . $iface . ".html'>$iface</a><br>\n";
  }
  print FROZEN "</p>\n";

  print FROZEN getFooter("");

  close FROZEN;
}

sub generateCrossIndex
{
  print "Generating index...\n";

  for (my $tidx = 0; $tidx<scalar(@filesToParse); $tidx++)
  {
    open INFILE, $filesToParse[$tidx];

    my $currentInterface, $currentMethod;

    while ($ln = <INFILE>){
      if (index($ln,"interface") == 0){
        $ln =~ /([A-Za-z0-9_]*)$/;
        $currentInterface = $1;
      }
      elsif (index($ln,"method") == 0){
        $ln =~ /([A-Za-z0-9_]*)$/;
        $currentMethod = $1;
      }
      elsif ($ln =~ /^attribute/){
        $ln =~ s/^attribute\s*//;
        $ln =~ s/^readonly\s*//;
        $ln =~ s/^notxpcom\s*//;
        $ln =~ s/^unscriptable\s*//;

        $ln =~ s/([A-Za-z0-9_]*)$//;
        my $attr = $1;
        chomp $ln;
        if (index($ln,"nsI") == 0){
          $ln =~ s/\&|\*|\s//g;
          $ln =~ s/Star(\*?)$/$1/;
          $crossRefMap{$ln}{"a $currentInterface.$attr"} = 1;
        }
      }
      elsif ($ln =~ s/^\s*returns\s*//){
        if (index($ln,"nsI") == 0){
          $ln =~ s/\&|\*|\s//g;
          $ln =~ s/Star(\*?)$/$1/;
          $crossRefMap{$ln}{"r $currentInterface.$currentMethod"} = 1;
        }
      }
      elsif ($ln =~ s/^\s*argument\s*//){
        while ($ln =~ s/(nsI[A-Za-z0-9_]*)//){
          $crossRefMap{$1}{"p $currentInterface.$currentMethod"} = 1;
        }
      }
    }
  }
}

sub outputCrossRefs
{
  my $interface = $_[0];

  my $hasanyitem = 0, $hasitem = 0;

  my @types = ("a","p","r");
  foreach $type (@types){
    $hasitem = 0;

    my %refs = %{$crossRefMap{$interface}};

    my $itemref;
    foreach $itemref (sort keys %refs){
      if ($itemref =~ /^$type\s*(.*)\.(.*)$/){
        my $ifacename = $1;
        my $pmname = $2;

        if (!$hasanyitem){
          if (((scalar @consts) > 0) || ((scalar keys %attributes) > 0) ||
              ((scalar keys %methods) > 0)){
            print OUTFILE "<hr>\n\n";
          }

          print OUTFILE "<a name='refs'></a>\n\n<h3>References</h3>\n";
        }
        if (!$hasitem){
          if ($type eq "a"){
            print OUTFILE "\n<p>This interface is the type of the following properties:</p>\n<p>\n";
          }
          elsif ($type eq "p"){
            print OUTFILE "\n<p>This interface is passed as an argument to the following methods:</p>\n<p>\n";
          }
          elsif ($type eq "r"){
            print OUTFILE "\n<p>This interface is returned from the following methods:</p>\n<p>\n";
          }
        }

        my $typemod = "method_";
        if (type eq "a"){ $typemod = "prop_"; }

        if ($hasitem){ print OUTFILE ",\n"; }
        print OUTFILE "<a href='$ifacename.html#$typemod$pmname'>$ifacename.$pmname</a>";

        $hasanyitem = 1;
        $hasitem = 1;
      }
    }
    if ($hasitem) {
      print OUTFILE "</p>\n";
    }
  }
}

sub generateMainIndex
{
  open GROUPS, "$SRCDIR/groups.txt";

  my $obsoleteMode = 0;

  my %interfaces=();
  my $cmode, $ln, $groupname, $grouptexthead, $grouptextbody, $subgroups;
  while ($ln = <GROUPS>){
    chomp $ln;
    if ($obsoleteMode){
      if ($ln && $ln !~ /^\s+$/ && substr($ln,0,1) ne "\@"){
        $allInterfaces{$ln} = $ln;
      }
    }
    elsif ($ln =~ /^OBSOLETE$/){
      $obsoleteMode = 1;
    }
    elsif ($ln =~ /^\#/){ next; }
    elsif ($ln =~ /^\[([A-Za-z0-9\s]*)\]/){
      $cmode=-1;
      foreach $interface (sort sortNames keys %interfaces){
        if (substr($interface,0,1) eq "\@"){
          if (!$cmode){ $cmode=1; $grouptextbody .= "</p><p>\n"; }
        } else { $cmode=0; }
        $grouptextbody .= "<a href='" . $interfaces{$interface} . ".html'>$interface</a><br>\n";
      }
      %interfaces=();

      if ($groupname){
        if ($grouptexthead =~ /<ul>/){ $grouptexthead .= "</ul>"; }
        open GROUPSET, ">$OUTPUTDIR/" . "group_$groupnamemod.html";
        print GROUPSET getHeader($groupname,"xpcomref","xpcomref", "");
        print GROUPSET $grouptexthead . $grouptextbody . getFooter("");
        close GROUPSET;
      }

      $groupname=$1;
      $groups{$groupname}="";
      $subgroups=0;

      $groupnamemod = $groupname;
      $groupnamemod =~ s/\s//g;
      $grouptextbody = "";

      $grouptexthead = "<h2>$groupname</h2>\n\n";
    }
    elsif ($ln =~ /^\((.*)\)/){
      $cmode=-1;
      foreach $interface (sort sortNames keys %interfaces){
        if (substr($interface,0,1) eq "\@"){
          if (!$cmode){ $cmode=1; $grouptextbody .= "</p><p>\n"; }
        } else { $cmode=0; }
        my $isfrozen = ($frozenInterfaces{$interface} ? "*" : "");
        $grouptextbody .= "<a href='" . $interfaces{$interface} . ".html'>$interface</a><br>\n";
      }
      %interfaces=();

      my $grouptext = $1;
      my $grouptextmod = $1;
      $grouptextmod =~ s/\s//g;
      if (!$subgroups){
        $subgroups=1;
        $grouptexthead .= "<p>Jump to:</p>\n<ul>\n";
      }
      $grouptexthead .= "  <li><a href='\#$grouptextmod'>$grouptext</a></li>\n";
      $grouptextbody .= "\n<hr><a name='$grouptextmod'></a><h3>$grouptext</h3>\n\n";
    }
    elsif ($ln =~ s/\!//){
      $cmode=-1;
      foreach $interface (sort sortNames keys %interfaces){
        if (substr($interface,0,1) eq "\@"){
          if (!$cmode){ $cmode=1; $grouptextbody .= "</p><p>\n"; }
        } else { $cmode=0; }
        $grouptextbody .= "<a href='" . $interfaces{$interface} . ".html'>$interface</a><br>\n";
      }
      %interfaces=();

      if ($grouptextbody){ $grouptextbody .= $ln; }
      else { $grouptexthead .= $ln; }
    }
    elsif ($ln && $ln !~ /^\s+$/){
      my $iface = $ln;
      $iface =~  s/~//;

      if ($ln =~ s/^(.*)\s+\->\s*(.*)//){
        $iface = $1;
        $interfaceCreationMap{$1} = $2;
      }

      if (substr($iface,0,1) ne "\@"){
        $allInterfaces{$iface} = $iface;
      }
      $interfaces{$iface} = convertComponentName($iface,0);
    }
  }
  close GROUPS;

  $cmode=-1;
  foreach $interface (sort sortNames keys %interfaces){
    if (substr($interface,0,1) eq "\@"){
      if (!$cmode){ $cmode=1; $grouptextbody .= "</p><p>\n"; }
    } else { $cmode=0; }
        $grouptextbody .= "<a href='" . $interfaces{$interface} . ".html'>$interface</a><br>\n";
  }
  if ($grouptexthead =~ /<ul>/){ $grouptexthead .= "</ul>"; }
  open GROUPSET, ">$OUTPUTDIR/" . "group_$groupnamemod.html";
  print GROUPSET getHeader($groupname,"xpcomref","xpcomref", "");
  print GROUPSET $grouptexthead . $grouptextbody . getFooter("");
  close GROUPSET;
}

sub parseComponents
{
  my $cname = "";

  open COMPFILE, "$SRCDIR/ctoi.txt";
  while($ln = <COMPFILE>){
    if (substr($ln,0,1) eq "\@"){
      $cname = $ln;
    }
    elsif (substr($ln,0,1) eq " "){
      $ln =~ s/\s//g;
      if ($ln !~ /^nsISupports$/ && (index($cname,"\@Class") == -1) && (index($cname,"\@Interface") == -1)){
        $components{$ln} .= "<li><a href='../" . convertComponentName($cname,0) . ".html'>$cname</a></li>";
      }
    }
  }
  close COMPFILE;
}

sub outputComponentHeader
{
  my $cname = $_[0];
  my $isclass = $_[1];
  my %interfacelist = %{$_[2]};

  my $iface;
  my $isfirst = 1;

  my @interfaceNames = keys %interfacelist;

  print OUTFILE "<h2>$cname</h2>\n\n";

  if ($isclass == 2){
    print OUTFILE "<p>This is a scriptable interface corresponding to ";
    if ((scalar @interfaceNames) == 1){
      my $iname = $interfaceNames[0];
      print OUTFILE "the <a href=\"$XPCOMREFURL/ifaces/$iname.html\">$iname</a> XPCOM interface.</p>\n\n";
      foreach $iface (sort keys %interfacelist){
        getInterfaceFileForCombining($iface,$isfirst,($isclass ? $cname : ""));
        $isfirst = 0;
      }
    }
    elsif ((scalar @interfaceNames) > 1){
      print OUTFILE "the following XPCOM interfaces:</p>\n\n<ul>\n";
      foreach $iface (sort keys %interfacelist){
        print OUTFILE "<li><a href='$XPCOMREFURL/ifaces/" . $iface . ".html'>$iface</a></li>\n";
        getInterfaceFileForCombining($iface,$isfirst,($isclass ? $cname : ""));
        $isfirst = 0;
      }
      print OUTFILE "</ul>\n";
    }
  }
  else {
    if ($isclass == 1){
      print OUTFILE "<p>This object is available to unprivileged JavaScript. " .
                    "It implements the following interfaces:</p>\n\n";
    }
    else {
      if ((scalar @interfaceNames) > 0){
        print OUTFILE "<p>This component implements the following interfaces:</p>\n\n";
      }
    }

    print OUTFILE "<ul>\n";
    foreach $iface (sort keys %interfacelist){
      print OUTFILE "<li><a href='$XPCOMREFURL/ifaces/" . $iface . ".html'>$iface</a></li>\n";

      getInterfaceFileForCombining($iface,$isfirst,($isclass ? $cname : ""));
      $isfirst = 0;
    }
    print OUTFILE "</ul>\n\n";
  }

  if ((scalar @interfaceNames) > 0){
    outputInterfaceBody($cname,$isclass);
  }

  print OUTFILE getFooter($isclass ? "" : "../");
  close OUTFILE;
}

sub outputComponents
{
  my $isclass = 0;
  my $cname = "", $componentdocs = "", $category = "";
  my %interfacelist = ();

  open COMPFILE, "$SRCDIR/ctoi.txt";
  while($ln = <COMPFILE>){
    if (substr($ln,0,1) eq "\@"){
      if ($cname){
        %usedInterfaceList = ();
        outputComponentHeader($cname,$isclass,\%interfacelist);
        print OUTFILE $componentdocs;
      }
      $cname = $ln;
      $cname =~ s/\n//;
      $componentdocs = "";
      %interfacelist=();
      if ($cname =~ s/^\@Interface\s*//){ $isclass = 2; }
      elsif ($cname =~ s/^\@Class\s*//){ $isclass = 1; }
      else { $isclass = 0; }

      if ($isclass){
        my $classname = $cname;
        $classname =~ s/[^A-Za-z0-9]//g;
        open OUTFILE, ">" . $OUTPUTDIR . "/objref/$classname.html";
      }
      else {
        open OUTFILE, ">" . $OUTPUTDIR . "/" . convertComponentName($cname,$isclass) . ".html";
      }
      if ($isclass){ print OUTFILE getHeader("$cname","objref",$category, ""); }
      else { print OUTFILE getHeader("Component $cname","xpcomref",$category, "../"); }
    }
    elsif (substr($ln,0,1) eq "\!"){
      $ln =~ s/^\!//;
      $componentdocs .= $ln;
    }
    elsif (substr($ln,0,1) eq " "){
      $ln =~ s/\s//g;
      if ($ln !~ /^nsISupports$/){
        $components{$ln} .= "<li><a href='../" . convertComponentName($cname,0) . ".html'>$cname</a></li>";
      }
      $interfacelist{$ln}=$ln;
    }
    elsif (substr($ln,0,1) eq "["){
      $category = $ln;
      $category =~ s/\[|\]|\s//g;
    }
  }
  if ($cname){
    outputComponentHeader($cname,$isclass,\%interfacelist);
    print OUTFILE $componentdocs;
  }
  close COMPFILE;
}

sub printInnerInterfacesList
{
  my $fl;
  print "Interfaces without their own IDL files:\n";
  while ($fl = <*.parsed.html>){
    $fl =~ s/\.parsed\.html/.html/;
    if (!(-e $fl)){ print $fl . "\n"; }
  }
  print "IDL files without output interfaces:\n";
  while ($fl = <*.idl>){
    $fl =~ s/\.idl/.parsed.html/;
    if (!(-e $fl)){ print $fl . "\n"; }
  }
}

sub convertComponentName
{
  my $cname = $_[0];
  my $isclass = $_[1];

  if ($isclass){
    $cname =~ s/[^A-Za-z0-9]//g;
    $cname = "/references/objref/" . $cname;
  }
  elsif ($cname =~ s/^\@mozilla\.org\:*//){
    $cname =~ s/[^A-Za-z0-9]//g;
    $cname = "comps/c_" . $cname;
  }
  else {
    $cname = "ifaces/$cname";
  }
  return $cname;
}

sub sortNames
{
  if ((substr($a,0,1) eq "\@") && (substr($b,0,1) ne "\@")){ return 1; }
  elsif ((substr($a,0,1) ne "\@") && (substr($b,0,1) eq "\@")){ return -1; }
  else { return $a cmp $b; }
}

sub getHeader
{
  if ($OUTPUTFORLOCAL){ return $localHeader; }

  my $pagetitle = $_[0];
  my $section = $_[1];
  my $category = $_[2];
  my $epath = $_[3];

  my $sectionlink = "";

  if ($section eq "objref"){
    $sectionlink = "<a href='$OBJREFURL'>Object Reference</a>";
  }
  else {
    $sectionlink = "<a href='$XPCOMREFURL'>XPCOM Reference</a>";
  }

  my $retval =
    "<?php
      \$pagebase=\"<a href='http://www.xulplanet.com/references/'>References</a> &gt; $sectionlink\";
      \$pagetitle=\"$pagetitle\";
      \$pageextrastyle=\"<link rel='stylesheet' href='/styles/default/xpcomref.css' type='text/css'>\";

      \$customsidebar=\"$epath$category-sidebar.php\";

      include \"$epath../../lib/header.php\";
     ?>
    ";

  return $retval;
}

sub getFooter
{
  my $epath = $_[0];

  my $retval = "<p class='xpcomsrcline'>Reference documentation is generated from " .
               "<a href='http://lxr.mozilla.org'>Mozilla's source</a>.</p>\n\n";

  if ($OUTPUTFORLOCAL){ return $retval .  $localFooter; }

  return $retval . 
         "<?php include \"$epath../../comments/comments.php\" ?>\n" .
         "<?php include \"$epath../../lib/footer.php\" ?>\n";
}

sub getInterfaceFileForCombining
{
  $interfacename = $_[0];
  my $isfirst = $_[1];
  my $objname = $_[2];

  my $inheritsfrom = "";

  if ($isfirst){
    %keys = ();
    @consts = ();
    %attributes = ();
    %methods = ();
  }

  if (($interfacename eq "nsISupports") || ($interfacename eq "nsIClassInfo") ||
      ($usedInterfaceList{$interfacename})){ return; }
  $usedInterfaceList{$interfacename} = $interfacename;

  my $ifacefilename = $interfaceFiles{$interfacename};
  if (!$ifacefilename){
    $ifacefilename = $interfacename . ".html";
  }

  open INFILE, $IDLDIR . "/" . $ifacefilename;

  my $ln = <INFILE>;
  while ($ln =~ /^\s+$/){ $ln = <INFILE>; }

  INFILEITERCREF: while ($ln){
    if ($ln =~ /interface\s*(noscript)*\s*$interfacename/){
      my $comment = parseComment($ln);
      if ($comment){
        $ln = <INFILE>;
        if ($ln =~ /\/\*/){
          my $ctmp = $keys{'comment'};
          $comment = parseComment($ln);
          $keys{'comment'} = $ctmp . $keys{'comment'};
          $ln = <INFILE>;
        }
      }

      my $interface = parseInterface($ln);
      if ($interface && !$comment){
        $comment = parseComment($ln);
      }

      $inheritsfrom = $keys{"inheritsInterface"};

      MEMBERSITERCREF: while ($ln = <INFILE>){
        if ($ln =~ /^\s+$/){ next MEMBERSITERCREF; }
        my $comment = parseComment($ln);
        if ($comment){
          $ln = <INFILE>;
          if ($ln =~ /\/\*/){
            parseComment($ln);
            $ln = <INFILE>;
          }
        }

        if ($ln =~ /^interface/){ last INFILEITERCREF; }
        if ($ln =~ /^const/){ parseConst($ln); }
        elsif ($ln =~ /^attribute/){ parseAttribute($ln); }
        elsif ($ln =~ /^method/){ parseMethod($ln,$objname); }
        %keys = ();
      }
    }
    else {
      $ln = <INFILE>;
    }
  }

  close INFILE;

  if ($inheritsfrom){
    getInterfaceFileForCombining($inheritsfrom,0,$objname);
  }
}

sub outputInterfaceBody
{
  my $cname = $_[0];
  my $isclass = $_[1];

  $cname =~ s/[^A-Za-z0-9]//g;

  my $objname = ($isclass) ? $cname : "";

  my $nameii;
  if ($isclass){
    my %allNamesForInterface = (%attributes, %methods);
    open ELEMREFINHERIT, ">$ELEMREFQUICKDIR/$cname.txt";
    foreach $nameii (sort keys %allNamesForInterface){
      if ($nameii !~ /\:/){
        print ELEMREFINHERIT "<a href='$OBJREFURL/$cname.html#";
        print ELEMREFINHERIT ($attributes{$nameii} ? "prop" : "method");
        print ELEMREFINHERIT "_$nameii'>$nameii</a><br>\n";
      }
    }
    close ELEMREFINHERIT;
  }

  if (scalar @consts){ outputConsts(!$isclass,$objname); }
  if (scalar keys %attributes){ outputAttributes(!$isclass,$objname); }
  if (scalar keys %methods){
    if ($isclass){ outputMethods($objname); }
    else { outputMethodsInTable($objname); }
  }
}