htmlgen.cpp

Go to the documentation of this file.

/******************************************************************************
 *
 * Copyright (C) 1997-2023 by Dimitri van Heesch.
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation under the terms of the GNU General Public License is hereby
 * granted. No representations are made about the suitability of this software
 * for any purpose. It is provided "as is" without express or implied warranty.
 * See the GNU General Public License for more details.
 *
 * Documents produced by Doxygen are derivative works derived from the
 * input used in their production; they are not affected by this license.
 *
 */
 
#include <stdlib.h>
#include <assert.h>
 
#include <mutex>
 
#include "message.h"
#include "htmlgen.h"
#include "config.h"
#include "util.h"
#include "doxygen.h"
#include "diagram.h"
#include "version.h"
#include "dot.h"
#include "dotcallgraph.h"
#include "dotclassgraph.h"
#include "dotdirdeps.h"
#include "dotgfxhierarchytable.h"
#include "dotgroupcollaboration.h"
#include "dotincldepgraph.h"
#include "language.h"
#include "htmlhelp.h"
#include "docparser.h"
#include "docnode.h"
#include "htmldocvisitor.h"
#include "searchindex.h"
#include "pagedef.h"
#include "debug.h"
#include "dirdef.h"
#include "vhdldocgen.h"
#include "layout.h"
#include "image.h"
#include "ftvhelp.h"
#include "resourcemgr.h"
#include "tooltip.h"
#include "fileinfo.h"
#include "dir.h"
#include "utf8.h"
#include "textstream.h"
#include "indexlist.h"
#include "datetime.h"
#include "portable.h"
#include "outputlist.h"
#include "stringutil.h"
#include "mermaid.h"
 
//#define DBG_HTML(x) x;
#define DBG_HTML(x)
 
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 };
 
// note: this is only active if DISABLE_INDEX=YES, if DISABLE_INDEX is disabled, this
// part will be rendered inside menu.js
static void writeClientSearchBox(TextStream &t,const DString &relPath)
{
  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";
}
 
// note: this is only active if DISABLE_INDEX=YES. if DISABLE_INDEX is disabled, this
// part will be rendered inside menu.js
static void writeServerSearchBox(TextStream &t,const DString &relPath,bool highlightSearch)
{
  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";
  }
}
 
//------------------------------------------------------------------------
/// 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]
/// ```
static DString getConvertLatexMacro()
{
  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;
}
 
static DString getSearchBox(bool serverSide, DString relPath, bool highlightSearch)
{
  TextStream t;
  if (serverSide)
  {
    writeServerSearchBox(t, relPath, highlightSearch);
  }
  else
  {
    writeClientSearchBox(t, relPath);
  }
  return t.str();
}
 
static DString substituteHtmlKeywords(const DString &file,
                                       const DString &str,
                                       const DString &title,
                                       const DString &relPath,
                                       const DString &navPath=DString(),
                                       bool isSource = false)
{
  // 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 = Config_getBool(HTML_DYNAMIC_SECTIONS) ||
                         (Config_getBool(SOURCE_BROWSER) && Config_getBool(SOURCE_TOOLTIPS));
  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;
}
 
//---------------------------------------------------------------------------------------------
 
static StringUnorderedMap g_lightMap;
static StringUnorderedMap g_darkMap;
 
static void fillColorStyleMap(const DString &definitions,StringUnorderedMap &map)
{
  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;
  }
}
 
static void fillColorStyleMaps()
{
  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);
  }
}
 
static DString replaceVariables(const DString &input)
{
  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;
  }
}
 
//----------------------------------------------------------------------------------------------
 
 
//--------------------------------------------------------------------------
 
HtmlCodeGenerator::HtmlCodeGenerator(TextStream *t) : m_t(t)
{
  //printf("%p:HtmlCodeGenerator()\n",(void*)this);
}
 
HtmlCodeGenerator::HtmlCodeGenerator(TextStream *t,const DString &relPath)
  : m_t(t), m_relPath(relPath)
{
  //printf("%p:HtmlCodeGenerator()\n",(void*)this);
}
 
void HtmlCodeGenerator::setRelativePath(const DString &path)
{
  m_relPath = path;
}
 
void HtmlCodeGenerator::codify(const DString &str)
{
  if (!str.empty())
  {
    int tabSize = Config_getInt(TAB_SIZE);
    const char *p=str.data();
    if (m_hide) // only update column count
    {
      m_col = updateColumnCount(p,m_col);
    }
    else // actually output content and keep track of m_col
    {
      while (*p)
      {
        char c=*p++;
        switch(c)
        {
          case '\t': {
                       int spacesToNextTabStop = tabSize - (m_col%tabSize);
                       while (spacesToNextTabStop--)
                       {
                         if (m_col>=m_stripIndentAmount) *m_t << " ";
                         m_col++;
                       }
                     }
                     break;
          case ' ':  if (m_col>=m_stripIndentAmount) *m_t << " ";
                     m_col++;
                     break;
          case '\n': *m_t << "\n"; m_col=0;
                     break;
          case '\r': break;
          case '<':  *m_t << "&lt;"; m_col++;
                     break;
          case '>':  *m_t << "&gt;"; m_col++;
                     break;
          case '&':  *m_t << "&amp;"; m_col++;
                     break;
          case '\'': *m_t << "&#39;"; m_col++; // &apos; is not valid XHTML
                     break;
          case '"':  *m_t << "&quot;"; m_col++;
                     break;
          case '\\':
                     if (*p=='<')
                     { *m_t << "&lt;"; p++; }
                     else if (*p=='>')
                     { *m_t << "&gt;"; p++; }
                     else if (*p=='[')
                     { *m_t << "\\&zwj;["; m_col++;p++; }
                     else if (*p==']')
                     { *m_t << "\\&zwj;]"; m_col++;p++; }
                     else if (*p=='(')
                     { *m_t << "\\&zwj;("; m_col++;p++; }
                     else if (*p==')')
                     { *m_t << "\\&zwj;)"; m_col++;p++; }
                     else
                       *m_t << "\\";
                     m_col++;
                     break;
          default:
                     {
                       uint8_t uc = static_cast<uint8_t>(c);
                       if (uc<32)
                       {
                         *m_t << "&#x24" << hex[uc>>4] << hex[uc&0xF] << ";";
                         m_col++;
                       }
                       else if (uc<0x80) // printable ASCII char
                       {
                         *m_t << c;
                         m_col++;
                       }
                       else // multibyte UTF-8 char
                       {
                         p=writeUTF8Char(*m_t,p-1);
                         m_col++;
                       }
                     }
                     break;
        }
      }
    }
  }
}
 
