• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdevelop API Reference
  • KDE Home
  • Contact Us
 

kdevplatform/language/duchain

  • sources
  • kfour-appscomplete
  • kdevelop
  • kdevplatform
  • language
  • duchain
classdeclaration.cpp
Go to the documentation of this file.
1 /* This file is part of KDevelop
2  Copyright 2007 David Nolden <[email protected]>
3  Copyright 2009 Lior Mualem <[email protected]>
4 
5  This library is free software; you can redistribute it and/or
6  modify it under the terms of the GNU Library General Public
7  License version 2 as published by the Free Software Foundation.
8 
9  This library is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  Library General Public License for more details.
13 
14  You should have received a copy of the GNU Library General Public License
15  along with this library; see the file COPYING.LIB. If not, write to
16  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  Boston, MA 02110-1301, USA.
18  */
19 
20 #include "classdeclaration.h"
21 #include "identifier.h"
22 #include <language/duchain/declaration.h>
23 #include <language/duchain/appendedlist.h>
24 #include <language/duchain/duchainregister.h>
25 #include "types/structuretype.h"
26 #include <debug.h>
27 
28 namespace KDevelop {
29 DEFINE_LIST_MEMBER_HASH(ClassDeclarationData, baseClasses, BaseClassInstance)
30 
31 ClassDeclaration::ClassDeclaration(const KDevelop::RangeInRevision& range, DUContext* context)
32  : ClassMemberDeclaration(*new ClassDeclarationData, range)
33 {
34  d_func_dynamic()->setClassId(this);
35  setContext(context);
36 }
37 
38 ClassDeclaration::ClassDeclaration(ClassDeclarationData& data, const KDevelop::RangeInRevision& range,
39  DUContext* context)
40  : ClassMemberDeclaration(data, range)
41 {
42  setContext(context);
43 }
44 
45 ClassDeclaration::ClassDeclaration(ClassDeclarationData& data)
46  : ClassMemberDeclaration(data)
47 {
48 }
49 
50 REGISTER_DUCHAIN_ITEM(ClassDeclaration);
51 
52 void ClassDeclaration::clearBaseClasses()
53 {
54  d_func_dynamic()->baseClassesList().clear();
55 }
56 
57 uint ClassDeclaration::baseClassesSize() const
58 {
59  return d_func()->baseClassesSize();
60 }
61 
62 const BaseClassInstance* ClassDeclaration::baseClasses() const
63 {
64  return d_func()->baseClasses();
65 }
66 
67 void ClassDeclaration::addBaseClass(const BaseClassInstance& klass)
68 {
69  d_func_dynamic()->baseClassesList().append(klass);
70 }
71 
72 void ClassDeclaration::replaceBaseClass(uint n, const BaseClassInstance& klass)
73 {
74  Q_ASSERT(n <= d_func()->baseClassesSize());
75  d_func_dynamic()->baseClassesList()[n] = klass;
76 }
77 
78 ClassDeclaration::~ClassDeclaration()
79 {
80 }
81 
82 ClassDeclaration::ClassDeclaration(const ClassDeclaration& rhs)
83  : ClassMemberDeclaration(*new ClassDeclarationData(*rhs.d_func()))
84 {
85  d_func_dynamic()->setClassId(this);
86 }
87 
88 Declaration* ClassDeclaration::clonePrivate() const
89 {
90  return new ClassDeclaration(*this);
91 }
92 
93 namespace {
94 bool isPublicBaseClassInternal(const ClassDeclaration* self, ClassDeclaration* base,
95  const KDevelop::TopDUContext* topContext,
96  int* baseConversionLevels, int depth, QSet<const ClassDeclaration*>* checked)
97 {
98  if (checked) {
99  if (checked->contains(self))
100  return false;
101  checked->insert(self);
102  } else if (depth > 3) {
103  //Too much depth, to prevent endless recursion, we control the recursion using the 'checked' set
104  QSet<const ClassDeclaration*> checkedSet;
105  return isPublicBaseClassInternal(self, base, topContext, baseConversionLevels, depth, &checkedSet);
106  }
107 
108  if (baseConversionLevels)
109  *baseConversionLevels = 0;
110 
111  if (self->indexedType() == base->indexedType())
112  return true;
113 
114  FOREACH_FUNCTION(const BaseClassInstance &b, self->baseClasses)
115  {
116  if (baseConversionLevels)
117  ++(*baseConversionLevels);
118  //qCDebug(LANGUAGE) << "public base of" << c->toString() << "is" << b.baseClass->toString();
119  if (b.access != KDevelop::Declaration::Private) {
120  int nextBaseConversion = 0;
121  if (StructureType::Ptr c = b.baseClass.type<StructureType>()) {
122  auto* decl = dynamic_cast<ClassDeclaration*>(c->declaration(topContext));
123  if (decl &&
124  isPublicBaseClassInternal(decl, base, topContext, &nextBaseConversion, depth + 1, checked)) {
125  if (baseConversionLevels)
126  *baseConversionLevels += nextBaseConversion;
127  return true;
128  }
129  }
130  }
131  if (baseConversionLevels)
132  --(*baseConversionLevels);
133  }
134  return false;
135 }
136 }
137 
138 bool ClassDeclaration::isPublicBaseClass(ClassDeclaration* base, const KDevelop::TopDUContext* topContext,
139  int* baseConversionLevels) const
140 {
141  return isPublicBaseClassInternal(this, base, topContext, baseConversionLevels, 0, nullptr);
142 }
143 
144 QString ClassDeclaration::toString() const
145 {
146  QString ret;
147  switch (classModifier()) {
148  case ClassDeclarationData::None:
149  //nothing
150  break;
151  case ClassDeclarationData::Abstract:
152  ret += QLatin1String("abstract ");
153  break;
154  case ClassDeclarationData::Final:
155  ret += QLatin1String("final ");
156  break;
157  }
158  switch (classType()) {
159  case ClassDeclarationData::Class:
160  ret += QLatin1String("class ");
161  break;
162  case ClassDeclarationData::Interface:
163  ret += QLatin1String("interface ");
164  break;
165  case ClassDeclarationData::Trait:
166  ret += QLatin1String("trait ");
167  break;
168  case ClassDeclarationData::Union:
169  ret += QLatin1String("union ");
170  break;
171  case ClassDeclarationData::Struct:
172  ret += QLatin1String("struct ");
173  break;
174  }
175  return ret + identifier().toString();
176 }
177 
178 ClassDeclarationData::ClassType ClassDeclaration::classType() const
179 {
180  return d_func()->m_classType;
181 }
182 
183 void ClassDeclaration::setClassType(ClassDeclarationData::ClassType type)
184 {
185  d_func_dynamic()->m_classType = type;
186 }
187 
188 ClassDeclarationData::ClassModifier ClassDeclaration::classModifier() const
189 {
190  return d_func()->m_classModifier;
191 }
192 
193 void ClassDeclaration::setClassModifier(ClassDeclarationData::ClassModifier modifier)
194 {
195  d_func_dynamic()->m_classModifier = modifier;
196 }
197 }
QSet
KDevelop::ClassDeclaration
Represents a single template-parameter definition.
Definition: classdeclaration.h:97
DEFINE_LIST_MEMBER_HASH
#define DEFINE_LIST_MEMBER_HASH(container, member, type)
Definition: appendedlist.h:218
KDevelop::REGISTER_DUCHAIN_ITEM
REGISTER_DUCHAIN_ITEM(AliasDeclaration)
KDevelop::ClassDeclaration::toString
QString toString() const override
Determine this declaration as a string.
Definition: classdeclaration.cpp:144
KDevelop::StructureType::Ptr
TypePtr< StructureType > Ptr
Definition: structuretype.h:42
KDevelop::ClassDeclaration::classModifier
ClassDeclarationData::ClassModifier classModifier() const
Definition: classdeclaration.cpp:188
KDevelop::ClassDeclaration::baseClassesSize
uint baseClassesSize() const
Count of base-classes.
Definition: classdeclaration.cpp:57
KDevelop::Declaration::setContext
void setContext(DUContext *context, bool anonymous=false)
Set the context in which this declaration occurs.
Definition: declaration.cpp:290
appendedlist.h
KDevelop::Declaration::identifier
Identifier identifier() const
Access this declaration's identifier.
Definition: declaration.cpp:204
KDevelop::Declaration
Represents a single declaration in a definition-use chain.
Definition: declaration.h:51
FOREACH_FUNCTION
#define FOREACH_FUNCTION(item, container)
Foreach macro that takes a container and a function-name, and will iterate through the vector returne...
Definition: appendedlist.h:213
declaration.h
QString
KDevelop::ClassDeclaration::classType
ClassDeclarationData::ClassType classType() const
Definition: classdeclaration.cpp:178
structuretype.h
identifier.h
KDevelop::Declaration::type
TypePtr< T > type() const
Convenience function to return this declaration's type dynamically casted to T.
Definition: declaration.h:305
KDevelop::Declaration::topContext
TopDUContext * topContext() const override
Determine the top context to which this object belongs.
Definition: declaration.cpp:633
KDevelop::ClassDeclaration::setClassModifier
void setClassModifier(ClassDeclarationData::ClassModifier modifier)
Definition: classdeclaration.cpp:193
KDevelop::TopDUContext
The top context in a definition-use chain for one source file.
Definition: topducontext.h:113
KDevelop::ClassDeclaration::~ClassDeclaration
~ClassDeclaration() override
Definition: classdeclaration.cpp:78
KDevelop::ClassMemberDeclaration
Represents a single class member definition in a definition-use chain.
Definition: classmemberdeclaration.h:32
KDevelop::Declaration::context
DUContext * context() const
Access the parent context of this declaration.
Definition: declaration.cpp:279
KDevelop::ClassDeclaration::ClassDeclaration
ClassDeclaration(const ClassDeclaration &rhs)
Definition: classdeclaration.cpp:82
QLatin1String
KDevelop::Declaration::Private
a private declaration
Definition: declaration.h:59
QSet::contains
bool contains(const T &value) const
KDevelop::Identifier::toString
QString toString(IdentifierStringFormattingOptions options=NoOptions) const
Definition: identifier.cpp:594
KDevelop::ClassDeclaration::replaceBaseClass
void replaceBaseClass(uint n, const BaseClassInstance &klass)
Definition: classdeclaration.cpp:72
KDevelop::ClassDeclaration::baseClasses
const BaseClassInstance * baseClasses() const
The types this class is based on.
Definition: classdeclaration.cpp:62
KDevelop::ClassDeclaration::clearBaseClasses
void clearBaseClasses()
Definition: classdeclaration.cpp:52
KDevelop
Definition: abstractfunctiondeclaration.cpp:27
QSet::insert
const_iterator insert(const T &value)
KDevelop::DUContext
A single context in source code, represented as a node in a directed acyclic graph.
Definition: ducontext.h:72
KDevelop::BaseClassInstance
Definition: classdeclaration.h:34
KDevelop::ClassDeclaration::setClassType
void setClassType(ClassDeclarationData::ClassType type)
Definition: classdeclaration.cpp:183
duchainregister.h
classdeclaration.h
KDevelop::ClassDeclaration::isPublicBaseClass
bool isPublicBaseClass(ClassDeclaration *base, const KDevelop::TopDUContext *topContext, int *baseConversionLevels=nullptr) const
Returns whether base is a public base-class of this class.
Definition: classdeclaration.cpp:138
KDevelop::ClassDeclaration::addBaseClass
void addBaseClass(const BaseClassInstance &klass)
Definition: classdeclaration.cpp:67
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Fri Apr 9 2021 23:29:59 by doxygen 1.8.16 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

kdevplatform/language/duchain

Skip menu "kdevplatform/language/duchain"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdevelop API Reference

Skip menu "kdevelop API Reference"
  • kdevplatform
  •   debugger
  •   documentation
  •   interfaces
  •   language
  •     assistant
  •     backgroundparser
  •     checks
  •     classmodel
  •     codecompletion
  •     codegen
  •     duchain
  •     editor
  •     highlighting
  •     interfaces
  •     util
  •   outputview
  •   project
  •   serialization
  •   shell
  •   sublime
  •   tests
  •   util
  •   vcs

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal