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)
 
OutputGeneratorget (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 *, 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 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 ()
 
void endMemberDocSimple ()
 
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 &)
 
LatexGeneratoroperator= (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
}
 
- Public Types inherited from BaseOutputDocInterface
enum  ParamListTypes { Param, RetVal, Exception }
 
enum  SectionTypes { EnumValues, Examples }
 
- Protected Attributes inherited from OutputGenerator
FTextStream t
 
QFilefile
 
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.

246  : OutputGenerator()
247 {
248  dir=Config_getString("LATEX_OUTPUT");
249  //printf("LatexGenerator::LatexGenerator() insideTabbing=FALSE\n");
253  m_indent=0;
255  m_prettyCode=Config_getBool("LATEX_SOURCE_CODE");
256 }
bool templateMemberItem
Definition: latexgen.h:341
const bool FALSE
Definition: qglobal.h:370
bool disableLinks
Definition: latexgen.h:338
bool insideTabbing
Definition: latexgen.h:336
#define Config_getString(val)
Definition: config.cpp:660
#define Config_getBool(val)
Definition: config.cpp:664
QCString dir
Definition: outputgen.h:489
bool firstDescItem
Definition: latexgen.h:337
const bool TRUE
Definition: qglobal.h:371
bool m_prettyCode
Definition: latexgen.h:342
LatexGenerator::~LatexGenerator ( )

Definition at line 258 of file latexgen.cpp.

259 {
260 }
LatexGenerator::LatexGenerator ( const LatexGenerator )
private

Member Function Documentation

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

Implements BaseOutputDocInterface.

Definition at line 1648 of file latexgen.cpp.

1649 {
1650  if (s1)
1651  {
1652  t << "\\index{";
1654  t << "@{";
1656  t << "}";
1657  if (s2)
1658  {
1659  t << "!";
1661  t << "@{";
1663  t << "}";
1664  }
1665  t << "}";
1666  }
1667 }
QCString latexEscapeIndexChars(const char *s, bool insideTabbing)
Definition: util.cpp:6683
bool insideTabbing
Definition: latexgen.h:336
QCString latexEscapeLabelName(const char *s, bool insideTabbing)
Definition: util.cpp:6647
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::addWord ( const char *  ,
bool   
)
inlinevirtual

Implements CodeOutputInterface.

Definition at line 330 of file latexgen.h.

330 {}
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.

94  { m_codeGen.codify(text); }
void codify(const char *text)
Definition: latexgen.cpp:71
LatexCodeGenerator m_codeGen
Definition: latexgen.h:343
void LatexGenerator::disable ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 85 of file latexgen.h.

85 { active=FALSE; }
const bool FALSE
Definition: qglobal.h:370
void LatexGenerator::disableIf ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 87 of file latexgen.h.

87 { if (o==Latex) disable(); }
void disable()
Definition: latexgen.h:85
void LatexGenerator::disableIfNot ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 88 of file latexgen.h.

88 { if (o!=Latex) disable(); }
void disable()
Definition: latexgen.h:85
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 1713 of file latexgen.cpp.

1714 {
1716 }
const bool FALSE
Definition: qglobal.h:370
bool insideTabbing
Definition: latexgen.h:336
void filterLatexString(FTextStream &t, const char *str, bool insideTabbing, bool insidePre, bool insideItem, bool keepSpaces)
Definition: util.cpp:6533
FTextStream t
Definition: outputgen.h:486
static QCString str
void LatexGenerator::enable ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 83 of file latexgen.h.

84  { if (genStack->top()) active=*genStack->top(); else active=TRUE; }
QStack< bool > * genStack
Definition: outputgen.h:491
const bool TRUE
Definition: qglobal.h:371
type * top() const
Definition: qstack.h:63
void LatexGenerator::enableIf ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 86 of file latexgen.h.

86 { if (o==Latex) enable(); }
void enable()
Definition: latexgen.h:83
void LatexGenerator::endAnonTypeScope ( int  indent)
virtual

Implements OutputGenerator.

Definition at line 1750 of file latexgen.cpp.

1751 {
1752  if (indent==0)
1753  {
1754  t << endl << "\\end{tabbing}";
1756  }
1757  m_indent=indent;
1758 }
const bool FALSE
Definition: qglobal.h:370
bool insideTabbing
Definition: latexgen.h:336
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::endBold ( )
inlinevirtual

End a section of text displayed in bold face.

Implements BaseOutputDocInterface.

Definition at line 205 of file latexgen.h.

205 { t << "}"; }
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::endCallGraph ( const DotCallGraph g)
virtual

Implements OutputGenerator.

Definition at line 1928 of file latexgen.cpp.

1929 {
1931 }
Definition: dot.h:43
#define Config_getString(val)
Definition: config.cpp:660
QCString relPath
Definition: latexgen.h:339
Definition: dot.h:42
QCString fileName
Definition: outputgen.h:488
QCString writeGraph(FTextStream &t, GraphOutputFormat gf, EmbeddedOutputFormat ef, const char *path, const char *fileName, const char *relPath, bool writeImageMap=TRUE, int graphId=-1) const
Definition: dot.cpp:3824
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::endCenter ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 225 of file latexgen.h.

225 { t << "\\end{center}" << endl; }
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::endClassDiagram ( const ClassDiagram d,
const char *  fileName,
const char *   
)
virtual

Implements OutputGenerator.

Definition at line 1732 of file latexgen.cpp.

1734 {
1736 }
void writeFigure(FTextStream &t, const char *path, const char *file) const
Definition: diagram.cpp:1057
QCString fileName
Definition: outputgen.h:488
QCString dir
Definition: outputgen.h:489
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::endCodeFragment ( )
virtual

Ends a source code fragment

Implements BaseOutputDocInterface.

Definition at line 2105 of file latexgen.cpp.

2106 {
2107  t << "\\end{DoxyCode}\n";
2108 }
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::endCodeLine ( )
inlinevirtual

Ends a line of code started with startCodeLine()

Implements CodeOutputInterface.

Definition at line 107 of file latexgen.h.

108  { m_codeGen.endCodeLine(); }
LatexCodeGenerator m_codeGen
Definition: latexgen.h:343
void LatexGenerator::endConstraintDocs ( )
virtual

Implements OutputGenerator.

Definition at line 2090 of file latexgen.cpp.

2091 {
2092 }
void LatexGenerator::endConstraintList ( )
virtual

Implements OutputGenerator.

Definition at line 2094 of file latexgen.cpp.

2095 {
2096  t << "\\end{description}" << endl;
2097  t << "\\end{Desc}" << endl;
2098 }
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::endConstraintParam ( )
virtual

Implements OutputGenerator.

Definition at line 2072 of file latexgen.cpp.

2073 {
2074 }
void LatexGenerator::endConstraintType ( )
virtual

Implements OutputGenerator.

Definition at line 2081 of file latexgen.cpp.

2082 {
2083  t << "}]";
2084 }
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::endContents ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 260 of file latexgen.h.

260 {}
void LatexGenerator::endDescForItem ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 241 of file latexgen.h.

241 {}
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 1959 of file latexgen.cpp.

1960 {
1961  if (firstDescItem)
1962  {
1963  t << "]" << endl;
1965  }
1966  else
1967  {
1968  lineBreak();
1969  }
1970 }
void lineBreak(const char *style=0)
Definition: latexgen.cpp:2127
const bool FALSE
Definition: qglobal.h:370
FTextStream t
Definition: outputgen.h:486
bool firstDescItem
Definition: latexgen.h:337
QTextStream & endl(QTextStream &s)
void LatexGenerator::endDescList ( )
inline

Definition at line 235 of file latexgen.h.

235 { t << "\\end{Desc}" << endl; }
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::endDescription ( )
virtual

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

Implements BaseOutputDocInterface.

Definition at line 1947 of file latexgen.cpp.

1948 {
1949  t << "\\end{description}" << endl;
1951 }
FTextStream t
Definition: outputgen.h:486
bool firstDescItem
Definition: latexgen.h:337
const bool TRUE
Definition: qglobal.h:371
QTextStream & endl(QTextStream &s)
void LatexGenerator::endDescTable ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 267 of file latexgen.h.

268  { t << "\\end{description}" << endl;
269  endDescForItem();
270  endSimpleSect();
271  }
void endSimpleSect()
Definition: latexgen.cpp:1987
FTextStream t
Definition: outputgen.h:486
void endDescForItem()
Definition: latexgen.h:241
QTextStream & endl(QTextStream &s)
void LatexGenerator::endDescTableData ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 277 of file latexgen.h.

277 {}
void LatexGenerator::endDescTableTitle ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 274 of file latexgen.h.

275  { t << "}]"; }
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::endDirDepGraph ( const DotDirDeps g)
virtual

Implements OutputGenerator.

Definition at line 1937 of file latexgen.cpp.

1938 {
1940 }
Definition: dot.h:43
#define Config_getString(val)
Definition: config.cpp:660
QCString relPath
Definition: latexgen.h:339
Definition: dot.h:42
QCString fileName
Definition: outputgen.h:488
FTextStream t
Definition: outputgen.h:486
QCString writeGraph(FTextStream &out, GraphOutputFormat gf, EmbeddedOutputFormat ef, const char *path, const char *fileName, const char *relPath, bool writeImageMap=TRUE, int graphId=-1, bool linkRelations=TRUE) const
Definition: dot.cpp:3977
void LatexGenerator::endDotGraph ( const DotClassGraph g)
virtual

Implements OutputGenerator.

Definition at line 1901 of file latexgen.cpp.

