1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
/*
SPDX-FileCopyrightText: 2001 Matthias Hoelzer-Kluepfel <hoelzer@kde.org>
SPDX-FileCopyrightText: 2001-2002 Bernd Gehrmann <bernd@kdevelop.org>
SPDX-FileCopyrightText: 2002-2003 Roberto Raggi <roberto@kdevelop.org>
SPDX-FileCopyrightText: 2002 Simon Hausmann <hausmann@kde.org>
SPDX-FileCopyrightText: 2003 Jens Dagerbo <jens.dagerbo@swipnet.se>
SPDX-FileCopyrightText: 2003 Mario Scalas <mario.scalas@libero.it>
SPDX-FileCopyrightText: 2003-2004 Alexander Dymo <adymo@kdevelop.org>
SPDX-FileCopyrightText: 2006 Matt Rogers <mattr@kde.org>
SPDX-FileCopyrightText: 2007 Andreas Pakulat <apaku@gmx.de>
SPDX-License-Identifier: LGPL-2.0-or-later
*/
#ifndef KDEVPLATFORM_SHELLPROJECT_H
#define KDEVPLATFORM_SHELLPROJECT_H
#include <interfaces/iproject.h>
#include <interfaces/istatus.h>
#include "shellexport.h"
template<typename T> class QList;
class KJob;
namespace KDevelop
{
class IProjectFileManager;
class IBuildSystemManager;
class ProjectFileItem;
class PersistentHash;
class ProjectPrivate;
/**
* \brief Object which represents a KDevelop project
*
* Provide better descriptions
*/
class KDEVPLATFORMSHELL_EXPORT Project : public IProject
{
Q_OBJECT
public:
/**
* Constructs a project.
*
* @param parent The parent object for the plugin.
*/
explicit Project(QObject *parent = nullptr);
~Project() override;
QList< ProjectBaseItem* > itemsForPath(const IndexedString& path) const override;
QList< ProjectFileItem* > filesForPath(const IndexedString& file) const override;
QList< ProjectFolderItem* > foldersForPath(const IndexedString& folder) const override;
QString projectTempFile() const;
QString developerTempFile() const;
Path developerFile() const;
void reloadModel() override;
Path projectFile() const override;
KSharedConfigPtr projectConfiguration() const override;
void addToFileSet( ProjectFileItem* file ) override;
void removeFromFileSet( ProjectFileItem* file ) override;
QSet<IndexedString> fileSet() const override;
bool isReady() const override;
Path path() const override;
Q_SCRIPTABLE QString name() const override;
public Q_SLOTS:
/**
* @brief Open a project
*
* This method opens a project and starts the process of loading the
* data for the project from disk.
*
* @param projectFile The path pointing to the location of the project
* file to load
*
* The project name is taken from the Name key in the project file in
* the 'General' group
*/
bool open(const Path &projectFile);
void close() override;
IProjectFileManager* projectFileManager() const override;
IBuildSystemManager* buildSystemManager() const override;
IPlugin* versionControlPlugin() const override;
IPlugin* managerPlugin() const override;
/**
* Set the manager plugin for the project.
*/
void setManagerPlugin( IPlugin* manager );
ProjectFolderItem* projectItem() const override;
/**
* Check if the url specified by @a url is part of the project.
* @a url can be either a relative url (to the project directory) or
* an absolute url.
*
* @param url the url to check
*
* @return true if the url @a url is a part of the project.
*/
bool inProject(const IndexedString &url) const override;
void setReloadJob(KJob* job) override;
Q_SIGNALS:
/**
* Internal signal to make IProjectController::projectAboutToOpen useful.
*/
void aboutToOpen(KDevelop::IProject*);
private:
const QScopedPointer<class ProjectPrivate> d_ptr;
Q_DECLARE_PRIVATE(Project)
};
} // namespace KDevelop
#endif
|
