Node representing a citation of some bibliographic reference. More...

#include <src/docnode.h>

Inheritance diagram for DocCite:

Collaboration diagram for DocCite:

Public Member Functions
	DocCite (DocParser parser, DocNodeVariant parent, const QCString &target, const QCString &context, CiteInfoOption opt)
QCString	file () const
QCString	relPath () const
QCString	ref () const
QCString	anchor () const
QCString	target () const
CiteInfoOption	option () const
QCString	getText () 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_ref
QCString	m_anchor
QCString	m_target
CiteInfoOption	m_option

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 a citation of some bibliographic reference.

Definition at line 244 of file docnode.h.

Constructor & Destructor Documentation

◆ DocCite()

DocCite::DocCite	(	DocParser *	parser,
		DocNodeVariant *	parent,
		const QCString &	target,
		const QCString &	context,
		CiteInfoOption	opt )

Definition at line 936 of file docnode.cpp.

                                                                                                                    : DocNode(parser,parent)
{
  size_t numBibFiles = Config_getList(CITE_BIB_FILES).size();
  //printf("DocCite::DocCite(target=%s)\n",qPrint(target));
  ASSERT(!target.isEmpty());
  m_relPath = parser->context.relPath;
  const CitationManager &ct = CitationManager::instance();
  const CiteInfo *cite = ct.find(target);
  //printf("cite=%p text='%s' numBibFiles=%d\n",cite,cite?qPrint(cite->text):"<null>",numBibFiles);
  m_option = opt;
  m_target = target;
  if (numBibFiles>0 && cite && !cite->text().isEmpty()) // ref to citation
  {
    m_ref          = "";
    m_anchor       = ct.anchorPrefix()+cite->label();
    m_file         = convertNameToFile(ct.fileName(),FALSE,TRUE);
    //printf("CITE ==> m_text=%s,m_ref=%s,m_file=%s,m_anchor=%s\n",
    //    qPrint(m_text),qPrint(m_ref),qPrint(m_file),qPrint(m_anchor));
    return;
  }
  if (numBibFiles==0)
  {
    warn_doc_error(parser->context.fileName,parser->tokenizer.getLineNr(),"\\cite command found but no bib files specified via CITE_BIB_FILES!");
  }
  else if (cite==nullptr)
  {
    warn_doc_error(parser->context.fileName,parser->tokenizer.getLineNr(),"unable to resolve reference to '{}' for \\cite command",
             target);
  }
  else
  {
    warn_doc_error(parser->context.fileName,parser->tokenizer.getLineNr(),"\\cite command to '{}' does not have an associated number",
             target);
  }
}

References CitationManager::anchorPrefix(), ASSERT, Config_getList, convertNameToFile(), DocNode::DocNode(), FALSE, CitationManager::fileName(), CitationManager::find(), CitationManager::instance(), QCString::isEmpty(), CiteInfo::label(), m_anchor, m_file, m_option, m_ref, m_relPath, m_target, DocNode::parent(), DocNode::parser(), target(), CiteInfo::text(), TRUE, and warn_doc_error.

Member Function Documentation

◆ anchor()

QCString DocCite::anchor ( ) const

inline

Definition at line 251 of file docnode.h.

251{ return m_anchor; }

References m_anchor.

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

◆ file()

QCString DocCite::file ( ) const

inline

Definition at line 248 of file docnode.h.

248{ return m_file; }

References m_file.

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

◆ getText()

QCString DocCite::getText ( ) const

Definition at line 972 of file docnode.cpp.

{
  QCString txt;
  auto opt = m_option;
  const CitationManager &ct = CitationManager::instance();
  const CiteInfo *citeInfo = ct.find(m_target);
 
  if (!opt.noPar())  txt += "[";
 
  if (citeInfo)
  {
    if      (opt.isNumber())      txt += citeInfo->text();
    else if (opt.isShortAuthor()) txt += citeInfo->shortAuthor();
    else if (opt.isYear())        txt += citeInfo->year();
  }
 
  if (!opt.noPar()) txt += "]";
  return txt;
}

References CitationManager::find(), CitationManager::instance(), m_option, m_target, CiteInfo::shortAuthor(), CiteInfo::text(), and CiteInfo::year().

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

◆ option()

CiteInfoOption DocCite::option ( ) const

inline

Definition at line 253 of file docnode.h.

253{ return m_option; }

References m_option.

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

◆ ref()

QCString DocCite::ref ( ) const

inline

Definition at line 250 of file docnode.h.

250{ return m_ref; }

References m_ref.

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

◆ relPath()

QCString DocCite::relPath ( ) const

inline

Definition at line 249 of file docnode.h.

249{ return m_relPath; }

References m_relPath.

Referenced by HtmlDocVisitor::operator()().

◆ target()

QCString DocCite::target ( ) const

inline

Definition at line 252 of file docnode.h.

252{ return m_target; }

References m_target.

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

Member Data Documentation

◆ m_anchor

QCString DocCite::m_anchor

private

Definition at line 260 of file docnode.h.

Referenced by anchor(), and DocCite().

◆ m_file

QCString DocCite::m_file

private

Definition at line 257 of file docnode.h.

Referenced by DocCite(), and file().

◆ m_option

CiteInfoOption DocCite::m_option

private

Definition at line 262 of file docnode.h.

Referenced by DocCite(), getText(), and option().

◆ m_ref

QCString DocCite::m_ref

private

Definition at line 259 of file docnode.h.

Referenced by DocCite(), and ref().

◆ m_relPath

QCString DocCite::m_relPath

private

Definition at line 258 of file docnode.h.

Referenced by DocCite(), and relPath().

◆ m_target

QCString DocCite::m_target

private

Definition at line 261 of file docnode.h.

Referenced by DocCite(), getText(), and target().

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

src/docnode.h
src/docnode.cpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DocCite()

Member Function Documentation

◆ anchor()

◆ file()

◆ getText()

◆ option()

◆ ref()

◆ relPath()

◆ target()

Member Data Documentation

◆ m_anchor

◆ m_file

◆ m_option

◆ m_ref

◆ m_relPath

◆ m_target