DocInternalRef Class Reference

Node representing an internal reference to some item. More...

#include <src/docnode.h>

Inheritance diagram for DocInternalRef:

Collaboration diagram for DocInternalRef:

Public Member Functions
	DocInternalRef (DocParser *parser, DocNodeVariant *parent, const QCString &target)
void	parse ()
QCString	file () const
QCString	relPath () const
QCString	anchor () 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
QCString	m_file
QCString	m_relPath
QCString	m_anchor

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

Definition at line 806 of file docnode.h.

Constructor & Destructor Documentation

DocInternalRef()

DocInternalRef::DocInternalRef	(	DocParser *	parser,
		DocNodeVariant *	parent,
		const QCString &	target )

Definition at line 673 of file docnode.cpp.

  : DocCompoundNode(parser,parent), m_relPath(parser->context.relPath)
{
  int i=ref.find('#');
  if (i!=-1)
  {
    m_anchor = ref.right(static_cast<int>(ref.length())-i-1);
    m_file   = ref.left(i);
  }
  else
  {
    m_file = ref;
  }
}

References DocCompoundNode::DocCompoundNode(), QCString::find(), QCString::left(), QCString::length(), m_anchor, m_file, m_relPath, DocNode::parent(), DocNode::parser(), relPath(), and QCString::right().

Member Function Documentation

anchor()

QCString DocInternalRef::anchor ( ) const

inline

Definition at line 813 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()().

file()

QCString DocInternalRef::file ( ) const

inline

Definition at line 811 of file docnode.h.

{ return m_file; }

References m_file.

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

parse()

void DocInternalRef::parse

(

)

Definition at line 688 of file docnode.cpp.

{
  AUTO_TRACE();
  auto ns = AutoNodeStack(parser(),thisVariant());
 
  Token tok = parser()->tokenizer.lex();
  while (!tok.is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF))
  {
    if (!parser()->defaultHandleToken(thisVariant(),tok,children()))
    {
      parser()->errorHandleDefaultToken(thisVariant(),tok,children(),"\\ref");
    }
    tok=parser()->tokenizer.lex();
  }
 
  parser()->handlePendingStyleCommands(thisVariant(),children());
}

References AUTO_TRACE, DocCompoundNode::children(), DocParser::errorHandleDefaultToken(), DocParser::handlePendingStyleCommands(), Token::is_any_of(), DocTokenizer::lex(), DocNode::parser(), DocNode::thisVariant(), and DocParser::tokenizer.

relPath()

QCString DocInternalRef::relPath ( ) const

inline

Definition at line 812 of file docnode.h.

{ return m_relPath; }

References m_relPath.

Referenced by DocInternalRef(), and HtmlDocVisitor::operator()().

Member Data Documentation

m_anchor

QCString DocInternalRef::m_anchor

private

Definition at line 818 of file docnode.h.

Referenced by anchor(), and DocInternalRef().

m_file

QCString DocInternalRef::m_file

private

Definition at line 816 of file docnode.h.

Referenced by DocInternalRef(), and file().

m_relPath

QCString DocInternalRef::m_relPath

private

Definition at line 817 of file docnode.h.

Referenced by DocInternalRef(), and relPath().

---

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

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