Doxygen
Loading...
Searching...
No Matches
docnode.cpp File Reference
#include "docnode.h"
#include "docparser_p.h"
#include "htmlentity.h"
#include "configimpl.h"
#include "configoptions.h"
#include "emoji.h"
#include "message.h"
#include "doxygen.h"
#include "cite.h"
#include "util.h"
#include "formula.h"
#include "markdown.h"
#include "pagedef.h"
#include "namespacedef.h"
#include "groupdef.h"
#include "cmdmapper.h"
#include "config.h"
#include "vhdldocgen.h"
#include "doctokenizer.h"
#include "plantuml.h"
#include "language.h"
#include "datetime.h"
#include "trace.h"
#include "anchor.h"
#include "aliases.h"
Include dependency graph for docnode.cpp:

Go to the source code of this file.

Classes

struct  ActiveRowSpan
 Helper class to compute the grid for an HTML style table. More...

Macros

#define AUTO_TRACE(...)
#define AUTO_TRACE_ADD(...)
#define AUTO_TRACE_EXIT(...)
#define INTERNAL_ASSERT(x)

Typedefs

typedef std::vector< ActiveRowSpanRowSpanList
 List of ActiveRowSpan classes.

Functions

static void unescapeCRef (QCString &s)
static QCString stripKnownExtensions (const QCString &text)
static void setParent (DocNodeVariant *n, DocNodeVariant *newParent)
static void flattenParagraphs (DocNodeVariant *root, DocNodeList &children)
static Token skipSpacesForTable (DocParser *parser)
static bool findAttribute (const HtmlAttribList &tagHtmlAttribs, const char *attrName, QCString *result)
static bool checkIfHtmlEndTagEndsAutoList (DocParser *parser, const DocNodeVariant *n)

Variables

static const char * g_sectionLevelToName []
static const StringUnorderedSet g_plantumlEngine

Macro Definition Documentation

◆ AUTO_TRACE

#define AUTO_TRACE ( ...)
Value:
(void)0

Definition at line 46 of file docnode.cpp.

Referenced by MemberDefImpl::_computeLinkableInProject(), SymbolResolver::Private::accessibleViaUsingDefinition(), SymbolResolver::Private::accessibleViaUsingNamespace(), addClassAndNestedClasses(), addClassToContext(), ModuleDefImpl::addClassToModule(), addConceptToContext(), ModuleDefImpl::addConceptToModule(), ModuleManager::addDocs(), addEnumDocs(), addEnumValuesToEnums(), ModuleDefImpl::addExportedModule(), addGlobalFunction(), ModuleDefImpl::addHeader(), ModuleManager::addHeader(), ModuleDefImpl::addImport(), ModuleManager::addImport(), addInterfaceOrServiceToServiceOrSingleton(), addListReferences(), addLocalObjCMethod(), addMemberDocs(), addMemberFunction(), addMemberSpecialization(), ClassDefImpl::addMembersToTemplateInstance(), ClassDefImpl::addMemberToList(), ModuleDefImpl::addMemberToModule(), ClassDefImpl::addMemberToTemplateInstance(), addMethodToClass(), Markdown::Private::addStrEscapeUtf8Nbsp(), DirDefImpl::addUsesDependency(), addVariable(), addVariableToClass(), addVariableToFile(), adjustConfiguration(), buildClassDocList(), buildClassList(), buildConceptDocList(), buildConceptList(), buildDefineList(), buildDictionaryList(), buildDirectories(), buildFunctionList(), buildGroupListFiltered(), buildInterfaceAndServiceList(), buildNamespaceList(), buildSequenceList(), buildTypedefList(), buildVarList(), checkConfiguration(), ClassDefImpl::ClassDefImpl(), ModuleManager::collectExportedSymbols(), ModuleManager::collectExportedSymbolsRecursively(), combineDeclarationAndDefinition(), computeClassRelations(), computeCommonDirPrefix(), DirDefImpl::computeDependencies(), computeDirDependencies(), computeIndentExcludingListMarkers(), computeMemberReferences(), computeTemplateClassRelations(), ClassDefImpl::containsOverload(), ModuleManager::createModuleDef(), DirDefImpl::createNewDir(), createUsingMemberImportForClass(), ClassDefImpl::deepCopy(), DocParser::defaultHandleTitleAndSize(), DocParser::defaultHandleToken(), distributeConceptGroups(), DocRef::DocRef(), encodeDirName(), extractCanonicalType(), Markdown::extractPageTitle(), Markdown::Private::extractTitleId(), filterMemberDocumentation(), findBaseClassesForClass(), CodeFragmentManager::Private::FragmentInfo::findBlockMarkers(), findClassRelation(), DocParser::findDocsForMemberOrCompound(), Markdown::Private::findEmphasisChar(), Markdown::Private::findEndOfLine(), findEnumDocumentation(), findEnums(), findFriends(), findFunctionPtr(), findGlobalMember(), findInheritedTemplateInstances(), findMember(), findMemberDocumentation(), findModuleDocumentation(), findObjCMethodDefinitions(), findTableColumns(), findTemplateInstanceRelation(), findUsedClassesForClass(), findUsedTemplateInstances(), findUsingDeclarations(), findUsingDeclImports(), findUsingDirectives(), SymbolResolver::Private::followPath(), generateDirDocs(), generateDocsForClassList(), generateOutput(), generateXRefPages(), getCanonicalTypeForIdentifier(), ClassDefImpl::getOutputFileBase(), DirDefImpl::getOutputFileBase(), SymbolResolver::Private::getResolvedSymbol(), SymbolResolver::Private::getResolvedSymbolRec(), SymbolResolver::Private::getResolvedType(), SymbolResolver::Private::getResolvedTypeRec(), DocParser::handleAHref(), DocParser::handleAnchor(), DocPara::handleCite(), DocPara::handleCommand(), handleCommentBlock(), DocPara::handleEmoji(), DocPara::handleFile(), DocPara::handleHtmlEndTag(), DocPara::handleHtmlHeader(), DocPara::handleHtmlStartTag(), DocPara::handleIFile(), DocPara::handleILine(), DocParser::handleImage(), DocParser::handleImg(), DocPara::handleInclude(), DocPara::handleIncludeOperator(), DocParser::handleInitialStyleCommands(), DocParser::handleInternalRef(), DocPara::handleLink(), DocParser::handleLinkedWord(), handleParametersCommentBlocks(), DocParser::handleParameterType(), DocPara::handleParamSection(), DocParser::handlePendingStyleCommands(), DocParser::handlePrefix(), DocPara::handleRef(), DocPara::handleSection(), DocPara::handleShowDate(), DocPara::handleSimpleSection(), DocPara::handleStartCode(), DocParser::handleStyleArgument(), DocParser::handleStyleEnter(), DocParser::handleStyleLeave(), DocParser::handleUnclosedStyleCommands(), DocPara::handleVhdlFlow(), DocPara::handleXRefItem(), hasLineBreak(), DocPara::injectToken(), ClassDefImpl::insertExplicitTemplateInstance(), ClassDefImpl::insertTemplateInstance(), ClassDefImpl::internalInsertMember(), DocParser::internalValidatingParseDoc(), SymbolResolver::isAccessibleFrom(), SymbolResolver::Private::isAccessibleFrom(), SymbolResolver::isAccessibleFromWithExpScope(), SymbolResolver::Private::isAccessibleFromWithExpScope(), Markdown::Private::isAtxHeader(), Markdown::Private::isBlockCommand(), isBlockQuote(), isCodeBlock(), isEmptyLine(), isEndOfList(), isExplicitPage(), isFencedCodeBlock(), Markdown::Private::isHeaderline(), isHRuler(), isLinkRef(), isListMarker(), Markdown::Private::isSpecialCommand(), isTableBlock(), isVarWithConstructor(), makeTemplateInstanceRelation(), markdownFileNameToId(), matchArgument2(), matchArguments2(), matchCanonicalTypes(), matchTemplateArguments(), mergeArguments(), mergeCategories(), ClassDefImpl::mergeCategory(), DirDefImpl::mergeDirectoryInTree(), mergeScopes(), ModuleDefImpl::mergeSymbolsFrom(), SymbolResolver::Private::newResolveTypedef(), organizeSubGroupsFiltered(), DocAutoList::parse(), DocAutoListItem::parse(), DocHRef::parse(), DocHtmlBlockQuote::parse(), DocHtmlCaption::parse(), DocHtmlCell::parse(), DocHtmlDescData::parse(), DocHtmlDescList::parse(), DocHtmlDescTitle::parse(), DocHtmlDetails::parse(), DocHtmlHeader::parse(), DocHtmlList::parse(), DocHtmlListItem::parse(), DocHtmlRow::parse(), DocHtmlSummary::parse(), DocHtmlTable::parse(), DocInclude::parse(), DocIncOperator::parse(), DocIndexEntry::parse(), DocInternal::parse(), DocInternalRef::parse(), DocLink::parse(), DocPara::parse(), DocParamList::parse(), DocParamSect::parse(), DocParBlock::parse(), DocRef::parse(), DocRoot::parse(), DocSecRefItem::parse(), DocSecRefList::parse(), DocSection::parse(), DocSimpleSect::parse(), DocText::parse(), DocTitle::parse(), DocVhdlFlow::parse(), CodeFragmentManager::parseCodeFragment(), CommentScanner::parseCommentBlock(), parseCompounds(), parseFile(), parseFilesMultiThreading(), parseFilesSingleThreading(), COutlineParser::parseInput(), parseInput(), parseMain(), parsePrototype(), DocSimpleSect::parseRcs(), DocHtmlDetails::parseSummary(), DocHtmlCell::parseXml(), DocHtmlList::parseXml(), DocHtmlListItem::parseXml(), DocHtmlRow::parseXml(), DocHtmlTable::parseXml(), DocParamList::parseXml(), DocSimpleSect::parseXml(), Markdown::Private::processBlocks(), Markdown::Private::processCodeSpan(), DocParser::processCopyDoc(), Markdown::Private::processEmphasis(), Markdown::Private::processEmphasis1(), Markdown::Private::processEmphasis2(), Markdown::Private::processEmphasis3(), Preprocessor::processFile(), Markdown::Private::processHtmlTag(), Markdown::Private::processHtmlTagWrite(), Markdown::Private::processInline(), Markdown::Private::processLink(), Markdown::Private::processNmdash(), Markdown::Private::processQuotations(), Markdown::Private::processQuoted(), Markdown::Private::processSpecialCommand(), readIncludeFile(), DocParser::readTextFileByName(), readTextFileByName(), SymbolResolver::resolveClass(), ModuleManager::resolveImports(), resolveLink(), ModuleManager::resolvePartitions(), ModuleManager::resolvePartitionsRecursively(), resolveRef(), SymbolResolver::resolveSymbol(), resolveTemplateInstanceInType(), resolveTypeDef(), skipSpacesForTable(), substituteTemplateArgumentsInString(), SymbolResolver::Private::substTypedef(), transferFunctionDocumentation(), transferFunctionReferences(), transferRelatedFunctionDocumentation(), transferStaticInstanceInitializers(), warnUndocumentedNamespaces(), Markdown::Private::writeBlockQuote(), DirDefImpl::writeBriefDescription(), Markdown::Private::writeCodeBlock(), DirDefImpl::writeDetailedDescription(), ClassDefImpl::writeDocumentation(), DirDefImpl::writeDocumentation(), DirRelation::writeDocumentation(), ModuleDefImpl::writeDocumentation(), ModuleDefImpl::writeExports(), Markdown::Private::writeFencedCodeBlock(), DirDefImpl::writeFileList(), ModuleDefImpl::writeFiles(), Markdown::Private::writeMarkdownImage(), Markdown::Private::writeOneLineHeaderOrRuler(), DirDefImpl::writeSubDirList(), and Markdown::Private::writeTableBlock().

