Doxygen
Loading...
Searching...
No Matches
DocHtmlHeader Class Reference

Node Html heading. More...

#include <src/docnode.h>

Inheritance diagram for DocHtmlHeader:
Collaboration diagram for DocHtmlHeader:

Public Member Functions

 DocHtmlHeader (DocParser *parser, DocNodeVariant *parent, const HtmlAttribList &attribs, int level)
int level () const
const HtmlAttribListattribs () const
Token parse ()
Public Member Functions inherited from DocCompoundNode
 DocCompoundNode (DocParser *parser, DocNodeVariant *parent)
DocNodeListchildren ()
const DocNodeListchildren () const
Public Member Functions inherited from DocNode
 DocNode (DocParser *parser, DocNodeVariant *parent)
 ~DocNode ()=default
DocNodeVariantparent ()
const DocNodeVariantparent () const
DocNodeVariantthisVariant ()
const DocNodeVariantthisVariant () const
void setThisVariant (DocNodeVariant *thisVariant)
DocParserparser ()
const DocParserparser () const
void setParent (DocNodeVariant *parent)
bool isPreformatted () const

Private Attributes

int m_level = 0
HtmlAttribList m_attribs

Additional Inherited Members

Protected Types inherited from DocNode
enum  RefType { Unknown , Anchor , Section , Table }
Protected Member Functions inherited from DocNode
void setInsidePreformatted (bool p)

Detailed Description

Node Html heading.

Definition at line 872 of file docnode.h.

Constructor & Destructor Documentation

◆ DocHtmlHeader()

DocHtmlHeader::DocHtmlHeader ( DocParser * parser,
DocNodeVariant * parent,
const HtmlAttribList & attribs,
int level )
inline

Definition at line 875 of file docnode.h.

875 :
DocCompoundNode(DocParser *parser, DocNodeVariant *parent)
Definition docnode.h:141
HtmlAttribList m_attribs
Definition docnode.h:883
const HtmlAttribList & attribs() const
Definition docnode.h:878
int level() const
Definition docnode.h:877
DocParser * parser()
Definition docnode.h:98
DocNodeVariant * parent()
Definition docnode.h:90

References attribs(), DocCompoundNode::DocCompoundNode(), level(), m_attribs, m_level, DocNode::parent(), and DocNode::parser().

Member Function Documentation

◆ attribs()

const HtmlAttribList & DocHtmlHeader::attribs ( ) const
inline

Definition at line 878 of file docnode.h.

878{ return m_attribs; }

References m_attribs.

Referenced by DocHtmlHeader(), and HtmlDocVisitor::operator()().

◆ level()

◆ parse()

Token DocHtmlHeader::parse ( )

Definition at line 1316 of file docnode.cpp.

1317{
1318 AUTO_TRACE();
1319 Token retval(TokenRetval::RetVal_OK);
1320 auto ns = AutoNodeStack(parser(),thisVariant());
1321
1322 Token tok = parser()->tokenizer.lex();
1323 while (!tok.is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF))
1324 {
1325 if (!parser()->defaultHandleToken(thisVariant(),tok,children()))
1326 {
1327 switch (tok.value())
1328 {
1329 case TokenRetval::TK_HTMLTAG:
1330 {
1331 HtmlTagType tagId=Mappers::htmlTagMapper->map(parser()->context.token->name);
1332 if (tagId==HtmlTagType::HTML_H1 && parser()->context.token->endTag) // found </h1> tag
1333 {
1334 if (m_level!=1)
1335 {
1336 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"<h{:d}> ended with </h1>",
1337 m_level);
1338 }
1339 goto endheader;
1340 }
1341 else if (tagId==HtmlTagType::HTML_H2 && parser()->context.token->endTag) // found </h2> tag
1342 {
1343 if (m_level!=2)
1344 {
1345 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"<h{:d}> ended with </h2>",
1346 m_level);
1347 }
1348 goto endheader;
1349 }
1350 else if (tagId==HtmlTagType::HTML_H3 && parser()->context.token->endTag) // found </h3> tag
1351 {
1352 if (m_level!=3)
1353 {
1354 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"<h{:d}> ended with </h3>",
1355 m_level);
1356 }
1357 goto endheader;
1358 }
1359 else if (tagId==HtmlTagType::HTML_H4 && parser()->context.token->endTag) // found </h4> tag
1360 {
1361 if (m_level!=4)
1362 {
1363 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"<h{:d}> ended with </h4>",
1364 m_level);
1365 }
1366 goto endheader;
1367 }
1368 else if (tagId==HtmlTagType::HTML_H5 && parser()->context.token->endTag) // found </h5> tag
1369 {
1370 if (m_level!=5)
1371 {
1372 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"<h{:d}> ended with </h5>",
1373 m_level);
1374 }
1375 goto endheader;
1376 }
1377 else if (tagId==HtmlTagType::HTML_H6 && parser()->context.token->endTag) // found </h6> tag
1378 {
1379 if (m_level!=6)
1380 {
1381 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"<h{:d}> ended with </h6>",
1382 m_level);
1383 }
1384 goto endheader;
1385 }
1386 else if (tagId==HtmlTagType::HTML_A)
1387 {
1388 if (!parser()->context.token->endTag)
1389 {
1390 parser()->handleAHref(thisVariant(),children(),parser()->context.token->attribs);
1391 }
1392 }
1393 else if (tagId==HtmlTagType::HTML_BR)
1394 {
1395 children().append<DocLineBreak>(parser(),thisVariant(),parser()->context.token->attribs);
1396 }
1397 else
1398 {
1399 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unexpected html tag <{}{}> found within <h{:d}> context",
1400 parser()->context.token->endTag?"/":"",parser()->context.token->name,m_level);
1401 }
1402 }
1403 break;
1404 default:
1405 char tmp[20];
1406 qsnprintf(tmp,20,"<h%d> tag",m_level);
1408 }
1409 }
1410 tok = parser()->tokenizer.lex();
1411 }
1412 if (tok.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
1413 {
1414 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unexpected end of comment while inside"
1415 " <h{:d}> tag",m_level);
1416 }
1417endheader:
1419 return retval;
1420}
DocNodeList & children()
Definition docnode.h:143
DocNodeVariant * thisVariant()
Definition docnode.h:93
DocTokenizer tokenizer
Token handleAHref(DocNodeVariant *parent, DocNodeList &children, const HtmlAttribList &tagHtmlAttribs)
void handlePendingStyleCommands(DocNodeVariant *parent, DocNodeList &children)
DocParserContext context
void errorHandleDefaultToken(DocNodeVariant *parent, Token tok, DocNodeList &children, const QCString &txt)
TokenRetval value() const
bool is_any_of(ARGS... args) const
HtmlTagType
Definition cmdmapper.h:169
#define AUTO_TRACE(...)
Definition docnode.cpp:46
#define warn_doc_error(file, line, fmt,...)
Definition message.h:112
const Mapper< HtmlTagType > * htmlTagMapper
#define qsnprintf
Definition qcstring.h:49
void append(Args &&... args)
Append a new DocNodeVariant to the list by constructing it with type T and parameters Args.
Definition docnode.h:1399
TokenInfo * token
Definition docparser_p.h:93
HtmlAttribList attribs

References DocNodeList::append(), TokenInfo::attribs, AUTO_TRACE, DocCompoundNode::children(), DocParser::context, DocParser::errorHandleDefaultToken(), DocParser::handleAHref(), DocParser::handlePendingStyleCommands(), HTML_A, HTML_BR, HTML_H1, HTML_H2, HTML_H3, HTML_H4, HTML_H5, HTML_H6, Mappers::htmlTagMapper, Token::is_any_of(), DocTokenizer::lex(), m_level, DocNode::parser(), qsnprintf, DocNode::thisVariant(), DocParserContext::token, DocParser::tokenizer, Token::value(), and warn_doc_error.

Member Data Documentation

◆ m_attribs

HtmlAttribList DocHtmlHeader::m_attribs
private

Definition at line 883 of file docnode.h.

Referenced by attribs(), and DocHtmlHeader().

◆ m_level

int DocHtmlHeader::m_level = 0
private

Definition at line 882 of file docnode.h.

Referenced by DocHtmlHeader(), level(), and parse().


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