[pulseview.git] / pv / globalsettings.hpp

/*
 * This file is part of the PulseView project.
 *
 * Copyright (C) 2017 Soeren Apel <soeren@apelpie.net>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see <http://www.gnu.org/licenses/>.
 */

#ifndef PULSEVIEW_GLOBALSETTINGS_HPP
#define PULSEVIEW_GLOBALSETTINGS_HPP

#include <map>

#include <glib.h>
#include <glibmm/variant.h>

#include <QSettings>
#include <QString>
#include <QVariant>

using std::map;
using std::vector;

namespace pv {

class GlobalSettingsInterface
{
public:
	virtual void on_setting_changed(const QString &key, const QVariant &value) = 0;
};


class GlobalSettings : public QSettings
{
	Q_OBJECT

public:
	static const QString Key_View_ZoomToFitDuringAcq;
	static const QString Key_View_ZoomToFitAfterAcq;
	static const QString Key_View_TriggerIsZeroTime;
	static const QString Key_View_ColoredBG;
	static const QString Key_View_StickyScrolling;
	static const QString Key_View_ShowSamplingPoints;
	static const QString Key_View_FillSignalHighAreas;
	static const QString Key_View_FillSignalHighAreaColor;
	static const QString Key_View_ShowAnalogMinorGrid;
	static const QString Key_View_ConversionThresholdDispMode;
	static const QString Key_View_DefaultDivHeight;
	static const QString Key_View_DefaultLogicHeight;
	static const QString Key_View_ShowHoverMarker;
	static const QString Key_View_SnapDistance;
	static const QString Key_Dec_InitialStateConfigurable;
	static const QString Key_Dec_ExportFormat;
	static const QString Key_Log_BufferSize;
	static const QString Key_Log_NotifyOfStacktrace;

	enum ConvThrDispMode {
		ConvThrDispMode_None = 0,
		ConvThrDispMode_Background,
		ConvThrDispMode_Dots
	};

public:
	GlobalSettings();

	void set_defaults_where_needed();

	static void add_change_handler(GlobalSettingsInterface *cb);
	static void remove_change_handler(GlobalSettingsInterface *cb);

	void setValue(const QString& key, const QVariant& value);

	/**
	 * Begins the tracking of changes. All changes will
	 * be recorded until stop_tracking() is called.
	 * The change tracking is global and doesn't support nesting.
	 */
	void start_tracking();

	/**
	 * Ends the tracking of changes without any changes to the settings.
	 */
	void stop_tracking();

	/**
	 * Ends the tracking of changes, undoing the changes since the
	 * change tracking began.
	 */
	void undo_tracked_changes();

	static void store_gvariant(QSettings &settings, GVariant *v);

	static GVariant* restore_gvariant(QSettings &settings);

	static void store_variantbase(QSettings &settings, Glib::VariantBase v);

	static Glib::VariantBase restore_variantbase(QSettings &settings);

private:
	static vector<GlobalSettingsInterface*> callbacks_;

	static bool tracking_;
	static map<QString, QVariant> tracked_changes_;
};

} // namespace pv

#endif // PULSEVIEW_GLOBALSETTINGS_HPP
Commit	Line	Data
bf9f1268 SA	1	/*
	2	* This file is part of the PulseView project.
	3	*
	4	* Copyright (C) 2017 Soeren Apel <soeren@apelpie.net>
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation; either version 2 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program; if not, see <http://www.gnu.org/licenses/>.
	18	*/
	19
	20	#ifndef PULSEVIEW_GLOBALSETTINGS_HPP
	21	#define PULSEVIEW_GLOBALSETTINGS_HPP
	22
bf9f1268 SA	23	#include <map>
bf9f1268 SA	24
d3feec23	25	#include <glib.h>
1325ce42	26	#include <glibmm/variant.h>
d3feec23	27
bf9f1268 SA	28	#include <QSettings>
	29	#include <QString>
	30	#include <QVariant>
	31