1902 {
1904 }
QCString writeGraph(FTextStream &t, GraphOutputFormat gf, EmbeddedOutputFormat ef, const char *path, const char *fileName, const char *relPath, bool TBRank=TRUE, bool imageMap=TRUE, int graphId=-1) const
Definition: dot.cpp:3133
Definition: dot.h:43
#define Config_getString(val)
Definition: config.cpp:660
QCString relPath
Definition: latexgen.h:339
Definition: dot.h:42
QCString fileName
Definition: outputgen.h:488
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::endDoxyAnchor ( const char *  fName,
const char *  anchor 
)
virtual

Implements OutputGenerator.

Definition at line 1606 of file latexgen.cpp.

1607 {
1608  static bool pdfHyperlinks = Config_getBool("PDF_HYPERLINKS");
1609  static bool usePDFLatex = Config_getBool("USE_PDFLATEX");
1610  if (usePDFLatex && pdfHyperlinks)
1611  {
1612  t << "\\hypertarget{";
1613  if (fName) t << stripPath(fName);
1614  if (anchor) t << "_" << anchor;
1615  t << "}{}";
1616  }
1617  t << "\\label{";
1618  if (fName) t << stripPath(fName);
1619  if (anchor) t << "_" << anchor;
1620  t << "}" << endl;
1621 }
static QCString stripPath(const QCString &s)
Definition: tagreader.cpp:1287
#define Config_getBool(val)
Definition: config.cpp:664
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::endEmphasis ( )
inlinevirtual

Ends a section of text displayed in italic.

Implements BaseOutputDocInterface.

Definition at line 203 of file latexgen.h.

203 { t << "}"; }
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::endFile ( )
virtual

Implements OutputGenerator.

Definition at line 809 of file latexgen.cpp.

810 {
811  endPlainFile();
813 }
void endPlainFile()
Definition: outputgen.cpp:55
void setSourceFileName(const QCString &sourceFileName)
Definition: latexgen.cpp:66
LatexCodeGenerator m_codeGen
Definition: latexgen.h:343
void LatexGenerator::endFontClass ( )
inlinevirtual

Ends a block started with startFontClass()

Implements CodeOutputInterface.

Definition at line 111 of file latexgen.h.

112  { m_codeGen.endFontClass(); }
LatexCodeGenerator m_codeGen
Definition: latexgen.h:343
void LatexGenerator::endGroupCollaboration ( const DotGroupCollaboration g)
virtual

Implements OutputGenerator.

Definition at line 1919 of file latexgen.cpp.

1920 {
1922 }
QCString writeGraph(FTextStream &t, GraphOutputFormat gf, EmbeddedOutputFormat ef, const char *path, const char *fileName, const char *relPath, bool writeImageMap=TRUE, int graphId=-1) const
Definition: dot.cpp:4519
Definition: dot.h:43
#define Config_getString(val)
Definition: config.cpp:660
QCString relPath
Definition: latexgen.h:339
Definition: dot.h:42
QCString fileName
Definition: outputgen.h:488
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::endGroupHeader ( int  )
virtual

Implements OutputGenerator.

Definition at line 1509 of file latexgen.cpp.

1510 {
1512  t << "}" << endl;
1513 }
const bool FALSE
Definition: qglobal.h:370
bool disableLinks
Definition: latexgen.h:338
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::endHeaderSection ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 171 of file latexgen.h.

171 {}
void LatexGenerator::endHtmlLink ( )
virtual

Ends a link started by startHtmlLink().

Implements BaseOutputDocInterface.

Definition at line 1323 of file latexgen.cpp.

1324 {
1325  t << "}";
1326 }
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::endInclDepGraph ( const DotInclDepGraph g)
virtual

Implements OutputGenerator.

Definition at line 1910 of file latexgen.cpp.

1911 {
1913 }
Definition: dot.h:43
#define Config_getString(val)
Definition: config.cpp:660
QCString relPath
Definition: latexgen.h:339
Definition: dot.h:42
QCString fileName
Definition: outputgen.h:488
FTextStream t
Definition: outputgen.h:486
QCString writeGraph(FTextStream &t, GraphOutputFormat gf, EmbeddedOutputFormat ef, const char *path, const char *fileName, const char *relPath, bool writeImageMap=TRUE, int graphId=-1) const
Definition: dot.cpp:3503
void LatexGenerator::endIndent ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 246 of file latexgen.h.

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

Implements OutputGenerator.

Definition at line 1296 of file latexgen.cpp.

1297 {
1298  if (!ref && fn)
1299  {
1300  t << "}{\\pageref{" << stripPath(fn) << "}}{}" << endl;
1301  }
1302 }
static QCString stripPath(const QCString &s)
Definition: tagreader.cpp:1287
QAsciiDict< Entry > fn
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::endIndexKey ( )
virtual

Implements OutputGenerator.

Definition at line 1360 of file latexgen.cpp.

1361 {
1362 }
void LatexGenerator::endIndexList ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 144 of file latexgen.h.

144 { t << "\\end{DoxyCompactList}" << endl; }
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::endIndexListItem ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 142 of file latexgen.h.

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

Implements OutputGenerator.

Definition at line 1000 of file latexgen.cpp.

