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)
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

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 975 of file docnode.cpp.

976{
977 const Definition *compound = nullptr;
978 QCString anchor;
979 m_refText = target;
980 m_relPath = parser->context.relPath;
981 if (!m_refText.isEmpty() && m_refText.at(0)=='#')
982 {
983 m_refText = m_refText.right(m_refText.length()-1);
984 }
985 if (resolveLink(parser->context.context,stripKnownExtensions(target),
986 parser->context.inSeeBlock,&compound,anchor,
987 parser->context.lang,parser->context.prefix))
988 {
990 if (compound && compound->isLinkable())
991 {
992 m_file = compound->getOutputFileBase();
993 m_ref = compound->getReference();
994 }
995 else if (compound && compound->definitionType()==Definition::TypeFile &&
996 (toFileDef(compound))->generateSourceFile()
997 ) // undocumented file that has source code we can link to
998 {
999 m_file = compound->getSourceFileBase();
1000 m_ref = compound->getReference();
1001 }
1002 return;
1003 }
1004
1005 // bogus link target
1006 warn_doc_error(parser->context.fileName,parser->tokenizer.getLineNr(),"unable to resolve link to '{}' for \\link command",
1007 target);
1008}
virtual bool isLinkable() const =0
virtual DefType definitionType() const =0
virtual QCString getReference() const =0
virtual QCString getSourceFileBase() const =0
virtual QCString getOutputFileBase() const =0
DocCompoundNode(DocParser *parser, DocNodeVariant *parent)
Definition docnode.h:141
DocParser * parser()
Definition docnode.h:98
DocNodeVariant * parent()
Definition docnode.h:90
static QCString stripKnownExtensions(const QCString &text)
Definition docnode.cpp:103
FileDef * toFileDef(Definition *d)
Definition filedef.cpp:1932
#define warn_doc_error(file, line, fmt,...)
Definition message.h:112
bool resolveLink(const QCString &scName, const QCString &lr, bool, const Definition **resContext, QCString &resAnchor, SrcLangExt lang, const QCString &prefix)
Definition util.cpp:3247

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

Member Function Documentation

◆ anchor()

◆ file()

◆ parse()

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

Definition at line 1011 of file docnode.cpp.

1012{
1013 AUTO_TRACE();
1014 QCString result;
1015 auto ns = AutoNodeStack(parser(),thisVariant());
1016
1017 Token tok = parser()->tokenizer.lex();
1018 while (!tok.is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF))
1019 {
1020 if (!parser()->defaultHandleToken(thisVariant(),tok,children(),FALSE))
1021 {
1022 switch (tok.value())
1023 {
1024 case TokenRetval::TK_COMMAND_AT:
1025 // fall through
1026 case TokenRetval::TK_COMMAND_BS:
1027 switch (Mappers::cmdMapper->map(parser()->context.token->name))
1028 {
1030 if (isJavaLink)
1031 {
1032 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"'{{@link...' ended with '{:c}{}' command",
1033 tok.command_to_char(),parser()->context.token->name);
1034 }
1035 goto endlink;
1036 default:
1037 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Illegal command '{:c}{}' as part of a \\link",
1038 tok.command_to_char(),parser()->context.token->name);
1039 break;
1040 }
1041 break;
1042 case TokenRetval::TK_SYMBOL:
1043 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unsupported symbol '{}' found as part of a \\link",
1044 parser()->context.token->name);
1045 break;
1046 case TokenRetval::TK_HTMLTAG:
1047 if (parser()->context.token->name!="see" || !isXmlLink)
1048 {
1049 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unexpected xml/html command {} found as part of a \\link",
1050 parser()->context.token->name);
1051 }
1052 goto endlink;
1053 case TokenRetval::TK_LNKWORD:
1054 case TokenRetval::TK_WORD:
1055 if (isJavaLink) // special case to detect closing }
1056 {
1057 QCString w = parser()->context.token->name;
1058 int p = 0;
1059 if (w=="}")
1060 {
1061 goto endlink;
1062 }
1063 else if ((p=w.find('}'))!=-1)
1064 {
1065 int l = static_cast<int>(w.length());
1066 children().append<DocWord>(parser(),thisVariant(),w.left(p));
1067 if (p<l-1) // something left after the } (for instance a .)
1068 {
1069 result=w.right(l-p-1);
1070 }
1071 goto endlink;
1072 }
1073 }
1075 break;
1076 default:
1077 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unexpected token {}",tok.to_string());
1078 break;
1079 }
1080 }
1081 tok = parser()->tokenizer.lex();
1082 }
1083 if (tok.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
1084 {
1085 warn_doc_error(parser()->context.fileName,
1086 parser()->tokenizer.getLineNr(),
1087 "Unexpected end of comment while inside link command");
1088 }
1089endlink:
1090
1091 if (children().empty()) // no link text
1092 {
1093 children().append<DocWord>(parser(),thisVariant(),m_refText);
1094 }
1095
1097 return result;
1098}
DocNodeList & children()
Definition docnode.h:143
DocNodeVariant * thisVariant()
Definition docnode.h:93
DocTokenizer tokenizer
void handlePendingStyleCommands(DocNodeVariant *parent, DocNodeList &children)
DocParserContext context
int find(char c, int index=0, bool cs=TRUE) const
Definition qcstring.cpp:43
size_t length() const
Returns the length of the string, not counting the 0-terminator.
Definition qcstring.h:153
QCString right(size_t len) const
Definition qcstring.h:219
QCString left(size_t len) const
Definition qcstring.h:214
TOKEN_SPECIFICATIONS RETVAL_SPECIFICATIONS const char * to_string() const
TokenRetval value() const
bool is_any_of(ARGS... args) const
char command_to_char() const
#define AUTO_TRACE(...)
Definition docnode.cpp:46
const Mapper< CommandType > * cmdMapper
#define FALSE
Definition qcstring.h:34
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
QCString name

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()

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