Differential D23114 Diff 69732 helpers/perf/ftrace_marker.h

Changeset View

Standalone View

helpers/perf/ftrace_marker.h

This file was added.

1		/********************************************************************
	zzagUnsubmitted Not Done I don't think that directory `helpers/` is the right place for the FtraceMarker class since it's not an internal utility. Directory `helpers/` contains libexec stuff. zzag: I don't think that directory `helpers/` is the right place for the FtraceMarker class since…
2		KWin - the KDE window manager
3		This file is part of the KDE project.
4
5		Copyright 2019 Roman Gilg <subdiff@gmail.com>
6
7		This program is free software; you can redistribute it and/or modify
8		it under the terms of the GNU General Public License as published by
9		the Free Software Foundation; either version 2 of the License, or
10		(at your option) any later version.
11
12		This program is distributed in the hope that it will be useful,
13		but WITHOUT ANY WARRANTY; without even the implied warranty of
14		MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15		GNU General Public License for more details.
16
17		You should have received a copy of the GNU General Public License
18		along with this program. If not, see <http://www.gnu.org/licenses/>.
19		*********************************************************************/
20		#pragma once
21
22		#include <kwinglobals.h>
23
24		#include <QFile>
25
26		namespace KWin
27		{
28		namespace Perf
29		{
30
31		/**
32		* Provides an interface to mark the Ftrace output for debugging.
33		*/
34		class FtraceMarker : public QObject
35		{
36		Q_OBJECT
37		public:
38		virtual ~FtraceMarker() = default;
39
40		/**
41		* @brief Enables or disables the marker
42		*
43		* @param enable The enablement state to set
44		* @return True if setting enablement succeeded, else false
	davidedmundsonUnsubmitted Done Using overloads to denote different actions (begin/end) is a bit unusual...especially if a future person wants to add a real overload davidedmundson: Using overloads to denote different actions (begin/end) is a bit unusual...especially if a…
45		*/
46		bool setEnabled(bool enable);
47		void print(const QString &message);
48		void printBegin(const QString &message, ulong ctx);
49		void printEnd(const QString &message, ulong ctx);
50
51		private:
52		bool findFile();
53
54		QFile *m_file = nullptr;
55
56		KWIN_SINGLETON(FtraceMarker)
57		};
58
59		}
60		}