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 DString &name, bool isSource, const DString &manName, const DString &title, int id, int hierarchyLevel) override
void	endFile () override
void	writeFooter (const DString &navPath) override
void	writeSearchInfo () override
void	startIndexSection (IndexSection) override
void	endIndexSection (IndexSection) override
void	writePageLink (const DString &, bool) override
void	startProjectNumber () override
void	endProjectNumber () override
void	writeStyleInfo (int part) override
void	startTitleHead (const DString &) override
void	endTitleHead (const DString &, const DString &) override
void	startParagraph (const DString &classDef) override
void	endParagraph () override
void	writeString (const DString &text) override
void	startIndexListItem () override
void	endIndexListItem () override
void	startIndexList () override
void	endIndexList () override
void	startIndexKey () override
void	endIndexKey () override
void	startIndexValue (bool) override
void	endIndexValue (const DString &, bool) override
void	startItemList () override
void	endItemList () override
void	startIndexItem (const DString &ref, const DString &file) override
void	endIndexItem (const DString &ref, const DString &file) override
void	docify (const DString &text) override
void	writeObjectLink (const DString &ref, const DString &file, const DString &anchor, const DString &name) override
void	startTextLink (const DString &file, const DString &anchor) override
void	endTextLink () override
void	startTypewriter () override
void	endTypewriter () override
void	startGroupHeader (const DString &, int) override
void	endGroupHeader (int) override
void	startItemListItem () override
void	endItemListItem () override
void	startMemberSections () override
void	endMemberSections () override
void	startHeaderSection () override
void	endHeaderSection () override
void	startMemberHeader (const DString &, int) override
void	endMemberHeader () override
void	startMemberSubtitle () override
void	endMemberSubtitle () override
void	startMemberDocList () override
void	endMemberDocList () override
void	startMemberList () override
void	endMemberList () override
void	startInlineHeader () override
void	endInlineHeader () override
void	startAnonTypeScope (int) override
void	endAnonTypeScope (int) override
void	startMemberItem (const DString &anchor, MemberItemType, const DString &inheritId) override
void	endMemberItem (MemberItemType) override
void	startMemberTemplateParams () override
void	endMemberTemplateParams (const DString &anchor, const DString &inheritId) override
void	startCompoundTemplateParams () override
void	endCompoundTemplateParams () override
void	startMemberGroupHeader (const DString &, bool) override
void	endMemberGroupHeader (bool) override
void	startMemberGroupDocs () override
void	endMemberGroupDocs () override
void	startMemberGroup () override
void	endMemberGroup (bool) override
void	insertMemberAlign (bool) override
void	insertMemberAlignLeft (MemberItemType, bool) override
void	startMemberDescription (const DString &anchor, const DString &inheritId, bool typ) override
void	endMemberDescription () override
void	startMemberDeclaration () override
void	endMemberDeclaration (const DString &anchor, const DString &inheritId) override
void	writeInheritedSectionTitle (const DString &id, const DString &ref, const DString &file, const DString &anchor, const DString &title, const DString &name) override
void	writeRuler () override
void	writeAnchor (const DString &, const DString &name) override
void	startEmphasis () override
void	endEmphasis () override
void	startBold () override
void	endBold () override
void	startDescForItem () override
void	endDescForItem () override
void	lineBreak (const DString &style) override
void	writeChar (char c) override
void	startMemberDoc (const DString &clName, const DString &memName, const DString &anchor, const DString &title, int memCount, int memTotal, bool showInline) override
void	endMemberDoc (bool) override
void	startDoxyAnchor (const DString &fName, const DString &manName, const DString &anchor, const DString &name, const DString &args) override
void	endDoxyAnchor (const DString &fName, const DString &anchor) override
void	addLabel (const DString &, const DString &) override
void	writeLatexSpacing () override
void	writeStartAnnoItem (const DString &type, const DString &file, const DString &path, const DString &name) override
void	startCenter () override
void	endCenter () override
void	startSmall () override
void	endSmall () override
void	startExamples () override
void	endExamples () override
void	startSection (const DString &, const DString &, SectionType) override
void	endSection (const DString &, SectionType) override
void	addIndexItem (const DString &, const DString &) override
void	startIndent () override
void	endIndent () override
void	writeSynopsis () override
void	startClassDiagram () override
void	endClassDiagram (const ClassDiagram &, const DString &, const DString &) override
void	startPageRef () override
void	endPageRef (const DString &, const DString &) override
void	startQuickIndices () override
void	endQuickIndices () override
void	writeSplitBar (const DString &name, const DString &allMembersFile) override
void	writeNavigationPath (const DString &s) override
void	writeLogo () override
void	writeQuickLinks (HighlightedItem hli, const DString &file, bool extraTabs) override
void	writeSummaryLink (const DString &file, const DString &anchor, const DString &title, bool first) override
void	writePageOutline () override
void	startContents () override
void	endContents () override
void	startPageDoc (const DString &pageTitle) override
void	endPageDoc () override
void	writeNonBreakableSpace (int) override
void	startDescTable (const DString &title, const bool hasInits) override
void	endDescTable () override
void	startDescTableRow () override
void	endDescTableRow () override
void	startDescTableTitle () override
void	endDescTableTitle () override
void	startDescTableInit () override
void	endDescTableInit () override
void	startDescTableData () override
void	endDescTableData () override
void	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 DString &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 DString &, bool) override
void	startConstraintList (const DString &) override
void	startConstraintParam () override
void	endConstraintParam () override
void	startConstraintType () override
void	endConstraintType () override
void	startConstraintDocs () override
void	endConstraintDocs () override
void	endConstraintList () override
void	startMemberDocSimple (bool) override
void	endMemberDocSimple (bool) override
void	startInlineMemberType () override
void	endInlineMemberType () override
void	startInlineMemberName () override
void	endInlineMemberName () override
void	startInlineMemberDoc () override
void	endInlineMemberDoc () override
void	startLabels () override
void	writeLabel (const DString &l, bool isLast) override
void	endLabels () override
void	startLocalToc (int level) override
void	endLocalToc () override
void	startTocEntry (const SectionInfo *si) override
void	endTocEntry (const SectionInfo *si) override
void	startPlainFile (const DString &name) override
void	endPlainFile () override
void	startEmbeddedDoc (size_t) override
void	endEmbeddedDoc () override
Public Member Functions inherited from OutputGenerator
	OutputGenerator ()
	OutputGenerator (const DString &dir)
