Node representing a HTML table 更多...

#include <docparser.h>

类 DocHtmlTable 继承关系图:

DocHtmlTable 的协作图:

Public 成员函数
	DocHtmlTable (DocParser &parser, DocNode *parent, const HtmlAttribList &attribs)

	~DocHtmlTable ()

Kind	kind () const override

size_t	numRows () const

bool	hasCaption ()

const HtmlAttribList &	attribs () const

int	parse ()

int	parseXml ()

size_t	numColumns () const

void	accept (DocVisitor *v) override

DocHtmlCaption *	caption () const

DocHtmlRow *	firstRow () const

Public 成员函数继承自 CompAccept< DocHtmlTable >
	CompAccept (DocParser &parser)

void	accept (DocVisitor *v) override

const DocNodeList &	children () const

DocNodeList &	children ()

Public 成员函数继承自 DocNode
	DocNode (DocParser &parser)

virtual	~DocNode ()

DocNode *	parent () const

void	setParent (DocNode *parent)

bool	isPreformatted () const

Private 成员函数
void	computeTableGrid ()
	determines the location of all cells in a grid, resolving row and column spans. 更多...

Private 属性
DocHtmlCaption *	m_caption = 0

HtmlAttribList	m_attribs

size_t	m_numCols = 0

额外继承的成员函数
Public 类型继承自 DocNode
enum	Kind { Kind_Root = 0, Kind_Word = 1, Kind_WhiteSpace = 2, Kind_Para = 3, Kind_AutoList = 4, Kind_AutoListItem = 5, Kind_Symbol = 6, Kind_URL = 7, Kind_StyleChange = 8, Kind_SimpleSect = 9, Kind_Title = 10, Kind_SimpleList = 11, Kind_SimpleListItem = 12, Kind_Section = 13, Kind_Verbatim = 14, Kind_XRefItem = 15, Kind_HtmlList = 16, Kind_HtmlListItem = 17, Kind_HtmlDescList = 18, Kind_HtmlDescData = 19, Kind_HtmlDescTitle = 20, Kind_HtmlTable = 21, Kind_HtmlRow = 22, Kind_HtmlCell = 23, Kind_HtmlCaption = 24, Kind_LineBreak = 25, Kind_HorRuler = 26, Kind_Anchor = 27, Kind_IndexEntry = 28, Kind_Internal = 29, Kind_HRef = 30, Kind_Include = 31, Kind_IncOperator = 32, Kind_HtmlHeader = 33, Kind_Image = 34, Kind_DotFile = 35, Kind_Link = 36, Kind_Ref = 37, Kind_Formula = 38, Kind_SecRefItem = 39, Kind_SecRefList = 40, Kind_SimpleSectSep = 41, Kind_LinkedWord = 42, Kind_ParamSect = 43, Kind_ParamList = 44, Kind_InternalRef = 45, Kind_Copy = 46, Kind_Text = 47, Kind_MscFile = 48, Kind_HtmlBlockQuote = 49, Kind_VhdlFlow = 50, Kind_ParBlock = 51, Kind_DiaFile = 52, Kind_Emoji = 53, Kind_Sep = 54 }

Protected 类型继承自 DocNode
enum	RefType { Unknown, Anchor, Section, Table }

Protected 成员函数继承自 DocNode
void	setInsidePreformatted (bool p)

Protected 属性继承自 CompAccept< DocHtmlTable >
DocNodeList	m_children

Protected 属性继承自 DocNode
DocNode *	m_parent = 0

DocParser &	m_parser

详细描述

Node representing a HTML table

在文件 docparser.h 第 1405 行定义.

构造及析构函数说明

◆ DocHtmlTable()

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

inline

在文件 docparser.h 第 1408 行定义.

1409 : CompAccept<DocHtmlTable>(parser), m_attribs(attribs) { m_caption=0; m_numCols=0; m_parent = parent; }

引用了 m_caption, m_numCols, DocNode::m_parent , 以及 DocNode::parent().

