Skip to main content

The XmlDocVisitor Class Reference

Concrete visitor implementation for XML output. More...

Declaration​

class XmlDocVisitor { ... }

Included Headers​

#include <src/xmldocvisitor.h>

Base class​

classDocVisitor

Helper base class for functionality shared by all visitors. More...

Public Constructors Index​

XmlDocVisitor (TextStream &t, OutputCodeList &ci, const QCString &langExt)

Public Operators Index​

voidoperator() (const DocWord &)
voidoperator() (const DocLinkedWord &)
voidoperator() (const DocWhiteSpace &)
voidoperator() (const DocSymbol &)
voidoperator() (const DocEmoji &)
voidoperator() (const DocURL &)
voidoperator() (const DocLineBreak &)
voidoperator() (const DocHorRuler &)
voidoperator() (const DocStyleChange &)
voidoperator() (const DocVerbatim &)
voidoperator() (const DocAnchor &)
voidoperator() (const DocInclude &)
voidoperator() (const DocIncOperator &)
voidoperator() (const DocFormula &)
voidoperator() (const DocIndexEntry &)
voidoperator() (const DocSimpleSectSep &)
voidoperator() (const DocCite &)
voidoperator() (const DocSeparator &)
voidoperator() (const DocAutoList &)
voidoperator() (const DocAutoListItem &)
voidoperator() (const DocPara &)
voidoperator() (const DocRoot &)
voidoperator() (const DocSimpleSect &)
voidoperator() (const DocTitle &)
voidoperator() (const DocSimpleList &)
voidoperator() (const DocSimpleListItem &)
voidoperator() (const DocSection &)
voidoperator() (const DocHtmlList &)
voidoperator() (const DocHtmlListItem &)
voidoperator() (const DocHtmlDescList &)
voidoperator() (const DocHtmlDescTitle &)
voidoperator() (const DocHtmlDescData &)
voidoperator() (const DocHtmlTable &)
voidoperator() (const DocHtmlRow &)
voidoperator() (const DocHtmlCell &)
voidoperator() (const DocHtmlCaption &)
voidoperator() (const DocInternal &)
voidoperator() (const DocHRef &)
voidoperator() (const DocHtmlSummary &)
voidoperator() (const DocHtmlDetails &)
voidoperator() (const DocHtmlHeader &)
voidoperator() (const DocImage &)
voidoperator() (const DocDotFile &)
voidoperator() (const DocMscFile &)
voidoperator() (const DocDiaFile &)
voidoperator() (const DocPlantUmlFile &)
voidoperator() (const DocLink &)
voidoperator() (const DocRef &)
voidoperator() (const DocSecRefItem &)
voidoperator() (const DocSecRefList &)
voidoperator() (const DocParamSect &)
voidoperator() (const DocParamList &)
voidoperator() (const DocXRefItem &)
voidoperator() (const DocInternalRef &)
voidoperator() (const DocText &)
voidoperator() (const DocHtmlBlockQuote &)
voidoperator() (const DocVhdlFlow &)
voidoperator() (const DocParBlock &)

Private Member Functions Index​

template <class T>
voidvisitChildren (const T &t)
voidfilter (const QCString &str)
voidstartLink (const QCString &ref, const QCString &file, const QCString &anchor)
voidendLink ()

Private Member Attributes Index​

TextStream &m_t
OutputCodeList &m_ci
boolm_insidePre = false
boolm_hide = false
QCStringm_langExt
intm_sectionLevel

Description​

Concrete visitor implementation for XML output.

Definition at line 33 of file xmldocvisitor.h.

Public Constructors​

XmlDocVisitor()​

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

Declaration at line 36 of file xmldocvisitor.h, definition at line 151 of file xmldocvisitor.cpp.

151XmlDocVisitor::XmlDocVisitor(TextStream &t,OutputCodeList &ci,const QCString &langExt)
152 : m_t(t), m_ci(ci), m_insidePre(FALSE), m_hide(FALSE),
153 m_langExt(langExt), m_sectionLevel(0)
154{
155}

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

Public Operators​

operator()()​

void XmlDocVisitor::operator() (const DocWord & w)

Declaration at line 42 of file xmldocvisitor.h, definition at line 161 of file xmldocvisitor.cpp.

161void XmlDocVisitor::operator()(const DocWord &w)
162{
163 if (m_hide) return;
164 filter(w.word());
165}

References filter, m_hide and DocWord::word.

operator()()​

void XmlDocVisitor::operator() (const DocLinkedWord & w)

Declaration at line 43 of file xmldocvisitor.h, definition at line 167 of file xmldocvisitor.cpp.

167void XmlDocVisitor::operator()(const DocLinkedWord &w)
168{
169 if (m_hide) return;
170 startLink(w.ref(),w.file(),w.anchor());
171 filter(w.word());
172 endLink();
173}

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

operator()()​

void XmlDocVisitor::operator() (const DocWhiteSpace & w)

Declaration at line 44 of file xmldocvisitor.h, definition at line 175 of file xmldocvisitor.cpp.

175void XmlDocVisitor::operator()(const DocWhiteSpace &w)
176{
177 if (m_hide) return;
178 if (m_insidePre)
179 {
180 m_t << w.chars();
181 }
182 else
183 {
184 m_t << " ";
185 }
186}

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

operator()()​

void XmlDocVisitor::operator() (const DocSymbol & s)

Declaration at line 45 of file xmldocvisitor.h, definition at line 188 of file xmldocvisitor.cpp.

188void XmlDocVisitor::operator()(const DocSymbol &s)
189{
190 if (m_hide) return;
191 const char *res = HtmlEntityMapper::instance().xml(s.symbol());
192 if (res)
193 {
194 m_t << res;
195 }
196 else
197 {
198 err("XML: non supported HTML-entity found: {}\n",HtmlEntityMapper::instance().html(s.symbol(),TRUE));
199 }
200}

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

operator()()​

void XmlDocVisitor::operator() (const DocEmoji & s)

Declaration at line 46 of file xmldocvisitor.h, definition at line 202 of file xmldocvisitor.cpp.

202void XmlDocVisitor::operator()(const DocEmoji &s)
203{
204 if (m_hide) return;
205 const char *res = EmojiEntityMapper::instance().name(s.index());
206 if (res)
207 {
208 QCString name=res;
209 name = name.mid(1,name.length()-2);
210 m_t << "<emoji name=\"" << name << "\" unicode=\"";
211 filter(EmojiEntityMapper::instance().unicode(s.index()));
212 m_t << "\"/>";
213 }
214 else
215 {
216 m_t << s.name();
217 }
218}

References filter, DocEmoji::index, EmojiEntityMapper::instance, QCString::length, m_hide, m_t, QCString::mid, DocEmoji::name and EmojiEntityMapper::name.

operator()()​

void XmlDocVisitor::operator() (const DocURL & u)

