pv/globalsettings.hpp

   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_View_ShowHoverMarker;
  60         static const QString Key_View_SnapDistance;
  61         static const QString Key_Dec_InitialStateConfigurable;
  62         static const QString Key_Dec_ExportFormat;
  63         static const QString Key_Log_BufferSize;
  64         static const QString Key_Log_NotifyOfStacktrace;
  65
  66         enum ConvThrDispMode {
  67                 ConvThrDispMode_None = 0,
  68                 ConvThrDispMode_Background,
  69                 ConvThrDispMode_Dots
  70         };
  71
  72 public:
  73         GlobalSettings();
  74
  75         void set_defaults_where_needed();
  76
  77         static void add_change_handler(GlobalSettingsInterface *cb);
  78         static void remove_change_handler(GlobalSettingsInterface *cb);
  79
  80         void setValue(const QString& key, const QVariant& value);
  81
  82         /**
  83          * Begins the tracking of changes. All changes will
  84          * be recorded until stop_tracking() is called.
  85          * The change tracking is global and doesn't support nesting.
  86          */
  87         void start_tracking();
  88
  89         /**
  90          * Ends the tracking of changes without any changes to the settings.
  91          */
  92         void stop_tracking();
  93
  94         /**
  95          * Ends the tracking of changes, undoing the changes since the
  96          * change tracking began.
  97          */
  98         void undo_tracked_changes();
  99
 100         static void store_gvariant(QSettings &settings, GVariant *v);
 101
 102         static GVariant* restore_gvariant(QSettings &settings);
 103
 104         static void store_variantbase(QSettings &settings, Glib::VariantBase v);
 105
 106         static Glib::VariantBase restore_variantbase(QSettings &settings);
 107
 108 private:
 109         static vector<GlobalSettingsInterface*> callbacks_;
 110
 111         static bool tracking_;
 112         static map<QString, QVariant> tracked_changes_;
 113 };
 114
 115 } // namespace pv
 116
 117 #endif // PULSEVIEW_GLOBALSETTINGS_HPP