The DocSecRefItem Class Reference

Node representing a reference to a section. More...

Declaration

class DocSecRefItem { ... }

Included Headers

#include <src/docnode.h>

Base class

class	DocCompoundNode
	Base class for nodes with children. More...

Public Constructors Index

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

Public Member Functions Index

QCString	target () const
QCString	file () const
QCString	anchor () const
QCString	relPath () const
QCString	ref () const
bool	refToTable () const
bool	isSubPage () const
void	parse ()

Private Member Attributes Index

QCString	m_target
RefType	m_refType = Unknown
bool	m_isSubPage = false
QCString	m_file
QCString	m_relPath
QCString	m_ref
QCString	m_anchor

Description

Node representing a reference to a section.

Definition at line 934 of file docnode.h.

Public Constructors

DocSecRefItem()

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

Declaration at line 937 of file docnode.h, definition at line 534 of file docnode.cpp.

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

535 DocCompoundNode(parser,parent), m_target(target), m_relPath(parser->context.relPath)

536{

537}

References DocCompoundNode::DocCompoundNode, m_relPath, m_target, DocNode::parent, DocNode::parser, relPath and target.

Public Member Functions

anchor()

QCString DocSecRefItem::anchor ()

inline

Definition at line 940 of file docnode.h.

940 QCString anchor() const { return m_anchor; }

Reference m_anchor.

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

file()

QCString DocSecRefItem::file ()

inline

Definition at line 939 of file docnode.h.

939 QCString file() const { return m_file; }

Reference m_file.

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

isSubPage()

bool DocSecRefItem::isSubPage ()

inline

Definition at line 944 of file docnode.h.

944 bool isSubPage() const { return m_isSubPage; }

Reference m_isSubPage.

Referenced by HtmlDocVisitor::operator() and LatexDocVisitor::operator().

parse()

void DocSecRefItem::parse ()

Declaration at line 945 of file docnode.h, definition at line 539 of file docnode.cpp.

539void DocSecRefItem::parse()

540{

541 AUTO_TRACE();

542 auto ns = AutoNodeStack(parser(),thisVariant());

543

544 parser()->tokenizer.setStateTitle();

545 Token tok = parser()->tokenizer.lex();

546 while (!tok.is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF))

547 {

548 if (!parser()->defaultHandleToken(thisVariant(),tok,children()))

549 {

550 parser()->errorHandleDefaultToken(thisVariant(),tok,children(),"\\refitem");

551 }

552 tok = parser()->tokenizer.lex();

553 }

554 parser()->tokenizer.setStatePara();

555 parser()->handlePendingStyleCommands(thisVariant(),children());

556

557 if (!m_target.isEmpty())

558 {

559 const SectionInfo *sec = SectionManager::instance().find(m_target);

560 if (sec==nullptr && parser()->context.lang==SrcLangExt::Markdown) // lookup as markdown file

561 {

562 sec = SectionManager::instance().find(markdownFileNameToId(m_target));

563 }

564 if (sec) // ref to section or anchor

565 {

566 // set defaults

567 m_ref = sec->ref();

568 m_file = stripKnownExtensions(sec->fileName());

569 m_refType = Section;

570 m_anchor = sec->label();

571 m_isSubPage = false;

572 // adjust if needed

573 switch (sec->type().level())

574 {

575 case SectionType::Page:

576 {

577 PageDef *pd = Doxygen::pageLinkedMap->find(m_target);

578 m_isSubPage = pd && pd->hasParentPage();

579 if (!m_isSubPage)

580 {

581 m_anchor="";

582 }

583 }

584 break;

585 case SectionType::Anchor:

586 m_refType = Anchor;

587 break;

588 case SectionType::Table:

589 m_refType = Table;

590 break;

591 default:

592 break;

593 }

594 //printf("m_ref=%s,m_file=%s,type=%d\n",

595 // qPrint(m_ref),qPrint(m_file),m_refType);

596 }

597 else

598 {

599 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"reference to unknown section {}",m_target);

600 }

601 }

602 else

603 {

604 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"reference to empty target");

605 }

606}

References DocNode::Anchor, SectionType::Anchor, AUTO_TRACE, DocCompoundNode::children, DocParser::errorHandleDefaultToken, SectionInfo::fileName, LinkedMap< T, Hash, KeyEqual, Map >::find, DocParser::handlePendingStyleCommands, PageDef::hasParentPage, SectionManager::instance, Token::is_any_of, SectionInfo::label, SectionType::level, DocTokenizer::lex, m_anchor, m_file, m_isSubPage, m_ref, m_refType, m_target, markdownFileNameToId, SectionType::Page, Doxygen::pageLinkedMap, DocNode::parser, SectionInfo::ref, DocNode::Section, DocTokenizer::setStatePara, DocTokenizer::setStateTitle, stripKnownExtensions, DocNode::Table, SectionType::Table, DocNode::thisVariant, DocParser::tokenizer, SectionInfo::type and warn_doc_error.

ref()

QCString DocSecRefItem::ref ()

inline

Definition at line 942 of file docnode.h.

942 QCString ref() const { return m_ref; }

Reference m_ref.

Referenced by HtmlDocVisitor::operator() and LatexDocVisitor::operator().

refToTable()

bool DocSecRefItem::refToTable ()

inline

Definition at line 943 of file docnode.h.

943 bool refToTable() const { return m_refType==Table; }

References m_refType and DocNode::Table.

Referenced by LatexDocVisitor::operator().

relPath()

QCString DocSecRefItem::relPath ()

inline

Definition at line 941 of file docnode.h.

941 QCString relPath() const { return m_relPath; }

Reference m_relPath.

Referenced by DocSecRefItem and HtmlDocVisitor::operator().

target()

QCString DocSecRefItem::target ()

inline

Definition at line 938 of file docnode.h.

938 QCString target() const { return m_target; }

Reference m_target.

Referenced by DocSecRefItem and PrintDocVisitor::operator().

Private Member Attributes

m_anchor

QCString DocSecRefItem::m_anchor

Definition at line 954 of file docnode.h.

954 QCString m_anchor;

Referenced by anchor and parse.

m_file

QCString DocSecRefItem::m_file

Definition at line 951 of file docnode.h.

951 QCString m_file;

Referenced by file and parse.

m_isSubPage

bool DocSecRefItem::m_isSubPage = false

Definition at line 950 of file docnode.h.

950 bool m_isSubPage = false;

Referenced by isSubPage and parse.

m_ref

QCString DocSecRefItem::m_ref

Definition at line 953 of file docnode.h.

953 QCString m_ref;

Referenced by parse and ref.

m_refType

RefType DocSecRefItem::m_refType = Unknown

Definition at line 949 of file docnode.h.

949 RefType m_refType = Unknown;

Referenced by parse and refToTable.

m_relPath

QCString DocSecRefItem::m_relPath

Definition at line 952 of file docnode.h.

952 QCString m_relPath;

Referenced by DocSecRefItem and relPath.

m_target

QCString DocSecRefItem::m_target

Definition at line 948 of file docnode.h.

948 QCString m_target;

Referenced by DocSecRefItem, parse and target.

---

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

• docnode.cpp
• docnode.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.