duchainpointer.h

Go to the documentation of this file.

/*
   Copyright 2007 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_DUCHAINPOINTER_H
#define KDEVPLATFORM_DUCHAINPOINTER_H
 
#include <QMetaType>
#include <QList>
#include <QExplicitlySharedDataPointer>
#include <language/languageexport.h>
 
//krazy:excludeall=dpointer
 
namespace KDevelop {
class DUContext;
class TopDUContext;
class DUChainBase;
class Declaration;
class AbstractFunctionDeclaration;
 
class KDEVPLATFORMLANGUAGE_EXPORT DUChainPointerData
    : public QSharedData
{
public:
    DUChainBase* base();
 
    DUChainBase* base() const;
 
    DUChainPointerData();
 
    ~DUChainPointerData();
 
private:
    explicit DUChainPointerData(DUChainBase* base);
 
    friend class DUChainBase;
    DUChainBase* m_base = nullptr;
    Q_DISABLE_COPY(DUChainPointerData)
};
 
template <class Type>
class DUChainPointer
{
    template <class OtherType>
    friend class DUChainPointer;
 
public:
    DUChainPointer() : d(QExplicitlySharedDataPointer<DUChainPointerData>(nullptr))
    {
    }
 
    DUChainPointer(const DUChainPointer&) = default;
    DUChainPointer(DUChainPointer&&) = default;
 
    template <class OtherType>
    explicit DUChainPointer(OtherType* rhs)
    {
        if (dynamic_cast<Type*>(rhs))
            d = rhs->weakPointer();
    }
 
    template <class OtherType>
    explicit DUChainPointer(DUChainPointer<OtherType> rhs)
    {
        if (dynamic_cast<Type*>(rhs.data()))
            d = rhs.d;
    }
 
    explicit DUChainPointer(QExplicitlySharedDataPointer<DUChainPointerData> rhs)
    {
        if (dynamic_cast<Type*>(rhs->base()))
            d = rhs;
    }
 
    explicit DUChainPointer(Type* rhs)
    {
        if (rhs)
            d = rhs->weakPointer();
    }
 
    ~DUChainPointer() = default;
 
    bool operator ==(const DUChainPointer<Type>& rhs) const
    {
        return d.data() == rhs.d.data();
    }
 
    bool operator !=(const DUChainPointer<Type>& rhs) const
    {
        return d.data() != rhs.d.data();
    }
 
    operator bool() const {
        return d && d->base();
    }
 
    Type& operator*() const
    {
        Q_ASSERT(d);
        return *static_cast<Type*>(d->base());
    }
 
    Type* operator->() const
    {
        Q_ASSERT(d);
        return static_cast<Type*>(d->base());
    }
 
    bool operator<(const DUChainPointer<Type>& rhs) const
    {
        return d.data() < rhs.d.data();
    }
 
    template <class NewType>
    DUChainPointer<NewType> dynamicCast() const
    {
        if (d && dynamic_cast<NewType*>(d->base()))  //When the reference to the pointer is constant that doesn't mean that the pointed object needs to be constant
            return DUChainPointer<NewType>(static_cast<NewType*>(d->base()));
        else
            return DUChainPointer<NewType>();
    }
 
    Type* data() const
    {
        if (!d)
            return nullptr;
        return static_cast<Type*>(d->base());
    }
 
    DUChainPointer<Type>& operator=(const DUChainPointer<Type>&) = default;
    DUChainPointer<Type>& operator=(DUChainPointer<Type>&&) = default;
 
    DUChainPointer<Type>& operator=(Type* rhs)
    {
        if (rhs)
            d = rhs->weakPointer();
        else
            d = nullptr;
 
        return *this;
    }
 
private:
    QExplicitlySharedDataPointer<DUChainPointerData> d;
};
 
using DUChainBasePointer = DUChainPointer<DUChainBase>;
using DUContextPointer = DUChainPointer<DUContext>;
using TopDUContextPointer = DUChainPointer<TopDUContext>;
using DeclarationPointer = DUChainPointer<Declaration>;
using FunctionDeclarationPointer = DUChainPointer<AbstractFunctionDeclaration>;
}
 
Q_DECLARE_METATYPE(KDevelop::DUChainBasePointer)
Q_DECLARE_METATYPE(KDevelop::DeclarationPointer)
Q_DECLARE_METATYPE(KDevelop::DUContextPointer)
Q_DECLARE_METATYPE(KDevelop::TopDUContextPointer)
 
#endif