1001 {
1002  //static bool compactLatex = Config_getBool("COMPACT_LATEX");
1003  static bool sourceBrowser = Config_getBool("SOURCE_BROWSER");
1004  static QCString latexHeader = Config_getString("LATEX_HEADER");
1005  static QCString latexFooter = Config_getString("LATEX_FOOTER");
1006  switch (is)
1007  {
1008  case isTitlePageStart:
1009  break;
1010  case isTitlePageAuthor:
1011  if (latexHeader.isEmpty())
1012  {
1014  }
1015  break;
1016  case isMainPage:
1017  {
1018  //QCString indexName=Config_getBool("GENERATE_TREEVIEW")?"main":"index";
1019  QCString indexName="index";
1020  t << "}\n\\label{index}";
1021  if (Config_getBool("PDF_HYPERLINKS")) t << "\\hypertarget{index}{}";
1022  t << "\\input{" << indexName << "}\n";
1023  }
1024  break;
1025  case isModuleIndex:
1026  t << "}\n\\input{modules}\n";
1027  break;
1028  case isDirIndex:
1029  t << "}\n\\input{dirs}\n";
1030  break;
1031  case isNamespaceIndex:
1032  t << "}\n\\input{namespaces}\n";
1033  break;
1034  case isClassHierarchyIndex:
1035  t << "}\n\\input{hierarchy}\n";
1036  break;
1037  case isCompoundIndex:
1038  t << "}\n\\input{annotated}\n";
1039  break;
1040  case isFileIndex:
1041  t << "}\n\\input{files}\n";
1042  break;
1043  case isPageIndex:
1044  t << "}\n\\input{pages}\n";
1045  break;
1046  case isModuleDocumentation:
1047  {
1049  GroupDef *gd;
1050  bool found=FALSE;
1051  for (gli.toFirst();(gd=gli.current()) && !found;++gli)
1052  {
1053  if (!gd->isReference())
1054  {
1055  t << "}\n\\input{" << gd->getOutputFileBase() << "}\n";
1056  found=TRUE;
1057  }
1058  }
1059  for (;(gd=gli.current());++gli)
1060  {
1061  if (!gd->isReference())
1062  {
1063  //if (compactLatex) t << "\\input"; else t << "\\include";
1064  t << "\\include";
1065  t << "{" << gd->getOutputFileBase() << "}\n";
1066  }
1067  }
1068  }
1069  break;
1070  case isDirDocumentation:
1071  {
1073  DirDef *dd;
1074  bool found=FALSE;
1075  for (dli.toFirst();(dd=dli.current()) && !found;++dli)
1076  {
1077  if (dd->isLinkableInProject())
1078  {
1079  t << "}\n\\input{" << dd->getOutputFileBase() << "}\n";
1080  found=TRUE;
1081  }
1082  }
1083  for (;(dd=dli.current());++dli)
1084  {
1085  if (dd->isLinkableInProject())
1086  {
1087  //if (compactLatex) t << "\\input"; else t << "\\include";
1088  t << "\\input";
1089  t << "{" << dd->getOutputFileBase() << "}\n";
1090  }
1091  }
1092  }
1093  break;
1095  {
1097  NamespaceDef *nd;
1098  bool found=FALSE;
1099  for (nli.toFirst();(nd=nli.current()) && !found;++nli)
1100  {
1101  if (nd->isLinkableInProject())
1102  {
1103  t << "}\n\\input{" << nd->getOutputFileBase() << "}\n";
1104  found=TRUE;
1105  }
1106  }
1107  while ((nd=nli.current()))
1108  {
1109  if (nd->isLinkableInProject())
1110  {
1111  //if (compactLatex) t << "\\input"; else t << "\\include";
1112  t << "\\input";
1113  t << "{" << nd->getOutputFileBase() << "}\n";
1114  }
1115  ++nli;
1116  }
1117  }
1118  break;
1119  case isClassDocumentation:
1120  {
1122  ClassDef *cd=0;
1123  bool found=FALSE;
1124  for (cli.toFirst();(cd=cli.current()) && !found;++cli)
1125  {
1126  if (cd->isLinkableInProject() &&
1127  cd->templateMaster()==0 &&
1128  !cd->isEmbeddedInOuterScope()
1129  )
1130  {
1131  t << "}\n\\input{" << cd->getOutputFileBase() << "}\n";
1132  found=TRUE;
1133  }
1134  }
1135  for (;(cd=cli.current());++cli)
1136  {
1137  if (cd->isLinkableInProject() &&
1138  cd->templateMaster()==0 &&
1139  !cd->isEmbeddedInOuterScope()
1140  )
1141  {
1142  //if (compactLatex) t << "\\input"; else t << "\\include";
1143  t << "\\input";
1144  t << "{" << cd->getOutputFileBase() << "}\n";
1145  }
1146  }
1147  }
1148  break;
1149  case isFileDocumentation:
1150  {
1151  bool isFirst=TRUE;
1153  FileName *fn;
1154  for (fnli.toFirst();(fn=fnli.current());++fnli)
1155  {
1156  FileNameIterator fni(*fn);
1157  FileDef *fd;
1158  for (;(fd=fni.current());++fni)
1159  {
1160  if (fd->isLinkableInProject())
1161  {
1162  if (isFirst)
1163  {
1164  t << "}\n\\input{" << fd->getOutputFileBase() << "}\n";
1165  if (sourceBrowser && m_prettyCode && fd->generateSourceFile())
1166  {
1167  //t << "\\include{" << fd->getSourceFileBase() << "}\n";
1168  t << "\\input{" << fd->getSourceFileBase() << "}\n";
1169  }
1170  isFirst=FALSE;
1171  }
1172  else
1173  {
1174  //if (compactLatex) t << "\\input" ; else t << "\\include";
1175  t << "\\input" ;
1176  t << "{" << fd->getOutputFileBase() << "}\n";
1177  if (sourceBrowser && m_prettyCode && fd->generateSourceFile())
1178  {
1179  //t << "\\include{" << fd->getSourceFileBase() << "}\n";
1180  t << "\\input{" << fd->getSourceFileBase() << "}\n";
1181  }
1182  }
1183  }
1184  }
1185  }
1186  }
1187  break;
1189  {
1190  t << "}\n";
1192  PageDef *pd=pdi.toFirst();
1193  if (pd)
1194  {
1195  t << "\\input{" << pd->getOutputFileBase() << "}\n";
1196  }
1197  for (++pdi;(pd=pdi.current());++pdi)
1198  {
1199  //if (compactLatex) t << "\\input" ; else t << "\\include";
1200  t << "\\input";
1201  t << "{" << pd->getOutputFileBase() << "}\n";
1202  }
1203  }
1204  break;
1205  case isPageDocumentation:
1206  {
1207  t << "}\n";
1208 #if 0
1210  PageDef *pd=pdi.toFirst();
1211  bool first=TRUE;
1212  for (pdi.toFirst();(pd=pdi.current());++pdi)
1213  {
1214  if (!pd->getGroupDef() && !pd->isReference())
1215  {
1216  if (compactLatex) t << "\\section"; else t << "\\chapter";
1217  t << "{" << pd->title();
1218  t << "}\n";
1219 
1220  if (compactLatex || first) t << "\\input" ; else t << "\\include";
1221  t << "{" << pd->getOutputFileBase() << "}\n";
1222  first=FALSE;
1223  }
1224  }
1225 #endif
1226  }
1227  break;
1228  case isPageDocumentation2:
1229  break;
1230  case isEndIndex:
1231  if (latexFooter.isEmpty())
1232  {
1234  }
1235  else
1236  {
1237  QCString footer = fileToString(latexFooter);
1238  t << substituteKeywords(footer,"",
1239  convertToLaTeX(Config_getString("PROJECT_NAME")),
1240  convertToLaTeX(Config_getString("PROJECT_NUMBER")),
1241  convertToLaTeX(Config_getString("PROJECT_BRIEF")));
1242  }
1243  break;
1244  }
1245 }
static GroupSDict * groupSDict
Definition: doxygen.h:119
QCString fileToString(const char *name, bool filter, bool isSourceCode)
Definition: util.cpp:2418
QCString substituteKeywords(const QCString &s, const char *title, const char *projName, const char *projNum, const char *projBrief)
Definition: util.cpp:5122
bool isLinkableInProject() const
Definition: classdef.cpp:2707
static PageSDict * exampleSDict
Definition: doxygen.h:101
bool isEmpty() const
Definition: qcstring.h:189
static void writeDefaultHeaderPart3(FTextStream &t)
Definition: latexgen.cpp:706
QCString title() const
Definition: pagedef.h:54
bool generateSourceFile() const
Definition: filedef.cpp:1396
QCString getOutputFileBase() const
const bool FALSE
Definition: qglobal.h:370
static FileNameList * inputNameList
Definition: doxygen.h:109
virtual bool isReference() const
QCString convertToLaTeX(const QCString &s, bool insideTabbing, bool keepSpaces)
Definition: util.cpp:5812
static NamespaceSDict * namespaceSDict
Definition: doxygen.h:120
ClassDef * templateMaster() const
Definition: classdef.cpp:4439
def cli(ctx)
Definition: main.py:7
Definition: sortdict.h:73
QAsciiDict< Entry > fn
bool isLinkableInProject() const
Definition: filedef.cpp:1877
QCString getSourceFileBase() const
Definition: filedef.cpp:1771
static DirSDict * directories
Definition: doxygen.h:139
static PageSDict * pageSDict
Definition: doxygen.h:102
bool isEmbeddedInOuterScope() const
Definition: classdef.cpp:4630
Definition: dirdef.h:44
#define Config_getString(val)
Definition: config.cpp:660
#define Config_getBool(val)
Definition: config.cpp:664
bool isLinkableInProject() const
Definition: dirdef.cpp:58
QCString getOutputFileBase() const
Definition: filedef.h:83
QCString getOutputFileBase() const
Definition: classdef.cpp:3533
QCString getOutputFileBase() const
Definition: dirdef.cpp:113
FTextStream t
Definition: outputgen.h:486
static void writeDefaultFooter(FTextStream &t)
Definition: latexgen.cpp:741
A model of a page symbol.
Definition: pagedef.h:29
friend class Iterator
Definition: sortdict.h:289
bool isLinkableInProject() const
QCString getOutputFileBase() const
Definition: groupdef.cpp:1512
static ClassSDict * classSDict
Definition: doxygen.h:99
QCString getOutputFileBase() const
Definition: pagedef.cpp:58
const bool TRUE
Definition: qglobal.h:371
GroupDef * getGroupDef() const
Definition: pagedef.cpp:52
bool m_prettyCode
Definition: latexgen.h:342
void LatexGenerator::endIndexValue ( const char *  name,
bool   
)
virtual

Implements OutputGenerator.

Definition at line 1370 of file latexgen.cpp.

1371 {
1372  //if (hasBrief) t << ")";
1373  t << "}{\\pageref{" << name << "}}{}" << endl;
1374 }
static QCString name
Definition: declinfo.cpp:673
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::endInlineHeader ( )
virtual

Implements OutputGenerator.

Definition at line 2122 of file latexgen.cpp.

2123 {
2124  t << "}" << endl;
2125 }
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::endInlineMemberDoc ( )
virtual

Implements OutputGenerator.

Definition at line 2173 of file latexgen.cpp.

2174 {
2175  t << "\\\\\n\\hline\n" << endl;
2176 }
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::endInlineMemberName ( )
virtual

Implements OutputGenerator.

Definition at line 2164 of file latexgen.cpp.

2165 {
2166  t << "&" << endl;
2167 }
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::endInlineMemberType ( )
virtual

Implements OutputGenerator.

Definition at line 2155 of file latexgen.cpp.

2156 {
2157  t << "&" << endl;
2158 }
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::endItemList ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 150 of file latexgen.h.

150 { t << "\\end{DoxyCompactItemize}" << endl; }
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
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.

166 {}
void LatexGenerator::endLabels ( )
virtual

Implements OutputGenerator.

Definition at line 2189 of file latexgen.cpp.

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

Implements OutputGenerator.

Definition at line 231 of file latexgen.h.

231 {}
void LatexGenerator::endMemberDescription ( )
virtual

Implements OutputGenerator.

Definition at line 1809 of file latexgen.cpp.

1810 {
1811  if (!insideTabbing)
1812  {
1813  //t << "\\item\\end{DoxyCompactList}";
1814  t << "\\end{DoxyCompactList}";
1815  }
1816  else
1817  {
1818  t << "}\\\\\n";
1819  }
1820 }
bool insideTabbing
Definition: latexgen.h:336
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::endMemberDoc ( bool  )
virtual

Implements OutputGenerator.

Definition at line 1593 of file latexgen.cpp.

1594 {
1596  t << "}";
1597  //if (Config_getBool("COMPACT_LATEX")) t << "\\hfill";
1598 }
const bool FALSE
Definition: qglobal.h:370
bool disableLinks
Definition: latexgen.h:338
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::endMemberDocList ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 177 of file latexgen.h.

177 {}
void LatexGenerator::endMemberDocName ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 298 of file latexgen.h.

298 {}
void LatexGenerator::endMemberDocPrefixItem ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 296 of file latexgen.h.

296 {}
void LatexGenerator::endMemberDocSimple ( )
virtual

Implements OutputGenerator.

Definition at line 2146 of file latexgen.cpp.

2147 {
2148  t << "\\end{DoxyFields}" << endl;
2149 }
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::endMemberGroup ( bool  hasHeader)
virtual

Implements OutputGenerator.

Definition at line 1890 of file latexgen.cpp.

1891 {
1892  if (hasHeader)t << "\\end{Indent}";
1893  t << endl;
1894 }
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::endMemberGroupDocs ( )
virtual

Implements OutputGenerator.

Definition at line 1881 of file latexgen.cpp.

1882 {
1883  t << "}";
1884 }
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::endMemberGroupHeader ( )
virtual

Implements OutputGenerator.

Definition at line 1869 of file latexgen.cpp.

1870 {
1871  // changed back to rev 756 due to bug 660501
1872  t << "}\\par" << endl;
1873  //t << "}" << endl;
1874 }
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::endMemberHeader ( )
virtual

Implements OutputGenerator.

Definition at line 1528 of file latexgen.cpp.

