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

Node representing a HTML list item. More...

#include <src/docnode.h>

Inheritance diagram for DocHtmlListItem:
Collaboration diagram for DocHtmlListItem:

Public Member Functions

 DocHtmlListItem (DocParser *parser, DocNodeVariant *parent, const HtmlAttribList &attribs, int num)
int itemNumber () const
const HtmlAttribListattribs () const
Token parse ()
Token parseXml ()
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

HtmlAttribList m_attribs
int m_itemNum = 0

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 representing a HTML list item.

Definition at line 1159 of file docnode.h.

Constructor & Destructor Documentation

◆ DocHtmlListItem()

DocHtmlListItem::DocHtmlListItem ( DocParser * parser,
DocNodeVariant * parent,
const HtmlAttribList & attribs,
int num )
inline

Definition at line 1162 of file docnode.h.

DocCompoundNode(DocParser *parser, DocNodeVariant *parent)
Definition docnode.h:140
const HtmlAttribList & attribs() const
Definition docnode.h:1165
HtmlAttribList m_attribs
Definition docnode.h:1170
DocParser * parser()
Definition docnode.h:97
DocNodeVariant * parent()
Definition docnode.h:89

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

Member Function Documentation

◆ attribs()

◆ itemNumber()

int DocHtmlListItem::itemNumber ( ) const
inline

Definition at line 1164 of file docnode.h.

1164{ return m_itemNum; }

References m_itemNum.

◆ parse()

Token DocHtmlListItem::parse ( )

Definition at line 2494 of file docnode.cpp.

2495{
2496 AUTO_TRACE();
2497 Token retval = Token::make_TK_NONE();
2498 auto ns = AutoNodeStack(parser(),thisVariant());
2499
2500 // parse one or more paragraphs
2501 bool isFirst=TRUE;
2502 DocPara *par=nullptr;
2503 do
2504 {
2505 children().append<DocPara>(parser(),thisVariant());
2506 par = children().get_last<DocPara>();
2507 if (isFirst) { par->markFirst(); isFirst=FALSE; }
2508 retval=par->parse();
2509 }
2510 while (retval.is(TokenRetval::TK_NEWPARA));
2511 if (par) par->markLast();
2512
2513 AUTO_TRACE_EXIT("retval={}",retval.to_string());
2514 return retval;
2515}
DocNodeList & children()
Definition docnode.h:142
DocNodeVariant * thisVariant()
Definition docnode.h:92
void markLast(bool v=TRUE)
Definition docnode.h:1081
void markFirst(bool v=TRUE)
Definition docnode.h:1080
Token parse()
Definition docnode.cpp:5479
bool is(TokenRetval rv) const
TOKEN_SPECIFICATIONS RETVAL_SPECIFICATIONS const char * to_string() const
#define AUTO_TRACE(...)
Definition docnode.cpp:46
#define AUTO_TRACE_EXIT(...)
Definition docnode.cpp:48
#define TRUE
Definition qcstring.h:37
#define FALSE
Definition qcstring.h:34
void append(Args &&... args)
Append a new DocNodeVariant to the list by constructing it with type T and parameters Args.
Definition docnode.h:1394
T * get_last()
Returns a pointer to the last element in the list if that element exists and holds a T,...
Definition docnode.h:1405

References DocNodeList::append(), AUTO_TRACE, AUTO_TRACE_EXIT, DocCompoundNode::children(), FALSE, DocNodeList::get_last(), Token::is(), DocPara::markFirst(), DocPara::markLast(), DocPara::parse(), DocNode::parser(), DocNode::thisVariant(), Token::to_string(), and TRUE.

◆ parseXml()

Token DocHtmlListItem::parseXml ( )

Definition at line 2517 of file docnode.cpp.

2518{
2519 AUTO_TRACE();
2520 Token retval = Token::make_TK_NONE();
2521 auto ns = AutoNodeStack(parser(),thisVariant());
2522
2523 // parse one or more paragraphs
2524 bool isFirst=TRUE;
2525 DocPara *par=nullptr;
2526 do
2527 {
2528 children().append<DocPara>(parser(),thisVariant());
2529 par = children().get_last<DocPara>();
2530 if (isFirst) { par->markFirst(); isFirst=FALSE; }
2531 retval=par->parse();
2532 if (retval.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF)) break;
2533
2534 //printf("new item: retval=%x parser()->context.token->name=%s parser()->context.token->endTag=%d\n",
2535 // retval,qPrint(parser()->context.token->name),parser()->context.token->endTag);
2536 if (retval.is(TokenRetval::RetVal_ListItem))
2537 {
2538 break;
2539 }
2540 }
2541 while (!retval.is(TokenRetval::RetVal_CloseXml));
2542
2543 if (par) par->markLast();
2544
2545 AUTO_TRACE_EXIT("retval={}",retval.to_string());
2546 return retval;
2547}
bool is_any_of(ARGS... args) const

References DocNodeList::append(), AUTO_TRACE, AUTO_TRACE_EXIT, DocCompoundNode::children(), FALSE, DocNodeList::get_last(), Token::is(), Token::is_any_of(), DocPara::markFirst(), DocPara::markLast(), DocPara::parse(), DocNode::parser(), DocNode::thisVariant(), Token::to_string(), and TRUE.

Member Data Documentation

◆ m_attribs

HtmlAttribList DocHtmlListItem::m_attribs
private

Definition at line 1170 of file docnode.h.

Referenced by attribs(), and DocHtmlListItem().

◆ m_itemNum

int DocHtmlListItem::m_itemNum = 0
private

Definition at line 1171 of file docnode.h.

Referenced by DocHtmlListItem(), and itemNumber().


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