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

 *

 * 

 *

 *

 * Copyright (C) 1997-2015 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 <qfileinfo.h> 

#include "xmldocvisitor.h"

#include "docparser.h"

#include "language.h"

#include "doxygen.h"

#include "outputgen.h"

#include "xmlgen.h"

#include "dot.h"

#include "message.h"

#include "util.h"

#include "parserintf.h"

#include "filename.h"

#include "config.h"

#include "htmlentity.h"

static void visitCaption(XmlDocVisitor *parent, QList<DocNode> children)

{

  QListIterator<DocNode> cli(children);

  DocNode *n;

  for (cli.toFirst();(n=cli.current());++cli) n->accept(parent);

}

static void visitPreStart(FTextStream &t, const char *cmd, const bool doCaption, 

                          XmlDocVisitor *parent, QList<DocNode> children, 

                          const QCString &name, bool writeType, DocImage::Type type, const QCString &width, 

                          const QCString &height)

{

  t << "<" << cmd;

  if (writeType)

  {

    t << " type=\"";

    switch(type)

    {

      case DocImage::Html:    t << "html"; break;

      case DocImage::Latex:   t << "latex"; break;

      case DocImage::Rtf:     t << "rtf"; break;

      case DocImage::DocBook: t << "docbook"; break;

    }

    t << "\"";

  }

  if (!name.isEmpty())

  {

    t << " name=\"" << name << "\"";

  }

  if (!width.isEmpty())

  {

    t << " width=\"" << convertToXML(width) << "\"";

  }

  else if (!height.isEmpty())

  {

    t << " height=\"" << convertToXML(height) << "\"";

  }

  if (doCaption)

  {

    t << " caption=\"";

    visitCaption(parent, children);

    t << "\"";

  }

  t << ">";

}

static void visitPostEnd(FTextStream &t, const char *cmd)

{

  t << "</" << cmd << ">" << endl;

}

XmlDocVisitor::XmlDocVisitor(FTextStream &t,CodeOutputInterface &ci) 

  : DocVisitor(DocVisitor_XML), m_t(t), m_ci(ci), m_insidePre(FALSE), m_hide(FALSE) 

{

}

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

  // visitor functions for leaf nodes

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

void XmlDocVisitor::visit(DocWord *w)

{

  if (m_hide) return;

  filter(w->word());

}

void XmlDocVisitor::visit(DocLinkedWord *w)

{

  if (m_hide) return;

  startLink(w->ref(),w->file(),w->anchor());

  filter(w->word());

  endLink();

}

void XmlDocVisitor::visit(DocWhiteSpace *w)

{

  if (m_hide) return;

  if (m_insidePre)

  {

    m_t << w->chars();

  }

  else

  {

    m_t << " ";

  }

}

void XmlDocVisitor::visit(DocSymbol *s)

{

  if (m_hide) return;

  const char *res = HtmlEntityMapper::instance()->xml(s->symbol());

  if (res)

  {

    m_t << res;

  }

  else

  {

    err("XML: non supported HTML-entity found: %s\n",HtmlEntityMapper::instance()->html(s->symbol(),TRUE));

  }

}

void XmlDocVisitor::visit(DocURL *u)

{

  if (m_hide) return;

  m_t << "

  if (u->isEmail()) m_t << "mailto:";

  filter(u->url());

  m_t << "\">";

  filter(u->url());

  m_t << "</ulink>";

}

void XmlDocVisitor::visit(DocLineBreak *)

{

  if (m_hide) return;

  m_t << "<linebreak/>\n";

}

void XmlDocVisitor::visit(DocHorRuler *)

{

  if (m_hide) return;

  m_t << "<hruler/>\n";

}

void XmlDocVisitor::visit(DocStyleChange *s)

