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
|
/*
SPDX-FileCopyrightText: 2013 Milian Wolff <mail@milianw.de>
SPDX-License-Identifier: LGPL-2.0-or-later
*/
#ifndef KDEVPLATFORM_PROJECTFILTERMANAGER_H
#define KDEVPLATFORM_PROJECTFILTERMANAGER_H
#include "projectexport.h"
#include <QObject>
#include <QVector>
#include <QSharedPointer>
namespace KDevelop {
class IProjectFilter;
class IProjectFilterProvider;
class IPlugin;
class IProject;
class Path;
class ProjectFilterManagerPrivate;
/**
* @short A helper class to manage project filtering in file managers.
*
* Use this class in implementations of IProjectFileManager to simplify
* the management of IProjectFilter instances for projects managed by
* your file manager.
*
* NOTE: This interface is _not_ threadsafe. But you can use filtersForProject()
* to implement thread safe filtering.
*
* @author Milian Wolff
*/
class KDEVPLATFORMPROJECT_EXPORT ProjectFilterManager : public QObject
{
Q_OBJECT
public:
explicit ProjectFilterManager(QObject* parent = nullptr);
~ProjectFilterManager() override;
/**
* @copydoc IProjectFilter::isValid
*/
bool isValid(const Path& path, bool isFolder, IProject* project) const;
/**
* Manage the filters of the given project.
*/
void add(IProject* project);
/**
* Remove the managed filters of the given project.
*/
void remove(IProject* project);
/**
* TODO: remove this once the cmake manager got cleaned up to not need this
* anymore.
*
* @return true if the project is managed, false otherwise.
*/
bool isManaged(IProject* project) const;
/**
* @return the current list of project filters for a given managed project.
*
* This can be used to implement a thread safe project filtering
*/
QVector<QSharedPointer<IProjectFilter> > filtersForProject(IProject* project) const;
private:
const QScopedPointer<class ProjectFilterManagerPrivate> d_ptr;
Q_DECLARE_PRIVATE(ProjectFilterManager)
Q_PRIVATE_SLOT(d_func(), void filterChanged( KDevelop::IProjectFilterProvider*, KDevelop::IProject* ) )
};
}
#endif // KDEVPLATFORM_PROJECTFILTERMANAGER_H
|