DocAnchor Class Reference

Node representing an anchor. More...

#include <src/docnode.h>

Inheritance diagram for DocAnchor:

Collaboration diagram for DocAnchor:

Public Member Functions
	DocAnchor (DocParser *parser, DocNodeVariant *parent, const QCString &id, bool newAnchor)
QCString	anchor () const
QCString	file () const
const HtmlAttribList &	attribs () 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_anchor
QCString	m_file
HtmlAttribList	m_attribs

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 an anchor.

Definition at line 227 of file docnode.h.

Constructor & Destructor Documentation

DocAnchor()

DocAnchor::DocAnchor	(	DocParser *	parser,
		DocNodeVariant *	parent,
		const QCString &	id,
		bool	newAnchor )

Definition at line 208 of file docnode.cpp.

                                                                                               : DocNode(parser,parent)
{
  if (id.isEmpty())
  {
    warn_doc_error(parser->context.fileName,parser->tokenizer.getLineNr(),"Empty anchor label");
    return;
  }
 
  const CitationManager &ct = CitationManager::instance();
  QCString anchorPrefix = ct.anchorPrefix();
  if (id.left(anchorPrefix.length()) == anchorPrefix)
  {
    const CiteInfo *cite = ct.find(id.mid(anchorPrefix.length()));
    if (cite)
    {
      m_file = convertNameToFile(ct.fileName(),FALSE,TRUE);
      m_anchor = id;
    }
    else
    {
      warn_doc_error(parser->context.fileName,parser->tokenizer.getLineNr(),"Invalid cite anchor id '%s'",qPrint(id));
      m_anchor = "invalid";
      m_file = "invalid";
    }
  }
  else if (newAnchor) // found <a name="label">
  {
    m_anchor = id;
  }
  else // found \anchor label
  {
    const SectionInfo *sec = SectionManager::instance().find(id);
    if (sec)
    {
      //printf("Found anchor %s\n",qPrint(id));
      m_file   = sec->fileName();
      m_anchor = sec->label();
    }
    else
    {
      warn_doc_error(parser->context.fileName,parser->tokenizer.getLineNr(),"Invalid anchor id '%s'",qPrint(id));
      m_anchor = "invalid";
      m_file = "invalid";
    }
  }
}

References CitationManager::anchorPrefix(), convertNameToFile(), DocNode::DocNode(), FALSE, CitationManager::fileName(), SectionInfo::fileName(), CitationManager::find(), LinkedMap< T, Hash, KeyEqual, Map >::find(), CitationManager::instance(), SectionManager::instance(), SectionInfo::label(), QCString::length(), m_anchor, m_file, DocNode::parent(), DocNode::parser(), qPrint(), TRUE, and warn_doc_error.

Member Function Documentation

anchor()

QCString DocAnchor::anchor ( ) const

inline

Definition at line 231 of file docnode.h.

{ return m_anchor; }

References m_anchor.

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

attribs()

const HtmlAttribList & DocAnchor::attribs ( ) const

inline

Definition at line 234 of file docnode.h.

{ return m_attribs; }

References m_attribs.

Referenced by HtmlDocVisitor::operator()().

file()

QCString DocAnchor::file ( ) const

inline

Definition at line 232 of file docnode.h.

{ return m_file; }

References m_file.

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

Member Data Documentation

m_anchor

QCString DocAnchor::m_anchor

private

Definition at line 237 of file docnode.h.

Referenced by anchor(), and DocAnchor().

m_attribs

HtmlAttribList DocAnchor::m_attribs

private

Definition at line 239 of file docnode.h.

Referenced by attribs().

m_file

QCString DocAnchor::m_file

private

Definition at line 238 of file docnode.h.

Referenced by DocAnchor(), and file().

---

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

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