htmlgen.cpp File Reference

#include "htmlgen.h"
#include <functional>
#include <memory>
#include <mutex>
#include "config.h"
#include "datetime.h"
#include "diagram.h"
#include "dir.h"
#include "dotcallgraph.h"
#include "dotclassgraph.h"
#include "dotdirdeps.h"
#include "dotgfxhierarchytable.h"
#include "dotgroupcollaboration.h"
#include "dotincldepgraph.h"
#include "doxygen.h"
#include "fileinfo.h"
#include "htmldocvisitor.h"
#include "indexlist.h"
#include "language.h"
#include "layout.h"
#include "mermaid.h"
#include "message.h"
#include "outputlist.h"
#include "pagedef.h"
#include "portable.h"
#include "resourcemgr.h"
#include "stringutil.h"
#include "textstream.h"
#include "utf8.h"
#include "util.h"
#include "version.h"
#include "vhdldocgen.h"

Include dependency graph for htmlgen.cpp:

Go to the source code of this file.

Macros
#define	DBG_HTML(x)

Functions
static bool	useDynamicSections ()
static void	writeClientSearchBox (TextStream &t, const DString &relPath)
static void	writeServerSearchBox (TextStream &t, const DString &relPath, bool highlightSearch)
static DString	getConvertLatexMacro ()
	Convert a set of LaTeX commands \(re)newcommand to a form readable by MathJax LaTeX syntax:
static DString	getSearchBox (bool serverSide, DString relPath, bool highlightSearch)
static DString	substituteHtmlKeywords (const DString &file, const DString &str, const DString &title, const DString &relPath, const DString &navPath=DString(), bool isSource=false)
static void	fillColorStyleMap (const DString &definitions, StringUnorderedMap &map)
static void	fillColorStyleMaps ()
static DString	replaceVariables (const DString &input)
static bool	hasDateReplacement (const DString &str)
static void	writeDefaultStyleSheet (TextStream &t)
static void	startSectionHeader (TextStream &t, const DString &relPath, int sectionCount)
static void	endSectionHeader (TextStream &t)
static void	startSectionSummary (TextStream &t, int sectionCount)
static void	endSectionSummary (TextStream &t)
static void	startSectionContent (TextStream &t, int sectionCount)
static void	endSectionContent (TextStream &t)
static void	startQuickIndexList (TextStream &t, bool topLevel=true)
static void	endQuickIndexList (TextStream &t)
static void	startQuickIndexItem (TextStream &t, const DString &l, bool hl, bool, const DString &relPath)
static void	endQuickIndexItem (TextStream &t, const DString &l)
static bool	quickLinkVisible (LayoutNavEntry::Kind kind)
static void	renderQuickLinksAsTree (TextStream &t, const DString &relPath, LayoutNavEntry *root)
static void	renderQuickLinksAsTabs (TextStream &t, const DString &relPath, LayoutNavEntry *hlEntry, LayoutNavEntry::Kind kind, bool highlightParent, bool highlightSearch)
static void	writeDefaultQuickLinks (TextStream &t, HighlightedItem hli, const DString &file, const DString &relPath, bool extraTabs)

Variables
static DString	g_header
static DString	g_header_file
static DString	g_footer_file
static DString	g_footer
static DString	g_mathjax_code
static DString	g_latex_macro
static bool	g_build_date = false
static constexpr auto	hex ="0123456789ABCDEF"
static const SelectionMarkerInfo	htmlMarkerInfo = { '<', "<!--BEGIN ",10,"<!--END ",8,"-->",3 }
static StringUnorderedMap	g_lightMap
static StringUnorderedMap	g_darkMap
static std::mutex	g_indexLock

Macro Definition Documentation

DBG_HTML

#define DBG_HTML

(

x

)

Definition at line 55 of file htmlgen.cpp.

Referenced by HtmlGenerator::endEmbeddedDoc(), HtmlGenerator::endIndent(), HtmlGenerator::endInlineMemberDoc(), HtmlGenerator::endInlineMemberName(), HtmlGenerator::endInlineMemberType(), HtmlGenerator::endLabels(), HtmlGenerator::endMemberDescription(), HtmlGenerator::endMemberDoc(), HtmlGenerator::endMemberDocList(), HtmlGenerator::endMemberDocName(), HtmlGenerator::endMemberDocPrefixItem(), HtmlGenerator::endMemberDocSimple(), HtmlGenerator::endMemberHeader(), HtmlGenerator::endMemberList(), HtmlGenerator::endMemberSections(), HtmlGenerator::endMemberSubtitle(), HtmlGenerator::endParameterExtra(), HtmlGenerator::endParameterList(), HtmlGenerator::endParameterName(), HtmlGenerator::endParameterType(), HtmlGenerator::exceptionEntry(), HtmlGenerator::insertMemberAlign(), HtmlGenerator::startEmbeddedDoc(), HtmlGenerator::startIndent(), HtmlGenerator::startInlineMemberDoc(), HtmlGenerator::startInlineMemberName(), HtmlGenerator::startInlineMemberType(), HtmlGenerator::startLabels(), HtmlGenerator::startMemberDescription(), HtmlGenerator::startMemberDoc(), HtmlGenerator::startMemberDocList(), HtmlGenerator::startMemberDocName(), HtmlGenerator::startMemberDocPrefixItem(), HtmlGenerator::startMemberDocSimple(), HtmlGenerator::startMemberHeader(), HtmlGenerator::startMemberItem(), HtmlGenerator::startMemberList(), HtmlGenerator::startMemberSections(), HtmlGenerator::startMemberSubtitle(), HtmlGenerator::startParameterExtra(), HtmlGenerator::startParameterList(), HtmlGenerator::startParameterName(), HtmlGenerator::startParameterType(), HtmlGenerator::writeInheritedSectionTitle(), and HtmlGenerator::writeLabel().

Function Documentation

endQuickIndexItem()

void endQuickIndexItem ( TextStream & t, const DString & l )

static

Definition at line 2905 of file htmlgen.cpp.

{
  t << "</span>";
  if (!l.empty()) t << "</a>";
  t << "</li>\n";
}

References DString::empty().

Referenced by renderQuickLinksAsTabs().

endQuickIndexList()

void endQuickIndexList ( TextStream & t )

static

Definition at line 2878 of file htmlgen.cpp.

{
  if (!Config_getBool(DISABLE_INDEX))
  {
    t << "    </ul>\n";
    t << "  </div>\n";
  }
  else
  {
    t << "</ul>\n";
  }
}

References Config_getBool.

Referenced by renderQuickLinksAsTabs(), and renderQuickLinksAsTree().

endSectionContent()

void endSectionContent ( TextStream & t )

static

Definition at line 2182 of file htmlgen.cpp.

{
  //t << "<!-- endSectionContent -->";
  t << "</div>\n";
}

Referenced by HtmlGenerator::endCallGraph(), HtmlGenerator::endClassDiagram(), HtmlGenerator::endDirDepGraph(), HtmlGenerator::endDotGraph(), HtmlGenerator::endGroupCollaboration(), and HtmlGenerator::endInclDepGraph().

endSectionHeader()

void endSectionHeader ( TextStream & t )

static

Definition at line 2140 of file htmlgen.cpp.

{
  //t << "<!-- endSectionHeader -->";
  t << "</div>\n";
}

Referenced by HtmlGenerator::endCallGraph(), HtmlGenerator::endClassDiagram(), HtmlGenerator::endDirDepGraph(), HtmlGenerator::endDotGraph(), HtmlGenerator::endGroupCollaboration(), and HtmlGenerator::endInclDepGraph().

endSectionSummary()

void endSectionSummary ( TextStream & t )

static

Definition at line 2157 of file htmlgen.cpp.

{
  //t << "<!-- endSectionSummary -->";
  bool dynamicSections = Config_getBool(HTML_DYNAMIC_SECTIONS);
  if (dynamicSections)
  {
    t << "</div>\n";
  }
}

References Config_getBool.

Referenced by HtmlGenerator::endCallGraph(), HtmlGenerator::endClassDiagram(), HtmlGenerator::endDirDepGraph(), HtmlGenerator::endDotGraph(), HtmlGenerator::endGroupCollaboration(), and HtmlGenerator::endInclDepGraph().

fillColorStyleMap()

void fillColorStyleMap ( const DString & definitions, StringUnorderedMap & map )

static

Definition at line 749 of file htmlgen.cpp.

