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

 *

 * 

 *

 * 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 "namespacedef.h"

#include "outputlist.h"

#include "util.h"

#include "language.h"

#include "classdef.h"

#include "classlist.h"

#include "memberlist.h"

#include "doxygen.h"

#include "message.h"

#include "docparser.h"

#include "searchindex.h"

#include "vhdldocgen.h"

#include "layout.h"

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

NamespaceDef::NamespaceDef(const char *df,int dl,

                           const char *name,const char *lref,

                           const char *fName) : 

   Definition(df,dl,name)

{

  if (fName)

  {

    fileName = stripExtension(fName);

  }

  else

  {

    fileName="namespace";

    fileName+=name;

  }

  classSDict = new ClassSDict(17);

  namespaceSDict = new NamespaceSDict(17);

  m_innerCompounds = new SDict<Definition>(17);

  usingDirList = 0;

  usingDeclList = 0;

  m_allMembersDict = 0;

  setReference(lref);

  memberGroupSDict = new MemberGroupSDict;

  memberGroupSDict->setAutoDelete(TRUE);

  visited=FALSE;

  m_subGrouping=Config_getBool("SUBGROUPING");

}

NamespaceDef::~NamespaceDef()

{

  delete classSDict;

  delete namespaceSDict;

  delete m_innerCompounds;

  delete usingDirList;

  delete usingDeclList;

  delete memberGroupSDict;

}

void NamespaceDef::distributeMemberGroupDocumentation()

{

  MemberGroupSDict::Iterator mgli(*memberGroupSDict);

  MemberGroup *mg;

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

  {

    mg->distributeMemberGroupDocumentation();

  }

}

void NamespaceDef::findSectionsInDocumentation()

{

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

  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 NamespaceDef::insertUsedFile(const char *f)

{

  if (files.find(f)==-1) 

  {

    if (Config_getBool("SORT_MEMBER_DOCS"))

      files.inSort(f);

    else

      files.append(f);

  }

}

void NamespaceDef::addInnerCompound(Definition *d)

{

  m_innerCompounds->append(d->localName(),d);

  if (d->definitionType()==Definition::TypeNamespace)

  {

    insertNamespace((NamespaceDef *)d);

  }

  else if (d->definitionType()==Definition::TypeClass)

  {

    insertClass((ClassDef *)d);

  }

}

void NamespaceDef::insertClass(ClassDef *cd)

{

  if (classSDict->find(cd->name())==0)

  {

    if (Config_getBool("SORT_BRIEF_DOCS"))

      classSDict->inSort(cd->name(),cd);

    else

      classSDict->append(cd->name(),cd);

  }

}

void NamespaceDef::insertNamespace(NamespaceDef *nd)

{

  if (namespaceSDict->find(nd->name())==0)

  {

    if (Config_getBool("SORT_MEMBER_DOCS"))

      namespaceSDict->inSort(nd->name(),nd);

    else

      namespaceSDict->append(nd->name(),nd);

  }

}

void NamespaceDef::addMembersToMemberGroup()

{

  QListIterator<MemberList> mli(m_memberLists);

  MemberList *ml;

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

  {

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

    {

      ::addMembersToMemberGroup(ml,&memberGroupSDict,this);

    }

  }

  // add members inside sections to their groups

  if (memberGroupSDict)

  {

    MemberGroupSDict::Iterator mgli(*memberGroupSDict);

    MemberGroup *mg;

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

    {

      if (mg->allMembersInSameSection() && m_subGrouping)

      {

        //printf("----> addToDeclarationSection(%s)\n",mg->header().data());

        mg->addToDeclarationSection();

      }

    }

  }

}

void NamespaceDef::insertMember(MemberDef *md)

{

  if (md->isHidden()) return;

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

  if (allMemberList==0)

  {

    allMemberList = new MemberList(MemberList::allMembersList);

    m_memberLists.append(allMemberList);

  }

  allMemberList->append(md); 

  if (m_allMembersDict==0)

  {

    m_allMembersDict = new MemberSDict;

  }

  //printf("%s::m_allMembersDict->append(%s)\n",name().data(),md->localName().data());

  m_allMembersDict->append(md->localName(),md); 

  //::addNamespaceMemberNameToIndex(md);

  //static bool sortBriefDocs=Config_getBool("SORT_BRIEF_DOCS");

  switch(md->memberType())

  {

    case MemberDef::Variable:     

      addMemberToList(MemberList::decVarMembers,md);

      addMemberToList(MemberList::docVarMembers,md);

      break;

    case MemberDef::Function: 

      addMemberToList(MemberList::decFuncMembers,md);

      addMemberToList(MemberList::docFuncMembers,md);

      break;

    case MemberDef::Typedef:      

      addMemberToList(MemberList::decTypedefMembers,md);

      addMemberToList(MemberList::docTypedefMembers,md);

      break;

    case MemberDef::Enumeration:  

      addMemberToList(MemberList::decEnumMembers,md);

      addMemberToList(MemberList::docEnumMembers,md);

      break;

    case MemberDef::EnumValue:    

      break;

    case MemberDef::Define:       

      addMemberToList(MemberList::decDefineMembers,md);

      addMemberToList(MemberList::docDefineMembers,md);

      break;

    default:

      err("NamespaceDef::insertMembers(): "

           "member `%s' with class scope `%s' inserted in namespace scope `%s'!\n",

           md->name().data(),

           md->getClassDef() ? md->getClassDef()->name().data() : "",

           name().data());

  }

}

void NamespaceDef::computeAnchors()

{

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

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

}

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

{

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

      !documentation().isEmpty()

     )

  {

    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);

    }

    ol.endTextBlock();

  }

}

