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

Member Enumeration Documentation

◆ Type

Enumerator
Unordered 
Ordered 

Definition at line 982 of file docnode.h.

982{ Unordered, Ordered };

Constructor & Destructor Documentation

◆ DocHtmlList()

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

Definition at line 983 of file docnode.h.

983 :
DocCompoundNode(DocParser *parser, DocNodeVariant *parent)
Definition docnode.h:140
Type m_type
Definition docnode.h:991
const HtmlAttribList & attribs() const
Definition docnode.h:986
HtmlAttribList m_attribs
Definition docnode.h:992
DocParser * parser()
Definition docnode.h:97
DocNodeVariant * parent()
Definition docnode.h:89

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

Member Function Documentation

◆ attribs()

◆ parse()

Token DocHtmlList::parse ( )

Definition at line 2534 of file docnode.cpp.

2535{
2536 AUTO_TRACE();
2537 Token retval = Token::make_RetVal_OK();
2538 int num=1;
2539 auto ns = AutoNodeStack(parser(),thisVariant());
2540
2541 // get next token
2542 Token tok=parser()->tokenizer.lex();
2543 // skip whitespace and paragraph breaks
2544 while (tok.is_any_of(TokenRetval::TK_WHITESPACE,TokenRetval::TK_NEWPARA)) tok=parser()->tokenizer.lex();
2545 // should find a html tag now
2546 if (tok.is(TokenRetval::TK_HTMLTAG))
2547 {
2548 HtmlTagType tagId=Mappers::htmlTagMapper->map(parser()->context.token->name);
2549 if (tagId==HtmlTagType::HTML_LI && !parser()->context.token->endTag) // found <li> tag
2550 {
2551 // ok, we can go on.
2552 }
2553 else if (((m_type==Unordered && tagId==HtmlTagType::HTML_UL) ||
2555 ) && parser()->context.token->endTag
2556 ) // found empty list
2557 {
2558 // add dummy item to obtain valid HTML
2559 children().append<DocHtmlListItem>(parser(),thisVariant(),HtmlAttribList(),1);
2560 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"empty list!");
2561 retval = Token::make_RetVal_EndList();
2562 goto endlist;
2563 }
2564 else // found some other tag
2565 {
2566 // add dummy item to obtain valid HTML
2567 children().append<DocHtmlListItem>(parser(),thisVariant(),HtmlAttribList(),1);
2568 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"expected <li> tag but "
2569 "found <%s%s> instead!",parser()->context.token->endTag?"/":"",qPrint(parser()->context.token->name));
2570 parser()->tokenizer.pushBackHtmlTag(parser()->context.token->name);
2571 goto endlist;
2572 }
2573 }
2574 else if (tok.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF)) // premature end of comment
2575 {
2576 // add dummy item to obtain valid HTML
2577 children().append<DocHtmlListItem>(parser(),thisVariant(),HtmlAttribList(),1);
2578 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"unexpected end of comment while looking"
2579 " for a html list item");
2580 goto endlist;
2581 }
2582 else // token other than html token
2583 {
2584 // add dummy item to obtain valid HTML
2585 children().append<DocHtmlListItem>(parser(),thisVariant(),HtmlAttribList(),1);
2586 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"expected <li> tag but found %s token instead!",
2587 tok.to_string());
2588 goto endlist;
2589 }
2590
2591 do
2592 {
2593 children().append<DocHtmlListItem>(parser(),thisVariant(),parser()->context.token->attribs,num++);
2594 DocHtmlListItem *li = children().get_last<DocHtmlListItem>();
2595 retval=li->parse();
2596 } while (retval.is(TokenRetval::RetVal_ListItem));
2597
2598 if (retval.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
2599 {
2600 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"unexpected end of comment while inside <%cl> block",
2601 m_type==Unordered ? 'u' : 'o');
2602 }
2603
2604endlist:
2605 AUTO_TRACE_EXIT("retval={}",retval.to_string());
2606 return retval.is(TokenRetval::RetVal_EndList) ? Token::make_RetVal_OK() : retval;
2607}
DocNodeList & children()
Definition docnode.h:142
DocNodeVariant * thisVariant()
Definition docnode.h:92
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:167
#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:74
const Mapper< HtmlTagType > * htmlTagMapper
const char * qPrint(const char *s)
Definition qcstring.h:661
void append(Args &&... args)
Append a new DocNodeVariant to the list by constructing it with type T and parameters Args.
Definition docnode.h:1379
T * get_last()
Returns a pointer to the last element in the list if that element exists and holds a T,...
Definition docnode.h:1390
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(), qPrint(), DocNode::thisVariant(), Token::to_string(), DocParserContext::token, DocParser::tokenizer, Unordered, and warn_doc_error.

◆ parseXml()

Token DocHtmlList::parseXml ( )

Definition at line 2609 of file docnode.cpp.

2610{
2611 AUTO_TRACE();
2612 Token retval = Token::make_RetVal_OK();
2613 int num=1;
2614 auto ns = AutoNodeStack(parser(),thisVariant());
2615
2616 // get next token
2617 Token tok=parser()->tokenizer.lex();
2618 // skip whitespace and paragraph breaks
2619 while (tok.is_any_of(TokenRetval::TK_WHITESPACE,TokenRetval::TK_NEWPARA)) tok=parser()->tokenizer.lex();
2620 // should find a html tag now
2621 if (tok.is(TokenRetval::TK_HTMLTAG))
2622 {
2623 HtmlTagType tagId=Mappers::htmlTagMapper->map(parser()->context.token->name);
2624 //printf("parser()->context.token->name=%s parser()->context.token->endTag=%d\n",qPrint(parser()->context.token->name),parser()->context.token->endTag);
2625 if (tagId==HtmlTagType::XML_ITEM && !parser()->context.token->endTag) // found <item> tag
2626 {
2627 // ok, we can go on.
2628 }
2629 else // found some other tag
2630 {
2631 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"expected <item> tag but "
2632 "found <%s> instead!",qPrint(parser()->context.token->name));
2633 parser()->tokenizer.pushBackHtmlTag(parser()->context.token->name);
2634 goto endlist;
2635 }
2636 }
2637 else if (tok.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF)) // premature end of comment
2638 {
2639 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"unexpected end of comment while looking"
2640 " for a html list item");
2641 goto endlist;
2642 }
2643 else // token other than html token
2644 {
2645 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"expected <item> tag but found %s token instead!",
2646 tok.to_string());
2647 goto endlist;
2648 }
2649
2650 do
2651 {
2652 children().append<DocHtmlListItem>(parser(),thisVariant(),parser()->context.token->attribs,num++);
2653 DocHtmlListItem *li = children().get_last<DocHtmlListItem>();
2654 retval=li->parseXml();
2655 if (retval.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF)) break;
2656 //printf("retval=%x parser()->context.token->name=%s\n",retval,qPrint(parser()->context.token->name));
2657 } while (retval.is(TokenRetval::RetVal_ListItem));
2658
2659 if (retval.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
2660 {
2661 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"unexpected end of comment while inside <list type=\"%s\"> block",
2662 m_type==Unordered ? "bullet" : "number");
2663 }
2664
2665endlist:
2666 AUTO_TRACE_EXIT("retval={}",retval.to_string());
2667 return (retval.is_any_of(TokenRetval::RetVal_EndList,TokenRetval::RetVal_CloseXml) || parser()->context.token->name=="list") ?
2668 Token::make_RetVal_OK() : retval;
2669}

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(), qPrint(), 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 992 of file docnode.h.

Referenced by attribs(), and DocHtmlList().

◆ m_type

Type DocHtmlList::m_type = Unordered
private

Definition at line 991 of file docnode.h.

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


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