Differential D7995 Diff 22667 kdevplatform/project/projectwatcher.h

Changeset View

Standalone View

View Options

kdevplatform/project/projectwatcher.h

  • This file was added.
1​/***************************************************************************
2​ * This file is part of KDevelop *
3​ * Copyright 2017 René Bertin <rjvbertin@gmail.com> *
4​ * *
5​ * This program is free software; you can redistribute it and/or modify *
6​ * it under the terms of the GNU Library General Public License as *
7​ * published by the Free Software Foundation; either version 2 of the *
8​ * License, or (at your option) any later version. *
9​ * *
10​ * This program is distributed in the hope that it will be useful, *
11​ * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12​ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13​ * GNU General Public License for more details. *
14​ * *
15​ * You should have received a copy of the GNU Library General Public *
16​ * License along with this program; if not, write to the *
17​ * Free Software Foundation, Inc., *
18​ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
19​ ***************************************************************************/
20​
21​#ifndef KDEVPLATFORM_PROJECTWATCHER_H
22​#define KDEVPLATFORM_PROJECTWATCHER_H
23​
24​#include "projectexport.h"
25​
26​#include <KDirWatch>
27​
28​namespace KDevelop {
29​
30​class IProject;
31​class ProjectFilterManager;
32​
33​class KDEVPLATFORMPROJECT_EXPORT ProjectWatcher : public KDirWatch
34​{
35​ Q_OBJECT
mwolffUnsubmitted
Done

whitespaces around operators

mwolff: whitespaces around operators
36​public:
37​ /**
38​ * Create a dirwatcher for @p project based on KDirWatch but
mwolffUnsubmitted
Done

de-inline, constify

mwolff: de-inline, constify
39​ * that will add or remove each directory only once.
mwolffUnsubmitted
Not Done

don't pimple, this class is not going to be exported

mwolff: don't pimple, this class is not going to be exported
rjvbbAuthorUnsubmitted
Not Done

No, but this approach also allows to tinker with the ProjectWatching internals without having to rebuild more than ProjectWatcher.cpp . I'll get rid of it in due time.

rjvbb: No, but this approach also allows to tinker with the ProjectWatching internals without having…
mwolffUnsubmitted
Not Done

Sure, but it's against our policy. We only pimpl public stuff.

mwolff: Sure, but it's against our policy. We only pimpl public stuff.
rjvbbAuthorUnsubmitted
Not Done

Understood. It will be removed but maybe not yet in the next patch revision.

rjvbb: Understood. It will be removed but maybe not yet in the next patch revision.
40​ */
41​ explicit ProjectWatcher(IProject* project);
42​
43​ /**
mwolffUnsubmitted
Done

add a big fat comment explaining why this must be static, change m_ prefix to s_

mwolff: add a big fat comment explaining why this must be static, change `m_` prefix to `s_`
44​ * Add directory @p path to the project dirwatcher if it is not
45​ * already being watched.
46​ */
47​ void addDir(const QString& path, WatchModes watchModes = WatchDirOnly);
48​ void removeDir(const QString& path);
49​
50​ /**
51​ * return the current number of directories being watched.
52​ */
53​ int size() const;
54​
55​private:
56​ int m_watchedCount;
57​};
58​
59​}
60​#endif //KDEVPLATFORM_PROJECTWATCHER_H