#include <src/definitionimpl.h>

Classes
class	Private
	Private data associated with a Symbol DefinitionImpl object. More...

Public Member Functions
	DefinitionImpl (Definition def, const QCString &defFileName, int defLine, int defColumn, const QCString &name, const char b=nullptr, const char *d=nullptr, bool isSymbol=TRUE)

	~DefinitionImpl ()

	DefinitionImpl (const DefinitionImpl &d)

DefinitionImpl &	operator= (const DefinitionImpl &d)

	DefinitionImpl (DefinitionImpl &&d)=delete

DefinitionImpl &	operator= (DefinitionImpl &&d)=delete

const QCString &	name () const

bool	isAnonymous () const

const QCString &	localName () const

QCString	qualifiedName () const

QCString	symbolName () const

QCString	getSourceFileBase () const

QCString	getSourceAnchor () const

QCString	documentation () const

int	docLine () const

QCString	docFile () const

QCString	briefDescription (bool abbreviate=FALSE) const

QCString	briefDescriptionAsTooltip () const

int	briefLine () const

QCString	inbodyDocumentation () const

QCString	inbodyFile () const

int	inbodyLine () const

QCString	briefFile () const

QCString	getDefFileName () const

QCString	getDefFileExtension () const

int	getDefLine () const

int	getDefColumn () const

bool	hasDocumentation () const

bool	hasUserDocumentation () const

bool	isVisibleInProject () const

bool	isVisible () const

bool	isHidden () const

bool	isArtificial () const

bool	isExported () const

QCString	getReference () const

bool	isReference () const

QCString	externalReference (const QCString &relPath) const

int	getStartDefLine () const

int	getStartBodyLine () const

int	getEndBodyLine () const

const FileDef *	getBodyDef () const

SrcLangExt	getLanguage () const

const GroupList &	partOfGroups () const

bool	isLinkableViaGroup () const

const RefItemVector &	xrefListItems () const

const Definition *	findInnerCompound (const QCString &name) const

Definition *	getOuterScope () const

const MemberVector &	getReferencesMembers () const

const MemberVector &	getReferencedByMembers () const

bool	hasSections () const

bool	hasSources () const

bool	hasBriefDescription () const

QCString	id () const

const SectionRefs &	getSectionRefs () const

void	setName (const QCString &name)

void	setId (const QCString &name)

void	setDefFile (const QCString &df, int defLine, int defColumn)

void	setDocumentation (const QCString &d, const QCString &docFile, int docLine, bool stripWhiteSpace=TRUE)

void	setBriefDescription (const QCString &b, const QCString &briefFile, int briefLine)

void	setInbodyDocumentation (const QCString &d, const QCString &docFile, int docLine)

void	setReference (const QCString &r)

void	addSectionsToDefinition (const std::vector< const SectionInfo * > &anchorList)

void	setBodySegment (int defLine, int bls, int ble)

void	setBodyDef (const FileDef *fd)

void	addSourceReferencedBy (MemberDef *d, const QCString &sourceRefName)

void	addSourceReferences (MemberDef *d, const QCString &sourceRefName)

void	setRefItems (const RefItemVector &sli)

void	mergeRefItems (Definition *d)

void	mergeReferences (const Definition *other)

void	mergeReferencedBy (const Definition *other)

void	addInnerCompound (Definition *d)

void	setOuterScope (Definition *d)

void	setHidden (bool b)

void	setArtificial (bool b)

void	setExported (bool b)

void	setLanguage (SrcLangExt lang)

void	writeSourceDef (OutputList &ol) const

void	writeInlineCode (OutputList &ol, const QCString &scopeName) const

bool	hasSourceRefs () const

bool	hasSourceReffedBy () const

void	writeSourceRefs (OutputList &ol, const QCString &scopeName) const

void	writeSourceReffedBy (OutputList &ol, const QCString &scopeName) const

void	makePartOfGroup (GroupDef *gd)

void	writeNavigationPath (OutputList &ol) const

QCString	navigationPathAsString () const

void	writeQuickMemberLinks (OutputList &, const MemberDef *) const

void	writeSummaryLinks (OutputList &) const

QCString	pathFragment () const

void	writeDocAnchorsToTagFile (TextStream &) const

void	setLocalName (const QCString &name)

void	writeToc (OutputList &ol, const LocalToc &lt) const

void	computeTooltip ()

void	_setSymbolName (const QCString &name)

QCString	_symbolName () const

Private Member Functions
int	_getXRefListId (const QCString &listName) const

void	_writeSourceRefList (OutputList &ol, const QCString &scopeName, const QCString &text, const std::unordered_map< std::string, MemberDef * > &members, bool) const

void	_setBriefDescription (const QCString &b, const QCString &briefFile, int briefLine)

void	_setDocumentation (const QCString &d, const QCString &docFile, int docLine, bool stripWhiteSpace, bool atTop)

void	_setInbodyDocumentation (const QCString &d, const QCString &docFile, int docLine)

bool	_docsAlreadyAdded (const QCString &doc, QCString &sigList)

Private Attributes
std::unique_ptr< Private >	p

Detailed Description

Definition at line 27 of file definitionimpl.h.

Constructor & Destructor Documentation

◆ DefinitionImpl() [1/3]

DefinitionImpl::DefinitionImpl	(	Definition *	def,
		const QCString &	defFileName,
		int	defLine,
		int	defColumn,
		const QCString &	name,
		const char *	b = nullptr,
		const char *	d = nullptr,
		bool	isSymbol = TRUE )

Definition at line 234 of file definition.cpp.

  : p(std::make_unique<Private>())
{
  setName(name);
  p->def = def;
  p->defLine = dl;
  p->defColumn = dc;
  p->init(df,name);
  p->isSymbol = isSymbol;
  if (isSymbol) addToMap(name,def);
  _setBriefDescription(b,df,dl);
  _setDocumentation(d,df,dl,TRUE,FALSE);
  if (matchExcludedSymbols(name))
  {
    p->hidden = TRUE;
  }
}

References _setBriefDescription(), _setDocumentation(), addToMap(), FALSE, matchExcludedSymbols(), name(), p, setName(), and TRUE.

Referenced by DefinitionImpl(), DefinitionImpl(), mergeReferencedBy(), mergeReferences(), operator=(), and operator=().

◆ ~DefinitionImpl()

DefinitionImpl::~DefinitionImpl ( )

Definition at line 270 of file definition.cpp.

{
  if (p->isSymbol)
  {
    removeFromMap(p->symbolName,p->def);
  }
}

References p, and removeFromMap().

◆ DefinitionImpl() [2/3]

DefinitionImpl::DefinitionImpl ( const DefinitionImpl & d )

Definition at line 255 of file definition.cpp.

  : p(std::make_unique<Private>(*d.p))
{
  if (p->isSymbol) addToMap(p->name,p->def);
}

References addToMap(), DefinitionImpl(), and p.

◆ DefinitionImpl() [3/3]

DefinitionImpl::DefinitionImpl ( DefinitionImpl && d )

delete

References DefinitionImpl().

Member Function Documentation

◆ _docsAlreadyAdded()

bool DefinitionImpl::_docsAlreadyAdded	(	const QCString &	doc,
		QCString &	sigList )

private

Definition at line 364 of file definition.cpp.

{
  uint8_t md5_sig[16];
  char sigStr[33];
  // to avoid mismatches due to differences in indenting, we first remove
  // double whitespaces...
  QCString docStr = doc.simplifyWhiteSpace();
  MD5Buffer(docStr.data(),static_cast<unsigned int>(docStr.length()),md5_sig);
  MD5SigToString(md5_sig,sigStr);
  //printf("%s:_docsAlreadyAdded doc='%s' sig='%s' docSigs='%s'\n",
  //    qPrint(name()),qPrint(doc),qPrint(sigStr),qPrint(sigList));
  if (sigList.find(sigStr)==-1) // new docs, add signature to prevent re-adding it
  {
    sigList+=QCString(":")+sigStr;
    return FALSE;
  }
  else
  {
    return TRUE;
  }
}

References QCString::data(), FALSE, QCString::find(), QCString::length(), QCString::simplifyWhiteSpace(), and TRUE.

Referenced by _setBriefDescription(), and toDefinition().

◆ _getXRefListId()

int DefinitionImpl::_getXRefListId ( const QCString & listName ) const

private

Definition at line 1317 of file definition.cpp.

{
  for (const RefItem *item : p->xrefListItems)
  {
    if (item->list()->listName()==listName)
    {
      return item->id();
    }
  }
  return -1;
}

References RefItem::id(), RefItem::list(), RefList::listName(), and p.

◆ _setBriefDescription()

void DefinitionImpl::_setBriefDescription	(	const QCString &	b,
		const QCString &	briefFile,
		int	briefLine )

private

Definition at line 439 of file definition.cpp.

{
  QCString brief = b;
  brief = brief.stripWhiteSpace();
  brief = stripLeadingAndTrailingEmptyLines(brief,briefLine);
  brief = brief.stripWhiteSpace();
  if (brief.isEmpty()) return;
  size_t bl = brief.length();
  if (bl>0)
  {
    if (!theTranslator || theTranslator->needsPunctuation()) // add punctuation if needed
    {
      int c = brief.at(bl-1);
      switch(c)
      {
        case '.': case '!': case '?': case '>': case ':': case ')': break;
        default:
          if (isUTF8CharUpperCase(brief.str(),0) && !lastUTF8CharIsMultibyte(brief.str())) brief+='.';
          break;
      }
    }
  }
 
  if (!_docsAlreadyAdded(brief,p->briefSignatures))
  {
    if (p->brief && !p->brief->doc.isEmpty())
    {
       //printf("adding to details\n");
       _setDocumentation(brief,briefFile,briefLine,FALSE,TRUE);
    }
    else
    {
      //fprintf(stderr,"DefinitionImpl::setBriefDescription(%s,%s,%d)\n",b,briefFile,briefLine);
      if (!p->brief.has_value())
      {
        p->brief = std::make_optional<BriefInfo>();
      }
      BriefInfo &briefInfo = p->brief.value();
      briefInfo.doc=brief;
      if (briefLine!=-1)
      {
        briefInfo.file = briefFile;
        briefInfo.line = briefLine;
      }
      else
      {
        briefInfo.file = briefFile;
        briefInfo.line = 1;
      }
    }
  }
  else
  {
    //printf("do nothing!\n");
  }
}

References _docsAlreadyAdded(), _setDocumentation(), QCString::at(), briefFile(), briefLine(), BriefInfo::doc, FALSE, BriefInfo::file, QCString::isEmpty(), isUTF8CharUpperCase(), lastUTF8CharIsMultibyte(), QCString::length(), BriefInfo::line, p, QCString::str(), stripLeadingAndTrailingEmptyLines(), QCString::stripWhiteSpace(), theTranslator, and TRUE.

Referenced by DefinitionImpl(), and setBriefDescription().

◆ _setDocumentation()

void DefinitionImpl::_setDocumentation	(	const QCString &	d,
		const QCString &	docFile,
		int	docLine,
		bool	stripWhiteSpace,
		bool	atTop )

private

Definition at line 386 of file definition.cpp.

{
  //printf("%s::setDocumentation(%s,%s,%d,%d)\n",qPrint(name()),d,docFile,docLine,stripWhiteSpace);
  if (d.isEmpty()) return;
  QCString doc = d;
  if (stripWhiteSpace)
  {
    doc = stripLeadingAndTrailingEmptyLines(doc,docLine);
  }
  else // don't strip whitespace
  {
    doc=d;
  }
  if (!_docsAlreadyAdded(doc,p->docSignatures))
  {
    //printf("setting docs for %s: '%s'\n",qPrint(name()),qPrint(m_doc));
    if (!p->details.has_value())
    {
      p->details = std::make_optional<DocInfo>();
    }
    DocInfo &details = p->details.value();
    if (details.doc.isEmpty()) // fresh detailed description
    {
      details.doc = doc;
    }
    else if (atTop) // another detailed description, append it to the start
    {
      details.doc = doc+"\n\n"+details.doc;
    }
    else // another detailed description, append it to the end
    {
      details.doc += "\n\n"+doc;
    }
    if (docLine!=-1) // store location if valid
    {
      details.file = docFile;
      details.line = docLine;
    }
    else
    {
      details.file = docFile;
      details.line = 1;
    }
  }
}

References docFile(), docLine(), and stripWhiteSpace().

Referenced by _setBriefDescription(), DefinitionImpl(), and setDocumentation().

◆ _setInbodyDocumentation()

void DefinitionImpl::_setInbodyDocumentation	(	const QCString &	d,
		const QCString &	docFile,
		int	docLine )

private

Definition at line 502 of file definition.cpp.

{
  if (!p->inbodyDocs.has_value())
  {
    p->inbodyDocs = std::make_optional<DocInfo>();
  }
  DocInfo &inbodyDocs = p->inbodyDocs.value();
  if (inbodyDocs.doc.isEmpty()) // fresh inbody docs
  {
    inbodyDocs.doc  = doc;
    inbodyDocs.file = inbodyFile;
    inbodyDocs.line = inbodyLine;
  }
  else // another inbody documentation fragment, append this to the end
  {
    inbodyDocs.doc += QCString("\n\n")+doc;
  }
}

References DocInfo::doc, DocInfo::file, inbodyFile(), inbodyLine(), QCString::isEmpty(), DocInfo::line, and p.

Referenced by setInbodyDocumentation().

◆ _setSymbolName()

void DefinitionImpl::_setSymbolName ( const QCString & name )

Definition at line 1759 of file definition.cpp.

{
  p->symbolName=name;
}

References name(), and p.

◆ _symbolName()

QCString DefinitionImpl::_symbolName ( ) const

Definition at line 1764 of file definition.cpp.

{
  return p->symbolName;
}

References p.

◆ _writeSourceRefList()

void DefinitionImpl::_writeSourceRefList	(	OutputList &	ol,
		const QCString &	scopeName,
		const QCString &	text,
		const std::unordered_map< std::string, MemberDef * > &	membersMap,
		bool	) const

private

Write a reference to the source code fragments in which this definition is used.

Definition at line 1079 of file definition.cpp.

