DocHtmlCaption Class Reference

Node representing a HTML table caption. More...

#include <src/docnode.h>

Inheritance diagram for DocHtmlCaption:

Collaboration diagram for DocHtmlCaption:

Public Member Functions
	DocHtmlCaption (DocParser *parser, DocNodeVariant *parent, const HtmlAttribList &attribs)
const HtmlAttribList &	attribs () const
Token	parse ()
bool	hasCaptionId () const
QCString	file () const
QCString	anchor () 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 Attributes
HtmlAttribList	m_attribs
bool	m_hasCaptionId = false
QCString	m_file
QCString	m_anchor

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

Definition at line 1221 of file docnode.h.

Constructor & Destructor Documentation

DocHtmlCaption()

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

Definition at line 1666 of file docnode.cpp.

  : DocCompoundNode(parser,parent)
{
  m_hasCaptionId = FALSE;
  for (const auto &opt : attribs)
  {
    if (opt.name=="id" && !opt.value.isEmpty()) // interpret id attribute as an anchor
    {
      const SectionInfo *sec = SectionManager::instance().find(opt.value);
      if (sec)
      {
        //printf("Found anchor %s\n",qPrint(id));
        m_file   = sec->fileName();
        m_anchor = sec->label();
        m_hasCaptionId = TRUE;
      }
      else
      {
        warn_doc_error(parser->context.fileName,parser->tokenizer.getLineNr(),"Invalid caption id '{}'",opt.value);
      }
    }
    else // copy attribute
    {
      m_attribs.push_back(opt);
    }
  }
}

References attribs(), DocCompoundNode::DocCompoundNode(), FALSE, SectionInfo::fileName(), LinkedMap< T, Hash, KeyEqual, Map >::find(), SectionManager::instance(), SectionInfo::label(), m_anchor, m_attribs, m_file, m_hasCaptionId, DocNode::parent(), DocNode::parser(), TRUE, and warn_doc_error.

Member Function Documentation

anchor()

QCString DocHtmlCaption::anchor ( ) const

inline

Definition at line 1229 of file docnode.h.

{ return m_anchor;       }

References m_anchor.

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

attribs()

const HtmlAttribList & DocHtmlCaption::attribs ( ) const

inline

Definition at line 1225 of file docnode.h.

{ return m_attribs; }

References m_attribs.

Referenced by DocHtmlCaption(), and HtmlDocVisitor::operator()().

file()

QCString DocHtmlCaption::file ( ) const

inline

Definition at line 1228 of file docnode.h.

{ return m_file;         }

References m_file.

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

hasCaptionId()

bool DocHtmlCaption::hasCaptionId ( ) const

inline

Definition at line 1227 of file docnode.h.

{ return m_hasCaptionId; }

References m_hasCaptionId.

parse()

Token DocHtmlCaption::parse

(

)

Definition at line 1694 of file docnode.cpp.

{
  AUTO_TRACE();
  Token retval = Token::make_TK_NONE();
  auto ns = AutoNodeStack(parser(),thisVariant());
  Token tok = parser()->tokenizer.lex();
  while (!tok.is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF))
  {
    if (!parser()->defaultHandleToken(thisVariant(),tok,children()))
    {
      switch (tok.value())
      {
        case TokenRetval::TK_HTMLTAG:
          {
            HtmlTagType tagId=Mappers::htmlTagMapper->map(parser()->context.token->name);
            if (tagId==HtmlTagType::HTML_CAPTION && parser()->context.token->endTag) // found </caption> tag
            {
              retval = Token::make_RetVal_OK();
              goto endcaption;
            }
            else
            {
              warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unexpected html tag <{}{}> found within <caption> context",
                  parser()->context.token->endTag?"/":"",parser()->context.token->name);
            }
          }
          break;
        default:
          parser()->errorHandleDefaultToken(thisVariant(),tok,children(),"<caption> tag");
          break;
      }
    }
    tok = parser()->tokenizer.lex();
  }
  if (tok.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
  {
    warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unexpected end of comment while inside"
           " <caption> tag");
  }
endcaption:
  parser()->handlePendingStyleCommands(thisVariant(),children());
  return retval;
}

References AUTO_TRACE, DocCompoundNode::children(), DocParser::errorHandleDefaultToken(), DocParser::handlePendingStyleCommands(), HTML_CAPTION, Mappers::htmlTagMapper, Token::is_any_of(), DocTokenizer::lex(), DocNode::parser(), DocNode::thisVariant(), DocParser::tokenizer, Token::value(), and warn_doc_error.

Member Data Documentation

m_anchor

QCString DocHtmlCaption::m_anchor

private

Definition at line 1235 of file docnode.h.

Referenced by anchor(), and DocHtmlCaption().

m_attribs

HtmlAttribList DocHtmlCaption::m_attribs

private

Definition at line 1232 of file docnode.h.

Referenced by attribs(), and DocHtmlCaption().

m_file

QCString DocHtmlCaption::m_file

private

Definition at line 1234 of file docnode.h.

Referenced by DocHtmlCaption(), and file().

m_hasCaptionId

bool DocHtmlCaption::m_hasCaptionId = false

private

Definition at line 1233 of file docnode.h.

Referenced by DocHtmlCaption(), and hasCaptionId().

---

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

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