XmlDocVisitor Class Reference

Concrete visitor implementation for XML output. More...

#include <src/xmldocvisitor.h>

Inheritance diagram for XmlDocVisitor:

Collaboration diagram for XmlDocVisitor:

Public Member Functions
	XmlDocVisitor (TextStream &t, OutputCodeList &ci, const DString &langExt)
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 &)
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)
void	filter (const DString &str, const bool keepEntities=false, const bool citeEntry=false)
void	startLink (const DString &ref, const DString &file, const DString &anchor)
void	endLink ()

Private Attributes
TextStream &	m_t
OutputCodeList &	m_ci
bool	m_insidePre = false
bool	m_hide = false
DString	m_langExt
int	m_sectionLevel

Detailed Description

Concrete visitor implementation for XML output.

Definition at line 27 of file xmldocvisitor.h.

Constructor & Destructor Documentation

XmlDocVisitor()

XmlDocVisitor::XmlDocVisitor	(	TextStream &	t,
		OutputCodeList &	ci,
		const DString &	langExt )

Definition at line 150 of file xmldocvisitor.cpp.

  : m_t(t), m_ci(ci), m_insidePre(false), m_hide(false),
    m_langExt(langExt), m_sectionLevel(0)
{
}

References m_ci, m_hide, m_insidePre, m_langExt, m_sectionLevel, and m_t.

Member Function Documentation

endLink()

void XmlDocVisitor::endLink ( )

private

Definition at line 1200 of file xmldocvisitor.cpp.

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

References m_t.

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

filter()

void XmlDocVisitor::filter ( const DString & str, const bool keepEntities = false, const bool citeEntry = false )

private

Definition at line 1183 of file xmldocvisitor.cpp.

{
  m_t << convertToXML(str, keepEntities, citeEntry);
}

References convertToXML(), and m_t.

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

operator()() [1/59]

void XmlDocVisitor::operator()

(

const DocAnchor &

anc

)

Definition at line 400 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<anchor id=\"" << anc.file() << "_1" << anc.anchor() << "\"/>";
}

References DocAnchor::anchor(), DocAnchor::file(), m_hide, and m_t.

operator()() [2/59]

void XmlDocVisitor::operator()

(

const DocAutoList &

l

)

Definition at line 609 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  if (l.isEnumList())
  {
    m_t << "<orderedlist>\n";
  }
  else
  {
    m_t << "<itemizedlist>\n";
  }
  visitChildren(l);
  if (l.isEnumList())
  {
    m_t << "</orderedlist>\n";
  }
  else
  {
    m_t << "</itemizedlist>\n";
  }
}

References DocAutoList::isEnumList(), m_hide, m_t, and visitChildren().

operator()() [3/59]

void XmlDocVisitor::operator()

(

const DocAutoListItem &

li

)

Definition at line 631 of file xmldocvisitor.cpp.

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

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

operator()() [4/59]

void XmlDocVisitor::operator()

(

const DocCite &

cite

)

Definition at line 583 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  auto opt = cite.option();
  if (!cite.file().empty())
  {
    if (!opt.noCite()) startLink(cite.ref(),cite.file(),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(), startLink(), and DocCite::target().

operator()() [5/59]

void XmlDocVisitor::operator()

(

const DocDiaFile &

df

)

Definition at line 989 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  copyFile(df.file(),Config_getString(XML_OUTPUT)+"/"+stripPath(df.file()));
  visitPreStart(m_t, "diafile", false, *this, df.children(), stripPath(df.file()), false, DocImage::Html, df.width(), df.height());
  visitChildren(df);
  visitPostEnd(m_t, "diafile");
}

References DocCompoundNode::children(), Config_getString, copyFile(), DocDiagramFileBase::file(), DocDiagramFileBase::height(), DocImage::Html, m_hide, m_t, stripPath(), visitChildren(), visitPostEnd(), visitPreStart(), and DocDiagramFileBase::width().

operator()() [6/59]

void XmlDocVisitor::operator()

(

const DocDotFile &

df

)

Definition at line 971 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  copyFile(df.file(),Config_getString(XML_OUTPUT)+"/"+stripPath(df.file()));
  visitPreStart(m_t, "dotfile", false, *this, df.children(), stripPath(df.file()), false, DocImage::Html, df.width(), df.height());
  visitChildren(df);
  visitPostEnd(m_t, "dotfile");
}

References DocCompoundNode::children(), Config_getString, copyFile(), DocDiagramFileBase::file(), DocDiagramFileBase::height(), DocImage::Html, m_hide, m_t, stripPath(), visitChildren(), visitPostEnd(), visitPreStart(), and DocDiagramFileBase::width().

operator()() [7/59]

void XmlDocVisitor::operator()

(

const DocEmoji &

s

)

Definition at line 201 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  const char *res = EmojiEntityMapper::instance().name(s.index());
  if (res)
  {
    DString name=res;
    name = name.mid(1,name.length()-2);
    m_t << "<emoji name=\"" << name << "\" unicode=\"";
    filter(EmojiEntityMapper::instance().unicode(s.index()));
    m_t << "\"/>";
  }
  else
  {
    m_t << s.name();
  }
}

References filter(), DocEmoji::index(), EmojiEntityMapper::instance(), DString::length(), m_hide, m_t, DString::mid(), DocEmoji::name(), and EmojiEntityMapper::name().

operator()() [8/59]

void XmlDocVisitor::operator()

(

const DocFormula &

f

)

Definition at line 554 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<formula id=\"" << f.id() << "\">";
  filter(f.text());
  m_t << "</formula>";
}

References filter(), DocFormula::id(), m_hide, m_t, and DocFormula::text().

operator()() [9/59]

void XmlDocVisitor::operator()

(

const DocHorRuler &

)

Definition at line 236 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<hruler/>\n";
}

References m_hide, and m_t.

operator()() [10/59]

void XmlDocVisitor::operator()

(

const DocHRef &

href

)

Definition at line 901 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<ulink url=\"" << convertToXML(href.url(), true) << "\">";
  visitChildren(href);
  m_t << "</ulink>";
}

References convertToXML(), m_hide, m_t, DocHRef::url(), and visitChildren().

operator()() [11/59]

void XmlDocVisitor::operator()

(

const DocHtmlBlockQuote &

q

)

Definition at line 1162 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<blockquote>";
  visitChildren(q);
  m_t << "</blockquote>";
}

References m_hide, m_t, and visitChildren().

operator()() [12/59]

void XmlDocVisitor::operator()

(

const DocHtmlCaption &

c

)

Definition at line 880 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<caption";
  if (!c.file().empty())
  {
    m_t << " id=\""  << stripPath(c.file()) << "_1" << c.anchor() << "\"";
  }
  m_t << ">";
  visitChildren(c);
  m_t << "</caption>\n";
}

References DocHtmlCaption::anchor(), DString::empty(), DocHtmlCaption::file(), m_hide, m_t, stripPath(), and visitChildren().

operator()() [13/59]

void XmlDocVisitor::operator()

(

const DocHtmlCell &

c

)

Definition at line 827 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  if (c.isHeading()) m_t << "<entry thead=\"yes\""; else m_t << "<entry thead=\"no\"";
  for (const auto &opt : c.attribs())
  {
    if (opt.name=="colspan" || opt.name=="rowspan")
    {
      m_t << " " << opt.name << "=\"" << opt.value.toInt() << "\"";
    }
    else if (opt.name=="align" &&
             (opt.value=="right" || opt.value=="left" || opt.value=="center"))
    {
      m_t << " align=\"" << opt.value << "\"";
    }
    else if (opt.name=="valign" &&
      (opt.value == "bottom" || opt.value == "top" || opt.value == "middle"))
    {
      m_t << " valign=\"" << opt.value << "\"";
    }
    else if (opt.name=="width")
    {
      m_t << " width=\"" << opt.value << "\"";
    }
    else if (opt.name=="class") // handle markdown generated attributes
    {
      if (opt.value.startsWith("markdownTable")) // handle markdown generated attributes
      {
        if (opt.value.endsWith("Right"))
        {
          m_t << " align='right'";
        }
        else if (opt.value.endsWith("Left"))
        {
          m_t << " align='left'";
        }
        else if (opt.value.endsWith("Center"))
        {
          m_t << " align='center'";
        }
        // skip 'markdownTable*' value ending with "None"
      }
      else if (!opt.value.empty())
      {
        m_t << " class=\"" << convertToXML(opt.value) << "\"";
      }
    }
  }
  m_t << ">";
  visitChildren(c);
  m_t << "</entry>";
}

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

operator()() [14/59]

void XmlDocVisitor::operator()

(

const DocHtmlDescData &

dd

)

Definition at line 790 of file xmldocvisitor.cpp.

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

References m_hide, m_t, and visitChildren().

operator()() [15/59]

void XmlDocVisitor::operator()

(

const DocHtmlDescList &

dl

)

Definition at line 774 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<variablelist>\n";
  visitChildren(dl);
  m_t << "</variablelist>\n";
}

References m_hide, m_t, and visitChildren().

operator()() [16/59]

void XmlDocVisitor::operator()

(

const DocHtmlDescTitle &

dt

)

Definition at line 782 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<varlistentry><term>";
  visitChildren(dt);
  m_t << "</term></varlistentry>\n";
}

References m_hide, m_t, and visitChildren().

operator()() [17/59]

void XmlDocVisitor::operator()

(

const DocHtmlDetails &

d

)

Definition at line 917 of file xmldocvisitor.cpp.

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

References m_hide, m_t, DocHtmlDetails::summary(), and visitChildren().

operator()() [18/59]

void XmlDocVisitor::operator()

(

const DocHtmlHeader &

header

)

Definition at line 930 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<heading level=\"" << header.level() << "\">";
  visitChildren(header);
  m_t << "</heading>\n";
}

