HtmlGenerator Class Reference

Generator for HTML output. More...

#include <src/htmlgen.h>

Inheritance diagram for HtmlGenerator:

Collaboration diagram for HtmlGenerator:

Classes
struct	TocState

Public Member Functions
	HtmlGenerator ()
	HtmlGenerator (const HtmlGenerator &)
HtmlGenerator &	operator= (const HtmlGenerator &)
	HtmlGenerator (HtmlGenerator &&)=delete
HtmlGenerator &	operator= (HtmlGenerator &&)=delete
	~HtmlGenerator ()
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 *, const MemberDef *, int id, int sectionLevel) override
void	startFile (const QCString &name, bool isSource, const QCString &manName, const QCString &title, int id, int hierarchyLevel) override
void	endFile () override
void	writeFooter (const QCString &navPath) override
void	writeSearchInfo () override
void	startIndexSection (IndexSection) override
void	endIndexSection (IndexSection) override
void	writePageLink (const QCString &, bool) override
void	startProjectNumber () override
void	endProjectNumber () override
void	writeStyleInfo (int part) override
void	startTitleHead (const QCString &) override
void	endTitleHead (const QCString &, const QCString &) override
void	startParagraph (const QCString &classDef) override
void	endParagraph () override
void	writeString (const QCString &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 QCString &, bool) override
void	startItemList () override
void	endItemList () override
void	startIndexItem (const QCString &ref, const QCString &file) override
void	endIndexItem (const QCString &ref, const QCString &file) override
void	docify (const QCString &text) override
void	writeObjectLink (const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name) override
void	startTextLink (const QCString &file, const QCString &anchor) override
void	endTextLink () override
void	startTypewriter () override
void	endTypewriter () override
void	startGroupHeader (const QCString &, 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 QCString &, 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 QCString &anchor, MemberItemType, const QCString &inheritId) override
void	endMemberItem (MemberItemType) override
void	startMemberTemplateParams () override
void	endMemberTemplateParams (const QCString &anchor, const QCString &inheritId) override
void	startCompoundTemplateParams () override
void	endCompoundTemplateParams () override
void	startMemberGroupHeader (const QCString &, 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	startMemberDescription (const QCString &anchor, const QCString &inheritId, bool typ) override
void	endMemberDescription () override
void	startMemberDeclaration () override
void	endMemberDeclaration (const QCString &anchor, const QCString &inheritId) override
void	writeInheritedSectionTitle (const QCString &id, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &title, const QCString &name) override
void	writeRuler () override
void	writeAnchor (const QCString &, const QCString &name) override
void	startEmphasis () override
void	endEmphasis () override
void	startBold () override
void	endBold () override
void	startDescForItem () override
void	endDescForItem () override
void	lineBreak (const QCString &style) override
void	writeChar (char c) override
void	startMemberDoc (const QCString &clName, const QCString &memName, const QCString &anchor, const QCString &title, int memCount, int memTotal, bool showInline) override
void	endMemberDoc (bool) override
void	startDoxyAnchor (const QCString &fName, const QCString &manName, const QCString &anchor, const QCString &name, const QCString &args) override
void	endDoxyAnchor (const QCString &fName, const QCString &anchor) override
void	addLabel (const QCString &, const QCString &) override
void	writeLatexSpacing () override
void	writeStartAnnoItem (const QCString &type, const QCString &file, const QCString &path, const QCString &name) override
void	startCenter () override
void	endCenter () override
void	startSmall () override
void	endSmall () override
void	startExamples () override
void	endExamples () override
void	startSection (const QCString &, const QCString &, SectionType) override
void	endSection (const QCString &, SectionType) override
void	addIndexItem (const QCString &, const QCString &) override
void	startIndent () override
void	endIndent () override
void	writeSynopsis () override
void	startClassDiagram () override
void	endClassDiagram (const ClassDiagram &, const QCString &, const QCString &) override
void	startPageRef () override
void	endPageRef (const QCString &, const QCString &) override
void	startQuickIndices () override
void	endQuickIndices () override
void	writeSplitBar (const QCString &name, const QCString &allMembersFile) override
void	writeNavigationPath (const QCString &s) override
void	writeLogo () override
void	writeQuickLinks (HighlightedItem hli, const QCString &file, bool extraTabs) override
void	writeSummaryLink (const QCString &file, const QCString &anchor, const QCString &title, bool first) override
void	writePageOutline () override
void	startContents () override
void	endContents () override
void	startPageDoc (const QCString &pageTitle) override
void	endPageDoc () override
void	writeNonBreakableSpace (int) override
void	startDescTable (const QCString &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	startDotGraph () override
void	endDotGraph (DotClassGraph &g) override
void	startInclDepGraph () override
void	endInclDepGraph (DotInclDepGraph &g) override
void	startGroupCollaboration () override
void	endGroupCollaboration (DotGroupCollaboration &g) override
void	startCallGraph () override
void	endCallGraph (DotCallGraph &g) override
void	startDirDepGraph () override
void	endDirDepGraph (DotDirDeps &g) override
void	writeGraphicalHierarchy (DotGfxHierarchyTable &g) override
void	startTextBlock (bool) override
void	endTextBlock (bool) override
void	lastIndexPage () override
void	startMemberDocPrefixItem () override
void	endMemberDocPrefixItem () override
void	startMemberDocName (bool) override
void	endMemberDocName () override
void	startParameterType (bool first, const QCString &key) override
void	endParameterType () override
void	startParameterName (bool) override
void	endParameterName () override
void	startParameterExtra () override
void	endParameterExtra (bool last, bool emptyList, bool closeBracket) override
void	startParameterDefVal (const char *sep) override
void	endParameterDefVal () override
void	startParameterList (bool) override
void	endParameterList () override
void	exceptionEntry (const QCString &, bool) override
void	startConstraintList (const QCString &) 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 QCString &l, bool isLast) override
void	endLabels () override
void	startLocalToc (int level) override
void	endLocalToc () override
void	startTocEntry (const SectionInfo *si) override
void	endTocEntry (const SectionInfo *si) override
void	startPlainFile (const QCString &name) override
void	endPlainFile () override
void	startEmbeddedDoc (int) override
void	endEmbeddedDoc () override
Public Member Functions inherited from OutputGenerator
	OutputGenerator ()
	OutputGenerator (const QCString &dir)
virtual	~OutputGenerator ()=default
QCString	dir () const
QCString	fileName () const
void	startPlainFile (const QCString &name)
void	endPlainFile ()

Static Public Member Functions
static void	init ()
static void	writeStyleSheetFile (TextStream &t)
static void	writeHeaderFile (TextStream &t, const QCString &cssname)
static void	writeFooterFile (TextStream &t)
static void	writeTabData ()
	Additional initialization after indices have been created.
static void	writeSearchInfoStatic (TextStream &t, const QCString &relPath)
static void	writeSearchData (const QCString &dir)
static void	writeSearchPage ()
static void	writeExternalSearchPage ()
static QCString	writeLogoAsString (const QCString &path)
static QCString	writeSplitBarAsString (const QCString &name, const QCString &relpath, const QCString &allMembersFile)
static QCString	getNavTreeCss ()

Private Member Functions
void	startTitle ()
void	endTitle ()
void	docify_ (const QCString &text, bool inHtmlComment)

Static Private Member Functions
static void	writePageFooter (TextStream &t, const QCString &, const QCString &, const QCString &)

Private Attributes
QCString	m_lastTitle
QCString	m_lastFile
QCString	m_relPath
int	m_sectionCount = 0
bool	m_emptySection = false
std::unique_ptr< OutputCodeList >	m_codeList
HtmlCodeGenerator *	m_codeGen = nullptr
int	m_pageOutlineIndent = 0
TocState	m_tocState

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
QCString	m_dir

Detailed Description

Generator for HTML output.

Definition at line 95 of file htmlgen.h.

Constructor & Destructor Documentation

HtmlGenerator() [1/3]

HtmlGenerator::HtmlGenerator

(

)

Definition at line 1142 of file htmlgen.cpp.

  : OutputGenerator(Config_getString(HTML_OUTPUT))
  , m_codeList(std::make_unique<OutputCodeList>())
{
  //printf("%p:HtmlGenerator()\n",(void*)this);
  m_codeGen = m_codeList->add<HtmlCodeGenerator>(&m_t);
}

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

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

HtmlGenerator() [2/3]

HtmlGenerator::HtmlGenerator

(

const HtmlGenerator &

og

)

Definition at line 1150 of file htmlgen.cpp.

                                                    : OutputGenerator(og.m_dir), OutputGenIntf()
{
  //printf("%p:HtmlGenerator(copy %p)\n",(void*)this,(void*)&og);
  m_codeList     = std::make_unique<OutputCodeList>(*og.m_codeList);
  m_codeGen      = m_codeList->get<HtmlCodeGenerator>(OutputType::Html);
  m_codeGen->setTextStream(&m_t);
  m_lastTitle    = og.m_lastTitle;
  m_lastFile     = og.m_lastFile;
  m_relPath      = og.m_relPath;
  m_sectionCount = og.m_sectionCount;
  m_emptySection = og.m_emptySection;
}

References Html, HtmlGenerator(), m_codeGen, m_codeList, OutputGenerator::m_dir, m_emptySection, m_lastFile, m_lastTitle, m_relPath, m_sectionCount, OutputGenerator::m_t, and OutputGenerator::OutputGenerator().

HtmlGenerator() [3/3]

HtmlGenerator::HtmlGenerator ( HtmlGenerator && )

delete

References HtmlGenerator().

~HtmlGenerator()

HtmlGenerator::~HtmlGenerator ( )

default

References OutputGenerator::dir().

Member Function Documentation

addCodeGen()

void HtmlGenerator::addCodeGen ( OutputCodeList & list )

overridevirtual

Implements OutputGenIntf.

Definition at line 1183 of file htmlgen.cpp.

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

References OutputCodeList::add(), and m_codeGen.

addIndexItem()

void HtmlGenerator::addIndexItem ( const QCString & , const QCString &  )

overridevirtual

Implements OutputGenIntf.

Definition at line 2664 of file htmlgen.cpp.

{
}

addLabel()

void HtmlGenerator::addLabel ( const QCString & , const QCString &  )

overridevirtual

Implements OutputGenIntf.

Definition at line 1764 of file htmlgen.cpp.

{
}

cleanup()

void HtmlGenerator::cleanup ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1349 of file htmlgen.cpp.

{
  QCString dname = Config_getString(HTML_OUTPUT);
  Dir d(dname.str());
  clearSubDirs(d);
}

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

clearBuffer()

void HtmlGenerator::clearBuffer

(

)

clone()

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

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 122 of file htmlgen.h.

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

docify()

void HtmlGenerator::docify ( const QCString & text )

overridevirtual

Implements OutputGenIntf.

Definition at line 1960 of file htmlgen.cpp.

{
  docify_(str,FALSE);
}

References docify_(), and FALSE.

Referenced by startExamples(), startMemberDoc(), startParameterDefVal(), writeChar(), writeObjectLink(), and writeStartAnnoItem().

docify_()

void HtmlGenerator::docify_ ( const QCString & text, bool inHtmlComment )

private

Definition at line 1965 of file htmlgen.cpp.

{
  if (!str.isEmpty())
  {
    const char *p=str.data();
    while (*p)
    {
      char c=*p++;
      switch(c)
      {
        case '<':  m_t << "&lt;"; break;
        case '>':  m_t << "&gt;"; break;
        case '&':  m_t << "&amp;"; break;
        case '"':  m_t << "&quot;"; break;
        case '-':  if (inHtmlComment) m_t << "&#45;"; else m_t << "-"; break;
        case '\\':
                   if (*p=='<')
                     { m_t << "&lt;"; p++; }
                   else if (*p=='>')
                     { m_t << "&gt;"; p++; }
                   else if (*p=='[')
                     { m_t << "\\&zwj;["; p++; }
                   else if (*p==']')
                     { m_t << "\\&zwj;]"; p++; }
                   else if (*p=='(')
                     { m_t << "\\&zwj;("; p++; }
                   else if (*p==')')
                     { m_t << "\\&zwj;)"; p++; }
                   else
                     m_t << "\\";
                   break;
        default:   m_t << c;
      }
    }
  }
}

References QCString::data(), QCString::isEmpty(), and OutputGenerator::m_t.

Referenced by docify().

endAnonTypeScope()

void HtmlGenerator::endAnonTypeScope ( int )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 185 of file htmlgen.h.

{}

endBold()

void HtmlGenerator::endBold ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 216 of file htmlgen.h.

{ m_t << "</b>"; }

References OutputGenerator::m_t.

endCallGraph()

void HtmlGenerator::endCallGraph ( DotCallGraph & g )

overridevirtual

Implements OutputGenIntf.

Definition at line 2587 of file htmlgen.cpp.

{
  endSectionHeader(m_t);
  startSectionSummary(m_t,m_sectionCount);
  endSectionSummary(m_t);
  startSectionContent(m_t,m_sectionCount);
 
  g.writeGraph(m_t,GraphOutputFormat::BITMAP,EmbeddedOutputFormat::Html,dir(),fileName(),m_relPath,TRUE,m_sectionCount);
 
  endSectionContent(m_t);
  m_sectionCount++;
}

References BITMAP, OutputGenerator::dir(), endSectionContent(), endSectionHeader(), endSectionSummary(), OutputGenerator::fileName(), Html, m_relPath, m_sectionCount, OutputGenerator::m_t, startSectionContent(), startSectionSummary(), TRUE, and DotCallGraph::writeGraph().

endCenter()

void HtmlGenerator::endCenter ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 234 of file htmlgen.h.

{ m_t << "</center>\n"; }

References OutputGenerator::m_t.

endClassDiagram()

void HtmlGenerator::endClassDiagram ( const ClassDiagram & d, const QCString & fileName, const QCString & name )

overridevirtual

Implements OutputGenIntf.

Definition at line 2088 of file htmlgen.cpp.

{
  endSectionHeader(m_t);
  startSectionSummary(m_t,m_sectionCount);
  endSectionSummary(m_t);
  startSectionContent(m_t,m_sectionCount);
  TextStream tt;
  d.writeImage(tt,dir(),m_relPath,fileName);
  if (!tt.empty())
  {
    m_t << " <div class=\"center\">\n";
    m_t << "  <img src=\"";
    m_t << m_relPath << fileName << ".png\" usemap=\"#" << convertToId(name);
    m_t << "_map\" alt=\"\"/>\n";
    m_t << "  <map id=\"" << convertToId(name);
    m_t << "_map\" name=\"" << convertToId(name);
    m_t << "_map\">\n";
    m_t << tt.str();
    m_t << "  </map>\n";
    m_t << "</div>";
  }
  else
  {
    m_t << " <div class=\"center\">\n";
    m_t << "  <img src=\"";
    m_t << m_relPath << fileName << ".png\" alt=\"\"/>\n";
    m_t << " </div>";
  }
  endSectionContent(m_t);
  m_sectionCount++;
}

References convertToId(), OutputGenerator::dir(), TextStream::empty(), endSectionContent(), endSectionHeader(), endSectionSummary(), OutputGenerator::fileName(), m_relPath, m_sectionCount, OutputGenerator::m_t, startSectionContent(), startSectionSummary(), TextStream::str(), and ClassDiagram::writeImage().

endCompoundTemplateParams()

void HtmlGenerator::endCompoundTemplateParams ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2191 of file htmlgen.cpp.

{
  m_t << "</div>";
}

References OutputGenerator::m_t.

endConstraintDocs()

void HtmlGenerator::endConstraintDocs ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3434 of file htmlgen.cpp.

{
  m_t << "</td></tr>\n";
}

References OutputGenerator::m_t.

endConstraintList()

void HtmlGenerator::endConstraintList ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3439 of file htmlgen.cpp.

{
  m_t << "</table>\n";
  m_t << "</dd>\n";
  m_t << "</dl>\n";
  m_t << "</div>\n";
}

References OutputGenerator::m_t.

endConstraintParam()

void HtmlGenerator::endConstraintParam ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3414 of file htmlgen.cpp.

{
  m_t << "</em></td>";
}

References OutputGenerator::m_t.

endConstraintType()

void HtmlGenerator::endConstraintType ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3424 of file htmlgen.cpp.

{
  m_t << "</em></td>";
}

References OutputGenerator::m_t.

endContents()

void HtmlGenerator::endContents ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3176 of file htmlgen.cpp.

{
  m_t << "</div><!-- contents -->\n";
}

References OutputGenerator::m_t.

endDescForItem()

void HtmlGenerator::endDescForItem ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 218 of file htmlgen.h.

{ m_t << "</dd>\n"; }

References OutputGenerator::m_t.

endDescTable()

void HtmlGenerator::endDescTable ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2681 of file htmlgen.cpp.

{
  m_t << "</table>\n";
}

References OutputGenerator::m_t.

endDescTableData()

void HtmlGenerator::endDescTableData ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2721 of file htmlgen.cpp.

{
  m_t << "</td>";
}

References OutputGenerator::m_t.

endDescTableInit()

void HtmlGenerator::endDescTableInit ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2711 of file htmlgen.cpp.

{
  m_t << "&#160;</td>";
}

References OutputGenerator::m_t.

endDescTableRow()

void HtmlGenerator::endDescTableRow ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2691 of file htmlgen.cpp.

{
  m_t << "</tr>\n";
}

References OutputGenerator::m_t.

endDescTableTitle()

void HtmlGenerator::endDescTableTitle ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2701 of file htmlgen.cpp.

{
  m_t << "&#160;</td>";
}

References OutputGenerator::m_t.

endDirDepGraph()

void HtmlGenerator::endDirDepGraph ( DotDirDeps & g )

overridevirtual

Implements OutputGenIntf.

Definition at line 2605 of file htmlgen.cpp.

{
  endSectionHeader(m_t);
  startSectionSummary(m_t,m_sectionCount);
  endSectionSummary(m_t);
  startSectionContent(m_t,m_sectionCount);
 
  g.writeGraph(m_t,GraphOutputFormat::BITMAP,EmbeddedOutputFormat::Html,dir(),fileName(),m_relPath,TRUE,m_sectionCount);
 
  endSectionContent(m_t);
  m_sectionCount++;
}

References BITMAP, OutputGenerator::dir(), endSectionContent(), endSectionHeader(), endSectionSummary(), OutputGenerator::fileName(), Html, m_relPath, m_sectionCount, OutputGenerator::m_t, startSectionContent(), startSectionSummary(), TRUE, and DotDirDeps::writeGraph().

endDotGraph()

void HtmlGenerator::endDotGraph ( DotClassGraph & g )

overridevirtual

Implements OutputGenIntf.

Definition at line 2517 of file htmlgen.cpp.

{
  bool generateLegend = Config_getBool(GENERATE_LEGEND);
  bool umlLook = Config_getBool(UML_LOOK);
  endSectionHeader(m_t);
  startSectionSummary(m_t,m_sectionCount);
  endSectionSummary(m_t);
  startSectionContent(m_t,m_sectionCount);
 
  g.writeGraph(m_t,GraphOutputFormat::BITMAP,EmbeddedOutputFormat::Html,dir(),fileName(),m_relPath,TRUE,TRUE,m_sectionCount);
  if (generateLegend && !umlLook)
  {
    QCString url = m_relPath+"graph_legend"+Doxygen::htmlFileExtension;
    m_t << "<center><span class=\"legend\">[";
    bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
    m_t << "<a ";
    if (generateTreeView) m_t << "target=\"top\" ";
    m_t << "href=\"";
    if (!url.isEmpty()) m_t << url;
    m_t << "\">";
    m_t << theTranslator->trLegend();
    m_t << "</a>";
    m_t << "]</span></center>";
  }
 
  endSectionContent(m_t);
  m_sectionCount++;
}

References BITMAP, Config_getBool, OutputGenerator::dir(), endSectionContent(), endSectionHeader(), endSectionSummary(), OutputGenerator::fileName(), Html, Doxygen::htmlFileExtension, QCString::isEmpty(), m_relPath, m_sectionCount, OutputGenerator::m_t, startSectionContent(), startSectionSummary(), theTranslator, TRUE, and DotClassGraph::writeGraph().

endDoxyAnchor()

void HtmlGenerator::endDoxyAnchor ( const QCString & fName, const QCString & anchor )

overridevirtual

Implements OutputGenIntf.

Definition at line 1760 of file htmlgen.cpp.

{
}

endEmbeddedDoc()

void HtmlGenerator::endEmbeddedDoc ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3553 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- endEmbeddedDoc -->\n";)
  m_t << "</div>";
}

