Doxygen
Loading...
Searching...
No Matches
memberdef.h File Reference
#include <vector>
#include <memory>
#include <optional>
#include <sys/types.h>
#include "types.h"
#include "definition.h"
#include "arguments.h"
#include "classdef.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

MemberDeftoMemberDef (Definition *d)
MemberDeftoMemberDef (DefinitionMutable *d)
const MemberDeftoMemberDef (const Definition *d)
MemberDefMutabletoMemberDefMutable (Definition *d)
std::unique_ptr< MemberDefcreateMemberDef (const QCString &defFileName, int defLine, int defColumn, const QCString &type, const QCString &name, const QCString &args, const QCString &excp, Protection prot, Specifier virt, bool stat, Relationship related, MemberType t, const ArgumentList &tal, const ArgumentList &al, const QCString &metaData)
 Factory method to create a new instance of a MemberDef.
std::unique_ptr< MemberDefcreateMemberDefAlias (const Definition *newScope, const MemberDef *aliasMd)
void combineDeclarationAndDefinition (MemberDefMutable *mdec, MemberDefMutable *mdef)
void addDocCrossReference (const MemberDef *src, const MemberDef *dst)

Function Documentation

◆ addDocCrossReference()

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

Definition at line 6421 of file memberdef.cpp.

6422{
6423 MemberDefMutable *src = toMemberDefMutable(const_cast<MemberDef*>(s));
6424 MemberDefMutable *dst = toMemberDefMutable(const_cast<MemberDef*>(d));
6425 if (src==nullptr || dst==nullptr) return;
6426 //printf("--> addDocCrossReference src=%s,dst=%s\n",qPrint(src->name()),qPrint(dst->name()));
6427 if (dst->isTypedef() || dst->isEnumerate()) return; // don't add types
6428 if ((dst->hasReferencedByRelation() || dst->hasCallerGraph()) &&
6429 src->isCallable()
6430 )
6431 {
6432 QCString sourceRefName = src->sourceRefName();
6435
6436 // ---- critical section
6437 std::lock_guard<std::mutex> lock(g_docCrossReferenceMutex);
6438 dst->addSourceReferencedBy(src,sourceRefName);
6439 if (mdDef)
6440 {
6441 mdDef->addSourceReferencedBy(src,sourceRefName);
6442 }
6443 if (mdDecl)
6444 {
6445 mdDecl->addSourceReferencedBy(src,sourceRefName);
6446 }
6447 // ---- end critical section
6448 }
6449 if ((src->hasReferencesRelation() || src->hasCallGraph()) &&
6450 src->isCallable()
6451 )
6452 {
6453 QCString sourceRefName = dst->sourceRefName();
6456
6457 // ---- critical section
6458 std::lock_guard<std::mutex> lock(g_docCrossReferenceMutex);
6459 src->addSourceReferences(dst,sourceRefName);
6460 if (mdDef)
6461 {
6462 mdDef->addSourceReferences(dst,sourceRefName);
6463 }
6464 if (mdDecl)
6465 {
6466 mdDecl->addSourceReferences(dst,sourceRefName);
6467 }
6468 // ---- end critical section
6469 }
6470}
virtual void addSourceReferences(MemberDef *d, const QCString &sourceRefName)=0
virtual void addSourceReferencedBy(MemberDef *d, const QCString &sourceRefName)=0
A model of a class/file/namespace member symbol.
Definition memberdef.h:48
virtual MemberDef * memberDefinition() const =0
virtual MemberDef * memberDeclaration() const =0
virtual bool hasReferencesRelation() const =0
virtual bool isTypedef() const =0
virtual bool hasCallGraph() const =0
virtual QCString sourceRefName() const =0
virtual bool hasCallerGraph() const =0
virtual bool isEnumerate() const =0
virtual bool hasReferencedByRelation() const =0
virtual bool isCallable() const =0
This is an alternative implementation of QCString.
Definition qcstring.h:101
QCString s
Definition htmlgen.cpp:154
static std::mutex g_docCrossReferenceMutex
MemberDefMutable * toMemberDefMutable(Definition *d)

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(), s, MemberDef::sourceRefName(), and toMemberDefMutable().

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

◆ combineDeclarationAndDefinition()

void combineDeclarationAndDefinition ( MemberDefMutable * mdec,
MemberDefMutable * mdef )

Definition at line 6177 of file memberdef.cpp.

6178{
6179 AUTO_TRACE("mdec='{}' mdef='{}' mdec.isPrototype={} mdef.isPrototype={}",
6180 mdec->name(), mdef->name(), mdec->isPrototype(), mdef->isPrototype());
6181 if (
6182 (mdef->isFunction() && !mdef->isStatic() && !mdef->isPrototype()) ||
6183 (mdef->isVariable() && !mdef->isExternal() && !mdef->isStatic())
6184 )
6185 {
6186 bool sameNumTemplateArgs = mdef->templateArguments().size()==mdec->templateArguments().size();
6187
6188 ArgumentList &mdefAl = const_cast<ArgumentList&>(mdef->argumentList());
6189 ArgumentList &mdecAl = const_cast<ArgumentList&>(mdec->argumentList());
6190 if (sameNumTemplateArgs &&
6191 matchArguments2(mdef->getOuterScope(),mdef->getFileDef(),&mdefAl,
6192 mdec->getOuterScope(),mdec->getFileDef(),&mdecAl,
6193 TRUE,mdef->getLanguage()
6194 )
6195 ) /* match found */
6196 {
6197 AUTO_TRACE_ADD("combining definition and declaration");
6198
6199 if (Config_getBool(RESOLVE_UNNAMED_PARAMS))
6200 {
6201 mdec->resolveUnnamedParameters(mdef);
6202 }
6203
6204 // first merge argument documentation
6205 transferArgumentDocumentation(mdecAl,mdefAl);
6206
6207 /* copy documentation between function definition and declaration */
6208 if (!mdec->briefDescription().isEmpty())
6209 {
6210 mdef->setBriefDescription(mdec->briefDescription(),mdec->briefFile(),mdec->briefLine());
6211 }
6212 else if (!mdef->briefDescription().isEmpty())
6213 {
6214 mdec->setBriefDescription(mdef->briefDescription(),mdef->briefFile(),mdef->briefLine());
6215 }
6216 if (!mdef->documentation().isEmpty())
6217 {
6218 //printf("transferring docs mdef->mdec (%s->%s)\n",mdef->argsString(),mdec->argsString());
6219 mdec->setDocumentation(mdef->documentation(),mdef->docFile(),mdef->docLine());
6221 if (mdefAl.hasParameters())
6222 {
6223 auto mdefAlComb = stringToArgumentList(mdef->getLanguage(),mdef->argsString());
6224 transferArgumentDocumentation(mdefAl,*mdefAlComb);
6225 mdec->moveArgumentList(std::move(mdefAlComb));
6226 }
6227 }
6228 else if (!mdec->documentation().isEmpty())
6229 {
6230 //printf("transferring docs mdec->mdef (%s->%s)\n",mdec->argsString(),mdef->argsString());
6231 mdef->setDocumentation(mdec->documentation(),mdec->docFile(),mdec->docLine());
6233 if (mdecAl.hasParameters())
6234 {
6235 auto mdecAlComb = stringToArgumentList(mdec->getLanguage(),mdec->argsString());
6236 transferArgumentDocumentation(mdecAl,*mdecAlComb);
6237 mdef->moveDeclArgumentList(std::move(mdecAlComb));
6238 }
6239 }
6240 if (!mdef->inbodyDocumentation().isEmpty())
6241 {
6242 mdec->setInbodyDocumentation(mdef->inbodyDocumentation(),mdef->inbodyFile(),mdef->inbodyLine());
6243 }
6244 else if (!mdec->inbodyDocumentation().isEmpty())
6245 {
6246 mdef->setInbodyDocumentation(mdec->inbodyDocumentation(),mdec->inbodyFile(),mdec->inbodyLine());
6247 }
6248 if (mdec->getStartBodyLine()!=-1 && mdef->getStartBodyLine()==-1)
6249 {
6250 //printf("body mdec->mdef %d-%d\n",mdec->getStartBodyLine(),mdef->getEndBodyLine());
6251 mdef->setBodySegment(mdec->getDefLine(),mdec->getStartBodyLine(),mdec->getEndBodyLine());
6252 mdef->setBodyDef(mdec->getBodyDef());
6253 //mdef->setBodyMember(mdec);
6254 }
6255 else if (mdef->getStartBodyLine()!=-1 && mdec->getStartBodyLine()==-1)
6256 {
6257 //printf("body mdef->mdec %d-%d\n",mdef->getStartBodyLine(),mdec->getEndBodyLine());
6258 mdec->setBodySegment(mdef->getDefLine(),mdef->getStartBodyLine(),mdef->getEndBodyLine());
6259 mdec->setBodyDef(mdef->getBodyDef());
6260 //mdec->setBodyMember(mdef);
6261 }
6264
6265 // copy group info.
6266 if (mdec->getGroupDef()==nullptr && mdef->getGroupDef()!=nullptr)
6267 {
6268 mdec->setGroupDef(mdef->getGroupDef(),
6269 mdef->getGroupPri(),
6270 mdef->docFile(),
6271 mdef->docLine(),
6272 mdef->hasDocumentation(),
6273 mdef
6274 );
6275 }
6276 else if (mdef->getGroupDef()==nullptr && mdec->getGroupDef()!=nullptr)
6277 {
6278 mdef->setGroupDef(mdec->getGroupDef(),
6279 mdec->getGroupPri(),
6280 mdec->docFile(),
6281 mdec->docLine(),
6282 mdec->hasDocumentation(),
6283 mdec
6284 );
6285 }
6286
6287
6288 mdec->mergeRefItems(mdef);
6289 mdef->mergeRefItems(mdec);
6290
6291 mdef->setMemberDeclaration(mdec);
6292 mdec->setMemberDefinition(mdef);
6293
6294 mergeMemberOverrideOptions(mdec,mdef);
6295
6296 mdef->addQualifiers(mdec->getQualifiers());
6297 mdec->addQualifiers(mdef->getQualifiers());
6298 }
6299 }
6300}
This class represents an function or template argument list.
Definition arguments.h:65
bool hasParameters() const
Definition arguments.h:76
size_t size() const
Definition arguments.h:100
virtual QCString docFile() const =0
virtual int getEndBodyLine() const =0
virtual SrcLangExt getLanguage() const =0
Returns the programming language this definition was written in.
virtual int docLine() const =0
virtual int getDefLine() const =0
virtual int inbodyLine() const =0
virtual const FileDef * getBodyDef() const =0
virtual int briefLine() const =0
virtual bool hasDocumentation() const =0
virtual QCString briefDescription(bool abbreviate=FALSE) const =0
virtual QCString documentation() const =0
virtual QCString briefFile() const =0
virtual Definition * getOuterScope() const =0
virtual int getStartBodyLine() const =0
virtual QCString inbodyDocumentation() const =0
virtual QCString inbodyFile() const =0
virtual const QCString & name() const =0
virtual void setBodySegment(int defLine, int bls, int ble)=0
virtual void setDocumentation(const QCString &d, const QCString &docFile, int docLine, bool stripWhiteSpace=TRUE)=0
virtual void setInbodyDocumentation(const QCString &d, const QCString &docFile, int docLine)=0
virtual void mergeRefItems(Definition *d)=0
virtual void setBodyDef(const FileDef *fd)=0
virtual void setBriefDescription(const QCString &b, const QCString &briefFile, int briefLine)=0
virtual const ArgumentList & templateArguments() const =0
virtual GroupDef * getGroupDef()=0
virtual const FileDef * getFileDef() const =0
virtual const ArgumentList & argumentList() const =0
virtual bool isFunction() const =0
virtual bool isExternal() const =0
virtual bool isStatic() const =0
virtual StringVector getQualifiers() const =0
virtual bool isDocsForDefinition() const =0
virtual Grouping::GroupPri_t getGroupPri() const =0
virtual TypeSpecifier getMemberSpecifiers() const =0
virtual bool isVariable() const =0
virtual QCString argsString() const =0
virtual bool isPrototype() const =0
virtual void setMemberDeclaration(MemberDef *md)=0
virtual void resolveUnnamedParameters(const MemberDef *md)=0
virtual void setDocsForDefinition(bool b)=0
virtual void mergeMemberSpecifiers(TypeSpecifier s)=0
virtual void addQualifiers(const StringVector &qualifiers)=0
virtual void moveDeclArgumentList(std::unique_ptr< ArgumentList > al)=0
virtual void setGroupDef(GroupDef *gd, Grouping::GroupPri_t pri, const QCString &fileName, int startLine, bool hasDocs, MemberDef *member=nullptr)=0
virtual void setMemberDefinition(MemberDef *md)=0
virtual void moveArgumentList(std::unique_ptr< ArgumentList > al)=0
bool isEmpty() const
Returns TRUE iff the string is empty.
Definition qcstring.h:150
#define Config_getBool(name)
Definition config.h:33
std::unique_ptr< ArgumentList > stringToArgumentList(SrcLangExt lang, const QCString &argsString, QCString *extraTypeChars=nullptr)
Definition defargs.l:814
#define AUTO_TRACE_ADD(...)
Definition docnode.cpp:47
#define AUTO_TRACE(...)
Definition docnode.cpp:46
static void transferArgumentDocumentation(ArgumentList &decAl, ArgumentList &defAl)
#define TRUE
Definition qcstring.h:37
bool matchArguments2(const Definition *srcScope, const FileDef *srcFileScope, const ArgumentList *srcAl, const Definition *dstScope, const FileDef *dstFileScope, const ArgumentList *dstAl, bool checkCV, SrcLangExt lang)
Definition util.cpp:1959
void mergeMemberOverrideOptions(MemberDefMutable *md1, MemberDefMutable *md2)
Definition util.cpp:7373

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(), 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(), QCString::isEmpty(), 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(), DefinitionMutable::setDocumentation(), MemberDefMutable::setGroupDef(), DefinitionMutable::setInbodyDocumentation(), MemberDefMutable::setMemberDeclaration(), MemberDefMutable::setMemberDefinition(), ArgumentList::size(), stringToArgumentList(), MemberDef::templateArguments(), transferArgumentDocumentation(), and TRUE.

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