{
  if (!membersMap.empty())
  {
    auto members = refMapToVector(membersMap);
 
    auto replaceFunc = [this,&members,scopeName,&ol](size_t entryIndex)
    {
      bool sourceBrowser   = Config_getBool(SOURCE_BROWSER);
      bool refLinkSource   = Config_getBool(REFERENCES_LINK_SOURCE);
      const MemberDef *md=members[entryIndex];
      if (md)
      {
        QCString scope=md->getScopeString();
        QCString name=md->name();
        //printf("class=%p scope=%s scopeName=%s\n",md->getClassDef(),qPrint(scope),scopeName);
        if (!scope.isEmpty() && scope!=scopeName)
        {
          name.prepend(scope+getLanguageSpecificSeparator(p->lang));
        }
        if (!md->isObjCMethod() &&
            (md->isFunction() || md->isSlot() ||
             md->isPrototype() || md->isSignal()
            )
           )
        {
          name+="()";
        }
        if (sourceBrowser &&
            !(md->isLinkable() && !refLinkSource) &&
            md->getStartBodyLine()!=-1 &&
            md->getBodyDef()
           )
        {
          const int maxLineNrStr = 10;
          char anchorStr[maxLineNrStr];
          qsnprintf(anchorStr,maxLineNrStr,"l%05d",md->getStartBodyLine());
          //printf("Write object link to %s\n",qPrint(md->getBodyDef()->getSourceFileBase()));
          ol.writeObjectLink(QCString(),md->getBodyDef()->getSourceFileBase(),anchorStr,name);
        }
        else if (md->isLinkable())
        {
          ol.writeObjectLink(md->getReference(),
              md->getOutputFileBase(),
              md->anchor(),name);
        }
        else
        {
          ol.docify(name);
        }
      }
    };
 
    ol.startParagraph("reference");
    ol.parseText(text);
    ol.docify(" ");
    writeMarkerList(ol,
                    theTranslator->trWriteList(static_cast<int>(members.size())).str(),
                    members.size(),
                    replaceFunc);
    ol.writeString(".");
    ol.endParagraph();
 
  }
}

References Definition::anchor(), Config_getBool, OutputList::docify(), OutputList::endParagraph(), Definition::getBodyDef(), getLanguageSpecificSeparator(), Definition::getOutputFileBase(), Definition::getReference(), MemberDef::getScopeString(), Definition::getSourceFileBase(), Definition::getStartBodyLine(), QCString::isEmpty(), MemberDef::isFunction(), Definition::isLinkable(), MemberDef::isObjCMethod(), MemberDef::isPrototype(), MemberDef::isSignal(), MemberDef::isSlot(), Definition::name(), name(), p, OutputList::parseText(), qsnprintf, refMapToVector(), OutputList::startParagraph(), theTranslator, writeMarkerList(), OutputList::writeObjectLink(), and OutputList::writeString().

Referenced by writeSourceReffedBy(), and writeSourceRefs().

◆ addInnerCompound()

void DefinitionImpl::addInnerCompound ( Definition * d )

Definition at line 1212 of file definition.cpp.

{
  err("DefinitionImpl::addInnerCompound() called\n");
}

References err.

◆ addSectionsToDefinition()

void DefinitionImpl::addSectionsToDefinition ( const std::vector< const SectionInfo * > & anchorList )

Definition at line 303 of file definition.cpp.

{
  //printf("%s: addSectionsToDefinition(%d)\n",qPrint(name()),anchorList->count());
  for (const SectionInfo *si : anchorList)
  {
    //printf("Add section '%s' to definition '%s'\n",
    //    qPrint(si->label()),qPrint(name()));
    SectionManager &sm = SectionManager::instance();
    SectionInfo *gsi=sm.find(si->label());
    //printf("===== label=%s gsi=%p\n",qPrint(si->label),gsi);
    if (gsi==nullptr)
    {
      gsi = sm.add(*si);
    }
    if (p->sectionRefs.find(gsi->label())==nullptr)
    {
      p->sectionRefs.add(gsi);
      gsi->setDefinition(p->def);
    }
  }
}

References SectionManager::add(), LinkedMap< T, Hash, KeyEqual, Map >::find(), SectionManager::instance(), SectionInfo::label(), p, and SectionInfo::setDefinition().

◆ addSourceReferencedBy()

void DefinitionImpl::addSourceReferencedBy	(	MemberDef *	d,
		const QCString &	sourceRefName )

Definition at line 1191 of file definition.cpp.

{
  if (md)
  {
    p->sourceRefByDict.emplace(sourceRefName.str(),md);
  }
}

References p, and QCString::str().

◆ addSourceReferences()

void DefinitionImpl::addSourceReferences	(	MemberDef *	d,
		const QCString &	sourceRefName )

Definition at line 1199 of file definition.cpp.

{
  if (md)
  {
    p->sourceRefsDict.emplace(sourceRefName.str(),md);
  }
}

References p, and QCString::str().

◆ briefDescription()

QCString DefinitionImpl::briefDescription ( bool abbreviate = FALSE ) const

Definition at line 1530 of file definition.cpp.

{
  //printf("%s::briefDescription(%d)='%s'\n",qPrint(name()),abbr,p->brief?qPrint(p->brief->doc):"<none>");
  return p->brief ?
         (abbr ? abbreviate(p->brief->doc,p->def->displayName()) : p->brief->doc) :
         QCString("");
}

References abbreviate(), and p.

Referenced by hasBriefDescription().

◆ briefDescriptionAsTooltip()

QCString DefinitionImpl::briefDescriptionAsTooltip ( ) const

Definition at line 1549 of file definition.cpp.

{
  return p->brief ? p->brief->tooltip : QCString();
}

References p.

◆ briefFile()

QCString DefinitionImpl::briefFile ( ) const

Definition at line 1559 of file definition.cpp.

{
  return p->brief && !p->brief->file.isEmpty() ? p->brief->file : QCString("<"+p->name+">");
}

References p.

Referenced by _setBriefDescription(), operator=(), and setBriefDescription().

◆ briefLine()

int DefinitionImpl::briefLine ( ) const

Definition at line 1554 of file definition.cpp.

{
  return p->brief ? p->brief->line : 1;
}

References p.

Referenced by _setBriefDescription(), operator=(), and setBriefDescription().

◆ computeTooltip()

void DefinitionImpl::computeTooltip ( )

Definition at line 1538 of file definition.cpp.

{
  if (p->brief && p->brief->tooltip.isEmpty() && !p->brief->doc.isEmpty())
  {
    const MemberDef *md = p->def->definitionType()==Definition::TypeMember ? toMemberDef(p->def) : nullptr;
    const Definition *scope = p->def->definitionType()==Definition::TypeMember ? p->def->getOuterScope() : p->def;
    p->brief->tooltip = parseCommentAsText(scope,md,
                                p->brief->doc, p->brief->file, p->brief->line);
  }
}

References p, parseCommentAsText(), toMemberDef(), and Definition::TypeMember.

◆ docFile()

QCString DefinitionImpl::docFile ( ) const

Definition at line 1475 of file definition.cpp.

{
  if (p->details && !p->details->file.isEmpty()) return p->details->file;
  else if (p->brief && !p->brief->file.isEmpty()) return p->brief->file;
  else  return "<" + p->name + ">";
}

References p.

Referenced by _setDocumentation(), operator=(), setDocumentation(), and toDefinition().

◆ docLine()

int DefinitionImpl::docLine ( ) const

Definition at line 1470 of file definition.cpp.

{
  return p->details ? p->details->line : p->brief ? p->brief->line : 1;
}

References p.

Referenced by _setDocumentation(), operator=(), setDocumentation(), and toDefinition().

◆ documentation()

QCString DefinitionImpl::documentation ( ) const

Definition at line 1465 of file definition.cpp.

{
  return p->details ? p->details->doc : QCString("");
}

References p.

◆ externalReference()

QCString DefinitionImpl::externalReference ( const QCString & relPath ) const

Definition at line 1775 of file definition.cpp.

{
  QCString ref = getReference();
  if (!ref.isEmpty())
  {
    auto it = Doxygen::tagDestinationMap.find(ref.str());
    if (it!=Doxygen::tagDestinationMap.end())
    {
      QCString result(it->second);
      size_t l = result.length();
      if (!relPath.isEmpty() && l>0 && result.at(0)=='.')
      { // relative path -> prepend relPath.
        result.prepend(relPath);
        l+=relPath.length();
      }
      if (l>0 && result.at(l-1)!='/') result+='/';
      return result;
    }
  }
  return relPath;
}

References QCString::at(), end(), getReference(), QCString::isEmpty(), QCString::length(), QCString::prepend(), QCString::str(), and Doxygen::tagDestinationMap.

◆ findInnerCompound()

const Definition * DefinitionImpl::findInnerCompound ( const QCString & name ) const

Definition at line 1207 of file definition.cpp.

{
  return nullptr;
}

◆ getBodyDef()

const FileDef * DefinitionImpl::getBodyDef ( ) const

Definition at line 1644 of file definition.cpp.

{
  return p->body ? p->body->fileDef : nullptr;
}

References p.

◆ getDefColumn()

int DefinitionImpl::getDefColumn ( ) const

Definition at line 1812 of file definition.cpp.

{
  return p->defColumn;
}

References p.

◆ getDefFileExtension()

QCString DefinitionImpl::getDefFileExtension ( ) const

Definition at line 1589 of file definition.cpp.

{
  return p->defFileExt;
}

References p.

◆ getDefFileName()

QCString DefinitionImpl::getDefFileName ( ) const

Definition at line 1584 of file definition.cpp.

{
  return p->defFileName;
}

References p.

◆ getDefLine()

int DefinitionImpl::getDefLine ( ) const

Definition at line 1807 of file definition.cpp.

{
  return p->defLine;
}

References p.

◆ getEndBodyLine()

int DefinitionImpl::getEndBodyLine ( ) const

Definition at line 1639 of file definition.cpp.

{
  return p->body ? p->body->endLine : -1;
}

References p.

◆ getLanguage()

SrcLangExt DefinitionImpl::getLanguage ( ) const

Definition at line 1728 of file definition.cpp.

{
  return p->lang;
}

References p.

Referenced by qualifiedName().

◆ getOuterScope()

Definition * DefinitionImpl::getOuterScope ( ) const

Definition at line 1663 of file definition.cpp.

{
  return p->outerScope;
}

References p.

Referenced by navigationPathAsString().

◆ getReference()

QCString DefinitionImpl::getReference ( ) const

Definition at line 1619 of file definition.cpp.

{
  return p->ref;
}

References p.

Referenced by externalReference().

◆ getReferencedByMembers()

const MemberVector & DefinitionImpl::getReferencedByMembers ( ) const

Definition at line 1680 of file definition.cpp.

{
  std::lock_guard<std::mutex> lock(g_memberReferenceMutex);
  if (p->referencedByMembers.empty() && !p->sourceRefByDict.empty())
  {
    p->referencedByMembers = refMapToVector(p->sourceRefByDict);
  }
  return p->referencedByMembers;
}

References g_memberReferenceMutex, p, and refMapToVector().

◆ getReferencesMembers()

const MemberVector & DefinitionImpl::getReferencesMembers ( ) const

Definition at line 1670 of file definition.cpp.

{
  std::lock_guard<std::mutex> lock(g_memberReferenceMutex);
  if (p->referencesMembers.empty() && !p->sourceRefsDict.empty())
  {
    p->referencesMembers = refMapToVector(p->sourceRefsDict);
  }
  return p->referencesMembers;
}

References g_memberReferenceMutex, p, and refMapToVector().

◆ getSectionRefs()

const SectionRefs & DefinitionImpl::getSectionRefs ( ) const

Definition at line 1453 of file definition.cpp.

{
  return p->sectionRefs;
}

References p.

◆ getSourceAnchor()

QCString DefinitionImpl::getSourceAnchor ( ) const

Definition at line 915 of file definition.cpp.

{
  const int maxAnchorStrLen = 20;
  char anchorStr[maxAnchorStrLen];
  anchorStr[0]='\0';
  if (p->body && p->body->startLine!=-1)
  {
    if (Htags::useHtags)
    {
      qsnprintf(anchorStr,maxAnchorStrLen,"L%d",p->body->defLine);
    }
    else
    {
      qsnprintf(anchorStr,maxAnchorStrLen,"l%05d",p->body->defLine);
    }
  }
  return anchorStr;
}

References p, qsnprintf, and Htags::useHtags.

Referenced by writeSourceDef().

◆ getSourceFileBase()

QCString DefinitionImpl::getSourceFileBase ( ) const

Definition at line 902 of file definition.cpp.

{
  ASSERT(p->def->definitionType()!=Definition::TypeFile); // file overloads this method
  QCString fn;
  bool sourceBrowser = Config_getBool(SOURCE_BROWSER);
  if (sourceBrowser &&
      p->body && p->body->startLine!=-1 && p->body->fileDef)
  {
    fn = p->body->fileDef->getSourceFileBase();
  }
  return fn;
}

References ASSERT, Config_getBool, p, and Definition::TypeFile.

Referenced by writeSourceDef().

◆ getStartBodyLine()

int DefinitionImpl::getStartBodyLine ( ) const

Definition at line 1634 of file definition.cpp.

{
  return p->body ? p->body->startLine : -1;
}

References p.

◆ getStartDefLine()

int DefinitionImpl::getStartDefLine ( ) const

Definition at line 1629 of file definition.cpp.

{
  return p->body ? p->body->defLine : -1;
}

References p.

◆ hasBriefDescription()

bool DefinitionImpl::hasBriefDescription ( ) const

Definition at line 1769 of file definition.cpp.

{
  bool briefMemberDesc = Config_getBool(BRIEF_MEMBER_DESC);
  return !briefDescription().isEmpty() && briefMemberDesc;
}

References briefDescription(), Config_getBool, and QCString::isEmpty().

◆ hasDocumentation()

bool DefinitionImpl::hasDocumentation ( ) const

Definition at line 1167 of file definition.cpp.

{
  bool extractAll    = Config_getBool(EXTRACT_ALL);
  //bool sourceBrowser = Config_getBool(SOURCE_BROWSER);
  bool hasDocs =
         (p->details    && !p->details->doc.isEmpty())    || // has detailed docs
         (p->brief      && !p->brief->doc.isEmpty())      || // has brief description
         (p->inbodyDocs && !p->inbodyDocs->doc.isEmpty()) || // has inbody docs
         extractAll //||                   // extract everything
  //       (sourceBrowser && p->body &&
  //        p->body->startLine!=-1 && p->body->fileDef)
         ; // link to definition
  return hasDocs;
}

References Config_getBool, and p.

◆ hasSections()

bool DefinitionImpl::hasSections ( ) const

Definition at line 325 of file definition.cpp.

{
  //printf("DefinitionImpl::hasSections(%s) #sections=%d\n",qPrint(name()),
  //    p->sectionRefs.size());
  if (p->sectionRefs.empty()) return FALSE;
  for (const SectionInfo *si : p->sectionRefs)
  {
    if (si->type().isSection())
    {
      return TRUE;
    }
  }
  return FALSE;
}

References FALSE, SectionType::isSection(), p, TRUE, and SectionInfo::type().

◆ hasSourceReffedBy()

bool DefinitionImpl::hasSourceReffedBy ( ) const

Definition at line 1157 of file definition.cpp.

{
  return !p->sourceRefByDict.empty();
}

References p.

◆ hasSourceRefs()

bool DefinitionImpl::hasSourceRefs ( ) const

Definition at line 1162 of file definition.cpp.

{
  return !p->sourceRefsDict.empty();
}

References p.

◆ hasSources()

bool DefinitionImpl::hasSources ( ) const

Definition at line 1005 of file definition.cpp.

{
  return p->body && p->body->startLine!=-1 &&
         p->body->endLine>=p->body->startLine &&
         p->body->fileDef;
}

References p.

Referenced by writeInlineCode().

◆ hasUserDocumentation()

bool DefinitionImpl::hasUserDocumentation ( ) const

Definition at line 1182 of file definition.cpp.

{
  bool hasDocs =
         (p->details    && !p->details->doc.isEmpty()) ||
         (p->brief      && !p->brief->doc.isEmpty())   ||
         (p->inbodyDocs && !p->inbodyDocs->doc.isEmpty());
  return hasDocs;
}

References p.

◆ id()

QCString DefinitionImpl::id ( ) const

Definition at line 298 of file definition.cpp.

{
  return p->id;
}

Referenced by setId().

◆ inbodyDocumentation()

QCString DefinitionImpl::inbodyDocumentation ( ) const

Definition at line 1566 of file definition.cpp.

{
  return p->inbodyDocs ? p->inbodyDocs->doc : QCString("");
}

References p.

◆ inbodyFile()

QCString DefinitionImpl::inbodyFile ( ) const

Definition at line 1576 of file definition.cpp.

{
  return p->inbodyDocs && !p->inbodyDocs->file.isEmpty() ? p->inbodyDocs->file : QCString("<"+p->name+">");
}

References p.

Referenced by _setInbodyDocumentation(), and setInbodyDocumentation().

◆ inbodyLine()

int DefinitionImpl::inbodyLine ( ) const

Definition at line 1571 of file definition.cpp.

{
  return p->inbodyDocs ? p->inbodyDocs->line : 1;
}

References p.

Referenced by _setInbodyDocumentation(), and setInbodyDocumentation().

◆ isAnonymous()

bool DefinitionImpl::isAnonymous ( ) const

Definition at line 1802 of file definition.cpp.

{
  return p->isAnonymous;
}

References p.

◆ isArtificial()

bool DefinitionImpl::isArtificial ( ) const

Definition at line 1609 of file definition.cpp.

{
  return p->isArtificial;
}

References p.

◆ isExported()

bool DefinitionImpl::isExported ( ) const

Definition at line 1614 of file definition.cpp.

{
  return p->isExported;
}

References p.

◆ isHidden()

bool DefinitionImpl::isHidden ( ) const

Definition at line 1594 of file definition.cpp.

{
  return p->hidden;
}

References p.

◆ isLinkableViaGroup()

bool DefinitionImpl::isLinkableViaGroup ( ) const

Definition at line 1654 of file definition.cpp.

{
  for (const auto &gd : partOfGroups())
  {
    if (gd->isLinkable()) return true;
  }
  return false;
}

References partOfGroups().

◆ isReference()

bool DefinitionImpl::isReference ( ) const

Definition at line 1624 of file definition.cpp.

{
  return !p->ref.isEmpty();
}

References p.

◆ isVisible()

bool DefinitionImpl::isVisible ( ) const

Definition at line 1604 of file definition.cpp.

{
  return p->def->isLinkable() && !p->hidden;
}

References p.

◆ isVisibleInProject()

bool DefinitionImpl::isVisibleInProject ( ) const

Definition at line 1599 of file definition.cpp.

{
  return p->def->isLinkableInProject() && !p->hidden;
}

References p.

◆ localName()

const QCString & DefinitionImpl::localName ( ) const

Definition at line 1276 of file definition.cpp.

{
  return p->localName;
}

References p.

Referenced by navigationPathAsString().

◆ makePartOfGroup()

void DefinitionImpl::makePartOfGroup ( GroupDef * gd )

Definition at line 1281 of file definition.cpp.

{
  p->partOfGroups.push_back(gd);
}

References p.

◆ mergeReferencedBy()

void DefinitionImpl::mergeReferencedBy ( const Definition * other )

Definition at line 1706 of file definition.cpp.

{
  const DefinitionImpl *defImpl = other->toDefinitionImpl_();
  if (defImpl)
  {
    for (const auto &kv : defImpl->p->sourceRefByDict)
    {
      auto it = p->sourceRefByDict.find(kv.first);
      if (it != p->sourceRefByDict.end())
      {
        p->sourceRefByDict.emplace(kv.first,kv.second);
      }
    }
  }
}

References DefinitionImpl(), p, and Definition::toDefinitionImpl_().

◆ mergeReferences()

void DefinitionImpl::mergeReferences ( const Definition * other )

Definition at line 1690 of file definition.cpp.

{
  const DefinitionImpl *defImpl = other->toDefinitionImpl_();
  if (defImpl)
  {
    for (const auto &kv : defImpl->p->sourceRefsDict)
    {
      auto it = p->sourceRefsDict.find(kv.first);
      if (it != p->sourceRefsDict.end())
      {
        p->sourceRefsDict.insert(kv);
      }
    }
  }
}

References DefinitionImpl(), p, and Definition::toDefinitionImpl_().

◆ mergeRefItems()

void DefinitionImpl::mergeRefItems ( Definition * d )

Definition at line 1291 of file definition.cpp.

{
  auto otherXrefList = d->xrefListItems();
 
  // append vectors
  p->xrefListItems.reserve(p->xrefListItems.size()+otherXrefList.size());
  p->xrefListItems.insert (p->xrefListItems.end(),
                                otherXrefList.begin(),otherXrefList.end());
 
  // sort results on itemId
  std::stable_sort(p->xrefListItems.begin(),p->xrefListItems.end(),
            [](RefItem *left,RefItem *right)
            { return  left->id() <right->id() ||
                     (left->id()==right->id() &&
                      left->list()->listName() < right->list()->listName());
            });
 
  // filter out duplicates
  auto last = std::unique(p->xrefListItems.begin(),p->xrefListItems.end(),
            [](const RefItem *left,const RefItem *right)
            { return left->id()==right->id() &&
                     left->list()->listName()==right->list()->listName();
            });
  p->xrefListItems.erase(last, p->xrefListItems.end());
}

References p, and Definition::xrefListItems().

◆ name()

const QCString & DefinitionImpl::name ( ) const

Definition at line 1797 of file definition.cpp.

{
  return p->name;
}

References p.

Referenced by _setSymbolName(), _writeSourceRefList(), addToMap(), DefinitionImpl(), matchExcludedSymbols(), navigationPathAsString(), operator=(), removeFromMap(), setLocalName(), and setName().

◆ navigationPathAsString()

QCString DefinitionImpl::navigationPathAsString ( ) const

Returns the string used in the footer for $navpath when GENERATE_TREEVIEW is enabled

Definition at line 1372 of file definition.cpp.

{
  QCString result;
  Definition *outerScope = getOuterScope();
  QCString locName = localName();
  if (outerScope && outerScope!=Doxygen::globalScope)
  {
    result+=outerScope->navigationPathAsString();
  }
  else if (p->def->definitionType()==Definition::TypeFile &&
           toFileDef(p->def)->getDirDef())
  {
    result+=(toFileDef(p->def))->getDirDef()->navigationPathAsString();
  }
  result+="<li class=\"navelem\">";
  if (p->def->isLinkableInProject())
  {
    QCString fn = p->def->getOutputFileBase();
    addHtmlExtensionIfMissing(fn);
    if (p->def->definitionType()==Definition::TypeGroup &&
        !toGroupDef(p->def)->groupTitle().isEmpty())
    {
      result+="<a class=\"el\" href=\"$relpath^"+fn+"\">"+
              convertToHtml(toGroupDef(p->def)->groupTitle())+"</a>";
    }
    else if (p->def->definitionType()==Definition::TypePage &&
             toPageDef(p->def)->hasTitle())
    {
      result+="<a class=\"el\" href=\"$relpath^"+fn+"\">"+
            convertToHtml((toPageDef(p->def))->title())+"</a>";
    }
    else if (p->def->definitionType()==Definition::TypeClass)
    {
      QCString name = locName;
      if (name.endsWith("-p"))
      {
        name = name.left(name.length()-2);
      }
      result+="<a class=\"el\" href=\"$relpath^"+fn;
      if (!p->def->anchor().isEmpty()) result+="#"+p->def->anchor();
      result+="\">"+convertToHtml(name)+"</a>";
    }
    else
    {
      result+="<a class=\"el\" href=\"$relpath^"+fn+"\">"+
              convertToHtml(locName)+"</a>";
    }
  }
  else
  {
    result+="<b>"+convertToHtml(locName)+"</b>";
  }
  result+="</li>";
  return result;
}