References DBG_HTML, and OutputGenerator::m_t.

endEmphasis()

void HtmlGenerator::endEmphasis ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 214 of file htmlgen.h.

{ m_t << "</em>"; }

References OutputGenerator::m_t.

endExamples()

void HtmlGenerator::endExamples ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2733 of file htmlgen.cpp.

{
  m_t << "</dl>\n";
}

References OutputGenerator::m_t.

endFile()

void HtmlGenerator::endFile ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1661 of file htmlgen.cpp.

{
  endPlainFile();
}

References endPlainFile().

endGroupCollaboration()

void HtmlGenerator::endGroupCollaboration ( DotGroupCollaboration & g )

overridevirtual

Implements OutputGenIntf.

Definition at line 2569 of file htmlgen.cpp.

{
  endSectionHeader(m_t);
  startSectionSummary(m_t,m_sectionCount);
  endSectionSummary(m_t);
  startSectionContent(m_t,m_sectionCount);
 
  g.writeGraph(m_t,GraphOutputFormat::BITMAP,EmbeddedOutputFormat::Html,dir(),fileName(),m_relPath,TRUE,m_sectionCount);
 
  endSectionContent(m_t);
  m_sectionCount++;
}

References BITMAP, OutputGenerator::dir(), endSectionContent(), endSectionHeader(), endSectionSummary(), OutputGenerator::fileName(), Html, m_relPath, m_sectionCount, OutputGenerator::m_t, startSectionContent(), startSectionSummary(), TRUE, and DotGroupCollaboration::writeGraph().

endGroupHeader()

void HtmlGenerator::endGroupHeader ( int extraIndentLevel )

overridevirtual

Implements OutputGenIntf.

Definition at line 1913 of file htmlgen.cpp.

{
  if (extraIndentLevel==2)
  {
    m_t << "</h4>\n";
  }
  else if (extraIndentLevel==1)
  {
    m_t << "</h3>\n";
  }
  else
  {
    m_t << "</h2>\n";
  }
}

References OutputGenerator::m_t.

endHeaderSection()

void HtmlGenerator::endHeaderSection ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3476 of file htmlgen.cpp.

{
  m_t << "</div><!--header-->\n";
}

References OutputGenerator::m_t.

endInclDepGraph()

void HtmlGenerator::endInclDepGraph ( DotInclDepGraph & g )

overridevirtual

Implements OutputGenIntf.

Definition at line 2551 of file htmlgen.cpp.

{
  endSectionHeader(m_t);
  startSectionSummary(m_t,m_sectionCount);
  endSectionSummary(m_t);
  startSectionContent(m_t,m_sectionCount);
 
  g.writeGraph(m_t,GraphOutputFormat::BITMAP,EmbeddedOutputFormat::Html,dir(),fileName(),m_relPath,TRUE,m_sectionCount);
 
  endSectionContent(m_t);
  m_sectionCount++;
}

References BITMAP, OutputGenerator::dir(), endSectionContent(), endSectionHeader(), endSectionSummary(), OutputGenerator::fileName(), Html, m_relPath, m_sectionCount, OutputGenerator::m_t, startSectionContent(), startSectionSummary(), TRUE, and DotInclDepGraph::writeGraph().

endIndent()

void HtmlGenerator::endIndent ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2658 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- endIndent -->\n";)
  m_t << "\n</div>\n" << "</div>\n";
}

References DBG_HTML, and OutputGenerator::m_t.

endIndexItem()

void HtmlGenerator::endIndexItem ( const QCString & ref, const QCString & file )

overridevirtual

Implements OutputGenIntf.

Definition at line 1826 of file htmlgen.cpp.

{
  //printf("HtmlGenerator::endIndexItem(%s,%s,%s)\n",ref,f,name);
  if (!ref.isEmpty() || !f.isEmpty())
  {
    m_t << "</a>";
  }
  else
  {
    m_t << "</b>";
  }
}

References QCString::isEmpty(), and OutputGenerator::m_t.

endIndexKey()

void HtmlGenerator::endIndexKey ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2321 of file htmlgen.cpp.

{
  //m_t << "</td>";
}

endIndexList()

void HtmlGenerator::endIndexList ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2311 of file htmlgen.cpp.

{
  m_t << "</table>\n";
}

References OutputGenerator::m_t.

endIndexListItem()

void HtmlGenerator::endIndexListItem ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1791 of file htmlgen.cpp.

{
  m_t << "</li>\n";
}

References OutputGenerator::m_t.

endIndexSection()

void HtmlGenerator::endIndexSection ( IndexSection )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 133 of file htmlgen.h.

{}

endIndexValue()

void HtmlGenerator::endIndexValue ( const QCString & , bool  )

overridevirtual

Implements OutputGenIntf.

Definition at line 2331 of file htmlgen.cpp.

{
  //m_t << "</td></tr>\n";
}

endInlineHeader()

void HtmlGenerator::endInlineHeader ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3491 of file htmlgen.cpp.

{
  m_t << "</h3></td></tr>\n";
}

References OutputGenerator::m_t.

endInlineMemberDoc()

void HtmlGenerator::endInlineMemberDoc ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3541 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- endInlineMemberDoc -->\n";)
  m_t << "</td></tr>\n";
}

References DBG_HTML, and OutputGenerator::m_t.

endInlineMemberName()

void HtmlGenerator::endInlineMemberName ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3529 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- endInlineMemberName -->\n";)
  m_t << "</td>\n";
}

References DBG_HTML, and OutputGenerator::m_t.

endInlineMemberType()

void HtmlGenerator::endInlineMemberType ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3517 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- endInlineMemberType -->\n";)
  m_t << "</td>\n";
}

References DBG_HTML, and OutputGenerator::m_t.

endItemList()

void HtmlGenerator::endItemList ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 153 of file htmlgen.h.

{ m_t << "</ul>\n"; }

References OutputGenerator::m_t.

endItemListItem()

void HtmlGenerator::endItemListItem ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 168 of file htmlgen.h.

{ m_t << "</li>\n"; }

References OutputGenerator::m_t.

endLabels()

void HtmlGenerator::endLabels ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3605 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- endLabels -->\n";)
  m_t << "</span>";
}

References DBG_HTML, and OutputGenerator::m_t.

endLocalToc()

void HtmlGenerator::endLocalToc ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3708 of file htmlgen.cpp.

{
  if (m_tocState.level > m_tocState.maxLevel) m_tocState.level = m_tocState.maxLevel;
  while (m_tocState.level>0)
  {
    m_tocState.decIndent(m_t,"</li>");
    m_tocState.decIndent(m_t,"</ul>");
    m_tocState.level--;
  }
  m_t << "</div>\n";
}

References OutputGenerator::m_t, and m_tocState.

endMemberDeclaration()

void HtmlGenerator::endMemberDeclaration ( const QCString & anchor, const QCString & inheritId )

overridevirtual

Implements OutputGenIntf.

Definition at line 3688 of file htmlgen.cpp.

{
}

endMemberDescription()

void HtmlGenerator::endMemberDescription ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2235 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- endMemberDescription -->\n")
  m_t << "<br /></td></tr>\n";
}

References DBG_HTML, and OutputGenerator::m_t.

endMemberDoc()

void HtmlGenerator::endMemberDoc ( bool hasArgs )

overridevirtual

Implements OutputGenIntf.

Definition at line 2501 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- endMemberDoc -->\n";)
  if (!hasArgs)
  {
    m_t << "        </tr>\n";
  }
  m_t << "      </table>\n";
 // m_t << "</div>\n";
}

References DBG_HTML, and OutputGenerator::m_t.

endMemberDocList()

void HtmlGenerator::endMemberDocList ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2341 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- endMemberDocList -->\n";)
}

References DBG_HTML, and OutputGenerator::m_t.

endMemberDocName()

void HtmlGenerator::endMemberDocName ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2385 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- endMemberDocName -->\n";)
  m_t << "</td>\n";
}

References DBG_HTML, and OutputGenerator::m_t.

endMemberDocPrefixItem()

void HtmlGenerator::endMemberDocPrefixItem ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2369 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- endMemberDocPrefixItem -->\n";)
  m_t << "</div>\n";
}

References DBG_HTML, and OutputGenerator::m_t.

endMemberDocSimple()

void HtmlGenerator::endMemberDocSimple ( bool )

overridevirtual

Implements OutputGenIntf.

Definition at line 3505 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- endMemberDocSimple -->\n";)
  m_t << "</table>\n";
}

References DBG_HTML, and OutputGenerator::m_t.

endMemberGroup()

void HtmlGenerator::endMemberGroup ( bool )

overridevirtual

Implements OutputGenIntf.

Definition at line 2647 of file htmlgen.cpp.

{
}

endMemberGroupDocs()

void HtmlGenerator::endMemberGroupDocs ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2638 of file htmlgen.cpp.

{
  m_t << "</div></td></tr>\n";
}

References OutputGenerator::m_t.

endMemberGroupHeader()

void HtmlGenerator::endMemberGroupHeader ( bool )

overridevirtual

Implements OutputGenIntf.

Definition at line 2628 of file htmlgen.cpp.

{
  m_t << "</div></td></tr>\n";
}

References OutputGenerator::m_t.

endMemberHeader()

void HtmlGenerator::endMemberHeader ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2283 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- endMemberHeader -->\n")
  m_t << "</h2></td></tr>\n";
}

References DBG_HTML, and OutputGenerator::m_t.

endMemberItem()

void HtmlGenerator::endMemberItem ( MemberItemType type )

overridevirtual

Implements OutputGenIntf.

Definition at line 2160 of file htmlgen.cpp.

{
  if (type==MemberItemType::AnonymousStart)
  {
    insertMemberAlign(false);
  }
  m_t << "</td></tr>\n";
}

References OutputGenerator::AnonymousStart, insertMemberAlign(), OutputGenerator::m_t, and type().

endMemberList()

void HtmlGenerator::endMemberList ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2127 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- endMemberList -->\n")
}

References DBG_HTML, and OutputGenerator::m_t.

endMemberSections()

void HtmlGenerator::endMemberSections ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2249 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- endMemberSections -->\n")
  if (!m_emptySection)
  {
    m_t << "</table>\n";
  }
}

References DBG_HTML, m_emptySection, and OutputGenerator::m_t.

endMemberSubtitle()

void HtmlGenerator::endMemberSubtitle ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2300 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- endMemberSubtitle -->\n")
  m_t << "</td></tr>\n";
}

References DBG_HTML, and OutputGenerator::m_t.

endMemberTemplateParams()

void HtmlGenerator::endMemberTemplateParams ( const QCString & anchor, const QCString & inheritId )

overridevirtual

Implements OutputGenIntf.

Definition at line 2173 of file htmlgen.cpp.

{
  bool dynamicSections = Config_getBool(HTML_DYNAMIC_SECTIONS);
  m_t << "</td></tr>\n";
  m_t << "<tr class=\"memitem:" << convertToId(anchor);
  if (!inheritId.isEmpty())
  {
    if (dynamicSections) m_t << " inherit";
    m_t << " " << inheritId;
  }
  m_t << " template\"><td class=\"memItemLeft\">";
}

References Config_getBool, convertToId(), QCString::isEmpty(), and OutputGenerator::m_t.

endPageDoc()

void HtmlGenerator::endPageDoc ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3186 of file htmlgen.cpp.

{
  m_t << "</div><!-- PageDoc -->\n";
}

References OutputGenerator::m_t.

endPageRef()

void HtmlGenerator::endPageRef ( const QCString & , const QCString &  )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 248 of file htmlgen.h.

{}

endParagraph()

void HtmlGenerator::endParagraph ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1776 of file htmlgen.cpp.

{
  m_t << "</p>\n";
}

References OutputGenerator::m_t.

endParameterDefVal()

void HtmlGenerator::endParameterDefVal ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2470 of file htmlgen.cpp.

{
  m_t << "</span>";
}

References OutputGenerator::m_t.

endParameterExtra()

void HtmlGenerator::endParameterExtra ( bool last, bool emptyList, bool closeBracket )

overridevirtual

Implements OutputGenIntf.

Definition at line 2439 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- endParameterExtra -->\n";)
  if (last)
  {
    if (emptyList)
    {
      if (closeBracket) m_t << "</td><td>)";
      m_t << "</td>\n";
      m_t << "          <td>";
    }
    else
    {
      m_t << "&#160;";
      if (closeBracket) m_t << ")";
    }
  }
  else
  {
    m_t << "</td>\n";
    m_t << "        </tr>\n";
  }
}

References DBG_HTML, and OutputGenerator::m_t.

endParameterList()

void HtmlGenerator::endParameterList ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2475 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- endParameterList -->\n";)
  m_t << "</td>\n";
  m_t << "        </tr>\n";
}

References DBG_HTML, and OutputGenerator::m_t.

endParameterName()

void HtmlGenerator::endParameterName ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2428 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- endParameterName -->\n";)
  m_t << "</em></span>";
}

References DBG_HTML, and OutputGenerator::m_t.

endParameterType()

void HtmlGenerator::endParameterType ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2416 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- endParameterType -->\n";)
  m_t << "</td>";
}

References DBG_HTML, and OutputGenerator::m_t.

endPlainFile()

void HtmlGenerator::endPlainFile ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 334 of file htmlgen.h.

{ OutputGenerator::endPlainFile(); }

References OutputGenerator::endPlainFile().

Referenced by endFile(), and writeStyleInfo().

endProjectNumber()

void HtmlGenerator::endProjectNumber ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1671 of file htmlgen.cpp.

{
  m_t << "</h3>";
}

References OutputGenerator::m_t.

endQuickIndices()

void HtmlGenerator::endQuickIndices ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3116 of file htmlgen.cpp.

{
  bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
  m_t << "</div><!-- top -->\n";
  if (!generateTreeView)
  {
    m_t << "<div id=\"doc-content\">\n";
  }
}

References Config_getBool, and OutputGenerator::m_t.

endSection()

void HtmlGenerator::endSection ( const QCString & , SectionType type )

overridevirtual

Implements OutputGenIntf.

Definition at line 1945 of file htmlgen.cpp.

{
  switch(type.level())
  {
    case SectionType::Page:             m_t << "</h1>"; break;
    case SectionType::Section:          m_t << "</h2>"; break;
    case SectionType::Subsection:       m_t << "</h3>"; break;
    case SectionType::Subsubsection:    m_t << "</h4>"; break;
    case SectionType::Paragraph:        m_t << "</h5>"; break;
    case SectionType::Subparagraph:     m_t << "</h6>"; break;
    case SectionType::Subsubparagraph:  m_t << "</h6>"; break;
    default: ASSERT(0); break;
  }
}

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

endSmall()

void HtmlGenerator::endSmall ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 236 of file htmlgen.h.

{ m_t << "</small>\n"; }

References OutputGenerator::m_t.

endTextBlock()

void HtmlGenerator::endTextBlock ( bool )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 287 of file htmlgen.h.

{ m_t << "</div>"; }

References OutputGenerator::m_t.

endTextLink()

void HtmlGenerator::endTextLink ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1887 of file htmlgen.cpp.

{
  m_t << "</a>";
}

References OutputGenerator::m_t.

endTitle()

void HtmlGenerator::endTitle ( )

inlineprivate

Definition at line 341 of file htmlgen.h.

{ m_t << "</div>"; }

References OutputGenerator::m_t.

Referenced by endTitleHead().

endTitleHead()

void HtmlGenerator::endTitleHead ( const QCString & , const QCString &  )

overridevirtual

Implements OutputGenIntf.

Definition at line 3470 of file htmlgen.cpp.

{
  endTitle();
  m_t << "</div>\n";
}

References endTitle(), and OutputGenerator::m_t.

endTocEntry()

void HtmlGenerator::endTocEntry ( const SectionInfo * si )

overridevirtual

Implements OutputGenIntf.

Definition at line 3764 of file htmlgen.cpp.

{
  SectionType type = si->type();
  int nextLevel = type.level();
  if (type.isSection() && nextLevel<=m_tocState.maxLevel)
  {
    m_t << "</a>\n";
    m_tocState.inLi[nextLevel]=true;
    m_tocState.level = nextLevel;
  }
}

References OutputGenerator::m_t, m_tocState, type(), and SectionInfo::type().

endTypewriter()

void HtmlGenerator::endTypewriter ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 164 of file htmlgen.h.

{ m_t << "</code>"; }

References OutputGenerator::m_t.

exceptionEntry()

void HtmlGenerator::exceptionEntry ( const QCString & prefix, bool closeBracket )

overridevirtual

Implements OutputGenIntf.

Definition at line 2482 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- exceptionEntry -->\n";)
  if (!closeBracket)
  {
  m_t << "</td>\n";
  m_t << "        </tr>\n";
  m_t << "        <tr>\n";
  m_t << "          <td align=\"right\">";
  }
  // colspan 2 so it gets both parameter type and parameter name columns
  if (!prefix.isEmpty())
    m_t << prefix << "</td><td>(</td><td colspan=\"2\">";
  else if (closeBracket)
    m_t << "&#160;)</td><td></td><td></td><td>";
  else
    m_t << "</td><td></td><td colspan=\"2\">";
}

References DBG_HTML, OutputGenerator::m_t, and prefix.

getNavTreeCss()

QCString HtmlGenerator::getNavTreeCss ( )

static

Definition at line 3692 of file htmlgen.cpp.

{
  ResourceMgr &mgr = ResourceMgr::instance();
  return replaceVariables(mgr.getAsString("navtree.css"));
}

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

Referenced by init().

init()

void HtmlGenerator::init ( )

static

Definition at line 1197 of file htmlgen.cpp.

{
  QCString dname = Config_getString(HTML_OUTPUT);
  Dir d(dname.str());
  if (!d.exists() && !d.mkdir(dname.str()))
  {
    term("Could not create output directory {}\n",dname);
  }
  //writeLogo(dname);
  if (!Config_getString(HTML_HEADER).isEmpty())
  {
    g_header_file=Config_getString(HTML_HEADER);
    g_header=fileToString(g_header_file);
    g_build_date = (g_build_date || hasDateReplacement(g_header));
    //printf("g_header='%s'\n",qPrint(g_header));
    QCString result = substituteHtmlKeywords(g_header_file,g_header,QCString(),QCString());
    checkBlocks(result,Config_getString(HTML_HEADER),htmlMarkerInfo);
  }
  else
  {
    g_header_file="header.html";
    g_header = ResourceMgr::instance().getAsString(g_header_file);
    g_build_date = (g_build_date || hasDateReplacement(g_header));
    QCString result = substituteHtmlKeywords(g_header_file,g_header,QCString(),QCString());
    checkBlocks(result,"<default header.html>",htmlMarkerInfo);
  }
 
  if (!Config_getString(HTML_FOOTER).isEmpty())
  {
    g_footer_file=Config_getString(HTML_FOOTER);
    g_footer=fileToString(g_footer_file);
    g_build_date = (g_build_date || hasDateReplacement(g_footer));
    //printf("g_footer='%s'\n",qPrint(g_footer));
    QCString result = substituteHtmlKeywords(g_footer_file,g_footer,QCString(),QCString());
    checkBlocks(result,Config_getString(HTML_FOOTER),htmlMarkerInfo);
  }
  else
  {
    g_footer_file = "footer.html";
    g_footer = ResourceMgr::instance().getAsString(g_footer_file);
    g_build_date = (g_build_date || hasDateReplacement(g_footer));
    QCString result = substituteHtmlKeywords(g_footer_file,g_footer,QCString(),QCString());
    checkBlocks(result,"<default footer.html>",htmlMarkerInfo);
  }
 
  if (Config_getBool(USE_MATHJAX))
  {
    if (!Config_getString(MATHJAX_CODEFILE).isEmpty())
    {
      g_mathjax_code=fileToString(Config_getString(MATHJAX_CODEFILE));
      //printf("g_mathjax_code='%s'\n",qPrint(g_mathjax_code));
    }
    g_latex_macro=getConvertLatexMacro();
    //printf("converted g_latex_macro='%s'\n",qPrint(g_latex_macro));
  }
  createSubDirs(d);
 
  fillColorStyleMaps();
 
  ResourceMgr &mgr = ResourceMgr::instance();
 
  {
    QCString tabsCss;
    if (Config_getBool(HTML_DYNAMIC_MENUS))
    {
      tabsCss = mgr.getAsString("tabs.css");
    }
    else // stylesheet for the 'old' static tabs
    {
      tabsCss = mgr.getAsString("fixed_tabs.css");
    }
 
    std::ofstream f = Portable::openOutputStream(dname+"/tabs.css");
    if (f.is_open())
    {
      TextStream t(&f);
      t << replaceVariables(tabsCss);
    }
  }
 
 
  if (Config_getBool(INTERACTIVE_SVG))
  {
    mgr.copyResource("svg.min.js",dname);
  }
 
  if (!Config_getBool(DISABLE_INDEX) && Config_getBool(HTML_DYNAMIC_MENUS))
  {
    mgr.copyResource("menu.js",dname);
  }
 
  // copy navtree.css
  {
    std::ofstream f = Portable::openOutputStream(dname+"/navtree.css");
    if (f.is_open())
    {
      TextStream t(&f);
      t << getNavTreeCss();
    }
  }
 
  if (Config_getBool(HTML_COPY_CLIPBOARD))
  {
    std::ofstream f = Portable::openOutputStream(dname+"/clipboard.js");
    if (f.is_open())
    {
      TextStream t(&f);
      t << substitute(mgr.getAsString("clipboard.js"),"$copy_to_clipboard_text",theTranslator->trCopyToClipboard());
    }
  }
 
  bool hasCookie = Config_getBool(GENERATE_TREEVIEW) || Config_getBool(SEARCHENGINE) || Config_getEnum(HTML_COLORSTYLE)==HTML_COLORSTYLE_t::TOGGLE;
  if (hasCookie)
  {
    mgr.copyResource("cookie.js",dname);
  }
 
  if (Config_getBool(HTML_COLORSTYLE)==HTML_COLORSTYLE_t::TOGGLE)
  {
    std::ofstream f = Portable::openOutputStream(dname+"/darkmode_toggle.js");
    if (f.is_open())
    {
      TextStream t(&f);
      t << substitute(replaceColorMarkers(mgr.getAsString("darkmode_toggle.js")),
          "$PROJECTID",getProjectId());
    }
  }
 
  if (Config_getBool(HTML_DYNAMIC_SECTIONS))
  {
    std::ofstream f = Portable::openOutputStream(dname+"/dynsections.js");
    if (f.is_open())
    {
      TextStream t(&f);
      t << replaceVariables(mgr.getAsString("dynsections.js"));
      if (Config_getBool(SOURCE_BROWSER) && Config_getBool(SOURCE_TOOLTIPS))
      {
        t << replaceVariables(mgr.getAsString("dynsections_tooltips.js"));
      }
    }
  }
  if (Config_getBool(HTML_CODE_FOLDING))
  {
    std::ofstream f = Portable::openOutputStream(dname+"/codefolding.js");
    if (f.is_open())
    {
      TextStream t(&f);
      t << replaceVariables(mgr.getAsString("codefolding.js"));
    }
  }
}

References checkBlocks(), Config_getBool, Config_getEnum, Config_getString, ResourceMgr::copyResource(), createSubDirs(), Dir::exists(), fileToString(), fillColorStyleMaps(), g_build_date, g_footer, g_footer_file, g_header, g_header_file, g_latex_macro, g_mathjax_code, ResourceMgr::getAsString(), getConvertLatexMacro(), getNavTreeCss(), getProjectId(), hasDateReplacement(), htmlMarkerInfo, ResourceMgr::instance(), Dir::mkdir(), Portable::openOutputStream(), replaceColorMarkers(), replaceVariables(), QCString::str(), substitute(), substituteHtmlKeywords(), term, and theTranslator.

Referenced by generateOutput().

insertMemberAlign()

void HtmlGenerator::insertMemberAlign ( bool )

overridevirtual

Implements OutputGenIntf.

Definition at line 2196 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- insertMemberAlign -->\n")
  m_t << "&#160;</td><td class=\"memItemRight\">";
}

References DBG_HTML, and OutputGenerator::m_t.

Referenced by endMemberItem().

insertMemberAlignLeft()

void HtmlGenerator::insertMemberAlignLeft ( MemberItemType type, bool initTag )

overridevirtual

Implements OutputGenIntf.

Definition at line 2202 of file htmlgen.cpp.

{
  if (!initTag) m_t << "&#160;</td>";
  switch (type)
  {
    case MemberItemType::Normal:         m_t << "<td class=\"memItemLeft\">"; break;
    case MemberItemType::AnonymousStart: m_t << "<td class=\"memItemLeft anon\">"; break;
    case MemberItemType::AnonymousEnd:   m_t << "<td class=\"memItemLeft anonEnd\">"; break;
    case MemberItemType::Templated:      m_t << "<td class=\"memTemplParams\" colspan=\"2\">"; break;
  }
}

References OutputGenerator::AnonymousEnd, OutputGenerator::AnonymousStart, OutputGenerator::m_t, OutputGenerator::Normal, OutputGenerator::Templated, and type().

Referenced by startMemberItem().

lastIndexPage()

void HtmlGenerator::lastIndexPage ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 288 of file htmlgen.h.

{}

lineBreak()

void HtmlGenerator::lineBreak ( const QCString & style )

overridevirtual

Implements OutputGenIntf.

Definition at line 3447 of file htmlgen.cpp.

{
  if (!style.isEmpty())
  {
    m_t << "<br class=\"" << style << "\" />\n";
  }
  else
  {
    m_t << "<br />\n";
  }
}

References QCString::isEmpty(), and OutputGenerator::m_t.

operator=() [1/2]

HtmlGenerator & HtmlGenerator::operator=

(

const HtmlGenerator &

og

)

Definition at line 1163 of file htmlgen.cpp.

{
  //printf("%p:HtmlGenerator(copy assign %p)\n",(void*)this,(void*)&og);
  if (this!=&og)
  {
    m_dir          = og.m_dir;
    m_codeList     = std::make_unique<OutputCodeList>(*og.m_codeList);
    m_codeGen      = m_codeList->get<HtmlCodeGenerator>(OutputType::Html);
    m_codeGen->setTextStream(&m_t);
    m_lastTitle    = og.m_lastTitle;
    m_lastFile     = og.m_lastFile;
    m_relPath      = og.m_relPath;
    m_sectionCount = og.m_sectionCount;
    m_emptySection = og.m_emptySection;
  }
  return *this;
}

References Html, HtmlGenerator(), m_codeGen, m_codeList, OutputGenerator::m_dir, m_emptySection, m_lastFile, m_lastTitle, m_relPath, m_sectionCount, and OutputGenerator::m_t.

operator=() [2/2]

HtmlGenerator & HtmlGenerator::operator= ( HtmlGenerator && )

delete

References HtmlGenerator().

startAnonTypeScope()

void HtmlGenerator::startAnonTypeScope ( int )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 184 of file htmlgen.h.

{}

startBold()

void HtmlGenerator::startBold ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 215 of file htmlgen.h.

{ m_t << "<b>"; }

References OutputGenerator::m_t.

startCallGraph()

void HtmlGenerator::startCallGraph ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2582 of file htmlgen.cpp.

{
  startSectionHeader(m_t,m_relPath,m_sectionCount);
}

References m_relPath, m_sectionCount, OutputGenerator::m_t, and startSectionHeader().

startCenter()

void HtmlGenerator::startCenter ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 233 of file htmlgen.h.

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

References OutputGenerator::m_t.

startClassDiagram()

void HtmlGenerator::startClassDiagram ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2083 of file htmlgen.cpp.

{
  startSectionHeader(m_t,m_relPath,m_sectionCount);
}

References m_relPath, m_sectionCount, OutputGenerator::m_t, and startSectionHeader().

startCompoundTemplateParams()

void HtmlGenerator::startCompoundTemplateParams ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2186 of file htmlgen.cpp.

{
  m_t << "<div class=\"compoundTemplParams\">";
}

References OutputGenerator::m_t.

startConstraintDocs()

void HtmlGenerator::startConstraintDocs ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3429 of file htmlgen.cpp.

{
  m_t << "<td>&#160;";
}

References OutputGenerator::m_t.

startConstraintList()

void HtmlGenerator::startConstraintList ( const QCString & header )

overridevirtual

Implements OutputGenIntf.

Definition at line 3402 of file htmlgen.cpp.

{
  m_t << "<div class=\"typeconstraint\">\n";
  m_t << "<dl><dt><b>" << header << "</b></dt><dd>\n";
  m_t << "<table border=\"0\" cellspacing=\"2\" cellpadding=\"0\">\n";
}

References OutputGenerator::m_t.

startConstraintParam()

void HtmlGenerator::startConstraintParam ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3409 of file htmlgen.cpp.

{
  m_t << "<tr><td valign=\"top\"><em>";
}

References OutputGenerator::m_t.

startConstraintType()

void HtmlGenerator::startConstraintType ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3419 of file htmlgen.cpp.

{
  m_t << "<td>&#160;:</td><td valign=\"top\"><em>";
}

References OutputGenerator::m_t.

startContents()

void HtmlGenerator::startContents ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3171 of file htmlgen.cpp.

{
  m_t << "<div class=\"contents\">\n";
}

References OutputGenerator::m_t.

startDescForItem()

void HtmlGenerator::startDescForItem ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 217 of file htmlgen.h.

{ m_t << "<dd>"; }

References OutputGenerator::m_t.

startDescTable()

void HtmlGenerator::startDescTable ( const QCString & title, const bool hasInits )

overridevirtual

Implements OutputGenIntf.

Definition at line 2676 of file htmlgen.cpp.

{
  m_t << "<table class=\"fieldtable\">\n"
      << "<tr><th colspan=\"" << (hasInits?3:2) << "\">" << title << "</th></tr>";
}

References OutputGenerator::m_t.

startDescTableData()

void HtmlGenerator::startDescTableData ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2716 of file htmlgen.cpp.

{
  m_t << "<td class=\"fielddoc\">";
}

References OutputGenerator::m_t.

startDescTableInit()

void HtmlGenerator::startDescTableInit ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2706 of file htmlgen.cpp.

{
  m_t << "<td class=\"fieldinit\">";
}

References OutputGenerator::m_t.

startDescTableRow()

void HtmlGenerator::startDescTableRow ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2686 of file htmlgen.cpp.

{
  m_t << "<tr>";
}

References OutputGenerator::m_t.

startDescTableTitle()

void HtmlGenerator::startDescTableTitle ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2696 of file htmlgen.cpp.

{
  m_t << "<td class=\"fieldname\">";
}

References OutputGenerator::m_t.

startDirDepGraph()

void HtmlGenerator::startDirDepGraph ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2600 of file htmlgen.cpp.

{
  startSectionHeader(m_t,m_relPath,m_sectionCount);
}

References m_relPath, m_sectionCount, OutputGenerator::m_t, and startSectionHeader().

startDotGraph()

void HtmlGenerator::startDotGraph ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2512 of file htmlgen.cpp.

{
  startSectionHeader(m_t,m_relPath,m_sectionCount);
}

References m_relPath, m_sectionCount, OutputGenerator::m_t, and startSectionHeader().

startDoxyAnchor()

void HtmlGenerator::startDoxyAnchor ( const QCString & fName, const QCString & manName, const QCString & anchor, const QCString & name, const QCString & args )

overridevirtual

Implements OutputGenIntf.

Definition at line 1753 of file htmlgen.cpp.

{
  m_t << "<a id=\"" << anchor << "\" name=\"" << anchor << "\"></a>";
}

References OutputGenerator::m_t.

startEmbeddedDoc()

void HtmlGenerator::startEmbeddedDoc ( int indent )

overridevirtual

Implements OutputGenIntf.

Definition at line 3547 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- startEmbeddedDoc -->\n";)
  m_t << "<div class=\"embeddoc\" style=\"margin-left:" << indent << "ch;\">";
}

References DBG_HTML, and OutputGenerator::m_t.

startEmphasis()

void HtmlGenerator::startEmphasis ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 213 of file htmlgen.h.

{ m_t << "<em>";  }

References OutputGenerator::m_t.

startExamples()

void HtmlGenerator::startExamples ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2726 of file htmlgen.cpp.

{
  m_t << "<dl class=\"section examples\"><dt>";
  docify(theTranslator->trExamples());
  m_t << "</dt>";
}

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

startFile()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 1548 of file htmlgen.cpp.

{
  //printf("HtmlGenerator::startFile(%s)\n",qPrint(name));
  m_relPath = relativePathToRoot(name);
  QCString fileName = name;
  addHtmlExtensionIfMissing(fileName);
  m_lastTitle=title;
 
  startPlainFile(fileName);
  m_codeGen->setFileName(fileName);
  m_codeGen->setRelativePath(m_relPath);
  {
    std::lock_guard<std::mutex> lock(g_indexLock);
    Doxygen::indexList->addIndexFile(fileName);
  }
 
  m_lastFile = fileName;
  m_t << substituteHtmlKeywords(g_header_file,g_header,convertToHtml(filterTitle(title)),m_relPath,QCString(),isSource);
 
  m_t << "<!-- " << theTranslator->trGeneratedBy() << " Doxygen "
      << getDoxygenVersion() << " -->\n";
  bool searchEngine = Config_getBool(SEARCHENGINE);
  if (searchEngine /*&& !generateTreeView*/)
  {
    m_t << "<script type=\"text/javascript\">\n";
    m_t << "let searchBox = new SearchBox(\"searchBox\", \""
        << m_relPath<< "search/\",'" << Doxygen::htmlFileExtension << "');\n";
    m_t << "</script>\n";
  }
  if (Config_getBool(HTML_CODE_FOLDING))
  {
    m_t << "<script type=\"text/javascript\">\n";
    m_t << "document.addEventListener('DOMContentLoaded', codefold.init);\n";
    m_t << "</script>\n";
  }
  m_sectionCount=0;
}

References addHtmlExtensionIfMissing(), Config_getBool, convertToHtml(), OutputGenerator::fileName(), filterTitle(), g_header, g_header_file, g_indexLock, Doxygen::htmlFileExtension, Doxygen::indexList, m_codeGen, m_lastFile, m_lastTitle, m_relPath, m_sectionCount, OutputGenerator::m_t, relativePathToRoot(), startPlainFile(), substituteHtmlKeywords(), and theTranslator.

startGroupCollaboration()

void HtmlGenerator::startGroupCollaboration ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2564 of file htmlgen.cpp.

{
  startSectionHeader(m_t,m_relPath,m_sectionCount);
}

References m_relPath, m_sectionCount, OutputGenerator::m_t, and startSectionHeader().

startGroupHeader()

void HtmlGenerator::startGroupHeader ( const QCString & id, int extraIndentLevel )

overridevirtual

Implements OutputGenIntf.

Definition at line 1892 of file htmlgen.cpp.

{
  if (extraIndentLevel==2)
  {
    m_t << "<h4";
  }
  else if (extraIndentLevel==1)
  {
    m_t << "<h3";
  }
  else // extraIndentLevel==0
  {
    m_t << "<h2";
  }
  if (!id.isEmpty())
  {
    m_t <<" id=\"header-"+convertToId(id)+"\"";
  }
  m_t << " class=\"groupheader\">";
}

References convertToId(), and OutputGenerator::m_t.

startHeaderSection()

void HtmlGenerator::startHeaderSection ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3459 of file htmlgen.cpp.

{
  m_t << "<div class=\"header\">\n";
}

References OutputGenerator::m_t.

startInclDepGraph()

void HtmlGenerator::startInclDepGraph ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2546 of file htmlgen.cpp.

{
  startSectionHeader(m_t,m_relPath,m_sectionCount);
}

References m_relPath, m_sectionCount, OutputGenerator::m_t, and startSectionHeader().

startIndent()

void HtmlGenerator::startIndent ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2651 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- startIndent -->\n";)
 
  m_t << "<div class=\"memdoc\">\n";
}

References DBG_HTML, and OutputGenerator::m_t.

startIndexItem()

void HtmlGenerator::startIndexItem ( const QCString & ref, const QCString & file )

overridevirtual

Implements OutputGenIntf.

Definition at line 1796 of file htmlgen.cpp.

{
  //printf("HtmlGenerator::startIndexItem(%s,%s)\n",ref,f);
  if (!ref.isEmpty() || !f.isEmpty())
  {
    if (!ref.isEmpty())
    {
      m_t << "<a class=\"elRef\" ";
      m_t << externalLinkTarget();
    }
    else
    {
      m_t << "<a class=\"el\" ";
    }
    m_t << "href=\"";
    m_t << externalRef(m_relPath,ref,TRUE);
    if (!f.isEmpty())
    {
      QCString fn=f;
      addHtmlExtensionIfMissing(fn);
      m_t << fn;
    }
    m_t << "\">";
  }
  else
  {
    m_t << "<b>";
  }
}

References addHtmlExtensionIfMissing(), externalLinkTarget(), externalRef(), QCString::isEmpty(), m_relPath, OutputGenerator::m_t, and TRUE.

startIndexKey()

void HtmlGenerator::startIndexKey ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2316 of file htmlgen.cpp.

{
  //m_t << "  <tr><td class=\"indexkey\">";
}

startIndexList()

void HtmlGenerator::startIndexList ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2306 of file htmlgen.cpp.

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

References OutputGenerator::m_t.

startIndexListItem()

void HtmlGenerator::startIndexListItem ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1786 of file htmlgen.cpp.

{
  m_t << "<li>";
}

References OutputGenerator::m_t.

startIndexSection()

void HtmlGenerator::startIndexSection ( IndexSection )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 132 of file htmlgen.h.

{}

startIndexValue()

void HtmlGenerator::startIndexValue ( bool )

overridevirtual

Implements OutputGenIntf.

Definition at line 2326 of file htmlgen.cpp.

{
  //m_t << "<td class=\"indexvalue\">";
}

startInlineHeader()

void HtmlGenerator::startInlineHeader ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3481 of file htmlgen.cpp.

{
  if (m_emptySection)
  {
    m_t << "<table class=\"memberdecls\">\n";
    m_emptySection=FALSE;
  }
  m_t << "<tr><td colspan=\"2\"><h3>";
}

References FALSE, m_emptySection, and OutputGenerator::m_t.

startInlineMemberDoc()

void HtmlGenerator::startInlineMemberDoc ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3535 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- startInlineMemberDoc -->\n";)
  m_t << "<td class=\"fielddoc\">\n";
}

References DBG_HTML, and OutputGenerator::m_t.

startInlineMemberName()

void HtmlGenerator::startInlineMemberName ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3523 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- startInlineMemberName -->\n";)
  m_t << "<td class=\"fieldname\">\n";
}

References DBG_HTML, and OutputGenerator::m_t.

startInlineMemberType()

void HtmlGenerator::startInlineMemberType ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3511 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- startInlineMemberType -->\n";)
  m_t << "<tr><td class=\"fieldtype\">\n";
}

References DBG_HTML, and OutputGenerator::m_t.

startItemList()

void HtmlGenerator::startItemList ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 152 of file htmlgen.h.

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

References OutputGenerator::m_t.

startItemListItem()

void HtmlGenerator::startItemListItem ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 167 of file htmlgen.h.

{ m_t << "<li>"; }

References OutputGenerator::m_t.

startLabels()

void HtmlGenerator::startLabels ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3559 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- startLabels -->\n";)
  m_t << "<span class=\"mlabels\">";
}

References DBG_HTML, and OutputGenerator::m_t.

startLocalToc()

void HtmlGenerator::startLocalToc ( int level )

overridevirtual

Implements OutputGenIntf.

Definition at line 3698 of file htmlgen.cpp.

{
  m_tocState.level=0;
  m_tocState.indent=0;
  m_tocState.maxLevel=level;
  m_tocState.inLi = BoolVector(level+1,false);
  m_t << "<div class=\"toc\">";
  m_t << "<h3>" << theTranslator->trRTFTableOfContents() << "</h3>\n";
}

References OutputGenerator::m_t, m_tocState, and theTranslator.

startMemberDeclaration()

void HtmlGenerator::startMemberDeclaration ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 204 of file htmlgen.h.

{}

startMemberDescription()

void HtmlGenerator::startMemberDescription ( const QCString & anchor, const QCString & inheritId, bool typ )

overridevirtual

Implements OutputGenIntf.

Definition at line 2214 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- startMemberDescription -->\n")
  bool dynamicSections = Config_getBool(HTML_DYNAMIC_SECTIONS);
  if (m_emptySection)
  {
    m_t << "<table class=\"memberdecls\">\n";
    m_emptySection=FALSE;
  }
  m_t << "<tr class=\"memdesc:" << anchor;
  if (!inheritId.isEmpty())
  {
    if (dynamicSections) m_t << " inherit";
    m_t << " " << inheritId;
  }
  m_t << "\">";
  m_t << "<td class=\"mdescLeft\">&#160;</td>";
  if (typ) m_t << "<td class=\"mdescLeft\">&#160;</td>";
  m_t << "<td class=\"mdescRight\">";
}

References Config_getBool, DBG_HTML, FALSE, QCString::isEmpty(), m_emptySection, and OutputGenerator::m_t.

startMemberDoc()

void HtmlGenerator::startMemberDoc ( const QCString & clName, const QCString & memName, const QCString & anchor, const QCString & title, int memCount, int memTotal, bool showInline )

overridevirtual

Implements OutputGenIntf.

Definition at line 2346 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- startMemberDoc -->\n";)
  m_t << "\n<h2 class=\"memtitle\">"
      << "<span class=\"permalink\"><a href=\"#" << anchor << "\">&#9670;&#160;</a></span>";
  docify(title);
  if (memTotal>1)
  {
    m_t << " <span class=\"overload\">[" << memCount << "/" << memTotal <<"]</span>";
  }
  m_t << "</h2>\n";
  m_t << "\n<div class=\"memitem\">\n";
  m_t << "<div class=\"memproto\">\n";
}

References DBG_HTML, docify(), and OutputGenerator::m_t.

startMemberDocList()

void HtmlGenerator::startMemberDocList ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2336 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- startMemberDocList -->\n";)
}

References DBG_HTML, and OutputGenerator::m_t.

startMemberDocName()

void HtmlGenerator::startMemberDocName ( bool )

overridevirtual

Implements OutputGenIntf.

Definition at line 2375 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- startMemberDocName -->\n";)
 
  m_t << "      <table class=\"memname\">\n";
 
  m_t << "        <tr>\n";
  m_t << "          <td class=\"memname\">";
}

References DBG_HTML, and OutputGenerator::m_t.

startMemberDocPrefixItem()

void HtmlGenerator::startMemberDocPrefixItem ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2363 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- startMemberDocPrefixItem -->\n";)
  m_t << "<div class=\"memtemplate\">\n";
}

References DBG_HTML, and OutputGenerator::m_t.

startMemberDocSimple()

void HtmlGenerator::startMemberDocSimple ( bool isEnum )

overridevirtual

Implements OutputGenIntf.

Definition at line 3496 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- startMemberDocSimple -->\n";)
  m_t << "<table class=\"fieldtable\">\n";
  m_t << "<tr><th colspan=\"" << (isEnum?"2":"3") << "\">";
  m_t << (isEnum? theTranslator->trEnumerationValues() :
       theTranslator->trCompoundMembers()) << "</th></tr>\n";
}

References DBG_HTML, OutputGenerator::m_t, and theTranslator.

startMemberGroup()

void HtmlGenerator::startMemberGroup ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2643 of file htmlgen.cpp.

{
}

startMemberGroupDocs()

void HtmlGenerator::startMemberGroupDocs ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2633 of file htmlgen.cpp.

{
  m_t << "<tr><td colspan=\"2\" class=\"ititle\"><div class=\"groupText\">";
}

References OutputGenerator::m_t.

startMemberGroupHeader()

void HtmlGenerator::startMemberGroupHeader ( const QCString & id, bool  )

overridevirtual

Implements OutputGenIntf.

Definition at line 2623 of file htmlgen.cpp.

{
  m_t << "<tr id=\"" << id << "\" class=\"groupHeader\"><td colspan=\"2\"><div class=\"groupHeader\">";
}

References OutputGenerator::m_t.

startMemberHeader()

void HtmlGenerator::startMemberHeader ( const QCString & anchor, int typ )

overridevirtual

Implements OutputGenIntf.

Definition at line 2258 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- startMemberHeader -->\n")
  if (!m_emptySection)
  {
    m_t << "</table>";
    m_emptySection=TRUE;
  }
  if (m_emptySection)
  {
    m_t << "<table class=\"memberdecls\">\n";
    m_emptySection=FALSE;
  }
  m_t << "<tr class=\"heading\"><td colspan=\"" << typ << "\"><h2";
  if (!anchor.isEmpty())
  {
    m_t << " id=\"header-" << anchor << "\"";
  }
  m_t << " class=\"groupheader\">";
  if (!anchor.isEmpty())
  {
    m_t << "<a id=\"" << anchor << "\" name=\"" << anchor << "\"></a>\n";
  }
}

References DBG_HTML, FALSE, QCString::isEmpty(), m_emptySection, OutputGenerator::m_t, and TRUE.

startMemberItem()

void HtmlGenerator::startMemberItem ( const QCString & anchor, MemberItemType type, const QCString & inheritId )

overridevirtual

Implements OutputGenIntf.

Definition at line 2136 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- startMemberItem() -->\n")
  bool dynamicSections = Config_getBool(HTML_DYNAMIC_SECTIONS);
  if (m_emptySection)
  {
    m_t << "<table class=\"memberdecls\">\n";
    m_emptySection=FALSE;
  }
  m_t << "<tr class=\"memitem:" << convertToId(anchor);
  if (!inheritId.isEmpty())
  {
    if (dynamicSections) m_t << " inherit";
    m_t << " " << inheritId;
  }
  m_t << "\"";
  if (!anchor.isEmpty())
  {
    m_t << " id=\"r_" << convertToId(anchor) << "\"";
  }
  m_t << ">";
  insertMemberAlignLeft(type, true);
}

References Config_getBool, convertToId(), DBG_HTML, FALSE, insertMemberAlignLeft(), QCString::isEmpty(), m_emptySection, OutputGenerator::m_t, and type().

startMemberList()

void HtmlGenerator::startMemberList ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2122 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- startMemberList -->\n")
}

References DBG_HTML, and OutputGenerator::m_t.

startMemberSections()

void HtmlGenerator::startMemberSections ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2241 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- startMemberSections -->\n")
  m_emptySection=TRUE; // we postpone writing <table> until we actually
                       // write a row to prevent empty tables, which
                       // are not valid XHTML!
}

References DBG_HTML, m_emptySection, OutputGenerator::m_t, and TRUE.

startMemberSubtitle()

void HtmlGenerator::startMemberSubtitle ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2289 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- startMemberSubtitle -->\n")
  if (m_emptySection)
  {
    m_t << "<table class=\"memberdecls\">\n";
    m_emptySection=FALSE;
  }
  m_t << "<tr><td class=\"ititle\" colspan=\"2\">";
}

References DBG_HTML, FALSE, m_emptySection, and OutputGenerator::m_t.

startMemberTemplateParams()

void HtmlGenerator::startMemberTemplateParams ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2169 of file htmlgen.cpp.

{
}

startPageDoc()

void HtmlGenerator::startPageDoc ( const QCString & pageTitle )

overridevirtual

Implements OutputGenIntf.

Definition at line 3181 of file htmlgen.cpp.

{
  m_t << "<div>";
}

References OutputGenerator::m_t.

startPageRef()

void HtmlGenerator::startPageRef ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 247 of file htmlgen.h.

{}

startParagraph()

void HtmlGenerator::startParagraph ( const QCString & classDef )

overridevirtual

Implements OutputGenIntf.

Definition at line 1768 of file htmlgen.cpp.

{
  if (!classDef.isEmpty())
    m_t << "\n<p class=\"" << classDef << "\">";
  else
    m_t << "\n<p>";
}

References QCString::isEmpty(), and OutputGenerator::m_t.

startParameterDefVal()

void HtmlGenerator::startParameterDefVal ( const char * sep )

overridevirtual

Implements OutputGenIntf.

Definition at line 2463 of file htmlgen.cpp.

{
  m_t << "<span class=\"paramdefsep\">";
  docify(s);
  m_t << "</span><span class=\"paramdefval\">";
}

References docify(), and OutputGenerator::m_t.

startParameterExtra()

void HtmlGenerator::startParameterExtra ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2434 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- startParameterExtra -->\n";)
}

References DBG_HTML, and OutputGenerator::m_t.

startParameterList()

void HtmlGenerator::startParameterList ( bool openBracket )

overridevirtual

Implements OutputGenIntf.

Definition at line 2391 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- startParameterList -->\n";)
  m_t << "          <td>";
  if (openBracket) m_t << "(";
  m_t << "</td>\n";
}

References DBG_HTML, and OutputGenerator::m_t.