{

  if (m_hide) return;

  switch (s->style())

  {

    case DocStyleChange::Bold:

      if (s->enable()) m_t << "<bold>";      else m_t << "</bold>";

      break;

    case DocStyleChange::Italic:

      if (s->enable()) m_t << "<emphasis>";     else m_t << "</emphasis>";

      break;

    case DocStyleChange::Code:

      if (s->enable()) m_t << "<computeroutput>";   else m_t << "</computeroutput>";

      break;

    case DocStyleChange::Subscript:

      if (s->enable()) m_t << "<subscript>";    else m_t << "</subscript>";

      break;

    case DocStyleChange::Superscript:

      if (s->enable()) m_t << "<superscript>";    else m_t << "</superscript>";

      break;

    case DocStyleChange::Center:

      if (s->enable()) m_t << "<center>"; else m_t << "</center>";

      break;

    case DocStyleChange::Small:

      if (s->enable()) m_t << "<small>";  else m_t << "</small>";

      break;

    case DocStyleChange::Preformatted:

      if (s->enable()) 

      {

        m_t << "<preformatted>";  

        m_insidePre=TRUE;

      }

      else 

      {

        m_t << "</preformatted>";

        m_insidePre=FALSE;

      }

      break;

    case DocStyleChange::Div:  /* HTML only */ break;

    case DocStyleChange::Span: /* HTML only */ break;

  }

}

void XmlDocVisitor::visit(DocVerbatim *s)

{

  if (m_hide) return;

  QCString lang = m_langExt;

  if (!s->language().isEmpty()) // explicit language setting

  {

    lang = s->language();

  }

  SrcLangExt langExt = getLanguageFromFileName(lang);

  switch(s->type())

  {

    case DocVerbatim::Code: // fall though

      m_t << "

      if (!s->language().isEmpty())

          m_t << " filename=\"" << lang << "\">";

      else

          m_t << ">";

      Doxygen::parserManager->getParser(lang)

                            ->parseCode(m_ci,s->context(),s->text(),langExt,

                                        s->isExample(),s->exampleFile());

      m_t << "</programlisting>"; 

      break;

    case DocVerbatim::Verbatim: 

      m_t << "<verbatim>";

      filter(s->text());

      m_t << "</verbatim>"; 

      break;

    case DocVerbatim::HtmlOnly: 

    case DocVerbatim::RtfOnly: 

    case DocVerbatim::ManOnly: 

    case DocVerbatim::LatexOnly: 

    case DocVerbatim::DocbookOnly:

      /* nothing */ 

      break;

    case DocVerbatim::XmlOnly: 

      m_t << s->text();

      break;

    case DocVerbatim::Dot:

      visitPreStart(m_t, "dot", s->hasCaption(), this, s->children(), QCString(""), FALSE, DocImage::Html, s->width(), s->height());

      filter(s->text());

      visitPostEnd(m_t, "dot");

      break;

    case DocVerbatim::Msc:

      visitPreStart(m_t, "msc", s->hasCaption(), this, s->children(),  QCString(""), FALSE, DocImage::Html, s->width(), s->height());

      filter(s->text());

      visitPostEnd(m_t, "msc");

      break;

    case DocVerbatim::PlantUML:

      visitPreStart(m_t, "plantuml", s->hasCaption(), this, s->children(),  QCString(""), FALSE, DocImage::Html, s->width(), s->height());

      filter(s->text());

      visitPostEnd(m_t, "plantuml");

      break;

  }

}

void XmlDocVisitor::visit(DocAnchor *anc)

{

  if (m_hide) return;

  m_t << "<anchor id=\"" << anc->file() << "_1" << anc->anchor() << "\"/>";

}

void XmlDocVisitor::visit(DocInclude *inc)

{

  if (m_hide) return;

  SrcLangExt langExt = getLanguageFromFileName(inc->extension());

  switch(inc->type())

  {

    case DocInclude::IncWithLines:

      { 

         m_t << "<programlisting filename=\"" << inc->file() << "\">";

         QFileInfo cfi( inc->file() );

         FileDef fd( cfi.dirPath().utf8(), cfi.fileName().utf8() );

         Doxygen::parserManager->getParser(inc->extension())

                               ->parseCode(m_ci,inc->context(),

                                           inc->text(),

                                           langExt,

                                           inc->isExample(),

                                           inc->exampleFile(),

                                           &fd,   // fileDef,

                                           -1,    // start line

                                           -1,    // end line

                                           FALSE, // inline fragment

                                           0,     // memberDef

                                           TRUE   // show line numbers

					   );

         m_t << "</programlisting>"; 

      }

      break;    

    case DocInclude::Include: 

      m_t << "<programlisting filename=\"" << inc->file() << "\">";

      Doxygen::parserManager->getParser(inc->extension())

                            ->parseCode(m_ci,inc->context(),

                                        inc->text(),

                                        langExt,

                                        inc->isExample(),

                                        inc->exampleFile(),

                                        0,     // fileDef

                                        -1,    // startLine

                                        -1,    // endLine

                                        TRUE,  // inlineFragment

                                        0,     // memberDef

                                        FALSE  // show line numbers

				       );

      m_t << "</programlisting>"; 

      break;

    case DocInclude::DontInclude: 

      break;

    case DocInclude::HtmlInclude: 

      m_t << "<htmlonly>";

      filter(inc->text());

      m_t << "</htmlonly>";

      break;

    case DocInclude::LatexInclude:

      m_t << "<latexonly>";

      filter(inc->text());

      m_t << "</latexonly>";

      break;

    case DocInclude::VerbInclude: 

      m_t << "<verbatim>";

      filter(inc->text());

      m_t << "</verbatim>"; 

      break;

    case DocInclude::Snippet:

      m_t << "<programlisting filename=\"" << inc->file() << "\">";

      Doxygen::parserManager->getParser(inc->extension())

                            ->parseCode(m_ci,

                                        inc->context(),

                                        extractBlock(inc->text(),inc->blockId()),

                                        langExt,

                                        inc->isExample(),

                                        inc->exampleFile()

                                       );

      m_t << "</programlisting>"; 

      break;

    case DocInclude::SnipWithLines:

      {

         m_t << "<programlisting filename=\"" << inc->file() << "\">";

         QFileInfo cfi( inc->file() );

         FileDef fd( cfi.dirPath().utf8(), cfi.fileName().utf8() );

         Doxygen::parserManager->getParser(inc->extension())

                               ->parseCode(m_ci,

                                           inc->context(),

                                           extractBlock(inc->text(),inc->blockId()),

                                           langExt,

                                           inc->isExample(),

                                           inc->exampleFile(), 

                                           &fd,

                                           lineBlock(inc->text(),inc->blockId()),

                                           -1,    // endLine

                                           FALSE, // inlineFragment

                                           0,     // memberDef

                                           TRUE   // show line number

                                          );

         m_t << "</programlisting>"; 

      }

      break;

    case DocInclude::SnippetDoc: 

    case DocInclude::IncludeDoc: 

      err("Internal inconsistency: found switch SnippetDoc / IncludeDoc in file: %s"

          "Please create a bug report\n",__FILE__);

      break;

  }

}

void XmlDocVisitor::visit(DocIncOperator *op)

{

  //printf("DocIncOperator: type=%d first=%d, last=%d text=`%s'\n",

  //    op->type(),op->isFirst(),op->isLast(),op->text().data());

  if (op->isFirst()) 

  {

    if (!m_hide)

    {

      m_t << "<programlisting filename=\"" << op->includeFileName() << "\">";

    }

    pushEnabled();

    m_hide = TRUE;

  }

  SrcLangExt langExt = getLanguageFromFileName(m_langExt);

  if (op->type()!=DocIncOperator::Skip) 

  {

    popEnabled();

    if (!m_hide) 

    {

      Doxygen::parserManager->getParser(m_langExt)

                            ->parseCode(m_ci,op->context(),

                                        op->text(),langExt,op->isExample(),

                                        op->exampleFile());

    }

    pushEnabled();

    m_hide=TRUE;

  }

  if (op->isLast())  

  {

    popEnabled();

    if (!m_hide) m_t << "</programlisting>"; 

  }

  else

  {

    if (!m_hide) m_t << endl;

  }

}

void XmlDocVisitor::visit(DocFormula *f)

{

  if (m_hide) return;

  m_t << "<formula id=\"" << f->id() << "\">";

  filter(f->text());

  m_t << "</formula>";

}

void XmlDocVisitor::visit(DocIndexEntry *ie)

{

  if (m_hide) return;

  m_t << "<indexentry>"

           "<primaryie>";

  filter(ie->entry());

  m_t << "</primaryie>"

           "<secondaryie></secondaryie>"

         "</indexentry>";

}

void XmlDocVisitor::visit(DocSimpleSectSep *sep)

{

  if (sep->parent() && sep->parent()->kind()==DocNode::Kind_SimpleSect)

  {

    visitPost((DocSimpleSect*)sep->parent()); // end current section

    visitPre((DocSimpleSect*)sep->parent());  // start new section

  }

}

void XmlDocVisitor::visit(DocCite *cite)

{

  if (m_hide) return;

  if (!cite->file().isEmpty()) startLink(cite->ref(),cite->file(),cite->anchor());

  filter(cite->text());

  if (!cite->file().isEmpty()) endLink();

}

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

// visitor functions for compound nodes

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

void XmlDocVisitor::visitPre(DocAutoList *l)

{

  if (m_hide) return;

  if (l->isEnumList())

  {

    m_t << "<orderedlist>\n";

  }

  else

  {

    m_t << "<itemizedlist>\n";

  }

}

void XmlDocVisitor::visitPost(DocAutoList *l)

{

  if (m_hide) return;

  if (l->isEnumList())

  {

    m_t << "</orderedlist>\n";

  }

  else

  {

    m_t << "</itemizedlist>\n";

  }

}

void XmlDocVisitor::visitPre(DocAutoListItem *)

{

  if (m_hide) return;

  m_t << "<listitem>";

}

void XmlDocVisitor::visitPost(DocAutoListItem *) 

{

  if (m_hide) return;

  m_t << "</listitem>";

}

void XmlDocVisitor::visitPre(DocPara *) 

{

  if (m_hide) return;

  m_t << "<para>";

}

void XmlDocVisitor::visitPost(DocPara *)

{

  if (m_hide) return;

  m_t << "</para>";

}

void XmlDocVisitor::visitPre(DocRoot *)

{

  //m_t << "
<font color=\"red\">New parser:</font>
\n";

}

void XmlDocVisitor::visitPost(DocRoot *)

{

  //m_t << "
<font color=\"red\">Old parser:</font>
\n";

}

void XmlDocVisitor::visitPre(DocSimpleSect *s)

{

  if (m_hide) return;

  m_t << "

  switch(s->type())

  {

    case DocSimpleSect::See: 

      m_t << "see"; break;

    case DocSimpleSect::Return: 

      m_t << "return"; break;

    case DocSimpleSect::Author: 

      m_t << "author"; break;

    case DocSimpleSect::Authors: 

      m_t << "authors"; break;

    case DocSimpleSect::Version: 

      m_t << "version"; break;

    case DocSimpleSect::Since: 

      m_t << "since"; break;

    case DocSimpleSect::Date: 

      m_t << "date"; break;

    case DocSimpleSect::Note: 

      m_t << "note"; break;

    case DocSimpleSect::Warning:

      m_t << "warning"; break;

    case DocSimpleSect::Pre:

      m_t << "pre"; break;

    case DocSimpleSect::Post:

      m_t << "post"; break;

    case DocSimpleSect::Copyright:

      m_t << "copyright"; break;

    case DocSimpleSect::Invar:

      m_t << "invariant"; break;

    case DocSimpleSect::Remark:

      m_t << "remark"; break;

    case DocSimpleSect::Attention:

      m_t << "attention"; break;

    case DocSimpleSect::User: 

      m_t << "par"; break;

    case DocSimpleSect::Rcs: 

      m_t << "rcs"; break;

    case DocSimpleSect::Unknown:  break;

  }

  m_t << "\">";

}

void XmlDocVisitor::visitPost(DocSimpleSect *)

{

  if (m_hide) return;

  m_t << "</simplesect>\n";

}

void XmlDocVisitor::visitPre(DocTitle *)

{

  if (m_hide) return;

  m_t << "<title>";

}

void XmlDocVisitor::visitPost(DocTitle *)

{

  if (m_hide) return;

  m_t << "</title>";

}

void XmlDocVisitor::visitPre(DocSimpleList *)

{

  if (m_hide) return;

  m_t << "<itemizedlist>\n";

}

void XmlDocVisitor::visitPost(DocSimpleList *)

{

  if (m_hide) return;

  m_t << "</itemizedlist>\n";

}

void XmlDocVisitor::visitPre(DocSimpleListItem *)

{

  if (m_hide) return;

  m_t << "<listitem>";

}

void XmlDocVisitor::visitPost(DocSimpleListItem *) 

{

  if (m_hide) return;

  m_t << "</listitem>\n";

}

void XmlDocVisitor::visitPre(DocSection *s)

{

  if (m_hide) return;

  m_t << "<sect" << s->level() << " id=\"" << s->file();

  if (!s->anchor().isEmpty()) m_t << "_1" << s->anchor();

  m_t << "\">" << endl;

  m_t << "<title>";

  filter(convertCharEntitiesToUTF8(s->title()));

  m_t << "</title>" << endl;

}

void XmlDocVisitor::visitPost(DocSection *s) 

{

  m_t << "</sect" << s->level() << ">\n";

}

void XmlDocVisitor::visitPre(DocHtmlList *s)

{

  if (m_hide) return;

  if (s->type()==DocHtmlList::Ordered) 

    m_t << "<orderedlist>\n"; 

  else 

    m_t << "<itemizedlist>\n";

}

void XmlDocVisitor::visitPost(DocHtmlList *s) 

{

  if (m_hide) return;

  if (s->type()==DocHtmlList::Ordered) 

    m_t << "</orderedlist>\n"; 

  else 

    m_t << "</itemizedlist>\n";

}

void XmlDocVisitor::visitPre(DocHtmlListItem *)

{

  if (m_hide) return;

  m_t << "<listitem>\n";

}

void XmlDocVisitor::visitPost(DocHtmlListItem *) 

{

  if (m_hide) return;

  m_t << "</listitem>\n";

}

void XmlDocVisitor::visitPre(DocHtmlDescList *)

{

  if (m_hide) return;

  m_t << "<variablelist>\n";

}

void XmlDocVisitor::visitPost(DocHtmlDescList *) 

{

  if (m_hide) return;

  m_t << "</variablelist>\n";

}

void XmlDocVisitor::visitPre(DocHtmlDescTitle *)

{

  if (m_hide) return;

  m_t << "<varlistentry><term>";

}

void XmlDocVisitor::visitPost(DocHtmlDescTitle *) 

{

  if (m_hide) return;

  m_t << "</term></varlistentry>\n";

}

void XmlDocVisitor::visitPre(DocHtmlDescData *)

{

  if (m_hide) return;

  m_t << "<listitem>";

}

void XmlDocVisitor::visitPost(DocHtmlDescData *) 

{

  if (m_hide) return;

  m_t << "</listitem>\n";

}

void XmlDocVisitor::visitPre(DocHtmlTable *t)

{

  if (m_hide) return;

  m_t << "numRows() 

      << "\" cols=\"" << t->numColumns() << "\">" ;

}

void XmlDocVisitor::visitPost(DocHtmlTable *) 

{

  if (m_hide) return;

  m_t << "\n";

}

void XmlDocVisitor::visitPre(DocHtmlRow *)

{

  if (m_hide) return;

  m_t << "<row>\n";

}

void XmlDocVisitor::visitPost(DocHtmlRow *) 

{

  if (m_hide) return;

  m_t << "</row>\n";

}

void XmlDocVisitor::visitPre(DocHtmlCell *c)

{

  if (m_hide) return;

  if (c->isHeading()) m_t << "<entry thead=\"yes\">"; else m_t << "<entry thead=\"no\">";

}

void XmlDocVisitor::visitPost(DocHtmlCell *) 

{

  if (m_hide) return;

  m_t << "</entry>"; 

}

void XmlDocVisitor::visitPre(DocHtmlCaption *)

{

  if (m_hide) return;

  m_t << "<caption>";

}

void XmlDocVisitor::visitPost(DocHtmlCaption *) 

{

  if (m_hide) return;

  m_t << "</caption>\n";

}

void XmlDocVisitor::visitPre(DocInternal *)

{

  if (m_hide) return;

  m_t << "<internal>";

}

void XmlDocVisitor::visitPost(DocInternal *) 

{

  if (m_hide) return;

  m_t << "</internal>" << endl;

}

void XmlDocVisitor::visitPre(DocHRef *href)

{

  if (m_hide) return;

  m_t << "

  filter(href->url());

  m_t << "\">";

}

