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

 *

 * 

 *

 *

 * 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 <qdir.h>

#include "htmldocvisitor.h"

#include "docparser.h"

#include "language.h"

#include "doxygen.h"

#include "outputgen.h"

#include "dot.h"

#include "message.h"

#include "config.h"

#include "htmlgen.h"

#include "parserintf.h"

#include "msc.h"

#include "dia.h"

#include "util.h"

#include "vhdldocgen.h"

#include "filedef.h"

#include "memberdef.h"

#include "htmlentity.h"

#include "plantuml.h"

static const int NUM_HTML_LIST_TYPES = 4;

static const char types[][NUM_HTML_LIST_TYPES] = {"1", "a", "i", "A"};

static QCString convertIndexWordToAnchor(const QString &word)

{

  static char hex[] = "0123456789abcdef";

  QCString result="a";

  const char *str = word.data();

  unsigned char c;

  if (str)

  {

    while ((c = *str++))

    {

      if ((c >= 'a' && c <= 'z') || // ALPHA

          (c >= 'A' && c <= 'Z') || // ALPHA

          (c >= '0' && c <= '9') || // DIGIT

          c == '-' ||

          c == '.' ||

          c == '_'

         )

      {

        result += c;

      }

      else

      {

        char enc[4];

        enc[0] = ':';

        enc[1] = hex[(c & 0xf0) >> 4];

        enc[2] = hex[c & 0xf];

        enc[3] = 0;

        result += enc;

      }

    }

  }

  return result;

}

static bool mustBeOutsideParagraph(DocNode *n)

{

  switch (n->kind())

  {

          /* 
 */

        case DocNode::Kind_HtmlList:

        case DocNode::Kind_SimpleList:

        case DocNode::Kind_AutoList:

          /* 
 */

        case DocNode::Kind_SimpleSect:

        case DocNode::Kind_ParamSect:

        case DocNode::Kind_HtmlDescList:

        case DocNode::Kind_XRefItem:

          /*  */

        case DocNode::Kind_HtmlTable:

          /* <h?> */

        case DocNode::Kind_Section:

        case DocNode::Kind_HtmlHeader:

          /* \internal */

        case DocNode::Kind_Internal:

          /* 
 */

        case DocNode::Kind_Include:

        case DocNode::Kind_Image:

        case DocNode::Kind_SecRefList:

          /* 
 */

        case DocNode::Kind_HorRuler:

          /* CopyDoc gets paragraph markers from the wrapping DocPara node,

           * but needs to insert them for all documentation being copied to

           * preserve formatting.

           */

        case DocNode::Kind_Copy:

          /* 
 */

        case DocNode::Kind_HtmlBlockQuote:

          /* \parblock */

        case DocNode::Kind_ParBlock:

          return TRUE;

        case DocNode::Kind_Verbatim:

          {

            DocVerbatim *dv = (DocVerbatim*)n;

            return dv->type()!=DocVerbatim::HtmlOnly || dv->isBlock();

          }

        case DocNode::Kind_StyleChange:

          return ((DocStyleChange*)n)->style()==DocStyleChange::Preformatted ||

                 ((DocStyleChange*)n)->style()==DocStyleChange::Div ||

                 ((DocStyleChange*)n)->style()==DocStyleChange::Center;

        case DocNode::Kind_Formula:

          return !((DocFormula*)n)->isInline();

        default:

          break;

  }

  return FALSE;

}

static QString htmlAttribsToString(const HtmlAttribList &attribs)

{

  QString result;

  HtmlAttribListIterator li(attribs);

  HtmlAttrib *att;

  for (li.toFirst();(att=li.current());++li)

  {

    if (!att->value.isEmpty())  // ignore attribute without values as they

                                // are not XHTML compliant

    {

      result+=" ";

      result+=att->name;

      result+="=\""+convertToXML(att->value)+"\"";

    }

  }

  return result;

}

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

HtmlDocVisitor::HtmlDocVisitor(FTextStream &t,CodeOutputInterface &ci,

                               Definition *ctx) 

  : DocVisitor(DocVisitor_Html), m_t(t), m_ci(ci), m_insidePre(FALSE), 

                                 m_hide(FALSE), m_ctx(ctx)

{

  if (ctx) m_langExt=ctx->getDefFileExtension();

}

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

  // visitor functions for leaf nodes

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

void HtmlDocVisitor::visit(DocWord *w)

{

  //printf("word: %s\n",w->word().data());

  if (m_hide) return;

  filter(w->word());

}

void HtmlDocVisitor::visit(DocLinkedWord *w)

{

  if (m_hide) return;

  //printf("linked word: %s\n",w->word().data());

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

  filter(w->word());

  endLink();

}

void HtmlDocVisitor::visit(DocWhiteSpace *w)

{

  if (m_hide) return;

  if (m_insidePre)

  {

    m_t << w->chars();

  }

  else

  {

    m_t << " ";

  }

}

void HtmlDocVisitor::visit(DocSymbol *s)

{

  if (m_hide) return;

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

  if (res)

  {

    m_t << res;

  }

  else

  {

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

  }

}

void HtmlDocVisitor::writeObfuscatedMailAddress(const QCString &url)

{

  m_t << "

  uint i;

  int size=3;

  for (i=0;i

  {

    m_t << "+'" << url.mid(i,size) << "'";

    i+=size;

    if (size==3) size=2; else size=3;

  }

  m_t << "; return false;\">";

}

void HtmlDocVisitor::visit(DocURL *u)

{

  if (m_hide) return;

  if (u->isEmail()) // mail address

  {

    QCString url = u->url();

    writeObfuscatedMailAddress(url);

    uint size=5,i;

    for (i=0;i

    {

      filter(url.mid(i,size));

      if (i<url.length()-size) m_t << "<span style=\"display: none;\">.nosp@m.";

      i+=size;

      if (size==5) size=4; else size=5;

    }

    m_t << "";

  }

  else // web address

  {

    m_t << "

    m_t << u->url() << "\">";

    filter(u->url());

    m_t << "";

  }

}

void HtmlDocVisitor::visit(DocLineBreak *)

{

  if (m_hide) return;

  m_t << "
\n";

}

void HtmlDocVisitor::visit(DocHorRuler *hr)

{

  if (m_hide) return;

  forceEndParagraph(hr);

  m_t << "
\n";

  forceStartParagraph(hr);

}

void HtmlDocVisitor::visit(DocStyleChange *s)

{

  if (m_hide) return;

  switch (s->style())

  {

    case DocStyleChange::Bold:

      if (s->enable()) m_t << "<b" << htmlAttribsToString(s->attribs()) << ">";      else m_t << "";

      break;

    case DocStyleChange::Italic:

      if (s->enable()) m_t << "<em" << htmlAttribsToString(s->attribs()) << ">";     else m_t << "";

      break;

    case DocStyleChange::Code:

      if (s->enable()) m_t << "<code" << htmlAttribsToString(s->attribs()) << ">";   else m_t << "";

      break;

    case DocStyleChange::Subscript:

      if (s->enable()) m_t << "<sub" << htmlAttribsToString(s->attribs()) << ">";    else m_t << "</sub>";

      break;

    case DocStyleChange::Superscript:

      if (s->enable()) m_t << "<sup" << htmlAttribsToString(s->attribs()) << ">";    else m_t << "</sup>";

      break;

    case DocStyleChange::Center:

      if (s->enable()) 

      {

        forceEndParagraph(s);

        m_t << "<center" << htmlAttribsToString(s->attribs()) << ">"; 

      }

      else 

      {

        m_t << "</center>";

        forceStartParagraph(s);

      }

      break;

    case DocStyleChange::Small:

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

      break;

    case DocStyleChange::Preformatted:

      if (s->enable())

      {

        forceEndParagraph(s);

        m_t << "<pre" << htmlAttribsToString(s->attribs()) << ">";

        m_insidePre=TRUE;

      }

      else

      {

        m_insidePre=FALSE;

        m_t << "";

        forceStartParagraph(s);

      }

      break;

    case DocStyleChange::Div:

      if (s->enable()) 

      {

        forceEndParagraph(s);

        m_t << "<div" << htmlAttribsToString(s->attribs()) << ">";  

      }

      else 

      {

        m_t << "";

        forceStartParagraph(s);

      }

      break;

    case DocStyleChange::Span:

      if (s->enable()) m_t << "<span" << htmlAttribsToString(s->attribs()) << ">";  else m_t << "";

      break;

  }

}

static void visitPreCaption(FTextStream &t, DocVerbatim *s)

{

  if (s->hasCaption())

  { 

    t << "
" << endl;

  }

}

static void visitPostCaption(FTextStream &t, DocVerbatim *s)

{

  if (s->hasCaption())

  {

    t << "" << endl;

  }

}

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

{

  QListIterator<DocNode> cli(children);

  DocNode *n;

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

}

void HtmlDocVisitor::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: 

      forceEndParagraph(s);

      m_t << PREFRAG_START;

      Doxygen::parserManager->getParser(lang)

                            ->parseCode(m_ci,

                                        s->context(),

                                        s->text(),

                                        langExt,

                                        s->isExample(),

                                        s->exampleFile(),

                                        0,     // fileDef

                                        -1,    // startLine

                                        -1,    // endLine

                                        FALSE, // inlineFragment

                                        0,     // memberDef

                                        TRUE,  // show line numbers

                                        m_ctx  // search context

                                       );

      m_t << PREFRAG_END;

      forceStartParagraph(s);

      break;

    case DocVerbatim::Verbatim: 

      forceEndParagraph(s);

      m_t << /*PREFRAG_START <<*/ "
";

      filter(s->text());

      m_t << "" /*<< PREFRAG_END*/;

      forceStartParagraph(s);

      break;

    case DocVerbatim::HtmlOnly: 

      if (s->isBlock()) forceEndParagraph(s);

      m_t << s->text(); 

      if (s->isBlock()) forceStartParagraph(s);

      break;

    case DocVerbatim::ManOnly: 

    case DocVerbatim::LatexOnly: 

    case DocVerbatim::XmlOnly: 

    case DocVerbatim::RtfOnly:

    case DocVerbatim::DocbookOnly:

      /* nothing */ 

      break;

    case DocVerbatim::Dot:

      {

        static int dotindex = 1;

        QCString fileName(4096);

        forceEndParagraph(s);

        fileName.sprintf("%s%d%s", 

            (Config_getString(HTML_OUTPUT)+"/inline_dotgraph_").data(), 

            dotindex++,

            ".dot"

           );

        QFile file(fileName);

        if (!file.open(IO_WriteOnly))

        {

          err("Could not open file %s for writing\n",fileName.data());

        }

        else

        {

          file.writeBlock( s->text(), s->text().length() );

          file.close();

          m_t << "
" << endl;

          writeDotFile(fileName,s->relPath(),s->context());

          visitPreCaption(m_t, s);

          visitCaption(this, s->children());

          visitPostCaption(m_t, s);

          m_t << "" << endl;

          if (Config_getBool(DOT_CLEANUP)) file.remove();

        }

        forceStartParagraph(s);

      }

      break;

    case DocVerbatim::Msc:

      {

        forceEndParagraph(s);

        static int mscindex = 1;

        QCString baseName(4096);

        baseName.sprintf("%s%d", 

            (Config_getString(HTML_OUTPUT)+"/inline_mscgraph_").data(), 

            mscindex++

            );

        QFile file(baseName+".msc");

        if (!file.open(IO_WriteOnly))

        {

          err("Could not open file %s.msc for writing\n",baseName.data());

        }

        else

        {

          QCString text = "msc {";

          text+=s->text();

          text+="}";

          file.writeBlock( text, text.length() );

          file.close();

          m_t << "
" << endl;

          writeMscFile(baseName+".msc",s->relPath(),s->context());

          visitPreCaption(m_t, s);

          visitCaption(this, s->children());

          visitPostCaption(m_t, s);

          m_t << "" << endl;

          if (Config_getBool(DOT_CLEANUP)) file.remove();

        }

        forceStartParagraph(s);

      }

      break;

    case DocVerbatim::PlantUML:

      {

        forceEndParagraph(s);

        static QCString htmlOutput = Config_getString(HTML_OUTPUT);

        QCString baseName = writePlantUMLSource(htmlOutput,s->exampleFile(),s->text());

        m_t << "
" << endl;

        writePlantUMLFile(baseName,s->relPath(),s->context());

        visitPreCaption(m_t, s);

        visitCaption(this, s->children());

        visitPostCaption(m_t, s);

        m_t << "" << endl;

        forceStartParagraph(s);

      }

      break;

  }

}