virtual	~OutputGenerator ()=default
DString	dir () const
DString	fileName () const
void	startPlainFile (const DString &name)
void	endPlainFile ()

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

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

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

Private Attributes
DString	m_lastTitle
DString	m_lastFile
DString	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
DString	m_dir

Detailed Description

Generator for HTML output.

Definition at line 92 of file htmlgen.h.

Constructor & Destructor Documentation

◆ HtmlGenerator() [1/3]

HtmlGenerator::HtmlGenerator ( )

Definition at line 1226 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 1234 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, OutputGenerator::OutputGenerator(), and HtmlCodeGenerator::setTextStream().

◆ 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 1267 of file htmlgen.cpp.

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

References OutputCodeList::add(), and m_codeGen.

◆ addIndexItem()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 2771 of file htmlgen.cpp.

2772{

2773}

◆ addLabel()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 1875 of file htmlgen.cpp.

1876{

1877}

◆ cleanup()

void HtmlGenerator::cleanup ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1437 of file htmlgen.cpp.

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

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

◆ clearBuffer()

void HtmlGenerator::clearBuffer ( )

◆ clone()

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

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 120 of file htmlgen.h.

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

◆ docify()

void HtmlGenerator::docify ( const DString & text )

overridevirtual

Implements OutputGenIntf.

Definition at line 2071 of file htmlgen.cpp.

{
  docify_(str,false);
}

References docify_().

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

◆ docify_()

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

private

Definition at line 2076 of file htmlgen.cpp.

{
  if (!str.empty())
  {
    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 DString::data(), DString::empty(), and OutputGenerator::m_t.

Referenced by docify().

◆ endAnonTypeScope()

void HtmlGenerator::endAnonTypeScope ( int )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 183 of file htmlgen.h.

183{}

◆ endBold()

void HtmlGenerator::endBold ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 214 of file htmlgen.h.

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

References OutputGenerator::m_t.

◆ endCallGraph()

void HtmlGenerator::endCallGraph ( DotCallGraph & g )

overridevirtual

Implements OutputGenIntf.

Definition at line 2694 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(), and DotCallGraph::writeGraph().

◆ endCenter()

void HtmlGenerator::endCenter ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 232 of file htmlgen.h.

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

References OutputGenerator::m_t.

◆ endClassDiagram()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 2195 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,true,true);
  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 2298 of file htmlgen.cpp.

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

References OutputGenerator::m_t.

◆ endConstraintDocs()

void HtmlGenerator::endConstraintDocs ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3522 of file htmlgen.cpp.

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

References OutputGenerator::m_t.

◆ endConstraintList()

void HtmlGenerator::endConstraintList ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3527 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 3502 of file htmlgen.cpp.

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

References OutputGenerator::m_t.

◆ endConstraintType()

void HtmlGenerator::endConstraintType ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3512 of file htmlgen.cpp.

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

References OutputGenerator::m_t.

◆ endContents()

void HtmlGenerator::endContents ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3263 of file htmlgen.cpp.

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

References OutputGenerator::m_t.

◆ endDescForItem()

void HtmlGenerator::endDescForItem ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 216 of file htmlgen.h.

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

References OutputGenerator::m_t.

◆ endDescTable()

void HtmlGenerator::endDescTable ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2788 of file htmlgen.cpp.

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

References OutputGenerator::m_t.

◆ endDescTableData()

void HtmlGenerator::endDescTableData ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2828 of file htmlgen.cpp.

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

References OutputGenerator::m_t.

◆ endDescTableInit()

void HtmlGenerator::endDescTableInit ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2818 of file htmlgen.cpp.

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

References OutputGenerator::m_t.

◆ endDescTableRow()

void HtmlGenerator::endDescTableRow ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2798 of file htmlgen.cpp.

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

References OutputGenerator::m_t.

◆ endDescTableTitle()

void HtmlGenerator::endDescTableTitle ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2808 of file htmlgen.cpp.

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

References OutputGenerator::m_t.

◆ endDirDepGraph()

void HtmlGenerator::endDirDepGraph ( DotDirDeps & g )

overridevirtual

Implements OutputGenIntf.

Definition at line 2712 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(), and DotDirDeps::writeGraph().

◆ endDotGraph()

void HtmlGenerator::endDotGraph ( DotClassGraph & g )

overridevirtual

Implements OutputGenIntf.

Definition at line 2624 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)
  {
    DString 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.empty()) 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(), DString::empty(), endSectionContent(), endSectionHeader(), endSectionSummary(), OutputGenerator::fileName(), Html, Doxygen::htmlFileExtension, m_relPath, m_sectionCount, OutputGenerator::m_t, startSectionContent(), startSectionSummary(), theTranslator, Translator::trLegend(), and DotClassGraph::writeGraph().

◆ endDoxyAnchor()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 1871 of file htmlgen.cpp.

1872{

1873}

◆ endEmbeddedDoc()

void HtmlGenerator::endEmbeddedDoc ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3641 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 212 of file htmlgen.h.

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

References OutputGenerator::m_t.

◆ endExamples()

void HtmlGenerator::endExamples ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2840 of file htmlgen.cpp.

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

References OutputGenerator::m_t.

◆ endFile()

void HtmlGenerator::endFile ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1772 of file htmlgen.cpp.

{
  endPlainFile();
}

References endPlainFile().

◆ endGroupCollaboration()

