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