void HtmlDocVisitor::visit(DocAnchor *anc)

{

  if (m_hide) return;

  m_t << "anchor() << "\">";

}

void HtmlDocVisitor::visit(DocInclude *inc)

{

  if (m_hide) return;

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

  switch(inc->type())

  {

    case DocInclude::Include: 

      forceEndParagraph(inc);

      m_t << PREFRAG_START;

      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_ctx  // search context 

                                       );

      m_t << PREFRAG_END;

      forceStartParagraph(inc);

      break;

    case DocInclude::IncWithLines:

      { 

         forceEndParagraph(inc);

         m_t << PREFRAG_START;

         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_ctx  // search context

                                           );

         m_t << PREFRAG_END;

         forceStartParagraph(inc);

      }

      break;

    case DocInclude::DontInclude: 

      break;

    case DocInclude::HtmlInclude: 

      m_t << inc->text(); 

      break;

    case DocInclude::LatexInclude:

      break;

    case DocInclude::VerbInclude: 

      forceEndParagraph(inc);

      m_t << /*PREFRAG_START <<*/ "
";

      filter(inc->text());

      m_t << "" /*<< PREFRAG_END*/;

      forceStartParagraph(inc);

      break;

    case DocInclude::Snippet:

      {

         forceEndParagraph(inc);

         m_t << PREFRAG_START;

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

                               ->parseCode(m_ci,

                                           inc->context(),

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

                                           langExt,

                                           inc->isExample(),

                                           inc->exampleFile(), 

                                           0,

                                           -1,    // startLine

                                           -1,    // endLine

                                           TRUE,  // inlineFragment

                                           0,     // memberDef

                                           FALSE, // show line number

                                           m_ctx  // search context

                                          );

         m_t << PREFRAG_END;

         forceStartParagraph(inc);

      }

      break;

    case DocInclude::SnipWithLines:

      {

         forceEndParagraph(inc);

         m_t << PREFRAG_START;

         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_ctx  // search context

                                          );

         m_t << PREFRAG_END;

         forceStartParagraph(inc);

      }

      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 HtmlDocVisitor::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 << PREFRAG_START;

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

                                0,     // fileDef

                                -1,    // startLine

                                -1,    // endLine

                                FALSE, // inline fragment

                                0,     // memberDef

                                TRUE,  // show line numbers

                                m_ctx  // search context

                               );

    }

    pushEnabled();

    m_hide=TRUE;

  }

  if (op->isLast())  

  {

    popEnabled();

    if (!m_hide) m_t << PREFRAG_END;

  }

  else

  {

    if (!m_hide) m_t << endl;

  }

}

