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

Node representing a link to some item. More...

#include <src/docnode.h>

Inheritance diagram for DocLink:
Collaboration diagram for DocLink:

Public Member Functions

 DocLink (DocParser *parser, DocNodeVariant *parent, const QCString &target)
QCString parse (bool, bool isXmlLink=FALSE)
QCString file () const
QCString relPath () const
QCString ref () 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

QCString m_file
QCString m_relPath
QCString m_ref
QCString m_anchor
QCString m_refText

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 link to some item.

Definition at line 758 of file docnode.h.

Constructor & Destructor Documentation

◆ DocLink()

DocLink::DocLink ( DocParser * parser,
DocNodeVariant * parent,
const QCString & target )

Definition at line 962 of file docnode.cpp.

962 : DocCompoundNode(parser,parent)
963{
964 const Definition *compound = nullptr;
965 QCString anchor;
966 m_refText = target;
967 m_relPath = parser->context.relPath;
968 if (!m_refText.isEmpty() && m_refText.at(0)=='#')
969 {
970 m_refText = m_refText.right(m_refText.length()-1);
971 }
972 if (resolveLink(parser->context.context,stripKnownExtensions(target),
973 parser->context.inSeeBlock,&compound,anchor,
974 parser->context.lang,parser->context.prefix))
975 {
976 m_anchor = anchor;
977 if (compound && compound->isLinkable())
978 {
979 m_file = compound->getOutputFileBase();
980 m_ref = compound->getReference();
981 }
982 else if (compound && compound->definitionType()==Definition::TypeFile &&
983 (toFileDef(compound))->generateSourceFile()
984 ) // undocumented file that has source code we can link to
985 {
986 m_file = compound->getSourceFileBase();
987 m_ref = compound->getReference();
988 }
989 return;
990 }
991
992 // bogus link target
993 warn_doc_error(parser->context.fileName,parser->tokenizer.getLineNr(),"unable to resolve link to '{}' for \\link command",
994 target);
995}
Definition::isLinkable
virtual bool isLinkable() const =0
Definition::definitionType
virtual DefType definitionType() const =0
Definition::getReference
virtual QCString getReference() const =0
Definition::getSourceFileBase
virtual QCString getSourceFileBase() const =0
Definition::getOutputFileBase
virtual QCString getOutputFileBase() const =0
DocCompoundNode::DocCompoundNode
DocCompoundNode(DocParser *parser, DocNodeVariant *parent)
Definition docnode.h:141
DocNode::parser
DocParser * parser()
Definition docnode.h:98
DocNode::parent
DocNodeVariant * parent()
Definition docnode.h:90
stripKnownExtensions
static QCString stripKnownExtensions(const QCString &text)
Definition docnode.cpp:103
toFileDef
FileDef * toFileDef(Definition *d)
Definition filedef.cpp:1932
warn_doc_error
#define warn_doc_error(file, line, fmt,...)
Definition message.h:112
resolveLink
bool resolveLink(const QCString &scName, const QCString &lr, bool, const Definition **resContext, QCString &resAnchor, SrcLangExt lang, const QCString &prefix)
Definition util.cpp:3246

References anchor(), Definition::definitionType(), DocCompoundNode::DocCompoundNode(), Definition::getReference(), Definition::getSourceFileBase(), m_file, m_ref, m_refText, m_relPath, DocNode::parent(), DocNode::parser(), resolveLink(), stripKnownExtensions(), toFileDef(), and Definition::TypeFile.

Member Function Documentation

◆ anchor()

QCString DocLink::anchor ( ) const
inline

Definition at line 766 of file docnode.h.

766{ return m_anchor; }

References m_anchor.

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

◆ file()

QCString DocLink::file ( ) const
inline

Definition at line 763 of file docnode.h.

763{ return m_file; }

References m_file.

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

◆ parse()

QCString DocLink::parse ( bool isJavaLink,
bool isXmlLink = FALSE )

Definition at line 998 of file docnode.cpp.

