[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_ShowAnalogMinorGrid;
	static const QString Key_View_ConversionThresholdDispMode;
	static const QString Key_View_DefaultDivHeight;
	static const QString Key_View_DefaultLogicHeight;
	static const QString Key_Dec_InitialStateConfigurable;
	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
	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
	23	#include <map>
	24
	25	#include <glib.h>
	26	#include <glibmm/variant.h>
	27
	28	#include <QSettings>
	29	#include <QString>
	30	#include <QVariant>
	31
	32	using std::map;
	33	using std::vector;
	34
	35	namespace pv {
	36
	37	class GlobalSettingsInterface
	38	{
	39	public:
	40	virtual void on_setting_changed(const QString &key, const QVariant &value) = 0;
	41	};
	42
	43
	44	class GlobalSettings : public QSettings
	45	{
	46	Q_OBJECT
	47
	48	public:
	49	static const QString Key_View_ZoomToFitDuringAcq;
	50	static const QString Key_View_ZoomToFitAfterAcq;
	51	static const QString Key_View_TriggerIsZeroTime;
	52	static const QString Key_View_ColoredBG;
	53	static const QString Key_View_StickyScrolling;
	54	static const QString Key_View_ShowSamplingPoints;
	55	static const QString Key_View_ShowAnalogMinorGrid;
	56	static const QString Key_View_ConversionThresholdDispMode;
	57	static const QString Key_View_DefaultDivHeight;
	58	static const QString Key_View_DefaultLogicHeight;
	59	static const QString Key_Dec_InitialStateConfigurable;
	60	static const QString Key_Log_BufferSize;
	61	static const QString Key_Log_NotifyOfStacktrace;
	62
	63	enum ConvThrDispMode {
	64	ConvThrDispMode_None = 0,
	65	ConvThrDispMode_Background,
	66	ConvThrDispMode_Dots
	67	};
	68
	69	public:
	70	GlobalSettings();
	71
	72	void set_defaults_where_needed();
	73
	74	static void add_change_handler(GlobalSettingsInterface *cb);
	75	static void remove_change_handler(GlobalSettingsInterface *cb);
	76
	77	void setValue(const QString& key, const QVariant& value);
	78
	79	/**
	80	* Begins the tracking of changes. All changes will
	81	* be recorded until stop_tracking() is called.
	82	* The change tracking is global and doesn't support nesting.
	83	*/
	84	void start_tracking();
	85
	86	/**
	87	* Ends the tracking of changes without any changes to the settings.
	88	*/
	89	void stop_tracking();
	90
	91	/**
	92	* Ends the tracking of changes, undoing the changes since the
	93	* change tracking began.
	94	*/
	95	void undo_tracked_changes();
	96
	97	static void store_gvariant(QSettings &settings, GVariant *v);
	98
	99	static GVariant* restore_gvariant(QSettings &settings);
	100
	101	static void store_variantbase(QSettings &settings, Glib::VariantBase v);
	102
	103	static Glib::VariantBase restore_variantbase(QSettings &settings);
	104
	105	private:
	106	static vector<GlobalSettingsInterface*> callbacks_;
	107
	108	static bool tracking_;
	109	static map<QString, QVariant> tracked_changes_;
	110	};
	111
	112	} // namespace pv
	113
	114	#endif // PULSEVIEW_GLOBALSETTINGS_HPP