Doxygen
Loading...
Searching...
No Matches
DocHtmlTable Class Referencefinal

Node representing a HTML table. More...

#include <src/docnode.h>

Inheritance diagram for DocHtmlTable:
Collaboration diagram for DocHtmlTable:

Public Member Functions

 DocHtmlTable (DocParser *parser, DocNodeVariant *parent, const HtmlAttribList &attribs)
size_t numRows () const
bool hasCaption () const
const HtmlAttribList & attribs () const
Token parse ()
Token parseXml ()
size_t numColumns () const
const DocNodeVariant * caption () const
size_t numberHeaderRows () const
Public Member Functions inherited from DocCompoundNode
 DocCompoundNode (DocParser *parser, DocNodeVariant *parent)
DocNodeList & children ()
const DocNodeList & children () const
Public Member Functions inherited from DocNode
 DocNode (DocParser *parser, DocNodeVariant *parent)
 ~DocNode ()=default
DocNodeVariant * parent ()
const DocNodeVariant * parent () const
DocNodeVariant * thisVariant ()
const DocNodeVariant * thisVariant () const
void setThisVariant (DocNodeVariant *thisVariant)
DocParser * parser ()
const DocParser * parser () const
void setParent (DocNodeVariant *parent)
bool isPreformatted () const

Private Member Functions

void computeTableGrid ()
 determines the location of all cells in a grid, resolving row and column spans.

Private Attributes

std::unique_ptr< DocNodeVariant > m_caption
HtmlAttribList m_attribs
size_t m_numCols = 0

Additional Inherited Members

Protected Types inherited from DocNode
enum  RefType {
  Unknown , Anchor , Section , Table ,
  Requirement
}
Protected Member Functions inherited from DocNode
void setInsidePreformatted (bool p)

Detailed Description

Node representing a HTML table.

Definition at line 1273 of file docnode.h.

Constructor & Destructor Documentation

◆ DocHtmlTable()

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

Definition at line 1276 of file docnode.h.

DocCompoundNode(DocParser *parser, DocNodeVariant *parent)
Definition docnode.h:141
const HtmlAttribList & attribs() const
Definition docnode.h:1280
HtmlAttribList m_attribs
Definition docnode.h:1290
DocParser * parser()
Definition docnode.h:97
DocNodeVariant * parent()
Definition docnode.h:89

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

Member Function Documentation

◆ attribs()

const HtmlAttribList & DocHtmlTable::attribs ( ) const
inline

Definition at line 1280 of file docnode.h.

1280{ return m_attribs; }

References m_attribs.

Referenced by DocHtmlTable(), HtmlDocVisitor::operator()(), and XmlDocVisitor::operator()().

◆ caption()

const DocNodeVariant * DocHtmlTable::caption ( ) const

◆ computeTableGrid()

void DocHtmlTable::computeTableGrid ( )
private

determines the location of all cells in a grid, resolving row and column spans.

For each the total number of visible cells is computed, and the total number of visible columns over all rows is stored.

Definition at line 2520 of file docnode.cpp.