void HtmlGenerator::endGroupCollaboration ( DotGroupCollaboration & g )

overridevirtual

Implements OutputGenIntf.

Definition at line 2676 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(), and DotGroupCollaboration::writeGraph().

◆ endGroupHeader()

void HtmlGenerator::endGroupHeader ( int extraIndentLevel )

overridevirtual

Implements OutputGenIntf.

Definition at line 2024 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 3564 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 2658 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(), and DotInclDepGraph::writeGraph().

◆ endIndent()

void HtmlGenerator::endIndent ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2765 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 DString &	ref,
		const DString &	file )

overridevirtual

Implements OutputGenIntf.

Definition at line 1937 of file htmlgen.cpp.

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

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

◆ endIndexKey()

void HtmlGenerator::endIndexKey ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2428 of file htmlgen.cpp.

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

◆ endIndexList()

void HtmlGenerator::endIndexList ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2418 of file htmlgen.cpp.

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

References OutputGenerator::m_t.

◆ endIndexListItem()

void HtmlGenerator::endIndexListItem ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1902 of file htmlgen.cpp.

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

References OutputGenerator::m_t.

◆ endIndexSection()

void HtmlGenerator::endIndexSection ( IndexSection )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 131 of file htmlgen.h.

131{}

◆ endIndexValue()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 2438 of file htmlgen.cpp.

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

◆ endInlineHeader()

void HtmlGenerator::endInlineHeader ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3579 of file htmlgen.cpp.

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

References OutputGenerator::m_t.

◆ endInlineMemberDoc()

void HtmlGenerator::endInlineMemberDoc ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3629 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 3617 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 3605 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 151 of file htmlgen.h.

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

References OutputGenerator::m_t.

◆ endItemListItem()

void HtmlGenerator::endItemListItem ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 166 of file htmlgen.h.

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

References OutputGenerator::m_t.

◆ endLabels()

void HtmlGenerator::endLabels ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3693 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 3801 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 HtmlGenerator::TocState::decIndent(), HtmlGenerator::TocState::level, OutputGenerator::m_t, m_tocState, and HtmlGenerator::TocState::maxLevel.

◆ endMemberDeclaration()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 3776 of file htmlgen.cpp.

3777{

3778}

◆ endMemberDescription()

void HtmlGenerator::endMemberDescription ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2342 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 2608 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 2448 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 2492 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 2476 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 3593 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 2754 of file htmlgen.cpp.

2755{

2756}

◆ endMemberGroupDocs()

void HtmlGenerator::endMemberGroupDocs ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2745 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 2735 of file htmlgen.cpp.

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

References OutputGenerator::m_t.

◆ endMemberHeader()

void HtmlGenerator::endMemberHeader ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2390 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 2267 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 2234 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 2356 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 2407 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 DString &	anchor,
		const DString &	inheritId )

overridevirtual

Implements OutputGenIntf.

Definition at line 2280 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.empty())
  {
    if (dynamicSections) m_t << " inherit";
    m_t << " " << inheritId;
  }
  m_t << " template\"><td class=\"memItemLeft\">";
}

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

◆ endPageDoc()

void HtmlGenerator::endPageDoc ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3273 of file htmlgen.cpp.

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

References OutputGenerator::m_t.

◆ endPageRef()

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

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 246 of file htmlgen.h.

246{}

◆ endParagraph()

void HtmlGenerator::endParagraph ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1887 of file htmlgen.cpp.

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

References OutputGenerator::m_t.

◆ endParameterDefVal()

void HtmlGenerator::endParameterDefVal ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2577 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 2546 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 2582 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 2535 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 2523 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 332 of file htmlgen.h.

332{ OutputGenerator::endPlainFile(); }

OutputGenerator::endPlainFile

void endPlainFile()

Definition outputgen.cpp:40

References OutputGenerator::endPlainFile().

Referenced by endFile(), and writeStyleInfo().

◆ endProjectNumber()

void HtmlGenerator::endProjectNumber ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1782 of file htmlgen.cpp.

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

References OutputGenerator::m_t.

◆ endQuickIndices()

void HtmlGenerator::endQuickIndices ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3204 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 DString &	,
		SectionType	type )

overridevirtual

Implements OutputGenIntf.

Definition at line 2056 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, SectionType::level(), 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 234 of file htmlgen.h.

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

References OutputGenerator::m_t.

◆ endTextBlock()

void HtmlGenerator::endTextBlock ( bool )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 285 of file htmlgen.h.

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

References OutputGenerator::m_t.

◆ endTextLink()

void HtmlGenerator::endTextLink ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1998 of file htmlgen.cpp.

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

References OutputGenerator::m_t.

◆ endTitle()

void HtmlGenerator::endTitle ( )

inlineprivate

Definition at line 339 of file htmlgen.h.

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

References OutputGenerator::m_t.

Referenced by endTitleHead().

◆ endTitleHead()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 3558 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 3857 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 HtmlGenerator::TocState::inLi, SectionType::isSection(), HtmlGenerator::TocState::level, SectionType::level(), OutputGenerator::m_t, m_tocState, HtmlGenerator::TocState::maxLevel, type(), and SectionInfo::type().

◆ endTypewriter()

void HtmlGenerator::endTypewriter ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 162 of file htmlgen.h.

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

References OutputGenerator::m_t.

◆ exceptionEntry()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 2589 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.empty())
    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.

◆ fixSpaces()

DString HtmlGenerator::fixSpaces ( const DString & s )

static

Definition at line 3786 of file htmlgen.cpp.

{
  return substitute(s," ","&#160;");
}

References substitute().

Referenced by renderQuickLinksAsTabs(), and renderQuickLinksAsTree().

◆ getNavTreeCss()

DString HtmlGenerator::getNavTreeCss ( )

static

Definition at line 3780 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 1281 of file htmlgen.cpp.