void HtmlCodeGenerator::stripCodeComments(bool b)
{
  m_stripCodeComments = b;
}
 
void HtmlCodeGenerator::startSpecialComment()
{
  m_hide = m_stripCodeComments;
  //*m_t << "[START]";
}
 
void HtmlCodeGenerator::endSpecialComment()
{
  //*m_t << "[END]";
  m_hide = false;
}
 
void HtmlCodeGenerator::setStripIndentAmount(size_t amount)
{
  m_stripIndentAmount = amount;
}
 
void HtmlCodeGenerator::writeLineNumber(const DString &ref,const DString &filename,
                                    const DString &anchor,int l,bool writeLineAnchor)
{
  m_lastLineInfo = LineInfo(ref,filename,anchor,l,writeLineAnchor);
  if (m_hide) return;
  const int maxLineNrStr = 10;
  char lineNumber[maxLineNrStr];
  char lineAnchor[maxLineNrStr];
  snprintf(lineNumber,maxLineNrStr,"%5d",l);
  snprintf(lineAnchor,maxLineNrStr,"l%05d",l);
 
  //printf("writeLineNumber open=%d\n",m_lineOpen);
  if (!m_lineOpen)
  {
    *m_t << "<div class=\"line\">";
    m_lineOpen = true;
  }
 
  if (writeLineAnchor) *m_t << "<a id=\"" << lineAnchor << "\" name=\"" << lineAnchor << "\"></a>";
  *m_t << "<span class=\"lineno\">";
  if (!filename.empty())
  {
    _writeCodeLink("line",ref,filename,anchor,lineNumber,DString());
  }
  else
  {
    codify(lineNumber);
  }
  *m_t << "</span>";
  m_col=0;
}
 
void HtmlCodeGenerator::writeCodeLink(CodeSymbolType type,
                                      const DString &ref,const DString &f,
                                      const DString &anchor, const DString &name,
                                      const DString &tooltip)
{
  if (m_hide) return;
  const char *hl = codeSymbolType2Str(type);
  DString hlClass = "code";
  if (hl)
  {
    hlClass+=" hl_";
    hlClass+=hl;
  }
  _writeCodeLink(hlClass,ref,f,anchor,name,tooltip);
}
 
void HtmlCodeGenerator::_writeCodeLink(const DString &className,
                                      const DString &ref,const DString &f,
                                      const DString &anchor, const DString &name,
                                      const DString &tooltip)
{
  m_col+=name.length();
  if (m_hide) return;
  if (!ref.empty())
  {
    *m_t << "<a class=\"" << className << "Ref\" ";
    *m_t << externalLinkTarget();
  }
  else
  {
    *m_t << "<a class=\"" << className << "\" ";
  }
  *m_t << "href=\"";
  DString fn = f;
  addHtmlExtensionIfMissing(fn);
  *m_t << createHtmlUrl(m_relPath,ref,
                        fileName()==fn,fn,anchor);
  *m_t << "\"";
  if (!tooltip.empty()) *m_t << " title=\"" << convertToHtml(tooltip) << "\"";
  *m_t << ">";
  codify(name);
  *m_t << "</a>";
}
 
void HtmlCodeGenerator::writeTooltip(const DString &id, const DocLinkInfo &docInfo,
                                     const DString &decl, const DString &desc,
                                     const SourceLinkInfo &defInfo,
                                     const SourceLinkInfo &declInfo)
{
  if (m_hide) return;
  *m_t << "<div class=\"ttc\" id=\"" << id << "\">";
  *m_t << "<div class=\"ttname\">";
  if (!docInfo.url.empty())
  {
    *m_t << "<a href=\"";
    DString fn = docInfo.url;
    addHtmlExtensionIfMissing(fn);
    *m_t << createHtmlUrl(m_relPath,docInfo.ref,
                          fileName()==fn,fn,docInfo.anchor);
    *m_t << "\">";
  }
  codify(docInfo.name);
  if (!docInfo.url.empty())
  {
    *m_t << "</a>";
  }
  *m_t << "</div>";
 
  if (!decl.empty())
  {
    *m_t << "<div class=\"ttdeci\">";
    codify(decl);
    *m_t << "</div>";
  }
 
  if (!desc.empty())
  {
    *m_t << "<div class=\"ttdoc\">";
    codify(desc);
    *m_t << "</div>";
  }
 
  if (!defInfo.file.empty())
  {
    *m_t << "<div class=\"ttdef\"><b>" << theTranslator->trDefinition() << "</b> ";
    if (!defInfo.url.empty())
    {
      *m_t << "<a href=\"";
      DString fn = defInfo.url;
      addHtmlExtensionIfMissing(fn);
      *m_t << createHtmlUrl(m_relPath,defInfo.ref,
                            fileName()==fn,fn,defInfo.anchor);
      *m_t << "\">";
    }
    *m_t << defInfo.file << ":" << defInfo.line;
    if (!defInfo.url.empty())
    {
      *m_t << "</a>";
    }
    *m_t << "</div>";
  }
  if (!declInfo.file.empty())
  {
    *m_t << "<div class=\"ttdecl\"><b>" << theTranslator->trDeclaration() << "</b> ";
    if (!declInfo.url.empty())
    {
      *m_t << "<a href=\"";
      DString fn = declInfo.url;
      addHtmlExtensionIfMissing(fn);
      *m_t << createHtmlUrl(m_relPath,declInfo.ref,
                            fileName()==fn,fn,declInfo.anchor);
      *m_t << "\">";
    }
    *m_t << declInfo.file << ":" << declInfo.line;
    if (!declInfo.url.empty())
    {
      *m_t << "</a>";
    }
    *m_t << "</div>";
  }
  *m_t << "</div>\n";
}
 
 
void HtmlCodeGenerator::startCodeLine(int)
{
  //printf("startCodeLine open=%d\n",m_lineOpen);
  m_col=0;
  if (m_hide) return;
  if (!m_lineOpen)
  {
    *m_t << "<div class=\"line\">";
    m_lineOpen = true;
  }
}
 