Declaration at line 47 of file xmldocvisitor.h, definition at line 220 of file xmldocvisitor.cpp.

220void XmlDocVisitor::operator()(const DocURL &u)
221{
222 if (m_hide) return;
223 m_t << "<ulink url=\"";
224 if (u.isEmail()) m_t << "mailto:";
225 filter(u.url());
226 m_t << "\">";
227 filter(u.url());
228 m_t << "</ulink>";
229}

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

operator()()​

void XmlDocVisitor::operator() (const DocLineBreak &)

Declaration at line 48 of file xmldocvisitor.h, definition at line 231 of file xmldocvisitor.cpp.

231void XmlDocVisitor::operator()(const DocLineBreak &)
232{
233 if (m_hide) return;
234 m_t << "<linebreak/>\n";
235}

References m_hide and m_t.

operator()()​

void XmlDocVisitor::operator() (const DocHorRuler &)

Declaration at line 49 of file xmldocvisitor.h, definition at line 237 of file xmldocvisitor.cpp.

237void XmlDocVisitor::operator()(const DocHorRuler &)
238{
239 if (m_hide) return;
240 m_t << "<hruler/>\n";
241}

References m_hide and m_t.

operator()()​

void XmlDocVisitor::operator() (const DocStyleChange & s)

Declaration at line 50 of file xmldocvisitor.h, definition at line 243 of file xmldocvisitor.cpp.

243void XmlDocVisitor::operator()(const DocStyleChange &s)
244{
245 if (m_hide) return;
246 switch (s.style())
247 {
248 case DocStyleChange::Bold:
249 if (s.enable()) m_t << "<bold>"; else m_t << "</bold>";
250 break;
251 case DocStyleChange::S:
252 if (s.enable()) m_t << "<s>"; else m_t << "</s>";
253 break;
254 case DocStyleChange::Strike:
255 if (s.enable()) m_t << "<strike>"; else m_t << "</strike>";
256 break;
257 case DocStyleChange::Del:
258 if (s.enable()) m_t << "<del>"; else m_t << "</del>";
259 break;
260 case DocStyleChange::Underline:
261 if (s.enable()) m_t << "<underline>"; else m_t << "</underline>";
262 break;
263 case DocStyleChange::Ins:
264 if (s.enable()) m_t << "<ins>"; else m_t << "</ins>";
265 break;
266 case DocStyleChange::Italic:
267 if (s.enable()) m_t << "<emphasis>"; else m_t << "</emphasis>";
268 break;
269 case DocStyleChange::Kbd:
270 case DocStyleChange::Typewriter:
271 case DocStyleChange::Code:
272 if (s.enable()) m_t << "<computeroutput>"; else m_t << "</computeroutput>";
273 break;
274 case DocStyleChange::Subscript:
275 if (s.enable()) m_t << "<subscript>"; else m_t << "</subscript>";
276 break;
277 case DocStyleChange::Superscript:
278 if (s.enable()) m_t << "<superscript>"; else m_t << "</superscript>";
279 break;
280 case DocStyleChange::Center:
281 if (s.enable()) m_t << "<center>"; else m_t << "</center>";
282 break;
283 case DocStyleChange::Small:
284 if (s.enable()) m_t << "<small>"; else m_t << "</small>";
285 break;
286 case DocStyleChange::Cite:
287 if (s.enable()) m_t << "<cite>"; else m_t << "</cite>";
288 break;
289 case DocStyleChange::Preformatted:
290 if (s.enable())
291 {
292 m_t << "<preformatted>";
293 m_insidePre=TRUE;
294 }
295 else
296 {
297 m_t << "</preformatted>";
298 m_insidePre=FALSE;
299 }
300 break;
301 case DocStyleChange::Div: /* HTML only */ break;
302 case DocStyleChange::Span: /* HTML only */ break;
303 }
304}

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

operator()()​

void XmlDocVisitor::operator() (const DocVerbatim & s)

Declaration at line 51 of file xmldocvisitor.h, definition at line 306 of file xmldocvisitor.cpp.

306void XmlDocVisitor::operator()(const DocVerbatim &s)
307{
308 if (m_hide) return;
309 QCString lang = m_langExt;
310 if (!s.language().isEmpty()) // explicit language setting
311 {
312 lang = s.language();
313 }
314 SrcLangExt langExt = getLanguageFromCodeLang(lang);
315 switch(s.type())
316 {
317 case DocVerbatim::Code:
318 m_t << "<programlisting";
319 if (!s.language().isEmpty())
320 m_t << " filename=\"" << lang << "\">";
321 else
322 m_t << ">";
323 getCodeParser(lang).parseCode(m_ci,s.context(),s.text(),langExt,
324 Config_getBool(STRIP_CODE_COMMENTS),
325 s.isExample(),s.exampleFile());
326 m_t << "</programlisting>";
327 break;
328 case DocVerbatim::JavaDocLiteral:
329 m_t << "<javadocliteral>";
330 filter(s.text());
331 m_t << "</javadocliteral>";
332 break;
333 case DocVerbatim::JavaDocCode:
334 m_t << "<javadoccode>";
335 filter(s.text());
336 m_t << "</javadoccode>";
337 break;
338 case DocVerbatim::Verbatim:
339 m_t << "<verbatim>";
340 filter(s.text());
341 m_t << "</verbatim>";
342 break;
343 case DocVerbatim::HtmlOnly:
344 if (s.isBlock())
345 {
346 m_t << "<htmlonly block=\"yes\">";
347 }
348 else
349 {
350 m_t << "<htmlonly>";
351 }
352 filter(s.text());
353 m_t << "</htmlonly>";
354 break;
355 case DocVerbatim::RtfOnly:
356 m_t << "<rtfonly>";
357 filter(s.text());
358 m_t << "</rtfonly>";
359 break;
360 case DocVerbatim::ManOnly:
361 m_t << "<manonly>";
362 filter(s.text());
363 m_t << "</manonly>";
364 break;
365 case DocVerbatim::LatexOnly:
366 m_t << "<latexonly>";
367 filter(s.text());
368 m_t << "</latexonly>";
369 break;
370 case DocVerbatim::DocbookOnly:
371 m_t << "<docbookonly>";
372 filter(s.text());
373 m_t << "</docbookonly>";
374 break;
375 case DocVerbatim::XmlOnly:
376 m_t << s.text();
377 break;
378 case DocVerbatim::Dot:
379 visitPreStart(m_t, "dot", s.hasCaption(), *this, s.children(), QCString(""), FALSE, DocImage::Html, s.width(), s.height());
380 filter(s.text());
381 visitPostEnd(m_t, "dot");
382 break;
383 case DocVerbatim::Msc:
384 visitPreStart(m_t, "msc", s.hasCaption(), *this, s.children(), QCString(""), FALSE, DocImage::Html, s.width(), s.height());
385 filter(s.text());
386 visitPostEnd(m_t, "msc");
387 break;
388 case DocVerbatim::PlantUML:
389 visitPreStart(m_t, "plantuml", s.hasCaption(), *this, s.children(), QCString(""), FALSE, DocImage::Html, s.width(), s.height(), s.engine());
390 filter(s.text());
391 visitPostEnd(m_t, "plantuml");
392 break;
393 }
394}

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

