DefinitionImpl Class Reference

#include <src/definitionimpl.h>

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

Public Member Functions
	DefinitionImpl (Definition *def, const DString &defFileName, int defLine, int defColumn, const DString &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 DString &	name () const
bool	isAnonymous () const
const DString &	localName () const
DString	qualifiedName () const
DString	symbolName () const
DString	getSourceFileBase () const
DString	getSourceAnchor () const
DString	documentation () const
int	docLine () const
DString	docFile () const
DString	briefDescription (bool abbreviate=false) const
DString	briefDescriptionAsTooltip () const
int	briefLine () const
DString	inbodyDocumentation () const
DString	inbodyFile () const
int	inbodyLine () const
DString	briefFile () const
DString	getDefFileName () const
DString	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
DString	getReference () const
bool	isReference () const
DString	externalReference (const DString &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 RequirementRefs &	requirementReferences () const
const Definition *	findInnerCompound (const DString &name) const
Definition *	getOuterScope () const
const MemberVector &	getReferencesMembers () const
const MemberVector &	getReferencedByMembers () const
bool	hasSections () const
bool	hasSources () const
bool	hasBriefDescription () const
DString	id () const
const SectionRefs &	getSectionRefs () const
void	setName (const DString &name)
void	setId (const DString &name)
void	setDefFile (const DString &df, int defLine, int defColumn)
void	setDocumentation (const DString &d, const DString &docFile, int docLine, bool stripWhiteSpace=true)
void	setBriefDescription (const DString &b, const DString &briefFile, int briefLine)
void	setInbodyDocumentation (const DString &d, const DString &docFile, int docLine)
void	setReference (const DString &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 DString &sourceRefName)
void	addSourceReferences (MemberDef *d, const DString &sourceRefName)
void	setRefItems (const RefItemVector &sli)
void	setRequirementReferences (const RequirementRefs &rqli)
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 DString &scopeName) const
bool	hasSourceRefs () const
bool	hasSourceReffedBy () const
void	writeSourceRefs (OutputList &ol, const DString &scopeName) const
void	writeSourceReffedBy (OutputList &ol, const DString &scopeName) const
bool	hasRequirementRefs () const
void	writeRequirementRefs (OutputList &ol) const
void	makePartOfGroup (GroupDef *gd)
void	writeNavigationPath (OutputList &ol) const
DString	navigationPathAsString () const
void	writeQuickMemberLinks (OutputList &, const MemberDef *) const
void	writeSummaryLinks (OutputList &) const
void	writePageNavigation (OutputList &ol) const
DString	pathFragment () const
void	writeDocAnchorsToTagFile (TextStream &) const
void	setLocalName (const DString &name)
void	writeToc (OutputList &ol, const LocalToc &lt) const
void	computeTooltip ()
void	_setSymbolName (const DString &name)
DString	_symbolName () const

Private Member Functions
int	_getXRefListId (const DString &listName) const
void	_writeSourceRefList (OutputList &ol, const DString &scopeName, const DString &text, const std::unordered_map< std::string, MemberDef * > &members, bool) const
void	_setBriefDescription (const DString &b, const DString &briefFile, int briefLine)
void	_setDocumentation (const DString &d, const DString &docFile, int docLine, bool stripWhiteSpace, bool atTop)
void	_setInbodyDocumentation (const DString &d, const DString &docFile, int docLine)
bool	_docsAlreadyAdded (const DString &doc, DString &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 DString &	defFileName,
		int	defLine,
		int	defColumn,
		const DString &	name,
		const char *	b = nullptr,
		const char *	d = nullptr,
		bool	isSymbol = true )

Definition at line 250 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(), matchExcludedSymbols(), name(), p, and setName().

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

~DefinitionImpl()

DefinitionImpl::~DefinitionImpl

(

)

Definition at line 286 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 271 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 DString & doc, DString & sigList )

private

Definition at line 379 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...
  DString 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)==DString::npos) // new docs, add signature to prevent re-adding it
  {
    sigList+=DString(":")+sigStr;
    return false;
  }
  else
  {
    return true;
  }
}

References DString::data(), DString::DString(), DString::find(), DString::length(), DString::npos, and DString::simplifyWhiteSpace().

Referenced by _setBriefDescription(), _setDocumentation(), _setInbodyDocumentation(), and operator=().

_getXRefListId()

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

private

Definition at line 1370 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.

Referenced by operator=().

_setBriefDescription()

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

private

Definition at line 454 of file definition.cpp.

