56 MemberDefImpl(
const QCString &defFileName,
int defLine,
int defColumn,
57 const QCString &type,
const QCString &
name,
const QCString &args,
60 const ArgumentList &al,
const QCString &metaData);
68 std::unique_ptr<MemberDef>
deepCopy()
const override;
69 void moveTo(Definition *)
override;
72 QCString
anchor()
const override;
84 const MemberList *
getSectionList(
const Definition *)
const override;
103 QCString
objCMethodName(
bool localLink,
bool showStatic)
const override;
109 bool isSlot()
const override;
120 bool isDCOP()
const override;
147 bool isCopy()
const override;
150 bool isWeak()
const override;
154 bool isNew()
const override;
244 ClassDef *
category()
const override;
270 void setSectionList(
const Definition *container,
const MemberList *sl)
override;
272 const QCString &fileName,
int startLine,
bool hasDocs,
273 MemberDef *member=
nullptr)
override;
291 void setPrototype(
bool p,
const QCString &df,
int line,
int column)
override;
293 void setDeclFile(
const QCString &df,
int line,
int column)
override;
298 void setType(
const QCString &t)
override;
317 void cacheTypedefVal(
const ClassDef *val,
const QCString &templSpec,
const QCString &resolvedType)
override;
332 const ClassDef *cd,
const NamespaceDef *nd,
const FileDef *fd,
const GroupDef *gd,
const ModuleDef *mod,
333 bool inGroup,
int indentLevel,
const ClassDef *inheritFrom=
nullptr,
const QCString &inheritId=QCString())
const override;
334 void writeDocumentation(
const MemberList *ml,
int memCount,
int memTotal,OutputList &ol,
335 const QCString &scopeName,
const Definition *container,
336 bool inGroup,
bool showEnumValues=
FALSE,
bool
337 showInline=
FALSE)
const override;
340 const ClassDef *cd,
const NamespaceDef *nd,
const FileDef *fd,
const GroupDef *gd,
const ModuleDef *mod)
const override;
341 void writeTagFile(TextStream &,
bool useQualifiedName,
bool showNamespaceMembers)
const override;
347 const std::unique_ptr<ArgumentList> &actualArgs)
const override;
350 const ClassDef *cd,
const NamespaceDef *nd,
const FileDef *fd,
const GroupDef *gd,
const ModuleDef *mod,
351 bool onlyText=
FALSE)
const override;
373 const QCString &cfname,
const QCString &ciname,
374 const QCString &cname)
const;
378 const ArgumentList &al,
bool writeReqClause=
true)
const;
384 void init(Definition *def,
const QCString &t,
const QCString &a,
const QCString &e,
387 const ArgumentList &al,
const QCString &meta
522 return std::make_unique<MemberDefImpl>(defFileName,defLine,defColumn,type,name,args,excp,prot,virt,
523 stat,related,t,tal,al,metaData);
543 std::unique_ptr<MemberDef>
deepCopy()
const override {
548 const QCString &
name()
const override
941 const std::unique_ptr<ArgumentList> &actualArgs)
const override
945 const ClassDef *cd,
const NamespaceDef *nd,
const FileDef *fd,
const GroupDef *gd,
const ModuleDef *mod,
946 bool inGroup,
int indentLevel,
const ClassDef *inheritFrom=
nullptr,
const QCString &inheritId=QCString())
const override
951 const ClassDef *cd,
const NamespaceDef *nd,
const FileDef *fd,
const GroupDef *gd,
const ModuleDef *mod)
const override
956 const ClassDef *cd,
const NamespaceDef *nd,
const FileDef *fd,
const GroupDef *gd,
const ModuleDef *mod,
957 bool onlyText=
FALSE)
const override
968 auto amd = std::make_unique<MemberDefAliasImpl>(newScope,aliasMd);
980 if ((i=clRealName.
find(
'<'))!=-1)
982 clRealName=clRealName.
left(i);
984 if ((i=clRealName.
findRev(
"::"))!=-1)
986 clRealName=clRealName.
right(clRealName.
length()-i-2);
988 while ((i=s.
find(clRealName,p))!=-1)
990 result+=s.
mid(p,i-p);
991 size_t j=clRealName.
length()+i;
995 result+=clRealName+t;
1002 p=i+
static_cast<int>(clRealName.
length());
1069 cName=scope->
name();
1070 int il=cName.
find(
'<');
1072 if (il!=-1 && ir!=-1 && ir>il)
1074 cName=cName.
mid(il,ir-il+1);
1093 bool paramTypeStarted=
FALSE;
1095 auto alIt = defArgList.
begin();
1096 while (alIt!=defArgList.
end())
1099 if (isDefine || first)
1102 paramTypeStarted=
true;
1116 if (sep!=
"::") { atype=
substitute(atype,
"::",sep); }
1127 funcPtrPos = atype.
find(
"*)(");
1128 if (funcPtrPos!=-1) funcPtrPos++;
1130 funcPtrPos==-1 ? atype : atype.
left(funcPtrPos));
1136 if (paramTypeStarted)
1139 paramTypeStarted=
FALSE;
1168 atype.
mid(funcPtrPos));
1186 if (alIt!=defArgList.
end())
1198 if (key!=
",") key+=
":";
1201 if (paramTypeStarted)
1206 paramTypeStarted=
TRUE;
1261 int index = exception.
find(
'(');
1266 for (
int comma = exception.
find(
',', index); comma!=-1; )
1270 exception.
mid(index,comma-index));
1273 comma = exception.
find(
',', index);
1275 int close = exception.
find(
')', index);
1285 "missing ) in exception list on member %s",
qPrint(md->
name()));
1298 if (
'{'==exception.
at(0))
1301 int index = exception.
find(
';');
1308 index = exception.
find(
';',oldIndex);
1439 init(
this,t,a,e,p,v,s,r,mt,tal,al,meta);
1451 result->DefinitionMixin<MemberDefMutable>::operator=(*this);
1471 result->m_def =
m_def ;
1472 result->m_anc =
m_anc ;
1473 result->m_decl =
m_decl ;
1475 result->m_read =
m_read ;
1539 result->m_isLinkableCached = 0;
1540 result->m_isConstructorCached = 0;
1541 result->m_isDestructorCached = 0;
1606 const ClassDef *mcd = md->getClassDef();
1637 QCString n =
name();
1657 bool separateMemberPages =
Config_getBool(SEPARATE_MEMBER_PAGES);
1658 bool inlineSimpleClasses =
Config_getBool(INLINE_SIMPLE_STRUCTS);
1684 if (inlineSimpleClasses && classDef->
isSimple())
1705 "Internal inconsistency: member %s does not belong to any"
1765 QCString result=
m_anc;
1790 bool extractPrivateVirtual =
Config_getBool(EXTRACT_PRIV_VIRTUAL);
1847 if (!groupDef && !nspace &&
1862 if (
m_stat && classDef==
nullptr && !extractStatic)
1927 bool onlyText)
const
1932 QCString n =
name();
1936 if (!hideScopeNames)
1946 else if (nspace && (gd || fd || moduleDef))
2005 ClassDef *annoClassDef=
nullptr;
2009 std::string stype = ltype.
str();
2010 static const reg::Ex r(R
"([\w@:]*@\d+[\w@:]*)");
2014 QCString annName = match.str();
2023 if (annoClassDef==
nullptr)
2030 return annoClassDef;
2039 bool extractPrivateVirtual =
Config_getBool(EXTRACT_PRIV_VIRTUAL);
2043 bool hideFriendCompounds =
Config_getBool(HIDE_FRIEND_COMPOUNDS);
2055 bool visibleIfStatic = !(
getClassDef()==
nullptr &&
2062 bool visibleIfDocumented = (!hideUndocMembers ||
2069 bool visibleIfEnabled = !(hideUndocMembers &&
2076 bool visibleIfFriendCompound = !(hideFriendCompounds &&
2105 bool visibleIfNotDefaultCDTor = !(cOrDTor &&
2120 bool visible = visibleIfStatic && visibleIfDocumented &&
2121 visibleIfEnabled && visibleIfPrivate &&
2122 visibleIfNotDefaultCDTor &&
2123 visibleIfFriendCompound &&
2173 for (
auto it = al.
begin(); it!=al.
end();)
2210 if (exception.
isEmpty())
return args;
2212 int eqPos = pos!=-1 ? args.
find(
'=',pos) : -1;
2213 if (eqPos==-1)
return args+
" "+exception;
2214 return args.
left(eqPos)+
" "+exception+
" "+args.
mid(eqPos);
2224 bool inGroup,
int indentLevel,
const ClassDef *inheritedFrom,
const QCString &inheritId)
const
2232 const Definition *d=
nullptr;
2233 ASSERT (cd!=
nullptr || nd!=
nullptr || fd!=
nullptr || gd!=
nullptr || mod!=
nullptr);
2236 else if (mod) d=mod;
2251 err(
"No context could be derived for member '%s'\n",
qPrint(
name()));
2255 QCString cname = d->
name();
2273 bool writeAnchor = (inGroup ||
getGroupDef()==
nullptr) &&
2279 QCString doxyName=
name();
2288 if (!detailsVisible)
2300 for (
int j=0;j<indentLevel;j++)
2327 static const reg::Ex r(R
"(@\d+)");
2329 std::string stype = ltype.str();
2330 bool endAnonScopeNeeded=
FALSE;
2333 int i =
static_cast<int>(match.position());
2334 int l =
static_cast<int>(match.length());
2347 for (
int j=0;j< indentLevel;j++)
2358 else if (!varName.
isEmpty() && (varName.
at(0)==
'*' || varName.
at(0)==
'&'))
2363 endAnonScopeNeeded=
TRUE;
2393 else if (ltype==
"@")
2413 if (htmlOn && !ltype.
isEmpty())
2438 bool extractPrivateVirtual =
Config_getBool(EXTRACT_PRIV_VIRTUAL);
2448 if (!
name().isEmpty() &&
2467 const ClassDef *rcd = cd;
2482 const ClassDef *rcd = cd;
2540 ol.
docify(
" [implementation]");
2565 for (
const auto &s : sl)
2584 if (
isAddable()) sl.emplace_back(
"add");
2588 for (
const auto &s : sl)
2609 if (endAnonScopeNeeded)
2625 if (!ast->isEmpty())
2676 bool extractPrivateVirtual =
Config_getBool(EXTRACT_PRIV_VIRTUAL);
2693 (alwaysDetailedSec &&
2741 if (!hideUndocMembers)
2744 docFilter = docFilter || docInfo;
2760 (docFilter && staticFilter && privateFilter && friendCompoundFilter && !
isHidden());
2772 bool inlineSimpleStructs =
Config_getBool(INLINE_SIMPLE_STRUCTS);
2776 bool simpleFilter = (
hasBriefDescription() || !hideUndocMembers) && inlineSimpleStructs &&
2781 bool result = visible || simpleFilter;
2801 TypeSpecifier(
m_memSpec).setInline(
false)!=TypeSpecifier()
2818 if (
isFriend()) sl.emplace_back(
"friend");
2819 else if (
isRelated()) sl.emplace_back(
"related");
2823 if (inlineInfo &&
isInline()) sl.emplace_back(
"inline");
2824 if (
isExplicit()) sl.emplace_back(
"explicit");
2825 if (
isMutable()) sl.emplace_back(
"mutable");
2826 if (
isStatic()) sl.emplace_back(
"static");
2840 if (
isAddable()) sl.emplace_back(
"add");
2845 if (
isFinal()) sl.emplace_back(
"final");
2846 if (
isAbstract()) sl.emplace_back(
"abstract");
2847 if (
isOverride()) sl.emplace_back(
"override");
2848 if (
isInitonly()) sl.emplace_back(
"initonly");
2849 if (
isSealed()) sl.emplace_back(
"sealed");
2850 if (
isNew()) sl.emplace_back(
"new");
2851 if (
isOptional()) sl.emplace_back(
"optional");
2852 if (
isRequired()) sl.emplace_back(
"required");
2859 if (
isAssign()) sl.emplace_back(
"assign");
2860 else if (
isCopy()) sl.emplace_back(
"copy");
2861 else if (
isRetain()) sl.emplace_back(
"retain");
2862 else if (
isWeak()) sl.emplace_back(
"weak");
2864 else if (
isUnretained()) sl.emplace_back(
"unsafe_unretained");
2874 if (
isSignal()) sl.emplace_back(
"signal");
2875 if (
isSlot()) sl.emplace_back(
"slot");
2876 if (
isDefault()) sl.emplace_back(
"default");
2877 if (
isDelete()) sl.emplace_back(
"delete");
2878 if (
isNoExcept()) sl.emplace_back(
"noexcept");
2881 if (
isReadonly()) sl.emplace_back(
"readonly");
2882 if (
isBound()) sl.emplace_back(
"bound");
2893 sl.emplace_back(
"implementation");
2902 sl.emplace_back(
"inherited");
2908 sl.emplace_back(
"implementation");
2913 bool alreadyAdded = std::find(sl.begin(), sl.end(), sx) != sl.end();
2928 DotCallGraph callGraph(
this,
FALSE);
2931 warn_uncond(
"Call graph for '%s' not generated, too many nodes (%d), threshold is %d. Consider increasing DOT_GRAPH_MAX_NODES.\n",
2950 DotCallGraph callerGraph(
this,
TRUE);
2953 warn_uncond(
"Caller graph for '%s' not generated, too many nodes (%d), threshold is %d. Consider increasing DOT_GRAPH_MAX_NODES.\n",
2971 const ClassDef *bcd=
nullptr;
2985 const ClassDef *bcd=
nullptr;
2992 QCString reimplFromLine;
3001 int markerPos = reimplFromLine.
find(
"@0");
3029 reimplFromLine.
length()-markerPos-2));
3034 err(
"translation error: no marker in trReimplementsFromList()\n");
3045 for (
const auto &bmd : bml)
3047 const ClassDef *bcd=bmd->getClassDef();
3064 auto replaceFunc = [&bml,&ol](
size_t entryIndex)
3067 auto it = bml.
begin();
3069 const MemberDef *bmd =
nullptr;
3070 const ClassDef *bcd =
nullptr;
3071 while (it!=bml.
end())
3077 if (cnt==entryIndex)
break;
3097 QCString reimplInLine;
3159 if (i!=-1 && !
name.isEmpty())
3200 bool hasInits =
false;
3205 if (fmd->isLinkable())
3207 if (!fmd->initializer().isEmpty())
3218 if (fmd->isLinkable())
3231 ol.
startDoxyAnchor(cfname,cname,fmd->anchor(),fmd->name(),fmd->argsString());
3242 if (!fmd->initializer().isEmpty())
3244 QCString initStr = fmd->initializer().stripWhiteSpace();
3258 bool hasBrief = !fmd->briefDescription().isEmpty();
3259 bool hasDetails = !fmd->documentation().isEmpty();
3292 QCString title =
name();
3297 ldef = title =
"anonymous enum";
3320 std::string sdef = ldef.
str();
3331 int ep = ldef.
find(
"::");
3337 ldef=ldef.
left(sp+1)+ldef.
mid(ep+2);
3341 int dp = ldef.
find(
':');
3344 ldef=ldef.
left(dp+1);
3346 int l=
static_cast<int>(ldef.
length());
3349 while (i>=0 && (
isId(ldef.
at(i)) || ldef.
at(i)==
':')) i--;
3350 while (i>=0 && isspace(
static_cast<uint8_t
>(ldef.
at(i)))) i--;
3354 ldef =
"("+ldef.
left(i+1)+
")"+ldef.
mid(i+1);
3372 if (inGroup && fd && showGroupedMembInc && !nm.
isEmpty())
3418 langCorrected =
".doxygen_lex_c";
3422 intf->resetCodeParserState();
3427 codeOL.endCodeFragment(
"DoxyCode");
3434 int memCount,
int memTotal,
3444 bool hasParameterList =
FALSE;
3457 QCString scopeName = scName;
3458 QCString memAnchor =
anchor();
3460 const Definition *scopedContainer = container;
3466 ciname = (
toGroupDef(container))->groupTitle();
3474 QCString cname = container->
name();
3478 QCString doxyName=
name();
3482 doxyName.
prepend(scopeName+sep);
3487 QCString title =
name();
3491 if (title.
at(0)==
'@')
3493 ldef = title =
"anonymous enum";
3515 if (ldef.
at(0)==
'@')
3527 QCString
prefix = scName + sep;
3542 bool htmlEndLabelTable=
FALSE;
3545 static const reg::Ex r(R
"(@\d+)");
3547 std::string sdef = ldef.str();
3552 for (
const auto &vmd : *ml)
3554 if (vmd->isEnumerate() && match.str()==vmd->name())
3559 std::string
prefix = match.prefix().str();
3560 std::string suffix = match.suffix().str();
3575 ol.
startMemberDoc(ciname,
name(),memAnchor,
"["+typeName+
"]",memCount,memTotal,showInline);
3582 std::string
prefix = match.prefix().str();
3583 std::string suffix = match.suffix().str();
3617 if (!first) ol.
docify(
" ");
3633 if (!first) ol.
docify(
" ");
3657 htmlEndLabelTable=
TRUE;
3664 int ep = ldef.
find(
"::");
3670 ldef=ldef.
left(sp+1)+ldef.
mid(ep+2);
3672 ldef=ldef.
mid(ep+2);
3676 int dp = ldef.
find(
':');
3679 ldef=ldef.
left(dp+1);
3681 int dl=
static_cast<int>(ldef.
length());
3684 while (i>=0 && (
isId(ldef.
at(i)) || ldef.
at(i)==
':')) i--;
3685 while (i>=0 && isspace(
static_cast<uint8_t
>(ldef.
at(i)))) i--;
3689 ldef=
"("+ldef.
left(i+1)+
")"+ldef.
mid(i+1);
3714 const Definition *scope = cd;
3715 if (scope==
nullptr) scope = nd;
3726 const Definition *scope = cd;
3727 if (scope==
nullptr) scope = nd;
3754 hasParameterList=
true;
3764 for (
const auto &s : sl)
3773 if (hasParameterList)
3788 if (htmlEndLabelTable)
3791 ol.
writeString(
" <td class=\"mlabels-right\">\n");
3794 for (
const auto &s : sl)
3826 scopedContainer,
this,
3852 scopedContainer,
this,
3912 static const reg::Ex re1(R
"(\a\w*::)");
3913 static const reg::Ex re2(R
"(\a\w*<[^>]*>::)");
3915 std::string t = ts.
str();
3918 t = match.prefix().str() + match.suffix().str();
3939 QCString doxyName =
name();
3941 QCString memAnchor =
anchor();
3944 if (scope) cname = scope->
name();
3945 if (doxyName.
at(0)==
'@')
3947 doxyName=
"__unnamed__";
3969 const char *prefixes[] = {
"struct ",
"union ",
"class ",
nullptr };
3970 const char **p = prefixes;
4068 default:
return "unknown";
4082 const Definition *d=
nullptr;
4111 name().find(
'@')==-1 && d && d->
name().
find(
'@')==-1 &&
4133 if (!fmd->isLinkableInProject())
4137 warn(fmd->getDefFileName(),fmd->getDefLine(),
"Documentation for enum member '%s%s%s' is missing.",
4193 for (
auto it = al.
begin(); it!=al.
end() && allDoc; ++it)
4197 !(isPython && (a.
name==
"self" || a.
name==
"cls"))
4205 if (!allDoc && declAl.
empty())
4208 for (
auto it = al.
begin(); it!=al.
end() && allDoc; ++it)
4212 !(isPython && (a.
name==
"self" || a.
name==
"cls"))
4237 bool isFortranSubroutine = isFortran && returnType.
find(
"subroutine")!=-1;
4239 bool isVoidReturn = returnType==
"void" || returnType.
endsWith(
" void");
4240 if (!isVoidReturn && (returnType==
"auto" || returnType.
endsWith(
" auto")))
4246 isVoidReturn = (strippedTrailingReturn==
"void") || (strippedTrailingReturn.
endsWith(
" void"));
4260 "parameters of member %s are not documented",
4267 isFortranSubroutine ||
4274 "return type of member %s is not documented",
4281 isFortranSubroutine ||
4292 ClassDef *fcd=
nullptr;
4293 QCString baseName=
name();
4294 int i=baseName.
find(
'<');
4295 if (i!=-1) baseName=baseName.
left(i);
4329 QCString memAnchor =
name();
4356 uint8_t md5_sig[16];
4358 MD5Buffer(memAnchor.
data(),
static_cast<unsigned int>(memAnchor.
length()),md5_sig);
4359 MD5SigToString(md5_sig,sigStr);
4360 m_anc = QCString(
"a")+sigStr;
4364 const QCString &fileName,
int startLine,
4407 const ArgumentList &formalArgs,
const std::unique_ptr<ArgumentList> &actualArgs)
const
4410 std::unique_ptr<ArgumentList> actualArgList = std::make_unique<ArgumentList>(
m_defArgList);
4414 for (Argument &arg : *actualArgList)
4418 actualArgList->setTrailingReturnType(
4422 QCString methodName=
name();
4435 ArgumentList(), ArgumentList(),
""
4438 mmd->moveArgumentList(std::move(actualArgList));
4442 mmd->setFormalTemplateArguments(formalArgs);
4476 while (p>=0 && isspace(
static_cast<uint8_t
>(
m_initializer.at(p)))) p--;
4491 if (optimizeOutputForC)
4503 QCString memName =
name();
4523 memName =
"[" + pd->
name() +
" " +
name() +
"]";
4559 "Internal inconsistency: recursion detected in overload relation for member %s!"
4578 tagFile <<
" <member kind=\"";
4600 tagFile <<
"\" protection=\"";
4603 else tagFile <<
"private";
4607 tagFile <<
"\" virtualness=\"";
4609 else tagFile <<
"pure";
4613 tagFile <<
"\" static=\"yes";
4623 tagFile <<
" <anchorfile>" <<
convertToXML(fn) <<
"</anchorfile>\n";
4625 QCString idStr =
id();
4628 tagFile <<
" <clangid>" <<
convertToXML(idStr) <<
"</clangid>\n";
4635 if (!fmd->isReference())
4638 tagFile <<
"\" anchor=\"" <<
convertToXML(fmd->anchor());
4644 tagFile <<
"\">" <<
convertToXML(fmd->name()) <<
"</enumvalue>\n";
4649 tagFile <<
" </member>\n";
4667 else if (
name()==
"__init__" &&
4676 int i=locName.
find(
'<');
4713 else if (
name()==
"__del__" &&
4747 uint32_t numVisibleEnumValues=0;
4750 if (fmd->isBriefSectionVisible()) numVisibleEnumValues++;
4757 QCString n =
name();
4783 uint32_t enumValuesPerLine =
static_cast<uint32_t
>(
Config_getInt(ENUM_VALUES_PER_LINE));
4784 if (numVisibleEnumValues>0 && enumValuesPerLine>0)
4791 const MemberDef *fmd=*it;
4803 if (numVisibleEnumValues>enumValuesPerLine
4804 && (enumMemCount%enumValuesPerLine)==0
4820 fmd->
writeLink(typeDecl,cd,nd,fd,gd,mod);
4837 bool prevVisible = fmdVisible;
4855 if (numVisibleEnumValues>enumValuesPerLine)
4962 if (
isStatic()) qm=
"+";
else qm=
"-";
4997 if (
isStatic()) qm=
"+ ";
else qm=
"- ";
5584 auto decSrc = decAlSrc.
begin(), defSrc = defAlSrc.
begin();
5585 for (
auto decIt = decAl.
begin(), defIt = defAl.
begin();
5586 decIt != decAl.
end() && defIt != defAl.
end() && decSrc != decAlSrc.
end() && defSrc != defAlSrc.
end();
5587 ++decIt, ++defIt, ++decSrc, ++defSrc++)
5589 Argument &decA = *decIt;
5590 Argument &defA = *defIt;
5591 const Argument &decAS = *decSrc;
5592 const Argument &defAS = *defSrc;
5828 for (
const auto &sx : qualifiers)
6058 auto srcIt = srcAl.
begin();
6059 auto dstIt = dstAl.
begin();
6060 while ( srcIt!=srcAl.
end() && dstIt!=dstAl.
end())
6062 Argument &argDst = *dstIt;
6063 const Argument &argSrc = *srcIt;
6074 auto srcIt = srcAl.
begin();
6075 auto dstIt = dstAl.
begin();
6077 while ( srcIt!=srcAl.
end() && dstIt!=dstAl.
end())
6079 Argument &argDst = *dstIt;
6080 const Argument &argSrc = *srcIt;
6124 for (
auto decIt = decAl.
begin(), defIt = defAl.
begin();
6125 decIt!= decAl.
end() && defIt!= defAl.
end();
6154 AUTO_TRACE(
"mdec='{}' mdef='{}' mdec.isPrototype={} mdef.isPrototype={}",
6165 if (sameNumTemplateArgs &&
6320 bool hideFriendCompounds =
Config_getBool(HIDE_FRIEND_COMPOUNDS);
6322 (
m_type==
"friend class" ||
6323 m_type==
"friend struct" ||
6332 m_type==
"friend union"));
6390 if (src==
nullptr || dst==
nullptr)
return;
6468 return static_cast<const MemberDef*
>(d);
std::vector< ArgumentList > ArgumentLists
This class represents an function or template argument list.
RefQualifierType refQualifier() const
bool hasParameters() const
QCString trailingReturnType() const
bool constSpecifier() const
bool volatileSpecifier() const
A abstract class representing of a compound symbol.
virtual QCString compoundTypeString() const =0
Returns the type of compound as a string.
virtual int isBaseClass(const ClassDef *bcd, bool followInstances, const QCString &templSpec=QCString()) const =0
Returns TRUE iff bcd is a direct or indirect base class of this class.
virtual ArgumentLists getTemplateParameterLists() const =0
Returns the template parameter lists that form the template declaration of this class.
virtual bool isObjectiveC() const =0
Returns TRUE if this class is implemented in Objective-C.
virtual bool isSimple() const =0
virtual ClassDef * categoryOf() const =0
Returns the class of which this is a category (Objective-C only)
virtual void writeDeclaration(OutputList &ol, const MemberDef *md, bool inGroup, int indentLevel, const ClassDef *inheritedFrom, const QCString &inheritId) const =0
virtual CompoundType compoundType() const =0
Returns the type of compound this is, i.e.
const Definition * getAlias() const
const Definition * getScope() const
DefinitionAliasMixin(const Definition *scope, const Definition *alias)
The common base class of all entity definitions found in the sources.
virtual QCString docFile() const =0
virtual const QCString & localName() 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 QCString getDefFileName() const =0
virtual bool isLinkable() const =0
virtual int getDefLine() const =0
virtual DefType definitionType() const =0
virtual QCString anchor() 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 id() const =0
virtual bool isLinkableInProject() const =0
virtual QCString briefDescription(bool abbreviate=FALSE) const =0
virtual bool hasUserDocumentation() const =0
virtual bool isAnonymous() const =0
virtual QCString getReference() const =0
virtual QCString documentation() const =0
virtual QCString qualifiedName() const =0
virtual QCString displayName(bool includeScope=TRUE) const =0
virtual QCString briefFile() const =0
virtual CodeSymbolType codeSymbolType() const =0
virtual QCString getOutputFileBase() const =0
virtual Definition * getOuterScope() const =0
virtual int getStartBodyLine() const =0
virtual bool isReference() const =0
virtual QCString inbodyDocumentation() const =0
virtual QCString inbodyFile() const =0
virtual const QCString & name() const =0
int getDefLine() const override
bool isReference() const override
const QCString & name() const override
void writeSourceDef(OutputList &ol) const override
bool hasUserDocumentation() const override
QCString inbodyFile() const override
QCString getDefFileName() const override
bool isExported() const override
void writeSourceRefs(OutputList &ol, const QCString &scopeName) const override
bool hasBriefDescription() const override
QCString docFile() const override
QCString getDefFileExtension() const override
bool hasSources() const override
QCString briefFile() const override
QCString qualifiedName() const override
bool isAnonymous() const override
QCString id() const override
void setOuterScope(Definition *def) override
void setDocumentation(const QCString &doc, const QCString &docFile, int docLine, bool stripWhiteSpace=TRUE) override
void setReference(const QCString &r) override
QCString getSourceFileBase() const override
const RefItemVector & xrefListItems() const override
QCString briefDescription(bool abbreviate=FALSE) const override
bool hasSourceReffedBy() const override
void setBriefDescription(const QCString &brief, const QCString &briefFile, int briefLine) override
void writeSourceReffedBy(OutputList &ol, const QCString &scopeName) const override
Definition * getOuterScope() const override
void setInbodyDocumentation(const QCString &doc, const QCString &docFile, int docLine) override
QCString getReference() const override
DefinitionMixin(const QCString &defFileName, int defLine, int defColumn, const QCString &name, const char *b=nullptr, const char *d=nullptr, bool isSymbol=TRUE)
int getEndBodyLine() const override
const QCString & localName() const override
bool hasSourceRefs() const override
void writeInlineCode(OutputList &ol, const QCString &scopeName) const override
bool isHidden() const override
const FileDef * getBodyDef() const override
int getStartBodyLine() const override
void setDefFile(const QCString &df, int defLine, int defColumn) override
QCString inbodyDocumentation() const override
int docLine() const override
int inbodyLine() const override
void setHidden(bool b) override
int briefLine() const override
QCString documentation() const override
int getDefColumn() const override
void writeDocAnchorsToTagFile(TextStream &fs) const override
bool hasDocumentation() const override
SrcLangExt getLanguage() const override
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 addSourceReferences(MemberDef *d, const QCString &sourceRefName)=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 void addSourceReferencedBy(MemberDef *d, const QCString &sourceRefName)=0
static bool suppressDocWarnings
static bool parseSourcesNeeded
static ParserManager * parserManager
static NamespaceDefMutable * globalScope
A model of a file symbol.
virtual const QCString & docName() const =0
A model of a group of symbols.
bool hasEnumValues() const override
bool isConstEval() const override
const ClassDef * getCachedTypedefVal() const override
NamespaceDef * getNamespaceDef() override
const NamespaceDef * getNamespaceDef() const override
bool hasExamples() const override
GroupDef * getGroupDef() override
QCString getDeclFileName() const override
QCString argsString() const override
bool isSettable() const override
bool isConstrained() const override
bool getGroupHasDocs() const override
const ClassDef * getClassDef() const override
const MemberDef * inheritsDocsFrom() const override
bool hasCallerGraph() const override
QCString enumBaseType() const override
bool isConstInit() const override
bool isFinal() const override
const MemberDef * reimplements() const override
bool isOptional() const override
QCString getOutputFileBase() const override
bool isTypeAlias() const override
bool isRequired() const override
bool isRemovable() const override
void setMemberGroup(MemberGroup *grp) override
bool isDeleted() const override
bool isPrivateGettable() const override
bool isSignal() const override
MemberDef * memberDeclaration() const override
bool isFriendClass() const override
const MemberDef * getGroupAlias() const override
bool isStrongEnumValue() const override
bool isAssign() const override
QCString getReadAccessor() const override
int getGroupStartLine() const override
std::unique_ptr< MemberDef > deepCopy() const override
bool isUNOProperty() const override
void warnIfUndocumented() const override
bool hasUserDocumentation() const override
bool isSliceLocal() const override
const ArgumentLists & definitionTemplateParameterLists() const override
bool isPublished() const override
bool isSequence() const override
bool isDictionary() const override
bool isVariable() const override
FileDef * getFileDef() override
ClassDef * getClassDefOfAnonymousType() const override
QCString getCachedResolvedTypedef() const override
const MemberDef * templateMaster() const override
void warnIfUndocumentedParams() const override
bool isExternal() const override
bool isProperty() const override
bool isWritable() const override
bool isDocumentedFriendClass() const override
bool isConstExpr() const override
int initializerLines() const override
bool isMaybeVoid() const override
int getMemberGroupId() const override
bool isInitonly() const override
const ExampleList & getExamples() const override
bool hasOneLineInitializer() const override
bool isProtectedGettable() const override
bool hasDocumentation() const override
bool livesInsideEnum() const override
QCString declaration() const override
bool hasCallGraph() const override
bool isCopy() const override
int getDeclLine() const override
bool isEnumerate() const override
void writeLink(OutputList &ol, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, const ModuleDef *mod, bool onlyText=FALSE) const override
const QCString & initializer() const override
bool isReference() const override
TypeSpecifier getMemberSpecifiers() const override
QCString getReference() const override
bool hasMultiLineInitializer() const override
QCString getCachedTypedefTemplSpec() const override
bool isDocsForDefinition() const override
Grouping::GroupPri_t getGroupPri() const override
bool isTypedefValCached() const override
const ClassDef * accessorClass() const override
bool isRaisable() const override
bool isUnretained() const override
bool isGettable() const override
const MemberVector & enumFieldList() const override
bool isObjCProperty() const override
int getDeclColumn() const override
const ArgumentList & declArgumentList() const override
bool isCallable() const override
bool isDefine() const override
bool isLinkableInProject() const override
bool hasDetailedDescription() const override
bool isFriendToHide() const override
QCString excpString() const override
QCString getDeclType() const override
QCString briefDescription(bool) const override
QCString objCMethodName(bool localLink, bool showStatic) const override
const GroupDef * getGroupDef() const override
bool isDestructor() const override
bool isNoDiscard() const override
bool hasDocumentedEnumValues() const override
bool isBound() const override
void detectUndocumentedParams(bool, bool) const override
bool fromAnonymousScope() const override
bool isFunctionPtr() const override
StringVector getLabels(const Definition *container) const override
QCString memberTypeName() const override
std::unique_ptr< MemberDef > createTemplateInstanceMember(const ArgumentList &formalArgs, const std::unique_ptr< ArgumentList > &actualArgs) const override
bool isAddable() const override
QCString getScopeString() const override
QCString getGroupFileName() const override
QCString extraTypeChars() const override
const ArgumentList & argumentList() const override
const ArgumentList & typeConstraints() const override
Specifier virtualness(int) const override
bool isFunctionOrSignalSlot() const override
bool isDefault() const override
bool isPrototype() const override
bool isAttribute() const override
MemberDef * memberDefinition() const override
bool isTypedef() const override
bool isNoExcept() const override
QCString displayDefinition() const override
bool isInline() const override
bool isRelatedOrFriend() const override
bool hasReferencesRelation() const override
bool isStrong() const override
const MemberDef * getMdAlias() const
bool isObjCMethod() const override
bool isAbstract() const override
bool isStatic() const override
bool isPrivateSettable() const override
bool isSealed() const override
bool isRelated() const override
bool isOverride() const override
bool isForeign() const override
bool isImplementation() const override
QCString anchor() const override
const MemberVector & reimplementedBy() const override
VhdlSpecifier getVhdlSpecifiers() const override
bool isMaybeDefault() const override
MemberType memberType() const override
bool isLinkable() const override
bool isProtectedSettable() const override
bool isReadonly() const override
const MemberDef * categoryRelation() const override
ClassDef * getClassDef() override
MemberDefAliasImpl(const Definition *newScope, const MemberDef *md)
const MemberDef * getEnumScope() const override
Protection protection() const override
bool isSlot() const override
const QCString & name() const override
bool isDelete() const override
bool isReadable() const override
bool isEvent() const override
QCString definition() const override
bool isNonAtomic() const override
QCString getWriteAccessor() const override
QCString bitfieldString() const override
DefType definitionType() const override
bool isReimplementedBy(const ClassDef *cd) const override
bool isDCOP() const override
void writeEnumDeclaration(OutputList &typeDecl, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, const ModuleDef *mod) const override
bool isDetailedSectionVisible(MemberListContainer container) const override
bool isNotFriend() const override
void writeDeclaration(OutputList &ol, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, const ModuleDef *mod, bool inGroup, int indentLevel, const ClassDef *inheritFrom=nullptr, const QCString &inheritId=QCString()) const override
const MemberList * getSectionList(const Definition *container) const override
bool isTemplateSpecialization() const override
QCString typeString() const override
const ModuleDef * getModuleDef() const override
bool isExplicit() const override
CodeSymbolType codeSymbolType() const override
MemberDef * fromAnonymousMember() const override
bool isConstructor() const override
bool isTransient() const override
int numberOfFlowKeyWords() const override
bool isFriend() const override
bool isWeak() const override
bool isMutable() const override
QCString requiresClause() const override
MemberDef * resolveAlias() override
const FileDef * getFileDef() const override
QCString fieldType() const override
std::optional< ArgumentList > formalTemplateArguments() const override
const MemberDef * resolveAlias() const override
bool isEnumValue() const override
bool isNew() const override
const MemberDef * getAnonymousEnumType() const override
bool isMaybeAmbiguous() const override
bool hasReferencedByRelation() const override
bool isCSharpProperty() const override
bool hasInlineSource() const override
ClassDef * category() const override
void moveTo(Definition *) override
MemberGroup * getMemberGroup() const override
MemberGroup * m_memberGroup
bool isFunction() const override
QCString displayName(bool b=TRUE) const override
bool visibleInIndex() const override
QCString sourceRefName() const override
ClassDef * relatedAlso() const override
bool isRetain() const override
bool isEnumStruct() const override
QCString documentation() const override
bool isBriefSectionVisible() const override
const ArgumentList & templateArguments() const override
~MemberDefAliasImpl() override
StringVector getQualifiers() const override
QCString qualifiedName() const override
A model of a class/file/namespace member symbol.
virtual QCString typeString() const =0
virtual bool isConstExpr() const =0
virtual bool getGroupHasDocs() const =0
virtual const MemberDef * getAnonymousEnumType() const =0
virtual bool isConstEval() const =0
virtual bool isInitonly() const =0
virtual bool isSignal() const =0
virtual bool isNoExcept() const =0
virtual QCString requiresClause() const =0
virtual bool isDestructor() const =0
virtual bool hasDetailedDescription() const =0
virtual bool isAssign() const =0
virtual bool isExplicit() const =0
virtual MemberDef * memberDefinition() const =0
virtual bool isNew() const =0
virtual QCString declaration() const =0
virtual QCString getCachedResolvedTypedef() const =0
virtual bool isObjCMethod() const =0
virtual bool hasDocumentedEnumValues() const =0
virtual MemberDef * memberDeclaration() const =0
virtual bool isMaybeVoid() const =0
virtual bool isConstructor() const =0
virtual bool isFriend() const =0
virtual void writeEnumDeclaration(OutputList &typeDecl, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, const ModuleDef *mod) const =0
virtual const ClassDef * accessorClass() const =0
virtual bool isForeign() const =0
virtual bool isSealed() const =0
virtual QCString definition() const =0
virtual bool hasExamples() const =0
virtual QCString enumBaseType() const =0
virtual bool isDelete() const =0
virtual void writeDeclaration(OutputList &ol, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, const ModuleDef *md, bool inGroup, int indentLevel=0, const ClassDef *inheritFrom=nullptr, const QCString &inheritId=QCString()) const =0
virtual int numberOfFlowKeyWords() const =0
virtual const MemberDef * inheritsDocsFrom() const =0
virtual bool isDefault() const =0
virtual bool isRelated() const =0
virtual bool isDocumentedFriendClass() const =0
virtual bool isConstInit() const =0
virtual bool fromAnonymousScope() const =0
virtual bool isDeleted() const =0
virtual const ClassDef * getCachedTypedefVal() const =0
virtual bool isRelatedOrFriend() const =0
virtual QCString fieldType() const =0
virtual QCString excpString() const =0
virtual bool isSequence() const =0
virtual bool isEnumStruct() const =0
virtual const ClassDef * getClassDef() const =0
virtual bool visibleInIndex() const =0
virtual const MemberDef * getGroupAlias() const =0
virtual bool isOverride() const =0
virtual bool hasReferencesRelation() const =0
virtual const ArgumentList & templateArguments() const =0
virtual GroupDef * getGroupDef()=0
virtual bool isSettable() const =0
virtual MemberDef * fromAnonymousMember() const =0
virtual bool isCSharpProperty() const =0
virtual bool isRetain() const =0
virtual bool isAddable() const =0
virtual bool isTypedef() const =0
virtual ClassDef * category() const =0
virtual bool isSlot() const =0
virtual const MemberVector & enumFieldList() const =0
virtual bool hasCallGraph() const =0
virtual const FileDef * getFileDef() const =0
virtual bool isInline() const =0
virtual bool isEvent() const =0
virtual const ArgumentList & argumentList() const =0
virtual QCString extraTypeChars() const =0
virtual bool isWritable() const =0
virtual bool isMaybeAmbiguous() const =0
virtual bool isPrivateGettable() const =0
virtual bool isStrongEnumValue() const =0
virtual VhdlSpecifier getVhdlSpecifiers() const =0
virtual const MemberVector & reimplementedBy() const =0
virtual int getGroupStartLine() const =0
virtual bool isFunction() const =0
virtual bool isRequired() const =0
virtual bool isAttribute() const =0
virtual bool isExternal() const =0
virtual QCString sourceRefName() const =0
virtual bool isCopy() const =0
virtual QCString displayDefinition() const =0
virtual QCString getScopeString() const =0
virtual int getMemberGroupId() const =0
virtual bool isDictionary() const =0
virtual int getDeclLine() const =0
virtual bool isTypeAlias() const =0
virtual QCString getDeclType() const =0
virtual int getDeclColumn() const =0
virtual bool isStatic() const =0
virtual const MemberDef * reimplements() const =0
virtual bool isMaybeDefault() const =0
virtual bool livesInsideEnum() const =0
virtual QCString getWriteAccessor() const =0
virtual bool hasInlineSource() const =0
virtual bool isTemplateSpecialization() const =0
virtual bool isPrivateSettable() const =0
virtual StringVector getQualifiers() const =0
virtual QCString getCachedTypedefTemplSpec() const =0
virtual QCString bitfieldString() const =0
virtual bool isRaisable() const =0
virtual bool isRemovable() const =0
virtual bool isTypedefValCached() const =0
virtual bool isConstrained() const =0
virtual bool isDocsForDefinition() const =0
virtual bool isBound() const =0
virtual bool hasEnumValues() const =0
virtual bool isFriendToHide() const =0
virtual bool isReimplementedBy(const ClassDef *cd) const =0
virtual bool isNonAtomic() const =0
virtual const ModuleDef * getModuleDef() const =0
virtual bool isDefine() const =0
virtual ClassDef * getClassDefOfAnonymousType() const =0
virtual const NamespaceDef * getNamespaceDef() const =0
virtual bool isPublished() const =0
virtual bool isFunctionPtr() const =0
virtual std::unique_ptr< MemberDef > createTemplateInstanceMember(const ArgumentList &formalArgs, const std::unique_ptr< ArgumentList > &actualArgs) const =0
virtual bool hasCallerGraph() const =0
virtual Grouping::GroupPri_t getGroupPri() const =0
virtual QCString getDeclFileName() const =0
virtual const ArgumentList & typeConstraints() const =0
virtual bool isProtectedSettable() const =0
virtual bool isImplementation() const =0
virtual bool isProtectedGettable() const =0
virtual QCString objCMethodName(bool localLink, bool showStatic) const =0
virtual bool hasOneLineInitializer() const =0
virtual const MemberDef * templateMaster() const =0
virtual std::optional< ArgumentList > formalTemplateArguments() const =0
virtual bool isObjCProperty() const =0
virtual bool isTransient() const =0
virtual const MemberList * getSectionList(const Definition *container) const =0
virtual bool hasMultiLineInitializer() const =0
virtual Protection protection() const =0
virtual TypeSpecifier getMemberSpecifiers() const =0
virtual bool isOptional() const =0
virtual QCString getReadAccessor() const =0
virtual bool isEnumerate() const =0
virtual bool isGettable() const =0
virtual MemberType memberType() const =0
virtual bool hasReferencedByRelation() const =0
virtual bool isFunctionOrSignalSlot() const =0
virtual bool isReadable() const =0
virtual bool isWeak() const =0
virtual bool isNoDiscard() const =0
virtual QCString memberTypeName() const =0
virtual bool isUnretained() const =0
virtual QCString getGroupFileName() const =0
virtual void writeLink(OutputList &ol, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, const ModuleDef *md, bool onlyText=FALSE) const =0
virtual ClassDef * relatedAlso() const =0
virtual bool isBriefSectionVisible() const =0
virtual const ArgumentLists & definitionTemplateParameterLists() const =0
virtual StringVector getLabels(const Definition *container) const =0
virtual bool isVariable() const =0
virtual bool isNotFriend() const =0
virtual bool isDCOP() const =0
virtual bool isStrong() const =0
virtual QCString argsString() const =0
virtual bool isSliceLocal() const =0
virtual Specifier virtualness(int count=0) const =0
virtual bool isUNOProperty() const =0
virtual const MemberDef * categoryRelation() const =0
virtual int initializerLines() const =0
virtual bool isFinal() const =0
virtual const ArgumentList & declArgumentList() const =0
virtual const ExampleList & getExamples() const =0
virtual bool isAbstract() const =0
virtual bool isMutable() const =0
virtual bool isFriendClass() const =0
virtual bool isCallable() const =0
virtual bool isDetailedSectionVisible(MemberListContainer container) const =0
virtual const MemberDef * getEnumScope() const =0
virtual bool isEnumValue() const =0
virtual bool isPrototype() const =0
virtual bool isProperty() const =0
virtual const QCString & initializer() const =0
bool _hasVisibleCallerGraph() const
void writeDocumentation(const MemberList *ml, int memCount, int memTotal, OutputList &ol, const QCString &scopeName, const Definition *container, bool inGroup, bool showEnumValues=FALSE, bool showInline=FALSE) const override
void _writeCallerGraph(OutputList &ol) const
void insertReimplementedBy(MemberDef *md) override
bool isDCOP() const override
QCString sourceRefName() const override
bool isDetailedSectionVisible(MemberListContainer container) const override
bool _isReimplements() const
bool isFunction() const override
int getDeclColumn() const override
void overrideReferencesRelation(bool e) override
const MemberDef * reimplements() const override
int getMemberGroupId() const override
bool isProperty() const override
bool visibleInIndex() const override
const ArgumentList & argumentList() const override
void setDocumentedEnumValues(bool value) override
bool m_detailedDescriptionCachedValue
bool isTypedefValCached() const override
void setTemplateMaster(MemberDef *mt) override
bool isInline() const override
const ExampleList & getExamples() const override
ArgumentLists m_defTmpArgLists
bool isFriendToHide() const override
void setFromAnonymousScope(bool b) override
bool fromAnonymousScope() const override
void invalidateTypedefValCache() override
ClassDef * accessorClass() const override
bool isFriendClass() const override
void setNamespace(NamespaceDef *nd) override
void setProtection(Protection p) override
const NamespaceDef * getNamespaceDef() const override
void setHidden(bool b) override
void _writeEnumValues(OutputList &ol, const Definition *container, const QCString &cfname, const QCString &ciname, const QCString &cname) const
void _writeTypeConstraints(OutputList &ol) const
bool isSliceLocal() const override
void makeRelated() override
int getGroupStartLine() const override
void warnIfUndocumented() const override
bool m_hasReferencedByRelation
void setDefinition(const QCString &d) override
QCString objCMethodName(bool localLink, bool showStatic) const override
void setMemberType(MemberType t) override
QCString getWriteAccessor() const override
const ArgumentList & typeConstraints() const override
DefType definitionType() const override
void setEnumBaseType(const QCString &type) override
bool isDestructor() const override
StringVector getQualifiers() const override
QCString qualifiedName() const override
void setAnonymousEnumType(const MemberDef *md) override
bool isOptional() const override
void _writeExamples(OutputList &ol) const
void moveTo(Definition *) override
bool isCallable() const override
QCString getCachedResolvedTypedef() const override
QCString anchor() const override
bool isBriefSectionVisible() const override
const MemberDef * m_categoryRelation
void init(Definition *def, const QCString &t, const QCString &a, const QCString &e, Protection p, Specifier v, bool s, Relationship r, MemberType mt, const ArgumentList &tal, const ArgumentList &al, const QCString &meta)
bool addExample(const QCString &anchor, const QCString &name, const QCString &file) override
void setCategoryRelation(const MemberDef *) override
bool isReference() const override
QCString extraTypeChars() const override
QCString getDeclType() const override
void warnIfUndocumentedParams() const override
VhdlSpecifier getVhdlSpecifiers() const override
bool _hasVisibleCallGraph() const
void setFormalTemplateArguments(const ArgumentList &al) override
bool isDefine() const override
void findSectionsInDocumentation() override
ClassDef * getClassDefOfAnonymousType() const override
QCString briefDescription(bool abbr=FALSE) const override
void setFileDef(FileDef *fd) override
const MemberDef * resolveAlias() const override
ArgumentList m_declArgList
std::unique_ptr< MemberDef > deepCopy() const override
void makeForeign() override
uint8_t m_isConstructorCached
bool hasMultiLineInitializer() const override
bool hasCallGraph() const override
QCString memberTypeName() const override
void _writeReimplementedBy(OutputList &ol) const
bool isNew() const override
void setMaxInitLines(int lines) override
void writeDeclaration(OutputList &ol, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, const ModuleDef *mod, bool inGroup, int indentLevel, const ClassDef *inheritFrom=nullptr, const QCString &inheritId=QCString()) const override
bool isDocsForDefinition() const override
const QCString & initializer() const override
void setEnumClassScope(ClassDef *cd) override
bool isUnretained() const override
bool isGettable() const override
MemberGroup * getMemberGroup() const override
bool hasUserDocumentation() const override
std::optional< ArgumentList > formalTemplateArguments() const override
std::map< const Definition *, const MemberList * > m_sectionMap
bool isEnumValue() const override
bool isObjCMethod() const override
MemberDef * memberDefinition() const override
bool m_isTypedefValCached
bool m_hasDocumentedReturnType
void setFromAnonymousMember(MemberDef *m) override
QCString m_extraTypeChars
StringVector m_qualifiers
void overrideCallGraph(bool e) override
void setInheritsDocsFrom(const MemberDef *md) override
void setAccessorType(ClassDef *cd, const QCString &t) override
void setType(const QCString &t) override
Specifier virtualness(int count=0) const override
ClassDefMutable * getClassDefMutable() override
bool hasDetailedDescription() const override
void setMemberGroupId(int id) override
QCString bitfieldString() const override
bool isCSharpProperty() const override
void setSectionList(const Definition *container, const MemberList *sl) override
QCString definition() const override
bool isRaisable() const override
void setDocumentation(const QCString &d, const QCString &docFile, int docLine, bool stripWhiteSpace=TRUE) override
std::unique_ptr< MemberDef > createTemplateInstanceMember(const ArgumentList &formalArgs, const std::unique_ptr< ArgumentList > &actualArgs) const override
const GroupDef * getGroupDef() const override
bool isRelatedOrFriend() const override
void insertEnumField(MemberDef *md) override
bool isMutable() const override
bool isPublished() const override
bool isLinkableInProject() const override
bool isProtectedSettable() const override
QCString getDeclFileName() const override
void setMemberGroup(MemberGroup *grp) override
void setMemberDeclaration(MemberDef *md) override
QCString enumBaseType() const override
bool isUNOProperty() const override
bool m_hasDocumentedParams
bool m_hasReferencesRelation
void _computeIsConstructor()
QCString displayName(bool=TRUE) const override
size_t _countReimplementedBy() const
bool isRequired() const override
const MemberVector & reimplementedBy() const override
bool isStrong() const override
MemberDef * fromAnonymousMember() const override
void moveDeclArgumentList(std::unique_ptr< ArgumentList > al) override
bool isTypeAlias() const override
void setMemberClass(ClassDef *cd) override
QCString excpString() const override
const MemberDef * templateMaster() const override
void setDocsForDefinition(bool b) override
const ClassDef * getCachedTypedefVal() const override
int initializerLines() const override
void setBitfields(const QCString &s) override
bool getGroupHasDocs() const override
const MemberDef * getEnumScope() const override
QCString argsString() const override
bool isMaybeDefault() const override
bool isReimplementedBy(const ClassDef *cd) const override
StringVector getLabels(const Definition *container) const override
bool isTransient() const override
ArgumentList m_defArgList
MemberDef * memberDeclaration() const override
std::optional< ArgumentList > m_formalTemplateArguments
bool isInitonly() const override
bool isAddable() const override
bool isRelated() const override
void moveArgumentList(std::unique_ptr< ArgumentList > al) override
const ClassDef * m_cachedTypedefValue
void setCategory(ClassDef *) override
uint8_t m_isDestructorCached
MemberType memberType() const override
QCString getScopeString() const override
Protection protection() const override
bool isConstructor() const override
void setGroupAlias(const MemberDef *md) override
bool isEnumerate() const override
const ArgumentList & templateArguments() const override
bool isCopy() const override
MemberDef * m_templateMaster
bool isReadonly() const override
QCString declaration() const override
ClassDef * m_accessorClass
void setTagInfo(const TagInfo *i) override
const ArgumentLists & definitionTemplateParameterLists() const override
void _writeTemplatePrefix(OutputList &ol, const Definition *def, const ArgumentList &al, bool writeReqClause=true) const
bool isStatic() const override
void writeTagFile(TextStream &, bool useQualifiedName, bool showNamespaceMembers) const override
MemberDef * resolveAlias() override
bool isFinal() const override
QCString m_requiresClause
bool isAttribute() const override
const MemberDef * m_enumScope
bool isDictionary() const override
bool isSlot() const override
bool hasInlineSource() const override
void addListReference(Definition *d) override
void setAnchor() override
MemberGroup * m_memberGroup
const MemberDef * m_groupAlias
bool isRetain() const override
MemberVector m_redefinedBy
ClassDef * category() const override
void overrideEnumValues(bool e) override
bool isDocumentedFriendClass() const override
bool isConstEval() const override
bool hasReferencesRelation() const override
void _writeTagData(const DefType) const
void overrideReferencedByRelation(bool e) override
bool isEnumStruct() const override
bool hasEnumValues() const override
void setInbodyDocumentation(const QCString &d, const QCString &inbodyFile, int inbodyLine) override
bool isExplicit() const override
void _writeCategoryRelation(OutputList &ol) const
void setTemplateSpecialization(bool b) override
bool isTemplateSpecialization() const override
void setInitializer(const QCString &i) override
QCString fieldType() const override
const MemberDef * inheritsDocsFrom() const override
int getDeclLine() const override
void setTypeConstraints(const ArgumentList &al) override
void setVhdlSpecifiers(VhdlSpecifier s) override
bool isImplementation() const override
void _writeMultiLineInitializer(OutputList &ol, const QCString &scopeName) const
bool livesInsideEnum() const override
bool isDelete() const override
void setEnumScope(MemberDef *md, bool livesInsideEnum=FALSE) override
QCString getCachedTypedefTemplSpec() const override
void setGroupDef(GroupDef *gd, Grouping::GroupPri_t pri, const QCString &fileName, int startLine, bool hasDocs, MemberDef *member=nullptr) override
bool isNoExcept() const override
QCString getOutputFileBase() const override
bool isWeak() const override
const MemberDef * getAnonymousEnumType() const override
const ModuleDef * getModuleDef() const override
void setRequiresClause(const QCString &req) override
bool isNoDiscard() const override
void setPrototype(bool p, const QCString &df, int line, int column) override
void incrementFlowKeyWordCount() override
const MemberDef * getGroupAlias() const override
bool isConstInit() const override
void setModuleDef(ModuleDef *mod) override
TypeSpecifier getMemberSpecifiers() const override
bool hasReferencedByRelation() const override
void setDeclFile(const QCString &df, int line, int column) override
void makeImplementationDetail() override
Grouping::GroupPri_t getGroupPri() const override
bool isLinkable() const override
bool hasDocumentation() const override
int numberOfFlowKeyWords() const override
bool isProtectedGettable() const override
bool m_hasDetailedDescriptionCached
void setDefinitionTemplateParameterLists(const ArgumentLists &lists) override
const ArgumentList & declArgumentList() const override
void invalidateCachedArgumentTypes() override
bool _isAnonymousBitField() const
QCString m_cachedTypedefTemplSpec
void detectUndocumentedParams(bool hasParamCommand, bool hasReturnCommand) const override
const MemberDef * m_annEnumType
bool isWritable() const override
bool isSealed() const override
void setWriteAccessor(const QCString &w) override
bool isAbstract() const override
bool isPrivateSettable() const override
void setArgsString(const QCString &as) override
QCString getReference() const override
bool isSequence() const override
void _computeLinkableInProject()
MemberDefImpl(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)
Grouping::GroupPri_t m_grouppri
void setRelatedAlso(ClassDef *cd) override
bool hasExamples() const override
void resolveUnnamedParameters(const MemberDef *md) override
void setMemberDefinition(MemberDef *md) override
void writeMemberDocSimple(OutputList &ol, const Definition *container) const override
void cacheTypedefVal(const ClassDef *val, const QCString &templSpec, const QCString &resolvedType) override
QCString documentation() const override
bool isSignal() const override
bool isMaybeVoid() const override
void _writeReimplements(OutputList &ol) const
bool isMaybeAmbiguous() const override
bool hasOneLineInitializer() const override
const MemberList * getSectionList(const Definition *) const override
void setReadAccessor(const QCString &r) override
bool isForeign() const override
void addQualifiers(const StringVector &qualifiers) override
QCString typeString() const override
bool isAssign() const override
bool isStrongEnumValue() const override
void _computeIsDestructor()
bool isNotFriend() const override
void copyArgumentNames(const MemberDef *bmd) override
bool isRemovable() const override
bool isDeleted() const override
MemberDef * m_groupMember
bool isFriend() const override
ArgumentList m_typeConstraints
ClassDef * relatedAlso() const override
void setReimplements(MemberDef *md) override
MemberVector m_enumFields
void writeEnumDeclaration(OutputList &typeDecl, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, const ModuleDef *mod) const override
bool isConstExpr() const override
QCString getGroupFileName() const override
bool isExternal() const override
const FileDef * getFileDef() const override
bool isNonAtomic() const override
const MemberDef * categoryRelation() const override
const MemberVector & enumFieldList() const override
const ClassDef * getClassDef() const override
bool isFunctionOrSignalSlot() const override
void overrideInlineSource(bool e) override
void overrideCallerGraph(bool e) override
bool isPrivateGettable() const override
void setExplicitExternal(bool b, const QCString &df, int line, int column) override
bool isEvent() const override
ClassDef * m_cachedAnonymousType
void setMemberSpecifiers(TypeSpecifier s) override
bool isFunctionPtr() const override
QCString m_cachedResolvedType
bool hasCallerGraph() const override
bool isObjCProperty() const override
bool isPrototype() const override
bool isTypedef() const override
void _writeGroupInclude(OutputList &ol, bool inGroup) const
bool hasDocumentedEnumValues() const override
~MemberDefImpl() override=default
uint8_t m_isLinkableCached
bool isVariable() const override
void mergeMemberSpecifiers(TypeSpecifier s) override
QCString requiresClause() const override
bool isConstrained() const override
bool isReadable() const override
QCString getReadAccessor() const override
void writeLink(OutputList &ol, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, const ModuleDef *mod, bool onlyText=FALSE) const override
QCString m_explicitOutputFileBase
void setBriefDescription(const QCString &b, const QCString &briefFile, int briefLine) override
bool isDefault() const override
void _writeCallGraph(OutputList &ol) const
bool isOverride() const override
const MemberDef * m_docProvider
bool isSettable() const override
bool isBound() const override
CodeSymbolType codeSymbolType() const override
QCString displayDefinition() const override
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
virtual void insertReimplementedBy(MemberDef *md)=0
A class representing a group of members.
A list of MemberDef objects as shown in documentation sections.
A vector of MemberDef object.
iterator begin() noexcept
An abstract interface of a namespace symbol.
virtual QCString compoundTypeString() const =0
void startCodeFragment(const QCString &style)
Class representing a list of output generators that are written to in parallel.
bool isEnabled(OutputType o)
void writeString(const QCString &text)
void startMemberDeclaration()
void startMemberDoc(const QCString &clName, const QCString &memName, const QCString &anchor, const QCString &title, int memCount, int memTotal, bool showInline)
void startMemberDocName(bool align)
void endParameterExtra(bool last, bool one, bool bracket)
void disable(OutputType o)
void endMemberTemplateParams(const QCString &anchor, const QCString &inheritId)
void endMemberDoc(bool hasArgs)
void startDescTableInit()
void startParameterExtra()
const OutputCodeList & codeGenerators() const
void startParameterList(bool openBracket)
void enable(OutputType o)
void endInlineMemberType()
void endMemberDescription()
void writeObjectLink(const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name)
void startInlineMemberType()
void startInlineMemberDoc()
void writeDoc(const IDocNodeAST *ast, const Definition *ctx, const MemberDef *md)
void startMemberDescription(const QCString &anchor, const QCString &inheritId=QCString(), bool typ=false)
void endDoxyAnchor(const QCString &fn, const QCString &anchor)
void docify(const QCString &s)
void startParagraph(const QCString &classDef=QCString())
void exceptionEntry(const QCString &prefix, bool closeBracket)
void addIndexItem(const QCString &s1, const QCString &s2)
void startDescTableTitle()
void endInlineMemberDoc()
void endMemberDocPrefixItem()
void startParameterDefVal(const char *separator)
void startAnonTypeScope(int i1)
void endMemberItem(OutputGenerator::MemberItemType type)
void startDescTable(const QCString &title, const bool hasInits)
void generateDoc(const QCString &fileName, int startLine, const Definition *ctx, const MemberDef *md, const QCString &docStr, bool indexWords, bool isExample, const QCString &exampleName, bool singleLine, bool linkFromIndex, bool markdownSupport)
void addLabel(const QCString &fName, const QCString &anchor)
void startDescTableData()
void pushGeneratorState()
void insertMemberAlign(bool templ=FALSE)
void endParameterDefVal()
void startParameterType(bool first, const QCString &key)
void disableAllBut(OutputType o)
void startDoxyAnchor(const QCString &fName, const QCString &manName, const QCString &anchor, const QCString &name, const QCString &args)
void endCallGraph(DotCallGraph &g)
void startInlineMemberName()
void writeLabel(const QCString &l, bool isLast)
void startMemberDocPrefixItem()
void endAnonTypeScope(int i1)
void endMemberDeclaration(const QCString &anchor, const QCString &inheritId)
void startParameterName(bool one)
void startMemberItem(const QCString &anchor, OutputGenerator::MemberItemType type, const QCString &id=QCString())
void endInlineMemberName()
void lineBreak(const QCString &style=QCString())
void parseText(const QCString &textStr)
void writeNonBreakableSpace(int num)
void startTextLink(const QCString &file, const QCString &anchor)
void startMemberTemplateParams()
std::unique_ptr< CodeParserInterface > getCodeParser(const QCString &extension)
Gets the interface to the parser associated with a given extension.
This is an alternative implementation of QCString.
int find(char c, int index=0, bool cs=TRUE) const
QCString & prepend(const char *s)
size_t length() const
Returns the length of the string, not counting the 0-terminator.
bool startsWith(const char *s) const
QCString mid(size_t index, size_t len=static_cast< size_t >(-1)) const
bool endsWith(const char *s) const
char & at(size_t i)
Returns a reference to the character at index i.
bool isEmpty() const
Returns TRUE iff the string is empty.
QCString stripWhiteSpace() const
returns a copy of this string with leading and trailing whitespace removed
QCString & remove(size_t index, size_t len)
const std::string & str() const
QCString & append(char c)
QCString right(size_t len) const
int findRev(char c, int index=-1, bool cs=TRUE) const
const char * data() const
Returns a pointer to the contents of the string in the form of a 0-terminated C string.
QCString left(size_t len) const
bool stripPrefix(const QCString &prefix)
Implements TextGeneratorIntf for an OutputDocInterface stream.
Text streaming class that buffers data.
virtual QCString trProvidedByCategory()=0
virtual QCString trDefineValue()=0
virtual QCString trExtendsClass()=0
virtual QCString trCallerGraph()=0
virtual QCString trReimplementedInList(int numEntries)=0
virtual QCString trGlobal(bool first_capital, bool singular)=0
virtual QCString trCallGraph()=0
virtual QCString trEnumerationValues()=0
virtual QCString trMore()=0
virtual QCString trInitialValue()=0
virtual QCString trImplementedInList(int numEntries)=0
virtual QCString trSubprogram(bool first_capital, bool singular)=0
virtual QCString trMember(bool first_capital, bool singular)=0
virtual QCString trReimplementedFromList(int numEntries)=0
virtual QCString trVhdlType(VhdlSpecifier type, bool single)=0
virtual QCString trImplementedFromList(int numEntries)=0
Wrapper class for a number of boolean properties.
static bool writeVHDLTypeDocumentation(const MemberDef *mdef, const Definition *d, OutputList &ol)
static void writeSource(const MemberDef *mdef, OutputList &ol, const QCString &cname)
static bool isMisc(const MemberDef *mdef)
ClassDefMutable * toClassDefMutable(Definition *d)
ClassDef * getClass(const QCString &n)
ClassDef * toClassDef(Definition *d)
Class representing a regular expression.
Object representing the matching results.
#define Config_getInt(name)
#define Config_getBool(name)
#define NON_COPYABLE(cls)
Macro to help implementing the rule of 5 for a non-copyable & movable class.
std::vector< std::string > StringVector
std::unique_ptr< ArgumentList > stringToArgumentList(SrcLangExt lang, const QCString &argsString, QCString *extraTypeChars=nullptr)
Definition * toDefinition(DefinitionMutable *dm)
#define AUTO_TRACE_ADD(...)
void docFindSections(const QCString &input, const Definition *d, const QCString &fileName)
IDocParserPtr createDocParser()
factory function to create a parser
IDocNodeASTPtr validatingParseDoc(IDocParser &parserIntf, const QCString &fileName, int startLine, const Definition *ctx, const MemberDef *md, const QCString &input, bool indexWords, bool isExample, const QCString &exampleName, bool singleLine, bool linkFromIndex, bool markdownSupport)
static void setAnonymousEnumType()
static void writeTagFile()
FileDef * toFileDef(Definition *d)
GroupDef * toGroupDef(Definition *d)
Translator * theTranslator
static QCString simplifyTypeForTable(const QCString &s)
static void writeExceptionList(OutputList &ol, const ClassDef *cd, const MemberDef *md)
static void writeExceptionListImpl(OutputList &ol, const ClassDef *cd, const MemberDef *md, QCString const &exception)
static QCString stripTrailingReturn(const QCString &trailRet)
static QCString combineArgsAndException(QCString args, QCString exception)
static bool writeDefArgumentList(OutputList &ol, const Definition *scope, const MemberDef *md)
static std::mutex g_hasDetailedDescriptionMutex
static std::mutex g_docCrossReferenceMutex
std::unique_ptr< MemberDef > createMemberDefAlias(const Definition *newScope, const MemberDef *aliasMd)
static void invalidateCachedTypesInArgumentList(ArgumentList &al)
static std::mutex g_detectUndocumentedParamsMutex
static void transferArgumentDocumentation(ArgumentList &decAl, ArgumentList &defAl)
void addDocCrossReference(const MemberDef *s, const MemberDef *d)
static std::mutex g_cachedAnonymousTypeMutex
MemberDefMutable * toMemberDefMutable(Definition *d)
void combineDeclarationAndDefinition(MemberDefMutable *mdec, MemberDefMutable *mdef)
static QCString addTemplateNames(const QCString &s, const QCString &n, const QCString &t)
MemberDef * toMemberDef(Definition *d)
static const reg::Ex reAnonymous(R"([\w:@]*@\d+)")
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)
Factory method to create a new instance of a MemberDef.
void msg(const char *fmt,...)
#define warn_undoc(file, line, fmt,...)
#define warn_uncond(fmt,...)
#define warn(file, line, fmt,...)
#define warn_doc_error(file, line, fmt,...)
ModuleDef * toModuleDef(Definition *d)
NamespaceDef * toNamespaceDef(Definition *d)
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.
QCString substitute(const QCString &s, const QCString &src, const QCString &dst)
substitute all occurrences of src in s by dst
const char * qPrint(const char *s)
uint32_t qstrlen(const char *str)
Returns the length of string str, or 0 if a null pointer is passed.
std::vector< RefItem * > RefItemVector
Web server based search engine.
std::string_view stripWhiteSpace(std::string_view s)
Given a string view s, returns a new, narrower view on that string, skipping over any leading or trai...
This class contains the information about the argument of a function or template.
GroupPri_t
Grouping priority.
@ GROUPING_AUTO_DEF
membership in group was defined via @defgroup
This struct is used to capture the tag file information for an Entry.
Protection
Protection level of members.
SrcLangExt
Language as given by extension.
Relationship
Kind of member relationship.
Specifier
Virtualness of a member.
QCString removeRedundantWhiteSpace(const QCString &s)
SrcLangExt getLanguageFromFileName(const QCString &fileName, SrcLangExt defLang)
bool protectionLevelVisible(Protection prot)
QCString substituteTemplateArgumentsInString(const QCString &nm, const ArgumentList &formalArgs, const ArgumentList *actualArgs)
void writeTypeConstraints(OutputList &ol, const Definition *d, const ArgumentList &al)
QCString stripAnonymousNamespaceScope(const QCString &s)
QCString tempArgListToString(const ArgumentList &al, SrcLangExt lang, bool includeDefault)
void addRefItem(const RefItemVector &sli, const QCString &key, const QCString &prefix, const QCString &name, const QCString &title, const QCString &args, const Definition *scope)
void writePageRef(OutputList &ol, const QCString &cn, const QCString &mn)
QCString removeAnonymousScopes(const QCString &str)
bool matchArguments2(const Definition *srcScope, const FileDef *srcFileScope, const ArgumentList *srcAl, const Definition *dstScope, const FileDef *dstFileScope, const ArgumentList *dstAl, bool checkCV, SrcLangExt lang)
QCString stripExtension(const QCString &fName)
QCString convertToXML(const QCString &s, bool keepEntities)
QCString getLanguageSpecificSeparator(SrcLangExt lang, bool classScope)
Returns the scope separator to use given the programming language lang.
void mergeMemberOverrideOptions(MemberDefMutable *md1, MemberDefMutable *md2)
void writeMarkerList(OutputList &ol, const std::string &markerText, size_t numMarkers, std::function< void(size_t)> replaceFunc)
QCString inlineArgListToDoc(const ArgumentList &al)
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)
void writeExamples(OutputList &ol, const ExampleList &list)
void addHtmlExtensionIfMissing(QCString &fName)
A bunch of utility functions.