void HtmlCodeGenerator::endCodeLine()
{
  //printf("endCodeLine hide=%d open=%d\n",m_hide,m_lineOpen);
  if (m_hide) return;
  if (m_col == 0)
  {
    *m_t << " ";
    m_col++;
  }
  if (m_lineOpen)
  {
    *m_t << "</div>\n";
    m_lineOpen = false;
  }
}
 
void HtmlCodeGenerator::startFontClass(const DString &s)
{
  if (m_hide) return;
  *m_t << "<span class=\"" << s << "\">";
}
 
void HtmlCodeGenerator::endFontClass()
{
  if (m_hide) return;
  *m_t << "</span>";
}
 
void HtmlCodeGenerator::writeCodeAnchor(const DString &anchor)
{
  if (m_hide) return;
  *m_t << "<a id=\"" << anchor << "\" name=\"" << anchor << "\"></a>";
}
 
void HtmlCodeGenerator::startCodeFragment(const DString &)
{
  *m_t << "<div class=\"fragment\">";
}
 
void HtmlCodeGenerator::endCodeFragment(const DString &)
{
  //printf("endCodeFragment hide=%d open=%d\n",m_hide,m_lineOpen);
  bool wasHidden = m_hide;
  m_hide = false;
  //endCodeLine checks is there is still an open code line, if so closes it.
  endCodeLine();
  m_hide = wasHidden;
 
  *m_t << "</div><!-- fragment -->";
}
 
void HtmlCodeGenerator::startFold(int lineNr,const DString &startMarker,const DString &endMarker)
{
  //printf("startFold open=%d\n",m_lineOpen);
  if (m_lineOpen) // if we have a hidden comment in a code fold, we need to end the line
  {
    *m_t << "</div>\n";
  }
  const int maxLineNrStr = 10;
  char lineNumber[maxLineNrStr];
  snprintf(lineNumber,maxLineNrStr,"%05d",lineNr);
  *m_t << "<div class=\"foldopen\" id=\"foldopen" << lineNumber <<
          "\" data-start=\"" << startMarker <<
          "\" data-end=\"" << endMarker <<
          "\">\n";
  if (m_lineOpen) // if we have a hidden comment in a code fold, we need to restart the line
  {
    *m_t << "<div class=\"line\">";
  }
  m_hide=false;
}
 
void HtmlCodeGenerator::_startOpenLine()
{
  //printf("_startOpenLine open=%d\n",m_lineOpen);
  *m_t << "<div class=\"line\">";
  bool wasHidden=m_hide;
  m_hide = false;
  m_lineOpen = true;
  writeLineNumber(m_lastLineInfo.ref,
      m_lastLineInfo.fileName,
      m_lastLineInfo.anchor,
      m_lastLineInfo.line+1,
      m_lastLineInfo.writeAnchor);
  m_hide = wasHidden;
}
 
void HtmlCodeGenerator::endFold()
{
  //printf("endFold open=%d\n",m_lineOpen);
  if (m_lineOpen) // if we have a hidden comment in a code fold, we need to end the line
  {
    *m_t << "</div>\n";
  }
  *m_t << "</div>\n";
  if (m_lineOpen)
  {
    _startOpenLine();
  }
}
 
//--------------------------------------------------------------------------
 
HtmlGenerator::HtmlGenerator()
  : 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);
}
 
HtmlGenerator::HtmlGenerator(const HtmlGenerator &og) : 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;
}
 
HtmlGenerator &HtmlGenerator::operator=(const HtmlGenerator &og)
{
  //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;
}
 
HtmlGenerator::~HtmlGenerator() = default;
 
void HtmlGenerator::addCodeGen(OutputCodeList &list)
{
  list.add<HtmlCodeGeneratorDefer>(m_codeGen);
}
 
static bool hasDateReplacement(const DString &str)
{
  return (str.contains("$datetime",false) ||
          str.contains("$date",false) ||
          str.contains("$time",false) ||
          str.contains("$year",false)
         );
}
 
void HtmlGenerator::init()
{
  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 (Config_getBool(HTML_DYNAMIC_SECTIONS) ||
      (Config_getBool(SOURCE_BROWSER) && Config_getBool(SOURCE_TOOLTIPS)))
  {
    std::ofstream f = Portable::openOutputStream(dname+"/dynsections.js");
    if (f.is_open())
    {
      TextStream t(&f);
      if (Config_getBool(HTML_DYNAMIC_SECTIONS))
      {
        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"));
    }
  }
}
 
void HtmlGenerator::cleanup()
{
  DString dname = Config_getString(HTML_OUTPUT);
  Dir d(dname.str());
  clearSubDirs(d);
}
 
/// Additional initialization after indices have been created
void HtmlGenerator::writeTabData()
{
  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");
  }
}
 
void HtmlGenerator::writeSearchData(const DString &dname)
{
  //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");
  }
}
 
static void writeDefaultStyleSheet(TextStream &t)
{
  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"));
  }
 
}
 
void HtmlGenerator::writeStyleSheetFile(TextStream &t)
{
  fillColorStyleMaps();
  writeDefaultStyleSheet(t);
}
 
void HtmlGenerator::writeHeaderFile(TextStream &t, const DString & /*cssname*/)
{
  t << "<!-- HTML header for doxygen " << getDoxygenVersion() << "-->\n";
  t << ResourceMgr::instance().getAsString("header.html");
}
 
void HtmlGenerator::writeFooterFile(TextStream &t)
{
  t << "<!-- HTML footer for doxygen " << getDoxygenVersion() << "-->\n";
  t << ResourceMgr::instance().getAsString("footer.html");
}
 
static std::mutex g_indexLock;
 
void HtmlGenerator::startFile(const DString &name,bool isSource,const DString &,
                              const DString &title,int /*id*/, int /*hierarchyLevel*/)
{
  //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 searchEngine = Config_getBool(SEARCHENGINE);
  if (searchEngine /*&& !generateTreeView*/)
  {
    m_t << "<script type=\"text/javascript\">\n";
    m_t << "let searchBox = new SearchBox(\"searchBox\", \""
        << m_relPath<< "search/\",'" << Doxygen::htmlFileExtension << "');\n";
    m_t << "</script>\n";
  }
  if (Config_getBool(HTML_CODE_FOLDING))
  {
    m_t << "<script type=\"text/javascript\">\n";
    m_t << "document.addEventListener('DOMContentLoaded', codefold.init);\n";
    m_t << "</script>\n";
  }
  m_sectionCount=0;
}
 
void HtmlGenerator::writeSearchInfoStatic(TextStream &t,const DString &)
{
  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";
  }
}
 
void HtmlGenerator::writeSearchInfo()
{
  writeSearchInfoStatic(m_t,m_relPath);
}
 
 
DString HtmlGenerator::writeLogoAsString(const DString &path)
{
  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;
}
 
void HtmlGenerator::writeLogo()
{
  m_t << writeLogoAsString(m_relPath);
}
 
void HtmlGenerator::writePageFooter(TextStream &t,const DString &lastTitle,
                              const DString &relPath,const DString &navPath)
{
  t << substituteHtmlKeywords(g_footer_file,g_footer,convertToHtml(lastTitle),relPath,navPath);
}
 
void HtmlGenerator::writeFooter(const DString &navPath)
{
  writePageFooter(m_t,m_lastTitle,m_relPath,navPath);
}
 
void HtmlGenerator::endFile()
{
  endPlainFile();
}
 
void HtmlGenerator::startProjectNumber()
{
  m_t << "<h3 class=\"version\">";
}
 
void HtmlGenerator::endProjectNumber()
{
  m_t << "</h3>";
}
 
void HtmlGenerator::writeStyleInfo(int part)
{
  //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 (Config_getBool(HTML_DYNAMIC_SECTIONS) ||
        (Config_getBool(SOURCE_BROWSER) && Config_getBool(SOURCE_TOOLTIPS)))
    {
      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");
    }
  }
}
 
void HtmlGenerator::startDoxyAnchor(const DString &,const DString &,
                                    const DString &anchor, const DString &,
                                    const DString &)
{
  m_t << "<a id=\"" << anchor << "\" name=\"" << anchor << "\"></a>";
}
 
void HtmlGenerator::endDoxyAnchor(const DString &,const DString &)
{
}
 
void HtmlGenerator::addLabel(const DString &,const DString &)
{
}
 
void HtmlGenerator::startParagraph(const DString &classDef)
{
  if (!classDef.empty())
    m_t << "\n<p class=\"" << classDef << "\">";
  else
    m_t << "\n<p>";
}
 
void HtmlGenerator::endParagraph()
{
  m_t << "</p>\n";
}
 
void HtmlGenerator::writeString(const DString &text)
{
  m_t << text;
}
 
void HtmlGenerator::startIndexListItem()
{
  m_t << "<li>";
}
 
void HtmlGenerator::endIndexListItem()
{
  m_t << "</li>\n";
}
 
void HtmlGenerator::startIndexItem(const DString &ref,const DString &f)
{
  //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>";
  }
}
 
void HtmlGenerator::endIndexItem(const DString &ref,const DString &f)
{
  //printf("HtmlGenerator::endIndexItem(%s,%s,%s)\n",ref,f,name);
  if (!ref.empty() || !f.empty())
  {
    m_t << "</a>";
  }
  else
  {
    m_t << "</b>";
  }
}
 
void HtmlGenerator::writeStartAnnoItem(const DString &,const DString &f,
                                       const DString &path,const DString &name)
{
  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> ";
}
 
void HtmlGenerator::writeObjectLink(const DString &ref,const DString &f,
                                    const DString &anchor, const DString &name)
{
  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>";
}
 
void HtmlGenerator::startTextLink(const DString &f,const DString &anchor)
{
  m_t << "<a href=\"";
  DString fn = f;
  addHtmlExtensionIfMissing(fn);
  m_t << createHtmlUrl(m_relPath,"",
                       fileName() == Config_getString(HTML_OUTPUT)+"/"+fn,
                       fn,
                       anchor);
  m_t << "\">";
}
 
void HtmlGenerator::endTextLink()
{
  m_t << "</a>";
}
 
void HtmlGenerator::startGroupHeader(const DString &id,int extraIndentLevel)
{
  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\">";
}
 
void HtmlGenerator::endGroupHeader(int extraIndentLevel)
{
  if (extraIndentLevel==2)
  {
    m_t << "</h4>\n";
  }
  else if (extraIndentLevel==1)
  {
    m_t << "</h3>\n";
  }
  else
  {
    m_t << "</h2>\n";
  }
}
 
void HtmlGenerator::startSection(const DString &lab,const DString &,SectionType type)
{
  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>";
}
 
void HtmlGenerator::endSection(const DString &,SectionType type)
{
  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;
  }
}
 