◆ AUTO_TRACE_ADD

#define AUTO_TRACE_ADD ( ...)
Value:
(void)0

Definition at line 47 of file docnode.cpp.

Referenced by MemberDefImpl::_computeLinkableInProject(), SymbolResolver::Private::accessibleViaUsingDefinition(), SymbolResolver::Private::accessibleViaUsingNamespace(), addClassToContext(), addConceptToContext(), addEnumValuesToEnums(), ModuleManager::addHeader(), ModuleManager::addImport(), addLocalObjCMethod(), addMemberFunction(), DirDefImpl::addUsesDependency(), addVariable(), addVariableToClass(), addVariableToFile(), buildDefineList(), buildDirectories(), buildFunctionList(), buildGroupListFiltered(), buildNamespaceList(), buildTypedefList(), ModuleManager::collectExportedSymbols(), combineDeclarationAndDefinition(), computeCommonDirPrefix(), DirDefImpl::computeDependencies(), computeDirDependencies(), computeTemplateClassRelations(), DirDefImpl::createNewDir(), ClassDefImpl::deepCopy(), DocParser::defaultHandleToken(), distributeConceptGroups(), CodeFragmentManager::Private::FragmentInfo::findBlockMarkers(), findClassRelation(), findEnumDocumentation(), findEnums(), findFriends(), findGlobalMember(), findMember(), findTemplateInstanceRelation(), findUsedClassesForClass(), findUsingDeclarations(), findUsingDeclImports(), findUsingDirectives(), SymbolResolver::Private::followPath(), getCanonicalTypeForIdentifier(), SymbolResolver::Private::getResolvedSymbol(), SymbolResolver::Private::getResolvedSymbolRec(), SymbolResolver::Private::getResolvedType(), SymbolResolver::Private::getResolvedTypeRec(), DocParser::handleImg(), DocParser::handleLinkedWord(), handleParametersCommentBlocks(), ClassDefImpl::internalInsertMember(), SymbolResolver::Private::isAccessibleFrom(), SymbolResolver::Private::isAccessibleFromWithExpScope(), isLinkRef(), makeTemplateInstanceRelation(), mergeArguments(), mergeCategories(), ClassDefImpl::mergeCategory(), SymbolResolver::Private::newResolveTypedef(), organizeSubGroupsFiltered(), DocIncOperator::parse(), DocPara::parse(), CodeFragmentManager::parseCodeFragment(), parseCompounds(), parseInput(), Markdown::Private::processCodeSpan(), Markdown::Private::processSpecialCommand(), readIncludeFile(), SymbolResolver::resolveClass(), ModuleManager::resolveImports(), ModuleManager::resolvePartitionsRecursively(), resolveRef(), resolveTemplateInstanceInType(), resolveTypeDef(), skipSpacesForTable(), substituteTemplateArgumentsInString(), transferFunctionReferences(), transferRelatedFunctionDocumentation(), transferStaticInstanceInitializers(), Markdown::Private::writeBlockQuote(), DirDefImpl::writeFileList(), and DirDefImpl::writeSubDirList().

