LatexGenerator Class Reference

Generator for LaTeX output. More...

#include <src/latexgen.h>

Inheritance diagram for LatexGenerator:

Collaboration diagram for LatexGenerator:

Public Member Functions
	LatexGenerator ()
	LatexGenerator (const LatexGenerator &)
LatexGenerator &	operator= (const LatexGenerator &)
	LatexGenerator (LatexGenerator &&)=delete
LatexGenerator &	operator= (LatexGenerator &&)=delete
	~LatexGenerator ()
void	clearBuffer ()
OutputType	type () const override
std::unique_ptr< OutputGenIntf >	clone () override
void	addCodeGen (OutputCodeList &list) override
void	cleanup () override
void	writeDoc (const IDocNodeAST *node, const Definition *ctx, const MemberDef *, int id, int sectionLevel) override
void	startFile (const DString &name, bool isSource, const DString &manName, const DString &title, int id, int hierarchyLevel) override
void	endFile () override
void	writeSearchInfo () override
void	writeFooter (const DString &) override
void	startPageDoc (const DString &) override
void	endPageDoc () override
void	startIndexSection (IndexSection) override
void	endIndexSection (IndexSection) override
void	writePageLink (const DString &, bool) override
void	startProjectNumber () override
void	endProjectNumber () override
void	writeStyleInfo (int part) override
void	startTitleHead (const DString &) override
void	endTitleHead (const DString &, const DString &name) override
void	startParagraph (const DString &classDef) override
void	endParagraph () override
void	writeString (const DString &text) override
void	startIndexListItem () override
void	endIndexListItem () override
void	startIndexList () override
void	endIndexList () override
void	startIndexKey () override
void	endIndexKey () override
void	startIndexValue (bool) override
void	endIndexValue (const DString &, bool) override
void	startItemList () override
void	endItemList () override
void	startIndexItem (const DString &ref, const DString &file) override
void	endIndexItem (const DString &ref, const DString &file) override
void	docify (const DString &text) override
void	writeObjectLink (const DString &ref, const DString &file, const DString &anchor, const DString &name) override
void	startTextLink (const DString &, const DString &) override
void	endTextLink () override
void	startTypewriter () override
void	endTypewriter () override
void	startGroupHeader (const DString &, int) override
void	endGroupHeader (int) override
void	startItemListItem () override
void	endItemListItem () override
void	startMemberSections () override
void	endMemberSections () override
void	startHeaderSection () override
void	endHeaderSection () override
void	startMemberHeader (const DString &, int) override
void	endMemberHeader () override
void	startMemberSubtitle () override
void	endMemberSubtitle () override
void	startMemberDocList () override
void	endMemberDocList () override
void	startMemberList () override
void	endMemberList () override
void	startInlineHeader () override
void	endInlineHeader () override
void	startAnonTypeScope (int) override
void	endAnonTypeScope (int) override
void	startMemberItem (const DString &, MemberItemType, const DString &) override
void	endMemberItem (MemberItemType) override
void	startMemberTemplateParams () override
void	endMemberTemplateParams (const DString &, const DString &) override
void	startCompoundTemplateParams () override
void	endCompoundTemplateParams () override
void	startMemberGroupHeader (const DString &, bool) override
void	endMemberGroupHeader (bool) override
void	startMemberGroupDocs () override
void	endMemberGroupDocs () override
void	startMemberGroup () override
void	endMemberGroup (bool) override
void	insertMemberAlign (bool) override
void	insertMemberAlignLeft (MemberItemType, bool) override
void	writeRuler () override
void	writeAnchor (const DString &fileName, const DString &name) override
void	startEmphasis () override
void	endEmphasis () override
void	startBold () override
void	endBold () override
void	lineBreak (const DString &style=DString()) override
void	startMemberDoc (const DString &, const DString &, const DString &, const DString &, int, int, bool) override
void	endMemberDoc (bool) override
void	startDoxyAnchor (const DString &, const DString &, const DString &, const DString &, const DString &) override
void	endDoxyAnchor (const DString &, const DString &) override
void	addLabel (const DString &, const DString &) override
void	writeChar (char c) override
void	writeLatexSpacing () override
void	writeStartAnnoItem (const DString &type, const DString &file, const DString &path, const DString &name) override
void	startCenter () override
void	endCenter () override
void	startSmall () override
void	endSmall () override
void	startMemberDescription (const DString &, const DString &, bool) override
void	endMemberDescription () override
void	startMemberDeclaration () override
void	endMemberDeclaration (const DString &, const DString &) override
void	writeInheritedSectionTitle (const DString &, const DString &, const DString &, const DString &, const DString &, const DString &) override
void	startExamples () override
void	endExamples () override
void	startDescForItem () override
void	endDescForItem () override
void	startSection (const DString &, const DString &, SectionType) override
void	endSection (const DString &, SectionType) override
void	addIndexItem (const DString &, const DString &) override
void	startIndent () override
void	endIndent () override
void	writeSynopsis () override
void	startClassDiagram () override
void	endClassDiagram (const ClassDiagram &, const DString &, const DString &) override
void	startPageRef () override
void	endPageRef (const DString &, const DString &) override
void	startQuickIndices () override
void	endQuickIndices () override
void	writeSplitBar (const DString &, const DString &) override
void	writeNavigationPath (const DString &) override
void	writeLogo () override
void	writeQuickLinks (HighlightedItem, const DString &, bool) override
void	writeSummaryLink (const DString &, const DString &, const DString &, bool) override
void	writePageOutline () override
void	startContents () override
void	endContents () override
void	writeNonBreakableSpace (int) override
void	startDescTable (const DString &title, const bool hasInits) override
void	endDescTable () override
void	startDescTableRow () override
void	endDescTableRow () override
void	startDescTableTitle () override
void	endDescTableTitle () override
void	startDescTableInit () override
void	endDescTableInit () override
void	startDescTableData () override
void	endDescTableData () override
void	lastIndexPage () override
void	startDotGraph () override
void	endDotGraph (DotClassGraph &) override
void	startInclDepGraph () override
void	endInclDepGraph (DotInclDepGraph &) override
void	startCallGraph () override
void	startGroupCollaboration () override
void	endGroupCollaboration (DotGroupCollaboration &g) override
void	endCallGraph (DotCallGraph &) override
void	startDirDepGraph () override
void	endDirDepGraph (DotDirDeps &g) override
void	writeGraphicalHierarchy (DotGfxHierarchyTable &) override
void	startTextBlock (bool) override
void	endTextBlock (bool) override
void	startMemberDocPrefixItem () override
void	endMemberDocPrefixItem () override
void	startMemberDocName (bool) override
void	endMemberDocName () override
void	startParameterType (bool, const DString &) override
void	endParameterType () override
void	startParameterName (bool) override
void	endParameterName () override
void	startParameterExtra () override
void	endParameterExtra (bool last, bool one, bool bracket) override
void	startParameterDefVal (const char *s) override
void	endParameterDefVal () override
void	startParameterList (bool) override
void	endParameterList () override
void	exceptionEntry (const DString &, bool) override
void	startConstraintList (const DString &) override
void	startConstraintParam () override
void	endConstraintParam () override
void	startConstraintType () override
void	endConstraintType () override
void	startConstraintDocs () override
void	endConstraintDocs () override
void	endConstraintList () override
void	startMemberDocSimple (bool) override
void	endMemberDocSimple (bool) override
void	startInlineMemberType () override
void	endInlineMemberType () override
void	startInlineMemberName () override
void	endInlineMemberName () override
void	startInlineMemberDoc () override
void	endInlineMemberDoc () override
void	startLabels () override
void	writeLabel (const DString &l, bool isLast) override
void	endLabels () override
void	startLocalToc (int level) override
void	endLocalToc () override
void	startTocEntry (const SectionInfo *) override
void	endTocEntry (const SectionInfo *) override
void	startPlainFile (const DString &name) override
void	endPlainFile () override
void	startEmbeddedDoc (size_t) override
void	endEmbeddedDoc () override
Public Member Functions inherited from OutputGenerator
	OutputGenerator ()
	OutputGenerator (const DString &dir)
virtual	~OutputGenerator ()=default
DString	dir () const
DString	fileName () const
void	startPlainFile (const DString &name)
void	endPlainFile ()

Static Public Member Functions
static void	init ()
static void	writeStyleSheetFile (TextStream &t)
static void	writeHeaderFile (TextStream &t)
static void	writeFooterFile (TextStream &t)

Private Attributes
bool	m_firstDescItem = true
bool	m_disableLinks = false
DString	m_relPath
int	m_indent = 0
bool	m_templateMemberItem = false
std::unique_ptr< OutputCodeList >	m_codeList
LatexCodeGenerator *	m_codeGen
bool	m_insideTableEnv = false
int	m_hierarchyLevel = 0

Additional Inherited Members
Public Types inherited from OutputGenerator
enum class	ParamListTypes { Param , RetVal , Exception }
enum class	MemberItemType { Normal , AnonymousStart , AnonymousEnd , Templated }
Protected Attributes inherited from OutputGenerator
TextStream	m_t
DString	m_dir

Detailed Description

Generator for LaTeX output.

Definition at line 95 of file latexgen.h.

Constructor & Destructor Documentation

LatexGenerator() [1/3]

LatexGenerator::LatexGenerator

(

)

Definition at line 321 of file latexgen.cpp.

  : OutputGenerator(Config_getString(LATEX_OUTPUT))
  , m_codeList(std::make_unique<OutputCodeList>())
{
  m_codeGen = m_codeList->add<LatexCodeGenerator>(&m_t);
}

References Config_getString, m_codeGen, m_codeList, OutputGenerator::m_t, and OutputGenerator::OutputGenerator().

Referenced by LatexGenerator(), LatexGenerator(), operator=(), and operator=().

LatexGenerator() [2/3]

LatexGenerator::LatexGenerator

(

const LatexGenerator &

og

)

Definition at line 328 of file latexgen.cpp.

                                                       : OutputGenerator(og.m_dir), OutputGenIntf()
{
  m_codeList           = std::make_unique<OutputCodeList>(*og.m_codeList);
  m_codeGen            = m_codeList->get<LatexCodeGenerator>(OutputType::Latex);
  m_codeGen->setTextStream(&m_t);
  m_firstDescItem      = og.m_firstDescItem;
  m_disableLinks       = og.m_disableLinks;
  m_relPath            = og.m_relPath;
  m_indent             = og.m_indent;
  m_templateMemberItem = og.m_templateMemberItem;
  m_hierarchyLevel     = og.m_hierarchyLevel;
}

References Latex, LatexGenerator(), m_codeGen, m_codeList, OutputGenerator::m_dir, m_disableLinks, m_firstDescItem, m_hierarchyLevel, m_indent, m_relPath, OutputGenerator::m_t, m_templateMemberItem, OutputGenerator::OutputGenerator(), and LatexCodeGenerator::setTextStream().

LatexGenerator() [3/3]

LatexGenerator::LatexGenerator ( LatexGenerator && )

delete

References LatexGenerator().

~LatexGenerator()

LatexGenerator::~LatexGenerator ( )

default

Member Function Documentation

addCodeGen()

void LatexGenerator::addCodeGen ( OutputCodeList & list )

overridevirtual

Implements OutputGenIntf.

Definition at line 361 of file latexgen.cpp.

{
  list.add<LatexCodeGeneratorDefer>(m_codeGen);
}

References OutputCodeList::add(), and m_codeGen.

addIndexItem()

void LatexGenerator::addIndexItem ( const DString & s1, const DString & s2 )

overridevirtual

Implements OutputGenIntf.

Definition at line 1668 of file latexgen.cpp.

{
  if (!s1.empty())
  {
    latexWriteIndexItem(m_t,s1,s2);
  }
}

References DString::empty(), latexWriteIndexItem(), and OutputGenerator::m_t.

addLabel()

void LatexGenerator::addLabel ( const DString & fName, const DString & anchor )

overridevirtual

Implements OutputGenIntf.

Definition at line 1627 of file latexgen.cpp.

{
  m_t << "\\label{";
  if (!fName.empty()) m_t << stripPath(fName);
  if (!anchor.empty()) m_t << "_" << anchor;
  if (m_insideTableEnv) m_t << "}";
  m_t << "} \n";
}

References DString::empty(), m_insideTableEnv, OutputGenerator::m_t, and stripPath().

cleanup()

void LatexGenerator::cleanup ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 678 of file latexgen.cpp.

{
  DString dname = Config_getString(LATEX_OUTPUT);
  Dir d(dname.str());
  clearSubDirs(d);
}

References clearSubDirs(), Config_getString, and DString::str().

clearBuffer()

void LatexGenerator::clearBuffer

(

)

clone()

std::unique_ptr< OutputGenIntf > LatexGenerator::clone ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 114 of file latexgen.h.

{ return std::make_unique<LatexGenerator>(*this); }

docify()

void LatexGenerator::docify ( const DString & text )

overridevirtual

Implements OutputGenIntf.

Definition at line 1724 of file latexgen.cpp.

{
  filterLatexString(m_t,str,
                    m_codeGen->insideTabbing(), // insideTabbing
                    false,           // insidePre
                    false,           // insideItem
                    m_codeGen->usedTableLevel()>0,  // insideTable
                    false            // keepSpaces
                   );
}

References filterLatexString(), LatexCodeGenerator::insideTabbing(), m_codeGen, OutputGenerator::m_t, and LatexCodeGenerator::usedTableLevel().

Referenced by startConstraintList(), startExamples(), startMemberDocSimple(), startParameterDefVal(), startParameterType(), writeChar(), and writeStartAnnoItem().

endAnonTypeScope()

void LatexGenerator::endAnonTypeScope ( int indent )

overridevirtual

Implements OutputGenIntf.

Definition at line 1767 of file latexgen.cpp.

{
  if (indent==0)
  {
    m_t << "\n" << "\\end{tabbing}";
    m_codeGen->setInsideTabbing(false);
  }
  m_indent=indent;
}

References m_codeGen, m_indent, OutputGenerator::m_t, and LatexCodeGenerator::setInsideTabbing().

endBold()

void LatexGenerator::endBold ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 201 of file latexgen.h.

{ m_t << "}"; }

References OutputGenerator::m_t.

endCallGraph()

void LatexGenerator::endCallGraph ( DotCallGraph & g )

overridevirtual

Implements OutputGenIntf.

Definition at line 2018 of file latexgen.cpp.

{
  g.writeGraph(m_t,GraphOutputFormat::EPS,EmbeddedOutputFormat::LaTeX,dir(),fileName(),m_relPath);
}

References OutputGenerator::dir(), EPS, OutputGenerator::fileName(), LaTeX, m_relPath, OutputGenerator::m_t, and DotCallGraph::writeGraph().

endCenter()

void LatexGenerator::endCenter ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 213 of file latexgen.h.

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

References OutputGenerator::m_t.

endClassDiagram()

void LatexGenerator::endClassDiagram ( const ClassDiagram & d, const DString & fileName, const DString &  )

overridevirtual

Implements OutputGenIntf.

Definition at line 1749 of file latexgen.cpp.

{
  d.writeFigure(m_t,dir(),fileName);
}

References OutputGenerator::dir(), OutputGenerator::fileName(), OutputGenerator::m_t, and ClassDiagram::writeFigure().

endCompoundTemplateParams()

void LatexGenerator::endCompoundTemplateParams ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 184 of file latexgen.h.

{ m_t << "}\n"; }

References OutputGenerator::m_t.

endConstraintDocs()

void LatexGenerator::endConstraintDocs ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2147 of file latexgen.cpp.

{
}

endConstraintList()

void LatexGenerator::endConstraintList ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2151 of file latexgen.cpp.

{
  m_t << "\\end{description}\n";
  m_t << "\\end{Desc}\n";
}

References OutputGenerator::m_t.

endConstraintParam()

void LatexGenerator::endConstraintParam ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2129 of file latexgen.cpp.

{
}

endConstraintType()

void LatexGenerator::endConstraintType ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2138 of file latexgen.cpp.

{
  m_t << "}]";
}

References OutputGenerator::m_t.

endContents()

void LatexGenerator::endContents ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 245 of file latexgen.h.

{}

endDescForItem()

void LatexGenerator::endDescForItem ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 225 of file latexgen.h.

{}

endDescTable()

void LatexGenerator::endDescTable ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1873 of file latexgen.cpp.

{
  m_codeGen->decUsedTableLevel();
  m_t << "\\end{DoxyEnumFields}\n";
}

References LatexCodeGenerator::decUsedTableLevel(), m_codeGen, and OutputGenerator::m_t.

endDescTableData()

void LatexGenerator::endDescTableData ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1913 of file latexgen.cpp.

{
  m_t << "\\\\\n\\hline\n\n";
}

References OutputGenerator::m_t.

endDescTableInit()

void LatexGenerator::endDescTableInit ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1904 of file latexgen.cpp.

{
}

endDescTableRow()

void LatexGenerator::endDescTableRow ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1886 of file latexgen.cpp.

{
}

endDescTableTitle()

void LatexGenerator::endDescTableTitle ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1895 of file latexgen.cpp.

{
}

endDirDepGraph()

void LatexGenerator::endDirDepGraph ( DotDirDeps & g )

overridevirtual

Implements OutputGenIntf.

Definition at line 2027 of file latexgen.cpp.

{
  g.writeGraph(m_t,GraphOutputFormat::EPS,EmbeddedOutputFormat::LaTeX,dir(),fileName(),m_relPath);
}

References OutputGenerator::dir(), EPS, OutputGenerator::fileName(), LaTeX, m_relPath, OutputGenerator::m_t, and DotDirDeps::writeGraph().

endDotGraph()

void LatexGenerator::endDotGraph ( DotClassGraph & g )

overridevirtual

Implements OutputGenIntf.

Definition at line 1991 of file latexgen.cpp.

{
  g.writeGraph(m_t,GraphOutputFormat::EPS,EmbeddedOutputFormat::LaTeX,dir(),fileName(),m_relPath);
}

References OutputGenerator::dir(), EPS, OutputGenerator::fileName(), LaTeX, m_relPath, OutputGenerator::m_t, and DotClassGraph::writeGraph().

endDoxyAnchor()

void LatexGenerator::endDoxyAnchor ( const DString & , const DString &  )

overridevirtual

Implements OutputGenIntf.

Definition at line 1623 of file latexgen.cpp.

{
}

endEmbeddedDoc()

void LatexGenerator::endEmbeddedDoc ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2293 of file latexgen.cpp.

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

References OutputGenerator::m_t.

endEmphasis()

void LatexGenerator::endEmphasis ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 199 of file latexgen.h.

{ m_t << "}"; }

References OutputGenerator::m_t.

endExamples()

void LatexGenerator::endExamples ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2039 of file latexgen.cpp.

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

References OutputGenerator::m_t.

endFile()

void LatexGenerator::endFile ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 722 of file latexgen.cpp.

{
  endPlainFile();
  m_codeGen->setSourceFileName("");
}

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

endGroupCollaboration()

void LatexGenerator::endGroupCollaboration ( DotGroupCollaboration & g )

overridevirtual

Implements OutputGenIntf.

Definition at line 2009 of file latexgen.cpp.

{
  g.writeGraph(m_t,GraphOutputFormat::EPS,EmbeddedOutputFormat::LaTeX,dir(),fileName(),m_relPath);
}

References OutputGenerator::dir(), EPS, OutputGenerator::fileName(), LaTeX, m_relPath, OutputGenerator::m_t, and DotGroupCollaboration::writeGraph().

endGroupHeader()

void LatexGenerator::endGroupHeader ( int )

overridevirtual

Implements OutputGenIntf.

Definition at line 1529 of file latexgen.cpp.

{
  m_disableLinks=false;
  m_t << "}\n";
}

References m_disableLinks, and OutputGenerator::m_t.

endHeaderSection()

void LatexGenerator::endHeaderSection ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 166 of file latexgen.h.

{}

endInclDepGraph()

void LatexGenerator::endInclDepGraph ( DotInclDepGraph & g )

overridevirtual

Implements OutputGenIntf.

Definition at line 2000 of file latexgen.cpp.

{
  g.writeGraph(m_t,GraphOutputFormat::EPS,EmbeddedOutputFormat::LaTeX,dir(),fileName(),m_relPath);
}

References OutputGenerator::dir(), EPS, OutputGenerator::fileName(), LaTeX, m_relPath, OutputGenerator::m_t, and DotInclDepGraph::writeGraph().

endIndent()

void LatexGenerator::endIndent ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 230 of file latexgen.h.

{}

endIndexItem()

void LatexGenerator::endIndexItem ( const DString & ref, const DString & file )

overridevirtual

Implements OutputGenIntf.

Definition at line 1340 of file latexgen.cpp.

{
  if (ref.empty() && !fn.empty())
  {
    m_t << "}{\\pageref{" << stripPath(fn) << "}}{}\n";
  }
}

References DString::empty(), OutputGenerator::m_t, and stripPath().

endIndexKey()

void LatexGenerator::endIndexKey ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1362 of file latexgen.cpp.

{
}

endIndexList()

void LatexGenerator::endIndexList ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 141 of file latexgen.h.

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

References OutputGenerator::m_t.

endIndexListItem()

void LatexGenerator::endIndexListItem ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 139 of file latexgen.h.

{}

endIndexSection()

void LatexGenerator::endIndexSection ( IndexSection is )

overridevirtual

Implements OutputGenIntf.

Definition at line 1093 of file latexgen.cpp.

{
  switch (is)
  {
    case IndexSection::isTitlePageStart:
      break;
    case IndexSection::isTitlePageAuthor:
      break;
    case IndexSection::isMainPage:
      {
        if (Doxygen::mainPage)
        {
          writePageLink(Doxygen::mainPage->getOutputFileBase(), false);
        }
      }
      break;
    case IndexSection::isModuleIndex:
      m_t << "}\n\\input{modules}\n";
      break;
    case IndexSection::isTopicIndex:
      m_t << "}\n\\input{topics}\n";
      break;
    case IndexSection::isDirIndex:
      m_t << "}\n\\input{dirs}\n";
      break;
    case IndexSection::isNamespaceIndex:
      m_t << "}\n\\input{namespaces}\n";
      break;
    case IndexSection::isConceptIndex:
      m_t << "}\n\\input{concepts}\n";
      break;
    case IndexSection::isClassHierarchyIndex:
      m_t << "}\n\\input{hierarchy}\n";
      break;
    case IndexSection::isCompoundIndex:
      m_t << "}\n\\input{annotated}\n";
      break;
    case IndexSection::isFileIndex:
      m_t << "}\n\\input{files}\n";
      break;
    case IndexSection::isPageIndex:
      m_t << "}\n\\input{pages}\n";
      break;
    case IndexSection::isTopicDocumentation:
      {
        m_t << "}\n";
        for (const auto &gd : *Doxygen::groupLinkedMap)
        {
          if (!gd->isReference() && !gd->isASubGroup())
          {
            writePageLink(gd->getOutputFileBase(), false);
          }
        }
      }
      break;
    case IndexSection::isModuleDocumentation:
      {
        m_t << "}\n";
        for (const auto &mod : ModuleManager::instance().modules())
        {
          if (!mod->isReference() && mod->isPrimaryInterface())
          {
            writePageLink(mod->getOutputFileBase(), false);
          }
        }
      }
      break;
    case IndexSection::isDirDocumentation:
      {
        bool found=false;
        for (const auto &dd : *Doxygen::dirLinkedMap)
        {
          if (dd->isLinkableInProject())
          {
            if (!found)
            {
              m_t << "}\n";
              found = true;
            }
            m_t << "\\input{" << dd->getOutputFileBase() << "}\n";
          }
        }
      }
      break;
    case IndexSection::isNamespaceDocumentation:
      {
        bool found=false;
        for (const auto &nd : *Doxygen::namespaceLinkedMap)
        {
          if (nd->isLinkableInProject() && !nd->isAlias())
          {
            if (!found)
            {
              m_t << "}\n";
              found=true;
            }
            m_t << "\\input{" << nd->getOutputFileBase() << "}\n";
          }
        }
      }
      break;
    case IndexSection::isConceptDocumentation:
      {
        bool found=false;
        for (const auto &cd : *Doxygen::conceptLinkedMap)
        {
          if (cd->isLinkableInProject() && !cd->isAlias())
          {
            if (!found)
            {
              m_t << "}\n";
              found=true;
            }
            m_t << "\\input{" << cd->getOutputFileBase() << "}\n";
          }
        }
      }
      break;
    case IndexSection::isClassDocumentation:
      {
        bool found=false;
        for (const auto &cd : *Doxygen::classLinkedMap)
        {
          if (cd->isLinkableInProject() &&
             !cd->isImplicitTemplateInstance() &&
             !cd->isEmbeddedInOuterScope() &&
             !cd->isAlias()
             )
          {
            if (!found)
            {
              m_t << "}\n"; // end doxysection or chapter title
              found=true;
            }
            m_t << "\\input{" << cd->getOutputFileBase() << "}\n";
          }
        }
      }
      break;
    case IndexSection::isFileDocumentation:
      {
        bool isFirst=true;
        for (const auto &fn : *Doxygen::inputNameLinkedMap)
        {
          for (const auto &fd : *fn)
          {
            if (fd->isLinkableInProject())
            {
              if (isFirst)
              {
                m_t << "}\n"; // end doxysection or chapter title
              }
              isFirst=false;
              m_t << "\\input{" << fd->getOutputFileBase() << "}\n";
            }
            if (fd->generateSourceFile())
            {
              if (isFirst)
              {
                m_t << "}\n"; // end doxysection or chapter title
              }
              isFirst=false;
              m_t << "\\input{" << fd->getSourceFileBase() << "}\n";
            }
          }
        }
      }
      break;
    case IndexSection::isExampleDocumentation:
      {
        m_t << "}\n";
        for (const auto &pd : *Doxygen::exampleLinkedMap)
        {
          m_t << "\\input{" << pd->getOutputFileBase() << "}\n";
        }
      }
      break;
    case IndexSection::isPageDocumentation:
      {
        for (const auto &pd : *Doxygen::pageLinkedMap)
        {
          if (!pd->getGroupDef() && !pd->isReference() && !pd->hasParentPage()
            && pd->name() != "citelist" && Doxygen::mainPage.get() != pd.get())
          {
            writePageLink(pd->getOutputFileBase(), false);
          }
        }
      }
      break;
    case IndexSection::isPageDocumentation2:
      break;
    case IndexSection::isEndIndex:
      m_t << substituteLatexKeywords(g_footer_file,g_footer,convertToLaTeX(Config_getString(PROJECT_NAME),m_codeGen->insideTabbing()));
      break;
  }
}

References Doxygen::classLinkedMap, Doxygen::conceptLinkedMap, Config_getString, convertToLaTeX(), Doxygen::dirLinkedMap, Doxygen::exampleLinkedMap, g_footer, g_footer_file, Doxygen::groupLinkedMap, Doxygen::inputNameLinkedMap, LatexCodeGenerator::insideTabbing(), ModuleManager::instance(), isClassDocumentation, isClassHierarchyIndex, isCompoundIndex, isConceptDocumentation, isConceptIndex, isDirDocumentation, isDirIndex, isEndIndex, isExampleDocumentation, isFileDocumentation, isFileIndex, isMainPage, isModuleDocumentation, isModuleIndex, isNamespaceDocumentation, isNamespaceIndex, isPageDocumentation, isPageDocumentation2, isPageIndex, isTitlePageAuthor, isTitlePageStart, isTopicDocumentation, isTopicIndex, m_codeGen, OutputGenerator::m_t, Doxygen::mainPage, Doxygen::namespaceLinkedMap, Doxygen::pageLinkedMap, substituteLatexKeywords(), and writePageLink().

endIndexValue()

void LatexGenerator::endIndexValue ( const DString & name, bool  )

overridevirtual

Implements OutputGenIntf.

Definition at line 1372 of file latexgen.cpp.

{
  //if (hasBrief) m_t << ")";
  m_t << "}{\\pageref{" << stripPath(name) << "}}{}\n";
}

References OutputGenerator::m_t, and stripPath().

endInlineHeader()

void LatexGenerator::endInlineHeader ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2169 of file latexgen.cpp.

{
  m_t << "}\n";
}

References OutputGenerator::m_t.

endInlineMemberDoc()

void LatexGenerator::endInlineMemberDoc ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2243 of file latexgen.cpp.

{
  m_t << "\\\\\n\\hline\n\n";
}

References OutputGenerator::m_t.

endInlineMemberName()

void LatexGenerator::endInlineMemberName ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2233 of file latexgen.cpp.

{
  m_t << "&\n";
  m_codeGen->setInsideTabbing(false);
}

References m_codeGen, OutputGenerator::m_t, and LatexCodeGenerator::setInsideTabbing().

endInlineMemberType()

void LatexGenerator::endInlineMemberType ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2222 of file latexgen.cpp.

{
  m_t << "&\n";
  m_codeGen->setInsideTabbing(false);
}

References m_codeGen, OutputGenerator::m_t, and LatexCodeGenerator::setInsideTabbing().

endItemList()

void LatexGenerator::endItemList ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 147 of file latexgen.h.

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

References OutputGenerator::m_t.

endItemListItem()

void LatexGenerator::endItemListItem ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 161 of file latexgen.h.

{}

endLabels()

void LatexGenerator::endLabels ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2259 of file latexgen.cpp.

{
}

endLocalToc()

void LatexGenerator::endLocalToc ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 314 of file latexgen.h.

{}

endMemberDeclaration()

void LatexGenerator::endMemberDeclaration ( const DString & , const DString &  )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 219 of file latexgen.h.

{}

endMemberDescription()

void LatexGenerator::endMemberDescription ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1826 of file latexgen.cpp.

{
  if (!m_codeGen->insideTabbing())
  {
    //m_t << "\\item\\end{DoxyCompactList}";
    m_t << "\\end{DoxyCompactList}";
  }
  else
  {
    m_t << "}\\\\\n";
  }
}

References LatexCodeGenerator::insideTabbing(), m_codeGen, and OutputGenerator::m_t.

endMemberDoc()

void LatexGenerator::endMemberDoc ( bool )

overridevirtual

Implements OutputGenIntf.

Definition at line 1600 of file latexgen.cpp.

{
  m_disableLinks=false;
  m_t << "}\n\n";
  //if (Config_getBool(COMPACT_LATEX)) m_t << "\\hfill";
}

References m_disableLinks, and OutputGenerator::m_t.

endMemberDocList()

void LatexGenerator::endMemberDocList ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 172 of file latexgen.h.

{}

endMemberDocName()

void LatexGenerator::endMemberDocName ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 278 of file latexgen.h.

{}

endMemberDocPrefixItem()

void LatexGenerator::endMemberDocPrefixItem ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 276 of file latexgen.h.

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

References OutputGenerator::m_t.

endMemberDocSimple()

void LatexGenerator::endMemberDocSimple ( bool isEnum )

overridevirtual

Implements OutputGenIntf.

Definition at line 2203 of file latexgen.cpp.

{
  m_insideTableEnv=false;
  m_codeGen->decUsedTableLevel();
  if (isEnum)
  {
    m_t << "\\end{DoxyEnumFields}\n";
  }
  else
  {
    m_t << "\\end{DoxyFields}\n";
  }
}

References LatexCodeGenerator::decUsedTableLevel(), m_codeGen, m_insideTableEnv, and OutputGenerator::m_t.

endMemberGroup()

void LatexGenerator::endMemberGroup ( bool hasHeader )

overridevirtual

Implements OutputGenIntf.

Definition at line 1980 of file latexgen.cpp.

{
  if (hasHeader)m_t << "\\end{Indent}";
  m_t << "\n";
}

References OutputGenerator::m_t.

endMemberGroupDocs()

void LatexGenerator::endMemberGroupDocs ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1971 of file latexgen.cpp.

{
  m_t << "}";
}

References OutputGenerator::m_t.

endMemberGroupHeader()

void LatexGenerator::endMemberGroupHeader ( bool hasHeader )

overridevirtual

Implements OutputGenIntf.

Definition at line 1959 of file latexgen.cpp.

{
  // changed back to rev 756 due to bug 660501
  if (hasHeader) m_t << "}\\par\n";
  //m_t << "}\n";
}

References OutputGenerator::m_t.

endMemberHeader()

void LatexGenerator::endMemberHeader ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1547 of file latexgen.cpp.

{
  m_disableLinks=false;
  m_t << "}\n";
}

References m_disableLinks, and OutputGenerator::m_t.

endMemberItem()

void LatexGenerator::endMemberItem ( MemberItemType )

overridevirtual

Implements OutputGenIntf.

Definition at line 1803 of file latexgen.cpp.

{
  if (m_codeGen->insideTabbing())
  {
    m_t << "\\\\";
  }
  m_templateMemberItem = false;
  m_t << "\n";
}

References LatexCodeGenerator::insideTabbing(), m_codeGen, OutputGenerator::m_t, and m_templateMemberItem.

endMemberList()

void LatexGenerator::endMemberList ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1931 of file latexgen.cpp.

{
  //printf("LatexGenerator::endMemberList(%d)\n",m_codeGen->InsideTabbing());
  if (!m_codeGen->insideTabbing())
  {
    m_t << "\\end{DoxyCompactItemize}\n";
  }
}

References LatexCodeGenerator::insideTabbing(), m_codeGen, and OutputGenerator::m_t.

endMemberSections()

void LatexGenerator::endMemberSections ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 164 of file latexgen.h.

{}

endMemberSubtitle()

void LatexGenerator::endMemberSubtitle ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 170 of file latexgen.h.

{}

endMemberTemplateParams()

void LatexGenerator::endMemberTemplateParams ( const DString & , const DString &  )

overridevirtual

Implements OutputGenIntf.

Definition at line 1785 of file latexgen.cpp.

{
  if (m_templateMemberItem)
  {
    m_t << "}\\\\";
  }
}

References OutputGenerator::m_t, and m_templateMemberItem.

endPageDoc()

void LatexGenerator::endPageDoc ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 125 of file latexgen.h.

{}

endPageRef()

void LatexGenerator::endPageRef ( const DString & clname, const DString & anchor )

overridevirtual

Implements OutputGenIntf.

Definition at line 1461 of file latexgen.cpp.

{
  m_t << "}{";
  if (!clname.empty()) m_t << clname;
  if (!anchor.empty()) m_t << "_" << anchor;
  m_t << "}";
}

References DString::empty(), and OutputGenerator::m_t.

endParagraph()

void LatexGenerator::endParagraph ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1321 of file latexgen.cpp.

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

References OutputGenerator::m_t.

endParameterDefVal()

void LatexGenerator::endParameterDefVal ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 286 of file latexgen.h.

{ endTypewriter(); }

References endTypewriter().

endParameterExtra()

void LatexGenerator::endParameterExtra ( bool last, bool one, bool bracket )

overridevirtual

Implements OutputGenIntf.

Definition at line 2081 of file latexgen.cpp.

{
  m_t << "}";
  if (last)
  {
    m_t << "\\end{DoxyParamCaption}";
    if (closeBracket) m_t << ")";
  }
}

References OutputGenerator::m_t.

endParameterList()

void LatexGenerator::endParameterList ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2051 of file latexgen.cpp.

{
}

endParameterName()

void LatexGenerator::endParameterName ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2071 of file latexgen.cpp.

{
  m_t << "}";
}

References OutputGenerator::m_t.

endParameterType()

void LatexGenerator::endParameterType ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2061 of file latexgen.cpp.

{
  m_t << "}]";
}

References OutputGenerator::m_t.

endPlainFile()

void LatexGenerator::endPlainFile ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 319 of file latexgen.h.

{ OutputGenerator::endPlainFile(); }

References OutputGenerator::endPlainFile().

Referenced by endFile(), and writeStyleInfo().

endProjectNumber()

void LatexGenerator::endProjectNumber ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 130 of file latexgen.h.

{}

endQuickIndices()

void LatexGenerator::endQuickIndices ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 237 of file latexgen.h.

{}

endSection()

void LatexGenerator::endSection ( const DString & lab, SectionType  )

overridevirtual

Implements OutputGenIntf.

Definition at line 1718 of file latexgen.cpp.

{
  m_t << "}\\label{" << lab << "}\n";
}

References OutputGenerator::m_t.

endSmall()

void LatexGenerator::endSmall ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 215 of file latexgen.h.

{ m_t << "\\normalsize "; }

References OutputGenerator::m_t.

endTextBlock()

void LatexGenerator::endTextBlock ( bool )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 273 of file latexgen.h.

{}

endTextLink()

void LatexGenerator::endTextLink ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1402 of file latexgen.cpp.

{
  bool pdfHyperlinks = Config_getBool(PDF_HYPERLINKS);
  if (!m_disableLinks && pdfHyperlinks)
  {
    m_t << "}";
  }
  m_t << "}";
}

References Config_getBool, m_disableLinks, and OutputGenerator::m_t.

endTitleHead()

void LatexGenerator::endTitleHead ( const DString & fileName, const DString & name )

overridevirtual

Implements OutputGenIntf.

Definition at line 1484 of file latexgen.cpp.

{
  m_t << "}\n";
 
  bool pdfHyperlinks = Config_getBool(PDF_HYPERLINKS);
  bool usePDFLatex   = Config_getBool(USE_PDFLATEX);
  if (usePDFLatex && pdfHyperlinks && !fileName.empty())
  {
    m_t << "\\hypertarget{" << stripPath(fileName) << "}{}";
  }
 
  DString fn = stripPath(fileName);
  if (!fn.empty())
  {
    m_t << "\\label{" << fn << "}";
  }
  if (!name.empty())
  {
    latexWriteIndexItem(m_t,name);
  }
}

References Config_getBool, DString::empty(), OutputGenerator::fileName(), latexWriteIndexItem(), OutputGenerator::m_t, and stripPath().

endTocEntry()

void LatexGenerator::endTocEntry ( const SectionInfo * )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 316 of file latexgen.h.

{}

endTypewriter()

void LatexGenerator::endTypewriter ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 157 of file latexgen.h.

{ m_t << "}";      }

References OutputGenerator::m_t.

Referenced by endParameterDefVal().

exceptionEntry()

void LatexGenerator::exceptionEntry ( const DString & prefix, bool closeBracket )

overridevirtual

Implements OutputGenIntf.

Definition at line 2091 of file latexgen.cpp.

{
  if (!prefix.empty())
  {
    m_t << " " << prefix << "(";
  }
  else if (closeBracket)
  {
    m_t << ")";
  }
  m_t << " ";
}

References OutputGenerator::m_t, and prefix.

init()

void LatexGenerator::init ( )

static

Definition at line 632 of file latexgen.cpp.

{
  DString dname = Config_getString(LATEX_OUTPUT);
  Dir d(dname.str());
  if (!d.exists() && !d.mkdir(dname.str()))
  {
    term("Could not create output directory {}\n",dname);
  }
 
  if (!Config_getString(LATEX_HEADER).empty())
  {
    g_header_file=Config_getString(LATEX_HEADER);
    g_header=fileToString(g_header_file);
    //printf("g_header='%s'\n",qPrint(g_header));
    DString result = substituteLatexKeywords(g_header_file,g_header,DString());
    checkBlocks(result,g_header_file,latexMarkerInfo);
  }
  else
  {
    g_header_file = "header.tex";
    g_header = ResourceMgr::instance().getAsString(g_header_file);
    DString result = substituteLatexKeywords(g_header_file,g_header,DString());
    checkBlocks(result,"<default header.tex>",latexMarkerInfo);
  }
  if (!Config_getString(LATEX_FOOTER).empty())
  {
    g_footer_file=Config_getString(LATEX_FOOTER);
    g_footer=fileToString(g_footer_file);
    //printf("g_footer='%s'\n",qPrint(g_footer));
    DString result = substituteLatexKeywords(g_footer_file,g_footer,DString());
    checkBlocks(result,g_footer_file,latexMarkerInfo);
  }
  else
  {
    g_footer_file = "footer.tex";
    g_footer = ResourceMgr::instance().getAsString(g_footer_file);
    DString result = substituteLatexKeywords(g_footer_file,g_footer,DString());
    checkBlocks(result,"<default footer.tex>",latexMarkerInfo);
  }
 
  writeLatexMakefile();
  writeMakeBat();
 
  createSubDirs(d);
}

References checkBlocks(), Config_getString, createSubDirs(), Dir::exists(), fileToString(), g_footer, g_footer_file, g_header, g_header_file, ResourceMgr::getAsString(), ResourceMgr::instance(), latexMarkerInfo, Dir::mkdir(), DString::str(), substituteLatexKeywords(), term, writeLatexMakefile(), and writeMakeBat().

Referenced by generateOutput().

insertMemberAlign()

void LatexGenerator::insertMemberAlign ( bool )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 193 of file latexgen.h.

{}

insertMemberAlignLeft()

void LatexGenerator::insertMemberAlignLeft ( MemberItemType , bool  )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 194 of file latexgen.h.

{}

lastIndexPage()

void LatexGenerator::lastIndexPage ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1918 of file latexgen.cpp.

{
}

lineBreak()

void LatexGenerator::lineBreak ( const DString & style = DString() )

overridevirtual

Implements OutputGenIntf.

Definition at line 2174 of file latexgen.cpp.

{
  if (m_codeGen->insideTabbing())
  {
    m_t << "\\\\\n";
  }
  else
  {
    m_t << "\\newline\n";
  }
}

References LatexCodeGenerator::insideTabbing(), m_codeGen, and OutputGenerator::m_t.

operator=() [1/2]

LatexGenerator & LatexGenerator::operator=

(

const LatexGenerator &

og

)

Definition at line 341 of file latexgen.cpp.

{
  if (this!=&og)
  {
    m_dir                = og.m_dir;
    m_codeList           = std::make_unique<OutputCodeList>(*og.m_codeList);
    m_codeGen            = m_codeList->get<LatexCodeGenerator>(OutputType::Latex);
    m_codeGen->setTextStream(&m_t);
    m_firstDescItem      = og.m_firstDescItem;
    m_disableLinks       = og.m_disableLinks;
    m_relPath            = og.m_relPath;
    m_indent             = og.m_indent;
    m_templateMemberItem = og.m_templateMemberItem;
    m_hierarchyLevel     = og.m_hierarchyLevel;
  }
  return *this;
}