References DocHtmlHeader::level(), m_hide, m_t, and visitChildren().

operator()() [19/59]

void XmlDocVisitor::operator()

(

const DocHtmlList &

s

)

Definition at line 731 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  if (s.type()==DocHtmlList::Ordered)
  {
    m_t << "<orderedlist";
    for (const auto &opt : s.attribs())
    {
      m_t << " " << opt.name << "=\"" << opt.value << "\"";
    }
    m_t << ">\n";
  }
  else
  {
    m_t << "<itemizedlist>\n";
  }
  visitChildren(s);
  if (s.type()==DocHtmlList::Ordered)
  {
    m_t << "</orderedlist>\n";
  }
  else
  {
    m_t << "</itemizedlist>\n";
  }
}

References DocHtmlList::attribs(), m_hide, m_t, DocHtmlList::Ordered, DocHtmlList::type(), and visitChildren().

operator()() [20/59]

void XmlDocVisitor::operator()

(

const DocHtmlListItem &

l

)

Definition at line 758 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<listitem";
  for (const auto &opt : l.attribs())
  {
    if (opt.name=="value")
    {
      m_t << " " << opt.name << "=\"" << opt.value << "\"";
    }
  }
  m_t << ">\n";
  visitChildren(l);
  m_t << "</listitem>\n";
}

References DocHtmlListItem::attribs(), m_hide, m_t, and visitChildren().

operator()() [21/59]

void XmlDocVisitor::operator()

(

const DocHtmlRow &

r

)

Definition at line 819 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<row>\n";
  visitChildren(r);
  m_t << "</row>\n";
}

References m_hide, m_t, and visitChildren().

operator()() [22/59]

void XmlDocVisitor::operator()

(

const DocHtmlSummary &

s

)

Definition at line 909 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<summary>";
  visitChildren(s);
  m_t << "</summary>";
}

References m_hide, m_t, and visitChildren().

operator()() [23/59]

void XmlDocVisitor::operator()

(

const DocHtmlTable &

t

)

Definition at line 798 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<table rows=\"" << t.numRows()
      << "\" cols=\"" << t.numColumns() << "\"" ;
  for (const auto &opt : t.attribs())
  {
    if (opt.name=="width")
    {
      m_t << " " << opt.name << "=\"" << opt.value << "\"";
    }
  }
  m_t << ">";
  if (t.caption())
  {
    std::visit(*this,*t.caption());
  }
  visitChildren(t);
  m_t << "</table>\n";
}

References DocHtmlTable::attribs(), DocHtmlTable::caption(), m_hide, m_t, DocHtmlTable::numColumns(), DocHtmlTable::numRows(), and visitChildren().

operator()() [24/59]

void XmlDocVisitor::operator()

(

const DocImage &

img

)

Definition at line 938 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
 
  DString url = img.url();
  DString baseName;
  if (url.empty())
  {
    baseName = img.relPath()+img.name();
  }
  else
  {
    baseName = correctURL(url,img.relPath());
  }
  HtmlAttribList attribs = img.attribs();
  auto it = std::find_if(attribs.begin(),attribs.end(),
                         [](const auto &att) { return att.name=="alt"; });
  DString altValue = it!=attribs.end() ? it->value : "";
  visitPreStart(m_t, "image", false, *this, img.children(), baseName, true,
                img.type(), img.width(), img.height(), DString(),
                altValue, img.isInlineImage());
 
  // copy the image to the output dir
  FileDef *fd = nullptr;
  bool ambig;
  if (url.empty() && (fd=Doxygen::imageNameLinkedMap->findFileDef(img.name(),ambig)))
  {
    copyFile(fd->absFilePath(),Config_getString(XML_OUTPUT)+"/"+baseName);
  }
  visitChildren(img);
  visitPostEnd(m_t, "image");
}

References FileDef::absFilePath(), DocImage::attribs(), DocCompoundNode::children(), Config_getString, copyFile(), correctURL(), DString::empty(), FileNameLinkedMap::findFileDef(), DocImage::height(), Doxygen::imageNameLinkedMap, DocImage::isInlineImage(), m_hide, m_t, DocImage::name(), DocImage::relPath(), DocImage::type(), DocImage::url(), visitChildren(), visitPostEnd(), visitPreStart(), and DocImage::width().

operator()() [25/59]

void XmlDocVisitor::operator()

(

const DocInclude &

inc

)

Definition at line 406 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  SrcLangExt langExt = getLanguageFromFileName(inc.extension());
  //printf("XMLDocVisitor: DocInclude type=%d trimleft=%d\n",inc.type(),inc.trimLeft());
  switch(inc.type())
  {
    case DocInclude::IncWithLines:
      {
         m_t << "<programlisting filename=\"" << inc.file() << "\">";
         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)
                                                 );
         m_t << "</programlisting>";
      }
      break;
    case DocInclude::Include:
      m_t << "<programlisting filename=\"" << inc.file() << "\">";
      getCodeParser(inc.extension()).parseCode(m_ci,inc.context(),
                                        inc.text(),
                                        langExt,
                                        inc.stripCodeComments(),
                                        CodeParserOptions()
                                        .setExample(inc.isExample(),inc.exampleFile())
                                        .setInlineFragment(true)
                                        .setShowLineNumbers(false)
                                              );
      m_t << "</programlisting>";
      break;
    case DocInclude::DontInclude:
    case DocInclude::DontIncWithLines:
      break;
    case DocInclude::HtmlInclude:
      if (inc.isBlock())
      {
        m_t << "<htmlonly block=\"yes\">";
      }
      else
      {
        m_t << "<htmlonly>";
      }
      filter(inc.text());
      m_t << "</htmlonly>";
      break;
    case DocInclude::LatexInclude:
      m_t << "<latexonly>";
      filter(inc.text());
      m_t << "</latexonly>";
      break;
    case DocInclude::RtfInclude:
      m_t << "<rtfonly>";
      filter(inc.text());
      m_t << "</rtfonly>";
      break;
    case DocInclude::ManInclude:
      m_t << "<manonly>";
      filter(inc.text());
      m_t << "</manonly>";
      break;
    case DocInclude::XmlInclude:
      filter(inc.text());
      break;
    case DocInclude::DocbookInclude:
      m_t << "<docbookonly>";
      filter(inc.text());
      m_t << "</docbookonly>";
      break;
    case DocInclude::VerbInclude:
      m_t << "<verbatim>";
      filter(inc.text());
      m_t << "</verbatim>";
      break;
    case DocInclude::Snippet:
    case DocInclude::SnippetWithLines:
      m_t << "<programlisting filename=\"" << inc.file() << "\">";
      CodeFragmentManager::instance().parseCodeFragment(m_ci,
                                       inc.file(),
                                       inc.blockId(),
                                       inc.context(),
                                       inc.type()==DocInclude::SnippetWithLines,
                                       inc.trimLeft(),
                                       inc.stripCodeComments()
                                      );
      m_t << "</programlisting>";
      break;
  }
}

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

operator()() [26/59]

void XmlDocVisitor::operator()

(

const DocIncOperator &

op

)

Definition at line 502 of file xmldocvisitor.cpp.

{
  //printf("DocIncOperator: type=%d first=%d, last=%d text='%s'\n",
  //    op.type(),op.isFirst(),op.isLast(),qPrint(op.text()));
  if (op.isFirst())
  {
    if (!m_hide)
    {
      m_t << "<programlisting filename=\"" << op.includeFileName() << "\">";
    }
    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())
                                         );
    }
    pushHidden(m_hide);
    m_hide=true;
  }
  if (op.isLast())
  {
    m_hide = popHidden();
    if (!m_hide) m_t << "</programlisting>";
  }
  else
  {
    if (!m_hide) m_t << "\n";
  }
}

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

operator()() [27/59]

void XmlDocVisitor::operator()

(

const DocIndexEntry &

ie

)

Definition at line 562 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<indexentry>"
           "<primaryie>";
  filter(ie.entry());
  m_t << "</primaryie>"
           "<secondaryie></secondaryie>"
         "</indexentry>";
}

References DocIndexEntry::entry(), filter(), m_hide, and m_t.

operator()() [28/59]

void XmlDocVisitor::operator()

(

const DocInternal &

i

)

Definition at line 893 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<internal>";
  visitChildren(i);
  m_t << "</internal>\n";
}

References m_hide, m_t, and visitChildren().

operator()() [29/59]

void XmlDocVisitor::operator()

(

const DocInternalRef &

ref

)

Definition at line 1148 of file xmldocvisitor.cpp.

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

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

operator()() [30/59]

void XmlDocVisitor::operator()

(

const DocLineBreak &

)

Definition at line 230 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<linebreak/>\n";
}

References m_hide, and m_t.

operator()() [31/59]

void XmlDocVisitor::operator()

(

const DocLink &

lnk

)

Definition at line 1016 of file xmldocvisitor.cpp.

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

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

operator()() [32/59]

void XmlDocVisitor::operator()

(

const DocLinkedWord &

w

)

Definition at line 166 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  startLink(w.ref(),w.file(),w.anchor());
  filter(w.word());
  endLink();
}

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

operator()() [33/59]

void XmlDocVisitor::operator()

(

const DocMermaidFile &

df

)

Definition at line 1007 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  copyFile(df.file(),Config_getString(XML_OUTPUT)+"/"+stripPath(df.file()));
  visitPreStart(m_t, "mermaidfile", false, *this, df.children(), stripPath(df.file()), false, DocImage::Html, df.width(), df.height());
  visitChildren(df);
  visitPostEnd(m_t, "mermaidfile");
}

References DocCompoundNode::children(), Config_getString, copyFile(), DocDiagramFileBase::file(), DocDiagramFileBase::height(), DocImage::Html, m_hide, m_t, stripPath(), visitChildren(), visitPostEnd(), visitPreStart(), and DocDiagramFileBase::width().

operator()() [34/59]

void XmlDocVisitor::operator()

(

const DocMscFile &

df

)

Definition at line 980 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  copyFile(df.file(),Config_getString(XML_OUTPUT)+"/"+stripPath(df.file()));
  visitPreStart(m_t, "mscfile", false, *this, df.children(), stripPath(df.file()), false, DocImage::Html, df.width(), df.height());
  visitChildren(df);
  visitPostEnd(m_t, "mscfile");
}

References DocCompoundNode::children(), Config_getString, copyFile(), DocDiagramFileBase::file(), DocDiagramFileBase::height(), DocImage::Html, m_hide, m_t, stripPath(), visitChildren(), visitPostEnd(), visitPreStart(), and DocDiagramFileBase::width().

operator()() [35/59]

void XmlDocVisitor::operator()

(

const DocPara &

p

)

Definition at line 651 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<para>";
  visitChildren(p);
  m_t << "</para>\n";
}

References m_hide, m_t, and visitChildren().

operator()() [36/59]

void XmlDocVisitor::operator()

(

const DocParamList &

pl

)

Definition at line 1083 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<parameteritem>\n";
  m_t << "<parameternamelist>\n";
  for (const auto &param : pl.parameters())
  {
    if (!pl.paramTypes().empty())
    {
      m_t << "<parametertype>";
      for (const auto &type : pl.paramTypes())
      {
        std::visit(*this,type);
      }
      m_t << "</parametertype>\n";
    }
    m_t << "<parametername";
    if (pl.direction()!=DocParamSect::Unspecified)
    {
      m_t << " direction=\"";
      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 << "inout";
      }
      m_t << "\"";
    }
    m_t << ">";
    std::visit(*this,param);
    m_t << "</parametername>\n";
  }
  m_t << "</parameternamelist>\n";
  m_t << "<parameterdescription>\n";
  for (const auto &par : pl.paragraphs())
  {
    std::visit(*this,par);
  }
  m_t << "</parameterdescription>\n";
  m_t << "</parameteritem>\n";
}

References DocParamList::direction(), GrowVector< T >::empty(), DocParamSect::In, DocParamSect::InOut, m_hide, m_t, DocParamSect::Out, DocParamList::paragraphs(), DocParamList::parameters(), DocParamList::paramTypes(), and DocParamSect::Unspecified.

operator()() [37/59]

void XmlDocVisitor::operator()

(

const DocParamSect &

s

)

Definition at line 1055 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<parameterlist kind=\"";
  switch(s.type())
  {
    case DocParamSect::Param:
      m_t << "param"; break;
    case DocParamSect::RetVal:
      m_t << "retval"; break;
    case DocParamSect::Exception:
      m_t << "exception"; break;
    case DocParamSect::TemplateParam:
      m_t << "templateparam"; break;
    default:
      ASSERT(0);
  }
  m_t << "\">";
  visitChildren(s);
  m_t << "</parameterlist>\n";
}

References ASSERT, DocParamSect::Exception, m_hide, m_t, DocParamSect::Param, DocParamSect::RetVal, DocParamSect::TemplateParam, DocParamSect::type(), and visitChildren().

operator()() [38/59]

void XmlDocVisitor::operator()

(

const DocParBlock &

pb

)

Definition at line 1174 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<parblock>";
  visitChildren(pb);
  m_t << "</parblock>";
}

References m_hide, m_t, and visitChildren().

operator()() [39/59]

void XmlDocVisitor::operator()

(

const DocPlantUmlFile &

df

)

Definition at line 998 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  copyFile(df.file(),Config_getString(XML_OUTPUT)+"/"+stripPath(df.file()));
  visitPreStart(m_t, "plantumlfile", false, *this, df.children(), stripPath(df.file()), false, DocImage::Html, df.width(), df.height());
  visitChildren(df);
  visitPostEnd(m_t, "plantumlfile");
}

References DocCompoundNode::children(), Config_getString, copyFile(), DocDiagramFileBase::file(), DocDiagramFileBase::height(), DocImage::Html, m_hide, m_t, stripPath(), visitChildren(), visitPostEnd(), visitPreStart(), and DocDiagramFileBase::width().

operator()() [40/59]

void XmlDocVisitor::operator()

(

const DocRef &

ref

)

Definition at line 1024 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  if (!ref.file().empty())
  {
    startLink(ref.ref(),ref.file(),ref.isSubPage() ? DString() : ref.anchor());
  }
  if (!ref.hasLinkText()) filter(ref.targetTitle());
  visitChildren(ref);
  if (!ref.file().empty()) endLink();
}

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

operator()() [41/59]

void XmlDocVisitor::operator()

(

const DocRoot &

r

)

Definition at line 659 of file xmldocvisitor.cpp.

{
  visitChildren(r);
}

References visitChildren().

operator()() [42/59]

void XmlDocVisitor::operator()

(

const DocSecRefItem &

ref

)

Definition at line 1036 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<tocitem id=\"" << ref.file();
  if (!ref.anchor().empty()) m_t << "_1" << ref.anchor();
  m_t << "\"";
  m_t << ">";
  visitChildren(ref);
  m_t << "</tocitem>\n";
}

References DocSecRefItem::anchor(), DString::empty(), DocSecRefItem::file(), m_hide, m_t, and visitChildren().

operator()() [43/59]

void XmlDocVisitor::operator()

(

const DocSecRefList &

l

)

Definition at line 1047 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<toclist>\n";
  visitChildren(l);
  m_t << "</toclist>\n";
}

References m_hide, m_t, and visitChildren().

operator()() [44/59]

void XmlDocVisitor::operator()

(

const DocSection &

s

)

Definition at line 703 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  int orgSectionLevel = m_sectionLevel;
  DString sectId = s.file();
  if (!s.anchor().empty()) sectId += "_1"+s.anchor();
  while (m_sectionLevel+1<s.level()) // fix missing intermediate levels
  {
    m_sectionLevel++;
    m_t << "<sect" << m_sectionLevel << " id=\"" << sectId << "_1s" << m_sectionLevel << "\">";
  }
  m_sectionLevel++;
  m_t << "<sect" << s.level() << " id=\"" << sectId << "\">\n";
  if (s.title())
  {
    std::visit(*this,*s.title());
  }
  visitChildren(s);
  m_t << "</sect" << s.level() << ">";
  m_sectionLevel--;
  while (orgSectionLevel<m_sectionLevel) // fix missing intermediate levels
  {
    m_t << "</sect" << m_sectionLevel << ">";
    m_sectionLevel--;
  }
  m_t << "\n";
}

References DocSection::anchor(), DString::empty(), DocSection::file(), DocSection::level(), m_hide, m_sectionLevel, m_t, DocSection::title(), and visitChildren().

operator()() [45/59]

void XmlDocVisitor::operator()

(

const DocSeparator &

)

Definition at line 1077 of file xmldocvisitor.cpp.

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

References m_t.

operator()() [46/59]

void XmlDocVisitor::operator()

(

const DocSimpleList &

l

)

Definition at line 684 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<itemizedlist>\n";
  visitChildren(l);
  m_t << "</itemizedlist>\n";
}

References m_hide, m_t, and visitChildren().

operator()() [47/59]

void XmlDocVisitor::operator()

(

const DocSimpleListItem &

li

)

Definition at line 692 of file xmldocvisitor.cpp.

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

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

operator()() [48/59]

void XmlDocVisitor::operator()

(

const DocSimpleSect &

s

)

Definition at line 664 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  startSimpleSect(m_t,s);
  if (s.title())
  {
    std::visit(*this,*s.title());
  }
  visitChildren(s);
  endSimpleSect(m_t,s);
}

References endSimpleSect(), m_hide, m_t, startSimpleSect(), DocSimpleSect::title(), and visitChildren().

operator()() [49/59]

void XmlDocVisitor::operator()

(

const DocSimpleSectSep &

sep

)

Definition at line 573 of file xmldocvisitor.cpp.

{
  const DocSimpleSect *sect = std::get_if<DocSimpleSect>(sep.parent());
  if (sect)
  {
    endSimpleSect(m_t,*sect);
    startSimpleSect(m_t,*sect);
  }
}

References endSimpleSect(), m_t, DocNode::parent(), and startSimpleSect().

operator()() [50/59]

void XmlDocVisitor::operator()

(

const DocStyleChange &

s

)

Definition at line 242 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  switch (s.style())
  {
    case DocStyleChange::Bold:
      if (s.enable()) m_t << "<bold>";      else m_t << "</bold>";
      break;
    case DocStyleChange::S:
      if (s.enable()) m_t << "<s>";      else m_t << "</s>";
      break;
    case DocStyleChange::Strike:
      if (s.enable()) m_t << "<strike>";      else m_t << "</strike>";
      break;
    case DocStyleChange::Del:
      if (s.enable()) m_t << "<del>";      else m_t << "</del>";
      break;
    case DocStyleChange::Underline:
      if (s.enable()) m_t << "<underline>";      else m_t << "</underline>";
      break;
    case DocStyleChange::Ins:
      if (s.enable()) m_t << "<ins>";      else m_t << "</ins>";
      break;
    case DocStyleChange::Italic:
      if (s.enable()) m_t << "<emphasis>";     else m_t << "</emphasis>";
      break;
    case DocStyleChange::Kbd:
    case DocStyleChange::Typewriter:
    case DocStyleChange::Code:
      if (s.enable()) m_t << "<computeroutput>";   else m_t << "</computeroutput>";
      break;
    case DocStyleChange::Subscript:
      if (s.enable()) m_t << "<subscript>";    else m_t << "</subscript>";
      break;
    case DocStyleChange::Superscript:
      if (s.enable()) m_t << "<superscript>";    else m_t << "</superscript>";
      break;
    case DocStyleChange::Center:
      if (s.enable()) m_t << "<center>"; else m_t << "</center>";
      break;
    case DocStyleChange::Small:
      if (s.enable()) m_t << "<small>";  else m_t << "</small>";
      break;
    case DocStyleChange::Cite:
      if (s.enable()) m_t << "<cite>";  else m_t << "</cite>";
      break;
    case DocStyleChange::Preformatted:
      if (s.enable())
      {
        m_t << "<preformatted>";
        m_insidePre=true;
      }
      else
      {
        m_t << "</preformatted>";
        m_insidePre=false;
      }
      break;
    case DocStyleChange::Div:  /* HTML only */ break;
    case DocStyleChange::Span: /* HTML only */ break;
  }
}

References DocStyleChange::Bold, DocStyleChange::Center, DocStyleChange::Cite, DocStyleChange::Code, DocStyleChange::Del, DocStyleChange::Div, DocStyleChange::enable(), 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::Typewriter, and DocStyleChange::Underline.

operator()() [51/59]

void XmlDocVisitor::operator()

(

const DocSymbol &

s

)

Definition at line 187 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  const char *res = HtmlEntityMapper::instance().xml(s.symbol());
  if (res)
  {
    m_t << res;
  }
  else
  {
    err("XML: non supported HTML-entity found: {}\n",HtmlEntityMapper::instance().html(s.symbol(),true));
  }
}

References err, HtmlEntityMapper::instance(), m_hide, m_t, DocSymbol::symbol(), and HtmlEntityMapper::xml().

operator()() [52/59]

void XmlDocVisitor::operator()

(

const DocText &

t

)

Definition at line 1157 of file xmldocvisitor.cpp.

{
  visitChildren(t);
}

References visitChildren().

operator()() [53/59]

void XmlDocVisitor::operator()

(

const DocTitle &

t

)

Definition at line 676 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<title>";
  visitChildren(t);
  m_t << "</title>";
}

References m_hide, m_t, and visitChildren().

operator()() [54/59]

void XmlDocVisitor::operator()

(

const DocURL &

u

)

Definition at line 219 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<ulink url=\"";
  if (u.isEmail()) m_t << "mailto:";
  filter(u.url());
  m_t << "\">";
  filter(u.url());
  m_t << "</ulink>";
}

References filter(), DocURL::isEmail(), m_hide, m_t, and DocURL::url().

operator()() [55/59]

void XmlDocVisitor::operator()

(

const DocVerbatim &

s

)

Definition at line 305 of file xmldocvisitor.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:
      m_t << "<programlisting";
      if (!s.language().empty())
          m_t << " filename=\"" << lang << "\">";
      else
          m_t << ">";
      getCodeParser(lang).parseCode(m_ci,s.context(),s.text(),langExt,
                                    Config_getBool(STRIP_CODE_COMMENTS),
                                    CodeParserOptions().setExample(s.isExample(),s.exampleFile()));
      m_t << "</programlisting>";
      break;
    case DocVerbatim::JavaDocLiteral:
      m_t << "<javadocliteral>";
      filter(s.text());
      m_t << "</javadocliteral>";
      break;
    case DocVerbatim::JavaDocCode:
      m_t << "<javadoccode>";
      filter(s.text());
      m_t << "</javadoccode>";
      break;
    case DocVerbatim::Verbatim:
      m_t << "<verbatim>";
      filter(s.text());
      m_t << "</verbatim>";
      break;
    case DocVerbatim::HtmlOnly:
      if (s.isBlock())
      {
        m_t << "<htmlonly block=\"yes\">";
      }
      else
      {
        m_t << "<htmlonly>";
      }
      filter(s.text());
      m_t << "</htmlonly>";
      break;
    case DocVerbatim::RtfOnly:
      m_t << "<rtfonly>";
      filter(s.text());
      m_t << "</rtfonly>";
      break;
    case DocVerbatim::ManOnly:
      m_t << "<manonly>";
      filter(s.text());
      m_t << "</manonly>";
      break;
    case DocVerbatim::LatexOnly:
      m_t << "<latexonly>";
      filter(s.text());
      m_t << "</latexonly>";
      break;
    case DocVerbatim::DocbookOnly:
      m_t << "<docbookonly>";
      filter(s.text());
      m_t << "</docbookonly>";
      break;
    case DocVerbatim::XmlOnly:
      m_t << s.text();
      break;
    case DocVerbatim::Dot:
      visitPreStart(m_t, "dot", s.hasCaption(), *this, s.children(), DString(""), false, DocImage::Html, s.width(), s.height());
      filter(s.text());
      visitPostEnd(m_t, "dot");
      break;
    case DocVerbatim::Msc:
      visitPreStart(m_t, "msc", s.hasCaption(), *this, s.children(),  DString(""), false, DocImage::Html, s.width(), s.height());
      filter(s.text());
      visitPostEnd(m_t, "msc");
      break;
    case DocVerbatim::PlantUML:
      visitPreStart(m_t, "plantuml", s.hasCaption(), *this, s.children(),  DString(""), false, DocImage::Html, s.width(), s.height(), s.engine());
      filter(s.text());
      visitPostEnd(m_t, "plantuml");
      break;
    case DocVerbatim::Mermaid:
      visitPreStart(m_t, "mermaid", s.hasCaption(), *this, s.children(), DString(""), false, DocImage::Html, s.width(), s.height());
      filter(s.text());
      visitPostEnd(m_t, "mermaid");
      break;
  }
}

References DocVerbatim::children(), DocVerbatim::Code, Config_getBool, DocVerbatim::context(), DocVerbatim::DocbookOnly, DocVerbatim::Dot, DString::empty(), DocVerbatim::engine(), DocVerbatim::exampleFile(), filter(), DocVisitor::getCodeParser(), getLanguageFromCodeLang(), DocVerbatim::hasCaption(), DocVerbatim::height(), DocImage::Html, DocVerbatim::HtmlOnly, DocVerbatim::isBlock(), DocVerbatim::isExample(), DocVerbatim::JavaDocCode, DocVerbatim::JavaDocLiteral, DocVerbatim::language(), DocVerbatim::LatexOnly, m_ci, m_hide, m_langExt, m_t, DocVerbatim::ManOnly, DocVerbatim::Mermaid, DocVerbatim::Msc, CodeParserInterface::parseCode(), DocVerbatim::PlantUML, DocVerbatim::RtfOnly, DocVerbatim::text(), DocVerbatim::type(), DocVerbatim::Verbatim, visitPostEnd(), visitPreStart(), DocVerbatim::width(), and DocVerbatim::XmlOnly.

operator()() [56/59]

void XmlDocVisitor::operator()

(

const DocVhdlFlow &

)

Definition at line 1170 of file xmldocvisitor.cpp.

{
}

operator()() [57/59]

void XmlDocVisitor::operator()

(

const DocWhiteSpace &

w

)

Definition at line 174 of file xmldocvisitor.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 XmlDocVisitor::operator()

(

const DocWord &

w

)

Definition at line 160 of file xmldocvisitor.cpp.

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

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

operator()() [59/59]

void XmlDocVisitor::operator()

(

const DocXRefItem &

x

)

Definition at line 1131 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  if (x.title().empty()) return;
  m_t << "<xrefsect id=\"";
  m_t << x.file() << "_1" << x.anchor();
  m_t << "\">";
  m_t << "<xreftitle>";
  filter(x.title());
  m_t << "</xreftitle>";
  m_t << "<xrefdescription>";
  visitChildren(x);
  if (x.title().empty()) return;
  m_t << "</xrefdescription>";
  m_t << "</xrefsect>";
}

References DocXRefItem::anchor(), DString::empty(), DocXRefItem::file(), filter(), m_hide, m_t, DocXRefItem::title(), and visitChildren().

startLink()

void XmlDocVisitor::startLink ( const DString & ref, const DString & file, const DString & anchor )

private

Definition at line 1188 of file xmldocvisitor.cpp.

{
  //printf("XmlDocVisitor: file=%s anchor=%s\n",qPrint(file),qPrint(anchor));
  m_t << "<ref refid=\"" << file;
  if (!anchor.empty()) m_t << "_1" << anchor;
  m_t << "\" kindref=\"";
  if (!anchor.empty()) m_t << "member"; else m_t << "compound";
  m_t << "\"";
  if (!ref.empty()) m_t << " external=\"" << ref << "\"";
  m_t << ">";
}

References DString::empty(), and m_t.

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

visitChildren()

template<class T>

void XmlDocVisitor::visitChildren ( const T & t )

inlineprivate

Definition at line 103 of file xmldocvisitor.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()(), and operator()().

Member Data Documentation

m_ci

OutputCodeList& XmlDocVisitor::m_ci

private

Definition at line 125 of file xmldocvisitor.h.

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

m_hide

bool XmlDocVisitor::m_hide = false

private

Definition at line 127 of file xmldocvisitor.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 XmlDocVisitor().

m_insidePre

bool XmlDocVisitor::m_insidePre = false

private

Definition at line 126 of file xmldocvisitor.h.

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

m_langExt

DString XmlDocVisitor::m_langExt

private

Definition at line 128 of file xmldocvisitor.h.

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

m_sectionLevel

int XmlDocVisitor::m_sectionLevel

private

Definition at line 129 of file xmldocvisitor.h.

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

m_t

TextStream& XmlDocVisitor::m_t

private

Definition at line 124 of file xmldocvisitor.h.

Referenced by endLink(), filter(), 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()(), startLink(), and XmlDocVisitor().

---

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

• src/xmldocvisitor.h
• src/xmldocvisitor.cpp