{
  DString brief = b;
  brief = brief.stripWhiteSpace();
  brief = stripLeadingAndTrailingEmptyLines(brief,briefLine);
  brief = brief.stripWhiteSpace();
  if (brief.empty()) 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 ':': break;
        default:
          if (isUTF8CharUpperCase(brief.str(),0) && !lastUTF8CharIsMultibyte(brief.str())) brief+='.';
          break;
      }
    }
  }
 
  if (!_docsAlreadyAdded(brief,p->briefSignatures))
  {
    if (p->brief && !p->brief->doc.empty())
    {
       //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(), DString::at(), briefFile(), briefLine(), BriefInfo::doc, DString::empty(), BriefInfo::file, isUTF8CharUpperCase(), lastUTF8CharIsMultibyte(), DString::length(), BriefInfo::line, Translator::needsPunctuation(), p, DString::str(), stripLeadingAndTrailingEmptyLines(), DString::stripWhiteSpace(), and theTranslator.

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

_setDocumentation()

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

private

Definition at line 401 of file definition.cpp.

{
  //printf("%s::setDocumentation(%s,%s,%d,%d)\n",qPrint(name()),d,docFile,docLine,stripWhiteSpace);
  if (d.empty()) return;
  DString 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.empty()) // 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 _docsAlreadyAdded(), docFile(), docLine(), DString::empty(), p, stripLeadingAndTrailingEmptyLines(), and stripWhiteSpace().

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

_setInbodyDocumentation()

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

private

Definition at line 517 of file definition.cpp.

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

References _docsAlreadyAdded(), DocInfo::doc, DString::DString(), DString::empty(), DocInfo::file, inbodyFile(), inbodyLine(), DocInfo::line, and p.

Referenced by operator=(), and setInbodyDocumentation().

_setSymbolName()

void DefinitionImpl::_setSymbolName

(

const DString &

name

)

Definition at line 1874 of file definition.cpp.

{
  p->symbolName=name;
}

References name(), and p.

Referenced by DefinitionMixin< Base >::_setSymbolName(), and operator=().

_symbolName()

DString DefinitionImpl::_symbolName

(

)

const

Definition at line 1879 of file definition.cpp.

{
  return p->symbolName;
}

References p.

Referenced by DefinitionMixin< Base >::_symbolName(), and operator=().

_writeSourceRefList()

void DefinitionImpl::_writeSourceRefList ( OutputList & ol, const DString & scopeName, const DString & 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 1113 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)
      {
        DString scope=md->getScopeString();
        DString name=md->name();
        //printf("class=%p scope=%s scopeName=%s\n",md->getClassDef(),qPrint(scope),scopeName);
        if (!scope.empty() && 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];
          snprintf(anchorStr,maxLineNrStr,"l%05d",md->getStartBodyLine());
          //printf("Write object link to %s\n",qPrint(md->getBodyDef()->getSourceFileBase()));
          ol.writeObjectLink(DString(),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(), DString::DString(), DString::empty(), OutputList::endParagraph(), Definition::getBodyDef(), getLanguageSpecificSeparator(), Definition::getOutputFileBase(), Definition::getReference(), MemberDef::getScopeString(), Definition::getSourceFileBase(), Definition::getStartBodyLine(), MemberDef::isFunction(), Definition::isLinkable(), MemberDef::isObjCMethod(), MemberDef::isPrototype(), MemberDef::isSignal(), MemberDef::isSlot(), Definition::name(), name(), p, OutputList::parseText(), DString::prepend(), refMapToVector(), OutputList::startParagraph(), DString::str(), theTranslator, Translator::trWriteList(), writeMarkerList(), OutputList::writeObjectLink(), and OutputList::writeString().

Referenced by operator=(), writeSourceReffedBy(), and writeSourceRefs().

addInnerCompound()

void DefinitionImpl::addInnerCompound

(

Definition *

d

)

Definition at line 1278 of file definition.cpp.

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

References err.

Referenced by DefinitionMixin< Base >::addInnerCompound(), and operator=().

addSectionsToDefinition()

void DefinitionImpl::addSectionsToDefinition

(

const std::vector< const SectionInfo * > &

anchorList

)

Definition at line 319 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()),(void*)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().

Referenced by DefinitionMixin< Base >::addSectionsToDefinition(), and operator=().

addSourceReferencedBy()

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

Definition at line 1257 of file definition.cpp.

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

References p, and DString::str().

Referenced by DefinitionMixin< Base >::addSourceReferencedBy(), and operator=().

addSourceReferences()

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

Definition at line 1265 of file definition.cpp.

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

References p, and DString::str().

Referenced by DefinitionMixin< Base >::addSourceReferences(), and operator=().

briefDescription()

DString DefinitionImpl::briefDescription

(

bool

abbreviate = false

)

const

Definition at line 1645 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) :
         DString("");
}

References abbreviate(), DString::DString(), and p.

Referenced by DefinitionMixin< Base >::briefDescription(), hasBriefDescription(), and operator=().

briefDescriptionAsTooltip()

DString DefinitionImpl::briefDescriptionAsTooltip

(

)

const

Definition at line 1664 of file definition.cpp.

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

References DString::DString(), and p.

Referenced by DefinitionMixin< Base >::briefDescriptionAsTooltip(), and operator=().

briefFile()

DString DefinitionImpl::briefFile

(

)

const

Definition at line 1674 of file definition.cpp.

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

References DString::DString(), and p.

Referenced by _setBriefDescription(), DefinitionMixin< Base >::briefFile(), operator=(), and setBriefDescription().

briefLine()

int DefinitionImpl::briefLine

(

)

const

Definition at line 1669 of file definition.cpp.

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

References p.

Referenced by _setBriefDescription(), DefinitionMixin< Base >::briefLine(), operator=(), and setBriefDescription().

computeTooltip()

void DefinitionImpl::computeTooltip

(

)

Definition at line 1653 of file definition.cpp.

{
  if (p->brief && p->brief->tooltip.empty() && !p->brief->doc.empty())
  {
    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.

Referenced by DefinitionMixin< Base >::computeTooltip(), and operator=().

docFile()

DString DefinitionImpl::docFile

(

)

const

Definition at line 1591 of file definition.cpp.

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

References p.

Referenced by _setDocumentation(), DefinitionMixin< Base >::docFile(), operator=(), setDocumentation(), and writeToc().

docLine()

int DefinitionImpl::docLine

(

)

const

Definition at line 1586 of file definition.cpp.

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

References p.

Referenced by _setDocumentation(), DefinitionMixin< Base >::docLine(), operator=(), and setDocumentation().

documentation()

DString DefinitionImpl::documentation

(

)

const

Definition at line 1581 of file definition.cpp.

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

References DString::DString(), and p.

Referenced by DefinitionMixin< Base >::documentation(), and operator=().

externalReference()

DString DefinitionImpl::externalReference

(

const DString &

relPath

)

const

Definition at line 1890 of file definition.cpp.

{
  DString ref = getReference();
  if (!ref.empty())
  {
    auto it = Doxygen::tagDestinationMap.find(ref.str());
    if (it!=Doxygen::tagDestinationMap.end())
    {
      DString result(it->second);
      size_t l = result.length();
      if (!relPath.empty() && 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 DString::at(), DString::empty(), end(), getReference(), DString::length(), DString::prepend(), DString::str(), and Doxygen::tagDestinationMap.

Referenced by DefinitionMixin< Base >::externalReference(), and operator=().

findInnerCompound()

const Definition * DefinitionImpl::findInnerCompound

(

const DString &

name

)

const

Definition at line 1273 of file definition.cpp.

{
  return nullptr;
}

Referenced by DefinitionMixin< Base >::findInnerCompound(), and operator=().

getBodyDef()

const FileDef * DefinitionImpl::getBodyDef

(

)

const

Definition at line 1759 of file definition.cpp.

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

References p.

Referenced by DefinitionMixin< Base >::getBodyDef(), and operator=().

getDefColumn()

int DefinitionImpl::getDefColumn

(

)

const

Definition at line 1927 of file definition.cpp.

{
  return p->defColumn;
}

References p.

Referenced by DefinitionMixin< Base >::getDefColumn(), and operator=().

getDefFileExtension()

DString DefinitionImpl::getDefFileExtension

(

)

const

Definition at line 1704 of file definition.cpp.

{
  return p->defFileExt;
}

References p.

Referenced by DefinitionMixin< Base >::getDefFileExtension(), and operator=().

getDefFileName()

DString DefinitionImpl::getDefFileName

(

)

const

Definition at line 1699 of file definition.cpp.

{
  return p->defFileName;
}

References p.

Referenced by DefinitionMixin< Base >::getDefFileName(), and operator=().

getDefLine()

int DefinitionImpl::getDefLine

(

)

const

Definition at line 1922 of file definition.cpp.

{
  return p->defLine;
}

References p.

Referenced by DefinitionMixin< Base >::getDefLine(), and operator=().

getEndBodyLine()

int DefinitionImpl::getEndBodyLine

(

)

const

Definition at line 1754 of file definition.cpp.

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

References p.

Referenced by DefinitionMixin< Base >::getEndBodyLine(), and operator=().

getLanguage()

SrcLangExt DefinitionImpl::getLanguage

(

)

const

Definition at line 1843 of file definition.cpp.

{
  return p->lang;
}

References p.

Referenced by DefinitionMixin< Base >::getLanguage(), and operator=().

getOuterScope()

Definition * DefinitionImpl::getOuterScope

(

)

const

Definition at line 1778 of file definition.cpp.

{
  return p->outerScope;
}

References p.

Referenced by DefinitionMixin< Base >::getOuterScope(), navigationPathAsString(), and operator=().

getReference()

DString DefinitionImpl::getReference

(

)

const

Definition at line 1734 of file definition.cpp.

{
  return p->ref;
}

References p.

Referenced by externalReference(), DefinitionMixin< Base >::getReference(), and operator=().

getReferencedByMembers()

const MemberVector & DefinitionImpl::getReferencedByMembers

(

)

const

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

Referenced by DefinitionMixin< Base >::getReferencedByMembers(), and operator=().

getReferencesMembers()

const MemberVector & DefinitionImpl::getReferencesMembers

(

)

const

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

Referenced by DefinitionMixin< Base >::getReferencesMembers(), and operator=().

getSectionRefs()

const SectionRefs & DefinitionImpl::getSectionRefs

(

)

const

Definition at line 1569 of file definition.cpp.

{
  return p->sectionRefs;
}

References p.

Referenced by DefinitionMixin< Base >::getSectionRefs(), and operator=().

getSourceAnchor()

DString DefinitionImpl::getSourceAnchor

(

)

const

Definition at line 950 of file definition.cpp.

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

References p, and Htags::useHtags.

Referenced by DefinitionMixin< Base >::getSourceAnchor(), operator=(), and writeSourceDef().

getSourceFileBase()

DString DefinitionImpl::getSourceFileBase

(

)

const

Definition at line 937 of file definition.cpp.

{
  ASSERT(p->def->definitionType()!=Definition::TypeFile); // file overloads this method
  DString 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 DefinitionMixin< Base >::getSourceFileBase(), operator=(), and writeSourceDef().

getStartBodyLine()

int DefinitionImpl::getStartBodyLine

(

)

const

Definition at line 1749 of file definition.cpp.

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

References p.

Referenced by DefinitionMixin< Base >::getStartBodyLine(), operator=(), and writeToc().

getStartDefLine()

int DefinitionImpl::getStartDefLine

(

)

const

Definition at line 1744 of file definition.cpp.

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

References p.

Referenced by DefinitionMixin< Base >::getStartDefLine(), and operator=().

hasBriefDescription()

bool DefinitionImpl::hasBriefDescription

(

)

const

Definition at line 1884 of file definition.cpp.

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

References briefDescription(), Config_getBool, and DString::empty().

Referenced by DefinitionMixin< Base >::hasBriefDescription(), and operator=().

hasDocumentation()

bool DefinitionImpl::hasDocumentation

(

)

const

Definition at line 1233 of file definition.cpp.

{
  bool extractAll    = Config_getBool(EXTRACT_ALL);
  //bool sourceBrowser = Config_getBool(SOURCE_BROWSER);
  bool hasDocs =
         (p->details    && !p->details->doc.empty())    || // has detailed docs
         (p->brief      && !p->brief->doc.empty())      || // has brief description
         (p->inbodyDocs && !p->inbodyDocs->doc.empty()) || // 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.

Referenced by DefinitionMixin< Base >::hasDocumentation(), and operator=().

hasRequirementRefs()

bool DefinitionImpl::hasRequirementRefs

(

)

const

Definition at line 1228 of file definition.cpp.

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

References p.

Referenced by DefinitionMixin< Base >::hasRequirementRefs(), and operator=().

hasSections()

bool DefinitionImpl::hasSections

(

)

const

Definition at line 341 of file definition.cpp.

{
  //printf("DefinitionImpl::hasSections(%s) #sections=%zu\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 SectionType::isSection(), p, and SectionInfo::type().

Referenced by DefinitionMixin< Base >::hasSections(), and operator=().

hasSourceReffedBy()

bool DefinitionImpl::hasSourceReffedBy

(

)

const

Definition at line 1218 of file definition.cpp.

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

References p.

Referenced by DefinitionMixin< Base >::hasSourceReffedBy(), and operator=().

hasSourceRefs()

bool DefinitionImpl::hasSourceRefs

(

)

const

Definition at line 1223 of file definition.cpp.

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

References p.

Referenced by DefinitionMixin< Base >::hasSourceRefs(), and operator=().

hasSources()

bool DefinitionImpl::hasSources

(

)

const

Definition at line 1040 of file definition.cpp.

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

References p.

Referenced by DefinitionMixin< Base >::hasSources(), operator=(), and writeInlineCode().

hasUserDocumentation()

bool DefinitionImpl::hasUserDocumentation

(

)

const

Definition at line 1248 of file definition.cpp.

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

References p.

Referenced by DefinitionMixin< Base >::hasUserDocumentation(), and operator=().

id()

DString DefinitionImpl::id

(

)

const

Definition at line 314 of file definition.cpp.

{
  return p->id;
}

References p.

Referenced by DefinitionMixin< Base >::id(), operator=(), and setId().

inbodyDocumentation()

DString DefinitionImpl::inbodyDocumentation

(

)

const

Definition at line 1681 of file definition.cpp.

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

References DString::DString(), and p.

Referenced by DefinitionMixin< Base >::inbodyDocumentation(), and operator=().

inbodyFile()

DString DefinitionImpl::inbodyFile

(

)

const

Definition at line 1691 of file definition.cpp.

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

References DString::DString(), and p.

Referenced by _setInbodyDocumentation(), DefinitionMixin< Base >::inbodyFile(), operator=(), and setInbodyDocumentation().

inbodyLine()

int DefinitionImpl::inbodyLine

(

)

const

Definition at line 1686 of file definition.cpp.

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

References p.

Referenced by _setInbodyDocumentation(), DefinitionMixin< Base >::inbodyLine(), operator=(), and setInbodyDocumentation().

isAnonymous()

bool DefinitionImpl::isAnonymous

(

)

const

Definition at line 1917 of file definition.cpp.

{
  return p->isAnonymous;
}

References p.

Referenced by DefinitionMixin< Base >::isAnonymous(), and operator=().

isArtificial()

bool DefinitionImpl::isArtificial

(

)

const

Definition at line 1724 of file definition.cpp.

{
  return p->isArtificial;
}

References p.

Referenced by DefinitionMixin< Base >::isArtificial(), and operator=().

isExported()

bool DefinitionImpl::isExported

(

)

const

Definition at line 1729 of file definition.cpp.

{
  return p->isExported;
}

References p.

Referenced by DefinitionMixin< Base >::isExported(), and operator=().

isHidden()

bool DefinitionImpl::isHidden

(

)

const

Definition at line 1709 of file definition.cpp.

{
  return p->hidden;
}

References p.

Referenced by DefinitionMixin< Base >::isHidden(), and operator=().

isLinkableViaGroup()

bool DefinitionImpl::isLinkableViaGroup

(

)

const

Definition at line 1769 of file definition.cpp.

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

References partOfGroups().

Referenced by DefinitionMixin< Base >::isLinkableViaGroup(), and operator=().

isReference()

bool DefinitionImpl::isReference

(

)

const

Definition at line 1739 of file definition.cpp.

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

References p.

Referenced by DefinitionMixin< Base >::isReference(), and operator=().

isVisible()

bool DefinitionImpl::isVisible

(

)

const

Definition at line 1719 of file definition.cpp.

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

References p.

Referenced by DefinitionMixin< Base >::isVisible(), and operator=().

isVisibleInProject()

bool DefinitionImpl::isVisibleInProject

(

)

const

Definition at line 1714 of file definition.cpp.

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

References p.

Referenced by DefinitionMixin< Base >::isVisibleInProject(), and operator=().

localName()

const DString & DefinitionImpl::localName

(

)

const

Definition at line 1324 of file definition.cpp.

{
  return p->localName;
}

References p.

Referenced by DefinitionMixin< Base >::localName(), navigationPathAsString(), and operator=().

makePartOfGroup()

void DefinitionImpl::makePartOfGroup

(

GroupDef *

gd

)

Definition at line 1329 of file definition.cpp.

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

References p.

Referenced by DefinitionMixin< Base >::makePartOfGroup(), and operator=().

mergeReferencedBy()

void DefinitionImpl::mergeReferencedBy

(

const Definition *

other

)

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

Referenced by DefinitionMixin< Base >::mergeReferencedBy(), and operator=().

mergeReferences()

void DefinitionImpl::mergeReferences

(

const Definition *

other

)

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

Referenced by DefinitionMixin< Base >::mergeReferences(), and operator=().

mergeRefItems()

void DefinitionImpl::mergeRefItems

(

Definition *

d

)

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

Referenced by DefinitionMixin< Base >::mergeRefItems(), and operator=().

name()

const DString & DefinitionImpl::name

(

)

const

Definition at line 1912 of file definition.cpp.

{
  return p->name;
}

References p.

Referenced by _setSymbolName(), _writeSourceRefList(), addToMap(), DefinitionImpl(), matchExcludedSymbols(), DefinitionMixin< Base >::name(), navigationPathAsString(), operator=(), removeFromMap(), setLocalName(), and setName().

navigationPathAsString()

DString DefinitionImpl::navigationPathAsString

(

)

const

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

Definition at line 1430 of file definition.cpp.

{
  DString result;
  Definition *outerScope = getOuterScope();
  DString 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())
  {
    DString fn = p->def->getOutputFileBase();
    addHtmlExtensionIfMissing(fn);
    if (p->def->definitionType()==Definition::TypeGroup &&
        !toGroupDef(p->def)->groupTitle().empty())
    {
      DString title = parseCommentAsHtml(p->def,nullptr,toGroupDef(p->def)->groupTitle(),
                                          p->def->getDefFileName(),p->def->getDefLine());
      result+="<a href=\"$relpath^"+fn+"\">"+title+"</a>";
    }
    else if (p->def->definitionType()==Definition::TypePage &&
             toPageDef(p->def)->hasTitle())
    {
      DString title = parseCommentAsHtml(p->def,nullptr,toPageDef(p->def)->title(),
                                          p->def->getDefFileName(),p->def->getDefLine());
      result+="<a href=\"$relpath^"+fn+"\">"+title+"</a>";
    }
    else if (p->def->definitionType()==Definition::TypeClass)
    {
      DString name = toClassDef(p->def)->className();
      if (name.endsWith("-p"))
      {
        name = name.left(name.length()-2);
      }
      result+="<a href=\"$relpath^"+fn;
      if (!p->def->anchor().empty()) result+="#"+p->def->anchor();
      result+="\">"+convertToHtml(name)+"</a>";
    }
    else
    {
      result+="<a href=\"$relpath^"+fn+"\">"+
              convertToHtml(locName)+"</a>";
    }
  }
  else
  {
    result+="<b>"+convertToHtml(locName)+"</b>";
  }
  result+="</li>";
  return result;
}

References addHtmlExtensionIfMissing(), ClassDef::className(), convertToHtml(), DString::empty(), DString::endsWith(), FileDef::getDirDef(), getOuterScope(), Doxygen::globalScope, GroupDef::groupTitle(), PageDef::hasTitle(), DString::left(), DString::length(), localName(), name(), Definition::navigationPathAsString(), p, parseCommentAsHtml(), PageDef::title(), toClassDef(), toFileDef(), toGroupDef(), toPageDef(), Definition::TypeClass, Definition::TypeFile, Definition::TypeGroup, and Definition::TypePage.

Referenced by DefinitionMixin< Base >::navigationPathAsString(), operator=(), and writeNavigationPath().

operator=() [1/2]

DefinitionImpl & DefinitionImpl::operator=

(

const DefinitionImpl &

d

)

Definition at line 277 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 _docsAlreadyAdded(), _getXRefListId(), _setBriefDescription(), _setDocumentation(), _setInbodyDocumentation(), _setSymbolName(), _symbolName(), _writeSourceRefList(), addInnerCompound(), addSectionsToDefinition(), addSourceReferencedBy(), addSourceReferences(), briefDescription(), briefDescriptionAsTooltip(), briefFile(), briefLine(), computeTooltip(), DefinitionImpl(), docFile(), docLine(), documentation(), externalReference(), findInnerCompound(), getBodyDef(), getDefColumn(), getDefFileExtension(), getDefFileName(), getDefLine(), getEndBodyLine(), getLanguage(), getOuterScope(), getReference(), getReferencedByMembers(), getReferencesMembers(), getSectionRefs(), getSourceAnchor(), getSourceFileBase(), getStartBodyLine(), getStartDefLine(), hasBriefDescription(), hasDocumentation(), hasRequirementRefs(), hasSections(), hasSourceReffedBy(), hasSourceRefs(), hasSources(), hasUserDocumentation(), id(), inbodyDocumentation(), inbodyFile(), inbodyLine(), isAnonymous(), isArtificial(), isExported(), isHidden(), isLinkableViaGroup(), isReference(), isVisible(), isVisibleInProject(), localName(), makePartOfGroup(), mergeReferencedBy(), mergeReferences(), mergeRefItems(), name(), navigationPathAsString(), partOfGroups(), pathFragment(), qualifiedName(), requirementReferences(), setArtificial(), setBodyDef(), setBodySegment(), setBriefDescription(), setDefFile(), setDocumentation(), setExported(), setHidden(), setId(), setInbodyDocumentation(), setLanguage(), setLocalName(), setName(), setOuterScope(), setReference(), setRefItems(), setRequirementReferences(), stripWhiteSpace(), symbolName(), writeDocAnchorsToTagFile(), writeInlineCode(), writeNavigationPath(), writePageNavigation(), writeQuickMemberLinks(), writeRequirementRefs(), writeSourceDef(), writeSourceReffedBy(), writeSourceRefs(), writeSummaryLinks(), writeToc(), and xrefListItems().

partOfGroups()

const GroupList & DefinitionImpl::partOfGroups

(

)

const

Definition at line 1764 of file definition.cpp.

{
  return p->partOfGroups;
}

References p.

Referenced by isLinkableViaGroup(), operator=(), and DefinitionMixin< Base >::partOfGroups().

pathFragment()

DString DefinitionImpl::pathFragment

(

)

const

Definition at line 1392 of file definition.cpp.

{
  DString result;
  if (p->outerScope && p->outerScope!=Doxygen::globalScope)
  {
    result = p->outerScope->pathFragment();
  }
  if (p->def->isLinkable())
  {
    if (!result.empty()) result+="/";
    if (p->def->definitionType()==Definition::TypeGroup &&
        !toGroupDef(p->def)->groupTitle().empty())
    {
      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 DString::empty(), Doxygen::globalScope, GroupDef::groupTitle(), PageDef::hasTitle(), p, PageDef::title(), toGroupDef(), toPageDef(), Definition::TypeGroup, and Definition::TypePage.

Referenced by operator=(), and DefinitionMixin< Base >::pathFragment().

qualifiedName()

DString DefinitionImpl::qualifiedName

(

)

const

Definition at line 1283 of file definition.cpp.

{
  std::call_once(p->qualifiedNameOnce.flag, [this]()
  {
    //printf("start %s::qualifiedName() localName=%s\n",qPrint(name()),qPrint(p->localName));
    if (p->outerScope==nullptr || p->outerScope->name()=="<globalScope>")
    {
      p->qualifiedName = (p->localName=="<globalScope>") ? DString() : p->localName;
    }
    else
    {
      p->qualifiedName = p->outerScope->qualifiedName()+
             getLanguageSpecificSeparator(getLanguage())+
             p->localName;
    }
    //printf("end %s::qualifiedName()=%s\n",qPrint(name()),qPrint(p->qualifiedName));
  });
  return p->qualifiedName;
}

References p.

Referenced by operator=(), and DefinitionMixin< Base >::qualifiedName().

requirementReferences()

const RequirementRefs & DefinitionImpl::requirementReferences

(

)

const

Definition at line 1387 of file definition.cpp.

{
  return p->requirementRefs;
}

References p.

Referenced by operator=(), and DefinitionMixin< Base >::requirementReferences().

setArtificial()

void DefinitionImpl::setArtificial

(

bool

b

)

Definition at line 1853 of file definition.cpp.

{
  p->isArtificial = b;
}

References p.

Referenced by operator=(), and DefinitionMixin< Base >::setArtificial().

setBodyDef()

void DefinitionImpl::setBodyDef

(

const FileDef *

fd

)

Definition at line 1031 of file definition.cpp.

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

References p.

Referenced by operator=(), and DefinitionMixin< Base >::setBodyDef().

setBodySegment()

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

Definition at line 1019 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.

Referenced by operator=(), and DefinitionMixin< Base >::setBodySegment().

setBriefDescription()

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

Definition at line 511 of file definition.cpp.

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

References _setBriefDescription(), briefFile(), briefLine(), and DString::empty().

Referenced by operator=(), and DefinitionMixin< Base >::setBriefDescription().

setDefFile()

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

Definition at line 160 of file definition.cpp.

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

References p.

Referenced by operator=(), and DefinitionMixin< Base >::setDefFile().

setDocumentation()

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

Definition at line 448 of file definition.cpp.

{
  if (d.empty()) return;
  _setDocumentation(d,docFile,docLine,stripWhiteSpace,false);
}

References _setDocumentation(), docFile(), docLine(), DString::empty(), and stripWhiteSpace().

Referenced by operator=(), and DefinitionMixin< Base >::setDocumentation().

setExported()

void DefinitionImpl::setExported

(

bool

b

)

Definition at line 1858 of file definition.cpp.

{
  p->isExported = b;
}

References p.

Referenced by operator=(), and DefinitionMixin< Base >::setExported().

setHidden()

void DefinitionImpl::setHidden

(

bool

b

)

Definition at line 1848 of file definition.cpp.

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

References p.

Referenced by operator=(), and DefinitionMixin< Base >::setHidden().

setId()

void DefinitionImpl::setId

(

const DString &

name

)

Definition at line 303 of file definition.cpp.

{
  if (id.empty()) 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.

Referenced by operator=(), and DefinitionMixin< Base >::setId().

setInbodyDocumentation()

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

Definition at line 539 of file definition.cpp.

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

References _setInbodyDocumentation(), DString::empty(), inbodyFile(), and inbodyLine().

Referenced by operator=(), and DefinitionMixin< Base >::setInbodyDocumentation().

setLanguage()

void DefinitionImpl::setLanguage

(

SrcLangExt

lang

)

Definition at line 1868 of file definition.cpp.

{
  p->lang=lang;
}

References p.

Referenced by operator=(), and DefinitionMixin< Base >::setLanguage().

setLocalName()

void DefinitionImpl::setLocalName

(

const DString &

name

)

Definition at line 1863 of file definition.cpp.

{
  p->localName=name;
}

References name(), and p.

Referenced by operator=(), and DefinitionMixin< Base >::setLocalName().

setName()

void DefinitionImpl::setName

(

const DString &

name

)

Definition at line 294 of file definition.cpp.

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

References DString::empty(), name(), DString::npos, and p.

Referenced by DefinitionImpl(), operator=(), and DefinitionMixin< Base >::setName().

setOuterScope()

void DefinitionImpl::setOuterScope

(

Definition *

d

)

Definition at line 1303 of file definition.cpp.

{
  //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->qualifiedNameOnce.reset();
    p->outerScope = d;
  }
  p->hidden = p->hidden || d->isHidden();
  assert(p->def!=p->outerScope);
}

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

Referenced by operator=(), and DefinitionMixin< Base >::setOuterScope().

setReference()

void DefinitionImpl::setReference

(

const DString &

r

)

Definition at line 1838 of file definition.cpp.

{
  p->ref=r;
}

References p.

Referenced by operator=(), and DefinitionMixin< Base >::setReference().

setRefItems()

void DefinitionImpl::setRefItems

(

const RefItemVector &

sli

)

Definition at line 1334 of file definition.cpp.

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

References p.

Referenced by operator=(), and DefinitionMixin< Base >::setRefItems().

setRequirementReferences()

void DefinitionImpl::setRequirementReferences

(

const RequirementRefs &

rqli

)

Definition at line 1339 of file definition.cpp.

{
  p->requirementRefs.insert(p->requirementRefs.end(), rqli.cbegin(), rqli.cend());
}

References p.

Referenced by operator=(), and DefinitionMixin< Base >::setRequirementReferences().

symbolName()

DString DefinitionImpl::symbolName

(

)

const

Definition at line 1574 of file definition.cpp.

{
  return p->symbolName;
}

References p.

Referenced by addToMap(), operator=(), and DefinitionMixin< Base >::symbolName().

writeDocAnchorsToTagFile()

void DefinitionImpl::writeDocAnchorsToTagFile

(

TextStream &

tagFile

)

const

Definition at line 355 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().empty() && !AnchorGenerator::instance().isGenerated(si->label().str()))
      {
        //printf("write an entry!\n");
        if (p->def->definitionType()==Definition::TypeMember) tagFile << "  ";
        DString fn = si->fileName();
        addHtmlExtensionIfMissing(fn);
        tagFile << "    <docanchor file=\"" << fn << "\"";
        if (!si->title().empty())
        {
          tagFile << " title=\"" << convertToXML(si->title()) << "\"";
        }
        tagFile << ">" << si->label() << "</docanchor>\n";
      }
    }
  }
}

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

Referenced by operator=(), and DefinitionMixin< Base >::writeDocAnchorsToTagFile().

writeInlineCode()

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

Write code of this definition into the documentation

Definition at line 1048 of file definition.cpp.

{
  const MemberDef *thisMd = nullptr;
  if (p->def->definitionType()==Definition::TypeMember)
  {
    thisMd = toMemberDef(p->def);
  }
  bool inlineSources = thisMd && thisMd->hasInlineSource() && thisMd->initializer().empty();
  //printf("Source Fragment %s: %d-%d\n",qPrint(name()),
  //        p->body->startLine,p->body->endLine);
  if (inlineSources && hasSources())
  {
    ol.pushGeneratorState();
    DString 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");
      size_t indent = 0;
      intf->parseCode(codeOL,           // codeOutIntf
                      scopeName,        // scope
                      detab(codeFragment,indent), // input
                      p->lang,     // lang
                      Config_getBool(STRIP_CODE_COMMENTS),
                      CodeParserOptions()
                      .setFileDef(p->body->fileDef)
                      .setStartLine(actualStart)
                      .setEndLine(actualEnd)
                      .setInlineFragment(true)
                      .setMemberDef(thisMd)
                     );
      codeOL.endCodeFragment("DoxyCode");
    }
    ol.popGeneratorState();
  }
}

References OutputList::codeGenerators(), Config_getBool, detab(), DString::empty(), ParserManager::getCodeParser(), MemberDef::hasInlineSource(), hasSources(), MemberDef::initializer(), MemberDef::memberType(), p, Doxygen::parserManager, OutputList::popGeneratorState(), OutputList::pushGeneratorState(), readCodeFragment(), CodeParserOptions::setEndLine(), CodeParserOptions::setInlineFragment(), CodeParserOptions::setMemberDef(), CodeParserOptions::setStartLine(), OutputCodeList::startCodeFragment(), toMemberDef(), and Definition::TypeMember.

Referenced by operator=(), and DefinitionMixin< Base >::writeInlineCode().

writeNavigationPath()

void DefinitionImpl::writeNavigationPath

(

OutputList &

ol

)

const

Definition at line 1489 of file definition.cpp.

{
  ol.pushGeneratorState();
  ol.disableAllBut(OutputType::Html);
 
  DString 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().

Referenced by operator=(), and DefinitionMixin< Base >::writeNavigationPath().

writePageNavigation()

void DefinitionImpl::writePageNavigation

(

OutputList &

ol

)

const

Definition at line 1940 of file definition.cpp.

{
}

Referenced by operator=(), and DefinitionMixin< Base >::writePageNavigation().

writeQuickMemberLinks()

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

Definition at line 1932 of file definition.cpp.

{
}

Referenced by operator=(), and DefinitionMixin< Base >::writeQuickMemberLinks().

writeRequirementRefs()

void DefinitionImpl::writeRequirementRefs

(

OutputList &

ol

)

const

Definition at line 1191 of file definition.cpp.

{
  if (!Config_getBool(GENERATE_REQUIREMENTS)) return;
  auto writeRefsForType = [&ol](const RequirementRefs &refs,const char *parType,const DString &text)
  {
    size_t num = refs.size();
    if (num>0)
    {
      ol.startParagraph(parType);
      ol.parseText(text);
      ol.docify(" ");
      writeMarkerList(ol,
                      theTranslator->trWriteList(static_cast<int>(num)).str(), num,
                      [&refs,&ol](size_t entryIndex) { RequirementManager::instance().writeRef(ol,refs[entryIndex]); }
                     );
      ol.writeString(".");
      ol.endParagraph();
    }
  };
 
  RequirementRefs satisfiesRefs;
  RequirementRefs verifiesRefs;
  splitRequirementRefs(p->requirementRefs,satisfiesRefs,verifiesRefs);
  writeRefsForType(satisfiesRefs,"satisfies",theTranslator->trSatisfies(satisfiesRefs.size()==1));
  writeRefsForType(verifiesRefs, "verifies", theTranslator->trVerifies(verifiesRefs.size()==1));
}

References Config_getBool, OutputList::docify(), OutputList::endParagraph(), p, OutputList::parseText(), splitRequirementRefs(), OutputList::startParagraph(), DString::str(), theTranslator, Translator::trSatisfies(), Translator::trVerifies(), Translator::trWriteList(), writeMarkerList(), and OutputList::writeString().

Referenced by operator=(), and DefinitionMixin< Base >::writeRequirementRefs().

writeSourceDef()

void DefinitionImpl::writeSourceDef

(

OutputList &

ol

)

const

Write a reference to the source code defining this definition

Definition at line 970 of file definition.cpp.

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

References DString::DString(), DString::empty(), OutputList::endParagraph(), err, DString::find(), getSourceAnchor(), getSourceFileBase(), DString::left(), DString::mid(), DString::npos, p, OutputList::parseText(), DString::sprintf(), OutputList::startParagraph(), theTranslator, Translator::trDefinedAtLineInSourceFile(), and OutputList::writeObjectLink().

Referenced by operator=(), and DefinitionMixin< Base >::writeSourceDef().

writeSourceReffedBy()

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

Definition at line 1181 of file definition.cpp.

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

References _writeSourceRefList(), p, theTranslator, and Translator::trReferencedBy().

Referenced by operator=(), and DefinitionMixin< Base >::writeSourceReffedBy().

writeSourceRefs()

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

Definition at line 1186 of file definition.cpp.

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

References _writeSourceRefList(), p, theTranslator, and Translator::trReferences().

Referenced by operator=(), and DefinitionMixin< Base >::writeSourceRefs().

writeSummaryLinks()

void DefinitionImpl::writeSummaryLinks

(

OutputList &

)

const

Definition at line 1936 of file definition.cpp.

{
}

Referenced by operator=(), and DefinitionMixin< Base >::writeSummaryLinks().

writeToc()

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

Definition at line 1505 of file definition.cpp.

{
  // first check if we have anything to show or if the outline is already shown on the outline panel
  if (p->sectionRefs.empty() || (Config_getBool(GENERATE_TREEVIEW) && Config_getBool(PAGE_OUTLINE_PANEL))) return;
  // generate the embedded toc
  //ol.writeLocalToc(p->sectionRefs,localToc);
 
  auto generateTocEntries = [this,&ol]()
  {
    for (const SectionInfo *si : p->sectionRefs)
    {
      if (si->type().isSection())
      {
        ol.startTocEntry(si);
        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;
        DString docTitle = si->title();
        if (docTitle.empty()) docTitle = si->label();
        ol.generateDoc(docFile(),
                       getStartBodyLine(),
                       scope,
                       md,
                       docTitle,
                       DocOptions()
                       .setIndexWords(true)
                       .setSingleLine(true)
                       .setSectionLevel(si->type().level())
                      );
        ol.endTocEntry(si);
      }
    }
  };
 
  if (localToc.isHtmlEnabled())
  {
    ol.pushGeneratorState();
    ol.disableAllBut(OutputType::Html);
    ol.startLocalToc(localToc.htmlLevel());
    generateTocEntries();
    ol.endLocalToc();
    ol.popGeneratorState();
  }
  if (localToc.isDocbookEnabled())
  {
    ol.pushGeneratorState();
    ol.disableAllBut(OutputType::Docbook);
    ol.startLocalToc(localToc.docbookLevel());
    generateTocEntries();
    ol.endLocalToc();
    ol.popGeneratorState();
  }
  if (localToc.isLatexEnabled())
  {
    ol.pushGeneratorState();
    ol.disableAllBut(OutputType::Latex);
    ol.startLocalToc(localToc.latexLevel());
    // no gneerateTocEntries() needed for LaTeX
    ol.endLocalToc();
    ol.popGeneratorState();
  }
}

References Config_getBool, OutputList::disableAllBut(), Docbook, LocalToc::docbookLevel(), docFile(), DString::empty(), OutputList::endLocalToc(), OutputList::endTocEntry(), OutputList::generateDoc(), getStartBodyLine(), Html, LocalToc::htmlLevel(), LocalToc::isDocbookEnabled(), LocalToc::isHtmlEnabled(), LocalToc::isLatexEnabled(), SectionType::isSection(), SectionInfo::label(), Latex, LocalToc::latexLevel(), SectionType::level(), p, OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startLocalToc(), OutputList::startTocEntry(), SectionInfo::title(), toMemberDef(), SectionInfo::type(), and Definition::TypeMember.

Referenced by operator=(), and DefinitionMixin< Base >::writeToc().

xrefListItems()

const RefItemVector & DefinitionImpl::xrefListItems

(

)

const

Definition at line 1382 of file definition.cpp.

{
  return p->xrefListItems;
}

References p.

Referenced by operator=(), and DefinitionMixin< Base >::xrefListItems().

Member Data Documentation

p

std::unique_ptr<Private> DefinitionImpl::p

private

Definition at line 148 of file definitionimpl.h.

Referenced by _getXRefListId(), _setBriefDescription(), _setDocumentation(), _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(), hasRequirementRefs(), hasSections(), hasSourceReffedBy(), hasSourceRefs(), hasSources(), hasUserDocumentation(), id(), inbodyDocumentation(), inbodyFile(), inbodyLine(), isAnonymous(), isArtificial(), isExported(), isHidden(), isReference(), isVisible(), isVisibleInProject(), localName(), makePartOfGroup(), mergeReferencedBy(), mergeReferences(), mergeRefItems(), name(), navigationPathAsString(), operator=(), partOfGroups(), pathFragment(), qualifiedName(), requirementReferences(), setArtificial(), setBodyDef(), setBodySegment(), setDefFile(), setExported(), setHidden(), setId(), setLanguage(), setLocalName(), setName(), setOuterScope(), setReference(), setRefItems(), setRequirementReferences(), symbolName(), writeDocAnchorsToTagFile(), writeInlineCode(), writeRequirementRefs(), writeSourceDef(), writeSourceReffedBy(), writeSourceRefs(), writeToc(), xrefListItems(), and ~DefinitionImpl().

---

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

• src/definitionimpl.h
• src/definition.cpp