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

Node representing a HTML table row. More...

#include <src/docnode.h>

Inheritance diagram for DocHtmlRow:
Collaboration diagram for DocHtmlRow:

Public Member Functions

 DocHtmlRow (DocParser *parser, DocNodeVariant *parent, const HtmlAttribList &attribs)
size_t numCells () const
const HtmlAttribListattribs () const
Token parse ()
Token parseXml (bool header)
bool isHeading () const
void setVisibleCells (uint32_t n)
uint32_t visibleCells () const
uint32_t rowIndex () const
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 Member Functions

void setRowIndex (uint32_t idx)

Private Attributes

HtmlAttribList m_attribs
uint32_t m_visibleCells = 0
uint32_t m_rowIdx = static_cast<uint32_t>(-1)

Friends

class DocHtmlTable

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 table row.

Definition at line 1245 of file docnode.h.

Constructor & Destructor Documentation

◆ DocHtmlRow()

DocHtmlRow::DocHtmlRow ( DocParser * parser,
DocNodeVariant * parent,
const HtmlAttribList & attribs )
inline

Definition at line 1249 of file docnode.h.

DocCompoundNode(DocParser *parser, DocNodeVariant *parent)
Definition docnode.h:141
HtmlAttribList m_attribs
Definition docnode.h:1262
const HtmlAttribList & attribs() const
Definition docnode.h:1252
DocParser * parser()
Definition docnode.h:98
DocNodeVariant * parent()
Definition docnode.h:90

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

Member Function Documentation

◆ attribs()

const HtmlAttribList & DocHtmlRow::attribs ( ) const
inline

Definition at line 1252 of file docnode.h.

1252{ return m_attribs; }

References m_attribs.

Referenced by DocHtmlRow(), DocbookDocVisitor::operator()(), and HtmlDocVisitor::operator()().

◆ isHeading()

bool DocHtmlRow::isHeading ( ) const

Definition at line 1935 of file docnode.cpp.

1936{ // a row is a table heading if all cells are marked as such
1937 bool heading=TRUE;
1938 for (const auto &n : children())
1939 {
1940 const DocHtmlCell *cell = std::get_if<DocHtmlCell>(&n);
1941 if (cell && !cell->isHeading())
1942 {
1943 heading = FALSE;
1944 break;
1945 }
1946 }
1947 return !children().empty() && heading;
1948}
DocNodeList & children()
Definition docnode.h:143
bool isHeading() const
Definition docnode.h:1200
bool empty() const
checks whether the container is empty
Definition growvector.h:140
#define TRUE
Definition qcstring.h:37
#define FALSE
Definition qcstring.h:34

References DocCompoundNode::children(), GrowVector< T >::empty(), FALSE, DocHtmlCell::isHeading(), and TRUE.

Referenced by DocbookDocVisitor::operator()(), LatexDocVisitor::operator()(), RTFDocVisitor::operator()(), parse(), and parseXml().

◆ numCells()

size_t DocHtmlRow::numCells ( ) const
inline

Definition at line 1251 of file docnode.h.

1251{ return children().size(); }
size_t size() const
returns the number of elements
Definition growvector.h:93

References DocCompoundNode::children(), and GrowVector< T >::size().

Referenced by RTFDocVisitor::operator()().

◆ parse()

Token DocHtmlRow::parse ( )

Definition at line 1981 of file docnode.cpp.

1982{
1983 AUTO_TRACE();
1984 Token retval = Token::make_RetVal_OK();
1985 auto ns = AutoNodeStack(parser(),thisVariant());
1986
1987 bool isHeading=FALSE;
1988 bool isFirst=TRUE;
1989 DocHtmlCell *cell=nullptr;
1990
1991 Token tok = skipSpacesForTable(parser());
1992 // should find a html tag now
1993 if (tok.is(TokenRetval::TK_HTMLTAG))
1994 {
1995 HtmlTagType tagId=Mappers::htmlTagMapper->map(parser()->context.token->name);
1996 if (tagId==HtmlTagType::HTML_TD && !parser()->context.token->endTag) // found <td> tag
1997 {
1998 }
1999 else if (tagId==HtmlTagType::HTML_TH && !parser()->context.token->endTag) // found <th> tag
2000 {
2002 }
2003 else // found some other tag
2004 {
2005 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"expected <td> or <th> tag but "
2006 "found <{}{}> instead!",parser()->context.token->endTag ? "/" : "", parser()->context.token->name);
2007 parser()->tokenizer.pushBackHtmlTag(parser()->context.token->name);
2008 goto endrow;
2009 }
2010 }
2011 else if (tok.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF)) // premature end of comment
2012 {
2013 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"unexpected end of comment while looking"
2014 " for a html description title");
2015 goto endrow;
2016 }
2017 else // token other than html token
2018 {
2019 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"expected <td> or <th> tag but found {} token instead!",
2020 tok.to_string());
2021 goto endrow;
2022 }
2023
2024 // parse one or more cells
2025 do
2026 {
2027 children().append<DocHtmlCell>(parser(),thisVariant(),
2029 isHeading);
2030 cell = children().get_last<DocHtmlCell>();
2031 cell->markFirst(isFirst);
2032 isFirst=FALSE;
2033 retval=cell->parse();
2034 isHeading = retval.is(TokenRetval::RetVal_TableHCell);
2035 //printf("DocHtmlRow:retval=%s\n",retval.to_string());
2036 if (retval.is(TokenRetval::RetVal_EndTableCell))
2037 {
2038 // get next token
2039 retval = skipSpacesForTable(parser());
2040 //printf("DocHtmlRow:retval= next=%s name=%s endTag=%d\n",retval.to_string(),qPrint(parser()->context.token->name),parser()->context.token->endTag);
2041 HtmlTagType tagId=Mappers::htmlTagMapper->map(parser()->context.token->name);
2042 if (tok.is(TokenRetval::TK_HTMLTAG))
2043 {
2044 if ((tagId==HtmlTagType::HTML_TD || tagId==HtmlTagType::HTML_TH) &&
2045 !parser()->context.token->endTag) // found new <td> or <td> tag
2046 {
2047 retval = Token::make_RetVal_TableCell();
2049 }
2050 else if (tagId==HtmlTagType::HTML_TR)
2051 {
2052 if (parser()->context.token->endTag) // found </tr> tag
2053 {
2054 retval = Token::make_RetVal_EndTableRow();
2055 }
2056 else // found <tr> tag
2057 {
2058 retval = Token::make_RetVal_TableRow();
2059 }
2060 }
2061 else if (tagId==HtmlTagType::HTML_TABLE && parser()->context.token->endTag) // found </table>
2062 {
2063 retval = Token::make_RetVal_EndTable();
2064 }
2065 else // found some other tag
2066 {
2067 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"expected <td>, <th> or <tr> tag but "
2068 "found <{}{}> instead!",parser()->context.token->endTag ? "/" : "", parser()->context.token->name);
2069 parser()->tokenizer.pushBackHtmlTag(parser()->context.token->name);
2070 goto endrow;
2071 }
2072 }
2073 else // token other than html token
2074 {
2075 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"expected <td>, <th> or <tr> tag but found {} token instead!",
2076 tok.to_string());
2077 goto endrow;
2078 }
2079 }
2080 }
2081 while (retval.is_any_of(TokenRetval::RetVal_TableCell,TokenRetval::RetVal_TableHCell));
2082 cell->markLast(TRUE);
2083
2084endrow:
2085 return retval;
2086}
void markLast(bool v=TRUE)
Definition docnode.h:1204
void markFirst(bool v=TRUE)
Definition docnode.h:1203
Token parse()
Definition docnode.cpp:1783
bool isHeading() const
Definition docnode.cpp:1935
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
static Token skipSpacesForTable(DocParser *parser)
Definition docnode.cpp:1950
#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, DocCompoundNode::children(), DocParser::context, FALSE, DocNodeList::get_last(), HTML_TABLE, HTML_TD, HTML_TH, HTML_TR, Mappers::htmlTagMapper, Token::is(), Token::is_any_of(), isHeading(), DocHtmlCell::markFirst(), DocHtmlCell::markLast(), DocHtmlCell::parse(), DocNode::parser(), DocTokenizer::pushBackHtmlTag(), skipSpacesForTable(), DocNode::thisVariant(), Token::to_string(), DocParserContext::token, DocParser::tokenizer, TRUE, and warn_doc_error.

◆ parseXml()

Token DocHtmlRow::parseXml ( bool header)

Definition at line 2088 of file docnode.cpp.

