1 /******************************************************************************

     2  *

     3  * 

     4  *

     5  * Copyright (C) 1997-2008 by Dimitri van Heesch.

     6  *

     7  * Permission to use, copy, modify, and distribute this software and its

     8  * documentation under the terms of the GNU General Public License is hereby 

     9  * granted. No representations are made about the suitability of this software 

    10  * for any purpose. It is provided "as is" without express or implied warranty.

    11  * See the GNU General Public License for more details.

    12  *

    13  * Documents produced by Doxygen are derivative works derived from the

    14  * input used in their production; they are not affected by this license.

    15  *

    16  */

    17 

    18 #include <stdlib.h>

    19 

    20 #include "qtbc.h"

    21 #include <qdir.h>

    22 #include "latexgen.h"

    23 #include "config.h"

    24 #include "message.h"

    25 #include "doxygen.h"

    26 #include "util.h"

    27 #include "diagram.h"

    28 #include "language.h"

    29 #include "version.h"

    30 #include "dot.h"

    31 #include "pagedef.h"

    32 #include "docparser.h"

    33 #include "latexdocvisitor.h"

    34 #include "dirdef.h"

    35 

    36 //static QCString filterTitle(const char *s)

    37 //{

    38 //  QCString tmp=s,result;

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

    40 //  {

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

    42 //    switch(c)

    43 //    {

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

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

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

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

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

    49 //      default:  result+=c;      break;

    50 //    }

    51 //  }

    52 //  return result;  

    53 //}

    54 

    55 

    56 

    57 LatexGenerator::LatexGenerator() : OutputGenerator()

    58 {

    59   dir=Config_getString("LATEX_OUTPUT");

    60   col=0;

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

    62   insideTabbing=FALSE;

    63   firstDescItem=TRUE;

    64   disableLinks=FALSE;

    65   m_indent=0;

    66   templateMemberItem = FALSE;

    67   m_prettyCode=Config_getBool("LATEX_SOURCE_CODE");

    68 }

    69 

    70 LatexGenerator::~LatexGenerator()

    71 {

    72 }

    73 

    74 void LatexGenerator::init()

    75 {

    76   QCString dir=Config_getString("LATEX_OUTPUT");

    77   QDir d(dir);

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

    79   {

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

    81     exit(1);

    82   }

    83   

    84   QCString fileName=dir+"/Makefile";

    85   QFile file(fileName);

    86   if (!file.open(IO_WriteOnly))

    87   {

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

    89     exit(1);

    90   }

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

    92   QCString latex_command = Config_getString("LATEX_CMD_NAME");

    93   QCString mkidx_command = Config_getString("MAKEINDEX_CMD_NAME");

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

    95   QTextStream t(&file);

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

    97   {

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

    99       << endl

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

   101       << endl

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

   103       << endl

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

   105       << endl

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

   107       << endl

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

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

   110       << endl;

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

   112 #if defined(_MSC_VER)

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

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

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

   116 #else

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

   118 #endif

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

   135       << endl

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

   137 #if defined(_MSC_VER)

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

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

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

   141 #else

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

   143 #endif

   144   }

   145   else // use pdflatex for higher quality output

   146   {

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

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

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

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

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

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

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

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

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

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

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

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

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

   160   }

   161 

   162   t << endl

   163     << "clean:" << endl

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

   165 

   166   createSubDirs(d);

   167 }

   168 

   169 static void writeDefaultHeaderPart1(QTextStream &t)

   170 {

   171   // part 1

   172 

   173   QCString paperName;

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

   175   QCString &paperType=Config_getEnum("PAPER_TYPE");

   176   if (paperType=="a4wide") 

   177     paperName="a4"; 

   178   else 

   179     paperName=paperType;

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

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

   182   t << "]{";

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

   184   t << "}\n";

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

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

   187     "\\usepackage{graphicx}\n"

   188     "\\usepackage{multicol}\n"

   189     "\\usepackage{float}\n"

   190     "\\usepackage{listings}\n"

   191     "\\usepackage{color}\n"

   192     "\\usepackage{textcomp}\n"

   193     "\\usepackage{alltt}\n"

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

   195     ;

   196   if (Config_getBool("USE_PDFLATEX"))

   197   {

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

   199   }

   200   if (Config_getBool("PDF_HYPERLINKS")) 

   201   {

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

   203       << "\\ifpdf" << endl

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

   205       << "            pagebackref=true," << endl

   206       << "            colorlinks=true," << endl

   207       << "            linkcolor=blue," << endl

   208       << "            unicode" << endl

   209       << "           ]{hyperref}" << endl

   210       << "\\else" << endl

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

   212       << "            pagebackref=true," << endl

   213       << "            colorlinks=true," << endl

   214       << "            linkcolor=blue," << endl

   215       << "            unicode" << endl

   216       << "           ]{hyperref}" << endl

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

   218       << "\\fi" << endl;

   219   }

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

   221   // support

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

   223   QCString sLanguageSupportCommand(

   224       theTranslator->latexLanguageSupportCommand());

   225 

   226   if (!sLanguageSupportCommand.isEmpty())

   227   {

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

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

   230     t << sLanguageSupportCommand << endl;

   231   }

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

   233 

   234   // define option for listings

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

   236                 "inputencoding=utf8,"

   237                 "basicstyle=\\footnotesize,"

   238                 "breaklines=true,"

   239                 "breakatwhitespace=true,"

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

   241                 "numbers=left }" << endl;

   242 

   243   QStrList &extraPackages = Config_getList("EXTRA_PACKAGES");

   244   const char *s=extraPackages.first();

   245   while (s)

   246   {

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

   248     s=extraPackages.next();

   249   }

   250   t << "\\makeindex\n"

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

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

   253     "\\begin{document}\n";

   254   static bool pdfHyperlinks = Config_getBool("PDF_HYPERLINKS");

   255   static bool usePDFLatex   = Config_getBool("USE_PDFLATEX");

   256   if (pdfHyperlinks && usePDFLatex)

   257   {

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

   259     // the index (be it as roman numbers)

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

   261   }

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

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

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

   265     "\\begin{center}\n"

   266     "{\\Large ";

   267 

   268 }

   269 

   270 static void writeDefaultHeaderPart2(QTextStream &t)

   271 {

   272   // part 2

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

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

   275     << "{\\large ";

   276 }

   277 

   278 static void writeDefaultHeaderPart3(QTextStream &t)

   279 {

   280   // part 3

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

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

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

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

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

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

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

   288   t << "\\tableofcontents\n";

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

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

   291   static bool pdfHyperlinks = Config_getBool("PDF_HYPERLINKS");

   292   static bool usePDFLatex   = Config_getBool("USE_PDFLATEX");

   293   if (pdfHyperlinks && usePDFLatex)

   294   {

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

   296   }

   297 }

   298 

   299 static void writeDefaultStyleSheetPart1(QTextStream &t)

   300 {

   301   // part 1

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

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

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

   305        "\\RequirePackage{alltt}\n"

   306        "\\RequirePackage{array}\n"

   307        "\\RequirePackage{calc}\n"

   308        "\\RequirePackage{color}\n"

   309        "\\RequirePackage{fancyhdr}\n"

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

   311   t << "% Setup fancy headings\n"

   312        "\\pagestyle{fancyplain}\n"

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

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

   315        "}\n";

   316   if (!Config_getBool("COMPACT_LATEX")) 

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

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

   319          "}\n";

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

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

   322        "}\n";

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

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

   325        "}\n";

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

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

   328        "}\n";

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

   330 }

   331 

   332 static void writeDefaultStyleSheetPart2(QTextStream &t)

   333 {

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

   335 }

   336 

   337 static void writeDefaultStyleSheetPart3(QTextStream &t)

   338 {

   339   t << "}}\n";

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

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

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

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

   344        "% those environments!\n"

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

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

   347        "  {%\n"

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

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

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

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

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

   353        "  }%\n"

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

   355        "}{%\n"

   356        "  \\end{list}%\n"

   357        "}\n\n";

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

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

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

   361        "  \\small%\n"

   362        "  \\begin{alltt}%\n"

   363        "}{%\n"

   364        "  \\end{alltt}%\n"

   365        "  \\normalsize%\n"

   366        "}\n\n";

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

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

   369        "  \\footnotesize%\n"

   370        "  \\verbatim%\n"

   371        "}{%\n"

   372        "  \\endverbatim%\n"

   373        "  \\normalsize%\n"

   374        "}\n\n";

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

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

   377        "  \\DoxyCode%\n"

   378        "}{%\n"

   379        "  \\endDoxyCode%\n"

   380        "}\n\n";

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

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

   383        "  \\footnotesize%\n"

   384        "  \\verbatim%\n"

   385        "}{%\n"

   386        "  \\endverbatim%\n"

   387        "  \\normalsize%\n"

   388        "}\n\n";

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

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

   391        "  \\DoxyVerb%\n"

   392        "}{%\n"

   393        "  \\endDoxyVerb%\n"

   394        "}\n\n";

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

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

   397        "  \\enumerate%\n"

   398        "}{%\n"

   399        "  \\endenumerate%\n"

   400        "}\n\n";

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

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

   403        "  \\itemize%\n"

   404        "}{%\n"

   405        "  \\enditemize%\n"

   406        "}\n\n";

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

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

   409        "  \\description%\n"

   410        "}{%\n"

   411        "  \\enddescription%\n"

   412        "}\n\n";

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

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

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

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

   417        "  \\begin{center}%\n"

   418        "}{%\n"

   419        "  \\end{center}%\n"

   420        "  \\end{figure}%\n"

   421        "}\n\n";

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

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

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

   425        "}{%\n"

   426        "}\n\n";

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

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

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

   430        "}{%\n"

   431        "  \\end{DoxyDesc}%\n"

   432        "}\n\n";

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

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

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

   436        "}{%\n"

   437        "  \\end{DoxyDesc}%\n"

   438        "}\n\n";

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

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

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

   442        "}{%\n"

   443        "  \\end{DoxyDesc}%\n"

   444        "}\n\n";

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

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

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

   448        "}{%\n"

   449        "  \\end{DoxyDesc}%\n"

   450        "}\n\n";

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

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

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

   454        "}{%\n"

   455        "  \\end{DoxyDesc}%\n"

   456        "}\n\n";

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

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

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

   460        "}{%\n"

   461        "  \\end{DoxyDesc}%\n"

   462        "}\n\n";

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

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

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

   466        "}{%\n"

   467        "  \\end{DoxyDesc}%\n"

   468        "}\n\n";

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

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

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

   472        "}{%\n"

   473        "  \\end{DoxyDesc}%\n"

   474        "}\n\n";

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

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

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

   478        "}{%\n"

   479        "  \\end{DoxyDesc}%\n"

   480        "}\n\n";

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

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

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

   484        "}{%\n"

   485        "  \\end{DoxyDesc}%\n"

   486        "}\n\n";

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

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

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

   490        "}{%\n"

   491        "  \\end{DoxyDesc}%\n"

   492        "}\n\n";

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

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

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

   496        "}{%\n"

   497        "  \\end{DoxyDesc}%\n"

   498        "}\n\n";

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

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

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

   502        "}{%\n"

   503        "  \\end{DoxyDesc}%\n"

   504        "}\n\n";

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

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

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

   508        "}{%\n"

   509        "  \\end{DoxyDesc}%\n"

   510        "}\n\n";

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

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

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

   514        "  {%\n"

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

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

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

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

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

   520        "  }%\n"

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

   522        "}{%\n"

   523        "  \\end{list}%\n"

   524        "}\n\n";

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

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

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

   528        "    \\begin{description}%\n"

   529        "}{%\n"

   530        "    \\end{description}%\n"

   531        "  \\end{DoxyDesc}%\n"

   532        "}\n\n";

   533   t << "% Used by return value lists\n"

   534        "\\newenvironment{DoxyRetVals}[1]{%\n"

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

   536        "    \\begin{description}%\n"

   537        "}{%\n"

   538        "    \\end{description}%\n"

   539        "  \\end{DoxyDesc}%\n"

   540        "}\n\n";

   541   t << "% Used by exception lists\n"

   542        "\\newenvironment{DoxyExceptions}[1]{%\n"

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

   544        "    \\begin{description}%\n"

   545        "}{%\n"

   546        "    \\end{description}%\n"

   547        "  \\end{DoxyDesc}%\n"

   548        "}\n\n";

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

   550        "\\newenvironment{DoxyTemplParams}[1]{%\n"

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

   552        "    \\begin{description}%\n"

   553        "}{%\n"

   554        "    \\end{description}%\n"

   555        "  \\end{DoxyDesc}%\n"

   556        "}\n\n";

   557   t << "\\newcommand{\\doxyref}[3]{\\textbf{#1} (\\textnormal{#2}\\,\\pageref{#3})}\n";

   558   t << "\\newenvironment{DoxyCompactList}\n";

   559   t << "{\\begin{list}{}{\n";

   560   t << "  \\setlength{\\leftmargin}{0.5cm}\n";

   561   t << "  \\setlength{\\itemsep}{0pt}\n";

   562   t << "  \\setlength{\\parsep}{0pt}\n";

   563   t << "  \\setlength{\\topsep}{0pt}\n";

   564   t << "  \\renewcommand{\\makelabel}{\\hfill}}}\n";

   565   t << "{\\end{list}}\n";

   566   t << "\\newenvironment{DoxyCompactItemize}\n";

   567   t << "{\n";

   568   t << "  \\begin{itemize}\n";

   569   t << "  \\setlength{\\itemsep}{-3pt}\n";

   570   t << "  \\setlength{\\parsep}{0pt}\n";

   571   t << "  \\setlength{\\topsep}{0pt}\n";

   572   t << "  \\setlength{\\partopsep}{0pt}\n";

   573   t << "}\n";

   574   t << "{\\end{itemize}}\n";

   575   t << "\\newcommand{\\PBS}[1]{\\let\\temp=\\\\#1\\let\\\\=\\temp}\n";

   576   t << "\\newlength{\\tmplength}\n";

   577   t << "\\newenvironment{TabularC}[1]\n";

   578   t << "{\n";

   579   t << "\\setlength{\\tmplength}\n";

   580   t << "     {\\linewidth/(#1)-\\tabcolsep*2-\\arrayrulewidth*(#1+1)/(#1)}\n";

   581   t << "      \\par\\begin{tabular*}{\\linewidth}\n";

   582   t << "             {*{#1}{|>{\\PBS\\raggedright\\hspace{0pt}}p{\\the\\tmplength}}|}\n";

   583   t << "}\n";

   584   t << "{\\end{tabular*}\\par}\n";

   585   t << "\\newcommand{\\entrylabel}[1]{\n";

   586   t << "   {\\parbox[b]{\\labelwidth-4pt}{\\makebox[0pt][l]{\\textbf{#1}}\\vspace{1.5\\baselineskip}}}}\n";

   587   t << "\\newenvironment{Desc}\n";

   588   t << "{\\begin{list}{}\n";

   589   t << "  {\n";

   590   t << "    \\settowidth{\\labelwidth}{40pt}\n";

   591   t << "    \\setlength{\\leftmargin}{\\labelwidth}\n";

   592   t << "    \\setlength{\\parsep}{0pt}\n";

   593   t << "    \\setlength{\\itemsep}{-4pt}\n";

   594   t << "    \\renewcommand{\\makelabel}{\\entrylabel}\n";

   595   t << "  }\n";

   596   t << "}\n";

   597   t << "{\\end{list}}\n";

   598 

   599   t << "\\newenvironment{Indent}\n";

   600   t << "  {\\begin{list}{}{\\setlength{\\leftmargin}{0.5cm}}\n";

   601   t << "      \\item[]\\ignorespaces}\n";

   602   t << "  {\\unskip\\end{list}}\n";

   603 

   604   t << "\\setlength{\\parindent}{0cm}\n";

   605   t << "\\setlength{\\parskip}{0.2cm}\n";

   606   t << "\\addtocounter{secnumdepth}{1}\n";

   607   t << "\\sloppy\n";

   608   t << "\\usepackage[T1]{fontenc}\n";

   609   t << "\\makeatletter\n";

   610   t << "\\renewcommand{\\paragraph}{\\@startsection{paragraph}{4}{0ex}%\n";

   611   t << "   {-3.25ex plus -1ex minus -0.2ex}%\n";

   612   t << "   {1.5ex plus 0.2ex}%\n";

   613   t << "   {\\normalfont\\normalsize\\bfseries}}\n";

   614   t << "\\makeatother\n";

   615   t << "\\stepcounter{secnumdepth}\n";

   616   t << "\\stepcounter{tocdepth}\n";

   617   t << "\\definecolor{comment}{rgb}{0.5,0.0,0.0}\n";

   618   t << "\\definecolor{keyword}{rgb}{0.0,0.5,0.0}\n";

   619   t << "\\definecolor{keywordtype}{rgb}{0.38,0.25,0.125}\n";

   620   t << "\\definecolor{keywordflow}{rgb}{0.88,0.5,0.0}\n";

   621   t << "\\definecolor{preprocessor}{rgb}{0.5,0.38,0.125}\n";

   622   t << "\\definecolor{stringliteral}{rgb}{0.0,0.125,0.25}\n";

   623   t << "\\definecolor{charliteral}{rgb}{0.0,0.5,0.5}\n";

   624   t << "\\definecolor{vhdldigit}{rgb}{1.0,0.0,1.0}\n";

   625   t << "\\definecolor{vhdlkeyword}{rgb}{0.43,0.0,0.43}\n";

   626   t << "\\definecolor{vhdllogic}{rgb}{1.0,0.0,0.0}\n";

   627   t << "\\definecolor{vhdlchar}{rgb}{0.0,0.0,0.0}\n";

   628 }

   629 

   630 void LatexGenerator::writeHeaderFile(QFile &f)

   631 {

   632   QTextStream t(&f);

   633   writeDefaultHeaderPart1(t);

   634   t << "Your title here";

   635   writeDefaultHeaderPart2(t);

   636   t << "Generated by";

   637   writeDefaultHeaderPart3(t);

   638 }

   639 

   640 void LatexGenerator::writeStyleSheetFile(QFile &f)

   641 {

   642   QTextStream t(&f);

   643   t.setEncoding(QTextStream::UnicodeUTF8);

   644 

   645   writeDefaultStyleSheetPart1(t);

   646   QCString &projectName = Config_getString("PROJECT_NAME");

   647 

   648   t << theTranslator->trGeneratedAt( dateToString(TRUE), projectName );

   649   t << " doxygen";

   650   //t << " " << theTranslator->trWrittenBy() << " ";

   651   //t << "Dimitri van Heesch \\copyright~1997-2008";

   652   writeDefaultStyleSheetPart2(t);

   653   t << theTranslator->trGeneratedAt( dateToString(TRUE), projectName );

   654   t << " doxygen";

   655   //t << " << theTranslator->trWrittenBy() << " ";

   656   //t << "Dimitri van Heesch \\copyright~1997-2008";

   657   writeDefaultStyleSheetPart3(t);

   658 }

   659 

   660 void LatexGenerator::startFile(const char *name,const char *,const char *)

   661 {

   662 #if 0

   663   setEncoding(Config_getString("LATEX_OUTPUT_ENCODING"));

   664 #endif

   665   QCString fileName=name;

   666   relPath = relativePathToRoot(fileName);

   667   sourceFileName = stripPath(fileName);

   668   if (fileName.right(4)!=".tex" && fileName.right(4)!=".sty") fileName+=".tex";

   669   startPlainFile(fileName);

   670 }

   671 

   672 void LatexGenerator::endFile()

   673 {

   674   endPlainFile();

   675   sourceFileName.resize(0);

   676 }

   677 

   678 //void LatexGenerator::writeIndex()

   679 //{

   680 //  startFile("refman.tex");

   681 //} 

   682   

   683 void LatexGenerator::startProjectNumber()

   684 {

   685   t << "\\\\[1ex]\\large "; 

   686 }

   687 

   688 void LatexGenerator::startIndexSection(IndexSections is)

   689 {

   690   bool &compactLatex = Config_getBool("COMPACT_LATEX");

   691   QCString &latexHeader = Config_getString("LATEX_HEADER");

   692   switch (is)

   693   {

   694     case isTitlePageStart:

   695       {

   696         if (latexHeader.isEmpty())

   697         {

   698           writeDefaultHeaderPart1(t);

   699         }

   700         else

   701         {

   702           QCString header = fileToString(latexHeader);

   703           t << substituteKeywords(header,0);

   704         }

   705       }

   706       break;

   707     case isTitlePageAuthor:

   708       if (latexHeader.isEmpty())

   709       {

   710         writeDefaultHeaderPart2(t);

   711       }

   712       break;

   713     case isMainPage:

   714       if (compactLatex) t << "\\section"; else t << "\\chapter";

   715       t << "{"; //Introduction}\n"

   716       break;

   717     //case isPackageIndex:

   718     //  if (compactLatex) t << "\\section"; else t << "\\chapter";

   719     //  t << "{"; //Package Index}\n"

   720     //  break;

   721     case isModuleIndex:

   722       if (compactLatex) t << "\\section"; else t << "\\chapter";

   723       t << "{"; //Module Index}\n"

   724       break;

   725     case isDirIndex:

   726       if (compactLatex) t << "\\section"; else t << "\\chapter";

   727       t << "{"; //Directory Index}\n"

   728       break;

   729     case isNamespaceIndex:

   730       if (compactLatex) t << "\\section"; else t << "\\chapter";

   731       t << "{"; //Namespace Index}\"

   732       break;

   733     case isClassHierarchyIndex:

   734       if (compactLatex) t << "\\section"; else t << "\\chapter";

   735       t << "{"; //Hierarchical Index}\n"

   736       break;

   737     case isCompoundIndex:

   738       if (compactLatex) t << "\\section"; else t << "\\chapter";

   739       t << "{"; //Annotated Compound Index}\n"

   740       break;

   741     case isFileIndex:

   742       if (compactLatex) t << "\\section"; else t << "\\chapter";

   743       t << "{"; //Annotated File Index}\n"

   744       break;

   745     case isPageIndex:

   746       if (compactLatex) t << "\\section"; else t << "\\chapter";

   747       t << "{"; //Annotated Page Index}\n"

   748       break;

   749     case isModuleDocumentation:

   750       {

   751         GroupSDict::Iterator gli(*Doxygen::groupSDict);

   752         GroupDef *gd;

   753         bool found=FALSE;

   754         for (gli.toFirst();(gd=gli.current()) && !found;++gli)

   755         {

   756           if (!gd->isReference())

   757           {

   758             if (compactLatex) t << "\\section"; else t << "\\chapter";

   759             t << "{"; //Module Documentation}\n";

   760             found=TRUE;

   761           }

   762         }

   763       }

   764       break;

   765     case isDirDocumentation:

   766       {

   767         SDict<DirDef>::Iterator dli(*Doxygen::directories);

   768         DirDef *dd;

   769         bool found=FALSE;

   770         for (dli.toFirst();(dd=dli.current()) && !found;++dli)

   771         {

   772           if (dd->isLinkableInProject())

   773           {

   774             if (compactLatex) t << "\\section"; else t << "\\chapter";

   775             t << "{"; //Module Documentation}\n";

   776             found=TRUE;

   777           }

   778         }

   779       }

   780       break;

   781     case isNamespaceDocumentation:

   782       {

   783         NamespaceSDict::Iterator nli(*Doxygen::namespaceSDict);

   784         NamespaceDef *nd;

   785         bool found=FALSE;

   786         for (nli.toFirst();(nd=nli.current()) && !found;++nli)

   787         {

   788           if (nd->isLinkableInProject())

   789           {

   790             if (compactLatex) t << "\\section"; else t << "\\chapter";

   791             t << "{"; // Namespace Documentation}\n":

   792             found=TRUE;

   793           }

   794         } 

   795       }

   796       break;

   797     case isClassDocumentation:

   798       {

   799         ClassSDict::Iterator cli(*Doxygen::classSDict);

   800         ClassDef *cd=0;

   801         bool found=FALSE;

   802         for (cli.toFirst();(cd=cli.current()) && !found;++cli)

   803         {

   804           if (cd->isLinkableInProject() && cd->templateMaster()==0)

   805           {

   806             if (compactLatex) t << "\\section"; else t << "\\chapter";

   807             t << "{"; //Compound Documentation}\n";

   808             found=TRUE;

   809           }

   810         }

   811       }

   812       break;

   813     case isFileDocumentation:

   814       {

   815         bool isFirst=TRUE;

   816         FileName *fn=Doxygen::inputNameList->first();

   817         while (fn)

   818         {

   819           FileDef *fd=fn->first();

   820           while (fd)

   821           {

   822             if (fd->isLinkableInProject())

   823             {

   824               if (isFirst)

   825               {

   826                 if (compactLatex) t << "\\section"; else t << "\\chapter";

   827                 t << "{"; //File Documentation}\n";

   828                 isFirst=FALSE;

   829                 break;

   830               }

   831             }

   832             fd=fn->next();

   833           }

   834           fn=Doxygen::inputNameList->next();

   835         }

   836       }

   837       break;

   838     case isExampleDocumentation:

   839       {

   840         if (compactLatex) t << "\\section"; else t << "\\chapter";

   841         t << "{"; //Example Documentation}\n";

   842       }

   843       break;

   844     case isPageDocumentation:

   845       {

   846         if (compactLatex) t << "\\section"; else t << "\\chapter";

   847         t << "{"; //Page Documentation}\n";

   848       }

   849       break;

   850     case isPageDocumentation2:

   851       break;

   852     case isEndIndex:

   853       break;

   854   }

   855 }

   856 

   857 void LatexGenerator::endIndexSection(IndexSections is)

   858 {

   859   static bool compactLatex = Config_getBool("COMPACT_LATEX");

   860   static bool sourceBrowser = Config_getBool("SOURCE_BROWSER");

   861   static QCString latexHeader = Config_getString("LATEX_HEADER");

   862   switch (is)

   863   {

   864     case isTitlePageStart:

   865       break;

   866     case isTitlePageAuthor:

   867       if (latexHeader.isEmpty())

   868       {

   869         writeDefaultHeaderPart3(t);

   870       }

   871       break;

   872     case isMainPage:

   873       {

   874         QCString indexName=Config_getBool("GENERATE_TREEVIEW")?"main":"index";

   875         t << "}\n\\label{index}";

   876         if (Config_getBool("PDF_HYPERLINKS")) t << "\\hypertarget{index}{}";

   877         t << "\\input{" << indexName << "}\n";

   878       }

   879       break;

   880     case isModuleIndex:

   881       t << "}\n\\input{modules}\n";

   882       break;

   883     case isDirIndex:

   884       t << "}\n\\input{dirs}\n";

   885       break;

   886     case isNamespaceIndex:

   887       t << "}\n\\input{namespaces}\n";

   888       break;

   889     case isClassHierarchyIndex:

   890       t << "}\n\\input{hierarchy}\n";

   891       break;

   892     case isCompoundIndex:

   893       t << "}\n\\input{annotated}\n";

   894       break;

   895     case isFileIndex:

   896       t << "}\n\\input{files}\n";

   897       break;

   898     case isPageIndex:

   899       t << "}\n\\input{pages}\n";

   900       break;

   901     case isModuleDocumentation:

   902       {

   903         GroupSDict::Iterator gli(*Doxygen::groupSDict);

   904         GroupDef *gd;

   905         bool found=FALSE;

   906         for (gli.toFirst();(gd=gli.current()) && !found;++gli)

   907         {

   908           if (!gd->isReference())

   909           {

   910             t << "}\n\\input{" << gd->getOutputFileBase() << "}\n";

   911             found=TRUE;

   912           }

   913         }

   914         for (;(gd=gli.current());++gli)

   915         {

   916           if (!gd->isReference())

   917           {

   918             if (compactLatex) t << "\\input"; else t << "\\include";

   919             t << "{" << gd->getOutputFileBase() << "}\n";

   920           }

   921         }

   922       }

   923       break;

   924     case isDirDocumentation:

   925       {

   926         SDict<DirDef>::Iterator dli(*Doxygen::directories);

   927         DirDef *dd;

   928         bool found=FALSE;

   929         for (dli.toFirst();(dd=dli.current()) && !found;++dli)

   930         {

   931           if (dd->isLinkableInProject())

   932           {

   933             t << "}\n\\input{" << dd->getOutputFileBase() << "}\n";

   934             found=TRUE;

   935           }

   936         }

   937         for (;(dd=dli.current());++dli)

   938         {

   939           if (dd->isLinkableInProject())

   940           {

   941             if (compactLatex) t << "\\input"; else t << "\\include";

   942             t << "{" << dd->getOutputFileBase() << "}\n";

   943           }

   944         }

   945       }

   946       break;

   947     case isNamespaceDocumentation:

   948       {

   949         NamespaceSDict::Iterator nli(*Doxygen::namespaceSDict);

   950         NamespaceDef *nd;

   951         bool found=FALSE;

   952         for (nli.toFirst();(nd=nli.current()) && !found;++nli)

   953         {

   954           if (nd->isLinkableInProject())

   955           {

   956             t << "}\n\\input{" << nd->getOutputFileBase() << "}\n";

   957             found=TRUE;

   958           }

   959         }

   960         while ((nd=nli.current()))

   961         {

   962           if (nd->isLinkableInProject())

   963           {

   964             if (compactLatex) t << "\\input"; else t << "\\include";

   965             t << "{" << nd->getOutputFileBase() << "}\n";

   966           }

   967           ++nli;

   968         }

   969       }

   970       break;

   971     case isClassDocumentation:

   972       {

   973         ClassSDict::Iterator cli(*Doxygen::classSDict);

   974         ClassDef *cd=0;

   975         bool found=FALSE;

   976         for (cli.toFirst();(cd=cli.current()) && !found;++cli)

   977         {

   978           if (cd->isLinkableInProject() && cd->templateMaster()==0)

   979           {

   980             t << "}\n\\input{" << cd->getOutputFileBase() << "}\n";

   981             found=TRUE;

   982           }

   983         }

   984         for (;(cd=cli.current());++cli)

   985         {

   986           if (cd->isLinkableInProject() && cd->templateMaster()==0)

   987           {

   988             if (compactLatex) t << "\\input"; else t << "\\include";

   989             t << "{" << cd->getOutputFileBase() << "}\n";

   990           } 

   991         }

   992       }

   993       break;

   994     case isFileDocumentation:

   995       {

   996         bool isFirst=TRUE;

   997         FileName *fn=Doxygen::inputNameList->first();

   998         while (fn)

   999         {

  1000           FileDef *fd=fn->first();

  1001           while (fd)

  1002           {

  1003             if (fd->isLinkableInProject())

  1004             {

  1005               if (isFirst)

  1006               {

  1007                 t << "}\n\\input{" << fd->getOutputFileBase() << "}\n";

  1008                 if (sourceBrowser && m_prettyCode && fd->generateSourceFile())

  1009                 {

  1010                   t << "\\include{" << fd->getSourceFileBase() << "}\n";

  1011                 }

  1012                 isFirst=FALSE;

  1013               }

  1014               else

  1015               {

  1016                 if (compactLatex) t << "\\input" ; else t << "\\include";

  1017                 t << "{" << fd->getOutputFileBase() << "}\n";

  1018                 if (sourceBrowser && m_prettyCode && fd->generateSourceFile())

  1019                 {

  1020                   t << "\\include{" << fd->getSourceFileBase() << "}\n";

  1021                 }

  1022               }

  1023             }

  1024             fd=fn->next();

  1025           }

  1026           fn=Doxygen::inputNameList->next();

  1027         }

  1028       }

  1029       break;

  1030     case isExampleDocumentation:

  1031       {

  1032         t << "}\n";

  1033         PageSDict::Iterator pdi(*Doxygen::exampleSDict);

  1034         PageDef *pd=pdi.toFirst();

  1035         if (pd)

  1036         {

  1037           t << "\\input{" << pd->getOutputFileBase() << "}\n";

  1038         }

  1039         for (++pdi;(pd=pdi.current());++pdi)

  1040         {

  1041           if (compactLatex) t << "\\input" ; else t << "\\include";

  1042           t << "{" << pd->getOutputFileBase() << "}\n";

  1043         }

  1044       }

  1045       break;

  1046     case isPageDocumentation:

  1047       {

  1048         t << "}\n";

  1049 #if 0

  1050         PageSDict::Iterator pdi(*Doxygen::pageSDict);

  1051         PageDef *pd=pdi.toFirst();

  1052         bool first=TRUE;

  1053         for (pdi.toFirst();(pd=pdi.current());++pdi)

  1054         {

  1055           if (!pd->getGroupDef() && !pd->isReference())

  1056           {

  1057              if (compactLatex) t << "\\section"; else t << "\\chapter";

  1058              t << "{" << pd->title();

  1059              t << "}\n";

  1060             

  1061             if (compactLatex || first) t << "\\input" ; else t << "\\include";

  1062             t << "{" << pd->getOutputFileBase() << "}\n";

  1063             first=FALSE;

  1064           }

  1065         }

  1066 #endif

  1067       }

  1068       break;

  1069     case isPageDocumentation2:

  1070       break;

  1071     case isEndIndex:

  1072       t << "\\printindex\n";

  1073       t << "\\end{document}\n";

  1074       break;

  1075   }

  1076 }

  1077 

  1078 void LatexGenerator::writePageLink(const char *name, bool first)

  1079 {

  1080   bool &compactLatex = Config_getBool("COMPACT_LATEX");

  1081   if (compactLatex || first) t << "\\input" ; else t << "\\include";

  1082   t << "{" << name << "}\n";

  1083 }

  1084 

  1085 

  1086 void LatexGenerator::writeStyleInfo(int part)

  1087 {

  1088   switch(part)

  1089   {

  1090     case 0:

  1091       {

  1092         //QCString pname=Config_getString("PROJECT_NAME").stripWhiteSpace();

  1093         startPlainFile("doxygen.sty");

  1094         writeDefaultStyleSheetPart1(t);

  1095       }

  1096       break;

  1097     case 1:

  1098     case 3:

  1099       t << " Doxygen ";

  1100       break;

  1101     case 2:

  1102       {

  1103         //t << " Dimitri van Heesch \\copyright~1997-2008";

  1104         t << "}]{}\n";

  1105         writeDefaultStyleSheetPart2(t);

  1106       }

  1107       break;

  1108     case 4:

  1109       {

  1110         //t << " Dimitri van Heesch \\copyright~1997-2008";

  1111         writeDefaultStyleSheetPart3(t);

  1112         endPlainFile();

  1113       }

  1114       break;

  1115   }

  1116 }

  1117 

  1118 void LatexGenerator::newParagraph()

  1119 {

  1120   t << endl << endl;

  1121 }

  1122 

  1123 void LatexGenerator::startParagraph()

  1124 {

  1125   t << endl << endl;

  1126 }

  1127 

  1128 void LatexGenerator::endParagraph()

  1129 {

  1130 }

  1131 

  1132 void LatexGenerator::writeString(const char *text)

  1133 {

  1134   t << text;