DocSecRefItem Class Reference

#include <docparser.h>

Inheritance diagram for DocSecRefItem:

Public Member Functions
	DocSecRefItem (DocNode *parent, const QCString &target)
Kind	kind () const
QCString	target () const
QCString	file () const
QCString	anchor () const
void	accept (DocVisitor *v)
void	parse ()
Public Member Functions inherited from CompAccept< DocSecRefItem >
	CompAccept ()
virtual	~CompAccept ()
void	accept (DocSecRefItem *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_target
QCString	m_file
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< DocSecRefItem >
QList< DocNode >	m_children
Protected Attributes inherited from DocNode
DocNode *	m_parent

Detailed Description

Node representing a reference to a section

Definition at line 959 of file docparser.h.

Constructor & Destructor Documentation

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

inline

Definition at line 962 of file docparser.h.

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

                                                          : 
      m_target(target) { m_parent = parent; }

Member Function Documentation

void DocSecRefItem::accept ( DocVisitor *  v )

inlinevirtual

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

Parameters

v	Abstract visitor.

Implements DocNode.

Definition at line 968 of file docparser.h.

References CompAccept< T >::accept().

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

QCString DocSecRefItem::anchor ( ) const

inline

Definition at line 967 of file docparser.h.

References m_anchor.

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

{ return m_anchor; }

QCString DocSecRefItem::file ( ) const

inline

Definition at line 966 of file docparser.h.

References m_file.

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

{ return m_file; }

Kind DocSecRefItem::kind ( ) const

inlinevirtual

Returns the kind of node. Provides runtime type information

Implements DocNode.

Definition at line 964 of file docparser.h.

References DocNode::Kind_SecRefItem.

{ return Kind_SecRefItem; }

void DocSecRefItem::parse

(

)

Definition at line 2268 of file docparser.cpp.

References SDict< T >::append(), DBG, defaultHandleToken(), doctokenizerYYlex(), doctokenizerYYlineno, doctokenizerYYsetStatePara(), doctokenizerYYsetStateTitle(), SectionInfo::fileName, SDict< T >::find(), g_fileName, g_nodeStack, g_token, handlePendingStyleCommands(), SectionInfo::label, m_anchor, CompAccept< DocSecRefItem >::m_children, m_file, m_target, TokenInfo::name, Doxygen::sectionDict, TK_COMMAND, TK_SYMBOL, tokToString(), and warn_doc_error().

Referenced by DocSecRefList::parse().

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

  doctokenizerYYsetStateTitle();
  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 \\refitem",
           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;
      }
    }
  }
  doctokenizerYYsetStatePara();
  handlePendingStyleCommands(this,m_children);

  SectionInfo *sec=0;
  if (!m_target.isEmpty())
  {
    sec=Doxygen::sectionDict->find(m_target);
    if (sec)
    {
      m_file   = sec->fileName;
      m_anchor = sec->label;
      if (g_sectionDict && g_sectionDict->find(m_target)==0)
      {
        g_sectionDict->append(m_target,sec);
      }
    }
    else
    {
      warn_doc_error(g_fileName,doctokenizerYYlineno,"reference to unknown section %s",
          qPrint(m_target));
    }
  } 
  else
  {
    warn_doc_error(g_fileName,doctokenizerYYlineno,"reference to empty target");
  }
  
  DBG(("DocSecRefItem::parse() end\n"));
  DocNode *n = g_nodeStack.pop();
  ASSERT(n==this);
}

QCString DocSecRefItem::target ( ) const

inline

Definition at line 965 of file docparser.h.

References m_target.

Referenced by PrintDocVisitor::visitPre().

{ return m_target; }

Member Data Documentation

QCString DocSecRefItem::m_anchor

private

Definition at line 974 of file docparser.h.

Referenced by anchor(), and parse().

QCString DocSecRefItem::m_file

private

Definition at line 973 of file docparser.h.

Referenced by file(), and parse().

QCString DocSecRefItem::m_target

private

Definition at line 972 of file docparser.h.

Referenced by parse(), and target().

---

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

• docparser.h
• docparser.cpp