My Project
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
LatexGenerator Class Reference

#include <latexgen.h>

Inheritance diagram for LatexGenerator:
OutputGenerator BaseOutputDocInterface CodeOutputInterface

Public Member Functions

 LatexGenerator ()
 
 ~LatexGenerator ()
 
void enable ()
 
void disable ()
 
void enableIf (OutputType o)
 
void disableIf (OutputType o)
 
void disableIfNot (OutputType o)
 
bool isEnabled (OutputType o)
 
OutputGenerator * get (OutputType o)
 
void codify (const char *text)
 
void writeCodeLink (const char *ref, const char *file, const char *anchor, const char *name, const char *tooltip)
 
void writeLineNumber (const char *ref, const char *file, const char *anchor, int lineNumber)
 
void writeTooltip (const char *id, const DocLinkInfo &docInfo, const char *decl, const char *desc, const SourceLinkInfo &defInfo, const SourceLinkInfo &declInfo)
 
void startCodeLine (bool hasLineNumbers)
 
void endCodeLine ()
 
void startFontClass (const char *s)
 
void endFontClass ()
 
void writeCodeAnchor (const char *anchor)
 
void writeDoc (DocNode *, Definition *ctx, MemberDef *)
 
void startFile (const char *name, const char *manName, const char *title)
 
void writeSearchInfo ()
 
void writeFooter (const char *)
 
void endFile ()
 
void clearBuffer ()
 
void startIndexSection (IndexSections)
 
void endIndexSection (IndexSections)
 
void writePageLink (const char *, bool)
 
void startProjectNumber ()
 
void endProjectNumber ()
 
void writeStyleInfo (int part)
 
void startTitleHead (const char *)
 
void startTitle ()
 
void endTitleHead (const char *, const char *name)
 
void endTitle ()
 
void newParagraph ()
 
void startParagraph ()
 
void endParagraph ()
 
void writeString (const char *text)
 
void startIndexListItem ()
 
void endIndexListItem ()
 
void startIndexList ()
 
void endIndexList ()
 
void startIndexKey ()
 
void endIndexKey ()
 
void startIndexValue (bool)
 
void endIndexValue (const char *, bool)
 
void startItemList ()
 
void endItemList ()
 
void startIndexItem (const char *ref, const char *file)
 
void endIndexItem (const char *ref, const char *file)
 
void docify (const char *text)
 
void writeObjectLink (const char *ref, const char *file, const char *anchor, const char *name)
 
void startTextLink (const char *, const char *)
 
void endTextLink ()
 
void startHtmlLink (const char *url)
 
void endHtmlLink ()
 
void startTypewriter ()
 
void endTypewriter ()
 
void startGroupHeader (int)
 
void endGroupHeader (int)
 
void startItemListItem ()
 
void endItemListItem ()
 
void startMemberSections ()
 
void endMemberSections ()
 
void startHeaderSection ()
 
void endHeaderSection ()
 
void startMemberHeader (const char *)
 
void endMemberHeader ()
 
void startMemberSubtitle ()
 
void endMemberSubtitle ()
 
void startMemberDocList ()
 
void endMemberDocList ()
 
void startMemberList ()
 
void endMemberList ()
 
void startInlineHeader ()
 
void endInlineHeader ()
 
void startAnonTypeScope (int)
 
void endAnonTypeScope (int)
 
void startMemberItem (const char *, int, const char *)
 
void endMemberItem ()
 
void startMemberTemplateParams ()
 
void endMemberTemplateParams (const char *, const char *)
 
void startMemberGroupHeader (bool)
 
void endMemberGroupHeader ()
 
void startMemberGroupDocs ()
 
void endMemberGroupDocs ()
 
void startMemberGroup ()
 
void endMemberGroup (bool)
 
void insertMemberAlign (bool)
 
void writeRuler ()
 
void writeAnchor (const char *fileName, const char *name)
 
void startCodeFragment ()
 
void endCodeFragment ()
 
void startEmphasis ()
 
void endEmphasis ()
 
void startBold ()
 
void endBold ()
 
void startDescription ()
 
void endDescription ()
 
void startDescItem ()
 
void endDescItem ()
 
void lineBreak (const char *style=0)
 
void startMemberDoc (const char *, const char *, const char *, const char *, int, int, bool)
 
void endMemberDoc (bool)
 
void startDoxyAnchor (const char *, const char *, const char *, const char *, const char *)
 
void endDoxyAnchor (const char *, const char *)
 
void writeChar (char c)
 
void writeLatexSpacing ()
 
void writeStartAnnoItem (const char *type, const char *file, const char *path, const char *name)
 
void writeEndAnnoItem (const char *name)
 
void startSubsection ()
 
void endSubsection ()
 
void startSubsubsection ()
 
void endSubsubsection ()
 
void startCenter ()
 
void endCenter ()
 
void startSmall ()
 
void endSmall ()
 
void startMemberDescription (const char *, const char *)
 
void endMemberDescription ()
 
void startMemberDeclaration ()
 
void endMemberDeclaration (const char *, const char *)
 
void writeInheritedSectionTitle (const char *, const char *, const char *, const char *, const char *, const char *)
 
void startDescList (SectionTypes)
 
void endDescList ()
 
void startSimpleSect (SectionTypes, const char *, const char *, const char *)
 
void endSimpleSect ()
 
void startParamList (ParamListTypes, const char *title)
 
void endParamList ()
 
void startDescForItem ()
 
void endDescForItem ()
 
void startSection (const char *, const char *, SectionInfo::SectionType)
 
void endSection (const char *, SectionInfo::SectionType)
 
void addIndexItem (const char *, const char *)
 
void startIndent ()
 
void endIndent ()
 
void writeSynopsis ()
 
void startClassDiagram ()
 
void endClassDiagram (const ClassDiagram &, const char *, const char *)
 
void startPageRef ()
 
void endPageRef (const char *, const char *)
 
void startQuickIndices ()
 
void endQuickIndices ()
 
void writeSplitBar (const char *)
 
void writeNavigationPath (const char *)
 
void writeLogo ()
 
void writeQuickLinks (bool, HighlightedItem, const char *)
 
void writeSummaryLink (const char *, const char *, const char *, bool)
 
void startContents ()
 
void endContents ()
 
void writeNonBreakableSpace (int)
 
void startDescTable (const char *title)
 
void endDescTable ()
 
void startDescTableRow ()
 
void endDescTableRow ()
 
void startDescTableTitle ()
 
void endDescTableTitle ()
 
void startDescTableData ()
 
void endDescTableData ()
 
void lastIndexPage ()
 
void startDotGraph ()
 
void endDotGraph (const DotClassGraph &)
 
void startInclDepGraph ()
 
void endInclDepGraph (const DotInclDepGraph &)
 
void startCallGraph ()
 
void startGroupCollaboration ()
 
void endGroupCollaboration (const DotGroupCollaboration &g)
 
void endCallGraph (const DotCallGraph &)
 
void startDirDepGraph ()
 
void endDirDepGraph (const DotDirDeps &g)
 
void writeGraphicalHierarchy (const DotGfxHierarchyTable &)
 
void startTextBlock (bool)
 
void endTextBlock (bool)
 
void startMemberDocPrefixItem ()
 
void endMemberDocPrefixItem ()
 
void startMemberDocName (bool)
 
void endMemberDocName ()
 
void startParameterType (bool, const char *)
 
void endParameterType ()
 
void startParameterName (bool)
 
void endParameterName (bool, bool, bool)
 
void startParameterList (bool)
 
void endParameterList ()
 
void exceptionEntry (const char *, bool)
 
void startConstraintList (const char *)
 
void startConstraintParam ()
 
void endConstraintParam ()
 
void startConstraintType ()
 
void endConstraintType ()
 
void startConstraintDocs ()
 
void endConstraintDocs ()
 
void endConstraintList ()
 
void startMemberDocSimple (bool)
 
void endMemberDocSimple (bool)
 
void startInlineMemberType ()
 
void endInlineMemberType ()
 
void startInlineMemberName ()
 
void endInlineMemberName ()
 
void startInlineMemberDoc ()
 
void endInlineMemberDoc ()
 
void startLabels ()
 
void writeLabel (const char *l, bool isLast)
 
void endLabels ()
 
void setCurrentDoc (Definition *, const char *, bool)
 
void addWord (const char *, bool)
 
- Public Member Functions inherited from OutputGenerator
 OutputGenerator ()
 
virtual ~OutputGenerator ()
 
void startPlainFile (const char *name)
 
void endPlainFile ()
 
bool isEnabled () const
 
void pushGeneratorState ()
 
void popGeneratorState ()
 
- Public Member Functions inherited from BaseOutputDocInterface
virtual ~BaseOutputDocInterface ()
 
virtual bool parseText (const QCString &s)
 
- Public Member Functions inherited from CodeOutputInterface
virtual ~CodeOutputInterface ()
 

Static Public Member Functions

static void init ()
 
static void writeStyleSheetFile (QFile &f)
 
static void writeHeaderFile (QFile &f)
 
static void writeFooterFile (QFile &f)
 

Private Member Functions

 LatexGenerator (const LatexGenerator &)
 
LatexGenerator & operator= (const LatexGenerator &)
 

Private Attributes

bool insideTabbing
 
bool firstDescItem
 
bool disableLinks
 
QCString relPath
 
int m_indent
 
bool templateMemberItem
 
bool m_prettyCode
 
LatexCodeGenerator m_codeGen
 

Additional Inherited Members

- Public Types inherited from OutputGenerator
enum  OutputType {
  Html, Latex, Man, RTF,
  XML, DEF, Perl
}
 
- Protected Attributes inherited from OutputGenerator
FTextStream t
 
QFile * file
 
QCString fileName
 
QCString dir
 
bool active
 
QStack< bool > * genStack
 

Detailed Description

Generator for LaTeX output.

Definition at line 70 of file latexgen.h.

Constructor & Destructor Documentation

LatexGenerator::LatexGenerator ( )

Definition at line 246 of file latexgen.cpp.

References Config_getBool, Config_getString, OutputGenerator::dir, disableLinks, firstDescItem, insideTabbing, m_indent, m_prettyCode, and templateMemberItem.

