DocRef Class Reference

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

#include <src/docnode.h>

Inheritance diagram for DocRef:

Collaboration diagram for DocRef:

Public Member Functions
	DocRef (DocParser *parser, DocNodeVariant *parent, const DString &target, const DString &context)
void	parse (char cmdChar, const DString &cmdName)
DString	file () const
DString	relPath () const
DString	ref () const
DString	anchor () const
DString	targetTitle () const
SectionType	sectionType () const
bool	hasLinkText () const
bool	refToAnchor () const
bool	refToSection () const
bool	refToTable () const
bool	isSubPage () 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
RefType	m_refType = Unknown
SectionType	m_sectionType = SectionType::Anchor
bool	m_isSubPage = false
DString	m_file
DString	m_relPath
DString	m_ref
DString	m_anchor
DString	m_text

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

Definition at line 786 of file docnode.h.

Constructor & Destructor Documentation

DocRef()

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

Definition at line 714 of file docnode.cpp.

                                                                                                    :
   DocCompoundNode(parser,parent), m_refType(Unknown), m_isSubPage(false)
{
  const Definition  *compound = nullptr;
  DString anchor;
  AUTO_TRACE("target='{}',context='{}'",target,context);
  ASSERT(!target.empty());
  m_relPath = parser->context.relPath;
  auto lang = parser->context.lang;
  const SectionInfo *sec = SectionManager::instance().find(parser->context.prefix+target);
  if (sec==nullptr && !parser->context.prefix.empty())
  {
    sec = SectionManager::instance().find(target);
  }
 
  if (sec==nullptr && getLanguageFromFileName(target)==SrcLangExt::Markdown) // lookup as markdown file
  {
    sec = SectionManager::instance().find(markdownFileNameToId(target));
  }
  if (sec) // ref to section or anchor
  {
    PageDef *pd = nullptr;
    int secLevel = sec->type().level();
    if (secLevel==SectionType::Page)
    {
      pd = Doxygen::pageLinkedMap->find(target);
    }
    m_text         = sec->title();
    if (m_text.empty()) m_text = sec->label();
 
    m_ref          = sec->ref();
    m_file         = stripKnownExtensions(sec->fileName());
    if (secLevel==SectionType::Anchor)
    {
      m_refType = Anchor;
    }
    else if (secLevel==SectionType::Table)
    {
      m_refType = Table;
    }
    else if (secLevel==SectionType::Requirement)
    {
      m_refType = Requirement;
      if (!Config_getBool(GENERATE_REQUIREMENTS))
      {
        m_file.clear(); // prevent link when there is no requirements page
      }
    }
    else
    {
      m_refType = Section;
    }
    m_isSubPage    = pd && pd->hasParentPage();
    if (secLevel!=SectionType::Page || m_isSubPage)
    {
      m_anchor = pd ? pd->getOutputFileBase() : sec->label();
    }
    m_sectionType = sec->type();
    //printf("m_text=%s,m_ref=%s,m_file=%s,type=%d\n",
    //    qPrint(m_text),qPrint(m_ref),qPrint(m_file),m_refType);
    AUTO_TRACE_EXIT("section");
    return;
  }
  else if (Config_getBool(IMPLICIT_DIR_DOCS) && target.lower().endsWith("/readme.md"))
  {
    DString dirTarget = target.left(target.length() - 9); // strip readme.md part
    const auto &dd = Doxygen::dirLinkedMap->find(dirTarget);
    if (dd)
    {
      m_text = target;
      m_file = dd->getOutputFileBase();
      AUTO_TRACE_EXIT("directory");
      return;
    }
  }
  else if (resolveLink(context,target,true,&compound,anchor,lang,parser->context.prefix))
  {
    bool isFile = compound ?
                 (compound->definitionType()==Definition::TypeFile ||
                  compound->definitionType()==Definition::TypePage ? true : false) :
                 false;
    bool isDir = compound && compound->definitionType()==Definition::TypeDir;
    if (compound && lang==SrcLangExt::Markdown) lang = compound->getLanguage();
    m_text = linkToText(lang,target,isFile || isDir);
    m_anchor = anchor;
    if (compound && compound->isLinkable()) // ref to compound
    {
      if (anchor.empty() &&                                  /* compound link */
          compound->definitionType()==Definition::TypeGroup && /* is group */
          !toGroupDef(compound)->groupTitle().empty()        /* with title */
         )
      {
        m_text=(toGroupDef(compound))->groupTitle(); // use group's title as link
      }
      else if (compound->definitionType()==Definition::TypeMember &&
          toMemberDef(compound)->isObjCMethod())
      {
        // Objective C Method
        const MemberDef *member = toMemberDef(compound);
        bool localLink = parser->context.memberDef ? member->getClassDef()==parser->context.memberDef->getClassDef() : false;
        m_text = member->objCMethodName(localLink,parser->context.inSeeBlock);
      }
      else if (Config_getBool(HIDE_SCOPE_NAMES))
      {
        size_t funcPos = m_text.find('(');
        if (funcPos!=DString::npos) // see issue #11834
        {
          m_text=stripScope(m_text.left(funcPos))+m_text.mid(funcPos);
        }
        else
        {
          m_text=stripScope(m_text);
        }
      }
 
      m_file = compound->getOutputFileBase();
      m_ref  = compound->getReference();
      //printf("isFile=%d compound=%s (%d)\n",isFile,qPrint(compound->name()),
      //    compound->definitionType());
      AUTO_TRACE_EXIT("compound");
      return;
    }
    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();
      AUTO_TRACE_EXIT("source");
      return;
    }
    else
    {
      AUTO_TRACE_EXIT("compound '{}' not linkable",compound?compound->name():"none");
    }
  }
  m_text = target;
  warn_doc_error(parser->context.fileName,parser->tokenizer.getLineNr(),"unable to resolve reference to '{}' for \\ref command",
           target);
}

