[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_PV_GLOBALSETTINGS_HPP
#define PULSEVIEW_PV_GLOBALSETTINGS_HPP

#include <map>

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

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

#include "util.hpp"

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_View_CursorShowSamples;
	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);

	static void store_timestamp(QSettings &settings, const char *name, const pv::util::Timestamp &ts);
	static pv::util::Timestamp restore_timestamp(QSettings &settings, const char *name);

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