1529 {
1531  t << "}" << endl;
1532 }
const bool FALSE
Definition: qglobal.h:370
bool disableLinks
Definition: latexgen.h:338
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::endMemberItem ( )
virtual

Implements OutputGenerator.

Definition at line 1786 of file latexgen.cpp.

1787 {
1788  if (insideTabbing)
1789  {
1790  t << "\\\\";
1791  }
1793  t << endl;
1794 }
bool templateMemberItem
Definition: latexgen.h:341
const bool FALSE
Definition: qglobal.h:370
bool insideTabbing
Definition: latexgen.h:336
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::endMemberList ( )
virtual

Implements OutputGenerator.

Definition at line 1844 of file latexgen.cpp.

1845 {
1846  //printf("LatexGenerator::endMemberList(%d)\n",insideTabbing);
1847  if (!insideTabbing)
1848  {
1849  t << "\\end{DoxyCompactItemize}" << endl;
1850  }
1851 }
bool insideTabbing
Definition: latexgen.h:336
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::endMemberSections ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 169 of file latexgen.h.

169 {}
void LatexGenerator::endMemberSubtitle ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 175 of file latexgen.h.

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

Implements OutputGenerator.

Definition at line 1768 of file latexgen.cpp.

1769 {
1770  if (templateMemberItem)
1771  {
1772  t << "}\\\\";
1773  }
1774 }
bool templateMemberItem
Definition: latexgen.h:341
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::endPageRef ( const char *  clname,
const char *  anchor 
)
virtual

Implements BaseOutputDocInterface.

Definition at line 1431 of file latexgen.cpp.

1432 {
1433  t << "}{";
1434  if (clname) t << clname;
1435  if (anchor) t << "_" << anchor;
1436  t << "}";
1437 }
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::endParagraph ( )
virtual

Ends a paragraph

Implements BaseOutputDocInterface.

Definition at line 1277 of file latexgen.cpp.

1278 {
1279  t << endl << endl;
1280 }
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::endParameterList ( )
virtual

Implements OutputGenerator.

Definition at line 2011 of file latexgen.cpp.

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

Implements OutputGenerator.

Definition at line 2031 of file latexgen.cpp.

2032 {
2033  t << "}" << endl;
2034 
2035  if (last)
2036  {
2037  t << "\\end{DoxyParamCaption}" << endl;
2038  if (closeBracket) t << ")";
2039  }
2040 }
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::endParameterType ( )
virtual

Implements OutputGenerator.

Definition at line 2021 of file latexgen.cpp.

2022 {
2023  t << "}]";
2024 }
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::endParamList ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1999 of file latexgen.cpp.

2000 {
2001  t << "\\end{Desc}" << endl;
2002 }
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::endProjectNumber ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 130 of file latexgen.h.

130 {}
void LatexGenerator::endQuickIndices ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 253 of file latexgen.h.

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

Implements BaseOutputDocInterface.

Definition at line 1707 of file latexgen.cpp.

1708 {
1709  t << "}\\label{" << lab << "}" << endl;
1710 }
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::endSimpleSect ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1987 of file latexgen.cpp.

1988 {
1989  t << "\\end{Desc}" << endl;
1990 }
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::endSmall ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 227 of file latexgen.h.

227 { t << "\\normalsize "; }
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::endSubsection ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 221 of file latexgen.h.

221 { t << "}" << endl; }
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::endSubsubsection ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 223 of file latexgen.h.

223 { t << "}" << endl; }
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::endTextBlock ( bool  )
inlinevirtual

Implements OutputGenerator.

Definition at line 293 of file latexgen.h.

293 {}
void LatexGenerator::endTextLink ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1399 of file latexgen.cpp.

1400 {
1401  t << "}";
1402 }
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::endTitle ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 135 of file latexgen.h.

135 { t << "}"; }
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::endTitleHead ( const char *  fileName,
const char *  name 
)
virtual

Implements OutputGenerator.

Definition at line 1458 of file latexgen.cpp.

1459 {
1460  t << "}" << endl;
1461  if (name)
1462  {
1463  t << "\\label{" << stripPath(fileName) << "}\\index{";
1465  t << "@{";
1467  t << "}}" << endl;
1468  }
1469 }
static QCString name
Definition: declinfo.cpp:673
QCString latexEscapeIndexChars(const char *s, bool insideTabbing)
Definition: util.cpp:6683
static QCString stripPath(const QCString &s)
Definition: tagreader.cpp:1287
bool insideTabbing
Definition: latexgen.h:336
QCString latexEscapeLabelName(const char *s, bool insideTabbing)
Definition: util.cpp:6647
QCString fileName
Definition: outputgen.h:488
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::endTypewriter ( )
inlinevirtual

End a section of text displayed in typewriter style.

Implements BaseOutputDocInterface.

Definition at line 162 of file latexgen.h.

162 { t << "}"; }
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::exceptionEntry ( const char *  prefix,
bool  closeBracket 
)
virtual

Implements OutputGenerator.

Definition at line 2042 of file latexgen.cpp.

2043 {
2044  if (prefix)
2045  t << " " << prefix;
2046  else if (closeBracket)
2047  t << ")";
2048  t << " ";
2049 }
FTextStream t
Definition: outputgen.h:486
OutputGenerator* LatexGenerator::get ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 90 of file latexgen.h.

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

Definition at line 437 of file latexgen.cpp.

438 {
439 
440  QCString dir=Config_getString("LATEX_OUTPUT");
441  QDir d(dir);
442  if (!d.exists() && !d.mkdir(dir))
443  {
444  err("Could not create output directory %s\n",dir.data());
445  exit(1);
446  }
447 
449  writeMakeBat();
450 
451  createSubDirs(d);
452 }
Traverses directory structures and contents in a platform-independent way.
Definition: qdir.h:52
static void writeMakeBat()
Definition: latexgen.cpp:354
const char * data() const
Definition: qcstring.h:207
#define Config_getString(val)
Definition: config.cpp:660
void err(const char *fmt,...)
Definition: message.cpp:226
QCString dir
Definition: outputgen.h:489
void createSubDirs(QDir &d)
Definition: util.cpp:5458
static void writeLatexMakefile()
Definition: latexgen.cpp:262
void LatexGenerator::insertMemberAlign ( bool  )
inlinevirtual

Implements OutputGenerator.

Definition at line 196 of file latexgen.h.

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

Implements OutputGenerator.

Definition at line 89 of file latexgen.h.

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

Implements OutputGenerator.

Definition at line 278 of file latexgen.h.

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

Implements BaseOutputDocInterface.

Definition at line 2127 of file latexgen.cpp.

2128 {
2129  if (insideTabbing)
2130  {
2131  t << "\\\\\n";
2132  }
2133  else
2134  {
2135  t << "\\\\*\n";
2136  }
2137 }
bool insideTabbing
Definition: latexgen.h:336
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::newParagraph ( )

Definition at line 1267 of file latexgen.cpp.

1268 {
1269  t << endl << endl;
1270 }
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
LatexGenerator& LatexGenerator::operator= ( const LatexGenerator )
private
void LatexGenerator::setCurrentDoc ( Definition ,
const char *  ,
bool   
)
inlinevirtual

Implements CodeOutputInterface.

Definition at line 329 of file latexgen.h.

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

Implements OutputGenerator.

Definition at line 1739 of file latexgen.cpp.

1740 {
1741  if (indent==0)
1742  {
1743  t << "\\begin{tabbing}" << endl;
1744  t << "xx\\=xx\\=xx\\=xx\\=xx\\=xx\\=xx\\=xx\\=xx\\=\\kill" << endl;
1746  }
1747  m_indent=indent;
1748 }
bool insideTabbing
Definition: latexgen.h:336
FTextStream t
Definition: outputgen.h:486
const bool TRUE
Definition: qglobal.h:371
QTextStream & endl(QTextStream &s)
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.

204 { t << "{\\bfseries "; }
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::startCallGraph ( )
virtual

Implements OutputGenerator.

Definition at line 1924 of file latexgen.cpp.

1925 {
1926 }
void LatexGenerator::startCenter ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 224 of file latexgen.h.

224 { t << "\\begin{center}" << endl; }
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::startClassDiagram ( )
virtual

Implements OutputGenerator.

Definition at line 1726 of file latexgen.cpp.

1727 {
1728  //if (Config_getBool("COMPACT_LATEX")) t << "\\subsubsection"; else t << "\\subsection";
1729  //t << "{";
1730 }
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 2100 of file latexgen.cpp.

2101 {
2102  t << "\n\\begin{DoxyCode}\n";
2103 }
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::startCodeLine ( bool  hasLineNumbers)
inlinevirtual

Implements CodeOutputInterface.

Definition at line 105 of file latexgen.h.

106  { m_codeGen.startCodeLine(hasLineNumbers); }
void startCodeLine(bool)
Definition: latexgen.cpp:223
LatexCodeGenerator m_codeGen
Definition: latexgen.h:343
void LatexGenerator::startConstraintDocs ( )
virtual

Implements OutputGenerator.

Definition at line 2086 of file latexgen.cpp.

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

Implements OutputGenerator.

Definition at line 2059 of file latexgen.cpp.

2060 {
2061  t << "\\begin{Desc}\n\\item[";
2062  docify(header);
2063  t << "]";
2064  t << "\\begin{description}" << endl;
2065 }
FTextStream t
Definition: outputgen.h:486
void docify(const char *text)
Definition: latexgen.cpp:1713
QTextStream & endl(QTextStream &s)
void LatexGenerator::startConstraintParam ( )
virtual

Implements OutputGenerator.

Definition at line 2067 of file latexgen.cpp.

2068 {
2069  t << "\\item[{\\em ";
2070 }
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::startConstraintType ( )
virtual

