declaration.h

Go to the documentation of this file.

/* This file is part of KDevelop
    Copyright 2006 Hamish Rodda <[email protected]>
    Copyright 2007-2008 David Nolden <[email protected]>
 
   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 KDEVPLATFORM_DECLARATION_H
#define KDEVPLATFORM_DECLARATION_H
 
#include <QList>
#include <QMap>
 
#include "types/abstracttype.h"
#include "duchainbase.h"
#include "instantiationinformation.h"
#include "identifier.h"
#include "indexeddeclaration.h"
 
class QByteArray;
 
namespace KDevelop {
class AbstractType;
class DUContext;
class IndexedString;
class DeclarationData;
class DeclarationId;
class Declaration;
class IndexedTopDUContext;
class TopDUContext;
 
class KDEVPLATFORMLANGUAGE_EXPORT Declaration
    : public DUChainBase
{
public:
    enum AccessPolicy : quint8 {
        Public ,
        Protected ,
        Private ,
        DefaultAccess 
    };
    enum Kind : quint8 {
        Type ,
        Instance ,
        NamespaceAlias ,
        Alias, 
        Namespace, 
        Import, 
        Macro 
    };
 
    Declaration(const RangeInRevision& range, DUContext* parentContext);
    Declaration(const Declaration& rhs);
    ~Declaration() override;
    explicit Declaration(DeclarationData& dd);
 
    Declaration& operator=(const Declaration& rhs) = delete;
 
    TopDUContext* topContext() const override;
 
    virtual bool isForwardDeclaration() const;
 
    virtual bool isFunctionDeclaration() const;
 
    virtual bool inDUChain() const;
 
    bool isDefinition() const;
    void setDeclarationIsDefinition(bool dd);
 
    bool isTypeAlias() const;
    void setIsTypeAlias(bool typeAlias);
 
    bool isDeprecated() const;
    void setDeprecated(bool deprecated);
 
    void setAlwaysForceDirect(bool direct);
    bool alwaysForceDirect() const;
 
    void setAutoDeclaration(bool _auto);
    bool isAutoDeclaration() const;
 
    void setExplicitlyDeleted(bool deleted);
    bool isExplicitlyDeleted() const;
 
    void setExplicitlyTyped(bool explicitlyTyped);
    bool isExplicitlyTyped() const;
 
    virtual Declaration* specialize(const 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;
 
    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;
 
    virtual void setInSymbolTable(bool inSymbolTable);
 
    bool operator==(const Declaration& other) const;
 
    virtual QString toString() const;
 
    QMap<IndexedString, QVector<RangeInRevision>> uses() const;
 
    bool hasUses() const;
 
    QMap<IndexedString, QVector<KTextEditor::Range>> usesCurrentRevision() 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 RangeInRevision& range);
 
    bool persistentlyDestroying() const;
 
    DUCHAIN_DECLARE_DATA(Declaration)
 
private:
    virtual Declaration* clonePrivate() const;
 
    void updateCodeModel();
 
    void rebuildDynamicData(DUContext* parent, uint ownIndex) override;
 
    friend class DUContext;
    friend class IndexedDeclaration;
    friend class LocalIndexedDeclaration;
    friend class TopDUContextDynamicData;
 
    DUContext* m_context = nullptr;
    TopDUContext* m_topContext = nullptr;
    int m_indexInTopContext = 0;
};
}
 
#endif // KDEVPLATFORM_DECLARATION_H