memberdef.h File Reference

#include <memory>
#include <optional>
#include <sys/types.h>
#include <vector>
#include "arguments.h"
#include "containers.h"
#include "definition.h"
#include "types.h"

Include dependency graph for memberdef.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	MemberDef
	A model of a class/file/namespace member symbol. More...
class	MemberDefMutable

Functions
MemberDef *	toMemberDef (Definition *d)
MemberDef *	toMemberDef (DefinitionMutable *d)
const MemberDef *	toMemberDef (const Definition *d)
MemberDefMutable *	toMemberDefMutable (Definition *d)
std::unique_ptr< MemberDef >	createMemberDef (const DString &defFileName, int defLine, size_t defColumn, const DString &type, const DString &name, const DString &args, const DString &excp, Protection prot, Specifier virt, bool stat, Relationship related, MemberType t, const ArgumentList &tal, const ArgumentList &al, const DString &metaData)
	Factory method to create a new instance of a MemberDef.
std::unique_ptr< MemberDef >	createMemberDefAlias (const Definition *newScope, const MemberDef *aliasMd)
void	combineDeclarationAndDefinition (MemberDefMutable *mdec, MemberDefMutable *mdef)
void	mergeMemberOverrideOptions (MemberDefMutable *md1, MemberDefMutable *md2)
void	addDocCrossReference (const MemberDef *src, const MemberDef *dst)

Function Documentation

addDocCrossReference()

void addDocCrossReference	(	const MemberDef *	src,
		const MemberDef *	dst )

Definition at line 6420 of file memberdef.cpp.

{
  MemberDefMutable *src = toMemberDefMutable(const_cast<MemberDef*>(s));
  MemberDefMutable *dst = toMemberDefMutable(const_cast<MemberDef*>(d));
  if (src==nullptr || dst==nullptr) return;
  //printf("--> addDocCrossReference src=%s,dst=%s\n",qPrint(src->name()),qPrint(dst->name()));
  if (dst->isTypedef() || dst->isEnumerate()) return; // don't add types
  if ((dst->hasReferencedByRelation() || dst->hasCallerGraph()) &&
      src->isCallable()
     )
  {
    DString sourceRefName = src->sourceRefName();
    MemberDefMutable *mdDef = toMemberDefMutable(dst->memberDefinition());
    MemberDefMutable *mdDecl = toMemberDefMutable(dst->memberDeclaration());
 
    // ---- critical section
    std::lock_guard<std::mutex> lock(g_docCrossReferenceMutex);
    dst->addSourceReferencedBy(src,sourceRefName);
    if (mdDef)
    {
      mdDef->addSourceReferencedBy(src,sourceRefName);
    }
    if (mdDecl)
    {
      mdDecl->addSourceReferencedBy(src,sourceRefName);
    }
    // ---- end critical section
  }
  if ((src->hasReferencesRelation() || src->hasCallGraph()) &&
      src->isCallable()
     )
  {
    DString sourceRefName = dst->sourceRefName();
    MemberDefMutable *mdDef = toMemberDefMutable(src->memberDefinition());
    MemberDefMutable *mdDecl = toMemberDefMutable(src->memberDeclaration());
 
    // ---- critical section
    std::lock_guard<std::mutex> lock(g_docCrossReferenceMutex);
    src->addSourceReferences(dst,sourceRefName);
    if (mdDef)
    {
      mdDef->addSourceReferences(dst,sourceRefName);
    }
    if (mdDecl)
    {
      mdDecl->addSourceReferences(dst,sourceRefName);
    }
    // ---- end critical section
  }
}

References DefinitionMutable::addSourceReferencedBy(), DefinitionMutable::addSourceReferences(), g_docCrossReferenceMutex, MemberDef::hasCallerGraph(), MemberDef::hasCallGraph(), MemberDef::hasReferencedByRelation(), MemberDef::hasReferencesRelation(), MemberDef::isCallable(), MemberDef::isEnumerate(), MemberDef::isTypedef(), MemberDef::memberDeclaration(), MemberDef::memberDefinition(), MemberDef::sourceRefName(), and toMemberDefMutable().