999{
1000 AUTO_TRACE();
1001 QCString result;
1002 auto ns = AutoNodeStack(parser(),thisVariant());
1003
1004 Token tok = parser()->tokenizer.lex();
1005 while (!tok.is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF))
1006 {
1007 if (!parser()->defaultHandleToken(thisVariant(),tok,children(),FALSE))
1008 {
1009 switch (tok.value())
1010 {
1011 case TokenRetval::TK_COMMAND_AT:
1012 // fall through
1013 case TokenRetval::TK_COMMAND_BS:
1014 switch (Mappers::cmdMapper->map(parser()->context.token->name))
1015 {
1016 case CommandType::CMD_ENDLINK:
1017 if (isJavaLink)
1018 {
1019 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"'{{@link...' ended with '{:c}{}' command",
1020 tok.command_to_char(),parser()->context.token->name);
1021 }
1022 goto endlink;
1023 default:
1024 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Illegal command '{:c}{}' as part of a \\link",
1025 tok.command_to_char(),parser()->context.token->name);
1026 break;
1027 }
1028 break;
1029 case TokenRetval::TK_SYMBOL:
1030 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unsupported symbol '{}' found as part of a \\link",
1031 parser()->context.token->name);
1032 break;
1033 case TokenRetval::TK_HTMLTAG:
1034 if (parser()->context.token->name!="see" || !isXmlLink)
1035 {
1036 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unexpected xml/html command {} found as part of a \\link",
1037 parser()->context.token->name);
1038 }
1039 goto endlink;
1040 case TokenRetval::TK_LNKWORD:
1041 case TokenRetval::TK_WORD:
1042 if (isJavaLink) // special case to detect closing }
1043 {
1044 QCString w = parser()->context.token->name;
1045 int p = 0;
1046 if (w=="}")
1047 {
1048 goto endlink;
1049 }
1050 else if ((p=w.find('}'))!=-1)
1051 {
1052 int l = static_cast<int>(w.length());
1053 children().append<DocWord>(parser(),thisVariant(),w.left(p));
1054 if (p<l-1) // something left after the } (for instance a .)
1055 {
1056 result=w.right(l-p-1);
1057 }
1058 goto endlink;
1059 }
1060 }
1061 children().append<DocWord>(parser(),thisVariant(),parser()->context.token->name);
1062 break;
1063 default:
1064 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unexpected token {}",tok.to_string());
1065 break;
1066 }
1067 }
1068 tok = parser()->tokenizer.lex();
1069 }
1070 if (tok.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
1071 {
1072 warn_doc_error(parser()->context.fileName,
1073 parser()->tokenizer.getLineNr(),
1074 "Unexpected end of comment while inside link command");
1075 }
1076endlink:
1077
1078 if (children().empty()) // no link text
1079 {
1080 children().append<DocWord>(parser(),thisVariant(),m_refText);
1081 }
1082
1083 parser()->handlePendingStyleCommands(thisVariant(),children());
1084 return result;
1085}
DocCompoundNode::children
DocNodeList & children()
Definition docnode.h:143
DocNode::thisVariant
DocNodeVariant * thisVariant()
Definition docnode.h:93
DocParser::tokenizer
DocTokenizer tokenizer
Definition docparser_p.h:142
DocParser::handlePendingStyleCommands
void handlePendingStyleCommands(DocNodeVariant *parent, DocNodeList &children)
Definition docparser.cpp:680
DocParser::context
DocParserContext context
Definition docparser_p.h:141
QCString::find
int find(char c, int index=0, bool cs=TRUE) const
Definition qcstring.cpp:43
QCString::length
size_t length() const
Returns the length of the string, not counting the 0-terminator.
Definition qcstring.h:153
QCString::right
QCString right(size_t len) const
Definition qcstring.h:219
QCString::left
QCString left(size_t len) const
Definition qcstring.h:214
Token::to_string
TOKEN_SPECIFICATIONS RETVAL_SPECIFICATIONS const char * to_string() const
Definition doctokenizer.h:93
Token::value
TokenRetval value() const
Definition doctokenizer.h:87
Token::is_any_of
bool is_any_of(ARGS... args) const
Definition doctokenizer.h:117
Token::command_to_char
char command_to_char() const
Definition doctokenizer.h:106
AUTO_TRACE
#define AUTO_TRACE(...)
Definition docnode.cpp:46
Mappers::cmdMapper
const Mapper< CommandType > * cmdMapper
Definition cmdmapper.cpp:250
FALSE
#define FALSE
Definition qcstring.h:34
DocNodeList::append
void append(Args &&... args)
Append a new DocNodeVariant to the list by constructing it with type T and parameters Args.
Definition docnode.h:1399
DocParserContext::token
TokenInfo * token
Definition docparser_p.h:92
TokenInfo::name
QCString name
Definition doctokenizer.h:138

References DocNodeList::append(), AUTO_TRACE, DocCompoundNode::children(), CMD_ENDLINK, Mappers::cmdMapper, Token::command_to_char(), DocParser::context, FALSE, QCString::find(), DocParser::handlePendingStyleCommands(), Token::is_any_of(), QCString::left(), QCString::length(), DocTokenizer::lex(), m_refText, TokenInfo::name, DocNode::parser(), QCString::right(), DocNode::thisVariant(), Token::to_string(), DocParserContext::token, DocParser::tokenizer, Token::value(), and warn_doc_error.

◆ ref()

QCString DocLink::ref ( ) const
inline

Definition at line 765 of file docnode.h.

765{ return m_ref; }

References m_ref.

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

◆ relPath()

QCString DocLink::relPath ( ) const
inline

Definition at line 764 of file docnode.h.

764{ return m_relPath; }

References m_relPath.

Referenced by HtmlDocVisitor::operator()().

Member Data Documentation

◆ m_anchor

QCString DocLink::m_anchor
private

Definition at line 772 of file docnode.h.

Referenced by anchor().

◆ m_file

QCString DocLink::m_file
private

Definition at line 769 of file docnode.h.

Referenced by DocLink(), and file().

◆ m_ref

QCString DocLink::m_ref
private

Definition at line 771 of file docnode.h.

Referenced by DocLink(), and ref().

◆ m_refText

QCString DocLink::m_refText
private

Definition at line 773 of file docnode.h.

Referenced by DocLink(), and parse().

◆ m_relPath

QCString DocLink::m_relPath
private

Definition at line 770 of file docnode.h.

Referenced by DocLink(), and relPath().

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