[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_Theme;
	static const QString Key_General_Style;
	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_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 save_internal_defaults();
	void set_defaults_where_needed();
	void set_bright_theme_default_colors();
	void set_dark_theme_default_colors();

	bool current_theme_is_dark();
	void apply_theme();

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

	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
3782d860 UH	25	#include <glib.h>
	26	#include <glibmm/variant.h>
	27
	28	#include <QPalette>
bf9f1268 SA	29	#include <QSettings>
	30	#include <QString>
	31	#include <QVariant>
	32
6f925ba9	33	using std::map;
3782d860 UH	34	using std::pair;
3782d860 UH	35	using std::vector;
6f925ba9	36
bf9f1268 SA	37	namespace pv {
bf9f1268 SA	38
3782d860 UH	39	extern const vector< pair<QString, QString> > Themes;
	40
	41
	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:
3782d860 UH	54	static const QString Key_General_Theme;
	55	static const QString Key_General_Style;
	56	static const QString Key_View_ZoomToFitDuringAcq;
	57	static const QString Key_View_ZoomToFitAfterAcq;
	58	static const QString Key_View_TriggerIsZeroTime;
	59	static const QString Key_View_ColoredBG;
87a97d8a	60	static const QString Key_View_StickyScrolling;
051ba3b3	61	static const QString Key_View_ShowSamplingPoints;
3782d860 UH	62	static const QString Key_View_FillSignalHighAreas;
3782d860 UH	63	static const QString Key_View_FillSignalHighAreaColor;
8ad61f40	64	static const QString Key_View_ShowAnalogMinorGrid;
3782d860 UH	65	static const QString Key_View_ConversionThresholdDispMode;
	66	static const QString Key_View_DefaultDivHeight;
	67	static const QString Key_View_DefaultLogicHeight;
	68	static const QString Key_View_ShowHoverMarker;
	69	static const QString Key_View_SnapDistance;
	70	static const QString Key_View_CursorFillColor;
1cc1c8de	71	static const QString Key_Dec_InitialStateConfigurable;
3782d860 UH	72	static const QString Key_Dec_ExportFormat;
	73	static const QString Key_Log_BufferSize;
	74	static const QString Key_Log_NotifyOfStacktrace;
	75
	76	enum ConvThrDispMode {
	77	ConvThrDispMode_None = 0,
	78	ConvThrDispMode_Background,
	79	ConvThrDispMode_Dots
	80	};
bf9f1268 SA	81
	82	public:
	83	GlobalSettings();
	84
3782d860	85	void save_internal_defaults();
c031de4b	86	void set_defaults_where_needed();
3782d860 UH	87	void set_bright_theme_default_colors();
	88	void set_dark_theme_default_colors();
	89
	90	bool current_theme_is_dark();
	91	void apply_theme();
c031de4b	92
3782d860 UH	93	static void add_change_handler(GlobalSettingsInterface *cb);
3782d860 UH	94	static void remove_change_handler(GlobalSettingsInterface *cb);
bf9f1268 SA	95
	96	void setValue(const QString& key, const QVariant& value);
	97
2cca9ebf SA	98	/**
	99	* Begins the tracking of changes. All changes will
	100	* be recorded until stop_tracking() is called.
	101	* The change tracking is global and doesn't support nesting.
	102	*/
	103	void start_tracking();
	104
	105	/**
	106	* Ends the tracking of changes without any changes to the settings.
	107	*/
	108	void stop_tracking();
	109
	110	/**
	111	* Ends the tracking of changes, undoing the changes since the
	112	* change tracking began.
	113	*/
	114	void undo_tracked_changes();
	115
3782d860 UH	116	static void store_gvariant(QSettings &settings, GVariant *v);
	117
	118	static GVariant* restore_gvariant(QSettings &settings);
	119
	120	static void store_variantbase(QSettings &settings, Glib::VariantBase v);
	121
	122	static Glib::VariantBase restore_variantbase(QSettings &settings);
	123
bf9f1268	124	private:
3782d860	125	static vector<GlobalSettingsInterface*> callbacks_;
2cca9ebf SA	126
2cca9ebf SA	127	static bool tracking_;
6f925ba9	128	static map<QString, QVariant> tracked_changes_;
3782d860 UH	129
	130	static QString default_style_;
	131	static QPalette default_palette_;
	132
	133	bool is_dark_theme_;
bf9f1268 SA	134	};
	135
	136	} // namespace pv
	137
	138	#endif // PULSEVIEW_GLOBALSETTINGS_HPP