2521{
2522 //printf("computeTableGrid()\n");
2523 RowSpanList rowSpans;
2524 uint32_t maxCols=0;
2525 uint32_t rowIdx=1;
2526 for (auto &rowNode : children())
2527 {
2528 uint32_t colIdx=1;
2529 uint32_t cells=0;
2530 DocHtmlRow *row = std::get_if<DocHtmlRow>(&rowNode);
2531 if (row)
2532 {
2533 for (auto &cellNode : row->children())
2534 {
2535 DocHtmlCell *cell = std::get_if<DocHtmlCell>(&cellNode);
2536 if (cell)
2537 {
2538 uint32_t rs = cell->rowSpan();
2539 uint32_t cs = cell->colSpan();
2540
2541 for (size_t i=0;i<rowSpans.size();i++)
2542 {
2543 if (rowSpans[i].rowsLeft>0 &&
2544 rowSpans[i].column==colIdx)
2545 {
2546 colIdx=rowSpans[i].column+1;
2547 cells++;
2548 }
2549 }
2550 if (rs>0) rowSpans.emplace_back(rs,colIdx);
2551 //printf("found cell at (%d,%d)\n",rowIdx,colIdx);
2552 cell->setRowIndex(rowIdx);
2553 cell->setColumnIndex(colIdx);
2554 colIdx+=cs;
2555 cells++;
2556 }
2557 }
2558 for (size_t i=0;i<rowSpans.size();i++)
2559 {
2560 if (rowSpans[i].rowsLeft>0) rowSpans[i].rowsLeft--;
2561 }
2562 row->setVisibleCells(cells);
2563 row->setRowIndex(rowIdx);
2564 rowIdx++;
2565 }
2566 if (colIdx-1>maxCols) maxCols=colIdx-1;
2567 }
2568 m_numCols = maxCols;
2569}
DocNodeList & children()
Definition docnode.h:143
void setColumnIndex(uint32_t idx)
Definition docnode.h:1222
void setRowIndex(uint32_t idx)
Definition docnode.h:1221
uint32_t rowSpan() const
Definition docnode.cpp:2018
uint32_t colSpan() const
Definition docnode.cpp:2030
void setVisibleCells(uint32_t n)
Definition docnode.h:1261
void setRowIndex(uint32_t idx)
Definition docnode.h:1266
size_t m_numCols
Definition docnode.h:1291
std::vector< ActiveRowSpan > RowSpanList
List of ActiveRowSpan classes.
Definition docnode.cpp:2514

References DocCompoundNode::children(), DocHtmlCell::colSpan(), m_numCols, DocHtmlCell::rowSpan(), DocHtmlCell::setColumnIndex(), DocHtmlCell::setRowIndex(), DocHtmlRow::setRowIndex(), and DocHtmlRow::setVisibleCells().

Referenced by parse(), and parseXml().

◆ hasCaption()

bool DocHtmlTable::hasCaption ( ) const

Definition at line 2345 of file docnode.cpp.

2346{
2347 return m_caption!=nullptr;
2348}

References m_caption.

◆ numberHeaderRows()

size_t DocHtmlTable::numberHeaderRows ( ) const

Definition at line 2355 of file docnode.cpp.

2356{
2357 size_t hl = 0;
2358 for (auto &rowNode : children())
2359 {
2360 const DocHtmlRow *row = std::get_if<DocHtmlRow>(&rowNode);
2361 if (row)
2362 {
2363 if (!row->isHeading()) break;
2364 hl++;
2365 }
2366 }
2367 return hl;
2368}
bool isHeading() const
Definition docnode.cpp:2102

References DocCompoundNode::children(), and DocHtmlRow::isHeading().

Referenced by LatexDocVisitor::operator()().

◆ numColumns()

size_t DocHtmlTable::numColumns ( ) const
inline

◆ numRows()

size_t DocHtmlTable::numRows ( ) const
inline

Definition at line 1278 of file docnode.h.

