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()

const HtmlAttribList & DocHtmlList::attribs ( ) const
inline

◆ parse()

Token DocHtmlList::parse ( )

Definition at line 2670 of file docnode.cpp.

2671{
2672 AUTO_TRACE();
2673 Token retval = Token::make_RetVal_OK();
2674 int num=1;
2675 auto ns = AutoNodeStack(parser(),thisVariant());
2676
2677 // get next token
2678 Token tok=parser()->tokenizer.lex();
2679 // skip whitespace and paragraph breaks
2680 while (tok.is_any_of(TokenRetval::TK_WHITESPACE,TokenRetval::TK_NEWPARA)) tok=parser()->tokenizer.lex();
2681 // should find a html tag now
2682 if (tok.is(TokenRetval::TK_HTMLTAG))
2683 {
2684 HtmlTagType tagId=Mappers::htmlTagMapper->map(parser()->context.token->name);
2685 if (tagId==HtmlTagType::HTML_LI && !parser()->context.token->endTag) // found <li> tag
2686 {
2687 // ok, we can go on.
2688 }
2689 else if (((m_type==Unordered && tagId==HtmlTagType::HTML_UL) ||
2691 ) && parser()->context.token->endTag
2692 ) // found empty list
2693 {
2694 // add dummy item to obtain valid HTML
2695 children().append<DocHtmlListItem>(parser(),thisVariant(),HtmlAttribList(),1);
2696 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"empty list!");
2697 retval = Token::make_RetVal_EndList();
2698 goto endlist;
2699 }
2700 else // found some other tag
2701 {
2702 // add dummy item to obtain valid HTML
2703 children().append<DocHtmlListItem>(parser(),thisVariant(),HtmlAttribList(),1);
2704 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"expected <li> tag but "
2705 "found <{}{}> instead!",parser()->context.token->endTag?"/":"",parser()->context.token->name);
2706 parser()->tokenizer.pushBackHtmlTag(parser()->context.token->name);
2707 goto endlist;
2708 }
2709 }
2710 else if (tok.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF)) // premature end of comment
2711 {
2712 // add dummy item to obtain valid HTML
2713 children().append<DocHtmlListItem>(parser(),thisVariant(),HtmlAttribList(),1);
2714 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"unexpected end of comment while looking"
2715 " for a html list item");
2716 goto endlist;
2717 }
2718 else // token other than html token
2719 {
2720 // add dummy item to obtain valid HTML
2721 children().append<DocHtmlListItem>(parser(),thisVariant(),HtmlAttribList(),1);
2722 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"expected <li> tag but found {} token instead!",
2723 tok.to_string());
2724 goto endlist;
2725 }
2726
2727 do
2728 {
2729 children().append<DocHtmlListItem>(parser(),thisVariant(),parser()->context.token->attribs,num++);
2730 DocHtmlListItem *li = children().get_last<DocHtmlListItem>();
2731 retval=li->parse();
2732 } while (retval.is(TokenRetval::RetVal_ListItem));
2733
2734 if (retval.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
2735 {
2736 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"unexpected end of comment while inside <{:c}l> block",
2737 m_type==Unordered ? 'u' : 'o');
2738 }
2739
2740endlist:
2741 AUTO_TRACE_EXIT("retval={}",retval.to_string());
2742 return retval.is(TokenRetval::RetVal_EndList) ? Token::make_RetVal_OK() : retval;
2743}
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:92
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 2745 of file docnode.cpp.

2746{
2747 AUTO_TRACE();
2748 Token retval = Token::make_RetVal_OK();
2749 int num=1;
2750 auto ns = AutoNodeStack(parser(),thisVariant());
2751
2752 // get next token
2753 Token tok=parser()->tokenizer.lex();
2754 // skip whitespace and paragraph breaks
2755 while (tok.is_any_of(TokenRetval::TK_WHITESPACE,TokenRetval::TK_NEWPARA)) tok=parser()->tokenizer.lex();
2756 // should find a html tag now
2757 if (tok.is(TokenRetval::TK_HTMLTAG))
2758 {
2759 HtmlTagType tagId=Mappers::htmlTagMapper->map(parser()->context.token->name);
2760 //printf("parser()->context.token->name=%s parser()->context.token->endTag=%d\n",qPrint(parser()->context.token->name),parser()->context.token->endTag);
2761 if (tagId==HtmlTagType::XML_ITEM && !parser()->context.token->endTag) // found <item> tag
2762 {
2763 // ok, we can go on.
2764 }
2765 else // found some other tag
2766 {
2767 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"expected <item> tag but "
2768 "found <{}> instead!",parser()->context.token->name);
2769 parser()->tokenizer.pushBackHtmlTag(parser()->context.token->name);
2770 goto endlist;
2771 }
2772 }
2773 else if (tok.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF)) // premature end of comment
2774 {
2775 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"unexpected end of comment while looking"
2776 " for a html list item");
2777 goto endlist;
2778 }
2779 else // token other than html token
2780 {
2781 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"expected <item> tag but found {} token instead!",
2782 tok.to_string());
2783 goto endlist;
2784 }
2785
2786 do
2787 {
2788 children().append<DocHtmlListItem>(parser(),thisVariant(),parser()->context.token->attribs,num++);
2789 DocHtmlListItem *li = children().get_last<DocHtmlListItem>();
2790 retval=li->parseXml();
2791 if (retval.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF)) break;
2792 //printf("retval=%x parser()->context.token->name=%s\n",retval,qPrint(parser()->context.token->name));
2793 } while (retval.is(TokenRetval::RetVal_ListItem));
2794
2795 if (retval.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
2796 {
2797 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"unexpected end of comment while inside <list type=\"{}\"> block",
2798 m_type==Unordered ? "bullet" : "number");
2799 }
2800
2801endlist:
2802 AUTO_TRACE_EXIT("retval={}",retval.to_string());
2803 return (retval.is_any_of(TokenRetval::RetVal_EndList,TokenRetval::RetVal_CloseXml) || parser()->context.token->name=="list") ?
2804 Token::make_RetVal_OK() : retval;
2805}

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()

Type DocHtmlList::type ( ) const
inline

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: