DocHtmlTable Class Reference

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(parser,parent), m_attribs(attribs) {}

References attribs(), DocCompoundNode::DocCompoundNode(), 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.

{ return m_attribs; }

References m_attribs.

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

caption()

const DocNodeVariant * DocHtmlTable::caption

(

)

const

Definition at line 2334 of file docnode.cpp.

{
  return m_caption.get();
}

References m_caption.

Referenced by DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), PerlModDocVisitor::operator()(), PrintDocVisitor::operator()(), RTFDocVisitor::operator()(), and XmlDocVisitor::operator()().

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 2504 of file docnode.cpp.

{
  //printf("computeTableGrid()\n");
  RowSpanList rowSpans;
  uint32_t maxCols=0;
  uint32_t rowIdx=1;
  for (auto &rowNode : children())
  {
    uint32_t colIdx=1;
    uint32_t cells=0;
    DocHtmlRow *row = std::get_if<DocHtmlRow>(&rowNode);
    if (row)
    {
      for (auto &cellNode : row->children())
      {
        DocHtmlCell *cell = std::get_if<DocHtmlCell>(&cellNode);
        if (cell)
        {
          uint32_t rs = cell->rowSpan();
          uint32_t cs = cell->colSpan();
 
          for (size_t i=0;i<rowSpans.size();i++)
          {
            if (rowSpans[i].rowsLeft>0 &&
                rowSpans[i].column==colIdx)
            {
              colIdx=rowSpans[i].column+1;
              cells++;
            }
          }
          if (rs>0) rowSpans.emplace_back(rs,colIdx);
          //printf("found cell at (%d,%d)\n",rowIdx,colIdx);
          cell->setRowIndex(rowIdx);
          cell->setColumnIndex(colIdx);
          colIdx+=cs;
          cells++;
        }
      }
      for (size_t i=0;i<rowSpans.size();i++)
      {
        if (rowSpans[i].rowsLeft>0) rowSpans[i].rowsLeft--;
      }
      row->setVisibleCells(cells);
      row->setRowIndex(rowIdx);
      rowIdx++;
    }
    if (colIdx-1>maxCols) maxCols=colIdx-1;
  }
  m_numCols = maxCols;
}

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 2329 of file docnode.cpp.

{
  return m_caption!=nullptr;
}

References m_caption.

numberHeaderRows()

size_t DocHtmlTable::numberHeaderRows

(

)

const

Definition at line 2339 of file docnode.cpp.

{
  size_t hl = 0;
  for (auto &rowNode : children())
  {
    const DocHtmlRow *row = std::get_if<DocHtmlRow>(&rowNode);
    if (row)
    {
      if (!row->isHeading())  break;
      hl++;
    }
  }
  return hl;
}

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

Referenced by LatexDocVisitor::operator()().

numColumns()

size_t DocHtmlTable::numColumns ( ) const

inline

Definition at line 1283 of file docnode.h.

{ return m_numCols; }

References m_numCols.

Referenced by DocbookDocVisitor::operator()(), LatexDocVisitor::operator()(), PrintDocVisitor::operator()(), and XmlDocVisitor::operator()().

numRows()

size_t DocHtmlTable::numRows ( ) const

inline

Definition at line 1278 of file docnode.h.

{ return children().size(); }

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

Referenced by PerlModDocVisitor::operator()(), PrintDocVisitor::operator()(), and XmlDocVisitor::operator()().

parse()

Token DocHtmlTable::parse

(

)

Definition at line 2354 of file docnode.cpp.

