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 ,
  Requirement
}
Protected Member Functions inherited from DocNode
void setInsidePreformatted (bool p)

Detailed Description

Node representing a HTML list item.

Definition at line 1170 of file docnode.h.

Constructor & Destructor Documentation

◆ DocHtmlListItem()

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

Definition at line 1173 of file docnode.h.

DocCompoundNode(DocParser *parser, DocNodeVariant *parent)
Definition docnode.h:141
const HtmlAttribList & attribs() const
Definition docnode.h:1176
HtmlAttribList m_attribs
Definition docnode.h:1181
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 1175 of file docnode.h.

1175{ return m_itemNum; }

References m_itemNum.

◆ parse()

Token DocHtmlListItem::parse ( )

Definition at line 2730 of file docnode.cpp.

2731{
2732 AUTO_TRACE();
2733 Token retval = Token::make_TK_NONE();
2734 auto ns = AutoNodeStack(parser(),thisVariant());
2735
2736 // parse one or more paragraphs
2737 bool isFirst=TRUE;
2738 DocPara *par=nullptr;
2739 do
2740 {
2741 children().append<DocPara>(parser(),thisVariant());
2742 par = children().get_last<DocPara>();
2743 if (isFirst) { par->markFirst(); isFirst=FALSE; }
2744 retval=par->parse();
2745 }
2746 while (retval.is(TokenRetval::TK_NEWPARA));
2747 if (par) par->markLast();
2748
2749 AUTO_TRACE_EXIT("retval={}",retval.to_string());
2750 return retval;
2751}
DocNodeList & children()
Definition docnode.h:143
DocNodeVariant * thisVariant()
Definition docnode.h:93
void markLast(bool v=TRUE)
Definition docnode.h:1095
void markFirst(bool v=TRUE)
Definition docnode.h:1094
Token parse()
Definition docnode.cpp:5784
bool is(TokenRetval rv) const
TOKEN_SPECIFICATIONS RETVAL_SPECIFICATIONS const char * to_string() const
#define AUTO_TRACE(...)
Definition docnode.cpp:48
#define AUTO_TRACE_EXIT(...)
Definition docnode.cpp:50
#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:1405
T * get_last()
Returns a pointer to the last element in the list if that element exists and holds a T,...
Definition docnode.h:1416

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

2754{
2755 AUTO_TRACE();
2756 Token retval = Token::make_TK_NONE();
2757 auto ns = AutoNodeStack(parser(),thisVariant());
2758
2759 // parse one or more paragraphs
2760 bool isFirst=TRUE;
2761 DocPara *par=nullptr;
2762 do
2763 {
2764 children().append<DocPara>(parser(),thisVariant());
2765 par = children().get_last<DocPara>();
2766 if (isFirst) { par->markFirst(); isFirst=FALSE; }
2767 retval=par->parse();
2768 if (retval.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF)) break;
2769
2770 //printf("new item: retval=%x parser()->context.token->name=%s parser()->context.token->endTag=%d\n",
2771 // retval,qPrint(parser()->context.token->name),parser()->context.token->endTag);
2772 if (retval.is(TokenRetval::RetVal_ListItem))
2773 {
2774 break;
2775 }
2776 }
2777 while (!retval.is(TokenRetval::RetVal_CloseXml));
2778
2779 if (par) par->markLast();
2780
2781 AUTO_TRACE_EXIT("retval={}",retval.to_string());
2782 return retval;
2783}
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 1181 of file docnode.h.

Referenced by attribs(), and DocHtmlListItem().

◆ m_itemNum

int DocHtmlListItem::m_itemNum = 0
private

Definition at line 1182 of file docnode.h.

Referenced by DocHtmlListItem(), and itemNumber().


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