Doxygen
Loading...
Searching...
No Matches
memberdef.cpp File Reference
#include <stdio.h>
#include <assert.h>
#include <mutex>
#include "md5.h"
#include "memberdef.h"
#include "membername.h"
#include "doxygen.h"
#include "util.h"
#include "code.h"
#include "message.h"
#include "htmlhelp.h"
#include "language.h"
#include "outputlist.h"
#include "example.h"
#include "membergroup.h"
#include "groupdef.h"
#include "defargs.h"
#include "docparser.h"
#include "dot.h"
#include "dotcallgraph.h"
#include "searchindex.h"
#include "parserintf.h"
#include "vhdldocgen.h"
#include "arguments.h"
#include "memberlist.h"
#include "namespacedef.h"
#include "moduledef.h"
#include "filedef.h"
#include "config.h"
#include "definitionimpl.h"
#include "regex.h"
#include "trace.h"
Include dependency graph for memberdef.cpp:

Go to the source code of this file.

Classes

class  MemberDefImpl
class  MemberDefAliasImpl

Functions

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)
static QCString addTemplateNames (const QCString &s, const QCString &n, const QCString &t)
static bool writeDefArgumentList (OutputList &ol, const Definition *scope, const MemberDef *md)
static void writeExceptionListImpl (OutputList &ol, const ClassDef *cd, const MemberDef *md, QCString const &exception)
static void writeExceptionList (OutputList &ol, const ClassDef *cd, const MemberDef *md)
static QCString combineArgsAndException (QCString args, QCString exception)
static QCString simplifyTypeForTable (const QCString &s)
static QCString stripTrailingReturn (const QCString &trailRet)
static void invalidateCachedTypesInArgumentList (ArgumentList &al)
static void transferArgumentDocumentation (ArgumentList &decAl, ArgumentList &defAl)
void combineDeclarationAndDefinition (MemberDefMutable *mdec, MemberDefMutable *mdef)
void addDocCrossReference (const MemberDef *s, const MemberDef *d)
MemberDeftoMemberDef (Definition *d)
MemberDeftoMemberDef (DefinitionMutable *md)
const MemberDeftoMemberDef (const Definition *d)
MemberDefMutabletoMemberDefMutable (Definition *d)

Variables

static std::mutex g_cachedAnonymousTypeMutex
static std::mutex g_hasDetailedDescriptionMutex
static const reg::Ex reAnonymous (R"([\w:@]*@\d+)")
static std::mutex g_detectUndocumentedParamsMutex
static std::mutex g_docCrossReferenceMutex

Function Documentation

◆ addDocCrossReference()

void addDocCrossReference ( const MemberDef * s,
const MemberDef * d )

Definition at line 6444 of file memberdef.cpp.

6445{
6446 MemberDefMutable *src = toMemberDefMutable(const_cast<MemberDef*>(s));
6447 MemberDefMutable *dst = toMemberDefMutable(const_cast<MemberDef*>(d));
6448 if (src==nullptr || dst==nullptr) return;
6449 //printf("--> addDocCrossReference src=%s,dst=%s\n",qPrint(src->name()),qPrint(dst->name()));
6450 if (dst->isTypedef() || dst->isEnumerate()) return; // don't add types
6451 if ((dst->hasReferencedByRelation() || dst->hasCallerGraph()) &&
6452 src->isCallable()
6453 )
6454 {
6455 QCString sourceRefName = src->sourceRefName();
6458
6459 // ---- critical section
6460 std::lock_guard<std::mutex> lock(g_docCrossReferenceMutex);
6461 dst->addSourceReferencedBy(src,sourceRefName);
6462 if (mdDef)
6463 {
6464 mdDef->addSourceReferencedBy(src,sourceRefName);
6465 }
6466 if (mdDecl)
6467 {
6468 mdDecl->addSourceReferencedBy(src,sourceRefName);
6469 }
6470 // ---- end critical section
6471 }
6472 if ((src->hasReferencesRelation() || src->hasCallGraph()) &&
6473 src->isCallable()
6474 )
6475 {
6476 QCString sourceRefName = dst->sourceRefName();
6479
6480 // ---- critical section
6481 std::lock_guard<std::mutex> lock(g_docCrossReferenceMutex);
6482 src->addSourceReferences(dst,sourceRefName);
6483 if (mdDef)
6484 {
6485 mdDef->addSourceReferences(dst,sourceRefName);
6486 }
6487 if (mdDecl)
6488 {
6489 mdDecl->addSourceReferences(dst,sourceRefName);
6490 }
6491 // ---- end critical section
6492 }
6493}
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
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(), MemberDef::sourceRefName(), and toMemberDefMutable().

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

