classdeclaration.h

Go to the documentation of this file.

/* This file is part of KDevelop
    Copyright 2008 David Nolden <[email protected]>
    Copyright 2009 Lior Mualem <[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_CLASSDECLARATION_H
#define KDEVPLATFORM_CLASSDECLARATION_H
 
#include <language/duchain/declaration.h>
#include <language/duchain/declarationdata.h>
#include <language/duchain/classmemberdeclarationdata.h>
#include <language/duchain/classmemberdeclaration.h>
 
namespace KDevelop {
class DUContext;
class TopDUContext;
}
 
namespace KDevelop {
struct KDEVPLATFORMLANGUAGE_EXPORT BaseClassInstance
{
    KDevelop::IndexedType baseClass; //May either be StructureType, or DelayedType
    KDevelop::Declaration::AccessPolicy access;
    bool virtualInheritance;
};
 
KDEVPLATFORMLANGUAGE_EXPORT DECLARE_LIST_MEMBER_HASH(ClassDeclarationData, baseClasses, BaseClassInstance)
 
class KDEVPLATFORMLANGUAGE_EXPORT ClassDeclarationData
    : public KDevelop::ClassMemberDeclarationData
{
public:
    enum ClassType {
        Class,
        Struct,
        Union,
        Interface,
        Trait
    };
 
    enum ClassModifier {
        Final,
        Abstract,
        None
    };
 
    ClassDeclarationData()
        : m_classType(Class)
        , m_classModifier(None)
    {
        initializeAppendedLists();
    }
 
    ~ClassDeclarationData()
    {
        freeAppendedLists();
    }
 
    ClassDeclarationData(const ClassDeclarationData& rhs)
        : KDevelop::ClassMemberDeclarationData(rhs)
    {
        initializeAppendedLists();
        copyListsFrom(rhs);
        m_classType = rhs.m_classType;
        m_classModifier = rhs.m_classModifier;
    }
 
    ClassDeclarationData& operator=(const ClassDeclarationData& rhs) = delete;
 
    ClassType m_classType;
    ClassModifier m_classModifier;
 
    START_APPENDED_LISTS_BASE(ClassDeclarationData, KDevelop::ClassMemberDeclarationData);
    APPENDED_LIST_FIRST(ClassDeclarationData, BaseClassInstance, baseClasses);
    END_APPENDED_LISTS(ClassDeclarationData, baseClasses);
};
 
class KDEVPLATFORMLANGUAGE_EXPORT ClassDeclaration
    : public KDevelop::ClassMemberDeclaration
{
public:
    ClassDeclaration(const ClassDeclaration& rhs);
    explicit ClassDeclaration(ClassDeclarationData& data);
    ClassDeclaration(const KDevelop::RangeInRevision& range, KDevelop::DUContext* context);
    ClassDeclaration(ClassDeclarationData& data, const KDevelop::RangeInRevision& range, KDevelop::DUContext* context);
    ~ClassDeclaration() override;
 
    void clearBaseClasses();
    uint baseClassesSize() const;
    const BaseClassInstance* baseClasses() const;
    void addBaseClass(const BaseClassInstance& klass);
    //Replaces the n'th base-class with the given one. The replaced base-class must have existed.
    void replaceBaseClass(uint n, const BaseClassInstance& klass);
 
    bool isPublicBaseClass(ClassDeclaration* base, const KDevelop::TopDUContext* topContext,
                           int* baseConversionLevels = nullptr) const;
 
    QString toString() const override;
 
    void setClassType(ClassDeclarationData::ClassType type);
 
    ClassDeclarationData::ClassType classType() const;
 
    void setClassModifier(ClassDeclarationData::ClassModifier modifier);
 
    ClassDeclarationData::ClassModifier classModifier() const;
 
    enum {
        Identity = 17
    };
 
private:
    KDevelop::Declaration* clonePrivate() const override;
    DUCHAIN_DECLARE_DATA(ClassDeclaration)
};
}
 
Q_DECLARE_TYPEINFO(KDevelop::BaseClassInstance, Q_MOVABLE_TYPE);
 
#endif // KDEVPLATFORM_CLASSDECLARATION_H