/******************************************************************************

 *

 * 

 *

 * Copyright (C) 1997-2008 by Dimitri van Heesch.

 *

 * Permission to use, copy, modify, and distribute this software and its

 * documentation under the terms of the GNU General Public License is hereby 

 * granted. No representations are made about the suitability of this software 

 * for any purpose. It is provided "as is" without express or implied warranty.

 * See the GNU General Public License for more details.

 *

 * Documents produced by Doxygen are derivative works derived from the

 * input used in their production; they are not affected by this license.

 *

 */

#include "qtbc.h"

#include "memberlist.h"

#include "classlist.h"

#include "filedef.h"

#include "doxygen.h"

#include "memberdef.h"

#include "classdef.h"

#include "namespacedef.h"

#include "util.h"

#include "language.h"

#include "outputlist.h"

#include "dot.h"

#include "message.h"

#include "docparser.h"

#include "searchindex.h"

#include "htags.h"

#include "parserintf.h"

#include "portable.h"

#include "vhdldocgen.h"

#include "debug.h"

#include "layout.h"

//---------------------------------------------------------------------------

class DevNullCodeDocInterface : public CodeOutputInterface

{

  public:

    virtual void codify(const char *) {}

    virtual void writeCodeLink(const char *,const char *,

                               const char *,const char *,

                               const char *) {}

    virtual void writeLineNumber(const char *,const char *,

                                 const char *,int) {}

    virtual void startCodeLine() {}

    virtual void endCodeLine() {}

    virtual void startCodeAnchor(const char *) {}

    virtual void endCodeAnchor() {}

    virtual void startFontClass(const char *) {}

    virtual void endFontClass() {}

    virtual void writeCodeAnchor(const char *) {}

    virtual void linkableSymbol(int, const char *,Definition *,Definition *) {}

};

//---------------------------------------------------------------------------

/*! create a new file definition, where \a p is the file path, 

    \a nm the file name, and \a ref is an HTML anchor name if the

    file was read from a tag file or 0 otherwise

*/

FileDef::FileDef(const char *p,const char *nm,

                 const char *lref,const char *dn)

   : Definition((QCString)p+nm,1,nm)

{

  path=p;

  filepath=path+nm;

  filename=nm;

  diskname=dn;

  if (diskname.isEmpty()) diskname=nm;

  setReference(lref);

  classSDict        = 0;

  includeList       = 0;

  includeDict       = 0; 

  includedByList    = 0;

  includedByDict    = 0; 

  namespaceSDict    = 0; 

  srcDefDict        = 0;

  srcMemberDict     = 0;

  usingDirList      = 0;

  usingDeclList     = 0;

  package           = 0;

  isSource          = FALSE; 

  docname           = nm;

  dir               = 0;

  if (Config_getBool("FULL_PATH_NAMES"))

  {

    docname.prepend(stripFromPath(path.copy()));

  }

  m_isJava          = name().right(5)==".java";

  memberGroupSDict = 0;

  acquireFileVersion();

  m_subGrouping=Config_getBool("SUBGROUPING");

}

/*! destroy the file definition */

FileDef::~FileDef()

{

  delete classSDict;

  delete includeDict;

  delete includeList;

  delete includedByDict;

  delete includedByList;

  delete namespaceSDict;

  delete srcDefDict;

  delete srcMemberDict;

  delete usingDirList;

  delete usingDeclList;

  delete memberGroupSDict;

}

/*! Compute the HTML anchor names for all members in the class */ 

void FileDef::computeAnchors()

{

  MemberList *ml = getMemberList(MemberList::allMembersList);

  if (ml) setAnchors(0,'a',ml);

}

void FileDef::distributeMemberGroupDocumentation()

{

  //printf("FileDef::distributeMemberGroupDocumentation()\n");

  if (memberGroupSDict)

  {

    MemberGroupSDict::Iterator mgli(*memberGroupSDict);

    MemberGroup *mg;

    for (;(mg=mgli.current());++mgli)

    {

      mg->distributeMemberGroupDocumentation();

    }

  }

}

void FileDef::findSectionsInDocumentation()

{

  docFindSections(documentation(),this,0,docFile());

  if (memberGroupSDict)

  {

    MemberGroupSDict::Iterator mgli(*memberGroupSDict);

    MemberGroup *mg;

    for (;(mg=mgli.current());++mgli)

    {

      mg->findSectionsInDocumentation();

    }

  }

  QListIterator<MemberList> mli(m_memberLists);

  MemberList *ml;

  for (mli.toFirst();(ml=mli.current());++mli)

  {

    if (ml->listType()&MemberList::declarationLists)

    {

      ml->findSectionsInDocumentation();

    }

  }

}

void FileDef::writeDetailedDescription(OutputList &ol,const QCString &title)

{

  if ((!briefDescription().isEmpty() && Config_getBool("REPEAT_BRIEF")) || 

      !documentation().isEmpty() ||

      (Config_getBool("SOURCE_BROWSER") && getStartBodyLine()!=-1 && getBodyDef())

     )

  {

    ol.writeRuler();

    ol.pushGeneratorState();

    ol.disableAllBut(OutputGenerator::Html);

      ol.writeAnchor(0,"_details"); 

    ol.popGeneratorState();

    ol.startGroupHeader();

    ol.parseText(title);

    ol.endGroupHeader();

    ol.startTextBlock();

    if (!briefDescription().isEmpty() && Config_getBool("REPEAT_BRIEF"))

    {

      ol.parseDoc(briefFile(),briefLine(),this,0,briefDescription(),FALSE,FALSE);

    }

    if (!briefDescription().isEmpty() && Config_getBool("REPEAT_BRIEF") && 

        !documentation().isEmpty())

    {

      ol.pushGeneratorState();

        ol.disable(OutputGenerator::Man);

        ol.disable(OutputGenerator::RTF);

        // ol.newParagraph(); // FIXME:PARA

        ol.enableAll();

        ol.disableAllBut(OutputGenerator::Man);

        ol.writeString("\n\n");

      ol.popGeneratorState();

    }

    if (!documentation().isEmpty())

    {

      ol.parseDoc(docFile(),docLine(),this,0,documentation()+"\n",TRUE,FALSE);

    }

    //printf("Writing source ref for file %s\n",name().data());

    if (Config_getBool("SOURCE_BROWSER")) 

    {

      ol.startParagraph();

      QCString refText = theTranslator->trDefinedInSourceFile();

      int fileMarkerPos = refText.find("@0");

      if (fileMarkerPos!=-1) // should always pass this.

      {

        ol.parseText(refText.left(fileMarkerPos)); //text left from marker 1

        ol.writeObjectLink(0,getSourceFileBase(),

            0,name());

        ol.parseText(refText.right(

              refText.length()-fileMarkerPos-2)); // text right from marker 2

      }

      ol.endParagraph();

    }

    ol.endTextBlock();

  }

}

void FileDef::writeBriefDescription(OutputList &ol)

{

  if (!briefDescription().isEmpty()) 

  {

    ol.startParagraph();

    ol.parseDoc(briefFile(),briefLine(),this,0,

                briefDescription(),TRUE,FALSE,0,TRUE,FALSE);

    ol.pushGeneratorState();

    ol.disable(OutputGenerator::RTF);

    ol.writeString(" \n");

    ol.enable(OutputGenerator::RTF);

    if (Config_getBool("REPEAT_BRIEF") ||

        !documentation().isEmpty()

       )

    {

      ol.disableAllBut(OutputGenerator::Html);

      ol.startTextLink(0,"_details");

      ol.parseText(theTranslator->trMore());

      ol.endTextLink();

    }

    ol.popGeneratorState();

    ol.endParagraph();

    //ol.pushGeneratorState();

    //ol.disable(OutputGenerator::RTF);

    //ol.newParagraph();

    //ol.popGeneratorState();

  }

  ol.writeSynopsis();

}

void FileDef::writeIncludeFiles(OutputList &ol)

{

  if (/*Config_getBool("SHOW_INCLUDE_FILES") &&*/ includeList && 

      includeList->count()>0)

  {

    ol.startTextBlock(TRUE);

    QListIterator<IncludeInfo> ili(*includeList);

    IncludeInfo *ii;

    for (;(ii=ili.current());++ili)

    {

      FileDef *fd=ii->fileDef;

      bool isIDLorJava = FALSE;

      if (fd)

      {

        isIDLorJava = fd->name().right(4)==".idl" ||   // M$ or Corba IDL

                      fd->name().right(5)==".pidl" ||

                      fd->name().right(5)==".java" ||  // Sun's Java

                      fd->name().right(4)==".jsl";     // M$ J#

      }

      ol.startTypewriter();

      if (isIDLorJava) // IDL/Java include

      {

        ol.docify("import ");

      }

      else if (ii->imported) // Objective-C include

      {

        ol.docify("#import ");

      }

      else // C/C++ include

      {

        ol.docify("#include ");

      }

      if (ii->local || isIDLorJava)

        ol.docify("\"");

      else

        ol.docify("<");

      ol.disable(OutputGenerator::Html);

      ol.docify(ii->includeName);

      ol.enableAll();

      ol.disableAllBut(OutputGenerator::Html);

      // Here we use the include file name as it appears in the file.

      // we could also we the name as it is used within doxygen,

      // then we should have used fd->docName() instead of ii->includeName

      if (fd && fd->isLinkable())

      {

        ol.writeObjectLink(fd->getReference(),

            fd->generateSourceFile() ? fd->includeName() : fd->getOutputFileBase(),

            0,ii->includeName);

        if (!Config_getString("GENERATE_TAGFILE").isEmpty() && !fd->isReference()) 

        {

          const char *locStr = (ii->local    || isIDLorJava) ? "yes" : "no";

          const char *impStr = (ii->imported || isIDLorJava) ? "yes" : "no";

          Doxygen::tagFile << "    <includes id=\"" 

                           << convertToXML(fd->getOutputFileBase()) << "\" "

                           << "name=\"" << convertToXML(fd->name()) << "\" "

                           << "local=\"" << locStr << "\" "

                           << "imported=\"" << impStr << "\">"

                           << convertToXML(ii->includeName)

                           << "</includes>" 

                           << endl;

        }

      }

      else

      {

        ol.docify(ii->includeName);

      }

      ol.enableAll();

      if (ii->local || isIDLorJava)

        ol.docify("\"");

      else

        ol.docify(">");

      if (isIDLorJava) 

        ol.docify(";");

      ol.endTypewriter();

      ol.lineBreak();

    }

    ol.endTextBlock();

  }

}

void FileDef::writeIncludeGraph(OutputList &ol)

{

  if (Config_getBool("HAVE_DOT") /*&& Config_getBool("INCLUDE_GRAPH")*/)

  {

    //printf("Graph for file %s\n",name().data());

    DotInclDepGraph incDepGraph(this,FALSE);

    if (!incDepGraph.isTrivial() && !incDepGraph.isTooBig())

    {

      ol.startTextBlock(); 

      ol.disable(OutputGenerator::Man);

      ol.startInclDepGraph();

      ol.parseText(theTranslator->trInclDepGraph(name()));

      ol.endInclDepGraph(incDepGraph);

      ol.enableAll();

      ol.endTextBlock(TRUE);

    }

    //incDepGraph.writeGraph(Config_getString("HTML_OUTPUT"),fd->getOutputFileBase());

  }

}

void FileDef::writeIncludedByGraph(OutputList &ol)

{

  if (Config_getBool("HAVE_DOT") /*&& Config_getBool("INCLUDED_BY_GRAPH")*/)

  {

    //printf("Graph for file %s\n",name().data());

    DotInclDepGraph incDepGraph(this,TRUE);

    if (!incDepGraph.isTrivial() && !incDepGraph.isTooBig())

    {

      ol.startTextBlock(); 

      ol.disable(OutputGenerator::Man);

      ol.startInclDepGraph();

      ol.parseText(theTranslator->trInclByDepGraph());

      ol.endInclDepGraph(incDepGraph);

      ol.enableAll();

      ol.endTextBlock(TRUE);

    }

    //incDepGraph.writeGraph(Config_getString("HTML_OUTPUT"),fd->getOutputFileBase());

  }

}

void FileDef::writeSourceLink(OutputList &ol)

{

  //printf("%s: generateSourceFile()=%d\n",name().data(),generateSourceFile());

  if (generateSourceFile())

  {

    ol.disableAllBut(OutputGenerator::Html);

    ol.startParagraph();

    ol.startTextLink(includeName(),0);

    ol.parseText(theTranslator->trGotoSourceCode());

    ol.endTextLink();

    ol.endParagraph();

    ol.enableAll();

  }

}

void FileDef::writeNamespaceDeclarations(OutputList &ol,const QCString &title)

{

  // write list of namespaces

  if (namespaceSDict) namespaceSDict->writeDeclaration(ol,title);

}

void FileDef::writeClassDeclarations(OutputList &ol,const QCString &title)

{

  // write list of classes

  if (classSDict) classSDict->writeDeclaration(ol,0,title,FALSE);

}

