Skip to content

Commit

Permalink
Refactoring: modernize ClassDef::getTemplateInstances()
Browse files Browse the repository at this point in the history
  • Loading branch information
@doxygen
doxygen committed Jan 22, 2021
1 parent 0aa9077 commit 62e5802
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 63 deletions.
46 changes: 19 additions & 27 deletions src/classdef.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ class ClassDefImpl : public DefinitionMixin<ClassDefMutable>
virtual bool isBaseClass(const ClassDef *bcd,bool followInstances,int level=0) const;
virtual bool isSubClass(ClassDef *bcd,int level=0) const;
virtual bool isAccessibleMember(const MemberDef *md) const;
virtual QDict<ClassDef> *getTemplateInstances() const;
virtual const TemplateInstanceList &getTemplateInstances() const;
virtual const ClassDef *templateMaster() const;
virtual bool isTemplate() const;
virtual IncludeInfo *includeInfo() const;
Expand Down Expand Up @@ -441,7 +441,7 @@ class ClassDefAliasImpl : public DefinitionAliasMixin<ClassDef>
{ return getCdAlias()->isSubClass(bcd,level); }
virtual bool isAccessibleMember(const MemberDef *md) const
{ return getCdAlias()->isAccessibleMember(md); }
virtual QDict<ClassDef> *getTemplateInstances() const
virtual const TemplateInstanceList &getTemplateInstances() const
{ return getCdAlias()->getTemplateInstances(); }
virtual const ClassDef *templateMaster() const
{ return getCdAlias()->templateMaster(); }
Expand Down Expand Up @@ -652,7 +652,7 @@ class ClassDefImpl::IMPL
/*! Template instances that exists of this class, the key in the
* dictionary is the template argument list.
*/
mutable QDict<ClassDef> *templateInstances = 0;
TemplateInstanceList templateInstances;

/*! Template instances that exists of this class, as defined by variables.
* We do NOT want to document these individually. The key in the
Expand Down Expand Up @@ -740,7 +740,6 @@ void ClassDefImpl::IMPL::init(const char *defFileName, const char *name,
usesIntfClassDict=0;
constraintClassDict=0;
subGrouping=Config_getBool(SUBGROUPING);
templateInstances = 0;
variableInstances = 0;
templateMaster =0;
templBaseClassNames = 0;
Expand Down Expand Up @@ -782,7 +781,6 @@ ClassDefImpl::IMPL::~IMPL()
delete usesIntfClassDict;
delete constraintClassDict;
delete incInfo;
delete templateInstances;
delete variableInstances;
delete templBaseClassNames;
}
Expand Down Expand Up @@ -1209,17 +1207,12 @@ void ClassDefImpl::insertUsedFile(FileDef *fd)
{
if (fd==0) return;
if (m_impl->files.find(fd)==-1) m_impl->files.append(fd);
if (m_impl->templateInstances)
for (const auto &ti : m_impl->templateInstances)
{
QDictIterator<ClassDef> qdi(*m_impl->templateInstances);
ClassDef *cd;
for (qdi.toFirst();(cd=qdi.current());++qdi)
ClassDefMutable *cdm = toClassDefMutable(ti.classDef);
if (cdm)
{
ClassDefMutable *cdm = toClassDefMutable(cd);
if (cdm)
{
cdm->insertUsedFile(fd);
}
cdm->insertUsedFile(fd);
}
}
}
Expand Down Expand Up @@ -3215,15 +3208,11 @@ bool ClassDefImpl::hasNonReferenceSuperClass() const
if (!found)
{
// look for template instances that might have non-reference super classes
QDict<ClassDef> *cil = bcd->getTemplateInstances();
if (cil)
for (const auto &cil : bcd->getTemplateInstances())
{
QDictIterator<ClassDef> tidi(*cil);
for ( ; tidi.current() && !found ; ++tidi) // for each template instance
{
// recurse into the template instance branch
found = found || tidi.current()->hasNonReferenceSuperClass();
}
// recurse into the template instance branch
found = cil.classDef->hasNonReferenceSuperClass();
if (found) break;
}
}
else
Expand Down Expand Up @@ -3939,11 +3928,14 @@ ClassDef *ClassDefImpl::insertTemplateInstance(const QCString &fileName,
int startLine, int startColumn, const QCString &templSpec,bool &freshInstance) const
{
freshInstance = FALSE;
if (m_impl->templateInstances==0)
auto it = std::find_if(m_impl->templateInstances.begin(),
m_impl->templateInstances.end(),
[&templSpec](const auto &ti) { return templSpec==ti.templSpec; });
ClassDefMutable *templateClass=0;
if (it!=m_impl->templateInstances.end())
{
m_impl->templateInstances = new QDict<ClassDef>(17);
templateClass = toClassDefMutable((*it).classDef);
}
ClassDefMutable *templateClass=toClassDefMutable(m_impl->templateInstances->find(templSpec));
if (templateClass==0)
{
QCString tcname = removeRedundantWhiteSpace(localName()+templSpec);
Expand All @@ -3965,7 +3957,7 @@ ClassDef *ClassDefImpl::insertTemplateInstance(const QCString &fileName,
templateClass->setOuterScope(getOuterScope());
templateClass->setHidden(isHidden());
templateClass->setArtificial(isArtificial());
m_impl->templateInstances->insert(templSpec,templateClass);
m_impl->templateInstances.push_back(TemplateInstanceDef(templSpec,templateClass));

// also add nested classes
for (const auto &innerCd : m_impl->innerClasses)
Expand Down Expand Up @@ -4638,7 +4630,7 @@ FileDef *ClassDefImpl::getFileDef() const
return m_impl->fileDef;
}

QDict<ClassDef> *ClassDefImpl::getTemplateInstances() const
const TemplateInstanceList &ClassDefImpl::getTemplateInstances() const
{
return m_impl->templateInstances;
}
Expand Down
13 changes: 12 additions & 1 deletion src/classdef.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,17 @@ struct BaseClassDef

using BaseClassList = std::vector<BaseClassDef>;

/** Class that contains information about a template instance relation */
struct TemplateInstanceDef
{
TemplateInstanceDef(const QCString &ts,const ClassDef *cd) : templSpec(ts), classDef(cd) {}
QCString templSpec;
const ClassDef *classDef;
};

using TemplateInstanceList = std::vector<TemplateInstanceDef>;


/** A abstract class representing of a compound symbol.
*
* A compound can be a class, struct, union, interface, service, singleton,
Expand Down Expand Up @@ -233,7 +244,7 @@ class ClassDef : public Definition
/** Returns a sorted dictionary with all template instances found for
* this template class. Returns 0 if not a template or no instances.
*/
virtual QDict<ClassDef> *getTemplateInstances() const = 0;
virtual const TemplateInstanceList &getTemplateInstances() const = 0;

/** Returns the template master of which this class is an instance.
* Returns 0 if not applicable.
Expand Down
22 changes: 5 additions & 17 deletions src/dotclassgraph.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -300,30 +300,18 @@ void DotClassGraph::buildGraph(const ClassDef *cd,DotNode *n,bool base,int dista
const ClassDef *templMaster=cd->templateMaster();
if (templMaster)
{
QDictIterator<ClassDef> cli(*templMaster->getTemplateInstances());
const ClassDef *templInstance;
for (;(templInstance=cli.current());++cli)
for (const auto &ti : templMaster->getTemplateInstances())
if (ti.classDef==cd)
{
if (templInstance==cd)
{
addClass(templMaster,n,EdgeInfo::Orange,cli.currentKey(),0,
0,TRUE,distance);
}
addClass(templMaster,n,EdgeInfo::Orange,ti.templSpec,0,0,TRUE,distance);
}
}
}
else // template relations for super classes
{
const QDict<ClassDef> *templInstances = cd->getTemplateInstances();
if (templInstances)
for (const auto &ti : cd->getTemplateInstances())
{
QDictIterator<ClassDef> cli(*templInstances);
const ClassDef *templInstance;
for (;(templInstance=cli.current());++cli)
{
addClass(templInstance,n,EdgeInfo::Orange,cli.currentKey(),0,
0,FALSE,distance);
}
addClass(ti.classDef,n,EdgeInfo::Orange,ti.templSpec,0,0,FALSE,distance);
}
}
}
Expand Down
26 changes: 8 additions & 18 deletions src/doxygen.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4840,19 +4840,16 @@ static void computeTemplateClassRelations()
bName=stripTemplateSpecifiersFromScope(bName);
ClassDefMutable *cd=getClassMutable(bName);
// strip any anonymous scopes first
QDict<ClassDef> *templInstances = 0;
if (cd && (templInstances=cd->getTemplateInstances()))
if (cd && !cd->getTemplateInstances().empty())
{
Debug::print(Debug::Classes,0," Template class %s : \n",qPrint(cd->name()));
QDictIterator<ClassDef> tdi(*templInstances);
ClassDef *itcd;
for (tdi.toFirst();(itcd=tdi.current());++tdi) // for each template instance
for (const auto &ti : cd->getTemplateInstances()) // for each template instance
{
ClassDefMutable *tcd=toClassDefMutable(itcd);
ClassDefMutable *tcd=toClassDefMutable(ti.classDef);
if (tcd)
{
Debug::print(Debug::Classes,0," Template instance %s : \n",qPrint(tcd->name()));
QCString templSpec = tdi.currentKey();
QCString templSpec = ti.templSpec;
std::unique_ptr<ArgumentList> templArgs = stringToArgumentList(tcd->getLanguage(),templSpec);
for (const BaseInfo &bi : root->extends)
{
Expand Down Expand Up @@ -7631,19 +7628,12 @@ static void createTemplateInstanceMembers()
for (const auto &cd : *Doxygen::classLinkedMap)
{
// that is a template
QDict<ClassDef> *templInstances = cd->getTemplateInstances();
if (templInstances)
for (const auto &ti : cd->getTemplateInstances())
{
QDictIterator<ClassDef> qdi(*templInstances);
ClassDef *tcd=0;
// for each instance of the template
for (qdi.toFirst();(tcd=qdi.current());++qdi)
ClassDefMutable *tcdm = toClassDefMutable(ti.classDef);
if (tcdm)
{
ClassDefMutable *tcdm = toClassDefMutable(tcd);
if (tcdm)
{
tcdm->addMembersToTemplateInstance(cd.get(),cd->templateArguments(),qdi.currentKey());
}
tcdm->addMembersToTemplateInstance(cd.get(),cd->templateArguments(),ti.templSpec);
}
}
}
Expand Down

0 comments on commit 62e5802

Please sign in to comment.