pv/globalsettings.cpp

   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 #include "globalsettings.hpp"
  21
  22 #include <QApplication>
  23 #include <QFontMetrics>
  24 #include <QString>
  25
  26 using std::map;
  27 using std::vector;
  28
  29 namespace pv {
  30
  31 const QString GlobalSettings::Key_View_ZoomToFitDuringAcq = "View_ZoomToFitDuringAcq";
  32 const QString GlobalSettings::Key_View_ZoomToFitAfterAcq = "View_ZoomToFitAfterAcq";
  33 const QString GlobalSettings::Key_View_TriggerIsZeroTime = "View_TriggerIsZeroTime";
  34 const QString GlobalSettings::Key_View_ColouredBG = "View_ColouredBG";
  35 const QString GlobalSettings::Key_View_StickyScrolling = "View_StickyScrolling";
  36 const QString GlobalSettings::Key_View_ShowSamplingPoints = "View_ShowSamplingPoints";
  37 const QString GlobalSettings::Key_View_ShowAnalogMinorGrid = "View_ShowAnalogMinorGrid";
  38 const QString GlobalSettings::Key_View_ConversionThresholdDispMode = "View_ConversionThresholdDispMode";
  39 const QString GlobalSettings::Key_View_DefaultDivHeight = "View_DefaultDivHeight";
  40 const QString GlobalSettings::Key_View_DefaultLogicHeight = "View_DefaultLogicHeight";
  41 const QString GlobalSettings::Key_Dec_InitialStateConfigurable = "Dec_InitialStateConfigurable";
  42 const QString GlobalSettings::Key_Log_BufferSize = "Log_BufferSize";
  43 const QString GlobalSettings::Key_Log_NotifyOfStacktrace = "Log_NotifyOfStacktrace";
  44
  45 vector<GlobalSettingsInterface*> GlobalSettings::callbacks_;
  46 bool GlobalSettings::tracking_ = false;
  47 map<QString, QVariant> GlobalSettings::tracked_changes_;
  48
  49 GlobalSettings::GlobalSettings() :
  50         QSettings()
  51 {
  52         beginGroup("Settings");
  53 }
  54
  55 void GlobalSettings::set_defaults_where_needed()
  56 {
  57         // Enable zoom-to-fit after acquisition by default
  58         if (!contains(Key_View_ZoomToFitAfterAcq))
  59                 setValue(Key_View_ZoomToFitAfterAcq, true);
  60
  61         // Enable coloured trace backgrounds by default
  62         if (!contains(Key_View_ColouredBG))
  63                 setValue(Key_View_ColouredBG, true);
  64
  65         // Enable showing sampling points by default
  66         if (!contains(Key_View_ShowSamplingPoints))
  67                 setValue(Key_View_ShowSamplingPoints, true);
  68
  69         if (!contains(Key_View_DefaultDivHeight))
  70                 setValue(Key_View_DefaultDivHeight,
  71                 3 * QFontMetrics(QApplication::font()).height());
  72
  73         if (!contains(Key_View_DefaultLogicHeight))
  74                 setValue(Key_View_DefaultLogicHeight,
  75                 2 * QFontMetrics(QApplication::font()).height());
  76
  77         // Default to 500 lines of backlog
  78         if (!contains(Key_Log_BufferSize))
  79                 setValue(Key_Log_BufferSize, 500);
  80
  81         // Notify user of existing stack trace by default
  82         if (!contains(Key_Log_NotifyOfStacktrace))
  83                 setValue(Key_Log_NotifyOfStacktrace, true);
  84 }
  85
  86 void GlobalSettings::add_change_handler(GlobalSettingsInterface *cb)
  87 {
  88         callbacks_.push_back(cb);
  89 }
  90
  91 void GlobalSettings::remove_change_handler(GlobalSettingsInterface *cb)
  92 {
  93         for (auto cb_it = callbacks_.begin(); cb_it != callbacks_.end(); cb_it++)
  94                 if (*cb_it == cb) {
  95                         callbacks_.erase(cb_it);
  96                         break;
  97                 }
  98 }
  99
 100 void GlobalSettings::setValue(const QString &key, const QVariant &value)
 101 {
 102         // Save previous value if we're tracking changes,
 103         // not altering an already-existing saved setting
 104         if (tracking_)
 105                 tracked_changes_.emplace(key, QSettings::value(key));
 106
 107         QSettings::setValue(key, value);
 108
 109         // Call all registered callbacks
 110         for (GlobalSettingsInterface *cb : callbacks_)
 111                 cb->on_setting_changed(key, value);
 112 }
 113
 114 void GlobalSettings::start_tracking()
 115 {
 116         tracking_ = true;
 117         tracked_changes_.clear();
 118 }
 119
 120 void GlobalSettings::stop_tracking()
 121 {
 122         tracking_ = false;
 123         tracked_changes_.clear();
 124 }
 125
 126 void GlobalSettings::undo_tracked_changes()
 127 {
 128         tracking_ = false;
 129
 130         for (auto entry : tracked_changes_)
 131                 setValue(entry.first, entry.second);
 132
 133         tracked_changes_.clear();
 134 }
 135
 136 void GlobalSettings::store_gvariant(QSettings &settings, GVariant *v)
 137 {
 138         const GVariantType *var_type = g_variant_get_type(v);
 139         char *var_type_str = g_variant_type_dup_string(var_type);
 140
 141         QByteArray var_data = QByteArray((const char*)g_variant_get_data(v),
 142                 g_variant_get_size(v));
 143
 144         settings.setValue("value", var_data);
 145         settings.setValue("type", var_type_str);
 146
 147         g_free(var_type_str);
 148 }
 149
 150 GVariant* GlobalSettings::restore_gvariant(QSettings &settings)
 151 {
 152         QString raw_type = settings.value("type").toString();
 153         GVariantType *var_type = g_variant_type_new(raw_type.toUtf8());
 154
 155         QByteArray data = settings.value("value").toByteArray();
 156
 157         gpointer var_data = g_memdup((gconstpointer)data.constData(),
 158                 (guint)data.size());
 159
 160         GVariant *value = g_variant_new_from_data(var_type, var_data,
 161                 data.size(), false, g_free, var_data);
 162
 163         g_variant_type_free(var_type);
 164
 165         return value;
 166 }
 167
 168
 169 } // namespace pv