{
  DString 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).empty())
  {
    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));
    DString result = substituteHtmlKeywords(g_header_file,g_header,DString(),DString());
    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));
    DString result = substituteHtmlKeywords(g_header_file,g_header,DString(),DString());
    checkBlocks(result,"<default header.html>",htmlMarkerInfo);
  }
 
  if (!Config_getString(HTML_FOOTER).empty())
  {
    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));
    DString result = substituteHtmlKeywords(g_footer_file,g_footer,DString(),DString());
    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));
    DString result = substituteHtmlKeywords(g_footer_file,g_footer,DString(),DString());
    checkBlocks(result,"<default footer.html>",htmlMarkerInfo);
  }
 
  if (Config_getBool(USE_MATHJAX))
  {
    if (!Config_getString(MATHJAX_CODEFILE).empty())
    {
      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();
 
  {
    DString 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 (useDynamicSections())
  {
    std::ofstream f = Portable::openOutputStream(dname+"/dynsections.js");
    if (f.is_open())
    {
      TextStream t(&f);
      if (Config_getBool(HTML_DYNAMIC_SECTIONS) ||
          (Config_getBool(OBFUSCATE_EMAILS) && !Config_getBool(GENERATE_HTMLHELP)))
      {
        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(), DString::str(), substitute(), substituteHtmlKeywords(), term, theTranslator, Translator::trCopyToClipboard(), and useDynamicSections().

Referenced by generateOutput().

◆ insertMemberAlign()

void HtmlGenerator::insertMemberAlign ( bool )

overridevirtual

Implements OutputGenIntf.

Definition at line 2303 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 2309 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 286 of file htmlgen.h.

286{}

◆ lineBreak()

void HtmlGenerator::lineBreak ( const DString & style )

overridevirtual

Implements OutputGenIntf.

Definition at line 3535 of file htmlgen.cpp.

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

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

◆ operator=() [1/2]

HtmlGenerator & HtmlGenerator::operator= ( const HtmlGenerator & og )

Definition at line 1247 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, OutputGenerator::m_t, and HtmlCodeGenerator::setTextStream().

◆ operator=() [2/2]

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

delete

References HtmlGenerator().

◆ startAnonTypeScope()

void HtmlGenerator::startAnonTypeScope ( int )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 182 of file htmlgen.h.

182{}

◆ startBold()

void HtmlGenerator::startBold ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 213 of file htmlgen.h.

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

References OutputGenerator::m_t.

◆ startCallGraph()

void HtmlGenerator::startCallGraph ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2689 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 231 of file htmlgen.h.

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

References OutputGenerator::m_t.

◆ startClassDiagram()

void HtmlGenerator::startClassDiagram ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2190 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 2293 of file htmlgen.cpp.

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

References OutputGenerator::m_t.

◆ startConstraintDocs()

void HtmlGenerator::startConstraintDocs ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3517 of file htmlgen.cpp.

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

References OutputGenerator::m_t.

◆ startConstraintList()

void HtmlGenerator::startConstraintList ( const DString & header )

overridevirtual

Implements OutputGenIntf.

Definition at line 3490 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 3497 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 3507 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 3258 of file htmlgen.cpp.

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

References OutputGenerator::m_t.

◆ startDescForItem()

void HtmlGenerator::startDescForItem ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 215 of file htmlgen.h.

215{ m_t << "<dd>"; }

References OutputGenerator::m_t.

◆ startDescTable()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 2783 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 2823 of file htmlgen.cpp.

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

References OutputGenerator::m_t.

◆ startDescTableInit()

void HtmlGenerator::startDescTableInit ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2813 of file htmlgen.cpp.

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

References OutputGenerator::m_t.

◆ startDescTableRow()

void HtmlGenerator::startDescTableRow ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2793 of file htmlgen.cpp.

{
  m_t << "<tr>";
}

References OutputGenerator::m_t.

◆ startDescTableTitle()

void HtmlGenerator::startDescTableTitle ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2803 of file htmlgen.cpp.

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

References OutputGenerator::m_t.

◆ startDirDepGraph()

void HtmlGenerator::startDirDepGraph ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2707 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 2619 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 DString &	fName,
		const DString &	manName,
		const DString &	anchor,
		const DString &	name,
		const DString &	args )

overridevirtual

Implements OutputGenIntf.

Definition at line 1864 of file htmlgen.cpp.

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

References OutputGenerator::m_t.

◆ startEmbeddedDoc()

void HtmlGenerator::startEmbeddedDoc ( size_t indent )

overridevirtual

Implements OutputGenIntf.

Definition at line 3635 of file htmlgen.cpp.

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

References DBG_HTML, and OutputGenerator::m_t.

◆ startEmphasis()

void HtmlGenerator::startEmphasis ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 211 of file htmlgen.h.

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

References OutputGenerator::m_t.

◆ startExamples()

void HtmlGenerator::startExamples ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2833 of file htmlgen.cpp.

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

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

◆ startFile()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 1643 of file htmlgen.cpp.

{
  //printf("HtmlGenerator::startFile(%s)\n",qPrint(name));
  m_relPath = relativePathToRoot(name);
  DString 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,DString(),isSource);
 
  m_t << "<!-- " << theTranslator->trGeneratedBy() << " Doxygen "
      << getDoxygenVersion() << " -->\n";
 
  bool generateTreeView  = Config_getBool(GENERATE_TREEVIEW);
  bool searchEngine      = Config_getBool(SEARCHENGINE);
  bool serverBasedSearch = Config_getBool(SERVER_BASED_SEARCH);
  bool disableIndex      = Config_getBool(DISABLE_INDEX);
  bool dynamicMenus      = Config_getBool(HTML_DYNAMIC_MENUS);
  bool fullSidebar       = Config_getBool(FULL_SIDEBAR);
 
  m_t << "<script type=\"application/json\" id=\"doxygen-config\">\n";
  m_t << "{\n";
  m_t << "  \"relPath\": \"" << m_relPath << "\",\n";
  m_t << "  \"generateTreeView\": " << (generateTreeView?"true":"false") << ",\n";
  m_t << "  \"searchEngine\": " << (searchEngine?"true":"false") << ",\n";
  m_t << "  \"serverBasedSearch\": " << (serverBasedSearch?"true":"false") << ",\n";
  m_t << "  \"disableIndex\": " << (disableIndex?"true":"false") << ",\n";
  m_t << "  \"dynamicMenus\": " << (dynamicMenus?"true":"false") << ",\n";
  m_t << "  \"fullSidebar\": " << (fullSidebar?"true":"false") << "\n";
  m_t << "}\n";
  m_t << "</script>\n";
 
  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(), IndexList::addIndexFile(), 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(), HtmlCodeGenerator::setFileName(), HtmlCodeGenerator::setRelativePath(), startPlainFile(), substituteHtmlKeywords(), theTranslator, and Translator::trGeneratedBy().

◆ startGroupCollaboration()

void HtmlGenerator::startGroupCollaboration ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2671 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 DString &	id,
		int	extraIndentLevel )

overridevirtual

Implements OutputGenIntf.

Definition at line 2003 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.empty())
  {
    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 3547 of file htmlgen.cpp.

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

References OutputGenerator::m_t.

◆ startInclDepGraph()

void HtmlGenerator::startInclDepGraph ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2653 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 2758 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 DString &	ref,
		const DString &	file )

overridevirtual

Implements OutputGenIntf.

Definition at line 1907 of file htmlgen.cpp.

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

References addHtmlExtensionIfMissing(), DString::empty(), externalLinkTarget(), externalRef(), m_relPath, and OutputGenerator::m_t.

◆ startIndexKey()

void HtmlGenerator::startIndexKey ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2423 of file htmlgen.cpp.

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

◆ startIndexList()

void HtmlGenerator::startIndexList ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2413 of file htmlgen.cpp.

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

References OutputGenerator::m_t.

◆ startIndexListItem()

void HtmlGenerator::startIndexListItem ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1897 of file htmlgen.cpp.

{
  m_t << "<li>";
}

References OutputGenerator::m_t.

◆ startIndexSection()

void HtmlGenerator::startIndexSection ( IndexSection )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 130 of file htmlgen.h.

130{}

◆ startIndexValue()

void HtmlGenerator::startIndexValue ( bool )

overridevirtual

Implements OutputGenIntf.

Definition at line 2433 of file htmlgen.cpp.

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

◆ startInlineHeader()

void HtmlGenerator::startInlineHeader ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3569 of file htmlgen.cpp.

{
  if (m_emptySection)
  {
    m_t << "<table class=\"memberdecls memberdecls-inline\">\n";
    m_emptySection=false;
  }
  m_t << "<tr><th colspan=\"2\"><h3>";
}

References m_emptySection, and OutputGenerator::m_t.

◆ startInlineMemberDoc()

void HtmlGenerator::startInlineMemberDoc ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3623 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 3611 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 3599 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 150 of file htmlgen.h.

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

References OutputGenerator::m_t.

◆ startItemListItem()

void HtmlGenerator::startItemListItem ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 165 of file htmlgen.h.

165{ m_t << "<li>"; }

References OutputGenerator::m_t.

◆ startLabels()

void HtmlGenerator::startLabels ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3647 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 3791 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 HtmlGenerator::TocState::indent, HtmlGenerator::TocState::inLi, HtmlGenerator::TocState::level, OutputGenerator::m_t, m_tocState, HtmlGenerator::TocState::maxLevel, theTranslator, and Translator::trRTFTableOfContents().

◆ startMemberDeclaration()

void HtmlGenerator::startMemberDeclaration ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 202 of file htmlgen.h.

202{}

◆ startMemberDescription()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 2321 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.empty())
  {
    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, DString::empty(), m_emptySection, and OutputGenerator::m_t.

◆ startMemberDoc()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 2453 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 2443 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 2482 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 2470 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 3584 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, theTranslator, Translator::trCompoundMembers(), and Translator::trEnumerationValues().

◆ startMemberGroup()

void HtmlGenerator::startMemberGroup ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2750 of file htmlgen.cpp.

2751{

2752}

◆ startMemberGroupDocs()

void HtmlGenerator::startMemberGroupDocs ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2740 of file htmlgen.cpp.

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

References OutputGenerator::m_t.

◆ startMemberGroupHeader()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 2730 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 DString &	anchor,
		int	typ )

overridevirtual

Implements OutputGenIntf.

Definition at line 2365 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.empty())
  {
    m_t << " id=\"header-" << anchor << "\"";
  }
  m_t << " class=\"groupheader\">";
  if (!anchor.empty())
  {
    m_t << "<a id=\"" << anchor << "\" name=\"" << anchor << "\"></a>\n";
  }
}

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