Referenced by findMemberLink(), generateClassMemberLink(), generateClassOrGlobalLink(), generateClassOrGlobalLink(), getLink(), getLinkInScope(), getLinkInScope(), writeObjCMethodCall(), and MemberDefMutable::writeTagFile().

combineDeclarationAndDefinition()

void combineDeclarationAndDefinition	(	MemberDefMutable *	mdec,
		MemberDefMutable *	mdef )

Definition at line 6126 of file memberdef.cpp.

{
  AUTO_TRACE("mdec='{}' mdef='{}' mdec.isPrototype={} mdef.isPrototype={}",
              mdec->name(), mdef->name(), mdec->isPrototype(), mdef->isPrototype());
  if (
      (!mdef->isDocTransferDone() || !mdec->isDocTransferDone()) &&
      (
       (mdef->isFunction() && !mdef->isStatic() && !mdef->isPrototype()) ||
       (mdef->isVariable() && !mdef->isExternal() && !mdef->isStatic())
      )
     )
  {
    bool sameNumTemplateArgs = mdef->templateArguments().size()==mdec->templateArguments().size();
 
    ArgumentList &mdefAl = const_cast<ArgumentList&>(mdef->argumentList());
    ArgumentList &mdecAl = const_cast<ArgumentList&>(mdec->argumentList());
    if (sameNumTemplateArgs &&
        matchArguments2(mdef->getOuterScope(),mdef->getFileDef(),mdef->typeString(),&mdefAl,
                        mdec->getOuterScope(),mdec->getFileDef(),mdec->typeString(),&mdecAl,
                        true,mdef->getLanguage()
                       )
       ) /* match found */
    {
      AUTO_TRACE_ADD("combining definition and declaration");
 
      if (Config_getBool(RESOLVE_UNNAMED_PARAMS))
      {
        mdec->resolveUnnamedParameters(mdef);
      }
 
      // first merge argument documentation
      transferArgumentDocumentation(mdecAl,mdefAl);
 
      // copy brief description between definition and declaration
      DString mdefBrief     = mdef->briefDescription();
      DString mdecBrief     = mdec->briefDescription();
      DString mdefBriefFile = mdef->briefFile();
      DString mdecBriefFile = mdec->briefFile();
      int mdefBriefLine      = mdef->briefLine();
      int mdecBriefLine      = mdec->briefLine();
      if (!mdef->isDocTransferDone() && !mdecBrief.empty())
      {
        mdef->setBriefDescription(mdecBrief,mdecBriefFile,mdecBriefLine);
      }
      if (!mdec->isDocTransferDone() && !mdefBrief.empty())
      {
        mdec->setBriefDescription(mdefBrief,mdefBriefFile,mdefBriefLine);
      }
 
      // copy detailed description between definition and declaration
      DString mdefDocs   = mdef->documentation();
      DString mdecDocs   = mdec->documentation();
      DString mdefFile   = mdef->docFile();
      DString mdecFile   = mdec->docFile();
      int mdefLine        = mdef->docLine();
      int mdecLine        = mdec->docLine();
      bool mdefDocsForDef = mdef->isDocsForDefinition();
      bool mdecDocsForDef = mdec->isDocsForDefinition();
      if (!mdec->isDocTransferDone() && !mdefDocs.empty())
      {
        //printf("transferring docs mdef->mdec (%s->%s)\n",mdef->argsString(),mdec->argsString());
        mdec->setDocumentation(mdefDocs,mdefFile,mdefLine);
        mdec->setDocsForDefinition(mdefDocsForDef);
        if (mdefAl.hasParameters())
        {
          auto mdefAlComb = stringToArgumentList(mdef->getLanguage(),mdef->argsString());
          transferArgumentDocumentation(mdefAl,*mdefAlComb);
          mdec->moveArgumentList(std::move(mdefAlComb));
        }
      }
      if (!mdef->isDocTransferDone() && !mdecDocs.empty())
      {
        //printf("transferring docs mdec->mdef (%s->%s)\n",mdec->argsString(),mdef->argsString());
        mdef->setDocumentation(mdecDocs,mdecFile,mdecLine);
        mdef->setDocsForDefinition(mdecDocsForDef);
        if (mdecAl.hasParameters())
        {
          auto mdecAlComb = stringToArgumentList(mdec->getLanguage(),mdec->argsString());
          transferArgumentDocumentation(mdecAl,*mdecAlComb);
          mdef->moveDeclArgumentList(std::move(mdecAlComb));
        }
      }
 
      // copy inbody documentation between definition and declaration
      DString mdefInbodyDocs = mdef->inbodyDocumentation();
      DString mdecInbodyDocs = mdec->inbodyDocumentation();
      DString mdefInbodyFile = mdef->inbodyFile();
      DString mdecInbodyFile = mdec->inbodyFile();
      int mdefInbodyLine      = mdef->inbodyLine();
      int mdecInbodyLine      = mdec->inbodyLine();
      if (!mdec->isDocTransferDone() && !mdefInbodyDocs.empty())
      {
        mdec->setInbodyDocumentation(mdefInbodyDocs,mdefInbodyFile,mdefInbodyLine);
      }
      if (!mdef->isDocTransferDone() && !mdecInbodyDocs.empty())
      {
        mdef->setInbodyDocumentation(mdecInbodyDocs,mdecInbodyFile,mdecInbodyLine);
      }
 
      if (mdec->getStartBodyLine()!=-1 && mdef->getStartBodyLine()==-1)
      {
        //printf("body mdec->mdef %d-%d\n",mdec->getStartBodyLine(),mdef->getEndBodyLine());
        mdef->setBodySegment(mdec->getDefLine(),mdec->getStartBodyLine(),mdec->getEndBodyLine());
        mdef->setBodyDef(mdec->getBodyDef());
        //mdef->setBodyMember(mdec);
      }
      else if (mdef->getStartBodyLine()!=-1 && mdec->getStartBodyLine()==-1)
      {
        //printf("body mdef->mdec %d-%d\n",mdef->getStartBodyLine(),mdec->getEndBodyLine());
        mdec->setBodySegment(mdef->getDefLine(),mdef->getStartBodyLine(),mdef->getEndBodyLine());
        mdec->setBodyDef(mdef->getBodyDef());
        //mdec->setBodyMember(mdef);
      }
      mdec->mergeMemberSpecifiers(mdef->getMemberSpecifiers());
      mdef->mergeMemberSpecifiers(mdec->getMemberSpecifiers());
 
      // copy group info.
      if (mdec->getGroupDef()==nullptr && mdef->getGroupDef()!=nullptr)
      {
        mdec->setGroupDef(mdef->getGroupDef(),
            mdef->getGroupPri(),
            mdef->docFile(),
            mdef->docLine(),
            mdef->hasDocumentation(),
            mdef
            );
      }
      else if (mdef->getGroupDef()==nullptr && mdec->getGroupDef()!=nullptr)
      {
        mdef->setGroupDef(mdec->getGroupDef(),
            mdec->getGroupPri(),
            mdec->docFile(),
            mdec->docLine(),
            mdec->hasDocumentation(),
            mdec
            );
      }
 
 
      mdec->mergeRefItems(mdef);
      mdef->mergeRefItems(mdec);
 
      mdef->setMemberDeclaration(mdec);
      mdec->setMemberDefinition(mdef);
 
      mergeMemberOverrideOptions(mdec,mdef);
 
      mdef->addQualifiers(mdec->getQualifiers());
      mdec->addQualifiers(mdef->getQualifiers());
 
      mdef->setDocTransferDone();
      mdec->setDocTransferDone();
    }
  }
}