void HtmlDocVisitor::visit(DocFormula *f)

{

  if (m_hide) return;

  bool bDisplay = !f->isInline();

  if (bDisplay) 

  {

    forceEndParagraph(f);

    m_t << "
" << endl;

  }

  if (Config_getBool(USE_MATHJAX))

  {

    QCString text = f->text();

    bool closeInline = FALSE;

    if (!bDisplay && !text.isEmpty() && text.at(0)=='$' && 

                      text.at(text.length()-1)=='$')

    {

      closeInline=TRUE;

      text = text.mid(1,text.length()-2);

      m_t << "\\(";

    }

    m_t << convertToHtml(text);

    if (closeInline)

    {

      m_t << "\\)";

    }

  }

  else

  {

    m_t << "

      << (bDisplay ? "Dsp" : "Inl");

    m_t << "\" alt=\"";

    filterQuotedCdataAttr(f->text());

    m_t << "\"";

    // TODO: cache image dimensions on formula generation and give height/width

    // for faster preloading and better rendering of the page

    m_t << " src=\"" << f->relPath() << f->name() << ".png\"/>";

  }

  if (bDisplay)

  {

    m_t << endl << "
" << endl;

    forceStartParagraph(f);

  }

}

void HtmlDocVisitor::visit(DocIndexEntry *e)

