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 <QColor>
  24 #include <QDebug>
  25 #include <QFile>
  26 #include <QFontMetrics>
  27 #include <QPixmapCache>
  28 #include <QString>
  29 #include <QStyle>
  30 #include <QtGlobal>
  31
  32 using std::map;
  33 using std::pair;
  34 using std::string;
  35 using std::vector;
  36
  37 namespace pv {
  38
  39 const vector< pair<QString, QString> > Themes {
  40         {"None" , ""},
  41         {"QDarkStyleSheet", ":/themes/qdarkstyle/style.qss"},
  42         {"DarkStyle", ":/themes/darkstyle/darkstyle.qss"}
  43 };
  44
  45 const QString GlobalSettings::Key_General_Theme = "General_Theme";
  46 const QString GlobalSettings::Key_General_Style = "General_Style";
  47 const QString GlobalSettings::Key_View_ZoomToFitDuringAcq = "View_ZoomToFitDuringAcq";
  48 const QString GlobalSettings::Key_View_ZoomToFitAfterAcq = "View_ZoomToFitAfterAcq";
  49 const QString GlobalSettings::Key_View_TriggerIsZeroTime = "View_TriggerIsZeroTime";
  50 const QString GlobalSettings::Key_View_ColoredBG = "View_ColoredBG";
  51 const QString GlobalSettings::Key_View_StickyScrolling = "View_StickyScrolling";
  52 const QString GlobalSettings::Key_View_ShowSamplingPoints = "View_ShowSamplingPoints";
  53 const QString GlobalSettings::Key_View_FillSignalHighAreas = "View_FillSignalHighAreas";
  54 const QString GlobalSettings::Key_View_FillSignalHighAreaColor = "View_FillSignalHighAreaColor";
  55 const QString GlobalSettings::Key_View_ShowAnalogMinorGrid = "View_ShowAnalogMinorGrid";
  56 const QString GlobalSettings::Key_View_ConversionThresholdDispMode = "View_ConversionThresholdDispMode";
  57 const QString GlobalSettings::Key_View_DefaultDivHeight = "View_DefaultDivHeight";
  58 const QString GlobalSettings::Key_View_DefaultLogicHeight = "View_DefaultLogicHeight";
  59 const QString GlobalSettings::Key_View_ShowHoverMarker = "View_ShowHoverMarker";
  60 const QString GlobalSettings::Key_View_SnapDistance = "View_SnapDistance";
  61 const QString GlobalSettings::Key_Dec_InitialStateConfigurable = "Dec_InitialStateConfigurable";
  62 const QString GlobalSettings::Key_Dec_ExportFormat = "Dec_ExportFormat";
  63 const QString GlobalSettings::Key_Log_BufferSize = "Log_BufferSize";
  64 const QString GlobalSettings::Key_Log_NotifyOfStacktrace = "Log_NotifyOfStacktrace";
  65
  66 vector<GlobalSettingsInterface*> GlobalSettings::callbacks_;
  67 bool GlobalSettings::tracking_ = false;
  68 map<QString, QVariant> GlobalSettings::tracked_changes_;
  69 QString GlobalSettings::default_style_;
  70 QPalette GlobalSettings::default_palette_;
  71
  72 GlobalSettings::GlobalSettings() :
  73         QSettings(),
  74         is_dark_theme_(false)
  75 {
  76         beginGroup("Settings");
  77 }
  78
  79 void GlobalSettings::save_internal_defaults()
  80 {
  81         default_style_ = qApp->style()->objectName();
  82         if (default_style_.isEmpty())
  83                 default_style_ = "fusion";
  84
  85         default_palette_ = QApplication::palette();
  86 }
  87
  88 void GlobalSettings::set_defaults_where_needed()
  89 {
  90         // Use no theme by default
  91         if (!contains(Key_General_Theme))
  92                 setValue(Key_General_Theme, 0);
  93         if (!contains(Key_General_Style))
  94                 setValue(Key_General_Style, "");
  95
  96         // Enable zoom-to-fit after acquisition by default
  97         if (!contains(Key_View_ZoomToFitAfterAcq))
  98                 setValue(Key_View_ZoomToFitAfterAcq, true);
  99
 100         // Enable colored trace backgrounds by default
 101         if (!contains(Key_View_ColoredBG))
 102                 setValue(Key_View_ColoredBG, true);
 103
 104         // Enable showing sampling points by default
 105         if (!contains(Key_View_ShowSamplingPoints))
 106                 setValue(Key_View_ShowSamplingPoints, true);
 107
 108         // Enable filling logic signal high areas by default
 109         if (!contains(Key_View_FillSignalHighAreas))
 110                 setValue(Key_View_FillSignalHighAreas, true);
 111
 112         if (!contains(Key_View_DefaultDivHeight))
 113                 setValue(Key_View_DefaultDivHeight,
 114                 3 * QFontMetrics(QApplication::font()).height());
 115
 116         if (!contains(Key_View_DefaultLogicHeight))
 117                 setValue(Key_View_DefaultLogicHeight,
 118                 2 * QFontMetrics(QApplication::font()).height());
 119
 120         if (!contains(Key_View_ShowHoverMarker))
 121                 setValue(Key_View_ShowHoverMarker, true);
 122
 123         if (!contains(Key_View_SnapDistance))
 124                 setValue(Key_View_SnapDistance, 15);
 125
 126         if (!contains(Key_Dec_ExportFormat))
 127                 setValue(Key_Dec_ExportFormat, "%s %d: %c: %1");
 128
 129         // Default to 500 lines of backlog
 130         if (!contains(Key_Log_BufferSize))
 131                 setValue(Key_Log_BufferSize, 500);
 132
 133         // Notify user of existing stack trace by default
 134         if (!contains(Key_Log_NotifyOfStacktrace))
 135                 setValue(Key_Log_NotifyOfStacktrace, true);
 136
 137         // Default theme is bright, so use its color scheme
 138         set_bright_theme_default_colors();
 139 }
 140
 141 void GlobalSettings::set_bright_theme_default_colors()
 142 {
 143         setValue(Key_View_FillSignalHighAreaColor,
 144                 QColor(0, 0, 0, 5 * 256 / 100).rgba());
 145 }
 146
 147 void GlobalSettings::set_dark_theme_default_colors()
 148 {
 149         setValue(Key_View_FillSignalHighAreaColor,
 150                 QColor(188, 188, 188, 9 * 256 / 100).rgba());
 151 }
 152
 153 bool GlobalSettings::current_theme_is_dark()
 154 {
 155         return is_dark_theme_;
 156 }
 157
 158 void GlobalSettings::apply_theme()
 159 {
 160         QString theme_name    = Themes.at(value(Key_General_Theme).toInt()).first;
 161         QString resource_name = Themes.at(value(Key_General_Theme).toInt()).second;
 162
 163         if (!resource_name.isEmpty()) {
 164                 QFile file(resource_name);
 165                 file.open(QFile::ReadOnly | QFile::Text);
 166                 qApp->setStyleSheet(file.readAll());
 167         } else
 168                 qApp->setStyleSheet("");
 169
 170         qApp->setPalette(default_palette_);
 171
 172         const QString style = value(Key_General_Style).toString();
 173         if (style.isEmpty())
 174                 qApp->setStyle(default_style_);
 175         else
 176                 qApp->setStyle(style);
 177
 178         is_dark_theme_ = false;
 179
 180         if (theme_name.compare("QDarkStyleSheet") == 0) {
 181                 QPalette dark_palette;
 182                 dark_palette.setColor(QPalette::Window, QColor(53, 53, 53));
 183                 dark_palette.setColor(QPalette::WindowText, Qt::white);
 184                 dark_palette.setColor(QPalette::Base, QColor(42, 42, 42));
 185                 dark_palette.setColor(QPalette::Dark, QColor(35, 35, 35));
 186                 dark_palette.setColor(QPalette::Highlight, QColor(42, 130, 218));
 187                 qApp->setPalette(dark_palette);
 188                 is_dark_theme_ = true;
 189         } else if (theme_name.compare("DarkStyle") == 0) {
 190                 QPalette dark_palette;
 191                 dark_palette.setColor(QPalette::Window, QColor(53, 53, 53));
 192                 dark_palette.setColor(QPalette::WindowText, Qt::white);
 193                 dark_palette.setColor(QPalette::Disabled, QPalette::WindowText, QColor(127, 127, 127));
 194                 dark_palette.setColor(QPalette::Base, QColor(42, 42, 42));
 195                 dark_palette.setColor(QPalette::AlternateBase, QColor(66, 66, 66));
 196                 dark_palette.setColor(QPalette::ToolTipBase, Qt::white);
 197                 dark_palette.setColor(QPalette::ToolTipText, QColor(53, 53, 53));
 198                 dark_palette.setColor(QPalette::Text, Qt::white);
 199                 dark_palette.setColor(QPalette::Disabled, QPalette::Text, QColor(127, 127, 127));
 200                 dark_palette.setColor(QPalette::Dark, QColor(35, 35, 35));
 201                 dark_palette.setColor(QPalette::Shadow, QColor(20, 20, 20));
 202                 dark_palette.setColor(QPalette::Button, QColor(53, 53, 53));
 203                 dark_palette.setColor(QPalette::ButtonText, Qt::white);
 204                 dark_palette.setColor(QPalette::Disabled, QPalette::ButtonText, QColor(127, 127, 127));
 205                 dark_palette.setColor(QPalette::BrightText, Qt::red);
 206                 dark_palette.setColor(QPalette::Link, QColor(42, 130, 218));
 207                 dark_palette.setColor(QPalette::Highlight, QColor(42, 130, 218));
 208                 dark_palette.setColor(QPalette::Disabled, QPalette::Highlight, QColor(80, 80, 80));
 209                 dark_palette.setColor(QPalette::HighlightedText, Qt::white);
 210                 dark_palette.setColor(QPalette::Disabled, QPalette::HighlightedText, QColor(127, 127, 127));
 211                 qApp->setPalette(dark_palette);
 212                 is_dark_theme_ = true;
 213         }
 214
 215         QPixmapCache::clear();
 216 }
 217
 218 void GlobalSettings::add_change_handler(GlobalSettingsInterface *cb)
 219 {
 220         callbacks_.push_back(cb);
 221 }
 222
 223 void GlobalSettings::remove_change_handler(GlobalSettingsInterface *cb)
 224 {
 225         for (auto cb_it = callbacks_.begin(); cb_it != callbacks_.end(); cb_it++)
 226                 if (*cb_it == cb) {
 227                         callbacks_.erase(cb_it);
 228                         break;
 229                 }
 230 }
 231
 232 void GlobalSettings::setValue(const QString &key, const QVariant &value)
 233 {
 234         // Save previous value if we're tracking changes,
 235         // not altering an already-existing saved setting
 236         if (tracking_)
 237                 tracked_changes_.emplace(key, QSettings::value(key));
 238
 239         QSettings::setValue(key, value);
 240
 241         // TODO Emulate noquote()
 242         qDebug() << "Setting" << key << "changed to" << value;
 243
 244         // Call all registered callbacks
 245         for (GlobalSettingsInterface *cb : callbacks_)
 246                 cb->on_setting_changed(key, value);
 247 }
 248
 249 void GlobalSettings::start_tracking()
 250 {
 251         tracking_ = true;
 252         tracked_changes_.clear();
 253 }
 254
 255 void GlobalSettings::stop_tracking()
 256 {
 257         tracking_ = false;
 258         tracked_changes_.clear();
 259 }
 260
 261 void GlobalSettings::undo_tracked_changes()
 262 {
 263         tracking_ = false;
 264
 265         for (auto& entry : tracked_changes_)
 266                 setValue(entry.first, entry.second);
 267
 268         tracked_changes_.clear();
 269 }
 270
 271 void GlobalSettings::store_gvariant(QSettings &settings, GVariant *v)
 272 {
 273         const GVariantType *var_type = g_variant_get_type(v);
 274         char *var_type_str = g_variant_type_dup_string(var_type);
 275
 276         QByteArray var_data = QByteArray((const char*)g_variant_get_data(v),
 277                 g_variant_get_size(v));
 278
 279         settings.setValue("value", var_data);
 280         settings.setValue("type", var_type_str);
 281
 282         g_free(var_type_str);
 283 }
 284
 285 GVariant* GlobalSettings::restore_gvariant(QSettings &settings)
 286 {
 287         QString raw_type = settings.value("type").toString();
 288         GVariantType *var_type = g_variant_type_new(raw_type.toUtf8());
 289
 290         QByteArray data = settings.value("value").toByteArray();
 291
 292         gpointer var_data = g_memdup((gconstpointer)data.constData(),
 293                 (guint)data.size());
 294
 295         GVariant *value = g_variant_new_from_data(var_type, var_data,
 296                 data.size(), false, g_free, var_data);
 297
 298         g_variant_type_free(var_type);
 299
 300         return value;
 301 }
 302
 303 void GlobalSettings::store_variantbase(QSettings &settings, Glib::VariantBase v)
 304 {
 305         const QByteArray var_data = QByteArray((const char*)v.get_data(), v.get_size());
 306
 307         settings.setValue("value", var_data);
 308         settings.setValue("type", QString::fromStdString(v.get_type_string()));
 309 }
 310
 311 Glib::VariantBase GlobalSettings::restore_variantbase(QSettings &settings)
 312 {
 313         QString raw_type = settings.value("type").toString();
 314         GVariantType *var_type = g_variant_type_new(raw_type.toUtf8());
 315
 316         QByteArray data = settings.value("value").toByteArray();
 317
 318         gpointer var_data = g_memdup((gconstpointer)data.constData(),
 319                 (guint)data.size());
 320
 321         GVariant *value = g_variant_new_from_data(var_type, var_data,
 322                 data.size(), false, g_free, var_data);
 323
 324         Glib::VariantBase ret_val = Glib::VariantBase(value, true);
 325
 326         g_variant_type_free(var_type);
 327         g_variant_unref(value);
 328
 329         return ret_val;
 330 }
 331
 332 } // namespace pv