DocHtmlCell Class Reference

Node representing a HTML table cell. More...

#include <src/docnode.h>

Inheritance diagram for DocHtmlCell:

Collaboration diagram for DocHtmlCell:

Public Types
enum	Alignment { Left , Right , Center }
enum	Valignment { Top , Middle , Bottom }

Public Member Functions
	DocHtmlCell (DocParser *parser, DocNodeVariant *parent, const HtmlAttribList &attribs, bool isHeading)
bool	isHeading () const
bool	isFirst () const
bool	isLast () const
void	markFirst (bool v=TRUE)
void	markLast (bool v=TRUE)
const HtmlAttribList &	attribs () const
Token	parse ()
Token	parseXml ()
uint32_t	rowIndex () const
uint32_t	columnIndex () const
uint32_t	rowSpan () const
uint32_t	colSpan () const
Alignment	alignment () const
Valignment	valignment () 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	setRowIndex (uint32_t idx)
void	setColumnIndex (uint32_t idx)

Private Attributes
bool	m_isHeading = false
bool	m_isFirst = false
bool	m_isLast = false
HtmlAttribList	m_attribs
uint32_t	m_rowIdx = static_cast<uint32_t>(-1)
uint32_t	m_colIdx = static_cast<uint32_t>(-1)

Friends
class	DocHtmlTable

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

Definition at line 1197 of file docnode.h.

Member Enumeration Documentation

Alignment

enum DocHtmlCell::Alignment

Enumerator
Left
Right
Center

Definition at line 1201 of file docnode.h.

{ Left, Right, Center };

Valignment

enum DocHtmlCell::Valignment

Enumerator
Top
Middle
Bottom

Definition at line 1202 of file docnode.h.

{Top, Middle, Bottom};

Constructor & Destructor Documentation

DocHtmlCell()

DocHtmlCell::DocHtmlCell ( DocParser * parser, DocNodeVariant * parent, const HtmlAttribList & attribs, bool isHeading )

inline

Definition at line 1203 of file docnode.h.

                                                                                                       :
       DocCompoundNode(parser,parent), m_isHeading(isHeading), m_attribs(attribs) {}

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

Member Function Documentation

alignment()

DocHtmlCell::Alignment DocHtmlCell::alignment

(

)

const

Definition at line 1941 of file docnode.cpp.

{
  for (const auto &attr : attribs())
  {
    QCString attrName  = attr.name.lower();
    QCString attrValue = attr.value.lower();
    if (attrName=="align")
    {
      if (attrValue=="center")
        return Center;
      else if (attrValue=="right")
        return Right;
      else return Left;
    }
    else if (attrName=="class" && attrValue.startsWith("markdowntable"))
    {
      if (attrValue=="markdowntableheadcenter")
        return Center;
      else if (attrValue=="markdowntableheadright")
        return Right;
      else if (attrValue=="markdowntableheadleft")
        return Left;
      else if (attrValue=="markdowntableheadnone")
        return Center;
      else if (attrValue=="markdowntablebodycenter")
        return Center;
      else if (attrValue=="markdowntablebodyright")
        return Right;
      else if (attrValue=="markdowntablebodyleft")
        return Left;
      else if (attrValue=="markdowntablebodynone")
        return Left;
      else return Left;
    }
  }
  return Left;
}

References attribs(), Center, Left, QCString::lower(), Right, and QCString::startsWith().

Referenced by LatexDocVisitor::operator()().

attribs()

const HtmlAttribList & DocHtmlCell::attribs ( ) const

inline

Definition at line 1210 of file docnode.h.

{ return m_attribs; }

References m_attribs.

Referenced by align(), alignment(), colSpan(), DocHtmlCell(), DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), XmlDocVisitor::operator()(), rowSpan(), and valignment().

colSpan()

uint32_t DocHtmlCell::colSpan

(

)

const

Definition at line 1929 of file docnode.cpp.

{
  for (const auto &attr : attribs())
  {
    if (attr.name.lower()=="colspan")
    {
      return std::max(1u,attr.value.toUInt());
    }
  }
  return 1;
}

References attribs().

Referenced by DocHtmlTable::computeTableGrid(), and LatexDocVisitor::operator()().

columnIndex()

uint32_t DocHtmlCell::columnIndex ( ) const

inline

Definition at line 1214 of file docnode.h.

{ return m_colIdx; }

References m_colIdx.

isFirst()

bool DocHtmlCell::isFirst ( ) const

inline

Definition at line 1206 of file docnode.h.

{ return m_isFirst; }

References m_isFirst.

Referenced by parse(), and parseXml().

isHeading()

bool DocHtmlCell::isHeading ( ) const

inline

Definition at line 1205 of file docnode.h.

{ return m_isHeading; }

References m_isHeading.

Referenced by DocHtmlCell(), DocHtmlRow::isHeading(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), PerlModDocVisitor::operator()(), PrintDocVisitor::operator()(), and XmlDocVisitor::operator()().

isLast()

bool DocHtmlCell::isLast ( ) const

inline

Definition at line 1207 of file docnode.h.

{ return m_isLast; }

References m_isLast.

Referenced by LatexDocVisitor::operator()().

markFirst()

void DocHtmlCell::markFirst ( bool v = TRUE )

inline

Definition at line 1208 of file docnode.h.

{ m_isFirst=v; }

References m_isFirst, and TRUE.

Referenced by DocHtmlRow::parse(), and DocHtmlRow::parseXml().

markLast()

void DocHtmlCell::markLast ( bool v = TRUE )

inline

Definition at line 1209 of file docnode.h.

{ m_isLast=v; }

References m_isLast, and TRUE.

Referenced by DocHtmlRow::parse(), and DocHtmlRow::parseXml().

parse()

Token DocHtmlCell::parse

(

)

Definition at line 1849 of file docnode.cpp.

{
  AUTO_TRACE();
  Token retval = Token::make_RetVal_OK();
  auto ns = AutoNodeStack(parser(),thisVariant());
 
  // parse one or more paragraphs
  bool isFirst=TRUE;
  DocPara *par=nullptr;
  do
  {
    children().append<DocPara>(parser(),thisVariant());
    par = children().get_last<DocPara>();
    if (isFirst) { par->markFirst(); isFirst=FALSE; }
    retval=par->parse();
    if (retval.is(TokenRetval::TK_HTMLTAG))
    {
      HtmlTagType tagId=Mappers::htmlTagMapper->map(parser()->context.token->name);
      if (tagId==HtmlTagType::HTML_TD && parser()->context.token->endTag) // found </td> tag
      {
        retval = Token::make_TK_NEWPARA(); // ignore the tag
      }
      else if (tagId==HtmlTagType::HTML_TH && parser()->context.token->endTag) // found </th> tag
      {
        retval = Token::make_TK_NEWPARA(); // ignore the tag
      }
    }
  }
  while (retval.is_any_of(TokenRetval::TK_NEWPARA,TokenRetval::RetVal_EndParBlock));
  if (par) par->markLast();
 
  return retval;
}

References DocNodeList::append(), AUTO_TRACE, DocCompoundNode::children(), FALSE, DocNodeList::get_last(), HTML_TD, HTML_TH, Mappers::htmlTagMapper, Token::is(), Token::is_any_of(), isFirst(), DocPara::markFirst(), DocPara::markLast(), DocPara::parse(), DocNode::parser(), DocNode::thisVariant(), and TRUE.

Referenced by DocHtmlRow::parse().

parseXml()

Token DocHtmlCell::parseXml

(

)

Definition at line 1883 of file docnode.cpp.

{
  AUTO_TRACE();
  Token retval = Token::make_RetVal_OK();
  auto ns = AutoNodeStack(parser(),thisVariant());
 
  // parse one or more paragraphs
  bool isFirst=TRUE;
  DocPara *par=nullptr;
  do
  {
    children().append<DocPara>(parser(),thisVariant());
    par = children().get_last<DocPara>();
    if (isFirst) { par->markFirst(); isFirst=FALSE; }
    retval=par->parse();
    if (retval.is(TokenRetval::TK_HTMLTAG))
    {
      HtmlTagType tagId=Mappers::htmlTagMapper->map(parser()->context.token->name);
      if (tagId==HtmlTagType::XML_ITEM && parser()->context.token->endTag) // found </item> tag
      {
        retval = Token::make_TK_NEWPARA(); // ignore the tag
      }
      else if (tagId==HtmlTagType::XML_DESCRIPTION && parser()->context.token->endTag) // found </description> tag
      {
        retval = Token::make_TK_NEWPARA(); // ignore the tag
      }
    }
  }
  while (retval.is(TokenRetval::TK_NEWPARA));
  if (par) par->markLast();
 
  return retval;
}