{
  size_t p=0,i=0;
  while ((i=definitions.find('\n',p))!=DString::npos)
  {
    DString line = definitions.mid(p,i-p);
    if (line.startsWith("--"))
    {
      size_t separator = line.find(':');
      ASSERT(separator!=DString::npos);
      std::string key = line.left(separator).str();
      size_t semi = line.rfind(';');
      ASSERT(semi!=DString::npos);
      std::string value = line.mid(separator+1,semi-separator-1).stripWhiteSpace().str();
      map.emplace(key,value);
      //printf("var(%s)=%s\n",qPrint(key),qPrint(value));
    }
    p=i+1;
  }
}

References ASSERT, DString::find(), DString::left(), DString::mid(), DString::npos, DString::rfind(), DString::startsWith(), DString::str(), and DString::stripWhiteSpace().

Referenced by fillColorStyleMaps().

fillColorStyleMaps()

void fillColorStyleMaps ( )

static

Definition at line 770 of file htmlgen.cpp.

{
  ResourceMgr &mgr = ResourceMgr::instance();
  auto colorStyle = Config_getEnum(HTML_COLORSTYLE);
  if (colorStyle==HTML_COLORSTYLE_t::LIGHT)
  {
    fillColorStyleMap(replaceColorMarkers(mgr.getAsString("lightmode_settings.css")),g_lightMap);
  }
  else if (colorStyle==HTML_COLORSTYLE_t::DARK)
  {
    fillColorStyleMap(replaceColorMarkers(mgr.getAsString("darkmode_settings.css")),g_darkMap);
  }
}

References Config_getEnum, fillColorStyleMap(), g_darkMap, g_lightMap, ResourceMgr::getAsString(), ResourceMgr::instance(), and replaceColorMarkers().

Referenced by HtmlGenerator::init(), and HtmlGenerator::writeStyleSheetFile().

getConvertLatexMacro()

DString getConvertLatexMacro ( )

static

Convert a set of LaTeX commands \(re)newcommand to a form readable by MathJax LaTeX syntax:

\newcommand{\cmd}{replacement}
  or
\renewcommand{\cmd}{replacement}

MathJax syntax:

cmd: "{replacement}"

LaTeX syntax:

\newcommand{\cmd}[nr]{replacement}
  or
\renewcommand{\cmd}[nr]{replacement}

MathJax syntax:

cmd: ["{replacement}",nr]

Definition at line 143 of file htmlgen.cpp.

{
  DString macrofile = Config_getString(FORMULA_MACROFILE);
  if (macrofile.empty()) return "";
  DString s = fileToString(macrofile);
  macrofile = FileInfo(macrofile.str()).absFilePath();
  size_t size = s.length();
  DString result;
  result.reserve(size+8);
  const char *data = s.data();
  int line = 1;
  int cnt = 0;
  size_t i = 0;
  DString nr;
  while (i < size)
  {
    nr = "";
    // skip initial white space, but count lines
    while (i < size && (data[i] == ' ' || data[i] == '\t' || data[i] == '\n'))
    {
      if (data[i] == '\n') line++;
      i++;
    }
    if (i >= size) break;
    // check for \newcommand or \renewcommand
    if (data[i] != '\\')
    {
      warn(macrofile,line, "file contains non valid code, expected '\\' got '{:c}'",data[i]);
      return "";
    }
    i++;
    if (literal_at(data+i,"newcommand"))
    {
      i += strlen("newcommand");
    }
    else if (literal_at(data+i,"renewcommand"))
    {
      i += strlen("renewcommand");
    }
    else
    {
      warn(macrofile,line, "file contains non valid code, expected 'newcommand' or 'renewcommand'");
      return "";
    }
    // handle {cmd}
    if (data[i] != '{')
    {
      warn(macrofile,line, "file contains non valid code, expected '{{' got '{:c}'",data[i]);
      return "";
    }
    i++;
    if (data[i] != '\\')
    {
      warn(macrofile,line, "file contains non valid code, expected '\\' got '{:c}'",data[i]);
      return "";
    }
    i++;
    // run till }, i.e. cmd
    result+="    ";
    while (i < size && (data[i] != '}')) result+=data[i++];
    if (i >= size)
    {
      warn(macrofile,line, "file contains non valid code, no closing '}}' for command");
      return "";
    }
    result+=": ";
    i++;
 
    if (data[i] == '[')
    {
      // handle [nr]
      // run till ]
      result+='[';
      i++;
      while (i < size && (data[i] != ']')) nr += data[i++];
      if (i >= size)
      {
        warn(macrofile,line, "file contains non valid code, no closing ']'");
        return "";
      }
      i++;
    }
    else if (data[i] != '{')
    {
      warn(macrofile,line, "file contains non valid code, expected '[' or '{{' got '{:c}'",data[i]);
      return "";
    }
    // handle {replacement}
    // retest as the '[' part might have advanced so we can have a new '{'
    if (data[i] != '{')
    {
      warn(macrofile,line, "file contains non valid code, expected '{{' got '{:c}'",data[i]);
      return "";
    }
    result+="\"{";
    i++;
    // run till }
    cnt = 1;
    while (i < size && cnt)
    {
      switch(data[i])
      {
        case '\\':
          result+="\\\\"; // need to escape it for MathJax js code
          i++;
          if (data[i] == '\\') // we have an escaped backslash
          {
            result+="\\\\";
            i++;
          }
          else if (data[i] != '"') result+=data[i++]; // double quote handled separately
          break;
        case '{':
          cnt++;
          result+=data[i++];
          break;
        case '}':
          cnt--;
          if (cnt) result+=data[i];
          i++;
          break;
        case '"':
          result+='\\'; // need to escape it for MathJax js code
          result+=data[i++];
          break;
        case '\n':
          line++;
          result+=data[i++];
          break;
        default:
          result+=data[i++];
          break;
      }
    }
    if (i > size)
    {
      warn(macrofile,line, "file contains non valid code, no closing '}}' for replacement");
      return "";
    }
    result+="}\"";
    if (!nr.empty())
    {
      result+=',';
      result+=nr;
      result+=']';
    }
    result+=",\n";
  }
  return result;
}

References FileInfo::absFilePath(), Config_getString, DString::data(), DString::empty(), fileToString(), DString::length(), literal_at(), DString::reserve(), DString::str(), and warn.

Referenced by HtmlGenerator::init().

getSearchBox()

DString getSearchBox ( bool serverSide, DString relPath, bool highlightSearch )

static

Definition at line 294 of file htmlgen.cpp.

{
  TextStream t;
  if (serverSide)
  {
    writeServerSearchBox(t, relPath, highlightSearch);
  }
  else
  {
    writeClientSearchBox(t, relPath);
  }
  return t.str();
}

References TextStream::str(), writeClientSearchBox(), and writeServerSearchBox().

Referenced by substituteHtmlKeywords(), and writeDefaultQuickLinks().

hasDateReplacement()

bool hasDateReplacement ( const DString & str )

static

Definition at line 1272 of file htmlgen.cpp.

{
  return (str.contains("$datetime",false) ||
          str.contains("$date",false) ||
          str.contains("$time",false) ||
          str.contains("$year",false)
         );
}

References DString::contains().

Referenced by HtmlGenerator::init().

quickLinkVisible()

bool quickLinkVisible ( LayoutNavEntry::Kind kind )

static

Definition at line 2912 of file htmlgen.cpp.

{
  const auto &index = Index::instance();
  bool showNamespaces = Config_getBool(SHOW_NAMESPACES);
  bool showFiles = Config_getBool(SHOW_FILES);
  switch (kind)
  {
    case LayoutNavEntry::MainPage:           return true;
    case LayoutNavEntry::User:               return true;
    case LayoutNavEntry::UserGroup:          return true;
    case LayoutNavEntry::Pages:              return index.numIndexedPages()>0;
    case LayoutNavEntry::Topics:             return index.numDocumentedGroups()>0;
    case LayoutNavEntry::Modules:            return index.numDocumentedModules()>0;
    case LayoutNavEntry::ModuleList:         return index.numDocumentedModules()>0;
    case LayoutNavEntry::ModuleMembers:      return index.numDocumentedModuleMembers(ModuleMemberHighlight::All)>0;
    case LayoutNavEntry::Namespaces:         return showNamespaces && index.numDocumentedNamespaces()>0;
    case LayoutNavEntry::NamespaceList:      return showNamespaces && index.numDocumentedNamespaces()>0;
    case LayoutNavEntry::NamespaceMembers:   return showNamespaces && index.numDocumentedNamespaceMembers(NamespaceMemberHighlight::All)>0;
    case LayoutNavEntry::Concepts:           return index.numDocumentedConcepts()>0;
    case LayoutNavEntry::Classes:            return index.numAnnotatedClasses()>0;
    case LayoutNavEntry::ClassList:          return index.numAnnotatedClasses()>0;
    case LayoutNavEntry::ClassIndex:         return index.numAnnotatedClasses()>0;
    case LayoutNavEntry::ClassHierarchy:     return index.numHierarchyClasses()>0;
    case LayoutNavEntry::ClassMembers:       return index.numDocumentedClassMembers(ClassMemberHighlight::All)>0;
    case LayoutNavEntry::Files:              return showFiles && index.numDocumentedFiles()>0;
    case LayoutNavEntry::FileList:           return showFiles && index.numDocumentedFiles()>0;
    case LayoutNavEntry::FileGlobals:        return showFiles && index.numDocumentedFileMembers(FileMemberHighlight::All)>0;
    case LayoutNavEntry::Examples:           return !Doxygen::exampleLinkedMap->empty();
    case LayoutNavEntry::Interfaces:         return index.numAnnotatedInterfaces()>0;
    case LayoutNavEntry::InterfaceList:      return index.numAnnotatedInterfaces()>0;
    case LayoutNavEntry::InterfaceIndex:     return index.numAnnotatedInterfaces()>0;
    case LayoutNavEntry::InterfaceHierarchy: return index.numHierarchyInterfaces()>0;
    case LayoutNavEntry::Structs:            return index.numAnnotatedStructs()>0;
    case LayoutNavEntry::StructList:         return index.numAnnotatedStructs()>0;
    case LayoutNavEntry::StructIndex:        return index.numAnnotatedStructs()>0;
    case LayoutNavEntry::Exceptions:         return index.numAnnotatedExceptions()>0;
    case LayoutNavEntry::ExceptionList:      return index.numAnnotatedExceptions()>0;
    case LayoutNavEntry::ExceptionIndex:     return index.numAnnotatedExceptions()>0;
    case LayoutNavEntry::ExceptionHierarchy: return index.numHierarchyExceptions()>0;
    case LayoutNavEntry::None:             // should never happen, means not properly initialized
      ASSERT(kind != LayoutNavEntry::None);
      return false;
  }
  return false;
}

References ClassMemberHighlight::All, FileMemberHighlight::All, ModuleMemberHighlight::All, NamespaceMemberHighlight::All, ASSERT, Config_getBool, LinkedMap< T, Hash, KeyEqual, Map >::empty(), Doxygen::exampleLinkedMap, and Index::instance().

Referenced by renderQuickLinksAsTabs(), and renderQuickLinksAsTree().

renderQuickLinksAsTabs()

void renderQuickLinksAsTabs ( TextStream & t, const DString & relPath, LayoutNavEntry * hlEntry, LayoutNavEntry::Kind kind, bool highlightParent, bool highlightSearch )

static

Definition at line 2987 of file htmlgen.cpp.

{
  if (hlEntry->parent()) // first draw the tabs for the parent of hlEntry
  {
    renderQuickLinksAsTabs(t,relPath,hlEntry->parent(),kind,highlightParent,highlightSearch);
  }
  if (hlEntry->parent() && !hlEntry->parent()->children().empty()) // draw tabs for row containing hlEntry
  {
    bool topLevel = hlEntry->parent()->parent()==nullptr;
    int count=0;
    for (const auto &entry : hlEntry->parent()->children())
    {
      if (entry->visible() && quickLinkVisible(entry->kind())) count++;
    }
    if (count>0) // at least one item is visible
    {
      startQuickIndexList(t,topLevel);
      for (const auto &entry : hlEntry->parent()->children())
      {
        if (entry->visible() && quickLinkVisible(entry->kind()))
        {
          DString url = entry->url();
          startQuickIndexItem(t,url,
              entry.get()==hlEntry  &&
              (!entry->children().empty() ||
               (entry->kind()==kind && !highlightParent)
              ),
              true,relPath);
          t << HtmlGenerator::fixSpaces(entry->title());
          endQuickIndexItem(t,url);
        }
      }
      if (hlEntry->parent()==LayoutDocManager::instance().rootNavEntry()) // first row is special as it contains the search box
      {
        bool searchEngine      = Config_getBool(SEARCHENGINE);
        bool serverBasedSearch = Config_getBool(SERVER_BASED_SEARCH);
        bool disableIndex      = Config_getBool(DISABLE_INDEX);
        bool generateTreeView  = Config_getBool(GENERATE_TREEVIEW);
        bool fullSidebar       = Config_getBool(FULL_SIDEBAR);
        // case where DISABLE_INDEX=NO & GENERATE_TREEVIEW=YES & FULL_SIDEBAR=YES has search box in the side panel
        if (searchEngine)
        {
          t << "      <li>\n";
          if (disableIndex || !generateTreeView || !fullSidebar)
          {
            if (!serverBasedSearch) // pure client side search
            {
              writeClientSearchBox(t,relPath);
              t << "      </li>\n";
            }
            else // server based search
            {
              writeServerSearchBox(t,relPath,highlightSearch);
              if (!highlightSearch)
              {
                t << "      </li>\n";
              }
            }
          }
          else
          {
            t << "      </li>\n";
          }
        }
        if (!highlightSearch || Config_getBool(FULL_SIDEBAR))
          // on the search page the index will be ended by the page itself if the search box is part of the navigation bar
        {
          endQuickIndexList(t);
        }
      }
      else // normal case for other rows than first one
      {
        endQuickIndexList(t);
      }
    }
  }
}

References LayoutNavEntry::children(), Config_getBool, endQuickIndexItem(), endQuickIndexList(), HtmlGenerator::fixSpaces(), LayoutDocManager::instance(), LayoutNavEntry::parent(), quickLinkVisible(), renderQuickLinksAsTabs(), LayoutDocManager::rootNavEntry(), startQuickIndexItem(), startQuickIndexList(), writeClientSearchBox(), and writeServerSearchBox().

Referenced by renderQuickLinksAsTabs(), and writeDefaultQuickLinks().

renderQuickLinksAsTree()

void renderQuickLinksAsTree ( TextStream & t, const DString & relPath, LayoutNavEntry * root )

static

Definition at line 2958 of file htmlgen.cpp.

{
  int count=0;
  for (const auto &entry : root->children())
  {
    if (entry->visible() && quickLinkVisible(entry->kind())) count++;
  }
  if (count>0) // at least one item is visible
  {
    startQuickIndexList(t);
    for (const auto &entry : root->children())
    {
      if (entry->visible() && quickLinkVisible(entry->kind()))
      {
        DString url = entry->url();
        t << "<li><a href=\"" << relPath << url << "\"><span>";
        t << HtmlGenerator::fixSpaces(entry->title());
        t << "</span></a>\n";
        // recursive into child list
        renderQuickLinksAsTree(t,relPath,entry.get());
        t << "</li>";
      }
    }
    endQuickIndexList(t);
  }
}

References LayoutNavEntry::children(), endQuickIndexList(), HtmlGenerator::fixSpaces(), quickLinkVisible(), renderQuickLinksAsTree(), and startQuickIndexList().

Referenced by renderQuickLinksAsTree(), and writeDefaultQuickLinks().

replaceVariables()

DString replaceVariables ( const DString & input )

static

Definition at line 784 of file htmlgen.cpp.

{
  auto doReplacements = [&input](const StringUnorderedMap &mapping) -> DString
  {
    DString result;
    result.reserve(input.length());
    size_t p=0,i=0;
    while ((i=input.find("var(",p))!=DString::npos)
    {
      result+=input.mid(p,i-p);
      size_t j=input.find(")",i+4);
      ASSERT(j!=DString::npos);
      auto it = mapping.find(input.mid(i+4,j-i-4).str()); // find variable
      if (it==mapping.end())
      {                            // should be found
        err("failed to find value variable {}. It is not longer defined in doxygen.css\n",input.mid(i+4,j-i-4));
      }
      else
      {
        //printf("replace '%s' by '%s'\n",qPrint(input.mid(i+4,j-i-4)),qPrint(it->second));
        result+=it->second;                          // add it value
      }
      p=j+1;
    }
    result+=input.mid(p,input.length()-p);
    return result;
  };
 
  auto colorStyle = Config_getEnum(HTML_COLORSTYLE);
  if (colorStyle==HTML_COLORSTYLE_t::LIGHT)
  {
    return doReplacements(g_lightMap);
  }
  else if (colorStyle==HTML_COLORSTYLE_t::DARK)
  {
    return doReplacements(g_darkMap);
  }
  else
  {
    return input;
  }
}

References ASSERT, Config_getEnum, err, DString::find(), g_darkMap, g_lightMap, DString::length(), DString::mid(), DString::npos, DString::reserve(), and DString::str().

Referenced by HtmlGenerator::getNavTreeCss(), HtmlGenerator::init(), writeDefaultStyleSheet(), and HtmlGenerator::writeSearchData().