◆ startMemberItem()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 2243 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.empty())
  {
    if (dynamicSections) m_t << " inherit";
    m_t << " " << inheritId;
  }
  m_t << "\"";
  if (!anchor.empty())
  {
    m_t << " id=\"r_" << convertToId(anchor) << "\"";
  }
  m_t << ">";
  insertMemberAlignLeft(type, true);
}

References Config_getBool, convertToId(), DBG_HTML, DString::empty(), insertMemberAlignLeft(), m_emptySection, OutputGenerator::m_t, and type().

◆ startMemberList()

void HtmlGenerator::startMemberList ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2229 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 2348 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, and OutputGenerator::m_t.

◆ startMemberSubtitle()

void HtmlGenerator::startMemberSubtitle ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2396 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, m_emptySection, and OutputGenerator::m_t.

◆ startMemberTemplateParams()

void HtmlGenerator::startMemberTemplateParams ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 2276 of file htmlgen.cpp.

2277{

2278}

◆ startPageDoc()

void HtmlGenerator::startPageDoc ( const DString & pageTitle )

overridevirtual

Implements OutputGenIntf.

Definition at line 3268 of file htmlgen.cpp.

{
  m_t << "<div>";
}

References OutputGenerator::m_t.

◆ startPageRef()

void HtmlGenerator::startPageRef ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 245 of file htmlgen.h.

