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_PV_GLOBALSETTINGS_HPP
  21 #define PULSEVIEW_PV_GLOBALSETTINGS_HPP
  22
  23 #include <map>
  24
  25 #include <glib.h>
  26 #include <glibmm/variant.h>
  27
  28 #include <QPalette>
  29 #include <QSettings>
  30 #include <QString>
  31 #include <QVariant>
  32
  33 #include "util.hpp"
  34
  35 using std::map;
  36 using std::pair;
  37 using std::vector;
  38
  39 namespace pv {
  40
  41 extern const vector< pair<QString, QString> > Themes;
  42
  43
  44 class GlobalSettingsInterface
  45 {
  46 public:
  47         virtual void on_setting_changed(const QString &key, const QVariant &value) = 0;
  48 };
  49
  50
  51 class GlobalSettings : public QSettings
  52 {
  53         Q_OBJECT
  54
  55 public:
  56         static const QString Key_General_Language;
  57         static const QString Key_General_Theme;
  58         static const QString Key_General_Style;
  59         static const QString Key_General_SaveWithSetup;
  60         static const QString Key_General_StartAllSessions;
  61         static const QString Key_View_ZoomToFitDuringAcq;
  62         static const QString Key_View_ZoomToFitAfterAcq;
  63         static const QString Key_View_TriggerIsZeroTime;
  64         static const QString Key_View_ColoredBG;
  65         static const QString Key_View_StickyScrolling;
  66         static const QString Key_View_AllowVerticalDragging;
  67         static const QString Key_View_ShowSamplingPoints;
  68         static const QString Key_View_FillSignalHighAreas;
  69         static const QString Key_View_FillSignalHighAreaColor;
  70         static const QString Key_View_ShowAnalogMinorGrid;
  71         static const QString Key_View_ConversionThresholdDispMode;
  72         static const QString Key_View_DefaultDivHeight;
  73         static const QString Key_View_DefaultLogicHeight;
  74         static const QString Key_View_ShowHoverMarker;
  75         static const QString Key_View_KeepRulerItemSelected;
  76         static const QString Key_View_SnapDistance;
  77         static const QString Key_View_CursorFillColor;
  78         static const QString Key_View_CursorShowInterval;
  79         static const QString Key_View_CursorShowFrequency;
  80         static const QString Key_View_CursorShowSamples;
  81         static const QString Key_Dec_InitialStateConfigurable;
  82         static const QString Key_Dec_ExportFormat;
  83         static const QString Key_Dec_AlwaysShowAllRows;
  84         static const QString Key_Log_BufferSize;
  85         static const QString Key_Log_NotifyOfStacktrace;
  86
  87         enum ConvThrDispMode {
  88                 ConvThrDispMode_None = 0,
  89                 ConvThrDispMode_Background,
  90                 ConvThrDispMode_Dots
  91         };
  92
  93 public:
  94         GlobalSettings();
  95
  96         void save_internal_defaults();
  97         void set_defaults_where_needed();
  98         void set_bright_theme_default_colors();
  99         void set_dark_theme_default_colors();
 100
 101         static bool current_theme_is_dark();
 102         void apply_theme();
 103
 104         void apply_language();
 105
 106         static void add_change_handler(GlobalSettingsInterface *cb);
 107         static void remove_change_handler(GlobalSettingsInterface *cb);
 108
 109         void setValue(const QString& key, const QVariant& value);
 110
 111         /**
 112          * Begins the tracking of changes. All changes will
 113          * be recorded until stop_tracking() is called.
 114          * The change tracking is global and doesn't support nesting.
 115          */
 116         void start_tracking();
 117
 118         /**
 119          * Ends the tracking of changes without any changes to the settings.
 120          */
 121         void stop_tracking();
 122
 123         /**
 124          * Ends the tracking of changes, undoing the changes since the
 125          * change tracking began.
 126          */
 127         void undo_tracked_changes();
 128
 129         static void store_gvariant(QSettings &settings, GVariant *v);
 130         static GVariant* restore_gvariant(QSettings &settings);
 131
 132         static void store_variantbase(QSettings &settings, Glib::VariantBase v);
 133         static Glib::VariantBase restore_variantbase(QSettings &settings);
 134
 135         static void store_timestamp(QSettings &settings, const char *name, const pv::util::Timestamp &ts);
 136         static pv::util::Timestamp restore_timestamp(QSettings &settings, const char *name);
 137
 138 private:
 139         static vector<GlobalSettingsInterface*> callbacks_;
 140
 141         static bool tracking_;
 142         static map<QString, QVariant> tracked_changes_;
 143
 144         static QString default_style_;
 145         static QPalette default_palette_;
 146
 147         static bool is_dark_theme_;
 148 };
 149
 150 } // namespace pv
 151
 152 #endif // PULSEVIEW_PV_GLOBALSETTINGS_HPP