[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 <QPalette>
#include <QSettings>
#include <QString>
#include <QVariant>

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

namespace pv {

extern const vector< pair<QString, QString> > Themes;


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_General_Language;
	static const QString Key_General_Theme;
	static const QString Key_General_Style;
	static const QString Key_General_SaveWithSetup;
	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_View_CursorFillColor;
	static const QString Key_View_CursorShowInterval;
	static const QString Key_View_CursorShowFrequency;
	static const QString Key_Dec_InitialStateConfigurable;
	static const QString Key_Dec_ExportFormat;
	static const QString Key_Dec_AlwaysShowAllRows;
	static const QString Key_Log_BufferSize;
	static const QString Key_Log_NotifyOfStacktrace;

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

public:
	GlobalSettings();

	void save_internal_defaults();
	void set_defaults_where_needed();
	void set_bright_theme_default_colors();
	void set_dark_theme_default_colors();

	static bool current_theme_is_dark();
	void apply_theme();

	void apply_language();

	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_;

	static QString default_style_;
	static QPalette default_palette_;

	static bool is_dark_theme_;
};

} // 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
37b0bd35	28	#include <QPalette>
bf9f1268 SA	29	#include <QSettings>
	30	#include <QString>
	31	#include <QVariant>
	32
6f925ba9	33	using std::map;
37b0bd35	34	using std::pair;
d0c0573b	35	using std::vector;
6f925ba9	36
bf9f1268 SA	37	namespace pv {
bf9f1268 SA	38
37b0bd35 SA	39	extern const vector< pair<QString, QString> > Themes;
	40
	41
d0c0573b SA	42	class GlobalSettingsInterface
	43	{
	44	public:
	45	virtual void on_setting_changed(const QString &key, const QVariant &value) = 0;
	46	};
	47
	48
bf9f1268 SA	49	class GlobalSettings : public QSettings
	50	{
	51	Q_OBJECT
	52
	53	public:
0466001b	54	static const QString Key_General_Language;
37b0bd35	55	static const QString Key_General_Theme;
374c697f	56	static const QString Key_General_Style;
8962d7b3	57	static const QString Key_General_SaveWithSetup;
e91fb166	58	static const QString Key_View_ZoomToFitDuringAcq;
28ceff25	59	static const QString Key_View_ZoomToFitAfterAcq;
ffc00fdd	60	static const QString Key_View_TriggerIsZeroTime;
641574bc	61	static const QString Key_View_ColoredBG;
87a97d8a	62	static const QString Key_View_StickyScrolling;
051ba3b3	63	static const QString Key_View_ShowSamplingPoints;
4521022b SA	64	static const QString Key_View_FillSignalHighAreas;
4521022b SA	65	static const QString Key_View_FillSignalHighAreaColor;
8ad61f40	66	static const QString Key_View_ShowAnalogMinorGrid;
90ee1ed9	67	static const QString Key_View_ConversionThresholdDispMode;
daa54986	68	static const QString Key_View_DefaultDivHeight;
48051ccb	69	static const QString Key_View_DefaultLogicHeight;
1931b5f9	70	static const QString Key_View_ShowHoverMarker;
fb641801	71	static const QString Key_View_SnapDistance;
c04f5a29	72	static const QString Key_View_CursorFillColor;
79a37ed8 MM	73	static const QString Key_View_CursorShowInterval;
79a37ed8 MM	74	static const QString Key_View_CursorShowFrequency;
1cc1c8de	75	static const QString Key_Dec_InitialStateConfigurable;
1ed996b4	76	static const QString Key_Dec_ExportFormat;
ab185f78	77	static const QString Key_Dec_AlwaysShowAllRows;
bcb4c327	78	static const QString Key_Log_BufferSize;
c5d6200c	79	static const QString Key_Log_NotifyOfStacktrace;
bf9f1268	80
90ee1ed9 SA	81	enum ConvThrDispMode {
	82	ConvThrDispMode_None = 0,
	83	ConvThrDispMode_Background,
	84	ConvThrDispMode_Dots
	85	};
	86
bf9f1268 SA	87	public:
	88	GlobalSettings();
	89
374c697f	90	void save_internal_defaults();
a42d2514 SA	91	void set_defaults_where_needed();
	92	void set_bright_theme_default_colors();
	93	void set_dark_theme_default_colors();
c031de4b	94
c6b4e925	95	static bool current_theme_is_dark();
37b0bd35 SA	96	void apply_theme();
37b0bd35 SA	97
0466001b SA	98	void apply_language();
0466001b SA	99
d0c0573b SA	100	static void add_change_handler(GlobalSettingsInterface *cb);
d0c0573b SA	101	static void remove_change_handler(GlobalSettingsInterface *cb);
bf9f1268 SA	102
	103	void setValue(const QString& key, const QVariant& value);
	104
2cca9ebf SA	105	/**
	106	* Begins the tracking of changes. All changes will
	107	* be recorded until stop_tracking() is called.
	108	* The change tracking is global and doesn't support nesting.
	109	*/
	110	void start_tracking();
	111
	112	/**
	113	* Ends the tracking of changes without any changes to the settings.
	114	*/
	115	void stop_tracking();
	116
	117	/**
	118	* Ends the tracking of changes, undoing the changes since the
	119	* change tracking began.
	120	*/
	121	void undo_tracked_changes();
	122
d3feec23 SA	123	static void store_gvariant(QSettings &settings, GVariant *v);
	124
	125	static GVariant* restore_gvariant(QSettings &settings);
	126
1325ce42 SA	127	static void store_variantbase(QSettings &settings, Glib::VariantBase v);
	128
	129	static Glib::VariantBase restore_variantbase(QSettings &settings);
	130
bf9f1268	131	private:
d0c0573b	132	static vector<GlobalSettingsInterface*> callbacks_;
2cca9ebf SA	133
2cca9ebf SA	134	static bool tracking_;
6f925ba9	135	static map<QString, QVariant> tracked_changes_;
37b0bd35	136
374c697f	137	static QString default_style_;
37b0bd35	138	static QPalette default_palette_;
a42d2514	139
c6b4e925	140	static bool is_dark_theme_;
bf9f1268 SA	141	};
	142
	143	} // namespace pv
	144
	145	#endif // PULSEVIEW_GLOBALSETTINGS_HPP