2089{
2090 AUTO_TRACE();
2091 Token retval = Token::make_RetVal_OK();
2092 auto ns = AutoNodeStack(parser(),thisVariant());
2093
2094 bool isFirst=TRUE;
2095 DocHtmlCell *cell=nullptr;
2096
2097 // get next token
2098 Token tok=parser()->tokenizer.lex();
2099 // skip whitespace
2100 while (tok.is_any_of(TokenRetval::TK_WHITESPACE,TokenRetval::TK_NEWPARA)) tok=parser()->tokenizer.lex();
2101 // should find a html tag now
2102 if (tok.is(TokenRetval::TK_HTMLTAG))
2103 {
2104 HtmlTagType tagId=Mappers::htmlTagMapper->map(parser()->context.token->name);
2105 if (tagId==HtmlTagType::XML_TERM && !parser()->context.token->endTag) // found <term> tag
2106 {
2107 }
2108 else if (tagId==HtmlTagType::XML_DESCRIPTION && !parser()->context.token->endTag) // found <description> tag
2109 {
2110 }
2111 else // found some other tag
2112 {
2113 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"expected <term> or <description> tag but "
2114 "found <{}> instead!",parser()->context.token->name);
2115 parser()->tokenizer.pushBackHtmlTag(parser()->context.token->name);
2116 goto endrow;
2117 }
2118 }
2119 else if (tok.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF)) // premature end of comment
2120 {
2121 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"unexpected end of comment while looking"
2122 " for a html description title");
2123 goto endrow;
2124 }
2125 else // token other than html token
2126 {
2127 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"expected <td> or <th> tag but found {} token instead!",
2128 tok.to_string());
2129 goto endrow;
2130 }
2131
2132 do
2133 {
2135 cell = children().get_last<DocHtmlCell>();
2136 cell->markFirst(isFirst);
2137 isFirst=FALSE;
2138 retval=cell->parseXml();
2139 }
2140 while (retval.is_any_of(TokenRetval::RetVal_TableCell,TokenRetval::RetVal_TableHCell));
2141 cell->markLast(TRUE);
2142
2143endrow:
2144 return retval;
2145}
Token parseXml()
Definition docnode.cpp:1817

References DocNodeList::append(), TokenInfo::attribs, AUTO_TRACE, DocCompoundNode::children(), DocParser::context, FALSE, DocNodeList::get_last(), Mappers::htmlTagMapper, Token::is(), Token::is_any_of(), isHeading(), DocTokenizer::lex(), DocHtmlCell::markFirst(), DocHtmlCell::markLast(), DocNode::parser(), DocHtmlCell::parseXml(), DocTokenizer::pushBackHtmlTag(), DocNode::thisVariant(), Token::to_string(), DocParserContext::token, DocParser::tokenizer, TRUE, warn_doc_error, XML_DESCRIPTION, and XML_TERM.

◆ rowIndex()

uint32_t DocHtmlRow::rowIndex ( ) const
inline

Definition at line 1258 of file docnode.h.

1258{ return m_rowIdx; }
uint32_t m_rowIdx
Definition docnode.h:1264

References m_rowIdx.

Referenced by LatexDocVisitor::operator()().

◆ setRowIndex()

void DocHtmlRow::setRowIndex ( uint32_t idx)
inlineprivate

Definition at line 1261 of file docnode.h.

1261{ m_rowIdx = idx; }

References m_rowIdx.

Referenced by DocHtmlTable::computeTableGrid().

◆ setVisibleCells()

void DocHtmlRow::setVisibleCells ( uint32_t n)
inline

Definition at line 1256 of file docnode.h.

1256{ m_visibleCells = n; }
uint32_t m_visibleCells
Definition docnode.h:1263

References m_visibleCells.

Referenced by DocHtmlTable::computeTableGrid().

◆ visibleCells()

uint32_t DocHtmlRow::visibleCells ( ) const
inline

Definition at line 1257 of file docnode.h.

1257{ return m_visibleCells; }

References m_visibleCells.

◆ DocHtmlTable

friend class DocHtmlTable
friend

Definition at line 1247 of file docnode.h.

References DocHtmlTable.

Referenced by DocHtmlTable.

Member Data Documentation

◆ m_attribs

HtmlAttribList DocHtmlRow::m_attribs
private

Definition at line 1262 of file docnode.h.

Referenced by attribs(), and DocHtmlRow().

◆ m_rowIdx

uint32_t DocHtmlRow::m_rowIdx = static_cast<uint32_t>(-1)
private

Definition at line 1264 of file docnode.h.

Referenced by rowIndex(), and setRowIndex().

◆ m_visibleCells

uint32_t DocHtmlRow::m_visibleCells = 0
private

Definition at line 1263 of file docnode.h.

Referenced by setVisibleCells(), and visibleCells().


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