Implements OutputGenerator.

Definition at line 2076 of file latexgen.cpp.

2077 {
2078  t << "} : {\\em ";
2079 }
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::startContents ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 259 of file latexgen.h.

259 {}
void LatexGenerator::startDescForItem ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 240 of file latexgen.h.

240 { t << "\\par" << endl; }
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::startDescItem ( )
virtual

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

Implements BaseOutputDocInterface.

Definition at line 1953 of file latexgen.cpp.

1954 {
1956  t << "\\item[";
1957 }
FTextStream t
Definition: outputgen.h:486
bool firstDescItem
Definition: latexgen.h:337
const bool TRUE
Definition: qglobal.h:371
void LatexGenerator::startDescList ( SectionTypes  )
inline

Definition at line 234 of file latexgen.h.

234 { t << "\\begin{Desc}\n\\item["; }
FTextStream t
Definition: outputgen.h:486
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 1942 of file latexgen.cpp.

1943 {
1944  t << "\\begin{description}" << endl;
1945 }
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::startDescTable ( const char *  title)
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 263 of file latexgen.h.

266  t << "\\begin{description}" << endl; }
FTextStream t
Definition: outputgen.h:486
void startDescForItem()
Definition: latexgen.h:240
void startSimpleSect(SectionTypes, const char *, const char *, const char *)
Definition: latexgen.cpp:1972
QTextStream & endl(QTextStream &s)
void LatexGenerator::startDescTableData ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 276 of file latexgen.h.

276 {}
void LatexGenerator::startDescTableTitle ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 272 of file latexgen.h.

273  { t << "\\item[{\\em " << endl; }
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::startDirDepGraph ( )
virtual

Implements OutputGenerator.

Definition at line 1933 of file latexgen.cpp.

1934 {
1935 }
void LatexGenerator::startDotGraph ( )
virtual

Implements OutputGenerator.

Definition at line 1896 of file latexgen.cpp.

1897 {
1898  newParagraph();
1899 }
void newParagraph()
Definition: latexgen.cpp:1267
void LatexGenerator::startDoxyAnchor ( const char *  fName,
const char *  ,
const char *  anchor,
const char *  ,
const char *   
)
virtual

Implements OutputGenerator.

Definition at line 1600 of file latexgen.cpp.

1603 {
1604 }
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.

202 { t << "{\\em "; }
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::startFile ( const char *  name,
const char *  manName,
const char *  title 
)
virtual

Implements OutputGenerator.

Definition at line 795 of file latexgen.cpp.

796 {
797 #if 0
798  setEncoding(Config_getString("LATEX_OUTPUT_ENCODING"));
799 #endif
801  relPath = relativePathToRoot(fileName);
802  if (fileName.right(4)!=".tex" && fileName.right(4)!=".sty") fileName+=".tex";
803  startPlainFile(fileName);
807 }
static QCString name
Definition: declinfo.cpp:673
void setSourceFileName(const QCString &sourceFileName)
Definition: latexgen.cpp:66
void setTextStream(FTextStream &t)
Definition: latexgen.cpp:55
static QCString stripPath(const QCString &s)
Definition: tagreader.cpp:1287
QCString relativePathToRoot(const char *name)
Definition: util.cpp:5436
void setRelativePath(const QCString &path)
Definition: latexgen.cpp:61
void startPlainFile(const char *name)
Definition: outputgen.cpp:42
QCString right(uint len) const
Definition: qcstring.cpp:231
LatexCodeGenerator m_codeGen
Definition: latexgen.h:343
#define Config_getString(val)
Definition: config.cpp:660
QCString relPath
Definition: latexgen.h:339
QCString fileName
Definition: outputgen.h:488
FTextStream t
Definition: outputgen.h:486
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.

void startFontClass(const char *)
Definition: latexgen.cpp:233
LatexCodeGenerator m_codeGen
Definition: latexgen.h:343
static QCString * s
Definition: config.cpp:1042
void LatexGenerator::startGroupCollaboration ( )
virtual

Implements OutputGenerator.

Definition at line 1915 of file latexgen.cpp.

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

Implements OutputGenerator.

Definition at line 1483 of file latexgen.cpp.

1484 {
1485  if (Config_getBool("COMPACT_LATEX"))
1486  {
1487  extraIndentLevel++;
1488  }
1489 
1490  if (extraIndentLevel==3)
1491  {
1492  t << "\\subparagraph*{";
1493  }
1494  else if (extraIndentLevel==2)
1495  {
1496  t << "\\paragraph{";
1497  }
1498  else if (extraIndentLevel==1)
1499  {
1500  t << "\\subsubsection{";
1501  }
1502  else // extraIndentLevel==0
1503  {
1504  t << "\\subsection{";
1505  }
1507 }
bool disableLinks
Definition: latexgen.h:338
#define Config_getBool(val)
Definition: config.cpp:664
FTextStream t
Definition: outputgen.h:486
const bool TRUE
Definition: qglobal.h:371
void LatexGenerator::startHeaderSection ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 170 of file latexgen.h.

170 {}
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 1312 of file latexgen.cpp.

1313 {
1314  if (Config_getBool("PDF_HYPERLINKS"))
1315  {
1316  t << "\\href{";
1317  t << url;
1318  t << "}";
1319  }
1320  t << "{\\tt ";
1321 }
#define Config_getBool(val)
Definition: config.cpp:664
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::startInclDepGraph ( )
virtual

Implements OutputGenerator.

Definition at line 1906 of file latexgen.cpp.

1907 {
1908 }
void LatexGenerator::startIndent ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 245 of file latexgen.h.

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

Implements OutputGenerator.

Definition at line 1287 of file latexgen.cpp.

1288 {
1289  t << "\\item ";
1290  if (!ref && fn)
1291  {
1292  t << "\\contentsline{section}{";
1293  }
1294 }
QAsciiDict< Entry > fn
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::startIndexKey ( )
virtual

Implements OutputGenerator.

Definition at line 1355 of file latexgen.cpp.

1356 {
1357  t << "\\item\\contentsline{section}{";
1358 }
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::startIndexList ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 143 of file latexgen.h.

143 { t << "\\begin{DoxyCompactList}" << endl; }
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::startIndexListItem ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 141 of file latexgen.h.

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

Implements OutputGenerator.

Definition at line 825 of file latexgen.cpp.

