DocInternalRef Class Reference

#include <docparser.h>

Inheritance diagram for DocInternalRef:

Public Member Functions
	DocInternalRef (DocNode *parent, const QCString &target)
void	parse ()
Kind	kind () const
QCString	file () const
QCString	relPath () const
QCString	anchor () const
void	accept (DocVisitor *v)
Public Member Functions inherited from CompAccept< DocInternalRef >
	CompAccept ()
virtual	~CompAccept ()
void	accept (DocInternalRef *obj, DocVisitor *v)
const QList< DocNode > &	children () const
QList< DocNode > &	children ()
Public Member Functions inherited from DocNode
	DocNode ()
virtual	~DocNode ()
DocNode *	parent () const
void	setParent (DocNode *parent)
bool	isPreformatted () const

Private Attributes
QCString	m_file
QCString	m_relPath
QCString	m_anchor

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 CompAccept< DocInternalRef >
QList< DocNode >	m_children
Protected Attributes inherited from DocNode
DocNode *	m_parent

Detailed Description

Node representing an internal reference to some item

Definition at line 851 of file docparser.h.

Constructor & Destructor Documentation

DocInternalRef::DocInternalRef	(	DocNode *	parent,
		const QCString &	target
	)

Definition at line 2395 of file docparser.cpp.

References m_anchor, m_file, DocNode::m_parent, and DocNode::parent().

  : m_relPath(g_relPath)
{
  m_parent = parent; 
  int i=ref.find('#');
  if (i!=-1)
  {
    m_anchor = ref.right(ref.length()-i-1);
    m_file   = ref.left(i);
  }
  else
  {
    m_file = ref;
  }
}

Member Function Documentation

void DocInternalRef::accept ( DocVisitor *  v )

inlinevirtual

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

Parameters

v	Abstract visitor.

Implements DocNode.

Definition at line 860 of file docparser.h.

References CompAccept< T >::accept().

{ CompAccept<DocInternalRef>::accept(this,v); }

QCString DocInternalRef::anchor ( ) const

inline

Definition at line 859 of file docparser.h.

References m_anchor.

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

{ return m_anchor; }

QCString DocInternalRef::file ( ) const

inline

Definition at line 857 of file docparser.h.

References m_file.

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

{ return m_file; }

Kind DocInternalRef::kind ( ) const

inlinevirtual

Returns the kind of node. Provides runtime type information

Implements DocNode.

Definition at line 856 of file docparser.h.

References DocNode::Kind_Ref.

{ return Kind_Ref; }

void DocInternalRef::parse

(

)

Definition at line 2411 of file docparser.cpp.

References DBG, defaultHandleToken(), doctokenizerYYlex(), doctokenizerYYlineno, g_fileName, g_nodeStack, g_token, handlePendingStyleCommands(), CompAccept< DocInternalRef >::m_children, TokenInfo::name, TK_COMMAND, TK_SYMBOL, tokToString(), and warn_doc_error().

Referenced by defaultHandleToken(), and DocPara::handleCommand().

{
  g_nodeStack.push(this);
  DBG(("DocInternalRef::parse() start\n"));

  int tok;
  while ((tok=doctokenizerYYlex()))
  {
    if (!defaultHandleToken(this,tok,m_children))
    {
      switch (tok)
      {
        case TK_COMMAND: 
          warn_doc_error(g_fileName,doctokenizerYYlineno,"Illegal command %s as part of a \\ref",
           qPrint(g_token->name));
          break;
        case TK_SYMBOL: 
      warn_doc_error(g_fileName,doctokenizerYYlineno,"Unsupported symbol %s found",
               qPrint(g_token->name));
          break;
        default:
      warn_doc_error(g_fileName,doctokenizerYYlineno,"Unexpected token %s",
        tokToString(tok));
          break;
      }
    }
  }

  handlePendingStyleCommands(this,m_children);
  DBG(("DocInternalRef::parse() end\n"));
  DocNode *n=g_nodeStack.pop();
  ASSERT(n==this);
}

QCString DocInternalRef::relPath ( ) const

inline

Definition at line 858 of file docparser.h.

References m_relPath.

Referenced by HtmlDocVisitor::visitPre().

{ return m_relPath; }

Member Data Documentation

QCString DocInternalRef::m_anchor

private

Definition at line 865 of file docparser.h.

Referenced by anchor(), and DocInternalRef().

QCString DocInternalRef::m_file

private

Definition at line 863 of file docparser.h.

Referenced by DocInternalRef(), and file().

QCString DocInternalRef::m_relPath

private

Definition at line 864 of file docparser.h.

Referenced by relPath().

---

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

• docparser.h
• docparser.cpp