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