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

 *

 * 

 *

 *

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

#include "latexdocvisitor.h"

#include "docparser.h"

#include "language.h"

#include "doxygen.h"

#include "outputgen.h"

#include "dot.h"

#include "util.h"

#include "message.h"

#include "parserintf.h"

#include "msc.h"

#include "htmlattrib.h"

static QString escapeLabelName(const char *s)

{

  QString result;

  const char *p=s;

  char c;

  while ((c=*p++))

  {

    switch (c)

    {

      case '%': result+="\\%"; break;

      case '|': result+="\\texttt{\"|}"; break;

      case '!': result+="\"!"; break;

      default: result+=c;

    }

  }

  return result;

}

const int maxLevels=5;

static const char *secLabels[maxLevels] = 

   { "section","subsection","subsubsection","paragraph","subparagraph" };

static const char *getSectionName(int level)

{

  int l = level;

  if (Config_getBool("COMPACT_LATEX")) l++;

  if (Doxygen::insideMainPage) l--;

  return secLabels[QMIN(maxLevels-1,l)];

}

static int rowspan(DocHtmlCell *cell)

{

  int retval = 0;

  HtmlAttribList attrs = cell->attribs ();

  for (unsigned int i = 0; i < attrs.count(); ++i) 

  {

    if ("rowspan" == attrs.at(i)->name.lower())

    {

      retval = attrs.at(i)->value.toInt();

      break;

    }

  }

  return retval;

}

QString LatexDocVisitor::escapeMakeIndexChars(const char *s)

{

  QString result;

  const char *p=s;

  char str[2]; str[1]=0;

  char c;

  while ((c=*p++))

  {

    switch (c)

    {

      case '!': m_t << "\"!"; break;

      case '"': m_t << "\"\""; break;

      case '@': m_t << "\"@"; break;

      case '|': m_t << "\\texttt{\"|}"; break;

      case '[': m_t << "["; break;

      case ']': m_t << "]"; break;

      default:  str[0]=c; filter(str); break;

    }

  }

  return result;

}

LatexDocVisitor::LatexDocVisitor(QTextStream &t,CodeOutputInterface &ci,

                                 const char *langExt,bool insideTabbing) 

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

    m_insideItem(FALSE), m_hide(FALSE), m_insideTabbing(insideTabbing),

    m_langExt(langExt), m_currentColumn(0), m_inRowspan(FALSE)

{

}

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

  // visitor functions for leaf nodes

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

void LatexDocVisitor::visit(DocWord *w)

{

  if (m_hide) return;

  filter(w->word());

}

void LatexDocVisitor::visit(DocLinkedWord *w)

{

  if (m_hide) return;

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

  filter(w->word());

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

}

void LatexDocVisitor::visit(DocWhiteSpace *w)

{

  if (m_hide) return;

  if (m_insidePre)

  {

    m_t << w->chars();

  }

  else

  {

    m_t << " ";

  }

}

void LatexDocVisitor::visit(DocSymbol *s)

{

  if (m_hide) return;

  switch(s->symbol())

  {

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

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

    case DocSymbol::Less:    if (m_insidePre) m_t << "<"; else m_t << "$<$"; 

                             break;

    case DocSymbol::Greater: if (m_insidePre) m_t << ">"; else m_t << "$>$"; break;

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

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

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

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

    case DocSymbol::Copy:    m_t << "\\copyright"; break;

    case DocSymbol::Tm:      m_t << "\\texttrademark"; break;

    case DocSymbol::Reg:     m_t << "\\textregistered"; break;

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

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

    case DocSymbol::Lsquo:   m_t << "`"; break;

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

    case DocSymbol::Ldquo:   m_t << "``"; break;

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

    case DocSymbol::Ndash:   m_t << "--"; break;

    case DocSymbol::Mdash:   m_t << "---"; break;

    case DocSymbol::Uml:     

                             if (s->letter()=='i') 

                               m_t << "\\\"{\\i}"; 

                             else                  

                               m_t << "\\\"{" << s->letter() << "}"; 

                             break;

    case DocSymbol::Acute:   

                             if (s->letter()=='i') 

                               m_t << "\\'{\\i}"; 

                             else                  

                               m_t << "\\'{" << s->letter() << "}"; 

                             break;

    case DocSymbol::Grave:   

                             if (s->letter()=='i') 

                               m_t << "\\`{\\i}"; 

                             else                  

                               m_t << "\\`{" << s->letter() << "}"; 

                             break;

    case DocSymbol::Circ:    

                             if (s->letter()=='i') 

                               m_t << "\\^{\\i}"; 

                             else                  

                               m_t << "\\^{" << s->letter() << "}"; 

                             break;

    case DocSymbol::Slash:   if (tolower(s->letter())=='o')

                               m_t << "\\" << s->letter();

                             else

                               m_t << s->letter();

                             break;

    case DocSymbol::Tilde:   m_t << "\\~{"  << s->letter() << "}"; break;

    case DocSymbol::Szlig:   m_t << "{\\ss}"; break;

    case DocSymbol::Cedil:   m_t << "\\c{" << s->letter() << "}"; break;

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

    case DocSymbol::Nbsp:    m_t << "~"; break;

    case DocSymbol::AElig:   m_t << "{\\AE}"; break;

    case DocSymbol::Aelig:   m_t << "{\\ae}"; break;

    default:

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

  }

}

void LatexDocVisitor::visit(DocURL *u)

{

  if (m_hide) return;

  if (Config_getBool("PDF_HYPERLINKS"))

  {

    m_t << "\\href{";

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

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

  }

  m_t << "{\\tt ";

  filter(u->url());

  m_t << "}";

}

void LatexDocVisitor::visit(DocLineBreak *)

{

  if (m_hide) return;

  m_t << "\\par\n";

}

void LatexDocVisitor::visit(DocHorRuler *)

{

  if (m_hide) return;

  m_t << "\n\n";

}

void LatexDocVisitor::visit(DocStyleChange *s)

{

  if (m_hide) return;

  switch (s->style())

  {

    case DocStyleChange::Bold:

      if (s->enable()) m_t << "{\\bfseries ";      else m_t << "}";

      break;

    case DocStyleChange::Italic:

      if (s->enable()) m_t << "{\\itshape ";     else m_t << "\\/}";

      break;

    case DocStyleChange::Code:

      if (s->enable()) m_t << "{\\ttfamily ";   else m_t << "}";

      break;

    case DocStyleChange::Subscript:

      if (s->enable()) m_t << "$_{\\mbox{";    else m_t << "}}$ ";

      break;

    case DocStyleChange::Superscript:

      if (s->enable()) m_t << "$^{\\mbox{";    else m_t << "}}$ ";

      break;

    case DocStyleChange::Center:

      if (s->enable()) m_t << "\\begin{center}"; else m_t << "\\end{center} ";

      break;

    case DocStyleChange::Small:

      if (s->enable()) m_t << "\n\\footnotesize ";  else m_t << "\n\\normalsize ";

      break;

    case DocStyleChange::Preformatted:

      if (s->enable()) 

      {

        m_t << "\n\\begin{DoxyPre}";

        m_insidePre=TRUE;

      }

      else

      {

        m_insidePre=FALSE;

        m_t << "\\end{DoxyPre}\n";

      }

      break;

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

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

  }

}

void LatexDocVisitor::visit(DocVerbatim *s)

{

  static bool latexSourceCode = Config_getBool("LATEX_SOURCE_CODE");

  if (m_hide) return;

  switch(s->type())

  {

    case DocVerbatim::Code: 

      if (latexSourceCode)

      {

        m_t << "\n\n\\begin{footnotesize}\\begin{alltt}" << endl; 

      }

      else

      {

        m_t << "\n\\begin{DoxyCode}\n";

      }

      Doxygen::parserManager->getParser(m_langExt)

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

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

      if (latexSourceCode)

      {

        m_t << "\\end{alltt}\\end{footnotesize}" << endl; 

      }

      else

      {

        m_t << "\\end{DoxyCode}\n";

      }

      break;

    case DocVerbatim::Verbatim: 

      m_t << "\\begin{DoxyVerb}";

      m_t << s->text();

      m_t << "\\end{DoxyVerb}\n";

      break;

    case DocVerbatim::HtmlOnly: 

    case DocVerbatim::XmlOnly: 

    case DocVerbatim::ManOnly: 

      /* nothing */ 

      break;

    case DocVerbatim::LatexOnly: 

      m_t << s->text(); 

      break;

    case DocVerbatim::Dot: 

      {

        static int dotindex = 1;

        QCString fileName(4096);

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

            (Config_getString("LATEX_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();

        m_t << "\\begin{center}\n";

        startDotFile(fileName,"","",FALSE);

        endDotFile(FALSE);

        m_t << "\\end{center}\n";

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

      }

      break;

    case DocVerbatim::Msc: 

      {

        static int mscindex = 1;

        QCString baseName(4096);

        baseName.sprintf("%s%d", 

            (Config_getString("LATEX_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();

        m_t << "\\begin{center}\n";

        writeMscFile(baseName);

        m_t << "\\end{center}\n";

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

      }

      break;

  }

}

void LatexDocVisitor::visit(DocAnchor *anc)

{

  if (m_hide) return;

  m_t << "\\label{" << anc->file() << "_" << anc->anchor() << "}" << endl;

  if (!anc->file().isEmpty() && Config_getBool("PDF_HYPERLINKS")) 

  {

    m_t << "\\hypertarget{" << anc->file() << "_" << anc->anchor() 

      << "}{}" << endl;

  }    

}

void LatexDocVisitor::visit(DocInclude *inc)

{

  if (m_hide) return;

  switch(inc->type())

  {

    case DocInclude::IncWithLines:

      { 

         m_t << "\n\\begin{DoxyCodeInclude}\n";

         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 << "\\end{DoxyCodeInclude}" << endl;

      }

      break;    

    case DocInclude::Include: 

      m_t << "\n\\begin{DoxyCodeInclude}\n";

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

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

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

                                        inc->exampleFile());

      m_t << "\\end{DoxyCodeInclude}\n";

      break;

    case DocInclude::DontInclude: 

      break;

    case DocInclude::HtmlInclude: 

      break;

    case DocInclude::VerbInclude: 

      m_t << "\n\\begin{DoxyVerbInclude}\n";

      m_t << inc->text();

      m_t << "\\end{DoxyVerbInclude}\n";

      break;

  }

}

void LatexDocVisitor::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 << "\n\\begin{DoxyCodeInclude}\n";

    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 << "\n\\end{DoxyCodeInclude}\n";

  }

  else

  {

    if (!m_hide) m_t << endl;

  }

}

void LatexDocVisitor::visit(DocFormula *f)

{

  if (m_hide) return;

  m_t << f->text();

}

void LatexDocVisitor::visit(DocIndexEntry *i)

{

  if (m_hide) return;

  m_t << "\\index{" << escapeLabelName(i->entry()) << "@{";

  escapeMakeIndexChars(i->entry());

  m_t << "}}";

}

void LatexDocVisitor::visit(DocSimpleSectSep *)

{

}

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

// visitor functions for compound nodes

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

void LatexDocVisitor::visitPre(DocAutoList *l)

{

  if (m_hide) return;

  if (l->isEnumList())

  {

    m_t << "\n\\begin{DoxyEnumerate}";

  }

  else

  {

    m_t << "\n\\begin{DoxyItemize}";

  }

}

void LatexDocVisitor::visitPost(DocAutoList *l)

{

  if (m_hide) return;

  if (l->isEnumList())

  {

    m_t << "\n\\end{DoxyEnumerate}";

  }

  else

  {

    m_t << "\n\\end{DoxyItemize}";

  }

}

void LatexDocVisitor::visitPre(DocAutoListItem *)

{

  if (m_hide) return;

  m_t << "\n\\item ";

}

void LatexDocVisitor::visitPost(DocAutoListItem *) 

{

}

void LatexDocVisitor::visitPre(DocPara *) 

{

}

void LatexDocVisitor::visitPost(DocPara *p)

{

  if (m_hide) return;

  if (!p->isLast() &&            // omit <p> for last paragraph

      !(p->parent() &&           // and for parameter sections

        p->parent()->kind()==DocNode::Kind_ParamSect

       )

     ) m_t << endl << endl;

}

void LatexDocVisitor::visitPre(DocRoot *)

{

}

void LatexDocVisitor::visitPost(DocRoot *)

{