68 std::unique_ptr<MemberDef>
deepCopy()
const override;
108 bool isSlot()
const override;
119 bool isDCOP()
const override;
147 bool isCopy()
const override;
150 bool isWeak()
const override;
154 bool isNew()
const override;
273 const DString &fileName,
int startLine,
bool hasDocs,
340 bool inGroup,
bool showEnumValues=
false,
bool
341 showInline=
false)
const override;
351 const std::unique_ptr<ArgumentList> &actualArgs)
const override;
355 bool onlyText=
false)
const override;
386 const ArgumentList &al,
bool writeReqClause=
true)
const;
533 return std::make_unique<MemberDefImpl>(defFileName,defLine,defColumn,type,name,args,excp,prot,virt,
534 stat,related,t,tal,al,metaData);
554 std::unique_ptr<MemberDef>
deepCopy()
const override {
956 const std::unique_ptr<ArgumentList> &actualArgs)
const override
966 DString aliasAnchor = declAnchor;
971 getMdAlias()->
writeDeclaration(ol,cd,nd,fd,gd,mod,inGroup,indentLevel,inheritFrom,inheritId,aliasAnchor);
980 bool onlyText=
false)
const override
991 auto amd = std::make_unique<MemberDefAliasImpl>(newScope,aliasMd);
1024 clRealName=clRealName.
left(i);
1028 clRealName=clRealName.
mid(i+2);
1032 result+=s.
mid(p,i-p);
1033 size_t j=clRealName.
length()+i;
1037 result+=clRealName+t;
1102 if (!isDefine) ol.
docify(
" ");
1112 cName=scope->
name();
1113 size_t il=cName.
find(
'<');
1114 size_t ir=cName.
rfind(
'>');
1117 cName=cName.
mid(il,ir-il+1);
1139 bool paramTypeStarted=
false;
1140 auto alIt = defArgList.
begin();
1141 while (alIt!=defArgList.
end())
1144 if (isDefine || first)
1147 paramTypeStarted=
true;
1161 if (sep!=
"::") { atype=
substitute(atype,
"::",sep); }
1174 size_t starPos = atype.
find(
'*');
1176 funcPtrPos = atype.
find(
")(");
1179 funcPtrPos=starPos+1;
1193 if (paramTypeStarted)
1196 paramTypeStarted=
false;
1242 if (alIt!=defArgList.
end())
1254 if (key!=
",") key+=
":";
1258 paramTypeStarted=
true;
1306 size_t index = exception.
find(
'(');
1319 comma = exception.
find(
',', index);
1330 "missing ) in exception list on member {}",md->
name());
1343 if (exception.
at(0)==
'{')
1346 size_t index = exception.
find(
';');
1347 size_t oldIndex = 1;
1353 index = exception.
find(
';',oldIndex);
1484 init(
this,t,a,e,p,v,s,r,mt,tal,al,meta);
1516 result->m_def =
m_def ;
1517 result->m_anc =
m_anc ;
1518 result->m_decl =
m_decl ;
1520 result->m_read =
m_read ;
1583 result->m_incInfo = std::make_unique<IncludeInfo>();
1587 result->m_isLinkableCached = 0;
1588 result->m_isConstructorCached = 0;
1589 result->m_isDestructorCached = 0;
1654 const ClassDef *mcd = md->getClassDef();
1705 bool separateMemberPages =
Config_getBool(SEPARATE_MEMBER_PAGES);
1706 bool inlineSimpleClasses =
Config_getBool(INLINE_SIMPLE_STRUCTS);
1736 if (inlineSimpleClasses && classDef->
isSimple())
1754 if (baseName.
empty())
1757 "Internal inconsistency: member {} does not belong to any container!",
name()
1842 bool extractPrivateVirtual =
Config_getBool(EXTRACT_PRIV_VIRTUAL);
1892 if (!groupDef && !nspace &&
1907 if (
m_stat && classDef==
nullptr && !extractStatic)
1982 bool onlyText)
const
1990 if (!hideScopeNames)
1996 if (classDef && (gd || mod) && !
isRelated())
2000 else if (nspace && (gd || fd || mod))
2052 bool extractPrivateVirtual =
Config_getBool(EXTRACT_PRIV_VIRTUAL);
2056 bool hideFriendCompounds =
Config_getBool(HIDE_FRIEND_COMPOUNDS);
2068 bool visibleIfStatic = !(
getClassDef()==
nullptr &&
2075 bool visibleIfDocumented = (!hideUndocMembers ||
2082 bool visibleIfEnabled = !(hideUndocMembers &&
2089 bool visibleIfFriendCompound = !(hideFriendCompounds &&
2098 m_mtype==MemberType::Friend ||
2099 (
m_prot==Protection::Private &&
2114 bool visibleIfNotDefaultCDTor = !(cOrDTor &&
2129 bool visible = visibleIfStatic && visibleIfDocumented &&
2130 visibleIfEnabled && visibleIfPrivate &&
2131 visibleIfNotDefaultCDTor &&
2132 visibleIfFriendCompound &&
2159 if (lang==SrcLangExt::Python)
2191 for (
auto it = al.
begin(); it!=al.
end();)
2221 if (exception.
empty())
return args;
2222 size_t pos = args.
rfind(
')');
2225 return args.
left(eqPos)+
" "+exception+
" "+args.
mid(eqPos);
2235 bool inGroup,
int indentLevel,
const ClassDef *inheritedFrom,
const DString &inheritId,
2236 const DString &declAnchor)
const
2243 if (!inGroup &&
m_mtype==MemberType::EnumValue)
return;
2246 ASSERT (cd!=
nullptr || nd!=
nullptr || fd!=
nullptr || gd!=
nullptr || mod!=
nullptr);
2251 if (d==gd || d==mod)
2263 err(
"No context could be derived for member '{}'\n",
name());
2284 bool writeAnchor = (inGroup ||
getGroupDef()==
nullptr) &&
2300 if (!detailsVisible)
2312 for (
int j=0;j<indentLevel;j++)
2330 if (
isTypedef() && lang != SrcLangExt::Slice)
2336 if (lang==SrcLangExt::Python)
2347 static const reg::Ex r(R
"(@\d+)");
2349 std::string stype = ltype.
str();
2350 bool endAnonScopeNeeded=
false;
2358 static const reg::Ex ar(R
"([\w@:]*@\d+[\w@:]*)");
2362 size_t al = amatch.
length();
2364 if (annoClassDef && amd==
nullptr)
2369 annoClassDef->
writeDeclaration(ol,inGroup,indentLevel+1,inheritedFrom,inheritId);
2373 for (
int j=0;j< indentLevel;j++)
2378 endAnonScopeNeeded=
true;
2388 DString typePlaceholder =
" { ... } ";
2389 if (lang==SrcLangExt::Cpp)
2395 amd->
anchor(),ltype.
left(ai)+typePlaceholder+ltype.
mid(ai+al));
2399 size_t i = match.position();
2400 size_t l = match.length();
2405 else if (ltype==
"@")
2435 bool extractPrivateVirtual =
Config_getBool(EXTRACT_PRIV_VIRTUAL);
2438 m_mtype==MemberType::Friend ||
2439 (
m_prot==Protection::Private &&
2444 if (!
name().empty() &&
2483 .setAutoBreak(
false)
2484 .setIndentLevel(indentLevel)
2520 ol.
docify(
" [implementation]");
2546 for (
const auto &s : sl)
2565 if (
isAddable()) sl.emplace_back(
"add");
2569 for (
const auto &s : sl)
2590 if (endAnonScopeNeeded)
2608 .setIndexWords(inheritedFrom==
nullptr)
2609 .setSingleLine(
true))
2655 bool extractPrivateVirtual =
Config_getBool(EXTRACT_PRIV_VIRTUAL);
2673 (alwaysDetailedSec &&
2730 if (!hideUndocMembers)
2733 docFilter = docFilter || docInfo;
2754 (docFilter && staticFilter && moduleFilter && privateFilter && friendCompoundFilter && !
isHidden());
2766 bool inlineSimpleStructs =
Config_getBool(INLINE_SIMPLE_STRUCTS);
2770 bool simpleFilter = (
hasBriefDescription() || !hideUndocMembers) && inlineSimpleStructs &&
2775 bool result = visible || simpleFilter;
2791 (
protection()!=Protection::Public || lvirt!=Specifier::Normal ||
2807 bool optVhdl = lang==SrcLangExt::VHDL;
2815 if (
isFriend()) sl.emplace_back(
"friend");
2816 else if (
isRelated()) sl.emplace_back(
"related");
2820 if (inlineInfo &&
isInline()) sl.emplace_back(
"inline");
2821 if (
isExplicit()) sl.emplace_back(
"explicit");
2822 if (
isMutable()) sl.emplace_back(
"mutable");
2824 if (
isStatic()) sl.emplace_back(
"static");
2839 if (
isAddable()) sl.emplace_back(
"add");
2844 if (
isFinal()) sl.emplace_back(
"final");
2845 if (
isAbstract()) sl.emplace_back(
"abstract");
2846 if (
isOverride()) sl.emplace_back(
"override");
2848 if (
isSealed()) sl.emplace_back(
"sealed");
2849 if (
isNew()) sl.emplace_back(
"new");
2850 if (
isOptional()) sl.emplace_back(
"optional");
2851 if (
isRequired()) sl.emplace_back(
"required");
2858 if (
isAssign()) sl.emplace_back(
"assign");
2859 else if (
isCopy()) sl.emplace_back(
"copy");
2860 else if (
isRetain()) sl.emplace_back(
"retain");
2861 else if (
isWeak()) sl.emplace_back(
"weak");
2862 else if (lang!=SrcLangExt::CSharp &&
isStrong()) sl.emplace_back(
"strong");
2863 else if (
isUnretained()) sl.emplace_back(
"unsafe_unretained");
2867 if (
protection()==Protection::Protected) sl.emplace_back(
"protected");
2868 else if (
protection()==Protection::Private) sl.emplace_back(
"private");
2869 else if (
protection()==Protection::Package) sl.emplace_back(
"package");
2871 if (lvirt==Specifier::Virtual) sl.emplace_back(
"virtual");
2872 else if (lvirt==Specifier::Pure) sl.emplace_back(
"pure virtual");
2873 if (
isSignal()) sl.emplace_back(
"signal");
2874 if (
isSlot()) sl.emplace_back(
"slot");
2875 if (
isDefault()) sl.emplace_back(
"default");
2876 if (
isDelete()) sl.emplace_back(
"delete");
2877 if (
isNoExcept()) sl.emplace_back(
"noexcept");
2880 if (
isReadonly()) sl.emplace_back(
"readonly");
2881 if (
isBound()) sl.emplace_back(
"bound");
2892 sl.emplace_back(
"implementation");
2897 sl.emplace_back(
"inherited");
2903 sl.emplace_back(
"implementation");
2908 bool alreadyAdded = std::find(sl.begin(), sl.end(), sx) != sl.end();
2926 warn_uncond(
"Call graph for '{}' not generated, too many nodes ({}), threshold is {}. Consider increasing DOT_GRAPH_MAX_NODES.\n",
2948 warn_uncond(
"Caller graph for '{}' not generated, too many nodes ({}), threshold is {}. Consider increasing DOT_GRAPH_MAX_NODES.\n",
3023 reimplFromLine.
length()-markerPos-2));
3028 err(
"translation error: no marker in trReimplementsFromList()\n");
3039 for (
const auto &bmd : bml)
3041 const ClassDef *bcd=bmd->getClassDef();
3058 auto replaceFunc = [&bml,&ol](
size_t entryIndex)
3061 auto it = bml.
begin();
3065 while (it!=bml.
end())
3071 if (cnt==entryIndex)
break;
3194 bool hasInits =
false;
3199 if (fmd->isLinkable())
3201 if (!fmd->initializer().empty())
3212 if (fmd->isLinkable())
3225 ol.
startDoxyAnchor(cfname,cname,fmd->anchor(),fmd->name(),fmd->argsString());
3236 if (!fmd->initializer().empty())
3252 bool hasBrief = !fmd->briefDescription().empty();
3253 bool hasDetails = !fmd->documentation().empty();
3263 .setIndexWords(
true));
3273 .setIndexWords(
true));
3297 ldef = title =
"anonymous enum";
3320 std::string sdef = ldef.
str();
3327 static const reg::Ex ar(R
"([\w@:]*@\d+[\w@:]*)");
3346 ldef=ldef.
left(sp+1)+ldef.
mid(ep+2);
3352 ldef=ldef.
left(dp+1);
3354 int l=
static_cast<int>(ldef.
length());
3357 while (i>=0 && (
isId(ldef.
at(i)) || ldef.
at(i)==
':')) i--;
3358 while (i>=0 && isspace(
static_cast<uint8_t
>(ldef.
at(i)))) i--;
3362 ldef =
"("+ldef.
left(i+1)+
")"+ldef.
mid(i+1);
3375 bool written =
false;
3414 if (inGroup && fd && showGroupedMembInc)
3429 bool isIDLorJava = lang==SrcLangExt::IDL || lang==SrcLangExt::Java;
3439 if (isIDLorJava || forceLocalIncludes) ol.
docify(
"\"");
else ol.
docify(
"<");
3450 if (isIDLorJava || forceLocalIncludes) ol.
docify(
"\"");
else ol.
docify(
">");
3462 if (
m_mtype==MemberType::Define)
3469 if (srcLangExt == SrcLangExt::Lex)
3471 langCorrected =
".doxygen_lex_c";
3472 srcLangExt = SrcLangExt::Cpp;
3475 intf->resetCodeParserState();
3481 .setInlineFragment(
true)
3483 .setShowLineNumbers(
false)
3486 codeOL.endCodeFragment(
"DoxyCode");
3493 int memCount,
int memTotal,
3503 bool hasParameterList =
false;
3513 bool optVhdl = lang==SrcLangExt::VHDL;
3519 const Definition *scopedContainer = container;
3525 ciname = (
toGroupDef(container))->groupTitle();
3539 if (!scopeName.
empty())
3541 doxyName.
prepend(scopeName+sep);
3551 if (title.
at(0)==
'@')
3553 ldef = title =
"anonymous enum";
3558 if (lang==SrcLangExt::Cpp)
3570 if (lang==SrcLangExt::Cpp)
3584 if (ldef.
at(0)==
'@')
3593 if (lang == SrcLangExt::Slice)
3611 bool htmlEndLabelTable=
false;
3613 auto startHtmlLabelTable = [&]()
3624 htmlEndLabelTable=
true;
3628 static const reg::Ex r(R
"(@\d+)");
3630 std::string sdef = ldef.str();
3637 for (
const auto &vmd : *ml)
3639 if (vmd->isEnumerate() && match.str()==vmd->name())
3645 DString suffix = match.suffix().str();
3664 startHtmlLabelTable();
3668 static const reg::Ex ar(R
"([\w@:]*@\d+[\w@:]*)");
3676 if (annoClassDef && amd==
nullptr)
3685 annoClassDef->
anchor(),annTypeName);
3690 DString typePlaceholder =
" { ... } ";
3691 if (lang==SrcLangExt::Cpp)
3700 prefix = match.prefix().str();
3766 startHtmlLabelTable();
3776 ldef=ldef.
left(sp+1)+ldef.
mid(ep+2);
3778 ldef=ldef.
mid(ep+2);
3784 ldef=ldef.
left(dp+1);
3786 int dl=
static_cast<int>(ldef.
length());
3789 while (i>=0 && (
isId(ldef.
at(i)) || ldef.
at(i)==
':')) i--;
3790 while (i>=0 && isspace(
static_cast<uint8_t
>(ldef.
at(i)))) i--;
3794 ldef=
"("+ldef.
left(i+1)+
")"+ldef.
mid(i+1);
3804 else if (lang==SrcLangExt::Slice)
3807 size_t pos = ldef.
rfind(
' ');
3815 if (scope==
nullptr) scope = nd;
3822 if (scope==
nullptr) scope = nd;
3849 hasParameterList=
true;
3859 for (
const auto &s : sl)
3868 if (hasParameterList)
3883 if (htmlEndLabelTable)
3886 ol.
writeString(
" <td class=\"mlabels-right\">\n");
3889 for (
const auto &s : sl)
3913 if (!brief.
empty() &&
3926 .setSingleLine(
true));
3932 if (!detailed.
empty() ||
3949 .setIndexWords(
true));
3960 .setIndexWords(
true));
3973 .setIndexWords(
true));
3990 .setIndexWords(
true));
4001 .setIndexWords(
true));
4033 static const reg::Ex re1(R
"(\a\w*::)");
4034 static const reg::Ex re2(R
"(\a\w*<[^>]*>::)");
4036 std::string t = ts.
str();
4039 t = match.prefix().str() + match.suffix().str();
4060 if (scope) cname = scope->
name();
4061 if (doxyName.
at(0)==
'@')
4063 doxyName=
"__unnamed__";
4080 static const reg::Ex ar(R
"([\w@:]*@\d+[\w@:]*)");
4086 size_t al = amatch.
length();
4139 .setSingleLine(
true));
4143 if (!detailed.
empty())
4163 if (
m_mtype == MemberType::Define)
4165 return "macro definition";
4167 else if (
m_mtype == MemberType::Enumeration)
4169 return "enumeration";
4171 return to_string_lower(
m_mtype);
4235 if (!fmd->isLinkableInProject())
4239 warn(fmd->getDefFileName(),fmd->getDefLine(),
"Documentation for enum member '{}{}{}' is missing.",
4275 bool isPython =
getLanguage()==SrcLangExt::Python;
4296 for (
auto it = al.
begin(); it!=al.
end() && allDoc; ++it)
4300 !(isPython && (a.
name==
"self" || a.
name==
"cls"))
4308 if (!allDoc && declAl.
empty())
4311 for (
auto it = al.
begin(); it!=al.
end() && allDoc; ++it)
4315 !(isPython && (a.
name==
"self" || a.
name==
"cls"))
4339 bool isFortran =
getLanguage()==SrcLangExt::Fortran;
4340 bool isFortranSubroutine = isFortran && returnType.
find(
"subroutine")!=
DString::npos;
4342 bool isVoidReturn = returnType==
"void" || returnType.
endsWith(
" void");
4343 if (!isVoidReturn && (returnType==
"auto" || returnType.
endsWith(
" auto")))
4349 isVoidReturn = (strippedTrailingReturn==
"void") || (strippedTrailingReturn.
endsWith(
" void"));
4363 "parameters of member {} are not documented",
4370 isFortranSubroutine ||
4378 "return type of member {} is not documented",
4385 isFortranSubroutine ||
4469 const DString &fileName,
int startLine,
4512 const ArgumentList &formalArgs,
const std::unique_ptr<ArgumentList> &actualArgs)
const
4515 std::unique_ptr<ArgumentList> actualArgList = std::make_unique<ArgumentList>(
m_defArgList);
4519 for (
Argument &arg : *actualArgList)
4523 actualArgList->setTrailingReturnType(
4543 mmd->moveArgumentList(std::move(actualArgList));
4547 mmd->setFormalTemplateArguments(formalArgs);
4582 while (p>=0 && isspace(
static_cast<uint8_t
>(
m_initializer.
at(p)))) p--;
4596 if (optimizeOutputForC)
4600 else if (lang==SrcLangExt::Fortran)
4618 memName =
"[" + pd->
name() +
" " +
name() +
"]";
4659 "Internal inconsistency: recursion detected in overload relation for member {}!",
name());
4660 return Specifier::Normal;
4664 while (rmd && v==Specifier::Normal)
4666 v = rmd->
virtualness(count+1)==Specifier::Normal ? Specifier::Normal : Specifier::Virtual;
4676 tagFile <<
" <member kind=\"";
4677 if (
m_mtype == MemberType::Enumeration)
4679 tagFile <<
"enumeration";
4683 tagFile << to_string_lower(
m_mtype);
4685 if (
m_prot!=Protection::Public)
4687 tagFile <<
"\" protection=\"";
4688 if (
m_prot==Protection::Protected) tagFile <<
"protected";
4689 else if (
m_prot==Protection::Package) tagFile <<
"package";
4690 else tagFile <<
"private";
4692 if (
m_virt!=Specifier::Normal)
4694 tagFile <<
"\" virtualness=\"";
4695 if (
m_virt==Specifier::Virtual) tagFile <<
"virtual";
4696 else tagFile <<
"pure";
4700 tagFile <<
"\" static=\"yes";
4710 tagFile <<
" <anchorfile>" <<
convertToXML(fn) <<
"</anchorfile>\n";
4715 tagFile <<
" <clangid>" <<
convertToXML(idStr) <<
"</clangid>\n";
4722 if (!fmd->isReference())
4725 tagFile <<
"\" anchor=\"" <<
convertToXML(fmd->anchor());
4731 tagFile <<
"\">" <<
convertToXML(fmd->name()) <<
"</enumvalue>\n";
4736 tagFile <<
" </member>\n";
4754 else if (
name()==
"__init__" &&
4763 size_t i=locName.
find(
'<');
4800 else if (
name()==
"__del__" &&
4834 uint32_t numVisibleEnumValues=0;
4837 if (fmd->isBriefSectionVisible()) numVisibleEnumValues++;
4869 uint32_t enumValuesPerLine =
static_cast<uint32_t
>(
Config_getInt(ENUM_VALUES_PER_LINE));
4870 if (numVisibleEnumValues>0 && enumValuesPerLine>0)
4889 if (numVisibleEnumValues>enumValuesPerLine
4890 && (enumMemCount%enumValuesPerLine)==0
4906 fmd->
writeLink(typeDecl,cd,nd,fd,gd,mod);
4923 bool prevVisible = fmdVisible;
4941 if (numVisibleEnumValues>enumValuesPerLine)
5037 if (
isStatic()) qm=
"+";
else qm=
"-";
5072 if (
isStatic()) qm=
"+ ";
else qm=
"- ";
5236 return m_mtype==MemberType::Signal;
5241 return m_mtype==MemberType::Slot;
5246 return m_mtype==MemberType::Variable;
5251 return m_mtype==MemberType::Enumeration;
5256 return m_mtype==MemberType::EnumValue;
5261 return m_mtype==MemberType::Typedef;
5266 return m_mtype==MemberType::Sequence;
5271 return m_mtype==MemberType::Dictionary;
5276 return m_mtype==MemberType::Function;
5281 return m_mtype==MemberType::Variable &&
5287 return m_mtype==MemberType::Define;
5292 return m_mtype==MemberType::Friend;
5297 return m_mtype==MemberType::DCOP;
5302 return m_mtype==MemberType::Property;
5307 return m_mtype==MemberType::Event;
5312 return m_related == Relationship::Related;
5317 return m_related == Relationship::Foreign;
5477 return m_mtype==MemberType::EnumValue &&
5680 auto decSrc = decAlSrc.
begin(), defSrc = defAlSrc.
begin();
5681 for (
auto decIt = decAl.
begin(), defIt = defAl.
begin();
5682 decIt != decAl.
end() && defIt != defAl.
end() && decSrc != decAlSrc.
end() && defSrc != defAlSrc.
end();
5683 ++decIt, ++defIt, ++decSrc, ++defSrc++)
5919 for (
const auto &sx : qualifiers)
6144 auto srcIt = srcAl.
begin();
6145 auto dstIt = dstAl.
begin();
6146 while ( srcIt!=srcAl.
end() && dstIt!=dstAl.
end())
6163 auto srcIt = srcAl.
begin();
6164 auto dstIt = dstAl.
begin();
6166 while ( srcIt!=srcAl.
end() && dstIt!=dstAl.
end())
6216 for (
auto decIt = decAl.
begin(), defIt = defAl.
begin();
6217 decIt!= decAl.
end() && defIt!= defAl.
end();
6251 if (i>0 && (i+5>=doc.
length() || !
isId(doc[i+5])))
6255 if (c==
'<' || ((c==
'\\' || c==
'@') && (i==1 ||
disspace(doc[i-2]))))
6267 AUTO_TRACE(
"mdec='{}' mdef='{}' mdec.isPrototype={} mdef.isPrototype={}",
6281 if (sameNumTemplateArgs &&
6299 if (!a.docs.empty()) mdefHasParamDocs =
true;
6311 int mdefLine = mdef->
docLine();
6312 int mdecLine = mdec->
docLine();
6338 if (mdefAl.hasParameters())
6350 if (!mdefHasParamDocs)
6497 const DString &includeName,
bool local,
bool force)
6499 if (!force || includeName.
empty())
return;
6509 bool hideFriendCompounds =
Config_getBool(HIDE_FRIEND_COMPOUNDS);
6584 if (src==
nullptr || dst==
nullptr)
return;
6662 return static_cast<const MemberDef*
>(d);
This class contains the information about the argument of a function or template.
This class represents an function or template argument list.
RefQualifierType refQualifier() const
bool hasParameters() const
DString trailingReturnType() const
bool constSpecifier() const
bool hasDocumentation(bool allowEmptyNames=false) const
bool hasTemplateDocumentation() const
bool volatileSpecifier() const
A abstract class representing of a compound symbol.
virtual void writeDeclaration(OutputList &ol, bool inGroup, int indentLevel, const ClassDef *inheritedFrom, const DString &inheritId) const =0
virtual int isBaseClass(const ClassDef *bcd, bool followInstances, const DString &templSpec=DString()) 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 DString compoundTypeString() const =0
Returns the type of compound as a string.
virtual ClassDef * categoryOf() const =0
Returns the class of which this is a category (Objective-C only).
virtual bool isImplicitTemplateInstance() const =0
virtual CompoundType compoundType() const =0
Returns the type of compound this is, i.e. class/struct/union/...
A String class for use with Doxygen wrapping std::string and adding some additional functionality off...
size_t rfind(char c, size_t pos=npos) const
DString mid(size_t index, size_t len=npos) const
DString simplifyWhiteSpace() const
return a copy of this string with leading and trailing whitespace removed and multiple internal white...
bool empty() const
Returns true iff the string is empty (std::string compatible alias for isEmpty()).
std::string_view view() const
DString & remove(size_t index, size_t len)
static constexpr size_t npos
value used to indicate 'not found' or 'to the end of the string', matching std::string::npos
char & at(size_t i)
Returns a reference to the character at index i.
DString right(size_t len) const
DString & prepend(const char *s)
int contains(char c, bool cs=true) const
size_t find(char c, size_t pos=0) const
DString stripWhiteSpace() const
returns a copy of this string with leading and trailing whitespace removed
DString left(size_t len) const
const std::string & str() const
bool stripPrefix(const DString &prefix)
bool startsWith(const char *s) const
bool endsWith(const char *s) const
size_t length() const
Returns the length of the string, not counting the 0-terminator.
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 DString briefDescription(bool abbreviate=false) const =0
virtual DString inbodyFile() const =0
virtual int getEndBodyLine() const =0
virtual DString briefFile() const =0
virtual SrcLangExt getLanguage() const =0
Returns the programming language this definition was written in.
virtual int docLine() const =0
virtual DString getDefFileName() const =0
virtual DString documentation() const =0
virtual bool isLinkable() const =0
virtual DString inbodyDocumentation() const =0
virtual int getDefLine() const =0
virtual DefType definitionType() const =0
virtual const DString & name() const =0
virtual const DString & localName() const =0
virtual int inbodyLine() const =0
virtual const FileDef * getBodyDef() const =0
virtual int briefLine() const =0
virtual bool hasDocumentation() const =0
virtual bool isLinkableInProject() const =0
virtual bool hasUserDocumentation() const =0
virtual bool isAnonymous() const =0
virtual DString displayName(bool includeScope=true) const =0
virtual DString qualifiedName() const =0
virtual DString anchor() const =0
virtual DString getReference() const =0
virtual CodeSymbolType codeSymbolType() const =0
virtual Definition * getOuterScope() const =0
virtual DString docFile() const =0
virtual int getStartBodyLine() const =0
virtual bool isReference() const =0
virtual DString getOutputFileBase() const =0
int getDefLine() const override
bool isReference() const override
DString docFile() const override
void writeSourceDef(OutputList &ol) const override
bool hasUserDocumentation() const override
DString qualifiedName() const override
bool isExported() const override
bool hasBriefDescription() const override
void setDefFile(const DString &df, int defLine, size_t defColumn) override
DString id() const override
DString briefFile() const override
bool hasSources() const override
bool hasRequirementRefs() const override
DString briefDescription(bool abbreviate=false) const override
const DString & name() const override
bool isAnonymous() const override
DString inbodyFile() const override
void setOuterScope(Definition *def) override
DString getReference() const override
void writeRequirementRefs(OutputList &ol) const override
void setInbodyDocumentation(const DString &doc, const DString &docFile, int docLine) override
const RefItemVector & xrefListItems() const override
bool hasSourceReffedBy() const override
size_t getDefColumn() const override
Definition * getOuterScope() const override
void setBriefDescription(const DString &brief, const DString &briefFile, int briefLine) override
int getEndBodyLine() const override
void setDocumentation(const DString &doc, const DString &docFile, int docLine, bool stripWhiteSpace=true) override
const DString & localName() const override
bool hasSourceRefs() const override
void setReference(const DString &r) override
bool isHidden() const override
DString getDefFileExtension() const override
DString getDefFileName() const override
DString documentation() const override
DefinitionMixin(const DString &defFileName, int defLine, size_t defColumn, const DString &name, const char *b=nullptr, const char *d=nullptr, bool isSymbol=true)
const FileDef * getBodyDef() const override
DString inbodyDocumentation() const override
int getStartBodyLine() const override
void writeSourceReffedBy(OutputList &ol, const DString &scopeName) const override
int docLine() const override
int inbodyLine() const override
void writeInlineCode(OutputList &ol, const DString &scopeName) const override
void setHidden(bool b) override
int briefLine() const override
DString getSourceFileBase() const override
void writeDocAnchorsToTagFile(TextStream &fs) const override
bool hasDocumentation() const override
void writeSourceRefs(OutputList &ol, const DString &scopeName) const override
SrcLangExt getLanguage() const override
virtual void setBodySegment(int defLine, int bls, int ble)=0
virtual void setInbodyDocumentation(const DString &d, const DString &docFile, int docLine)=0
virtual void setDocumentation(const DString &d, const DString &docFile, int docLine, bool stripWhiteSpace=true)=0
virtual void addSourceReferences(MemberDef *d, const DString &sourceRefName)=0
virtual void addSourceReferencedBy(MemberDef *d, const DString &sourceRefName)=0
virtual void setBriefDescription(const DString &b, const DString &briefFile, int briefLine)=0
virtual void mergeRefItems(Definition *d)=0
virtual void setBodyDef(const FileDef *fd)=0
Representation of an call graph.
static bool suppressDocWarnings
static bool parseSourcesNeeded
static ParserManager * parserManager
static NamespaceDefMutable * globalScope
bool inSort(const Example &ex)
A model of a file symbol.
virtual DString absFilePath() 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
DString getGroupFileName() const override
GroupDef * getGroupDef() 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
bool isConstInit() const override
bool isFinal() 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 MemberDef * reimplements() const override
DString argsString() const override
const DString & initializer() const override
bool isOptional() const override
const ClassDef * getClassDefOfAnonymousType() 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
size_t getDeclColumn() const override
bool isFriendClass() const override
const MemberDef * getGroupAlias() const override
bool isStrongEnumValue() const override
bool isAssign() const override
DString typeString() 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
DString getOutputFileBase() 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
const MemberDef * templateMaster() const override
void warnIfUndocumentedParams() const override
const MemberDef * anonymousMemberForDetails() const override
bool isExternal() const override
DString excpString() const override
bool isProperty() const override
bool isWritable() const override
bool isDocumentedFriendClass() const override
int redefineCount() const override
bool isConstExpr() const override
int initializerLines() const override
bool isMaybeVoid() const override
int getMemberGroupId() const override
DString objCMethodName(bool localLink, bool showStatic) 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
bool hasCallGraph() const override
bool isCopy() const override
DString displayDefinition() const override
DString getWriteAccessor() const override
int getDeclLine() const override
bool isEnumerate() const override
DString getReference() 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 DString &inheritId=DString(), const DString &declAnchor=DString()) const override
bool isReference() const override
TypeSpecifier getMemberSpecifiers() const override
bool isThreadLocal() const override
bool hasMultiLineInitializer() const override
bool isDocsForDefinition() const override
Grouping::GroupPri_t getGroupPri() const override
bool isTypedefValCached() const override
bool isRaisable() const override
bool isUnretained() const override
bool isGettable() const override
const MemberVector & enumFieldList() const override
DString anchor() const override
bool isObjCProperty() const override
DString qualifiedName() const override
const ArgumentList & declArgumentList() const override
DString briefDescription(bool) const override
bool isCallable() const override
bool isDefine() const override
bool isLinkableInProject() const override
bool hasDetailedDescription() const override
bool isFriendToHide() const override
DString getCachedTypedefTemplSpec() const override
const MemberDef * anonymousMemberForDeclaration() 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
DString requiresClause() const override
bool isFunctionPtr() const override
StringVector getLabels(const Definition *container) const override
std::unique_ptr< MemberDef > createTemplateInstanceMember(const ArgumentList &formalArgs, const std::unique_ptr< ArgumentList > &actualArgs) const override
bool isAddable() 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
bool isInline() const override
bool isRelatedOrFriend() const override
bool hasReferencesRelation() const override
bool isStrong() const override
const MemberDef * getMdAlias() const
bool isObjCMethod() const override
const DString & name() const override
bool isAbstract() const override
DString extraTypeChars() const override
bool isStatic() const override
bool isPrivateSettable() const override
bool isSealed() const override
bool isRelated() const override
DString memberTypeName() const override
bool isOverride() const override
bool isForeign() const override
bool isImplementation() const override
const MemberVector & reimplementedBy() const override
VhdlSpecifier getVhdlSpecifiers() const override
bool isMaybeDefault() const override
MemberType memberType() const override
bool isLinkable() const override
DString getDeclFileName() const override
bool isProtectedSettable() const override
bool isReadonly() const override
DString declaration() const override
DString getCachedResolvedTypedef() const override
const MemberDef * categoryRelation() const override
ClassDef * getClassDef() override
DString documentation() const override
MemberDefAliasImpl(const Definition *newScope, const MemberDef *md)
const MemberDef * getEnumScope() const override
DString getReadAccessor() const override
Protection protection() const override
bool isSlot() const override
DString displayName(bool b=true) const override
bool isDelete() const override
bool isReadable() const override
bool isEvent() const override
bool isNonAtomic() const override
DefType definitionType() const override
DString getScopeString() const override
bool isReimplementedBy(const ClassDef *cd) const override
bool isDCOP() const override
DString bitfieldString() const override
void writeEnumDeclaration(OutputList &typeDecl, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, const ModuleDef *mod) const override
bool isDocTransferDone() const override
bool isDetailedSectionVisible(MemberListContainer container) const override
bool isNotFriend() const override
const MemberList * getSectionList(const Definition *container) const override
bool isTemplateSpecialization() const override
const ModuleDef * getModuleDef() const override
bool isExplicit() const override
DString enumBaseType() const override
CodeSymbolType codeSymbolType() 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
MemberDef * resolveAlias() override
const FileDef * getFileDef() const override
std::optional< ArgumentList > formalTemplateArguments() const override
DString sourceRefName() const override
DString definition() 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
DString fieldType() 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
DString getDeclType() const override
bool visibleInIndex() const override
ClassDef * relatedAlso() const override
bool isRetain() const override
bool isEnumStruct() const override
bool isBriefSectionVisible() const override
const ArgumentList & templateArguments() const override
~MemberDefAliasImpl() override
StringVector getQualifiers() const override
A model of a class/file/namespace member symbol.
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 bool isDestructor() const =0
virtual DString getDeclType() 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 bool isObjCMethod() const =0
virtual bool hasDocumentedEnumValues() const =0
virtual MemberDef * memberDeclaration() const =0
virtual DString requiresClause() 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 DString argsString() const =0
virtual bool isForeign() const =0
virtual bool isSealed() const =0
virtual bool hasExamples() const =0
virtual bool isDelete() const =0
virtual int numberOfFlowKeyWords() const =0
virtual const MemberDef * inheritsDocsFrom() const =0
virtual bool isDefault() const =0
virtual DString objCMethodName(bool localLink, bool showStatic) const =0
virtual bool isRelated() const =0
virtual bool isDocumentedFriendClass() const =0
virtual bool isConstInit() const =0
virtual bool isDeleted() const =0
virtual DString definition() const =0
virtual const ClassDef * getCachedTypedefVal() const =0
virtual bool isRelatedOrFriend() 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 DString declaration() const =0
virtual DString excpString() const =0
virtual DString getCachedResolvedTypedef() const =0
virtual const ArgumentList & templateArguments() const =0
virtual DString getDeclFileName() const =0
virtual const DString & initializer() const =0
virtual GroupDef * getGroupDef()=0
virtual bool isSettable() 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 DString getReadAccessor() const =0
virtual const ArgumentList & argumentList() 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 bool isCopy() const =0
virtual int getMemberGroupId() const =0
virtual bool isDictionary() const =0
virtual DString bitfieldString() const =0
virtual int getDeclLine() const =0
virtual bool isTypeAlias() const =0
virtual bool isStatic() const =0
virtual const MemberDef * reimplements() const =0
virtual bool isMaybeDefault() const =0
virtual bool livesInsideEnum() const =0
virtual bool hasInlineSource() const =0
virtual bool isTemplateSpecialization() const =0
virtual bool isPrivateSettable() const =0
virtual DString displayDefinition() const =0
virtual StringVector getQualifiers() const =0
virtual const MemberDef * anonymousMemberForDeclaration() const =0
virtual bool isRaisable() const =0
virtual bool isRemovable() const =0
virtual bool isTypedefValCached() const =0
virtual bool isConstrained() const =0
virtual DString getWriteAccessor() 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 isThreadLocal() const =0
virtual bool isDefine() const =0
virtual DString extraTypeChars() const =0
virtual const NamespaceDef * getNamespaceDef() const =0
virtual bool isPublished() const =0
virtual DString getScopeString() const =0
virtual bool isFunctionPtr() const =0
virtual DString sourceRefName() 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 const ArgumentList & typeConstraints() const =0
virtual const MemberDef * anonymousMemberForDetails() const =0
virtual size_t getDeclColumn() const =0
virtual bool isProtectedSettable() const =0
virtual const ClassDef * getClassDefOfAnonymousType() const =0
virtual bool isImplementation() const =0
virtual bool isProtectedGettable() 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 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 DString &inheritId=DString(), const DString &declAnchor=DString()) const =0
virtual Protection protection() const =0
virtual TypeSpecifier getMemberSpecifiers() const =0
virtual bool isOptional() const =0
virtual DString getCachedTypedefTemplSpec() 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 DString fieldType() const =0
virtual bool isReadable() const =0
virtual bool isWeak() const =0
virtual bool isDocTransferDone() const =0
virtual bool isNoDiscard() const =0
virtual DString enumBaseType() const =0
virtual bool isUnretained() 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 DString getGroupFileName() const =0
virtual bool isDCOP() const =0
virtual bool isStrong() const =0
virtual DString typeString() const =0
virtual bool isSliceLocal() const =0
virtual Specifier virtualness(int count=0) const =0
virtual bool isUNOProperty() const =0
virtual int redefineCount() 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 DString memberTypeName() 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 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 bool isProperty() const =0
bool _hasVisibleCallerGraph() const
DString getCachedTypedefTemplSpec() const override
void _writeCallerGraph(OutputList &ol) const
void insertReimplementedBy(MemberDef *md) override
bool isDCOP() const override
DString enumBaseType() const override
const MemberDef * anonymousMemberForDeclaration() const override
bool isDetailedSectionVisible(MemberListContainer container) const override
bool _isReimplements() const
bool isFunction() const override
void cacheTypedefVal(const ClassDef *val, const DString &templSpec, const DString &resolvedType) 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 writeDocumentation(const MemberList *ml, int memCount, int memTotal, OutputList &ol, const DString &scopeName, const Definition *container, bool inGroup, bool showEnumValues=false, bool showInline=false) const override
void setDocumentedEnumValues(bool value) override
bool m_detailedDescriptionCachedValue
bool isTypedefValCached() const override
DString objCMethodName(bool localLink, bool showStatic) const override
bool isInline() const override
const ExampleList & getExamples() const override
ArgumentLists m_defTmpArgLists
DString getWriteAccessor() const override
bool isFriendToHide() const override
void invalidateTypedefValCache() 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 _writeTypeConstraints(OutputList &ol) const
bool isSliceLocal() const override
void makeRelated() override
int getGroupStartLine() const override
void setAnonymousMemberForDeclaration(const MemberDef *md) override
void warnIfUndocumented() 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 DString &inheritId=DString(), const DString &declAnchor=DString()) const override
bool m_hasReferencedByRelation
void setMemberType(MemberType t) override
const ArgumentList & typeConstraints() const override
void setRequiresClause(const DString &req) override
DefType definitionType() const override
bool isDestructor() const override
StringVector getQualifiers() const override
DString getDeclFileName() const override
void setRedefineCount(int) override
void setAnonymousEnumType(const MemberDef *md) override
bool isOptional() const override
void _writeExamples(OutputList &ol) const
void moveTo(Definition *) override
bool isCallable() const override
void setBriefDescription(const DString &b, const DString &briefFile, int briefLine) override
DString getScopeString() const override
bool isBriefSectionVisible() const override
const MemberDef * m_categoryRelation
void setCategoryRelation(const MemberDef *) override
bool isReference() const override
DString m_cachedResolvedType
void warnIfUndocumentedParams() const override
VhdlSpecifier getVhdlSpecifiers() const override
bool _hasVisibleCallGraph() const
void setFormalTemplateArguments(const ArgumentList &al) override
DString extraTypeChars() const override
void setClassDefOfAnonymousType(const ClassDef *cd) override
bool isDefine() const override
void findSectionsInDocumentation() override
DString displayDefinition() 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
void _writeReimplementedBy(OutputList &ol) const
bool isNew() const override
void setMaxInitLines(int lines) override
bool isDocsForDefinition() const override
DString definition() const override
void setEnumClassScope(ClassDef *cd) override
void setReadAccessor(const DString &r) 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
DString anchor() const override
StringVector m_qualifiers
void overrideCallGraph(bool e) override
void setInheritsDocsFrom(const MemberDef *md) override
bool addExample(const DString &anchor, const DString &name, const DString &file) override
Specifier virtualness(int count=0) const override
ClassDefMutable * getClassDefMutable() override
bool hasDetailedDescription() const override
void setMemberGroupId(int id) override
DString getReference() const override
bool isCSharpProperty() const override
void setSectionList(const Definition *container, const MemberList *sl) override
bool isRaisable() const override
void setTemplateMaster(const MemberDef *mt) 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
void setMemberGroup(MemberGroup *grp) override
void setMemberDeclaration(MemberDef *md) override
void setDeclFile(const DString &df, int line, size_t column) override
bool isUNOProperty() const override
bool m_hasDocumentedParams
bool m_hasReferencesRelation
void _computeIsConstructor()
size_t _countReimplementedBy() const
bool isRequired() const override
const MemberDef * m_annMemberForDetails
const MemberVector & reimplementedBy() const override
bool isStrong() const override
void moveDeclArgumentList(std::unique_ptr< ArgumentList > al) override
bool isTypeAlias() const override
void setMemberClass(ClassDef *cd) override
const MemberDef * templateMaster() const override
void setDocsForDefinition(bool b) override
const ClassDef * getCachedTypedefVal() const override
int initializerLines() const override
bool getGroupHasDocs() const override
const MemberDef * getEnumScope() 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
void setWriteAccessor(const DString &w) override
bool isRelated() const override
void moveArgumentList(std::unique_ptr< ArgumentList > al) override
DString qualifiedName() const override
const ClassDef * m_cachedTypedefValue
void setCategory(ClassDef *) override
void setAnonymousMemberForDetails(const MemberDef *md) override
uint8_t m_isDestructorCached
MemberType memberType() const override
DString sourceRefName() const override
const ClassDef * m_anonymousType
Protection protection() const override
bool isConstructor() const override
void setGroupAlias(const MemberDef *md) override
void setPrototype(bool p, const DString &df, int line, size_t column) override
bool isEnumerate() const override
const ArgumentList & templateArguments() const override
bool isCopy() const override
void setType(const DString &t) override
DString declaration() const override
bool isReadonly() const override
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
void _writeMultiLineInitializer(OutputList &ol, const DString &scopeName) const
MemberDef * resolveAlias() override
bool isFinal() const override
bool isAttribute() const override
const MemberDef * m_enumScope
DString m_explicitOutputFileBase
int redefineCount() const override
void setExplicitExternal(bool b, const DString &df, int line, size_t column) override
bool isDictionary() const override
bool isSlot() const override
DString bitfieldString() const override
DString memberTypeName() const override
bool hasInlineSource() const 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
const MemberDef * anonymousMemberForDetails() const override
bool isDocTransferDone() const 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
bool isExplicit() const override
void _writeCategoryRelation(OutputList &ol) const
void setTemplateSpecialization(bool b) override
bool isTemplateSpecialization() const override
DString typeString() 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
bool livesInsideEnum() const override
bool isDelete() const override
DString getCachedResolvedTypedef() const override
DString excpString() const override
DString fieldType() const override
bool isNoExcept() const override
DString argsString() const override
bool isWeak() const override
const MemberDef * getAnonymousEnumType() const override
void setDocumentation(const DString &d, const DString &docFile, int docLine, bool stripWhiteSpace=true) override
const ModuleDef * getModuleDef() const override
void setDocTransferDone() override
bool isNoDiscard() const override
void incrementFlowKeyWordCount() override
const MemberDef * getGroupAlias() const override
bool isConstInit() const override
void setModuleDef(ModuleDef *mod) override
DString getDeclType() const override
TypeSpecifier getMemberSpecifiers() const override
bool hasReferencedByRelation() const 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
MemberDefImpl(const DString &defFileName, int defLine, size_t defColumn, const DString &type, const DString &name, const DString &args, const DString &excp, Protection prot, Specifier virt, bool stat, Relationship related, MemberType t, const ArgumentList &tal, const ArgumentList &al, const DString &metaData)
void setDefinitionTemplateParameterLists(const ArgumentLists &lists) override
const ArgumentList & declArgumentList() const override
void invalidateCachedArgumentTypes() override
bool _isAnonymousBitField() const
size_t getDeclColumn() const override
void detectUndocumentedParams(bool hasParamCommand, bool hasReturnCommand) const override
const MemberDef * m_annEnumType
bool isWritable() const override
DString m_cachedTypedefTemplSpec
const MemberDef * m_templateMaster
bool isSealed() const override
bool isAbstract() const override
bool isPrivateSettable() const override
void setInitializer(const DString &i) override
bool isSequence() const override
void _computeLinkableInProject()
Grouping::GroupPri_t m_grouppri
void setRelatedAlso(ClassDef *cd) override
const MemberDef * m_annMemberForDecl
void addRequirementReferences(const Definition *) override
bool hasExamples() const override
void resolveUnnamedParameters(const MemberDef *md) override
void setMemberDefinition(MemberDef *md) override
bool isThreadLocal() const override
void writeMemberDocSimple(OutputList &ol, const Definition *container) const override
void setGroupDef(GroupDef *gd, Grouping::GroupPri_t pri, const DString &fileName, int startLine, bool hasDocs, MemberDef *member=nullptr) override
bool isSignal() const override
bool isMaybeVoid() const override
void init(Definition *def, const DString &t, const DString &a, const DString &e, Protection p, Specifier v, bool s, Relationship r, MemberType mt, const ArgumentList &tal, const ArgumentList &al, const DString &meta)
void _writeReimplements(OutputList &ol) const
bool isMaybeAmbiguous() const override
bool hasOneLineInitializer() const override
const MemberList * getSectionList(const Definition *) const override
bool isForeign() const override
void addQualifiers(const StringVector &qualifiers) override
void setEnumBaseType(const DString &type) override
bool isAssign() const override
bool isStrongEnumValue() const override
DString getReadAccessor() const override
void _computeIsDestructor()
bool isNotFriend() const override
const ClassDef * getClassDefOfAnonymousType() const override
void copyArgumentNames(const MemberDef *bmd) override
bool isRemovable() const override
void setExplicitInherited(bool b) override
bool isDeleted() const override
DString getGroupFileName() const override
MemberDef * m_groupMember
const DString & initializer() const override
bool isFriend() const override
DString documentation() const override
void setArgsString(const DString &as) override
ArgumentList m_typeConstraints
ClassDef * relatedAlso() const override
void setReimplements(MemberDef *md) 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
MemberVector m_enumFields
std::unique_ptr< IncludeInfo > m_incInfo
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
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
void setDefinition(const DString &d) override
bool isFunctionOrSignalSlot() const override
void overrideInlineSource(bool e) override
void overrideCallerGraph(bool e) override
bool isPrivateGettable() const override
bool isEvent() const override
void setMemberSpecifiers(TypeSpecifier s) override
bool isFunctionPtr() const override
bool hasCallerGraph() const override
bool isObjCProperty() const override
void setEnumScope(MemberDef *md, bool livesInsideEnum=false) override
bool isPrototype() const override
DString requiresClause() const override
bool isTypedef() const override
void _writeGroupInclude(OutputList &ol, bool inGroup) const
bool hasDocumentedEnumValues() const override
~MemberDefImpl() override=default
void _writeEnumValues(OutputList &ol, const Definition *container, const DString &cfname, const DString &ciname, const DString &cname) const
uint8_t m_isLinkableCached
void setIncludeFile(FileDef *fd, const DString &incName, bool local, bool force) override
bool isVariable() const override
void mergeMemberSpecifiers(TypeSpecifier s) override
DString displayName(bool=true) const override
bool isConstrained() const override
bool isReadable() const override
DString getOutputFileBase() const override
void addListReference(const Definition *) override
bool isDefault() const override
void _writeCallGraph(OutputList &ol) const
DString briefDescription(bool abbr=false) const override
bool isOverride() const override
const MemberDef * m_docProvider
bool isSettable() const override
bool isBound() const override
CodeSymbolType codeSymbolType() const override
void setBitfields(const DString &s) override
void setInbodyDocumentation(const DString &d, const DString &inbodyFile, int inbodyLine) override
virtual void setMemberDeclaration(MemberDef *md)=0
virtual void setDocTransferDone()=0
virtual void resolveUnnamedParameters(const MemberDef *md)=0
virtual void overrideReferencesRelation(bool e)=0
virtual void overrideReferencedByRelation(bool e)=0
virtual void setDocsForDefinition(bool b)=0
virtual void overrideCallGraph(bool e)=0
virtual void overrideInlineSource(bool e)=0
virtual void overrideEnumValues(bool e)=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 overrideCallerGraph(bool e)=0
virtual void setMemberDefinition(MemberDef *md)=0
virtual void moveArgumentList(std::unique_ptr< ArgumentList > al)=0
virtual void insertReimplementedBy(MemberDef *md)=0
virtual void setGroupDef(GroupDef *gd, Grouping::GroupPri_t pri, const DString &fileName, int startLine, bool hasDocs, MemberDef *member=nullptr)=0
A class representing a group of members.
A list of MemberDef objects as shown in documentation sections.
A vector of MemberDef object.
bool contains(const MemberDef *md) const
void inSort(MemberDef *md)
iterator begin() noexcept
void push_back(const T &value)
An abstract interface of a namespace symbol.
virtual DString compoundTypeString() const =0
void startCodeFragment(const DString &style)
Class representing a list of output generators that are written to in parallel.
void writeDoc(const IDocNodeAST *ast, const Definition *ctx, const MemberDef *md, int sectionLevel=-1)
void startMemberDeclaration()
void parseText(const DString &textStr)
void startMemberDocName(bool align)
void endParameterExtra(bool last, bool one, bool bracket)
void disable(OutputType o)
void startParagraph(const DString &classDef=DString())
void writeObjectLink(const DString &ref, const DString &file, const DString &anchor, const DString &name)
void endMemberDoc(bool hasArgs)
void startDescTableInit()
void addIndexItem(const DString &s1, const DString &s2)
void startParameterExtra()
void endPageRef(const DString &c, const DString &a)
const OutputCodeList & codeGenerators() const
void startParameterList(bool openBracket)
void enable(OutputType o)
void endInlineMemberType()
void endMemberDescription()
void endMemberDeclaration(const DString &anchor, const DString &inheritId)
void startInlineMemberType()
void docify(const DString &s)
void startInlineMemberDoc()
void endMemberTemplateParams(const DString &anchor, const DString &inheritId)
void lineBreak(const DString &style=DString())
void startMemberDoc(const DString &clName, const DString &memName, const DString &anchor, const DString &title, int memCount, int memTotal, bool showInline)
void insertMemberAlign(bool templ=false)
void writeString(const DString &text)
void endDoxyAnchor(const DString &fn, const DString &anchor)
void startDescTable(const DString &title, const bool hasInits)
void startDescTableTitle()
void endInlineMemberDoc()
void endMemberDocPrefixItem()
void startParameterDefVal(const char *separator)
void startAnonTypeScope(int i1)
void addLabel(const DString &fName, const DString &anchor)
void endMemberItem(OutputGenerator::MemberItemType type)
void startDescTableData()
void pushGeneratorState()
void endParameterDefVal()
void disableAllBut(OutputType o)
void exceptionEntry(const DString &prefix, bool closeBracket)
void writeLabel(const DString &l, bool isLast)
void startMemberItem(const DString &anchor, OutputGenerator::MemberItemType type, const DString &id=DString())
void startMemberDescription(const DString &anchor, const DString &inheritId=DString(), bool typ=false)
void endCallGraph(DotCallGraph &g)
void startInlineMemberName()
void generateDoc(const DString &fileName, int startLine, const Definition *ctx, const MemberDef *md, const DString &docStr, const DocOptions &options)
void startMemberDocPrefixItem()
void endAnonTypeScope(int i1)
void startParameterName(bool one)
void startParameterType(bool first, const DString &key)
void endInlineMemberName()
void writeNonBreakableSpace(int num)
void startDoxyAnchor(const DString &fName, const DString &manName, const DString &anchor, const DString &name, const DString &args)
void startMemberTemplateParams()
std::unique_ptr< CodeParserInterface > getCodeParser(const DString &extension)
Gets the interface to the parser associated with a given extension.
static RequirementManager & instance()
void addRequirementRefsForSymbol(const Definition *symbol)
This struct is used to capture the tag file information for an Entry.
Implements TextGeneratorIntf for an OutputDocInterface stream.
Text streaming class that buffers data.
virtual DString trProvidedByCategory()=0
virtual DString trReimplementedFromList(int numEntries)=0
virtual DString trDefineValue()=0
virtual DString trSubprogram(bool first_capital, bool singular)=0
virtual DString trImplementedInList(int numEntries)=0
virtual DString trInitialValue()=0
virtual DString trImplementedFromList(int numEntries)=0
virtual DString trVhdlType(VhdlSpecifier type, bool single)=0
virtual DString trPageAbbreviation()=0
virtual DString trReimplementedInList(int numEntries)=0
virtual DString trExtendsClass()=0
virtual DString trCallerGraph()=0
virtual DString trMember(bool first_capital, bool singular)=0
virtual DString trEnumerationValues()=0
virtual DString trCallGraph()=0
virtual DString trGlobal(bool first_capital, bool singular)=0
Wrapper class for a number of boolean properties.
static bool writeVHDLTypeDocumentation(const MemberDef *mdef, const Definition *d, OutputList &ol)
static bool isMisc(const MemberDef *mdef)
static void writeSource(const MemberDef *mdef, OutputList &ol, const DString &cname)
ClassDefMutable * toClassDefMutable(Definition *d)
ClassDef * getClass(const DString &n)
ClassDef * toClassDef(Definition *d)
Class representing a regular expression.
Object representing the matching results.
SubMatch prefix() const
Return the part of the string before the match.
size_t position() const
Returns the position of the match or std::string::npos if no position is set.
SubMatch suffix() const
Return the part of the string after the match.
size_t length() const
Returns the position of the match or std::string::npos if no length is set.
std::string str() const
Returns the matching part as a string.
#define Config_getInt(name)
#define Config_getList(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 DString &argsString, DString *extraTypeChars=nullptr)
Definition * toDefinition(DefinitionMutable *dm)
#define AUTO_TRACE_ADD(...)
IDocParserPtr createDocParser()
factory function to create a parser
void docFindSections(const DString &input, const Definition *d, const DString &fileName)
IDocNodeASTPtr validatingParseDoc(IDocParser &parserIntf, const DString &fileName, int startLine, const Definition *ctx, const MemberDef *md, const DString &input, const DocOptions &options)
DString substitute(const DString &s, const DString &src, const DString &dst)
substitute all occurrences of src in s by dst
bool isId(char c)
Returns true if c is a valid character for an identifier.
DString includeClose(SrcLangExt lang, IncludeKind kind)
DString includeOpen(SrcLangExt lang, IncludeKind kind)
FileDef * toFileDef(Definition *d)
DString includeStatement(SrcLangExt lang, IncludeKind kind)
GroupDef * toGroupDef(Definition *d)
Translator * theTranslator
void linkifyText(const TextGeneratorIntf &out, const DString &text, const LinkifyTextOptions &options)
DString md5str(const std::string_view &str)
static DString simplifyTypeForTable(const DString &s)
static DString addTemplateNames(const DString &s, const DString &n, const DString &t)
static void writeExceptionListImpl(OutputList &ol, const ClassDef *cd, const MemberDef *md, DString const &exception)
static void writeExceptionList(OutputList &ol, const ClassDef *cd, const MemberDef *md)
static void writePageRef(OutputList &ol, const DString &cn, const DString &mn)
static DString combineArgsAndException(DString args, DString exception)
static bool writeDefArgumentList(OutputList &ol, const Definition *scope, const MemberDef *md)
static std::mutex g_hasDetailedDescriptionMutex
std::unique_ptr< MemberDef > createMemberDef(const DString &defFileName, int defLine, size_t defColumn, const DString &type, const DString &name, const DString &args, const DString &excp, Protection prot, Specifier virt, bool stat, Relationship related, MemberType t, const ArgumentList &tal, const ArgumentList &al, const DString &metaData)
Factory method to create a new instance of a MemberDef.
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)
MemberDefMutable * toMemberDefMutable(Definition *d)
void mergeMemberOverrideOptions(MemberDefMutable *md1, MemberDefMutable *md2)
static DString stripTrailingReturn(const DString &trailRet)
void combineDeclarationAndDefinition(MemberDefMutable *mdec, MemberDefMutable *mdef)
static bool hasParamCommand(const DString &doc)
MemberDef * toMemberDef(Definition *d)
static const reg::Ex reAnonymous(R"([\w:@]*@\d+)")
#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.
void addRefItem(const RefItemVector &sli, const DString &key, const DString &prefix, const DString &name, const DString &title, const DString &args, const Definition *scope)
std::vector< RefItem * > RefItemVector
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...
Options to configure the code parser.
Helper class to pass options when calling OutputList::generateDoc().
Data associated with an example.
GroupPri_t
Grouping priority.
@ GROUPING_AUTO_DEF
membership in group was defined via @defgroup
LinkifyTextOptions & setScope(const Definition *scope)
LinkifyTextOptions & setSelf(const Definition *self)
LinkifyTextOptions & setFileScope(const FileDef *fileScope)
bool isTypeAClassFriend(const DString &type)
DString stripExtension(const DString &fName)
DString substituteTemplateArgumentsInString(const DString &nm, const ArgumentList &formalArgs, const ArgumentList *actualArgs)
DString inlineArgListToDoc(const ArgumentList &al)
bool protectionLevelVisible(Protection prot)
DString stripFromIncludePath(const DString &path)
DString detab(const DString &s, size_t &refIndent)
void stripIndentationVerbatim(DString &doc, size_t indentationLevel, bool skipFirstLine)
void writeTypeConstraints(OutputList &ol, const Definition *d, const ArgumentList &al)
DString removeRedundantWhiteSpace(const DString &s)
DString tempArgListToString(const ArgumentList &al, SrcLangExt lang, bool includeDefault)
SrcLangExt getLanguageFromFileName(const DString &fileName, SrcLangExt defLang)
bool matchArguments2(const Definition *srcScope, const FileDef *srcFileScope, const DString &srcReturnType, const ArgumentList *srcAl, const Definition *dstScope, const FileDef *dstFileScope, const DString &dstReturnType, const ArgumentList *dstAl, bool checkCV, SrcLangExt lang)
void addHtmlExtensionIfMissing(DString &fName)
DString convertToXML(const DString &s, bool keepEntities, const bool citeEntry)
DString getLanguageSpecificSeparator(SrcLangExt lang, bool classScope)
DString removeAnonymousScopes(const DString &str)
void writeMarkerList(OutputList &ol, const std::string &markerText, size_t numMarkers, std::function< void(size_t)> replaceFunc)
DString inlineTemplateArgListToDoc(const ArgumentList &al)
void writeExamples(OutputList &ol, const ExampleList &list)
A bunch of utility functions.