◆ createMemberDef()

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

◆ createMemberDefAlias()

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

Definition at line 971 of file memberdef.cpp.

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

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

◆ toMemberDef() [1/3]

const MemberDef * toMemberDef ( const Definition * d)

Definition at line 6499 of file memberdef.cpp.

6500{
6501 if (d && (typeid(*d)==typeid(MemberDefImpl) || typeid(*d)==typeid(MemberDefAliasImpl)))
6502 {
6503 return static_cast<const MemberDef*>(d);
6504 }
6505 else
6506 {
6507 return nullptr;
6508 }
6509}

◆ toMemberDef() [2/3]

◆ toMemberDef() [3/3]

MemberDef * toMemberDef ( DefinitionMutable * d)

Definition at line 6486 of file memberdef.cpp.

6487{
6488 Definition *d = toDefinition(md);
6489 if (d && typeid(*d)==typeid(MemberDefImpl))
6490 {
6491 return static_cast<MemberDef*>(d);
6492 }
6493 else
6494 {
6495 return nullptr;
6496 }
6497}
The common base class of all entity definitions found in the sources.
Definition definition.h:76
Definition * toDefinition(DefinitionMutable *dm)

References toDefinition().

◆ toMemberDefMutable()

MemberDefMutable * toMemberDefMutable ( Definition * d)

Definition at line 6511 of file memberdef.cpp.

6512{
6513 if (d && typeid(*d)==typeid(MemberDefImpl))
6514 {
6515 return static_cast<MemberDefMutable*>(d);
6516 }
6517 else
6518 {
6519 return nullptr;
6520 }
6521}

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(), addVariableToClass(), addVariableToFile(), 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(), SymbolResolver::Private::newResolveTypedef(), processTagLessClasses(), MemberList::setAnchors(), MemberList::setAnonymousEnumType(), MemberDefMutable::setFromAnonymousScope(), ClassDefImpl::setGroupDefForAllMembers(), transferFunctionDocumentation(), transferFunctionReferences(), transferRelatedFunctionDocumentation(), transferStaticInstanceInitializers(), tryAddEnumDocsToGroupMember(), vhdlCorrectMemberProperties(), MemberDefImpl::writeDeclaration(), MemberList::writeDocumentation(), MemberList::writeDocumentationPage(), VhdlDocGen::writePlainVHDLDeclarations(), MemberList::writeSimpleDocumentation(), VhdlDocGen::writeSource(), and MemberList::writeTagFile().