1278{ 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 PerlModDocVisitor::operator()(), PrintDocVisitor::operator()(), and XmlDocVisitor::operator()().

◆ parse()

Token DocHtmlTable::parse ( )

Definition at line 2370 of file docnode.cpp.

2371{
2372 AUTO_TRACE();
2373 Token retval = Token::make_RetVal_OK();
2374 auto ns = AutoNodeStack(parser(),thisVariant());
2375
2376getrow:
2377 // skip whitespace and tbody, thead and tfoot tags
2378 Token tok = skipSpacesForTable(parser());
2379 // should find a html tag now
2380 if (tok.is(TokenRetval::TK_HTMLTAG))
2381 {
2382 HtmlTagType tagId=Mappers::htmlTagMapper->map(parser()->context.token->name);
2383 if (tagId==HtmlTagType::HTML_TR && !parser()->context.token->endTag) // found <tr> tag
2384 {
2385 // no caption, just rows
2386 retval = Token::make_RetVal_TableRow();
2387 }
2388 else if (tagId==HtmlTagType::HTML_CAPTION && !parser()->context.token->endTag) // found <caption> tag
2389 {
2390 if (m_caption)
2391 {
2392 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"table already has a caption, found another one");
2393 }
2394 else
2395 {
2396 m_caption = createDocNode<DocHtmlCaption>(parser(),thisVariant(),parser()->context.token->attribs);
2397 retval=std::get<DocHtmlCaption>(*m_caption).parse();
2398
2399 if (retval.is(TokenRetval::RetVal_OK)) // caption was parsed ok
2400 {
2401 goto getrow;
2402 }
2403 }
2404 }
2405 else // found wrong token
2406 {
2407 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"expected <tr> or <caption> tag but "
2408 "found <{}{}> instead!", parser()->context.token->endTag ? "/" : "", parser()->context.token->name);
2409 }
2410 }
2411 else if (tok.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF)) // premature end of comment
2412 {
2413 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"unexpected end of comment while looking"
2414 " for a <tr> or <caption> tag");
2415 }
2416 else // token other than html token
2417 {
2418 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"expected <tr> tag but found {} token instead!",
2419 tok.to_string());
2420 }
2421
2422 // parse one or more rows
2423 while (retval.is(TokenRetval::RetVal_TableRow))
2424 {
2426 retval = children().get_last<DocHtmlRow>()->parse();
2427 //printf("DocHtmlTable::retval=%s\n",retval.to_string());
2428 if (retval.is(TokenRetval::RetVal_EndTableRow))
2429 {
2430 // get next token
2431 retval = skipSpacesForTable(parser());
2432 //printf("DocHtmlTable::retval= next=%s name=%s endTag=%d\n",retval.to_string(),qPrint(parser()->context.token->name),parser()->context.token->endTag);
2433 HtmlTagType tagId=Mappers::htmlTagMapper->map(parser()->context.token->name);
2434 if (tagId==HtmlTagType::HTML_TR && !parser()->context.token->endTag)
2435 {
2436 retval = Token::make_RetVal_TableRow();
2437 }
2438 else if (tagId==HtmlTagType::HTML_TABLE && parser()->context.token->endTag)
2439 {
2440 retval = Token::make_RetVal_EndTable();
2441 }
2442 else if (retval.is(TokenRetval::TK_HTMLTAG)) // some other HTML tag
2443 {
2444 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"expected <tr> or </table> tag but "
2445 "found <{}> instead!",parser()->context.token->name);
2446 parser()->tokenizer.pushBackHtmlTag(parser()->context.token->name);
2447 }
2448 else // found some other tag
2449 {
2450 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"expected <tr> or </table> tag but "
2451 "found token {} instead!",retval.to_string());
2452 retval=Token::make_RetVal_OK();
2453 break;
2454 }
2455 }
2456 }
2457
2459
2460 return retval.is(TokenRetval::RetVal_EndTable) ? Token::make_RetVal_OK() : retval;
2461}
Token parse()
Definition docnode.cpp:2370
void computeTableGrid()
determines the location of all cells in a grid, resolving row and column spans.
Definition docnode.cpp:2520
DocNodeVariant * thisVariant()
Definition docnode.h:92
void append(Args &&... args)
Append a new DocNodeVariant to the list by constructing it with type T and parameters Args.
Definition docnode.h:1404
T * get_last()
Returns a pointer to the last element in the list if that element exists and holds a T,...
Definition docnode.h:1415
DocTokenizer tokenizer
DocParserContext context
void pushBackHtmlTag(const DString &tag)
bool is(TokenRetval rv) const
TOKEN_SPECIFICATIONS RETVAL_SPECIFICATIONS const char * to_string() const
bool is_any_of(ARGS... args) const
HtmlAttribList attribs
HtmlTagType
Definition cmdmapper.h:174
#define AUTO_TRACE(...)
Definition docnode.cpp:53
static Token skipSpacesForTable(DocParser *parser)
Definition docnode.cpp:2117
std::unique_ptr< DocNodeVariant > createDocNode(Args &&...args)
Definition docnode.h:1500
#define warn_doc_error(file, line, fmt,...)
Definition message.h:112
const Mapper< HtmlTagType > * htmlTagMapper
TokenInfo * token
Definition docparser_p.h:94