◆ addTemplateNames()

QCString addTemplateNames ( const QCString & s,
const QCString & n,
const QCString & t )
static

Definition at line 983 of file memberdef.cpp.

984{
985 QCString result;
986 QCString clRealName=n;
987 int p=0,i=0;
988 if ((i=clRealName.find('<'))!=-1)
989 {
990 clRealName=clRealName.left(i); // strip template specialization
991 }
992 if ((i=clRealName.findRev("::"))!=-1)
993 {
994 clRealName=clRealName.right(clRealName.length()-i-2);
995 }
996 while ((i=s.find(clRealName,p))!=-1)
997 {
998 result+=s.mid(p,i-p);
999 size_t j=clRealName.length()+i;
1000 if (s.length()==j || (s.at(j)!='<' && !isId(s.at(j))))
1001 { // add template names
1002 //printf("Adding %s+%s\n",qPrint(clRealName),qPrint(t));
1003 result+=clRealName+t;
1004 }
1005 else
1006 { // template names already present
1007 //printf("Adding %s\n",qPrint(clRealName));
1008 result+=clRealName;
1009 }
1010 p=i+static_cast<int>(clRealName.length());
1011 }
1012 result+=s.right(s.length()-p);
1013 //printf("addTemplateNames(%s,%s,%s)=%s\n",qPrint(s),qPrint(n),qPrint(t),qPrint(result));
1014 return result;
1015}
int find(char c, int index=0, bool cs=TRUE) const
Definition qcstring.cpp:43
size_t length() const
Returns the length of the string, not counting the 0-terminator.
Definition qcstring.h:166
QCString mid(size_t index, size_t len=static_cast< size_t >(-1)) const
Definition qcstring.h:241
char & at(size_t i)
Returns a reference to the character at index i.
Definition qcstring.h:593
QCString right(size_t len) const
Definition qcstring.h:234
int findRev(char c, int index=-1, bool cs=TRUE) const
Definition qcstring.cpp:96
QCString left(size_t len) const
Definition qcstring.h:229
bool isId(int c)
Definition util.h:208

References QCString::at(), QCString::find(), QCString::findRev(), isId(), QCString::left(), QCString::length(), QCString::mid(), and QCString::right().

Referenced by writeDefArgumentList().

◆ combineArgsAndException()

QCString combineArgsAndException ( QCString args,
QCString exception )
static

Definition at line 2207 of file memberdef.cpp.

2208{
2209 if (exception.isEmpty()) return args; // no exception, nothing to combine args
2210 int pos = args.findRev(')');
2211 int eqPos = pos!=-1 ? args.find('=',pos) : -1; // look for '=' in '(args) = something'
2212 if (eqPos==-1) return args+" "+exception; // append exception at the end
2213 return args.left(eqPos)+" "+exception+" "+args.mid(eqPos); // insert exception before =
2214}
bool isEmpty() const
Returns TRUE iff the string is empty.
Definition qcstring.h:163

References QCString::find(), QCString::findRev(), QCString::isEmpty(), QCString::left(), and QCString::mid().

Referenced by MemberDefImpl::writeDeclaration().

◆ combineDeclarationAndDefinition()

void combineDeclarationAndDefinition ( MemberDefMutable * mdec,
MemberDefMutable * mdef )

Definition at line 6200 of file memberdef.cpp.

6201{
6202 AUTO_TRACE("mdec='{}' mdef='{}' mdec.isPrototype={} mdef.isPrototype={}",
6203 mdec->name(), mdef->name(), mdec->isPrototype(), mdef->isPrototype());
6204 if (
6205 (mdef->isFunction() && !mdef->isStatic() && !mdef->isPrototype()) ||
6206 (mdef->isVariable() && !mdef->isExternal() && !mdef->isStatic())
6207 )
6208 {
6209 bool sameNumTemplateArgs = mdef->templateArguments().size()==mdec->templateArguments().size();
6210
6211 ArgumentList &mdefAl = const_cast<ArgumentList&>(mdef->argumentList());
6212 ArgumentList &mdecAl = const_cast<ArgumentList&>(mdec->argumentList());
6213 if (sameNumTemplateArgs &&
6214 matchArguments2(mdef->getOuterScope(),mdef->getFileDef(),&mdefAl,
6215 mdec->getOuterScope(),mdec->getFileDef(),&mdecAl,
6216 TRUE,mdef->getLanguage()
6217 )
6218 ) /* match found */
6219 {
6220 AUTO_TRACE_ADD("combining definition and declaration");
6221
6222 if (Config_getBool(RESOLVE_UNNAMED_PARAMS))
6223 {
6224 mdec->resolveUnnamedParameters(mdef);
6225 }
6226
6227 // first merge argument documentation
6228 transferArgumentDocumentation(mdecAl,mdefAl);
6229
6230 /* copy documentation between function definition and declaration */
6231 if (!mdec->briefDescription().isEmpty())
6232 {
6233 mdef->setBriefDescription(mdec->briefDescription(),mdec->briefFile(),mdec->briefLine());
6234 }
6235 else if (!mdef->briefDescription().isEmpty())
6236 {
6237 mdec->setBriefDescription(mdef->briefDescription(),mdef->briefFile(),mdef->briefLine());
6238 }
6239 if (!mdef->documentation().isEmpty())
6240 {
6241 //printf("transferring docs mdef->mdec (%s->%s)\n",mdef->argsString(),mdec->argsString());
6242 mdec->setDocumentation(mdef->documentation(),mdef->docFile(),mdef->docLine());
6244 if (mdefAl.hasParameters())
6245 {
6246 auto mdefAlComb = stringToArgumentList(mdef->getLanguage(),mdef->argsString());
6247 transferArgumentDocumentation(mdefAl,*mdefAlComb);
6248 mdec->moveArgumentList(std::move(mdefAlComb));
6249 }
6250 }
6251 else if (!mdec->documentation().isEmpty())
6252 {
6253 //printf("transferring docs mdec->mdef (%s->%s)\n",mdec->argsString(),mdef->argsString());
6254 mdef->setDocumentation(mdec->documentation(),mdec->docFile(),mdec->docLine());
6256 if (mdecAl.hasParameters())
6257 {
6258 auto mdecAlComb = stringToArgumentList(mdec->getLanguage(),mdec->argsString());
6259 transferArgumentDocumentation(mdecAl,*mdecAlComb);
6260 mdef->moveDeclArgumentList(std::move(mdecAlComb));
6261 }
6262 }
6263 if (!mdef->inbodyDocumentation().isEmpty())
6264 {
6265 mdec->setInbodyDocumentation(mdef->inbodyDocumentation(),mdef->inbodyFile(),mdef->inbodyLine());
6266 }
6267 else if (!mdec->inbodyDocumentation().isEmpty())
6268 {
6269 mdef->setInbodyDocumentation(mdec->inbodyDocumentation(),mdec->inbodyFile(),mdec->inbodyLine());
6270 }
6271 if (mdec->getStartBodyLine()!=-1 && mdef->getStartBodyLine()==-1)
6272 {
6273 //printf("body mdec->mdef %d-%d\n",mdec->getStartBodyLine(),mdef->getEndBodyLine());
6274 mdef->setBodySegment(mdec->getDefLine(),mdec->getStartBodyLine(),mdec->getEndBodyLine());
6275 mdef->setBodyDef(mdec->getBodyDef());
6276 //mdef->setBodyMember(mdec);
6277 }
6278 else if (mdef->getStartBodyLine()!=-1 && mdec->getStartBodyLine()==-1)
6279 {
6280 //printf("body mdef->mdec %d-%d\n",mdef->getStartBodyLine(),mdec->getEndBodyLine());
6281 mdec->setBodySegment(mdef->getDefLine(),mdef->getStartBodyLine(),mdef->getEndBodyLine());
6282 mdec->setBodyDef(mdef->getBodyDef());
6283 //mdec->setBodyMember(mdef);
6284 }
6287
6288 // copy group info.
6289 if (mdec->getGroupDef()==nullptr && mdef->getGroupDef()!=nullptr)
6290 {
6291 mdec->setGroupDef(mdef->getGroupDef(),
6292 mdef->getGroupPri(),
6293 mdef->docFile(),
6294 mdef->docLine(),
6295 mdef->hasDocumentation(),
6296 mdef
6297 );
6298 }
6299 else if (mdef->getGroupDef()==nullptr && mdec->getGroupDef()!=nullptr)
6300 {
6301 mdef->setGroupDef(mdec->getGroupDef(),
6302 mdec->getGroupPri(),
6303 mdec->docFile(),
6304 mdec->docLine(),
6305 mdec->hasDocumentation(),
6306 mdec
6307 );
6308 }
6309
6310
6311 mdec->mergeRefItems(mdef);
6312 mdef->mergeRefItems(mdec);
6313
6314 mdef->setMemberDeclaration(mdec);
6315 mdec->setMemberDefinition(mdef);
6316
6317 mergeMemberOverrideOptions(mdec,mdef);
6318
6319 mdef->addQualifiers(mdec->getQualifiers());
6320 mdec->addQualifiers(mdef->getQualifiers());
6321 }
6322 }
6323}
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
#define Config_getBool(name)
Definition config.h:33
std::unique_ptr< ArgumentList > stringToArgumentList(SrcLangExt lang, const QCString &argsString, QCString *extraTypeChars=nullptr)
Definition defargs.l:809
#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:1956
void mergeMemberOverrideOptions(MemberDefMutable *md1, MemberDefMutable *md2)
Definition util.cpp:6771

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 974 of file memberdef.cpp.

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

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