826 {
827  bool &compactLatex = Config_getBool("COMPACT_LATEX");
828  QCString &latexHeader = Config_getString("LATEX_HEADER");
829  switch (is)
830  {
831  case isTitlePageStart:
832  {
833  if (latexHeader.isEmpty())
834  {
836  }
837  else
838  {
839  QCString header = fileToString(latexHeader);
840  t << substituteKeywords(header,"",
841  convertToLaTeX(Config_getString("PROJECT_NAME")),
842  convertToLaTeX(Config_getString("PROJECT_NUMBER")),
843  convertToLaTeX(Config_getString("PROJECT_BRIEF")));
844  }
845  }
846  break;
847  case isTitlePageAuthor:
848  if (latexHeader.isEmpty())
849  {
851  }
852  break;
853  case isMainPage:
854  if (compactLatex) t << "\\section"; else t << "\\chapter";
855  t << "{"; //Introduction}\n"
856  break;
857  //case isPackageIndex:
858  // if (compactLatex) t << "\\section"; else t << "\\chapter";
859  // t << "{"; //Package Index}\n"
860  // break;
861  case isModuleIndex:
862  if (compactLatex) t << "\\section"; else t << "\\chapter";
863  t << "{"; //Module Index}\n"
864  break;
865  case isDirIndex:
866  if (compactLatex) t << "\\section"; else t << "\\chapter";
867  t << "{"; //Directory Index}\n"
868  break;
869  case isNamespaceIndex:
870  if (compactLatex) t << "\\section"; else t << "\\chapter";
871  t << "{"; //Namespace Index}\"
872  break;
874  if (compactLatex) t << "\\section"; else t << "\\chapter";
875  t << "{"; //Hierarchical Index}\n"
876  break;
877  case isCompoundIndex:
878  if (compactLatex) t << "\\section"; else t << "\\chapter";
879  t << "{"; //Annotated Compound Index}\n"
880  break;
881  case isFileIndex:
882  if (compactLatex) t << "\\section"; else t << "\\chapter";
883  t << "{"; //Annotated File Index}\n"
884  break;
885  case isPageIndex:
886  if (compactLatex) t << "\\section"; else t << "\\chapter";
887  t << "{"; //Annotated Page Index}\n"
888  break;
890  {
892  GroupDef *gd;
893  bool found=FALSE;
894  for (gli.toFirst();(gd=gli.current()) && !found;++gli)
895  {
896  if (!gd->isReference())
897  {
898  if (compactLatex) t << "\\section"; else t << "\\chapter";
899  t << "{"; //Module Documentation}\n";
900  found=TRUE;
901  }
902  }
903  }
904  break;
905  case isDirDocumentation:
906  {
908  DirDef *dd;
909  bool found=FALSE;
910  for (dli.toFirst();(dd=dli.current()) && !found;++dli)
911  {
912  if (dd->isLinkableInProject())
913  {
914  if (compactLatex) t << "\\section"; else t << "\\chapter";
915  t << "{"; //Module Documentation}\n";
916  found=TRUE;
917  }
918  }
919  }
920  break;
922  {
924  NamespaceDef *nd;
925  bool found=FALSE;
926  for (nli.toFirst();(nd=nli.current()) && !found;++nli)
927  {
928  if (nd->isLinkableInProject())
929  {
930  if (compactLatex) t << "\\section"; else t << "\\chapter";
931  t << "{"; // Namespace Documentation}\n":
932  found=TRUE;
933  }
934  }
935  }
936  break;
938  {
940  ClassDef *cd=0;
941  bool found=FALSE;
942  for (cli.toFirst();(cd=cli.current()) && !found;++cli)
943  {
944  if (cd->isLinkableInProject() &&
945  cd->templateMaster()==0 &&
947  )
948  {
949  if (compactLatex) t << "\\section"; else t << "\\chapter";
950  t << "{"; //Compound Documentation}\n";
951  found=TRUE;
952  }
953  }
954  }
955  break;
956  case isFileDocumentation:
957  {
958  bool isFirst=TRUE;
960  FileName *fn;
961  for (fnli.toFirst();(fn=fnli.current());++fnli)
962  {
963  FileNameIterator fni(*fn);
964  FileDef *fd;
965  for (;(fd=fni.current());++fni)
966  {
967  if (fd->isLinkableInProject())
968  {
969  if (isFirst)
970  {
971  if (compactLatex) t << "\\section"; else t << "\\chapter";
972  t << "{"; //File Documentation}\n";
973  isFirst=FALSE;
974  break;
975  }
976  }
977  }
978  }
979  }
980  break;
982  {
983  if (compactLatex) t << "\\section"; else t << "\\chapter";
984  t << "{"; //Example Documentation}\n";
985  }
986  break;
987  case isPageDocumentation:
988  {
989  if (compactLatex) t << "\\section"; else t << "\\chapter";
990  t << "{"; //Page Documentation}\n";
991  }
992  break;
994  break;
995  case isEndIndex:
996  break;
997  }
998 }
static GroupSDict * groupSDict
Definition: doxygen.h:119
QCString fileToString(const char *name, bool filter, bool isSourceCode)
Definition: util.cpp:2418
QCString substituteKeywords(const QCString &s, const char *title, const char *projName, const char *projNum, const char *projBrief)
Definition: util.cpp:5122
bool isLinkableInProject() const
Definition: classdef.cpp:2707
bool isEmpty() const
Definition: qcstring.h:189
static void writeDefaultHeaderPart2(FTextStream &t)
Definition: latexgen.cpp:697
const bool FALSE
Definition: qglobal.h:370
static FileNameList * inputNameList
Definition: doxygen.h:109
virtual bool isReference() const
QCString convertToLaTeX(const QCString &s, bool insideTabbing, bool keepSpaces)
Definition: util.cpp:5812
static NamespaceSDict * namespaceSDict
Definition: doxygen.h:120
ClassDef * templateMaster() const
Definition: classdef.cpp:4439
def cli(ctx)
Definition: main.py:7
Definition: sortdict.h:73
QAsciiDict< Entry > fn
bool isLinkableInProject() const
Definition: filedef.cpp:1877
static DirSDict * directories
Definition: doxygen.h:139
bool isEmbeddedInOuterScope() const
Definition: classdef.cpp:4630
Definition: dirdef.h:44
#define Config_getString(val)
Definition: config.cpp:660
#define Config_getBool(val)
Definition: config.cpp:664
bool isLinkableInProject() const
Definition: dirdef.cpp:58
static void writeDefaultHeaderPart1(FTextStream &t)
Definition: latexgen.cpp:454
FTextStream t
Definition: outputgen.h:486
friend class Iterator
Definition: sortdict.h:289
bool isLinkableInProject() const
static ClassSDict * classSDict
Definition: doxygen.h:99
const bool TRUE
Definition: qglobal.h:371
void LatexGenerator::startIndexValue ( bool  hasBrief)
virtual

Implements OutputGenerator.

Definition at line 1364 of file latexgen.cpp.

1365 {
1366  t << " ";
1367  if (hasBrief) t << "\\\\*";
1368 }
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::startInlineHeader ( )
virtual

Implements OutputGenerator.

Definition at line 2110 of file latexgen.cpp.

2111 {
2112  if (Config_getBool("COMPACT_LATEX"))
2113  {
2114  t << "\\paragraph*{";
2115  }
2116  else
2117  {
2118  t << "\\subsubsection*{";
2119  }
2120 }
#define Config_getBool(val)
Definition: config.cpp:664
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::startInlineMemberDoc ( )
virtual

Implements OutputGenerator.

Definition at line 2169 of file latexgen.cpp.

2170 {
2171 }
void LatexGenerator::startInlineMemberName ( )
virtual

Implements OutputGenerator.

Definition at line 2160 of file latexgen.cpp.

2161 {
2162 }
void LatexGenerator::startInlineMemberType ( )
virtual

Implements OutputGenerator.

Definition at line 2151 of file latexgen.cpp.

2152 {
2153 }
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.

149 { t << "\\begin{DoxyCompactItemize}" << endl; }
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
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.

165 { t << "\\item " << endl; }
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::startLabels ( )
virtual

Implements OutputGenerator.

Definition at line 2178 of file latexgen.cpp.

2179 {
2180  t << "\\hspace{0.3cm}";
2181 }
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::startMemberDeclaration ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 230 of file latexgen.h.

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

Implements OutputGenerator.

Definition at line 1796 of file latexgen.cpp.

1797 {
1798  if (!insideTabbing)
1799  {
1800  t << "\\begin{DoxyCompactList}\\small\\item\\em ";
1801  }
1802  else
1803  {
1804  for (int i=0;i<m_indent+2;i++) t << "\\>";
1805  t << "{\\em ";
1806  }
1807 }
bool insideTabbing
Definition: latexgen.h:336
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::startMemberDoc ( const char *  clname,
const char *  memname,
const char *  ,
const char *  title,
bool  showInline 
)
virtual

Implements OutputGenerator.

Definition at line 1534 of file latexgen.cpp.

1539 {
1540  if (memname && memname[0]!='@')
1541  {
1542  t << "\\index{";
1543  if (clname)
1544  {
1546  t << "@{";
1548  t << "}!";
1549  }
1550  t << latexEscapeLabelName(memname,insideTabbing);
1551  t << "@{";
1553  t << "}}" << endl;
1554 
1555  t << "\\index{";
1556  t << latexEscapeLabelName(memname,insideTabbing);
1557  t << "@{";
1559  t << "}";
1560  if (clname)
1561  {
1562  t << "!";
1564  t << "@{";
1566  t << "}";
1567  }
1568  t << "}" << endl;
1569  }
1570  static const char *levelLab[] = { "subsubsection","paragraph","subparagraph", "subparagraph" };
1571  static bool compactLatex = Config_getBool("COMPACT_LATEX");
1572  static bool pdfHyperlinks = Config_getBool("PDF_HYPERLINKS");
1573  int level=0;
1574  if (showInline) level+=2;
1575  if (compactLatex) level++;
1576  t << "\\" << levelLab[level];
1577 
1578  t << "[{";
1579  if (pdfHyperlinks)
1580  {
1581  t << "\\texorpdfstring{";
1582  }
1584  if (pdfHyperlinks)
1585  {
1586  t << "}{" << latexEscapePDFString(title) << "}";
1587  }
1588  t << "}]";
1589  t << "{\\setlength{\\rightskip}{0pt plus 5cm}";
1591 }
QCString latexEscapeIndexChars(const char *s, bool insideTabbing)
Definition: util.cpp:6683
bool disableLinks
Definition: latexgen.h:338
bool insideTabbing
Definition: latexgen.h:336
QCString latexEscapeLabelName(const char *s, bool insideTabbing)
Definition: util.cpp:6647
#define Config_getBool(val)
Definition: config.cpp:664
QCString latexEscapePDFString(const char *s)
Definition: util.cpp:6721
FTextStream t
Definition: outputgen.h:486
const bool TRUE
Definition: qglobal.h:371
QTextStream & endl(QTextStream &s)
void LatexGenerator::startMemberDocList ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 176 of file latexgen.h.

176 {}
void LatexGenerator::startMemberDocName ( bool  )
inlinevirtual

Implements OutputGenerator.

Definition at line 297 of file latexgen.h.

297 {}
void LatexGenerator::startMemberDocPrefixItem ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 295 of file latexgen.h.

295 {}
void LatexGenerator::startMemberDocSimple ( )
virtual

Implements OutputGenerator.

Definition at line 2139 of file latexgen.cpp.

2140 {
2141  t << "\\begin{DoxyFields}{";
2143  t << "}" << endl;
2144 }
FTextStream t
Definition: outputgen.h:486
void docify(const char *text)
Definition: latexgen.cpp:1713
Translator * theTranslator
Definition: language.cpp:157
virtual QCString trCompoundMembers()=0
QTextStream & endl(QTextStream &s)
void LatexGenerator::startMemberGroup ( )
virtual

Implements OutputGenerator.

Definition at line 1886 of file latexgen.cpp.

1887 {
1888 }
void LatexGenerator::startMemberGroupDocs ( )
virtual

Implements OutputGenerator.

Definition at line 1876 of file latexgen.cpp.

1877 {
1878  t << "{\\em ";
1879 }
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::startMemberGroupHeader ( bool  hasHeader)
virtual

Implements OutputGenerator.

Definition at line 1854 of file latexgen.cpp.

1855 {
1856  if (hasHeader) t << "\\begin{Indent}";
1857  t << "{\\bf ";
1858  // changed back to rev 756 due to bug 660501
1859  //if (Config_getBool("COMPACT_LATEX"))
1860  //{
1861  // t << "\\subparagraph*{";
1862  //}
1863  //else
1864  //{
1865  // t << "\\paragraph*{";
1866  //}
1867 }
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::startMemberHeader ( const char *  )
virtual

Implements OutputGenerator.

Definition at line 1515 of file latexgen.cpp.