operator()()​

void XmlDocVisitor::operator() (const DocAnchor & anc)

Declaration at line 52 of file xmldocvisitor.h, definition at line 396 of file xmldocvisitor.cpp.

396void XmlDocVisitor::operator()(const DocAnchor &anc)
397{
398 if (m_hide) return;
399 m_t << "<anchor id=\"" << anc.file() << "_1" << anc.anchor() << "\"/>";
400}

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

operator()()​

void XmlDocVisitor::operator() (const DocInclude & inc)

Declaration at line 53 of file xmldocvisitor.h, definition at line 402 of file xmldocvisitor.cpp.

402void XmlDocVisitor::operator()(const DocInclude &inc)
403{
404 if (m_hide) return;
405 SrcLangExt langExt = getLanguageFromFileName(inc.extension());
406 //printf("XMLDocVisitor: DocInclude type=%d trimleft=%d\n",inc.type(),inc.trimLeft());
407 switch(inc.type())
408 {
409 case DocInclude::IncWithLines:
410 {
411 m_t << "<programlisting filename=\"" << inc.file() << "\">";
412 FileInfo cfi( inc.file().str() );
413 auto fd = createFileDef( cfi.dirPath(), cfi.fileName());
414 getCodeParser(inc.extension()).parseCode(m_ci,inc.context(),
415 inc.text(),
416 langExt,
417 inc.stripCodeComments(),
418 inc.isExample(),
419 inc.exampleFile(),
420 fd.get(), // fileDef,
421 -1, // start line
422 -1, // end line
423 FALSE, // inline fragment
424 nullptr, // memberDef
425 TRUE // show line numbers
426 );
427 m_t << "</programlisting>";
428 }
429 break;
430 case DocInclude::Include:
431 m_t << "<programlisting filename=\"" << inc.file() << "\">";
432 getCodeParser(inc.extension()).parseCode(m_ci,inc.context(),
433 inc.text(),
434 langExt,
435 inc.stripCodeComments(),
436 inc.isExample(),
437 inc.exampleFile(),
438 nullptr, // fileDef
439 -1, // startLine
440 -1, // endLine
441 TRUE, // inlineFragment
442 nullptr, // memberDef
443 FALSE // show line numbers
444 );
445 m_t << "</programlisting>";
446 break;
447 case DocInclude::DontInclude:
448 case DocInclude::DontIncWithLines:
449 break;
450 case DocInclude::HtmlInclude:
451 if (inc.isBlock())
452 {
453 m_t << "<htmlonly block=\"yes\">";
454 }
455 else
456 {
457 m_t << "<htmlonly>";
458 }
459 filter(inc.text());
460 m_t << "</htmlonly>";
461 break;
462 case DocInclude::LatexInclude:
463 m_t << "<latexonly>";
464 filter(inc.text());
465 m_t << "</latexonly>";
466 break;
467 case DocInclude::RtfInclude:
468 m_t << "<rtfonly>";
469 filter(inc.text());
470 m_t << "</rtfonly>";
471 break;
472 case DocInclude::ManInclude:
473 m_t << "<manonly>";
474 filter(inc.text());
475 m_t << "</manonly>";
476 break;
477 case DocInclude::XmlInclude:
478 filter(inc.text());
479 break;
480 case DocInclude::DocbookInclude:
481 m_t << "<docbookonly>";
482 filter(inc.text());
483 m_t << "</docbookonly>";
484 break;
485 case DocInclude::VerbInclude:
486 m_t << "<verbatim>";
487 filter(inc.text());
488 m_t << "</verbatim>";
489 break;
490 case DocInclude::Snippet:
491 case DocInclude::SnippetWithLines:
492 m_t << "<programlisting filename=\"" << inc.file() << "\">";
493 CodeFragmentManager::instance().parseCodeFragment(m_ci,
494 inc.file(),
495 inc.blockId(),
496 inc.context(),
497 inc.type()==DocInclude::SnippetWithLines,
498 inc.trimLeft(),
499 inc.stripCodeComments()
500 );
501 m_t << "</programlisting>";
502 break;
503 }
504}

References DocInclude::blockId, DocInclude::context, createFileDef, FileInfo::dirPath, DocInclude::DocbookInclude, DocInclude::DontInclude, DocInclude::DontIncWithLines, DocInclude::exampleFile, DocInclude::extension, FALSE, 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, DocInclude::Snippet, DocInclude::SnippetWithLines, QCString::str, DocInclude::stripCodeComments, DocInclude::text, DocInclude::trimLeft, TRUE, DocInclude::type, DocInclude::VerbInclude and DocInclude::XmlInclude.

operator()()​

void XmlDocVisitor::operator() (const DocIncOperator & op)

Declaration at line 54 of file xmldocvisitor.h, definition at line 506 of file xmldocvisitor.cpp.

506void XmlDocVisitor::operator()(const DocIncOperator &op)
507{
508 //printf("DocIncOperator: type=%d first=%d, last=%d text='%s'\n",
509 // op.type(),op.isFirst(),op.isLast(),qPrint(op.text()));
510 if (op.isFirst())
511 {
512 if (!m_hide)
513 {
514 m_t << "<programlisting filename=\"" << op.includeFileName() << "\">";
515 }
516 pushHidden(m_hide);
517 m_hide = TRUE;
518 }
519 QCString locLangExt = getFileNameExtension(op.includeFileName());
520 if (locLangExt.isEmpty()) locLangExt = m_langExt;
521 SrcLangExt langExt = getLanguageFromFileName(locLangExt);
522 if (op.type()!=DocIncOperator::Skip)
523 {
524 m_hide = popHidden();
525 if (!m_hide)
526 {
527 std::unique_ptr<FileDef> fd;
528 if (!op.includeFileName().isEmpty())
529 {
530 FileInfo cfi( op.includeFileName().str() );
531 fd = createFileDef( cfi.dirPath(), cfi.fileName() );
532 }
533
534 getCodeParser(locLangExt).parseCode(m_ci,op.context(),
535 op.text(),langExt,
536 op.stripCodeComments(),
537 op.isExample(),
538 op.exampleFile(),
539 fd.get(), // fileDef
540 op.line(), // startLine
541 -1, // endLine
542 FALSE, // inline fragment
543 nullptr, // memberDef
544 op.showLineNo() // show line numbers
545 );
546 }
547 pushHidden(m_hide);
548 m_hide=TRUE;
549 }
550 if (op.isLast())
551 {
552 m_hide = popHidden();
553 if (!m_hide) m_t << "</programlisting>";
554 }
555 else
556 {
557 if (!m_hide) m_t << "\n";
558 }
559}

