DocCite Class Reference

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 DString &target, const DString &context, CiteInfoOption opt)
DString	file () const
DString	relPath () const
DString	ref () const
DString	anchor () const
DString	target () const
CiteInfoOption	option () const
DString	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
DString	m_file
DString	m_relPath
DString	m_ref
DString	m_anchor
DString	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 DString &	target,
		const DString &	context,
		CiteInfoOption	opt )

Definition at line 952 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.empty());
  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().empty()) // 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, DocParser::context, convertNameToFile(), DocNode::DocNode(), DString::empty(), CitationManager::fileName(), DocParserContext::fileName, CitationManager::find(), DocTokenizer::getLineNr(), CitationManager::instance(), CiteInfo::label(), m_anchor, m_file, m_option, m_ref, m_relPath, m_target, DocNode::parent(), DocNode::parser(), DocParserContext::relPath, target(), CiteInfo::text(), DocParser::tokenizer, and warn_doc_error.

Member Function Documentation

anchor()

DString DocCite::anchor ( ) const

inline

Definition at line 251 of file docnode.h.

{ return m_anchor; }

References m_anchor.

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

file()

DString DocCite::file ( ) const

inline

Definition at line 248 of file docnode.h.

{ 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()

DString DocCite::getText

(

)

const

Definition at line 988 of file docnode.cpp.

{
  DString 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.

{ 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()

DString DocCite::ref ( ) const

inline

Definition at line 250 of file docnode.h.

{ return m_ref; }

References m_ref.

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

relPath()

DString DocCite::relPath ( ) const

inline

Definition at line 249 of file docnode.h.

{ return m_relPath; }

References m_relPath.

Referenced by HtmlDocVisitor::operator()().

target()

DString DocCite::target ( ) const

inline

Definition at line 252 of file docnode.h.

{ 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

DString DocCite::m_anchor

private

Definition at line 260 of file docnode.h.

Referenced by anchor(), and DocCite().

m_file

DString 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

DString DocCite::m_ref

private

Definition at line 259 of file docnode.h.

Referenced by DocCite(), and ref().

m_relPath

DString DocCite::m_relPath

private

Definition at line 258 of file docnode.h.

Referenced by DocCite(), and relPath().

m_target

DString 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