References MemberDefMutable::addQualifiers(), MemberDef::argsString(), MemberDef::argumentList(), AUTO_TRACE, AUTO_TRACE_ADD, Definition::briefDescription(), Definition::briefFile(), Definition::briefLine(), Config_getBool, Definition::docFile(), Definition::docLine(), Definition::documentation(), DString::empty(), Definition::getBodyDef(), Definition::getDefLine(), Definition::getEndBodyLine(), MemberDef::getFileDef(), MemberDef::getGroupDef(), MemberDef::getGroupPri(), Definition::getLanguage(), MemberDef::getMemberSpecifiers(), Definition::getOuterScope(), MemberDef::getQualifiers(), Definition::getStartBodyLine(), Definition::hasDocumentation(), ArgumentList::hasParameters(), Definition::inbodyDocumentation(), Definition::inbodyFile(), Definition::inbodyLine(), MemberDef::isDocsForDefinition(), MemberDef::isDocTransferDone(), MemberDef::isExternal(), MemberDef::isFunction(), MemberDef::isPrototype(), MemberDef::isStatic(), MemberDef::isVariable(), matchArguments2(), mergeMemberOverrideOptions(), MemberDefMutable::mergeMemberSpecifiers(), DefinitionMutable::mergeRefItems(), MemberDefMutable::moveArgumentList(), MemberDefMutable::moveDeclArgumentList(), Definition::name(), MemberDefMutable::resolveUnnamedParameters(), DefinitionMutable::setBodyDef(), DefinitionMutable::setBodySegment(), DefinitionMutable::setBriefDescription(), MemberDefMutable::setDocsForDefinition(), MemberDefMutable::setDocTransferDone(), DefinitionMutable::setDocumentation(), MemberDefMutable::setGroupDef(), DefinitionMutable::setInbodyDocumentation(), MemberDefMutable::setMemberDeclaration(), MemberDefMutable::setMemberDefinition(), ArgumentList::size(), stringToArgumentList(), MemberDef::templateArguments(), transferArgumentDocumentation(), and MemberDef::typeString().