startParameterName()

void HtmlGenerator::startParameterName ( bool )

overridevirtual

Implements OutputGenIntf.

Definition at line 2422 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- startParameterName -->\n";)
  m_t << "          <td class=\"paramname\"><span class=\"paramname\"><em>";
}

References DBG_HTML, and OutputGenerator::m_t.

startParameterType()

void HtmlGenerator::startParameterType ( bool first, const QCString & key )

overridevirtual

Implements OutputGenIntf.

Definition at line 2399 of file htmlgen.cpp.

{
  if (first)
  {
    DBG_HTML(m_t << "<!-- startFirstParameterType -->\n";)
    m_t << "          <td class=\"paramtype\">";
  }
  else
  {
    DBG_HTML(m_t << "<!-- startParameterType -->\n";)
    m_t << "        <tr>\n";
    m_t << "          <td class=\"paramkey\">" << key << "</td>\n";
    m_t << "          <td></td>\n";
    m_t << "          <td class=\"paramtype\">";
  }
}

References DBG_HTML, and OutputGenerator::m_t.

startPlainFile()

void HtmlGenerator::startPlainFile ( const QCString & name )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 333 of file htmlgen.h.

{ OutputGenerator::startPlainFile(name); }

References OutputGenerator::startPlainFile().

Referenced by startFile(), and writeStyleInfo().

startProjectNumber()

void HtmlGenerator::startProjectNumber ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1666 of file htmlgen.cpp.

{
  m_t << "<h3 class=\"version\">";
}

References OutputGenerator::m_t.

startQuickIndices()

void HtmlGenerator::startQuickIndices ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 249 of file htmlgen.h.

{}

startSection()

void HtmlGenerator::startSection ( const QCString & lab, const QCString & , SectionType type )

overridevirtual

Implements OutputGenIntf.

Definition at line 1929 of file htmlgen.cpp.

{
  switch(type.level())
  {
    case SectionType::Page:             m_t << "\n\n<h1 class=\"doxsection\">"; break;
    case SectionType::Section:          m_t << "\n\n<h2 class=\"doxsection\">"; break;
    case SectionType::Subsection:       m_t << "\n\n<h3 class=\"doxsection\">"; break;
    case SectionType::Subsubsection:    m_t << "\n\n<h4 class=\"doxsection\">"; break;
    case SectionType::Paragraph:        m_t << "\n\n<h5 class=\"doxsection\">"; break;
    case SectionType::Subparagraph:     m_t << "\n\n<h6 class=\"doxsection\">"; break;
    case SectionType::Subsubparagraph:  m_t << "\n\n<h6 class=\"doxsection\">"; break;
    default: ASSERT(0); break;
  }
  m_t << "<a id=\"" << lab << "\" name=\"" << lab << "\"></a>";
}

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

startSmall()

void HtmlGenerator::startSmall ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 235 of file htmlgen.h.

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

References OutputGenerator::m_t.

startTextBlock()

void HtmlGenerator::startTextBlock ( bool )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 286 of file htmlgen.h.

{ m_t << "<div class=\"textblock\">"; }

References OutputGenerator::m_t.

startTextLink()

void HtmlGenerator::startTextLink ( const QCString & file, const QCString & anchor )

overridevirtual

Implements OutputGenIntf.

Definition at line 1875 of file htmlgen.cpp.

{
  m_t << "<a href=\"";
  QCString fn = f;
  addHtmlExtensionIfMissing(fn);
  m_t << createHtmlUrl(m_relPath,"",true,
                       fileName() == Config_getString(HTML_OUTPUT)+"/"+fn,
                       fn,
                       anchor);
  m_t << "\">";
}

References addHtmlExtensionIfMissing(), Config_getString, createHtmlUrl(), OutputGenerator::fileName(), m_relPath, and OutputGenerator::m_t.

startTitle()

void HtmlGenerator::startTitle ( )

inlineprivate

Definition at line 340 of file htmlgen.h.

{ m_t << "<div class=\"title\">"; }

References OutputGenerator::m_t.

Referenced by startTitleHead().

startTitleHead()

void HtmlGenerator::startTitleHead ( const QCString & )

overridevirtual

Implements OutputGenIntf.

Definition at line 3464 of file htmlgen.cpp.

{
  m_t << "  <div class=\"headertitle\">";
  startTitle();
}

References OutputGenerator::m_t, and startTitle().

startTocEntry()

void HtmlGenerator::startTocEntry ( const SectionInfo * si )

overridevirtual

Implements OutputGenIntf.

Definition at line 3720 of file htmlgen.cpp.

{
  SectionType type = si->type();
  if (type.isSection())
  {
    //printf("  level=%d title=%s maxLevel=%d\n",level,qPrint(si->title()),maxLevel);
    int nextLevel = type.level();
    if (nextLevel>m_tocState.level)
    {
      for (int l=m_tocState.level;l<nextLevel;l++)
      {
        if (l < m_tocState.maxLevel)
        {
          m_tocState.incIndent(m_t,"<ul>");
          char cs[2] = { static_cast<char>('0'+l+1), 0 };
          const char *empty = (l!=nextLevel-1) ? " empty" : "";
          m_tocState.incIndent(m_t,"<li class=\"level" + QCString(cs) + empty + "\">");
        }
      }
    }
    else if (nextLevel<m_tocState.level)
    {
      for (int l=m_tocState.level;l>nextLevel;l--)
      {
        if (l <= m_tocState.maxLevel) m_tocState.decIndent(m_t,"</li>");
        m_tocState.inLi[l] = false;
        if (l <= m_tocState.maxLevel) m_tocState.decIndent(m_t,"</ul>");
      }
    }
    if (nextLevel <= m_tocState.maxLevel)
    {
      if (m_tocState.inLi[nextLevel] || m_tocState.level>nextLevel)
      {
        m_tocState.decIndent(m_t,"</li>");
        char cs[2] = { static_cast<char>('0'+nextLevel), 0 };
        m_tocState.incIndent(m_t,"<li class=\"level" + QCString(cs) + "\">");
      }
      QCString label = si->label();
      m_tocState.writeIndent(m_t);
      m_t  << "<a href=\"#"+label+"\">";
    }
  }
}

References SectionInfo::label(), OutputGenerator::m_t, m_tocState, type(), and SectionInfo::type().

startTypewriter()

void HtmlGenerator::startTypewriter ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 163 of file htmlgen.h.

{ m_t << "<code>"; }

References OutputGenerator::m_t.

type()

OutputType HtmlGenerator::type ( ) const

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 121 of file htmlgen.h.

{ return OutputType::Html; }

References Html.

Referenced by endMemberItem(), endSection(), endTocEntry(), insertMemberAlignLeft(), startMemberItem(), startSection(), and startTocEntry().

writeAnchor()

void HtmlGenerator::writeAnchor ( const QCString & , const QCString & name )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 211 of file htmlgen.h.

                                  { m_t << "<a name=\"" << name <<"\" id=\"" << name << "\"></a>"; }

References OutputGenerator::m_t.

writeChar()

void HtmlGenerator::writeChar ( char c )

overridevirtual

Implements OutputGenIntf.

Definition at line 2002 of file htmlgen.cpp.

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

References docify().

writeDoc()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 2738 of file htmlgen.cpp.

{
  const DocNodeAST *astImpl = dynamic_cast<const DocNodeAST*>(ast);
  if (astImpl && sectionLevel<=m_tocState.maxLevel)
  {
    m_codeList->setId(id);
    HtmlDocVisitor visitor(m_t,*m_codeList,ctx,fileName());
    std::visit(visitor,astImpl->root);
  }
}

References OutputGenerator::fileName(), m_codeList, OutputGenerator::m_t, m_tocState, and DocNodeAST::root.

writeExternalSearchPage()

void HtmlGenerator::writeExternalSearchPage ( )

static

Definition at line 3296 of file htmlgen.cpp.

{
  bool disableIndex            = Config_getBool(DISABLE_INDEX);
  bool generateTreeView        = Config_getBool(GENERATE_TREEVIEW);
  bool fullSidebar             = Config_getBool(FULL_SIDEBAR);
  bool quickLinksAfterSplitbar = !disableIndex && generateTreeView && fullSidebar;
  QCString dname               = Config_getString(HTML_OUTPUT);
  QCString fileName            = dname+"/search"+Doxygen::htmlFileExtension;
  std::ofstream f = Portable::openOutputStream(fileName);
  if (f.is_open())
  {
    TextStream t(&f);
    t << substituteHtmlKeywords(g_header_file,g_header,"Search","");
 
    t << "<!-- " << theTranslator->trGeneratedBy() << " Doxygen "
      << getDoxygenVersion() << " -->\n";
    t << "<script type=\"text/javascript\">\n";
    t << "let searchBox = new SearchBox(\"searchBox\", \""
      << "search/\",'" << Doxygen::htmlFileExtension << "');\n";
    t << "</script>\n";
 
    if (!disableIndex && !quickLinksAfterSplitbar)
    {
      writeDefaultQuickLinks(t,HighlightedItem::Search,QCString(),QCString(),false);
    }
    if (generateTreeView)
    {
      t << "</div><!-- top -->\n";
    }
    t << writeSplitBarAsString("search.php",QCString(),QCString());
    if (quickLinksAfterSplitbar)
    {
      writeDefaultQuickLinks(t,HighlightedItem::Search,QCString(),QCString(),false);
    }
 
    t << "<div class=\"header\">\n";
    t << "  <div class=\"headertitle\">\n";
    t << "    <div class=\"title\">" << theTranslator->trSearchResultsTitle() << "</div>\n";
    t << "  </div>\n";
    t << "</div>\n";
    t << "<div class=\"contents\">\n";
 
    t << "<div id=\"searchresults\"></div>\n";
    t << "</div>\n";
 
    if (generateTreeView)
    {
      t << "</div><!-- doc-content -->\n";
      t << "</div><!-- container -->\n";
    }
 
    writePageFooter(t,"Search","","");
 
  }
  f.close();
 
  QCString scriptName = dname+"/search/search.js";
  f = Portable::openOutputStream(scriptName);
  if (f.is_open())
  {
    TextStream t(&f);
    t << "const searchResultsText=["
      << "\"" << theTranslator->trSearchResults(0) << "\","
      << "\"" << theTranslator->trSearchResults(1) << "\","
      << "\"" << theTranslator->trSearchResults(2) << "\"];\n";
    t << "const serverUrl=\"" << Config_getString(SEARCHENGINE_URL) << "\";\n";
    t << "const tagMap = {\n";
    bool first=TRUE;
    // add search mappings
    const StringVector &extraSearchMappings = Config_getList(EXTRA_SEARCH_MAPPINGS);
    for (const auto &ml : extraSearchMappings)
    {
      QCString mapLine(ml);
      int eqPos = mapLine.find('=');
      if (eqPos!=-1) // tag command contains a destination
      {
        QCString tagName = mapLine.left(eqPos).stripWhiteSpace();
        QCString destName = mapLine.right(mapLine.length()-eqPos-1).stripWhiteSpace();
        if (!tagName.isEmpty())
        {
          if (!first) t << ",\n";
          t << "  \"" << tagName << "\": \"" << destName << "\"";
          first=FALSE;
        }
      }
    }
    if (!first) t << "\n";
    t << "};\n\n";
    t << ResourceMgr::instance().getAsString("extsearch.js");
    t << "\n";
    t << "document.addEventListener('DOMContentLoaded',() => {\n";
    t << "  const query = trim(getURLParameter('query'));\n";
    t << "  if (query) {\n";
    t << "    searchFor(query,0,20);\n";
    t << "  } else {\n";
    t << "    const results = document.getElementById('results');\n";
    t << "    results.innerHtml = '<p>" << theTranslator->trSearchResults(0) << "</p>';\n";
    t << "  }\n";
    t << "});\n";
  }
  else
  {
     err("Failed to open file '{}' for writing...\n",scriptName);
  }
}

References Config_getBool, Config_getList, Config_getString, err, FALSE, OutputGenerator::fileName(), QCString::find(), g_header, g_header_file, ResourceMgr::getAsString(), Doxygen::htmlFileExtension, ResourceMgr::instance(), QCString::isEmpty(), QCString::left(), QCString::length(), Portable::openOutputStream(), QCString::right(), Search, QCString::stripWhiteSpace(), substituteHtmlKeywords(), theTranslator, TRUE, writeDefaultQuickLinks(), writePageFooter(), and writeSplitBarAsString().

Referenced by generateOutput().

writeFooter()

void HtmlGenerator::writeFooter ( const QCString & navPath )

overridevirtual

Implements OutputGenIntf.

Definition at line 1656 of file htmlgen.cpp.

{
  writePageFooter(m_t,m_lastTitle,m_relPath,navPath);
}

References m_lastTitle, m_relPath, OutputGenerator::m_t, and writePageFooter().

writeFooterFile()

void HtmlGenerator::writeFooterFile ( TextStream & t )

static

Definition at line 1540 of file htmlgen.cpp.

{
  t << "<!-- HTML footer for doxygen " << getDoxygenVersion() << "-->\n";
  t << ResourceMgr::instance().getAsString("footer.html");
}

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

Referenced by readConfiguration().

writeGraphicalHierarchy()

void HtmlGenerator::writeGraphicalHierarchy ( DotGfxHierarchyTable & g )

overridevirtual

Implements OutputGenIntf.

Definition at line 2618 of file htmlgen.cpp.

{
  g.writeGraph(m_t,dir(),fileName());
}

References OutputGenerator::dir(), OutputGenerator::fileName(), OutputGenerator::m_t, and DotGfxHierarchyTable::writeGraph().

writeHeaderFile()

void HtmlGenerator::writeHeaderFile ( TextStream & t, const QCString & cssname )

static

Definition at line 1534 of file htmlgen.cpp.

{
  t << "<!-- HTML header for doxygen " << getDoxygenVersion() << "-->\n";
  t << ResourceMgr::instance().getAsString("header.html");
}

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

Referenced by readConfiguration().

writeInheritedSectionTitle()

void HtmlGenerator::writeInheritedSectionTitle ( const QCString & id, const QCString & ref, const QCString & file, const QCString & anchor, const QCString & title, const QCString & name )

overridevirtual

Implements OutputGenIntf.

Definition at line 3611 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- writeInheritedSectionTitle -->\n";)
  bool dynamicSections = Config_getBool(HTML_DYNAMIC_SECTIONS);
  QCString a = anchor;
  if (!a.isEmpty()) a.prepend("#");
  QCString classLink = QCString("<a class=\"el\" ");
  if (!ref.isEmpty())
  {
    classLink+= externalLinkTarget();
    classLink += " href=\"";
    classLink+= externalRef(m_relPath,ref,TRUE);
  }
  else
  {
    classLink += "href=\"";
    classLink+=m_relPath;
  }
  QCString fn = file;
  addHtmlExtensionIfMissing(fn);
  classLink=classLink+fn+a;
  classLink+=QCString("\">")+convertToHtml(name,FALSE)+"</a>";
  m_t << "<tr class=\"inherit_header " << id << "\">";
  if (dynamicSections) 
  {
    m_t << "<td colspan=\"2\" onclick=\"javascript:dynsection.toggleInherit('" << id << "')\">";
    m_t << "<span class=\"dynarrow\"><span class=\"arrowhead closed\"></span></span>";
  }
  else
  {
    m_t << "<td colspan=\"2\">";
  }
  m_t << theTranslator->trInheritedFrom(convertToHtml(title,FALSE),classLink)
    << "</td></tr>\n";
}

References addHtmlExtensionIfMissing(), Config_getBool, convertToHtml(), DBG_HTML, externalLinkTarget(), externalRef(), FALSE, QCString::isEmpty(), m_relPath, OutputGenerator::m_t, QCString::prepend(), theTranslator, and TRUE.

writeLabel()

void HtmlGenerator::writeLabel ( const QCString & l, bool isLast )

overridevirtual

Implements OutputGenIntf.

Definition at line 3565 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- writeLabel(" << label << ") -->\n";)
 
  auto convertLabelToClass = [](const std::string &lab) {
    QCString input = convertUTF8ToLower(lab);
    QCString result;
    size_t l=input.length();
    result.reserve(l);
 
    // Create valid class selector, see 10.2 here https://www.w3.org/TR/selectors-3/#w3cselgrammar
    // ident     [-]?{nmstart}{nmchar}*
    // nmstart   [_a-z]|{nonascii}
    // nonascii  [^\0-\177]
    // nmchar    [_a-z0-9-]|{nonascii}
 
    bool nmstart=false;
    for (size_t i=0; i<l; i++)
    {
      char c = input.at(i);
      if (c<0 || (c>='a' && c<='z') || c=='_') // nmstart pattern
      {
        nmstart=true;
        result+=c;
      }
      else if (nmstart && (c<0 || (c>='a' && c<='z') || (c>='0' && c<='9') || c=='_')) // nmchar pattern
      {
        result+=c;
      }
      else if (nmstart && (c==' ' || c=='-')) // show whitespace as -
      {
        result+='-';
      }
    }
    return result;
  };
 
  m_t << "<span class=\"mlabel " << convertLabelToClass(label.stripWhiteSpace().str()) << "\">" << label << "</span>";
}

References QCString::at(), convertUTF8ToLower(), DBG_HTML, QCString::length(), OutputGenerator::m_t, QCString::reserve(), QCString::str(), and QCString::stripWhiteSpace().

writeLatexSpacing()

void HtmlGenerator::writeLatexSpacing ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 230 of file htmlgen.h.

{}

writeLogo()

void HtmlGenerator::writeLogo ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1645 of file htmlgen.cpp.

{
  m_t << writeLogoAsString(m_relPath);
}

References m_relPath, OutputGenerator::m_t, and writeLogoAsString().

writeLogoAsString()

QCString HtmlGenerator::writeLogoAsString ( const QCString & path )

static

Definition at line 1623 of file htmlgen.cpp.

{
  QCString result;
  switch (Config_getEnum(TIMESTAMP))
  {
    case TIMESTAMP_t::NO:
      result = theTranslator->trGeneratedBy();
      break;
    default:
      result = theTranslator->trGeneratedAt("<span class=\"timestamp\"></span>",
                    convertToHtml(Config_getString(PROJECT_NAME)));
      break;
  }
  result += "&#160;\n<a href=\"https://www.doxygen.org/index.html\">\n"
            "<img class=\"footer\" src=\"";
  result += path;
  result += "doxygen.svg\" width=\"104\" height=\"31\" alt=\"doxygen\"/></a> ";
  result += getDoxygenVersion();
  result += " ";
  return result;
}

References Config_getEnum, Config_getString, convertToHtml(), and theTranslator.

Referenced by writeLogo(), and writeSearchPage().

writeNavigationPath()

void HtmlGenerator::writeNavigationPath ( const QCString & s )

overridevirtual

Implements OutputGenIntf.

Definition at line 3166 of file htmlgen.cpp.

{
  m_t << substitute(s,"$relpath^",m_relPath);
}

References m_relPath, OutputGenerator::m_t, and substitute().

writeNonBreakableSpace()

void HtmlGenerator::writeNonBreakableSpace ( int n )

overridevirtual

Implements OutputGenIntf.

Definition at line 2668 of file htmlgen.cpp.

{
  for (int i=0; i<n; i++)
  {
    m_t << "&#160;";
  }
}

References OutputGenerator::m_t.

writeObjectLink()

void HtmlGenerator::writeObjectLink ( const QCString & ref, const QCString & file, const QCString & anchor, const QCString & name )

overridevirtual

Implements OutputGenIntf.

Definition at line 1851 of file htmlgen.cpp.

{
  if (!ref.isEmpty())
  {
    m_t << "<a class=\"elRef\" ";
    m_t << externalLinkTarget();
  }
  else
  {
    m_t << "<a class=\"el\" ";
  }
  m_t << "href=\"";
  QCString fn = f;
  addHtmlExtensionIfMissing(fn);
  m_t << createHtmlUrl(m_relPath,ref,true,
                       fileName() == Config_getString(HTML_OUTPUT)+"/"+fn,
                       fn,
                       anchor);
  m_t << "\">";
  docify(name);
  m_t << "</a>";
}

References addHtmlExtensionIfMissing(), Config_getString, createHtmlUrl(), docify(), externalLinkTarget(), OutputGenerator::fileName(), QCString::isEmpty(), m_relPath, and OutputGenerator::m_t.

writePageFooter()

void HtmlGenerator::writePageFooter ( TextStream & t, const QCString & lastTitle, const QCString & relPath, const QCString & navPath )

staticprivate

Definition at line 1650 of file htmlgen.cpp.

{
  t << substituteHtmlKeywords(g_footer_file,g_footer,convertToHtml(lastTitle),relPath,navPath);
}

References convertToHtml(), g_footer, g_footer_file, and substituteHtmlKeywords().

Referenced by writeExternalSearchPage(), writeFooter(), and writeSearchPage().

writePageLink()

void HtmlGenerator::writePageLink ( const QCString & , bool  )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 134 of file htmlgen.h.

{}

writePageOutline()

void HtmlGenerator::writePageOutline ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3677 of file htmlgen.cpp.

{
  m_t << "<div id=\"page-nav\" class=\"page-nav-panel\">\n";
  m_t << "<div id=\"page-nav-resize-handle\"></div>\n";
  m_t << "<div id=\"page-nav-tree\">\n";
  m_t << "<div id=\"page-nav-contents\">\n";
  m_t << "</div><!-- page-nav-contents -->\n";
  m_t << "</div><!-- page-nav-tree -->\n";
  m_t << "</div><!-- page-nav -->\n";
}

References OutputGenerator::m_t.

writeQuickLinks()

void HtmlGenerator::writeQuickLinks ( HighlightedItem hli, const QCString & file, bool extraTabs )

overridevirtual

Implements OutputGenIntf.

Definition at line 3191 of file htmlgen.cpp.

{
  writeDefaultQuickLinks(m_t,hli,file,m_relPath,extraTabs);
}

References m_relPath, OutputGenerator::m_t, and writeDefaultQuickLinks().

writeRuler()

void HtmlGenerator::writeRuler ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 210 of file htmlgen.h.

{ m_t << "<hr/>"; }

References OutputGenerator::m_t.

writeSearchData()

void HtmlGenerator::writeSearchData ( const QCString & dir )

static

Definition at line 1366 of file htmlgen.cpp.

{
  //bool serverBasedSearch = Config_getBool(SERVER_BASED_SEARCH);
  //writeImgData(dname,serverBasedSearch ? search_server_data : search_client_data);
  ResourceMgr &mgr = ResourceMgr::instance();
 
  QCString searchDirName = dname;
  std::ofstream f = Portable::openOutputStream(searchDirName+"/search.css");
  if (f.is_open())
  {
    TextStream t(&f);
    QCString searchCss;
    // the position of the search box depends on a number of settings.
    // Insert the right piece of CSS code depending on which options are selected
    if (Config_getBool(GENERATE_TREEVIEW) && Config_getBool(FULL_SIDEBAR))
    {
      searchCss = mgr.getAsString("search_sidebar.css"); // we have a full height side bar
    }
    else if (Config_getBool(DISABLE_INDEX))
    {
      if (Config_getBool(HTML_COLORSTYLE)==HTML_COLORSTYLE_t::TOGGLE)
      {
        searchCss = mgr.getAsString("search_nomenu_toggle.css"); // we have no tabs but do have a darkmode button
      }
      else
      {
        searchCss = mgr.getAsString("search_nomenu.css"); // we have no tabs and no darkmode button
      }
    }
    else if (!Config_getBool(HTML_DYNAMIC_MENUS))
    {
      searchCss = mgr.getAsString("search_fixedtabs.css"); // we have tabs, but they are static
    }
    else
    {
      searchCss = mgr.getAsString("search.css"); // default case with a dynamic menu bar
    }
    // and then add the option independent part of the styling
    searchCss += mgr.getAsString("search_common.css");
    searchCss = substitute(searchCss,"$doxygenversion",getDoxygenVersion());
    t << replaceVariables(searchCss);
    Doxygen::indexList->addStyleSheetFile("search/search.css");
  }
}

References Config_getBool, ResourceMgr::getAsString(), Doxygen::indexList, ResourceMgr::instance(), Portable::openOutputStream(), replaceVariables(), and substitute().

Referenced by generateOutput().

writeSearchInfo()

void HtmlGenerator::writeSearchInfo ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1617 of file htmlgen.cpp.

{
  writeSearchInfoStatic(m_t,m_relPath);
}

References m_relPath, OutputGenerator::m_t, and writeSearchInfoStatic().

writeSearchInfoStatic()

void HtmlGenerator::writeSearchInfoStatic ( TextStream & t, const QCString & relPath )

static

Definition at line 1587 of file htmlgen.cpp.

{
  bool searchEngine      = Config_getBool(SEARCHENGINE);
  bool serverBasedSearch = Config_getBool(SERVER_BASED_SEARCH);
  if (searchEngine && !serverBasedSearch)
  {
    t << "<!-- window showing the filter options -->\n";
    t << "<div id=\"MSearchSelectWindow\"\n";
    t << "     onmouseover=\"return searchBox.OnSearchSelectShow()\"\n";
    t << "     onmouseout=\"return searchBox.OnSearchSelectHide()\"\n";
    t << "     onkeydown=\"return searchBox.OnSearchSelectKey(event)\">\n";
    t << "</div>\n";
    t << "\n";
    t << "<!-- iframe showing the search results (closed by default) -->\n";
    t << "<div id=\"MSearchResultsWindow\">\n";
    t << "<div id=\"MSearchResults\">\n";
    t << "<div class=\"SRPage\">\n";
    t << "<div id=\"SRIndex\">\n";
    t << "<div id=\"SRResults\"></div>\n"; // here the results will be inserted
    t << "<div class=\"SRStatus\" id=\"Loading\">"   << theTranslator->trLoading()   << "</div>\n";
    t << "<div class=\"SRStatus\" id=\"Searching\">" << theTranslator->trSearching() << "</div>\n";
    t << "<div class=\"SRStatus\" id=\"NoMatches\">" << theTranslator->trNoMatches() << "</div>\n";
    t << "</div>\n"; // SRIndex
    t << "</div>\n"; // SRPage
    t << "</div>\n"; // MSearchResults
    t << "</div>\n"; // MSearchResultsWindow
    t << "\n";
  }
}

References Config_getBool, and theTranslator.

Referenced by writeSearchInfo().

writeSearchPage()

void HtmlGenerator::writeSearchPage ( )

static

Definition at line 3197 of file htmlgen.cpp.