startQuickIndexItem()

void startQuickIndexItem ( TextStream & t, const DString & l, bool hl, bool , const DString & relPath )

static

Definition at line 2891 of file htmlgen.cpp.

{
  t << "      <li";
  if (hl)
  {
    t << " class=\"current\"";
  }
  t << ">";
  if (!l.empty()) t << "<a href=\"" << correctURL(l,relPath) << "\">";
  t << "<span>";
}

References correctURL(), and DString::empty().

Referenced by renderQuickLinksAsTabs().

startQuickIndexList()

void startQuickIndexList ( TextStream & t, bool topLevel = true )

static

Definition at line 2858 of file htmlgen.cpp.

{
  if (!Config_getBool(DISABLE_INDEX))
  {
    if (topLevel)
    {
      t << "  <div id=\"navrow1\" class=\"tabs\">\n";
    }
    else
    {
      t << "  <div id=\"navrow2\" class=\"tabs2\">\n";
    }
    t << "    <ul class=\"tablist\">\n";
  }
  else
  {
    t << "<ul>";
  }
}

References Config_getBool.

Referenced by renderQuickLinksAsTabs(), and renderQuickLinksAsTree().

startSectionContent()

void startSectionContent ( TextStream & t, int sectionCount )

static

Definition at line 2167 of file htmlgen.cpp.

{
  //t << "<!-- startSectionContent -->";
  bool dynamicSections = Config_getBool(HTML_DYNAMIC_SECTIONS);
  if (dynamicSections)
  {
    t << "<div id=\"dynsection-" << sectionCount << "-content\" "
         "class=\"dyncontent hidden\">\n";
  }
  else
  {
    t << "<div class=\"dyncontent\">\n";
  }
}

References Config_getBool.

Referenced by HtmlGenerator::endCallGraph(), HtmlGenerator::endClassDiagram(), HtmlGenerator::endDirDepGraph(), HtmlGenerator::endDotGraph(), HtmlGenerator::endGroupCollaboration(), and HtmlGenerator::endInclDepGraph().

startSectionHeader()

void startSectionHeader ( TextStream & t, const DString & relPath, int sectionCount )

static

Definition at line 2123 of file htmlgen.cpp.

{
  //t << "<!-- startSectionHeader -->";
  bool dynamicSections = Config_getBool(HTML_DYNAMIC_SECTIONS);
  if (dynamicSections)
  {
    t << "<div id=\"dynsection-" << sectionCount << "\" "
         "class=\"dynheader closed\">"
         "<span class=\"dynarrow\"><span class=\"arrowhead closed\"></span></span>";
  }
  else
  {
    t << "<div class=\"dynheader\">\n";
  }
}

References Config_getBool.

Referenced by HtmlGenerator::startCallGraph(), HtmlGenerator::startClassDiagram(), HtmlGenerator::startDirDepGraph(), HtmlGenerator::startDotGraph(), HtmlGenerator::startGroupCollaboration(), and HtmlGenerator::startInclDepGraph().

startSectionSummary()

void startSectionSummary ( TextStream & t, int sectionCount )

static

Definition at line 2146 of file htmlgen.cpp.

{
  //t << "<!-- startSectionSummary -->";
  bool dynamicSections = Config_getBool(HTML_DYNAMIC_SECTIONS);
  if (dynamicSections)
  {
    t << "<div id=\"dynsection-" << sectionCount << "-summary\" "
         "class=\"dynsummary\">\n";
  }
}

References Config_getBool.

Referenced by HtmlGenerator::endCallGraph(), HtmlGenerator::endClassDiagram(), HtmlGenerator::endDirDepGraph(), HtmlGenerator::endDotGraph(), HtmlGenerator::endGroupCollaboration(), and HtmlGenerator::endInclDepGraph().

substituteHtmlKeywords()

DString substituteHtmlKeywords ( const DString & file, const DString & str, const DString & title, const DString & relPath, const DString & navPath = DString(), bool isSource = false )

static

Definition at line 308 of file htmlgen.cpp.

{
  // Build CSS/JavaScript tags depending on treeview, search engine settings
  DString cssFile;
  DString generatedBy;
  DString treeViewCssJs;
  DString searchCssJs;
  DString searchBox;
  DString mathJaxJs;
  DString mermaidJs;
  DString extraCssText;
 
  DString projectName = Config_getString(PROJECT_NAME);
  bool treeView = Config_getBool(GENERATE_TREEVIEW);
  bool dynamicSections = useDynamicSections();
  bool codeFolding = Config_getBool(HTML_CODE_FOLDING);
  bool searchEngine = Config_getBool(SEARCHENGINE);
  bool serverBasedSearch = Config_getBool(SERVER_BASED_SEARCH);
  bool mathJax = Config_getBool(USE_MATHJAX);
  bool disableIndex = Config_getBool(DISABLE_INDEX);
  bool hasProjectName = !projectName.empty();
  bool hasProjectNumber = !Config_getString(PROJECT_NUMBER).empty();
  bool hasProjectBrief = !Config_getString(PROJECT_BRIEF).empty();
  bool hasProjectLogo = !Config_getString(PROJECT_LOGO).empty();
  bool hasProjectIcon = !Config_getString(PROJECT_ICON).empty();
  bool hasFullSideBar = Config_getBool(FULL_SIDEBAR) && /*disableIndex &&*/ treeView;
  bool hasCopyClipboard = Config_getBool(HTML_COPY_CLIPBOARD);
  bool hasCookie = treeView || searchEngine || Config_getEnum(HTML_COLORSTYLE)==HTML_COLORSTYLE_t::TOGGLE;
  static bool titleArea = (hasProjectName || hasProjectBrief || hasProjectLogo || (disableIndex && searchEngine));
 
  cssFile = Config_getString(HTML_STYLESHEET);
  if (cssFile.empty())
  {
    cssFile = "doxygen.css";
  }
  else
  {
    if (!cssFile.startsWith("http:") && !cssFile.startsWith("https:"))
    {
      FileInfo cssfi(cssFile.str());
      if (cssfi.exists())
      {
        cssFile = cssfi.fileName();
      }
      else
      {
        cssFile = "doxygen.css";
      }
    }
  }
 
  extraCssText = "";
  StringVector extraCssFile = Config_getList(HTML_EXTRA_STYLESHEET);
  for (const auto &fileName : extraCssFile)
  {
    if (!fileName.empty())
    {
      DString htmlStyleSheet = fileName;
      if (htmlStyleSheet.startsWith("http:") || htmlStyleSheet.startsWith("https:"))
      {
        extraCssText += "<link href=\""+htmlStyleSheet+"\" rel=\"stylesheet\" type=\"text/css\"/>\n";
      }
      else
      {
        FileInfo fi(fileName);
        if (fi.exists())
        {
          extraCssText += "<link href=\"$relpath^"+stripPath(fileName)+"\" rel=\"stylesheet\" type=\"text/css\"/>\n";
        }
      }
    }
  }
 
  switch (Config_getEnum(TIMESTAMP))
  {
    case TIMESTAMP_t::NO:
      generatedBy = theTranslator->trGeneratedBy();
      break;
    default:
      generatedBy = theTranslator->trGeneratedAt("<span class=\"timestamp\"></span>",
                    convertToHtml(Config_getString(PROJECT_NAME)));
      break;
  }
  if (treeView)
  {
    treeViewCssJs = "<link href=\"$relpath^navtree.css\" rel=\"stylesheet\" type=\"text/css\"/>\n"
                    "<script type=\"text/javascript\" src=\"$relpath^navtreedata.js\"></script>\n"
                    "<script type=\"text/javascript\" src=\"$relpath^navtree.js\"></script>\n";
  }
 
  if (searchEngine)
  {
    searchCssJs = "<link href=\"$relpath^search/search.css\" rel=\"stylesheet\" type=\"text/css\"/>\n";
    if (!serverBasedSearch)
    {
      searchCssJs += "<script type=\"text/javascript\" src=\"$relpath^search/searchdata.js\"></script>\n";
    }
    else
    {
      searchCssJs += "<style type=\"text/css\">\n"
        "@font-face {\n"
        "  font-family: 'Material Symbols Outlined';\n"
        "  font-style: normal;\n"
        "  font-weight: 400;\n"
        "  src: url($relpath^MaterialSymbolsOutlined.min.woff2) format('woff2');\n"
        "}\n"
        ".material-symbols-outlined {\n"
        "  font-family: 'Material Symbols Outlined';\n"
        "  font-weight: normal;\n"
        "  font-style: normal;\n"
        "  font-size: 24px;\n"
        "  line-height: 1;\n"
        "  letter-spacing: normal;\n"
        "  text-transform: none;\n"
        "  display: inline-block;\n"
        "  white-space: nowrap;\n"
        "  word-wrap: normal;\n"
        "  direction: ltr;\n"
        "  -moz-font-feature-settings: 'liga';\n"
        "  -moz-osx-font-smoothing: grayscale;\n"
        "}\n"
       "</style>\n";
    }
    searchCssJs += "<script type=\"text/javascript\" src=\"$relpath^search/search.js\"></script>\n";
 
    if (!serverBasedSearch)
    {
    }
    else
    {
      // OPENSEARCH_PROVIDER {
      searchCssJs += "<link rel=\"search\" href=\"" + relPath +
                     "search_opensearch.php?v=opensearch.xml\" "
                     "type=\"application/opensearchdescription+xml\" title=\"" +
                     (hasProjectName ? projectName : DString("Doxygen")) +
                     "\"/>";
      // OPENSEARCH_PROVIDER }
    }
    searchBox = getSearchBox(serverBasedSearch, relPath, false);
  }
 
  if (mathJax && !isSource)
  {
    auto mathJaxVersion = Config_getEnum(MATHJAX_VERSION);
    DString path = Config_getString(MATHJAX_RELPATH);
    if (path.empty() || path.startsWith("..")) // relative path
    {
      path.prepend(relPath);
    }
 
    auto writeMathJax3Packages = [&mathJaxJs](const StringVector &mathJaxExtensions)
    {
      mathJaxJs += "    packages: ['base','configmacros'";
      if (!g_latex_macro.empty())
      {
        mathJaxJs+= ",'newcommand'";
      }
      for (const auto &s : mathJaxExtensions)
      {
        mathJaxJs+= ",'"+s+"'";
      }
      mathJaxJs += "]\n";
    };
 
    auto writeMathJax4Packages = [&mathJaxJs](const StringVector &mathJaxExtensions)
    {
      mathJaxJs += "    packages: {\n";
      bool first = true;
      for (const auto &s : mathJaxExtensions)
      {
        if (!first) mathJaxJs+= ",";
        if (s.at(0) =='-')
        {
          mathJaxJs+= "\n        '[-]': ['";
          mathJaxJs+=s.data()+1;
          mathJaxJs+="']";
        }
        else
        {
          mathJaxJs+= "\n        '[+]': ['"+s+"']";
        }
        first = false;
      }
      mathJaxJs += "\n    }\n";
    };
 
    auto writeMathJaxScript = [&path,&mathJaxJs](const DString &pathPostfix,
                                                 std::function<void(const StringVector&)> writePackages)
    {
      DString mathJaxFormat = Config_getEnumAsString(MATHJAX_FORMAT);
      mathJaxJs += "<script type=\"text/javascript\">\n"
        "window.MathJax = {\n"
        "  options: {\n"
        "    ignoreHtmlClass: 'tex2jax_ignore',\n"
        "    processHtmlClass: 'tex2jax_process'\n"
        "  }";
      // MACRO / EXT
      StringVector mathJaxExtensions = Config_getList(MATHJAX_EXTENSIONS);
      if (!mathJaxExtensions.empty() || !g_latex_macro.empty())
      {
        mathJaxJs+= ",\n";
        if (!mathJaxExtensions.empty())
        {
          bool first = true;
          mathJaxJs+= "  loader: {\n"
                      "    load: [";
          for (const auto &s : mathJaxExtensions)
          {
            if (s.at(0) !='-')
            {
              if (!first) mathJaxJs+= ",";
              mathJaxJs+= "'[tex]/"+s+"'"; // packages preceded by a minus sign should not be loaded
              first = false;
            }
          }
          mathJaxJs+= "]\n"
                      "  },\n";
        }
        mathJaxJs+= "  tex: {\n"
                    "    macros: {";
        if (!g_latex_macro.empty())
        {
          mathJaxJs += g_latex_macro+"    ";
        }
        mathJaxJs+="},\n";
        writePackages(mathJaxExtensions);
        mathJaxJs += "  }\n";
      }
      else
      {
        mathJaxJs += "\n";
      }
      mathJaxJs += "};\n";
      // MATHJAX_CODEFILE
      if (!g_mathjax_code.empty())
      {
        mathJaxJs += g_mathjax_code;
        mathJaxJs += "\n";
      }
      mathJaxJs+="</script>\n";
      mathJaxJs += "<script type=\"text/javascript\" id=\"MathJax-script\" async=\"async\" src=\"" +
        path + pathPostfix + "tex-" + mathJaxFormat.lower() + ".js\">";
      mathJaxJs+="</script>\n";
    };
 
    switch (mathJaxVersion)
    {
      case MATHJAX_VERSION_t::MathJax_4:
        writeMathJaxScript("",writeMathJax4Packages);
        break;
      case MATHJAX_VERSION_t::MathJax_3:
        writeMathJaxScript("es5/",writeMathJax3Packages);
        break;
      case MATHJAX_VERSION_t::MathJax_2:
        {
          DString mathJaxFormat = Config_getEnumAsString(MATHJAX_FORMAT);
          mathJaxJs = "<script type=\"text/x-mathjax-config\">\n"
                      "MathJax.Hub.Config({\n"
                      "  extensions: [\"tex2jax.js\"";
          StringVector mathJaxExtensions = Config_getList(MATHJAX_EXTENSIONS);
          for (const auto &s : mathJaxExtensions)
          {
            mathJaxJs+= ", \""+DString(s)+".js\"";
          }
          if (mathJaxFormat.empty())
          {
            mathJaxFormat = "HTML-CSS";
          }
          mathJaxJs += "],\n"
                       "  jax: [\"input/TeX\",\"output/"+mathJaxFormat+"\"],\n";
          if (!g_latex_macro.empty())
          {
            mathJaxJs += "   TeX: { Macros: {\n";
            mathJaxJs += g_latex_macro;
            mathJaxJs += "\n"
                         "  } }\n";
          }
          mathJaxJs +=   "});\n";
          if (!g_mathjax_code.empty())
          {
            mathJaxJs += g_mathjax_code;
            mathJaxJs += "\n";
          }
          mathJaxJs += "</script>\n";
          mathJaxJs += "<script type=\"text/javascript\" async=\"async\" src=\"" + path + "MathJax.js\"></script>\n";
        }
        break;
    }
  }
 
  DString darkModeJs;
  if (Config_getEnum(HTML_COLORSTYLE)==HTML_COLORSTYLE_t::TOGGLE)
  {
    darkModeJs="<script type=\"text/javascript\" src=\"$relpath^darkmode_toggle.js\"></script>\n";
  }
 
  if (MermaidManager::instance().hasInlineDiagrams())
  {
    DString mermaidJsUrl = Config_getString(MERMAID_JS_URL);
    mermaidJs =  "<script type=\"module\">\n"
                 "import mermaid from '" + mermaidJsUrl + "';\n";
    switch(Config_getEnum(HTML_COLORSTYLE))
    {
      case HTML_COLORSTYLE_t::LIGHT:
        mermaidJs += "const theme = 'default';\n";
        break;
      case HTML_COLORSTYLE_t::DARK:
        mermaidJs += "const theme = 'dark';\n";
        break;
      case HTML_COLORSTYLE_t::AUTO_LIGHT:
      case HTML_COLORSTYLE_t::AUTO_DARK:
        mermaidJs += "const theme = window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'default';\n";
        break;
      case HTML_COLORSTYLE_t::TOGGLE:
        mermaidJs += "const theme = DarkModeToggle.darkModeEnabled ? 'dark' : 'default'\n";
        break;
    }
    mermaidJs += "mermaid.initialize({ startOnLoad: true, theme: theme });\n";
    if (Config_getEnum(HTML_COLORSTYLE)==HTML_COLORSTYLE_t::TOGGLE)
    {
      mermaidJs +=
      "(function() {\n"
      "  const elementCode = '.mermaid';\n"
      "  const loadMermaid = function(theme) {\n"
      "    mermaid.initialize({theme})\n"
      "    mermaid.init({theme}, document.querySelectorAll(elementCode))\n"
      "  }\n"
      "  const saveOriginalData = function() {\n"
      "    return new Promise((resolve, reject) => {\n"
      "      try {\n"
      "        var els = document.querySelectorAll(elementCode), count = els.length;\n"
      "        els.forEach(element => {\n"
      "          element.setAttribute('data-original-code', element.innerHTML)\n"
      "          count--\n"
      "          if (count == 0) { resolve() }\n"
      "        });\n"
      "      } catch (error) { reject(error) }\n"
      "    })\n"
      "  }\n"
      "  const resetProcessed = function(){\n"
      "    return new Promise((resolve, reject) => {\n"
      "      try {\n"
      "        var els = document.querySelectorAll(elementCode), count = els.length;\n"
      "        els.forEach(element => {\n"
      "          if (element.getAttribute('data-original-code') != null) {\n"
      "              element.removeAttribute('data-processed')\n"
      "              element.innerHTML = element.getAttribute('data-original-code')\n"
      "          }\n"
      "          count--\n"
      "          if(count == 0) { resolve() }\n"
      "        });\n"
      "      } catch (error) { reject(error) }\n"
      "    })\n"
      "  }\n"
      "  saveOriginalData()\n"
      "  const original = DarkModeToggle.enableDarkMode.bind(DarkModeToggle);\n"
      "  DarkModeToggle.enableDarkMode = function(enable) {\n"
      "      original(enable);\n"
      "      resetProcessed().then(loadMermaid(enable ? 'dark' : 'default')).catch(console.error)\n"
      "  };\n"
      "})();\n";
    }
    mermaidJs += "</script>\n";
  }
 
  if (hasCookie) // extend the $treeview tag to avoid breaking old files used with HTML_HEADER
  {
    treeViewCssJs+="<script type=\"text/javascript\" src=\"$relpath^cookie.js\"></script>\n";
  }
 
  DString projName = convertToHtml(Config_getString(PROJECT_NAME)),
 
  // first substitute generic keywords then do the HTML specific keywords
  result = substituteKeywords(file,str,
  {
    // keyword           value getter
    { "$title",          [&]() { return !title.empty() ? title : projName;               } },
    { "$doxygenversion", [&]() { return getDoxygenVersion();                             } },
    { "$projectname",    [&]() { return projName;                                        } },
    { "$projectnumber",  [&]() { return convertToHtml(Config_getString(PROJECT_NUMBER)); } },
    { "$projectbrief",   [&]() { return convertToHtml(Config_getString(PROJECT_BRIEF));  } },
    { "$projectlogo",    [&]() { return stripPath(projectLogoFile());                    } },
    { "$logosize",       [&]() { return projectLogoSize();                               } },
    { "$projecticon",    [&]() { return stripPath(Config_getString(PROJECT_ICON));       } },
    { "$langISO",        [&]() { return theTranslator->trISOLang();                      } },
    { "$showdate",       [&](const DString &fmt) { return showDate(fmt);                 } },
 
    // keyword           value getter
    { "$datetime",       [&]() -> DString { return "<span class=\"datetime\"></span>";   } },
    { "$date",           [&]() -> DString { return "<span class=\"date\"></span>";       } },
    { "$time",           [&]() -> DString { return "<span class=\"time\"></span>";       } },
    { "$year",           [&]() -> DString { return "<span class=\"year\"></span>";       } },
    { "$navpath",        [&]() -> DString { return navPath;                              } },
    { "$stylesheet",     [&]() -> DString { return cssFile;                              } },
    { "$treeview",       [&]() -> DString { return treeViewCssJs;                        } },
    { "$searchbox",      [&]() -> DString { return searchBox;                            } },
    { "$search",         [&]() -> DString { return searchCssJs;                          } },
    { "$mathjax",        [&]() -> DString { return mathJaxJs;                            } },
    { "$mermaidjs",      [&]() -> DString { return mermaidJs;                            } },
    { "$darkmode",       [&]() -> DString { return darkModeJs;                           } },
    { "$generatedby",    [&]() -> DString { return generatedBy;                          } },
    { "$extrastylesheet",[&]() -> DString { return extraCssText;                         } },
    { "$relpath$",       [&]() -> DString { return relPath;                              } } //<-- obsolete: for backwards compatibility only
  });
 
  result = substitute(result,"$relpath^",relPath); //<-- must be done after the previous substitutions
 
  // remove conditional blocks
  result = selectBlocks(result,
  {
    // keyword,            is enabled
    { "FULL_SIDEBAR",      hasFullSideBar   },
    { "DISABLE_INDEX",     disableIndex     },
    { "GENERATE_TREEVIEW", treeView         },
    { "SEARCHENGINE",      searchEngine     },
    { "TITLEAREA",         titleArea        },
    { "PROJECT_NAME",      hasProjectName   },
    { "PROJECT_NUMBER",    hasProjectNumber },
    { "PROJECT_BRIEF",     hasProjectBrief  },
    { "PROJECT_LOGO",      hasProjectLogo   },
    { "PROJECT_ICON",      hasProjectIcon   },
    { "COPY_CLIPBOARD",    hasCopyClipboard },
    { "HTML_CODE_FOLDING", codeFolding      },
    { "HTML_DYNAMIC_SECTIONS", dynamicSections},
  },htmlMarkerInfo);
 
  result = removeEmptyLines(result.str());
 
  return result;
}