References DocNodeList::append(), TokenInfo::attribs, AUTO_TRACE, DocCompoundNode::children(), computeTableGrid(), DocParser::context, createDocNode(), DocNodeList::get_last(), HTML_CAPTION, HTML_TABLE, HTML_TR, Mappers::htmlTagMapper, Token::is(), Token::is_any_of(), m_caption, parse(), DocNode::parser(), DocTokenizer::pushBackHtmlTag(), skipSpacesForTable(), DocNode::thisVariant(), Token::to_string(), DocParserContext::token, DocParser::tokenizer, and warn_doc_error.

Referenced by parse().

◆ parseXml()

Token DocHtmlTable::parseXml ( )

Definition at line 2463 of file docnode.cpp.

2464{
2465 AUTO_TRACE();
2466 Token retval = Token::make_RetVal_OK();
2467 auto ns = AutoNodeStack(parser(),thisVariant());
2468
2469 // get next token
2470 Token tok=parser()->tokenizer.lex();
2471 // skip whitespace
2472 while (tok.is_any_of(TokenRetval::TK_WHITESPACE,TokenRetval::TK_NEWPARA)) tok=parser()->tokenizer.lex();
2473 // should find a html tag now
2475 bool isHeader=false;
2476 if (tok.is(TokenRetval::TK_HTMLTAG))
2477 {
2478 tagId=Mappers::htmlTagMapper->map(parser()->context.token->name);
2479 if (tagId==HtmlTagType::XML_ITEM && !parser()->context.token->endTag) // found <item> tag
2480 {
2481 retval = Token::make_RetVal_TableRow();
2482 }
2483 if (tagId==HtmlTagType::XML_LISTHEADER && !parser()->context.token->endTag) // found <listheader> tag
2484 {
2485 retval = Token::make_RetVal_TableRow();
2486 isHeader=true;
2487 }
2488 }
2489
2490 // parse one or more rows
2491 while (retval.is(TokenRetval::RetVal_TableRow))
2492 {
2494 DocHtmlRow *tr = children().get_last<DocHtmlRow>();
2495 retval=tr->parseXml(isHeader);
2496 isHeader=false;
2497 }
2498
2500
2501 tagId=Mappers::htmlTagMapper->map(parser()->context.token->name);
2502 return tagId==HtmlTagType::XML_LIST && parser()->context.token->endTag ? Token::make_RetVal_OK() : retval;
2503}

References DocNodeList::append(), TokenInfo::attribs, AUTO_TRACE, DocCompoundNode::children(), computeTableGrid(), DocParser::context, TokenInfo::endTag, DocNodeList::get_last(), Mappers::htmlTagMapper, Token::is(), Token::is_any_of(), DocTokenizer::lex(), DocNode::parser(), DocNode::thisVariant(), DocParserContext::token, DocParser::tokenizer, UNKNOWN, XML_ITEM, XML_LIST, and XML_LISTHEADER.

Member Data Documentation

◆ m_attribs

HtmlAttribList DocHtmlTable::m_attribs
private

Definition at line 1290 of file docnode.h.

Referenced by attribs(), and DocHtmlTable().

◆ m_caption

std::unique_ptr<DocNodeVariant> DocHtmlTable::m_caption
private

Definition at line 1289 of file docnode.h.

Referenced by caption(), hasCaption(), and parse().

◆ m_numCols

size_t DocHtmlTable::m_numCols = 0
private

Definition at line 1291 of file docnode.h.

Referenced by computeTableGrid(), and numColumns().


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