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 DString &target)
DString	parse (bool, bool isXmlLink=false)
DString	file () const
DString	relPath () const
DString	ref () const
DString	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
DString	m_file
DString	m_relPath
DString	m_ref
DString	m_anchor
DString	m_refText

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

Definition at line 767 of file docnode.h.

Constructor & Destructor Documentation

DocLink()

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

Definition at line 997 of file docnode.cpp.

                                                                               : DocCompoundNode(parser,parent)
{
  const Definition *compound = nullptr;
  DString anchor;
  m_refText = target;
  m_relPath = parser->context.relPath;
  if (!m_refText.empty() && m_refText.at(0)=='#')
  {
    m_refText = m_refText.mid(1);
  }
  if (resolveLink(parser->context.context,stripKnownExtensions(target),
                  parser->context.inSeeBlock,&compound,anchor,
                  parser->context.lang,parser->context.prefix))
  {
    m_anchor = anchor;
    if (compound && compound->isLinkable())
    {
      m_file = compound->getOutputFileBase();
      m_ref  = compound->getReference();
    }
    else if (compound && compound->definitionType()==Definition::TypeFile &&
             (toFileDef(compound))->generateSourceFile()
            ) // undocumented file that has source code we can link to
    {
      m_file = compound->getSourceFileBase();
      m_ref  = compound->getReference();
    }
    return;
  }
 
  // bogus link target
  warn_doc_error(parser->context.fileName,parser->tokenizer.getLineNr(),"unable to resolve link to '{}' for \\link command",
         target);
}

References anchor(), DString::at(), DocParser::context, DocParserContext::context, Definition::definitionType(), DocCompoundNode::DocCompoundNode(), DString::empty(), Definition::getReference(), Definition::getSourceFileBase(), DocParserContext::inSeeBlock, DocParserContext::lang, m_file, m_ref, m_refText, m_relPath, DocNode::parent(), DocNode::parser(), DocParserContext::prefix, DocParserContext::relPath, resolveLink(), stripKnownExtensions(), toFileDef(), and Definition::TypeFile.

Member Function Documentation

anchor()

DString DocLink::anchor ( ) const

inline

Definition at line 775 of file docnode.h.

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

DString DocLink::file ( ) const

inline

Definition at line 772 of file docnode.h.

{ return m_file; }

References m_file.

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

parse()

DString DocLink::parse	(	bool	isJavaLink,
		bool	isXmlLink = false )

Definition at line 1033 of file docnode.cpp.

{
  AUTO_TRACE();
  DString result;
  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(),false))
    {
      switch (tok.value())
      {
        case TokenRetval::TK_COMMAND_AT:
        // fall through
        case TokenRetval::TK_COMMAND_BS:
          switch (Mappers::cmdMapper->map(parser()->context.token->name))
          {
            case CommandType::CMD_ENDLINK:
              if (isJavaLink)
              {
                warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"'{{@link...' ended with '{:c}{}' command",
                  tok.command_to_char(),parser()->context.token->name);
              }
              goto endlink;
            default:
              warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Illegal command '{:c}{}' as part of a \\link",
                  tok.command_to_char(),parser()->context.token->name);
              break;
          }
          break;
        case TokenRetval::TK_SYMBOL:
          warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unsupported symbol '{}' found as part of a \\link",
              parser()->context.token->name);
          break;
        case TokenRetval::TK_HTMLTAG:
          if (parser()->context.token->name!="see" || !isXmlLink)
          {
            warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unexpected xml/html command {} found as part of a \\link",
                parser()->context.token->name);
          }
          goto endlink;
        case TokenRetval::TK_LNKWORD:
        case TokenRetval::TK_WORD:
          if (isJavaLink) // special case to detect closing }
          {
            DString w = parser()->context.token->name;
            size_t p = 0;
            if (w=="}")
            {
              goto endlink;
            }
            else if ((p=w.find('}'))!=DString::npos)
            {
              size_t l = w.length();
              children().append<DocWord>(parser(),thisVariant(),w.left(p));
              if (l>1 && p<l-1) // something left after the } (for instance a .)
              {
                result=w.right(l-p-1);
              }
              goto endlink;
            }
          }
          children().append<DocWord>(parser(),thisVariant(),parser()->context.token->name);
          break;
        default:
          warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unexpected token {}",tok.to_string());
        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 link command");
  }
endlink:
 
  if (children().empty()) // no link text
  {
    children().append<DocWord>(parser(),thisVariant(),m_refText);
  }
 
  parser()->handlePendingStyleCommands(thisVariant(),children());
  return result;
}

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

ref()

DString DocLink::ref ( ) const

inline

Definition at line 774 of file docnode.h.

{ return m_ref; }

References m_ref.

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

relPath()

DString DocLink::relPath ( ) const

inline

Definition at line 773 of file docnode.h.

{ return m_relPath; }

References m_relPath.

Referenced by HtmlDocVisitor::operator()().

Member Data Documentation

m_anchor

DString DocLink::m_anchor

private

Definition at line 781 of file docnode.h.

Referenced by anchor().

m_file

DString DocLink::m_file

private

Definition at line 778 of file docnode.h.

Referenced by DocLink(), and file().

m_ref

DString DocLink::m_ref

private

Definition at line 780 of file docnode.h.

Referenced by DocLink(), and ref().

m_refText

DString DocLink::m_refText

private

Definition at line 782 of file docnode.h.

Referenced by DocLink(), and parse().

m_relPath

DString DocLink::m_relPath

private

Definition at line 779 of file docnode.h.

Referenced by DocLink(), and relPath().

---

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

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