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

Node representing an auto List. More...

#include <src/docnode.h>

Inheritance diagram for DocAutoList:
Collaboration diagram for DocAutoList:

Public Types

enum  ListType { Unnumbered =1 , Unchecked =-2 , Checked_x =-3 , Checked_X =-4 }

Public Member Functions

 DocAutoList (DocParser *parser, DocNodeVariant *parent, int indent, bool isEnumList, int depth, bool isCheckedList)
bool isEnumList () const
int indent () const
bool isCheckedList () const
int depth () const
Token parse ()
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

int m_indent = 0
bool m_isEnumList = false
bool m_isCheckedList = false
int m_depth = 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 an auto List.

Definition at line 570 of file docnode.h.

Member Enumeration Documentation

◆ ListType

Enumerator
Unnumbered 
Unchecked 
Checked_x 
Checked_X 

Definition at line 573 of file docnode.h.

574 {
575 Unnumbered=1, Unchecked=-2, Checked_x=-3, Checked_X=-4 // positive numbers give the label
576 };

Constructor & Destructor Documentation

◆ DocAutoList()

DocAutoList::DocAutoList ( DocParser * parser,
DocNodeVariant * parent,
int indent,
bool isEnumList,
int depth,
bool isCheckedList )

Definition at line 2938 of file docnode.cpp.

2939 :
2942{
2943}
int m_depth
Definition docnode.h:590
bool isCheckedList() const
Definition docnode.h:582
bool isEnumList() const
Definition docnode.h:580
int depth() const
Definition docnode.h:583
int m_indent
Definition docnode.h:587
bool m_isCheckedList
Definition docnode.h:589
int indent() const
Definition docnode.h:581
bool m_isEnumList
Definition docnode.h:588
DocCompoundNode(DocParser *parser, DocNodeVariant *parent)
Definition docnode.h:141
DocParser * parser()
Definition docnode.h:98
DocNodeVariant * parent()
Definition docnode.h:90

References depth(), DocCompoundNode::DocCompoundNode(), indent(), isCheckedList(), isEnumList(), m_depth, m_indent, m_isCheckedList, m_isEnumList, DocNode::parent(), and DocNode::parser().

Member Function Documentation

◆ depth()

int DocAutoList::depth ( ) const
inline

Definition at line 583 of file docnode.h.

583{ return m_depth; }

References m_depth.

Referenced by DocAutoList(), and HtmlDocVisitor::operator()().

◆ indent()

int DocAutoList::indent ( ) const
inline

Definition at line 581 of file docnode.h.

581{ return m_indent; }

References m_indent.

Referenced by DocAutoList(), and DocPara::parse().

◆ isCheckedList()

bool DocAutoList::isCheckedList ( ) const
inline

◆ isEnumList()

◆ parse()

Token DocAutoList::parse ( )

Definition at line 2945 of file docnode.cpp.

2946{
2947 AUTO_TRACE();
2948 Token retval = Token::make_RetVal_OK();
2949 int num=1;
2950 auto ns = AutoNodeStack(parser(),thisVariant());
2952 // first item or sub list => create new list
2953 do
2954 {
2955 switch (parser()->context.token->id)
2956 {
2957 case -1:
2958 break;
2959 case DocAutoList::Unchecked: // unchecked
2960 case DocAutoList::Checked_x: // checked with x
2961 case DocAutoList::Checked_X: // checked with X
2962 num = parser()->context.token->id;
2963 break;
2964 default: // explicitly numbered list
2965 num=parser()->context.token->id; // override num with real number given
2966 break;
2967 }
2968
2969 children().append<DocAutoListItem>(parser(),thisVariant(),m_indent,num++);
2970 retval = children().get_last<DocAutoListItem>()->parse();
2971 //printf("DocAutoList::parse(): retval=0x%x parser()->context.token->indent=%d m_indent=%d "
2972 // "m_isEnumList=%d parser()->context.token->isEnumList=%d parser()->context.token->name=%s\n",
2973 // retval,parser()->context.token->indent,m_indent,m_isEnumList,parser()->context.token->isEnumList,
2974 // qPrint(parser()->context.token->name));
2975 //printf("num=%d parser()->context.token->id=%d\n",num,parser()->context.token->id);
2976 }
2977 while (retval.is(TokenRetval::TK_LISTITEM) && // new list item
2978 m_indent==parser()->context.token->indent && // at same indent level
2979 m_isEnumList==parser()->context.token->isEnumList && // of the same kind
2980 m_isCheckedList==parser()->context.token->isCheckedList && // of the same kind
2981 (parser()->context.token->id==-1 || parser()->context.token->id>=num) // increasing number (or no number or checked list)
2982 );
2983
2985 AUTO_TRACE_EXIT("retval={}",retval.to_string());
2986 return retval;
2987}
Token parse()
Definition docnode.cpp:2945
DocNodeList & children()
Definition docnode.h:143
DocNodeVariant * thisVariant()
Definition docnode.h:93
DocTokenizer tokenizer
DocParserContext context
void startAutoList()
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
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

References DocNodeList::append(), AUTO_TRACE, AUTO_TRACE_EXIT, Checked_X, Checked_x, DocCompoundNode::children(), DocParser::context, DocTokenizer::endAutoList(), DocNodeList::get_last(), TokenInfo::id, Token::is(), m_indent, m_isCheckedList, m_isEnumList, parse(), DocNode::parser(), DocTokenizer::startAutoList(), DocNode::thisVariant(), Token::to_string(), DocParserContext::token, DocParser::tokenizer, and Unchecked.

Referenced by parse().

Member Data Documentation

◆ m_depth

int DocAutoList::m_depth = 0
private

Definition at line 590 of file docnode.h.

Referenced by depth(), and DocAutoList().

◆ m_indent

int DocAutoList::m_indent = 0
private

Definition at line 587 of file docnode.h.

Referenced by DocAutoList(), indent(), and parse().

◆ m_isCheckedList

bool DocAutoList::m_isCheckedList = false
private

Definition at line 589 of file docnode.h.

Referenced by DocAutoList(), isCheckedList(), and parse().

◆ m_isEnumList

bool DocAutoList::m_isEnumList = false
private

Definition at line 588 of file docnode.h.

Referenced by DocAutoList(), isEnumList(), and parse().


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