◆ invalidateCachedTypesInArgumentList()

void invalidateCachedTypesInArgumentList ( ArgumentList & al)
static

Definition at line 6137 of file memberdef.cpp.

6138{
6139 for (Argument &a : al)
6140 {
6141 a.canType.clear();
6142 }
6143}
This class contains the information about the argument of a function or template.
Definition arguments.h:27

Referenced by MemberDefImpl::invalidateCachedArgumentTypes().

◆ simplifyTypeForTable()

QCString simplifyTypeForTable ( const QCString & s)
static

Definition at line 3956 of file memberdef.cpp.

3957{
3959 if (ts.endsWith("::")) ts = ts.left(ts.length()-2);
3960 static const reg::Ex re1(R"(\a\w*::)"); // non-template version
3961 static const reg::Ex re2(R"(\a\w*<[^>]*>::)"); // template version
3963 std::string t = ts.str();
3964 while (reg::search(t,match,re2) || reg::search(t,match,re1))
3965 {
3966 t = match.prefix().str() + match.suffix().str(); // remove the matched part
3967 }
3968 //printf("simplifyTypeForTable(%s)->%s\n",qPrint(s),qPrint(t));
3969 return t;
3970}
bool endsWith(const char *s) const
Definition qcstring.h:524
const std::string & str() const
Definition qcstring.h:552
Class representing a regular expression.
Definition regex.h:39
Object representing the matching results.
Definition regex.h:153
bool search(std::string_view str, Match &match, const Ex &re, size_t pos)
Search in a given string str starting at position pos for a match against regular expression re.
Definition regex.cpp:748
bool match(std::string_view str, Match &match, const Ex &re)
Matches a given string str for a match against regular expression re.
Definition regex.cpp:759
QCString removeAnonymousScopes(const QCString &str)
Definition util.cpp:170

References QCString::endsWith(), QCString::left(), QCString::length(), removeAnonymousScopes(), reg::search(), and QCString::str().

Referenced by MemberDefImpl::fieldType().

◆ stripTrailingReturn()

QCString stripTrailingReturn ( const QCString & trailRet)
static

Definition at line 4205 of file memberdef.cpp.

4206{
4207 QCString ret = trailRet;
4208
4209 ret = ret.stripWhiteSpace();
4210 if (ret.startsWith("->"))
4211 {
4212 ret = ret.mid(2).stripWhiteSpace();
4213 return ret;
4214 }
4215 return trailRet;
4216}
bool startsWith(const char *s) const
Definition qcstring.h:507
QCString stripWhiteSpace() const
returns a copy of this string with leading and trailing whitespace removed
Definition qcstring.h:260

References QCString::mid(), QCString::startsWith(), and QCString::stripWhiteSpace().

Referenced by MemberDefImpl::warnIfUndocumentedParams().

◆ toMemberDef() [1/3]

const MemberDef * toMemberDef ( const Definition * d)

Definition at line 6522 of file memberdef.cpp.

6523{
6524 if (d && (typeid(*d)==typeid(MemberDefImpl) || typeid(*d)==typeid(MemberDefAliasImpl)))
6525 {
6526 return static_cast<const MemberDef*>(d);
6527 }
6528 else
6529 {
6530 return nullptr;
6531 }
6532}

◆ toMemberDef() [2/3]

◆ toMemberDef() [3/3]

MemberDef * toMemberDef ( DefinitionMutable * md)

Definition at line 6509 of file memberdef.cpp.