245{}

◆ startParagraph()

void HtmlGenerator::startParagraph ( const DString & classDef )

overridevirtual

Implements OutputGenIntf.

Definition at line 1879 of file htmlgen.cpp.

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

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

◆ startParameterDefVal()

void HtmlGenerator::startParameterDefVal ( const char * sep )

overridevirtual

Implements OutputGenIntf.

Definition at line 2570 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 2541 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 2498 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 2529 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 DString &	key )

overridevirtual

Implements OutputGenIntf.

Definition at line 2506 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 DString & name )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 331 of file htmlgen.h.

331{ OutputGenerator::startPlainFile(name); }

OutputGenerator::startPlainFile

void startPlainFile(const DString &name)

Definition outputgen.cpp:28

References OutputGenerator::startPlainFile().

Referenced by startFile(), and writeStyleInfo().

◆ startProjectNumber()

void HtmlGenerator::startProjectNumber ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1777 of file htmlgen.cpp.

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

References OutputGenerator::m_t.

◆ startQuickIndices()

void HtmlGenerator::startQuickIndices ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 247 of file htmlgen.h.

247{}

◆ startSection()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 2040 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, SectionType::level(), 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 233 of file htmlgen.h.

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

References OutputGenerator::m_t.

◆ startTextBlock()

void HtmlGenerator::startTextBlock ( bool )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 284 of file htmlgen.h.

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

References OutputGenerator::m_t.

◆ startTextLink()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 1986 of file htmlgen.cpp.

{
  m_t << "<a href=\"";
  DString fn = f;
  addHtmlExtensionIfMissing(fn);
  m_t << createHtmlUrl(m_relPath,"",
                       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 338 of file htmlgen.h.

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

References OutputGenerator::m_t.

Referenced by startTitleHead().

◆ startTitleHead()

void HtmlGenerator::startTitleHead ( const DString & )

overridevirtual

Implements OutputGenIntf.

Definition at line 3552 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 3813 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" + DString(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" + DString(cs) + "\">");
      }
      DString label = si->label();
      m_tocState.writeIndent(m_t);
      m_t  << "<a href=\"#"+label+"\">";
    }
  }
}

References HtmlGenerator::TocState::decIndent(), HtmlGenerator::TocState::incIndent(), HtmlGenerator::TocState::inLi, SectionType::isSection(), SectionInfo::label(), HtmlGenerator::TocState::level, SectionType::level(), OutputGenerator::m_t, m_tocState, HtmlGenerator::TocState::maxLevel, type(), SectionInfo::type(), and HtmlGenerator::TocState::writeIndent().

◆ startTypewriter()

void HtmlGenerator::startTypewriter ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 161 of file htmlgen.h.

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

References OutputGenerator::m_t.

◆ type()

OutputType HtmlGenerator::type ( ) const

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 119 of file htmlgen.h.

119{ return OutputType::Html; }

References Html.

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

◆ writeAnchor()

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

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 209 of file htmlgen.h.

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

References OutputGenerator::m_t.

◆ writeChar()

void HtmlGenerator::writeChar ( char c )

overridevirtual

Implements OutputGenIntf.

Definition at line 2113 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 2845 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, HtmlGenerator::TocState::maxLevel, and DocNodeAST::root.

◆ writeExternalSearchPage()

void HtmlGenerator::writeExternalSearchPage ( )

static