{

  QCString anchor = convertIndexWordToAnchor(e->entry());

  if (e->member()) 

  {

    anchor.prepend(e->member()->anchor()+"_");

  }

  m_t << "";

  //printf("*** DocIndexEntry: word='%s' scope='%s' member='%s'\n",

  //       e->entry().data(),

  //       e->scope()  ? e->scope()->name().data()  : "<null>",

  //       e->member() ? e->member()->name().data() : "<null>"

  //      );

  Doxygen::indexList->addIndexItem(e->scope(),e->member(),anchor,e->entry());

}

void HtmlDocVisitor::visit(DocSimpleSectSep *)

{

  m_t << "" << endl;

  m_t << "
" << endl;

}

void HtmlDocVisitor::visit(DocCite *cite)

{

  if (m_hide) return;

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

  {

    startLink(cite->ref(),cite->file(),cite->relPath(),cite->anchor());

  }

  else

  {

    m_t << "[";

  }

  filter(cite->text());

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

  {

    endLink();

  }

  else

  {

    m_t << "]";

  }

}

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

// visitor functions for compound nodes

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

void HtmlDocVisitor::visitPre(DocAutoList *l)

{

  //printf("DocAutoList::visitPre\n");

  if (m_hide) return;

  forceEndParagraph(l);

  if (l->isEnumList())

  {

    //

    // Do list type based on depth:

    // 1.

    //   a.

    //     i.

    //       A. 

    //         1. (repeat)...

    //

    m_t << "
depth() % NUM_HTML_LIST_TYPES] << "\">";

  }

  else

  {

    m_t << "
";

  }

  if (!l->isPreformatted()) m_t << "\n";

}

void HtmlDocVisitor::visitPost(DocAutoList *l)

{

  //printf("DocAutoList::visitPost\n");

  if (m_hide) return;

  if (l->isEnumList())

  {

    m_t << "";

  }

  else

  {

    m_t << "";

  }

  if (!l->isPreformatted()) m_t << "\n";

  forceStartParagraph(l);

}

void HtmlDocVisitor::visitPre(DocAutoListItem *)

{

  if (m_hide) return;

  m_t << "
";

}

void HtmlDocVisitor::visitPost(DocAutoListItem *li) 

{

  if (m_hide) return;

  m_t << "";

  if (!li->isPreformatted()) m_t << "\n";

}

template<class T> 

bool isFirstChildNode(T *parent, DocNode *node)

{

   return parent->children().getFirst()==node;

}

template<class T> 

bool isLastChildNode(T *parent, DocNode *node)

{

   return parent->children().getLast()==node;

}

bool isSeparatedParagraph(DocSimpleSect *parent,DocPara *par)

{

  QList<DocNode> nodes = parent->children();

  int i = nodes.findRef(par);

  if (i==-1) return FALSE;

  int count = parent->children().count();

  if (count>1 && i==0) // first node

  {

    if (nodes.at(i+1)->kind()==DocNode::Kind_SimpleSectSep)

    {

      return TRUE;

    }

  }

  else if (count>1 && i==count-1) // last node

  {

    if (nodes.at(i-1)->kind()==DocNode::Kind_SimpleSectSep)

    {

      return TRUE;

    }

  }

  else if (count>2 && i>0 && i

  {

    if (nodes.at(i-1)->kind()==DocNode::Kind_SimpleSectSep &&

        nodes.at(i+1)->kind()==DocNode::Kind_SimpleSectSep)

    {

      return TRUE;

    }

  }

  return FALSE;

}

static int getParagraphContext(DocPara *p,bool &isFirst,bool &isLast)

{

  int t=0;

  isFirst=FALSE;

  isLast=FALSE;

  if (p && p->parent())

  {

    switch (p->parent()->kind()) 

    {

      case DocNode::Kind_ParBlock:

        { // hierarchy: node N -> para -> parblock -> para

          // adapt return value to kind of N

          DocNode::Kind kind = DocNode::Kind_Para;

          if ( p->parent()->parent() && p->parent()->parent()->parent() )

          {

            kind = p->parent()->parent()->parent()->kind();

          }

          isFirst=isFirstChildNode((DocParBlock*)p->parent(),p);