6510{
6511 Definition *d = toDefinition(md);
6512 if (d && typeid(*d)==typeid(MemberDefImpl))
6513 {
6514 return static_cast<MemberDef*>(d);
6515 }
6516 else
6517 {
6518 return nullptr;
6519 }
6520}
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 6534 of file memberdef.cpp.

6535{
6536 if (d && typeid(*d)==typeid(MemberDefImpl))
6537 {
6538 return static_cast<MemberDefMutable*>(d);
6539 }
6540 else
6541 {
6542 return nullptr;
6543 }
6544}

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

◆ transferArgumentDocumentation()

void transferArgumentDocumentation ( ArgumentList & decAl,
ArgumentList & defAl )
static

Definition at line 6170 of file memberdef.cpp.

6171{
6172 for (auto decIt = decAl.begin(), defIt = defAl.begin();
6173 decIt!= decAl.end() && defIt!= defAl.end();
6174 ++decIt, ++defIt)
6175 {
6176 Argument &decA = *decIt;
6177 Argument &defA = *defIt;
6178 if (decA.docs.isEmpty() && !defA.docs.isEmpty())
6179 {
6180 decA.docs = defA.docs;
6181 }
6182 else if (defA.docs.isEmpty() && !decA.docs.isEmpty())
6183 {
6184 defA.docs = decA.docs;
6185 }
6186 if (Config_getBool(RESOLVE_UNNAMED_PARAMS))
6187 {
6188 if (decA.name.isEmpty() && !defA.name.isEmpty())
6189 {
6190 decA.name = defA.name;
6191 }
6192 else if (defA.name.isEmpty() && !decA.name.isEmpty())
6193 {
6194 defA.name = decA.name;
6195 }
6196 }
6197 }
6198}
iterator end()
Definition arguments.h:94
iterator begin()
Definition arguments.h:93
QCString name
Definition arguments.h:44
QCString docs
Definition arguments.h:47

References ArgumentList::begin(), Config_getBool, Argument::docs, ArgumentList::end(), QCString::isEmpty(), and Argument::name.

Referenced by combineDeclarationAndDefinition().

◆ writeDefArgumentList()

bool writeDefArgumentList ( OutputList & ol,
const Definition * scope,
const MemberDef * md )
static

Definition at line 1056 of file memberdef.cpp.

1057{
1058 const ArgumentList &defArgList=(md->isDocsForDefinition()) ?
1059 md->argumentList() : md->declArgumentList();
1060 //printf("writeDefArgumentList '%s' isDocsForDefinition()=%d hasParameters()=%d (%s)\n",
1061 // qPrint(md->name()),md->isDocsForDefinition(),defArgList.hasParameters(),qPrint(argListToString(defArgList)));
1062 if (!defArgList.hasParameters() || md->isProperty() || md->isTypedef())
1063 {
1064 return FALSE; // member has no function like argument list
1065 }
1066
1067 bool isDefine = md->isDefine();
1068 if (!isDefine) ol.docify(" ");
1069
1070 //printf("writeDefArgList(%d)\n",defArgList->count());
1071 ol.endMemberDocName();
1073 //printf("===> name=%s isDefine=%d\n",qPrint(md->name()),md->isDefine());
1074
1075 QCString cName;
1076 if (scope)
1077 {
1078 cName=scope->name();
1079 int il=cName.find('<');
1080 int ir=cName.findRev('>');
1081 if (il!=-1 && ir!=-1 && ir>il)
1082 {
1083 cName=cName.mid(il,ir-il+1);
1084 //printf("1. cName=%s\n",qPrint(cName));
1085 }
1086 else if (scope->definitionType()==Definition::TypeClass)
1087 {
1088 cName=tempArgListToString((toClassDef(scope))->templateArguments(),
1089 scope->getLanguage());
1090 //printf("2. cName=%s\n",qPrint(cName));
1091 }
1092 else // no template specifier
1093 {
1094 cName.clear();
1095 }
1096 }
1097 //printf("~~~ %s cName=%s\n",qPrint(md->name()),qPrint(cName));
1098
1100
1101 bool first=TRUE;
1102 bool paramTypeStarted=FALSE;
1103 auto alIt = defArgList.begin();
1104 while (alIt!=defArgList.end())
1105 {
1106 Argument a = *alIt;
1107 if (isDefine || first)
1108 {
1109 ol.startParameterType(first,QCString());
1110 paramTypeStarted=true;
1111 if (isDefine)
1112 {
1113 ol.endParameterType();
1115 }
1116 }
1117
1118 if (!a.attrib.isEmpty() && !md->isObjCMethod()) // argument has an IDL attribute
1119 {
1120 ol.docify(a.attrib+" ");
1121 }
1122
1123 QCString atype = a.type;
1124 if (sep!="::") { atype=substitute(atype,"::",sep); }
1125
1126 int funcPtrPos=-1;
1127 {
1128 if (md->isObjCMethod()) { atype.prepend("("); atype.append(")"); }
1129 if (atype!="...")
1130 {
1131 if (!cName.isEmpty() && scope && scope!=Doxygen::globalScope)
1132 {
1133 atype=addTemplateNames(atype,scope->name(),cName);
1134 }
1135 funcPtrPos = atype.find("*)(");
1136 if (funcPtrPos!=-1) funcPtrPos++;
1137 linkifyText(TextGeneratorOLImpl(ol),scope,md->getBodyDef(),md,
1138 funcPtrPos==-1 ? atype : atype.left(funcPtrPos));
1139 }
1140 }
1141
1142 if (!isDefine)
1143 {
1144 if (paramTypeStarted)
1145 {
1146 ol.endParameterType();
1147 paramTypeStarted=FALSE;
1148 }
1149 ol.startParameterName(defArgList.size()<2);
1150 }
1151 else
1152 {
1153 ol.endParameterName();
1154 }
1155
1156 if (atype=="...")
1157 {
1158 ol.docify(atype);
1159 }
1160 else if (!a.name.isEmpty()) // argument has a name
1161 {
1162 ol.docify(a.name);
1163 }
1164 if (!isDefine)
1165 {
1166 if (funcPtrPos!=-1)
1167 {
1169 }
1170 ol.endParameterName();
1171 }
1173 if (funcPtrPos!=-1)
1174 {
1175 linkifyText(TextGeneratorOLImpl(ol),scope,md->getBodyDef(),md,
1176 atype.mid(funcPtrPos));
1177 }
1178 if (!a.array.isEmpty())
1179 {
1180 ol.docify(a.array);
1181 }
1182 if (!a.defval.isEmpty()) // write the default value
1183 {
1184 QCString n=a.defval;
1185 if (scope && scope!=Doxygen::globalScope && !cName.isEmpty())
1186 {
1187 n=addTemplateNames(n,scope->name(),cName);
1188 }
1189 ol.startParameterDefVal(" = ");
1191 ol.endParameterDefVal();
1192 }
1193 ++alIt;
1194 if (alIt!=defArgList.end())
1195 {
1196 a = *alIt;
1197 if (!md->isObjCMethod()) ol.docify(", "); // there are more arguments
1198 if (!isDefine)
1199 {
1200 QCString key;
1201 if (md->isObjCMethod() && a.attrib.length()>=2)
1202 {
1203 //printf("Found parameter keyword %s\n",a.qPrint(attrib));
1204 // strip [ and ]
1205 key=a.attrib.mid(1,a.attrib.length()-2);
1206 if (key!=",") key+=":"; // for normal keywords add colon
1207 }
1208 ol.endParameterExtra(false,false,!md->isObjCMethod());
1209 ol.startParameterType(FALSE,key);
1210 paramTypeStarted=TRUE;
1211 }
1212 else // isDefine
1213 {
1214 ol.endParameterExtra(false,false,true);
1215 }
1216 }
1217 first=FALSE;
1218 }
1219 if (first)
1220 {
1221 ol.startParameterName(defArgList.size()<2);
1222 ol.endParameterName();
1224 }
1225 ol.endParameterExtra(TRUE,defArgList.size()<2,!md->isObjCMethod());
1226 if (!md->extraTypeChars().isEmpty())
1227 {
1228 ol.docify(md->extraTypeChars());
1229 }
1230 if (defArgList.constSpecifier())
1231 {
1232 ol.docify(" const");
1233 }
1234 if (defArgList.volatileSpecifier())
1235 {
1236 ol.docify(" volatile");
1237 }
1238 if (defArgList.refQualifier()==RefQualifierType::LValue)
1239 {
1240 ol.docify(" &");
1241 }
1242 else if (defArgList.refQualifier()==RefQualifierType::RValue)
1243 {
1244 ol.docify(" &&");
1245 }
1246 if (!defArgList.trailingReturnType().isEmpty())
1247 {
1249 scope, // scope
1250 md->getBodyDef(), // fileScope
1251 md, // self
1252 defArgList.trailingReturnType(), // text
1253 FALSE // autoBreak
1254 );
1255
1256 }
1257 return TRUE;
1258}
RefQualifierType refQualifier() const
Definition arguments.h:116
QCString trailingReturnType() const
Definition arguments.h:114
bool constSpecifier() const
Definition arguments.h:111
bool volatileSpecifier() const
Definition arguments.h:112
virtual DefType definitionType() const =0
static NamespaceDefMutable * globalScope
Definition doxygen.h:121
virtual bool isObjCMethod() const =0
virtual QCString extraTypeChars() const =0
virtual bool isDefine() const =0
virtual const ArgumentList & declArgumentList() const =0
virtual bool isProperty() const =0
void endParameterExtra(bool last, bool one, bool bracket)
Definition outputlist.h:694
void endMemberDocName()
Definition outputlist.h:682
void startParameterExtra()
Definition outputlist.h:692
void startParameterList(bool openBracket)
Definition outputlist.h:700
void docify(const QCString &s)
Definition outputlist.h:437
void startParameterDefVal(const char *separator)
Definition outputlist.h:696
void endParameterDefVal()
Definition outputlist.h:698
void startParameterType(bool first, const QCString &key)
Definition outputlist.h:684
void endParameterName()
Definition outputlist.h:690
void endParameterType()
Definition outputlist.h:686
void startParameterName(bool one)
Definition outputlist.h:688
void writeNonBreakableSpace(int num)
Definition outputlist.h:626
QCString & prepend(const char *s)
Definition qcstring.h:422
QCString & append(char c)
Definition qcstring.h:396
void clear()
Definition qcstring.h:182
Implements TextGeneratorIntf for an OutputDocInterface stream.
Definition util.h:77
ClassDef * toClassDef(Definition *d)
static QCString addTemplateNames(const QCString &s, const QCString &n, const QCString &t)
QCString substitute(const QCString &s, const QCString &src, const QCString &dst)
substitute all occurrences of src in s by dst
Definition qcstring.cpp:482
#define FALSE
Definition qcstring.h:34
QCString type
Definition arguments.h:42
QCString defval
Definition arguments.h:46
QCString array
Definition arguments.h:45
QCString attrib
Definition arguments.h:41
QCString tempArgListToString(const ArgumentList &al, SrcLangExt lang, bool includeDefault)
Definition util.cpp:1244
QCString getLanguageSpecificSeparator(SrcLangExt lang, bool classScope)
Returns the scope separator to use given the programming language lang.
Definition util.cpp:5809
void linkifyText(const TextGeneratorIntf &out, const Definition *scope, const FileDef *fileScope, const Definition *self, const QCString &text, bool autoBreak, bool external, bool keepSpaces, int indentLevel)
Definition util.cpp:902

References addTemplateNames(), QCString::append(), MemberDef::argumentList(), Argument::array, Argument::attrib, ArgumentList::begin(), QCString::clear(), ArgumentList::constSpecifier(), MemberDef::declArgumentList(), Definition::definitionType(), Argument::defval, OutputList::docify(), ArgumentList::end(), OutputList::endMemberDocName(), OutputList::endParameterDefVal(), OutputList::endParameterExtra(), OutputList::endParameterName(), OutputList::endParameterType(), MemberDef::extraTypeChars(), FALSE, QCString::find(), QCString::findRev(), Definition::getBodyDef(), Definition::getLanguage(), getLanguageSpecificSeparator(), Doxygen::globalScope, ArgumentList::hasParameters(), MemberDef::isDefine(), MemberDef::isDocsForDefinition(), QCString::isEmpty(), MemberDef::isObjCMethod(), MemberDef::isProperty(), MemberDef::isTypedef(), QCString::left(), QCString::length(), linkifyText(), LValue, QCString::mid(), Argument::name, Definition::name(), QCString::prepend(), ArgumentList::refQualifier(), RValue, ArgumentList::size(), OutputList::startParameterDefVal(), OutputList::startParameterExtra(), OutputList::startParameterList(), OutputList::startParameterName(), OutputList::startParameterType(), substitute(), tempArgListToString(), toClassDef(), ArgumentList::trailingReturnType(), TRUE, Argument::type, Definition::TypeClass, ArgumentList::volatileSpecifier(), and OutputList::writeNonBreakableSpace().

Referenced by MemberDefImpl::writeDocumentation().

◆ writeExceptionList()

void writeExceptionList ( OutputList & ol,
const ClassDef * cd,
const MemberDef * md )
static