Referenced by ClassDefImpl::mergeCategory(), transferFunctionDocumentation(), and MemberDefMutable::writeTagFile().

createMemberDef()

std::unique_ptr< MemberDef > createMemberDef	(	const DString &	defFileName,
		int	defLine,
		size_t	defColumn,
		const DString &	type,
		const DString &	name,
		const DString &	args,
		const DString &	excp,
		Protection	prot,
		Specifier	virt,
		bool	stat,
		Relationship	related,
		MemberType	t,
		const ArgumentList &	tal,
		const ArgumentList &	al,
		const DString &	metaData )

Factory method to create a new instance of a MemberDef.

Definition at line 517 of file memberdef.cpp.

{
  return std::make_unique<MemberDefImpl>(defFileName,defLine,defColumn,type,name,args,excp,prot,virt,
                           stat,related,t,tal,al,metaData);
}

Referenced by addEnumValuesToEnums(), addGlobalFunction(), addInstance(), addInterfaceOrServiceToServiceOrSingleton(), addLocalObjCMethod(), addMemberSpecialization(), addMethodToClass(), addOverloaded(), addVariableToClass(), addVariableToFile(), buildDefineList(), createTagLessInstance(), MemberDefImpl::createTemplateInstanceMember(), createUsingMemberImportForClass(), findDefineDocumentation(), findEnums(), findMember(), findUsingDeclImports(), and MemberDefMutable::writeTagFile().

createMemberDefAlias()

std::unique_ptr< MemberDef > createMemberDefAlias	(	const Definition *	newScope,
		const MemberDef *	aliasMd )

Definition at line 967 of file memberdef.cpp.

{
  auto amd = std::make_unique<MemberDefAliasImpl>(newScope,aliasMd);
  //printf("amd: name=%s displayName=%s\n",qPrint(amd->name()),qPrint(amd->displayName()));
  return amd;
}

Referenced by MemberDefAliasImpl::deepCopy(), findUsingDeclImports(), NamespaceDefImpl::insertMember(), insertMemberAlias(), and MemberDefMutable::writeTagFile().

mergeMemberOverrideOptions()

void mergeMemberOverrideOptions	(	MemberDefMutable *	md1,
		MemberDefMutable *	md2 )

