PerlModDocVisitor Class Reference

Concrete visitor implementation for PerlMod output. More...

Inheritance diagram for PerlModDocVisitor:

Collaboration diagram for PerlModDocVisitor:

Public Member Functions
	PerlModDocVisitor (PerlModOutput &)
void	finish ()
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	addLink (const DString &ref, const DString &file, const DString &anchor)
void	enterText ()
void	leaveText ()
void	openItem (const DString &)
void	closeItem ()
void	singleItem (const DString &)
void	openSubBlock (const DString &=DString())
void	closeSubBlock ()

Private Attributes
PerlModOutput &	m_output
bool	m_textmode
bool	m_textblockstart
DString	m_other

Detailed Description

Concrete visitor implementation for PerlMod output.

Definition at line 274 of file perlmodgen.cpp.

Constructor & Destructor Documentation

PerlModDocVisitor()

PerlModDocVisitor::PerlModDocVisitor

(

PerlModOutput &

output

)

Definition at line 386 of file perlmodgen.cpp.

  : m_output(output), m_textmode(false), m_textblockstart(false)
{
  m_output.openList("doc");
}

References m_output, m_textblockstart, m_textmode, and PerlModOutput::openList().

Member Function Documentation

addLink()

void PerlModDocVisitor::addLink ( const DString & ref, const DString & file, const DString & anchor )

private

Definition at line 399 of file perlmodgen.cpp.

{
  DString link = file;
  if (!anchor.empty())
    (link += "_1") += anchor;
  m_output.addFieldQuotedString("link", link);
}

References PerlModOutput::addFieldQuotedString(), DString::empty(), and m_output.

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

closeItem()

void PerlModDocVisitor::closeItem ( )

private

Definition at line 413 of file perlmodgen.cpp.

{
  leaveText();
  m_output.closeHash();
}

References PerlModOutput::closeHash(), leaveText(), and m_output.

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

closeSubBlock()

void PerlModDocVisitor::closeSubBlock ( )

private

Definition at line 451 of file perlmodgen.cpp.

{
  leaveText();
  m_output.closeList();
}

References PerlModOutput::closeList(), leaveText(), and m_output.

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

enterText()

void PerlModDocVisitor::enterText ( )

private

Definition at line 419 of file perlmodgen.cpp.

{
  if (m_textmode)
    return;
  openItem("text");
  m_output.addField("content").add('\'');
  m_textmode = true;
}

References PerlModOutput::add(), PerlModOutput::addField(), m_output, m_textmode, and openItem().

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

finish()

void PerlModDocVisitor::finish

(

)

Definition at line 392 of file perlmodgen.cpp.

{
  leaveText();
  m_output.closeList()
    .add(m_other);
}

References PerlModOutput::add(), PerlModOutput::closeList(), leaveText(), m_other, and m_output.

Referenced by addPerlModDocBlock().

leaveText()

void PerlModDocVisitor::leaveText ( )

private

Definition at line 428 of file perlmodgen.cpp.

{
  if (!m_textmode)
    return;
  m_textmode = false;
  m_output
    .add('\'')
    .closeHash();
}

References PerlModOutput::add(), PerlModOutput::closeHash(), m_output, and m_textmode.

Referenced by closeItem(), closeSubBlock(), finish(), openItem(), openSubBlock(), operator()(), operator()(), operator()(), and operator()().

openItem()

void PerlModDocVisitor::openItem ( const DString & name )

private

Definition at line 407 of file perlmodgen.cpp.

{
  leaveText();
  m_output.openHash().addFieldQuotedString("type", name);
}

References PerlModOutput::addFieldQuotedString(), leaveText(), m_output, and PerlModOutput::openHash().

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

openSubBlock()

void PerlModDocVisitor::openSubBlock ( const DString & s = DString() )

private

Definition at line 444 of file perlmodgen.cpp.

{
  leaveText();
  m_output.openList(s);
  m_textblockstart = true;
}

References leaveText(), m_output, m_textblockstart, and PerlModOutput::openList().

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

operator()() [1/59]

void PerlModDocVisitor::operator()

(

const DocAnchor &

anc

)

Definition at line 667 of file perlmodgen.cpp.

{
  DString anchor = anc.file() + "_1" + anc.anchor();
  openItem("anchor");
  m_output.addFieldQuotedString("id", anchor);
  closeItem();
}

References PerlModOutput::addFieldQuotedString(), DocAnchor::anchor(), closeItem(), DocAnchor::file(), m_output, and openItem().

operator()() [2/59]

void PerlModDocVisitor::operator()

(

const DocAutoList &

l

)

Definition at line 774 of file perlmodgen.cpp.

{
  openItem("list");
  m_output.addFieldQuotedString("style", l.isEnumList() ? "ordered" : (l.isCheckedList() ? "check" :"itemized"));
  openSubBlock("content");
  visitChildren(l);
  closeSubBlock();
  closeItem();
}

References PerlModOutput::addFieldQuotedString(), closeItem(), closeSubBlock(), DocAutoList::isCheckedList(), DocAutoList::isEnumList(), m_output, openItem(), openSubBlock(), and visitChildren().

operator()() [3/59]

void PerlModDocVisitor::operator()

(

const DocAutoListItem &

li

)

Definition at line 784 of file perlmodgen.cpp.

{
  openSubBlock();
  switch (li.itemNumber())
  {
    case DocAutoList::Unchecked: // unchecked
      m_output.addFieldQuotedString("style", "Unchecked");
      break;
    case DocAutoList::Checked_x: // checked with x
    case DocAutoList::Checked_X: // checked with X
      m_output.addFieldQuotedString("style", "Checked");
      break;
    default:
      break;
  }
  visitChildren(li);
  closeSubBlock();
}

References PerlModOutput::addFieldQuotedString(), DocAutoList::Checked_X, DocAutoList::Checked_x, closeSubBlock(), DocAutoListItem::itemNumber(), m_output, openSubBlock(), DocAutoList::Unchecked, and visitChildren().

operator()() [4/59]

void PerlModDocVisitor::operator()

(

const DocCite &

cite

)

Definition at line 750 of file perlmodgen.cpp.

{
  openItem("cite");
  auto opt = cite.option();
  DString txt;
  if (!cite.file().empty())
  {
    txt = cite.getText();
  }
  else
  {
    if (!opt.noPar()) txt += "[";
    txt += cite.target();
    if (!opt.noPar()) txt += "]";
  }
  m_output.addFieldQuotedString("text", txt);
  closeItem();
}

References PerlModOutput::addFieldQuotedString(), closeItem(), DString::empty(), DocCite::file(), DocCite::getText(), m_output, openItem(), DocCite::option(), and DocCite::target().

operator()() [5/59]

void PerlModDocVisitor::operator()

(

const DocDiaFile &

df

)

Definition at line 1143 of file perlmodgen.cpp.

{
#if 0
  m_output.add("<diafile name=\""); m_output.add(df->file()); m_output.add("\">");
#endif
  visitChildren(df);
#if 0
  m_output.add("</diafile>");
#endif
}

References PerlModOutput::add(), DocDiagramFileBase::file(), m_output, and visitChildren().

operator()() [6/59]

void PerlModDocVisitor::operator()

(

const DocDotFile &

df

)

Definition at line 1122 of file perlmodgen.cpp.

{
#if 0
  m_output.add("<dotfile name=\""); m_output.add(df->file()); m_output.add("\">");
#endif
  visitChildren(df);
#if 0
  m_output.add("</dotfile>");
#endif
}

References PerlModOutput::add(), DocDiagramFileBase::file(), m_output, and visitChildren().

operator()() [7/59]

void PerlModDocVisitor::operator()

(

const DocEmoji &

sy

)

Definition at line 569 of file perlmodgen.cpp.

{
  enterText();
  const char *name = EmojiEntityMapper::instance().name(sy.index());
  if (name)
  {
    m_output.add(name);
  }
  else
  {
    m_output.add(sy.name());
  }
}

References PerlModOutput::add(), enterText(), DocEmoji::index(), EmojiEntityMapper::instance(), m_output, DocEmoji::name(), and EmojiEntityMapper::name().

operator()() [8/59]

void PerlModDocVisitor::operator()

(

const DocFormula &

f

)

Definition at line 725 of file perlmodgen.cpp.

{
  openItem("formula");
  DString id;
  id += DString().setNum(f.id());
  m_output.addFieldQuotedString("id", id).addFieldQuotedString("content", f.text());
  closeItem();
}

References PerlModOutput::addFieldQuotedString(), closeItem(), DocFormula::id(), m_output, openItem(), DString::setNum(), and DocFormula::text().

operator()() [9/59]

void PerlModDocVisitor::operator()

(

const DocHorRuler &

)

Definition at line 595 of file perlmodgen.cpp.

{
  singleItem("hruler");
}

References singleItem().

operator()() [10/59]

void PerlModDocVisitor::operator()

(

const DocHRef &

href

)

Definition at line 1038 of file perlmodgen.cpp.

{
#if 0
  m_output.add("<ulink url=\""); m_output.add(href.url()); m_output.add("\">");
#endif
  visitChildren(href);
#if 0
  m_output.add("</ulink>");
#endif
}

References PerlModOutput::add(), m_output, DocHRef::url(), and visitChildren().

operator()() [11/59]

void PerlModDocVisitor::operator()

(

const DocHtmlBlockQuote &

q

)

Definition at line 1337 of file perlmodgen.cpp.

{
  openItem("blockquote");
  openSubBlock("content");
  visitChildren(q);
  closeSubBlock();
  closeItem();
}

References closeItem(), closeSubBlock(), openItem(), openSubBlock(), and visitChildren().

operator()() [12/59]

void PerlModDocVisitor::operator()

(

const DocHtmlCaption &

c

)

Definition at line 1016 of file perlmodgen.cpp.

{
#if 0
  m_output.add("<caption>");
#endif
  visitChildren(c);
#if 0
  m_output.add("</caption>\n");
#endif
}

References PerlModOutput::add(), m_output, and visitChildren().

operator()() [13/59]

void PerlModDocVisitor::operator()

(

const DocHtmlCell &

c

)

Definition at line 1005 of file perlmodgen.cpp.

{
#if 0
  if (c.isHeading()) m_output.add("<entry thead=\"yes\">"); else m_output.add("<entry thead=\"no\">");
#endif
  visitChildren(c);
#if 0
  m_output.add("</entry>");
#endif
}

References PerlModOutput::add(), DocHtmlCell::isHeading(), m_output, and visitChildren().

operator()() [14/59]

void PerlModDocVisitor::operator()

(

const DocHtmlDescData &

dd

)

Definition at line 967 of file perlmodgen.cpp.

{
#if 0
  m_output.add("<listitem>");
#endif
  visitChildren(dd);
#if 0
  m_output.add("</listitem>\n");
#endif
}

References PerlModOutput::add(), m_output, and visitChildren().

operator()() [15/59]

void PerlModDocVisitor::operator()

(

const DocHtmlDescList &

dl

)

Definition at line 945 of file perlmodgen.cpp.

{
#if 0
  m_output.add("<variablelist>\n");
#endif
  visitChildren(dl);
#if 0
  m_output.add("</variablelist>\n");
#endif
}

References PerlModOutput::add(), m_output, and visitChildren().

operator()() [16/59]

void PerlModDocVisitor::operator()

(

const DocHtmlDescTitle &

dt

)

Definition at line 956 of file perlmodgen.cpp.

{
#if 0
  m_output.add("<varlistentry><term>");
#endif
  visitChildren(dt);
#if 0
  m_output.add("</term></varlistentry>\n");
#endif
}

References PerlModOutput::add(), m_output, and visitChildren().

operator()() [17/59]

void PerlModDocVisitor::operator()

(

const DocHtmlDetails &

details

)

Definition at line 1058 of file perlmodgen.cpp.

{
  openItem("details");
  auto summary = details.summary();
  if (summary)
  {
    std::visit(*this,*summary);
  }
  openSubBlock("content");
  visitChildren(details);
  closeSubBlock();
  closeItem();
}

References closeItem(), closeSubBlock(), openItem(), openSubBlock(), and visitChildren().

operator()() [18/59]

void PerlModDocVisitor::operator()

(

const DocHtmlHeader &

header

)

Definition at line 1072 of file perlmodgen.cpp.

{
#if 0
  m_output.add("<sect"); m_output.add(header.level()); m_output.add(">");
#endif
  visitChildren(header);
#if 0
  m_output.add("</sect"); m_output.add(header.level()); m_output.add(">\n");
#endif
}

References PerlModOutput::add(), DocHtmlHeader::level(), m_output, and visitChildren().

operator()() [19/59]

void PerlModDocVisitor::operator()

(

const DocHtmlList &

l

)

Definition at line 910 of file perlmodgen.cpp.

{
  openItem("list");
  m_output.addFieldQuotedString("style", (l.type() == DocHtmlList::Ordered) ? "ordered" : "itemized");
  for (const auto &opt : l.attribs())
  {
    if (opt.name=="type")
    {
      m_output.addFieldQuotedString("list_type", qPrint(opt.value));
    }
    if (opt.name=="start")
    {
      m_output.addFieldQuotedString("start", qPrint(opt.value));
    }
  }
  openSubBlock("content");
  visitChildren(l);
  closeSubBlock();
  closeItem();
}

References PerlModOutput::addFieldQuotedString(), DocHtmlList::attribs(), closeItem(), closeSubBlock(), m_output, openItem(), openSubBlock(), DocHtmlList::Ordered, qPrint(), DocHtmlList::type(), and visitChildren().

operator()() [20/59]

void PerlModDocVisitor::operator()

(

const DocHtmlListItem &

l

)

Definition at line 931 of file perlmodgen.cpp.

{
  for (const auto &opt : l.attribs())
  {
    if (opt.name=="value")
    {
      m_output.addFieldQuotedString("item_value", qPrint(opt.value));
    }
  }
  openSubBlock();
  visitChildren(l);
  closeSubBlock();
}

References PerlModOutput::addFieldQuotedString(), DocHtmlListItem::attribs(), closeSubBlock(), m_output, openSubBlock(), qPrint(), and visitChildren().

operator()() [21/59]

void PerlModDocVisitor::operator()

(

const DocHtmlRow &

r

)

Definition at line 994 of file perlmodgen.cpp.

{
#if 0
  m_output.add("<row>\n");
#endif
  visitChildren(r);
#if 0
  m_output.add("</row>\n");
#endif
}

References PerlModOutput::add(), m_output, and visitChildren().

operator()() [22/59]

void PerlModDocVisitor::operator()

(

const DocHtmlSummary &

summary

)

Definition at line 1049 of file perlmodgen.cpp.

{
  openItem("summary");
  openSubBlock("content");
  visitChildren(summary);
  closeSubBlock();
  closeItem();
}

References closeItem(), closeSubBlock(), openItem(), openSubBlock(), and visitChildren().

operator()() [23/59]

void PerlModDocVisitor::operator()

(

const DocHtmlTable &

t

)

Definition at line 978 of file perlmodgen.cpp.

{
#if 0
  m_output.add("<table rows=\""); m_output.add(t.numRows());
  m_output.add("\" cols=\""); m_output.add(t.numCols()); m_output.add("\">");
#endif
  if (t.caption())
  {
    std::visit(*this,*t.caption());
  }
  visitChildren(t);
#if 0
  m_output.add("</table>\n");
#endif
}

References PerlModOutput::add(), DocHtmlTable::caption(), m_output, DocHtmlTable::numRows(), and visitChildren().

operator()() [24/59]

void PerlModDocVisitor::operator()

(

const DocImage &

img

)

Definition at line 1083 of file perlmodgen.cpp.

{
#if 0
  m_output.add("<image type=\"");
  switch(img.type())
  {
  case DocImage::Html:  m_output.add("html"); break;
  case DocImage::Latex: m_output.add("latex"); break;
  case DocImage::Rtf:   m_output.add("rtf"); break;
  }
  m_output.add("\"");
 
  DString baseName=img.name();
  int i;
  if ((i=baseName.findRev('/'))!=-1 || (i=baseName.findRev('\\'))!=-1)
  {
    baseName=baseName.mid(i+1);
  }
  m_output.add(" name=\""); m_output.add(baseName); m_output.add("\"");
  if (!img.width().empty())
  {
    m_output.add(" width=\"");
    m_output.addQuoted(img.width());
    m_output.add("\"");
  }
  else if (!img.height().empty())
  {
    m_output.add(" height=\"");
    m_output.addQuoted(img.height());
    m_output.add("\"");
  }
  m_output.add(">");
#endif
  visitChildren(img);
#if 0
  m_output.add("</image>");
#endif
}

References PerlModOutput::add(), PerlModOutput::addQuoted(), DString::empty(), DocImage::height(), DocImage::Html, DocImage::Latex, m_output, DString::mid(), DocImage::name(), DocImage::Rtf, DocImage::type(), visitChildren(), and DocImage::width().

operator()() [25/59]

void PerlModDocVisitor::operator()

(

const DocInclude &

inc

)

Definition at line 675 of file perlmodgen.cpp.

{
  const char *type = nullptr;
  switch (inc.type())
  {
    case DocInclude::IncWithLines:
      return;
    case DocInclude::Include:
      return;
    case DocInclude::DontInclude: return;
    case DocInclude::DontIncWithLines: return;
    case DocInclude::HtmlInclude: type = "htmlonly"; break;
    case DocInclude::LatexInclude: type = "latexonly"; break;
    case DocInclude::RtfInclude: type = "rtfonly"; break;
    case DocInclude::ManInclude: type = "manonly"; break;
    case DocInclude::XmlInclude: type = "xmlonly"; break;
    case DocInclude::DocbookInclude: type = "docbookonly"; break;
    case DocInclude::VerbInclude: type = "preformatted"; break;
    case DocInclude::Snippet: return;
    case DocInclude::SnippetWithLines: return;
  }
  openItem(type);
  m_output.addFieldQuotedString("content", inc.text());
  closeItem();
}

References PerlModOutput::addFieldQuotedString(), closeItem(), DocInclude::DocbookInclude, DocInclude::DontInclude, DocInclude::DontIncWithLines, DocInclude::HtmlInclude, DocInclude::Include, DocInclude::IncWithLines, DocInclude::LatexInclude, m_output, DocInclude::ManInclude, openItem(), DocInclude::RtfInclude, DocInclude::Snippet, DocInclude::SnippetWithLines, DocInclude::text(), DocInclude::type(), DocInclude::VerbInclude, and DocInclude::XmlInclude.

operator()() [26/59]

void PerlModDocVisitor::operator()

(

const DocIncOperator &

)

Definition at line 701 of file perlmodgen.cpp.

{
#if 0
  //printf("DocIncOperator: type=%d first=%d, last=%d text='%s'\n",
  //    op.type(),op.isFirst(),op.isLast(),op.text().data());
  if (op.isFirst())
  {
    m_output.add("<programlisting>");
  }
  if (op.type()!=DocIncOperator::Skip)
  {
    parseCode(m_ci,op.context(),op.text(),false,0);
  }
  if (op.isLast())
  {
    m_output.add("</programlisting>");
  }
  else
  {
    m_output.add('\n');
  }
#endif
}

References PerlModOutput::add(), m_output, and DocIncOperator::Skip.

operator()() [27/59]

void PerlModDocVisitor::operator()

(

const DocIndexEntry &

)

Definition at line 734 of file perlmodgen.cpp.

{
#if 0
  m_output.add("<indexentry>"
               "<primaryie>");
  m_output.addQuoted(ie->entry());
  m_output.add("</primaryie>"
               "<secondaryie></secondaryie>"
               "</indexentry>");
#endif
}

References PerlModOutput::add(), PerlModOutput::addQuoted(), and m_output.

operator()() [28/59]

void PerlModDocVisitor::operator()

(

const DocInternal &

i

)

Definition at line 1027 of file perlmodgen.cpp.

{
#if 0
  m_output.add("<internal>");
#endif
  visitChildren(i);
#if 0
  m_output.add("</internal>");
#endif
}

References PerlModOutput::add(), m_output, and visitChildren().

operator()() [29/59]

void PerlModDocVisitor::operator()

(

const DocInternalRef &

ref

)

Definition at line 1322 of file perlmodgen.cpp.

{
  openItem("ref");
  addLink(DString(),ref.file(),ref.anchor());
  openSubBlock("content");
  visitChildren(ref);
  closeSubBlock();
  closeItem();
}

References addLink(), DocInternalRef::anchor(), closeItem(), closeSubBlock(), DocInternalRef::file(), openItem(), openSubBlock(), and visitChildren().

operator()() [30/59]

void PerlModDocVisitor::operator()

(

const DocLineBreak &

)

Definition at line 590 of file perlmodgen.cpp.

{
  singleItem("linebreak");
}

References singleItem().

operator()() [31/59]

void PerlModDocVisitor::operator()

(

const DocLink &

lnk

)

Definition at line 1176 of file perlmodgen.cpp.

{
  openItem("link");
  addLink(lnk.ref(), lnk.file(), lnk.anchor());
  visitChildren(lnk);
  closeItem();
}

References addLink(), DocLink::anchor(), closeItem(), DocLink::file(), openItem(), DocLink::ref(), and visitChildren().

operator()() [32/59]

void PerlModDocVisitor::operator()

(

const DocLinkedWord &

w

)

Definition at line 485 of file perlmodgen.cpp.

{
  openItem("url");
  addLink(w.ref(), w.file(), w.anchor());
  m_output.addFieldQuotedString("content", w.word());
  closeItem();
}

References PerlModOutput::addFieldQuotedString(), addLink(), DocLinkedWord::anchor(), closeItem(), DocLinkedWord::file(), m_output, openItem(), DocLinkedWord::ref(), and DocLinkedWord::word().

operator()() [33/59]

void PerlModDocVisitor::operator()

(

const DocMermaidFile &

df

)

Definition at line 1165 of file perlmodgen.cpp.

{
#if 0
  m_output.add("<mermaidfile name=\""); m_output.add(df->file()); m_output.add("\">");
#endif
  visitChildren(df);
#if 0
  m_output.add("</mermaidfile>");
#endif
}

References PerlModOutput::add(), DocDiagramFileBase::file(), m_output, and visitChildren().

operator()() [34/59]

void PerlModDocVisitor::operator()

(

const DocMscFile &

df

)

Definition at line 1132 of file perlmodgen.cpp.

{
#if 0
  m_output.add("<mscfile name=\""); m_output.add(df->file()); m_output.add("\">");
#endif
  visitChildren(df);
#if 0
  m_output.add("<mscfile>");
#endif
}

References PerlModOutput::add(), DocDiagramFileBase::file(), m_output, and visitChildren().

operator()() [35/59]

void PerlModDocVisitor::operator()

(

const DocPara &

p

)

Definition at line 803 of file perlmodgen.cpp.

{
  if (m_textblockstart)
    m_textblockstart = false;
  else
    singleItem("parbreak");
  /*
  openItem("para");
  openSubBlock("content");
  */
  visitChildren(p);
  /*
  closeSubBlock();
  closeItem();
  */
}

References m_textblockstart, singleItem(), and visitChildren().

operator()() [36/59]

void PerlModDocVisitor::operator()

(

const DocParamList &

pl

)

Definition at line 1244 of file perlmodgen.cpp.

{
  leaveText();
  m_output.openHash().openList("parameters");
  for (const auto &param : pl.parameters())
  {
    DString name;
    const DocWord *word = std::get_if<DocWord>(&param);
    const DocLinkedWord *linkedWord = std::get_if<DocLinkedWord>(&param);
    if (word)
    {
      name = word->word();
    }
    else if (linkedWord)
    {
      name = linkedWord->word();
    }
 
    DString dir = "";
    const DocParamSect *sect = std::get_if<DocParamSect>(pl.parent());
    if (sect && sect->hasInOutSpecifier())
    {
      if (pl.direction()!=DocParamSect::Unspecified)
      {
        if (pl.direction()==DocParamSect::In)
        {
          dir = "in";
        }
        else if (pl.direction()==DocParamSect::Out)
        {
          dir = "out";
        }
        else if (pl.direction()==DocParamSect::InOut)
        {
          dir = "in,out";
        }
      }
    }
 
    m_output.openHash()
      .addFieldQuotedString("name", name).addFieldQuotedString("dir", dir)
      .closeHash();
  }
  m_output.closeList()
    .openList("doc");
  for (const auto &par : pl.paragraphs())
  {
    std::visit(*this,par);
  }
  leaveText();
  m_output.closeList()
    .closeHash();
}

References PerlModOutput::addFieldQuotedString(), PerlModOutput::closeHash(), PerlModOutput::closeList(), DocParamList::direction(), DocParamSect::hasInOutSpecifier(), DocParamSect::In, DocParamSect::InOut, leaveText(), m_output, PerlModOutput::openHash(), PerlModOutput::openList(), DocParamSect::Out, DocParamList::paragraphs(), DocParamList::parameters(), DocNode::parent(), DocParamSect::Unspecified, DocLinkedWord::word(), and DocWord::word().

operator()() [37/59]

void PerlModDocVisitor::operator()

(

const DocParamSect &

s

)

Definition at line 1217 of file perlmodgen.cpp.

{
  leaveText();
  const char *type = nullptr;
  switch(s.type())
  {
    case DocParamSect::Param:     type = "params"; break;
    case DocParamSect::RetVal:    type = "retvals"; break;
    case DocParamSect::Exception: type = "exceptions"; break;
    case DocParamSect::TemplateParam: type = "templateparam"; break;
    case DocParamSect::Unknown:
      err("unknown parameter section found\n");
      break;
  }
  m_output.openHash();
  //openOther();
  openSubBlock(type);
  visitChildren(s);
  closeSubBlock();
  //closeOther();
  m_output.closeHash();
}

References PerlModOutput::closeHash(), closeSubBlock(), err, DocParamSect::Exception, leaveText(), m_output, PerlModOutput::openHash(), openSubBlock(), DocParamSect::Param, DocParamSect::RetVal, DocParamSect::TemplateParam, DocParamSect::type(), DocParamSect::Unknown, and visitChildren().

operator()() [38/59]

void PerlModDocVisitor::operator()

(

const DocParBlock &

pb

)

Definition at line 1350 of file perlmodgen.cpp.

{
  visitChildren(pb);
}

References visitChildren().

operator()() [39/59]

void PerlModDocVisitor::operator()

(

const DocPlantUmlFile &

df

)

Definition at line 1154 of file perlmodgen.cpp.

{
#if 0
  m_output.add("<plantumlfile name=\""); m_output.add(df->file()); m_output.add("\">");
#endif
  visitChildren(df);
#if 0
  m_output.add("</plantumlfile>");
#endif
}

References PerlModOutput::add(), DocDiagramFileBase::file(), m_output, and visitChildren().

operator()() [40/59]

void PerlModDocVisitor::operator()

(

const DocRef &

ref

)

Definition at line 1184 of file perlmodgen.cpp.

{
  openItem("ref");
  if (!ref.hasLinkText())
    m_output.addFieldQuotedString("text", ref.targetTitle());
  openSubBlock("content");
  visitChildren(ref);
  closeSubBlock();
  closeItem();
}

References PerlModOutput::addFieldQuotedString(), closeItem(), closeSubBlock(), DocRef::hasLinkText(), m_output, openItem(), openSubBlock(), DocRef::targetTitle(), and visitChildren().

operator()() [41/59]

void PerlModDocVisitor::operator()

(

const DocRoot &

r

)

Definition at line 820 of file perlmodgen.cpp.

{
  visitChildren(r);
}

References visitChildren().

operator()() [42/59]

void PerlModDocVisitor::operator()

(

const DocSecRefItem &

ref

)

Definition at line 1195 of file perlmodgen.cpp.

{
#if 0
  m_output.add("<tocitem id=\""); m_output.add(ref->file()); m_output.add("_1"); m_output.add(ref->anchor()); m_output.add("\">");
#endif
  visitChildren(ref);
#if 0
  m_output.add("</tocitem>");
#endif
}

References PerlModOutput::add(), DocSecRefItem::anchor(), DocSecRefItem::file(), m_output, and visitChildren().

operator()() [43/59]

void PerlModDocVisitor::operator()

(

const DocSecRefList &

l

)

Definition at line 1206 of file perlmodgen.cpp.

{
#if 0
  m_output.add("<toclist>");
#endif
  visitChildren(l);
#if 0
  m_output.add("</toclist>");
#endif
}

References PerlModOutput::add(), m_output, and visitChildren().

operator()() [44/59]

void PerlModDocVisitor::operator()

(

const DocSection &

s

)

Definition at line 895 of file perlmodgen.cpp.

{
  DString sect = DString().sprintf("sect%d",s.level());
  openItem(sect);
  //m_output.addFieldQuotedString("title", s.title());
  if (s.title())
  {
    std::visit(*this,*s.title());
  }
  openSubBlock("content");
  visitChildren(s);
  closeSubBlock();
  closeItem();
}

References closeItem(), closeSubBlock(), DocSection::level(), openItem(), openSubBlock(), DString::sprintf(), DocSection::title(), and visitChildren().

operator()() [45/59]

void PerlModDocVisitor::operator()

(

const DocSeparator &

)

Definition at line 1240 of file perlmodgen.cpp.

{
}

operator()() [46/59]

void PerlModDocVisitor::operator()

(

const DocSimpleList &

l

)

Definition at line 875 of file perlmodgen.cpp.

{
  openItem("list");
  m_output.addFieldQuotedString("style", "itemized");
  openSubBlock("content");
  visitChildren(l);
  closeSubBlock();
  closeItem();
}

References PerlModOutput::addFieldQuotedString(), closeItem(), closeSubBlock(), m_output, openItem(), openSubBlock(), and visitChildren().

operator()() [47/59]

void PerlModDocVisitor::operator()

(

const DocSimpleListItem &

li

)

Definition at line 885 of file perlmodgen.cpp.

{
  openSubBlock();
  if (li.paragraph())
  {
    std::visit(*this,*li.paragraph());
  }
  closeSubBlock();
}

References closeSubBlock(), openSubBlock(), and DocSimpleListItem::paragraph().

operator()() [48/59]

void PerlModDocVisitor::operator()

(

const DocSimpleSect &

s

)

Definition at line 825 of file perlmodgen.cpp.

{
  const char *type = nullptr;
  switch (s.type())
  {
  case DocSimpleSect::See:       type = "see"; break;
  case DocSimpleSect::Return:    type = "return"; break;
  case DocSimpleSect::Author:    type = "author"; break;
  case DocSimpleSect::Authors:   type = "authors"; break;
  case DocSimpleSect::Version:   type = "version"; break;
  case DocSimpleSect::Since:     type = "since"; break;
  case DocSimpleSect::Date:      type = "date"; break;
  case DocSimpleSect::Note:      type = "note"; break;
  case DocSimpleSect::Warning:   type = "warning"; break;
  case DocSimpleSect::Pre:       type = "pre"; break;
  case DocSimpleSect::Post:      type = "post"; break;
  case DocSimpleSect::Copyright: type = "copyright"; break;
  case DocSimpleSect::Invar:     type = "invariant"; break;
  case DocSimpleSect::Remark:    type = "remark"; break;
  case DocSimpleSect::Attention: type = "attention"; break;
  case DocSimpleSect::Important: type = "important"; break;
  case DocSimpleSect::User:      type = "par"; break;
  case DocSimpleSect::Rcs:       type = "rcs"; break;
  case DocSimpleSect::Unknown:
    err("unknown simple section found\n");
    break;
  }
  leaveText();
  m_output.openHash();
  //openOther();
  openSubBlock(type);
  if (s.title())
  {
    std::visit(*this,*s.title());
  }
  visitChildren(s);
  closeSubBlock();
  //closeOther();
  m_output.closeHash();
}

References DocSimpleSect::Attention, DocSimpleSect::Author, DocSimpleSect::Authors, PerlModOutput::closeHash(), closeSubBlock(), DocSimpleSect::Copyright, DocSimpleSect::Date, err, DocSimpleSect::Important, DocSimpleSect::Invar, leaveText(), m_output, DocSimpleSect::Note, PerlModOutput::openHash(), openSubBlock(), DocSimpleSect::Post, DocSimpleSect::Pre, DocSimpleSect::Rcs, DocSimpleSect::Remark, DocSimpleSect::Return, DocSimpleSect::See, DocSimpleSect::Since, DocSimpleSect::title(), DocSimpleSect::type(), DocSimpleSect::Unknown, DocSimpleSect::User, DocSimpleSect::Version, visitChildren(), and DocSimpleSect::Warning.

operator()() [49/59]

void PerlModDocVisitor::operator()

(

const DocSimpleSectSep &

)

Definition at line 746 of file perlmodgen.cpp.

{
}

operator()() [50/59]

void PerlModDocVisitor::operator()

(

const DocStyleChange &

s

)

Definition at line 600 of file perlmodgen.cpp.

{
  const char *style = nullptr;
  switch (s.style())
  {
    case DocStyleChange::Bold:          style = "bold"; break;
    case DocStyleChange::S:             style = "s"; break;
    case DocStyleChange::Strike:        style = "strike"; break;
    case DocStyleChange::Del:           style = "del"; break;
    case DocStyleChange::Underline:     style = "underline"; break;
    case DocStyleChange::Ins:           style = "ins"; break;
    case DocStyleChange::Italic:        style = "italic"; break;
    case DocStyleChange::Code:          style = "code"; break;
    case DocStyleChange::Subscript:     style = "subscript"; break;
    case DocStyleChange::Superscript:   style = "superscript"; break;
    case DocStyleChange::Center:        style = "center"; break;
    case DocStyleChange::Small:         style = "small"; break;
    case DocStyleChange::Cite:          style = "cite"; break;
    case DocStyleChange::Preformatted:  style = "preformatted"; break;
    case DocStyleChange::Div:           style = "div"; break;
    case DocStyleChange::Span:          style = "span"; break;
    case DocStyleChange::Kbd:           style = "kbd"; break;
    case DocStyleChange::Typewriter:    style = "typewriter"; break;
  }
  openItem("style");
  m_output.addFieldQuotedString("style", style)
    .addFieldBoolean("enable", s.enable());
  closeItem();
}

References PerlModOutput::addFieldBoolean(), PerlModOutput::addFieldQuotedString(), DocStyleChange::Bold, DocStyleChange::Center, DocStyleChange::Cite, closeItem(), DocStyleChange::Code, DocStyleChange::Del, DocStyleChange::Div, DocStyleChange::enable(), DocStyleChange::Ins, DocStyleChange::Italic, DocStyleChange::Kbd, m_output, openItem(), 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 PerlModDocVisitor::operator()

(

const DocSymbol &

sy

)

Definition at line 499 of file perlmodgen.cpp.

{
  const HtmlEntityMapper::PerlSymb *res = HtmlEntityMapper::instance().perl(sy.symbol());
  const char *accent=nullptr;
  if (res->symb)
  {
    switch (res->type)
    {
      case HtmlEntityMapper::Perl_string:
        enterText();
        m_output.add(res->symb);
        break;
      case HtmlEntityMapper::Perl_char:
        enterText();
        m_output.add(res->symb[0]);
        break;
      case HtmlEntityMapper::Perl_symbol:
        leaveText();
        openItem("symbol");
        m_output.addFieldQuotedString("symbol", res->symb);
        closeItem();
        break;
      default:
        switch(res->type)
        {
          case HtmlEntityMapper::Perl_umlaut:
            accent = "umlaut";
            break;
          case HtmlEntityMapper::Perl_acute:
            accent = "acute";
            break;
          case HtmlEntityMapper::Perl_grave:
            accent = "grave";
            break;
          case HtmlEntityMapper::Perl_circ:
            accent = "circ";
            break;
          case HtmlEntityMapper::Perl_slash:
            accent = "slash";
            break;
          case HtmlEntityMapper::Perl_tilde:
            accent = "tilde";
            break;
          case HtmlEntityMapper::Perl_cedilla:
            accent = "cedilla";
            break;
          case HtmlEntityMapper::Perl_ring:
            accent = "ring";
            break;
          default:
            break;
        }
        leaveText();
        if (accent)
        {
          openItem("accent");
          m_output
            .addFieldQuotedString("accent", accent)
            .addFieldQuotedChar("letter", res->symb[0]);
          closeItem();
        }
        break;
    }
  }
  else
  {
    err("perl: non supported HTML-entity found: {}\n",HtmlEntityMapper::instance().html(sy.symbol(),true));
  }
}

References PerlModOutput::add(), PerlModOutput::addFieldQuotedChar(), PerlModOutput::addFieldQuotedString(), closeItem(), enterText(), err, HtmlEntityMapper::instance(), leaveText(), m_output, openItem(), HtmlEntityMapper::perl(), HtmlEntityMapper::Perl_acute, HtmlEntityMapper::Perl_cedilla, HtmlEntityMapper::Perl_char, HtmlEntityMapper::Perl_circ, HtmlEntityMapper::Perl_grave, HtmlEntityMapper::Perl_ring, HtmlEntityMapper::Perl_slash, HtmlEntityMapper::Perl_string, HtmlEntityMapper::Perl_symbol, HtmlEntityMapper::Perl_tilde, HtmlEntityMapper::Perl_umlaut, HtmlEntityMapper::PerlSymb::symb, DocSymbol::symbol(), and HtmlEntityMapper::PerlSymb::type.

operator()() [52/59]

void PerlModDocVisitor::operator()

(

const DocText &

t

)

Definition at line 1332 of file perlmodgen.cpp.

{
  visitChildren(t);
}

References visitChildren().

operator()() [53/59]

void PerlModDocVisitor::operator()

(

const DocTitle &

t

)

Definition at line 866 of file perlmodgen.cpp.

{
  openItem("title");
  openSubBlock("content");
  visitChildren(t);
  closeSubBlock();
  closeItem();
}

References closeItem(), closeSubBlock(), openItem(), openSubBlock(), and visitChildren().

operator()() [54/59]

void PerlModDocVisitor::operator()

(

const DocURL &

u

)

Definition at line 583 of file perlmodgen.cpp.

{
  openItem("url");
  m_output.addFieldQuotedString("content", u.url());
  closeItem();
}

References PerlModOutput::addFieldQuotedString(), closeItem(), m_output, openItem(), and DocURL::url().

operator()() [55/59]

void PerlModDocVisitor::operator()

(

const DocVerbatim &

s

)

Definition at line 630 of file perlmodgen.cpp.

{
  const char *type = nullptr;
  switch (s.type())
  {
    case DocVerbatim::Code:
#if 0
      m_output.add("<programlisting>");
      parseCode(m_ci,s->context(),s->text(),false,0);
      m_output.add("</programlisting>");
      return;
#endif
    case DocVerbatim::JavaDocCode:
    case DocVerbatim::JavaDocLiteral:
    case DocVerbatim::Verbatim:  type = "preformatted"; break;
    case DocVerbatim::HtmlOnly:  type = "htmlonly";     break;
    case DocVerbatim::RtfOnly:   type = "rtfonly";      break;
    case DocVerbatim::ManOnly:   type = "manonly";      break;
    case DocVerbatim::LatexOnly: type = "latexonly";    break;
    case DocVerbatim::XmlOnly:   type = "xmlonly";      break;
    case DocVerbatim::DocbookOnly: type = "docbookonly"; break;
    case DocVerbatim::Dot:       type = "dot";          break;
    case DocVerbatim::Msc:       type = "msc";          break;
    case DocVerbatim::PlantUML:  type = "plantuml";     break;
    case DocVerbatim::Mermaid:   type = "mermaid";      break;
  }
  openItem(type);
  if (s.hasCaption())
  {
     openSubBlock("caption");
     visitChildren(s);
     closeSubBlock();
  }
  m_output.addFieldQuotedString("content", s.text());
  closeItem();
}

References PerlModOutput::add(), PerlModOutput::addFieldQuotedString(), closeItem(), closeSubBlock(), DocVerbatim::Code, DocVerbatim::context(), DocVerbatim::DocbookOnly, DocVerbatim::Dot, DocVerbatim::hasCaption(), DocVerbatim::HtmlOnly, DocVerbatim::JavaDocCode, DocVerbatim::JavaDocLiteral, DocVerbatim::LatexOnly, m_output, DocVerbatim::ManOnly, DocVerbatim::Mermaid, DocVerbatim::Msc, openItem(), openSubBlock(), DocVerbatim::PlantUML, DocVerbatim::RtfOnly, DocVerbatim::text(), DocVerbatim::type(), DocVerbatim::Verbatim, visitChildren(), and DocVerbatim::XmlOnly.

operator()() [56/59]

void PerlModDocVisitor::operator()

(

const DocVhdlFlow &

)

Definition at line 1346 of file perlmodgen.cpp.

{
}

operator()() [57/59]

void PerlModDocVisitor::operator()

(

const DocWhiteSpace &

)

Definition at line 493 of file perlmodgen.cpp.

{
  enterText();
  m_output.add(' ');
}

References PerlModOutput::add(), enterText(), and m_output.

operator()() [58/59]

void PerlModDocVisitor::operator()

(

const DocWord &

w

)

Definition at line 479 of file perlmodgen.cpp.

{
  enterText();
  m_output.addQuoted(w.word());
}

References PerlModOutput::addQuoted(), enterText(), m_output, and DocWord::word().

operator()() [59/59]

void PerlModDocVisitor::operator()

(

const DocXRefItem &

x

)

Definition at line 1298 of file perlmodgen.cpp.

{
#if 0
  m_output.add("<xrefsect id=\"");
  m_output.add(x->file()); m_output.add("_1"); m_output.add(x->anchor());
  m_output.add("\">");
  m_output.add("<xreftitle>");
  m_output.addQuoted(x->title());
  m_output.add("</xreftitle>");
  m_output.add("<xrefdescription>");
#endif
  if (x.title().empty()) return;
  openItem("xrefitem");
  openSubBlock("content");
  visitChildren(x);
  if (x.title().empty()) return;
  closeSubBlock();
  closeItem();
#if 0
  m_output.add("</xrefdescription>");
  m_output.add("</xrefsect>");
#endif
}

References PerlModOutput::add(), PerlModOutput::addQuoted(), DocXRefItem::anchor(), closeItem(), closeSubBlock(), DString::empty(), DocXRefItem::file(), m_output, openItem(), openSubBlock(), DocXRefItem::title(), and visitChildren().

singleItem()

void PerlModDocVisitor::singleItem ( const DString & name )

private

Definition at line 438 of file perlmodgen.cpp.

{
  openItem(name);
  closeItem();
}

References closeItem(), and openItem().

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

visitChildren()

template<class T>

void PerlModDocVisitor::visitChildren ( const T & t )

inlineprivate

Definition at line 352 of file perlmodgen.cpp.

    {
      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()().

Member Data Documentation

m_other

DString PerlModDocVisitor::m_other

private

Definition at line 383 of file perlmodgen.cpp.

Referenced by finish().

m_output

PerlModOutput& PerlModDocVisitor::m_output

private

Definition at line 380 of file perlmodgen.cpp.

Referenced by addLink(), closeItem(), closeSubBlock(), enterText(), finish(), leaveText(), openItem(), openSubBlock(), 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 PerlModDocVisitor().

m_textblockstart

bool PerlModDocVisitor::m_textblockstart

private

Definition at line 382 of file perlmodgen.cpp.

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

m_textmode

bool PerlModDocVisitor::m_textmode

private

Definition at line 381 of file perlmodgen.cpp.

Referenced by enterText(), leaveText(), and PerlModDocVisitor().

---

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

• src/perlmodgen.cpp