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
|
/*
This file is part of KDevelop
Copyright 2013 Milian Wolff <mail@milianw.de>
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_IPROJECTFILTERPROVIDER_H
#define KDEVPLATFORM_IPROJECTFILTERPROVIDER_H
#include <project/projectexport.h>
#include <QObject>
#include <QSharedPointer>
namespace KDevelop
{
class IProject;
class IProjectFilter;
/**
* @short An interface to create project filters.
*
* Plugins implement this interface and return an instance of a custom
* IProjectFilter implementation, which is then doing the actual filtering.
*
* The filter should then allow filtering of files and folders in a
* threadsafe way.
*
* Project managers are supposed to listen to the filterChanged signal
* and update the project filter accordingly, i.e. by creating a new
* filter instance.
*
* This interface was designed such that project filtering can be done in a
* multithreaded project manager without the need for any locks.
*
* @author Milian Wolff
*/
class KDEVPLATFORMPROJECT_EXPORT IProjectFilterProvider
{
public:
virtual ~IProjectFilterProvider();
/**
* Factory function to create threadsafe project filter instances.
*
* @param project The project that the filter should operate on.
*
* @return A threadsafe implementation of the IProjectFilter instance.
*/
virtual QSharedPointer<IProjectFilter> createFilter(IProject* project) const = 0;
Q_SIGNALS:
/**
* Should be emitted whenever the filter rules for the given @p project changed.
*
* Listeners should act on this signal by replacing their current filter
* with a new instance.
*/
void filterChanged(KDevelop::IProjectFilterProvider*, KDevelop::IProject* project);
};
}
Q_DECLARE_INTERFACE( KDevelop::IProjectFilterProvider, "org.kdevelop.IProjectFilterProvider")
#endif // KDEVPLATFORM_IPROJECTFILTERPROVIDER_H
|