References addHtmlExtensionIfMissing(), convertToHtml(), getOuterScope(), Doxygen::globalScope, GroupDef::groupTitle(), localName(), name(), Definition::navigationPathAsString(), p, toFileDef(), toGroupDef(), toPageDef(), Definition::TypeClass, Definition::TypeFile, Definition::TypeGroup, and Definition::TypePage.

Referenced by writeNavigationPath().

◆ operator=() [1/2]

DefinitionImpl & DefinitionImpl::operator= ( const DefinitionImpl & d )

Definition at line 261 of file definition.cpp.

{
  if (this!=&other)
  {
    p = std::make_unique<Private>(*other.p);
  }
  return *this;
}

References DefinitionImpl(), and p.

◆ operator=() [2/2]

DefinitionImpl & DefinitionImpl::operator= ( DefinitionImpl && d )

delete

References abbreviate(), briefFile(), briefLine(), DefinitionImpl(), docFile(), docLine(), FALSE, name(), stripWhiteSpace(), and TRUE.

◆ partOfGroups()

const GroupList & DefinitionImpl::partOfGroups ( ) const

Definition at line 1649 of file definition.cpp.

{
  return p->partOfGroups;
}

References p.

Referenced by isLinkableViaGroup().

◆ pathFragment()

QCString DefinitionImpl::pathFragment ( ) const

Definition at line 1334 of file definition.cpp.

{
  QCString result;
  if (p->outerScope && p->outerScope!=Doxygen::globalScope)
  {
    result = p->outerScope->pathFragment();
  }
  if (p->def->isLinkable())
  {
    if (!result.isEmpty()) result+="/";
    if (p->def->definitionType()==Definition::TypeGroup &&
        !toGroupDef(p->def)->groupTitle().isEmpty())
    {
      result+=toGroupDef(p->def)->groupTitle();
    }
    else if (p->def->definitionType()==Definition::TypePage &&
        toPageDef(p->def)->hasTitle())
    {
      result+=toPageDef(p->def)->title();
    }
    else
    {
      result+=p->localName;
    }
  }
  else
  {
    result+=p->localName;
  }
  return result;
}

References Doxygen::globalScope, GroupDef::groupTitle(), QCString::isEmpty(), p, PageDef::title(), toGroupDef(), toPageDef(), Definition::TypeGroup, and Definition::TypePage.

◆ qualifiedName()

QCString DefinitionImpl::qualifiedName ( ) const

Definition at line 1219 of file definition.cpp.

{
  std::lock_guard<std::recursive_mutex> lock(g_qualifiedNameMutex);
  if (!p->qualifiedName.isEmpty())
  {
    return p->qualifiedName;
  }
 
  //printf("start %s::qualifiedName() localName=%s\n",qPrint(name()),qPrint(p->localName));
  if (p->outerScope==nullptr)
  {
    if (p->localName=="<globalScope>")
    {
      return "";
    }
    else
    {
      return p->localName;
    }
  }
 
  if (p->outerScope->name()=="<globalScope>")
  {
    p->qualifiedName = p->localName;
  }
  else
  {
    p->qualifiedName = p->outerScope->qualifiedName()+
           getLanguageSpecificSeparator(getLanguage())+
           p->localName;
  }
  //printf("end %s::qualifiedName()=%s\n",qPrint(name()),qPrint(p->qualifiedName));
  //count--;
  return p->qualifiedName;
}

References g_qualifiedNameMutex, getLanguage(), getLanguageSpecificSeparator(), and p.

◆ setArtificial()

void DefinitionImpl::setArtificial ( bool b )

Definition at line 1738 of file definition.cpp.

{
  p->isArtificial = b;
}

References p.

◆ setBodyDef()

void DefinitionImpl::setBodyDef ( const FileDef * fd )

Definition at line 996 of file definition.cpp.

{
  if (!p->body.has_value())
  {
    p->body = std::make_optional<BodyInfo>();
  }
  p->body.value().fileDef=fd;
}

References p.

◆ setBodySegment()

void DefinitionImpl::setBodySegment	(	int	defLine,
		int	bls,
		int	ble )

Definition at line 984 of file definition.cpp.

{
  if (!p->body.has_value())
  {
    p->body = std::make_optional<BodyInfo>();
  }
  BodyInfo &body = p->body.value();
  body.defLine   = defLine;
  body.startLine = bls;
  body.endLine   = ble;
}

References BodyInfo::defLine, BodyInfo::endLine, p, and BodyInfo::startLine.

◆ setBriefDescription()

void DefinitionImpl::setBriefDescription	(	const QCString &	b,
		const QCString &	briefFile,
		int	briefLine )

Definition at line 496 of file definition.cpp.

{
  if (b.isEmpty()) return;
  _setBriefDescription(b,briefFile,briefLine);
}

References _setBriefDescription(), briefFile(), briefLine(), and QCString::isEmpty().

◆ setDefFile()

void DefinitionImpl::setDefFile	(	const QCString &	df,
		int	defLine,
		int	defColumn )

Definition at line 150 of file definition.cpp.

{
  p->setDefFileName(df);
  p->defLine = defLine;
  p->defColumn = defCol;
}

References p.

◆ setDocumentation()

void DefinitionImpl::setDocumentation	(	const QCString &	d,
		const QCString &	docFile,
		int	docLine,
		bool	stripWhiteSpace = TRUE )

Definition at line 433 of file definition.cpp.

{
  if (d.isEmpty()) return;
  _setDocumentation(d,docFile,docLine,stripWhiteSpace,FALSE);
}

References _setDocumentation(), docFile(), docLine(), FALSE, QCString::isEmpty(), and stripWhiteSpace().

◆ setExported()

void DefinitionImpl::setExported ( bool b )

Definition at line 1743 of file definition.cpp.

{
  p->isExported = b;
}

References p.

◆ setHidden()

void DefinitionImpl::setHidden ( bool b )

Definition at line 1733 of file definition.cpp.

{
  p->hidden = p->hidden || b;
}

References p.

◆ setId()

void DefinitionImpl::setId ( const QCString & name )

Definition at line 287 of file definition.cpp.

{
  if (id.isEmpty()) return;
  p->id = id;
  if (Doxygen::clangUsrMap)
  {
    //printf("DefinitionImpl::setId '%s'->'%s'\n",id,qPrint(p->name));
    Doxygen::clangUsrMap->emplace(id.str(),p->def);
  }
}

References Doxygen::clangUsrMap, id(), and p.

◆ setInbodyDocumentation()

void DefinitionImpl::setInbodyDocumentation	(	const QCString &	d,
		const QCString &	docFile,
		int	docLine )

Definition at line 521 of file definition.cpp.

{
  if (d.isEmpty()) return;
  _setInbodyDocumentation(d,inbodyFile,inbodyLine);
}

References _setInbodyDocumentation(), inbodyFile(), inbodyLine(), and QCString::isEmpty().

◆ setLanguage()

void DefinitionImpl::setLanguage ( SrcLangExt lang )

Definition at line 1753 of file definition.cpp.

{
  p->lang=lang;
}

References p.

◆ setLocalName()

void DefinitionImpl::setLocalName ( const QCString & name )

Definition at line 1748 of file definition.cpp.

{
  p->localName=name;
}

References name(), and p.

◆ setName()

void DefinitionImpl::setName ( const QCString & name )

Definition at line 278 of file definition.cpp.

{
  if (name.isEmpty()) return;
  p->name = name;
  p->isAnonymous = p->name.isEmpty() ||
                        p->name.at(0)=='@' ||
                        p->name.find("::@")!=-1;
}

References name(), and p.

Referenced by DefinitionImpl().

◆ setOuterScope()

void DefinitionImpl::setOuterScope ( Definition * d )

Definition at line 1255 of file definition.cpp.

{
  std::lock_guard<std::recursive_mutex> lock(g_qualifiedNameMutex);
  //printf("%s::setOuterScope(%s)\n",qPrint(name()),d?qPrint(d->name()):"<none>");
  Definition *outerScope = p->outerScope;
  bool found=false;
  // make sure that we are not creating a recursive scope relation.
  while (outerScope && !found)
  {
    found = (outerScope==d);
    outerScope = outerScope->getOuterScope();
  }
  if (!found)
  {
    p->qualifiedName.clear(); // flush cached scope name
    p->outerScope = d;
  }
  p->hidden = p->hidden || d->isHidden();
  assert(p->def!=p->outerScope);
}

References found, g_qualifiedNameMutex, Definition::getOuterScope(), Definition::isHidden(), and p.

◆ setReference()

void DefinitionImpl::setReference ( const QCString & r )

Definition at line 1723 of file definition.cpp.

{
  p->ref=r;
}

References p.

◆ setRefItems()

void DefinitionImpl::setRefItems ( const RefItemVector & sli )

Definition at line 1286 of file definition.cpp.

{
  p->xrefListItems.insert(p->xrefListItems.end(), sli.cbegin(), sli.cend());
}

References p.

◆ symbolName()

QCString DefinitionImpl::symbolName ( ) const

Definition at line 1458 of file definition.cpp.

{
  return p->symbolName;
}

References p.

Referenced by addToMap().

◆ writeDocAnchorsToTagFile()

void DefinitionImpl::writeDocAnchorsToTagFile ( TextStream & tagFile ) const

Definition at line 340 of file definition.cpp.

{
  if (!p->sectionRefs.empty())
  {
    //printf("%s: writeDocAnchorsToTagFile(%d)\n",qPrint(name()),p->sectionRef.size());
    for (const SectionInfo *si : p->sectionRefs)
    {
      if (!si->generated() && si->ref().isEmpty() && !AnchorGenerator::instance().isGenerated(si->label().str()))
      {
        //printf("write an entry!\n");
        if (p->def->definitionType()==Definition::TypeMember) tagFile << "  ";
        QCString fn = si->fileName();
        addHtmlExtensionIfMissing(fn);
        tagFile << "    <docanchor file=\"" << fn << "\"";
        if (!si->title().isEmpty())
        {
          tagFile << " title=\"" << convertToXML(si->title()) << "\"";
        }
        tagFile << ">" << si->label() << "</docanchor>\n";
      }
    }
  }
}

References addHtmlExtensionIfMissing(), convertToXML(), SectionInfo::fileName(), SectionInfo::generated(), AnchorGenerator::instance(), QCString::isEmpty(), SectionInfo::label(), p, SectionInfo::ref(), QCString::str(), SectionInfo::title(), and Definition::TypeMember.

◆ writeInlineCode()

void DefinitionImpl::writeInlineCode	(	OutputList &	ol,
		const QCString &	scopeName ) const

Write code of this definition into the documentation

Definition at line 1013 of file definition.cpp.

{
  const MemberDef *thisMd = nullptr;
  if (p->def->definitionType()==Definition::TypeMember)
  {
    thisMd = toMemberDef(p->def);
  }
  bool inlineSources = thisMd && thisMd->hasInlineSource();
  //printf("Source Fragment %s: %d-%d\n",qPrint(name()),
  //        p->body->startLine,p->body->endLine);
  if (inlineSources && hasSources())
  {
    ol.pushGeneratorState();
    QCString codeFragment;
    bool isMacro = thisMd && thisMd->memberType()==MemberType::Define;
    int actualStart=p->body->startLine,actualEnd=p->body->endLine;
    if (readCodeFragment(p->body->fileDef->absFilePath(),isMacro,
          actualStart,actualEnd,codeFragment)
       )
    {
      //printf("Adding code fragment '%s' ext='%s' range=%d-%d\n",
      //    qPrint(codeFragment),qPrint(p->defFileExt),actualStart,actualEnd);
      auto intf = Doxygen::parserManager->getCodeParser(p->defFileExt);
      intf->resetCodeParserState();
      //printf("Read:\n'%s'\n\n",qPrint(codeFragment));
 
      auto &codeOL = ol.codeGenerators();
      codeOL.startCodeFragment("DoxyCode");
      intf->parseCode(codeOL,           // codeOutIntf
                      scopeName,        // scope
                      codeFragment,     // input
                      p->lang,     // lang
                      Config_getBool(STRIP_CODE_COMMENTS),
                      FALSE,            // isExample
                      QCString(),       // exampleName
                      p->body->fileDef,  // fileDef
                      actualStart,      // startLine
                      actualEnd,        // endLine
                      TRUE,             // inlineFragment
                      thisMd,           // memberDef
                      TRUE              // show line numbers
                     );
      codeOL.endCodeFragment("DoxyCode");
    }
    ol.popGeneratorState();
  }
}

References OutputList::codeGenerators(), Config_getBool, Define, FALSE, MemberDef::hasInlineSource(), hasSources(), MemberDef::memberType(), p, Doxygen::parserManager, OutputList::popGeneratorState(), OutputList::pushGeneratorState(), readCodeFragment(), OutputCodeList::startCodeFragment(), toMemberDef(), TRUE, and Definition::TypeMember.

◆ writeNavigationPath()

void DefinitionImpl::writeNavigationPath ( OutputList & ol ) const

Definition at line 1429 of file definition.cpp.

{
  ol.pushGeneratorState();
  ol.disableAllBut(OutputType::Html);
 
  QCString navPath;
  navPath += "<div id=\"nav-path\" class=\"navpath\">\n"
             "  <ul>\n";
  navPath += navigationPathAsString();
  navPath += "  </ul>\n"
             "</div>\n";
  ol.writeNavigationPath(navPath);
 
  ol.popGeneratorState();
}

References OutputList::disableAllBut(), Html, navigationPathAsString(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), and OutputList::writeNavigationPath().

◆ writeQuickMemberLinks()

void DefinitionImpl::writeQuickMemberLinks	(	OutputList &	,
		const MemberDef *	) const

Definition at line 1817 of file definition.cpp.

1818{

1819}

◆ writeSourceDef()

void DefinitionImpl::writeSourceDef ( OutputList & ol ) const

Write a reference to the source code defining this definition

Definition at line 935 of file definition.cpp.