References Latex, LatexGenerator(), m_codeGen, m_codeList, OutputGenerator::m_dir, m_disableLinks, m_firstDescItem, m_hierarchyLevel, m_indent, m_relPath, OutputGenerator::m_t, m_templateMemberItem, and LatexCodeGenerator::setTextStream().

operator=() [2/2]

LatexGenerator & LatexGenerator::operator= ( LatexGenerator && )

delete

References LatexGenerator().

startAnonTypeScope()

void LatexGenerator::startAnonTypeScope ( int indent )

overridevirtual

Implements OutputGenIntf.

Definition at line 1756 of file latexgen.cpp.

{
  if (indent==0)
  {
    m_t << "\\begin{tabbing}\n";
    m_t << "xx\\=xx\\=xx\\=xx\\=xx\\=xx\\=xx\\=xx\\=xx\\=\\kill\n";
    m_codeGen->setInsideTabbing(true);
  }
  m_indent=indent;
}

References m_codeGen, m_indent, OutputGenerator::m_t, and LatexCodeGenerator::setInsideTabbing().

startBold()

void LatexGenerator::startBold ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 200 of file latexgen.h.

{ m_t << "{\\bfseries "; }

References OutputGenerator::m_t.

startCallGraph()

void LatexGenerator::startCallGraph ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2014 of file latexgen.cpp.

{
}

startCenter()

void LatexGenerator::startCenter ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 212 of file latexgen.h.

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

References OutputGenerator::m_t.

startClassDiagram()

void LatexGenerator::startClassDiagram ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1743 of file latexgen.cpp.

{
  //if (Config_getBool(COMPACT_LATEX)) m_t << "\\doxysubsubsection"; else m_t << "\\doxysubsection";
  //m_t << "{";
}

startCompoundTemplateParams()

void LatexGenerator::startCompoundTemplateParams ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 183 of file latexgen.h.

{ m_t << "\\doxysubsubsection*{";}

References OutputGenerator::m_t.

startConstraintDocs()

void LatexGenerator::startConstraintDocs ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2143 of file latexgen.cpp.

{
}

startConstraintList()

void LatexGenerator::startConstraintList ( const DString & header )

overridevirtual

Implements OutputGenIntf.

Definition at line 2116 of file latexgen.cpp.

{
  m_t << "\\begin{Desc}\n\\item[";
  docify(header);
  m_t << "]";
  m_t << "\\begin{description}\n";
}

References docify(), and OutputGenerator::m_t.

startConstraintParam()

void LatexGenerator::startConstraintParam ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2124 of file latexgen.cpp.

{
  m_t << "\\item[{\\em ";
}

References OutputGenerator::m_t.

startConstraintType()

void LatexGenerator::startConstraintType ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2133 of file latexgen.cpp.

{
  m_t << "} : {\\em ";
}

References OutputGenerator::m_t.

startContents()

void LatexGenerator::startContents ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 244 of file latexgen.h.

{}

startDescForItem()

void LatexGenerator::startDescForItem ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 224 of file latexgen.h.

{ m_t << "\\par\n"; }

References OutputGenerator::m_t.

startDescTable()

void LatexGenerator::startDescTable ( const DString & title, const bool hasInits )

overridevirtual

Implements OutputGenIntf.

Definition at line 1867 of file latexgen.cpp.

{
  m_codeGen->incUsedTableLevel();
  m_t << "\\begin{DoxyEnumFields}[" << (hasInits?3:2) << "]{" << title << "}\n";
}

References LatexCodeGenerator::incUsedTableLevel(), m_codeGen, and OutputGenerator::m_t.

startDescTableData()

void LatexGenerator::startDescTableData ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1908 of file latexgen.cpp.

{
  m_t << "&";
}

References OutputGenerator::m_t.

startDescTableInit()

void LatexGenerator::startDescTableInit ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1899 of file latexgen.cpp.

{
  m_t << "&";
}

References OutputGenerator::m_t.

startDescTableRow()

void LatexGenerator::startDescTableRow ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1879 of file latexgen.cpp.

{
  // 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)
  m_t << "\\raisebox{\\heightof{T}}[0pt][0pt]{";
}

References OutputGenerator::m_t.

startDescTableTitle()

void LatexGenerator::startDescTableTitle ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1890 of file latexgen.cpp.

{
  m_t << "}";
}

References OutputGenerator::m_t.

startDirDepGraph()

void LatexGenerator::startDirDepGraph ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2023 of file latexgen.cpp.

{
}

startDotGraph()

void LatexGenerator::startDotGraph ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1986 of file latexgen.cpp.

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

References OutputGenerator::m_t.

startDoxyAnchor()

void LatexGenerator::startDoxyAnchor ( const DString & fName, const DString & , const DString & anchor, const DString & , const DString &  )

overridevirtual

Implements OutputGenIntf.

Definition at line 1607 of file latexgen.cpp.

{
  bool pdfHyperlinks = Config_getBool(PDF_HYPERLINKS);
  bool usePDFLatex   = Config_getBool(USE_PDFLATEX);
  if (m_insideTableEnv) m_t << "\\doxymbox{"; // see issue #6093
  if (usePDFLatex && pdfHyperlinks)
  {
    m_t << "\\Hypertarget{";
    if (!fName.empty()) m_t << stripPath(fName);
    if (!anchor.empty()) m_t << "_" << anchor;
    m_t << "}";
  }
}

References Config_getBool, DString::empty(), m_insideTableEnv, OutputGenerator::m_t, and stripPath().

startEmbeddedDoc()

void LatexGenerator::startEmbeddedDoc ( size_t indent )

overridevirtual

Implements OutputGenIntf.

Definition at line 2288 of file latexgen.cpp.

{
  m_t << "\\begin{DoxyEmbeddedDoc}[" << indent << "]\n";
}

References OutputGenerator::m_t.

startEmphasis()

void LatexGenerator::startEmphasis ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 198 of file latexgen.h.

{ m_t << "{\\em ";  }

References OutputGenerator::m_t.

startExamples()

void LatexGenerator::startExamples ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2032 of file latexgen.cpp.

{
  m_t << "\\begin{Desc}\n\\item[";
  docify(theTranslator->trExamples());
  m_t << "]";
}

References docify(), OutputGenerator::m_t, theTranslator, and Translator::trExamples().

startFile()

void LatexGenerator::startFile ( const DString & name, bool isSource, const DString & manName, const DString & title, int id, int hierarchyLevel )

overridevirtual

Implements OutputGenIntf.

Definition at line 708 of file latexgen.cpp.

{
#if 0
  setEncoding(Config_getString(LATEX_OUTPUT_ENCODING));
#endif
  DString fileName=name;
  m_hierarchyLevel = hierarchyLevel;
  m_relPath = relativePathToRoot(fileName);
  if (!fileName.endsWith(".tex") && !fileName.endsWith(".sty")) fileName+=".tex";
  startPlainFile(fileName);
  m_codeGen->setRelativePath(m_relPath);
  m_codeGen->setSourceFileName(stripPath(fileName));
}

References Config_getString, DString::endsWith(), OutputGenerator::fileName(), m_codeGen, m_hierarchyLevel, m_relPath, relativePathToRoot(), LatexCodeGenerator::setRelativePath(), LatexCodeGenerator::setSourceFileName(), startPlainFile(), and stripPath().

startGroupCollaboration()

void LatexGenerator::startGroupCollaboration ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2005 of file latexgen.cpp.

{
}

startGroupHeader()

void LatexGenerator::startGroupHeader ( const DString & , int extraIndentLevel )

overridevirtual

Implements OutputGenIntf.

Definition at line 1506 of file latexgen.cpp.

{
  if (Config_getBool(COMPACT_LATEX))
  {
    extraIndentLevel++;
  }
 
  if (extraIndentLevel>=3)
  {
    m_t << "\\doxysubparagraph*{";
  }
  else if (extraIndentLevel==2)
  {
    m_t << "\\doxyparagraph{";
  }
  else
  {
    extraIndentLevel += m_hierarchyLevel + 1;
    m_t << "\\" << LatexSections::name(extraIndentLevel) << "{";
  }
  m_disableLinks=true;
}

References Config_getBool, m_disableLinks, m_hierarchyLevel, OutputGenerator::m_t, and LatexSections::name().

startHeaderSection()

void LatexGenerator::startHeaderSection ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 165 of file latexgen.h.

{}

startInclDepGraph()

void LatexGenerator::startInclDepGraph ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1996 of file latexgen.cpp.

{
}

startIndent()

void LatexGenerator::startIndent ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 229 of file latexgen.h.

{}

startIndexItem()

void LatexGenerator::startIndexItem ( const DString & ref, const DString & file )

overridevirtual

Implements OutputGenIntf.

Definition at line 1331 of file latexgen.cpp.

{
  m_t << "\\item ";
  if (ref.empty() && !fn.empty())
  {
    m_t << "\\contentsline{section}{";
  }
}

References DString::empty(), and OutputGenerator::m_t.

startIndexKey()

void LatexGenerator::startIndexKey ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1357 of file latexgen.cpp.

{
  m_t << "\\item\\contentsline{section}{";
}

References OutputGenerator::m_t.

startIndexList()

void LatexGenerator::startIndexList ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 140 of file latexgen.h.

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

References OutputGenerator::m_t.

startIndexListItem()

void LatexGenerator::startIndexListItem ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 138 of file latexgen.h.

{}

startIndexSection()

void LatexGenerator::startIndexSection ( IndexSection is )

overridevirtual

Implements OutputGenIntf.

Definition at line 927 of file latexgen.cpp.

