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

 *

 * 

 *

 *

 * 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 <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 "util.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";

  uint i;

  QCString result;

  for (i=0;i<word.length();i++)

  {

    int c = word.at(i);

    if (isId(c))

    {

      result+=c;

    }

    else if (isspace(c))

    {

      result+="_";

    }

    else

    {

      char cs[3];

      cs[0]=hex[c>>4];

      cs[1]=hex[c&0xf];

      cs[2]=0;

      result+=cs;

    }

  }

  return result;

}

static bool mustBeOutsideParagraph(DocNode *n)

{

  switch (n->kind())

  {

          /* <ul> */

        case DocNode::Kind_HtmlList:

        case DocNode::Kind_SimpleList:

        case DocNode::Kind_AutoList:

          /* <dl> */

        case DocNode::Kind_SimpleSect:

        case DocNode::Kind_ParamSect:

        case DocNode::Kind_HtmlDescList:

        case DocNode::Kind_XRefItem:

          /* <table> */

        case DocNode::Kind_HtmlTable:

          /* <h?> */

        case DocNode::Kind_Section:

        case DocNode::Kind_HtmlHeader:

          /* <div> */

        case DocNode::Kind_Verbatim:

        case DocNode::Kind_Include:

        case DocNode::Kind_Image:

        case DocNode::Kind_SecRefList:

          /* <hr> */

        case DocNode::Kind_HorRuler:

          return TRUE;

        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(QTextStream &t,CodeOutputInterface &ci,

                               const char *langExt) 

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

                                 m_hide(FALSE), m_langExt(langExt)

{

}

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

  // visitor functions for leaf nodes

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

void HtmlDocVisitor::visit(DocWord *w)

{

  if (m_hide) return;

  filter(w->word());

}

void HtmlDocVisitor::visit(DocLinkedWord *w)

{

  if (m_hide) return;

  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;

  switch(s->symbol())

  {

    case DocSymbol::BSlash:  m_t << "\\"; break;

    case DocSymbol::At:      m_t << "@"; break;

    case DocSymbol::Less:    m_t << "&lt;"; break;

    case DocSymbol::Greater: m_t << "&gt;"; break;

    case DocSymbol::Amp:     m_t << "&amp;"; break;

    case DocSymbol::Dollar:  m_t << "$"; break;

    case DocSymbol::Hash:    m_t << "#"; break;

    case DocSymbol::Percent: m_t << "%"; break;

    case DocSymbol::Copy:    m_t << "&copy;"; break;

    case DocSymbol::Tm:      m_t << "&trade;"; break;

    case DocSymbol::Reg:     m_t << "&reg;"; break;

    case DocSymbol::Apos:    m_t << "'"; break;

    case DocSymbol::Quot:    m_t << "\""; break;

    case DocSymbol::Lsquo:   m_t << "&lsquo;"; break;

    case DocSymbol::Rsquo:   m_t << "&rsquo;"; break;

    case DocSymbol::Ldquo:   m_t << "&ldquo;"; break;

    case DocSymbol::Rdquo:   m_t << "&rdquo;"; break;

    case DocSymbol::Ndash:   m_t << "&ndash;"; break;

    case DocSymbol::Mdash:   m_t << "&mdash;"; break;

    case DocSymbol::Uml:     m_t << "&" << s->letter() << "uml;"; break;

    case DocSymbol::Acute:   m_t << "&" << s->letter() << "acute;"; break;

    case DocSymbol::Grave:   m_t << "&" << s->letter() << "grave;"; break;

    case DocSymbol::Circ:    m_t << "&" << s->letter() << "circ;"; break;

    case DocSymbol::Slash:   m_t << "&" << s->letter() << "slash;"; break;

    case DocSymbol::Tilde:   m_t << "&" << s->letter() << "tilde;"; break;

    case DocSymbol::Szlig:   m_t << "&szlig;"; break;

    case DocSymbol::Cedil:   m_t << "&" << s->letter() << "cedil;"; break;

    case DocSymbol::Ring:    m_t << "&" << s->letter() << "ring;"; break;

    case DocSymbol::Nbsp:    m_t << "&nbsp;"; break;

    case DocSymbol::AElig:   m_t << "&AElig;"; break;

    case DocSymbol::Aelig:   m_t << "&aelig;"; break;

    default:

                             err("Error: unknown symbol found\n");

  }

}

void HtmlDocVisitor::visit(DocURL *u)

{

  if (m_hide) return;

  m_t << "<a href=\"";

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

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

  filter(u->url());

  m_t << "</a>";

}

void HtmlDocVisitor::visit(DocLineBreak *)

{

  if (m_hide) return;

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

}

void HtmlDocVisitor::visit(DocHorRuler *)

{

  if (m_hide) return;

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

}

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 << "</b>";

      break;

    case DocStyleChange::Italic:

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

      break;

    case DocStyleChange::Code:

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

      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 << "</pre>";

        forceStartParagraph(s);

      }

      break;

    case DocStyleChange::Div:

      if (s->enable()) 

      {

        forceEndParagraph(s);

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

      }

      else 

      {

        m_t << "</div>";

        forceStartParagraph(s);

      }

      break;

    case DocStyleChange::Span:

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

      break;

  }

}

void HtmlDocVisitor::visit(DocVerbatim *s)

{

  if (m_hide) return;

  switch(s->type())

  {

    case DocVerbatim::Code: // fall though

      forceEndParagraph(s);

      m_t << PREFRAG_START;

      Doxygen::parserManager->getParser(m_langExt)

                            ->parseCode(m_ci,s->context(),s->text().latin1(),

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

      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: 

      m_t << s->text(); 

      break;

    case DocVerbatim::ManOnly: 

    case DocVerbatim::LatexOnly: 

    case DocVerbatim::XmlOnly: 

      /* nothing */ 

      break;

    case DocVerbatim::Dot:

      {

        static int dotindex = 1;

        QCString fileName(4096);

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

        }

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

        file.close();

        forceEndParagraph(s);

        m_t << "<div align=\"center\">" << endl;

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

        m_t << "</div>" << endl;

        forceStartParagraph(s);

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

      }

      break;

    case DocVerbatim::Msc:

      {

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

        }

        QCString text = "msc {";

        text+=s->text();

        text+="}";

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

        file.close();

        forceEndParagraph(s);

        m_t << "<div align=\"center\">" << endl;

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

        m_t << "</div>" << endl;

        forceStartParagraph(s);

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

      }

      break;

  }

}

void HtmlDocVisitor::visit(DocAnchor *anc)

{

  if (m_hide) return;

  m_t << "<a class=\"anchor\" id=\"" << anc->anchor() << "\"></a>";

}

void HtmlDocVisitor::visit(DocInclude *inc)

{

  if (m_hide) return;

  switch(inc->type())

  {

    case DocInclude::Include: 

      forceEndParagraph(inc);

      m_t << PREFRAG_START;

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

                            ->parseCode(m_ci,                 

                                        inc->context(),

                                        inc->text().latin1(),

                                        inc->isExample(),

                                        inc->exampleFile(),

                                        0,   // fd

                                        -1,  // startLine

                                        -1,  // endLine

                                        TRUE // inlineFragment

                                       );

      m_t << PREFRAG_END;

      forceStartParagraph(inc);

      break;

    case DocInclude::IncWithLines:

      { 

         forceEndParagraph(inc);

         m_t << PREFRAG_START;

         QFileInfo cfi( inc->file() );

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

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

                               ->parseCode(m_ci,

                                           inc->context(),

                                           inc->text().latin1(),

                                           inc->isExample(),

                                           inc->exampleFile(), &fd);

         m_t << PREFRAG_END;

         forceStartParagraph(inc);

      }

      break;

    case DocInclude::DontInclude: 

      break;

    case DocInclude::HtmlInclude: 

      m_t << inc->text(); 

      break;

    case DocInclude::VerbInclude: 

      forceEndParagraph(inc);

      m_t << PREFRAG_START;

      filter(inc->text());

      m_t << PREFRAG_END;

      forceStartParagraph(inc);

      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;

  }

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

  {

    popEnabled();

    if (!m_hide) 

    {

      Doxygen::parserManager->getParser(m_langExt)

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

                                op->text().latin1(),op->isExample(),

                                op->exampleFile());

    }

    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 << "<p class=\"formulaDsp\">" << endl;

  }

  m_t << "<img class=\"formula" 

      << (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 << "</p>" << endl;

    forceStartParagraph(f);

  }

}

void HtmlDocVisitor::visit(DocIndexEntry *e)

{

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

  if (e->member()) 

  {

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

  }

  m_t << "<a name=\"" << anchor << "\"></a>";

  //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 << "</dd>" << endl;

  m_t << "<dd>" << endl;

}

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

// visitor functions for compound nodes

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

void HtmlDocVisitor::visitPre(DocAutoList *l)