#include <md5.h>

#include "dirdef.h"

#include "filename.h"

#include "doxygen.h"

#include "util.h"

#include "outputlist.h"

#include "language.h"

#include "message.h"

#include "dot.h"

#include "layout.h"

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

// method implementation

static int g_dirCount=0;

DirDef::DirDef(const char *path) : Definition(path,1,path)

{

  // get display name (stipping the paths mentioned in STRIP_FROM_PATH)

  m_dispName = stripFromPath(path);

  // get short name (last part of path)

  m_shortName = path;

  if (m_shortName.at(m_shortName.length()-1)=='/')

  { // strip trailing /

    m_shortName = m_shortName.left(m_shortName.length()-1);

  }

  int pi=m_shortName.findRev('/');

  if (pi!=-1) 

  { // remove everything till the last /

    m_shortName = m_shortName.mid(pi+1);

  }

  setLocalName(m_shortName);

  m_fileList   = new FileList;

  m_usedDirs   = new QDict<UsedDir>(257);

  m_usedDirs->setAutoDelete(TRUE);

  m_dirCount   = g_dirCount++;

  m_level=-1;

  m_parent=0;

}

DirDef::~DirDef()

{

  delete m_fileList;

  delete m_usedDirs;

}

bool DirDef::isLinkableInProject() const 

{ 

  return !isReference() && Config_getBool("SHOW_DIRECTORIES"); 

}

bool DirDef::isLinkable() const 

{ 

  return isReference() || isLinkableInProject(); 

}

void DirDef::addSubDir(DirDef *subdir)

{

  m_subdirs.inSort(subdir);

  subdir->setOuterScope(this);

  subdir->m_parent=this;

}

void DirDef::addFile(FileDef *fd)

{

  m_fileList->inSort(fd);

  fd->setDirDef(this);

}

static QCString encodeDirName(const QCString &anchor)

{

  QCString result;

  // convert to md5 hash

  uchar md5_sig[16];

  QCString sigStr(33);

  MD5Buffer((const unsigned char *)anchor.data(),anchor.length(),md5_sig);

  MD5SigToString(md5_sig,sigStr.data(),33);

  return sigStr;

  // old algorithm

//  int l = anchor.length(),i;

//  for (i=0;i<l;i++)

//  {

//    char c = anchor.at(i);

//    if ((c>='a' && c<='z') || (c>='A' && c<='Z') || (c>='0' && c<='9'))

//    {

//      result+=c;

//    }

//    else

//    {

//      static char hexStr[]="0123456789ABCDEF";

//      char escChar[]={ '_', 0, 0, 0 };

//      escChar[1]=hexStr[c>>4];

//      escChar[2]=hexStr[c&0xf];

//      result+=escChar;

//    }

//  }

//  return result;

}

QCString DirDef::getOutputFileBase() const

{

  return "dir_"+encodeDirName(name());

  //return QCString().sprintf("dir_%06d",m_dirCount);

}

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

    // repeat brief description

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

    {

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

    }

    // separator between brief and details

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

    }

    // write documentation

    if (!documentation().isEmpty())

    {

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

    }

  }

}

void DirDef::writeBriefDescription(OutputList &ol)

{

  if (!briefDescription().isEmpty()) 

  {

    ol.startParagraph();

    ol.parseDoc(briefFile(),briefLine(),this,0,briefDescription(),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.pushGeneratorState();

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

    //ol.newParagraph();

    //ol.popGeneratorState();

    ol.endParagraph();

  }

  ol.writeSynopsis();

}

void DirDef::writeDirectoryGraph(OutputList &ol)

{

  // write graph dependency graph

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

  {

    DotDirDeps dirDep(this);

    if (!dirDep.isTrivial())

    {

      msg("Generating dependency graph for directory %s\n",displayName().data());

      ol.disable(OutputGenerator::Man);

      ol.startParagraph();

      ol.startDirDepGraph();

      //TODO: ol.parseText(theTranslator->trDirDepGraph());

      ol.endDirDepGraph(dirDep);

      ol.endParagraph();

      ol.enableAll();

    }

  }

}

void DirDef::writeSubDirList(OutputList &ol)

{

  // write subdir list

  if (m_subdirs.count()>0)

  {

    ol.parseText(theTranslator->trDir(TRUE,FALSE));

    ol.endMemberHeader();

    ol.startMemberList();

    DirDef *dd=m_subdirs.first();

    while (dd)

    {

      ol.startMemberItem(0);

      ol.parseText(theTranslator->trDir(FALSE,TRUE)+" ");

      ol.insertMemberAlign();

      ol.writeObjectLink(dd->getReference(),dd->getOutputFileBase(),0,dd->shortName());

      ol.endMemberItem();

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

      {

        Doxygen::tagFile << "    <dir>" << convertToXML(dd->displayName()) << "</dir>" << endl;

      }

      if (!dd->briefDescription().isEmpty() && Config_getBool("BRIEF_MEMBER_DESC"))

      {

        ol.startParagraph();

        ol.startMemberDescription();

        ol.parseDoc(briefFile(),briefLine(),dd,0,dd->briefDescription(),

            FALSE, // indexWords

            FALSE, // isExample

            0,     // exampleName

            FALSE, // single line

            TRUE   // link from index

           );

        ol.endMemberDescription();

        ol.endParagraph();

      }

      dd=m_subdirs.next();

    }

    ol.endMemberList();

  }

}

void DirDef::writeFileList(OutputList &ol)

{

  // write file list

  if (m_fileList->count()>0)

  {

    ol.parseText(theTranslator->trFile(TRUE,FALSE));

    ol.endMemberHeader();

    ol.startMemberList();

    FileDef *fd=m_fileList->first();

    while (fd)

    {

      ol.startMemberItem(0);

      ol.docify(theTranslator->trFile(FALSE,TRUE)+" ");

      ol.insertMemberAlign();

      if (fd->isLinkable())

      {

        ol.writeObjectLink(fd->getReference(),fd->getOutputFileBase(),0,fd->name());

      }

      else

      {

        ol.startBold();

        ol.docify(fd->name()); 

        ol.endBold();

      }

      if (fd->generateSourceFile())

      {

        ol.pushGeneratorState();

        ol.disableAllBut(OutputGenerator::Html);

        ol.docify(" ");

        ol.startTextLink(fd->includeName(),0);

        ol.docify("[");

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

        ol.docify("]");

        ol.endTextLink();

        ol.popGeneratorState();

      }

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

      {

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

      }

      ol.endMemberItem();

      if (!fd->briefDescription().isEmpty() && Config_getBool("BRIEF_MEMBER_DESC"))

      {

        ol.startParagraph();

        ol.startMemberDescription();

        ol.parseDoc(briefFile(),briefLine(),fd,0,fd->briefDescription(),

            FALSE, // indexWords

            FALSE, // isExample

            0,     // exampleName

            FALSE, // single line

            TRUE   // link from index

           );

        ol.endMemberDescription();

        ol.endParagraph();

      }

      fd=m_fileList->next();

    }

    ol.endMemberList();

  }

}

void DirDef::startMemberDeclarations(OutputList &ol)

{

  ol.startMemberSections();

}

void DirDef::endMemberDeclarations(OutputList &ol)

{

  ol.endMemberSections();

}

void DirDef::writeDocumentation(OutputList &ol)

{

  ol.pushGeneratorState();

  QCString shortTitle=theTranslator->trDirReference(m_shortName);

  QCString title=theTranslator->trDirReference(m_dispName);

  startFile(ol,getOutputFileBase(),name(),title,HLI_None,TRUE);

  // write navigation path

  writeNavigationPath(ol);

  ol.endQuickIndices();

  startTitle(ol,getOutputFileBase());

  ol.pushGeneratorState();

    ol.disableAllBut(OutputGenerator::Html);

    ol.parseText(shortTitle);

    ol.enableAll();

    ol.disable(OutputGenerator::Html);

    ol.parseText(title);

  ol.popGeneratorState();

  endTitle(ol,getOutputFileBase(),title);

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

  {

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

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

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

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

  }

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

  QListIterator<LayoutDocEntry> eli(

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

  LayoutDocEntry *lde;

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

  {

    switch (lde->kind())

    {

      case LayoutDocEntry::BriefDesc: 

        writeBriefDescription(ol);

        break; 

      case LayoutDocEntry::DirGraph: 

        writeDirectoryGraph(ol);

        break; 

      case LayoutDocEntry::MemberDeclStart: 

        startMemberDeclarations(ol);

        break; 

      case LayoutDocEntry::DirSubDirs: 

        writeSubDirList(ol);

        break; 

      case LayoutDocEntry::DirFiles: 

        writeFileList(ol);

        break; 

      case LayoutDocEntry::MemberDeclEnd: 

        endMemberDeclarations(ol);

        break;

      case LayoutDocEntry::DetailedDesc: 

        {

          LayoutDocEntrySection *ls = (LayoutDocEntrySection*)lde;

          writeDetailedDescription(ol,ls->title);

        }

        break;

      case LayoutDocEntry::ClassIncludes:

      case LayoutDocEntry::ClassInheritanceGraph:

      case LayoutDocEntry::ClassNestedClasses:

      case LayoutDocEntry::ClassCollaborationGraph:

      case LayoutDocEntry::ClassAllMembersLink:

      case LayoutDocEntry::ClassUsedFiles:

      case LayoutDocEntry::NamespaceNestedNamespaces:

      case LayoutDocEntry::NamespaceClasses:

      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::AuthorSection:

      case LayoutDocEntry::MemberGroups:

      case LayoutDocEntry::MemberDecl:

      case LayoutDocEntry::MemberDef:

      case LayoutDocEntry::MemberDefStart:

      case LayoutDocEntry::MemberDefEnd:

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

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

        break;

    }

  }

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

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

  {

    writeDocAnchorsToTagFile();

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

  }

  endFile(ol); 

  ol.popGeneratorState();

}

#if 0

void DirDef::writePathFragment(OutputList &ol) const

{

  if (m_parent)

  {

    m_parent->writePathFragment(ol);

    ol.writeString(" / ");

  }

  ol.writeObjectLink(getReference(),getOutputFileBase(),0,shortName());

}

void DirDef::writeNavigationPath(OutputList &ol)

{

  ol.pushGeneratorState();

  ol.disableAllBut(OutputGenerator::Html);

  ol.writeString("<div class=\"nav\">\n");

  writePathFragment(ol);

  ol.writeString("</div>\n");

  ol.popGeneratorState();

}

#endif

void DirDef::setLevel()

{

  if (m_level==-1) // level not set before

  {

    DirDef *p = parent();

    if (p)

    {

      p->setLevel();

      m_level = p->level()+1;

    }

    else

    {

      m_level = 0;

    }

  }

}

/** Add as "uses" dependency between \a this dir and \a dir,

 *  that was caused by a dependency on file \a fd.

 */ 

void DirDef::addUsesDependency(DirDef *dir,FileDef *srcFd,

                               FileDef *dstFd,bool inherited)

{

  if (this==dir) return; // do not add self-dependencies

  //static int count=0;

  //printf("  %d add dependency %s->%s due to %s->%s\n",

  //    count++,shortName().data(),

  //    dir->shortName().data(),

  //    srcFd->name().data(),

  //    dstFd->name().data());

  // levels match => add direct dependency

  bool added=FALSE;

  UsedDir *usedDir = m_usedDirs->find(dir->getOutputFileBase());

  if (usedDir) // dir dependency already present

  {

     FilePair *usedPair = usedDir->findFilePair(

         srcFd->getOutputFileBase()+dstFd->getOutputFileBase());

     if (usedPair==0) // new file dependency

     {

       //printf("  => new file\n");

       usedDir->addFileDep(srcFd,dstFd); 

       added=TRUE;

     }

     else

     {

       // dir & file dependency already added

     }

  }

  else // new directory dependency

  {

    //printf("  => new file\n");

    usedDir = new UsedDir(dir,inherited);

    usedDir->addFileDep(srcFd,dstFd); 

    m_usedDirs->insert(dir->getOutputFileBase(),usedDir);

    added=TRUE;

  }

  if (added)

  {

    if (dir->parent())

    {

      // add relation to parent of used dir

      addUsesDependency(dir->parent(),srcFd,dstFd,inherited);

    }

    if (parent())

    {

      // add relation for the parent of this dir as well

      parent()->addUsesDependency(dir,srcFd,dstFd,TRUE);

    }

  }

}

/** Computes the dependencies between directories

 */

void DirDef::computeDependencies()