: OutputGenerator()
{
dir=Config_getString(LATEX_OUTPUT);
//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 ( )

Definition at line 258 of file latexgen.cpp.

{
}
LatexGenerator::LatexGenerator ( const LatexGenerator &  )
private

Member Function Documentation

void LatexGenerator::addIndexItem ( const char *  s1,
const char *  s2 
)
virtual

Implements BaseOutputDocInterface.

Definition at line 1641 of file latexgen.cpp.

References insideTabbing, latexEscapeIndexChars(), latexEscapeLabelName(), and OutputGenerator::t.

{
if (s1)
{
t << "\\index{";
t << latexEscapeLabelName(s1,insideTabbing);
t << "@{";
t << latexEscapeIndexChars(s1,insideTabbing);
t << "}";
if (s2)
{
t << "!";
t << latexEscapeLabelName(s2,insideTabbing);
t << "@{";
t << latexEscapeIndexChars(s2,insideTabbing);
t << "}";
}
t << "}";
}
}
void LatexGenerator::addWord ( const char *  ,
bool   
)
inlinevirtual

Implements CodeOutputInterface.

Definition at line 323 of file latexgen.h.

{}
void LatexGenerator::clearBuffer ( )
void LatexGenerator::codify ( const char *  s)
inlinevirtual

Writes an code fragment to the output. This function should keep spaces visible, should break lines at a newline and should convert tabs to the right number of spaces.

Implements CodeOutputInterface.

Definition at line 93 of file latexgen.h.

References LatexCodeGenerator::codify(), and m_codeGen.

{ m_codeGen.codify(text); }
void LatexGenerator::disable ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 85 of file latexgen.h.

References OutputGenerator::active.

Referenced by disableIf(), and disableIfNot().

{ active=FALSE; }
void LatexGenerator::disableIf ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 87 of file latexgen.h.

References disable(), and OutputGenerator::Latex.

{ if (o==Latex) disable(); }
void LatexGenerator::disableIfNot ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 88 of file latexgen.h.

References disable(), and OutputGenerator::Latex.

{ if (o!=Latex) disable(); }
void LatexGenerator::docify ( const char *  s)
virtual

Writes an ASCII string to the output. Converts characters that have A special meaning, like & in html.

Implements BaseOutputDocInterface.

Definition at line 1706 of file latexgen.cpp.

References filterLatexString(), insideTabbing, and OutputGenerator::t.

Referenced by startConstraintList(), startMemberDocSimple(), startParamList(), startSimpleSect(), writeChar(), writeObjectLink(), and writeStartAnnoItem().

{
filterLatexString(t,str,insideTabbing,FALSE,FALSE);
}
void LatexGenerator::enable ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 83 of file latexgen.h.

References OutputGenerator::active, and OutputGenerator::genStack.

Referenced by enableIf().

{ if (genStack->top()) active=*genStack->top(); else active=TRUE; }
void LatexGenerator::enableIf ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 86 of file latexgen.h.

References enable(), and OutputGenerator::Latex.

{ if (o==Latex) enable(); }
void LatexGenerator::endAnonTypeScope ( int  indent)
virtual

Implements OutputGenerator.

Definition at line 1743 of file latexgen.cpp.

References endl(), insideTabbing, m_indent, and OutputGenerator::t.

{
if (indent==0)
{
t << endl << "\\end{tabbing}";
insideTabbing=FALSE;
}
m_indent=indent;
}
void LatexGenerator::endBold ( )
inlinevirtual

End a section of text displayed in bold face.

Implements BaseOutputDocInterface.

Definition at line 205 of file latexgen.h.

References OutputGenerator::t.

{ t << "}"; }
void LatexGenerator::endCallGraph ( const DotCallGraph &  g)
virtual

Implements OutputGenerator.

Definition at line 1980 of file latexgen.cpp.

References Config_getString, EOF_LaTeX, OutputGenerator::fileName, GOF_EPS, relPath, OutputGenerator::t, and DotCallGraph::writeGraph().

{
g.writeGraph(t,GOF_EPS,EOF_LaTeX,Config_getString(LATEX_OUTPUT),fileName,relPath);
}
void LatexGenerator::endCenter ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 225 of file latexgen.h.

References endl(), and OutputGenerator::t.

{ t << "\\end{center}" << endl; }
void LatexGenerator::endClassDiagram ( const ClassDiagram &  d,
const char *  fileName,
const char *   
)
virtual

Implements OutputGenerator.

Definition at line 1725 of file latexgen.cpp.

References OutputGenerator::dir, OutputGenerator::t, and ClassDiagram::writeFigure().

{
d.writeFigure(t,dir,fileName);
}
void LatexGenerator::endCodeFragment ( )
virtual

Ends a source code fragment

Implements BaseOutputDocInterface.

Definition at line 2156 of file latexgen.cpp.

References OutputGenerator::t.

{
t << "\\end{DoxyCode}\n";
}
void LatexGenerator::endCodeLine ( )
inlinevirtual

Ends a line of code started with startCodeLine()

Implements CodeOutputInterface.

Definition at line 107 of file latexgen.h.

References LatexCodeGenerator::endCodeLine(), and m_codeGen.

{ m_codeGen.endCodeLine(); }
void LatexGenerator::endConstraintDocs ( )
virtual

Implements OutputGenerator.

Definition at line 2141 of file latexgen.cpp.

{
}
void LatexGenerator::endConstraintList ( )
virtual

Implements OutputGenerator.

Definition at line 2145 of file latexgen.cpp.

References endl(), and OutputGenerator::t.

{
t << "\\end{description}" << endl;
t << "\\end{Desc}" << endl;
}
void LatexGenerator::endConstraintParam ( )
virtual

Implements OutputGenerator.

Definition at line 2123 of file latexgen.cpp.

{
}
void LatexGenerator::endConstraintType ( )
virtual

Implements OutputGenerator.

Definition at line 2132 of file latexgen.cpp.

References OutputGenerator::t.

{
t << "}]";
}
void LatexGenerator::endContents ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 260 of file latexgen.h.

{}
void LatexGenerator::endDescForItem ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 241 of file latexgen.h.

{}
void LatexGenerator::endDescItem ( )
virtual

Ends an item of a description list and starts the description itself: e.g. </dt> in HTML.

Implements BaseOutputDocInterface.

Definition at line 2011 of file latexgen.cpp.

References endl(), firstDescItem, lineBreak(), and OutputGenerator::t.

{
if (firstDescItem)
{
t << "]" << endl;
firstDescItem=FALSE;
}
else
{
lineBreak();
}
}
void LatexGenerator::endDescList ( )
inline

Definition at line 235 of file latexgen.h.

References endl(), and OutputGenerator::t.

{ t << "\\end{Desc}" << endl; }
void LatexGenerator::endDescription ( )
virtual

Ends a description list: e.g. </dl> in HTML

Implements BaseOutputDocInterface.

Definition at line 1999 of file latexgen.cpp.

References endl(), firstDescItem, and OutputGenerator::t.

{
t << "\\end{description}" << endl;
firstDescItem=TRUE;
}
void LatexGenerator::endDescTable ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1848 of file latexgen.cpp.

References endl(), and OutputGenerator::t.

{
t << "\\end{DoxyEnumFields}" << endl;
}
void LatexGenerator::endDescTableData ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1878 of file latexgen.cpp.

References endl(), and OutputGenerator::t.

{
t << "\\\\\n\\hline\n" << endl;
}
void LatexGenerator::endDescTableRow ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1860 of file latexgen.cpp.

{
}
void LatexGenerator::endDescTableTitle ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1869 of file latexgen.cpp.

{
}
void LatexGenerator::endDirDepGraph ( const DotDirDeps &  g)
virtual

Implements OutputGenerator.

Definition at line 1989 of file latexgen.cpp.

References Config_getString, EOF_LaTeX, OutputGenerator::fileName, GOF_EPS, relPath, OutputGenerator::t, and DotDirDeps::writeGraph().

{
g.writeGraph(t,GOF_EPS,EOF_LaTeX,Config_getString(LATEX_OUTPUT),fileName,relPath);
}
void LatexGenerator::endDotGraph ( const DotClassGraph &  g)
virtual

Implements OutputGenerator.

Definition at line 1953 of file latexgen.cpp.

References Config_getString, EOF_LaTeX, OutputGenerator::fileName, GOF_EPS, relPath, OutputGenerator::t, and DotClassGraph::writeGraph().

{
g.writeGraph(t,GOF_EPS,EOF_LaTeX,Config_getString(LATEX_OUTPUT),fileName,relPath);
}
void LatexGenerator::endDoxyAnchor ( const char *  fName,
const char *  anchor 
)
virtual

Implements OutputGenerator.

Definition at line 1612 of file latexgen.cpp.

{
}
void LatexGenerator::endEmphasis ( )
inlinevirtual

Ends a section of text displayed in italic.

Implements BaseOutputDocInterface.

Definition at line 203 of file latexgen.h.

References OutputGenerator::t.

{ t << "}"; }
void LatexGenerator::endFile ( )
virtual

Implements OutputGenerator.

Definition at line 796 of file latexgen.cpp.

References OutputGenerator::endPlainFile(), m_codeGen, and LatexCodeGenerator::setSourceFileName().

{
endPlainFile();
m_codeGen.setSourceFileName("");
}
void LatexGenerator::endFontClass ( )
inlinevirtual

Ends a block started with startFontClass()

Implements CodeOutputInterface.

Definition at line 111 of file latexgen.h.

References LatexCodeGenerator::endFontClass(), and m_codeGen.

{ m_codeGen.endFontClass(); }
void LatexGenerator::endGroupCollaboration ( const DotGroupCollaboration &  g)
virtual

Implements OutputGenerator.

Definition at line 1971 of file latexgen.cpp.

References Config_getString, EOF_LaTeX, OutputGenerator::fileName, GOF_EPS, relPath, OutputGenerator::t, and DotGroupCollaboration::writeGraph().

{
g.writeGraph(t,GOF_EPS,EOF_LaTeX,Config_getString(LATEX_OUTPUT),fileName,relPath);
}
void LatexGenerator::endGroupHeader ( int  )
virtual

Implements OutputGenerator.

Definition at line 1496 of file latexgen.cpp.

References disableLinks, endl(), and OutputGenerator::t.

{
disableLinks=FALSE;
t << "}" << endl;
}
void LatexGenerator::endHeaderSection ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 171 of file latexgen.h.

{}
void LatexGenerator::endHtmlLink ( )
virtual

Ends a link started by startHtmlLink().

Implements BaseOutputDocInterface.

Definition at line 1310 of file latexgen.cpp.

References OutputGenerator::t.

{
t << "}";
}
void LatexGenerator::endInclDepGraph ( const DotInclDepGraph &  g)
virtual

Implements OutputGenerator.

Definition at line 1962 of file latexgen.cpp.

References Config_getString, EOF_LaTeX, OutputGenerator::fileName, GOF_EPS, relPath, OutputGenerator::t, and DotInclDepGraph::writeGraph().

{
g.writeGraph(t,GOF_EPS,EOF_LaTeX,Config_getString(LATEX_OUTPUT),fileName,relPath);
}
void LatexGenerator::endIndent ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 246 of file latexgen.h.

{}
void LatexGenerator::endIndexItem ( const char *  ref,
const char *  file 
)
virtual

Implements OutputGenerator.

Definition at line 1283 of file latexgen.cpp.

References endl(), stripPath(), and OutputGenerator::t.

{
if (!ref && fn)
{
t << "}{\\pageref{" << stripPath(fn) << "}}{}" << endl;
}
}
void LatexGenerator::endIndexKey ( )
virtual

Implements OutputGenerator.

Definition at line 1347 of file latexgen.cpp.

{
}
void LatexGenerator::endIndexList ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 144 of file latexgen.h.

References endl(), and OutputGenerator::t.

{ t << "\\end{DoxyCompactList}" << endl; }
void LatexGenerator::endIndexListItem ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 142 of file latexgen.h.

{}
void LatexGenerator::endIndexSection ( IndexSections  is)
virtual

Implements OutputGenerator.

Definition at line 987 of file latexgen.cpp.

References Doxygen::classSDict, Config_getBool, Config_getString, convertToLaTeX(), Doxygen::directories, Doxygen::exampleSDict, fileToString(), FileDef::generateSourceFile(), PageDef::getGroupDef(), NamespaceDef::getOutputFileBase(), GroupDef::getOutputFileBase(), PageDef::getOutputFileBase(), DirDef::getOutputFileBase(), FileDef::getOutputFileBase(), ClassDef::getOutputFileBase(), FileDef::getSourceFileBase(), Doxygen::groupSDict, Doxygen::inputNameList, isClassDocumentation, isClassHierarchyIndex, isCompoundIndex, isDirDocumentation, isDirIndex, ClassDef::isEmbeddedInOuterScope(), isEndIndex, isExampleDocumentation, isFileDocumentation, isFileIndex, DirDef::isLinkableInProject(), NamespaceDef::isLinkableInProject(), FileDef::isLinkableInProject(), ClassDef::isLinkableInProject(), isMainPage, isModuleDocumentation, isModuleIndex, isNamespaceDocumentation, isNamespaceIndex, isPageDocumentation, isPageDocumentation2, isPageIndex, Definition::isReference(), isTitlePageAuthor, isTitlePageStart, SDict< GroupDef >::Iterator, SDict< NamespaceDef >::Iterator, SDict< PageDef >::Iterator, SDict< ClassDef >::Iterator, m_prettyCode, Doxygen::namespaceSDict, Doxygen::pageSDict, substituteKeywords(), OutputGenerator::t, ClassDef::templateMaster(), PageDef::title(), writeDefaultFooter(), and writeDefaultHeaderPart3().

{
//static bool compactLatex = Config_getBool(COMPACT_LATEX);
static bool sourceBrowser = Config_getBool(SOURCE_BROWSER);
static QCString latexHeader = Config_getString(LATEX_HEADER);
static QCString latexFooter = Config_getString(LATEX_FOOTER);
switch (is)
{
case isTitlePageStart:
break;
case isTitlePageAuthor:
if (latexHeader.isEmpty())
{
writeDefaultHeaderPart3(t);
}
break;
case isMainPage:
{
//QCString indexName=Config_getBool(GENERATE_TREEVIEW)?"main":"index";
QCString indexName="index";
t << "}\n\\label{index}";
if (Config_getBool(PDF_HYPERLINKS)) t << "\\hypertarget{index}{}";
t << "\\input{" << indexName << "}\n";
}
break;
case isModuleIndex:
t << "}\n\\input{modules}\n";
break;
case isDirIndex:
t << "}\n\\input{dirs}\n";
break;
case isNamespaceIndex:
t << "}\n\\input{namespaces}\n";
break;
case isClassHierarchyIndex:
t << "}\n\\input{hierarchy}\n";
break;
case isCompoundIndex:
t << "}\n\\input{annotated}\n";
break;
case isFileIndex:
t << "}\n\\input{files}\n";
break;
case isPageIndex:
t << "}\n\\input{pages}\n";
break;
case isModuleDocumentation:
{
GroupSDict::Iterator gli(*Doxygen::groupSDict);
GroupDef *gd;
bool found=FALSE;
for (gli.toFirst();(gd=gli.current()) && !found;++gli)
{
if (!gd->isReference())
{
t << "}\n\\input{" << gd->getOutputFileBase() << "}\n";
found=TRUE;
}
}
for (;(gd=gli.current());++gli)
{
if (!gd->isReference())
{
//if (compactLatex) t << "\\input"; else t << "\\include";
t << "\\include";
t << "{" << gd->getOutputFileBase() << "}\n";
}
}
}
break;
case isDirDocumentation:
{
SDict<DirDef>::Iterator dli(*Doxygen::directories);
DirDef *dd;
bool found=FALSE;
for (dli.toFirst();(dd=dli.current()) && !found;++dli)
{
if (dd->isLinkableInProject())
{
t << "}\n\\input{" << dd->getOutputFileBase() << "}\n";
found=TRUE;
}
}
for (;(dd=dli.current());++dli)
{
if (dd->isLinkableInProject())
{
//if (compactLatex) t << "\\input"; else t << "\\include";
t << "\\input";
t << "{" << dd->getOutputFileBase() << "}\n";
}
}
}
break;
case isNamespaceDocumentation:
{
NamespaceSDict::Iterator nli(*Doxygen::namespaceSDict);
NamespaceDef *nd;
bool found=FALSE;
for (nli.toFirst();(nd=nli.current()) && !found;++nli)
{
if (nd->isLinkableInProject())
{
t << "}\n\\input{" << nd->getOutputFileBase() << "}\n";
found=TRUE;
}
}
while ((nd=nli.current()))
{
if (nd->isLinkableInProject())
{
//if (compactLatex) t << "\\input"; else t << "\\include";
t << "\\input";
t << "{" << nd->getOutputFileBase() << "}\n";
}
++nli;
}
}
break;
case isClassDocumentation:
{
ClassSDict::Iterator cli(*Doxygen::classSDict);
ClassDef *cd=0;
bool found=FALSE;
for (cli.toFirst();(cd=cli.current()) && !found;++cli)
{
if (cd->isLinkableInProject() &&
cd->templateMaster()==0 &&
!cd->isEmbeddedInOuterScope()
)
{
t << "}\n\\input{" << cd->getOutputFileBase() << "}\n";
found=TRUE;
}
}
for (;(cd=cli.current());++cli)
{
if (cd->isLinkableInProject() &&
cd->templateMaster()==0 &&
!cd->isEmbeddedInOuterScope()
)
{
//if (compactLatex) t << "\\input"; else t << "\\include";
t << "\\input";
t << "{" << cd->getOutputFileBase() << "}\n";
}
}
}
break;
case isFileDocumentation:
{
bool isFirst=TRUE;
FileNameListIterator fnli(*Doxygen::inputNameList);
FileName *fn;
for (fnli.toFirst();(fn=fnli.current());++fnli)
{
FileNameIterator fni(*fn);
FileDef *fd;
for (;(fd=fni.current());++fni)
{
if (fd->isLinkableInProject())
{
if (isFirst)
{
t << "}\n\\input{" << fd->getOutputFileBase() << "}\n";
if (sourceBrowser && m_prettyCode && fd->generateSourceFile())
{
//t << "\\include{" << fd->getSourceFileBase() << "}\n";
t << "\\input{" << fd->getSourceFileBase() << "}\n";
}
isFirst=FALSE;
}
else
{
//if (compactLatex) t << "\\input" ; else t << "\\include";
t << "\\input" ;
t << "{" << fd->getOutputFileBase() << "}\n";
if (sourceBrowser && m_prettyCode && fd->generateSourceFile())
{
//t << "\\include{" << fd->getSourceFileBase() << "}\n";
t << "\\input{" << fd->getSourceFileBase() << "}\n";
}
}
}
}
}
}
break;
case isExampleDocumentation:
{
t << "}\n";
PageSDict::Iterator pdi(*Doxygen::exampleSDict);
PageDef *pd=pdi.toFirst();
if (pd)
{
t << "\\input{" << pd->getOutputFileBase() << "}\n";
}
for (++pdi;(pd=pdi.current());++pdi)
{
//if (compactLatex) t << "\\input" ; else t << "\\include";
t << "\\input";
t << "{" << pd->getOutputFileBase() << "}\n";
}
}
break;
case isPageDocumentation:
{
t << "}\n";
#if 0
PageSDict::Iterator pdi(*Doxygen::pageSDict);
PageDef *pd=pdi.toFirst();
bool first=TRUE;
for (pdi.toFirst();(pd=pdi.current());++pdi)
{
if (!pd->getGroupDef() && !pd->isReference())
{
if (compactLatex) t << "\\section"; else t << "\\chapter";
t << "{" << pd->title();
t << "}\n";
if (compactLatex || first) t << "\\input" ; else t << "\\include";
t << "{" << pd->getOutputFileBase() << "}\n";
first=FALSE;
}
}
#endif
}
break;
case isPageDocumentation2:
break;
case isEndIndex:
if (latexFooter.isEmpty())
{
writeDefaultFooter(t);
}
else
{
QCString footer = fileToString(latexFooter);
t << substituteKeywords(footer,"",
convertToLaTeX(Config_getString(PROJECT_NAME)),
convertToLaTeX(Config_getString(PROJECT_NUMBER)),
convertToLaTeX(Config_getString(PROJECT_BRIEF)));
}
break;
}
}
void LatexGenerator::endIndexValue ( const char *  name,
bool   
)
virtual

Implements OutputGenerator.

Definition at line 1357 of file latexgen.cpp.

References endl(), stripPath(), and OutputGenerator::t.

{
//if (hasBrief) t << ")";
t << "}{\\pageref{" << stripPath(name) << "}}{}" << endl;
}
void LatexGenerator::endInlineHeader ( )
virtual

Implements OutputGenerator.

Definition at line 2173 of file latexgen.cpp.

References endl(), and OutputGenerator::t.

{
t << "}" << endl;
}
void LatexGenerator::endInlineMemberDoc ( )
virtual

Implements OutputGenerator.

Definition at line 2239 of file latexgen.cpp.

References endl(), and OutputGenerator::t.

{
t << "\\\\\n\\hline\n" << endl;
}
void LatexGenerator::endInlineMemberName ( )
virtual

Implements OutputGenerator.

Definition at line 2230 of file latexgen.cpp.

References endl(), and OutputGenerator::t.

{
t << "&" << endl;
}
void LatexGenerator::endInlineMemberType ( )
virtual

Implements OutputGenerator.

Definition at line 2221 of file latexgen.cpp.

References endl(), and OutputGenerator::t.

{
t << "&" << endl;
}
void LatexGenerator::endItemList ( )
inlinevirtual

Ends a bullet list: e.g. </ul> in html

Implements BaseOutputDocInterface.

Definition at line 150 of file latexgen.h.

References endl(), and OutputGenerator::t.

{ t << "\\end{DoxyCompactItemize}" << endl; }
void LatexGenerator::endItemListItem ( )
inlinevirtual

Writes a list item for a bullet or enumerated list: e.g. </li> in html

Implements BaseOutputDocInterface.

Definition at line 166 of file latexgen.h.

{}
void LatexGenerator::endLabels ( )
virtual

Implements OutputGenerator.

Definition at line 2255 of file latexgen.cpp.

{
}
void LatexGenerator::endMemberDeclaration ( const char *  ,
const char *   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 231 of file latexgen.h.

{}
void LatexGenerator::endMemberDescription ( )
virtual

Implements OutputGenerator.

Definition at line 1802 of file latexgen.cpp.

References insideTabbing, and OutputGenerator::t.

{
if (!insideTabbing)
{
//t << "\\item\\end{DoxyCompactList}";
t << "\\end{DoxyCompactList}";
}
else
{
t << "}\\\\\n";
}
}
void LatexGenerator::endMemberDoc ( bool  )
virtual

Implements OutputGenerator.

Definition at line 1586 of file latexgen.cpp.

References disableLinks, and OutputGenerator::t.

{
disableLinks=FALSE;
t << "}\n\n";
//if (Config_getBool(COMPACT_LATEX)) t << "\\hfill";
}
void LatexGenerator::endMemberDocList ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 177 of file latexgen.h.

{}
void LatexGenerator::endMemberDocName ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 291 of file latexgen.h.

{}
void LatexGenerator::endMemberDocPrefixItem ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 289 of file latexgen.h.

References endl(), and OutputGenerator::t.

{ t << "\\\\" << endl; }
void LatexGenerator::endMemberDocSimple ( bool  isEnum)
virtual

Implements OutputGenerator.

Definition at line 2205 of file latexgen.cpp.

References endl(), and OutputGenerator::t.

{
if (isEnum)
{
t << "\\end{DoxyEnumFields}" << endl;
}
else
{
t << "\\end{DoxyFields}" << endl;
}
}
void LatexGenerator::endMemberGroup ( bool  hasHeader)
virtual

Implements OutputGenerator.

Definition at line 1942 of file latexgen.cpp.

References endl(), and OutputGenerator::t.

{
if (hasHeader)t << "\\end{Indent}";
t << endl;
}
void LatexGenerator::endMemberGroupDocs ( )
virtual

Implements OutputGenerator.

Definition at line 1933 of file latexgen.cpp.

References OutputGenerator::t.

{
t << "}";
}
void LatexGenerator::endMemberGroupHeader ( )
virtual

Implements OutputGenerator.

Definition at line 1921 of file latexgen.cpp.

References endl(), and OutputGenerator::t.

{
// changed back to rev 756 due to bug 660501
t << "}\\par" << endl;
//t << "}" << endl;
}
void LatexGenerator::endMemberHeader ( )
virtual

Implements OutputGenerator.

Definition at line 1515 of file latexgen.cpp.

References disableLinks, endl(), and OutputGenerator::t.

{
disableLinks=FALSE;
t << "}" << endl;
}
void LatexGenerator::endMemberItem ( )
virtual

Implements OutputGenerator.

Definition at line 1779 of file latexgen.cpp.

References endl(), insideTabbing, OutputGenerator::t, and templateMemberItem.

{
if (insideTabbing)
{
t << "\\\\";
}
templateMemberItem = FALSE;
t << endl;
}
void LatexGenerator::endMemberList ( )
virtual

Implements OutputGenerator.

Definition at line 1896 of file latexgen.cpp.

References endl(), insideTabbing, and OutputGenerator::t.

{
//printf("LatexGenerator::endMemberList(%d)\n",insideTabbing);
if (!insideTabbing)
{
t << "\\end{DoxyCompactItemize}" << endl;
}
}
void LatexGenerator::endMemberSections ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 169 of file latexgen.h.

{}
void LatexGenerator::endMemberSubtitle ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 175 of file latexgen.h.

{}
void LatexGenerator::endMemberTemplateParams ( const char *  ,
const char *   
)
virtual

Implements OutputGenerator.

Definition at line 1761 of file latexgen.cpp.

References OutputGenerator::t, and templateMemberItem.

{
if (templateMemberItem)
{
t << "}\\\\";
}
}
void LatexGenerator::endPageRef ( const char *  clname,
const char *  anchor 
)
virtual

Implements BaseOutputDocInterface.

Definition at line 1418 of file latexgen.cpp.

References OutputGenerator::t.

{
t << "}{";
if (clname) t << clname;
if (anchor) t << "_" << anchor;
t << "}";
}
void LatexGenerator::endParagraph ( )
virtual

Ends a paragraph

Implements BaseOutputDocInterface.

Definition at line 1264 of file latexgen.cpp.

References endl(), and OutputGenerator::t.

{
t << endl << endl;
}
void LatexGenerator::endParameterList ( )
virtual

Implements OutputGenerator.

Definition at line 2063 of file latexgen.cpp.

{
}
void LatexGenerator::endParameterName ( bool  last,
bool  ,
bool  closeBracket 
)
virtual

Implements OutputGenerator.

Definition at line 2083 of file latexgen.cpp.

References OutputGenerator::t.

{
t << " }";
if (last)
{
t << "\\end{DoxyParamCaption}";
if (closeBracket) t << ")";
}
}
void LatexGenerator::endParameterType ( )
virtual

Implements OutputGenerator.

Definition at line 2073 of file latexgen.cpp.

References OutputGenerator::t.

{
t << "}]";
}
void LatexGenerator::endParamList ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 2051 of file latexgen.cpp.

References endl(), and OutputGenerator::t.

{
t << "\\end{Desc}" << endl;
}
void LatexGenerator::endProjectNumber ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 130 of file latexgen.h.

{}
void LatexGenerator::endQuickIndices ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 253 of file latexgen.h.

{}
void LatexGenerator::endSection ( const char *  lab,
SectionInfo::SectionType   
)
virtual

Implements BaseOutputDocInterface.

Definition at line 1700 of file latexgen.cpp.

References endl(), and OutputGenerator::t.

{
t << "}\\label{" << lab << "}" << endl;
}
void LatexGenerator::endSimpleSect ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 2039 of file latexgen.cpp.

References endl(), and OutputGenerator::t.

{
t << "\\end{Desc}" << endl;
}
void LatexGenerator::endSmall ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 227 of file latexgen.h.

References OutputGenerator::t.

{ t << "\\normalsize "; }
void LatexGenerator::endSubsection ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 221 of file latexgen.h.

References endl(), and OutputGenerator::t.

{ t << "}" << endl; }
void LatexGenerator::endSubsubsection ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 223 of file latexgen.h.

References endl(), and OutputGenerator::t.

{ t << "}" << endl; }
void LatexGenerator::endTextBlock ( bool  )
inlinevirtual

Implements OutputGenerator.

Definition at line 286 of file latexgen.h.

{}
void LatexGenerator::endTextLink ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1386 of file latexgen.cpp.

References OutputGenerator::t.

{
t << "}";
}
void LatexGenerator::endTitle ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 135 of file latexgen.h.

References OutputGenerator::t.

{ t << "}"; }
void LatexGenerator::endTitleHead ( const char *  fileName,
const char *  name 
)
virtual

Implements OutputGenerator.

Definition at line 1445 of file latexgen.cpp.

References endl(), insideTabbing, latexEscapeIndexChars(), latexEscapeLabelName(), stripPath(), and OutputGenerator::t.

{
t << "}" << endl;
if (name)
{
t << "\\label{" << stripPath(fileName) << "}\\index{";
t << latexEscapeLabelName(name,insideTabbing);
t << "@{";
t << latexEscapeIndexChars(name,insideTabbing);
t << "}}" << endl;
}
}
void LatexGenerator::endTypewriter ( )
inlinevirtual

End a section of text displayed in typewriter style.

Implements BaseOutputDocInterface.

Definition at line 162 of file latexgen.h.

References OutputGenerator::t.

{ t << "}"; }
void LatexGenerator::exceptionEntry ( const char *  prefix,
bool  closeBracket 
)
virtual

Implements OutputGenerator.

Definition at line 2093 of file latexgen.cpp.

References OutputGenerator::t.

{
if (prefix)
t << " " << prefix;
else if (closeBracket)
t << ")";
t << " ";
}
OutputGenerator* LatexGenerator::get ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 90 of file latexgen.h.

References OutputGenerator::Latex.

{ return (o==Latex) ? this : 0; }
void LatexGenerator::init ( )
static

Definition at line 437 of file latexgen.cpp.

References Config_getString, createSubDirs(), OutputGenerator::dir, err(), writeLatexMakefile(), and writeMakeBat().

Referenced by generateOutput().

{
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);
}
writeLatexMakefile();
writeMakeBat();
createSubDirs(d);
}
void LatexGenerator::insertMemberAlign ( bool  )
inlinevirtual

Implements OutputGenerator.

Definition at line 196 of file latexgen.h.

{}
bool LatexGenerator::isEnabled ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 89 of file latexgen.h.

References OutputGenerator::active, and OutputGenerator::Latex.

{ return (o==Latex && active); }
void LatexGenerator::lastIndexPage ( )
virtual

Implements OutputGenerator.

Definition at line 1883 of file latexgen.cpp.

{
}
void LatexGenerator::lineBreak ( const char *  style = 0)
virtual

Implements BaseOutputDocInterface.

Definition at line 2178 of file latexgen.cpp.

References insideTabbing, and OutputGenerator::t.

Referenced by endDescItem().

{
if (insideTabbing)
{
t << "\\\\\n";
}
else
{
t << "\\newline\n";
}
}
void LatexGenerator::newParagraph ( )

Definition at line 1254 of file latexgen.cpp.

References endl(), and OutputGenerator::t.

Referenced by startDotGraph().

{
t << endl << endl;
}
LatexGenerator& LatexGenerator::operator= ( const LatexGenerator &  )
private
void LatexGenerator::setCurrentDoc ( Definition *  ,
const char *  ,
bool   
)
inlinevirtual

Implements CodeOutputInterface.

Definition at line 322 of file latexgen.h.

{}
void LatexGenerator::startAnonTypeScope ( int  indent)
virtual

Implements OutputGenerator.

Definition at line 1732 of file latexgen.cpp.

References endl(), insideTabbing, m_indent, and OutputGenerator::t.

{
if (indent==0)
{
t << "\\begin{tabbing}" << endl;
t << "xx\\=xx\\=xx\\=xx\\=xx\\=xx\\=xx\\=xx\\=xx\\=\\kill" << endl;
insideTabbing=TRUE;
}
m_indent=indent;
}
void LatexGenerator::startBold ( )
inlinevirtual

Changes the text font to bold face. The bold section ends with endBold()

Implements BaseOutputDocInterface.

Definition at line 204 of file latexgen.h.

References OutputGenerator::t.

{ t << "{\\bfseries "; }
void LatexGenerator::startCallGraph ( )
virtual

Implements OutputGenerator.

Definition at line 1976 of file latexgen.cpp.

{
}
void LatexGenerator::startCenter ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 224 of file latexgen.h.

References endl(), and OutputGenerator::t.

{ t << "\\begin{center}" << endl; }
void LatexGenerator::startClassDiagram ( )
virtual

Implements OutputGenerator.

Definition at line 1719 of file latexgen.cpp.

{
//if (Config_getBool(COMPACT_LATEX)) t << "\\subsubsection"; else t << "\\subsection";
//t << "{";
}
void LatexGenerator::startCodeFragment ( )
virtual

Starts a source code fragment. The fragment will be fed to the code parser (see code.h) for syntax highlighting and cross-referencing. The fragment ends by a call to endCodeFragment()

Implements BaseOutputDocInterface.

Definition at line 2151 of file latexgen.cpp.

References OutputGenerator::t.

{
t << "\n\\begin{DoxyCode}\n";
}
void LatexGenerator::startCodeLine ( bool  hasLineNumbers)
inlinevirtual

Implements CodeOutputInterface.

Definition at line 105 of file latexgen.h.

References m_codeGen, and LatexCodeGenerator::startCodeLine().

{ m_codeGen.startCodeLine(hasLineNumbers); }
void LatexGenerator::startConstraintDocs ( )
virtual

Implements OutputGenerator.

Definition at line 2137 of file latexgen.cpp.

{
}
void LatexGenerator::startConstraintList ( const char *  header)
virtual

Implements OutputGenerator.

Definition at line 2110 of file latexgen.cpp.

References docify(), endl(), and OutputGenerator::t.

{
t << "\\begin{Desc}\n\\item[";
docify(header);
t << "]";
t << "\\begin{description}" << endl;
}
void LatexGenerator::startConstraintParam ( )
virtual

Implements OutputGenerator.

Definition at line 2118 of file latexgen.cpp.

References OutputGenerator::t.

{
t << "\\item[{\\em ";
}
void LatexGenerator::startConstraintType ( )
virtual

Implements OutputGenerator.

Definition at line 2127 of file latexgen.cpp.

References OutputGenerator::t.

{
t << "} : {\\em ";
}
void LatexGenerator::startContents ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 259 of file latexgen.h.

{}
void LatexGenerator::startDescForItem ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 240 of file latexgen.h.

References endl(), and OutputGenerator::t.

{ t << "\\par" << endl; }
void LatexGenerator::startDescItem ( )
virtual

Starts an item of a description list: e.g. <dt> in HTML.

Implements BaseOutputDocInterface.

Definition at line 2005 of file latexgen.cpp.

References firstDescItem, and OutputGenerator::t.

{
firstDescItem=TRUE;
t << "\\item[";
}
void LatexGenerator::startDescList ( SectionTypes  )
inline

Definition at line 234 of file latexgen.h.

References OutputGenerator::t.

{ t << "\\begin{Desc}\n\\item["; }
void LatexGenerator::startDescription ( )
virtual

Starts a description list: e.g. <dl> in HTML Items are surrounded by startDescItem() and endDescItem()

Implements BaseOutputDocInterface.

Definition at line 1994 of file latexgen.cpp.

References endl(), and OutputGenerator::t.

{
t << "\\begin{description}" << endl;
}
void LatexGenerator::startDescTable ( const char *  title)
virtual

Implements BaseOutputDocInterface.

Definition at line 1843 of file latexgen.cpp.

References endl(), and OutputGenerator::t.

{
t << "\\begin{DoxyEnumFields}{" << title << "}" << endl;
}
void LatexGenerator::startDescTableData ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1873 of file latexgen.cpp.

References OutputGenerator::t.

{
t << "&";
}
void LatexGenerator::startDescTableRow ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1853 of file latexgen.cpp.

References OutputGenerator::t.

{
// this is needed to prevent the \hypertarget, \label, and \index commands from messing up
// the row height (based on http://tex.stackexchange.com/a/186102)
t << "\\raisebox{\\heightof{T}}[0pt][0pt]{";
}
void LatexGenerator::startDescTableTitle ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1864 of file latexgen.cpp.

References OutputGenerator::t.

{
t << "}";
}
void LatexGenerator::startDirDepGraph ( )
virtual

Implements OutputGenerator.

Definition at line 1985 of file latexgen.cpp.

{
}
void LatexGenerator::startDotGraph ( )
virtual

Implements OutputGenerator.

Definition at line 1948 of file latexgen.cpp.

References newParagraph().

{
newParagraph();
}
void LatexGenerator::startDoxyAnchor ( const char *  fName,
const char *  ,
const char *  anchor,
const char *  ,
const char *   
)
virtual

Implements OutputGenerator.

Definition at line 1593 of file latexgen.cpp.

References Config_getBool, endl(), stripPath(), and OutputGenerator::t.

{
static bool pdfHyperlinks = Config_getBool(PDF_HYPERLINKS);
static bool usePDFLatex = Config_getBool(USE_PDFLATEX);
if (usePDFLatex && pdfHyperlinks)
{
t << "\\hypertarget{";
if (fName) t << stripPath(fName);
if (anchor) t << "_" << anchor;
t << "}{}";
}
t << "\\label{";
if (fName) t << stripPath(fName);
if (anchor) t << "_" << anchor;
t << "} " << endl;
}
void LatexGenerator::startEmphasis ( )
inlinevirtual

Changes the text font to italic. The italic section ends with endEmphasis()

Implements BaseOutputDocInterface.

Definition at line 202 of file latexgen.h.

References OutputGenerator::t.

{ t << "{\\em "; }
void LatexGenerator::startFile ( const char *  name,
const char *  manName,
const char *  title 
)
virtual

Implements OutputGenerator.

Definition at line 782 of file latexgen.cpp.

References Config_getString, OutputGenerator::fileName, m_codeGen, relativePathToRoot(), relPath, LatexCodeGenerator::setRelativePath(), LatexCodeGenerator::setSourceFileName(), LatexCodeGenerator::setTextStream(), OutputGenerator::startPlainFile(), stripPath(), and OutputGenerator::t.

{
#if 0
setEncoding(Config_getString(LATEX_OUTPUT_ENCODING));
#endif
QCString fileName=name;
relPath = relativePathToRoot(fileName);
if (fileName.right(4)!=".tex" && fileName.right(4)!=".sty") fileName+=".tex";
startPlainFile(fileName);
m_codeGen.setTextStream(t);
m_codeGen.setRelativePath(relPath);
m_codeGen.setSourceFileName(stripPath(fileName));
}
void LatexGenerator::startFontClass ( const char *  clsName)
inlinevirtual

Starts a block with a certain meaning. Used for syntax highlighting, which elements of the same type are rendered using the same 'font class'.

Parameters
clsNameThe category name.

Implements CodeOutputInterface.

Definition at line 109 of file latexgen.h.

References m_codeGen, and LatexCodeGenerator::startFontClass().

{ m_codeGen.startFontClass(s); }
void LatexGenerator::startGroupCollaboration ( )
virtual

Implements OutputGenerator.

Definition at line 1967 of file latexgen.cpp.

{
}
void LatexGenerator::startGroupHeader ( int  extraIndentLevel)
virtual

Implements OutputGenerator.

Definition at line 1470 of file latexgen.cpp.

References Config_getBool, disableLinks, and OutputGenerator::t.

{
if (Config_getBool(COMPACT_LATEX))
{
extraIndentLevel++;
}
if (extraIndentLevel==3)
{
t << "\\subparagraph*{";
}
else if (extraIndentLevel==2)
{
t << "\\paragraph{";
}
else if (extraIndentLevel==1)
{
t << "\\subsubsection{";
}
else // extraIndentLevel==0
{
t << "\\subsection{";
}
disableLinks=TRUE;
}
void LatexGenerator::startHeaderSection ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 170 of file latexgen.h.

{}
void LatexGenerator::startHtmlLink ( const char *  url)
virtual

Starts a (link to an) URL found in the documentation.

Parameters
urlThe URL to link to.

Implements BaseOutputDocInterface.

Definition at line 1299 of file latexgen.cpp.

References Config_getBool, and OutputGenerator::t.

{
if (Config_getBool(PDF_HYPERLINKS))
{
t << "\\href{";
t << url;
t << "}";
}
t << "{\\tt ";
}
void LatexGenerator::startInclDepGraph ( )
virtual

Implements OutputGenerator.

Definition at line 1958 of file latexgen.cpp.

{
}
void LatexGenerator::startIndent ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 245 of file latexgen.h.

{}
void LatexGenerator::startIndexItem ( const char *  ref,
const char *  file 
)
virtual

Implements OutputGenerator.

Definition at line 1274 of file latexgen.cpp.

References OutputGenerator::t.

{
t << "\\item ";
if (!ref && fn)
{
t << "\\contentsline{section}{";
}
}
void LatexGenerator::startIndexKey ( )
virtual

Implements OutputGenerator.

Definition at line 1342 of file latexgen.cpp.

References OutputGenerator::t.

{
t << "\\item\\contentsline{section}{";
}
void LatexGenerator::startIndexList ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 143 of file latexgen.h.

References endl(), and OutputGenerator::t.

{ t << "\\begin{DoxyCompactList}" << endl; }
void LatexGenerator::startIndexListItem ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 141 of file latexgen.h.

{}
void LatexGenerator::startIndexSection ( IndexSections  is)
virtual

Implements OutputGenerator.

Definition at line 812 of file latexgen.cpp.

References Doxygen::classSDict, Config_getBool, Config_getString, convertToLaTeX(), Doxygen::directories, fileToString(), Doxygen::groupSDict, Doxygen::inputNameList, isClassDocumentation, isClassHierarchyIndex, isCompoundIndex, isDirDocumentation, isDirIndex, ClassDef::isEmbeddedInOuterScope(), isEndIndex, isExampleDocumentation, isFileDocumentation, isFileIndex, DirDef::isLinkableInProject(), NamespaceDef::isLinkableInProject(), FileDef::isLinkableInProject(), ClassDef::isLinkableInProject(), isMainPage, isModuleDocumentation, isModuleIndex, isNamespaceDocumentation, isNamespaceIndex, isPageDocumentation, isPageDocumentation2, isPageIndex, Definition::isReference(), isTitlePageAuthor, isTitlePageStart, SDict< GroupDef >::Iterator, SDict< ClassDef >::Iterator, SDict< NamespaceDef >::Iterator, Doxygen::namespaceSDict, substituteKeywords(), OutputGenerator::t, ClassDef::templateMaster(), writeDefaultHeaderPart1(), and writeDefaultHeaderPart2().

{
bool &compactLatex = Config_getBool(COMPACT_LATEX);
QCString &latexHeader = Config_getString(LATEX_HEADER);
switch (is)
{
case isTitlePageStart:
{
if (latexHeader.isEmpty())
{
writeDefaultHeaderPart1(t);
}
else
{
QCString header = fileToString(latexHeader);
t << substituteKeywords(header,"",
convertToLaTeX(Config_getString(PROJECT_NAME)),
convertToLaTeX(Config_getString(PROJECT_NUMBER)),
convertToLaTeX(Config_getString(PROJECT_BRIEF)));
}
}
break;
case isTitlePageAuthor:
if (latexHeader.isEmpty())
{
writeDefaultHeaderPart2(t);
}
break;
case isMainPage:
if (compactLatex) t << "\\section"; else t << "\\chapter";
t << "{"; //Introduction}\n"
break;
//case isPackageIndex:
// if (compactLatex) t << "\\section"; else t << "\\chapter";
// t << "{"; //Package Index}\n"
// break;
case isModuleIndex:
if (compactLatex) t << "\\section"; else t << "\\chapter";
t << "{"; //Module Index}\n"
break;
case isDirIndex:
if (compactLatex) t << "\\section"; else t << "\\chapter";
t << "{"; //Directory Index}\n"
break;
case isNamespaceIndex:
if (compactLatex) t << "\\section"; else t << "\\chapter";
t << "{"; //Namespace Index}\"
break;
case isClassHierarchyIndex:
if (compactLatex) t << "\\section"; else t << "\\chapter";
t << "{"; //Hierarchical Index}\n"
break;
case isCompoundIndex:
if (compactLatex) t << "\\section"; else t << "\\chapter";
t << "{"; //Annotated Compound Index}\n"
break;
case isFileIndex:
if (compactLatex) t << "\\section"; else t << "\\chapter";
t << "{"; //Annotated File Index}\n"
break;
case isPageIndex:
if (compactLatex) t << "\\section"; else t << "\\chapter";
t << "{"; //Annotated Page Index}\n"
break;
case isModuleDocumentation:
{
GroupSDict::Iterator gli(*Doxygen::groupSDict);
GroupDef *gd;
bool found=FALSE;
for (gli.toFirst();(gd=gli.current()) && !found;++gli)
{
if (!gd->isReference())
{
if (compactLatex) t << "\\section"; else t << "\\chapter";
t << "{"; //Module Documentation}\n";
found=TRUE;
}
}
}
break;
case isDirDocumentation:
{
SDict<DirDef>::Iterator dli(*Doxygen::directories);
DirDef *dd;
bool found=FALSE;
for (dli.toFirst();(dd=dli.current()) && !found;++dli)
{
if (dd->isLinkableInProject())
{
if (compactLatex) t << "\\section"; else t << "\\chapter";
t << "{"; //Module Documentation}\n";
found=TRUE;
}
}
}
break;
case isNamespaceDocumentation:
{
NamespaceSDict::Iterator nli(*Doxygen::namespaceSDict);
NamespaceDef *nd;
bool found=FALSE;
for (nli.toFirst();(nd=nli.current()) && !found;++nli)
{
if (nd->isLinkableInProject())
{
if (compactLatex) t << "\\section"; else t << "\\chapter";
t << "{"; // Namespace Documentation}\n":
found=TRUE;
}
}
}
break;
case isClassDocumentation:
{
ClassSDict::Iterator cli(*Doxygen::classSDict);
ClassDef *cd=0;
bool found=FALSE;
for (cli.toFirst();(cd=cli.current()) && !found;++cli)
{
if (cd->isLinkableInProject() &&
cd->templateMaster()==0 &&
!cd->isEmbeddedInOuterScope()
)
{
if (compactLatex) t << "\\section"; else t << "\\chapter";
t << "{"; //Compound Documentation}\n";
found=TRUE;
}
}
}
break;
case isFileDocumentation:
{
bool isFirst=TRUE;
FileNameListIterator fnli(*Doxygen::inputNameList);
FileName *fn;
for (fnli.toFirst();(fn=fnli.current());++fnli)
{
FileNameIterator fni(*fn);
FileDef *fd;
for (;(fd=fni.current());++fni)
{
if (fd->isLinkableInProject())
{
if (isFirst)
{
if (compactLatex) t << "\\section"; else t << "\\chapter";
t << "{"; //File Documentation}\n";
isFirst=FALSE;
break;
}
}
}
}
}
break;
case isExampleDocumentation:
{
if (compactLatex) t << "\\section"; else t << "\\chapter";
t << "{"; //Example Documentation}\n";
}
break;
case isPageDocumentation:
{
if (compactLatex) t << "\\section"; else t << "\\chapter";
t << "{"; //Page Documentation}\n";
}
break;
case isPageDocumentation2:
break;
case isEndIndex:
break;
}
}
void LatexGenerator::startIndexValue ( bool  hasBrief)
virtual

Implements OutputGenerator.

Definition at line 1351 of file latexgen.cpp.

References OutputGenerator::t.

{
t << " ";
if (hasBrief) t << "\\\\*";
}
void LatexGenerator::startInlineHeader ( )
virtual

Implements OutputGenerator.

Definition at line 2161 of file latexgen.cpp.

References Config_getBool, and OutputGenerator::t.

{
if (Config_getBool(COMPACT_LATEX))
{
t << "\\paragraph*{";
}
else
{
t << "\\subsubsection*{";
}
}
void LatexGenerator::startInlineMemberDoc ( )
virtual

Implements OutputGenerator.

Definition at line 2235 of file latexgen.cpp.

{
}
void LatexGenerator::startInlineMemberName ( )
virtual

Implements OutputGenerator.

Definition at line 2226 of file latexgen.cpp.

{
}
void LatexGenerator::startInlineMemberType ( )
virtual

Implements OutputGenerator.

Definition at line 2217 of file latexgen.cpp.

{
}
void LatexGenerator::startItemList ( )
inlinevirtual

Start of a bullet list: e.g. <ul> in html. startItemListItem() is Used for the bullet items.

Implements BaseOutputDocInterface.

Definition at line 149 of file latexgen.h.

References endl(), and OutputGenerator::t.

{ t << "\\begin{DoxyCompactItemize}" << endl; }
void LatexGenerator::startItemListItem ( )
inlinevirtual

Writes a list item for a bullet or enumerated list: e.g. <li> in html

Implements BaseOutputDocInterface.

Definition at line 165 of file latexgen.h.

References endl(), and OutputGenerator::t.

{ t << "\\item " << endl; }
void LatexGenerator::startLabels ( )
virtual

Implements OutputGenerator.

Definition at line 2244 of file latexgen.cpp.

References OutputGenerator::t.

{
t << "\\hspace{0.3cm}";
}
void LatexGenerator::startMemberDeclaration ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 230 of file latexgen.h.

{}
void LatexGenerator::startMemberDescription ( const char *  ,
const char *   
)
virtual

Implements OutputGenerator.

Definition at line 1789 of file latexgen.cpp.

References insideTabbing, m_indent, and OutputGenerator::t.

{
if (!insideTabbing)
{
t << "\\begin{DoxyCompactList}\\small\\item\\em ";
}
else
{
for (int i=0;i<m_indent+2;i++) t << "\\>";
t << "{\\em ";
}
}
void LatexGenerator::startMemberDoc ( const char *  clname,
const char *  memname,
const char *  ,
const char *  title,
int  memCount,
int  memTotal,
bool  showInline 
)
virtual

Implements OutputGenerator.

Definition at line 1521 of file latexgen.cpp.

References Config_getBool, endl(), insideTabbing, latexEscapeIndexChars(), latexEscapeLabelName(), latexEscapePDFString(), and OutputGenerator::t.

{
if (memname && memname[0]!='@')
{
t << "\\index{";
if (clname)
{
t << latexEscapeLabelName(clname,insideTabbing);
t << "@{";
t << latexEscapeIndexChars(clname,insideTabbing);
t << "}!";
}
t << latexEscapeLabelName(memname,insideTabbing);
t << "@{";
t << latexEscapeIndexChars(memname,insideTabbing);
t << "}}" << endl;
t << "\\index{";
t << latexEscapeLabelName(memname,insideTabbing);
t << "@{";
t << latexEscapeIndexChars(memname,insideTabbing);
t << "}";
if (clname)
{
t << "!";
t << latexEscapeLabelName(clname,insideTabbing);
t << "@{";
t << latexEscapeIndexChars(clname,insideTabbing);
t << "}";
}
t << "}" << endl;
}
static const char *levelLab[] = { "subsubsection","paragraph","subparagraph", "subparagraph" };
static bool compactLatex = Config_getBool(COMPACT_LATEX);
static bool pdfHyperlinks = Config_getBool(PDF_HYPERLINKS);
int level=0;
if (showInline) level+=2;
if (compactLatex) level++;
t << "\\" << levelLab[level];
t << "{";
if (pdfHyperlinks)
{
t << "\\texorpdfstring{";
}
t << latexEscapeIndexChars(title,insideTabbing);
if (pdfHyperlinks)
{
t << "}{" << latexEscapePDFString(title) << "}";
}
if (memTotal>1)
{
t << "\\hspace{0.1cm}{\\footnotesize\\ttfamily [" << memCount << "/" << memTotal << "]}";
}
t << "}";
t << "\n{\\footnotesize\\ttfamily ";
//disableLinks=TRUE;
}
void LatexGenerator::startMemberDocList ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 176 of file latexgen.h.

{}
void LatexGenerator::startMemberDocName ( bool  )
inlinevirtual

Implements OutputGenerator.

Definition at line 290 of file latexgen.h.

{}
void LatexGenerator::startMemberDocPrefixItem ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 288 of file latexgen.h.

{}
void LatexGenerator::startMemberDocSimple ( bool  isEnum)
virtual

Implements OutputGenerator.

Definition at line 2190 of file latexgen.cpp.

References docify(), endl(), OutputGenerator::t, theTranslator, Translator::trCompoundMembers(), and Translator::trEnumerationValues().

{
if (isEnum)
{
t << "\\begin{DoxyEnumFields}{";
docify(theTranslator->trEnumerationValues());
}
else
{
t << "\\begin{DoxyFields}{";
docify(theTranslator->trCompoundMembers());
}
t << "}" << endl;
}
void LatexGenerator::startMemberGroup ( )
virtual

Implements OutputGenerator.

Definition at line 1938 of file latexgen.cpp.

{
}
void LatexGenerator::startMemberGroupDocs ( )
virtual

Implements OutputGenerator.

Definition at line 1928 of file latexgen.cpp.

References OutputGenerator::t.

{
t << "{\\em ";
}
void LatexGenerator::startMemberGroupHeader ( bool  hasHeader)
virtual

Implements OutputGenerator.

Definition at line 1906 of file latexgen.cpp.

References OutputGenerator::t.

{
if (hasHeader) t << "\\begin{Indent}";
t << "{\\bf ";
// changed back to rev 756 due to bug 660501
//if (Config_getBool(COMPACT_LATEX))
//{
// t << "\\subparagraph*{";
//}
//else
//{
// t << "\\paragraph*{";
//}
}
void LatexGenerator::startMemberHeader ( const char *  )
virtual

Implements OutputGenerator.

Definition at line 1502 of file latexgen.cpp.

References Config_getBool, disableLinks, and OutputGenerator::t.

{
if (Config_getBool(COMPACT_LATEX))
{
t << "\\subsubsection*{";
}
else
{
t << "\\subsection*{";
}
disableLinks=TRUE;
}
void LatexGenerator::startMemberItem ( const char *  ,
int  annoType,
const char *   
)
virtual

Implements OutputGenerator.

Definition at line 1769 of file latexgen.cpp.

References endl(), insideTabbing, OutputGenerator::t, and templateMemberItem.

{
//printf("LatexGenerator::startMemberItem(%d)\n",annType);
if (!insideTabbing)
{
t << "\\item " << endl;
templateMemberItem = (annoType == 3);
}
}
void LatexGenerator::startMemberList ( )
virtual

Implements OutputGenerator.

Definition at line 1888 of file latexgen.cpp.

References endl(), insideTabbing, and OutputGenerator::t.

{
if (!insideTabbing)
{
t << "\\begin{DoxyCompactItemize}" << endl;
}
}
void LatexGenerator::startMemberSections ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 168 of file latexgen.h.

{}
void LatexGenerator::startMemberSubtitle ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 174 of file latexgen.h.

{}
void LatexGenerator::startMemberTemplateParams ( )
virtual

Implements OutputGenerator.

Definition at line 1753 of file latexgen.cpp.

References OutputGenerator::t, and templateMemberItem.

{
if (templateMemberItem)
{
t << "{\\footnotesize ";
}
}
void LatexGenerator::startPageRef ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1413 of file latexgen.cpp.

References OutputGenerator::t.

{
t << " \\doxyref{}{";
}
void LatexGenerator::startParagraph ( )
virtual

Starts a new paragraph

Starts a new paragraph

Implements BaseOutputDocInterface.

Definition at line 1259 of file latexgen.cpp.

References endl(), and OutputGenerator::t.

{
t << endl << endl;
}
void LatexGenerator::startParameterList ( bool  openBracket)
virtual

Implements OutputGenerator.

Definition at line 2056 of file latexgen.cpp.

References OutputGenerator::t.

{
/* start of ParameterType ParameterName list */
if (openBracket) t << "(";
t << "\\begin{DoxyParamCaption}";
}
void LatexGenerator::startParameterName ( bool  )
virtual

Implements OutputGenerator.

Definition at line 2078 of file latexgen.cpp.

References OutputGenerator::t.

{
t << "{";
}
void LatexGenerator::startParameterType ( bool  first,
const char *  key 
)
virtual

Implements OutputGenerator.

Definition at line 2067 of file latexgen.cpp.

References OutputGenerator::t.

{
t << "\\item[{";
if (!first && key) t << key;
}
void LatexGenerator::startParamList ( ParamListTypes  ,
const char *  title 
)
virtual

Implements BaseOutputDocInterface.

Definition at line 2044 of file latexgen.cpp.

References docify(), and OutputGenerator::t.

{
t << "\\begin{Desc}\n\\item[";
docify(title);
t << "]";
}
void LatexGenerator::startProjectNumber ( )
virtual

Implements OutputGenerator.

Definition at line 807 of file latexgen.cpp.

References OutputGenerator::t.

{
t << "\\\\[1ex]\\large ";
}
void LatexGenerator::startQuickIndices ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 252 of file latexgen.h.

{}
void LatexGenerator::startSection ( const char *  lab,
const char *  ,
SectionInfo::SectionType  type 
)
virtual

Implements BaseOutputDocInterface.

Definition at line 1663 of file latexgen.cpp.

References Config_getBool, SectionInfo::Page, SectionInfo::Paragraph, SectionInfo::Section, stripPath(), SectionInfo::Subsection, SectionInfo::Subsubsection, and OutputGenerator::t.

{
static bool pdfHyperlinks = Config_getBool(PDF_HYPERLINKS);
static bool usePDFLatex = Config_getBool(USE_PDFLATEX);
if (usePDFLatex && pdfHyperlinks)
{
t << "\\hypertarget{" << stripPath(lab) << "}{}";
}
t << "\\";
if (Config_getBool(COMPACT_LATEX))
{
switch(type)
{
case SectionInfo::Page: t << "subsection"; break;
case SectionInfo::Section: t << "subsubsection"; break;
case SectionInfo::Subsection: t << "paragraph"; break;
case SectionInfo::Subsubsection: t << "subparagraph"; break;
case SectionInfo::Paragraph: t << "subparagraph"; break;
default: ASSERT(0); break;
}
t << "{";
}
else
{
switch(type)
{
case SectionInfo::Page: t << "section"; break;
case SectionInfo::Section: t << "subsection"; break;
case SectionInfo::Subsection: t << "subsubsection"; break;
case SectionInfo::Subsubsection: t << "paragraph"; break;
case SectionInfo::Paragraph: t << "subparagraph"; break;
default: ASSERT(0); break;
}
t << "{";
}
}
void LatexGenerator::startSimpleSect ( SectionTypes  ,
const char *  file,
const char *  anchor,
const char *  title 
)
virtual

Implements BaseOutputDocInterface.

Definition at line 2024 of file latexgen.cpp.

References docify(), OutputGenerator::t, and writeObjectLink().

{
t << "\\begin{Desc}\n\\item[";
if (file)
{
writeObjectLink(0,file,anchor,title);
}
else
{
docify(title);
}
t << "]";
}
void LatexGenerator::startSmall ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 226 of file latexgen.h.

References OutputGenerator::t.

{ t << "\\footnotesize "; }
void LatexGenerator::startSubsection ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 220 of file latexgen.h.

References OutputGenerator::t.

{ t << "\\subsection*{"; }
void LatexGenerator::startSubsubsection ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 222 of file latexgen.h.

References OutputGenerator::t.

{ t << "\\subsubsection*{"; }
void LatexGenerator::startTextBlock ( bool  )
inlinevirtual

Implements OutputGenerator.

Definition at line 285 of file latexgen.h.

{}
void LatexGenerator::startTextLink ( const char *  f,
const char *  anchor 
)
virtual

Implements BaseOutputDocInterface.

Definition at line 1371 of file latexgen.cpp.

References Config_getBool, disableLinks, stripPath(), and OutputGenerator::t.

{
if (!disableLinks && Config_getBool(PDF_HYPERLINKS))
{
t << "\\hyperlink{";
if (f) t << stripPath(f);
if (anchor) t << "_" << anchor;
t << "}{";
}
else
{
t << "{\\bf ";
}
}
void LatexGenerator::startTitle ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1458 of file latexgen.cpp.

References Config_getBool, and OutputGenerator::t.

{
if (Config_getBool(COMPACT_LATEX))
{
t << "\\subsection{";
}
else
{
t << "\\section{";
}
}
void LatexGenerator::startTitleHead ( const char *  fileName)
virtual

Implements OutputGenerator.

Definition at line 1427 of file latexgen.cpp.

References Config_getBool, stripPath(), and OutputGenerator::t.

{
static bool pdfHyperlinks = Config_getBool(PDF_HYPERLINKS);
static bool usePDFLatex = Config_getBool(USE_PDFLATEX);
if (usePDFLatex && pdfHyperlinks && fileName)
{
t << "\\hypertarget{" << stripPath(fileName) << "}{}";
}
if (Config_getBool(COMPACT_LATEX))
{
t << "\\subsection{";
}
else
{
t << "\\section{";
}
}
void LatexGenerator::startTypewriter ( )
inlinevirtual

Changes the text font to fixed size. The section ends with endTypewriter()

Implements BaseOutputDocInterface.

Definition at line 161 of file latexgen.h.

References OutputGenerator::t.

{ t << "{\\ttfamily "; }
void LatexGenerator::writeAnchor ( const char *  fileName,
const char *  name 
)
virtual

Implements BaseOutputDocInterface.

Definition at line 1616 of file latexgen.cpp.

References Config_getBool, endl(), stripPath(), and OutputGenerator::t.

{
//printf("LatexGenerator::writeAnchor(%s,%s)\n",fName,name);
t << "\\label{" << stripPath(name) << "}" << endl;
static bool pdfHyperlinks = Config_getBool(PDF_HYPERLINKS);
static bool usePDFLatex = Config_getBool(USE_PDFLATEX);
if (usePDFLatex && pdfHyperlinks)
{
if (fName)
{
t << "\\hypertarget{" << stripPath(fName) << "_" << stripPath(name) << "}{}" << endl;
}
else
{
t << "\\hypertarget{" << stripPath(name) << "}{}" << endl;
}
}
}
void LatexGenerator::writeChar ( char  c)
virtual

Writes a single ASCII character to the output. Converts characters that have a special meaning.

Implements BaseOutputDocInterface.

Definition at line 1711 of file latexgen.cpp.

References docify().

{
char cs[2];
cs[0]=c;
cs[1]=0;
docify(cs);
}
void LatexGenerator::writeCodeAnchor ( const char *  name)
inlinevirtual

Write an anchor to a source listing.

Parameters
nameThe name of the anchor.

Implements CodeOutputInterface.

Definition at line 113 of file latexgen.h.

References m_codeGen, and LatexCodeGenerator::writeCodeAnchor().

{ m_codeGen.writeCodeAnchor(anchor); }
void LatexGenerator::writeCodeLink ( const char *  ref,
const char *  file,
const char *  anchor,
const char *  name,
const char *  tooltip 
)
inlinevirtual

Writes a link to an object in a code fragment.

Parameters
refIf this is non-zero, the object is to be found in an external documentation file.
fileThe file in which the object is located.
anchorThe anchor uniquely identifying the object within the file.
nameThe text to display as a placeholder for the link.
tooltipThe tooltip to display when the mouse is on the link.

Implements CodeOutputInterface.

Definition at line 95 of file latexgen.h.

References m_codeGen, and LatexCodeGenerator::writeCodeLink().

