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 1164 of file docnode.h.

Constructor & Destructor Documentation

◆ DocHtmlListItem()

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

Definition at line 1167 of file docnode.h.

DocCompoundNode(DocParser *parser, DocNodeVariant *parent)
Definition docnode.h:141
const HtmlAttribList & attribs() const
Definition docnode.h:1170
HtmlAttribList m_attribs
Definition docnode.h:1175
DocParser * parser()
Definition docnode.h:98
DocNodeVariant * parent()
Definition docnode.h:90

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 1169 of file docnode.h.

1169{ return m_itemNum; }

References m_itemNum.

◆ parse()

Token DocHtmlListItem::parse ( )

Definition at line 2654 of file docnode.cpp.

2655{
2656 AUTO_TRACE();
2657 Token retval = Token::make_TK_NONE();
2658 auto ns = AutoNodeStack(parser(),thisVariant());
2659
2660 // parse one or more paragraphs
2661 bool isFirst=TRUE;
2662 DocPara *par=nullptr;
2663 do
2664 {
2665 children().append<DocPara>(parser(),thisVariant());
2666 par = children().get_last<DocPara>();
2667 if (isFirst) { par->markFirst(); isFirst=FALSE; }
2668 retval=par->parse();
2669 }
2670 while (retval.is(TokenRetval::TK_NEWPARA));
2671 if (par) par->markLast();
2672
2673 AUTO_TRACE_EXIT("retval={}",retval.to_string());
2674 return retval;
2675}
DocNodeList & children()
Definition docnode.h:143
DocNodeVariant * thisVariant()
Definition docnode.h:93
void markLast(bool v=TRUE)
Definition docnode.h:1086
void markFirst(bool v=TRUE)
Definition docnode.h:1085
Token parse()
Definition docnode.cpp:5714
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:1399
T * get_last()
Returns a pointer to the last element in the list if that element exists and holds a T,...
Definition docnode.h:1410

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

2678{
2679 AUTO_TRACE();
2680 Token retval = Token::make_TK_NONE();
2681 auto ns = AutoNodeStack(parser(),thisVariant());
2682
2683 // parse one or more paragraphs
2684 bool isFirst=TRUE;
2685 DocPara *par=nullptr;
2686 do
2687 {
2688 children().append<DocPara>(parser(),thisVariant());
2689 par = children().get_last<DocPara>();
2690 if (isFirst) { par->markFirst(); isFirst=FALSE; }
2691 retval=par->parse();
2692 if (retval.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF)) break;
2693
2694 //printf("new item: retval=%x parser()->context.token->name=%s parser()->context.token->endTag=%d\n",
2695 // retval,qPrint(parser()->context.token->name),parser()->context.token->endTag);
2696 if (retval.is(TokenRetval::RetVal_ListItem))
2697 {
2698 break;
2699 }
2700 }
2701 while (!retval.is(TokenRetval::RetVal_CloseXml));
2702
2703 if (par) par->markLast();
2704
2705 AUTO_TRACE_EXIT("retval={}",retval.to_string());
2706 return retval;
2707}
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 1175 of file docnode.h.

Referenced by attribs(), and DocHtmlListItem().

◆ m_itemNum

int DocHtmlListItem::m_itemNum = 0
private

Definition at line 1176 of file docnode.h.

Referenced by DocHtmlListItem(), and itemNumber().


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