Definition at line 3383 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;
  DString dname               = Config_getString(HTML_OUTPUT);
  DString 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,DString(),DString(),false);
    }
    if (generateTreeView)
    {
      t << "</div><!-- top -->\n";
    }
    t << writeSplitBarAsString("search.php",DString(),DString());
    if (quickLinksAfterSplitbar)
    {
      writeDefaultQuickLinks(t,HighlightedItem::Search,DString(),DString(),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();
 
  DString 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
    StringVector extraSearchMappings = Config_getList(EXTRA_SEARCH_MAPPINGS);
    for (const auto &ml : extraSearchMappings)
    {
      DString mapLine(ml);
      if (size_t eqPos = mapLine.find('='); eqPos!=DString::npos) // tag command contains a destination
      {
        DString tagName = mapLine.left(eqPos).stripWhiteSpace();
        DString destName = mapLine.mid(eqPos+1).stripWhiteSpace();
        if (!tagName.empty())
        {
          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('searchresults');\n";
    t << "    if (results) {\n";
    t << "      results.innerHTML = '<p>" << theTranslator->trSearchResults(0) << "</p>';\n";
    t << "    }\n";
    t << "  }\n";
    t << "});\n";
  }
  else
  {
     err("Failed to open file '{}' for writing...\n",scriptName);
  }
}

References Config_getBool, Config_getList, Config_getString, DString::empty(), err, OutputGenerator::fileName(), DString::find(), g_header, g_header_file, ResourceMgr::getAsString(), Doxygen::htmlFileExtension, ResourceMgr::instance(), DString::left(), DString::mid(), DString::npos, Portable::openOutputStream(), Search, DString::stripWhiteSpace(), substituteHtmlKeywords(), theTranslator, Translator::trGeneratedBy(), Translator::trSearchResults(), Translator::trSearchResultsTitle(), writeDefaultQuickLinks(), writePageFooter(), and writeSplitBarAsString().

Referenced by generateOutput().

◆ writeFooter()

void HtmlGenerator::writeFooter ( const DString & navPath )

overridevirtual

Implements OutputGenIntf.

Definition at line 1767 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 1635 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 2725 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 DString &	cssname )

static

Definition at line 1629 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 DString &	id,
		const DString &	ref,
		const DString &	file,
		const DString &	anchor,
		const DString &	title,
		const DString &	name )

overridevirtual

Implements OutputGenIntf.

Definition at line 3699 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- writeInheritedSectionTitle -->\n";)
  bool dynamicSections = Config_getBool(HTML_DYNAMIC_SECTIONS);
  DString a = anchor;
  if (!a.empty()) a.prepend("#");
  DString classLink = DString("<a class=\"el\" ");
  if (!ref.empty())
  {
    classLink+= externalLinkTarget();
    classLink += " href=\"";
    classLink+= externalRef(m_relPath,ref);
  }
  else
  {
    classLink += "href=\"";
    classLink+=m_relPath;
  }
  DString fn = file;
  addHtmlExtensionIfMissing(fn);
  classLink=classLink+fn+a;
  classLink+=DString("\">")+convertToHtml(name,false)+"</a>";
  m_t << "<tr class=\"inherit_header " << id << "\">";
  if (dynamicSections)
  {
    m_t << "<td colspan=\"2\" class=\"dyn-inherit\">";
    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, DString::empty(), externalLinkTarget(), externalRef(), m_relPath, OutputGenerator::m_t, DString::prepend(), theTranslator, and Translator::trInheritedFrom().

◆ writeLabel()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 3653 of file htmlgen.cpp.

{
  DBG_HTML(m_t << "<!-- writeLabel(" << label << ") -->\n";)
 
  auto convertLabelToClass = [](const std::string &lab) {
    DString input = convertUTF8ToLower(lab);
    DString 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 (static_cast<signed char>(c)<0 || (c>='a' && c<='z') || c=='_') // nmstart pattern
      {
        nmstart=true;
        result+=c;
      }
      else if (nmstart && (static_cast<signed char>(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 DString::at(), convertUTF8ToLower(), DBG_HTML, DString::length(), OutputGenerator::m_t, DString::reserve(), DString::str(), and DString::stripWhiteSpace().

◆ writeLatexSpacing()

void HtmlGenerator::writeLatexSpacing ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 228 of file htmlgen.h.

228{}

◆ writeLogo()

void HtmlGenerator::writeLogo ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1756 of file htmlgen.cpp.

{
  m_t << writeLogoAsString(m_relPath);
}

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

◆ writeLogoAsString()

DString HtmlGenerator::writeLogoAsString ( const DString & path )

static

Definition at line 1734 of file htmlgen.cpp.

{
  DString 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(), theTranslator, Translator::trGeneratedAt(), and Translator::trGeneratedBy().

Referenced by writeLogo(), and writeSearchPage().

◆ writeNavigationPath()

void HtmlGenerator::writeNavigationPath ( const DString & s )

overridevirtual

Implements OutputGenIntf.

Definition at line 3253 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 2775 of file htmlgen.cpp.

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

References OutputGenerator::m_t.

◆ writeObjectLink()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 1962 of file htmlgen.cpp.

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

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

◆ writePageFooter()

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

staticprivate

Definition at line 1761 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 DString &	,
		bool	)

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 132 of file htmlgen.h.

132{}

◆ writePageOutline()

void HtmlGenerator::writePageOutline ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 3765 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 DString &	file,
		bool	extraTabs )

overridevirtual

Implements OutputGenIntf.

Definition at line 3278 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 208 of file htmlgen.h.

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

References OutputGenerator::m_t.

◆ writeSearchData()

void HtmlGenerator::writeSearchData ( const DString & dir )

static

Definition at line 1461 of file htmlgen.cpp.

{
  //bool serverBasedSearch = Config_getBool(SERVER_BASED_SEARCH);
  //writeImgData(dname,serverBasedSearch ? search_server_data : search_client_data);
  ResourceMgr &mgr = ResourceMgr::instance();
 
  DString searchDirName = dname;
  std::ofstream f = Portable::openOutputStream(searchDirName+"/search.css");
  if (f.is_open())
  {
    TextStream t(&f);
    DString 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 IndexList::addStyleSheetFile(), 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 1728 of file htmlgen.cpp.

{
  writeSearchInfoStatic(m_t,m_relPath);
}

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

◆ writeSearchInfoStatic()

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

static

Definition at line 1701 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 << "</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, theTranslator, Translator::trLoading(), Translator::trNoMatches(), and Translator::trSearching().

Referenced by writeSearchInfo().

◆ writeSearchPage()

void HtmlGenerator::writeSearchPage ( )

static

Definition at line 3284 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;
  DString projectName         = Config_getString(PROJECT_NAME);
  DString htmlOutput          = Config_getString(HTML_OUTPUT);
 
  // OPENSEARCH_PROVIDER {
  DString 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 }
 
  DString 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,DString(),DString(),false);
    }
    if (generateTreeView)
    {
      t << "</div><!-- top -->\n";
    }
    t << writeSplitBarAsString("search.php",DString(),DString());
    if (quickLinksAfterSplitbar)
    {
      writeDefaultQuickLinks(t,HighlightedItem::Search,DString(),DString(),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();
 
  DString 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, Translator::trGeneratedBy(), Translator::trSearch(), Translator::trSearchMatches(), Translator::trSearchResults(), Translator::trSearchResultsTitle(), writeDefaultQuickLinks(), writeLogoAsString(), writePageFooter(), and writeSplitBarAsString().

Referenced by generateOutput().

◆ writeSplitBar()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 3248 of file htmlgen.cpp.

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

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

◆ writeSplitBarAsString()

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

static

Definition at line 3214 of file htmlgen.cpp.

{
  bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
  DString result;
  // write split bar
  if (generateTreeView)
  {
    DString fn = name;
    addHtmlExtensionIfMissing(fn);
    if (!Config_getBool(FULL_SIDEBAR))
    {
      result += DString(
        "<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\" 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 DString &	type,
		const DString &	file,
		const DString &	path,
		const DString &	name )

overridevirtual

Implements OutputGenIntf.

Definition at line 1950 of file htmlgen.cpp.

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

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

◆ writeString()

void HtmlGenerator::writeString ( const DString & text )

overridevirtual

Implements OutputGenIntf.

Definition at line 1892 of file htmlgen.cpp.

{
  m_t << text;
}

References OutputGenerator::m_t.

◆ writeStyleInfo()

void HtmlGenerator::writeStyleInfo ( int part )

overridevirtual

Implements OutputGenIntf.

Definition at line 1787 of file htmlgen.cpp.

{
  //printf("writeStyleInfo(%d)\n",part);
  if (part==0)
  {
    if (Config_getString(HTML_STYLESHEET).empty()) // 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
    {
      DString 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
          DString fileStr = fileToString(cssName);
          // write the string into the output dir
          startPlainFile(cssfi.fileName());
          m_t << fileStr;
          endPlainFile();
        }
        Doxygen::indexList->addStyleSheetFile(cssfi.fileName());
      }
    }
    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 (useDynamicSections())
    {
      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 IndexList::addStyleSheetFile(), Config_getBool, Config_getEnum, Config_getList, Config_getString, DString::empty(), endPlainFile(), err, FileInfo::exists(), FileInfo::fileName(), OutputGenerator::fileName(), fileToString(), Doxygen::indexList, FileInfo::isFile(), FileInfo::isReadable(), OutputGenerator::m_t, startPlainFile(), DString::startsWith(), DString::str(), useDynamicSections(), and writeDefaultStyleSheet().

◆ writeStyleSheetFile()

void HtmlGenerator::writeStyleSheetFile ( TextStream & t )

static

Definition at line 1623 of file htmlgen.cpp.

{
  fillColorStyleMaps();
  writeDefaultStyleSheet(t);
}

References fillColorStyleMaps(), and writeDefaultStyleSheet().

Referenced by readConfiguration().

◆ writeSummaryLink()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 3738 of file htmlgen.cpp.

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

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

◆ writeSynopsis()

void HtmlGenerator::writeSynopsis ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 242 of file htmlgen.h.

242{}

◆ writeTabData()

void HtmlGenerator::writeTabData ( )

static

Additional initialization after indices have been created.

Definition at line 1445 of file htmlgen.cpp.

{
  Doxygen::indexList->addStyleSheetFile("tabs.css");
  DString dname=Config_getString(HTML_OUTPUT);
  ResourceMgr &mgr = ResourceMgr::instance();
  mgr.copyResource("doxygen.svg",dname);
  Doxygen::indexList->addImageFile("doxygen.svg");
  if (Config_getBool(SEARCHENGINE) && Config_getBool(SERVER_BASED_SEARCH))
  {
    mgr.copyResource("MaterialSymbolsOutlined.min.woff2",dname);
    Doxygen::indexList->addImageFile("MaterialSymbolsOutlined.min.woff2");
    mgr.copyResource("MaterialSymbolsOutlined_LICENSE.txt",dname);
    Doxygen::indexList->addImageFile("MaterialSymbolsOutlined_LICENSE.txt");
  }
}

References IndexList::addImageFile(), IndexList::addStyleSheetFile(), Config_getBool, 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 349 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 348 of file htmlgen.h.

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

◆ m_emptySection

bool HtmlGenerator::m_emptySection = false

private

Definition at line 347 of file htmlgen.h.

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

◆ m_lastFile

DString HtmlGenerator::m_lastFile

private

Definition at line 344 of file htmlgen.h.

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

◆ m_lastTitle

DString HtmlGenerator::m_lastTitle

private

Definition at line 343 of file htmlgen.h.

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

◆ m_pageOutlineIndent

int HtmlGenerator::m_pageOutlineIndent = 0

private

Definition at line 350 of file htmlgen.h.

◆ m_relPath

DString HtmlGenerator::m_relPath

private

◆ m_sectionCount

int HtmlGenerator::m_sectionCount = 0

private

Definition at line 346 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 362 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

Classes

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HtmlGenerator() [1/3]

◆ HtmlGenerator() [2/3]

◆ HtmlGenerator() [3/3]

◆ ~HtmlGenerator()

Member Function Documentation

◆ addCodeGen()

◆ addIndexItem()

◆ addLabel()

◆ cleanup()

◆ clearBuffer()

◆ clone()

◆ docify()

◆ docify_()

◆ endAnonTypeScope()

◆ endBold()

◆ endCallGraph()

◆ endCenter()

◆ endClassDiagram()

◆ endCompoundTemplateParams()

◆ endConstraintDocs()

◆ endConstraintList()

◆ endConstraintParam()

◆ endConstraintType()

◆ endContents()

◆ endDescForItem()

◆ endDescTable()

◆ endDescTableData()

◆ endDescTableInit()

◆ endDescTableRow()

◆ endDescTableTitle()

◆ endDirDepGraph()

◆ endDotGraph()

◆ endDoxyAnchor()

◆ endEmbeddedDoc()

◆ endEmphasis()

◆ endExamples()

◆ endFile()

◆ endGroupCollaboration()

◆ endGroupHeader()

◆ endHeaderSection()

◆ endInclDepGraph()

◆ endIndent()

◆ endIndexItem()

◆ endIndexKey()

◆ endIndexList()

◆ endIndexListItem()

◆ endIndexSection()

◆ endIndexValue()

◆ endInlineHeader()

◆ endInlineMemberDoc()

◆ endInlineMemberName()

◆ endInlineMemberType()

◆ endItemList()

◆ endItemListItem()

◆ endLabels()

◆ endLocalToc()

◆ endMemberDeclaration()

◆ endMemberDescription()

◆ endMemberDoc()

◆ endMemberDocList()

◆ endMemberDocName()

◆ endMemberDocPrefixItem()

◆ endMemberDocSimple()

◆ endMemberGroup()

◆ endMemberGroupDocs()

◆ endMemberGroupHeader()

◆ endMemberHeader()

◆ endMemberItem()

◆ endMemberList()

◆ endMemberSections()

◆ endMemberSubtitle()