void FileDef::startMemberDeclarations(OutputList &ol)

{

  ol.startMemberSections();

}

void FileDef::endMemberDeclarations(OutputList &ol)

{

  ol.endMemberSections();

}

void FileDef::startMemberDocumentation(OutputList &ol)

{

  if (Config_getBool("SEPARATE_MEMBER_PAGES"))

  {

    ol.disable(OutputGenerator::Html);

    Doxygen::suppressDocWarnings = TRUE;

  }

}

void FileDef::endMemberDocumentation(OutputList &ol)

{

  if (Config_getBool("SEPARATE_MEMBER_PAGES"))

  {

    ol.enable(OutputGenerator::Html);

    Doxygen::suppressDocWarnings = FALSE;

  }

}

void FileDef::writeMemberGroups(OutputList &ol)

{

  /* write user defined member groups */

  if (memberGroupSDict)

  {

    MemberGroupSDict::Iterator mgli(*memberGroupSDict);

    MemberGroup *mg;

    for (;(mg=mgli.current());++mgli)

    {

      if ((!mg->allMembersInSameSection() || !m_subGrouping) 

          && mg->header()!="[NOHEADER]")

      {

        mg->writeDeclarations(ol,0,0,this,0);

      }

    }

  }

}

void FileDef::writeAuthorSection(OutputList &ol)

{

  // write Author section (Man only)

  ol.pushGeneratorState();

  ol.disableAllBut(OutputGenerator::Man);

  ol.startGroupHeader();

  ol.parseText(theTranslator->trAuthor(TRUE,TRUE));

  ol.endGroupHeader();

  ol.parseText(theTranslator->trGeneratedAutomatically(Config_getString("PROJECT_NAME")));

  ol.popGeneratorState();

}

/*! Write the documentation page for this file to the file of output

    generators \a ol. 

*/

void FileDef::writeDocumentation(OutputList &ol)

{

  //funcList->countDecMembers();

  //QCString fn = name();

  //if (Config_getBool("FULL_PATH_NAMES"))

  //{

  //  fn.prepend(stripFromPath(getPath().copy()));

  //}

  //printf("WriteDocumentation diskname=%s\n",diskname.data());

  QCString versionTitle;

  if (!fileVersion.isEmpty())

  {

    versionTitle=("("+fileVersion+")");

  }

  QCString title = docname+versionTitle;

  QCString pageTitle=theTranslator->trFileReference(docname);

  if (Config_getBool("SHOW_DIRECTORIES") && getDirDef())

  {

    startFile(ol,getOutputFileBase(),name(),pageTitle,HLI_FileVisible,TRUE);

    getDirDef()->writeNavigationPath(ol);

    ol.endQuickIndices();

    ol.startContents();

    QCString pageTitleShort=theTranslator->trFileReference(name());

    startTitle(ol,getOutputFileBase());

    ol.pushGeneratorState();

      ol.disableAllBut(OutputGenerator::Html);

      ol.parseText(pageTitleShort); // Html only

      ol.enableAll();

      ol.disable(OutputGenerator::Html);

      ol.parseText(pageTitle); // other output formats

    ol.popGeneratorState();

    addGroupListToTitle(ol,this);

    endTitle(ol,getOutputFileBase(),title);

  }

  else

  {

    startFile(ol,getOutputFileBase(),name(),pageTitle,HLI_FileVisible);

    startTitle(ol,getOutputFileBase());

    ol.parseText(pageTitle);

    addGroupListToTitle(ol,this);

    endTitle(ol,getOutputFileBase(),title);

  }

  if (!fileVersion.isEmpty())

  {

    ol.disableAllBut(OutputGenerator::Html);

    ol.startProjectNumber();

    ol.docify(versionTitle);

    ol.endProjectNumber();

    ol.enableAll();

  }

  if (Doxygen::searchIndex)

  {

    Doxygen::searchIndex->setCurrentDoc(pageTitle,getOutputFileBase());

    Doxygen::searchIndex->addWord(localName(),TRUE);

  }

  if (!Config_getString("GENERATE_TAGFILE").isEmpty()) 

  {

    Doxygen::tagFile << "  <compound kind=\"file\">" << endl;

    Doxygen::tagFile << "    <name>" << convertToXML(name()) << "</name>" << endl;

    Doxygen::tagFile << "    <path>" << convertToXML(getPath()) << "</path>" << endl;

    Doxygen::tagFile << "    <filename>"