Doxygen
Loading...
Searching...
No Matches
docparser_p.h
Go to the documentation of this file.
1/******************************************************************************
2 *
3 * Copyright (C) 1997-2022 by Dimitri van Heesch.
4 *
5 * Permission to use, copy, modify, and distribute this software and its
6 * documentation under the terms of the GNU General Public License is hereby
7 * granted. No representations are made about the suitability of this software
8 * for any purpose. It is provided "as is" without express or implied warranty.
9 * See the GNU General Public License for more details.
10 *
11 * Documents produced by Doxygen are derivative works derived from the
12 * input used in their production; they are not affected by this license.
13 *
14 */
15
16#ifndef DOCPARSER_P_H
17#define DOCPARSER_P_H
18
19/** @file
20 * @brief Private header shared between docparser.cpp and docnode.cpp
21 */
22
23#include <cassert>
24#include <stack>
25#include <iterator>
26#include <vector>
27#include <deque>
28#include <cstdint>
29
30#include "containers.h"
31#include "docparser.h"
32#include "docnode.h"
33#include "doctokenizer.h"
34#include "searchindex.h"
35#include "construct.h"
36#include "cmdmapper.h"
37
38using DefinitionStack = std::vector<const Definition *>;
39using DocNodeStack = std::stack<DocNodeVariant *>;
40
41template<typename T, typename Container = std::deque<T>>
42class IterableStack : public std::stack<T, Container>
43{
44 using std::stack<T, Container>::c;
45
46public:
47
48 // expose just the iterators of the underlying container
49 auto begin() { return std::begin(c); }
50 auto end() { return std::end(c); }
51
52 auto begin() const { return std::begin(c); }
53 auto end() const { return std::end(c); }
54};
56
57/** Parser's context to store all global variables.
58 */
98
99class DocParser : public IDocParser
100{
101 public:
102 void pushContext();
103 void popContext();
104 void handleImg(DocNodeVariant *parent,DocNodeList &children,const HtmlAttribList &tagHtmlAttribs);
106 const QCString &doc);
107 QCString processCopyDoc(const char *data,size_t &len);
108 QCString findAndCopyImage(const QCString &fileName,DocImage::Type type, bool doWarn = true);
109 void checkArgumentName();
110 void checkRetvalName();
112 bool findDocsForMemberOrCompound(const QCString &commandName,
113 QCString *pDoc,
114 QCString *pBrief,
115 const Definition **pDef);
117 DocNodeList &children,bool
118 handleWord=TRUE);
120 DocNodeList &children,const QCString &txt);
122 DocNodeList &children, QCString &width,QCString &height);
124 const QCString &cmdName);
126 const QCString &tagName,const HtmlAttribList *attribs);
128 const QCString &tagName);
131 Token handleAHref(DocNodeVariant *parent,DocNodeList &children,const HtmlAttribList &tagHtmlAttribs);
133 void handleLinkedWord(DocNodeVariant *parent,DocNodeList &children,bool ignoreAutoLinkFlag=FALSE);
134 void handleParameterType(DocNodeVariant *parent,DocNodeList &children,const QCString &paramTypes);
139 void readTextFileByName(const QCString &file,QCString &text);
140
141 std::stack< DocParserContext > contextStack;
144};
145
146//---------------------------------------------------------------------------
147
149{
150 public:
152 : m_parser(parser), m_node(node) { m_parser->context.nodeStack.push(node); }
154 {
155#if defined(NDEBUG)
156 (void)m_node;
157 if (!m_parser->context.nodeStack.empty())
158 {
159 m_parser->context.nodeStack.pop(); // robust version that does not assert
160 }
161#else
162 assert(m_parser->context.nodeStack.top()==m_node);
163 m_parser->context.nodeStack.pop(); // error checking version
164#endif
165 }
167
168 private:
171};
172
173inline bool isPreformatted(const DocNodeVariant *n)
174{
175 return std::visit([](auto &&x)->decltype(auto) { return x.isPreformatted(); }, *n);
176}
177
178/*! Returns TRUE iff node n is a child of a preformatted node */
179inline bool insidePRE(const DocNodeVariant *n)
180{
181 while (n)
182 {
183 if (isPreformatted(n)) return TRUE;
184 n=parent(n);
185 }
186 return FALSE;
187}
188
189/*! Returns TRUE iff node n is a child of a html list item node */
190inline bool insideLI(const DocNodeVariant *n)
191{
192 while (n)
193 {
194 if (std::holds_alternative<DocHtmlListItem>(*n)) return TRUE;
195 n=parent(n);
196 }
197 return FALSE;
198}
199
200/*! Returns TRUE iff node n is a child of a html list item node */
201inline bool insideBlockQuote(const DocNodeVariant *n)
202{
203 while (n)
204 {
205 if (std::holds_alternative<DocHtmlBlockQuote>(*n)) return TRUE;
206 n=parent(n);
207 }
208 return FALSE;
209}
210
211
212//---------------------------------------------------------------------------
213
214/*! Returns TRUE iff node n is a child of a unordered html list node */
215inline bool insideUL(const DocNodeVariant *n)
216{
217 while (n)
218 {
219 if (std::holds_alternative<DocHtmlList>(*n) &&
220 std::get<DocHtmlList>(*n).type()==DocHtmlList::Unordered)
221 {
222 return TRUE;
223 }
224 n=parent(n);
225 }
226 return FALSE;
227}
228
229//---------------------------------------------------------------------------
230
231/*! Returns TRUE iff node n is a child of a ordered html list node */
232inline bool insideOL(const DocNodeVariant *n)
233{
234 while (n)
235 {
236 if (std::holds_alternative<DocHtmlList>(*n) &&
237 std::get<DocHtmlList>(*n).type()==DocHtmlList::Ordered)
238 {
239 return TRUE;
240 }
241 n=parent(n);
242 }
243 return FALSE;
244}
245
246//---------------------------------------------------------------------------
247
248inline bool insideTable(const DocNodeVariant *n)
249{
250 while (n)
251 {
252 if (std::holds_alternative<DocHtmlTable>(*n)) return TRUE;
253 n=parent(n);
254 }
255 return FALSE;
256}
257
258//---------------------------------------------------------------------------
259
260inline bool insideDetails(const DocNodeVariant *n)
261{
262 while (n)
263 {
264 if (std::holds_alternative<DocHtmlDetails>(*n)) return TRUE;
265 n=parent(n);
266 }
267 return FALSE;
268}
269
270//---------------------------------------------------------------------------
271
272inline bool insideDL(const DocNodeVariant *n)
273{
274 while (n)
275 {
276 if (std::holds_alternative<DocHtmlDescList>(*n)) return TRUE;
277 n=parent(n);
278 }
279 return FALSE;
280}
281
282#endif
DocParser * m_parser
const DocNodeVariant * m_node
AutoNodeStack(DocParser *parser, DocNodeVariant *node)
The common base class of all entity definitions found in the sources.
Definition definition.h:76
bool defaultHandleToken(DocNodeVariant *parent, Token tok, DocNodeList &children, bool handleWord=TRUE)
std::stack< DocParserContext > contextStack
void handleLinkedWord(DocNodeVariant *parent, DocNodeList &children, bool ignoreAutoLinkFlag=FALSE)
DocTokenizer tokenizer
void handleInternalRef(DocNodeVariant *parent, DocNodeList &children)
void handleParameterType(DocNodeVariant *parent, DocNodeList &children, const QCString &paramTypes)
QCString findAndCopyImage(const QCString &fileName, DocImage::Type type, bool doWarn=true)
Definition docparser.cpp:94
void checkRetvalName()
QCString processCopyDoc(const char *data, size_t &len)
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 checkUnOrMultipleDocumentedParams()
void popContext()
Definition docparser.cpp:74
bool findDocsForMemberOrCompound(const QCString &commandName, QCString *pDoc, QCString *pBrief, const Definition **pDef)
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 checkArgumentName()
DocParserContext context
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 pushContext()
Definition docparser.cpp:60
void errorHandleDefaultToken(DocNodeVariant *parent, Token tok, DocNodeList &children, const QCString &txt)
Class representing a list of HTML attributes.
Definition htmlattrib.h:33
opaque parser interface
Definition docparser.h:35
auto end() const
Definition docparser_p.h:53
auto begin() const
Definition docparser_p.h:52
A model of a class/file/namespace member symbol.
Definition memberdef.h:48
This is an alternative implementation of QCString.
Definition qcstring.h:101
CommandType
Definition cmdmapper.h:29
#define NON_COPYABLE(cls)
Macro to help implementing the rule of 5 for a non-copyable & movable class.
Definition construct.h:37
std::multiset< std::string > StringMultiSet
Definition containers.h:32
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
Definition docnode.h:67
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
std::stack< DocNodeVariant * > DocNodeStack
Definition docparser_p.h:39
bool isPreformatted(const DocNodeVariant *n)
bool insideUL(const DocNodeVariant *n)
bool insideTable(const DocNodeVariant *n)
std::vector< const Definition * > DefinitionStack
Definition docparser_p.h:38
IterableStack< const DocNodeVariant * > DocStyleChangeStack
Definition docparser_p.h:55
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)
#define TRUE
Definition qcstring.h:37
#define FALSE
Definition qcstring.h:34
Web server based search engine.
Parser's context to store all global variables.
Definition docparser_p.h:60
StringMultiSet retvalsFound
Definition docparser_p.h:76
bool includeFileShowLineNo
Definition docparser_p.h:90
DocStyleChangeStack styleStack
Definition docparser_p.h:68
size_t includeFileLength
Definition docparser_p.h:88
QCString fileName
Definition docparser_p.h:71
DocNodeStack nodeStack
Definition docparser_p.h:67
StringMultiSet paramsFound
Definition docparser_p.h:77
DefinitionStack copyStack
Definition docparser_p.h:70
QCString exampleName
Definition docparser_p.h:80
const Definition * scope
Definition docparser_p.h:61
QCString includeFileText
Definition docparser_p.h:86
TokenInfo * token
Definition docparser_p.h:93
DocStyleChangeStack initialStyleStack
Definition docparser_p.h:69
SrcLangExt lang
Definition docparser_p.h:83
QCString searchUrl
Definition docparser_p.h:81
QCString includeFileName
Definition docparser_p.h:85
size_t includeFileOffset
Definition docparser_p.h:87
const MemberDef * memberDef
Definition docparser_p.h:78
Data associated with a token used by the comment block parser.
SrcLangExt
Definition types.h:207