References Config_getBool, Config_getEnum, Config_getEnumAsString, Config_getList, Config_getString, convertToHtml(), DString::data(), DString::empty(), FileInfo::exists(), FileInfo::fileName(), g_latex_macro, g_mathjax_code, getSearchBox(), htmlMarkerInfo, MermaidManager::instance(), DString::lower(), DString::prepend(), projectLogoFile(), projectLogoSize(), removeEmptyLines(), selectBlocks(), showDate(), DString::startsWith(), DString::str(), stripPath(), substitute(), substituteKeywords(), theTranslator, Translator::trGeneratedAt(), Translator::trGeneratedBy(), Translator::trISOLang(), and useDynamicSections().

Referenced by HtmlGenerator::init(), HtmlGenerator::startFile(), HtmlGenerator::writeExternalSearchPage(), HtmlGenerator::writePageFooter(), and HtmlGenerator::writeSearchPage().

useDynamicSections()

bool useDynamicSections ( )

inlinestatic

Definition at line 70 of file htmlgen.cpp.

{
  return Config_getBool(HTML_DYNAMIC_SECTIONS) ||
         (Config_getBool(OBFUSCATE_EMAILS) && !Config_getBool(GENERATE_HTMLHELP)) ||
         (Config_getBool(SOURCE_BROWSER) && Config_getBool(SOURCE_TOOLTIPS));
}

References Config_getBool.

Referenced by HtmlGenerator::init(), substituteHtmlKeywords(), and HtmlGenerator::writeStyleInfo().

writeClientSearchBox()

void writeClientSearchBox ( TextStream & t, const DString & relPath )

static

Definition at line 77 of file htmlgen.cpp.

{
  t << "        <div id=\"MSearchBox\" class=\"MSearchBoxInactive\">\n";
  t << "        <span class=\"left\">\n";
  t << "          <span id=\"MSearchSelect\" class=\"search-icon\">";
  t << "<span class=\"search-icon-dropdown\"></span></span>\n";
  t << "          <input type=\"text\" id=\"MSearchField\" value=\"\" placeholder=\""
    << theTranslator->trSearch() << "\" accesskey=\"S\"/>\n";
  t << "          </span><span class=\"right\">\n";
  t << "            <a id=\"MSearchClose\" href=\"javascript:searchBox.CloseResultsWindow()\">"
    << "<div id=\"MSearchCloseImg\" class=\"close-icon\"></div></a>\n";
  t << "          </span>\n";
  t << "        </div>\n";
}

References theTranslator, and Translator::trSearch().

Referenced by getSearchBox(), and renderQuickLinksAsTabs().

writeDefaultQuickLinks()

void writeDefaultQuickLinks ( TextStream & t, HighlightedItem hli, const DString & file, const DString & relPath, bool extraTabs )

static

Definition at line 3067 of file htmlgen.cpp.