◆ ~DocHtmlTable()

DocHtmlTable::~DocHtmlTable ( )

inline

在文件 docparser.h 第 1410 行定义.

1410 { delete m_caption; }

引用了 m_caption.

成员函数说明

◆ accept()

void DocHtmlTable::accept ( DocVisitor * v )

overridevirtual

Acceptor function for node visitors. Part of the visitor pattern.

参数

v	Abstract visitor.

实现了 DocNode.

在文件 docparser.cpp 第 3729 行定义.

 {
   v->visitPre(this);
   // for HTML output we put the caption first
   //if (m_caption && v->id()==DocVisitor_Html) m_caption->accept(v);
   // doxygen 1.8.11: always put the caption first
   if (m_caption) m_caption->accept(v);
   for (const auto &n : m_children) n->accept(v);
   // for other output formats we put the caption last
   //if (m_caption && v->id()!=DocVisitor_Html) m_caption->accept(v);
   v->visitPost(this);
 }

引用了 CompAccept< T >::accept(), m_caption, CompAccept< DocHtmlTable >::m_children, DocVisitor::visitPost() , 以及 DocVisitor::visitPre().

◆ attribs()

const HtmlAttribList& DocHtmlTable::attribs ( ) const

inline

在文件 docparser.h 第 1414 行定义.

1414 { return m_attribs; }

引用了 m_attribs.

被这些函数引用 HtmlDocVisitor::visitPre() , 以及 XmlDocVisitor::visitPre().

◆ caption()

DocHtmlCaption* DocHtmlTable::caption ( ) const

inline

在文件 docparser.h 第 1419 行定义.

1419 { return m_caption; }

引用了 m_caption.

被这些函数引用 HtmlDocVisitor::visitPre() , 以及 LatexDocVisitor::visitPre().

◆ 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.

在文件 docparser.cpp 第 3677 行定义.

 {
   //printf("computeTableGrid()\n");
   RowSpanList rowSpans;
   uint maxCols=0;
   uint rowIdx=1;
   for (const auto &rowNode : children())
   {
     uint colIdx=1;
     uint cells=0;
     if (rowNode->kind()==DocNode::Kind_HtmlRow)
     {
       size_t i;
       DocHtmlRow *row = (DocHtmlRow*)rowNode.get();
       for (const auto &cellNode : row->children())
       {
         if (cellNode->kind()==DocNode::Kind_HtmlCell)
         {
           DocHtmlCell *cell = (DocHtmlCell*)cellNode.get();
           uint rs = cell->rowSpan();
           uint cs = cell->colSpan();
  
           for (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 (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;
 }

引用了 CompAccept< DocHtmlTable >::children(), CompAccept< T >::children(), DocHtmlCell::colSpan(), DocNode::Kind_HtmlCell, DocNode::Kind_HtmlRow, m_numCols, DocHtmlCell::rowSpan(), DocHtmlCell::setColumnIndex(), DocHtmlCell::setRowIndex(), DocHtmlRow::setRowIndex() , 以及 DocHtmlRow::setVisibleCells().

被这些函数引用 parse() , 以及 parseXml().

◆ firstRow()

DocHtmlRow* DocHtmlTable::firstRow ( ) const

inline

在文件 docparser.h 第 1420 行定义.

                                  {
                              return (!m_children.empty() && m_children.front()->kind()==Kind_HtmlRow) ?
                                      (DocHtmlRow*)m_children.front().get() : 0;
                            }

引用了 DocNode::Kind_HtmlRow , 以及 CompAccept< DocHtmlTable >::m_children.

被这些函数引用 LatexDocVisitor::visitPre().

◆ hasCaption()

bool DocHtmlTable::hasCaption ( )

inline

在文件 docparser.h 第 1413 行定义.

1413 { return m_caption!=0; }

引用了 m_caption.

被这些函数引用 HtmlDocVisitor::visitPre() , 以及 LatexDocVisitor::visitPre().

◆ kind()

Kind DocHtmlTable::kind ( ) const

inlineoverridevirtual

Returns the kind of node. Provides runtime type information

实现了 DocNode.

在文件 docparser.h 第 1411 行定义.

1411 { return Kind_HtmlTable; }

引用了 DocNode::Kind_HtmlTable.

◆ numColumns()

size_t DocHtmlTable::numColumns ( ) const

inline

在文件 docparser.h 第 1417 行定义.

1417 { return m_numCols; }

引用了 m_numCols.

被这些函数引用 PrintDocVisitor::visitPost(), DocbookDocVisitor::visitPre(), LatexDocVisitor::visitPre() , 以及 XmlDocVisitor::visitPre().

◆ numRows()

size_t DocHtmlTable::numRows ( ) const

inline

在文件 docparser.h 第 1412 行定义.

1412 { return m_children.size(); }

引用了 CompAccept< DocHtmlTable >::m_children.

被这些函数引用 PrintDocVisitor::visitPost() , 以及 XmlDocVisitor::visitPre().

◆ parse()

int DocHtmlTable::parse ( )

在文件 docparser.cpp 第 3551 行定义.

 {
   int retval=RetVal_OK;
   auto ns = AutoNodeStack(m_parser,this);
   DBG(("DocHtmlTable::parse() start\n"));
  
 getrow:
   // get next token
   int tok=m_parser.tokenizer.lex();
   // skip whitespace
   while (tok==TK_WHITESPACE || tok==TK_NEWPARA) tok=m_parser.tokenizer.lex();
   // should find a html tag now
   if (tok==TK_HTMLTAG)
   {
     int tagId=Mappers::htmlTagMapper->map(m_parser.context.token->name);
     if (tagId==HTML_TR && !m_parser.context.token->endTag) // found <tr> tag
     {
       // no caption, just rows
       retval=RetVal_TableRow;
     }
     else if (tagId==HTML_CAPTION && !m_parser.context.token->endTag) // found <caption> tag
     {
       if (m_caption)
       {
         warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"table already has a caption, found another one");
       }
       else
       {
         m_caption = new DocHtmlCaption(m_parser,this,m_parser.context.token->attribs);
         retval=m_caption->parse();
  
         if (retval==RetVal_OK) // caption was parsed ok
         {
           goto getrow;
         }
       }
     }
     else // found wrong token
     {
       warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"expected <tr> or <caption> tag but "
           "found <%s%s> instead!", m_parser.context.token->endTag ? "/" : "", qPrint(m_parser.context.token->name));
     }
   }
   else if (tok==0) // premature end of comment
   {
       warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"unexpected end of comment while looking"
           " for a <tr> or <caption> tag");
   }
   else // token other than html token
   {
     warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"expected <tr> tag but found %s token instead!",
         DocTokenizer::tokToString(tok));
   }
  
   // parse one or more rows
   while (retval==RetVal_TableRow)
   {
     DocHtmlRow *tr=new DocHtmlRow(m_parser,this,m_parser.context.token->attribs);
     m_children.push_back(std::unique_ptr<DocHtmlRow>(tr));
     retval=tr->parse();
   }
  
   computeTableGrid();
  
   DBG(("DocHtmlTable::parse() end\n"));
   return retval==RetVal_EndTable ? RetVal_OK : retval;
 }

引用了 TokenInfo::attribs, computeTableGrid(), DocParser::context, DBG, TokenInfo::endTag, DocParserContext::fileName, DocTokenizer::getLineNr(), HTML_CAPTION, HTML_TR, Mappers::htmlTagMapper, DocTokenizer::lex(), m_caption, CompAccept< DocHtmlTable >::m_children, DocNode::m_parser, Mapper::map(), TokenInfo::name, DocHtmlCaption::parse(), DocHtmlRow::parse(), qPrint(), RetVal_EndTable, RetVal_OK, RetVal_TableRow, TK_HTMLTAG, TK_NEWPARA, TK_WHITESPACE, DocParserContext::token, DocParser::tokenizer, DocTokenizer::tokToString() , 以及 warn_doc_error().

被这些函数引用 DocPara::handleHtmlStartTag().

◆ parseXml()

int DocHtmlTable::parseXml ( )

在文件 docparser.cpp 第 3619 行定义.

 {
   int retval=RetVal_OK;
   auto ns = AutoNodeStack(m_parser,this);
   DBG(("DocHtmlTable::parseXml() start\n"));
  
   // get next token
   int tok=m_parser.tokenizer.lex();
   // skip whitespace
   while (tok==TK_WHITESPACE || tok==TK_NEWPARA) tok=m_parser.tokenizer.lex();
   // should find a html tag now
   int tagId=0;
   bool isHeader=FALSE;
   if (tok==TK_HTMLTAG)
   {
     tagId=Mappers::htmlTagMapper->map(m_parser.context.token->name);
     if (tagId==XML_ITEM && !m_parser.context.token->endTag) // found <item> tag
     {
       retval=RetVal_TableRow;
     }
     if (tagId==XML_LISTHEADER && !m_parser.context.token->endTag) // found <listheader> tag
     {
       retval=RetVal_TableRow;
       isHeader=TRUE;
     }
   }
  
   // parse one or more rows
   while (retval==RetVal_TableRow)
   {
     DocHtmlRow *tr=new DocHtmlRow(m_parser,this,m_parser.context.token->attribs);
     m_children.push_back(std::unique_ptr<DocHtmlRow>(tr));
     retval=tr->parseXml(isHeader);
     isHeader=FALSE;
   }
  
   computeTableGrid();
  
   DBG(("DocHtmlTable::parseXml() end\n"));
   tagId=Mappers::htmlTagMapper->map(m_parser.context.token->name);
   return tagId==XML_LIST && m_parser.context.token->endTag ? RetVal_OK : retval;
 }

引用了 TokenInfo::attribs, computeTableGrid(), DocParser::context, DBG, TokenInfo::endTag, FALSE, Mappers::htmlTagMapper, DocTokenizer::lex(), CompAccept< DocHtmlTable >::m_children, DocNode::m_parser, Mapper::map(), TokenInfo::name, DocHtmlRow::parseXml(), RetVal_OK, RetVal_TableRow, TK_HTMLTAG, TK_NEWPARA, TK_WHITESPACE, DocParserContext::token, DocParser::tokenizer, TRUE, XML_ITEM, XML_LIST , 以及 XML_LISTHEADER.

被这些函数引用 DocPara::handleHtmlStartTag().

类成员变量说明

◆ m_attribs

HtmlAttribList DocHtmlTable::m_attribs

private

在文件 docparser.h 第 1428 行定义.

被这些函数引用 attribs().

◆ m_caption

DocHtmlCaption* DocHtmlTable::m_caption = 0

private

在文件 docparser.h 第 1427 行定义.

被这些函数引用 accept(), caption(), DocHtmlTable(), hasCaption(), parse() , 以及 ~DocHtmlTable().

◆ m_numCols

size_t DocHtmlTable::m_numCols = 0

private

在文件 docparser.h 第 1429 行定义.

被这些函数引用 computeTableGrid(), DocHtmlTable() , 以及 numColumns().

该类的文档由以下文件生成:

src/docparser.h
src/docparser.cpp

Public 成员函数

Private 成员函数

Private 属性

额外继承的成员函数

详细描述

构造及析构函数说明

◆ DocHtmlTable()

◆ ~DocHtmlTable()

成员函数说明

◆ accept()

◆ attribs()

◆ caption()

◆ computeTableGrid()

◆ firstRow()

◆ hasCaption()

◆ kind()

◆ numColumns()

◆ numRows()

◆ parse()

◆ parseXml()

类成员变量说明

◆ m_attribs

◆ m_caption

◆ m_numCols