42#if !ENABLE_DOCPARSER_TRACING
46#define AUTO_TRACE(...) (void)0
47#define AUTO_TRACE_ADD(...) (void)0
48#define AUTO_TRACE_EXIT(...) (void)0
51#define INTERNAL_ASSERT(x) do {} while(0)
70 "uml",
"bpm",
"wire",
"dot",
"ditaa",
71 "salt",
"math",
"latex",
"gantt",
"mindmap",
72 "wbs",
"yaml",
"creole",
"json",
"flow",
73 "board",
"git",
"hcl",
"regex",
"ebnf",
74 "files",
"chen",
"chronology"
84 const char *p =
s.data();
90 if (c==
'{') c=
'<';
else if (c==
'}') c=
'>';
120 std::visit([&](
auto &&x)->
decltype(
auto) {
return x.setParent(newParent); }, *n);
164 size_t len=locSymName.
length();
167 if (locSymName.
at(len-1)!=
':') locSymName.
append(
":");
168 if (locSymName.
at(0)!=
':') locSymName.
prepend(
":");
186 Doxygen::searchIndex.addWord(word,false);
203 Doxygen::searchIndex.addWord(word,false);
219 if (
id.left(anchorPrefix.
length()) == anchorPrefix)
309 parser()->tokenizer.getLineNr(),
310 "block marked with {} for \\snippet should appear twice in file {}, found it {:d} times",
324 "No previous '\\include' or '\\dontinclude' command for '\\{}' present",
335 size_t so = o, bo = 0;
336 bool nonEmpty =
FALSE;
349 else if (!isspace(
static_cast<uint8_t
>(c)))
379 else if (!isspace(
static_cast<uint8_t
>(c)))
412 else if (!isspace(
static_cast<uint8_t
>(c)))
443 else if (!isspace(
static_cast<uint8_t
>(c)))
487 if (
parser()->context.memberDef &&
parser()->context.memberDef->name().at(0)==
'@')
546 while (!tok.
is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF))
560 if (sec==
nullptr &&
parser()->context.lang==SrcLangExt::Markdown)
619 while (!tok.
is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF))
621 if (tok.
is_any_of(TokenRetval::TK_COMMAND_AT, TokenRetval::TK_COMMAND_BS))
628 if (!tok.
is(TokenRetval::TK_WHITESPACE))
634 if (!tok.
is_any_of(TokenRetval::TK_WORD,TokenRetval::TK_LNKWORD))
648 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"Illegal command '{:c}{}' as part of a \\secreflist",
653 else if (tok.
is(TokenRetval::TK_WHITESPACE))
659 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"Unexpected token {} inside section reference list",
691 while (!tok.
is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF))
710 AUTO_TRACE(
"target='{}',context='{}'",target,context);
713 auto lang =
parser->context.lang;
715 if (sec==
nullptr && !
parser->context.prefix.isEmpty())
767 m_file = dd->getOutputFileBase();
774 bool isFile = compound ?
778 if (compound && lang==SrcLangExt::Markdown) lang = compound->
getLanguage();
811 toFileDef(compound)->generateSourceFile()
825 warn_doc_error(
parser->context.fileName,
parser->tokenizer.getLineNr(),
"unable to resolve reference to '{}' for \\ref command",
831 for (
auto &&elem : elements)
841 for (
auto &dn : children)
843 DocPara *para = std::get_if<DocPara>(&dn);
855 for (
auto &cn : children)
862 for (
auto &ccn : *opt_children)
876 while (!tok.
is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF))
882 case TokenRetval::TK_HTMLTAG:
895 if (
parser()->context.insideHtmlLink)
900 "Potential recursion while resolving \\ref command!");
927 if (numBibFiles>0 && cite && !cite->
text().
isEmpty())
938 warn_doc_error(
parser->context.fileName,
parser->tokenizer.getLineNr(),
"\\cite command found but no bib files specified via CITE_BIB_FILES!");
940 else if (cite==
nullptr)
942 warn_doc_error(
parser->context.fileName,
parser->tokenizer.getLineNr(),
"unable to resolve reference to '{}' for \\cite command",
947 warn_doc_error(
parser->context.fileName,
parser->tokenizer.getLineNr(),
"\\cite command to '{}' does not have an associated number",
959 if (!opt.noPar()) txt +=
"[";
963 if (opt.isNumber()) txt += citeInfo->
text();
964 else if (opt.isShortAuthor()) txt += citeInfo->
shortAuthor();
965 else if (opt.isYear()) txt += citeInfo->
year();
968 if (!opt.noPar()) txt +=
"]";
983 m_refText = m_refText.right(m_refText.length()-1);
990 if (compound && compound->isLinkable())
992 m_file = compound->getOutputFileBase();
993 m_ref = compound->getReference();
996 (
toFileDef(compound))->generateSourceFile()
1006 warn_doc_error(parser->context.fileName,parser->tokenizer.getLineNr(),
"unable to resolve link to '{}' for \\link command",
1018 while (!tok.
is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF))
1022 switch (tok.
value())
1024 case TokenRetval::TK_COMMAND_AT:
1026 case TokenRetval::TK_COMMAND_BS:
1042 case TokenRetval::TK_SYMBOL:
1043 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"Unsupported symbol '{}' found as part of a \\link",
1044 parser()->context.token->name);
1046 case TokenRetval::TK_HTMLTAG:
1047 if (
parser()->context.token->name!=
"see" || !isXmlLink)
1049 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"Unexpected xml/html command {} found as part of a \\link",
1050 parser()->context.token->name);
1053 case TokenRetval::TK_LNKWORD:
1054 case TokenRetval::TK_WORD:
1063 else if ((p=w.
find(
'}'))!=-1)
1065 int l =
static_cast<int>(w.
length());
1069 result=w.
right(l-p-1);
1083 if (tok.
is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
1086 parser()->tokenizer.getLineNr(),
1087 "Unexpected end of comment while inside link command");
1107 p->relPath =
parser->context.relPath;
1117 if (fd==
nullptr && !
p->name.endsWith(
".dot"))
1128 "Possible candidates:\n{}",
p->name,
1136 "in any of the paths specified via DOTFILE_DIRS!",
p->name);
1145 p->relPath =
parser->context.relPath;
1155 if (fd==
nullptr && !
p->name.endsWith(
".msc"))
1166 "Possible candidates:\n{}",
qPrint(
p->name),
1174 "in any of the paths specified via MSCFILE_DIRS!",
p->name);
1185 p->relPath =
parser->context.relPath;
1195 if (fd==
nullptr && !
p->name.endsWith(
".dia"))
1206 "Possible candidates:\n{}",
p->name,
1214 "in any of the paths specified via DIAFILE_DIRS!",
p->name);
1224 p->relPath =
parser->context.relPath;
1234 if (fd==
nullptr && !
p->name.endsWith(
".puml"))
1237 if (fd==
nullptr && !
p->name.endsWith(
".pu"))
1249 "Possible candidates:\n{}",
p->name,
1257 "in any of the paths specified via PLANTUMLFILE_DIRS!",
p->name);
1275 while (!tok.
is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF))
1302 QCString locName =
p->url.isEmpty() ?
p->name :
p->url;
1303 int len =
static_cast<int>(locName.
length());
1304 int fnd = locName.
find(
'?');
1305 if (fnd==-1) fnd=len;
1306 return fnd>=4 && locName.
mid(fnd-4,4)==
".svg";
1320 Token retval(TokenRetval::RetVal_OK);
1324 while (!tok.
is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF))
1328 switch (tok.
value())
1330 case TokenRetval::TK_HTMLTAG:
1389 if (!
parser()->context.token->endTag)
1400 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"Unexpected html tag <{}{}> found within <h{:d}> context",
1413 if (tok.
is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
1430 while (!tok.
is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF))
1434 if (tok.
value()==TokenRetval::TK_HTMLTAG &&
1436 parser()->context.token->endTag
1448 if (tok.
is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
1460 Token retval(TokenRetval::TK_NONE);
1471 retval=par->
parse();
1473 while (retval.
is(TokenRetval::TK_NEWPARA));
1476 if (retval.
is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
1478 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"unexpected end of comment while inside <details> block");
1489 return retval.
is(TokenRetval::RetVal_EndHtmlDetails) ? Token::make_RetVal_OK() : retval;
1505 Token retval(TokenRetval::RetVal_OK);
1509 while (!tok.
is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF))
1513 switch (tok.
value())
1515 case TokenRetval::TK_HTMLTAG:
1528 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"Unexpected html tag <{}{}> found within <a href=...> context",
1529 parser()->context.token->endTag?
"/":
"",
parser()->context.token->name);
1540 if (tok.
is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
1543 " <a href=...> tag");
1555 Token retval(TokenRetval::RetVal_OK);
1565 if (isFirst) { par->markFirst(); isFirst=
FALSE; }
1566 retval=par->parse();
1567 if (!par->isEmpty())
1576 if (retval.
is(TokenRetval::TK_LISTITEM))
1580 }
while (!retval.
is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF,
1581 TokenRetval::RetVal_Section, TokenRetval::RetVal_Subsection, TokenRetval::RetVal_Subsubsection,
1582 TokenRetval::RetVal_Paragraph, TokenRetval::RetVal_SubParagraph, TokenRetval::RetVal_SubSubParagraph,
1583 TokenRetval::RetVal_EndInternal));
1587 while ((level==1 && retval.
is(TokenRetval::RetVal_Section)) ||
1588 (level==2 && retval.
is(TokenRetval::RetVal_Subsection)) ||
1589 (level==3 && retval.
is(TokenRetval::RetVal_Subsubsection)) ||
1590 (level==4 && retval.
is(TokenRetval::RetVal_Paragraph)) ||
1591 (level==5 && retval.
is(TokenRetval::RetVal_SubParagraph)) ||
1592 (level==6 && retval.
is(TokenRetval::RetVal_SubSubParagraph))
1601 if (retval.
is(TokenRetval::RetVal_Internal))
1603 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"\\internal command found inside internal section");
1615 Token retval(TokenRetval::RetVal_OK);
1618 if (!tok.
is(TokenRetval::TK_WHITESPACE))
1626 while (!tok.
is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF))
1628 switch (tok.
value())
1630 case TokenRetval::TK_WHITESPACE:
1633 case TokenRetval::TK_WORD:
1634 case TokenRetval::TK_LNKWORD:
1637 case TokenRetval::TK_SYMBOL:
1659 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"Unexpected symbol '{}' found as argument of \\addindex",
parser()->context.token->name);
1664 case TokenRetval::TK_COMMAND_AT:
1666 case TokenRetval::TK_COMMAND_BS:
1688 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"Unexpected command {} found as argument of \\addindex",
1689 parser()->context.token->name);
1713 for (
const auto &opt :
attribs)
1715 if (opt.name==
"id" && !opt.value.isEmpty())
1740 Token retval = Token::make_TK_NONE();
1743 while (!tok.
is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF))
1747 switch (tok.
value())
1749 case TokenRetval::TK_HTMLTAG:
1754 retval = Token::make_RetVal_OK();
1759 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"Unexpected html tag <{}{}> found within <caption> context",
1760 parser()->context.token->endTag?
"/":
"",
parser()->context.token->name);
1771 if (tok.
is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
1786 Token retval = Token::make_RetVal_OK();
1797 retval=par->
parse();
1798 if (retval.
is(TokenRetval::TK_HTMLTAG))
1803 retval = Token::make_TK_NEWPARA();
1807 retval = Token::make_TK_NEWPARA();
1811 while (retval.
is_any_of(TokenRetval::TK_NEWPARA,TokenRetval::RetVal_EndParBlock));
1820 Token retval = Token::make_RetVal_OK();
1831 retval=par->
parse();
1832 if (retval.
is(TokenRetval::TK_HTMLTAG))
1837 retval = Token::make_TK_NEWPARA();
1841 retval = Token::make_TK_NEWPARA();
1845 while (retval.
is(TokenRetval::TK_NEWPARA));
1853 for (
const auto &attr :
attribs())
1855 if (attr.name.lower()==
"rowspan")
1857 return attr.value.toUInt();
1865 for (
const auto &attr :
attribs())
1867 if (attr.name.lower()==
"colspan")
1869 return std::max(1u,attr.value.toUInt());
1877 for (
const auto &attr :
attribs())
1881 if (attrName==
"align")
1883 if (attrValue==
"center")
1885 else if (attrValue==
"right")
1889 else if (attrName==
"class" && attrValue.
startsWith(
"markdowntable"))
1891 if (attrValue==
"markdowntableheadcenter")
1893 else if (attrValue==
"markdowntableheadright")
1895 else if (attrValue==
"markdowntableheadleft")
1897 else if (attrValue==
"markdowntableheadnone")
1899 else if (attrValue==
"markdowntablebodycenter")
1901 else if (attrValue==
"markdowntablebodyright")
1903 else if (attrValue==
"markdowntablebodyleft")
1905 else if (attrValue==
"markdowntablebodynone")
1915 for (
const auto &attr :
attribs())
1919 if (attrName==
"valign")
1921 if (attrValue==
"top")
1923 else if (attrValue==
"bottom")
1925 else if (attrValue==
"middle")
1940 const DocHtmlCell *cell = std::get_if<DocHtmlCell>(&n);
1955 while (tok.
is_any_of(TokenRetval::TK_WHITESPACE,TokenRetval::TK_NEWPARA,TokenRetval::TK_HTMLTAG))
1957 if (tok.
is(TokenRetval::TK_HTMLTAG))
1984 Token retval = Token::make_RetVal_OK();
1993 if (tok.
is(TokenRetval::TK_HTMLTAG))
2006 "found <{}{}> instead!",
parser()->context.token->endTag ?
"/" :
"",
parser()->context.token->name);
2011 else if (tok.
is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
2014 " for a html description title");
2019 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"expected <td> or <th> tag but found {} token instead!",
2033 retval=cell->
parse();
2034 isHeading = retval.
is(TokenRetval::RetVal_TableHCell);
2036 if (retval.
is(TokenRetval::RetVal_EndTableCell))
2042 if (tok.
is(TokenRetval::TK_HTMLTAG))
2045 !
parser()->context.token->endTag)
2047 retval = Token::make_RetVal_TableCell();
2052 if (
parser()->context.token->endTag)
2054 retval = Token::make_RetVal_EndTableRow();
2058 retval = Token::make_RetVal_TableRow();
2063 retval = Token::make_RetVal_EndTable();
2068 "found <{}{}> instead!",
parser()->context.token->endTag ?
"/" :
"",
parser()->context.token->name);
2075 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"expected <td>, <th> or <tr> tag but found {} token instead!",
2081 while (retval.
is_any_of(TokenRetval::RetVal_TableCell,TokenRetval::RetVal_TableHCell));
2091 Token retval = Token::make_RetVal_OK();
2102 if (tok.
is(TokenRetval::TK_HTMLTAG))
2114 "found <{}> instead!",
parser()->context.token->name);
2119 else if (tok.
is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
2122 " for a html description title");
2127 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"expected <td> or <th> tag but found {} token instead!",
2140 while (retval.
is_any_of(TokenRetval::RetVal_TableCell,TokenRetval::RetVal_TableHCell));
2161 if (!
children().empty() && std::holds_alternative<DocHtmlRow>(
children().front()))
2171 Token retval = Token::make_RetVal_OK();
2178 if (tok.
is(TokenRetval::TK_HTMLTAG))
2184 retval = Token::make_RetVal_TableRow();
2195 retval=std::get<DocHtmlCaption>(*m_caption).parse();
2197 if (retval.
is(TokenRetval::RetVal_OK))
2206 "found <{}{}> instead!",
parser()->context.token->endTag ?
"/" :
"",
parser()->context.token->name);
2209 else if (tok.
is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
2212 " for a <tr> or <caption> tag");
2221 while (retval.
is(TokenRetval::RetVal_TableRow))
2226 if (retval.is(TokenRetval::RetVal_EndTableRow))
2234 retval = Token::make_RetVal_TableRow();
2238 retval = Token::make_RetVal_EndTable();
2243 "found token {} instead!",retval.to_string());
2244 retval=Token::make_RetVal_OK();
2252 return retval.
is(TokenRetval::RetVal_EndTable) ? Token::make_RetVal_OK() : retval;
2258 Token retval = Token::make_RetVal_OK();
2267 bool isHeader=
FALSE;
2268 if (tok.
is(TokenRetval::TK_HTMLTAG))
2273 retval = Token::make_RetVal_TableRow();
2277 retval = Token::make_RetVal_TableRow();
2283 while (retval.
is(TokenRetval::RetVal_TableRow))
2287 retval=tr->parseXml(isHeader);
2322 DocHtmlRow *row = std::get_if<DocHtmlRow>(&rowNode);
2325 for (
auto &cellNode : row->
children())
2327 DocHtmlCell *cell = std::get_if<DocHtmlCell>(&cellNode);
2330 uint32_t rs = cell->
rowSpan();
2331 uint32_t cs = cell->
colSpan();
2333 for (
size_t i=0;
i<rowSpans.size();
i++)
2335 if (rowSpans[
i].rowsLeft>0 &&
2336 rowSpans[
i].column==colIdx)
2338 colIdx=rowSpans[
i].column+1;
2342 if (rs>0) rowSpans.emplace_back(rs,colIdx);
2350 for (
size_t i=0;
i<rowSpans.size();
i++)
2352 if (rowSpans[
i].rowsLeft>0) rowSpans[
i].rowsLeft--;
2358 if (colIdx-1>maxCols) maxCols=colIdx-1;
2368 Token retval = Token::make_TK_NONE();
2372 while (!tok.
is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF))
2376 switch (tok.
value())
2378 case TokenRetval::TK_COMMAND_AT:
2380 case TokenRetval::TK_COMMAND_BS:
2383 bool isJavaLink=
FALSE;
2389 if (!tok.
is(TokenRetval::TK_WHITESPACE))
2398 if (!tok.
is(TokenRetval::TK_WORD))
2400 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"unexpected token {} as the argument of '{:c}{}' command",
2418 if (!tok.
is(TokenRetval::TK_WHITESPACE))
2427 if (!tok.
is(TokenRetval::TK_WORD))
2429 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"unexpected token {} as the argument of \\{} command",
2437 QCString leftOver = lnk->parse(isJavaLink);
2438 if (!leftOver.isEmpty())
2448 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"Illegal command '{:c}{}' found as part of a <dt> tag",
2453 case TokenRetval::TK_SYMBOL:
2454 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"Unsupported symbol '{}' found as part of a <dt> tag",
2455 parser()->context.token->name);
2457 case TokenRetval::TK_HTMLTAG:
2462 retval = Token::make_RetVal_DescData();
2472 retval = Token::make_RetVal_DescTitle();
2477 retval = Token::make_RetVal_EndDesc();
2482 if (!
parser()->context.token->endTag)
2489 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"Unexpected html tag <{}{}> found within <dt> context",
2490 parser()->context.token->endTag?
"/":
"",
parser()->context.token->name);
2502 if (tok.
is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
2518 Token retval = Token::make_TK_NONE();
2528 retval=par->
parse();
2530 while (retval.
is(TokenRetval::TK_NEWPARA));
2541 Token retval = Token::make_RetVal_OK();
2549 if (tok.
is(TokenRetval::TK_HTMLTAG))
2559 "found <{}> instead!",
parser()->context.token->name);
2564 else if (tok.
is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
2567 " for a html description title");
2584 if (retval.is(TokenRetval::RetVal_DescData))
2587 while (retval.is(TokenRetval::RetVal_DescData))
2594 else if (!retval.is(TokenRetval::RetVal_DescTitle))
2599 }
while (retval.
is(TokenRetval::RetVal_DescTitle));
2601 if (retval.
is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
2603 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"unexpected end of comment while inside <dl> block");
2608 return retval.
is(TokenRetval::RetVal_EndDesc) ? Token::make_RetVal_OK() : retval;
2616 Token retval = Token::make_TK_NONE();
2627 retval=par->
parse();
2629 while (retval.
is(TokenRetval::TK_NEWPARA));
2639 Token retval = Token::make_TK_NONE();
2650 retval=par->
parse();
2651 if (retval.
is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
break;
2655 if (retval.
is(TokenRetval::RetVal_ListItem))
2660 while (!retval.
is(TokenRetval::RetVal_CloseXml));
2673 Token retval = Token::make_RetVal_OK();
2682 if (tok.
is(TokenRetval::TK_HTMLTAG))
2691 ) &&
parser()->context.token->endTag
2697 retval = Token::make_RetVal_EndList();
2705 "found <{}{}> instead!",
parser()->context.token->endTag?
"/":
"",
parser()->context.token->name);
2710 else if (tok.
is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
2715 " for a html list item");
2732 }
while (retval.
is(TokenRetval::RetVal_ListItem));
2734 if (retval.
is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
2736 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"unexpected end of comment while inside <{:c}l> block",
2742 return retval.
is(TokenRetval::RetVal_EndList) ? Token::make_RetVal_OK() : retval;
2748 Token retval = Token::make_RetVal_OK();
2757 if (tok.
is(TokenRetval::TK_HTMLTAG))
2768 "found <{}> instead!",
parser()->context.token->name);
2773 else if (tok.
is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
2776 " for a html list item");
2790 retval=li->parseXml();
2791 if (retval.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
break;
2793 }
while (retval.
is(TokenRetval::RetVal_ListItem));
2795 if (retval.
is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
2797 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"unexpected end of comment while inside <list type=\"{}\"> block",
2803 return (retval.
is_any_of(TokenRetval::RetVal_EndList,TokenRetval::RetVal_CloseXml) ||
parser()->context.token->name==
"list") ?
2804 Token::make_RetVal_OK() : retval;
2812 Token retval = Token::make_TK_NONE();
2823 retval=par->
parse();
2825 while (retval.
is(TokenRetval::TK_NEWPARA));
2828 if (retval.
is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
2830 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"unexpected end of comment while inside <blockquote> block");
2834 return retval.
is(TokenRetval::RetVal_EndBlockQuote) ? Token::make_RetVal_OK() : retval;
2842 Token retval = Token::make_TK_NONE();
2853 retval=par->
parse();
2855 while (retval.
is(TokenRetval::TK_NEWPARA));
2859 return retval.
is(TokenRetval::RetVal_EndBlockQuote) ? Token::make_RetVal_OK() : retval;
2886 Token rv = Token::make_TK_NONE();
2892 }
while (rv.
is(TokenRetval::RetVal_ListItem));
2893 return (!rv.
is(TokenRetval::TK_NEWPARA)) ? rv : Token::make_RetVal_OK();
2906 Token retval = Token::make_RetVal_OK();
2916 if (isFirst) { par->markFirst(); isFirst=
FALSE; }
2917 retval=par->parse();
2918 if (!par->isEmpty())
2929 }
while (retval.
is(TokenRetval::TK_NEWPARA) &&
parser()->context.token->indent>
m_indent);
2948 Token retval = Token::make_RetVal_OK();
2955 switch (
parser()->context.token->id)
2977 while (retval.
is(TokenRetval::TK_LISTITEM) &&
2981 (
parser()->context.token->id==-1 ||
parser()->context.token->id>=num)
2997 while (!tok.
is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF))
3029 return m_title && std::get<DocTitle>(*m_title).hasTitle();
3041 std::get_if<DocTitle>(
m_title.get())->parse();
3045 if (!
children().empty() && std::holds_alternative<DocPara>(
children().back()))
3063 Token retval = par->parse();
3083 return Token::make_RetVal_OK();
3091 Token retval = Token::make_RetVal_OK();
3095 if (!
children().empty() && std::holds_alternative<DocPara>(
children().back()))
3097 std::get<DocPara>(
children().back()).markLast(
false);
3109 retval = par->parse();
3110 if (retval.
is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
break;
3111 if (retval.
is(TokenRetval::RetVal_CloseXml))
3113 retval = Token::make_RetVal_OK();
3125 if (
children().empty() || (p=std::get_if<DocPara>(&
children().back()))==
nullptr)
3147 case See:
return "see";
3148 case Return:
return "return";
3150 case Authors:
return "author";
3151 case Version:
return "version";
3152 case Since:
return "since";
3153 case Date:
return "date";
3154 case Note:
return "note";
3155 case Warning:
return "warning";
3156 case Pre:
return "pre";
3157 case Post:
return "post";
3159 case Invar:
return "invariant";
3160 case Remark:
return "remark";
3163 case User:
return "user";
3164 case Rcs:
return "rcs";
3174 Token retval = Token::make_RetVal_OK();
3180 if (!tok.
is(TokenRetval::TK_WHITESPACE))
3184 retval = Token::make_RetVal_EndParBlock();
3189 while (tok.
is(TokenRetval::TK_WORD))
3194 if (typeSeparator!=-1)
3200 if (
parent() && std::holds_alternative<DocParamSect>(*
parent()))
3202 std::get<DocParamSect>(*
parent()).m_hasTypeSpecifier=
true;
3221 if (tok.
is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
3223 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"unexpected end of comment block while parsing the "
3224 "argument of command {}",saveCmdName);
3225 retval = Token::make_RetVal_EndParBlock();
3228 if (!tok.
is(TokenRetval::TK_WHITESPACE))
3230 if (!tok.
is(TokenRetval::TK_NEWPARA))
3232 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"unexpected token {} in comment block while parsing the "
3233 "argument of command {}",tok.
to_string(),saveCmdName);
3235 retval = Token::make_RetVal_EndParBlock();
3241 retval = par->
parse();
3253 Token retval = Token::make_RetVal_OK();
3274 retval = par->parse();
3296 if (retval.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
break;
3298 }
while (retval.
is(TokenRetval::RetVal_CloseXml) &&
3303 if (retval.
is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
3309 retval = Token::make_RetVal_OK();
3321 Token retval = Token::make_RetVal_OK();
3329 if (!
children().empty() && std::holds_alternative<DocParamList>(
children().back()))
3344 retval = pl->parseXml(cmdName);
3348 retval = pl->parse(cmdName);
3350 if (retval.
is(TokenRetval::RetVal_EndParBlock))
3352 retval = Token::make_RetVal_OK();
3371 bool needsSeparator =
FALSE;
3373 (ss=
children().get_last<DocSimpleSect>()) &&
3378 needsSeparator =
TRUE;
3385 Token rv = Token::make_RetVal_OK();
3394 return (!rv.
is(TokenRetval::TK_NEWPARA)) ? rv : Token::make_RetVal_OK();
3399 bool xmlContext=
FALSE,
3405 (ps=
children().get_last<DocParamSect>()) &&
3417 return (!rv.
is(TokenRetval::TK_NEWPARA)) ? rv : Token::make_RetVal_OK();
3428 if (tok.
is(TokenRetval::TK_WORD) &&
parser()->context.token->name==
"{")
3433 for (
auto const &opt : optList)
3435 if (opt ==
"number")
3439 warn(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"Multiple options specified with \\{}, discarding '{}'", saveCmdName, opt);
3446 else if (opt ==
"year")
3450 warn(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"Multiple options specified with \\{}, discarding '{}'", saveCmdName, opt);
3457 else if (opt ==
"shortauthor")
3461 warn(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"Multiple options specified with \\{}, discarding '{}'", saveCmdName, opt);
3468 else if (opt ==
"nopar")
3472 else if (opt ==
"nocite")
3478 warn(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"Unknown option specified with \\{}, discarding '{}'", saveCmdName, opt);
3486 if (!tok.
is(TokenRetval::TK_WHITESPACE))
3493 else if (!tok.
is(TokenRetval::TK_WHITESPACE))
3496 cmdChar,saveCmdName);
3506 if (tok.
is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
3508 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"THE ONE unexpected end of comment block while parsing the "
3509 "argument of command '{:c}{}'",cmdChar,saveCmdName);
3512 else if (!tok.
is_any_of(TokenRetval::TK_WORD,TokenRetval::TK_LNKWORD))
3530 if (!tok.
is(TokenRetval::TK_WHITESPACE))
3538 if (tok.
is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
3540 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"no emoji name given or unexpected end of comment block while parsing the "
3541 "argument of command '{:c}{}'",cmdChar,cmdName);
3545 else if (!tok.
is(TokenRetval::TK_WORD))
3560 if (!tok.
is(TokenRetval::TK_WHITESPACE))
3568 if (tok.
is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
3570 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"unexpected end of comment block while parsing the "
3571 "argument of command '{:c}{}'",cmdChar,cmdName);
3574 else if (!tok.
is_any_of(TokenRetval::TK_WORD,TokenRetval::TK_LNKWORD))
3584 switch (opt->
kind())
3604 std::string lstFormat =
theTranslator->trWriteList(
static_cast<int>(lst->size())).str();
3605 static const reg::Ex marker(R
"(@(\d+))");
3610 for ( ; it!=
end ; ++it)
3612 const auto &match = *it;
3613 size_t newIndex = match.position();
3614 size_t matchLen = match.length();
3615 optionValue += lstFormat.substr(index,newIndex-index);
3616 unsigned long entryIndex = std::stoul(match[1].str());
3617 if (entryIndex<(
unsigned long)lst->size())
3619 optionValue += lst->at(entryIndex);
3621 index=newIndex+matchLen;
3623 optionValue+=lstFormat.substr(index);
3628 warn(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"Obsolete setting for '{:c}{}': '{}'",
3629 cmdChar,cmdName,
parser()->context.token->name);
3633 "Disabled setting (i.e. not supported in this doxygen executable) for '{:c}{}': '{}'",
3634 cmdChar,cmdName,
parser()->context.token->name);
3647 warn(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"Unknown option for '{:c}{}': '{}'",
3648 cmdChar,cmdName,
parser()->context.token->name);
3658 ASSERT(retval.
is(TokenRetval::TK_WHITESPACE));
3661 if (retval.
is(TokenRetval::RetVal_OK))
3681 if (!tok.
is(TokenRetval::TK_WHITESPACE))
3689 if (!tok.
is(TokenRetval::TK_WORD))
3703 bool specDateOnlyWS = !specDateRaw.
isEmpty() && specDate.
isEmpty();
3704 if (!specDate.
isEmpty() && !tok.
is_any_of(TokenRetval::TK_WORD,TokenRetval::TK_NONE,TokenRetval::TK_EOF))
3706 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"invalid <date_time> argument for command '{:c}{}'",
3717 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"invalid <date_time> argument for command '{:c}{}': {}",
3718 cmdChar,cmdName,
err);
3730 if ((usedFormat&bitMask) && !(specFormat&bitMask))
3732 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"'{:c}{}' <format> parameter '{}' has {} related markers which are not specified in the <date_time> parameter '{}'. Filling in the current value for {} instead.",
3750 if (!tok.
is(TokenRetval::TK_WORD))
3763 if (!tok.
is(TokenRetval::TK_WHITESPACE))
3772 if (!tok.
is(TokenRetval::TK_WORD))
3788 if (!tok.
is(TokenRetval::TK_WHITESPACE))
3797 if (tok.
is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
3799 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"unexpected end of comment block while parsing the "
3800 "argument of command {}", saveCmdName);
3803 else if (!tok.
is(TokenRetval::TK_WORD))
3827 (!n1_docIncOp && !n1_docWs) ||
3828 (n1_docWs && n2 && !n2_docIncOp);
3833 n1_docIncOp->markLast(
false);
3835 else if (n1_docWs && n2_docIncOp)
3848 if (!tok.
is(TokenRetval::TK_WHITESPACE))
3857 if (!tok.
is(TokenRetval::TK_WORD))
3884 AUTO_TRACE(
"cmdName={} isJavaLink={}",cmdName,isJavaLink);
3887 if (!tok.
is(TokenRetval::TK_WHITESPACE))
3895 if (!tok.
is(TokenRetval::TK_WORD))
3901 if (saveCmdName ==
"javalink")
3910 if (saveCmdName ==
"javalink")
3916 QCString leftOver = lnk->parse(isJavaLink);
3928 if (!tok.
is(TokenRetval::TK_WHITESPACE))
3931 cmdChar,
qPrint(saveCmdName));
3936 if (!tok.
is(TokenRetval::TK_WORD))
3955 bool isBlock =
false;
3956 bool trimLeft =
false;
3957 bool localScope =
false;
3959 if (tok.
is(TokenRetval::TK_WORD) &&
parser()->context.token->name==
"{")
3965 auto contains = [&optList](
const char *kw)
3967 return std::find(optList.begin(),optList.end(),kw)!=optList.end();
3969 localScope = contains(
"local");
3970 if (contains(
"nostrip"))
3972 stripCodeComments =
false;
3974 else if (contains(
"strip"))
3976 stripCodeComments =
true;
3983 if (contains(
"lineno"))
3990 if (!tok.
is(TokenRetval::TK_WHITESPACE))
3997 else if (tok.
is(TokenRetval::TK_WORD) &&
parser()->context.token->name==
"[")
4005 else if (!tok.
is(TokenRetval::TK_WHITESPACE))
4014 if (tok.
is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
4016 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"unexpected end of comment block while parsing the "
4017 "argument of command {}",saveCmdName);
4020 else if (!tok.
is(TokenRetval::TK_WORD))
4034 if (!tok.
is(TokenRetval::TK_WORD))
4036 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"expected block identifier, but found token {} instead while parsing the {} command",
4051 blockId,isBlock,trimLeft);
4061 if (!tok.
is(TokenRetval::TK_WHITESPACE))
4064 cmdChar,saveCmdName);
4068 if (tok.
is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
4070 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"unexpected end of comment block while parsing the "
4071 "argument of command '{:c}{}'", cmdChar,saveCmdName);
4074 else if (!tok.
is_any_of(TokenRetval::TK_WORD,TokenRetval::TK_LNKWORD))
4091 return retval.is(TokenRetval::RetVal_OK) ? Token::make_TK_NEWPARA() : retval;
4113 if (
parser()->context.xmlComment)
4119 while (
i<l && (
parser()->context.token->verb.at(
i)==
' ' ||
parser()->context.token->verb.at(
i)==
'\n'))
4121 if (
parser()->context.token->verb.at(
i)==
'\n') li=
i+1;
4131 if (retval.
is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
4142 if (
parser()->context.memberDef)
4180 Token retval = Token::make_RetVal_OK();
4186 std::string str{cmdChar};
4190 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"Found unexpanded alias '{:c}{}'. Check if number of arguments passed is correct.",cmdChar,cmdName);
4339 retval = Token::make_RetVal_Section();
4345 retval = Token::make_RetVal_Subsection();
4351 retval = Token::make_RetVal_Subsubsection();
4357 retval = Token::make_RetVal_Paragraph();
4363 retval = Token::make_RetVal_SubParagraph();
4369 retval = Token::make_RetVal_SubSubParagraph();
4389 if (retval.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
4401 if (retval.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
4413 if (retval.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
4425 if (retval.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
4437 if (retval.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
4449 if (retval.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
4463 int idx = fullMatch.
find(
'{');
4464 int idxEnd = fullMatch.
find(
"}",idx+1);
4470 for (
const auto &opt : optList)
4472 if (opt.empty())
continue;
4475 if (locOpt ==
"code")
4481 warn(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"Unknown option '{}' for '\\iliteral'",opt);
4489 if (retval.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
4497 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"javadoc literal section ended without end marker");
4516 if (retval.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
4537 dv->setText(
parser()->context.token->verb);
4538 dv->setWidth(width);
4539 dv->setHeight(height);
4540 dv->setLocation(
parser()->context.fileName,
parser()->tokenizer.getLineNr());
4543 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"ignoring \\dot command because HAVE_DOT is not set");
4546 if (retval.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
4567 dv->setText(
parser()->context.token->verb);
4568 dv->setWidth(width);
4569 dv->setHeight(height);
4570 dv->setLocation(
parser()->context.fileName,
parser()->tokenizer.getLineNr());
4571 if (retval.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
4585 int idx = fullMatch.
find(
'{');
4586 int idxEnd = fullMatch.
find(
"}",idx+1);
4593 for (
const auto &opt : optList)
4595 if (opt.empty())
continue;
4603 warn(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"Multiple definition of engine for '\\startuml'");
4616 warn(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"Multiple use of filename for '\\startuml'");
4625 if (engine.
isEmpty()) engine =
"uml";
4631 assert(retval.is(TokenRetval::RetVal_OK));
4652 if (engine ==
"ditaa")
4654 dv->setUseBitmap(
true);
4656 else if (engine ==
"uml")
4658 int i = trimmedVerb.
find(
'\n');
4662 dv->setText(trimmedVerb);
4663 dv->setWidth(width);
4664 dv->setHeight(height);
4665 dv->setLocation(
parser()->context.fileName,
parser()->tokenizer.getLineNr());
4668 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"ignoring \\startuml command because PLANTUML_JAR_PATH is not set");
4671 if (retval.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
4679 retval = Token::make_RetVal_EndParBlock();
4738 retval = Token::make_RetVal_Internal();
4741 retval = Token::make_RetVal_EndInternal();
4810 "ignoring \\dotfile command because HAVE_DOT is not set");
4898 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"Unexpected command '{}' in paragraph context",cmdName);
4901 INTERNAL_ASSERT(retval.
is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF,TokenRetval::RetVal_OK,TokenRetval::RetVal_SimpleSec
4902 TokenRetval::TK_LISTITEM,TokenRetval::TK_ENDLIST,TokenRetval::TK_NEWPARA
4903 TokenRetval::RetVal_Section,TokenRetval::RetVal_EndList
4904 TokenRetval::RetVal_Internal,TokenRetval::RetVal_SwitchLang
4905 TokenRetval::RetVal_EndInternal)
4912 const char *attrName,
4916 for (
const auto &opt : tagHtmlAttribs)
4918 if (opt.name==attrName)
4920 *result = opt.value;
4929 AUTO_TRACE(
"tagName={} #tagHtmlAttrs={}",tagName,tagHtmlAttribs.size());
4930 Token retval = Token::make_RetVal_OK();
4936 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"HTML tag ('<{}/>') may not use the 'empty tag' XHTML syntax.",
4942 if (!
parser()->context.token->emptyTag)
4950 if (!
parser()->context.token->emptyTag)
4958 if (
parser()->context.token->emptyTag)
break;
4965 retval = Token::make_RetVal_ListItem();
4987 if (
parser()->context.token->emptyTag)
break;
4988 if (
parser()->context.xmlComment)
5033 if (
parser()->context.token->emptyTag)
break;
5039 retval = Token::make_TK_NEWPARA();
5042 if (!
parser()->context.token->emptyTag)
5051 retval = Token::make_RetVal_DescTitle();
5061 retval = Token::make_RetVal_DescData();
5069 if (!
parser()->context.token->emptyTag)
5077 retval = Token::make_RetVal_TableRow();
5080 retval = Token::make_RetVal_TableCell();
5083 retval = Token::make_RetVal_TableHCell();
5130 if (!
parser()->context.token->emptyTag)
5137 if (!
parser()->context.token->emptyTag)
5147 if (!
parser()->context.token->emptyTag)
5150 while (n && !std::holds_alternative<DocHtmlDetails>(*n)) n=
::parent(n);
5160 retval = Token::make_TK_NEWPARA();
5174 retval = Token::make_TK_NEWPARA();
5180 retval = Token::make_RetVal_TableCell();
5250 retval = Token::make_RetVal_TableRow();
5254 retval = Token::make_RetVal_ListItem();
5269 retval = Token::make_RetVal_TableCell();
5283 if (
parser()->context.token->emptyTag)
5300 if (!leftOver.isEmpty())
5318 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"Missing 'cref' or 'langword' attribute from <see> tag.");
5346 std::get<DocSimpleSect>(*vss).appendLinkWord(cref);
5347 retval = Token::make_RetVal_OK();
5404 Token retval = Token::make_RetVal_OK();
5414 retval = Token::make_RetVal_EndList();
5424 retval = Token::make_RetVal_EndList();
5440 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"found </details> tag without matching <details>");
5444 retval = Token::make_RetVal_EndHtmlDetails();
5450 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"found </blockquote> tag without matching <blockquote>");
5454 retval = Token::make_RetVal_EndBlockQuote();
5514 retval = Token::make_TK_NEWPARA();
5517 retval = Token::make_RetVal_EndDesc();
5526 retval = Token::make_RetVal_EndTable();
5529 retval = Token::make_RetVal_EndTableRow();
5532 retval = Token::make_RetVal_EndTableCell();
5535 retval = Token::make_RetVal_EndTableCell();
5579 retval = Token::make_TK_NEWPARA();
5593 retval = Token::make_RetVal_CloseXml();
5629 if (!std::get_if<DocAutoListItem>(n))
5637 const auto docAutoList = std::get_if<DocAutoList>(n);
5640 indent = docAutoList->indent();
5649 const auto docPara = std::get_if<DocPara>(n);
5655 return std::get<DocStyleChange>(*stack.top());
5665 indentStr.
fill(
' ',indent);
5680 Token retval = Token::make_TK_NONE();
5681 while (!tok.
is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF))
5685 if (tok.
is_any_of(TokenRetval::TK_WORD,TokenRetval::TK_LNKWORD,TokenRetval::TK_SYMBOL,TokenRetval::TK_URL,
5686 TokenRetval::TK_COMMAND_AT,TokenRetval::TK_COMMAND_BS,TokenRetval::TK_HTMLTAG)
5693 case TokenRetval::TK_WORD:
5696 case TokenRetval::TK_LNKWORD:
5699 case TokenRetval::TK_URL:
5702 case TokenRetval::TK_WHITESPACE:
5720 case TokenRetval::TK_LISTITEM:
5724 while (n && !std::holds_alternative<DocAutoList>(*n)) n=
::parent(n);
5725 const DocAutoList *al = std::get_if<DocAutoList>(n);
5732 retval = Token::make_TK_LISTITEM();
5742 al = std::get_if<DocAutoList>(n);
5756 }
while (retval.
is(TokenRetval::TK_LISTITEM) &&
5761 if (retval.
is(TokenRetval::RetVal_SimpleSec))
5767 if (
parser()->context.token->name.startsWith(
"rcs:"))
5771 tok = Token::make_TK_RCSTAG();
5775 tok = Token::make_TK_COMMAND_BS();
5780 else if (retval.
is(TokenRetval::TK_ENDLIST))
5796 case TokenRetval::TK_ENDLIST:
5797 AUTO_TRACE_ADD(
"Found end of list inside of paragraph at line {}",
parser()->tokenizer.getLineNr());
5798 if (std::get_if<DocAutoListItem>(
parent()))
5801 if (al && al->
indent()>=
parser()->context.token->indent)
5804 retval = Token::make_TK_ENDLIST();
5810 "has invalid indent level");
5819 case TokenRetval::TK_COMMAND_AT:
5821 case TokenRetval::TK_COMMAND_BS:
5826 while (n && !std::holds_alternative<DocSimpleSect>(*n) &&
5827 !std::holds_alternative<DocParamSect>(*n))
5838 retval = Token::make_RetVal_SimpleSec();
5844 while (n && !std::holds_alternative<DocSimpleListItem>(*n)) n=
::parent(n);
5849 retval = Token::make_RetVal_ListItem();
5859 if (retval.
is(TokenRetval::RetVal_SimpleSec))
5865 if (
parser()->context.token->name.startsWith(
"rcs:"))
5869 tok = Token::make_TK_RCSTAG();
5873 tok = Token::make_TK_COMMAND_BS();
5878 else if (retval.
value()>TokenRetval::TK_NONE && retval.
value()<TokenRetval::RetVal_OK)
5884 else if (retval.
value()!=TokenRetval::RetVal_OK)
5891 case TokenRetval::TK_HTMLTAG:
5893 if (!
parser()->context.token->endTag)
5905 if (!retval.
is(TokenRetval::RetVal_OK))
5911 case TokenRetval::TK_SYMBOL:
5922 parser()->context.token->name);
5926 case TokenRetval::TK_NEWPARA:
5927 retval = Token::make_TK_NEWPARA();
5929 case TokenRetval::TK_RCSTAG:
5932 while (n && !std::holds_alternative<DocSimpleSect>(*n) &&
5933 !std::holds_alternative<DocParamSect>(*n))
5943 retval = Token::make_RetVal_SimpleSec();
5954 "Found unexpected token (id={})",tok.
to_string());
5959 retval=Token::make_TK_NONE();
5962 DocPara *par = std::get_if<DocPara>(
parser()->context.nodeStack.top());
5963 if (!
parser()->context.token->endTag && par &&
5964 retval.
is(TokenRetval::TK_NEWPARA) &&
parser()->context.token->name.lower() ==
"p")
5968 INTERNAL_ASSERT(retval.
is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF,TokenRetval::TK_NEWPARA,TokenRetval::TK_LISTITEM,
5969 TokenRetval::TK_ENDLIST,TokenRetval::RetVal_OK)
5981 Token retval = Token::make_RetVal_OK();
5984 if (!
m_id.isEmpty())
6006 if (isFirst) { par->markFirst(); isFirst=
FALSE; }
6007 retval=par->parse();
6008 if (!par->isEmpty())
6017 if (retval.
is(TokenRetval::TK_LISTITEM))
6021 if (retval.
is(TokenRetval::RetVal_Internal))
6025 if (retval.is(TokenRetval::RetVal_EndInternal))
6027 retval = Token::make_RetVal_OK();
6030 }
while (!retval.
is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF, TokenRetval::RetVal_Section, TokenRetval::RetVal_Subsection,
6031 TokenRetval::RetVal_Subsubsection, TokenRetval::RetVal_Paragraph, TokenRetval::RetVal_SubParagraph,
6032 TokenRetval::RetVal_SubSubParagraph, TokenRetval::RetVal_EndInternal)
6039 if (retval.
is(TokenRetval::RetVal_Subsection) &&
m_level<=1)
6042 while (retval.
is(TokenRetval::RetVal_Subsection))
6051 else if (retval.
is(TokenRetval::RetVal_Subsubsection) &&
m_level<=2)
6057 parser()->tokenizer.getLineNr(),
6058 "Unexpected subsubsection command found inside {}!",
6062 while (retval.
is(TokenRetval::RetVal_Subsubsection))
6069 if (!(
m_level < 2 && retval.
is(TokenRetval::RetVal_Subsection)))
break;
6071 else if (retval.
is(TokenRetval::RetVal_Paragraph) &&
m_level<=3)
6077 "Unexpected paragraph command found inside {}!",
6081 while (retval.
is(TokenRetval::RetVal_Paragraph))
6088 if (!(
m_level<3 && (retval.
is_any_of(TokenRetval::RetVal_Subsection,TokenRetval::RetVal_Subsubsection))))
break;
6090 else if (retval.
is(TokenRetval::RetVal_SubParagraph) &&
m_level<=4)
6096 "Unexpected subparagraph command found inside {}!",
6100 while (retval.
is(TokenRetval::RetVal_SubParagraph))
6107 if (!(
m_level<4 && (retval.
is_any_of(TokenRetval::RetVal_Subsection,TokenRetval::RetVal_Subsubsection,TokenRetval::RetVal_Paragraph))))
break;
6109 else if (retval.
is(TokenRetval::RetVal_SubSubParagraph) &&
m_level<=5)
6115 "Unexpected subsubparagraph command found inside {}!",
6119 while (retval.
is(TokenRetval::RetVal_SubSubParagraph))
6126 if (!(
m_level<5 && (retval.
is_any_of( TokenRetval::RetVal_Subsection, TokenRetval::RetVal_Subsubsection,
6127 TokenRetval::RetVal_Paragraph, TokenRetval::RetVal_SubParagraph))))
break;
6136 TokenRetval::RetVal_Section, TokenRetval::RetVal_Subsection,
6137 TokenRetval::RetVal_Subsubsection, TokenRetval::RetVal_Paragraph,
6138 TokenRetval::RetVal_SubParagraph, TokenRetval::RetVal_SubSubParagraph,
6139 TokenRetval::RetVal_Internal, TokenRetval::RetVal_EndInternal)
6155 while (!tok.
is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF))
6159 case TokenRetval::TK_WORD:
6162 case TokenRetval::TK_WHITESPACE:
6165 case TokenRetval::TK_SYMBOL:
6175 parser()->context.token->name);
6179 case TokenRetval::TK_COMMAND_AT:
6181 case TokenRetval::TK_COMMAND_BS:
6243 parser()->context.token->name);
6267 Token retval = Token::make_TK_NONE();
6277 if (isFirst) { par->markFirst(); isFirst=
FALSE; }
6278 retval=par->parse();
6279 if (par->isEmpty() && par->attribs().empty())
6288 auto checkParagraph = [
this,&retval](
Token t,
int level,
const char *sectionType,
const char *parentSectionType) {
6294 parser()->tokenizer.getLineNr(),
6295 "found {} command (id: '{}') outside of {} context!",
6296 sectionType,
parser()->context.token->sectionId,parentSectionType);
6300 if (!
parser()->context.token->sectionId.isEmpty())
6313 sectionType,
parser()->context.token->sectionId,sectionType);
6314 retval = Token::make_TK_NONE();
6319 warn_doc_error(
parser()->context.fileName,
parser()->tokenizer.getLineNr(),
"Missing id for {}; ignoring {}",sectionType,sectionType);
6320 retval = Token::make_TK_NONE();
6325 checkParagraph(Token::make_RetVal_SubSubParagraph(), 6,
"subsubparagraph",
"subparagraph" );
6326 checkParagraph(Token::make_RetVal_SubParagraph(), 5,
"subparagraph",
"paragraph" );
6327 checkParagraph(Token::make_RetVal_Paragraph(), 4,
"paragraph",
"subsubsection" );
6328 checkParagraph(Token::make_RetVal_Subsubsection(), 3,
"subsubsection",
"subsection" );
6329 checkParagraph(Token::make_RetVal_Subsection(), 2,
"subsection",
"section" );
6331 if (retval.
is(TokenRetval::TK_LISTITEM))
6335 if (retval.
is(TokenRetval::RetVal_Internal))
6340 }
while (!retval.
is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF,TokenRetval::RetVal_Section));
6345 while (retval.
is(TokenRetval::RetVal_Section))
6347 if (!
parser()->context.token->sectionId.isEmpty())
6360 retval = Token::make_TK_NONE();
6366 retval = Token::make_TK_NONE();
bool isAliasCmd(std::string_view aliasCmd)
static AnchorGenerator & instance()
Returns the singleton instance.
QCString anchorPrefix() const
const CiteInfo * find(const QCString &label) const
Return the citation info for a given label.
static CitationManager & instance()
QCString fileName() const
static CiteInfoOption makeYear()
static CiteInfoOption makeNumber()
static CiteInfoOption makeShortAuthor()
Class representing a Boolean type option.
QCString * valueStringRef()
Class representing an enum type option.
static ConfigImpl * instance()
ConfigOption * get(const QCString &name) const
Class representing an integer type option.
QCString * valueStringRef()
Class representing a list type option.
Abstract base class for any configuration option.
@ O_Disabled
Disabled compile time option.
@ O_Enum
A fixed set of items.
@ O_Obsolete
An obsolete option.
@ O_Info
A section header.
Class representing a string type option.
The common base class of all entity definitions found in the sources.
virtual SrcLangExt getLanguage() const =0
Returns the programming language this definition was written in.
virtual bool isLinkable() const =0
virtual DefType definitionType() const =0
virtual QCString briefDescription(bool abbreviate=FALSE) const =0
virtual QCString getReference() const =0
virtual QCString getSourceFileBase() const =0
virtual QCString documentation() const =0
virtual QCString getOutputFileBase() const =0
virtual Definition * getOuterScope() const =0
virtual const QCString & name() const =0
DocAnchor(DocParser *parser, DocNodeVariant *parent, const QCString &id, bool newAnchor)
Node representing an auto List.
bool isCheckedList() const
DocAutoList(DocParser *parser, DocNodeVariant *parent, int indent, bool isEnumList, int depth, bool isCheckedList)
Node representing an item of a auto list.
DocAutoListItem(DocParser *parser, DocNodeVariant *parent, int indent, int num)
Node representing a citation of some bibliographic reference.
DocCite(DocParser *parser, DocNodeVariant *parent, const QCString &target, const QCString &context, CiteInfoOption opt)
DocCompoundNode(DocParser *parser, DocNodeVariant *parent)
DocDiaFile(DocParser *parser, DocNodeVariant *parent, const QCString &name, const QCString &context, const QCString &srcFile, int srcLine)
std::unique_ptr< Private > p
DocDiagramFileBase(DocParser *parser, DocNodeVariant *parent, const QCString &name, const QCString &context, const QCString &srcFile, int srcLine)
DocDotFile(DocParser *parser, DocNodeVariant *parent, const QCString &name, const QCString &context, const QCString &srcFile, int srcLine)
Node representing an emoji.
DocEmoji(DocParser *parser, DocNodeVariant *parent, const QCString &symName)
Node representing a horizontal ruler.
Node representing an HTML blockquote.
DocHtmlCaption(DocParser *parser, DocNodeVariant *parent, const HtmlAttribList &attribs)
const HtmlAttribList & attribs() const
Node representing a HTML table cell.
Valignment valignment() const
void setColumnIndex(uint32_t idx)
void setRowIndex(uint32_t idx)
void markLast(bool v=TRUE)
void markFirst(bool v=TRUE)
Alignment alignment() const
const HtmlAttribList & attribs() const
Node representing a HTML description data.
Node representing a Html description list.
Node representing a Html description item.
const HtmlAttribList & attribs() const
void parseSummary(DocNodeVariant *, HtmlAttribList &attribs)
const DocNodeVariant * summary() const
std::unique_ptr< DocNodeVariant > m_summary
Node representing a Html list.
Node representing a HTML list item.
Node representing a HTML table row.
Token parseXml(bool header)
void setVisibleCells(uint32_t n)
void setRowIndex(uint32_t idx)
Node representing a HTML table.
std::unique_ptr< DocNodeVariant > m_caption
void computeTableGrid()
determines the location of all cells in a grid, resolving row and column spans.
const DocNodeVariant * caption() const
const DocNodeVariant * firstRow() const
const HtmlAttribList & attribs() const
DocImage(DocParser *parser, DocNodeVariant *parent, const HtmlAttribList &attribs, const QCString &name, Type t, const QCString &url=QCString(), bool inlineImage=TRUE)
std::unique_ptr< Private > p
Node representing a include/dontinclude operator block.
const char * typeAsString() const
QCString m_includeFileName
void markLast(bool v=TRUE)
Node representing an included text block from file.
Node representing an entry in the index.
Node representing an internal section of documentation.
DocInternalRef(DocParser *parser, DocNodeVariant *parent, const QCString &target)
Node representing a line break.
Node representing a link to some item.
DocLink(DocParser *parser, DocNodeVariant *parent, const QCString &target)
QCString parse(bool, bool isXmlLink=FALSE)
DocLinkedWord(DocParser *parser, DocNodeVariant *parent, const QCString &word, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &tooltip)
DocMscFile(DocParser *parser, DocNodeVariant *parent, const QCString &name, const QCString &context, const QCString &srcFile, int srcLine)
DocNode(DocParser *parser, DocNodeVariant *parent)
void setInsidePreformatted(bool p)
DocNodeVariant * thisVariant()
DocNodeVariant * parent()
Node representing an block of paragraphs.
Node representing a paragraph in the documentation tree.
Token handleSimpleSection(DocSimpleSect::Type t, bool xmlContext=FALSE)
void handleLink(const QCString &cmdName, bool isJavaLink)
void handleCite(char cmdChar, const QCString &cmdName)
DocPara(DocParser *parser, DocNodeVariant *parent)
void handleInclude(const QCString &cmdName, DocInclude::Type t)
Token handleCommand(char cmdChar, const QCString &cmdName)
void handleDoxyConfig(char cmdChar, const QCString &cmdName)
void handleSection(char cmdChar, const QCString &cmdName)
void handleFile(const QCString &cmdName)
void handleIFile(char cmdChar, const QCString &cmdName)
Token handleParamSection(const QCString &cmdName, DocParamSect::Type t, bool xmlContext, int direction)
void markLast(bool v=TRUE)
Token handleHtmlStartTag(const QCString &tagName, const HtmlAttribList &tagHtmlAttribs)
void handleEmoji(char cmdChar, const QCString &cmdName)
void handleIncludeOperator(const QCString &cmdName, DocIncOperator::Type t)
void markFirst(bool v=TRUE)
void handleRef(char cmdChar, const QCString &cmdName)
void handleILine(char cmdChar, const QCString &cmdName)
void setAttribs(const HtmlAttribList &attribs)
Token handleHtmlHeader(const HtmlAttribList &tagHtmlAttribs, int level)
void handleShowDate(char cmdChar, const QCString &cmdName)
Token handleHtmlEndTag(const QCString &tagName)
bool injectToken(Token tok, const QCString &tokText)
void markFirst(bool b=TRUE)
Token parseXml(const QCString ¶mName)
void markLast(bool b=TRUE)
Token parse(const QCString &cmdName)
DocParamSect::Type m_type
Node representing a parameter section.
friend class DocParamList
Token parse(const QCString &cmdName, bool xmlContext, Direction d)
bool defaultHandleToken(DocNodeVariant *parent, Token tok, DocNodeList &children, bool handleWord=TRUE)
void handleLinkedWord(DocNodeVariant *parent, DocNodeList &children, bool ignoreAutoLinkFlag=FALSE)
void handleInternalRef(DocNodeVariant *parent, DocNodeList &children)
void handleParameterType(DocNodeVariant *parent, DocNodeList &children, const QCString ¶mTypes)
void readTextFileByName(const QCString &file, QCString &text)
Token handleAHref(DocNodeVariant *parent, DocNodeList &children, const HtmlAttribList &tagHtmlAttribs)
Token internalValidatingParseDoc(DocNodeVariant *parent, DocNodeList &children, const QCString &doc)
void handleInitialStyleCommands(DocNodeVariant *parent, DocNodeList &children)
void handleStyleLeave(DocNodeVariant *parent, DocNodeList &children, DocStyleChange::Style s, const QCString &tagName)
void handlePendingStyleCommands(DocNodeVariant *parent, DocNodeList &children)
void handleImage(DocNodeVariant *parent, DocNodeList &children)
void handleStyleEnter(DocNodeVariant *parent, DocNodeList &children, DocStyleChange::Style s, const QCString &tagName, const HtmlAttribList *attribs)
void handlePrefix(DocNodeVariant *parent, DocNodeList &children)
Token handleStyleArgument(DocNodeVariant *parent, DocNodeList &children, const QCString &cmdName)
void handleAnchor(DocNodeVariant *parent, DocNodeList &children)
void handleImg(DocNodeVariant *parent, DocNodeList &children, const HtmlAttribList &tagHtmlAttribs)
void defaultHandleTitleAndSize(const CommandType cmd, DocNodeVariant *parent, DocNodeList &children, QCString &width, QCString &height)
void handleUnclosedStyleCommands()
void errorHandleDefaultToken(DocNodeVariant *parent, Token tok, DocNodeList &children, const QCString &txt)
DocPlantUmlFile(DocParser *parser, DocNodeVariant *parent, const QCString &name, const QCString &context, const QCString &srcFile, int srcLine)
Node representing a reference to some item.
SectionType m_sectionType
DocRef(DocParser *parser, DocNodeVariant *parent, const QCString &target, const QCString &context)
Node representing a reference to a section.
DocSecRefItem(DocParser *parser, DocNodeVariant *parent, const QCString &target)
Node representing a list of section references.
Node representing a normal section.
std::unique_ptr< DocNodeVariant > m_title
DocSection(DocParser *parser, DocNodeVariant *parent, int level, const QCString &id)
const DocNodeVariant * title() const
Node representing a simple list.
Node representing a simple list item.
std::unique_ptr< DocNodeVariant > m_paragraph
DocSimpleListItem(DocParser *parser, DocNodeVariant *parent)
Node representing a simple section.
QCString typeString() const
Token parse(bool userTitle, bool needsSeparator)
DocSimpleSect(DocParser *parser, DocNodeVariant *parent, Type t)
const DocNodeVariant * title() const
void appendLinkWord(const QCString &word)
std::unique_ptr< DocNodeVariant > m_title
Node representing a separator between two simple sections of the same type.
Node representing a style change.
const char * styleString() const
Node representing a special symbol.
static HtmlEntityMapper::SymType decodeSymbol(const QCString &symName)
Node representing a simple section title.
void parseFromString(DocNodeVariant *, const QCString &title)
void setStateILiteralOpt()
void setStatePlantUMLOpt()
void setInsidePre(bool b)
void unputString(const QCString &tag)
void setStateDoxyConfig()
void setStateQuotedString()
void pushBackHtmlTag(const QCString &tag)
Node representing a URL (or email address)
Node representing a verbatim, unparsed text fragment.
DocVerbatim(DocParser *parser, DocNodeVariant *parent, const QCString &context, const QCString &text, Type t, bool isExample, const QCString &exampleFile, bool isBlock=FALSE, const QCString &lang=QCString())
std::unique_ptr< Private > p
QCString exampleFile() const
void setEngine(const QCString &e)
Node representing a VHDL flow chart.
DocVhdlFlow(DocParser *parser, DocNodeVariant *parent)
Node representing some amount of white space.
Node representing a word.
DocWord(DocParser *parser, DocNodeVariant *parent, const QCString &word)
Node representing an item of a cross-referenced list.
DocXRefItem(DocParser *parser, DocNodeVariant *parent, int id, const QCString &key)
static FileNameLinkedMap * plantUmlFileNameLinkedMap
static FileNameLinkedMap * dotFileNameLinkedMap
static NamespaceDefMutable * globalScope
static FileNameLinkedMap * mscFileNameLinkedMap
static FileNameLinkedMap * diaFileNameLinkedMap
static QCString htmlFileExtension
static PageLinkedMap * pageLinkedMap
static DirLinkedMap * dirLinkedMap
static SearchIndexIntf searchIndex
static EmojiEntityMapper & instance()
Returns the one and only instance of the Emoji entity mapper.
int symbol2index(const std::string &symName) const
Returns a code for the requested Emoji entity name.
A model of a file symbol.
virtual QCString absFilePath() const =0
void clear()
clears the contents
size_t size() const
returns the number of elements
iterator end()
returns an iterator to the end
T & back()
access the last element
void pop_back()
removes the last element
bool empty() const
checks whether the container is empty
void emplace_back(Args &&...args)
T & front()
access the first element
Class representing a list of HTML attributes.
static HtmlEntityMapper & instance()
Returns the one and only instance of the HTML entity mapper.
SymType name2sym(const QCString &symName) const
Give code of the requested HTML entity name.
const T * find(const std::string &key) const
A model of a class/file/namespace member symbol.
virtual const ClassDef * getClassDef() const =0
virtual const MemberDef * reimplements() const =0
virtual QCString objCMethodName(bool localLink, bool showStatic) const =0
A model of a page symbol.
virtual bool hasParentPage() const =0
This is an alternative implementation of QCString.
int find(char c, int index=0, bool cs=TRUE) const
void fill(char c, int len=-1)
Fills a string with a predefined character.
QCString & prepend(const char *s)
size_t length() const
Returns the length of the string, not counting the 0-terminator.
bool startsWith(const char *s) const
QCString mid(size_t index, size_t len=static_cast< size_t >(-1)) const
bool endsWith(const char *s) const
char & at(size_t i)
Returns a reference to the character at index i.
bool isEmpty() const
Returns TRUE iff the string is empty.
QCString stripWhiteSpace() const
returns a copy of this string with leading and trailing whitespace removed
const std::string & str() const
QCString & append(char c)
QCString right(size_t len) const
const char * data() const
Returns a pointer to the contents of the string in the form of a 0-terminated C string.
std::string_view view() const
QCString left(size_t len) const
This struct represents an item in the list of references.
List of cross-referenced items.
QCString sectionTitle() const
QCString fileName() const
RefItem * find(int itemId)
static RefListManager & instance()
class that provide information about a section.
QCString fileName() const
static SectionManager & instance()
returns a reference to the singleton
static constexpr int Anchor
static constexpr int Table
constexpr int level() const
static constexpr int Page
bool is(TokenRetval rv) const
TOKEN_SPECIFICATIONS RETVAL_SPECIFICATIONS const char * to_string() const
TokenRetval value() const
bool is_any_of(ARGS... args) const
char command_to_char() const
static void createFlowChart(const MemberDef *)
Class representing a regular expression.
Class to iterate through matches.
#define Config_getList(name)
#define Config_getBool(name)
#define Config_getString(name)
std::unordered_set< std::string > StringUnorderedSet
std::vector< std::string > StringVector
QCString formatDateTime(const QCString &format, const std::tm &dt, int &formatUsed)
Return a string representation for a given std::tm value that is formatted according to the pattern g...
QCString dateTimeFromString(const QCString &spec, std::tm &dt, int &format)
Returns the filled in std::tm for a given string representing a date and/or time.
constexpr const char * SF_bit2str(int bitNumber)
Helper function that returns the name related one of the SF bits.
constexpr int SF_NumBits
number of bits in SF vector
DirIterator end(const DirIterator &) noexcept
#define AUTO_TRACE_ADD(...)
static const char * g_sectionLevelToName[]
static QCString stripKnownExtensions(const QCString &text)
static void unescapeCRef(QCString &s)
static const StringUnorderedSet g_plantumlEngine
#define INTERNAL_ASSERT(x)
static void flattenParagraphs(DocNodeVariant *root, DocNodeList &children)
static Token skipSpacesForTable(DocParser *parser)
#define AUTO_TRACE_EXIT(...)
static bool findAttribute(const HtmlAttribList &tagHtmlAttribs, const char *attrName, QCString *result)
std::vector< ActiveRowSpan > RowSpanList
List of ActiveRowSpan classes.
static void setParent(DocNodeVariant *n, DocNodeVariant *newParent)
static bool checkIfHtmlEndTagEndsAutoList(DocParser *parser, const DocNodeVariant *n)
std::variant< DocWord, DocLinkedWord, DocURL, DocLineBreak, DocHorRuler, DocAnchor, DocCite, DocStyleChange, DocSymbol, DocEmoji, DocWhiteSpace, DocSeparator, DocVerbatim, DocInclude, DocIncOperator, DocFormula, DocIndexEntry, DocAutoList, DocAutoListItem, DocTitle, DocXRefItem, DocImage, DocDotFile, DocMscFile, DocDiaFile, DocVhdlFlow, DocLink, DocRef, DocInternalRef, DocHRef, DocHtmlHeader, DocHtmlDescTitle, DocHtmlDescList, DocSection, DocSecRefItem, DocSecRefList, DocInternal, DocParBlock, DocSimpleList, DocHtmlList, DocSimpleSect, DocSimpleSectSep, DocParamSect, DocPara, DocParamList, DocSimpleListItem, DocHtmlListItem, DocHtmlDescData, DocHtmlCell, DocHtmlCaption, DocHtmlRow, DocHtmlTable, DocHtmlBlockQuote, DocText, DocRoot, DocHtmlDetails, DocHtmlSummary, DocPlantUmlFile > DocNodeVariant
constexpr bool holds_one_of_alternatives(const DocNodeVariant &v)
returns true iff v holds one of types passed as template parameters
DocNodeList * call_method_children(DocNodeVariant *v)
constexpr DocNodeVariant * parent(DocNodeVariant *n)
returns the parent node of a given node n or nullptr if the node has no parent.
std::unique_ptr< DocNodeVariant > createDocNode(Args &&...args)
Private header shared between docparser.cpp and docnode.cpp.
bool insideUL(const DocNodeVariant *n)
bool insideTable(const DocNodeVariant *n)
IterableStack< const DocNodeVariant * > DocStyleChangeStack
bool insidePRE(const DocNodeVariant *n)
bool insideLI(const DocNodeVariant *n)
bool insideDL(const DocNodeVariant *n)
bool insideBlockQuote(const DocNodeVariant *n)
bool insideDetails(const DocNodeVariant *n)
bool insideOL(const DocNodeVariant *n)
FileDef * toFileDef(Definition *d)
GroupDef * toGroupDef(Definition *d)
if(macrofile.isEmpty()) return ""
Convert a set of LaTeX commands \(re)newcommand to a form readable by MathJax LaTeX syntax: \newcomm...
Translator * theTranslator
QCString markdownFileNameToId(const QCString &fileName)
processes string s and converts markdown into doxygen/html commands.
MemberDef * toMemberDef(Definition *d)
#define warn(file, line, fmt,...)
#define warn_doc_error(file, line, fmt,...)
const Mapper< HtmlTagType > * htmlTagMapper
const Mapper< CommandType > * cmdMapper
QCString trunc(const QCString &s, size_t numChars=15)
QCString substitute(const QCString &s, const QCString &src, const QCString &dst)
substitute all occurrences of src in s by dst
const char * qPrint(const char *s)
ActiveRowSpan(uint32_t rows, uint32_t col)
virtual QCString text() const =0
virtual QCString shortAuthor() const =0
virtual QCString label() const =0
virtual QCString year() const =0
void move_append(DocNodeList &l)
moves the element of list l at the end of this list.
void append(Args &&... args)
Append a new DocNodeVariant to the list by constructing it with type T and parameters Args.
T * get_last()
Returns a pointer to the last element in the list if that element exists and holds a T,...
StringMultiSet retvalsFound
bool includeFileShowLineNo
DocStyleChangeStack styleStack
StringMultiSet paramsFound
DefinitionStack copyStack
const MemberDef * memberDef
QCString linkToText(SrcLangExt lang, const QCString &link, bool isFileName)
SrcLangExt getLanguageFromFileName(const QCString &fileName, SrcLangExt defLang)
QCString stripIndentation(const QCString &s, bool skipFirstLine)
QCString showFileDefMatches(const FileNameLinkedMap *fnMap, const QCString &n)
QCString stripScope(const QCString &name)
bool resolveLink(const QCString &scName, const QCString &lr, bool, const Definition **resContext, QCString &resAnchor, SrcLangExt lang, const QCString &prefix)
QCString convertNameToFile(const QCString &name, bool allowDots, bool allowUnderscore)
StringVector split(const std::string &s, const std::string &delimiter)
split input string s by string delimiter delimiter.
QCString stripLeadingAndTrailingEmptyLines(const QCString &s, int &docLine)
Special version of QCString::stripWhiteSpace() that only strips completely blank lines.
FileDef * findFileDef(const FileNameLinkedMap *fnMap, const QCString &n, bool &ambig)
A bunch of utility functions.