References DocNodeList::append(), AUTO_TRACE, DocCompoundNode::children(), FALSE, DocNodeList::get_last(), Mappers::htmlTagMapper, Token::is(), isFirst(), DocPara::markFirst(), DocPara::markLast(), DocPara::parse(), DocNode::parser(), DocNode::thisVariant(), TRUE, XML_DESCRIPTION, and XML_ITEM.

Referenced by DocHtmlRow::parseXml().

rowIndex()

uint32_t DocHtmlCell::rowIndex ( ) const

inline

Definition at line 1213 of file docnode.h.

{ return m_rowIdx; }

References m_rowIdx.

rowSpan()

uint32_t DocHtmlCell::rowSpan

(

)

const

Definition at line 1917 of file docnode.cpp.

{
  for (const auto &attr : attribs())
  {
    if (attr.name.lower()=="rowspan")
    {
      return attr.value.toUInt();
    }
  }
  return 0;
}

References attribs().

Referenced by DocHtmlTable::computeTableGrid(), and LatexDocVisitor::operator()().

setColumnIndex()

void DocHtmlCell::setColumnIndex ( uint32_t idx )

inlineprivate

Definition at line 1222 of file docnode.h.

{ m_colIdx = idx; }

References m_colIdx.

Referenced by DocHtmlTable::computeTableGrid().

setRowIndex()

void DocHtmlCell::setRowIndex ( uint32_t idx )

inlineprivate

Definition at line 1221 of file docnode.h.

{ m_rowIdx = idx; }

References m_rowIdx.

Referenced by DocHtmlTable::computeTableGrid().

valignment()

DocHtmlCell::Valignment DocHtmlCell::valignment

(

)

const

Definition at line 1979 of file docnode.cpp.

{
  for (const auto &attr : attribs())
  {
    QCString attrName  = attr.name.lower();
    QCString attrValue = attr.value.lower();
    if (attrName=="valign")
    {
      if (attrValue=="top")
        return Top;
      else if (attrValue=="bottom")
        return Bottom;
      else if (attrValue=="middle")
        return Middle;
      else return Middle;
    }
  }
  return Middle;
}

References attribs(), Bottom, QCString::lower(), Middle, and Top.

Referenced by LatexDocVisitor::operator()().

Friends And Related Symbol Documentation

DocHtmlTable

friend class DocHtmlTable

friend

Definition at line 1199 of file docnode.h.

References DocHtmlTable.

Referenced by DocHtmlTable.

Member Data Documentation

m_attribs

HtmlAttribList DocHtmlCell::m_attribs

private

Definition at line 1226 of file docnode.h.

Referenced by attribs(), and DocHtmlCell().

m_colIdx

uint32_t DocHtmlCell::m_colIdx = static_cast<uint32_t>(-1)

private

Definition at line 1228 of file docnode.h.

Referenced by columnIndex(), and setColumnIndex().

m_isFirst

bool DocHtmlCell::m_isFirst = false

private

Definition at line 1224 of file docnode.h.

Referenced by isFirst(), and markFirst().

m_isHeading

bool DocHtmlCell::m_isHeading = false

private

Definition at line 1223 of file docnode.h.

Referenced by DocHtmlCell(), and isHeading().

m_isLast

bool DocHtmlCell::m_isLast = false

private

Definition at line 1225 of file docnode.h.

Referenced by isLast(), and markLast().

m_rowIdx

uint32_t DocHtmlCell::m_rowIdx = static_cast<uint32_t>(-1)

private

Definition at line 1227 of file docnode.h.

Referenced by rowIndex(), and setRowIndex().

---

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

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