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

 *

 * 

 *

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

#include "qtbc.h"

#include <qdir.h>

#include "latexgen.h"

#include "config.h"

#include "message.h"

#include "doxygen.h"

#include "util.h"

#include "diagram.h"

#include "language.h"

#include "version.h"

#include "dot.h"

#include "pagedef.h"

#include "docparser.h"

#include "latexdocvisitor.h"

#include "dirdef.h"

//static QCString filterTitle(const char *s)

//{

//  QCString tmp=s,result;

//  uint i;for (i=0;i<tmp.length();i++)

//  {

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

//    switch(c)

//    {

//      case '#': result+="\\#";  break;

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

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

//      case '[': result+="{";    break;

//      case ']': result+="}";    break;

//      default:  result+=c;      break;

//    }

//  }

//  return result;  

//}

LatexGenerator::LatexGenerator() : OutputGenerator()

{

  dir=Config_getString("LATEX_OUTPUT");

  col=0;

  //printf("LatexGenerator::LatexGenerator() insideTabbing=FALSE\n");

  insideTabbing=FALSE;

  firstDescItem=TRUE;

  disableLinks=FALSE;

  m_indent=0;

  templateMemberItem = FALSE;

  m_prettyCode=Config_getBool("LATEX_SOURCE_CODE");

}

LatexGenerator::~LatexGenerator()

{

}

void LatexGenerator::init()

{

  QCString dir=Config_getString("LATEX_OUTPUT");

  QDir d(dir);

  if (!d.exists() && !d.mkdir(dir))

  {

    err("Could not create output directory %s\n",dir.data());

    exit(1);

  }

  QCString fileName=dir+"/Makefile";

  QFile file(fileName);

  if (!file.open(IO_WriteOnly))

  {

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

    exit(1);

  }

  // inserted by KONNO Akihisa <konno@researchers.jp> 2002-03-05

  QCString latex_command = Config_getString("LATEX_CMD_NAME");

  QCString mkidx_command = Config_getString("MAKEINDEX_CMD_NAME");

  // end insertion by KONNO Akihisa <konno@researchers.jp> 2002-03-05

  QTextStream t(&file);

  if (!Config_getBool("USE_PDFLATEX")) // use plain old latex

  {

    t << "all: clean refman.dvi" << endl

      << endl

      << "ps: refman.ps" << endl

      << endl

      << "pdf: refman.pdf" << endl

      << endl

      << "ps_2on1: refman_2on1.ps" << endl

      << endl

      << "pdf_2on1: refman_2on1.pdf" << endl

      << endl

      << "refman.ps: refman.dvi" << endl

      << "\tdvips -o refman.ps refman.dvi" << endl

      << endl;

    t << "refman.pdf: refman.ps" << endl;

#if defined(_MSC_VER)

    // ps2pdf.bat does not work properly from a makefile using GNU make!

    t << "\tgswin32c -q -dNOPAUSE -dBATCH -sDEVICE=pdfwrite "

      "-sOutputFile=refman.pdf -c save pop -f refman.ps" << endl << endl;

#else

    t << "\tps2pdf refman.ps refman.pdf" << endl << endl;

#endif

    t << "refman.dvi: refman.tex doxygen.sty" << endl

      << "\techo \"Running latex...\"" << endl

      << "\t" << latex_command << " refman.tex" << endl

      << "\techo \"Running makeindex...\"" << endl

      << "\t" << mkidx_command << " refman.idx" << endl

      << "\techo \"Rerunning latex....\"" << endl

      << "\t" << latex_command << " refman.tex" << endl

      << "\tlatex_count=5 ; \\" << endl

      << "\twhile egrep -s 'Rerun (LaTeX|to get cross-references right)' refman.log && [ $$latex_count -gt 0 ] ;\\" << endl

      << "\t    do \\" << endl

      << "\t      echo \"Rerunning latex....\" ;\\" << endl

      << "\t      " << latex_command << " refman.tex ;\\" << endl

      << "\t      latex_count=`expr $$latex_count - 1` ;\\" << endl

      << "\t    done" << endl << endl

      << "refman_2on1.ps: refman.ps" << endl

      << "\tpsnup -2 refman.ps >refman_2on1.ps" << endl

      << endl

      << "refman_2on1.pdf: refman_2on1.ps" << endl

#if defined(_MSC_VER)

      // ps2pdf.bat does not work properly from a makefile using GNU make!

      << "\tgswin32c -q -dNOPAUSE -dBATCH -sDEVICE=pdfwrite "

         "-sOutputFile=refman_2on1.pdf -c save pop -f refman_2on1.ps" << endl;

#else

      << "\tps2pdf refman_2on1.ps refman_2on1.pdf" << endl;

#endif

  }

  else // use pdflatex for higher quality output

  {

    t << "all: clean refman.pdf" << endl << endl

      << "pdf: refman.pdf" << endl << endl;

    t << "refman.pdf: refman.tex" << endl;

    t << "\tpdflatex refman.tex" << endl;

    t << "\tmakeindex refman.idx" << endl;

    t << "\tpdflatex refman.tex" << endl

      << "\tlatex_count=5 ; \\" << endl

      << "\twhile egrep -s 'Rerun (LaTeX|to get cross-references right)' refman.log && [ $$latex_count -gt 0 ] ;\\" << endl

      << "\t    do \\" << endl

      << "\t      echo \"Rerunning latex....\" ;\\" << endl

      << "\t      pdflatex refman.tex ;\\" << endl

      << "\t      latex_count=`expr $$latex_count - 1` ;\\" << endl

      << "\t    done" << endl << endl;

  }

  t << endl

    << "clean:" << endl

    << "\trm -f *.ps *.dvi *.aux *.toc *.idx *.ind *.ilg *.log *.out refman.pdf" << endl;

  createSubDirs(d);

}

static void writeDefaultHeaderPart1(QTextStream &t)

{

  // part 1

  QCString paperName;

  if (Config_getBool("LATEX_BATCHMODE")) t << "\\batchmode" << endl;

  QCString &paperType=Config_getEnum("PAPER_TYPE");

  if (paperType=="a4wide") 

    paperName="a4"; 

  else 

    paperName=paperType;

  t << "\\documentclass[" << paperName << "paper";

  //if (Config_getBool("PDF_HYPERLINKS")) t << ",ps2pdf";

  t << "]{";

  if (Config_getBool("COMPACT_LATEX")) t << "article"; else t << "book";

  t << "}\n";

  if (paperType=="a4wide") t << "\\usepackage{a4wide}\n";

  t << "\\usepackage{makeidx}\n"

    "\\usepackage{graphicx}\n"

    "\\usepackage{multicol}\n"

    "\\usepackage{float}\n"

    "\\usepackage{listings}\n"

    "\\usepackage{color}\n"

    "\\usepackage{textcomp}\n"

    "\\usepackage{alltt}\n"

    //"\\usepackage{ae,aecompl,aeguill}\n"

    ;

  if (Config_getBool("USE_PDFLATEX"))

  {

    t << "\\usepackage{times}" << endl;

  }

  if (Config_getBool("PDF_HYPERLINKS")) 

  {

    t << "\\usepackage{ifpdf}" << endl

      << "\\ifpdf" << endl

      << "\\usepackage[pdftex," << endl

      << "            pagebackref=true," << endl

      << "            colorlinks=true," << endl

      << "            linkcolor=blue," << endl

      << "            unicode" << endl

      << "           ]{hyperref}" << endl

      << "\\else" << endl

      << "\\usepackage[ps2pdf," << endl

      << "            pagebackref=true," << endl

      << "            colorlinks=true," << endl

      << "            linkcolor=blue," << endl

      << "            unicode" << endl

      << "           ]{hyperref}" << endl

      << "\\usepackage{pspicture}" << endl

      << "\\fi" << endl;

  }

  // Try to get the command for switching on the language

  // support

  t << "\\usepackage[utf8]{inputenc}" << endl;

  QCString sLanguageSupportCommand(

      theTranslator->latexLanguageSupportCommand());

  if (!sLanguageSupportCommand.isEmpty())

  {

    // The command is not empty.  Put it to the output.

    // if the command is empty, no output is needed.

    t << sLanguageSupportCommand << endl;

  }

  t << "\\usepackage{doxygen}\n";

  // define option for listings

  t << "\\lstset{language=C++,"

                "inputencoding=utf8,"

                "basicstyle=\\footnotesize,"

                "breaklines=true,"

                "breakatwhitespace=true,"

                "tabsize=" << Config_getInt("TAB_SIZE") <<","

                "numbers=left }" << endl;

  QStrList &extraPackages = Config_getList("EXTRA_PACKAGES");

  const char *s=extraPackages.first();

  while (s)

  {

    t << "\\usepackage{" << s << "}\n";

    s=extraPackages.next();

  }

  t << "\\makeindex\n"

    "\\setcounter{tocdepth}{3}\n"

    "\\renewcommand{\\footrulewidth}{0.4pt}\n"

    "\\begin{document}\n";

  static bool pdfHyperlinks = Config_getBool("PDF_HYPERLINKS");

  static bool usePDFLatex   = Config_getBool("USE_PDFLATEX");

  if (pdfHyperlinks && usePDFLatex)

  {

    // to avoid duplicate page anchors due to reuse of same numbers for

    // the index (be it as roman numbers)

    t << "\\hypersetup{pageanchor=false}" << endl;

  }

  if (theTranslator->idLanguage()=="greek") t << "\\selectlanguage{greek}\n";

  t << "\\begin{titlepage}\n"

    "\\vspace*{7cm}\n"

    "\\begin{center}\n"

    "{\\Large ";

}

static void writeDefaultHeaderPart2(QTextStream &t)

{

  // part 2

  t << "}\\\\" << endl

    << "\\vspace*{1cm}" << endl

    << "{\\large ";

}

static void writeDefaultHeaderPart3(QTextStream &t)

{

  // part 3

  t << " Doxygen " << versionString << "}\\\\" << endl

    << "\\vspace*{0.5cm}" << endl

    << "{\\small " << dateToString(TRUE) << "}\\\\" << endl

    << "\\end{center}" << endl

    << "\\end{titlepage}" << endl;

  if (!Config_getBool("COMPACT_LATEX")) t << "\\clearemptydoublepage\n";

  t << "\\pagenumbering{roman}\n";

  t << "\\tableofcontents\n";

  if (!Config_getBool("COMPACT_LATEX")) t << "\\clearemptydoublepage\n";

  t << "\\pagenumbering{arabic}\n";

  static bool pdfHyperlinks = Config_getBool("PDF_HYPERLINKS");

  static bool usePDFLatex   = Config_getBool("USE_PDFLATEX");

  if (pdfHyperlinks && usePDFLatex)

  {

    t << "\\hypersetup{pageanchor=true}" << endl;

  }

}

static void writeDefaultStyleSheetPart1(QTextStream &t)

{

  // part 1

  t << "\\NeedsTeXFormat{LaTeX2e}\n"

       "\\ProvidesPackage{doxygen}\n\n";

  t << "% Packages used by this style file\n"

       "\\RequirePackage{alltt}\n"

       "\\RequirePackage{array}\n"

       "\\RequirePackage{calc}\n"

       "\\RequirePackage{color}\n"

       "\\RequirePackage{fancyhdr}\n"

       "\\RequirePackage{verbatim}\n\n";

  t << "% Setup fancy headings\n"

       "\\pagestyle{fancyplain}\n"

       "\\newcommand{\\clearemptydoublepage}{%\n"

       "  \\newpage{\\pagestyle{empty}\\cleardoublepage}%\n"

       "}\n";

  if (!Config_getBool("COMPACT_LATEX")) 

    t << "\\renewcommand{\\chaptermark}[1]{%\n"

         "  \\markboth{#1}{}%\n"

         "}\n";

  t << "\\renewcommand{\\sectionmark}[1]{%\n"

       "  \\markright{\\thesection\\ #1}%\n"

       "}\n";

  t << "\\lhead[\\fancyplain{}{\\bfseries\\thepage}]{%\n"

       "  \\fancyplain{}{\\bfseries\\rightmark}%\n"

       "}\n";

  t << "\\rhead[\\fancyplain{}{\\bfseries\\leftmark}]{%\n"

       "  \\fancyplain{}{\\bfseries\\thepage}%\n"

       "}\n";

  t << "\\rfoot[\\fancyplain{}{\\bfseries\\scriptsize%\n  ";

}

static void writeDefaultStyleSheetPart2(QTextStream &t)

{

  t << "\\lfoot[]{\\fancyplain{}{\\bfseries\\scriptsize%\n  ";

}

static void writeDefaultStyleSheetPart3(QTextStream &t)

{

  t << "}}\n";

  t << "\\cfoot{}\n\n";

  t << "%---------- Internal commands used in this style file ----------------\n\n";

  t << "% Generic environment used by all paragraph-based environments defined\n"

       "% below. Note that the command \\title{...} needs to be defined inside\n"

       "% those environments!\n"

       "\\newenvironment{DoxyDesc}[1]{%\n"

       "  \\begin{list}{}%\n"

       "  {%\n"

       "    \\settowidth{\\labelwidth}{40pt}%\n"

       "    \\setlength{\\leftmargin}{\\labelwidth}%\n"

       "    \\setlength{\\parsep}{0pt}%\n"

       "    \\setlength{\\itemsep}{-4pt}%\n"

       "    \\renewcommand{\\makelabel}{\\entrylabel}%\n"

       "  }%\n"

       "  \\item[#1:]%\n"

       "}{%\n"

       "  \\end{list}%\n"

       "}\n\n";

  t << "%---------- Commands used by doxygen LaTeX output generator ----------\n\n";

  t << "% Used by <pre> ... </pre>\n"

       "\\newenvironment{DoxyPre}{%\n"

       "  \\small%\n"

       "  \\begin{alltt}%\n"

       "}{%\n"

       "  \\end{alltt}%\n"

       "  \\normalsize%\n"

       "}\n\n";

  t << "% Used by @code ... @endcode\n"

       "\\newenvironment{DoxyCode}{%\n"

       "  \\footnotesize%\n"

       "  \\verbatim%\n"

       "}{%\n"

       "  \\endverbatim%\n"

       "  \\normalsize%\n"

       "}\n\n";

  t << "% Used by @example, @include, @includelineno and @dontinclude\n"

       "\\newenvironment{DoxyCodeInclude}{%\n"

       "  \\DoxyCode%\n"

       "}{%\n"

       "  \\endDoxyCode%\n"

       "}\n\n";

  t << "% Used by @verbatim ... @endverbatim\n"

       "\\newenvironment{DoxyVerb}{%\n"

       "  \\footnotesize%\n"

       "  \\verbatim%\n"

       "}{%\n"

       "  \\endverbatim%\n"

       "  \\normalsize%\n"

       "}\n\n";

  t << "% Used by @verbinclude\n"

       "\\newenvironment{DoxyVerbInclude}{%\n"

       "  \\DoxyVerb%\n"

       "}{%\n"

       "  \\endDoxyVerb%\n"

       "}\n\n";

  t << "% Used by numbered lists (using '-#' or <ol> ... </ol>)\n"

       "\\newenvironment{DoxyEnumerate}{%\n"

       "  \\enumerate%\n"

       "}{%\n"

       "  \\endenumerate%\n"

       "}\n\n";

  t << "% Used by bullet lists (using '-', @li, @arg, or <ul> ... </ul>)\n"

       "\\newenvironment{DoxyItemize}{%\n"

       "  \\itemize%\n"

       "}{%\n"

       "  \\enditemize%\n"

       "}\n\n";

  t << "% Used by description lists (using <dl> ... </dl>)\n"

       "\\newenvironment{DoxyDescription}{%\n"

       "  \\description%\n"

       "}{%\n"

       "  \\enddescription%\n"

       "}\n\n";

  t << "% Used by @image, @dotfile, and @dot ... @enddot\n"

       "% (only if caption is specified)\n"

       "\\newenvironment{DoxyImage}{%\n"

       "  \\begin{figure}[H]%\n"

       "  \\begin{center}%\n"

       "}{%\n"

       "  \\end{center}%\n"

       "  \\end{figure}%\n"

       "}\n\n";

  t << "% Used by @image, @dotfile, @dot ... @enddot, and @msc ... @endmsc\n"

       "% (only if no caption is specified)\n"

       "\\newenvironment{DoxyImageNoCaption}{%\n"

       "}{%\n"

       "}\n\n";

  t << "% Used by @attention\n"

       "\\newenvironment{DoxyAttention}[1]{%\n"

       "  \\begin{DoxyDesc}{#1}%\n"

       "}{%\n"

       "  \\end{DoxyDesc}%\n"

       "}\n\n";

  t << "% Used by @author and @authors\n"

       "\\newenvironment{DoxyAuthor}[1]{%\n"

       "  \\begin{DoxyDesc}{#1}%\n"

       "}{%\n"

       "  \\end{DoxyDesc}%\n"

       "}\n\n";

  t << "% Used by @date\n"

       "\\newenvironment{DoxyDate}[1]{%\n"

       "  \\begin{DoxyDesc}{#1}%\n"

       "}{%\n"

       "  \\end{DoxyDesc}%\n"

       "}\n\n";

  t << "% Used by @invariant\n"

       "\\newenvironment{DoxyInvariant}[1]{%\n"

       "  \\begin{DoxyDesc}{#1}%\n"

       "}{%\n"

       "  \\end{DoxyDesc}%\n"

       "}\n\n";

  t << "% Used by @note\n"

       "\\newenvironment{DoxyNote}[1]{%\n"

       "  \\begin{DoxyDesc}{#1}%\n"

       "}{%\n"

       "  \\end{DoxyDesc}%\n"

       "}\n\n";

  t << "% Used by @post\n"

       "\\newenvironment{DoxyPostcond}[1]{%\n"

       "  \\begin{DoxyDesc}{#1}%\n"

       "}{%\n"

       "  \\end{DoxyDesc}%\n"

       "}\n\n";

  t << "% Used by @pre\n"

       "\\newenvironment{DoxyPrecond}[1]{%\n"

       "  \\begin{DoxyDesc}{#1}%\n"

       "}{%\n"

       "  \\end{DoxyDesc}%\n"

       "}\n\n";

  t << "% Used by @remark\n"

       "\\newenvironment{DoxyRemark}[1]{%\n"

       "  \\begin{DoxyDesc}{#1}%\n"

       "}{%\n"

       "  \\end{DoxyDesc}%\n"

       "}\n\n";

  t << "% Used by @return\n"

       "\\newenvironment{DoxyReturn}[1]{%\n"

       "  \\begin{DoxyDesc}{#1}%\n"

       "}{%\n"

       "  \\end{DoxyDesc}%\n"

       "}\n\n";

  t << "% Used by @since\n"

       "\\newenvironment{DoxySince}[1]{%\n"

       "  \\begin{DoxyDesc}{#1}%\n"

       "}{%\n"

       "  \\end{DoxyDesc}%\n"

       "}\n\n";

  t << "% Used by @see\n"

       "\\newenvironment{DoxySeeAlso}[1]{%\n"

       "  \\begin{DoxyDesc}{#1}%\n"

       "}{%\n"

       "  \\end{DoxyDesc}%\n"

       "}\n\n";

  t << "% Used by @version\n"

       "\\newenvironment{DoxyVersion}[1]{%\n"

       "  \\begin{DoxyDesc}{#1}%\n"

       "}{%\n"

       "  \\end{DoxyDesc}%\n"

       "}\n\n";

  t << "% Used by @warning\n"

       "\\newenvironment{DoxyWarning}[1]{%\n"

       "  \\begin{DoxyDesc}{#1}%\n"

       "}{%\n"

       "  \\end{DoxyDesc}%\n"

       "}\n\n";

  t << "% Used by @internal\n"

       "\\newenvironment{DoxyInternal}[1]{%\n"

       "  \\begin{DoxyDesc}{#1}%\n"

       "}{%\n"

       "  \\end{DoxyDesc}%\n"

       "}\n\n";

  t << "% Used by @par and @paragraph\n"

       "\\newenvironment{DoxyParagraph}[1]{%\n"

       "  \\begin{list}{}%\n"

       "  {%\n"

       "    \\settowidth{\\labelwidth}{40pt}%\n"

       "    \\setlength{\\leftmargin}{\\labelwidth}%\n"

       "    \\setlength{\\parsep}{0pt}%\n"

       "    \\setlength{\\itemsep}{-4pt}%\n"

       "    \\renewcommand{\\makelabel}{\\entrylabel}%\n"

       "  }%\n"

       "  \\item[#1]%\n"

       "}{%\n"

       "  \\end{list}%\n"

       "}\n\n";

  t << "% Used by parameter lists\n"

       "\\newenvironment{DoxyParams}[1]{%\n"

       "  \\begin{DoxyDesc}{#1}%\n"

       "    \\begin{description}%\n"