1516 {
1517  if (Config_getBool("COMPACT_LATEX"))
1518  {
1519  t << "\\subsubsection*{";
1520  }
1521  else
1522  {
1523  t << "\\subsection*{";
1524  }
1526 }
bool disableLinks
Definition: latexgen.h:338
#define Config_getBool(val)
Definition: config.cpp:664
FTextStream t
Definition: outputgen.h:486
const bool TRUE
Definition: qglobal.h:371
void LatexGenerator::startMemberItem ( const char *  ,
int  annoType,
const char *   
)
virtual

Implements OutputGenerator.

Definition at line 1776 of file latexgen.cpp.

1777 {
1778  //printf("LatexGenerator::startMemberItem(%d)\n",annType);
1779  if (!insideTabbing)
1780  {
1781  t << "\\item " << endl;
1782  templateMemberItem = (annoType == 3);
1783  }
1784 }
bool templateMemberItem
Definition: latexgen.h:341
bool insideTabbing
Definition: latexgen.h:336
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::startMemberList ( )
virtual

Implements OutputGenerator.

Definition at line 1836 of file latexgen.cpp.

1837 {
1838  if (!insideTabbing)
1839  {
1840  t << "\\begin{DoxyCompactItemize}" << endl;
1841  }
1842 }
bool insideTabbing
Definition: latexgen.h:336
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::startMemberSections ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 168 of file latexgen.h.

168 {}
void LatexGenerator::startMemberSubtitle ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 174 of file latexgen.h.

174 {}
void LatexGenerator::startMemberTemplateParams ( )
virtual

Implements OutputGenerator.

Definition at line 1760 of file latexgen.cpp.

1761 {
1762  if (templateMemberItem)
1763  {
1764  t << "{\\footnotesize ";
1765  }
1766 }
bool templateMemberItem
Definition: latexgen.h:341
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::startPageRef ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1426 of file latexgen.cpp.

1427 {
1428  t << " \\doxyref{}{";
1429 }
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::startParagraph ( )
virtual

Starts a new paragraph

Starts a new paragraph

Implements BaseOutputDocInterface.

Definition at line 1272 of file latexgen.cpp.

1273 {
1274  t << endl << endl;
1275 }
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::startParameterList ( bool  openBracket)
virtual

Implements OutputGenerator.

Definition at line 2004 of file latexgen.cpp.

2005 {
2006  /* start of ParameterType ParameterName list */
2007  if (openBracket) t << "(";
2008  t << endl << "\\begin{DoxyParamCaption}" << endl;
2009 }
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::startParameterName ( bool  )
virtual

Implements OutputGenerator.

Definition at line 2026 of file latexgen.cpp.

2027 {
2028  t << "{";
2029 }
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::startParameterType ( bool  first,
const char *  key 
)
virtual

Implements OutputGenerator.

Definition at line 2015 of file latexgen.cpp.

2016 {
2017  t << "\\item[{";
2018  if (!first && key) t << key;
2019 }
def key(type, name=None)
Definition: graph.py:13
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::startParamList ( ParamListTypes  ,
const char *  title 
)
virtual

Implements BaseOutputDocInterface.

Definition at line 1992 of file latexgen.cpp.

1993 {
1994  t << "\\begin{Desc}\n\\item[";
1995  docify(title);
1996  t << "]";
1997 }
FTextStream t
Definition: outputgen.h:486
void docify(const char *text)
Definition: latexgen.cpp:1713
void LatexGenerator::startProjectNumber ( )
virtual

Implements OutputGenerator.

Definition at line 820 of file latexgen.cpp.

821 {
822  t << "\\\\[1ex]\\large ";
823 }
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::startQuickIndices ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 252 of file latexgen.h.

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

Implements BaseOutputDocInterface.

Definition at line 1670 of file latexgen.cpp.

1671 {
1672  static bool pdfHyperlinks = Config_getBool("PDF_HYPERLINKS");
1673  static bool usePDFLatex = Config_getBool("USE_PDFLATEX");
1674  if (usePDFLatex && pdfHyperlinks)
1675  {
1676  t << "\\hypertarget{" << stripPath(lab) << "}{}";
1677  }
1678  t << "\\";
1679  if (Config_getBool("COMPACT_LATEX"))
1680  {
1681  switch(type)
1682  {
1683  case SectionInfo::Page: t << "subsection"; break;
1684  case SectionInfo::Section: t << "subsubsection"; break;
1685  case SectionInfo::Subsection: t << "paragraph"; break;
1686  case SectionInfo::Subsubsection: t << "subparagraph"; break;
1687  case SectionInfo::Paragraph: t << "subparagraph"; break;
1688  default: ASSERT(0); break;
1689  }
1690  t << "{";
1691  }
1692  else
1693  {
1694  switch(type)
1695  {
1696  case SectionInfo::Page: t << "section"; break;
1697  case SectionInfo::Section: t << "subsection"; break;
1698  case SectionInfo::Subsection: t << "subsubsection"; break;
1699  case SectionInfo::Subsubsection: t << "paragraph"; break;
1700  case SectionInfo::Paragraph: t << "subparagraph"; break;
1701  default: ASSERT(0); break;
1702  }
1703  t << "{";
1704  }
1705 }
static QCString stripPath(const QCString &s)
Definition: tagreader.cpp:1287
#define Config_getBool(val)
Definition: config.cpp:664
FTextStream t
Definition: outputgen.h:486
#define ASSERT(x)
Definition: qglobal.h:590
void LatexGenerator::startSimpleSect ( SectionTypes  ,
const char *  file,
const char *  anchor,
const char *  title 
)
virtual

Implements BaseOutputDocInterface.

Definition at line 1972 of file latexgen.cpp.

1974 {
1975  t << "\\begin{Desc}\n\\item[";
1976  if (file)
1977  {
1978  writeObjectLink(0,file,anchor,title);
1979  }
1980  else
1981  {
1982  docify(title);
1983  }
1984  t << "]";
1985 }
QFile * file
Definition: outputgen.h:487
FTextStream t
Definition: outputgen.h:486
void docify(const char *text)
Definition: latexgen.cpp:1713
void writeObjectLink(const char *ref, const char *file, const char *anchor, const char *name)
Definition: latexgen.cpp:1404
void LatexGenerator::startSmall ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 226 of file latexgen.h.

226 { t << "\\footnotesize "; }
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::startSubsection ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 220 of file latexgen.h.

220 { t << "\\subsection*{"; }
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::startSubsubsection ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 222 of file latexgen.h.

222 { t << "\\subsubsection*{"; }
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::startTextBlock ( bool  )
inlinevirtual

Implements OutputGenerator.

Definition at line 292 of file latexgen.h.

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

Implements BaseOutputDocInterface.

Definition at line 1384 of file latexgen.cpp.

1385 {
1386  if (!disableLinks && Config_getBool("PDF_HYPERLINKS"))
1387  {
1388  t << "\\hyperlink{";
1389  if (f) t << stripPath(f);
1390  if (anchor) t << "_" << anchor;
1391  t << "}{";
1392  }
1393  else
1394  {
1395  t << "{\\bf ";
1396  }
1397 }
static QCString stripPath(const QCString &s)
Definition: tagreader.cpp:1287
bool disableLinks
Definition: latexgen.h:338
#define Config_getBool(val)
Definition: config.cpp:664
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::startTitle ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1471 of file latexgen.cpp.

1472 {
1473  if (Config_getBool("COMPACT_LATEX"))
1474  {
1475  t << "\\subsection{";
1476  }
1477  else
1478  {
1479  t << "\\section{";
1480  }
1481 }
#define Config_getBool(val)
Definition: config.cpp:664
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::startTitleHead ( const char *  fileName)
virtual

Implements OutputGenerator.

Definition at line 1440 of file latexgen.cpp.

1441 {
1442  static bool pdfHyperlinks = Config_getBool("PDF_HYPERLINKS");
1443  static bool usePDFLatex = Config_getBool("USE_PDFLATEX");
1444  if (usePDFLatex && pdfHyperlinks && fileName)
1445  {
1446  t << "\\hypertarget{" << stripPath(fileName) << "}{}";
1447  }
1448  if (Config_getBool("COMPACT_LATEX"))
1449  {
1450  t << "\\subsection{";
1451  }
1452  else
1453  {
1454  t << "\\section{";
1455  }
1456 }
static QCString stripPath(const QCString &s)
Definition: tagreader.cpp:1287
#define Config_getBool(val)
Definition: config.cpp:664
QCString fileName
Definition: outputgen.h:488
FTextStream t
Definition: outputgen.h:486
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.

161 { t << "{\\ttfamily "; }
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::writeAnchor ( const char *  fileName,
const char *  name 
)
virtual

Implements BaseOutputDocInterface.

Definition at line 1623 of file latexgen.cpp.

1624 {
1625  //printf("LatexGenerator::writeAnchor(%s,%s)\n",fName,name);
1626  t << "\\label{" << stripPath(name) << "}" << endl;
1627  static bool pdfHyperlinks = Config_getBool("PDF_HYPERLINKS");
1628  static bool usePDFLatex = Config_getBool("USE_PDFLATEX");
1629  if (usePDFLatex && pdfHyperlinks)
1630  {
1631  if (fName)
1632  {
1633  t << "\\hypertarget{" << stripPath(fName) << "_" << stripPath(name) << "}{}" << endl;
1634  }
1635  else
1636  {
1637  t << "\\hypertarget{" << stripPath(name) << "}{}" << endl;
1638  }
1639  }
1640 }
static QCString name
Definition: declinfo.cpp:673
static QCString stripPath(const QCString &s)
Definition: tagreader.cpp:1287
#define Config_getBool(val)
Definition: config.cpp:664
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
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 1718 of file latexgen.cpp.

1719 {
1720  char cs[2];
1721  cs[0]=c;
1722  cs[1]=0;
1723  docify(cs);
1724 }
void docify(const char *text)
Definition: latexgen.cpp:1713
const char * 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.

114  { m_codeGen.writeCodeAnchor(anchor); }
void writeCodeAnchor(const char *)
Definition: latexgen.h:51
LatexCodeGenerator m_codeGen
Definition: latexgen.h:343
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.

98  { m_codeGen.writeCodeLink(ref,file,anchor,name,tooltip); }
static QCString name
Definition: declinfo.cpp:673
void writeCodeLink(const char *ref, const char *file, const char *anchor, const char *name, const char *tooltip)
Definition: latexgen.cpp:160
LatexCodeGenerator m_codeGen
Definition: latexgen.h:343
QFile * file
Definition: outputgen.h:487
void LatexGenerator::writeDoc ( DocNode n,
Definition ctx,
MemberDef  
)
virtual

Implements OutputGenerator.

Definition at line 2051 of file latexgen.cpp.

2052 {
2053  LatexDocVisitor *visitor =
2054  new LatexDocVisitor(t,*this,ctx?ctx->getDefFileExtension():QCString(""),insideTabbing);
2055  n->accept(visitor);
2056  delete visitor;
2057 }
Concrete visitor implementation for LaTeX output.
QCString getDefFileExtension() const
bool insideTabbing
Definition: latexgen.h:336
FTextStream t
Definition: outputgen.h:486
virtual void accept(DocVisitor *v)=0
void LatexGenerator::writeEndAnnoItem ( const char *  name)
virtual

Implements OutputGenerator.

Definition at line 1350 of file latexgen.cpp.

1351 {
1352  t << "}{\\pageref{" << name << "}}{}" << endl;
1353 }
static QCString name
Definition: declinfo.cpp:673
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::writeFooter ( const char *  )
inlinevirtual

Implements OutputGenerator.

Definition at line 122 of file latexgen.h.

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

Definition at line 781 of file latexgen.cpp.

782 {
783  FTextStream t(&f);
784  t << "% Latex footer for doxygen " << versionString << endl;
786 }
Simplified and optimized version of QTextStream.
Definition: ftextstream.h:11
char versionString[]
Definition: version.cpp:1
FTextStream t
Definition: outputgen.h:486
static void writeDefaultFooter(FTextStream &t)
Definition: latexgen.cpp:741
QTextStream & endl(QTextStream &s)
void LatexGenerator::writeGraphicalHierarchy ( const DotGfxHierarchyTable )
inlinevirtual

Implements OutputGenerator.

Definition at line 290 of file latexgen.h.

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

Definition at line 770 of file latexgen.cpp.

771 {
772  FTextStream t(&f);
773  t << "% Latex header for doxygen " << versionString << endl;
775  t << "Your title here";
777  t << "Generated by";
779 }
static void writeDefaultHeaderPart3(FTextStream &t)
Definition: latexgen.cpp:706
static void writeDefaultHeaderPart2(FTextStream &t)
Definition: latexgen.cpp:697
Simplified and optimized version of QTextStream.
Definition: ftextstream.h:11
char versionString[]
Definition: version.cpp:1
static void writeDefaultHeaderPart1(FTextStream &t)
Definition: latexgen.cpp:454
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
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.

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

Implements OutputGenerator.

Definition at line 2183 of file latexgen.cpp.

2184 {
2185  t << "{\\ttfamily [" << l << "]}";
2186  if (!isLast) t << ", ";
2187 }
static QStrList * l
Definition: config.cpp:1044
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::writeLatexSpacing ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 216 of file latexgen.h.

216 { t << "\\hspace{0.3cm}"; }
FTextStream t
Definition: outputgen.h:486
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.

100  { m_codeGen.writeLineNumber(ref,file,anchor,lineNumber); }
void writeLineNumber(const char *, const char *, const char *, int)
Definition: latexgen.cpp:189
LatexCodeGenerator m_codeGen
Definition: latexgen.h:343
QFile * file
Definition: outputgen.h:487
void LatexGenerator::writeLogo ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 256 of file latexgen.h.

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

Implements OutputGenerator.

Definition at line 255 of file latexgen.h.

255 {}
void LatexGenerator::writeNonBreakableSpace ( int  )
virtual

Implements BaseOutputDocInterface.

Definition at line 1823 of file latexgen.cpp.

1824 {
1825  //printf("writeNonBreakbleSpace()\n");
1826  if (insideTabbing)
1827  {
1828  t << "\\>";
1829  }
1830  else
1831  {
1832  t << "~";
1833  }
1834 }
bool insideTabbing
Definition: latexgen.h:336
FTextStream t
Definition: outputgen.h:486
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 1404 of file latexgen.cpp.

1406 {
1407  static bool pdfHyperlinks = Config_getBool("PDF_HYPERLINKS");
1408  if (!disableLinks && !ref && pdfHyperlinks)
1409  {
1410  t << "\\hyperlink{";
1411  if (f) t << stripPath(f);
1412  if (f && anchor) t << "_";
1413  if (anchor) t << anchor;
1414  t << "}{";
1415  docify(text);
1416  t << "}";
1417  }
1418  else
1419  {
1420  t << "{\\bf ";
1421  docify(text);
1422  t << "}";
1423  }
1424 }
static QCString stripPath(const QCString &s)
Definition: tagreader.cpp:1287
bool disableLinks
Definition: latexgen.h:338
#define Config_getBool(val)
Definition: config.cpp:664
FTextStream t
Definition: outputgen.h:486
void docify(const char *text)
Definition: latexgen.cpp:1713
void LatexGenerator::writePageLink ( const char *  name,
bool   
)
virtual

Implements OutputGenerator.

Definition at line 1247 of file latexgen.cpp.

1248 {
1249  //bool &compactLatex = Config_getBool("COMPACT_LATEX");
1250  // next is remove for bug615957
1251  //if (compactLatex || first) t << "\\input" ; else t << "\\include";
1252  t << "\\input" ;
1253  t << "{" << name << "}\n";
1254 }
static QCString name
Definition: declinfo.cpp:673
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::writeQuickLinks ( bool  ,
HighlightedItem  ,
const char *   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 257 of file latexgen.h.

257 {}
void LatexGenerator::writeRuler ( )
inlinevirtual

Writes a horizontal ruler to the output

Implements BaseOutputDocInterface.

Definition at line 198 of file latexgen.h.

198 { t << endl << endl; }
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::writeSearchInfo ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 121 of file latexgen.h.

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

Implements OutputGenerator.

Definition at line 254 of file latexgen.h.

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

Implements OutputGenerator.

Definition at line 1341 of file latexgen.cpp.

1343 {
1344  t << "\\item\\contentsline{section}{\\bf ";
1345  if (path) docify(path);
1346  docify(name);
1347  t << "} ";
1348 }
static QCString name
Definition: declinfo.cpp:673
FTextStream t
Definition: outputgen.h:486
void docify(const char *text)
Definition: latexgen.cpp:1713
void LatexGenerator::writeString ( const char *  text)
virtual

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

Implements BaseOutputDocInterface.

Definition at line 1282 of file latexgen.cpp.

1283 {
1284  t << text;
1285 }
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::writeStyleInfo ( int  part)
virtual

Implements OutputGenerator.

Definition at line 1257 of file latexgen.cpp.

1258 {
1259  if (part > 0)
1260  return;
1261 
1262  startPlainFile("doxygen.sty");
1264  endPlainFile();
1265 }
void endPlainFile()
Definition: outputgen.cpp:55
static void writeDefaultStyleSheet(FTextStream &t)
Definition: latexgen.cpp:736
void startPlainFile(const char *name)
Definition: outputgen.cpp:42
FTextStream t
Definition: outputgen.h:486
void LatexGenerator::writeStyleSheetFile ( QFile f)
static

Definition at line 788 of file latexgen.cpp.

789 {
790  FTextStream t(&f);
791  t << "% stylesheet for doxygen " << versionString << endl;
793 }
Simplified and optimized version of QTextStream.
Definition: ftextstream.h:11
static void writeDefaultStyleSheet(FTextStream &t)
Definition: latexgen.cpp:736
char versionString[]
Definition: version.cpp:1
FTextStream t
Definition: outputgen.h:486
QTextStream & endl(QTextStream &s)
void LatexGenerator::writeSummaryLink ( const char *  ,
const char *  ,
const char *  ,
bool   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 258 of file latexgen.h.

258 {}
void LatexGenerator::writeSynopsis ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 247 of file latexgen.h.

247 {}
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.

104  { m_codeGen.writeTooltip(id,docInfo,decl,desc,defInfo,declInfo); }
void writeTooltip(const char *, const DocLinkInfo &, const char *, const char *, const SourceLinkInfo &, const SourceLinkInfo &)
Definition: latexgen.h:39
LatexCodeGenerator m_codeGen
Definition: latexgen.h:343

Member Data Documentation

bool LatexGenerator::disableLinks
private

Definition at line 338 of file latexgen.h.

bool LatexGenerator::firstDescItem
private

Definition at line 337 of file latexgen.h.

bool LatexGenerator::insideTabbing
private

Definition at line 336 of file latexgen.h.

LatexCodeGenerator LatexGenerator::m_codeGen
private

Definition at line 343 of file latexgen.h.

int LatexGenerator::m_indent
private

Definition at line 340 of file latexgen.h.

bool LatexGenerator::m_prettyCode
private

Definition at line 342 of file latexgen.h.

QCString LatexGenerator::relPath
private

Definition at line 339 of file latexgen.h.

bool LatexGenerator::templateMemberItem
private

Definition at line 341 of file latexgen.h.


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