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

6424{
6425 MemberDefMutable *src = toMemberDefMutable(const_cast<MemberDef*>(s));
6426 MemberDefMutable *dst = toMemberDefMutable(const_cast<MemberDef*>(d));
6427 if (src==nullptr || dst==nullptr) return;
6428 //printf("--> addDocCrossReference src=%s,dst=%s\n",qPrint(src->name()),qPrint(dst->name()));
6429 if (dst->isTypedef() || dst->isEnumerate()) return; // don't add types
6430 if ((dst->hasReferencedByRelation() || dst->hasCallerGraph()) &&
6431 src->isCallable()
6432 )
6433 {
6434 QCString sourceRefName = src->sourceRefName();
6437
6438 // ---- critical section
6439 std::lock_guard<std::mutex> lock(g_docCrossReferenceMutex);
6440 dst->addSourceReferencedBy(src,sourceRefName);
6441 if (mdDef)
6442 {
6443 mdDef->addSourceReferencedBy(src,sourceRefName);
6444 }
6445 if (mdDecl)
6446 {
6447 mdDecl->addSourceReferencedBy(src,sourceRefName);
6448 }
6449 // ---- end critical section
6450 }
6451 if ((src->hasReferencesRelation() || src->hasCallGraph()) &&
6452 src->isCallable()
6453 )
6454 {
6455 QCString sourceRefName = dst->sourceRefName();
6458
6459 // ---- critical section
6460 std::lock_guard<std::mutex> lock(g_docCrossReferenceMutex);
6461 src->addSourceReferences(dst,sourceRefName);
6462 if (mdDef)
6463 {
6464 mdDef->addSourceReferences(dst,sourceRefName);
6465 }
6466 if (mdDecl)
6467 {
6468 mdDecl->addSourceReferences(dst,sourceRefName);
6469 }
6470 // ---- end critical section
6471 }
6472}
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 980 of file memberdef.cpp.

981{
982 QCString result;
983 QCString clRealName=n;
984 int p=0,i=0;
985 if ((i=clRealName.find('<'))!=-1)
986 {
987 clRealName=clRealName.left(i); // strip template specialization
988 }
989 if ((i=clRealName.findRev("::"))!=-1)
990 {
991 clRealName=clRealName.right(clRealName.length()-i-2);
992 }
993 while ((i=s.find(clRealName,p))!=-1)
994 {
995 result+=s.mid(p,i-p);
996 size_t j=clRealName.length()+i;
997 if (s.length()==j || (s.at(j)!='<' && !isId(s.at(j))))
998 { // add template names
999 //printf("Adding %s+%s\n",qPrint(clRealName),qPrint(t));
1000 result+=clRealName+t;
1001 }
1002 else
1003 { // template names already present
1004 //printf("Adding %s\n",qPrint(clRealName));
1005 result+=clRealName;
1006 }
1007 p=i+static_cast<int>(clRealName.length());
1008 }
1009 result+=s.right(s.length()-p);
1010 //printf("addTemplateNames(%s,%s,%s)=%s\n",qPrint(s),qPrint(n),qPrint(t),qPrint(result));
1011 return result;
1012}
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:153
QCString mid(size_t index, size_t len=static_cast< size_t >(-1)) const
Definition qcstring.h:226
char & at(size_t i)
Returns a reference to the character at index i.
Definition qcstring.h:578
QCString right(size_t len) const
Definition qcstring.h:219
int findRev(char c, int index=-1, bool cs=TRUE) const
Definition qcstring.cpp:91
QCString left(size_t len) const
Definition qcstring.h:214
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 2204 of file memberdef.cpp.

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

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