{
  AUTO_TRACE();
  Token retval = Token::make_RetVal_OK();
  auto ns = AutoNodeStack(parser(),thisVariant());
 
getrow:
  // skip whitespace and tbody, thead and tfoot tags
  Token tok = skipSpacesForTable(parser());
  // should find a html tag now
  if (tok.is(TokenRetval::TK_HTMLTAG))
  {
    HtmlTagType tagId=Mappers::htmlTagMapper->map(parser()->context.token->name);
    if (tagId==HtmlTagType::HTML_TR && !parser()->context.token->endTag) // found <tr> tag
    {
      // no caption, just rows
      retval = Token::make_RetVal_TableRow();
    }
    else if (tagId==HtmlTagType::HTML_CAPTION && !parser()->context.token->endTag) // found <caption> tag
    {
      if (m_caption)
      {
        warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"table already has a caption, found another one");
      }
      else
      {
        m_caption = createDocNode<DocHtmlCaption>(parser(),thisVariant(),parser()->context.token->attribs);
        retval=std::get<DocHtmlCaption>(*m_caption).parse();
 
        if (retval.is(TokenRetval::RetVal_OK)) // caption was parsed ok
        {
          goto getrow;
        }
      }
    }
    else // found wrong token
    {
      warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"expected <tr> or <caption> tag but "
          "found <{}{}> instead!", parser()->context.token->endTag ? "/" : "", parser()->context.token->name);
    }
  }
  else if (tok.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF)) // premature end of comment
  {
      warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"unexpected end of comment while looking"
          " for a <tr> or <caption> tag");
  }
  else // token other than html token
  {
    warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"expected <tr> tag but found {} token instead!",
        tok.to_string());
  }
 
  // parse one or more rows
  while (retval.is(TokenRetval::RetVal_TableRow))
  {
    children().append<DocHtmlRow>(parser(),thisVariant(),parser()->context.token->attribs);
    retval = children().get_last<DocHtmlRow>()->parse();
    //printf("DocHtmlTable::retval=%s\n",retval.to_string());
    if (retval.is(TokenRetval::RetVal_EndTableRow))
    {
      // get next token
      retval = skipSpacesForTable(parser());
      //printf("DocHtmlTable::retval= next=%s name=%s endTag=%d\n",retval.to_string(),qPrint(parser()->context.token->name),parser()->context.token->endTag);
      HtmlTagType tagId=Mappers::htmlTagMapper->map(parser()->context.token->name);
      if (tagId==HtmlTagType::HTML_TR && !parser()->context.token->endTag)
      {
        retval = Token::make_RetVal_TableRow();
      }
      else if (tagId==HtmlTagType::HTML_TABLE && parser()->context.token->endTag)
      {
        retval = Token::make_RetVal_EndTable();
      }
      else if (retval.is(TokenRetval::TK_HTMLTAG)) // some other HTML tag
      {
        warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"expected <tr> or </table> tag but "
            "found <{}> instead!",parser()->context.token->name);
        parser()->tokenizer.pushBackHtmlTag(parser()->context.token->name);
      }
      else // found some other tag
      {
        warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"expected <tr> or </table> tag but "
            "found token {} instead!",retval.to_string());
        retval=Token::make_RetVal_OK();
        break;
      }
    }
  }
 
  computeTableGrid();
 
  return retval.is(TokenRetval::RetVal_EndTable) ? Token::make_RetVal_OK() : retval;
}

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 2447 of file docnode.cpp.

{
  AUTO_TRACE();
  Token retval = Token::make_RetVal_OK();
  auto ns = AutoNodeStack(parser(),thisVariant());
 
  // get next token
  Token tok=parser()->tokenizer.lex();
  // skip whitespace
  while (tok.is_any_of(TokenRetval::TK_WHITESPACE,TokenRetval::TK_NEWPARA)) tok=parser()->tokenizer.lex();
  // should find a html tag now
  HtmlTagType tagId=HtmlTagType::UNKNOWN;
  bool isHeader=false;
  if (tok.is(TokenRetval::TK_HTMLTAG))
  {
    tagId=Mappers::htmlTagMapper->map(parser()->context.token->name);
    if (tagId==HtmlTagType::XML_ITEM && !parser()->context.token->endTag) // found <item> tag
    {
      retval = Token::make_RetVal_TableRow();
    }
    if (tagId==HtmlTagType::XML_LISTHEADER && !parser()->context.token->endTag) // found <listheader> tag
    {
      retval = Token::make_RetVal_TableRow();
      isHeader=true;
    }
  }
 
  // parse one or more rows
  while (retval.is(TokenRetval::RetVal_TableRow))
  {
    children().append<DocHtmlRow>(parser(),thisVariant(),parser()->context.token->attribs);
    DocHtmlRow *tr = children().get_last<DocHtmlRow>();
    retval=tr->parseXml(isHeader);
    isHeader=false;
  }
 
  computeTableGrid();
 
  tagId=Mappers::htmlTagMapper->map(parser()->context.token->name);
  return tagId==HtmlTagType::XML_LIST && parser()->context.token->endTag ? Token::make_RetVal_OK() : retval;
}

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:

• src/docnode.h
• src/docnode.cpp