Definition at line 1299 of file memberdef.cpp.

1300{
1301 QCString exception = md->excpString().stripWhiteSpace();
1302 if ('{'==exception.at(0))
1303 {
1304 // this is an UNO IDL attribute - need special handling
1305 int index = exception.find(';');
1306 int oldIndex = 1;
1307 while (-1 != index) // there should be no more than 2 (set / get)
1308 {
1309 // omit '{' and ';' -> "set raises (...)"
1310 writeExceptionListImpl(ol,cd,md,exception.mid(oldIndex,index-oldIndex));
1311 oldIndex=index+1;
1312 index = exception.find(';',oldIndex);
1313 }
1314 // the rest is now just '}' - omit that
1315 }
1316 else
1317 {
1318 writeExceptionListImpl(ol,cd,md,exception);
1319 }
1320}
virtual QCString excpString() const =0
static void writeExceptionListImpl(OutputList &ol, const ClassDef *cd, const MemberDef *md, QCString const &exception)

References QCString::at(), MemberDef::excpString(), QCString::find(), QCString::mid(), QCString::stripWhiteSpace(), and writeExceptionListImpl().

Referenced by MemberDefImpl::writeDocumentation().

◆ writeExceptionListImpl()

void writeExceptionListImpl ( OutputList & ol,
const ClassDef * cd,
const MemberDef * md,
QCString const & exception )
static

Definition at line 1260 of file memberdef.cpp.

1262{
1263 // this is ordinary exception spec - there must be a '('
1264 //printf("exception='%s'\n",qPrint(exception));
1265 int index = exception.find('(');
1266 if (index!=-1)
1267 {
1268 ol.exceptionEntry(exception.left(index),false);
1269 ++index; // paren in second column so skip it here
1270 for (int comma = exception.find(',', index); comma!=-1; )
1271 {
1272 ++comma; // include comma
1274 exception.mid(index,comma-index));
1275 ol.exceptionEntry(QCString(),false);
1276 index=comma;
1277 comma = exception.find(',', index);
1278 }
1279 int close = exception.find(')', index);
1280 if (close!=-1)
1281 {
1282 QCString type=removeRedundantWhiteSpace(exception.mid(index,close-index));
1283 linkifyText(TextGeneratorOLImpl(ol),cd,md->getBodyDef(),md,type);
1284 ol.exceptionEntry(QCString(),true);
1285 }
1286 else
1287 {
1288 warn(md->getDefFileName(),md->getDefLine(),
1289 "missing ) in exception list on member {}",md->name());
1290 }
1291 }
1292 else // Java Exception
1293 {
1294 ol.docify(" ");
1295 linkifyText(TextGeneratorOLImpl(ol),cd,md->getBodyDef(),md,exception);
1296 }
1297}
virtual QCString getDefFileName() const =0
void exceptionEntry(const QCString &prefix, bool closeBracket)
Definition outputlist.h:704
#define warn(file, line, fmt,...)
Definition message.h:97
QCString removeRedundantWhiteSpace(const QCString &s)
Definition util.cpp:576

References OutputList::docify(), OutputList::exceptionEntry(), QCString::find(), Definition::getBodyDef(), Definition::getDefFileName(), Definition::getDefLine(), QCString::left(), linkifyText(), QCString::mid(), Definition::name(), removeRedundantWhiteSpace(), and warn.

Referenced by writeExceptionList().

Variable Documentation

◆ g_cachedAnonymousTypeMutex

std::mutex g_cachedAnonymousTypeMutex
static

Definition at line 1975 of file memberdef.cpp.

Referenced by MemberDefImpl::getClassDefOfAnonymousType().

◆ g_detectUndocumentedParamsMutex

std::mutex g_detectUndocumentedParamsMutex
static

Definition at line 4218 of file memberdef.cpp.

Referenced by MemberDefImpl::detectUndocumentedParams().

◆ g_docCrossReferenceMutex

std::mutex g_docCrossReferenceMutex
static

Definition at line 6442 of file memberdef.cpp.

Referenced by addDocCrossReference().

◆ g_hasDetailedDescriptionMutex

std::mutex g_hasDetailedDescriptionMutex
static

Definition at line 2667 of file memberdef.cpp.

Referenced by MemberDefImpl::hasDetailedDescription().

◆ reAnonymous

const reg::Ex reAnonymous(R"([\w:@]*@\d+)") ( R"([\w:@]*@\d+)" )
static