{
  bool compactLatex = Config_getBool(COMPACT_LATEX);
  switch (is)
  {
    case IndexSection::isTitlePageStart:
      m_t << substituteLatexKeywords(g_header_file,g_header,convertToLaTeX(Config_getString(PROJECT_NAME),m_codeGen->insideTabbing()));
      break;
    case IndexSection::isTitlePageAuthor:
      break;
    case IndexSection::isMainPage:
      break;
    case IndexSection::isModuleIndex:
      if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";
      m_t << "{"; //Module Index}\n"
      break;
    case IndexSection::isTopicIndex:
      if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";
      m_t << "{"; //Topic Index}\n"
      break;
    case IndexSection::isDirIndex:
      if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";
      m_t << "{"; //Directory Index}\n"
      break;
    case IndexSection::isNamespaceIndex:
      if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";
      m_t << "{"; //Namespace Index}\n"
      break;
    case IndexSection::isConceptIndex:
      if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";
      m_t << "{"; //Concept Index}\n"
      break;
    case IndexSection::isClassHierarchyIndex:
      if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";
      m_t << "{"; //Hierarchical Index}\n"
      break;
    case IndexSection::isCompoundIndex:
      if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";
      m_t << "{"; //Annotated Compound Index}\n"
      break;
    case IndexSection::isFileIndex:
      if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";
      m_t << "{"; //Annotated File Index}\n"
      break;
    case IndexSection::isPageIndex:
      if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";
      m_t << "{"; //Annotated Page Index}\n"
      break;
    case IndexSection::isTopicDocumentation:
      {
        for (const auto &gd : *Doxygen::groupLinkedMap)
        {
          if (!gd->isReference())
          {
            if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";
            m_t << "{"; //Topic Documentation}\n";
            break;
          }
        }
      }
      break;
    case IndexSection::isModuleDocumentation:
      {
        for (const auto &mod : ModuleManager::instance().modules())
        {
          if (!mod->isReference() && mod->isPrimaryInterface())
          {
            if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";
            m_t << "{"; //Topic Documentation}\n";
            break;
          }
        }
      }
      break;
    case IndexSection::isDirDocumentation:
      {
        for (const auto &dd : *Doxygen::dirLinkedMap)
        {
          if (dd->isLinkableInProject())
          {
            if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";
            m_t << "{"; //Dir Documentation}\n";
            break;
          }
        }
      }
      break;
    case IndexSection::isNamespaceDocumentation:
      {
        for (const auto &nd : *Doxygen::namespaceLinkedMap)
        {
          if (nd->isLinkableInProject() && !nd->isAlias())
          {
            if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";
            m_t << "{"; // Namespace Documentation}\n":
            break;
          }
        }
      }
      break;
    case IndexSection::isConceptDocumentation:
      {
        for (const auto &cd : *Doxygen::conceptLinkedMap)
        {
          if (cd->isLinkableInProject() && !cd->isAlias())
          {
            if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";
            m_t << "{"; // Concept Documentation}\n":
            break;
          }
        }
      }
      break;
    case IndexSection::isClassDocumentation:
      {
        for (const auto &cd : *Doxygen::classLinkedMap)
        {
          if (cd->isLinkableInProject() &&
              !cd->isImplicitTemplateInstance() &&
              !cd->isEmbeddedInOuterScope() &&
              !cd->isAlias()
             )
          {
            if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";
            m_t << "{"; //Compound Documentation}\n";
            break;
          }
        }
      }
      break;
    case IndexSection::isFileDocumentation:
      {
        bool isFirst=true;
        for (const auto &fn : *Doxygen::inputNameLinkedMap)
        {
          for (const auto &fd : *fn)
          {
            if (fd->isLinkableInProject() || fd->generateSourceFile())
            {
              if (isFirst)
              {
                if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";
                m_t << "{"; //File Documentation}\n";
                isFirst=false;
                break;
              }
            }
          }
        }
      }
      break;
    case IndexSection::isExampleDocumentation:
      {
        if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";
        m_t << "{"; //Example Documentation}\n";
      }
      break;
    case IndexSection::isPageDocumentation:
      break;
    case IndexSection::isPageDocumentation2:
      break;
    case IndexSection::isEndIndex:
      break;
  }
}

References Doxygen::classLinkedMap, Doxygen::conceptLinkedMap, Config_getBool, Config_getString, convertToLaTeX(), Doxygen::dirLinkedMap, g_header, g_header_file, Doxygen::groupLinkedMap, Doxygen::inputNameLinkedMap, LatexCodeGenerator::insideTabbing(), ModuleManager::instance(), isClassDocumentation, isClassHierarchyIndex, isCompoundIndex, isConceptDocumentation, isConceptIndex, isDirDocumentation, isDirIndex, isEndIndex, isExampleDocumentation, isFileDocumentation, isFileIndex, isMainPage, isModuleDocumentation, isModuleIndex, isNamespaceDocumentation, isNamespaceIndex, isPageDocumentation, isPageDocumentation2, isPageIndex, isTitlePageAuthor, isTitlePageStart, isTopicDocumentation, isTopicIndex, m_codeGen, OutputGenerator::m_t, Doxygen::namespaceLinkedMap, and substituteLatexKeywords().

startIndexValue()

void LatexGenerator::startIndexValue ( bool hasBrief )

overridevirtual

Implements OutputGenIntf.

Definition at line 1366 of file latexgen.cpp.

{
  m_t << " ";
  if (hasBrief) m_t << "\\\\*";
}

References OutputGenerator::m_t.

startInlineHeader()

void LatexGenerator::startInlineHeader ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2157 of file latexgen.cpp.

{
  if (Config_getBool(COMPACT_LATEX))
  {
    m_t << "\\doxyparagraph*{";
  }
  else
  {
    m_t << "\\" << LatexSections::name(m_hierarchyLevel + 1) << "*{";
  }
}

References Config_getBool, m_hierarchyLevel, OutputGenerator::m_t, and LatexSections::name().

startInlineMemberDoc()

void LatexGenerator::startInlineMemberDoc ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2239 of file latexgen.cpp.

{
}

startInlineMemberName()

void LatexGenerator::startInlineMemberName ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2228 of file latexgen.cpp.

{
  m_codeGen->setInsideTabbing(true); // to prevent \+ from causing unwanted breaks
}

References m_codeGen, and LatexCodeGenerator::setInsideTabbing().

startInlineMemberType()

void LatexGenerator::startInlineMemberType ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2217 of file latexgen.cpp.

{
  m_codeGen->setInsideTabbing(true); // to prevent \+ from causing unwanted breaks
}

References m_codeGen, and LatexCodeGenerator::setInsideTabbing().

startItemList()

void LatexGenerator::startItemList ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 146 of file latexgen.h.

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

References OutputGenerator::m_t.

startItemListItem()

void LatexGenerator::startItemListItem ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 160 of file latexgen.h.

{ m_t << "\\item \n"; }

References OutputGenerator::m_t.

startLabels()

void LatexGenerator::startLabels ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2248 of file latexgen.cpp.

{
  m_t << "\\hspace{0.3cm}";
}

References OutputGenerator::m_t.

startLocalToc()

void LatexGenerator::startLocalToc ( int level )

overridevirtual

Implements OutputGenIntf.

Definition at line 2281 of file latexgen.cpp.

{
  int maxLevel = level + m_hierarchyLevel;
  m_t << "\\DoxyTOC{\\etocsetnexttocdepth{" << maxLevel << "}";
  m_t << "\\localtableofcontents}\n";
}

References m_hierarchyLevel, and OutputGenerator::m_t.

startMemberDeclaration()

void LatexGenerator::startMemberDeclaration ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 218 of file latexgen.h.

{}

startMemberDescription()

void LatexGenerator::startMemberDescription ( const DString & , const DString & , bool  )

overridevirtual

Implements OutputGenIntf.

Definition at line 1813 of file latexgen.cpp.

{
  if (!m_codeGen->insideTabbing())
  {
    m_t << "\\begin{DoxyCompactList}\\small\\item\\em ";
  }
  else
  {
    for (int i=0;i<m_indent+2;i++) m_t << "\\>";
    m_t << "{\\em ";
  }
}

References LatexCodeGenerator::insideTabbing(), m_codeGen, m_indent, and OutputGenerator::m_t.

startMemberDoc()

void LatexGenerator::startMemberDoc ( const DString & clname, const DString & memname, const DString & , const DString & title, int memCount, int memTotal, bool showInline )

overridevirtual

Implements OutputGenIntf.

Definition at line 1553 of file latexgen.cpp.

{
  if (!memname.empty() && memname[0]!='@')
  {
    latexWriteIndexItem(m_t,clname,memname);
    latexWriteIndexItem(m_t,memname,clname);
  }
  bool compactLatex = Config_getBool(COMPACT_LATEX);
  bool pdfHyperlinks = Config_getBool(PDF_HYPERLINKS);
  if (showInline)
  {
    m_t << "\\doxysubparagraph";
  }
  else if (compactLatex)
  {
    m_t << "\\doxyparagraph";
  }
  else
  {
    m_t << "\\" << LatexSections::name(m_hierarchyLevel + 2);
  }
 
  m_t << "{";
  if (pdfHyperlinks)
  {
    m_t << "\\texorpdfstring{";
  }
  m_t << latexEscapeIndexChars(title);
  if (pdfHyperlinks)
  {
    m_t << "}{" << latexEscapePDFString(title) << "}";
  }
  if (memTotal>1)
  {
    m_t << "\\hspace{0.1cm}{\\footnotesize\\ttfamily [" << memCount << "/" << memTotal << "]}";
  }
  m_t << "}";
  m_t << "\n{\\footnotesize\\ttfamily ";
  //m_disableLinks=true;
}

References Config_getBool, DString::empty(), latexEscapeIndexChars(), latexEscapePDFString(), latexWriteIndexItem(), m_hierarchyLevel, OutputGenerator::m_t, and LatexSections::name().

startMemberDocList()

void LatexGenerator::startMemberDocList ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 171 of file latexgen.h.

{}

startMemberDocName()

void LatexGenerator::startMemberDocName ( bool )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 277 of file latexgen.h.

{}

startMemberDocPrefixItem()

void LatexGenerator::startMemberDocPrefixItem ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 275 of file latexgen.h.

{}

startMemberDocSimple()

void LatexGenerator::startMemberDocSimple ( bool isEnum )

overridevirtual

Implements OutputGenIntf.

Definition at line 2186 of file latexgen.cpp.

{
  m_codeGen->incUsedTableLevel();
  if (isEnum)
  {
    m_t << "\\begin{DoxyEnumFields}{";
    docify(theTranslator->trEnumerationValues());
  }
  else
  {
    m_t << "\\begin{DoxyFields}{";
    docify(theTranslator->trCompoundMembers());
  }
  m_t << "}\n";
  m_insideTableEnv=true;
}

References docify(), LatexCodeGenerator::incUsedTableLevel(), m_codeGen, m_insideTableEnv, OutputGenerator::m_t, theTranslator, Translator::trCompoundMembers(), and Translator::trEnumerationValues().

startMemberGroup()

void LatexGenerator::startMemberGroup ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1976 of file latexgen.cpp.

{
}

startMemberGroupDocs()

void LatexGenerator::startMemberGroupDocs ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1966 of file latexgen.cpp.

{
  m_t << "{\\em ";
}

References OutputGenerator::m_t.

startMemberGroupHeader()

void LatexGenerator::startMemberGroupHeader ( const DString & , bool hasHeader )

overridevirtual

Implements OutputGenIntf.

Definition at line 1941 of file latexgen.cpp.

{
  if (hasHeader)
  {
    m_t << "\\begin{Indent}";
    m_t << "\\textbf{ ";
  }
  // changed back to rev 756 due to bug 660501
  //if (Config_getBool(COMPACT_LATEX))
  //{
  //  m_t << "\\doxysubparagraph*{";
  //}
  //else
  //{
  //  m_t << "\\doxyparagraph*{";
  //}
}

References OutputGenerator::m_t.

startMemberHeader()

void LatexGenerator::startMemberHeader ( const DString & , int  )

overridevirtual

Implements OutputGenIntf.

Definition at line 1535 of file latexgen.cpp.

{
  int l = m_hierarchyLevel + 1;
  if (Config_getBool(COMPACT_LATEX))
  {
    ++l;
  }
 
  m_t << "\\" << LatexSections::name(l+1) << "*{";
  m_disableLinks=true;
}

References Config_getBool, m_disableLinks, m_hierarchyLevel, OutputGenerator::m_t, and LatexSections::name().

startMemberItem()

void LatexGenerator::startMemberItem ( const DString & , MemberItemType type, const DString &  )

overridevirtual

Implements OutputGenIntf.

Definition at line 1793 of file latexgen.cpp.

{
  //printf("LatexGenerator::startMemberItem(%d)\n",annType);
  if (!m_codeGen->insideTabbing())
  {
    m_t << "\\item \n";
    m_templateMemberItem = (type == MemberItemType::Templated);
  }
}

References LatexCodeGenerator::insideTabbing(), m_codeGen, OutputGenerator::m_t, m_templateMemberItem, OutputGenerator::Templated, and type().

startMemberList()

void LatexGenerator::startMemberList ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1923 of file latexgen.cpp.

{
  if (!m_codeGen->insideTabbing())
  {
    m_t << "\\begin{DoxyCompactItemize}\n";
  }
}

References LatexCodeGenerator::insideTabbing(), m_codeGen, and OutputGenerator::m_t.

startMemberSections()

void LatexGenerator::startMemberSections ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 163 of file latexgen.h.

{}

startMemberSubtitle()

void LatexGenerator::startMemberSubtitle ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 169 of file latexgen.h.

{}

startMemberTemplateParams()

void LatexGenerator::startMemberTemplateParams ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1777 of file latexgen.cpp.

{
  if (m_templateMemberItem)
  {
    m_t << "{\\footnotesize ";
  }
}

References OutputGenerator::m_t, and m_templateMemberItem.

startPageDoc()

void LatexGenerator::startPageDoc ( const DString & )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 124 of file latexgen.h.

{}

startPageRef()

void LatexGenerator::startPageRef ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1456 of file latexgen.cpp.

{
  m_t << " \\doxyref{}{";
}

References OutputGenerator::m_t.

startParagraph()

void LatexGenerator::startParagraph ( const DString & classDef )

overridevirtual

Implements OutputGenIntf.

Definition at line 1316 of file latexgen.cpp.

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

References OutputGenerator::m_t.

startParameterDefVal()

void LatexGenerator::startParameterDefVal ( const char * s )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 285 of file latexgen.h.

{ docify(s); startTypewriter(); }

References docify(), and startTypewriter().

startParameterExtra()

void LatexGenerator::startParameterExtra ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2076 of file latexgen.cpp.

{
  m_t << "{";
}

References OutputGenerator::m_t.

startParameterList()

void LatexGenerator::startParameterList ( bool openBracket )

overridevirtual

Implements OutputGenIntf.

Definition at line 2044 of file latexgen.cpp.

{
  /* start of ParameterType ParameterName list */
  if (openBracket) m_t << "(";
  m_t << "\\begin{DoxyParamCaption}";
}

References OutputGenerator::m_t.

startParameterName()

void LatexGenerator::startParameterName ( bool )

overridevirtual

Implements OutputGenIntf.

Definition at line 2066 of file latexgen.cpp.

{
  m_t << "{";
}

References OutputGenerator::m_t.

startParameterType()

void LatexGenerator::startParameterType ( bool first, const DString & key )

overridevirtual

Implements OutputGenIntf.

Definition at line 2055 of file latexgen.cpp.

{
  m_t << "\\item[{";
  if (!first && !key.empty()) docify(key);
}

References docify(), DString::empty(), and OutputGenerator::m_t.

startPlainFile()

void LatexGenerator::startPlainFile ( const DString & name )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 318 of file latexgen.h.

{ OutputGenerator::startPlainFile(name); }

References OutputGenerator::startPlainFile().

Referenced by startFile(), and writeStyleInfo().

startProjectNumber()

void LatexGenerator::startProjectNumber ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 733 of file latexgen.cpp.

{
  m_t << "\\\\[1ex]\\large ";
}

References OutputGenerator::m_t.

startQuickIndices()

void LatexGenerator::startQuickIndices ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 236 of file latexgen.h.

{}

startSection()

void LatexGenerator::startSection ( const DString & lab, const DString & , SectionType type )

overridevirtual

Implements OutputGenIntf.

Definition at line 1677 of file latexgen.cpp.

{
  bool pdfHyperlinks = Config_getBool(PDF_HYPERLINKS);
  bool usePDFLatex   = Config_getBool(USE_PDFLATEX);
  if (usePDFLatex && pdfHyperlinks)
  {
    m_t << "\\hypertarget{" << stripPath(lab) << "}{}";
  }
  m_t << "\\";
  if (Config_getBool(COMPACT_LATEX))
  {
    switch(type.level())
    {
      case SectionType::Page:             m_t << "doxysubsection"; break;
      case SectionType::Section:          m_t << "doxysubsubsection"; break;
      case SectionType::Subsection:       m_t << "doxysubsubsubsection"; break;
      case SectionType::Subsubsection:    m_t << "doxysubsubsubsubsection"; break;
      case SectionType::Paragraph:        m_t << "doxysubsubsubsubsubsection"; break;
      case SectionType::Subparagraph:     m_t << "doxysubsubsubsubsubsubsection"; break;
      case SectionType::Subsubparagraph:  m_t << "doxysubsubsubsubsubsubsection"; break;
      default: ASSERT(0); break;
    }
    m_t << "{";
  }
  else
  {
    switch(type.level())
    {
      case SectionType::Page:             m_t << "doxysection"; break;
      case SectionType::Section:          m_t << "doxysubsection"; break;
      case SectionType::Subsection:       m_t << "doxysubsubsection"; break;
      case SectionType::Subsubsection:    m_t << "doxysubsubsubsection"; break;
      case SectionType::Paragraph:        m_t << "doxysubsubsubsubsection"; break;
      case SectionType::Subparagraph:     m_t << "doxysubsubsubsubsubsection"; break;
      case SectionType::Subsubparagraph:  m_t << "doxysubsubsubsubsubsubsection"; break;
      default: ASSERT(0); break;
    }
    m_t << "{";
  }
}

References ASSERT, Config_getBool, SectionType::level(), OutputGenerator::m_t, SectionType::Page, SectionType::Paragraph, SectionType::Section, stripPath(), SectionType::Subparagraph, SectionType::Subsection, SectionType::Subsubparagraph, SectionType::Subsubsection, and type().

startSmall()

void LatexGenerator::startSmall ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 214 of file latexgen.h.

{ m_t << "\\footnotesize "; }

References OutputGenerator::m_t.

startTextBlock()

void LatexGenerator::startTextBlock ( bool )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 272 of file latexgen.h.

{}

startTextLink()

void LatexGenerator::startTextLink ( const DString & f, const DString & anchor )

overridevirtual

Implements OutputGenIntf.

Definition at line 1386 of file latexgen.cpp.

{
  bool pdfHyperlinks = Config_getBool(PDF_HYPERLINKS);
  if (!m_disableLinks && pdfHyperlinks)
  {
    m_t << "\\doxymbox{\\hyperlink{";
    if (!f.empty()) m_t << stripPath(f);
    if (!anchor.empty()) m_t << "_" << anchor;
    m_t << "}{";
  }
  else
  {
    m_t << "\\textbf{ ";
  }
}

References Config_getBool, DString::empty(), m_disableLinks, OutputGenerator::m_t, and stripPath().

startTitleHead()

void LatexGenerator::startTitleHead ( const DString & fileName )

overridevirtual

Implements OutputGenIntf.

Definition at line 1470 of file latexgen.cpp.

{
  int hierarchyLevel = m_hierarchyLevel;
  if (Config_getBool(COMPACT_LATEX))
  {
    ++hierarchyLevel;
  }
 
  if (hierarchyLevel < 0)
    m_t << "\\chapter{";
  else
    m_t << "\\" << LatexSections::name(hierarchyLevel) << "{";
}

References Config_getBool, OutputGenerator::fileName(), m_hierarchyLevel, OutputGenerator::m_t, and LatexSections::name().

startTocEntry()

void LatexGenerator::startTocEntry ( const SectionInfo * )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 315 of file latexgen.h.

{}

startTypewriter()

void LatexGenerator::startTypewriter ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 156 of file latexgen.h.

{ m_t << "{\\ttfamily "; }

References OutputGenerator::m_t.

Referenced by startParameterDefVal().

type()

OutputType LatexGenerator::type ( ) const

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 113 of file latexgen.h.

{ return OutputType::Latex; }

References Latex.

Referenced by startMemberItem(), and startSection().

writeAnchor()

void LatexGenerator::writeAnchor ( const DString & fileName, const DString & name )

overridevirtual

Implements OutputGenIntf.

Definition at line 1636 of file latexgen.cpp.

{
  //printf("LatexGenerator::writeAnchor(%s,%s)\n",fName,name);
  if (!fName.empty())
  {
    m_t << "\\label{" << stripPath(fName) << "_" << stripPath(name) << "}\n";
  }
  else
  {
    m_t << "\\label{" << stripPath(name) << "}\n";
  }
  bool pdfHyperlinks = Config_getBool(PDF_HYPERLINKS);
  bool usePDFLatex   = Config_getBool(USE_PDFLATEX);
  if (usePDFLatex && pdfHyperlinks)
  {
    if (!fName.empty())
    {
      m_t << "\\Hypertarget{" << stripPath(fName) << "_" << stripPath(name) << "}\n";
    }
    else
    {
      m_t << "\\Hypertarget{" << stripPath(name) << "}\n";
    }
  }
}

References Config_getBool, DString::empty(), OutputGenerator::m_t, and stripPath().

writeChar()

void LatexGenerator::writeChar ( char c )

overridevirtual

Implements OutputGenIntf.

Definition at line 1735 of file latexgen.cpp.

{
  char cs[2];
  cs[0]=c;
  cs[1]=0;
  docify(cs);
}

References docify().

writeDoc()

void LatexGenerator::writeDoc ( const IDocNodeAST * node, const Definition * ctx, const MemberDef * , int id, int sectionLevel )

overridevirtual

Implements OutputGenIntf.

Definition at line 2104 of file latexgen.cpp.

{
  const DocNodeAST *astImpl = dynamic_cast<const DocNodeAST*>(ast);
  if (astImpl)
  {
    LatexDocVisitor visitor(m_t,*m_codeList,*m_codeGen,
                            ctx?ctx->getDefFileExtension():DString(""),
                            m_hierarchyLevel);
    std::visit(visitor,astImpl->root);
  }
}

References Definition::getDefFileExtension(), m_codeGen, m_codeList, m_hierarchyLevel, OutputGenerator::m_t, and DocNodeAST::root.

writeFooter()

void LatexGenerator::writeFooter ( const DString & )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 122 of file latexgen.h.

{}

writeFooterFile()

void LatexGenerator::writeFooterFile ( TextStream & t )

static

Definition at line 696 of file latexgen.cpp.

{
  t << "% Latex footer for doxygen " << getDoxygenVersion() << "\n";
  t << ResourceMgr::instance().getAsString("footer.tex");
}

References ResourceMgr::getAsString(), and ResourceMgr::instance().

Referenced by readConfiguration().

writeGraphicalHierarchy()

void LatexGenerator::writeGraphicalHierarchy ( DotGfxHierarchyTable & )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 270 of file latexgen.h.

{}

writeHeaderFile()

void LatexGenerator::writeHeaderFile ( TextStream & t )

static

Definition at line 690 of file latexgen.cpp.

{
  t << "% Latex header for doxygen " << getDoxygenVersion() << "\n";
  t << ResourceMgr::instance().getAsString("header.tex");
}

References ResourceMgr::getAsString(), and ResourceMgr::instance().

Referenced by readConfiguration().

writeInheritedSectionTitle()

void LatexGenerator::writeInheritedSectionTitle ( const DString & , const DString & ref, const DString & file, const DString & anchor, const DString & title, const DString & name )

overridevirtual

Implements OutputGenIntf.

Definition at line 2263 of file latexgen.cpp.

{
  if (Config_getBool(COMPACT_LATEX))
  {
    m_t << "\\doxyparagraph*{";
  }
  else
  {
    m_t << "\\" << LatexSections::name(m_hierarchyLevel + 1) << "*{";
  }
  m_t << theTranslator->trInheritedFrom(convertToLaTeX(title,m_codeGen->insideTabbing()),
                                        objectLinkToString(ref, file, anchor, name, m_codeGen->insideTabbing(), m_disableLinks));
  m_t << "}\n";
}

References Config_getBool, convertToLaTeX(), LatexCodeGenerator::insideTabbing(), m_codeGen, m_disableLinks, m_hierarchyLevel, OutputGenerator::m_t, LatexSections::name(), objectLinkToString(), theTranslator, and Translator::trInheritedFrom().

writeLabel()

void LatexGenerator::writeLabel ( const DString & l, bool isLast )

overridevirtual

Implements OutputGenIntf.

Definition at line 2253 of file latexgen.cpp.

{
  m_t << "{\\ttfamily [" << l << "]}";
  if (!isLast) m_t << ", ";
}

References OutputGenerator::m_t.

writeLatexSpacing()

void LatexGenerator::writeLatexSpacing ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 209 of file latexgen.h.

{ m_t << "\\hspace{0.3cm}"; }

References OutputGenerator::m_t.

writeLogo()

void LatexGenerator::writeLogo ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 240 of file latexgen.h.

{}

writeNavigationPath()

void LatexGenerator::writeNavigationPath ( const DString & )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 239 of file latexgen.h.

{}

writeNonBreakableSpace()

void LatexGenerator::writeNonBreakableSpace ( int )

overridevirtual

Implements OutputGenIntf.

Definition at line 1840 of file latexgen.cpp.

{
  //printf("writeNonBreakableSpace()\n");
  if (m_codeGen->insideTabbing())
  {
    m_t << "\\>";
  }
  else
  {
    m_t << "~";
  }
}

References LatexCodeGenerator::insideTabbing(), m_codeGen, and OutputGenerator::m_t.

writeObjectLink()

void LatexGenerator::writeObjectLink ( const DString & ref, const DString & file, const DString & anchor, const DString & name )

overridevirtual

Implements OutputGenIntf.

Definition at line 1450 of file latexgen.cpp.

{
  m_t << objectLinkToString(ref,f,anchor,text,m_codeGen->insideTabbing(),m_disableLinks);
}

References LatexCodeGenerator::insideTabbing(), m_codeGen, m_disableLinks, OutputGenerator::m_t, and objectLinkToString().

writePageLink()

void LatexGenerator::writePageLink ( const DString & name, bool  )

overridevirtual

Implements OutputGenIntf.

Definition at line 1290 of file latexgen.cpp.

{
  //bool &compactLatex = Config_getBool(COMPACT_LATEX);
  // next is remove for bug615957
  //if (compactLatex || first) m_t << "\\input" ; else m_t << "\\include";
  m_t << "\\input" ;
  m_t << "{" << name << "}\n";
}

References OutputGenerator::m_t.

Referenced by endIndexSection().

writePageOutline()

void LatexGenerator::writePageOutline ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 243 of file latexgen.h.

{}

writeQuickLinks()

void LatexGenerator::writeQuickLinks ( HighlightedItem , const DString & , bool  )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 241 of file latexgen.h.

{}

writeRuler()

void LatexGenerator::writeRuler ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 196 of file latexgen.h.

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

References OutputGenerator::m_t.

writeSearchInfo()

void LatexGenerator::writeSearchInfo ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 121 of file latexgen.h.

{}

writeSplitBar()

void LatexGenerator::writeSplitBar ( const DString & , const DString &  )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 238 of file latexgen.h.

{}

writeStartAnnoItem()

void LatexGenerator::writeStartAnnoItem ( const DString & type, const DString & file, const DString & path, const DString & name )

overridevirtual

Implements OutputGenIntf.

Definition at line 1348 of file latexgen.cpp.

{
  m_t << "\\item\\contentsline{section}\\textbf{ ";
  if (!path.empty()) docify(path);
  docify(name);
  m_t << "} ";
}

References docify(), DString::empty(), and OutputGenerator::m_t.

writeString()

void LatexGenerator::writeString ( const DString & text )

overridevirtual

Implements OutputGenIntf.

Definition at line 1326 of file latexgen.cpp.

{
  m_t << text;
}

References OutputGenerator::m_t.

writeStyleInfo()

void LatexGenerator::writeStyleInfo ( int part )

overridevirtual

an extension of the etoc package is required that is only available in the newer version. Providing the updated version to be used with older versions of LaTeX

Implements OutputGenIntf.

Definition at line 1299 of file latexgen.cpp.

{
  if (part > 0)
    return;
 
  startPlainFile("doxygen.sty");
  writeDefaultStyleSheet(m_t);
  endPlainFile();
 
  /// an extension of the etoc package is required that is only available in the
  /// newer version. Providing the updated version to be used with older versions
  /// of LaTeX
  startPlainFile("etoc_doxygen.sty");
  m_t << ResourceMgr::instance().getAsString("etoc_doxygen.sty");
  endPlainFile();
}

References endPlainFile(), ResourceMgr::getAsString(), ResourceMgr::instance(), OutputGenerator::m_t, startPlainFile(), and writeDefaultStyleSheet().

writeStyleSheetFile()

void LatexGenerator::writeStyleSheetFile ( TextStream & t )

static

Definition at line 702 of file latexgen.cpp.

{
  t << "% stylesheet for doxygen " << getDoxygenVersion() << "\n";
  writeDefaultStyleSheet(t);
}

References writeDefaultStyleSheet().

Referenced by readConfiguration().

writeSummaryLink()

void LatexGenerator::writeSummaryLink ( const DString & , const DString & , const DString & , bool  )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 242 of file latexgen.h.

{}

writeSynopsis()

void LatexGenerator::writeSynopsis ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 231 of file latexgen.h.

{}

Member Data Documentation

m_codeGen

LatexCodeGenerator* LatexGenerator::m_codeGen

private

Definition at line 331 of file latexgen.h.

Referenced by addCodeGen(), docify(), endAnonTypeScope(), endDescTable(), endFile(), endIndexSection(), endInlineMemberName(), endInlineMemberType(), endMemberDescription(), endMemberDocSimple(), endMemberItem(), endMemberList(), LatexGenerator(), LatexGenerator(), lineBreak(), operator=(), startAnonTypeScope(), startDescTable(), startFile(), startIndexSection(), startInlineMemberName(), startInlineMemberType(), startMemberDescription(), startMemberDocSimple(), startMemberItem(), startMemberList(), writeDoc(), writeInheritedSectionTitle(), writeNonBreakableSpace(), and writeObjectLink().

m_codeList

std::unique_ptr<OutputCodeList> LatexGenerator::m_codeList

private

Definition at line 330 of file latexgen.h.

Referenced by LatexGenerator(), LatexGenerator(), operator=(), and writeDoc().

m_disableLinks

bool LatexGenerator::m_disableLinks = false

private

Definition at line 326 of file latexgen.h.

Referenced by endGroupHeader(), endMemberDoc(), endMemberHeader(), endTextLink(), LatexGenerator(), operator=(), startGroupHeader(), startMemberHeader(), startTextLink(), writeInheritedSectionTitle(), and writeObjectLink().

m_firstDescItem

bool LatexGenerator::m_firstDescItem = true

private

Definition at line 325 of file latexgen.h.

Referenced by LatexGenerator(), and operator=().

m_hierarchyLevel

int LatexGenerator::m_hierarchyLevel = 0

private

Definition at line 333 of file latexgen.h.

Referenced by LatexGenerator(), operator=(), startFile(), startGroupHeader(), startInlineHeader(), startLocalToc(), startMemberDoc(), startMemberHeader(), startTitleHead(), writeDoc(), and writeInheritedSectionTitle().

m_indent

int LatexGenerator::m_indent = 0

private

Definition at line 328 of file latexgen.h.

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

m_insideTableEnv

bool LatexGenerator::m_insideTableEnv = false

private

Definition at line 332 of file latexgen.h.

Referenced by addLabel(), endMemberDocSimple(), startDoxyAnchor(), and startMemberDocSimple().

m_relPath

DString LatexGenerator::m_relPath

private

Definition at line 327 of file latexgen.h.

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

m_templateMemberItem

bool LatexGenerator::m_templateMemberItem = false

private

Definition at line 329 of file latexgen.h.

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

---

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

• src/latexgen.h
• src/latexgen.cpp