• Skip to content
• Skip to link menu

KDE 4.4 API Reference

• KDE API Reference
• KDevelop Platform Libraries

• Sitemap
• Contact Us

 

language/duchain

declaration.h

/* This file is part of KDevelop
    Copyright 2006 Hamish Rodda <rodda@kde.org>
    Copyright 2007-2008 David Nolden <david.nolden.kdevelop@art-master.de>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License version 2 as published by the Free Software Foundation.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/

#ifndef DECLARATION_H
#define DECLARATION_H

#include <QtCore/QList>
#include <QtCore/QMap>
//#include <QtCore/qcontainerfwd.h>

#include "../editor/documentrangeobject.h"
#include "identifier.h"
#include "indexedstring.h"
#include "types/abstracttype.h"
#include "duchainbase.h"
#include "topducontext.h"
#include "indexeditems.h"

class QByteArray;

namespace KTextEditor {
  class SmartRange;
}

namespace KDevelop
{

class AbstractType;
class DUContext;
class Use;
class ForwardDeclaration;
class DeclarationData;
class DeclarationId;
class Declaration;
class IndexedTopDUContext;


class KDEVPLATFORMLANGUAGE_EXPORT Declaration : public DUChainBase
{
public:
  enum AccessPolicy {
    Public    ,
    Protected ,
    Private   ,
    DefaultAccess 
  };
  enum Kind {
    Type     ,
    Instance ,
    NamespaceAlias,
    Alias, 
    Namespace, 
    Import 
  };

  Declaration(const SimpleRange& range, DUContext* parentContext);
  Declaration(const Declaration& rhs);
  virtual ~Declaration();
  Declaration( DeclarationData & dd );

  virtual TopDUContext* topContext() const;

  virtual bool isForwardDeclaration() const;
  ForwardDeclaration* toForwardDeclaration();
  const ForwardDeclaration* toForwardDeclaration() const;

  virtual bool isFunctionDeclaration() const;

  virtual bool inDUChain() const;

  bool isDefinition() const;
  void setDeclarationIsDefinition(bool dd);

  bool isTypeAlias() const;
  void setIsTypeAlias(bool typeAlias);

  bool isFinal() const;
  void setFinal(bool final);

  virtual Declaration* specialize(IndexedInstantiationInformation specialization, const TopDUContext* topContext, int upDistance = 0);

  DUContext * internalContext() const;

  void setInternalContext(DUContext* context);

  virtual DUContext * logicalInternalContext(const TopDUContext* topContext) const;

  const Declaration* logicalDeclaration(const TopDUContext* topContext) const;

  Declaration* logicalDeclaration(const TopDUContext* topContext);

  DUContext* context() const;

  void setContext(DUContext* context, bool anonymous = false);

  template <class T>
  TypePtr<T> type() const { return TypePtr<T>::dynamicCast(abstractType()); }

  AbstractType::Ptr abstractType() const;

  template <class T>
  void setType(TypePtr<T> type) { setAbstractType(AbstractType::Ptr::staticCast(type)); }

  virtual void setAbstractType(AbstractType::Ptr type);

  IndexedType indexedType() const;

  void setIdentifier(const Identifier& identifier);

  Identifier identifier() const;

  IndexedIdentifier indexedIdentifier() const;

  QualifiedIdentifier qualifiedIdentifier() const;

  bool equalQualifiedIdentifier(const Declaration* rhs) const;

  Kind kind() const;

  void setKind(Kind kind);

  QByteArray comment() const;

  void setComment(const QByteArray& str);
  void setComment(const QString& str);

  bool inSymbolTable() const;

  void setInSymbolTable(bool inSymbolTable);

  bool operator==(const Declaration& other) const;

  virtual QString toString() const;


  QMap<IndexedString, QList<SimpleRange> > uses() const;

  QList<KTextEditor::SmartRange*> smartUses() const;

  virtual uint additionalIdentity() const;

  virtual IndexedInstantiationInformation specialization() const;

  virtual DeclarationId id(bool forceDirect = false) const;

  uint ownIndex() const;

  bool isAnonymous() const;

  void clearOwnIndex();

  void allocateOwnIndex();

  Declaration* clone() const;

  virtual void activateSpecialization();

  enum {
    Identity = 7
  };

protected:

  Declaration( DeclarationData & dd, const SimpleRange& range );

  DUCHAIN_DECLARE_DATA(Declaration)
private:
  virtual Declaration* clonePrivate() const;

  void updateCodeModel();

  void rebuildDynamicData(DUContext* parent, uint ownIndex);

  friend class DUContext;
  friend class IndexedDeclaration;
  friend class LocalIndexedDeclaration;
  friend class TopDUContextDynamicData;
  DUContext* m_context;
  TopDUContext* m_topContext;
  int m_indexInTopContext;
};

inline uint qHash(const IndexedDeclaration& decl) {
  return decl.hash();
}
}

Q_DECLARE_METATYPE(KDevelop::IndexedDeclaration)

#endif // DECLARATION_H

// kate: space-indent on; indent-width 2; tab-width 4; replace-tabs on; auto-insert-doxygen on

language/duchain

Skip menu "language/duchain"

• Main Page
• Namespace List
• Class Hierarchy
• Alphabetical List
• Class List
• File List
• Namespace Members
• Class Members
• Related Pages

KDevelop Platform Libraries

Skip menu "KDevelop Platform Libraries"

• interfaces
• language
•   codegen
•   duchain
•   editor
• outputview
• project
• shell
• sublime
• util
• vcs

Generated for KDevelop Platform Libraries by doxygen 1.5.9-20090814
This website is maintained by Adriaan de Groot and Allen Winter.
KDE^® and the K Desktop Environment^® logo are registered trademarks of KDE e.V. | Legal