Definition at line 6282 of file memberdef.cpp.

{
  if (Config_getBool(CALL_GRAPH)  !=md1->hasCallGraph())   md2->overrideCallGraph(md1->hasCallGraph());
  if (Config_getBool(CALLER_GRAPH)!=md1->hasCallerGraph()) md2->overrideCallerGraph(md1->hasCallerGraph());
  if (Config_getBool(CALL_GRAPH)  !=md2->hasCallGraph())   md1->overrideCallGraph( md2->hasCallGraph());
  if (Config_getBool(CALLER_GRAPH)!=md2->hasCallerGraph()) md1->overrideCallerGraph(md2->hasCallerGraph());
 
  if (Config_getBool(SHOW_ENUM_VALUES)  !=md1->hasEnumValues())   md2->overrideEnumValues(md1->hasEnumValues());
  if (Config_getBool(SHOW_ENUM_VALUES)  !=md2->hasEnumValues())   md1->overrideEnumValues( md2->hasEnumValues());
 
  if (Config_getBool(REFERENCED_BY_RELATION)!=md1->hasReferencedByRelation()) md2->overrideReferencedByRelation(md1->hasReferencedByRelation());
  if (Config_getBool(REFERENCES_RELATION)   !=md1->hasReferencesRelation())   md2->overrideReferencesRelation(md1->hasReferencesRelation());
  if (Config_getBool(REFERENCED_BY_RELATION)!=md2->hasReferencedByRelation()) md1->overrideReferencedByRelation(md2->hasReferencedByRelation());
  if (Config_getBool(REFERENCES_RELATION)   !=md2->hasReferencesRelation())   md1->overrideReferencesRelation(md2->hasReferencesRelation());
 
  if (Config_getBool(INLINE_SOURCES)!=md1->hasInlineSource()) md2->overrideInlineSource(md1->hasInlineSource());
  if (Config_getBool(INLINE_SOURCES)!=md2->hasInlineSource()) md1->overrideInlineSource(md2->hasInlineSource());
}

References Config_getBool, MemberDef::hasCallerGraph(), MemberDef::hasCallGraph(), MemberDef::hasEnumValues(), MemberDef::hasInlineSource(), MemberDef::hasReferencedByRelation(), MemberDef::hasReferencesRelation(), MemberDefMutable::overrideCallerGraph(), MemberDefMutable::overrideCallGraph(), MemberDefMutable::overrideEnumValues(), MemberDefMutable::overrideInlineSource(), MemberDefMutable::overrideReferencedByRelation(), and MemberDefMutable::overrideReferencesRelation().

Referenced by combineDeclarationAndDefinition(), findFriends(), and MemberDefMutable::writeTagFile().

toMemberDef() [1/3]

const MemberDef * toMemberDef

(

const Definition *

d

)

Definition at line 6498 of file memberdef.cpp.

{
  if (d && (typeid(*d)==typeid(MemberDefImpl) || typeid(*d)==typeid(MemberDefAliasImpl)))
  {
    return static_cast<const MemberDef*>(d);
  }
  else
  {
    return nullptr;
  }
}

toMemberDef() [2/3]

MemberDef * toMemberDef

(

Definition *

d

)

Definition at line 6473 of file memberdef.cpp.

{
  if (d && (typeid(*d)==typeid(MemberDefImpl) || typeid(*d)==typeid(MemberDefAliasImpl)))
  {
    return static_cast<MemberDef*>(d);
  }
  else
  {
    return nullptr;
  }
}

Referenced by codeFolding(), DefinitionImpl::computeTooltip(), definitionToName(), DocRef::DocRef(), dumpSymbol(), findMemberLink(), findUsingDeclImports(), generateClassOrGlobalLink(), RequirementManager::generatePage(), getDefs(), MemberDefAliasImpl::getMdAlias(), MemberDefAliasImpl::getMdAlias(), getMemberFromSymbol(), SymbolResolver::Private::getResolvedSymbol(), SymbolResolver::Private::getResolvedType(), getSQLDocBlock(), SymbolResolver::Private::isAccessibleFrom(), SymbolResolver::Private::isAccessibleFromWithExpScope(), DocParser::processCopyDoc(), SymbolResolver::resolveSymbol(), resolveUserReferences(), SearchIndex::setCurrentDoc(), SearchIndexExternal::setCurrentDoc(), SymbolResolver::Private::substTypedef(), DefinitionImpl::writeInlineCode(), writeJavasScriptSearchDataPage(), writeObjCMethodCall(), MemberDefMutable::writeTagFile(), DefinitionImpl::writeToc(), and TooltipManager::writeTooltips().

toMemberDef() [3/3]

MemberDef * toMemberDef

(

DefinitionMutable *

d

)

Definition at line 6485 of file memberdef.cpp.

{
  Definition *d = toDefinition(md);
  if (d && typeid(*d)==typeid(MemberDefImpl))
  {
    return static_cast<MemberDef*>(d);
  }
  else
  {
    return nullptr;
  }
}

References toDefinition().

toMemberDefMutable()

MemberDefMutable * toMemberDefMutable

(

Definition *

d

)

Definition at line 6510 of file memberdef.cpp.

{
  if (d && typeid(*d)==typeid(MemberDefImpl))
  {
    return static_cast<MemberDefMutable*>(d);
  }
  else
  {
    return nullptr;
  }
}

Referenced by addDocCrossReference(), addEnumValuesToEnums(), addGlobalFunction(), addInstance(), addInterfaceOrServiceToServiceOrSingleton(), MemberList::addListReferences(), addLocalObjCMethod(), addMemberFunction(), addMemberSpecialization(), addMembersToMemberGroup(), addMemberToGroups(), ClassDefImpl::addMemberToList(), FileDefImpl::addMemberToList(), ModuleDefImpl::addMemberToList(), NamespaceDefImpl::addMemberToList(), ModuleDefImpl::addMemberToModule(), ModuleManager::addMemberToModule(), ClassDefImpl::addMemberToTemplateInstance(), addMethodToClass(), addOverloaded(), MemberList::addRequirementReferences(), addVariableToClass(), addVariableToFile(), associateVariableWithAnonymousEnumType(), buildDefineList(), buildFunctionList(), buildTypedefList(), computeMemberRelationsForBaseClass(), createTagLessInstance(), MemberDefImpl::createTemplateInstanceMember(), createUsingMemberImportForClass(), ClassDefImpl::deepCopy(), MemberGroup::distributeMemberGroupDocumentation(), findDefineDocumentation(), findDEV(), findEnumDocumentation(), findEnums(), findFriends(), findGlobalMember(), findMember(), MemberList::findSectionsInDocumentation(), findUsingDeclImports(), flushCachedTemplateRelations(), flushUnresolvedRelations(), generateClassMemberLink(), generateClassOrGlobalLink(), getLinkInScope(), ClassDefImpl::hideDerivedVariablesInPython(), incrementFlowKeyWordCount(), incrementFlowKeyWordCount(), inheritDocumentation(), GroupDefImpl::insertMember(), MemberGroup::insertMember(), NamespaceDefImpl::insertMember(), MemberDefImpl::insertReimplementedBy(), ClassDefImpl::mergeCategory(), ClassDefImpl::mergeMembersFromBaseClasses(), SymbolResolver::Private::newResolveTypedef(), processTagLessClasses(), MemberList::setAnchors(), MemberList::setAnonymousEnumType(), ClassDefImpl::setGroupDefForAllMembers(), transferFunctionDocumentation(), transferFunctionReferences(), transferRelatedFunctionDocumentation(), transferStaticInstanceInitializers(), tryAddEnumDocsToGroupMember(), vhdlCorrectMemberProperties(), MemberList::writeDocumentation(), MemberList::writeDocumentationPage(), VhdlDocGen::writePlainVHDLDeclarations(), MemberList::writeSimpleDocumentation(), VhdlDocGen::writeSource(), MemberDefMutable::writeTagFile(), and MemberList::writeTagFile().