6180{
6181 AUTO_TRACE("mdec='{}' mdef='{}' mdec.isPrototype={} mdef.isPrototype={}",
6182 mdec->name(), mdef->name(), mdec->isPrototype(), mdef->isPrototype());
6183 if (
6184 (mdef->isFunction() && !mdef->isStatic() && !mdef->isPrototype()) ||
6185 (mdef->isVariable() && !mdef->isExternal() && !mdef->isStatic())
6186 )
6187 {
6188 bool sameNumTemplateArgs = mdef->templateArguments().size()==mdec->templateArguments().size();
6189
6190 ArgumentList &mdefAl = const_cast<ArgumentList&>(mdef->argumentList());
6191 ArgumentList &mdecAl = const_cast<ArgumentList&>(mdec->argumentList());
6192 if (sameNumTemplateArgs &&
6193 matchArguments2(mdef->getOuterScope(),mdef->getFileDef(),&mdefAl,
6194 mdec->getOuterScope(),mdec->getFileDef(),&mdecAl,
6195 TRUE,mdef->getLanguage()
6196 )
6197 ) /* match found */
6198 {
6199 AUTO_TRACE_ADD("combining definition and declaration");
6200
6201 if (Config_getBool(RESOLVE_UNNAMED_PARAMS))
6202 {
6203 mdec->resolveUnnamedParameters(mdef);
6204 }
6205
6206 // first merge argument documentation
6207 transferArgumentDocumentation(mdecAl,mdefAl);
6208
6209 /* copy documentation between function definition and declaration */
6210 if (!mdec->briefDescription().isEmpty())
6211 {
6212 mdef->setBriefDescription(mdec->briefDescription(),mdec->briefFile(),mdec->briefLine());
6213 }
6214 else if (!mdef->briefDescription().isEmpty())
6215 {
6216 mdec->setBriefDescription(mdef->briefDescription(),mdef->briefFile(),mdef->briefLine());
6217 }
6218 if (!mdef->documentation().isEmpty())
6219 {
6220 //printf("transferring docs mdef->mdec (%s->%s)\n",mdef->argsString(),mdec->argsString());
6221 mdec->setDocumentation(mdef->documentation(),mdef->docFile(),mdef->docLine());
6223 if (mdefAl.hasParameters())
6224 {
6225 auto mdefAlComb = stringToArgumentList(mdef->getLanguage(),mdef->argsString());
6226 transferArgumentDocumentation(mdefAl,*mdefAlComb);
6227 mdec->moveArgumentList(std::move(mdefAlComb));
6228 }
6229 }
6230 else if (!mdec->documentation().isEmpty())
6231 {
6232 //printf("transferring docs mdec->mdef (%s->%s)\n",mdec->argsString(),mdef->argsString());
6233 mdef->setDocumentation(mdec->documentation(),mdec->docFile(),mdec->docLine());
6235 if (mdecAl.hasParameters())
6236 {
6237 auto mdecAlComb = stringToArgumentList(mdec->getLanguage(),mdec->argsString());
6238 transferArgumentDocumentation(mdecAl,*mdecAlComb);
6239 mdef->moveDeclArgumentList(std::move(mdecAlComb));
6240 }
6241 }
6242 if (!mdef->inbodyDocumentation().isEmpty())
6243 {
6244 mdec->setInbodyDocumentation(mdef->inbodyDocumentation(),mdef->inbodyFile(),mdef->inbodyLine());
6245 }
6246 else if (!mdec->inbodyDocumentation().isEmpty())
6247 {
6248 mdef->setInbodyDocumentation(mdec->inbodyDocumentation(),mdec->inbodyFile(),mdec->inbodyLine());
6249 }
6250 if (mdec->getStartBodyLine()!=-1 && mdef->getStartBodyLine()==-1)
6251 {
6252 //printf("body mdec->mdef %d-%d\n",mdec->getStartBodyLine(),mdef->getEndBodyLine());
6253 mdef->setBodySegment(mdec->getDefLine(),mdec->getStartBodyLine(),mdec->getEndBodyLine());
6254 mdef->setBodyDef(mdec->getBodyDef());
6255 //mdef->setBodyMember(mdec);
6256 }
6257 else if (mdef->getStartBodyLine()!=-1 && mdec->getStartBodyLine()==-1)
6258 {
6259 //printf("body mdef->mdec %d-%d\n",mdef->getStartBodyLine(),mdec->getEndBodyLine());
6260 mdec->setBodySegment(mdef->getDefLine(),mdef->getStartBodyLine(),mdef->getEndBodyLine());
6261 mdec->setBodyDef(mdef->getBodyDef());
6262 //mdec->setBodyMember(mdef);
6263 }
6266
6267 // copy group info.
6268 if (mdec->getGroupDef()==nullptr && mdef->getGroupDef()!=nullptr)
6269 {
6270 mdec->setGroupDef(mdef->getGroupDef(),
6271 mdef->getGroupPri(),
6272 mdef->docFile(),
6273 mdef->docLine(),
6274 mdef->hasDocumentation(),
6275 mdef
6276 );
6277 }
6278 else if (mdef->getGroupDef()==nullptr && mdec->getGroupDef()!=nullptr)
6279 {
6280 mdef->setGroupDef(mdec->getGroupDef(),
6281 mdec->getGroupPri(),
6282 mdec->docFile(),
6283 mdec->docLine(),
6284 mdec->hasDocumentation(),
6285 mdec
6286 );
6287 }
6288
6289
6290 mdec->mergeRefItems(mdef);
6291 mdef->mergeRefItems(mdec);
6292
6293 mdef->setMemberDeclaration(mdec);
6294 mdec->setMemberDefinition(mdef);
6295
6296 mergeMemberOverrideOptions(mdec,mdef);
6297
6298 mdef->addQualifiers(mdec->getQualifiers());
6299 mdec->addQualifiers(mdef->getQualifiers());
6300 }
6301 }
6302}
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:1959
void mergeMemberOverrideOptions(MemberDefMutable *md1, MemberDefMutable *md2)
Definition util.cpp:7378

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

◆ invalidateCachedTypesInArgumentList()

