Differential D7995 Diff 20162 kdevplatform/project/projectwatcher.h

Changeset View

Standalone View

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 <KDirWatch>
25
26		namespace KDevelop {
27
28		class IProject;
29		class ProjectFilterManager;
30
31		class ProjectWatcher : public KDirWatch
32		{
33		public:
34		explicit ProjectWatcher(IProject* project, ProjectFilterManager* filter);
35
	mwolffUnsubmitted Done whitespaces around operators mwolff: whitespaces around operators
36		void addDir(const QString& path, WatchModes watchModes = WatchDirOnly);
37		void removeDir(const QString& path);
38
	mwolffUnsubmitted Done de-inline, constify mwolff: de-inline, constify
39		int size() const;
	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		private:
42		IProject* m_project;
43		ProjectFilterManager* m_filter;
	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		int m_watchedCount;
45		};
46
47		}
48		#endif //KDEVPLATFORM_PROJECTWATCHER_H