{ m_codeGen.writeCodeLink(ref,file,anchor,name,tooltip); }
void LatexGenerator::writeDoc ( DocNode *  n,
Definition *  ctx,
MemberDef *   
)
virtual

Implements OutputGenerator.

Definition at line 2102 of file latexgen.cpp.

References DocNode::accept(), Definition::getDefFileExtension(), insideTabbing, and OutputGenerator::t.

{
LatexDocVisitor *visitor =
new LatexDocVisitor(t,*this,ctx?ctx->getDefFileExtension():QCString(""),insideTabbing);
n->accept(visitor);
delete visitor;
}
void LatexGenerator::writeEndAnnoItem ( const char *  name)
virtual

Implements OutputGenerator.

Definition at line 1337 of file latexgen.cpp.

References endl(), stripPath(), and OutputGenerator::t.

{
t << "}{\\pageref{" << stripPath(name) << "}}{}" << endl;
}
void LatexGenerator::writeFooter ( const char *  )
inlinevirtual

Implements OutputGenerator.

Definition at line 122 of file latexgen.h.

{}
void LatexGenerator::writeFooterFile ( QFile &  f)
static

Definition at line 768 of file latexgen.cpp.

References endl(), OutputGenerator::t, versionString, and writeDefaultFooter().

Referenced by readConfiguration().

{
FTextStream t(&f);
t << "% Latex footer for doxygen " << versionString << endl;
writeDefaultFooter(t);
}
void LatexGenerator::writeGraphicalHierarchy ( const DotGfxHierarchyTable &  )
inlinevirtual

Implements OutputGenerator.

Definition at line 283 of file latexgen.h.

{}
void LatexGenerator::writeHeaderFile ( QFile &  f)
static

Definition at line 757 of file latexgen.cpp.

References endl(), OutputGenerator::t, versionString, writeDefaultHeaderPart1(), writeDefaultHeaderPart2(), and writeDefaultHeaderPart3().

Referenced by readConfiguration().

{
FTextStream t(&f);
t << "% Latex header for doxygen " << versionString << endl;
writeDefaultHeaderPart1(t);
t << "Your title here";
writeDefaultHeaderPart2(t);
t << "Generated by";
writeDefaultHeaderPart3(t);
}
void LatexGenerator::writeInheritedSectionTitle ( const char *  ,
const char *  ,
const char *  ,
const char *  ,
const char *  ,
const char *   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 232 of file latexgen.h.

{}
void LatexGenerator::writeLabel ( const char *  l,
bool  isLast 
)
virtual

Implements OutputGenerator.

Definition at line 2249 of file latexgen.cpp.

References OutputGenerator::t.

{
t << "{\\ttfamily [" << l << "]}";
if (!isLast) t << ", ";
}
void LatexGenerator::writeLatexSpacing ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 216 of file latexgen.h.

References OutputGenerator::t.

{ t << "\\hspace{0.3cm}"; }
void LatexGenerator::writeLineNumber ( const char *  ref,
const char *  file,
const char *  anchor,
int  lineNumber 
)
inlinevirtual

Writes the line number of a source listing

Parameters
refExternal reference (when imported from a tag file)
fileThe file part of the URL pointing to the docs.
anchorThe anchor part of the URL pointing to the docs.
lineNumberThe line number to write

Implements CodeOutputInterface.

Definition at line 99 of file latexgen.h.

References m_codeGen, and LatexCodeGenerator::writeLineNumber().

{ m_codeGen.writeLineNumber(ref,file,anchor,lineNumber); }
void LatexGenerator::writeLogo ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 256 of file latexgen.h.

{}
void LatexGenerator::writeNavigationPath ( const char *  )
inlinevirtual

Implements OutputGenerator.

Definition at line 255 of file latexgen.h.

{}
void LatexGenerator::writeNonBreakableSpace ( int  )
virtual

Implements BaseOutputDocInterface.

Definition at line 1816 of file latexgen.cpp.

References insideTabbing, and OutputGenerator::t.

{
//printf("writeNonBreakbleSpace()\n");
if (insideTabbing)
{
t << "\\>";
}
else
{
t << "~";
}
}
void LatexGenerator::writeObjectLink ( const char *  ref,
const char *  file,
const char *  anchor,
const char *  name 
)
virtual

Writes a link to an object in the documentation.

Parameters
refIf this is non-zero, the object is to be found in an external documentation file.
fileThe file in which the object is located.
anchorThe anchor uniquely identifying the object within the file.
nameThe text to display as a placeholder for the link.

Implements BaseOutputDocInterface.

Definition at line 1391 of file latexgen.cpp.

References Config_getBool, disableLinks, docify(), stripPath(), and OutputGenerator::t.

Referenced by startSimpleSect().

{
static bool pdfHyperlinks = Config_getBool(PDF_HYPERLINKS);
if (!disableLinks && !ref && pdfHyperlinks)
{
t << "\\hyperlink{";
if (f) t << stripPath(f);
if (f && anchor) t << "_";
if (anchor) t << anchor;
t << "}{";
docify(text);
t << "}";
}
else
{
t << "{\\bf ";
docify(text);
t << "}";
}
}
void LatexGenerator::writePageLink ( const char *  name,
bool   
)
virtual

Implements OutputGenerator.

Definition at line 1234 of file latexgen.cpp.

References OutputGenerator::t.

{
//bool &compactLatex = Config_getBool(COMPACT_LATEX);
// next is remove for bug615957
//if (compactLatex || first) t << "\\input" ; else t << "\\include";
t << "\\input" ;
t << "{" << name << "}\n";
}
void LatexGenerator::writeQuickLinks ( bool  ,
HighlightedItem  ,
const char *   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 257 of file latexgen.h.

{}
void LatexGenerator::writeRuler ( )
inlinevirtual

Writes a horizontal ruler to the output

Implements BaseOutputDocInterface.

Definition at line 198 of file latexgen.h.

References endl(), and OutputGenerator::t.

{ t << endl << endl; }
void LatexGenerator::writeSearchInfo ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 121 of file latexgen.h.

{}
void LatexGenerator::writeSplitBar ( const char *  )
inlinevirtual

Implements OutputGenerator.

Definition at line 254 of file latexgen.h.

{}
void LatexGenerator::writeStartAnnoItem ( const char *  type,
const char *  file,
const char *  path,
const char *  name 
)
virtual

Implements OutputGenerator.

Definition at line 1328 of file latexgen.cpp.

References docify(), and OutputGenerator::t.

{
t << "\\item\\contentsline{section}{\\bf ";
if (path) docify(path);
docify(name);
t << "} ";
}
void LatexGenerator::writeString ( const char *  text)
virtual

Writes an ASCII string to the output, without converting special characters.

Implements BaseOutputDocInterface.

Definition at line 1269 of file latexgen.cpp.

References OutputGenerator::t.

{
t << text;
}
void LatexGenerator::writeStyleInfo ( int  part)
virtual

Implements OutputGenerator.

Definition at line 1244 of file latexgen.cpp.

References OutputGenerator::endPlainFile(), OutputGenerator::startPlainFile(), OutputGenerator::t, and writeDefaultStyleSheet().

{
if (part > 0)
return;
startPlainFile("doxygen.sty");
writeDefaultStyleSheet(t);
endPlainFile();
}
void LatexGenerator::writeStyleSheetFile ( QFile &  f)
static

Definition at line 775 of file latexgen.cpp.

References endl(), OutputGenerator::t, versionString, and writeDefaultStyleSheet().

Referenced by readConfiguration().

{
FTextStream t(&f);
t << "% stylesheet for doxygen " << versionString << endl;
writeDefaultStyleSheet(t);
}
void LatexGenerator::writeSummaryLink ( const char *  ,
const char *  ,
const char *  ,
bool   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 258 of file latexgen.h.

{}
void LatexGenerator::writeSynopsis ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 247 of file latexgen.h.

{}
void LatexGenerator::writeTooltip ( const char *  id,
const DocLinkInfo &  docInfo,
const char *  decl,
const char *  desc,
const SourceLinkInfo &  defInfo,
const SourceLinkInfo &  declInfo 
)
inlinevirtual

Writes a tool tip definition

Parameters
idunique identifier for the tooltip
docInfoInfo about the symbol's documentation.
declfull declaration of the symbol (for functions)
descbrief description for the symbol
defInfoInfo about the symbol's definition in the source code
declInfoInfo about the symbol's declaration in the source code

Implements CodeOutputInterface.

Definition at line 101 of file latexgen.h.

References m_codeGen, and LatexCodeGenerator::writeTooltip().

{ m_codeGen.writeTooltip(id,docInfo,decl,desc,defInfo,declInfo); }

Member Data Documentation

bool LatexGenerator::disableLinks
private

Definition at line 331 of file latexgen.h.

Referenced by endGroupHeader(), endMemberDoc(), endMemberHeader(), LatexGenerator(), startGroupHeader(), startMemberHeader(), startTextLink(), and writeObjectLink().

bool LatexGenerator::firstDescItem
private

Definition at line 330 of file latexgen.h.

Referenced by endDescItem(), endDescription(), LatexGenerator(), and startDescItem().

bool LatexGenerator::insideTabbing
private

Definition at line 329 of file latexgen.h.

Referenced by addIndexItem(), docify(), endAnonTypeScope(), endMemberDescription(), endMemberItem(), endMemberList(), endTitleHead(), LatexGenerator(), lineBreak(), startAnonTypeScope(), startMemberDescription(), startMemberDoc(), startMemberItem(), startMemberList(), writeDoc(), and writeNonBreakableSpace().

LatexCodeGenerator LatexGenerator::m_codeGen
private

Definition at line 336 of file latexgen.h.

Referenced by codify(), endCodeLine(), endFile(), endFontClass(), startCodeLine(), startFile(), startFontClass(), writeCodeAnchor(), writeCodeLink(), writeLineNumber(), and writeTooltip().

int LatexGenerator::m_indent
private

Definition at line 333 of file latexgen.h.

Referenced by endAnonTypeScope(), LatexGenerator(), startAnonTypeScope(), and startMemberDescription().

bool LatexGenerator::m_prettyCode
private

Definition at line 335 of file latexgen.h.

Referenced by endIndexSection(), and LatexGenerator().

QCString LatexGenerator::relPath
private

Definition at line 332 of file latexgen.h.

Referenced by endCallGraph(), endDirDepGraph(), endDotGraph(), endGroupCollaboration(), endInclDepGraph(), and startFile().

bool LatexGenerator::templateMemberItem
private

Definition at line 334 of file latexgen.h.

Referenced by endMemberItem(), endMemberTemplateParams(), LatexGenerator(), startMemberItem(), and startMemberTemplateParams().

The documentation for this class was generated from the following files: