projectmodel.h

Go to the documentation of this file.

/* This file is part of KDevelop
    Copyright 2005 Roberto Raggi <[email protected]>
    Copyright 2007 Andreas Pakulat <[email protected]>
    Copyright 2007 Aleix Pol <[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 as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.
 
    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_PROJECTMODEL_H
#define KDEVPLATFORM_PROJECTMODEL_H
 
#include <QAbstractItemModel>
#include <QUrl>
 
#include "projectexport.h"
 
template<typename T1,typename T2> struct QPair;
template<typename T> class QList;
 
namespace KDevelop
{
 
class IProject;
class ProjectFolderItem;
class ProjectBuildFolderItem;
class ProjectFileItem;
class ProjectTargetItem;
class ProjectExecutableTargetItem;
class ProjectLibraryTargetItem;
class ProjectModel;
class IndexedString;
class Path;
class ProjectModelPrivate;
 
class KDEVPLATFORMPROJECT_EXPORT ProjectVisitor
{
public:
    ProjectVisitor();
    virtual ~ProjectVisitor();
    virtual void visit( ProjectModel* );
    virtual void visit( IProject* );
    virtual void visit( ProjectFolderItem* );
    virtual void visit( ProjectFileItem* );
    virtual void visit( ProjectBuildFolderItem* );
    virtual void visit( ProjectExecutableTargetItem* );
    virtual void visit( ProjectLibraryTargetItem* );
};
 
class KDEVPLATFORMPROJECT_EXPORT ProjectBaseItem
{
    public:
        ProjectBaseItem( IProject*, const QString &name, ProjectBaseItem *parent = nullptr );
        virtual ~ProjectBaseItem();
 
 
        enum ProjectItemType
        {
            BaseItem = 0          ,
            BuildFolder = 1       ,
            Folder = 2            ,
            ExecutableTarget = 3  ,
            LibraryTarget = 4     ,
            Target = 5            ,
            File = 6              ,
            CustomProjectItemType = 100 
        };
 
        enum RenameStatus
        {
            RenameOk = 0,
            ExistingItemSameName = 1,
            ProjectManagerRenameFailed = 2,
            InvalidNewName = 3
        };
 
        IProject* project() const;
 
        virtual ProjectFolderItem *folder() const;
 
        virtual ProjectTargetItem *target() const;
 
        virtual ProjectFileItem *file() const;
 
        virtual ProjectExecutableTargetItem *executable() const;
 
        QList<ProjectFolderItem*> folderList() const;
 
        QList<ProjectTargetItem*> targetList() const;
 
        QList<ProjectFileItem*> fileList() const;
 
        virtual bool lessThan( const KDevelop::ProjectBaseItem* ) const;
        static bool pathLessThan(KDevelop::ProjectBaseItem* item1, KDevelop::ProjectBaseItem* item2);
 
        ProjectBaseItem* child( int row ) const;
        QList<ProjectBaseItem*> children() const;
        QModelIndex index() const;
        virtual ProjectBaseItem* parent() const;
        QString text() const;
        int row() const;
 
        int rowCount() const;
 
        ProjectModel* model() const;
 
        void appendRow( ProjectBaseItem* item );
 
        void removeRow( int row );
 
        void removeRows( int row, int count );
 
        ProjectBaseItem* takeRow( int row );
 
        virtual int type() const;
 
        virtual QString iconName() const;
 
        virtual void setPath( const Path& );
 
        Path path() const;
 
        IndexedString indexedPath() const;
 
        QString baseName() const;
 
        virtual RenameStatus rename( const QString& newname );
 
        bool isProjectRoot() const;
 
        virtual Qt::ItemFlags flags();
 
        void setFlags(Qt::ItemFlags flags);
 
    protected:
        void setText( const QString& text );
 
        const QScopedPointer<class ProjectBaseItemPrivate> d_ptr;
        void setRow( int row );
        void setModel( ProjectModel* model );
    private:
        Q_DECLARE_PRIVATE(ProjectBaseItem)
        friend class ProjectModel;
};
 
class KDEVPLATFORMPROJECT_EXPORT ProjectFolderItem: public ProjectBaseItem
{
public:
    ProjectFolderItem( IProject* project, const Path& path, ProjectBaseItem* parent = nullptr );
 
    ProjectFolderItem( const QString& name, ProjectBaseItem *parent );
 
    ~ProjectFolderItem() override;
 
    void setPath(const Path& ) override;
 
    ProjectFolderItem *folder() const override;
 
    int type() const override;
 
    QString folderName() const;
 
    bool hasFileOrFolder(const QString& name) const;
 
    QString iconName() const override;
    RenameStatus rename(const QString& newname) override;
 
private:
    void propagateRename( const Path& newBase ) const;
};
 
 
class KDEVPLATFORMPROJECT_EXPORT ProjectBuildFolderItem: public ProjectFolderItem
{
public:
    ProjectBuildFolderItem( IProject* project, const Path &path, ProjectBaseItem* parent = nullptr );
    ProjectBuildFolderItem( const QString &name, ProjectBaseItem *parent );
 
    int type() const override;
    QString iconName() const override;
};
 
class KDEVPLATFORMPROJECT_EXPORT ProjectTargetItem: public ProjectBaseItem
{
public:
    ProjectTargetItem( IProject*, const QString &name, ProjectBaseItem *parent = nullptr );
 
    int type() const override;
 
    ProjectTargetItem *target() const override;
    QString iconName() const override;
    void setPath(const Path& path ) override;
};
 
class KDEVPLATFORMPROJECT_EXPORT ProjectExecutableTargetItem: public ProjectTargetItem
{
    public:
        ProjectExecutableTargetItem( IProject*, const QString &name, ProjectBaseItem *parent = nullptr );
 
        ProjectExecutableTargetItem *executable() const override;
        int type() const override;
        virtual QUrl builtUrl() const=0;
        virtual QUrl installedUrl() const=0;
};
 
 
class KDEVPLATFORMPROJECT_EXPORT ProjectLibraryTargetItem: public ProjectTargetItem
{
    public:
        ProjectLibraryTargetItem(IProject* project, const QString &name, ProjectBaseItem *parent = nullptr );
 
        int type() const override;
};
 
class KDEVPLATFORMPROJECT_EXPORT ProjectFileItem: public ProjectBaseItem
{
public:
    ProjectFileItem( IProject* project, const Path& path, ProjectBaseItem* parent = nullptr );
 
    ProjectFileItem( const QString& name, ProjectBaseItem *parent );
    ~ProjectFileItem() override;
 
    int type() const override;
 
    ProjectFileItem *file() const override;
 
    QString fileName() const;
 
    void setPath( const Path& ) override;
    QString iconName() const override;
    RenameStatus rename(const QString& newname) override;
};
 
class KDEVPLATFORMPROJECT_EXPORT ProjectModel: public QAbstractItemModel
{
    Q_OBJECT
public:
    enum Roles {
          ProjectRole = Qt::UserRole+1
        , ProjectItemRole
        , UrlRole
        , LastRole
    };
 
    explicit ProjectModel( QObject *parent = nullptr );
    ~ProjectModel() override;
 
    void clear();
 
    void appendRow( ProjectBaseItem* item );
    void removeRow( int row );
    ProjectBaseItem* takeRow( int row );
 
    ProjectBaseItem* itemAt( int row ) const;
    QList<ProjectBaseItem*> topItems() const;
 
    QModelIndex pathToIndex(const QStringList& tofetch) const;
    QStringList pathFromIndex(const QModelIndex& index) const;
 
    QModelIndex indexFromItem( const ProjectBaseItem* item ) const;
    ProjectBaseItem* itemFromIndex( const QModelIndex& ) const;
 
    int columnCount( const QModelIndex& parent = QModelIndex() ) const override;
    QVariant data( const QModelIndex& index, int role = Qt::DisplayRole ) const override;
    QModelIndex parent( const QModelIndex& child ) const override;
    int rowCount( const QModelIndex& parent = QModelIndex() ) const override;
    QModelIndex index(int row, int column, const QModelIndex& parent = QModelIndex()) const override;
 
    bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole) override;
    bool insertColumns(int column, int count, const QModelIndex& parent = QModelIndex()) override;
    bool insertRows(int row, int count, const QModelIndex& parent = QModelIndex()) override;
 
    Qt::ItemFlags flags(const QModelIndex& index) const override;
    Qt::DropActions supportedDropActions() const override;
 
    QList<ProjectBaseItem*> itemsForPath(const IndexedString& path) const;
 
    ProjectBaseItem* itemForPath(const IndexedString& path) const;
 
private:
    const QScopedPointer<class ProjectModelPrivate> d_ptr;
    Q_DECLARE_PRIVATE(ProjectModel)
    friend class ProjectBaseItem;
};
 
KDEVPLATFORMPROJECT_EXPORT QStringList joinProjectBasePath( const QStringList& partialpath, KDevelop::ProjectBaseItem* item );
KDEVPLATFORMPROJECT_EXPORT QStringList removeProjectBasePath( const QStringList& fullpath, KDevelop::ProjectBaseItem* item );
 
}
 
Q_DECLARE_METATYPE(KDevelop::ProjectBaseItem*)
Q_DECLARE_METATYPE(KDevelop::ProjectFolderItem*)
Q_DECLARE_METATYPE(KDevelop::ProjectFileItem*)
Q_DECLARE_METATYPE(KDevelop::ProjectLibraryTargetItem*)
Q_DECLARE_METATYPE(KDevelop::ProjectExecutableTargetItem*)
Q_DECLARE_METATYPE(KDevelop::ProjectTargetItem*)
Q_DECLARE_METATYPE(KDevelop::ProjectBuildFolderItem*)
Q_DECLARE_METATYPE(QList<KDevelop::ProjectBaseItem*>)
 
#endif // KDEVPLATFORM_PROJECTMODEL_H