References DocIncOperator::context, createFileDef, FileInfo::dirPath, DocIncOperator::exampleFile, FALSE, FileInfo::fileName, DocVisitor::getCodeParser, getFileNameExtension, getLanguageFromFileName, DocIncOperator::includeFileName, QCString::isEmpty, DocIncOperator::isExample, DocIncOperator::isFirst, DocIncOperator::isLast, DocIncOperator::line, m_ci, m_hide, m_langExt, m_t, CodeParserInterface::parseCode, DocVisitor::popHidden, DocVisitor::pushHidden, DocIncOperator::showLineNo, DocIncOperator::Skip, QCString::str, DocIncOperator::stripCodeComments, DocIncOperator::text, TRUE and DocIncOperator::type.

operator()()​

void XmlDocVisitor::operator() (const DocFormula & f)

Declaration at line 55 of file xmldocvisitor.h, definition at line 561 of file xmldocvisitor.cpp.

561void XmlDocVisitor::operator()(const DocFormula &f)
562{
563 if (m_hide) return;
564 m_t << "<formula id=\"" << f.id() << "\">";
565 filter(f.text());
566 m_t << "</formula>";
567}

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

operator()()​

void XmlDocVisitor::operator() (const DocIndexEntry & ie)

Declaration at line 56 of file xmldocvisitor.h, definition at line 569 of file xmldocvisitor.cpp.

569void XmlDocVisitor::operator()(const DocIndexEntry &ie)
570{
571 if (m_hide) return;
572 m_t << "<indexentry>"
573 "<primaryie>";
574 filter(ie.entry());
575 m_t << "</primaryie>"
576 "<secondaryie></secondaryie>"
577 "</indexentry>";
578}

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

operator()()​

void XmlDocVisitor::operator() (const DocSimpleSectSep & sep)

Declaration at line 57 of file xmldocvisitor.h, definition at line 580 of file xmldocvisitor.cpp.

580void XmlDocVisitor::operator()(const DocSimpleSectSep &sep)
581{
582 const DocSimpleSect *sect = std::get_if<DocSimpleSect>(sep.parent());
583 if (sect)
584 {
585 endSimpleSect(m_t,*sect);
586 startSimpleSect(m_t,*sect);
587 }
588}

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

operator()()​

void XmlDocVisitor::operator() (const DocCite & cite)

Declaration at line 58 of file xmldocvisitor.h, definition at line 590 of file xmldocvisitor.cpp.

590void XmlDocVisitor::operator()(const DocCite &cite)
591{
592 if (m_hide) return;
593 auto opt = cite.option();
594 if (!cite.file().isEmpty())
595 {
596 if (!opt.noCite()) startLink(cite.ref(),cite.file(),cite.anchor());
597
598 filter(cite.getText());
599
600 if (!opt.noCite()) endLink();
601 }
602 else
603 {
604 m_t << "<b>";
605 if (!opt.noPar()) filter("[");
606 filter(cite.target());
607 if (!opt.noPar()) filter("]");
608 m_t << "</b>";
609 }
610}

References DocCite::anchor, endLink, DocCite::file, filter, DocCite::getText, QCString::isEmpty, m_hide, m_t, DocCite::option, DocCite::ref, startLink and DocCite::target.

operator()()​

void XmlDocVisitor::operator() (const DocSeparator &)

Declaration at line 59 of file xmldocvisitor.h, definition at line 1075 of file xmldocvisitor.cpp.

1075void XmlDocVisitor::operator()(const DocSeparator &)
1076{
1077 m_t << "</parametertype>\n";
1078 m_t << "<parametertype>";
1079}

Reference m_t.

operator()()​

void XmlDocVisitor::operator() (const DocAutoList & l)

Declaration at line 65 of file xmldocvisitor.h, definition at line 616 of file xmldocvisitor.cpp.

616void XmlDocVisitor::operator()(const DocAutoList &l)
617{
618 if (m_hide) return;
619 if (l.isEnumList())
620 {
621 m_t << "<orderedlist>\n";
622 }
623 else
624 {
625 m_t << "<itemizedlist>\n";
626 }
627 visitChildren(l);
628 if (l.isEnumList())
629 {
630 m_t << "</orderedlist>\n";
631 }
632 else
633 {
634 m_t << "</itemizedlist>\n";
635 }
636}

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

operator()()​

void XmlDocVisitor::operator() (const DocAutoListItem & li)

Declaration at line 66 of file xmldocvisitor.h, definition at line 638 of file xmldocvisitor.cpp.

638void XmlDocVisitor::operator()(const DocAutoListItem &li)
639{
640 if (m_hide) return;
641 switch (li.itemNumber())
642 {
643 case DocAutoList::Unchecked: // unchecked
644 m_t << "<listitem override=\"unchecked\">";
645 break;
646 case DocAutoList::Checked_x: // checked with x
647 case DocAutoList::Checked_X: // checked with X
648 m_t << "<listitem override=\"checked\">";
649 break;
650 default:
651 m_t << "<listitem>";
652 break;
653 }
654 visitChildren(li);
655 m_t << "</listitem>";
656}

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

operator()()​

void XmlDocVisitor::operator() (const DocPara & p)

Declaration at line 67 of file xmldocvisitor.h, definition at line 658 of file xmldocvisitor.cpp.

658void XmlDocVisitor::operator()(const DocPara &p)
659{
660 if (m_hide) return;
661 m_t << "<para>";
662 visitChildren(p);
663 m_t << "</para>\n";
664}

References m_hide, m_t and visitChildren.

operator()()​

void XmlDocVisitor::operator() (const DocRoot & r)

Declaration at line 68 of file xmldocvisitor.h, definition at line 666 of file xmldocvisitor.cpp.

666void XmlDocVisitor::operator()(const DocRoot &r)
667{
668 visitChildren(r);
669}

Reference visitChildren.

operator()()​

void XmlDocVisitor::operator() (const DocSimpleSect & s)

Declaration at line 69 of file xmldocvisitor.h, definition at line 671 of file xmldocvisitor.cpp.

671void XmlDocVisitor::operator()(const DocSimpleSect &s)
672{
673 if (m_hide) return;
674 startSimpleSect(m_t,s);
675 if (s.title())
676 {
677 std::visit(*this,*s.title());
678 }
679 visitChildren(s);
680 endSimpleSect(m_t,s);
681}

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

operator()()​

void XmlDocVisitor::operator() (const DocTitle & t)

Declaration at line 70 of file xmldocvisitor.h, definition at line 683 of file xmldocvisitor.cpp.

683void XmlDocVisitor::operator()(const DocTitle &t)
684{
685 if (m_hide) return;
686 m_t << "<title>";
687 visitChildren(t);
688 m_t << "</title>";
689}

References m_hide, m_t and visitChildren.

operator()()​

void XmlDocVisitor::operator() (const DocSimpleList & l)

Declaration at line 71 of file xmldocvisitor.h, definition at line 691 of file xmldocvisitor.cpp.

691void XmlDocVisitor::operator()(const DocSimpleList &l)
692{
693 if (m_hide) return;
694 m_t << "<itemizedlist>\n";
695 visitChildren(l);
696 m_t << "</itemizedlist>\n";
697}

References m_hide, m_t and visitChildren.

operator()()​

void XmlDocVisitor::operator() (const DocSimpleListItem & li)

Declaration at line 72 of file xmldocvisitor.h, definition at line 699 of file xmldocvisitor.cpp.

699void XmlDocVisitor::operator()(const DocSimpleListItem &li)
700{
701 if (m_hide) return;
702 m_t << "<listitem>";
703 if (li.paragraph())
704 {
705 std::visit(*this,*li.paragraph());
706 }
707 m_t << "</listitem>\n";
708}

References m_hide, m_t and DocSimpleListItem::paragraph.

operator()()​

void XmlDocVisitor::operator() (const DocSection & s)

Declaration at line 73 of file xmldocvisitor.h, definition at line 710 of file xmldocvisitor.cpp.

710void XmlDocVisitor::operator()(const DocSection &s)
711{
712 if (m_hide) return;
713 int orgSectionLevel = m_sectionLevel;
714 QCString sectId = s.file();
715 if (!s.anchor().isEmpty()) sectId += "_1"+s.anchor();
716 while (m_sectionLevel+1<s.level()) // fix missing intermediate levels
717 {
718 m_sectionLevel++;
719 m_t << "<sect" << m_sectionLevel << " id=\"" << sectId << "_1s" << m_sectionLevel << "\">";
720 }
721 m_sectionLevel++;
722 m_t << "<sect" << s.level() << " id=\"" << sectId << "\">\n";
723 if (s.title())
724 {
725 std::visit(*this,*s.title());
726 }
727 visitChildren(s);
728 m_t << "</sect" << s.level() << ">";
729 m_sectionLevel--;
730 while (orgSectionLevel<m_sectionLevel) // fix missing intermediate levels
731 {
732 m_t << "</sect" << m_sectionLevel << ">";
733 m_sectionLevel--;
734 }
735 m_t << "\n";
736}

References DocSection::anchor, DocSection::file, QCString::isEmpty, DocSection::level, m_hide, m_sectionLevel, m_t, DocSection::title and visitChildren.

operator()()​

void XmlDocVisitor::operator() (const DocHtmlList & s)

Declaration at line 74 of file xmldocvisitor.h, definition at line 738 of file xmldocvisitor.cpp.

738void XmlDocVisitor::operator()(const DocHtmlList &s)
739{
740 if (m_hide) return;
741 if (s.type()==DocHtmlList::Ordered)
742 {
743 m_t << "<orderedlist";
744 for (const auto &opt : s.attribs())
745 {
746 m_t << " " << opt.name << "=\"" << opt.value << "\"";
747 }
748 m_t << ">\n";
749 }
750 else
751 {
752 m_t << "<itemizedlist>\n";
753 }
754 visitChildren(s);
755 if (s.type()==DocHtmlList::Ordered)
756 {
757 m_t << "</orderedlist>\n";
758 }
759 else
760 {
761 m_t << "</itemizedlist>\n";
762 }
763}

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

operator()()​

void XmlDocVisitor::operator() (const DocHtmlListItem & l)

Declaration at line 75 of file xmldocvisitor.h, definition at line 765 of file xmldocvisitor.cpp.

765void XmlDocVisitor::operator()(const DocHtmlListItem &l)
766{
767 if (m_hide) return;
768 m_t << "<listitem";
769 for (const auto &opt : l.attribs())
770 {
771 if (opt.name=="value")
772 {
773 m_t << " " << opt.name << "=\"" << opt.value << "\"";
774 }
775 }
776 m_t << ">\n";
777 visitChildren(l);
778 m_t << "</listitem>\n";
779}

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

operator()()​

void XmlDocVisitor::operator() (const DocHtmlDescList & dl)

Declaration at line 76 of file xmldocvisitor.h, definition at line 781 of file xmldocvisitor.cpp.

781void XmlDocVisitor::operator()(const DocHtmlDescList &dl)
782{
783 if (m_hide) return;
784 m_t << "<variablelist>\n";
785 visitChildren(dl);
786 m_t << "</variablelist>\n";
787}

References m_hide, m_t and visitChildren.

operator()()​

void XmlDocVisitor::operator() (const DocHtmlDescTitle & dt)

Declaration at line 77 of file xmldocvisitor.h, definition at line 789 of file xmldocvisitor.cpp.

789void XmlDocVisitor::operator()(const DocHtmlDescTitle &dt)
790{
791 if (m_hide) return;
792 m_t << "<varlistentry><term>";
793 visitChildren(dt);
794 m_t << "</term></varlistentry>\n";
795}

References m_hide, m_t and visitChildren.

operator()()​

void XmlDocVisitor::operator() (const DocHtmlDescData & dd)

Declaration at line 78 of file xmldocvisitor.h, definition at line 797 of file xmldocvisitor.cpp.

797void XmlDocVisitor::operator()(const DocHtmlDescData &dd)
798{
799 if (m_hide) return;
800 m_t << "<listitem>";
801 visitChildren(dd);
802 m_t << "</listitem>\n";
803}

References m_hide, m_t and visitChildren.

operator()()​

void XmlDocVisitor::operator() (const DocHtmlTable & t)

Declaration at line 79 of file xmldocvisitor.h, definition at line 805 of file xmldocvisitor.cpp.

805void XmlDocVisitor::operator()(const DocHtmlTable &t)
806{
807 if (m_hide) return;
808 m_t << "<table rows=\"" << t.numRows()
809 << "\" cols=\"" << t.numColumns() << "\"" ;
810 for (const auto &opt : t.attribs())
811 {
812 if (opt.name=="width")
813 {
814 m_t << " " << opt.name << "=\"" << opt.value << "\"";
815 }
816 }
817 m_t << ">";
818 if (t.caption())
819 {
820 std::visit(*this,*t.caption());
821 }
822 visitChildren(t);
823 m_t << "</table>\n";
824}

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

operator()()​

void XmlDocVisitor::operator() (const DocHtmlRow & r)

Declaration at line 80 of file xmldocvisitor.h, definition at line 826 of file xmldocvisitor.cpp.

826void XmlDocVisitor::operator()(const DocHtmlRow &r)
827{
828 if (m_hide) return;
829 m_t << "<row>\n";
830 visitChildren(r);
831 m_t << "</row>\n";
832}

References m_hide, m_t and visitChildren.

operator()()​

void XmlDocVisitor::operator() (const DocHtmlCell & c)

Declaration at line 81 of file xmldocvisitor.h, definition at line 834 of file xmldocvisitor.cpp.

