Doxygen
Loading...
Searching...
No Matches
DocHRef Class Reference

Node representing a Hypertext reference. More...

#include <src/docnode.h>

Inheritance diagram for DocHRef:
Collaboration diagram for DocHRef:

Public Member Functions

 DocHRef (DocParser *parser, DocNodeVariant *parent, const HtmlAttribList &attribs, const QCString &url, const QCString &relPath, const QCString &file)
Token parse ()
QCString url () const
QCString file () const
QCString relPath () const
const HtmlAttribListattribs () const
Public Member Functions inherited from DocCompoundNode
 DocCompoundNode (DocParser *parser, DocNodeVariant *parent)
DocNodeListchildren ()
const DocNodeListchildren () const
Public Member Functions inherited from DocNode
 DocNode (DocParser *parser, DocNodeVariant *parent)
 ~DocNode ()=default
DocNodeVariantparent ()
const DocNodeVariantparent () const
DocNodeVariantthisVariant ()
const DocNodeVariantthisVariant () const
void setThisVariant (DocNodeVariant *thisVariant)
DocParserparser ()
const DocParserparser () const
void setParent (DocNodeVariant *parent)
bool isPreformatted () const

Private Attributes

HtmlAttribList m_attribs
QCString m_url
QCString m_relPath
QCString m_file

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 Hypertext reference.

Definition at line 822 of file docnode.h.

Constructor & Destructor Documentation

◆ DocHRef()

DocHRef::DocHRef ( DocParser * parser,
DocNodeVariant * parent,
const HtmlAttribList & attribs,
const QCString & url,
const QCString & relPath,
const QCString & file )
inline

Definition at line 825 of file docnode.h.

DocCompoundNode(DocParser *parser, DocNodeVariant *parent)
Definition docnode.h:141
HtmlAttribList m_attribs
Definition docnode.h:836
QCString url() const
Definition docnode.h:830
QCString m_file
Definition docnode.h:839
QCString relPath() const
Definition docnode.h:832
QCString file() const
Definition docnode.h:831
const HtmlAttribList & attribs() const
Definition docnode.h:833
QCString m_url
Definition docnode.h:837
QCString m_relPath
Definition docnode.h:838
DocParser * parser()
Definition docnode.h:98
DocNodeVariant * parent()
Definition docnode.h:90

References attribs(), DocCompoundNode::DocCompoundNode(), file(), m_attribs, m_file, m_relPath, m_url, DocNode::parent(), DocNode::parser(), relPath(), and url().

Member Function Documentation

◆ attribs()

const HtmlAttribList & DocHRef::attribs ( ) const
inline

Definition at line 833 of file docnode.h.

833{ return m_attribs; }

References m_attribs.

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

◆ file()

QCString DocHRef::file ( ) const
inline

Definition at line 831 of file docnode.h.

831{ return m_file; }

References m_file.

Referenced by DocHRef(), DocbookDocVisitor::operator()(), and RTFDocVisitor::operator()().

◆ parse()

Token DocHRef::parse ( )

Definition at line 1489 of file docnode.cpp.

1490{
1491 AUTO_TRACE();
1492 Token retval(TokenRetval::RetVal_OK);
1493 auto ns = AutoNodeStack(parser(),thisVariant());
1494
1495 Token tok = parser()->tokenizer.lex();
1496 while (!tok.is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF))
1497 {
1498 if (!parser()->defaultHandleToken(thisVariant(),tok,children()))
1499 {
1500 switch (tok.value())
1501 {
1502 case TokenRetval::TK_HTMLTAG:
1503 {
1504 HtmlTagType tagId=Mappers::htmlTagMapper->map(parser()->context.token->name);
1505 if (tagId==HtmlTagType::HTML_A && parser()->context.token->endTag) // found </a> tag
1506 {
1507 goto endhref;
1508 }
1509 else if (tagId==HtmlTagType::HTML_BR)
1510 {
1511 children().append<DocLineBreak>(parser(),thisVariant(),parser()->context.token->attribs);
1512 }
1513 else
1514 {
1515 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unexpected html tag <{}{}> found within <a href=...> context",
1516 parser()->context.token->endTag?"/":"",parser()->context.token->name);
1517 }
1518 }
1519 break;
1520 default:
1521 parser()->errorHandleDefaultToken(thisVariant(),tok,children(),"<a>..</a> block");
1522 break;
1523 }
1524 }
1525 tok = parser()->tokenizer.lex();
1526 }
1527 if (tok.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
1528 {
1529 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unexpected end of comment while inside"
1530 " <a href=...> tag");
1531 }
1532endhref:
1534 return retval;
1535}
DocNodeList & children()
Definition docnode.h:143
DocNodeVariant * thisVariant()
Definition docnode.h:93
DocTokenizer tokenizer
void handlePendingStyleCommands(DocNodeVariant *parent, DocNodeList &children)
DocParserContext context
void errorHandleDefaultToken(DocNodeVariant *parent, Token tok, DocNodeList &children, const QCString &txt)
TokenRetval value() const
bool is_any_of(ARGS... args) const
HtmlTagType
Definition cmdmapper.h:169
#define AUTO_TRACE(...)
Definition docnode.cpp:46
#define warn_doc_error(file, line, fmt,...)
Definition message.h:112
const Mapper< HtmlTagType > * htmlTagMapper
void append(Args &&... args)
Append a new DocNodeVariant to the list by constructing it with type T and parameters Args.
Definition docnode.h:1399
TokenInfo * token
Definition docparser_p.h:92
HtmlAttribList attribs

References DocNodeList::append(), TokenInfo::attribs, AUTO_TRACE, DocCompoundNode::children(), DocParser::context, DocParser::errorHandleDefaultToken(), DocParser::handlePendingStyleCommands(), HTML_A, HTML_BR, Mappers::htmlTagMapper, Token::is_any_of(), DocTokenizer::lex(), DocNode::parser(), DocNode::thisVariant(), DocParserContext::token, DocParser::tokenizer, Token::value(), and warn_doc_error.

◆ relPath()

QCString DocHRef::relPath ( ) const
inline

Definition at line 832 of file docnode.h.

832{ return m_relPath; }

References m_relPath.

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

◆ url()

Member Data Documentation

◆ m_attribs

HtmlAttribList DocHRef::m_attribs
private

Definition at line 836 of file docnode.h.

Referenced by attribs(), and DocHRef().

◆ m_file

QCString DocHRef::m_file
private

Definition at line 839 of file docnode.h.

Referenced by DocHRef(), and file().

◆ m_relPath

QCString DocHRef::m_relPath
private

Definition at line 838 of file docnode.h.

Referenced by DocHRef(), and relPath().

◆ m_url

QCString DocHRef::m_url
private

Definition at line 837 of file docnode.h.

Referenced by DocHRef(), and url().


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