void HtmlGenerator::docify(const DString &str)
{
  docify_(str,false);
}
 
void HtmlGenerator::docify_(const DString &str,bool inHtmlComment)
{
  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;
      }
    }
  }
}
 
void HtmlGenerator::writeChar(char c)
{
  char cs[2];
  cs[0]=c;
  cs[1]=0;
  docify(cs);
}
 
//--- helper function for dynamic sections -------------------------
 
static void startSectionHeader(TextStream &t,
                               const DString &relPath,int sectionCount)
{
  //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";
  }
}
 
static void endSectionHeader(TextStream &t)
{
  //t << "<!-- endSectionHeader -->";
  t << "</div>\n";
}
 
static void startSectionSummary(TextStream &t,int sectionCount)
{
  //t << "<!-- startSectionSummary -->";
  bool dynamicSections = Config_getBool(HTML_DYNAMIC_SECTIONS);
  if (dynamicSections)
  {
    t << "<div id=\"dynsection-" << sectionCount << "-summary\" "
         "class=\"dynsummary\">\n";
  }
}
 
static void endSectionSummary(TextStream &t)
{
  //t << "<!-- endSectionSummary -->";
  bool dynamicSections = Config_getBool(HTML_DYNAMIC_SECTIONS);
  if (dynamicSections)
  {
    t << "</div>\n";
  }
}
 
static void startSectionContent(TextStream &t,int sectionCount)
{
  //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";
  }
}
 
static void endSectionContent(TextStream &t)
{
  //t << "<!-- endSectionContent -->";
  t << "</div>\n";
}
 
//----------------------------
 
void HtmlGenerator::startClassDiagram()
{
  startSectionHeader(m_t,m_relPath,m_sectionCount);
}
 
void HtmlGenerator::endClassDiagram(const ClassDiagram &d,
                                const DString &fileName,const DString &name)
{
  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++;
}
 
 
void HtmlGenerator::startMemberList()
{
  DBG_HTML(m_t << "<!-- startMemberList -->\n")
}
 
void HtmlGenerator::endMemberList()
{
  DBG_HTML(m_t << "<!-- endMemberList -->\n")
}
 
// anonymous type:
//  0 = single column right aligned
//  1 = double column left aligned
//  2 = single column left aligned
void HtmlGenerator::startMemberItem(const DString &anchor,MemberItemType type,const DString &inheritId)
{
  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);
}
 
void HtmlGenerator::endMemberItem(MemberItemType type)
{
  if (type==MemberItemType::AnonymousStart)
  {
    insertMemberAlign(false);
  }
  m_t << "</td></tr>\n";
}
 
void HtmlGenerator::startMemberTemplateParams()
{
}
 
void HtmlGenerator::endMemberTemplateParams(const DString &anchor,const DString &inheritId)
{
  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\">";
}
 
void HtmlGenerator::startCompoundTemplateParams()
{
  m_t << "<div class=\"compoundTemplParams\">";
}
 
void HtmlGenerator::endCompoundTemplateParams()
{
  m_t << "</div>";
}
 
void HtmlGenerator::insertMemberAlign(bool)
{
  DBG_HTML(m_t << "<!-- insertMemberAlign -->\n")
  m_t << "&#160;</td><td class=\"memItemRight\">";
}
 
void HtmlGenerator::insertMemberAlignLeft(MemberItemType type, bool initTag)
{
  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;
  }
}
 
void HtmlGenerator::startMemberDescription(const DString &anchor,const DString &inheritId, bool typ)
{
  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\">";
}
 
void HtmlGenerator::endMemberDescription()
{
  DBG_HTML(m_t << "<!-- endMemberDescription -->\n")
  m_t << "<br /></td></tr>\n";
}
 
void HtmlGenerator::startMemberSections()
{
  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!
}
 
void HtmlGenerator::endMemberSections()
{
  DBG_HTML(m_t << "<!-- endMemberSections -->\n")
  if (!m_emptySection)
  {
    m_t << "</table>\n";
  }
}
 
void HtmlGenerator::startMemberHeader(const DString &anchor, int typ)
{
  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";
  }
}
 
void HtmlGenerator::endMemberHeader()
{
  DBG_HTML(m_t << "<!-- endMemberHeader -->\n")
  m_t << "</h2></td></tr>\n";
}
 
void HtmlGenerator::startMemberSubtitle()
{
  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\">";
}
 
void HtmlGenerator::endMemberSubtitle()
{
  DBG_HTML(m_t << "<!-- endMemberSubtitle -->\n")
  m_t << "</td></tr>\n";
}
 
void HtmlGenerator::startIndexList()
{
  m_t << "<table>\n";
}
 
void HtmlGenerator::endIndexList()
{
  m_t << "</table>\n";
}
 
void HtmlGenerator::startIndexKey()
{
  //m_t << "  <tr><td class=\"indexkey\">";
}
 
void HtmlGenerator::endIndexKey()
{
  //m_t << "</td>";
}
 
void HtmlGenerator::startIndexValue(bool)
{
  //m_t << "<td class=\"indexvalue\">";
}
 
void HtmlGenerator::endIndexValue(const DString &,bool)
{
  //m_t << "</td></tr>\n";
}
 
void HtmlGenerator::startMemberDocList()
{
  DBG_HTML(m_t << "<!-- startMemberDocList -->\n";)
}
 
void HtmlGenerator::endMemberDocList()
{
  DBG_HTML(m_t << "<!-- endMemberDocList -->\n";)
}
 
void HtmlGenerator::startMemberDoc( const DString &/* clName */, const DString &/* memName */,
                                    const DString &anchor, const DString &title,
                                    int memCount, int memTotal, bool /* showInline */)
{
  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";
}
 
void HtmlGenerator::startMemberDocPrefixItem()
{
  DBG_HTML(m_t << "<!-- startMemberDocPrefixItem -->\n";)
  m_t << "<div class=\"memtemplate\">\n";
}
 