834void XmlDocVisitor::operator()(const DocHtmlCell &c)
835{
836 if (m_hide) return;
837 if (c.isHeading()) m_t << "<entry thead=\"yes\""; else m_t << "<entry thead=\"no\"";
838 for (const auto &opt : c.attribs())
839 {
840 if (opt.name=="colspan" || opt.name=="rowspan")
841 {
842 m_t << " " << opt.name << "=\"" << opt.value.toInt() << "\"";
843 }
844 else if (opt.name=="align" &&
845 (opt.value=="right" || opt.value=="left" || opt.value=="center"))
846 {
847 m_t << " align=\"" << opt.value << "\"";
848 }
849 else if (opt.name=="valign" &&
850 (opt.value == "bottom" || opt.value == "top" || opt.value == "middle"))
851 {
852 m_t << " valign=\"" << opt.value << "\"";
853 }
854 else if (opt.name=="width")
855 {
856 m_t << " width=\"" << opt.value << "\"";
857 }
858 else if (opt.name=="class") // handle markdown generated attributes
859 {
860 if (opt.value.startsWith("markdownTable")) // handle markdown generated attributes
861 {
862 if (opt.value.endsWith("Right"))
863 {
864 m_t << " align='right'";
865 }
866 else if (opt.value.endsWith("Left"))
867 {
868 m_t << " align='left'";
869 }
870 else if (opt.value.endsWith("Center"))
871 {
872 m_t << " align='center'";
873 }
874 // skip 'markdownTable*' value ending with "None"
875 }
876 else if (!opt.value.isEmpty())
877 {
878 m_t << " class=\"" << convertToXML(opt.value) << "\"";
879 }
880 }
881 }
882 m_t << ">";
883 visitChildren(c);
884 m_t << "</entry>";
885}

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

operator()()​

void XmlDocVisitor::operator() (const DocHtmlCaption & c)

Declaration at line 82 of file xmldocvisitor.h, definition at line 887 of file xmldocvisitor.cpp.

887void XmlDocVisitor::operator()(const DocHtmlCaption &c)
888{
889 if (m_hide) return;
890 m_t << "<caption";
891 if (!c.file().isEmpty())
892 {
893 m_t << " id=\"" << stripPath(c.file()) << "_1" << c.anchor() << "\"";
894 }
895 m_t << ">";
896 visitChildren(c);
897 m_t << "</caption>\n";
898}

References DocHtmlCaption::anchor, DocHtmlCaption::file, QCString::isEmpty, m_hide, m_t, stripPath and visitChildren.

operator()()​

void XmlDocVisitor::operator() (const DocInternal & i)

Declaration at line 83 of file xmldocvisitor.h, definition at line 900 of file xmldocvisitor.cpp.

900void XmlDocVisitor::operator()(const DocInternal &i)
901{
902 if (m_hide) return;
903 m_t << "<internal>";
904 visitChildren(i);
905 m_t << "</internal>\n";
906}

References m_hide, m_t and visitChildren.

operator()()​

void XmlDocVisitor::operator() (const DocHRef & href)

Declaration at line 84 of file xmldocvisitor.h, definition at line 908 of file xmldocvisitor.cpp.

908void XmlDocVisitor::operator()(const DocHRef &href)
909{
910 if (m_hide) return;
911 m_t << "<ulink url=\"" << convertToXML(href.url(), TRUE) << "\">";
912 visitChildren(href);
913 m_t << "</ulink>";
914}

References convertToXML, m_hide, m_t, TRUE, DocHRef::url and visitChildren.

operator()()​

void XmlDocVisitor::operator() (const DocHtmlSummary & s)

Declaration at line 85 of file xmldocvisitor.h, definition at line 916 of file xmldocvisitor.cpp.

916void XmlDocVisitor::operator()(const DocHtmlSummary &s)
917{
918 if (m_hide) return;
919 m_t << "<summary>";
920 visitChildren(s);
921 m_t << "</summary>";
922}

References m_hide, m_t and visitChildren.

operator()()​

void XmlDocVisitor::operator() (const DocHtmlDetails & d)

Declaration at line 86 of file xmldocvisitor.h, definition at line 924 of file xmldocvisitor.cpp.

924void XmlDocVisitor::operator()(const DocHtmlDetails &d)
925{
926 if (m_hide) return;
927 m_t << "<details>";
928 auto summary = d.summary();
929 if (summary)
930 {
931 std::visit(*this,*summary);
932 }
933 visitChildren(d);
934 m_t << "</details>";
935}

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

operator()()​

void XmlDocVisitor::operator() (const DocHtmlHeader & header)

Declaration at line 87 of file xmldocvisitor.h, definition at line 937 of file xmldocvisitor.cpp.

937void XmlDocVisitor::operator()(const DocHtmlHeader &header)
938{
939 if (m_hide) return;
940 m_t << "<heading level=\"" << header.level() << "\">";
941 visitChildren(header);
942 m_t << "</heading>\n";
943}

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

operator()()​

void XmlDocVisitor::operator() (const DocImage & img)

Declaration at line 88 of file xmldocvisitor.h, definition at line 945 of file xmldocvisitor.cpp.

945void XmlDocVisitor::operator()(const DocImage &img)
946{
947 if (m_hide) return;
948
949 QCString url = img.url();
950 QCString baseName;
951 if (url.isEmpty())
952 {
953 baseName = img.relPath()+img.name();
954 }
955 else
956 {
957 baseName = correctURL(url,img.relPath());
958 }
959 HtmlAttribList attribs = img.attribs();
960 auto it = std::find_if(attribs.begin(),attribs.end(),
961 [](const auto &att) { return att.name=="alt"; });
962 QCString altValue = it!=attribs.end() ? it->value : "";
963 visitPreStart(m_t, "image", FALSE, *this, img.children(), baseName, TRUE,
964 img.type(), img.width(), img.height(), QCString(),
965 altValue, img.isInlineImage());
966
967 // copy the image to the output dir
968 FileDef *fd = nullptr;
969 bool ambig;
970 if (url.isEmpty() && (fd=findFileDef(Doxygen::imageNameLinkedMap,img.name(),ambig)))
971 {
972 copyFile(fd->absFilePath(),Config_getString(XML_OUTPUT)+"/"+baseName);
973 }
974 visitChildren(img);
975 visitPostEnd(m_t, "image");
976}

References FileDef::absFilePath, DocImage::attribs, DocCompoundNode::children, Config_getString, copyFile, correctURL, FALSE, findFileDef, DocImage::height, Doxygen::imageNameLinkedMap, QCString::isEmpty, DocImage::isInlineImage, m_hide, m_t, DocImage::name, DocImage::relPath, TRUE, DocImage::type, DocImage::url, visitChildren, visitPostEnd, visitPreStart and DocImage::width.

operator()()​

void XmlDocVisitor::operator() (const DocDotFile & df)

Declaration at line 89 of file xmldocvisitor.h, definition at line 978 of file xmldocvisitor.cpp.

978void XmlDocVisitor::operator()(const DocDotFile &df)
979{
980 if (m_hide) return;
981 copyFile(df.file(),Config_getString(XML_OUTPUT)+"/"+stripPath(df.file()));
982 visitPreStart(m_t, "dotfile", FALSE, *this, df.children(), stripPath(df.file()), FALSE, DocImage::Html, df.width(), df.height());
983 visitChildren(df);
984 visitPostEnd(m_t, "dotfile");
985}

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

operator()()​

void XmlDocVisitor::operator() (const DocMscFile & df)

Declaration at line 90 of file xmldocvisitor.h, definition at line 987 of file xmldocvisitor.cpp.

987void XmlDocVisitor::operator()(const DocMscFile &df)
988{
989 if (m_hide) return;
990 copyFile(df.file(),Config_getString(XML_OUTPUT)+"/"+stripPath(df.file()));
991 visitPreStart(m_t, "mscfile", FALSE, *this, df.children(), stripPath(df.file()), FALSE, DocImage::Html, df.width(), df.height());
992 visitChildren(df);
993 visitPostEnd(m_t, "mscfile");
994}

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

operator()()​

void XmlDocVisitor::operator() (const DocDiaFile & df)

Declaration at line 91 of file xmldocvisitor.h, definition at line 996 of file xmldocvisitor.cpp.

996void XmlDocVisitor::operator()(const DocDiaFile &df)
997{
998 if (m_hide) return;
999 copyFile(df.file(),Config_getString(XML_OUTPUT)+"/"+stripPath(df.file()));
1000 visitPreStart(m_t, "diafile", FALSE, *this, df.children(), stripPath(df.file()), FALSE, DocImage::Html, df.width(), df.height());
1001 visitChildren(df);
1002 visitPostEnd(m_t, "diafile");
1003}

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

operator()()​

void XmlDocVisitor::operator() (const DocPlantUmlFile & df)

Declaration at line 92 of file xmldocvisitor.h, definition at line 1005 of file xmldocvisitor.cpp.

1005void XmlDocVisitor::operator()(const DocPlantUmlFile &df)
1006{
1007 if (m_hide) return;
1008 copyFile(df.file(),Config_getString(XML_OUTPUT)+"/"+stripPath(df.file()));
1009 visitPreStart(m_t, "plantumlfile", FALSE, *this, df.children(), stripPath(df.file()), FALSE, DocImage::Html, df.width(), df.height());
1010 visitChildren(df);
1011 visitPostEnd(m_t, "plantumlfile");
1012}

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

operator()()​

void XmlDocVisitor::operator() (const DocLink & lnk)

Declaration at line 93 of file xmldocvisitor.h, definition at line 1014 of file xmldocvisitor.cpp.

1014void XmlDocVisitor::operator()(const DocLink &lnk)
1015{
1016 if (m_hide) return;
1017 startLink(lnk.ref(),lnk.file(),lnk.anchor());
1018 visitChildren(lnk);
1019 endLink();
1020}

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

operator()()​

void XmlDocVisitor::operator() (const DocRef & ref)

Declaration at line 94 of file xmldocvisitor.h, definition at line 1022 of file xmldocvisitor.cpp.

1022void XmlDocVisitor::operator()(const DocRef &ref)
1023{
1024 if (m_hide) return;
1025 if (!ref.file().isEmpty())
1026 {
1027 startLink(ref.ref(),ref.file(),ref.isSubPage() ? QCString() : ref.anchor());
1028 }
1029 if (!ref.hasLinkText()) filter(ref.targetTitle());
1030 visitChildren(ref);
1031 if (!ref.file().isEmpty()) endLink();
1032}

References DocRef::anchor, endLink, DocRef::file, filter, DocRef::hasLinkText, QCString::isEmpty, DocRef::isSubPage, m_hide, DocRef::ref, startLink, DocRef::targetTitle and visitChildren.

operator()()​

void XmlDocVisitor::operator() (const DocSecRefItem & ref)

Declaration at line 95 of file xmldocvisitor.h, definition at line 1034 of file xmldocvisitor.cpp.

1034void XmlDocVisitor::operator()(const DocSecRefItem &ref)
1035{
1036 if (m_hide) return;
1037 m_t << "<tocitem id=\"" << ref.file();
1038 if (!ref.anchor().isEmpty()) m_t << "_1" << ref.anchor();
1039 m_t << "\"";
1040 m_t << ">";
1041 visitChildren(ref);
1042 m_t << "</tocitem>\n";
1043}

References DocSecRefItem::anchor, DocSecRefItem::file, QCString::isEmpty, m_hide, m_t and visitChildren.

operator()()​

void XmlDocVisitor::operator() (const DocSecRefList & l)

Declaration at line 96 of file xmldocvisitor.h, definition at line 1045 of file xmldocvisitor.cpp.

1045void XmlDocVisitor::operator()(const DocSecRefList &l)
1046{
1047 if (m_hide) return;
1048 m_t << "<toclist>\n";
1049 visitChildren(l);
1050 m_t << "</toclist>\n";
1051}

References m_hide, m_t and visitChildren.

operator()()​

void XmlDocVisitor::operator() (const DocParamSect & s)

Declaration at line 97 of file xmldocvisitor.h, definition at line 1053 of file xmldocvisitor.cpp.

1053void XmlDocVisitor::operator()(const DocParamSect &s)
1054{
1055 if (m_hide) return;
1056 m_t << "<parameterlist kind=\"";
1057 switch(s.type())
1058 {
1059 case DocParamSect::Param:
1060 m_t << "param"; break;
1061 case DocParamSect::RetVal:
1062 m_t << "retval"; break;
1063 case DocParamSect::Exception:
1064 m_t << "exception"; break;
1065 case DocParamSect::TemplateParam:
1066 m_t << "templateparam"; break;
1067 default:
1068 ASSERT(0);
1069 }
1070 m_t << "\">";
1071 visitChildren(s);
1072 m_t << "</parameterlist>\n";
1073}

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

operator()()​

void XmlDocVisitor::operator() (const DocParamList & pl)

Declaration at line 98 of file xmldocvisitor.h, definition at line 1081 of file xmldocvisitor.cpp.

1081void XmlDocVisitor::operator()(const DocParamList &pl)
1082{
1083 if (m_hide) return;
1084 m_t << "<parameteritem>\n";
1085 m_t << "<parameternamelist>\n";
1086 for (const auto &param : pl.parameters())
1087 {
1088 if (!pl.paramTypes().empty())
1089 {
1090 m_t << "<parametertype>";
1091 for (const auto &type : pl.paramTypes())
1092 {
1093 std::visit(*this,type);
1094 }
1095 m_t << "</parametertype>\n";
1096 }
1097 m_t << "<parametername";
1098 if (pl.direction()!=DocParamSect::Unspecified)
1099 {
1100 m_t << " direction=\"";
1101 if (pl.direction()==DocParamSect::In)
1102 {
1103 m_t << "in";
1104 }
1105 else if (pl.direction()==DocParamSect::Out)
1106 {
1107 m_t << "out";
1108 }
1109 else if (pl.direction()==DocParamSect::InOut)
1110 {
1111 m_t << "inout";
1112 }
1113 m_t << "\"";
1114 }
1115 m_t << ">";
1116 std::visit(*this,param);
1117 m_t << "</parametername>\n";
1118 }
1119 m_t << "</parameternamelist>\n";
1120 m_t << "<parameterdescription>\n";
1121 for (const auto &par : pl.paragraphs())
1122 {
1123 std::visit(*this,par);
1124 }
1125 m_t << "</parameterdescription>\n";
1126 m_t << "</parameteritem>\n";
1127}

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()()​

void XmlDocVisitor::operator() (const DocXRefItem & x)

Declaration at line 99 of file xmldocvisitor.h, definition at line 1129 of file xmldocvisitor.cpp.

1129void XmlDocVisitor::operator()(const DocXRefItem &x)
1130{
1131 if (m_hide) return;
1132 if (x.title().isEmpty()) return;
1133 m_t << "<xrefsect id=\"";
1134 m_t << x.file() << "_1" << x.anchor();
1135 m_t << "\">";
1136 m_t << "<xreftitle>";
1137 filter(x.title());
1138 m_t << "</xreftitle>";
1139 m_t << "<xrefdescription>";
1140 visitChildren(x);
1141 if (x.title().isEmpty()) return;
1142 m_t << "</xrefdescription>";
1143 m_t << "</xrefsect>";
1144}

References DocXRefItem::anchor, DocXRefItem::file, filter, QCString::isEmpty, m_hide, m_t, DocXRefItem::title and visitChildren.

operator()()​

void XmlDocVisitor::operator() (const DocInternalRef & ref)

Declaration at line 100 of file xmldocvisitor.h, definition at line 1146 of file xmldocvisitor.cpp.

1146void XmlDocVisitor::operator()(const DocInternalRef &ref)
1147{
1148 if (m_hide) return;
1149 startLink(QCString(),ref.file(),ref.anchor());
1150 visitChildren(ref);
1151 endLink();
1152 m_t << " ";
1153}

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

operator()()​

void XmlDocVisitor::operator() (const DocText & t)

Declaration at line 101 of file xmldocvisitor.h, definition at line 1155 of file xmldocvisitor.cpp.

1155void XmlDocVisitor::operator()(const DocText &t)
1156{
1157 visitChildren(t);
1158}

Reference visitChildren.

operator()()​

void XmlDocVisitor::operator() (const DocHtmlBlockQuote & q)

Declaration at line 102 of file xmldocvisitor.h, definition at line 1160 of file xmldocvisitor.cpp.

1160void XmlDocVisitor::operator()(const DocHtmlBlockQuote &q)
1161{
1162 if (m_hide) return;
1163 m_t << "<blockquote>";
1164 visitChildren(q);
1165 m_t << "</blockquote>";
1166}

References m_hide, m_t and visitChildren.

operator()()​

void XmlDocVisitor::operator() (const DocVhdlFlow &)

Declaration at line 103 of file xmldocvisitor.h, definition at line 1168 of file xmldocvisitor.cpp.

1168void XmlDocVisitor::operator()(const DocVhdlFlow &)
1169{
1170}

operator()()​

void XmlDocVisitor::operator() (const DocParBlock & pb)

Declaration at line 104 of file xmldocvisitor.h, definition at line 1172 of file xmldocvisitor.cpp.

1172void XmlDocVisitor::operator()(const DocParBlock &pb)
1173{
1174 if (m_hide) return;
1175 m_t << "<parblock>";
1176 visitChildren(pb);
1177 m_t << "</parblock>";
1178}

References m_hide, m_t and visitChildren.

Private Member Functions​

endLink()​

void XmlDocVisitor::endLink ()

Declaration at line 123 of file xmldocvisitor.h, definition at line 1198 of file xmldocvisitor.cpp.

1198void XmlDocVisitor::endLink()
1199{
1200 m_t << "</ref>";
1201}

Reference m_t.

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

filter()​

void XmlDocVisitor::filter (const QCString & str)

Declaration at line 120 of file xmldocvisitor.h, definition at line 1181 of file xmldocvisitor.cpp.

1181void XmlDocVisitor::filter(const QCString &str)
1182{
1183 m_t << convertToXML(str);
1184}

References convertToXML and m_t.

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

startLink()​

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

Declaration at line 121 of file xmldocvisitor.h, definition at line 1186 of file xmldocvisitor.cpp.

1186void XmlDocVisitor::startLink(const QCString &ref,const QCString &file,const QCString &anchor)
1187{
1188 //printf("XmlDocVisitor: file=%s anchor=%s\n",qPrint(file),qPrint(anchor));
1189 m_t << "<ref refid=\"" << file;
1190 if (!anchor.isEmpty()) m_t << "_1" << anchor;
1191 m_t << "\" kindref=\"";
1192 if (!anchor.isEmpty()) m_t << "member"; else m_t << "compound";
1193 m_t << "\"";
1194 if (!ref.isEmpty()) m_t << " external=\"" << ref << "\"";
1195 m_t << ">";
1196}

References QCString::isEmpty and m_t.

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

visitChildren()​

template <class T>
void XmlDocVisitor::visitChildren (const T & t)
 inline

Definition at line 108 of file xmldocvisitor.h.

108 void visitChildren(const T &t)
109 {
110 for (const auto &child : t.children())
111 {
112 std::visit(*this, child);
113 }
114 }

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() and operator().

Private Member Attributes​

m_ci​

OutputCodeList& XmlDocVisitor::m_ci

Definition at line 130 of file xmldocvisitor.h.

130 OutputCodeList &m_ci;

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

m_hide​

bool XmlDocVisitor::m_hide = false

Definition at line 132 of file xmldocvisitor.h.

132 bool m_hide = false;

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() and XmlDocVisitor.

m_insidePre​

bool XmlDocVisitor::m_insidePre = false

Definition at line 131 of file xmldocvisitor.h.

131 bool m_insidePre = false;

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

m_langExt​

QCString XmlDocVisitor::m_langExt

Definition at line 133 of file xmldocvisitor.h.

133 QCString m_langExt;

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

m_sectionLevel​

int XmlDocVisitor::m_sectionLevel

Definition at line 134 of file xmldocvisitor.h.

134 int m_sectionLevel;

Referenced by operator() and XmlDocVisitor.

m_t​

TextStream& XmlDocVisitor::m_t

Definition at line 129 of file xmldocvisitor.h.

129 TextStream &m_t;

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(), startLink and XmlDocVisitor.

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

Generated via doxygen2docusaurus by Doxygen 1.14.0.