void invalidateCachedTypesInArgumentList ( ArgumentList & al)
static

Definition at line 6116 of file memberdef.cpp.

6117{
6118 for (Argument &a : al)
6119 {
6120 a.canType.clear();
6121 }
6122}
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 3929 of file memberdef.cpp.

3930{
3932 if (ts.endsWith("::")) ts = ts.left(ts.length()-2);
3933 static const reg::Ex re1(R"(\a\w*::)"); // non-template version
3934 static const reg::Ex re2(R"(\a\w*<[^>]*>::)"); // template version
3936 std::string t = ts.str();
3937 while (reg::search(t,match,re2) || reg::search(t,match,re1))
3938 {
3939 t = match.prefix().str() + match.suffix().str(); // remove the matched part
3940 }
3941 //printf("simplifyTypeForTable(%s)->%s\n",qPrint(s),t.c_str());
3942 return QCString(t);
3943}
bool endsWith(const char *s) const
Definition qcstring.h:509
const std::string & str() const
Definition qcstring.h:537
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:173

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

4177{
4178 QCString ret = trailRet;
4179
4180 ret = ret.stripWhiteSpace();
4181 if (ret.startsWith("->"))
4182 {
4183 ret = ret.mid(2).stripWhiteSpace();
4184 return ret;
4185 }
4186 return trailRet;
4187}
bool startsWith(const char *s) const
Definition qcstring.h:492
QCString stripWhiteSpace() const
returns a copy of this string with leading and trailing whitespace removed
Definition qcstring.h:245

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

Referenced by MemberDefImpl::warnIfUndocumentedParams().

◆ toMemberDef() [1/3]

const MemberDef * toMemberDef ( const Definition * d)

Definition at line 6501 of file memberdef.cpp.

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

◆ toMemberDef() [2/3]

◆ toMemberDef() [3/3]

MemberDef * toMemberDef ( DefinitionMutable * md)

Definition at line 6488 of file memberdef.cpp.

6489{
6490 Definition *d = toDefinition(md);
6491 if (d && typeid(*d)==typeid(MemberDefImpl))
6492 {
6493 return static_cast<MemberDef*>(d);
6494 }
6495 else
6496 {
6497 return nullptr;
6498 }
6499}
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 6513 of file memberdef.cpp.

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

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

6150{
6151 for (auto decIt = decAl.begin(), defIt = defAl.begin();
6152 decIt!= decAl.end() && defIt!= defAl.end();
6153 ++decIt, ++defIt)
6154 {
6155 Argument &decA = *decIt;
6156 Argument &defA = *defIt;
6157 if (decA.docs.isEmpty() && !defA.docs.isEmpty())
6158 {
6159 decA.docs = defA.docs;
6160 }
6161 else if (defA.docs.isEmpty() && !decA.docs.isEmpty())
6162 {
6163 defA.docs = decA.docs;
6164 }
6165 if (Config_getBool(RESOLVE_UNNAMED_PARAMS))
6166 {
6167 if (decA.name.isEmpty() && !defA.name.isEmpty())
6168 {
6169 decA.name = defA.name;
6170 }
6171 else if (defA.name.isEmpty() && !decA.name.isEmpty())
6172 {
6173 defA.name = decA.name;
6174 }
6175 }
6176 }
6177}
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 1053 of file memberdef.cpp.

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

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

1297{
1298 QCString exception(QCString(md->excpString()).stripWhiteSpace());
1299 if ('{'==exception.at(0))
1300 {
1301 // this is an UNO IDL attribute - need special handling
1302 int index = exception.find(';');
1303 int oldIndex = 1;
1304 while (-1 != index) // there should be no more than 2 (set / get)
1305 {
1306 // omit '{' and ';' -> "set raises (...)"
1307 writeExceptionListImpl(ol,cd,md,exception.mid(oldIndex,index-oldIndex));
1308 oldIndex=index+1;
1309 index = exception.find(';',oldIndex);
1310 }
1311 // the rest is now just '}' - omit that
1312 }
1313 else
1314 {
1315 writeExceptionListImpl(ol,cd,md,exception);
1316 }
1317}
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 1257 of file memberdef.cpp.

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

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

Referenced by MemberDefImpl::getClassDefOfAnonymousType().

◆ g_detectUndocumentedParamsMutex

std::mutex g_detectUndocumentedParamsMutex
static

Definition at line 4189 of file memberdef.cpp.

Referenced by MemberDefImpl::detectUndocumentedParams().

◆ g_docCrossReferenceMutex

std::mutex g_docCrossReferenceMutex
static

Definition at line 6421 of file memberdef.cpp.

Referenced by addDocCrossReference().

◆ g_hasDetailedDescriptionMutex

std::mutex g_hasDetailedDescriptionMutex
static

Definition at line 2659 of file memberdef.cpp.

Referenced by MemberDefImpl::hasDetailedDescription().

◆ reAnonymous

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