void HtmlGenerator::endMemberDocPrefixItem()
{
  DBG_HTML(m_t << "<!-- endMemberDocPrefixItem -->\n";)
  m_t << "</div>\n";
}
 
void HtmlGenerator::startMemberDocName(bool /*align*/)
{
  DBG_HTML(m_t << "<!-- startMemberDocName -->\n";)
 
  m_t << "      <table class=\"memname\">\n";
 
  m_t << "        <tr>\n";
  m_t << "          <td class=\"memname\">";
}
 
void HtmlGenerator::endMemberDocName()
{
  DBG_HTML(m_t << "<!-- endMemberDocName -->\n";)
  m_t << "</td>\n";
}
 
void HtmlGenerator::startParameterList(bool openBracket)
{
  DBG_HTML(m_t << "<!-- startParameterList -->\n";)
  m_t << "          <td>";
  if (openBracket) m_t << "(";
  m_t << "</td>\n";
}
 
void HtmlGenerator::startParameterType(bool first,const DString &key)
{
  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\">";
  }
}
 
void HtmlGenerator::endParameterType()
{
  DBG_HTML(m_t << "<!-- endParameterType -->\n";)
  m_t << "</td>";
}
 
void HtmlGenerator::startParameterName(bool /*oneArgOnly*/)
{
  DBG_HTML(m_t << "<!-- startParameterName -->\n";)
  m_t << "          <td class=\"paramname\"><span class=\"paramname\"><em>";
}
 
void HtmlGenerator::endParameterName()
{
  DBG_HTML(m_t << "<!-- endParameterName -->\n";)
  m_t << "</em></span>";
}
 
void HtmlGenerator::startParameterExtra()
{
  DBG_HTML(m_t << "<!-- startParameterExtra -->\n";)
}
 
void HtmlGenerator::endParameterExtra(bool last,bool emptyList, bool closeBracket)
{
  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";
  }
}
 
void HtmlGenerator::startParameterDefVal(const char *s)
{
  m_t << "<span class=\"paramdefsep\">";
  docify(s);
  m_t << "</span><span class=\"paramdefval\">";
}
 
void HtmlGenerator::endParameterDefVal()
{
  m_t << "</span>";
}
 
void HtmlGenerator::endParameterList()
{
  DBG_HTML(m_t << "<!-- endParameterList -->\n";)
  m_t << "</td>\n";
  m_t << "        </tr>\n";
}
 
void HtmlGenerator::exceptionEntry(const DString &prefix,bool closeBracket)
{
  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\">";
}
 
void HtmlGenerator::endMemberDoc(bool hasArgs)
{
  DBG_HTML(m_t << "<!-- endMemberDoc -->\n";)
  if (!hasArgs)
  {
    m_t << "        </tr>\n";
  }
  m_t << "      </table>\n";
 // m_t << "</div>\n";
}
 
void HtmlGenerator::startDotGraph()
{
  startSectionHeader(m_t,m_relPath,m_sectionCount);
}
 
void HtmlGenerator::endDotGraph(DotClassGraph &g)
{
  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++;
}
 
void HtmlGenerator::startInclDepGraph()
{
  startSectionHeader(m_t,m_relPath,m_sectionCount);
}
 
void HtmlGenerator::endInclDepGraph(DotInclDepGraph &g)
{
  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++;
}
 
void HtmlGenerator::startGroupCollaboration()
{
  startSectionHeader(m_t,m_relPath,m_sectionCount);
}
 
void HtmlGenerator::endGroupCollaboration(DotGroupCollaboration &g)
{
  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++;
}
 
void HtmlGenerator::startCallGraph()
{
  startSectionHeader(m_t,m_relPath,m_sectionCount);
}
 
void HtmlGenerator::endCallGraph(DotCallGraph &g)
{
  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++;
}
 
void HtmlGenerator::startDirDepGraph()
{
  startSectionHeader(m_t,m_relPath,m_sectionCount);
}
 
void HtmlGenerator::endDirDepGraph(DotDirDeps &g)
{
  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++;
}
 
void HtmlGenerator::writeGraphicalHierarchy(DotGfxHierarchyTable &g)
{
  g.writeGraph(m_t,dir(),fileName());
}
 
void HtmlGenerator::startMemberGroupHeader(const DString &id,bool)
{
  m_t << "<tr id=\"" << id << "\" class=\"groupHeader\"><td colspan=\"2\"><div class=\"groupHeader\">";
}
 
void HtmlGenerator::endMemberGroupHeader(bool)
{
  m_t << "</div></td></tr>\n";
}
 
void HtmlGenerator::startMemberGroupDocs()
{
  m_t << "<tr><td colspan=\"2\" class=\"ititle\"><div class=\"groupText\">";
}
 
void HtmlGenerator::endMemberGroupDocs()
{
  m_t << "</div></td></tr>\n";
}
 
void HtmlGenerator::startMemberGroup()
{
}
 
void HtmlGenerator::endMemberGroup(bool)
{
}
 
void HtmlGenerator::startIndent()
{
  DBG_HTML(m_t << "<!-- startIndent -->\n";)
 
  m_t << "<div class=\"memdoc\">\n";
}
 
void HtmlGenerator::endIndent()
{
  DBG_HTML(m_t << "<!-- endIndent -->\n";)
  m_t << "\n</div>\n" << "</div>\n";
}
 
void HtmlGenerator::addIndexItem(const DString &,const DString &)
{
}
 
void HtmlGenerator::writeNonBreakableSpace(int n)
{
  for (int i=0; i<n; i++)
  {
    m_t << "&#160;";
  }
}
 
void HtmlGenerator::startDescTable(const DString &title,const bool hasInits)
{
  m_t << "<table class=\"fieldtable\">\n"
      << "<tr><th colspan=\"" << (hasInits?3:2) << "\">" << title << "</th></tr>";
}
void HtmlGenerator::endDescTable()
{
  m_t << "</table>\n";
}
 
void HtmlGenerator::startDescTableRow()
{
  m_t << "<tr>";
}
 
void HtmlGenerator::endDescTableRow()
{
  m_t << "</tr>\n";
}
 
void HtmlGenerator::startDescTableTitle()
{
  m_t << "<td class=\"fieldname\">";
}
 
void HtmlGenerator::endDescTableTitle()
{
  m_t << "&#160;</td>";
}
 
void HtmlGenerator::startDescTableInit()
{
  m_t << "<td class=\"fieldinit\">";
}
 
void HtmlGenerator::endDescTableInit()
{
  m_t << "&#160;</td>";
}
 
void HtmlGenerator::startDescTableData()
{
  m_t << "<td class=\"fielddoc\">";
}
 
void HtmlGenerator::endDescTableData()
{
  m_t << "</td>";
}
 
void HtmlGenerator::startExamples()
{
  m_t << "<dl class=\"section examples\"><dt>";
  docify(theTranslator->trExamples());
  m_t << "</dt>";
}
 
void HtmlGenerator::endExamples()
{
  m_t << "</dl>\n";
}
 
void HtmlGenerator::writeDoc(const IDocNodeAST *ast,const Definition *ctx,const MemberDef *,int id,int sectionLevel)
{
  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);
  }
}
 
//---------------- helpers for index generation -----------------------------
 
static void startQuickIndexList(TextStream &t,bool topLevel=true)
{
  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>";
  }
}
 
static void endQuickIndexList(TextStream &t)
{
  if (!Config_getBool(DISABLE_INDEX))
  {
    t << "    </ul>\n";
    t << "  </div>\n";
  }
  else
  {
    t << "</ul>\n";
  }
}
 
static void startQuickIndexItem(TextStream &t,const DString &l,
                                bool hl,bool /*compact*/,
                                const DString &relPath)
{
  t << "      <li";
  if (hl)
  {
    t << " class=\"current\"";
  }
  t << ">";
  if (!l.empty()) t << "<a href=\"" << correctURL(l,relPath) << "\">";
  t << "<span>";
}
 
static void endQuickIndexItem(TextStream &t,const DString &l)
{
  t << "</span>";
  if (!l.empty()) t << "</a>";
  t << "</li>\n";
}
 
static bool quickLinkVisible(LayoutNavEntry::Kind kind)
{
  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;
}
 
static void renderQuickLinksAsTree(TextStream &t,const DString &relPath,LayoutNavEntry *root)
 
{
  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);
  }
}
 
 
static void renderQuickLinksAsTabs(TextStream &t,const DString &relPath,
                             LayoutNavEntry *hlEntry,LayoutNavEntry::Kind kind,
                             bool highlightParent,bool highlightSearch)
{
  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);
      }
    }
  }
}
 
static void writeDefaultQuickLinks(TextStream &t,
                                   HighlightedItem hli,
                                   const DString &file,
                                   const DString &relPath,
                                   bool extraTabs)
{
  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;
  }
 
  t << "<script type=\"application/json\" id=\"doxygen-config\">\n";
  t << "{\n";
  t << "  \"relPath\": \"" << relPath << "\",\n";
  t << "  \"generateTreeView\": " << (generateTreeView?"true":"false") << ",\n";
  t << "  \"searchEngine\": " << (searchEngine?"true":"false") << ",\n";
  t << "  \"serverBasedSearch\": " << (serverBasedSearch?"true":"false") << ",\n";
  t << "  \"disableIndex\": " << (disableIndex?"true":"false") << ",\n";
  t << "  \"dynamicMenus\": " << (dynamicMenus?"true":"false") << ",\n";
  t << "  \"fullSidebar\": " << (fullSidebar?"true":"false") << "\n";
  t << "}\n";
  t << "</script>\n";
 
  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";
  }
}
 
void HtmlGenerator::endQuickIndices()
{
  bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
  m_t << "</div><!-- top -->\n";
  if (!generateTreeView)
  {
    m_t << "<div id=\"doc-content\">\n";
  }
}
 
DString HtmlGenerator::writeSplitBarAsString(const DString &name,const DString &relpath,const DString &allMembersFile)
{
  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;
}
 
void HtmlGenerator::writeSplitBar(const DString &name,const DString &allMembersFile)
{
  m_t << writeSplitBarAsString(name,m_relPath,allMembersFile);
}
 
void HtmlGenerator::writeNavigationPath(const DString &s)
{
  m_t << substitute(s,"$relpath^",m_relPath);
}
 
void HtmlGenerator::startContents()
{
  m_t << "<div class=\"contents\">\n";
}
 
void HtmlGenerator::endContents()
{
  m_t << "</div><!-- contents -->\n";
}
 
void HtmlGenerator::startPageDoc(const DString &/* pageTitle */)
{
  m_t << "<div>";
}
 
void HtmlGenerator::endPageDoc()
{
  m_t << "</div><!-- PageDoc -->\n";
}
 
void HtmlGenerator::writeQuickLinks(HighlightedItem hli,const DString &file,bool extraTabs)
{
  writeDefaultQuickLinks(m_t,hli,file,m_relPath,extraTabs);
}
 
// PHP based search script
void HtmlGenerator::writeSearchPage()
{
  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);
  }
}
 
void HtmlGenerator::writeExternalSearchPage()
{
  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 << "    results.innerHTML = '<p>" << theTranslator->trSearchResults(0) << "</p>';\n";
    t << "  }\n";
    t << "});\n";
  }
  else
  {
     err("Failed to open file '{}' for writing...\n",scriptName);
  }
}
 
void HtmlGenerator::startConstraintList(const DString &header)
{
  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";
}
 
void HtmlGenerator::startConstraintParam()
{
  m_t << "<tr><td valign=\"top\"><em>";
}
 
void HtmlGenerator::endConstraintParam()
{
  m_t << "</em></td>";
}
 
void HtmlGenerator::startConstraintType()
{
  m_t << "<td>&#160;:</td><td valign=\"top\"><em>";
}
 
void HtmlGenerator::endConstraintType()
{
  m_t << "</em></td>";
}
 
void HtmlGenerator::startConstraintDocs()
{
  m_t << "<td>&#160;";
}
 
void HtmlGenerator::endConstraintDocs()
{
  m_t << "</td></tr>\n";
}
 
void HtmlGenerator::endConstraintList()
{
  m_t << "</table>\n";
  m_t << "</dd>\n";
  m_t << "</dl>\n";
  m_t << "</div>\n";
}
 
void HtmlGenerator::lineBreak(const DString &style)
{
  if (!style.empty())
  {
    m_t << "<br class=\"" << style << "\" />\n";
  }
  else
  {
    m_t << "<br />\n";
  }
}
 
void HtmlGenerator::startHeaderSection()
{
  m_t << "<div class=\"header\">\n";
}
 
void HtmlGenerator::startTitleHead(const DString &)
{
  m_t << "  <div class=\"headertitle\">";
  startTitle();
}
 
void HtmlGenerator::endTitleHead(const DString &,const DString &)
{
  endTitle();
  m_t << "</div>\n";
}
 
void HtmlGenerator::endHeaderSection()
{
  m_t << "</div><!--header-->\n";
}
 
void HtmlGenerator::startInlineHeader()
{
  if (m_emptySection)
  {
    m_t << "<table class=\"memberdecls memberdecls-inline\">\n";
    m_emptySection=false;
  }
  m_t << "<tr><th colspan=\"2\"><h3>";
}
 
void HtmlGenerator::endInlineHeader()
{
  m_t << "</h3></th></tr>\n";
}
 
void HtmlGenerator::startMemberDocSimple(bool isEnum)
{
  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";
}
 
void HtmlGenerator::endMemberDocSimple(bool)
{
  DBG_HTML(m_t << "<!-- endMemberDocSimple -->\n";)
  m_t << "</table>\n";
}
 
void HtmlGenerator::startInlineMemberType()
{
  DBG_HTML(m_t << "<!-- startInlineMemberType -->\n";)
  m_t << "<tr><td class=\"fieldtype\">\n";
}
 
void HtmlGenerator::endInlineMemberType()
{
  DBG_HTML(m_t << "<!-- endInlineMemberType -->\n";)
  m_t << "</td>\n";
}
 
void HtmlGenerator::startInlineMemberName()
{
  DBG_HTML(m_t << "<!-- startInlineMemberName -->\n";)
  m_t << "<td class=\"fieldname\">\n";
}
 
void HtmlGenerator::endInlineMemberName()
{
  DBG_HTML(m_t << "<!-- endInlineMemberName -->\n";)
  m_t << "</td>\n";
}
 
void HtmlGenerator::startInlineMemberDoc()
{
  DBG_HTML(m_t << "<!-- startInlineMemberDoc -->\n";)
  m_t << "<td class=\"fielddoc\">\n";
}
 
void HtmlGenerator::endInlineMemberDoc()
{
  DBG_HTML(m_t << "<!-- endInlineMemberDoc -->\n";)
  m_t << "</td></tr>\n";
}
 
void HtmlGenerator::startEmbeddedDoc(size_t indent)
{
  DBG_HTML(m_t << "<!-- startEmbeddedDoc -->\n";)
  m_t << "<div class=\"embeddoc indent-" << indent << "\">";
}
 
void HtmlGenerator::endEmbeddedDoc()
{
  DBG_HTML(m_t << "<!-- endEmbeddedDoc -->\n";)
  m_t << "</div>";
}
 
void HtmlGenerator::startLabels()
{
  DBG_HTML(m_t << "<!-- startLabels -->\n";)
  m_t << "<span class=\"mlabels\">";
}
 
void HtmlGenerator::writeLabel(const DString &label,bool /*isLast*/)
{
  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 (c<0 || (c>='a' && c<='z') || c=='_') // nmstart pattern
      {
        nmstart=true;
        result+=c;
      }
      else if (nmstart && (c<0 || (c>='a' && c<='z') || (c>='0' && c<='9') || c=='_')) // nmchar pattern
      {
        result+=c;
      }
      else if (nmstart && (c==' ' || c=='-')) // show whitespace as -
      {
        result+='-';
      }
    }
    return result;
  };
 
  m_t << "<span class=\"mlabel " << convertLabelToClass(label.stripWhiteSpace().str()) << "\">" << label << "</span>";
}
 
void HtmlGenerator::endLabels()
{
  DBG_HTML(m_t << "<!-- endLabels -->\n";)
  m_t << "</span>";
}
 
void HtmlGenerator::writeInheritedSectionTitle(
                  const DString &id,    const DString &ref,
                  const DString &file,  const DString &anchor,
                  const DString &title, const DString &name)
{
  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";
}
 
void HtmlGenerator::writeSummaryLink(const DString &file,const DString &anchor,const DString &title,bool first)
{
  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>";
}
 
void HtmlGenerator::writePageOutline()
{
  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";
}
 
void HtmlGenerator::endMemberDeclaration(const DString &anchor,const DString &inheritId)
{
}
 
DString HtmlGenerator::getNavTreeCss()
{
  ResourceMgr &mgr = ResourceMgr::instance();
  return replaceVariables(mgr.getAsString("navtree.css"));
}
 
DString HtmlGenerator::fixSpaces(const DString &s)
{
  return substitute(s," ","&#160;");
}
 
void HtmlGenerator::startLocalToc(int level)
{
  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";
}
 
void HtmlGenerator::endLocalToc()
{
  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";
}
 
void HtmlGenerator::startTocEntry(const SectionInfo *si)
{
  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+"\">";
    }
  }
}
 
void HtmlGenerator::endTocEntry(const SectionInfo *si)
{
  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;
  }
}