void NamespaceDef::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();

    // FIXME:PARA

    //ol.pushGeneratorState();

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

    //ol.newParagraph();

    //ol.popGeneratorState();

  }

  ol.writeSynopsis();

}

void NamespaceDef::startMemberDeclarations(OutputList &ol)

{

  ol.startMemberSections();

}

void NamespaceDef::endMemberDeclarations(OutputList &ol)

{

  ol.endMemberSections();

}

void NamespaceDef::startMemberDocumentation(OutputList &ol)

{

  if (Config_getBool("SEPARATE_MEMBER_PAGES"))

  {

    ol.disable(OutputGenerator::Html);

    Doxygen::suppressDocWarnings = TRUE;

  }

}

void NamespaceDef::endMemberDocumentation(OutputList &ol)

{

  if (Config_getBool("SEPARATE_MEMBER_PAGES"))

  {

    ol.enable(OutputGenerator::Html);

    Doxygen::suppressDocWarnings = FALSE;

  }

}

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

{

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

}

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

{

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

}

void NamespaceDef::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,this,0,0);

      }

    }

  }

}

void NamespaceDef::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();

}

void NamespaceDef::writeDocumentation(OutputList &ol)

{

  bool fortranOpt = Config_getBool("OPTIMIZE_FOR_FORTRAN");

  QCString pageTitle;

  if (Config_getBool("OPTIMIZE_OUTPUT_JAVA"))

  {

    pageTitle = theTranslator->trPackage(displayName());

  }

  else if (fortranOpt)

  {

    pageTitle = theTranslator->trModuleReference(displayName());

  }

  else

  {

    pageTitle = theTranslator->trNamespaceReference(displayName());

  }

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

  if (getOuterScope()!=Doxygen::globalScope)

  {

    writeNavigationPath(ol);

  }

  ol.endQuickIndices();

  ol.startContents();

  startTitle(ol,getOutputFileBase());

  ol.parseText(pageTitle);

  addGroupListToTitle(ol,this);

  endTitle(ol,getOutputFileBase(),displayName());

  if (Doxygen::searchIndex)

  {

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

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

  }

  bool generateTagFile = !Config_getString("GENERATE_TAGFILE").isEmpty();

  if (generateTagFile)

  {

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

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

    Doxygen::tagFile << "    <filename>" << convertToXML(getOutputFileBase()) << Doxygen::htmlFileExtension << "</filename>" << endl;

  }

  Doxygen::indexList.addIndexItem(this,0);

  //---------------------------------------- start flexible part -------------------------------

  QListIterator<LayoutDocEntry> eli(

      LayoutDocManager::instance().docEntries(LayoutDocManager::Namespace));

  LayoutDocEntry *lde;

  for (eli.toFirst();(lde=eli.current());++eli)

  {

    switch (lde->kind())

    {

      case LayoutDocEntry::BriefDesc: 

        writeBriefDescription(ol);

        break; 

      case LayoutDocEntry::MemberDeclStart: 

        startMemberDeclarations(ol);

        break; 

      case LayoutDocEntry::NamespaceClasses: 

        {

          LayoutDocEntrySection *ls = (LayoutDocEntrySection*)lde;

          writeClassDeclarations(ol,ls->title);

        }

        break; 

      case LayoutDocEntry::NamespaceNestedNamespaces: 

        {

          LayoutDocEntrySection *ls = (LayoutDocEntrySection*)lde;

          writeNamespaceDeclarations(ol,ls->title);

        }

        break; 

      case LayoutDocEntry::MemberGroups: 

        writeMemberGroups(ol);

        break; 

      case LayoutDocEntry::MemberDecl: 

        {

          LayoutDocEntryMemberDecl *lmd = (LayoutDocEntryMemberDecl*)lde;

          writeMemberDeclarations(ol,lmd->type,lmd->title);

        }

        break; 

      case LayoutDocEntry::MemberDeclEnd: 

        endMemberDeclarations(ol);

        break;

      case LayoutDocEntry::DetailedDesc: 

        {

          LayoutDocEntrySection *ls = (LayoutDocEntrySection*)lde;

          writeDetailedDescription(ol,ls->title);

        }

        break;

      case LayoutDocEntry::MemberDefStart: 

        startMemberDocumentation(ol);

        break; 

      case LayoutDocEntry::MemberDef: 

        {

          LayoutDocEntryMemberDef *lmd = (LayoutDocEntryMemberDef*)lde;

          writeMemberDocumentation(ol,lmd->type,lmd->title);

        }

        break;

      case LayoutDocEntry::MemberDefEnd: 

        endMemberDocumentation(ol);

        break;

      case LayoutDocEntry::AuthorSection: 

        writeAuthorSection(ol);

        break;

      case LayoutDocEntry::ClassIncludes:

      case LayoutDocEntry::ClassInheritanceGraph:

      case LayoutDocEntry::ClassNestedClasses:

      case LayoutDocEntry::ClassCollaborationGraph:

      case LayoutDocEntry::ClassAllMembersLink:

      case LayoutDocEntry::ClassUsedFiles:

      case LayoutDocEntry::FileClasses:

      case LayoutDocEntry::FileNamespaces:

      case LayoutDocEntry::FileIncludes:

      case LayoutDocEntry::FileIncludeGraph:

      case LayoutDocEntry::FileIncludedByGraph: 

      case LayoutDocEntry::FileSourceLink:

      case LayoutDocEntry::GroupClasses: 

      case LayoutDocEntry::GroupNamespaces:

      case LayoutDocEntry::GroupDirs: 

      case LayoutDocEntry::GroupNestedGroups: 

      case LayoutDocEntry::GroupFiles:

      case LayoutDocEntry::GroupGraph: 

      case LayoutDocEntry::GroupPageDocs:

      case LayoutDocEntry::DirSubDirs:

      case LayoutDocEntry::DirFiles:

      case LayoutDocEntry::DirGraph:

        err("Internal inconsistency: member %d should not be part of "

            "LayoutDocManager::Namespace entry list\n",lde->kind());

        break;

    }

  }

  //---------------------------------------- end flexible part -------------------------------

  endFile(ol);

  if (generateTagFile)

  {

    writeDocAnchorsToTagFile();

    Doxygen::tagFile << "  </compound>" << endl;

  }

  if (Config_getBool("SEPARATE_MEMBER_PAGES"))

  {

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

    if (allMemberList) allMemberList->sort();

    writeMemberPages(ol);

  }

}

void NamespaceDef::writeMemberPages(OutputList &ol)

{

  ol.pushGeneratorState();