{
  bool serverBasedSearch = Config_getBool(SERVER_BASED_SEARCH);
  bool searchEngine      = Config_getBool(SEARCHENGINE);
  bool externalSearch    = Config_getBool(EXTERNAL_SEARCH);
  bool generateTreeView  = Config_getBool(GENERATE_TREEVIEW);
  bool fullSidebar       = Config_getBool(FULL_SIDEBAR);
  bool disableIndex      = Config_getBool(DISABLE_INDEX);
  bool dynamicMenus      = Config_getBool(HTML_DYNAMIC_MENUS);
  LayoutNavEntry *root = LayoutDocManager::instance().rootNavEntry();
  LayoutNavEntry::Kind kind = LayoutNavEntry::None;
  LayoutNavEntry::Kind altKind = LayoutNavEntry::None; // fall back for the old layout file
  bool highlightParent=false;
  switch (hli) // map HLI enums to LayoutNavEntry::Kind enums
  {
    case HighlightedItem::Main:                kind = LayoutNavEntry::MainPage;         break;
    case HighlightedItem::Topics:              kind = LayoutNavEntry::Topics;           break;
    case HighlightedItem::Modules:             kind = LayoutNavEntry::ModuleList;       altKind = LayoutNavEntry::Modules;     break;
    case HighlightedItem::Namespaces:          kind = LayoutNavEntry::NamespaceList;    altKind = LayoutNavEntry::Namespaces;  break;
    case HighlightedItem::ClassHierarchy:      kind = LayoutNavEntry::ClassHierarchy;   break;
    case HighlightedItem::InterfaceHierarchy:  kind = LayoutNavEntry::InterfaceHierarchy;   break;
    case HighlightedItem::ExceptionHierarchy:  kind = LayoutNavEntry::ExceptionHierarchy;   break;
    case HighlightedItem::Classes:             kind = LayoutNavEntry::ClassIndex;       altKind = LayoutNavEntry::Classes;     break;
    case HighlightedItem::Concepts:            kind = LayoutNavEntry::Concepts;         break;
    case HighlightedItem::Interfaces:          kind = LayoutNavEntry::InterfaceIndex;   altKind = LayoutNavEntry::Interfaces;  break;
    case HighlightedItem::Structs:             kind = LayoutNavEntry::StructIndex;      altKind = LayoutNavEntry::Structs;     break;
    case HighlightedItem::Exceptions:          kind = LayoutNavEntry::ExceptionIndex;   altKind = LayoutNavEntry::Exceptions;  break;
    case HighlightedItem::AnnotatedClasses:    kind = LayoutNavEntry::ClassList;        altKind = LayoutNavEntry::Classes;     break;
    case HighlightedItem::AnnotatedInterfaces: kind = LayoutNavEntry::InterfaceList;    altKind = LayoutNavEntry::Interfaces;  break;
    case HighlightedItem::AnnotatedStructs:    kind = LayoutNavEntry::StructList;       altKind = LayoutNavEntry::Structs;     break;
    case HighlightedItem::AnnotatedExceptions: kind = LayoutNavEntry::ExceptionList;    altKind = LayoutNavEntry::Exceptions;  break;
    case HighlightedItem::Files:               kind = LayoutNavEntry::FileList;         altKind = LayoutNavEntry::Files;       break;
    case HighlightedItem::NamespaceMembers:    kind = LayoutNavEntry::NamespaceMembers; break;
    case HighlightedItem::ModuleMembers:       kind = LayoutNavEntry::ModuleMembers;    break;
    case HighlightedItem::Functions:           kind = LayoutNavEntry::ClassMembers;     break;
    case HighlightedItem::Globals:             kind = LayoutNavEntry::FileGlobals;      break;
    case HighlightedItem::Pages:               kind = LayoutNavEntry::Pages;            break;
    case HighlightedItem::Examples:            kind = LayoutNavEntry::Examples;         break;
    case HighlightedItem::UserGroup:           kind = LayoutNavEntry::UserGroup;        break;
    case HighlightedItem::ClassVisible:        kind = LayoutNavEntry::ClassList;        altKind = LayoutNavEntry::Classes;
                                               highlightParent = true; break;
    case HighlightedItem::ConceptVisible:      kind = LayoutNavEntry::Concepts;
                                               highlightParent = true; break;
    case HighlightedItem::ModuleVisible:       kind = LayoutNavEntry::ModuleList;       altKind = LayoutNavEntry::Modules;
                                               highlightParent = true; break;
    case HighlightedItem::InterfaceVisible:    kind = LayoutNavEntry::InterfaceList;    altKind = LayoutNavEntry::Interfaces;
                                               highlightParent = true; break;
    case HighlightedItem::StructVisible:       kind = LayoutNavEntry::StructList;       altKind = LayoutNavEntry::Structs;
                                               highlightParent = true; break;
    case HighlightedItem::ExceptionVisible:    kind = LayoutNavEntry::ExceptionList;    altKind = LayoutNavEntry::Exceptions;
                                               highlightParent = true; break;
    case HighlightedItem::NamespaceVisible:    kind = LayoutNavEntry::NamespaceList;    altKind = LayoutNavEntry::Namespaces;
                                               highlightParent = true; break;
    case HighlightedItem::FileVisible:         kind = LayoutNavEntry::FileList;         altKind = LayoutNavEntry::Files;
                                               highlightParent = true; break;
    case HighlightedItem::None:   break;
    case HighlightedItem::Search: break;
  }
 
  if (!disableIndex && dynamicMenus)
  {
    DString searchPage;
    if (externalSearch)
    {
      searchPage = "search" + Doxygen::htmlFileExtension;
    }
    else
    {
      searchPage = "search.php";
    }
    t << "<script type=\"text/javascript\" src=\"" << relPath << "menudata.js\"></script>\n";
    t << "<script type=\"text/javascript\" src=\"" << relPath << "menu.js\"></script>\n";
    t << "<div id=\"main-nav-mobile\">\n";
    if (searchEngine && !fullSidebar)
    {
      t <<   "<div class=\"sm sm-dox\"><input id=\"main-menu-state\" type=\"checkbox\"/>\n";
      t <<     "<label class=\"main-menu-btn\" for=\"main-menu-state\">\n";
      t <<     "<span class=\"main-menu-btn-icon\"></span> Toggle main menu visibility</label>\n";
      t <<     "<span id=\"searchBoxPos1\">";
      t <<     "</span>\n";
      t <<   "</div>\n";
    }
    t << "</div><!-- main-nav-mobile -->\n";
    t << "<div id=\"main-nav\">\n";
    t << "  <ul class=\"sm sm-dox\" id=\"main-menu\">\n";
    t << "    <li id=\"searchBoxPos2\">\n";
    if (searchEngine && !(generateTreeView && fullSidebar))
    {
      t << getSearchBox(serverBasedSearch,relPath,false);
    }
    t << "    </li>\n";
    t << "  </ul>\n";
    t << "</div><!-- main-nav -->\n";
  }
  else if (!disableIndex) // && !Config_getBool(HTML_DYNAMIC_MENUS)
  {
    // find highlighted index item
    LayoutNavEntry *hlEntry = root->find(kind,kind==LayoutNavEntry::UserGroup ? file : DString());
    if (!hlEntry && altKind!=LayoutNavEntry::None) { hlEntry=root->find(altKind); kind=altKind; }
    if (!hlEntry) // highlighted item not found in the index! -> just show the level 1 index...
    {
      highlightParent=true;
      hlEntry = root->children().front().get();
      if (hlEntry==nullptr)
      {
        return; // argl, empty index!
      }
    }
    if (kind==LayoutNavEntry::UserGroup)
    {
      LayoutNavEntry *e = hlEntry->children().front().get();
      if (e)
      {
        hlEntry = e;
      }
    }
    t << "<div id=\"main-nav\">\n";
    renderQuickLinksAsTabs(t,relPath,hlEntry,kind,highlightParent,hli==HighlightedItem::Search);
    if (!extraTabs)
    {
      t << "</div><!-- main-nav -->\n";
    }
  }
  else if (!generateTreeView)
  {
    renderQuickLinksAsTree(t,relPath,root);
  }
  if (generateTreeView && !disableIndex && fullSidebar && !extraTabs)
  {
     t << "<div id=\"container\"><div id=\"doc-content\">\n";
  }
}

References AnnotatedClasses, AnnotatedExceptions, AnnotatedInterfaces, AnnotatedStructs, LayoutNavEntry::children(), Classes, ClassHierarchy, ClassVisible, Concepts, ConceptVisible, Config_getBool, Examples, ExceptionHierarchy, Exceptions, ExceptionVisible, Files, FileVisible, LayoutNavEntry::find(), Functions, getSearchBox(), Globals, Doxygen::htmlFileExtension, LayoutDocManager::instance(), InterfaceHierarchy, Interfaces, InterfaceVisible, Main, ModuleMembers, Modules, ModuleVisible, NamespaceMembers, Namespaces, NamespaceVisible, None, Pages, renderQuickLinksAsTabs(), renderQuickLinksAsTree(), LayoutDocManager::rootNavEntry(), Search, Structs, StructVisible, Topics, and UserGroup.

Referenced by HtmlGenerator::writeExternalSearchPage(), HtmlGenerator::writeQuickLinks(), and HtmlGenerator::writeSearchPage().

writeDefaultStyleSheet()

void writeDefaultStyleSheet ( TextStream & t )

static

Definition at line 1506 of file htmlgen.cpp.

