DocAnchor Class Reference

#include <docparser.h>

Inheritance diagram for DocAnchor:

Public Member Functions
	DocAnchor (DocNode *parent, const QCString &id, bool newAnchor)
Kind	kind () const
QCString	anchor () const
QCString	file () const
void	accept (DocVisitor *v)
Public Member Functions inherited from DocNode
	DocNode ()
virtual	~DocNode ()
DocNode *	parent () const
void	setParent (DocNode *parent)
bool	isPreformatted () const

Private Attributes
QCString	m_anchor
QCString	m_file

Additional Inherited Members
Public Types inherited from DocNode
enum	Kind {   Kind_Root = 0, Kind_Word = 1, Kind_WhiteSpace = 2, Kind_Para = 3,   Kind_AutoList = 4, Kind_AutoListItem = 5, Kind_Symbol = 6, Kind_URL = 7,   Kind_StyleChange = 8, Kind_SimpleSect = 9, Kind_Title = 10, Kind_SimpleList = 11,   Kind_SimpleListItem = 12, Kind_Section = 13, Kind_Verbatim = 14, Kind_XRefItem = 15,   Kind_HtmlList = 16, Kind_HtmlListItem = 17, Kind_HtmlDescList = 18, Kind_HtmlDescData = 19,   Kind_HtmlDescTitle = 20, Kind_HtmlTable = 21, Kind_HtmlRow = 22, Kind_HtmlCell = 23,   Kind_HtmlCaption = 24, Kind_LineBreak = 25, Kind_HorRuler = 26, Kind_Anchor = 27,   Kind_IndexEntry = 28, Kind_Internal = 29, Kind_HRef = 30, Kind_Include = 31,   Kind_IncOperator = 32, Kind_HtmlHeader = 33, Kind_Image = 34, Kind_DotFile = 35,   Kind_Link = 36, Kind_Ref = 37, Kind_Formula = 38, Kind_SecRefItem = 39,   Kind_SecRefList = 40, Kind_SimpleSectSep = 41, Kind_LinkedWord = 42, Kind_ParamSect = 43,   Kind_ParamList = 44, Kind_InternalRef = 45, Kind_Copy = 46, Kind_Text = 47,   Kind_MscFile = 48, Kind_HtmlBlockQuote = 49, Kind_VhdlFlow = 50, Kind_ParBlock = 51,   Kind_DiaFile = 52 }
Protected Member Functions inherited from DocNode
void	setInsidePreformatted (bool p)
Protected Attributes inherited from DocNode
DocNode *	m_parent

Detailed Description

Node representing an anchor

Definition at line 272 of file docparser.h.

Constructor & Destructor Documentation

DocAnchor::DocAnchor	(	DocNode *	parent,
		const QCString &	id,
		bool	newAnchor
	)

Definition at line 1845 of file docparser.cpp.

References CiteConsts::anchorPrefix, SDict< T >::append(), Doxygen::citeDict, convertNameToFile(), doctokenizerYYlineno, CiteConsts::fileName, SectionInfo::fileName, CiteDict::find(), SDict< T >::find(), g_fileName, SectionInfo::label, m_anchor, m_file, DocNode::m_parent, DocNode::parent(), Doxygen::sectionDict, and warn_doc_error().

{
  m_parent = parent; 
  if (id.isEmpty())
  {
    warn_doc_error(g_fileName,doctokenizerYYlineno,"Empty anchor label");
  }
  if (newAnchor) // found <a name="label">
  {
    m_anchor = id;
  }
  else if (id.left(CiteConsts::anchorPrefix.length()) == CiteConsts::anchorPrefix) 
  {
    CiteInfo *cite = Doxygen::citeDict->find(id.mid(CiteConsts::anchorPrefix.length()));
    if (cite) 
    {
      m_file = convertNameToFile(CiteConsts::fileName,FALSE,TRUE);
      m_anchor = id;
    }
    else 
    {
      warn_doc_error(g_fileName,doctokenizerYYlineno,"Invalid cite anchor id `%s'",qPrint(id));
      m_anchor = "invalid";
      m_file = "invalid";
    }
  }
  else // found \anchor label
  {
    SectionInfo *sec = Doxygen::sectionDict->find(id);
    if (sec)
    {
      //printf("Found anchor %s\n",id.data());
      m_file   = sec->fileName;
      m_anchor = sec->label;
      if (g_sectionDict && g_sectionDict->find(id)==0)
      {
        //printf("Inserting in dictionary!\n");
        g_sectionDict->append(id,sec);
      }
    }
    else
    {
      warn_doc_error(g_fileName,doctokenizerYYlineno,"Invalid anchor id `%s'",qPrint(id));
      m_anchor = "invalid";
      m_file = "invalid";
    }
  }
}

Member Function Documentation

void DocAnchor::accept ( DocVisitor *  v )

inlinevirtual

Acceptor function for node visitors. Part of the visitor pattern.

Parameters

v	Abstract visitor.

Implements DocNode.

Definition at line 279 of file docparser.h.

References DocVisitor::visit().

{ v->visit(this); }

QCString DocAnchor::anchor ( ) const

inline

Definition at line 277 of file docparser.h.

References m_anchor.

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

{ return m_anchor; }

QCString DocAnchor::file ( ) const

inline

Definition at line 278 of file docparser.h.

References m_file.

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

{ return m_file; }

Kind DocAnchor::kind ( ) const

inlinevirtual

Returns the kind of node. Provides runtime type information

Implements DocNode.

Definition at line 276 of file docparser.h.

References DocNode::Kind_Anchor.

{ return Kind_Anchor; }

Member Data Documentation

QCString DocAnchor::m_anchor

private

Definition at line 282 of file docparser.h.

Referenced by anchor(), and DocAnchor().

QCString DocAnchor::m_file

private

Definition at line 283 of file docparser.h.

Referenced by DocAnchor(), and file().

---

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

• docparser.h
• docparser.cpp