6f925ba9	32	using std::map;
d0c0573b	33	using std::vector;
6f925ba9	34
bf9f1268 SA	35	namespace pv {
bf9f1268 SA	36
d0c0573b SA	37	class GlobalSettingsInterface
	38	{
	39	public:
	40	virtual void on_setting_changed(const QString &key, const QVariant &value) = 0;
	41	};
	42
	43
bf9f1268 SA	44	class GlobalSettings : public QSettings
	45	{
	46	Q_OBJECT
	47
	48	public:
e91fb166	49	static const QString Key_View_ZoomToFitDuringAcq;
28ceff25	50	static const QString Key_View_ZoomToFitAfterAcq;
ffc00fdd	51	static const QString Key_View_TriggerIsZeroTime;
641574bc	52	static const QString Key_View_ColoredBG;
87a97d8a	53	static const QString Key_View_StickyScrolling;
051ba3b3	54	static const QString Key_View_ShowSamplingPoints;
4521022b SA	55	static const QString Key_View_FillSignalHighAreas;
4521022b SA	56	static const QString Key_View_FillSignalHighAreaColor;
8ad61f40	57	static const QString Key_View_ShowAnalogMinorGrid;
90ee1ed9	58	static const QString Key_View_ConversionThresholdDispMode;
daa54986	59	static const QString Key_View_DefaultDivHeight;
48051ccb	60	static const QString Key_View_DefaultLogicHeight;
1931b5f9	61	static const QString Key_View_ShowHoverMarker;
fb641801	62	static const QString Key_View_SnapDistance;
1cc1c8de	63	static const QString Key_Dec_InitialStateConfigurable;
1ed996b4	64	static const QString Key_Dec_ExportFormat;
bcb4c327	65	static const QString Key_Log_BufferSize;
c5d6200c	66	static const QString Key_Log_NotifyOfStacktrace;
bf9f1268	67
90ee1ed9 SA	68	enum ConvThrDispMode {
	69	ConvThrDispMode_None = 0,
	70	ConvThrDispMode_Background,
	71	ConvThrDispMode_Dots
	72	};
	73
bf9f1268 SA	74	public:
	75	GlobalSettings();
	76
c031de4b SA	77	void set_defaults_where_needed();
c031de4b SA	78
d0c0573b SA	79	static void add_change_handler(GlobalSettingsInterface *cb);
d0c0573b SA	80	static void remove_change_handler(GlobalSettingsInterface *cb);
bf9f1268 SA	81
	82	void setValue(const QString& key, const QVariant& value);
	83
2cca9ebf SA	84	/**
	85	* Begins the tracking of changes. All changes will
	86	* be recorded until stop_tracking() is called.
	87	* The change tracking is global and doesn't support nesting.
	88	*/
	89	void start_tracking();
	90
	91	/**
	92	* Ends the tracking of changes without any changes to the settings.
	93	*/
	94	void stop_tracking();
	95
	96	/**
	97	* Ends the tracking of changes, undoing the changes since the
	98	* change tracking began.
	99	*/
	100	void undo_tracked_changes();
	101
d3feec23 SA	102	static void store_gvariant(QSettings &settings, GVariant *v);
	103
	104	static GVariant* restore_gvariant(QSettings &settings);
	105
1325ce42 SA	106	static void store_variantbase(QSettings &settings, Glib::VariantBase v);
	107
	108	static Glib::VariantBase restore_variantbase(QSettings &settings);
	109
bf9f1268	110	private:
d0c0573b	111	static vector<GlobalSettingsInterface*> callbacks_;
2cca9ebf SA	112
2cca9ebf SA	113	static bool tracking_;
6f925ba9	114	static map<QString, QVariant> tracked_changes_;
bf9f1268 SA	115	};
	116
	117	} // namespace pv
	118
	119	#endif // PULSEVIEW_GLOBALSETTINGS_HPP