◆ AUTO_TRACE_EXIT

#define AUTO_TRACE_EXIT ( ...)
Value:
(void)0

Definition at line 48 of file docnode.cpp.

Referenced by SymbolResolver::Private::accessibleViaUsingDefinition(), SymbolResolver::Private::accessibleViaUsingNamespace(), ClassDefImpl::ClassDefImpl(), computeIndentExcludingListMarkers(), ClassDefImpl::containsOverload(), DocParser::defaultHandleTitleAndSize(), DocRef::DocRef(), encodeDirName(), extractCanonicalType(), Markdown::extractPageTitle(), Markdown::Private::extractTitleId(), DocParser::findDocsForMemberOrCompound(), Markdown::Private::findEmphasisChar(), Markdown::Private::findEndOfLine(), findFunctionPtr(), findTableColumns(), SymbolResolver::Private::followPath(), getCanonicalTypeForIdentifier(), SymbolResolver::Private::getResolvedSymbol(), SymbolResolver::Private::getResolvedSymbolRec(), SymbolResolver::Private::getResolvedType(), SymbolResolver::Private::getResolvedTypeRec(), DocPara::handleCommand(), DocPara::handleHtmlEndTag(), DocPara::handleHtmlStartTag(), DocPara::handleParamSection(), DocPara::handleStartCode(), DocParser::handleStyleArgument(), hasLineBreak(), DocParser::internalValidatingParseDoc(), SymbolResolver::isAccessibleFrom(), SymbolResolver::Private::isAccessibleFrom(), SymbolResolver::isAccessibleFromWithExpScope(), SymbolResolver::Private::isAccessibleFromWithExpScope(), Markdown::Private::isAtxHeader(), Markdown::Private::isBlockCommand(), isBlockQuote(), isCodeBlock(), isEmptyLine(), isEndOfList(), isExplicitPage(), isFencedCodeBlock(), Markdown::Private::isHeaderline(), isHRuler(), isLinkRef(), isListMarker(), Markdown::Private::isSpecialCommand(), isTableBlock(), isVarWithConstructor(), markdownFileNameToId(), matchArgument2(), matchTemplateArguments(), mergeScopes(), SymbolResolver::Private::newResolveTypedef(), DocAutoList::parse(), DocAutoListItem::parse(), DocHtmlBlockQuote::parse(), DocHtmlDetails::parse(), DocHtmlList::parse(), DocHtmlListItem::parse(), DocIndexEntry::parse(), DocInternal::parse(), DocPara::parse(), DocParamList::parse(), DocParamSect::parse(), DocParBlock::parse(), DocSection::parse(), DocSimpleSect::parse(), CommentScanner::parseCommentBlock(), DocHtmlList::parseXml(), DocHtmlListItem::parseXml(), DocParamList::parseXml(), DocSimpleSect::parseXml(), Markdown::Private::processCodeSpan(), DocParser::processCopyDoc(), Markdown::Private::processEmphasis(), Markdown::Private::processEmphasis1(), Markdown::Private::processEmphasis2(), Markdown::Private::processEmphasis3(), Markdown::Private::processHtmlTagWrite(), Markdown::Private::processLink(), Markdown::Private::processNmdash(), Markdown::Private::processQuoted(), Markdown::Private::processSpecialCommand(), SymbolResolver::resolveClass(), resolveLink(), SymbolResolver::resolveSymbol(), resolveTypeDef(), substituteTemplateArgumentsInString(), SymbolResolver::Private::substTypedef(), Markdown::Private::writeBlockQuote(), Markdown::Private::writeCodeBlock(), and Markdown::Private::writeTableBlock().

◆ INTERNAL_ASSERT

#define INTERNAL_ASSERT ( x)
Value:
do {} while(0)

Definition at line 51 of file docnode.cpp.

Referenced by DocPara::handleCommand(), DocPara::parse(), and DocSection::parse().

Typedef Documentation

◆ RowSpanList

typedef std::vector<ActiveRowSpan> RowSpanList

List of ActiveRowSpan classes.

Definition at line 2340 of file docnode.cpp.

Function Documentation

◆ checkIfHtmlEndTagEndsAutoList()

bool checkIfHtmlEndTagEndsAutoList ( DocParser * parser,
const DocNodeVariant * n )
static

Definition at line 5655 of file docnode.cpp.

5656{
5657 // expected hierarchy:
5658 // 1. DocAutoListItem <- n
5659 // 2. DocAutoList <- parent(n)
5660 // 3. DocPara <- parent(parent(n))
5661
5662 // step 1
5663 if (!std::get_if<DocAutoListItem>(n)) // not inside a auto list item
5664 {
5665 return false;
5666 }
5667
5668 // step 2
5669 n = parent(n);
5670 int indent = 0;
5671 const auto docAutoList = std::get_if<DocAutoList>(n);
5672 if (docAutoList) // capture indent
5673 {
5674 indent = docAutoList->indent();
5675 }
5676 else
5677 {
5678 return false;
5679 }
5680
5681 // step 3
5682 n = parent(n);
5683 const auto docPara = std::get_if<DocPara>(n);
5684 if (docPara)
5685 {
5686 QCString tagNameLower = QCString(parser->context.token->name).lower();
5687 auto topStyleChange = [](const DocStyleChangeStack &stack) -> const DocStyleChange &
5688 {
5689 return std::get<DocStyleChange>(*stack.top());
5690 };
5691
5692 if (parser->context.styleStack.empty() || // no style change
5693 (topStyleChange(parser->context.styleStack).tagName()==tagNameLower && // correct style change
5694 topStyleChange(parser->context.styleStack).position()!=parser->context.nodeStack.size()) // wrong position, so normal close
5695 )
5696 {
5697 // insert an artificial 'end of autolist' marker and parse again
5698 QCString indentStr;
5699 indentStr.fill(' ',indent);
5700 parser->tokenizer.unputString("\\ilinebr "+indentStr+".\\ilinebr"+indentStr+"</"+parser->context.token->name+">");
5701 return true;
5702 }
5703 }
5704 return false;
5705}
DocTokenizer tokenizer
DocParserContext context
Node representing a style change.
Definition docnode.h:268
void unputString(const QCString &tag)
This is an alternative implementation of QCString.
Definition qcstring.h:101
QCString lower() const
Definition qcstring.h:249
QCString fill(char c, int len=-1)
Fills a string with a predefined character.
Definition qcstring.h:193
constexpr DocNodeVariant * parent(DocNodeVariant *n)
returns the parent node of a given node n or nullptr if the node has no parent.
Definition docnode.h:1330
IterableStack< const DocNodeVariant * > DocStyleChangeStack
Definition docparser_p.h:55
DocStyleChangeStack styleStack
Definition docparser_p.h:68
DocNodeStack nodeStack
Definition docparser_p.h:67
TokenInfo * token
Definition docparser_p.h:93
QCString name

References DocParser::context, QCString::fill(), QCString::lower(), TokenInfo::name, DocParserContext::nodeStack, parent(), DocParserContext::styleStack, DocParserContext::token, DocParser::tokenizer, and DocTokenizer::unputString().

Referenced by DocPara::parse().

◆ findAttribute()

bool findAttribute ( const HtmlAttribList & tagHtmlAttribs,
const char * attrName,
QCString * result )
static

Definition at line 4945 of file docnode.cpp.

4948{
4949
4950 for (const auto &opt : tagHtmlAttribs)
4951 {
4952 if (opt.name==attrName)
4953 {
4954 *result = opt.value;
4955 return TRUE;
4956 }
4957 }
4958 return FALSE;
4959}
#define TRUE
Definition qcstring.h:37
#define FALSE
Definition qcstring.h:34

References FALSE, and TRUE.

Referenced by DocPara::handleHtmlStartTag().

◆ flattenParagraphs()

void flattenParagraphs ( DocNodeVariant * root,
DocNodeList & children )
static

Definition at line 837 of file docnode.cpp.

838{
839 DocNodeList newChildren;
840 for (auto &dn : children)
841 {
842 DocPara *para = std::get_if<DocPara>(&dn);
843 if (para)
844 {
845 //// move the children of the paragraph to the end of the newChildren list
846 newChildren.move_append(para->children());
847 }
848 }
849
850 // replace the children list by the newChildren list
851 children.clear();
852 children.move_append(newChildren);
853 // reparent the children
854 for (auto &cn : children)
855 {
856 setParent(&cn,root);
857 // we also need to set the parent for each child of cn, as cn's address may have changed.
858 auto opt_children = call_method_children(&cn);
859 if (opt_children)
860 {
861 for (auto &ccn : *opt_children)
862 {
863 setParent(&ccn,&cn);
864 }
865 }
866 }
867}
DocNodeList & children()
Definition docnode.h:143
Node representing a paragraph in the documentation tree.
Definition docnode.h:1080
void clear()
clears the contents
Definition growvector.h:143
static void setParent(DocNodeVariant *n, DocNodeVariant *newParent)
Definition docnode.cpp:117
DocNodeList * call_method_children(DocNodeVariant *v)
Definition docnode.h:1385
void move_append(DocNodeList &l)
moves the element of list l at the end of this list.
Definition docnode.cpp:828

References call_method_children(), DocCompoundNode::children(), GrowVector< T >::clear(), DocNodeList::move_append(), and setParent().

Referenced by DocRef::parse(), and DocTitle::parseFromString().

◆ setParent()

void setParent ( DocNodeVariant * n,
DocNodeVariant * newParent )
static

Definition at line 117 of file docnode.cpp.

118{
119 std::visit([&](auto &&x)->decltype(auto) { return x.setParent(newParent); }, *n);
120}

Referenced by flattenParagraphs().

◆ skipSpacesForTable()

Token skipSpacesForTable ( DocParser * parser)
static

Definition at line 1949 of file docnode.cpp.

1950{
1951 AUTO_TRACE();
1952 // get next token
1953 Token tok=parser->tokenizer.lex();
1954 // skip whitespace and tbody, thead and tfoot tags
1955 while (tok.is_any_of(TokenRetval::TK_WHITESPACE,TokenRetval::TK_NEWPARA,TokenRetval::TK_HTMLTAG,
1956 TokenRetval::TK_COMMAND_AT,TokenRetval::TK_COMMAND_BS))
1957 {
1958 if (tok.is(TokenRetval::TK_HTMLTAG))
1959 {
1960 AUTO_TRACE_ADD("html_tag={}",parser->context.token->name);
1962 // skip over tbody, thead, tfoot tags
1963 if (tagId==HtmlTagType::HTML_TBODY ||
1964 tagId==HtmlTagType::HTML_THEAD ||
1966 {
1967 tok=parser->tokenizer.lex();
1968 }
1969 else
1970 {
1971 break;
1972 }
1973 }
1974 else if (tok.is(TokenRetval::TK_COMMAND_AT) || tok.is(TokenRetval::TK_COMMAND_BS))
1975 {
1976 QCString cmdName=parser->context.token->name;
1977 AUTO_TRACE_ADD("command={}",cmdName);
1978 auto cmdType = Mappers::cmdMapper->map(cmdName);
1979 if (cmdType==CommandType::CMD_ILINE)
1980 {
1981 parser->tokenizer.pushState();
1982 parser->tokenizer.setStateILine();
1983 tok = parser->tokenizer.lex();
1984 if (!tok.is(TokenRetval::TK_WORD))
1985 {
1986 warn_doc_error(parser->context.fileName,parser->tokenizer.getLineNr(),"invalid argument for command '{:c}{}'",
1987 tok.command_to_char(),cmdName);
1988 }
1989 parser->tokenizer.popState();
1990 tok = parser->tokenizer.lex();
1991 }
1992 else
1993 {
1994 break;
1995 }
1996 }
1997 else
1998 {
1999 AUTO_TRACE_ADD("skip whitespace");
2000 tok=parser->tokenizer.lex();
2001 }
2002 }
2003 return tok;
2004}
void setStateILine()
int getLineNr(void)
bool is(TokenRetval rv) const
bool is_any_of(ARGS... args) const
char command_to_char() const
HtmlTagType
Definition cmdmapper.h:169
#define AUTO_TRACE_ADD(...)
Definition docnode.cpp:47
#define AUTO_TRACE(...)
Definition docnode.cpp:46
#define warn_doc_error(file, line, fmt,...)
Definition message.h:112
const Mapper< HtmlTagType > * htmlTagMapper
const Mapper< CommandType > * cmdMapper
QCString fileName
Definition docparser_p.h:71

References AUTO_TRACE, AUTO_TRACE_ADD, CMD_ILINE, Mappers::cmdMapper, Token::command_to_char(), DocParser::context, DocParserContext::fileName, DocTokenizer::getLineNr(), HTML_TBODY, HTML_TFOOT, HTML_THEAD, Mappers::htmlTagMapper, Token::is(), Token::is_any_of(), DocTokenizer::lex(), TokenInfo::name, DocTokenizer::popState(), DocTokenizer::pushState(), DocTokenizer::setStateILine(), DocParserContext::token, DocParser::tokenizer, and warn_doc_error.

Referenced by DocHtmlRow::parse(), and DocHtmlTable::parse().

◆ stripKnownExtensions()

QCString stripKnownExtensions ( const QCString & text)
static

Strips known html and tex extensions from text.

Definition at line 103 of file docnode.cpp.

104{
105 QCString result=text;
106 if (result.endsWith(".tex"))
107 {
108 result=result.left(result.length()-4);
109 }
111 {
112 result=result.left(result.length()-Doxygen::htmlFileExtension.length());
113 }
114 return result;
115}
static QCString htmlFileExtension
Definition doxygen.h:122
size_t length() const
Returns the length of the string, not counting the 0-terminator.
Definition qcstring.h:166
bool endsWith(const char *s) const
Definition qcstring.h:524
QCString right(size_t len) const
Definition qcstring.h:234
QCString left(size_t len) const
Definition qcstring.h:229

References QCString::endsWith(), Doxygen::htmlFileExtension, QCString::left(), QCString::length(), and QCString::right().

Referenced by DocLink::DocLink(), DocRef::DocRef(), and DocSecRefItem::parse().

◆ unescapeCRef()

void unescapeCRef ( QCString & s)
static

Definition at line 81 of file docnode.cpp.

82{
83 QCString result;
84 const char *p = s.data();
85 if (p)
86 {
87 char c = 0;
88 while ((c=*p++))
89 {
90 if (c=='{') c='<'; else if (c=='}') c='>';
91 result+=c;
92 }
93 }
94
95 result=substitute(result,"&lt;","<");
96 result=substitute(result,"&gt;",">");
97 s = result;
98}
const char * data() const
Returns a pointer to the contents of the string in the form of a 0-terminated C string.
Definition qcstring.h:172
QCString substitute(const QCString &s, const QCString &src, const QCString &dst)
substitute all occurrences of src in s by dst
Definition qcstring.cpp:482

References QCString::data(), and substitute().

Referenced by DocPara::handleHtmlStartTag().

Variable Documentation

◆ g_plantumlEngine

const StringUnorderedSet g_plantumlEngine
static
Initial value:
{
"uml", "bpm", "wire", "dot", "ditaa",
"salt", "math", "latex", "gantt", "mindmap",
"wbs", "yaml", "creole", "json", "flow",
"board", "git", "hcl", "regex", "ebnf",
"files", "chen", "chronology"
}

Definition at line 69 of file docnode.cpp.

69 {
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"
75};

Referenced by DocPara::handleCommand().

◆ g_sectionLevelToName

const char* g_sectionLevelToName[]
static
Initial value:
=
{
"page",
"section",
"subsection",
"subsubsection",
"paragraph",
"subparagraph"
}

Definition at line 56 of file docnode.cpp.

57{
58 "page",
59 "section",
60 "subsection",
61 "subsubsection",
62 "paragraph",
63 "subparagraph"
64};

Referenced by DocSection::parse().