forked from qt-creator/qt-creator
f844f54cb7
Instead of constructor arguments. This makes it clearer on the user side which value is actually changed. Change-Id: I63ae8cd139a49700996c8874098111aad89ace22 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
387 lines
13 KiB
C++
387 lines
13 KiB
C++
/****************************************************************************
|
|
**
|
|
** Copyright (C) 2016 The Qt Company Ltd.
|
|
** Contact: https://www.qt.io/licensing/
|
|
**
|
|
** This file is part of Qt Creator.
|
|
**
|
|
** Commercial License Usage
|
|
** Licensees holding valid commercial Qt licenses may use this file in
|
|
** accordance with the commercial license agreement provided with the
|
|
** Software or, alternatively, in accordance with the terms contained in
|
|
** a written agreement between you and The Qt Company. For licensing terms
|
|
** and conditions see https://www.qt.io/terms-conditions. For further
|
|
** information use the contact form at https://www.qt.io/contact-us.
|
|
**
|
|
** GNU General Public License Usage
|
|
** Alternatively, this file may be used under the terms of the GNU
|
|
** General Public License version 3 as published by the Free Software
|
|
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
|
|
** included in the packaging of this file. Please review the following
|
|
** information to ensure the GNU General Public License requirements will
|
|
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
|
|
**
|
|
****************************************************************************/
|
|
|
|
#pragma once
|
|
|
|
#include "projectexplorer_export.h"
|
|
|
|
#include <QFutureInterface>
|
|
#include <QIcon>
|
|
#include <QStringList>
|
|
|
|
#include <coreplugin/id.h>
|
|
|
|
#include <utils/fileutils.h>
|
|
#include <utils/optional.h>
|
|
|
|
#include <functional>
|
|
|
|
namespace Utils { class MimeType; }
|
|
|
|
namespace ProjectExplorer {
|
|
|
|
class Project;
|
|
|
|
enum class NodeType : quint16 {
|
|
File = 1,
|
|
Folder,
|
|
VirtualFolder,
|
|
Project
|
|
};
|
|
|
|
// File types common for qt projects
|
|
enum class FileType : quint16 {
|
|
Unknown = 0,
|
|
Header,
|
|
Source,
|
|
Form,
|
|
StateChart,
|
|
Resource,
|
|
QML,
|
|
Project,
|
|
FileTypeSize
|
|
};
|
|
|
|
enum ProjectAction {
|
|
// Special value to indicate that the actions are handled by the parent
|
|
InheritedFromParent,
|
|
AddSubProject,
|
|
AddExistingProject,
|
|
RemoveSubProject,
|
|
// Let's the user select to which project file
|
|
// the file is added
|
|
AddNewFile,
|
|
AddExistingFile,
|
|
// Add files, which match user defined filters,
|
|
// from an existing directory and its subdirectories
|
|
AddExistingDirectory,
|
|
// Removes a file from the project, optionally also
|
|
// delete it on disc
|
|
RemoveFile,
|
|
// Deletes a file from the file system, informs the project
|
|
// that a file was deleted
|
|
// DeleteFile is a define on windows...
|
|
EraseFile,
|
|
Rename,
|
|
DuplicateFile,
|
|
// hides actions that use the path(): Open containing folder, open terminal here and Find in Directory
|
|
HidePathActions,
|
|
HideFileActions,
|
|
HideFolderActions,
|
|
};
|
|
|
|
class FileNode;
|
|
class FolderNode;
|
|
class ProjectNode;
|
|
class ContainerNode;
|
|
|
|
// Documentation inside.
|
|
class PROJECTEXPLORER_EXPORT Node
|
|
{
|
|
public:
|
|
enum PriorityLevel {
|
|
DefaultPriority = 0,
|
|
DefaultFilePriority = 100000,
|
|
DefaultFolderPriority = 200000,
|
|
DefaultVirtualFolderPriority = 300000,
|
|
DefaultProjectPriority = 400000,
|
|
DefaultProjectFilePriority = 500000
|
|
};
|
|
|
|
virtual ~Node();
|
|
Node(const Node &other) = delete;
|
|
NodeType nodeType() const;
|
|
int priority() const;
|
|
|
|
ProjectNode *parentProjectNode() const; // parent project, will be nullptr for the top-level project
|
|
FolderNode *parentFolderNode() const; // parent folder or project
|
|
|
|
ProjectNode *managingProject(); // project managing this node.
|
|
// result is the container's rootProject node if this is a project container node
|
|
// (i.e. possibly null)
|
|
// or node if node is a top-level ProjectNode directly below a container
|
|
// or node->parentProjectNode() for all other cases.
|
|
const ProjectNode *managingProject() const; // see above.
|
|
|
|
const Utils::FileName &filePath() const; // file system path
|
|
int line() const;
|
|
QByteArray id() const;
|
|
virtual QString displayName() const;
|
|
virtual QString tooltip() const;
|
|
bool isEnabled() const;
|
|
bool listInProject() const;
|
|
bool isGenerated() const;
|
|
|
|
virtual bool supportsAction(ProjectAction action, const Node *node) const;
|
|
|
|
void setEnabled(bool enabled);
|
|
void setAbsoluteFilePathAndLine(const Utils::FileName &filePath, int line);
|
|
|
|
virtual FileNode *asFileNode() { return nullptr; }
|
|
virtual const FileNode *asFileNode() const { return nullptr; }
|
|
virtual FolderNode *asFolderNode() { return nullptr; }
|
|
virtual const FolderNode *asFolderNode() const { return nullptr; }
|
|
virtual ProjectNode *asProjectNode() { return nullptr; }
|
|
virtual const ProjectNode *asProjectNode() const { return nullptr; }
|
|
virtual ContainerNode *asContainerNode() { return nullptr; }
|
|
virtual const ContainerNode *asContainerNode() const { return nullptr; }
|
|
|
|
virtual QString buildKey() const { return QString(); }
|
|
|
|
static bool sortByPath(const Node *a, const Node *b);
|
|
void setParentFolderNode(FolderNode *parentFolder);
|
|
|
|
void setListInProject(bool l);
|
|
void setIsGenerated(bool g);
|
|
|
|
static FileType fileTypeForMimeType(const Utils::MimeType &mt);
|
|
static FileType fileTypeForFileName(const Utils::FileName &file);
|
|
|
|
protected:
|
|
explicit Node(NodeType nodeType);
|
|
|
|
void setPriority(int priority);
|
|
void setLine(int line);
|
|
void setNodeId(const QByteArray &nodeId);
|
|
void setFilePath(const Utils::FileName &filePath);
|
|
|
|
private:
|
|
FolderNode *m_parentFolderNode = nullptr;
|
|
Utils::FileName m_filePath;
|
|
QByteArray m_nodeId;
|
|
int m_line = -1;
|
|
int m_priority = DefaultPriority;
|
|
const NodeType m_nodeType;
|
|
enum NodeFlag : quint16 {
|
|
FlagNone = 0,
|
|
FlagIsEnabled = 1 << 0,
|
|
FlagIsGenerated = 1 << 1,
|
|
FlagListInProject = 1 << 2,
|
|
};
|
|
NodeFlag m_flags = FlagIsEnabled;
|
|
};
|
|
|
|
class PROJECTEXPLORER_EXPORT FileNode : public Node
|
|
{
|
|
public:
|
|
FileNode(const Utils::FileName &filePath, const FileType fileType);
|
|
|
|
FileNode *clone() const;
|
|
|
|
FileType fileType() const;
|
|
|
|
FileNode *asFileNode() final { return this; }
|
|
const FileNode *asFileNode() const final { return this; }
|
|
|
|
static QList<FileNode *>
|
|
scanForFiles(const Utils::FileName &directory,
|
|
const std::function<FileNode *(const Utils::FileName &fileName)> factory,
|
|
QFutureInterface<QList<FileNode *>> *future = nullptr);
|
|
bool supportsAction(ProjectAction action, const Node *node) const override;
|
|
|
|
private:
|
|
FileType m_fileType;
|
|
};
|
|
|
|
// Documentation inside.
|
|
class PROJECTEXPLORER_EXPORT FolderNode : public Node
|
|
{
|
|
public:
|
|
explicit FolderNode(const Utils::FileName &folderPath, NodeType nodeType = NodeType::Folder,
|
|
const QString &displayName = QString());
|
|
|
|
QString displayName() const override;
|
|
QIcon icon() const;
|
|
|
|
Node *findNode(const std::function<bool(Node *)> &filter);
|
|
QList<Node *> findNodes(const std::function<bool(Node *)> &filter);
|
|
|
|
void forEachNode(const std::function<void(FileNode *)> &fileTask,
|
|
const std::function<void(FolderNode *)> &folderTask = {},
|
|
const std::function<bool(const FolderNode *)> &folderFilterTask = {}) const;
|
|
void forEachGenericNode(const std::function<void(Node *)> &genericTask) const;
|
|
void forEachProjectNode(const std::function<void(const ProjectNode *)> &genericTask) const;
|
|
ProjectNode *findProjectNode(const std::function<bool(const ProjectNode *)> &predicate);
|
|
const QList<Node *> nodes() const;
|
|
QList<FileNode *> fileNodes() const;
|
|
FileNode *fileNode(const Utils::FileName &file) const;
|
|
QList<FolderNode *> folderNodes() const;
|
|
using FolderNodeFactory = std::function<std::unique_ptr<FolderNode>(const Utils::FileName &)>;
|
|
void addNestedNodes(std::vector<std::unique_ptr<FileNode>> &&files,
|
|
const Utils::FileName &overrideBaseDir = Utils::FileName(),
|
|
const FolderNodeFactory &factory
|
|
= [](const Utils::FileName &fn) { return std::make_unique<FolderNode>(fn); });
|
|
void addNestedNode(std::unique_ptr<FileNode> &&fileNode,
|
|
const Utils::FileName &overrideBaseDir = Utils::FileName(),
|
|
const FolderNodeFactory &factory
|
|
= [](const Utils::FileName &fn) { return std::make_unique<FolderNode>(fn); });
|
|
void compress();
|
|
|
|
bool isAncesterOf(Node *n);
|
|
|
|
// takes ownership of newNode.
|
|
// Will delete newNode if oldNode is not a child of this node.
|
|
bool replaceSubtree(Node *oldNode, std::unique_ptr<Node> &&newNode);
|
|
|
|
void setDisplayName(const QString &name);
|
|
void setIcon(const QIcon &icon);
|
|
|
|
class LocationInfo {
|
|
public:
|
|
LocationInfo(const QString &dn, const Utils::FileName &p, const int l = -1) :
|
|
path(p), line(l), displayName(dn) { }
|
|
|
|
Utils::FileName path;
|
|
int line = -1;
|
|
QString displayName;
|
|
};
|
|
void setLocationInfo(const QList<LocationInfo> &info);
|
|
const QList<LocationInfo> locationInfo() const;
|
|
|
|
virtual QString addFileFilter() const;
|
|
|
|
bool supportsAction(ProjectAction action, const Node *node) const override;
|
|
|
|
virtual bool addFiles(const QStringList &filePaths, QStringList *notAdded = nullptr);
|
|
virtual bool removeFiles(const QStringList &filePaths, QStringList *notRemoved = nullptr);
|
|
virtual bool deleteFiles(const QStringList &filePaths);
|
|
virtual bool canRenameFile(const QString &filePath, const QString &newFilePath);
|
|
virtual bool renameFile(const QString &filePath, const QString &newFilePath);
|
|
|
|
class AddNewInformation
|
|
{
|
|
public:
|
|
AddNewInformation(const QString &name, int p)
|
|
:displayName(name), priority(p)
|
|
{ }
|
|
QString displayName;
|
|
int priority;
|
|
};
|
|
|
|
virtual AddNewInformation addNewInformation(const QStringList &files, Node *context) const;
|
|
|
|
|
|
// determines if node will be shown in the flat view, by default folder and projects aren't shown
|
|
virtual bool showInSimpleTree() const;
|
|
// determines if node will always be shown when hiding empty directories
|
|
virtual bool showWhenEmpty() const;
|
|
|
|
void addNode(std::unique_ptr<Node> &&node);
|
|
std::unique_ptr<Node> takeNode(Node *node);
|
|
|
|
bool isEmpty() const;
|
|
|
|
FolderNode *asFolderNode() override { return this; }
|
|
const FolderNode *asFolderNode() const override { return this; }
|
|
|
|
protected:
|
|
virtual void handleSubTreeChanged(FolderNode *node);
|
|
|
|
std::vector<std::unique_ptr<Node>> m_nodes;
|
|
QList<LocationInfo> m_locations;
|
|
|
|
private:
|
|
QString m_displayName;
|
|
mutable QIcon m_icon;
|
|
};
|
|
|
|
class PROJECTEXPLORER_EXPORT VirtualFolderNode : public FolderNode
|
|
{
|
|
public:
|
|
explicit VirtualFolderNode(const Utils::FileName &folderPath, int priority,
|
|
const QByteArray &id = {});
|
|
|
|
void setAddFileFilter(const QString &filter) { m_addFileFilter = filter; }
|
|
QString addFileFilter() const override;
|
|
|
|
private:
|
|
QString m_addFileFilter;
|
|
};
|
|
|
|
// Documentation inside.
|
|
class PROJECTEXPLORER_EXPORT ProjectNode : public FolderNode
|
|
{
|
|
public:
|
|
virtual bool canAddSubProject(const QString &proFilePath) const;
|
|
virtual bool addSubProject(const QString &proFile);
|
|
virtual QStringList subProjectFileNamePatterns() const;
|
|
virtual bool removeSubProject(const QString &proFilePath);
|
|
virtual Utils::optional<Utils::FileName> visibleAfterAddFileAction() const {
|
|
return Utils::nullopt;
|
|
}
|
|
|
|
bool addFiles(const QStringList &filePaths, QStringList *notAdded = nullptr) override;
|
|
bool removeFiles(const QStringList &filePaths, QStringList *notRemoved = nullptr) override;
|
|
bool deleteFiles(const QStringList &filePaths) override;
|
|
bool canRenameFile(const QString &filePath, const QString &newFilePath) override;
|
|
bool renameFile(const QString &filePath, const QString &newFilePath) override;
|
|
bool supportsAction(ProjectAction action, const Node *node) const override;
|
|
|
|
// by default returns false
|
|
virtual bool deploysFolder(const QString &folder) const;
|
|
|
|
ProjectNode *projectNode(const Utils::FileName &file) const;
|
|
|
|
ProjectNode *asProjectNode() final { return this; }
|
|
const ProjectNode *asProjectNode() const final { return this; }
|
|
|
|
virtual QStringList targetApplications() const { return {}; }
|
|
virtual bool parseInProgress() const { return false; }
|
|
|
|
virtual bool validParse() const { return false; }
|
|
virtual QVariant data(Core::Id role) const;
|
|
virtual bool setData(Core::Id role, const QVariant &value) const;
|
|
|
|
protected:
|
|
explicit ProjectNode(const Utils::FileName &projectFilePath);
|
|
};
|
|
|
|
class PROJECTEXPLORER_EXPORT ContainerNode : public FolderNode
|
|
{
|
|
public:
|
|
ContainerNode(Project *project);
|
|
|
|
QString displayName() const final;
|
|
bool supportsAction(ProjectAction action, const Node *node) const final;
|
|
|
|
ContainerNode *asContainerNode() final { return this; }
|
|
const ContainerNode *asContainerNode() const final { return this; }
|
|
|
|
ProjectNode *rootProjectNode() const;
|
|
Project *project() const { return m_project; }
|
|
|
|
void removeAllChildren();
|
|
|
|
private:
|
|
void handleSubTreeChanged(FolderNode *node) final;
|
|
|
|
Project *m_project;
|
|
};
|
|
|
|
} // namespace ProjectExplorer
|
|
|
|
Q_DECLARE_METATYPE(ProjectExplorer::Node *)
|
|
Q_DECLARE_METATYPE(ProjectExplorer::FolderNode *)
|