{
  //printf("DefinitionImpl::writeSourceRef %d %p\n",bodyLine,bodyDef);
  QCString fn = getSourceFileBase();
  if (!fn.isEmpty())
  {
    QCString refText = theTranslator->trDefinedAtLineInSourceFile();
    int lineMarkerPos = refText.find("@0");
    int fileMarkerPos = refText.find("@1");
    if (lineMarkerPos!=-1 && fileMarkerPos!=-1) // should always pass this.
    {
      QCString lineStr;
      lineStr.sprintf("%d",p->body->defLine);
      QCString anchorStr = getSourceAnchor();
      ol.startParagraph("definition");
      if (lineMarkerPos<fileMarkerPos) // line marker before file marker
      {
        // write text left from linePos marker
        ol.parseText(refText.left(lineMarkerPos));
        ol.writeObjectLink(QCString(),fn,anchorStr,lineStr);
        // write text between markers
        ol.parseText(refText.mid(lineMarkerPos+2,fileMarkerPos-lineMarkerPos-2));
        // write file link
        ol.writeObjectLink(QCString(),fn,QCString(),p->body->fileDef->name());
        // write text right from file marker
        ol.parseText(refText.right(refText.length()-static_cast<size_t>(fileMarkerPos)-2));
      }
      else // file marker before line marker
      {
        // write text left from file marker
        ol.parseText(refText.left(fileMarkerPos));
        // write file link
        ol.writeObjectLink(QCString(),fn,QCString(),p->body->fileDef->name());
        // write text between markers
        ol.parseText(refText.mid(fileMarkerPos+2,lineMarkerPos-fileMarkerPos-2));
        // write line link
        ol.writeObjectLink(QCString(),fn,anchorStr,lineStr);
        // write text right from linePos marker
        ol.parseText(refText.right(refText.length()-static_cast<size_t>(lineMarkerPos)-2));
      }
      ol.endParagraph();
    }
    else
    {
      err("translation error: invalid markers in trDefinedAtLineInSourceFile()\n");
    }
  }
}

References OutputList::endParagraph(), err, QCString::find(), getSourceAnchor(), getSourceFileBase(), QCString::isEmpty(), QCString::left(), QCString::length(), QCString::mid(), p, OutputList::parseText(), QCString::right(), QCString::sprintf(), OutputList::startParagraph(), theTranslator, and OutputList::writeObjectLink().

◆ writeSourceReffedBy()

void DefinitionImpl::writeSourceReffedBy	(	OutputList &	ol,
		const QCString &	scopeName ) const

Definition at line 1147 of file definition.cpp.

{
  _writeSourceRefList(ol,scopeName,theTranslator->trReferencedBy(),p->sourceRefByDict,FALSE);
}

References _writeSourceRefList(), FALSE, p, and theTranslator.

◆ writeSourceRefs()

void DefinitionImpl::writeSourceRefs	(	OutputList &	ol,
		const QCString &	scopeName ) const

Definition at line 1152 of file definition.cpp.

{
  _writeSourceRefList(ol,scopeName,theTranslator->trReferences(),p->sourceRefsDict,TRUE);
}

References _writeSourceRefList(), p, theTranslator, and TRUE.

◆ writeSummaryLinks()

void DefinitionImpl::writeSummaryLinks ( OutputList & ) const

Definition at line 1821 of file definition.cpp.

1822{

1823}

◆ writeToc()

void DefinitionImpl::writeToc	(	OutputList &	ol,
		const LocalToc &	lt ) const

Definition at line 1445 of file definition.cpp.

{
  if (p->sectionRefs.empty()) return;
  ol.writeLocalToc(p->sectionRefs,localToc);
}

References p, and OutputList::writeLocalToc().

◆ xrefListItems()

const RefItemVector & DefinitionImpl::xrefListItems ( ) const

Definition at line 1329 of file definition.cpp.

{
  return p->xrefListItems;
}

References p.

Member Data Documentation

◆ p

std::unique_ptr<Private> DefinitionImpl::p

private

Definition at line 143 of file definitionimpl.h.

Referenced by _getXRefListId(), _setBriefDescription(), _setInbodyDocumentation(), _setSymbolName(), _symbolName(), _writeSourceRefList(), addSectionsToDefinition(), addSourceReferencedBy(), addSourceReferences(), briefDescription(), briefDescriptionAsTooltip(), briefFile(), briefLine(), computeTooltip(), DefinitionImpl(), DefinitionImpl(), docFile(), docLine(), documentation(), getBodyDef(), getDefColumn(), getDefFileExtension(), getDefFileName(), getDefLine(), getEndBodyLine(), getLanguage(), getOuterScope(), getReference(), getReferencedByMembers(), getReferencesMembers(), getSectionRefs(), getSourceAnchor(), getSourceFileBase(), getStartBodyLine(), getStartDefLine(), hasDocumentation(), hasSections(), hasSourceReffedBy(), hasSourceRefs(), hasSources(), hasUserDocumentation(), inbodyDocumentation(), inbodyFile(), inbodyLine(), isAnonymous(), isArtificial(), isExported(), isHidden(), isReference(), isVisible(), isVisibleInProject(), localName(), makePartOfGroup(), mergeReferencedBy(), mergeReferences(), mergeRefItems(), name(), navigationPathAsString(), operator=(), partOfGroups(), pathFragment(), qualifiedName(), setArtificial(), setBodyDef(), setBodySegment(), setDefFile(), setExported(), setHidden(), setId(), setLanguage(), setLocalName(), setName(), setOuterScope(), setReference(), setRefItems(), symbolName(), toDefinition(), writeDocAnchorsToTagFile(), writeInlineCode(), writeSourceDef(), writeSourceReffedBy(), writeSourceRefs(), writeToc(), xrefListItems(), and ~DefinitionImpl().

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

src/definitionimpl.h
src/definition.cpp

Classes

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DefinitionImpl() [1/3]

◆ ~DefinitionImpl()

◆ DefinitionImpl() [2/3]

◆ DefinitionImpl() [3/3]

Member Function Documentation

◆ _docsAlreadyAdded()

◆ _getXRefListId()

◆ _setBriefDescription()

◆ _setDocumentation()

◆ _setInbodyDocumentation()

◆ _setSymbolName()

◆ _symbolName()

◆ _writeSourceRefList()

◆ addInnerCompound()

◆ addSectionsToDefinition()

◆ addSourceReferencedBy()

◆ addSourceReferences()

◆ briefDescription()

◆ briefDescriptionAsTooltip()

◆ briefFile()

◆ briefLine()

◆ computeTooltip()

◆ docFile()

◆ docLine()

◆ documentation()

◆ externalReference()

◆ findInnerCompound()

◆ getBodyDef()

◆ getDefColumn()

◆ getDefFileExtension()

◆ getDefFileName()

◆ getDefLine()

◆ getEndBodyLine()

◆ getLanguage()

◆ getOuterScope()

◆ getReference()

◆ getReferencedByMembers()

◆ getReferencesMembers()

◆ getSectionRefs()

◆ getSourceAnchor()

◆ getSourceFileBase()

◆ getStartBodyLine()

◆ getStartDefLine()

◆ hasBriefDescription()

◆ hasDocumentation()

◆ hasSections()

◆ hasSourceReffedBy()

◆ hasSourceRefs()

◆ hasSources()

◆ hasUserDocumentation()

◆ id()

◆ inbodyDocumentation()

◆ inbodyFile()

◆ inbodyLine()

◆ isAnonymous()

◆ isArtificial()

◆ isExported()

◆ isHidden()

◆ isLinkableViaGroup()

◆ isReference()

◆ isVisible()

◆ isVisibleInProject()

◆ localName()

◆ makePartOfGroup()

◆ mergeReferencedBy()

◆ mergeReferences()

◆ mergeRefItems()

◆ name()

◆ navigationPathAsString()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ partOfGroups()

◆ pathFragment()

◆ qualifiedName()