References DocNode::Anchor, SectionType::Anchor, anchor(), ASSERT, AUTO_TRACE, AUTO_TRACE_EXIT, DString::clear(), Config_getBool, DocParser::context, Definition::definitionType(), Doxygen::dirLinkedMap, DocCompoundNode::DocCompoundNode(), DString::empty(), DString::endsWith(), DocParserContext::fileName, SectionInfo::fileName(), DString::find(), LinkedMap< T, Hash, KeyEqual, Map >::find(), MemberDef::getClassDef(), Definition::getLanguage(), getLanguageFromFileName(), DocTokenizer::getLineNr(), Definition::getOutputFileBase(), Definition::getReference(), Definition::getSourceFileBase(), PageDef::hasParentPage(), DocParserContext::inSeeBlock, SectionManager::instance(), Definition::isLinkable(), SectionInfo::label(), DocParserContext::lang, DString::left(), DString::length(), SectionType::level(), linkToText(), DString::lower(), m_anchor, m_file, m_isSubPage, m_ref, m_refType, m_relPath, m_sectionType, m_text, markdownFileNameToId(), DocParserContext::memberDef, DString::mid(), Definition::name(), DString::npos, MemberDef::objCMethodName(), SectionType::Page, Doxygen::pageLinkedMap, DocNode::parent(), DocNode::parser(), DocParserContext::prefix, SectionInfo::ref(), DocParserContext::relPath, DocNode::Requirement, SectionType::Requirement, resolveLink(), DocNode::Section, stripKnownExtensions(), stripScope(), DocNode::Table, SectionType::Table, SectionInfo::title(), toFileDef(), toGroupDef(), DocParser::tokenizer, toMemberDef(), SectionInfo::type(), Definition::TypeDir, Definition::TypeFile, Definition::TypeGroup, Definition::TypeMember, Definition::TypePage, DocNode::Unknown, and warn_doc_error.

Member Function Documentation

anchor()

DString DocRef::anchor ( ) const

inline

Definition at line 794 of file docnode.h.

{ return m_anchor; }

References m_anchor.

Referenced by convertMapFile(), DocRef(), DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), PrintDocVisitor::operator()(), RTFDocVisitor::operator()(), XmlDocVisitor::operator()(), replaceRef(), and LayoutNavEntry::url().

file()

DString DocRef::file ( ) const

inline

Definition at line 791 of file docnode.h.

{ return m_file; }

References m_file.

Referenced by convertMapFile(), DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), PrintDocVisitor::operator()(), RTFDocVisitor::operator()(), XmlDocVisitor::operator()(), replaceRef(), and LayoutNavEntry::url().

hasLinkText()

bool DocRef::hasLinkText ( ) const

inline

Definition at line 797 of file docnode.h.

{ return !children().empty(); }

References DocCompoundNode::children(), and GrowVector< T >::empty().

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

isSubPage()

bool DocRef::isSubPage ( ) const

inline

Definition at line 801 of file docnode.h.

{ return m_isSubPage; }

References m_isSubPage.

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

parse()

void DocRef::parse	(	char	cmdChar,
		const DString &	cmdName )

Definition at line 896 of file docnode.cpp.