{
  t << "/* The standard CSS for doxygen " << getDoxygenVersion() << "*/\n\n";
  switch (Config_getEnum(HTML_COLORSTYLE))
  {
    case HTML_COLORSTYLE_t::LIGHT:
    case HTML_COLORSTYLE_t::DARK:
      /* variables will be resolved while writing to the CSS file */
      break;
    case HTML_COLORSTYLE_t::AUTO_LIGHT:
    case HTML_COLORSTYLE_t::TOGGLE:
      t << "html {\n";
      t << replaceColorMarkers(ResourceMgr::instance().getAsString("lightmode_settings.css"));
      t << "}\n\n";
      break;
    case HTML_COLORSTYLE_t::AUTO_DARK:
      t << "html {\n";
      t << replaceColorMarkers(ResourceMgr::instance().getAsString("darkmode_settings.css"));
      t << "}\n\n";
      break;
  }
  if (Config_getEnum(HTML_COLORSTYLE)==HTML_COLORSTYLE_t::AUTO_LIGHT)
  {
    t << "@media (prefers-color-scheme: dark) {\n";
    t << "  html:not(.dark-mode) {\n";
    t << "    color-scheme: dark;\n\n";
    t << replaceColorMarkers(ResourceMgr::instance().getAsString("darkmode_settings.css"));
    t << "}}\n";
  }
  else if (Config_getEnum(HTML_COLORSTYLE)==HTML_COLORSTYLE_t::AUTO_DARK)
  {
    t << "@media (prefers-color-scheme: light) {\n";
    t << "  html:not(.light-mode) {\n";
    t << "    color-scheme: light;\n\n";
    t << replaceColorMarkers(ResourceMgr::instance().getAsString("lightmode_settings.css"));
    t << "}}\n";
  }
  else if (Config_getEnum(HTML_COLORSTYLE)==HTML_COLORSTYLE_t::TOGGLE)
  {
    t << "html.dark-mode {\n";
    t << replaceColorMarkers(ResourceMgr::instance().getAsString("darkmode_settings.css"));
    t << "}\n\n";
  }
 
  DString cssStr = ResourceMgr::instance().getAsString("doxygen.css");
  bool hasFullSidebar = Config_getBool(FULL_SIDEBAR) && Config_getBool(GENERATE_TREEVIEW);
  if (hasFullSidebar)
  {
    cssStr+="\n"
            "#titlearea {\n"
            "  border-bottom: none;\n"
            "  background-color: var(--nav-background-color);\n"
            "  border-right: 1px solid var(--nav-border-color);\n"
            "}\n";
  }
  t << replaceVariables(cssStr);
 
  bool addTimestamp = Config_getEnum(TIMESTAMP)!=TIMESTAMP_t::NO;
  if (g_build_date  || addTimestamp)
  {
    t << "\nhtml {\n";
 
    if (addTimestamp)
    {
      DString timeStampStr;
      switch (Config_getEnum(TIMESTAMP))
      {
        case TIMESTAMP_t::YES:
        case TIMESTAMP_t::DATETIME:
          timeStampStr = dateToString(DateTimeType::DateTime);
          break;
        case TIMESTAMP_t::DATE:
          timeStampStr = dateToString(DateTimeType::Date);
          break;
        default:
          break;
      }
      t << "--timestamp: '" << timeStampStr << "';\n";
    }
    if (g_build_date)
    {
      t << "--datetime: '" << dateToString(DateTimeType::DateTime) << "';\n";
      t << "--date: '" << dateToString(DateTimeType::Date) << "';\n";
      t << "--time: '" << dateToString(DateTimeType::Time) << "';\n";
      t << "--year: '" << yearToString() << "';\n";
    }
    t << "}\n";
 
    if (addTimestamp)
    {
      t << "span.timestamp { content: ' '; }\n";
      t << "span.timestamp:before { content: var(--timestamp); }\n\n";
    }
    if (g_build_date)
    {
      t << "span.datetime { content: ' '; }\n";
      t << "span.datetime:before { content: var(--datetime); }\n\n";
      t << "span.date { content: ' '; }\n";
      t << "span.date:before { content: var(--date); }\n\n";
      t << "span.time { content: ' '; }\n";
      t << "span.time:before { content: var(--time); }\n\n";
      t << "span.year { content: ' '; }\n";
      t << "span.year:before { content: var(--year); }\n\n";
    }
  }
 
  // For Webkit based the scrollbar styling cannot be overruled (bug in chromium?).
  // To allow the user to style the scrollbars differently we should only add it in case
  // the user did not specify any extra stylesheets.
  bool addScrollbarStyling = Config_getList(HTML_EXTRA_STYLESHEET).empty();
  if (addScrollbarStyling)
  {
    t << replaceVariables(ResourceMgr::instance().getAsString("scrollbar.css"));
  }
 
}

References Config_getBool, Config_getEnum, Config_getList, Date, DateTime, dateToString(), g_build_date, ResourceMgr::getAsString(), ResourceMgr::instance(), replaceColorMarkers(), replaceVariables(), Time, and yearToString().

Referenced by HtmlGenerator::writeStyleInfo(), and HtmlGenerator::writeStyleSheetFile().

writeServerSearchBox()

void writeServerSearchBox ( TextStream & t, const DString & relPath, bool highlightSearch )

static

Definition at line 94 of file htmlgen.cpp.

{
  bool externalSearch = Config_getBool(EXTERNAL_SEARCH);
  t << "        <div id=\"MSearchBox\" class=\"MSearchBoxInactive\">\n";
  t << "          <div class=\"left\">\n";
  t << "            <form id=\"FSearchBox\" action=\"" << relPath;
  if (externalSearch)
  {
    t << "search" << Doxygen::htmlFileExtension;
  }
  else
  {
    t << "search.php";
  }
  t << "\" method=\"get\">\n";
  t << "              <span id=\"MSearchSelectExt\" class=\"search-icon\"></span>\n";
  if (!highlightSearch || !Config_getBool(HTML_DYNAMIC_MENUS))
  {
    t << "              <input type=\"text\" id=\"MSearchField\" name=\"query\" value=\"\" placeholder=\""
      << theTranslator->trSearch() << "\" size=\"20\" accesskey=\"S\"/>\n";
    t << "            </form>\n";
    t << "          </div><div class=\"right\"></div>\n";
    t << "        </div>\n";
  }
}

References Config_getBool, Doxygen::htmlFileExtension, theTranslator, and Translator::trSearch().

Referenced by getSearchBox(), and renderQuickLinksAsTabs().

Variable Documentation

g_build_date

bool g_build_date = false

static

Definition at line 63 of file htmlgen.cpp.

Referenced by HtmlGenerator::init(), and writeDefaultStyleSheet().

g_darkMap

StringUnorderedMap g_darkMap

static

Definition at line 747 of file htmlgen.cpp.

Referenced by fillColorStyleMaps(), and replaceVariables().

g_footer

DString g_footer

static

Definition at line 60 of file htmlgen.cpp.

Referenced by HtmlGenerator::init(), and HtmlGenerator::writePageFooter().

g_footer_file

DString g_footer_file

static

Definition at line 59 of file htmlgen.cpp.

Referenced by HtmlGenerator::init(), and HtmlGenerator::writePageFooter().

g_header

DString g_header

static

Definition at line 57 of file htmlgen.cpp.

Referenced by HtmlGenerator::init(), HtmlGenerator::startFile(), HtmlGenerator::writeExternalSearchPage(), and HtmlGenerator::writeSearchPage().

g_header_file

DString g_header_file

static

Definition at line 58 of file htmlgen.cpp.

Referenced by HtmlGenerator::init(), HtmlGenerator::startFile(), HtmlGenerator::writeExternalSearchPage(), and HtmlGenerator::writeSearchPage().

g_indexLock

std::mutex g_indexLock

static

Definition at line 1641 of file htmlgen.cpp.

Referenced by HtmlGenerator::startFile().

g_latex_macro

DString g_latex_macro

static

Definition at line 62 of file htmlgen.cpp.

Referenced by HtmlGenerator::init(), and substituteHtmlKeywords().

g_lightMap

StringUnorderedMap g_lightMap

static

Definition at line 746 of file htmlgen.cpp.

Referenced by fillColorStyleMaps(), and replaceVariables().

g_mathjax_code

DString g_mathjax_code

static

Definition at line 61 of file htmlgen.cpp.

Referenced by HtmlGenerator::init(), and substituteHtmlKeywords().

hex

auto hex ="0123456789ABCDEF"

staticconstexpr

Definition at line 64 of file htmlgen.cpp.

Referenced by HtmlCodeGenerator::codify().

htmlMarkerInfo

const SelectionMarkerInfo htmlMarkerInfo = { '<', "<!--BEGIN ",10,"<!--END ",8,"-->",3 }

static

Definition at line 66 of file htmlgen.cpp.

Referenced by HtmlGenerator::init(), and substituteHtmlKeywords().