Differential D23287 Diff 65993 processcore/process_data_provider.h

Changeset View

Standalone View

processcore/process_data_provider.h

This file was added.

1		/*
2		Copyright (c) 2019 David Edmundson <davidedmundson@kde.org>
3
4		This library is free software; you can redistribute it and/or
5		modify it under the terms of the GNU Library General Public
6		License as published by the Free Software Foundation; either
7		version 2 of the License, or (at your option) any later version.
8
9		This library is distributed in the hope that it will be useful,
10		but WITHOUT ANY WARRANTY; without even the implied warranty of
11		MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12		Library General Public License for more details.
13
14		You should have received a copy of the GNU Library General Public License
15		along with this library; see the file COPYING.LIB. If not, write to
16		the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17		Boston, MA 02110-1301, USA.
18		*/
19		#pragma once
20
21		#include <QObject>
22		#include <QVariant>
	broulikUnsubmitted Not Done Unused broulik: Unused
23
	broulikUnsubmitted Done Unused broulik: Unused
24		namespace KSysGuard {
25
26		class Processes;
27		class Process;
28		class ProcessAttribute;
29
30		/**
31		* Base class for a process plugin data
32		* Plugins provide a list of additional attributes, which in turn have data about a given process
	broulikUnsubmitted Done Not used before its declaration below? broulik: Not used before its declaration below?
33		*/
34		class Q_DECL_EXPORT ProcessDataProvider : public QObject
35		{
36		Q_OBJECT
37
38		public:
39		ProcessDataProvider(QObject *parent, const QVariantList &args);
40		~ProcessDataProvider() override;
41
42		/**
43		* Accessors for process information matching
44		*/
45		KSysGuard::Processes *processes() const;
46
47		/**
48		* Returns a new process object for a given PID
49		* This will update the process list if this PID does not exist yet
50		* This may return a null pointer
51		*/
52		KSysGuard::Process *getProcess(long pid);
53
	zzagUnsubmitted Not Done Coding style inconsistency: pointer alignment. Such inconsistency can be noticed in other parts of this patch too, e.g. QVector<KSysGuard::ProcessAttribute> and QVector<KSysGuard::ProcessAttribute >, etc. zzag: Coding style inconsistency: pointer alignment. Such inconsistency can be noticed in other…
54		/**
55		* A list of all process attributes provided by this plugin
	broulikUnsubmitted Not Done Why `const`? broulik: Why `const`?
	davidedmundsonAuthorUnsubmitted Not Done Simply why not? Doesn't really make a difference. davidedmundson: Simply why not? Doesn't really make a difference.
56		* It is expected to remain constant through the lifespan of this class
57		*/
58		QVector<ProcessAttribute *> attributes() const;
59
60		/**
61		* Called when processes should be updated if manually polled
62		* Plugins can however update at any time if enabled
63		*/
64		virtual void update()
65		{
66		}
67
	ahiemstraUnsubmitted Done I'm missing the implementation for this method in process_data_provider.cpp ahiemstra: I'm missing the implementation for this method in process_data_provider.cpp
68		/**
69		* True when at least one attribute from this plugin is subscribed
70		*/
71		bool enabled() const;
72
73		virtual void handleEnabledChanged(bool enabled)
74		{
75		Q_UNUSED(enabled)
76		}
77
78		// for any future compatibility
79		virtual void virtual_hook(int id, void *data)
80		{
81		Q_UNUSED(id)
82		Q_UNUSED(data)
83		}
84
85		protected:
86		/**
87		* Register a new process attribute
88		* Process attributes should be created in the plugin constuctor and must live for the duration the plugin
89		*/
90		void addProcessAttribute(ProcessAttribute *attribute);
91
92		private:
	broulikUnsubmitted Not Done Docs broulik: Docs
93		class Private;
94		QScopedPointer<Private> d;
95		};
96
97		}
	broulikUnsubmitted Done Coding style: asterisk after space broulik: Coding style: asterisk after space