{
  bool disableIndex            = Config_getBool(DISABLE_INDEX);
  bool generateTreeView        = Config_getBool(GENERATE_TREEVIEW);
  bool fullSidebar             = Config_getBool(FULL_SIDEBAR);
  bool quickLinksAfterSplitbar = !disableIndex && generateTreeView && fullSidebar;
  QCString projectName         = Config_getString(PROJECT_NAME);
  QCString htmlOutput          = Config_getString(HTML_OUTPUT);
 
  // OPENSEARCH_PROVIDER {
  QCString configFileName = htmlOutput+"/search_config.php";
  std::ofstream f = Portable::openOutputStream(configFileName);
  if (f.is_open())
  {
    TextStream t(&f);
    t << "<?php\n\n";
    t << "$config = array(\n";
    t << "  'PROJECT_NAME' => \"" << convertToHtml(projectName) << "\",\n";
    t << "  'GENERATE_TREEVIEW' => " << (generateTreeView?"true":"false") << ",\n";
    t << "  'DISABLE_INDEX' => " << (disableIndex?"true":"false") << ",\n";
    t << "  'FULL_SIDEBAR' => " << (fullSidebar?"true":"false") << ",\n";
    t << ");\n\n";
    t << "$translator = array(\n";
    t << "  'search_results_title' => \"" << theTranslator->trSearchResultsTitle() << "\",\n";
    t << "  'search_results' => array(\n";
    t << "    0 => \"" << theTranslator->trSearchResults(0) << "\",\n";
    t << "    1 => \"" << theTranslator->trSearchResults(1) << "\",\n";
    t << "    2 => \"" << substitute(theTranslator->trSearchResults(2), "$", "\\$") << "\",\n";
    t << "  ),\n";
    t << "  'search_matches' => \"" << theTranslator->trSearchMatches() << "\",\n";
    t << "  'search' => \"" << theTranslator->trSearch() << "\",\n";
    t << "  'logo' => \"" << substitute(substitute(writeLogoAsString(""), "\"","\\\""), "\n","\\n") << "\",\n";
    t << ");\n\n";
    t << "?>\n";
  }
  f.close();
 
  ResourceMgr::instance().copyResource("search_functions.php",htmlOutput);
  ResourceMgr::instance().copyResource("search_opensearch.php",htmlOutput);
  // OPENSEARCH_PROVIDER }
 
  QCString fileName = htmlOutput+"/search.php";
  f = Portable::openOutputStream(fileName);
  if (f.is_open())
  {
    TextStream t(&f);
    t << substituteHtmlKeywords(g_header_file,g_header,"Search","");
 
    t << "<!-- " << theTranslator->trGeneratedBy() << " Doxygen "
      << getDoxygenVersion() << " -->\n";
    t << "<script type=\"text/javascript\">\n";
    t << "let searchBox = new SearchBox(\"searchBox\", \""
      << "search/\",'" << Doxygen::htmlFileExtension << "');\n";
    t << "</script>\n";
 
    if (!disableIndex && !quickLinksAfterSplitbar)
    {
      writeDefaultQuickLinks(t,HighlightedItem::Search,QCString(),QCString(),false);
    }
    if (generateTreeView)
    {
      t << "</div><!-- top -->\n";
    }
    t << writeSplitBarAsString("search.php",QCString(),QCString());
    if (quickLinksAfterSplitbar)
    {
      writeDefaultQuickLinks(t,HighlightedItem::Search,QCString(),QCString(),false);
    }
    t << "<!-- generated -->\n";
 
    t << "<?php\n";
    t << "require_once \"search_functions.php\";\n";
    t << "main();\n";
    t << "?>\n";
 
    // Write empty navigation path, to make footer connect properly
    if (generateTreeView)
    {
      t << "</div><!-- doc-content -->\n";
      t << "</div><!-- container -->\n";
    }
 
    writePageFooter(t,"Search","","");
  }
  f.close();
 
  QCString scriptName = htmlOutput+"/search/search.js";
  f = Portable::openOutputStream(scriptName);
  if (f.is_open())
  {
    TextStream t(&f);
    t << ResourceMgr::instance().getAsString("extsearch.js");
  }
  else
  {
     err("Failed to open file '{}' for writing...\n",scriptName);
  }
}

References Config_getBool, Config_getString, convertToHtml(), ResourceMgr::copyResource(), err, OutputGenerator::fileName(), g_header, g_header_file, ResourceMgr::getAsString(), Doxygen::htmlFileExtension, ResourceMgr::instance(), Portable::openOutputStream(), Search, substitute(), substituteHtmlKeywords(), theTranslator, writeDefaultQuickLinks(), writeLogoAsString(), writePageFooter(), and writeSplitBarAsString().

Referenced by generateOutput().

writeSplitBar()

void HtmlGenerator::writeSplitBar ( const QCString & name, const QCString & allMembersFile )

overridevirtual

Implements OutputGenIntf.

Definition at line 3161 of file htmlgen.cpp.

{
  m_t << writeSplitBarAsString(name,m_relPath,allMembersFile);
}

References m_relPath, OutputGenerator::m_t, and writeSplitBarAsString().

writeSplitBarAsString()

QCString HtmlGenerator::writeSplitBarAsString ( const QCString & name, const QCString & relpath, const QCString & allMembersFile )

static

Definition at line 3126 of file htmlgen.cpp.

{
  bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
  QCString result;
  // write split bar
  if (generateTreeView)
  {
    QCString fn = name;
    addHtmlExtensionIfMissing(fn);
    if (!Config_getBool(FULL_SIDEBAR))
    {
      result += QCString(
        "<div id=\"side-nav\" class=\"ui-resizable side-nav-resizable\">\n");
    }
    result+=
     "  <div id=\"nav-tree\">\n"
     "    <div id=\"nav-tree-contents\">\n"
     "      <div id=\"nav-sync\" class=\"sync\"></div>\n"
     "    </div>\n"
     "  </div>\n"
     "  <div id=\"splitbar\" style=\"-moz-user-select:none;\" \n"
     "       class=\"ui-resizable-handle\">\n"
     "  </div>\n"
     "</div>\n"
     "<script type=\"text/javascript\">\n"
     "document.addEventListener('DOMContentLoaded',() => { initNavTree('" + fn + "','" + relpath + "','" + allMembersFile + "'); });\n"
     "</script>\n";
     if (Config_getBool(DISABLE_INDEX) || !Config_getBool(FULL_SIDEBAR))
     {
       result+="<div id=\"container\">\n<div id=\"doc-content\">\n";
     }
  }
  return result;
}

References addHtmlExtensionIfMissing(), and Config_getBool.

Referenced by writeExternalSearchPage(), writeSearchPage(), and writeSplitBar().

writeStartAnnoItem()

void HtmlGenerator::writeStartAnnoItem ( const QCString & type, const QCString & file, const QCString & path, const QCString & name )

overridevirtual

Implements OutputGenIntf.

Definition at line 1839 of file htmlgen.cpp.

{
  m_t << "<li>";
  if (!path.isEmpty()) docify(path);
  QCString fn = f;
  addHtmlExtensionIfMissing(fn);
  m_t << "<a class=\"el\" href=\"" << fn << "\">";
  docify(name);
  m_t << "</a> ";
}

References addHtmlExtensionIfMissing(), docify(), QCString::isEmpty(), and OutputGenerator::m_t.

writeString()

void HtmlGenerator::writeString ( const QCString & text )

overridevirtual

Implements OutputGenIntf.

Definition at line 1781 of file htmlgen.cpp.

{
  m_t << text;
}

References OutputGenerator::m_t.

writeStyleInfo()

void HtmlGenerator::writeStyleInfo ( int part )

overridevirtual

Implements OutputGenIntf.

Definition at line 1676 of file htmlgen.cpp.

{
  //printf("writeStyleInfo(%d)\n",part);
  if (part==0)
  {
    if (Config_getString(HTML_STYLESHEET).isEmpty()) // write default style sheet
    {
      //printf("write doxygen.css\n");
      startPlainFile("doxygen.css");
      writeDefaultStyleSheet(m_t);
      endPlainFile();
      Doxygen::indexList->addStyleSheetFile("doxygen.css");
    }
    else // write user defined style sheet
    {
      QCString cssName=Config_getString(HTML_STYLESHEET);
      if (!cssName.startsWith("http:") && !cssName.startsWith("https:"))
      {
        FileInfo cssfi(cssName.str());
        if (!cssfi.exists() || !cssfi.isFile() || !cssfi.isReadable())
        {
          err("style sheet {} does not exist or is not readable!\n", Config_getString(HTML_STYLESHEET));
        }
        else
        {
          // convert style sheet to string
          QCString fileStr = fileToString(cssName);
          // write the string into the output dir
          startPlainFile(cssfi.fileName());
          m_t << fileStr;
          endPlainFile();
        }
        Doxygen::indexList->addStyleSheetFile(cssfi.fileName());
      }
    }
    const StringVector &extraCssFiles = Config_getList(HTML_EXTRA_STYLESHEET);
    for (const auto &fileName : extraCssFiles)
    {
      if (!fileName.empty())
      {
        FileInfo fi(fileName);
        if (fi.exists())
        {
          Doxygen::indexList->addStyleSheetFile(fi.fileName());
        }
      }
    }
 
    Doxygen::indexList->addStyleSheetFile("navtree.css");
 
    if (Config_getBool(HTML_DYNAMIC_SECTIONS))
    {
      Doxygen::indexList->addStyleSheetFile("dynsections.js");
    }
    if (Config_getBool(HTML_CODE_FOLDING))
    {
      Doxygen::indexList->addStyleSheetFile("codefolding.js");
    }
 
    if (Config_getEnum(HTML_COLORSTYLE)==HTML_COLORSTYLE_t::TOGGLE)
    {
      Doxygen::indexList->addStyleSheetFile("darkmode_toggle.js");
    }
 
    if (Config_getBool(INTERACTIVE_SVG))
    {
      Doxygen::indexList->addStyleSheetFile("svg.min.js");
    }
 
    if (!Config_getBool(DISABLE_INDEX) && Config_getBool(HTML_DYNAMIC_MENUS))
    {
      Doxygen::indexList->addStyleSheetFile("menu.js");
      Doxygen::indexList->addStyleSheetFile("menudata.js");
    }
  }
}

References Config_getBool, Config_getEnum, Config_getList, Config_getString, endPlainFile(), err, FileInfo::exists(), FileInfo::fileName(), OutputGenerator::fileName(), fileToString(), Doxygen::indexList, FileInfo::isFile(), FileInfo::isReadable(), OutputGenerator::m_t, startPlainFile(), QCString::startsWith(), QCString::str(), and writeDefaultStyleSheet().

writeStyleSheetFile()

void HtmlGenerator::writeStyleSheetFile ( TextStream & t )

static

Definition at line 1528 of file htmlgen.cpp.

{
  fillColorStyleMaps();
  writeDefaultStyleSheet(t);
}

References fillColorStyleMaps(), and writeDefaultStyleSheet().

Referenced by readConfiguration().

writeSummaryLink()

void HtmlGenerator::writeSummaryLink ( const QCString & file, const QCString & anchor, const QCString & title, bool first )

overridevirtual

Implements OutputGenIntf.

Definition at line 3650 of file htmlgen.cpp.

{
  if (first)
  {
    m_t << "  <div class=\"summary\">\n";
  }
  else
  {
    m_t << " &#124;\n";
  }
  m_t << "<a href=\"";
  if (!file.isEmpty())
  {
    QCString fn = file;
    addHtmlExtensionIfMissing(fn);
    m_t << m_relPath << fn;
  }
  else if (!anchor.isEmpty())
  {
    m_t << "#";
    m_t << anchor;
  }
  m_t << "\">";
  m_t << title;
  m_t << "</a>";
}

References addHtmlExtensionIfMissing(), QCString::isEmpty(), m_relPath, and OutputGenerator::m_t.

writeSynopsis()

void HtmlGenerator::writeSynopsis ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 244 of file htmlgen.h.

{}

writeTabData()

void HtmlGenerator::writeTabData ( )

static

Additional initialization after indices have been created.

Definition at line 1357 of file htmlgen.cpp.

{
  Doxygen::indexList->addStyleSheetFile("tabs.css");
  QCString dname=Config_getString(HTML_OUTPUT);
  ResourceMgr &mgr = ResourceMgr::instance();
  mgr.copyResource("doxygen.svg",dname);
  Doxygen::indexList->addImageFile("doxygen.svg");
}

References Config_getString, ResourceMgr::copyResource(), Doxygen::indexList, and ResourceMgr::instance().

Referenced by generateOutput().

Member Data Documentation

m_codeGen

HtmlCodeGenerator* HtmlGenerator::m_codeGen = nullptr

private

Definition at line 351 of file htmlgen.h.

Referenced by addCodeGen(), HtmlGenerator(), HtmlGenerator(), operator=(), and startFile().

m_codeList

std::unique_ptr<OutputCodeList> HtmlGenerator::m_codeList

private

Definition at line 350 of file htmlgen.h.

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

m_emptySection

bool HtmlGenerator::m_emptySection = false

private

Definition at line 349 of file htmlgen.h.

Referenced by endMemberSections(), HtmlGenerator(), operator=(), startInlineHeader(), startMemberDescription(), startMemberHeader(), startMemberItem(), startMemberSections(), and startMemberSubtitle().

m_lastFile

QCString HtmlGenerator::m_lastFile

private

Definition at line 346 of file htmlgen.h.

Referenced by HtmlGenerator(), operator=(), and startFile().

m_lastTitle

QCString HtmlGenerator::m_lastTitle

private

Definition at line 345 of file htmlgen.h.

Referenced by HtmlGenerator(), operator=(), startFile(), and writeFooter().

m_pageOutlineIndent

int HtmlGenerator::m_pageOutlineIndent = 0

private

Definition at line 352 of file htmlgen.h.

m_relPath

QCString HtmlGenerator::m_relPath

private

Definition at line 347 of file htmlgen.h.

Referenced by endCallGraph(), endClassDiagram(), endDirDepGraph(), endDotGraph(), endGroupCollaboration(), endInclDepGraph(), HtmlGenerator(), operator=(), startCallGraph(), startClassDiagram(), startDirDepGraph(), startDotGraph(), startFile(), startGroupCollaboration(), startInclDepGraph(), startIndexItem(), startTextLink(), writeFooter(), writeInheritedSectionTitle(), writeLogo(), writeNavigationPath(), writeObjectLink(), writeQuickLinks(), writeSearchInfo(), writeSplitBar(), and writeSummaryLink().

m_sectionCount

int HtmlGenerator::m_sectionCount = 0

private

Definition at line 348 of file htmlgen.h.

Referenced by endCallGraph(), endClassDiagram(), endDirDepGraph(), endDotGraph(), endGroupCollaboration(), endInclDepGraph(), HtmlGenerator(), operator=(), startCallGraph(), startClassDiagram(), startDirDepGraph(), startDotGraph(), startFile(), startGroupCollaboration(), and startInclDepGraph().

m_tocState

TocState HtmlGenerator::m_tocState

private

Definition at line 364 of file htmlgen.h.

Referenced by endLocalToc(), endTocEntry(), startLocalToc(), startTocEntry(), and writeDoc().

---

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

• src/htmlgen.h
• src/htmlgen.cpp