{
  AUTO_TRACE();
  auto ns = AutoNodeStack(parser(),thisVariant());
  char cmdCharStr[2] = { cmdChar, 0 };
 
  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:
          break;
        default:
          parser()->errorHandleDefaultToken(thisVariant(),tok,children(),cmdCharStr+cmdName);
          break;
      }
    }
    tok=parser()->tokenizer.lex();
  }
 
  if (children().empty() && !m_text.empty())
  {
    DString text = m_text;
    if (parser()->context.insideHtmlLink)
    {
      // we already in a link/title only output anchor
      text = m_anchor;
      warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),
          "Potential recursion while resolving {:c}{} command!",cmdChar,cmdName);
    }
    parser()->context.insideHtmlLink=true;
    { DocParser::AutoSaveContext saveContext(*parser());
      parser()->internalValidatingParseDoc(thisVariant(),children(),text);
    }
    parser()->context.insideHtmlLink=false;
    parser()->tokenizer.setStatePara();
    flattenParagraphs(thisVariant(),children());
  }
 
  parser()->handlePendingStyleCommands(thisVariant(),children());
}

References AUTO_TRACE, DocCompoundNode::children(), DocParser::context, DString::empty(), DocParser::errorHandleDefaultToken(), flattenParagraphs(), DocParser::handlePendingStyleCommands(), DocParserContext::insideHtmlLink, DocParser::internalValidatingParseDoc(), Token::is_any_of(), DocTokenizer::lex(), m_anchor, m_text, DocNode::parser(), DocTokenizer::setStatePara(), DocNode::thisVariant(), DocParser::tokenizer, Token::value(), and warn_doc_error.

ref()

DString DocRef::ref ( ) const

inline

Definition at line 793 of file docnode.h.

{ return m_ref; }

References m_ref.

Referenced by convertMapFile(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), PrintDocVisitor::operator()(), RTFDocVisitor::operator()(), XmlDocVisitor::operator()(), replaceRef(), and LayoutNavEntry::url().

refToAnchor()

bool DocRef::refToAnchor ( ) const

inline

Definition at line 798 of file docnode.h.

{ return m_refType==Anchor; }

References DocNode::Anchor, and m_refType.

Referenced by PrintDocVisitor::operator()().

refToSection()

bool DocRef::refToSection ( ) const

inline

Definition at line 799 of file docnode.h.

{ return m_refType==Section; }

References m_refType, and DocNode::Section.

Referenced by LatexDocVisitor::operator()(), and PrintDocVisitor::operator()().

refToTable()

bool DocRef::refToTable ( ) const

inline

Definition at line 800 of file docnode.h.

{ return m_refType==Table; }

References m_refType, and DocNode::Table.

Referenced by LatexDocVisitor::operator()(), and PrintDocVisitor::operator()().

relPath()

DString DocRef::relPath ( ) const

inline

Definition at line 792 of file docnode.h.

{ return m_relPath; }

References m_relPath.

Referenced by HtmlDocVisitor::operator()().

sectionType()

SectionType DocRef::sectionType ( ) const

inline

Definition at line 796 of file docnode.h.

{ return m_sectionType; }

References m_sectionType.

Referenced by LatexDocVisitor::operator()().

targetTitle()

DString DocRef::targetTitle ( ) const

inline

Definition at line 795 of file docnode.h.

{ return m_text; }

References m_text.

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

Member Data Documentation

m_anchor

DString DocRef::m_anchor

private

Definition at line 810 of file docnode.h.

Referenced by anchor(), DocRef(), and parse().

m_file

DString DocRef::m_file

private

Definition at line 807 of file docnode.h.

Referenced by DocRef(), and file().

m_isSubPage

bool DocRef::m_isSubPage = false

private

Definition at line 806 of file docnode.h.

Referenced by DocRef(), and isSubPage().

m_ref

DString DocRef::m_ref

private

Definition at line 809 of file docnode.h.

Referenced by DocRef(), and ref().

m_refType

RefType DocRef::m_refType = Unknown

private

Definition at line 804 of file docnode.h.

Referenced by DocRef(), refToAnchor(), refToSection(), and refToTable().

m_relPath

DString DocRef::m_relPath

private

Definition at line 808 of file docnode.h.

Referenced by DocRef(), and relPath().

m_sectionType

SectionType DocRef::m_sectionType = SectionType::Anchor

private

Definition at line 805 of file docnode.h.

Referenced by DocRef(), and sectionType().

m_text

DString DocRef::m_text

private

Definition at line 811 of file docnode.h.

Referenced by DocRef(), parse(), and targetTitle().

---

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

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