void XmlDocVisitor::visitPost(DocHRef *) 

{

  if (m_hide) return;

  m_t << "</ulink>";

}

void XmlDocVisitor::visitPre(DocHtmlHeader *header)

{

  if (m_hide) return;

  m_t << "<heading level=\"" << header->level() << "\">";

}

void XmlDocVisitor::visitPost(DocHtmlHeader *) 

{

  if (m_hide) return;

  m_t << "</heading>\n";

}

void XmlDocVisitor::visitPre(DocImage *img)

{

  if (m_hide) return;

  QCString baseName=img->name();

  int i;

  if ((i=baseName.findRev('/'))!=-1 || (i=baseName.findRev('\\'))!=-1)

  {

    baseName=baseName.right(baseName.length()-i-1);

  }

  visitPreStart(m_t, "image", FALSE, this, img->children(), baseName, TRUE, img->type(), img->width(), img->height());

  // copy the image to the output dir

  FileDef *fd;

  bool ambig;

  if ((fd=findFileDef(Doxygen::imageNameDict,img->name(),ambig)))

  {

    QFile inImage(fd->absFilePath());

    QFile outImage(Config_getString(XML_OUTPUT)+"/"+baseName.data());

    if (inImage.open(IO_ReadOnly))

    {

      if (outImage.open(IO_WriteOnly))

      {

        char *buffer = new char[inImage.size()];

        inImage.readBlock(buffer,inImage.size());

        outImage.writeBlock(buffer,inImage.size());

        outImage.flush();

        delete[] buffer;

      }

    }

  }

}

void XmlDocVisitor::visitPost(DocImage *) 

{

  if (m_hide) return;

  visitPostEnd(m_t, "image");

}

void XmlDocVisitor::visitPre(DocDotFile *df)

{

  if (m_hide) return;

  visitPreStart(m_t, "dotfile", FALSE, this, df->children(), df->file(), FALSE, DocImage::Html, df->width(), df->height());

}

void XmlDocVisitor::visitPost(DocDotFile *) 

{

  if (m_hide) return;

  visitPostEnd(m_t, "dotfile");

}

void XmlDocVisitor::visitPre(DocMscFile *df)

{

  if (m_hide) return;

  visitPreStart(m_t, "mscfile", FALSE, this, df->children(), df->file(), FALSE, DocImage::Html, df->width(), df->height());

}

void XmlDocVisitor::visitPost(DocMscFile *) 

{

  if (m_hide) return;

  visitPostEnd(m_t, "mscfile");

}

void XmlDocVisitor::visitPre(DocDiaFile *df)

{

  if (m_hide) return;

  visitPreStart(m_t, "diafile", FALSE, this, df->children(), df->file(), FALSE, DocImage::Html, df->width(), df->height());

}

void XmlDocVisitor::visitPost(DocDiaFile *)

{

  if (m_hide) return;

  visitPostEnd(m_t, "diafile");

}

void XmlDocVisitor::visitPre(DocLink *lnk)

{

  if (m_hide) return;

  startLink(lnk->ref(),lnk->file(),lnk->anchor());

}

void XmlDocVisitor::visitPost(DocLink *) 

{

  if (m_hide) return;

  endLink();

}

void XmlDocVisitor::visitPre(DocRef *ref)

{

  if (m_hide) return;

  if (!ref->file().isEmpty()) 

  {

    startLink(ref->ref(),ref->file(),ref->isSubPage() ? QCString() : ref->anchor());

  }

  if (!ref->hasLinkText()) filter(ref->targetTitle());

}

void XmlDocVisitor::visitPost(DocRef *ref) 

{

  if (m_hide) return;

  if (!ref->file().isEmpty()) endLink();

  //m_t << " ";

}

void XmlDocVisitor::visitPre(DocSecRefItem *ref)

{

  if (m_hide) return;

  m_t << "<tocitem id=\"" << ref->file() << "_1" << ref->anchor() << "\">";

}

void XmlDocVisitor::visitPost(DocSecRefItem *) 

{

  if (m_hide) return;

  m_t << "</tocitem>" << endl;

}

void XmlDocVisitor::visitPre(DocSecRefList *)

{

  if (m_hide) return;

  m_t << "<toclist>" << endl;