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 1317 of file docnode.cpp.

1318{
1319 AUTO_TRACE();
1320 Token retval(TokenRetval::RetVal_OK);
1321 auto ns = AutoNodeStack(parser(),thisVariant());
1322
1323 Token tok = parser()->tokenizer.lex();
1324 while (!tok.is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF))
1325 {
1326 if (!parser()->defaultHandleToken(thisVariant(),tok,children()))
1327 {
1328 switch (tok.value())
1329 {
1330 case TokenRetval::TK_HTMLTAG:
1331 {
1332 HtmlTagType tagId=Mappers::htmlTagMapper->map(parser()->context.token->name);
1333 if (tagId==HtmlTagType::HTML_H1 && parser()->context.token->endTag) // found </h1> tag
1334 {
1335 if (m_level!=1)
1336 {
1337 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"<h{:d}> ended with </h1>",
1338 m_level);
1339 }
1340 goto endheader;
1341 }
1342 else if (tagId==HtmlTagType::HTML_H2 && parser()->context.token->endTag) // found </h2> tag
1343 {
1344 if (m_level!=2)
1345 {
1346 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"<h{:d}> ended with </h2>",
1347 m_level);
1348 }
1349 goto endheader;
1350 }
1351 else if (tagId==HtmlTagType::HTML_H3 && parser()->context.token->endTag) // found </h3> tag
1352 {
1353 if (m_level!=3)
1354 {
1355 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"<h{:d}> ended with </h3>",
1356 m_level);
1357 }
1358 goto endheader;
1359 }
1360 else if (tagId==HtmlTagType::HTML_H4 && parser()->context.token->endTag) // found </h4> tag
1361 {
1362 if (m_level!=4)
1363 {
1364 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"<h{:d}> ended with </h4>",
1365 m_level);
1366 }
1367 goto endheader;
1368 }
1369 else if (tagId==HtmlTagType::HTML_H5 && parser()->context.token->endTag) // found </h5> tag
1370 {
1371 if (m_level!=5)
1372 {
1373 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"<h{:d}> ended with </h5>",
1374 m_level);
1375 }
1376 goto endheader;
1377 }
1378 else if (tagId==HtmlTagType::HTML_H6 && parser()->context.token->endTag) // found </h6> tag
1379 {
1380 if (m_level!=6)
1381 {
1382 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"<h{:d}> ended with </h6>",
1383 m_level);
1384 }
1385 goto endheader;
1386 }
1387 else if (tagId==HtmlTagType::HTML_A)
1388 {
1389 if (!parser()->context.token->endTag)
1390 {
1391 parser()->handleAHref(thisVariant(),children(),parser()->context.token->attribs);
1392 }
1393 }
1394 else if (tagId==HtmlTagType::HTML_BR)
1395 {
1396 children().append<DocLineBreak>(parser(),thisVariant(),parser()->context.token->attribs);
1397 }
1398 else
1399 {
1400 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unexpected html tag <{}{}> found within <h{:d}> context",
1401 parser()->context.token->endTag?"/":"",parser()->context.token->name,m_level);
1402 }
1403 }
1404 break;
1405 default:
1406 char tmp[20];
1407 qsnprintf(tmp,20,"<h%d> tag",m_level);
1409 }
1410 }
1411 tok = parser()->tokenizer.lex();
1412 }
1413 if (tok.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
1414 {
1415 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unexpected end of comment while inside"
1416 " <h{:d}> tag",m_level);
1417 }
1418endheader:
1420 return retval;
1421}
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: