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

Node representing a Html list. More...

#include <src/docnode.h>

Inheritance diagram for DocHtmlList:
Collaboration diagram for DocHtmlList:

Public Types

enum  Type { Unordered , Ordered }

Public Member Functions

 DocHtmlList (DocParser *parser, DocNodeVariant *parent, const HtmlAttribList &attribs, Type t)
Type type () 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

Type m_type = Unordered
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 representing a Html list.

Definition at line 999 of file docnode.h.

Member Enumeration Documentation

◆ Type

Enumerator
Unordered 
Ordered 

Definition at line 1002 of file docnode.h.

Constructor & Destructor Documentation

◆ DocHtmlList()

DocHtmlList::DocHtmlList ( DocParser * parser,
DocNodeVariant * parent,
const HtmlAttribList & attribs,
Type t )
inline

Definition at line 1003 of file docnode.h.

1003 :
DocCompoundNode(DocParser *parser, DocNodeVariant *parent)
Definition docnode.h:141
Type m_type
Definition docnode.h:1011
const HtmlAttribList & attribs() const
Definition docnode.h:1006
HtmlAttribList m_attribs
Definition docnode.h:1012
DocParser * parser()
Definition docnode.h:98
DocNodeVariant * parent()
Definition docnode.h:90

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

Member Function Documentation

◆ attribs()

◆ parse()

Token DocHtmlList::parse ( )

Definition at line 2699 of file docnode.cpp.

2700{
2701 AUTO_TRACE();
2702 Token retval = Token::make_RetVal_OK();
2703 int num=1;
2704 auto ns = AutoNodeStack(parser(),thisVariant());
2705
2706 // get next token
2707 Token tok=parser()->tokenizer.lex();
2708 // skip whitespace and paragraph breaks
2709 while (tok.is_any_of(TokenRetval::TK_WHITESPACE,TokenRetval::TK_NEWPARA)) tok=parser()->tokenizer.lex();
2710 // should find a html tag now
2711 if (tok.is(TokenRetval::TK_HTMLTAG))
2712 {
2713 HtmlTagType tagId=Mappers::htmlTagMapper->map(parser()->context.token->name);
2714 if (tagId==HtmlTagType::HTML_LI && !parser()->context.token->endTag) // found <li> tag
2715 {
2716 // ok, we can go on.
2717 }
2718 else if (((m_type==Unordered && tagId==HtmlTagType::HTML_UL) ||
2720 ) && parser()->context.token->endTag
2721 ) // found empty list
2722 {
2723 // add dummy item to obtain valid HTML
2724 children().append<DocHtmlListItem>(parser(),thisVariant(),HtmlAttribList(),1);
2725 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"empty list!");
2726 retval = Token::make_RetVal_EndList();
2727 goto endlist;
2728 }
2729 else // found some other tag
2730 {
2731 // add dummy item to obtain valid HTML
2732 children().append<DocHtmlListItem>(parser(),thisVariant(),HtmlAttribList(),1);
2733 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"expected <li> tag but "
2734 "found <{}{}> instead!",parser()->context.token->endTag?"/":"",parser()->context.token->name);
2735 parser()->tokenizer.pushBackHtmlTag(parser()->context.token->name);
2736 goto endlist;
2737 }
2738 }
2739 else if (tok.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF)) // premature end of comment
2740 {
2741 // add dummy item to obtain valid HTML
2742 children().append<DocHtmlListItem>(parser(),thisVariant(),HtmlAttribList(),1);
2743 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"unexpected end of comment while looking"
2744 " for a html list item");
2745 goto endlist;
2746 }
2747 else // token other than html token
2748 {
2749 // add dummy item to obtain valid HTML
2750 children().append<DocHtmlListItem>(parser(),thisVariant(),HtmlAttribList(),1);
2751 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"expected <li> tag but found {} token instead!",
2752 tok.to_string());
2753 goto endlist;
2754 }
2755
2756 do
2757 {
2758 children().append<DocHtmlListItem>(parser(),thisVariant(),parser()->context.token->attribs,num++);
2759 DocHtmlListItem *li = children().get_last<DocHtmlListItem>();
2760 retval=li->parse();
2761 } while (retval.is(TokenRetval::RetVal_ListItem));
2762
2763 if (retval.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
2764 {
2765 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"unexpected end of comment while inside <{:c}l> block",
2766 m_type==Unordered ? 'u' : 'o');
2767 }
2768
2769endlist:
2770 AUTO_TRACE_EXIT("retval={}",retval.to_string());
2771 return retval.is(TokenRetval::RetVal_EndList) ? Token::make_RetVal_OK() : retval;
2772}
DocNodeList & children()
Definition docnode.h:143
DocNodeVariant * thisVariant()
Definition docnode.h:93
DocTokenizer tokenizer
DocParserContext context
void pushBackHtmlTag(const QCString &tag)
bool is(TokenRetval rv) const
TOKEN_SPECIFICATIONS RETVAL_SPECIFICATIONS const char * to_string() const
bool is_any_of(ARGS... args) const
HtmlTagType
Definition cmdmapper.h:169
#define AUTO_TRACE(...)
Definition docnode.cpp:46
#define AUTO_TRACE_EXIT(...)
Definition docnode.cpp:48
#define warn_doc_error(file, line, fmt,...)
Definition message.h:112
const Mapper< HtmlTagType > * htmlTagMapper
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
TokenInfo * token
Definition docparser_p.h:93
HtmlAttribList attribs

References DocNodeList::append(), TokenInfo::attribs, AUTO_TRACE, AUTO_TRACE_EXIT, DocCompoundNode::children(), DocParser::context, DocNodeList::get_last(), HTML_LI, HTML_OL, HTML_UL, Mappers::htmlTagMapper, Token::is(), Token::is_any_of(), DocTokenizer::lex(), m_type, Ordered, DocNode::parser(), DocTokenizer::pushBackHtmlTag(), DocNode::thisVariant(), Token::to_string(), DocParserContext::token, DocParser::tokenizer, Unordered, and warn_doc_error.

◆ parseXml()

Token DocHtmlList::parseXml ( )

Definition at line 2774 of file docnode.cpp.

2775{
2776 AUTO_TRACE();
2777 Token retval = Token::make_RetVal_OK();
2778 int num=1;
2779 auto ns = AutoNodeStack(parser(),thisVariant());
2780
2781 // get next token
2782 Token tok=parser()->tokenizer.lex();
2783 // skip whitespace and paragraph breaks
2784 while (tok.is_any_of(TokenRetval::TK_WHITESPACE,TokenRetval::TK_NEWPARA)) tok=parser()->tokenizer.lex();
2785 // should find a html tag now
2786 if (tok.is(TokenRetval::TK_HTMLTAG))
2787 {
2788 HtmlTagType tagId=Mappers::htmlTagMapper->map(parser()->context.token->name);
2789 //printf("parser()->context.token->name=%s parser()->context.token->endTag=%d\n",qPrint(parser()->context.token->name),parser()->context.token->endTag);
2790 if (tagId==HtmlTagType::XML_ITEM && !parser()->context.token->endTag) // found <item> tag
2791 {
2792 // ok, we can go on.
2793 }
2794 else // found some other tag
2795 {
2796 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"expected <item> tag but "
2797 "found <{}> instead!",parser()->context.token->name);
2798 parser()->tokenizer.pushBackHtmlTag(parser()->context.token->name);
2799 goto endlist;
2800 }
2801 }
2802 else if (tok.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF)) // premature end of comment
2803 {
2804 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"unexpected end of comment while looking"
2805 " for a html list item");
2806 goto endlist;
2807 }
2808 else // token other than html token
2809 {
2810 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"expected <item> tag but found {} token instead!",
2811 tok.to_string());
2812 goto endlist;
2813 }
2814
2815 do
2816 {
2817 children().append<DocHtmlListItem>(parser(),thisVariant(),parser()->context.token->attribs,num++);
2818 DocHtmlListItem *li = children().get_last<DocHtmlListItem>();
2819 retval=li->parseXml();
2820 if (retval.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF)) break;
2821 //printf("retval=%x parser()->context.token->name=%s\n",retval,qPrint(parser()->context.token->name));
2822 } while (retval.is(TokenRetval::RetVal_ListItem));
2823
2824 if (retval.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
2825 {
2826 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"unexpected end of comment while inside <list type=\"{}\"> block",
2827 m_type==Unordered ? "bullet" : "number");
2828 }
2829
2830endlist:
2831 AUTO_TRACE_EXIT("retval={}",retval.to_string());
2832 return (retval.is_any_of(TokenRetval::RetVal_EndList,TokenRetval::RetVal_CloseXml) || parser()->context.token->name=="list") ?
2833 Token::make_RetVal_OK() : retval;
2834}

References DocNodeList::append(), TokenInfo::attribs, AUTO_TRACE, AUTO_TRACE_EXIT, DocCompoundNode::children(), DocParser::context, DocNodeList::get_last(), Mappers::htmlTagMapper, Token::is(), Token::is_any_of(), DocTokenizer::lex(), m_type, DocNode::parser(), DocTokenizer::pushBackHtmlTag(), DocNode::thisVariant(), Token::to_string(), DocParserContext::token, DocParser::tokenizer, Unordered, warn_doc_error, and XML_ITEM.

◆ type()

Member Data Documentation

◆ m_attribs

HtmlAttribList DocHtmlList::m_attribs
private

Definition at line 1012 of file docnode.h.

Referenced by attribs(), and DocHtmlList().

◆ m_type

Type DocHtmlList::m_type = Unordered
private

Definition at line 1011 of file docnode.h.

Referenced by DocHtmlList(), parse(), parseXml(), and type().


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