HtmlDocVisitor Class Reference

Concrete visitor implementation for HTML output. More...

#include <src/htmldocvisitor.h>

Inheritance diagram for HtmlDocVisitor:

Collaboration diagram for HtmlDocVisitor:

Public Member Functions
	HtmlDocVisitor (TextStream &t, OutputCodeList &ci, const Definition *ctx, const DString &fn=DString())
void	operator() (const DocWord &)
void	operator() (const DocLinkedWord &)
void	operator() (const DocWhiteSpace &)
void	operator() (const DocSymbol &)
void	operator() (const DocEmoji &)
void	operator() (const DocURL &)
void	operator() (const DocLineBreak &)
void	operator() (const DocHorRuler &)
void	operator() (const DocStyleChange &)
void	operator() (const DocVerbatim &)
void	operator() (const DocAnchor &)
void	operator() (const DocInclude &)
void	operator() (const DocIncOperator &)
void	operator() (const DocFormula &)
void	operator() (const DocIndexEntry &)
void	operator() (const DocSimpleSectSep &)
void	operator() (const DocCite &)
void	operator() (const DocSeparator &)
void	operator() (const DocAutoList &)
void	operator() (const DocAutoListItem &)
void	operator() (const DocPara &)
void	operator() (const DocRoot &)
void	operator() (const DocSimpleSect &)
void	operator() (const DocTitle &)
void	operator() (const DocSimpleList &)
void	operator() (const DocSimpleListItem &)
void	operator() (const DocSection &)
void	operator() (const DocHtmlList &)
void	operator() (const DocHtmlListItem &)
void	operator() (const DocHtmlDescList &)
void	operator() (const DocHtmlDescTitle &)
void	operator() (const DocHtmlDescData &)
void	operator() (const DocHtmlTable &)
void	operator() (const DocHtmlRow &)
void	operator() (const DocHtmlCell &)
void	operator() (const DocHtmlCaption &)
void	operator() (const DocInternal &)
void	operator() (const DocHRef &)
void	operator() (const DocHtmlSummary &)
void	operator() (const DocHtmlDetails &)
void	operator() (const DocHtmlHeader &)
void	operator() (const DocImage &)
void	operator() (const DocDotFile &)
void	operator() (const DocMscFile &)
void	operator() (const DocDiaFile &)
void	operator() (const DocPlantUmlFile &)
void	operator() (const DocMermaidFile &)
void	operator() (const DocLink &)
void	operator() (const DocRef &)
void	operator() (const DocSecRefItem &)
void	operator() (const DocSecRefList &)
void	operator() (const DocParamSect &)
void	operator() (const DocParamList &)
void	operator() (const DocXRefItem &)
void	operator() (const DocInternalRef &)
void	operator() (const DocText &)
void	operator() (const DocHtmlBlockQuote &)
void	operator() (const DocVhdlFlow &)
void	operator() (const DocParBlock &)
template<class Node>
void	forceEndParagraph (const Node &n)
	Used for items found inside a paragraph, which due to XHTML restrictions have to be outside of the paragraph.
template<class Node>
void	forceStartParagraph (const Node &n)
	Used for items found inside a paragraph, which due to XHTML restrictions have to be outside of the paragraph.
Public Member Functions inherited from DocVisitor
	DocVisitor ()
virtual	~DocVisitor ()
CodeParserInterface &	getCodeParser (const DString &langExt)
void	pushHidden (bool hide)
bool	popHidden ()

Private Member Functions
template<class T>
void	visitChildren (const T &t)
template<class T>
void	visitCaption (TextStream &t, const T &n)
void	writeObfuscatedMailAddress (const DString &url)
void	filter (const DString &str, bool retainNewline=false, bool citeEntry=false)
DString	filterQuotedCdataAttr (const DString &str)
	Escape basic entities to produce a valid CDATA attribute value, assume that the outer quoting will be using the double quote ".
void	startLink (const DString &ref, const DString &file, const DString &relPath, const DString &anchor, const DString &tooltip="")
void	endLink ()
void	writeDotFile (const DString &fileName, const DString &relPath, const DString &context, const DString &srcFile, int srcLine, bool newFile=true)
void	writeMscFile (const DString &fileName, const DString &relPath, const DString &context, const DString &srcFile, int srcLine, bool newFile=true)
void	writeDiaFile (const DString &fileName, const DString &relPath, const DString &context, const DString &srcFile, int srcLine, bool newFile=true)
void	writePlantUMLFile (const DString &fileName, const DString &relPath, const DString &context, const DString &srcFile, int srcLine)
void	writeMermaidFile (const DString &fileName, const DString &relPath, const DString &context, const DString &srcFile, int srcLine)
template<class DocNode>
void	forceEndParagraph (const DocNode &n)
template<class DocNode>
void	forceStartParagraph (const DocNode &n)

Private Attributes
TextStream &	m_t
OutputCodeList &	m_ci
bool	m_insidePre = false
bool	m_hide = false
bool	m_insideTitle = false
const Definition *	m_ctx
DString	m_fileName
DString	m_langExt

Detailed Description

Concrete visitor implementation for HTML output.

Definition at line 29 of file htmldocvisitor.h.

Constructor & Destructor Documentation

HtmlDocVisitor()

HtmlDocVisitor::HtmlDocVisitor	(	TextStream &	t,
		OutputCodeList &	ci,
		const Definition *	ctx,
		const DString &	fn = DString() )

Definition at line 233 of file htmldocvisitor.cpp.

  : m_t(t), m_ci(ci), m_ctx(ctx), m_fileName(fn)
{
  if (ctx) m_langExt=ctx->getDefFileExtension();
}

References Definition::getDefFileExtension(), m_ci, m_ctx, m_fileName, m_langExt, and m_t.

Member Function Documentation

endLink()

void HtmlDocVisitor::endLink ( )

private

Definition at line 2273 of file htmldocvisitor.cpp.

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

References m_t.

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

filter()

void HtmlDocVisitor::filter ( const DString & str, bool retainNewline = false, bool citeEntry = false )

private

Definition at line 2155 of file htmldocvisitor.cpp.

{
  if (str.empty()) return;
  const char *p=str.data();
  while (*p)
  {
    char c=*p++;
    switch(c)
    {
      case '\n': if(retainNewline) m_t << "<br/>"; m_t << c; break;
      case '<':  m_t << "&lt;"; break;
      case '>':  m_t << "&gt;"; break;
      case '&':  // possibility to have a special symbol
        if (!citeEntry) {m_t << "&amp;"; break;}
        p = HtmlEntityMapper::instance().writeHtmlEntity(
            m_t,
            p-1,
            [](HtmlEntityMapper::SymType symType) { return HtmlEntityMapper::instance().html(symType); },
            "&amp;");
        break;
      case '\\':
        if ((*p == '(') || (*p == ')') || (*p == '[') || (*p == ']'))
          m_t << "\\&zwj;" << *p++;
        else
          m_t << c;
        break;
      default:
        {
          uint8_t uc = static_cast<uint8_t>(c);
          if (uc<32 && !isspace(c)) // non-printable control characters
          {
            m_t << "&#x24" << hex[uc>>4] << hex[uc&0xF] << ";";
          }
          else
          {
            m_t << c;
          }
        }
        break;
    }
  }
}

References DString::data(), DString::empty(), hex, HtmlEntityMapper::html(), HtmlEntityMapper::instance(), m_t, and HtmlEntityMapper::writeHtmlEntity().

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

filterQuotedCdataAttr()

DString HtmlDocVisitor::filterQuotedCdataAttr ( const DString & str )

private

Escape basic entities to produce a valid CDATA attribute value, assume that the outer quoting will be using the double quote ".

Definition at line 2200 of file htmldocvisitor.cpp.

{
  if (str.empty()) return str;
  DString result;
  result.reserve(str.length()+8);
  const char *p=str.data();
  while (*p)
  {
    char c=*p++;
    switch(c)
    {
      case '&':  result+="&"; break;
      case '"':  result+="""; break;
      case '<':  result+="&lt;"; break;
      case '>':  result+="&gt;"; break;
      case '\\':
        if ((*p == '(') || (*p == ')') || (*p == '[') || (*p == ']'))
        {
          result+="\\&zwj;";
          result+=*p++;
        }
        else
        {
          result+=c;
        }
        break;
      default:
        {
          uint8_t uc = static_cast<uint8_t>(c);
          if (uc<32 && !isspace(c)) // non-printable control characters
          {
            result+="&#x24";
            result+=hex[uc>>4];
            result+=hex[uc&0xF];
            result+=";";
          }
          else
          {
            result+=c;
          }
        }
        break;
    }
  }
  return result;
}

References DString::data(), DString::empty(), hex, DString::length(), and DString::reserve().

Referenced by operator()().

forceEndParagraph() [1/2]

template<class DocNode>

void HtmlDocVisitor::forceEndParagraph ( const DocNode & n )

private

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

forceEndParagraph() [2/2]

template<class Node>

void HtmlDocVisitor::forceEndParagraph

(

const Node &

n

)

Used for items found inside a paragraph, which due to XHTML restrictions have to be outside of the paragraph.

This method will forcefully end the current paragraph and forceStartParagraph() will restart it.

Definition at line 2400 of file htmldocvisitor.cpp.

{
  const DocPara *para=std::get_if<DocPara>(n.parent());
  if (para)
  {
    const DocNodeList &children = para->children();
 
    //printf("forceEndParagraph\n");
    //dumpDocNodeList(children);
 
    auto it = std::find_if(std::begin(children),std::end(children),
        [&n](const auto &np) { return holds_value(&n,np); });
    if (it==std::end(children))   return;
    if (it==std::begin(children)) return; // first node in paragraph
    it = std::prev(it);
    bool found=false;
    while (!found)
    {
      found = !isInvisibleNode(*it);
      if (found) break;
      if (it!=std::begin(children))
      {
        --it;
      }
      else
      {
        break;
      }
    }
    if (!found) return; // first visible node in paragraph
    const DocNodeVariant &v = *it;
    if (mustBeOutsideParagraph(v)) return; // previous node already outside paragraph context
    bool styleOutsideParagraph=false;
    if (it!=std::begin(children))
    {
      it = std::prev(it);
      styleOutsideParagraph=insideStyleChangeThatIsOutsideParagraph(para,it);
    }
    bool isFirst = false;
    bool isLast = false;
    getParagraphContext(*para,isFirst,isLast);
    //printf("forceEnd first=%d last=%d styleOutsideParagraph=%d\n",isFirst,isLast,styleOutsideParagraph);
    if (isFirst && isLast) return;
    if (styleOutsideParagraph) return;
 
    //printf("adding </p>\n");
    m_t << "</p>";
  }
}

References DocCompoundNode::children(), getParagraphContext(), holds_value(), insideStyleChangeThatIsOutsideParagraph(), isInvisibleNode(), m_t, and mustBeOutsideParagraph().

forceStartParagraph() [1/2]

template<class DocNode>

void HtmlDocVisitor::forceStartParagraph ( const DocNode & n )

private

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

forceStartParagraph() [2/2]

template<class Node>

void HtmlDocVisitor::forceStartParagraph

(

const Node &

n

)

Used for items found inside a paragraph, which due to XHTML restrictions have to be outside of the paragraph.

This method will forcefully start the paragraph, that was previously ended by forceEndParagraph().

Definition at line 2455 of file htmldocvisitor.cpp.

{
  //printf("> forceStartParagraph(%s)\n",docNodeName(n));
  const DocPara *para=nullptr;
  if (n.parent() && (para = std::get_if<DocPara>(n.parent()))) // if we are inside a paragraph
  {
    const DocNodeList &children = para->children();
 
    auto it = std::find_if(std::begin(children),
                           std::end(children),
                           [&n](const auto &np)
                           { return holds_value(&n,np); });
    if (it==std::end(children)) return;
    bool styleOutsideParagraph=insideStyleChangeThatIsOutsideParagraph(para,it);
    //printf("it=%s (%p) styleOutsideParagraph=%d\n",
    //    docNodeName(*it), (void *)&*it, styleOutsideParagraph);
    if (styleOutsideParagraph) return;
    it = std::next(it);
    while (it!=std::end(children) && isInvisibleNode(*it))
    {
      ++it;
    }
    if (it!=std::end(children))
    {
      const DocNodeVariant &v = *it;
      if (mustBeOutsideParagraph(v)) return; // next element also outside paragraph
    }
    else
    {
      return; // only whitespace at the end!
    }
 
    bool needsTag = true;
    bool isFirst = false;
    bool isLast = false;
    getParagraphContext(*para,isFirst,isLast);
    if (isFirst && isLast)  needsTag = false;
    //printf("forceStart first=%d last=%d needsTag=%d\n",isFirst,isLast,needsTag);
 
    if (needsTag) m_t << "<p>";
  }
}

References DocCompoundNode::children(), getParagraphContext(), holds_value(), insideStyleChangeThatIsOutsideParagraph(), isInvisibleNode(), m_t, and mustBeOutsideParagraph().

operator()() [1/59]

void HtmlDocVisitor::operator()

(

const DocAnchor &

anc

)

Definition at line 683 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<a class=\"anchor\" id=\"" << anc.anchor() << "\"" << anc.attribs().toString() << "></a>";
}

References DocAnchor::anchor(), DocAnchor::attribs(), m_hide, m_t, and HtmlAttribList::toString().

operator()() [2/59]

void HtmlDocVisitor::operator()

(

const DocAutoList &

l

)

Definition at line 988 of file htmldocvisitor.cpp.

{
  //printf("DocAutoList::visitPre\n");
  if (m_hide) return;
  forceEndParagraph(l);
  if (l.isEnumList())
  {
    //
    // Do list type based on depth:
    // 1.
    //   a.
    //     i.
    //       A.
    //         1. (repeat)...
    //
    m_t << "<ol type=\"" << g_types[l.depth() % NUM_HTML_LIST_TYPES] << "\">";
  }
  else
  {
    if (l.isCheckedList())
    {
      m_t << "<ul class=\"check\">";
    }
    else
    {
      m_t << "<ul>";
    }
  }
  if (!l.isPreformatted()) m_t << "\n";
  visitChildren(l);
  if (l.isEnumList())
  {
    m_t << "</ol>";
  }
  else
  {
    m_t << "</ul>";
  }
  if (!l.isPreformatted()) m_t << "\n";
  forceStartParagraph(l);
}

References DocAutoList::depth(), forceEndParagraph(), forceStartParagraph(), g_types, DocAutoList::isCheckedList(), DocAutoList::isEnumList(), DocNode::isPreformatted(), m_hide, m_t, NUM_HTML_LIST_TYPES, and visitChildren().

operator()() [3/59]

void HtmlDocVisitor::operator()

(

const DocAutoListItem &

li

)

Definition at line 1030 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  switch (li.itemNumber())
  {
    case DocAutoList::Unchecked: // unchecked
      m_t << "<li class=\"unchecked\">";
      break;
    case DocAutoList::Checked_x: // checked with x
    case DocAutoList::Checked_X: // checked with X
      m_t << "<li class=\"checked\">";
      break;
    default:
      m_t << "<li>";
      break;
  }
  visitChildren(li);
  m_t << "</li>";
  if (!li.isPreformatted()) m_t << "\n";
}

References DocAutoList::Checked_X, DocAutoList::Checked_x, DocNode::isPreformatted(), DocAutoListItem::itemNumber(), m_hide, m_t, DocAutoList::Unchecked, and visitChildren().

operator()() [4/59]

void HtmlDocVisitor::operator()

(

const DocCite &

cite

)

Definition at line 962 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  auto opt = cite.option();
  if (!cite.file().empty())
  {
    if (!opt.noCite()) startLink(cite.ref(),cite.file(),cite.relPath(),cite.anchor());
    filter(cite.getText(), false, true);
    if (!opt.noCite()) endLink();
  }
  else
  {
    m_t << "<b>";
    if (!opt.noPar()) filter("[");
    filter(cite.target());
    if (!opt.noPar()) filter("]");
    m_t << "</b>";
  }
}

References DocCite::anchor(), DString::empty(), endLink(), DocCite::file(), filter(), DocCite::getText(), m_hide, m_t, DocCite::option(), DocCite::ref(), DocCite::relPath(), startLink(), and DocCite::target().

operator()() [5/59]

void HtmlDocVisitor::operator()

(

const DocDiaFile &

df

)

Definition at line 1806 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  forceEndParagraph(df);
  bool exists = false;
  std::string inBuf;
  if (readInputFile(df.file(),inBuf))
  {
    auto fileName = writeInlineGraph(Config_getString(HTML_OUTPUT)+"/"+stripPath(df.file())+"_", // baseName
                                     ".dia",                                                     // extension
                                     inBuf,                                                      // contents
                                     exists);
    if (!fileName.empty())
    {
      m_t << "<div class=\"diagraph\">\n";
      writeDiaFile(fileName,df.relPath(),df.context(),df.srcFile(),df.srcLine(),!exists);
      if (df.hasCaption())
      {
        m_t << "<div class=\"caption\">\n";
      }
      visitChildren(df);
      if (df.hasCaption())
      {
        m_t << "</div>\n";
      }
      m_t << "</div>\n";
    }
  }
  forceStartParagraph(df);
}

References Config_getString, DocDiagramFileBase::context(), DocDiagramFileBase::file(), forceEndParagraph(), forceStartParagraph(), DocDiagramFileBase::hasCaption(), m_hide, m_t, readInputFile(), DocDiagramFileBase::relPath(), DocDiagramFileBase::srcFile(), DocDiagramFileBase::srcLine(), stripPath(), visitChildren(), writeDiaFile(), and writeInlineGraph().

operator()() [6/59]

void HtmlDocVisitor::operator()

(

const DocDotFile &

df

)

Definition at line 1744 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  forceEndParagraph(df);
  bool exists = false;
  std::string inBuf;
  if (readInputFile(df.file(),inBuf))
  {
    auto fileName = writeInlineGraph(Config_getString(HTML_OUTPUT)+"/"+stripPath(df.file())+"_", // baseName
                                     ".dot",                                                     // extension
                                     inBuf,                                                      // contents
                                     exists);
    if (!fileName.empty())
    {
      m_t << "<div class=\"dotgraph\">\n";
      writeDotFile(fileName,df.relPath(),df.context(),df.srcFile(),df.srcLine(),!exists);
      if (df.hasCaption())
      {
        m_t << "<div class=\"caption\">\n";
      }
      visitChildren(df);
      if (df.hasCaption())
      {
        m_t << "</div>\n";
      }
      m_t << "</div>\n";
  }
  }
  forceStartParagraph(df);
}

References Config_getString, DocDiagramFileBase::context(), DocDiagramFileBase::file(), forceEndParagraph(), forceStartParagraph(), DocDiagramFileBase::hasCaption(), m_hide, m_t, readInputFile(), DocDiagramFileBase::relPath(), DocDiagramFileBase::srcFile(), DocDiagramFileBase::srcLine(), stripPath(), visitChildren(), writeDotFile(), and writeInlineGraph().

operator()() [7/59]

void HtmlDocVisitor::operator()

(

const DocEmoji &

s

)

Definition at line 309 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  const char *res = EmojiEntityMapper::instance().unicode(s.index());
  if (res)
  {
    m_t << "<span class=\"emoji\">" << res << "</span>";
  }
  else
  {
    m_t << s.name();
  }
}

References DocEmoji::index(), EmojiEntityMapper::instance(), m_hide, m_t, DocEmoji::name(), and EmojiEntityMapper::unicode().

operator()() [8/59]

void HtmlDocVisitor::operator()

(

const DocFormula &

f

)

Definition at line 827 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  bool bDisplay = !f.isInline();
  if (bDisplay)
  {
    forceEndParagraph(f);
    m_t << "<p class=\"formulaDsp\">\n";
  }
 
  if (Config_getBool(USE_MATHJAX))
  {
    DString text = f.text();
    bool closeInline = false;
    if (!bDisplay && !text.empty() && text.at(0)=='$' &&
                      text.at(text.length()-1)=='$')
    {
      closeInline=true;
      text = text.mid(1,text.length()-2);
      m_t << "\\(";
    }
    else if (!bDisplay && !text.empty())
    {
      closeInline=true;
      m_t << "\\(";
    }
    m_t << convertToHtml(text);
    if (closeInline)
    {
      m_t << "\\)";
    }
  }
  else
  {
    const Formula *formula = FormulaManager::instance().findFormula(f.id());
 
    enum class ImageType { Light, Dark };
    enum class Visibility { Always, Dark, Light, AutoDark, AutoLight };
    auto writeFormula = [&](ImageType imgType,Visibility visibility) -> DString {
      // see https://chipcullen.com/how-to-have-dark-mode-image-that-works-with-user-choice for the design idea
      TextStream t;
      DString extension = Config_getEnum(HTML_FORMULA_FORMAT)==HTML_FORMULA_FORMAT_t::svg ? ".svg":".png" ;
      if (visibility==Visibility::AutoDark || visibility==Visibility::AutoLight)
      {
        t << "<picture>";
        t << "<source srcset=\"" << f.relPath() << f.name();
        if (visibility==Visibility::AutoDark)
        {
          t << extension;
          t << "\" media=\"(prefers-color-scheme: light)\"";
        }
        else // AutoLight
        {
          t << "_dark";
          t << extension;
          t << "\" media=\"(prefers-color-scheme: dark)\"";
        }
        t << "/>";
      }
      t << "<img class=\"formula";
      t << (bDisplay ? "Dsp" : "Inl");
      if (visibility==Visibility::Light)     t << " light-mode-visible";
      else if (visibility==Visibility::Dark) t << " dark-mode-visible";
      t << "\" alt=\"" << filterQuotedCdataAttr(f.text()) << "\"" << " src=\"" << f.relPath() << f.name();
      if (imgType==ImageType::Dark) t << "_dark";
      t << extension;
      if (formula && formula->width()!=-1)
      {
        t << "\" width=\"";
        t << formula->width();
      }
      if (formula && formula->height()!=-1)
      {
        t << "\" height=\"";
        t << formula->height();
      }
      t << "\"/>";
      if (visibility==Visibility::AutoDark || visibility==Visibility::AutoLight)
      {
        t << "</picture>";
      }
      return t.str();
    };
 
    auto colorStyle = Config_getEnum(HTML_COLORSTYLE);
    switch(colorStyle)
    {
      case HTML_COLORSTYLE_t::LIGHT:
        m_t << writeFormula(ImageType::Light,Visibility::Always);
        break;
      case HTML_COLORSTYLE_t::DARK:
        m_t << writeFormula(ImageType::Dark, Visibility::Always);
        break;
      case HTML_COLORSTYLE_t::AUTO_LIGHT:
        m_t << writeFormula(ImageType::Light, Visibility::AutoLight);
        break;
      case HTML_COLORSTYLE_t::AUTO_DARK:
        m_t << writeFormula(ImageType::Dark, Visibility::AutoDark);
        break;
      case HTML_COLORSTYLE_t::TOGGLE:
        // write the image twice and use javascript (darkmode_toggle.js) to show only one of them
        m_t << writeFormula(ImageType::Light,Visibility::Light);
        m_t << writeFormula(ImageType::Dark, Visibility::Dark);
        break;
    }
  }
  if (bDisplay)
  {
    m_t << "\n</p>\n";
    forceStartParagraph(f);
  }
}

References DString::at(), Config_getBool, Config_getEnum, convertToHtml(), DString::empty(), filterQuotedCdataAttr(), FormulaManager::findFormula(), forceEndParagraph(), forceStartParagraph(), Formula::height(), DocFormula::id(), FormulaManager::instance(), DocFormula::isInline(), DString::length(), m_hide, m_t, DString::mid(), DocFormula::name(), DocFormula::relPath(), TextStream::str(), DocFormula::text(), and Formula::width().

operator()() [9/59]

void HtmlDocVisitor::operator()

(

const DocHorRuler &

hr

)

Definition at line 396 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  forceEndParagraph(hr);
  m_t << "<hr "<< hr.attribs().toString() << " />\n";
  forceStartParagraph(hr);
}

References DocHorRuler::attribs(), forceEndParagraph(), forceStartParagraph(), m_hide, m_t, and HtmlAttribList::toString().

operator()() [10/59]

void HtmlDocVisitor::operator()

(

const DocHRef &

href

)

Definition at line 1585 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  if (href.url().startsWith("mailto:"))
  {
    writeObfuscatedMailAddress(href.url().mid(7));
  }
  else
  {
    DString url = correctURL(href.url(),href.relPath());
    m_t << "<a href=\"" << convertToHtml(url)  << "\""
        << href.attribs().toString() << ">";
  }
  visitChildren(href);
  m_t << "</a>";
}

References DocHRef::attribs(), convertToHtml(), correctURL(), m_hide, m_t, DString::mid(), DocHRef::relPath(), DString::startsWith(), HtmlAttribList::toString(), DocHRef::url(), visitChildren(), and writeObfuscatedMailAddress().

operator()() [11/59]

void HtmlDocVisitor::operator()

(

const DocHtmlBlockQuote &

b

)

Definition at line 2111 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  forceEndParagraph(b);
  m_t << "<blockquote class=\"doxtable\"" << b.attribs().toString() << ">\n";
  visitChildren(b);
  m_t << "</blockquote>\n";
  forceStartParagraph(b);
}

References DocHtmlBlockQuote::attribs(), forceEndParagraph(), forceStartParagraph(), m_hide, m_t, HtmlAttribList::toString(), and visitChildren().

operator()() [12/59]

void HtmlDocVisitor::operator()

(

const DocHtmlCaption &

c

)

Definition at line 1571 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<caption" << c.attribs().toString() << ">";
  visitChildren(c);
  m_t << "</caption>\n";
}

References DocHtmlCaption::attribs(), m_hide, m_t, HtmlAttribList::toString(), and visitChildren().

operator()() [13/59]

void HtmlDocVisitor::operator()

(

const DocHtmlCell &

c

)

Definition at line 1556 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  if (c.isHeading())
  {
    m_t << "<th" << c.attribs().toString() << ">";
  }
  else
  {
    m_t << "<td" << c.attribs().toString() << ">";
  }
  visitChildren(c);
  if (c.isHeading()) m_t << "</th>"; else m_t << "</td>";
}

References DocHtmlCell::attribs(), DocHtmlCell::isHeading(), m_hide, m_t, HtmlAttribList::toString(), and visitChildren().

operator()() [14/59]

void HtmlDocVisitor::operator()

(

const DocHtmlDescData &

dd

)

Definition at line 1507 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<dd" << dd.attribs().toString() << ">";
  visitChildren(dd);
  m_t << "</dd>\n";
}

References DocHtmlDescData::attribs(), m_hide, m_t, HtmlAttribList::toString(), and visitChildren().

operator()() [15/59]

void HtmlDocVisitor::operator()

(

const DocHtmlDescList &

dl

)

Definition at line 1489 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  forceEndParagraph(dl);
  m_t << "<dl" << dl.attribs().toString() << ">\n";
  visitChildren(dl);
  m_t << "</dl>\n";
  forceStartParagraph(dl);
}

References DocHtmlDescList::attribs(), forceEndParagraph(), forceStartParagraph(), m_hide, m_t, HtmlAttribList::toString(), and visitChildren().

operator()() [16/59]

void HtmlDocVisitor::operator()

(

const DocHtmlDescTitle &

dt

)

Definition at line 1499 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<dt" << dt.attribs().toString() << ">";
  visitChildren(dt);
  m_t << "</dt>\n";
}

References DocHtmlDescTitle::attribs(), m_hide, m_t, HtmlAttribList::toString(), and visitChildren().

operator()() [17/59]

void HtmlDocVisitor::operator()

(

const DocHtmlDetails &

d

)

Definition at line 1610 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  forceEndParagraph(d);
  m_t << "<details " << d.attribs().toString() << ">\n";
  auto summary = d.summary();
  if (summary)
  {
    std::visit(*this,*summary);
  }
  visitChildren(d);
  m_t << "</details>\n";
  forceStartParagraph(d);
}

References DocHtmlDetails::attribs(), forceEndParagraph(), forceStartParagraph(), m_hide, m_t, DocHtmlDetails::summary(), HtmlAttribList::toString(), and visitChildren().

operator()() [18/59]

void HtmlDocVisitor::operator()

(

const DocHtmlHeader &

header

)

Definition at line 1625 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  forceEndParagraph(header);
  m_t << "<h" << header.level() << header.attribs().toString() << ">";
  visitChildren(header);
  m_t << "</h" << header.level() << ">\n";
  forceStartParagraph(header);
}

References DocHtmlHeader::attribs(), forceEndParagraph(), forceStartParagraph(), DocHtmlHeader::level(), m_hide, m_t, HtmlAttribList::toString(), and visitChildren().

operator()() [19/59]

void HtmlDocVisitor::operator()

(

const DocHtmlList &

s

)

Definition at line 1454 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  forceEndParagraph(s);
  if (s.type()==DocHtmlList::Ordered)
  {
    m_t << "<ol" << s.attribs().toString();
  }
  else
  {
    m_t << "<ul" << s.attribs().toString();
  }
  m_t << ">\n";
  visitChildren(s);
  if (s.type()==DocHtmlList::Ordered)
  {
    m_t << "</ol>";
  }
  else
  {
    m_t << "</ul>";
  }
  if (!s.isPreformatted()) m_t << "\n";
  forceStartParagraph(s);
}

References DocHtmlList::attribs(), forceEndParagraph(), forceStartParagraph(), DocNode::isPreformatted(), m_hide, m_t, DocHtmlList::Ordered, HtmlAttribList::toString(), DocHtmlList::type(), and visitChildren().

operator()() [20/59]

void HtmlDocVisitor::operator()

(

const DocHtmlListItem &

i

)

Definition at line 1480 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<li" << i.attribs().toString() << ">";
  if (!i.isPreformatted()) m_t << "\n";
  visitChildren(i);
  m_t << "</li>\n";
}

References DocHtmlListItem::attribs(), DocNode::isPreformatted(), m_hide, m_t, HtmlAttribList::toString(), and visitChildren().

operator()() [21/59]

void HtmlDocVisitor::operator()

(

const DocHtmlRow &

tr

)

Definition at line 1548 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<tr" << tr.attribs().toString() << ">\n";
  visitChildren(tr);
  m_t << "</tr>\n";
}

References DocHtmlRow::attribs(), m_hide, m_t, HtmlAttribList::toString(), and visitChildren().

operator()() [22/59]

void HtmlDocVisitor::operator()

(

const DocHtmlSummary &

s

)

Definition at line 1602 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<summary " << s.attribs().toString() << ">\n";
  visitChildren(s);
  m_t << "</summary>\n";
}

References DocHtmlSummary::attribs(), m_hide, m_t, HtmlAttribList::toString(), and visitChildren().

operator()() [23/59]

void HtmlDocVisitor::operator()

(

const DocHtmlTable &

t

)

Definition at line 1515 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
 
  forceEndParagraph(t);
 
  if (t.caption())
  {
    DString anc = std::get<DocHtmlCaption>(*t.caption()).anchor();
    if (!anc.empty())
    {
      m_t << "<a class=\"anchor\" id=\"" << anc << "\"></a>\n";
    }
  }
 
  DString attrs = t.attribs().toString();
  if (attrs.empty())
  {
    m_t << "<table class=\"doxtable\">\n";
  }
  else
  {
    m_t << "<table" << t.attribs().toString() << ">\n";
  }
  if (t.caption())
  {
    std::visit(*this,*t.caption());
  }
  visitChildren(t);
  m_t << "</table>\n";
  forceStartParagraph(t);
}

References DocHtmlTable::attribs(), DocHtmlTable::caption(), DString::empty(), forceEndParagraph(), forceStartParagraph(), m_hide, m_t, HtmlAttribList::toString(), and visitChildren().

operator()() [24/59]

void HtmlDocVisitor::operator()

(

const DocImage &

img

)

Definition at line 1635 of file htmldocvisitor.cpp.

{
  if (img.type()==DocImage::Html)
  {
    bool inlineImage = img.isInlineImage();
    bool typeSVG = img.isSVG();
    DString url = img.url();
 
    if (!inlineImage)
    {
      forceEndParagraph(img);
    }
    if (m_hide) return;
    DString baseName=stripPath(img.name());
    if (!inlineImage) m_t << "<div class=\"image\">\n";
    DString sizeAttribs;
    if (!img.width().empty())
    {
      sizeAttribs+=" width=\""+img.width()+"\"";
    }
    if (!img.height().empty()) // link to local file
    {
      sizeAttribs+=" height=\""+img.height()+"\"";
    }
    // 16 cases: url.empty() | typeSVG | inlineImage | img.hasCaption()
 
    HtmlAttribList attribs = img.attribs();
    if (typeSVG)
    {
      attribs.mergeAttribute("style","pointer-events: none;");
    }
    DString alt;
    DString attrs = attribs.toString(&alt);
    DString src;
    if (url.empty())
    {
      src = img.relPath()+img.name();
    }
    else
    {
      src = correctURL(url,img.relPath());
    }
    if (typeSVG && !inlineImage && !src.startsWith("http://") && !src.startsWith("https://"))
    {
      m_t << "<object type=\"image/svg+xml\" data=\"" << convertToHtml(src)
        << "\"" << sizeAttribs << attrs;
      if (inlineImage)
      {
        // skip closing tag
      }
      else
      {
        m_t << ">" << alt << "</object>\n";
      }
    }
    else
    {
      m_t << "<img src=\"" << convertToHtml(src) << "\" alt=\"" << alt << "\"" << sizeAttribs << attrs;
      if (inlineImage)
      {
        m_t << " class=\"inline\"";
      }
      else
      {
        m_t << "/>\n";
      }
    }
    if (img.hasCaption())
    {
      if (inlineImage)
      {
        m_t << " title=\"";
        m_insideTitle=true;
      }
      else
      {
        m_t << "<div class=\"caption\">\n";
      }
    }
    else if (inlineImage)
    {
      m_t << "/>";
    }
 
    visitChildren(img);
 
    if (img.hasCaption())
    {
      if (inlineImage)
      {
        m_t << "\"/>";
        m_insideTitle=false;
      }
      else // end <div class="caption">
      {
        m_t << "</div>";
      }
    }
    if (!inlineImage) // end <div class="image">
    {
      m_t << "</div>\n";
      forceStartParagraph(img);
    }
  }
  else // other format -> skip
  {
  }
}

References DocImage::attribs(), convertToHtml(), correctURL(), DString::empty(), forceEndParagraph(), forceStartParagraph(), DocImage::hasCaption(), DocImage::height(), DocImage::Html, DocImage::isInlineImage(), DocImage::isSVG(), m_hide, m_insideTitle, m_t, HtmlAttribList::mergeAttribute(), DocImage::name(), DocImage::relPath(), DString::startsWith(), stripPath(), HtmlAttribList::toString(), DocImage::type(), DocImage::url(), visitChildren(), and DocImage::width().

operator()() [25/59]

void HtmlDocVisitor::operator()

(

const DocInclude &

inc

)

Definition at line 689 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  SrcLangExt langExt = getLanguageFromFileName(inc.extension());
  switch(inc.type())
  {
    case DocInclude::Include:
      forceEndParagraph(inc);
      m_ci.startCodeFragment("DoxyCode");
      getCodeParser(inc.extension()).parseCode(m_ci,
                                        inc.context(),
                                        inc.text(),
                                        langExt,
                                        inc.stripCodeComments(),
                                        CodeParserOptions()
                                        .setExample(inc.isExample(), inc.exampleFile())
                                        .setInlineFragment(true)
                                        .setShowLineNumbers(false)
                                        .setSearchCtx(m_ctx)
                                       );
      m_ci.endCodeFragment("DoxyCode");
      forceStartParagraph(inc);
      break;
    case DocInclude::IncWithLines:
      {
         forceEndParagraph(inc);
         m_ci.startCodeFragment("DoxyCode");
         FileInfo cfi( inc.file().str() );
         auto fd = createFileDef( cfi.dirPath(), cfi.fileName() );
         getCodeParser(inc.extension()).parseCode(m_ci,
                                           inc.context(),
                                           inc.text(),
                                           langExt,
                                           inc.stripCodeComments(),
                                           CodeParserOptions()
                                           .setExample(inc.isExample(), inc.exampleFile())
                                           .setFileDef(fd.get())
                                           .setInlineFragment(true)
                                           .setSearchCtx(m_ctx)
                                           );
         m_ci.endCodeFragment("DoxyCode");
         forceStartParagraph(inc);
      }
      break;
    case DocInclude::DontInclude:
    case DocInclude::LatexInclude:
    case DocInclude::RtfInclude:
    case DocInclude::ManInclude:
    case DocInclude::XmlInclude:
    case DocInclude::DocbookInclude:
    case DocInclude::DontIncWithLines:
      break;
    case DocInclude::HtmlInclude:
      {
        if (inc.isBlock()) forceEndParagraph(inc);
        m_t << inc.text();
        if (inc.isBlock()) forceStartParagraph(inc);
      }
      break;
    case DocInclude::VerbInclude:
      forceEndParagraph(inc);
      m_t << "<pre class=\"fragment\">";
      filter(inc.text());
      m_t << "</pre>";
      forceStartParagraph(inc);
      break;
    case DocInclude::Snippet:
    case DocInclude::SnippetWithLines:
      forceEndParagraph(inc);
      m_ci.startCodeFragment("DoxyCode");
      CodeFragmentManager::instance().parseCodeFragment(m_ci,
                                       inc.file(),
                                       inc.blockId(),
                                       inc.context(),
                                       inc.type()==DocInclude::SnippetWithLines,
                                       inc.trimLeft(),
                                       inc.stripCodeComments()
                                      );
      m_ci.endCodeFragment("DoxyCode");
      forceStartParagraph(inc);
      break;
  }
}

References DocInclude::blockId(), DocInclude::context(), createFileDef(), FileInfo::dirPath(), DocInclude::DocbookInclude, DocInclude::DontInclude, DocInclude::DontIncWithLines, OutputCodeList::endCodeFragment(), DocInclude::exampleFile(), DocInclude::extension(), DocInclude::file(), FileInfo::fileName(), filter(), forceEndParagraph(), forceStartParagraph(), DocVisitor::getCodeParser(), getLanguageFromFileName(), DocInclude::HtmlInclude, DocInclude::Include, DocInclude::IncWithLines, CodeFragmentManager::instance(), DocInclude::isBlock(), DocInclude::isExample(), DocInclude::LatexInclude, m_ci, m_ctx, m_hide, m_t, DocInclude::ManInclude, CodeParserInterface::parseCode(), CodeFragmentManager::parseCodeFragment(), DocInclude::RtfInclude, CodeParserOptions::setFileDef(), CodeParserOptions::setInlineFragment(), CodeParserOptions::setSearchCtx(), CodeParserOptions::setShowLineNumbers(), DocInclude::Snippet, DocInclude::SnippetWithLines, OutputCodeList::startCodeFragment(), DString::str(), DocInclude::stripCodeComments(), DocInclude::text(), DocInclude::trimLeft(), DocInclude::type(), DocInclude::VerbInclude, and DocInclude::XmlInclude.

operator()() [26/59]

void HtmlDocVisitor::operator()

(

const DocIncOperator &

op

)

Definition at line 773 of file htmldocvisitor.cpp.

{
  //printf("DocIncOperator: type=%d first=%d, last=%d text='%s'\n",
  //    op.type(),op.isFirst(),op.isLast(),qPrint(op.text()));
  if (op.isFirst())
  {
    forceEndParagraph(op);
    if (!m_hide) m_ci.startCodeFragment("DoxyCode");
    pushHidden(m_hide);
    m_hide=true;
  }
  DString locLangExt = getFileNameExtension(op.includeFileName());
  if (locLangExt.empty()) locLangExt = m_langExt;
  SrcLangExt langExt = getLanguageFromFileName(locLangExt);
  if (op.type()!=DocIncOperator::Skip)
  {
    m_hide = popHidden();
    if (!m_hide)
    {
      std::unique_ptr<FileDef> fd;
      if (!op.includeFileName().empty())
      {
        FileInfo cfi( op.includeFileName().str() );
        fd = createFileDef( cfi.dirPath(), cfi.fileName() );
      }
      getCodeParser(locLangExt).parseCode(
                                m_ci,
                                op.context(),
                                op.text(),
                                langExt,
                                op.stripCodeComments(),
                                CodeParserOptions()
                                .setExample(op.isExample(), op.exampleFile())
                                .setFileDef(fd.get())
                                .setStartLine(op.line())
                                .setShowLineNumbers(op.showLineNo())
                                .setSearchCtx(m_ctx)
                               );
    }
    pushHidden(m_hide);
    m_hide=true;
  }
  if (op.isLast())
  {
    m_hide = popHidden();
    if (!m_hide) m_ci.endCodeFragment("DoxyCode");
    forceStartParagraph(op);
  }
  else
  {
    if (!m_hide) m_t << "\n";
  }
}

References DocIncOperator::context(), createFileDef(), FileInfo::dirPath(), DString::empty(), OutputCodeList::endCodeFragment(), DocIncOperator::exampleFile(), FileInfo::fileName(), forceEndParagraph(), forceStartParagraph(), DocVisitor::getCodeParser(), getFileNameExtension(), getLanguageFromFileName(), DocIncOperator::includeFileName(), DocIncOperator::isExample(), DocIncOperator::isFirst(), DocIncOperator::isLast(), DocIncOperator::line(), m_ci, m_ctx, m_hide, m_langExt, m_t, CodeParserInterface::parseCode(), DocVisitor::popHidden(), DocVisitor::pushHidden(), CodeParserOptions::setFileDef(), CodeParserOptions::setSearchCtx(), CodeParserOptions::setShowLineNumbers(), CodeParserOptions::setStartLine(), DocIncOperator::showLineNo(), DocIncOperator::Skip, OutputCodeList::startCodeFragment(), DString::str(), DocIncOperator::stripCodeComments(), DocIncOperator::text(), and DocIncOperator::type().

operator()() [27/59]

void HtmlDocVisitor::operator()

(

const DocIndexEntry &

e

)

Definition at line 940 of file htmldocvisitor.cpp.

{
  DString anchor = convertIndexWordToAnchor(e.entry());
  if (e.member())
  {
    anchor.prepend(e.member()->anchor()+"_");
  }
  m_t << "<a id=\"" << anchor << "\" name=\"" << anchor << "\"></a>";
  //printf("*** DocIndexEntry: word='%s' scope='%s' member='%s'\n",
  //       qPrint(e.entry()),
  //       e.scope()  ? qPrint(e.scope()->name())  : "<null>",
  //       e.member() ? qPrint(e.member()->name()) : "<null>"
  //      );
  Doxygen::indexList->addIndexItem(e.scope(),e.member(),anchor,e.entry());
}

References IndexList::addIndexItem(), Definition::anchor(), convertIndexWordToAnchor(), DocIndexEntry::entry(), Doxygen::indexList, m_t, DocIndexEntry::member(), DString::prepend(), and DocIndexEntry::scope().

operator()() [28/59]

void HtmlDocVisitor::operator()

(

const DocInternal &

i

)

Definition at line 1579 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  visitChildren(i);
}

References m_hide, and visitChildren().

operator()() [29/59]

void HtmlDocVisitor::operator()

(

const DocInternalRef &

ref

)

Definition at line 2097 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  startLink(DString(),ref.file(),ref.relPath(),ref.anchor());
  visitChildren(ref);
  endLink();
  m_t << " ";
}

References DocInternalRef::anchor(), DString::DString(), endLink(), DocInternalRef::file(), m_hide, m_t, DocInternalRef::relPath(), startLink(), and visitChildren().

operator()() [30/59]

void HtmlDocVisitor::operator()

(

const DocLineBreak &

br

)

Definition at line 390 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<br "<< br.attribs().toString() << " />\n";
}

References DocLineBreak::attribs(), m_hide, m_t, and HtmlAttribList::toString().

operator()() [31/59]

void HtmlDocVisitor::operator()

(

const DocLink &

lnk

)

Definition at line 1922 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  startLink(lnk.ref(),lnk.file(),lnk.relPath(),lnk.anchor());
  visitChildren(lnk);
  endLink();
}

References DocLink::anchor(), endLink(), DocLink::file(), m_hide, DocLink::ref(), DocLink::relPath(), startLink(), and visitChildren().

operator()() [32/59]

void HtmlDocVisitor::operator()

(

const DocLinkedWord &

w

)

Definition at line 264 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  //printf("linked word: %s\n",qPrint(w.word()));
  startLink(w.ref(),w.file(),w.relPath(),w.anchor(),w.tooltip());
  filter(w.word());
  endLink();
}

References DocLinkedWord::anchor(), endLink(), DocLinkedWord::file(), filter(), m_hide, DocLinkedWord::ref(), DocLinkedWord::relPath(), startLink(), DocLinkedWord::tooltip(), and DocLinkedWord::word().

operator()() [33/59]

void HtmlDocVisitor::operator()

(

const DocMermaidFile &

df

)

Definition at line 1872 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  if (!Config_getBool(DOT_CLEANUP)) copyFile(df.file(),Config_getString(HTML_OUTPUT)+"/"+stripPath(df.file()));
  forceEndParagraph(df);
  if (Config_getEnum(MERMAID_RENDER_MODE)==MERMAID_RENDER_MODE_t::CLI)
  {
    std::string inBuf;
    readInputFile(df.file(),inBuf);
    auto htmlOutput   = Config_getString(HTML_OUTPUT);
    auto outputFormat = MermaidManager::OutputFormat::HTML;
    auto imageFormat  = MermaidManager::convertToImageFormat(outputFormat);
    DString baseName = MermaidManager::instance().writeMermaidSource(htmlOutput,DString(),
                                      inBuf,imageFormat,df.srcFile(),df.srcLine());
    m_t << "<div class=\"mermaidgraph\">\n";
    writeMermaidFile(baseName,df.relPath(),DString(),df.srcFile(),df.srcLine());
    if (df.hasCaption())
    {
      m_t << "<div class=\"caption\">\n";
    }
    visitChildren(df);
    if (df.hasCaption())
    {
      m_t << "</div>\n";
    }
    m_t << "</div>\n";
  }
  else // AUTO or CLIENT_SIDE
  {
    // CLIENT_SIDE or AUTO: embed mermaid source for client-side rendering
    std::string inBuf;
    readInputFile(df.file(),inBuf);
    m_t << "<div class=\"mermaidgraph\">\n";
    m_t << "<pre class=\"mermaid\">\n";
    m_t << convertToHtml(inBuf);
    m_t << "</pre>\n";
    if (df.hasCaption())
    {
      m_t << "<div class=\"caption\">\n";
    }
    visitChildren(df);
    if (df.hasCaption())
    {
      m_t << "</div>\n";
    }
    m_t << "</div>\n";
  }
  forceStartParagraph(df);
}

References Config_getBool, Config_getEnum, Config_getString, convertToHtml(), MermaidManager::convertToImageFormat(), copyFile(), DString::DString(), DocDiagramFileBase::file(), forceEndParagraph(), forceStartParagraph(), DocDiagramFileBase::hasCaption(), MermaidManager::HTML, MermaidManager::instance(), m_hide, m_t, readInputFile(), DocDiagramFileBase::relPath(), DocDiagramFileBase::srcFile(), DocDiagramFileBase::srcLine(), stripPath(), visitChildren(), writeMermaidFile(), and MermaidManager::writeMermaidSource().

operator()() [34/59]

void HtmlDocVisitor::operator()

(

const DocMscFile &

df

)

Definition at line 1775 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  forceEndParagraph(df);
  bool exists = false;
  std::string inBuf;
  if (readInputFile(df.file(),inBuf))
  {
    auto fileName = writeInlineGraph(Config_getString(HTML_OUTPUT)+"/"+stripPath(df.file())+"_", // baseName
                                     ".msc",                                                     // extension
                                     inBuf,                                                      // contents
                                      exists);
    if (!fileName.empty())
    {
      m_t << "<div class=\"mscgraph\">\n";
      writeMscFile(fileName,df.relPath(),df.context(),df.srcFile(),df.srcLine(),!exists);
      if (df.hasCaption())
      {
        m_t << "<div class=\"caption\">\n";
      }
      visitChildren(df);
      if (df.hasCaption())
      {
        m_t << "</div>\n";
      }
      m_t << "</div>\n";
    }
  }
  forceStartParagraph(df);
}

References Config_getString, DocDiagramFileBase::context(), DocDiagramFileBase::file(), forceEndParagraph(), forceStartParagraph(), DocDiagramFileBase::hasCaption(), m_hide, m_t, readInputFile(), DocDiagramFileBase::relPath(), DocDiagramFileBase::srcFile(), DocDiagramFileBase::srcLine(), stripPath(), visitChildren(), writeInlineGraph(), and writeMscFile().

operator()() [35/59]

void HtmlDocVisitor::operator()

(

const DocPara &

p

)

Definition at line 1258 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
 
  //printf("> DocPara\n");
  //dumpDocNodeList(p.children());
 
  bool needsTag = determineIfNeedsTag(p);
  //printf("  needsTag=%d\n",needsTag);
  bool needsTagBefore = needsTag;
  bool needsTagAfter  = needsTag;
 
  // if the first element of a paragraph is something that should be outside of
  // the paragraph (<ul>,<dl>,<table>,..) then that will already started the
  // paragraph and we don't need to do it here
  if (!p.children().empty())
  {
    auto it = std::find_if(std::begin(p.children()),std::end(p.children()),
                           [](const auto &node) { return !isInvisibleNode(node); });
    if (it!=std::end(p.children()))
    {
      const DocNodeVariant &n = *it;
      if (mustBeOutsideParagraph(n))
      {
        needsTagBefore = false;
      }
    }
  }
 
  // check if this paragraph is the first or last or intermediate child of a <li> or <dd>.
  // this allows us to mark the tag with a special class so we can
  // fix the otherwise ugly spacing.
  bool isFirst = false;
  bool isLast  = false;
  contexts_t t = getParagraphContext(p,isFirst,isLast);
  //printf("startPara first=%d last=%d\n",isFirst,isLast);
  if (isFirst && isLast) needsTagBefore=false;
 
  //printf("  needsTagBefore=%d\n",needsTagBefore);
  // write the paragraph tag (if needed)
  if (needsTagBefore)
  {
    if (contexts(t))
      m_t << "<p class=\"" << contexts(t) << "\"" << p.attribs().toString() << ">";
    else
      m_t << "<p" << p.attribs().toString() << ">";
  }
 
  visitChildren(p);
 
  // if the last element of a paragraph is something that should be outside of
  // the paragraph (<ul>,<dl>,<table>) then that will already have ended the
  // paragraph and we don't need to do it here
  if (!p.children().empty())
  {
    auto it = std::prev(std::end(p.children()));
    for (;;)
    {
      const DocNodeVariant &n = *it;
      if (!isInvisibleNode(n))
      {
        if (mustBeOutsideParagraph(n))
        {
          needsTagAfter = false;
        }
        // stop searching if we found a node that is visible
        break;
      }
      if (it==std::begin(p.children()))
      {
        // stop searching if we are at the beginning of the list
        break;
      }
      else
      {
        --it;
      }
    }
  }
 
  //printf("endPara first=%d last=%d\n",isFirst,isLast);
  if (isFirst && isLast) needsTagAfter=false;
 
  //printf("  needsTagAfter=%d\n",needsTagAfter);
  if (needsTagAfter) m_t << "</p>\n";
  //printf("< DocPara\n");
}

References DocPara::attribs(), DocCompoundNode::children(), contexts(), determineIfNeedsTag(), GrowVector< T >::empty(), getParagraphContext(), isInvisibleNode(), m_hide, m_t, mustBeOutsideParagraph(), HtmlAttribList::toString(), and visitChildren().

operator()() [36/59]

void HtmlDocVisitor::operator()

(

const DocParamList &

pl

)

Definition at line 2017 of file htmldocvisitor.cpp.

{
  //printf("DocParamList::visitPre\n");
  if (m_hide) return;
  m_t << "    <tr>";
  const DocParamSect *sect = std::get_if<DocParamSect>(pl.parent());
  if (sect && sect->hasInOutSpecifier())
  {
    m_t << "<td class=\"paramdir\">";
    if (pl.direction()!=DocParamSect::Unspecified)
    {
      m_t << "[";
      if (pl.direction()==DocParamSect::In)
      {
        m_t << "in";
      }
      else if (pl.direction()==DocParamSect::Out)
      {
        m_t << "out";
      }
      else if (pl.direction()==DocParamSect::InOut)
      {
        m_t << "in,out";
      }
      m_t << "]";
    }
    m_t << "</td>";
  }
  if (sect && sect->hasTypeSpecifier())
  {
    m_t << "<td class=\"paramtype\">";
    for (const auto &type : pl.paramTypes())
    {
      std::visit(*this,type);
    }
    m_t << "</td>";
  }
  m_t << "<td class=\"paramname\">";
  bool first=true;
  for (const auto &param : pl.parameters())
  {
    if (!first) m_t << ","; else first=false;
    std::visit(*this,param);
  }
  m_t << "</td><td>";
  for (const auto &par : pl.paragraphs())
  {
    std::visit(*this,par);
  }
  m_t << "</td></tr>\n";
}

References DocParamList::direction(), DocParamSect::hasInOutSpecifier(), DocParamSect::hasTypeSpecifier(), DocParamSect::In, DocParamSect::InOut, m_hide, m_t, DocParamSect::Out, DocParamList::paragraphs(), DocParamList::parameters(), DocParamList::paramTypes(), DocNode::parent(), and DocParamSect::Unspecified.

operator()() [37/59]

void HtmlDocVisitor::operator()

(

const DocParamSect &

s

)

Definition at line 1973 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  forceEndParagraph(s);
  DString className;
  DString heading;
  switch(s.type())
  {
    case DocParamSect::Param:
      heading=theTranslator->trParameters();
      className="params";
      break;
    case DocParamSect::RetVal:
      heading=theTranslator->trReturnValues();
      className="retval";
      break;
    case DocParamSect::Exception:
      heading=theTranslator->trExceptions();
      className="exception";
      break;
    case DocParamSect::TemplateParam:
      heading=theTranslator->trTemplateParameters();
      className="tparams";
      break;
    default:
      ASSERT(0);
  }
  m_t << "<dl class=\"" << className << "\"><dt>";
  m_t << heading;
  m_t << "</dt><dd>\n";
  m_t << "  <table class=\"" << className << "\">\n";
  visitChildren(s);
  m_t << "  </table>\n";
  m_t << "  </dd>\n";
  m_t << "</dl>\n";
  forceStartParagraph(s);
}

References ASSERT, DocParamSect::Exception, forceEndParagraph(), forceStartParagraph(), m_hide, m_t, DocParamSect::Param, DocParamSect::RetVal, DocParamSect::TemplateParam, theTranslator, Translator::trExceptions(), Translator::trParameters(), Translator::trReturnValues(), Translator::trTemplateParameters(), DocParamSect::type(), and visitChildren().

operator()() [38/59]

void HtmlDocVisitor::operator()

(

const DocParBlock &

pb

)

Definition at line 2149 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  visitChildren(pb);
}

References m_hide, and visitChildren().

operator()() [39/59]

void HtmlDocVisitor::operator()

(

const DocPlantUmlFile &

df

)

Definition at line 1837 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  if (!Config_getBool(DOT_CLEANUP)) copyFile(df.file(),Config_getString(HTML_OUTPUT)+"/"+stripPath(df.file()));
  forceEndParagraph(df);
  DString htmlOutput = Config_getString(HTML_OUTPUT);
  DString imgExt = getDotImageExtension();
  PlantumlManager::OutputFormat format = PlantumlManager::PUML_BITMAP; // default : PUML_BITMAP
  if (imgExt=="svg")
  {
    format = PlantumlManager::PUML_SVG;
  }
  std::string inBuf;
  readInputFile(df.file(),inBuf);
  auto baseNameVector = PlantumlManager::instance().writePlantUMLSource(htmlOutput,DString(),
                                    inBuf,format,DString(),df.srcFile(),df.srcLine(),false);
  for (const auto &bName: baseNameVector)
  {
    DString baseName=makeBaseName(bName,".pu");
    m_t << "<div class=\"plantumlgraph\">\n";
    writePlantUMLFile(baseName,df.relPath(),DString(),df.srcFile(),df.srcLine());
    if (df.hasCaption())
    {
      m_t << "<div class=\"caption\">\n";
    }
    visitChildren(df);
    if (df.hasCaption())
    {
      m_t << "</div>\n";
    }
    m_t << "</div>\n";
  }
  forceStartParagraph(df);
}

References Config_getBool, Config_getString, copyFile(), DString::DString(), DocDiagramFileBase::file(), forceEndParagraph(), forceStartParagraph(), getDotImageExtension(), DocDiagramFileBase::hasCaption(), PlantumlManager::instance(), m_hide, m_t, makeBaseName(), PlantumlManager::PUML_BITMAP, PlantumlManager::PUML_SVG, readInputFile(), DocDiagramFileBase::relPath(), DocDiagramFileBase::srcFile(), DocDiagramFileBase::srcLine(), stripPath(), visitChildren(), writePlantUMLFile(), and PlantumlManager::writePlantUMLSource().

operator()() [40/59]

void HtmlDocVisitor::operator()

(

const DocRef &

ref

)

Definition at line 1930 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  if (!ref.file().empty())
  {
    // when ref.isSubPage()==true we use ref.file() for HTML and
    // ref.anchor() for LaTeX/RTF
    startLink(ref.ref(),ref.file(),ref.relPath(),ref.isSubPage() ? DString() : ref.anchor(), ref.targetTitle());
  }
  if (!ref.hasLinkText()) filter(ref.targetTitle());
  visitChildren(ref);
  if (!ref.file().empty()) endLink();
  //m_t << " ";
}

References DocRef::anchor(), DString::empty(), endLink(), DocRef::file(), filter(), DocRef::hasLinkText(), DocRef::isSubPage(), m_hide, DocRef::ref(), DocRef::relPath(), startLink(), DocRef::targetTitle(), and visitChildren().

operator()() [41/59]

void HtmlDocVisitor::operator()

(

const DocRoot &

r

)

Definition at line 1346 of file htmldocvisitor.cpp.

{
  //printf("> DocRoot\n");
  //dumpDocNodeList(r.children());
  visitChildren(r);
  //printf("< DocRoot\n");
}

References visitChildren().

operator()() [42/59]

void HtmlDocVisitor::operator()

(

const DocSecRefItem &

ref

)

Definition at line 1945 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  if (!ref.file().empty())
  {
    m_t << "<li>";
    startLink(ref.ref(),ref.file(),ref.relPath(),ref.isSubPage() ? DString() : ref.anchor());
  }
  visitChildren(ref);
  if (!ref.file().empty())
  {
    endLink();
    m_t << "</li>\n";
  }
}

References DocSecRefItem::anchor(), DString::empty(), endLink(), DocSecRefItem::file(), DocSecRefItem::isSubPage(), m_hide, m_t, DocSecRefItem::ref(), DocSecRefItem::relPath(), startLink(), and visitChildren().

operator()() [43/59]

void HtmlDocVisitor::operator()

(

const DocSecRefList &

s

)

Definition at line 1961 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  forceEndParagraph(s);
  m_t << "<div>\n";
  m_t << "<ul class=\"multicol\">\n";
  visitChildren(s);
  m_t << "</ul>\n";
  m_t << "</div>\n";
  forceStartParagraph(s);
}

References forceEndParagraph(), forceStartParagraph(), m_hide, m_t, and visitChildren().

operator()() [44/59]

void HtmlDocVisitor::operator()

(

const DocSection &

s

)

Definition at line 1438 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  forceEndParagraph(s);
  m_t << "<h" << s.level() << " class=\"doxsection\">";
  m_t << "<a class=\"anchor\" id=\"" << s.anchor();
  m_t << "\"></a>\n";
  if (s.title())
  {
    std::visit(*this,*s.title());
  }
  m_t << "</h" << s.level() << ">\n";
  visitChildren(s);
  forceStartParagraph(s);
}

References DocSection::anchor(), forceEndParagraph(), forceStartParagraph(), DocSection::level(), m_hide, m_t, DocSection::title(), and visitChildren().

operator()() [45/59]

void HtmlDocVisitor::operator()

(

const DocSeparator &

s

)

Definition at line 2011 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "&#160;" << s.chars() << "&#160;";
}

References DocSeparator::chars(), m_hide, and m_t.

operator()() [46/59]

void HtmlDocVisitor::operator()

(

const DocSimpleList &

sl

)

Definition at line 1414 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  forceEndParagraph(sl);
  m_t << "<ul>";
  if (!sl.isPreformatted()) m_t << "\n";
  visitChildren(sl);
  m_t << "</ul>";
  if (!sl.isPreformatted()) m_t << "\n";
  forceStartParagraph(sl);
}

References forceEndParagraph(), forceStartParagraph(), DocNode::isPreformatted(), m_hide, m_t, and visitChildren().

operator()() [47/59]

void HtmlDocVisitor::operator()

(

const DocSimpleListItem &

li

)

Definition at line 1426 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<li>";
  if (li.paragraph())
  {
    visit(*this,*li.paragraph());
  }
  m_t << "</li>";
  if (!li.isPreformatted()) m_t << "\n";
}

References DocNode::isPreformatted(), m_hide, m_t, and DocSimpleListItem::paragraph().

operator()() [48/59]

void HtmlDocVisitor::operator()

(

const DocSimpleSect &

s

)

Definition at line 1354 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  forceEndParagraph(s);
  m_t << "<dl class=\"section " << s.typeString() << "\"><dt>";
  switch(s.type())
  {
    case DocSimpleSect::See:
      m_t << theTranslator->trSeeAlso(); break;
    case DocSimpleSect::Return:
      m_t << theTranslator->trReturns(); break;
    case DocSimpleSect::Author:
      m_t << theTranslator->trAuthor(true,true); break;
    case DocSimpleSect::Authors:
      m_t << theTranslator->trAuthor(true,false); break;
    case DocSimpleSect::Version:
      m_t << theTranslator->trVersion(); break;
    case DocSimpleSect::Since:
      m_t << theTranslator->trSince(); break;
    case DocSimpleSect::Date:
      m_t << theTranslator->trDate(); break;
    case DocSimpleSect::Note:
      m_t << theTranslator->trNote(); break;
    case DocSimpleSect::Warning:
      m_t << theTranslator->trWarning(); break;
    case DocSimpleSect::Pre:
      m_t << theTranslator->trPrecondition(); break;
    case DocSimpleSect::Post:
      m_t << theTranslator->trPostcondition(); break;
    case DocSimpleSect::Copyright:
      m_t << theTranslator->trCopyright(); break;
    case DocSimpleSect::Invar:
      m_t << theTranslator->trInvariant(); break;
    case DocSimpleSect::Remark:
      m_t << theTranslator->trRemarks(); break;
    case DocSimpleSect::Attention:
      m_t << theTranslator->trAttention(); break;
    case DocSimpleSect::Important:
      m_t << theTranslator->trImportant(); break;
    case DocSimpleSect::User: break;
    case DocSimpleSect::Rcs: break;
    case DocSimpleSect::Unknown:  break;
  }
 
  if (s.title())
  {
    std::visit(*this,*s.title());
  }
  m_t << "</dt><dd>";
  visitChildren(s);
  m_t << "</dd></dl>\n";
  forceStartParagraph(s);
}

References DocSimpleSect::Attention, DocSimpleSect::Author, DocSimpleSect::Authors, DocSimpleSect::Copyright, DocSimpleSect::Date, forceEndParagraph(), forceStartParagraph(), DocSimpleSect::Important, DocSimpleSect::Invar, m_hide, m_t, DocSimpleSect::Note, DocSimpleSect::Post, DocSimpleSect::Pre, DocSimpleSect::Rcs, DocSimpleSect::Remark, DocSimpleSect::Return, DocSimpleSect::See, DocSimpleSect::Since, theTranslator, DocSimpleSect::title(), Translator::trAttention(), Translator::trAuthor(), Translator::trCopyright(), Translator::trDate(), Translator::trImportant(), Translator::trInvariant(), Translator::trNote(), Translator::trPostcondition(), Translator::trPrecondition(), Translator::trRemarks(), Translator::trReturns(), Translator::trSeeAlso(), Translator::trSince(), Translator::trVersion(), Translator::trWarning(), DocSimpleSect::type(), DocSimpleSect::typeString(), DocSimpleSect::Unknown, DocSimpleSect::User, DocSimpleSect::Version, visitChildren(), and DocSimpleSect::Warning.

operator()() [49/59]

void HtmlDocVisitor::operator()

(

const DocSimpleSectSep &

)

Definition at line 956 of file htmldocvisitor.cpp.

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

References m_t.

operator()() [50/59]

void HtmlDocVisitor::operator()

(

const DocStyleChange &

s

)

Definition at line 404 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  switch (s.style())
  {
    case DocStyleChange::Bold:
      if (s.enable()) m_t << "<b" << s.attribs().toString() << ">";      else m_t << "</b>";
      break;
    case DocStyleChange::S:
      if (s.enable()) m_t << "<s" << s.attribs().toString() << ">";      else m_t << "</s>";
      break;
    case DocStyleChange::Strike:
      if (s.enable()) m_t << "<strike" << s.attribs().toString() << ">"; else m_t << "</strike>";
      break;
    case DocStyleChange::Del:
      if (s.enable()) m_t << "<del" << s.attribs().toString() << ">";    else m_t << "</del>";
      break;
    case DocStyleChange::Underline:
      if (s.enable()) m_t << "<u" << s.attribs().toString() << ">";      else m_t << "</u>";
      break;
    case DocStyleChange::Ins:
      if (s.enable()) m_t << "<ins" << s.attribs().toString() << ">";    else m_t << "</ins>";
      break;
    case DocStyleChange::Italic:
      if (s.enable())
      {
        auto attribs = s.attribs();
        if (s.tagName()=="a")
        {
          attribs.mergeAttribute("class","arg");
        }
        m_t << "<em" << attribs.toString() << ">";
      }
      else
      {
        m_t << "</em>";
      }
      break;
    case DocStyleChange::Kbd:
      if (s.enable()) m_t << "<kbd" << s.attribs().toString() << ">";    else m_t << "</kbd>";
      break;
    case DocStyleChange::Typewriter:
      if (s.enable())
      {
        m_t << "<span class=\"tt\"" << s.attribs().toString() << ">";
        m_insidePre=true;
      }
      else
      {
        m_t << "</span>";
        m_insidePre=false;
      }
      break;
    case DocStyleChange::Code:
      if (s.enable())
      {
        auto attribs = s.attribs();
        if (s.tagName()=="p")
        {
          attribs.mergeAttribute("class","param");
        }
        m_t << "<code" << attribs.toString() << ">";
        m_insidePre=true;
      }
      else
      {
        m_insidePre=false;
        m_t << "</code>";
      }
      break;
    case DocStyleChange::Subscript:
      if (s.enable()) m_t << "<sub" << s.attribs().toString() << ">"; else m_t << "</sub>";
      break;
    case DocStyleChange::Superscript:
      if (s.enable()) m_t << "<sup" << s.attribs().toString() << ">"; else m_t << "</sup>";
      break;
    case DocStyleChange::Center:
      if (s.enable())
      {
        forceEndParagraph(s);
        m_t << "<center" << s.attribs().toString() << ">";
      }
      else
      {
        m_t << "</center>";
        forceStartParagraph(s);
      }
      break;
    case DocStyleChange::Small:
      if (s.enable()) m_t << "<small" << s.attribs().toString() << ">";  else m_t << "</small>";
      break;
    case DocStyleChange::Cite:
      if (s.enable()) m_t << "<cite" << s.attribs().toString() << ">";  else m_t << "</cite>";
      break;
    case DocStyleChange::Preformatted:
      if (s.enable())
      {
        forceEndParagraph(s);
        m_t << "<pre" << s.attribs().toString() << ">";
        m_insidePre=true;
      }
      else
      {
        m_insidePre=false;
        m_t << "</pre>";
        forceStartParagraph(s);
      }
      break;
    case DocStyleChange::Div:
      if (s.enable())
      {
        forceEndParagraph(s);
        m_t << "<div" << s.attribs().toString() << ">";
      }
      else
      {
        m_t << "</div>";
        forceStartParagraph(s);
      }
      break;
    case DocStyleChange::Span:
      if (s.enable()) m_t << "<span" << s.attribs().toString() << ">";  else m_t << "</span>";
      break;
  }
}

References DocStyleChange::attribs(), DocStyleChange::Bold, DocStyleChange::Center, DocStyleChange::Cite, DocStyleChange::Code, DocStyleChange::Del, DocStyleChange::Div, DocStyleChange::enable(), forceEndParagraph(), forceStartParagraph(), DocStyleChange::Ins, DocStyleChange::Italic, DocStyleChange::Kbd, m_hide, m_insidePre, m_t, DocStyleChange::Preformatted, DocStyleChange::S, DocStyleChange::Small, DocStyleChange::Span, DocStyleChange::Strike, DocStyleChange::style(), DocStyleChange::Subscript, DocStyleChange::Superscript, DocStyleChange::tagName(), HtmlAttribList::toString(), DocStyleChange::Typewriter, and DocStyleChange::Underline.

operator()() [51/59]

void HtmlDocVisitor::operator()

(

const DocSymbol &

s

)

Definition at line 286 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  if (m_insideTitle &&
      (s.symbol()==HtmlEntityMapper::Sym_Quot || s.symbol()==HtmlEntityMapper::Sym_quot)) // escape "'s inside title="..."
  {
    m_t << "&quot;";
  }
  else
  {
    const char *res = HtmlEntityMapper::instance().html(s.symbol());
    if (res)
    {
      m_t << res;
    }
    else
    {
      err("HTML: non supported HTML-entity found: {}\n",
          HtmlEntityMapper::instance().html(s.symbol(),true));
    }
  }
}

References err, HtmlEntityMapper::html(), HtmlEntityMapper::instance(), m_hide, m_insideTitle, m_t, HtmlEntityMapper::Sym_Quot, HtmlEntityMapper::Sym_quot, and DocSymbol::symbol().

operator()() [52/59]

void HtmlDocVisitor::operator()

(

const DocText &

t

)

Definition at line 2106 of file htmldocvisitor.cpp.

{
  visitChildren(t);
}

References visitChildren().

operator()() [53/59]

void HtmlDocVisitor::operator()

(

const DocTitle &

t

)

Definition at line 1408 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  visitChildren(t);
}

References m_hide, and visitChildren().

operator()() [54/59]

void HtmlDocVisitor::operator()

(

const DocURL &

u

)

Definition at line 351 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  if (u.isEmail()) // mail address
  {
    DString url = u.url();
    // obfuscate the mail address link
    writeObfuscatedMailAddress(url);
    if (!Config_getBool(OBFUSCATE_EMAILS))
    {
      m_t << url;
    }
    else
    {
      const char *p = url.data();
      // also obfuscate the address as shown on the web page
      uint32_t size=5;
      while (*p)
      {
        for (uint32_t j=0;j<size && *p;j++)
        {
          p = writeUTF8Char(m_t,p);
        }
        if (*p) m_t << "<span class=\"obfuscator\">.nosp@m.</span>";
        if (size==5) size=4; else size=5;
      }
    }
    m_t << "</a>";
  }
  else // web address
  {
    m_t << "<a href=\"";
    filter(u.url());
    m_t << "\">";
    filter(u.url());
    m_t << "</a>";
  }
}

References Config_getBool, DString::data(), filter(), DocURL::isEmail(), m_hide, m_t, DocURL::url(), writeObfuscatedMailAddress(), and writeUTF8Char().

operator()() [55/59]

void HtmlDocVisitor::operator()

(

const DocVerbatim &

s

)

---

Definition at line 532 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  DString lang = m_langExt;
  if (!s.language().empty()) // explicit language setting
  {
    lang = s.language();
  }
  SrcLangExt langExt = getLanguageFromCodeLang(lang);
  switch(s.type())
  {
    case DocVerbatim::Code:
      forceEndParagraph(s);
      m_ci.startCodeFragment("DoxyCode");
      getCodeParser(lang).parseCode(m_ci,
                                        s.context(),
                                        s.text(),
                                        langExt,
                                        Config_getBool(STRIP_CODE_COMMENTS),
                                        CodeParserOptions()
                                        .setExample(s.isExample(), s.exampleFile())
                                        .setInlineFragment(true)
                                        .setSearchCtx(m_ctx)
                                       );
      m_ci.endCodeFragment("DoxyCode");
      forceStartParagraph(s);
      break;
    case DocVerbatim::Verbatim:
      forceEndParagraph(s);
      m_t << "<pre class=\"fragment\">";
      filter(s.text());
      m_t << "</pre>";
      forceStartParagraph(s);
      break;
    case DocVerbatim::JavaDocLiteral:
      filter(s.text(), true);
      break;
    case DocVerbatim::JavaDocCode:
      m_t << "<code class=\"JavaDocCode\">";
      filter(s.text(), true);
      m_t << "</code>";
      break;
    case DocVerbatim::HtmlOnly:
      {
        if (s.isBlock()) forceEndParagraph(s);
        m_t << s.text();
        if (s.isBlock()) forceStartParagraph(s);
      }
      break;
    case DocVerbatim::ManOnly:
    case DocVerbatim::LatexOnly:
    case DocVerbatim::XmlOnly:
    case DocVerbatim::RtfOnly:
    case DocVerbatim::DocbookOnly:
      /* nothing */
      break;
 
    case DocVerbatim::Dot:
      {
        forceEndParagraph(s);
 
        bool exists = false;
        auto fileName = writeInlineGraph(Config_getString(HTML_OUTPUT)+"/inline_dotgraph_", // baseName
                                         ".dot",                                            // extension
                                         s.text(),                                          // contents
                                         exists);
        if (!fileName.empty())
        {
          m_t << "<div class=\"dotgraph\">\n";
          writeDotFile(fileName,s.relPath(),s.context(),s.srcFile(),s.srcLine(),!exists);
          visitCaption(m_t, s);
          m_t << "</div>\n";
        }
 
        forceStartParagraph(s);
      }
      break;
    case DocVerbatim::Msc:
      {
        forceEndParagraph(s);
 
        bool exists = false;
        auto fileName = writeInlineGraph(Config_getString(HTML_OUTPUT)+"/inline_mscgraph_", // baseName
                                         ".msc",                                            // extension
                                         "msc {"+s.text()+"}",                              // contents
                                         exists);
        if (!fileName.empty())
        {
          m_t << "<div class=\"mscgraph\">\n";
          writeMscFile(fileName,s.relPath(),s.context(),s.srcFile(),s.srcLine(),!exists);
          visitCaption(m_t, s);
          m_t << "</div>\n";
        }
 
        forceStartParagraph(s);
      }
      break;
    case DocVerbatim::PlantUML:
      {
        forceEndParagraph(s);
        DString htmlOutput = Config_getString(HTML_OUTPUT);
        DString imgExt = getDotImageExtension();
        PlantumlManager::OutputFormat format = PlantumlManager::PUML_BITMAP; // default : PUML_BITMAP
        if (imgExt=="svg")
        {
          format = PlantumlManager::PUML_SVG;
        }
        auto baseNameVector = PlantumlManager::instance().writePlantUMLSource(
                                    htmlOutput,s.exampleFile(),
                                    s.text(),format,s.engine(),s.srcFile(),s.srcLine(),true);
        for (const auto &baseName: baseNameVector)
        {
          m_t << "<div class=\"plantumlgraph\">\n";
          writePlantUMLFile(baseName,s.relPath(),s.context(),s.srcFile(),s.srcLine());
          visitCaption(m_t, s);
          m_t << "</div>\n";
        }
        forceStartParagraph(s);
      }
      break;
    case DocVerbatim::Mermaid:
      {
        forceEndParagraph(s);
        if (Config_getEnum(MERMAID_RENDER_MODE)==MERMAID_RENDER_MODE_t::CLI) // CLI mode: pre-generate image via mmdc
        {
          auto htmlOutput = Config_getString(HTML_OUTPUT);
          auto outputFormat = MermaidManager::OutputFormat::HTML;
          auto imageFormat  = MermaidManager::convertToImageFormat(outputFormat);
          DString baseName = MermaidManager::instance().writeMermaidSource(
                                      htmlOutput,s.exampleFile(),
                                      s.text(),imageFormat,s.srcFile(),s.srcLine());
          m_t << "<div class=\"mermaidgraph\">\n";
          writeMermaidFile(baseName,s.relPath(),s.context(),s.srcFile(),s.srcLine());
          visitCaption(m_t, s);
          m_t << "</div>\n";
        }
        else // CLIENT_SIDE or AUTO mode: embed for client-side rendering
        {
          m_t << "<div class=\"mermaidgraph\">\n";
          m_t << "<pre class=\"mermaid\">\n";
          m_t << convertToHtml(s.text());
          m_t << "</pre>\n";
          visitCaption(m_t, s);
          m_t << "</div>\n";
        }
        forceStartParagraph(s);
      }
      break;
  }
}

References DocVerbatim::Code, Config_getBool, Config_getEnum, Config_getString, DocVerbatim::context(), convertToHtml(), MermaidManager::convertToImageFormat(), DocVerbatim::DocbookOnly, DocVerbatim::Dot, DString::empty(), OutputCodeList::endCodeFragment(), DocVerbatim::engine(), DocVerbatim::exampleFile(), filter(), forceEndParagraph(), forceStartParagraph(), DocVisitor::getCodeParser(), getDotImageExtension(), getLanguageFromCodeLang(), MermaidManager::HTML, DocVerbatim::HtmlOnly, MermaidManager::instance(), PlantumlManager::instance(), DocVerbatim::isBlock(), DocVerbatim::isExample(), DocVerbatim::JavaDocCode, DocVerbatim::JavaDocLiteral, DocVerbatim::language(), DocVerbatim::LatexOnly, m_ci, m_ctx, m_hide, m_langExt, m_t, DocVerbatim::ManOnly, DocVerbatim::Mermaid, DocVerbatim::Msc, CodeParserInterface::parseCode(), DocVerbatim::PlantUML, PlantumlManager::PUML_BITMAP, PlantumlManager::PUML_SVG, DocVerbatim::relPath(), DocVerbatim::RtfOnly, CodeParserOptions::setInlineFragment(), CodeParserOptions::setSearchCtx(), DocVerbatim::srcFile(), DocVerbatim::srcLine(), OutputCodeList::startCodeFragment(), DocVerbatim::text(), DocVerbatim::type(), DocVerbatim::Verbatim, visitCaption(), writeDotFile(), writeInlineGraph(), writeMermaidFile(), MermaidManager::writeMermaidSource(), writeMscFile(), writePlantUMLFile(), PlantumlManager::writePlantUMLSource(), and DocVerbatim::XmlOnly.

operator()() [56/59]

void HtmlDocVisitor::operator()

(

const DocVhdlFlow &

vf

)

Definition at line 2121 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  if (VhdlDocGen::getFlowMember()) // use VHDL flow chart creator
  {
    forceEndParagraph(vf);
    DString fname=FlowChart::convertNameToFileName();
    m_t << "<p>";
    m_t << theTranslator->trFlowchart();
    m_t << " ";
    m_t << "<a href=\"";
    m_t << fname;
    m_t << ".svg\">";
    m_t << VhdlDocGen::getFlowMember()->name();
    m_t << "</a>";
    if (vf.hasCaption())
    {
      m_t << "<br />";
    }
  }
  visitChildren(vf);
  if (VhdlDocGen::getFlowMember()) // use VHDL flow chart creator
  {
    m_t << "</p>";
    forceStartParagraph(vf);
  }
}

References FlowChart::convertNameToFileName(), forceEndParagraph(), forceStartParagraph(), VhdlDocGen::getFlowMember(), DocVhdlFlow::hasCaption(), m_hide, m_t, Definition::name(), theTranslator, Translator::trFlowchart(), and visitChildren().

operator()() [57/59]

void HtmlDocVisitor::operator()

(

const DocWhiteSpace &

w

)

Definition at line 273 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  if (m_insidePre)
  {
    m_t << w.chars();
  }
  else
  {
    m_t << " ";
  }
}

References DocWhiteSpace::chars(), m_hide, m_insidePre, and m_t.

operator()() [58/59]

void HtmlDocVisitor::operator()

(

const DocWord &

w

)

Definition at line 258 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  filter(w.word());
}

References filter(), m_hide, and DocWord::word().

operator()() [59/59]

void HtmlDocVisitor::operator()

(

const DocXRefItem &

x

)

Definition at line 2069 of file htmldocvisitor.cpp.

{
  if (m_hide) return;
  if (x.title().empty()) return;
 
  forceEndParagraph(x);
  bool anonymousEnum = x.file()=="@";
  if (!anonymousEnum)
  {
    DString fn = x.file();
    addHtmlExtensionIfMissing(fn);
    m_t << "<dl class=\"" << x.key() << "\"><dt><b><a class=\"el\" href=\""
        << x.relPath() << fn
        << "#" << x.anchor() << "\">";
  }
  else
  {
    m_t << "<dl class=\"" << x.key() << "\"><dt><b>";
  }
  filter(x.title());
  if (!anonymousEnum) m_t << "</a>";
  m_t << "</b></dt><dd>";
  visitChildren(x);
  if (x.title().empty()) return;
  m_t << "</dd></dl>\n";
  forceStartParagraph(x);
}

References addHtmlExtensionIfMissing(), DocXRefItem::anchor(), DString::empty(), DocXRefItem::file(), filter(), forceEndParagraph(), forceStartParagraph(), DocXRefItem::key(), m_hide, m_t, DocXRefItem::relPath(), DocXRefItem::title(), and visitChildren().

startLink()

void HtmlDocVisitor::startLink ( const DString & ref, const DString & file, const DString & relPath, const DString & anchor, const DString & tooltip = "" )

private

Definition at line 2247 of file htmldocvisitor.cpp.

{
  //printf("HtmlDocVisitor: file=%s anchor=%s\n",qPrint(file),qPrint(anchor));
  if (!ref.empty()) // link to entity imported via tag file
  {
    m_t << "<a class=\"elRef\" ";
    m_t << externalLinkTarget();
  }
  else // local link
  {
    m_t << "<a class=\"el\" ";
  }
  m_t << "href=\"";
  DString fn = file;
  addHtmlExtensionIfMissing(fn);
  m_t << createHtmlUrl(relPath,ref,true,
                       m_fileName == Config_getString(HTML_OUTPUT)+"/"+fn,
                       fn,
                       anchor);
  m_t << "\"";
  if (!tooltip.empty()) m_t << " title=\"" << convertToHtml(tooltip) << "\"";
  m_t << ">";
}

References addHtmlExtensionIfMissing(), Config_getString, convertToHtml(), createHtmlUrl(), DString::empty(), externalLinkTarget(), m_fileName, and m_t.

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

visitCaption()

template<class T>

void HtmlDocVisitor::visitCaption ( TextStream & t, const T & n )

private

Definition at line 241 of file htmldocvisitor.cpp.

{
  if (n.hasCaption())
  {
    t << "<div class=\"caption\">\n";
    for (const auto &child : n.children())
    {
      std::visit(*this, child);
    }
    t << "</div>\n";
  }
}

Referenced by operator()().

visitChildren()

template<class T>

void HtmlDocVisitor::visitChildren ( const T & t )

inlineprivate

Definition at line 106 of file htmldocvisitor.h.

    {
      for (const auto &child : t.children())
      {
        std::visit(*this, child);
      }
    }

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

writeDiaFile()

void HtmlDocVisitor::writeDiaFile ( const DString & fileName, const DString & relPath, const DString & context, const DString & srcFile, int srcLine, bool newFile = true )

private

Definition at line 2300 of file htmldocvisitor.cpp.

{
  DString baseName=makeBaseName(fileName,".dia");
  baseName.prepend("dia_");
  DString outDir = Config_getString(HTML_OUTPUT);
  if (newFile) writeDiaGraphFromFile(fileName,outDir,baseName,DiaOutputFormat::BITMAP,srcFile,srcLine,true);
 
  m_t << "<img src=\"" << relPath << baseName << ".png" << "\" />\n";
}

References BITMAP, Config_getString, m_t, makeBaseName(), DString::prepend(), and writeDiaGraphFromFile().

Referenced by operator()().

writeDotFile()

void HtmlDocVisitor::writeDotFile ( const DString & fileName, const DString & relPath, const DString & context, const DString & srcFile, int srcLine, bool newFile = true )

private

Definition at line 2278 of file htmldocvisitor.cpp.

{
  DString baseName=makeBaseName(fileName,".dot");
  baseName.prepend("dot_");
  DString outDir = Config_getString(HTML_OUTPUT);
  if (newFile) writeDotGraphFromFile(fileName,outDir,baseName,GraphOutputFormat::BITMAP,srcFile,srcLine,true);
  writeDotImageMapFromFile(m_t,fileName,outDir,relPath,baseName,context,-1,srcFile,srcLine,newFile);
}

References BITMAP, Config_getString, m_t, makeBaseName(), DString::prepend(), writeDotGraphFromFile(), and writeDotImageMapFromFile().

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

writeMermaidFile()

void HtmlDocVisitor::writeMermaidFile ( const DString & fileName, const DString & relPath, const DString & context, const DString & srcFile, int srcLine )

private

Definition at line 2332 of file htmldocvisitor.cpp.

{
  auto baseName     = makeBaseName(fileName,".mmd");
  auto outDir       = Config_getString(HTML_OUTPUT);
  auto outputFormat = MermaidManager::OutputFormat::HTML;
  auto imageFormat  = MermaidManager::convertToImageFormat(outputFormat);
  auto imgExt       = MermaidManager::imageExtension(imageFormat);
  MermaidManager::instance().generateMermaidOutput(fileName,outDir,imageFormat,true);
  if (imageFormat == MermaidManager::ImageFormat::SVG)
  {
    m_t << "<object type=\"image/svg+xml\" data=\"" << relPath << baseName << "." << imgExt << "\"></object>\n";
  }
  else
  {
    m_t << "<img src=\"" << relPath << baseName << "." << imgExt << "\" />\n";
  }
}

References Config_getString, MermaidManager::convertToImageFormat(), MermaidManager::generateMermaidOutput(), MermaidManager::HTML, MermaidManager::imageExtension(), MermaidManager::instance(), m_t, makeBaseName(), and MermaidManager::SVG.

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

writeMscFile()

void HtmlDocVisitor::writeMscFile ( const DString & fileName, const DString & relPath, const DString & context, const DString & srcFile, int srcLine, bool newFile = true )

private

Definition at line 2288 of file htmldocvisitor.cpp.

{
  DString baseName=makeBaseName(fileName,".msc");
  baseName.prepend("msc_");
  DString outDir = Config_getString(HTML_OUTPUT);
  DString imgExt = getDotImageExtension();
  MscOutputFormat mscFormat = imgExt=="svg" ? MscOutputFormat::SVG : MscOutputFormat::BITMAP;
  if (newFile) writeMscGraphFromFile(fileName,outDir,baseName,mscFormat,srcFile,srcLine,true);
  writeMscImageMapFromFile(m_t,fileName,outDir,relPath,baseName,context,mscFormat,srcFile,srcLine);
}

References BITMAP, Config_getString, getDotImageExtension(), m_t, makeBaseName(), DString::prepend(), SVG, writeMscGraphFromFile(), and writeMscImageMapFromFile().

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

writeObfuscatedMailAddress()

void HtmlDocVisitor::writeObfuscatedMailAddress ( const DString & url )

private

Definition at line 323 of file htmldocvisitor.cpp.

{
  if (!Config_getBool(OBFUSCATE_EMAILS))
  {
    m_t << "<a href=\"mailto:" << url << "\">";
  }
  else
  {
    m_t << "<a href=\"mai'+'lto:";
    if (!url.empty())
    {
      const char *p = url.data();
      uint32_t size=3;
      while (*p)
      {
        m_t << "+'";
        for (uint32_t j=0;j<size && *p;j++)
        {
          p = writeUTF8Char(m_t,p);
        }
        m_t << "'";
        if (size==3) size=2; else size=3;
      }
    }
    m_t << "\">";
  }
}

References Config_getBool, DString::data(), DString::empty(), m_t, and writeUTF8Char().

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

writePlantUMLFile()

void HtmlDocVisitor::writePlantUMLFile ( const DString & fileName, const DString & relPath, const DString & context, const DString & srcFile, int srcLine )

private

Definition at line 2311 of file htmldocvisitor.cpp.

{
  DString baseName=makeBaseName(fileName,".pu");
  DString outDir = Config_getString(HTML_OUTPUT);
  DString imgExt = getDotImageExtension();
  if (imgExt=="svg")
  {
    PlantumlManager::instance().generatePlantUMLOutput(fileName,outDir,PlantumlManager::PUML_SVG,true);
    //m_t << "<iframe scrolling=\"no\" frameborder=\"0\" src=\"" << relPath << baseName << ".svg" << "\" />\n";
    //m_t << "<p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p>";
    //m_t << "</iframe>\n";
    m_t << "<object type=\"image/svg+xml\" data=\"" << relPath << baseName << ".svg\"></object>\n";
  }
  else
  {
    PlantumlManager::instance().generatePlantUMLOutput(fileName,outDir,PlantumlManager::PUML_BITMAP,true);
    m_t << "<img src=\"" << relPath << baseName << ".png" << "\" />\n";
  }
}

References Config_getString, PlantumlManager::generatePlantUMLOutput(), getDotImageExtension(), PlantumlManager::instance(), m_t, makeBaseName(), PlantumlManager::PUML_BITMAP, and PlantumlManager::PUML_SVG.

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

Member Data Documentation

m_ci

OutputCodeList& HtmlDocVisitor::m_ci

private

Definition at line 148 of file htmldocvisitor.h.

Referenced by HtmlDocVisitor(), operator()(), operator()(), and operator()().

m_ctx

const Definition* HtmlDocVisitor::m_ctx

private

Definition at line 152 of file htmldocvisitor.h.

Referenced by HtmlDocVisitor(), operator()(), operator()(), and operator()().

m_fileName

DString HtmlDocVisitor::m_fileName

private

Definition at line 153 of file htmldocvisitor.h.

Referenced by HtmlDocVisitor(), and startLink().

m_hide

bool HtmlDocVisitor::m_hide = false

private

Definition at line 150 of file htmldocvisitor.h.

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

m_insidePre

bool HtmlDocVisitor::m_insidePre = false

private

Definition at line 149 of file htmldocvisitor.h.

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

m_insideTitle

bool HtmlDocVisitor::m_insideTitle = false

private

Definition at line 151 of file htmldocvisitor.h.

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

m_langExt

DString HtmlDocVisitor::m_langExt

private

Definition at line 154 of file htmldocvisitor.h.

Referenced by HtmlDocVisitor(), operator()(), and operator()().

m_t

TextStream& HtmlDocVisitor::m_t

private

Definition at line 147 of file htmldocvisitor.h.

Referenced by endLink(), filter(), forceEndParagraph(), forceStartParagraph(), HtmlDocVisitor(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), startLink(), writeDiaFile(), writeDotFile(), writeMermaidFile(), writeMscFile(), writeObfuscatedMailAddress(), and writePlantUMLFile().

---

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

• src/htmldocvisitor.h
• src/htmldocvisitor.cpp