pv/dialogs/settings.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 "config.h"
  21
  22 #include <glib.h>
  23 #include <boost/version.hpp>
  24
  25 #include <QApplication>
  26 #include <QDialogButtonBox>
  27 #include <QFormLayout>
  28 #include <QGroupBox>
  29 #include <QHBoxLayout>
  30 #include <QLabel>
  31 #include <QString>
  32 #include <QTextBrowser>
  33 #include <QTextDocument>
  34 #include <QVBoxLayout>
  35
  36 #include "settings.hpp"
  37
  38 #include "pv/devicemanager.hpp"
  39 #include "pv/globalsettings.hpp"
  40
  41 #include <libsigrokcxx/libsigrokcxx.hpp>
  42
  43 #ifdef ENABLE_DECODE
  44 #include <libsigrokdecode/libsigrokdecode.h>
  45 #endif
  46
  47 using std::shared_ptr;
  48
  49 namespace pv {
  50 namespace dialogs {
  51
  52 Settings::Settings(DeviceManager &device_manager, QWidget *parent) :
  53         QDialog(parent, nullptr),
  54         device_manager_(device_manager)
  55 {
  56         const int icon_size = 64;
  57
  58         resize(600, 400);
  59
  60         page_list = new QListWidget;
  61         page_list->setViewMode(QListView::IconMode);
  62         page_list->setIconSize(QSize(icon_size, icon_size));
  63         page_list->setMovement(QListView::Static);
  64         page_list->setMaximumWidth(icon_size + (icon_size / 2));
  65         page_list->setSpacing(12);
  66
  67         pages = new QStackedWidget;
  68         create_pages();
  69         page_list->setCurrentIndex(page_list->model()->index(0, 0));
  70
  71         QHBoxLayout *tab_layout = new QHBoxLayout;
  72         tab_layout->addWidget(page_list);
  73         tab_layout->addWidget(pages, Qt::AlignLeft);
  74
  75         QDialogButtonBox *button_box = new QDialogButtonBox(
  76                 QDialogButtonBox::Ok | QDialogButtonBox::Cancel);
  77
  78         QVBoxLayout* root_layout = new QVBoxLayout(this);
  79         root_layout->addLayout(tab_layout);
  80         root_layout->addWidget(button_box);
  81
  82         connect(button_box, SIGNAL(accepted()), this, SLOT(accept()));
  83         connect(button_box, SIGNAL(rejected()), this, SLOT(reject()));
  84         connect(page_list, SIGNAL(currentItemChanged(QListWidgetItem*, QListWidgetItem*)),
  85                 this, SLOT(on_page_changed(QListWidgetItem*, QListWidgetItem*)));
  86
  87         // Start to record changes
  88         GlobalSettings settings;
  89         settings.start_tracking();
  90 }
  91
  92 void Settings::create_pages()
  93 {
  94         // View page
  95         pages->addWidget(get_view_settings_form(pages));
  96
  97         QListWidgetItem *viewButton = new QListWidgetItem(page_list);
  98         viewButton->setIcon(QIcon(":/icons/settings-views.svg"));
  99         viewButton->setText(tr("Views"));
 100         viewButton->setTextAlignment(Qt::AlignHCenter);
 101         viewButton->setFlags(Qt::ItemIsSelectable | Qt::ItemIsEnabled);
 102
 103 #ifdef ENABLE_DECODE
 104         // Decoder page
 105         pages->addWidget(get_decoder_settings_form(pages));
 106
 107         QListWidgetItem *decoderButton = new QListWidgetItem(page_list);
 108         decoderButton->setIcon(QIcon(":/icons/add-decoder.svg"));
 109         decoderButton->setText(tr("Decoders"));
 110         decoderButton->setTextAlignment(Qt::AlignHCenter);
 111         decoderButton->setFlags(Qt::ItemIsSelectable | Qt::ItemIsEnabled);
 112 #endif
 113
 114         // About page
 115         pages->addWidget(get_about_page(pages));
 116
 117         QListWidgetItem *aboutButton = new QListWidgetItem(page_list);
 118         aboutButton->setIcon(QIcon(":/icons/information.svg"));
 119         aboutButton->setText(tr("About"));
 120         aboutButton->setTextAlignment(Qt::AlignHCenter);
 121         aboutButton->setFlags(Qt::ItemIsSelectable | Qt::ItemIsEnabled);
 122 }
 123
 124 QCheckBox *Settings::create_checkbox(const QString& key, const char* slot) const
 125 {
 126         GlobalSettings settings;
 127
 128         QCheckBox *cb = new QCheckBox();
 129         cb->setChecked(settings.value(key).toBool());
 130         connect(cb, SIGNAL(stateChanged(int)), this, slot);
 131         return cb;
 132 }
 133
 134 QWidget *Settings::get_view_settings_form(QWidget *parent) const
 135 {
 136         QCheckBox *cb;
 137
 138         QWidget *form = new QWidget(parent);
 139         QVBoxLayout *form_layout = new QVBoxLayout(form);
 140
 141         // Trace view settings
 142         QGroupBox *trace_view_group = new QGroupBox(tr("Trace View"));
 143         form_layout->addWidget(trace_view_group);
 144
 145         QFormLayout *trace_view_layout = new QFormLayout();
 146         trace_view_group->setLayout(trace_view_layout);
 147
 148         cb = create_checkbox(GlobalSettings::Key_View_ColouredBG,
 149                 SLOT(on_view_colouredBG_changed(int)));
 150         trace_view_layout->addRow(tr("Use coloured trace &background"), cb);
 151
 152         cb = create_checkbox(GlobalSettings::Key_View_ZoomToFitDuringAcq,
 153                 SLOT(on_view_zoomToFitDuringAcq_changed(int)));
 154         trace_view_layout->addRow(tr("Constantly perform &zoom-to-fit during acquisition"), cb);
 155
 156         cb = create_checkbox(GlobalSettings::Key_View_ZoomToFitAfterAcq,
 157                 SLOT(on_view_zoomToFitAfterAcq_changed(int)));
 158         trace_view_layout->addRow(tr("Perform a zoom-to-&fit when acquisition stops"), cb);
 159
 160         cb = create_checkbox(GlobalSettings::Key_View_StickyScrolling,
 161                 SLOT(on_view_stickyScrolling_changed(int)));
 162         trace_view_layout->addRow(tr("Always keep &newest samples at the right edge during capture"), cb);
 163
 164         cb = create_checkbox(GlobalSettings::Key_View_ShowSamplingPoints,
 165                 SLOT(on_view_showSamplingPoints_changed(int)));
 166         trace_view_layout->addRow(tr("Show data &sampling points"), cb);
 167
 168         cb = create_checkbox(GlobalSettings::Key_View_ShowAnalogMinorGrid,
 169                 SLOT(on_view_showAnalogMinorGrid_changed(int)));
 170         trace_view_layout->addRow(tr("Show analog minor grid in addition to vdiv grid"), cb);
 171
 172         return form;
 173 }
 174
 175 QWidget *Settings::get_decoder_settings_form(QWidget *parent) const
 176 {
 177 #ifdef ENABLE_DECODE
 178         QCheckBox *cb;
 179
 180         QWidget *form = new QWidget(parent);
 181         QVBoxLayout *form_layout = new QVBoxLayout(form);
 182
 183         // Decoder settings
 184         QGroupBox *decoder_group = new QGroupBox(tr("Decoders"));
 185         form_layout->addWidget(decoder_group);
 186
 187         QFormLayout *decoder_layout = new QFormLayout();
 188         decoder_group->setLayout(decoder_layout);
 189
 190         cb = create_checkbox(GlobalSettings::Key_Dec_InitialStateConfigurable,
 191                 SLOT(on_dec_initialStateConfigurable_changed(int)));
 192         decoder_layout->addRow(tr("Allow configuration of &initial signal state"), cb);
 193
 194         return form;
 195 #else
 196         (void)parent;
 197 #endif
 198 }
 199
 200 #ifdef ENABLE_DECODE
 201 static gint sort_pds(gconstpointer a, gconstpointer b)
 202 {
 203         const struct srd_decoder *sda, *sdb;
 204
 205         sda = (const struct srd_decoder *)a;
 206         sdb = (const struct srd_decoder *)b;
 207         return strcmp(sda->id, sdb->id);
 208 }
 209 #endif
 210
 211 QWidget *Settings::get_about_page(QWidget *parent) const
 212 {
 213 #ifdef ENABLE_DECODE
 214         struct srd_decoder *dec;
 215 #endif
 216
 217         QLabel *icon = new QLabel();
 218         icon->setPixmap(QPixmap(QString::fromUtf8(":/icons/pulseview.svg")));
 219
 220         /* Setup the version field */
 221         QLabel *version_info = new QLabel();
 222         version_info->setText(tr("%1 %2<br />%3<br /><a href=\"http://%4\">%4</a>")
 223                 .arg(QApplication::applicationName(),
 224                 QApplication::applicationVersion(),
 225                 tr("GNU GPL, version 3 or later"),
 226                 QApplication::organizationDomain()));
 227         version_info->setOpenExternalLinks(true);
 228
 229         shared_ptr<sigrok::Context> context = device_manager_.context();
 230
 231         QString s;
 232
 233         s.append("<style type=\"text/css\"> tr .id { white-space: pre; padding-right: 5px; } </style>");
 234
 235         s.append("<table>");
 236
 237         /* Library info */
 238         s.append("<tr><td colspan=\"2\"><b>" +
 239                 tr("Libraries and features:") + "</b></td></tr>");
 240
 241         s.append(QString("<tr><td><i>%1</i></td><td>%2</td></tr>")
 242                 .arg(QString("Qt"), qVersion()));
 243         s.append(QString("<tr><td><i>%1</i></td><td>%2</td></tr>")
 244                 .arg(QString("glibmm"), PV_GLIBMM_VERSION));
 245         s.append(QString("<tr><td><i>%1</i></td><td>%2</td></tr>")
 246                 .arg(QString("Boost"), BOOST_LIB_VERSION));
 247
 248         s.append(QString("<tr><td><i>%1</i></td><td>%2/%3 (rt: %4/%5)</td></tr>")
 249                 .arg(QString("libsigrok"), SR_PACKAGE_VERSION_STRING,
 250                 SR_LIB_VERSION_STRING, sr_package_version_string_get(),
 251                 sr_lib_version_string_get()));
 252
 253         GSList *l_orig = sr_buildinfo_libs_get();
 254         for (GSList *l = l_orig; l; l = l->next) {
 255                 GSList *m = (GSList *)l->data;
 256                 const char *lib = (const char *)m->data;
 257                 const char *version = (const char *)m->next->data;
 258                 s.append(QString("<tr><td><i>- %1</i></td><td>%2</td></tr>")
 259                         .arg(QString(lib), QString(version)));
 260                 g_slist_free_full(m, g_free);
 261         }
 262         g_slist_free(l_orig);
 263
 264         char *host = sr_buildinfo_host_get();
 265         s.append(QString("<tr><td><i>- Host</i></td><td>%1</td></tr>")
 266                 .arg(QString(host)));
 267         g_free(host);
 268
 269         char *scpi_backends = sr_buildinfo_scpi_backends_get();
 270         s.append(QString("<tr><td><i>- SCPI backends</i></td><td>%1</td></tr>")
 271                 .arg(QString(scpi_backends)));
 272         g_free(scpi_backends);
 273
 274 #ifdef ENABLE_DECODE
 275         s.append(QString("<tr><td><i>%1</i></td><td>%2/%3 (rt: %4/%5)</td></tr>")
 276                 .arg(QString("libsigrokdecode"), SRD_PACKAGE_VERSION_STRING,
 277                 SRD_LIB_VERSION_STRING, srd_package_version_string_get(),
 278                 srd_lib_version_string_get()));
 279
 280         l_orig = srd_buildinfo_libs_get();
 281         for (GSList *l = l_orig; l; l = l->next) {
 282                 GSList *m = (GSList *)l->data;
 283                 const char *lib = (const char *)m->data;
 284                 const char *version = (const char *)m->next->data;
 285                 s.append(QString("<tr><td><i>- %1</i></td><td>%2</td></tr>")
 286                         .arg(QString(lib), QString(version)));
 287                 g_slist_free_full(m, g_free);
 288         }
 289         g_slist_free(l_orig);
 290
 291         host = srd_buildinfo_host_get();
 292         s.append(QString("<tr><td><i>- Host</i></td><td>%1</td></tr>")
 293                 .arg(QString(host)));
 294         g_free(host);
 295 #endif
 296
 297         /* Set up the supported field */
 298         s.append("<tr><td colspan=\"2\"></td></tr>");
 299         s.append("<tr><td colspan=\"2\"><b>" +
 300                 tr("Supported hardware drivers:") + "</b></td></tr>");
 301         for (auto entry : context->drivers()) {
 302                 s.append(QString("<tr><td class=\"id\"><i>%1</i></td><td>%2</td></tr>")
 303                         .arg(QString::fromUtf8(entry.first.c_str()),
 304                                 QString::fromUtf8(entry.second->long_name().c_str())));
 305         }
 306
 307         s.append("<tr><td colspan=\"2\"></td></tr>");
 308         s.append("<tr><td colspan=\"2\"><b>" +
 309                 tr("Supported input formats:") + "</b></td></tr>");
 310         for (auto entry : context->input_formats()) {
 311                 s.append(QString("<tr><td class=\"id\"><i>%1</i></td><td>%2</td></tr>")
 312                         .arg(QString::fromUtf8(entry.first.c_str()),
 313                                 QString::fromUtf8(entry.second->description().c_str())));
 314         }
 315
 316         s.append("<tr><td colspan=\"2\"></td></tr>");
 317         s.append("<tr><td colspan=\"2\"><b>" +
 318                 tr("Supported output formats:") + "</b></td></tr>");
 319         for (auto entry : context->output_formats()) {
 320                 s.append(QString("<tr><td class=\"id\"><i>%1</i></td><td>%2</td></tr>")
 321                         .arg(QString::fromUtf8(entry.first.c_str()),
 322                                 QString::fromUtf8(entry.second->description().c_str())));
 323         }
 324
 325 #ifdef ENABLE_DECODE
 326         s.append("<tr><td colspan=\"2\"></td></tr>");
 327         s.append("<tr><td colspan=\"2\"><b>" +
 328                 tr("Supported protocol decoders:") + "</b></td></tr>");
 329         GSList *sl = g_slist_copy((GSList *)srd_decoder_list());
 330         sl = g_slist_sort(sl, sort_pds);
 331         for (const GSList *l = sl; l; l = l->next) {
 332                 dec = (struct srd_decoder *)l->data;
 333                 s.append(QString("<tr><td class=\"id\"><i>%1</i></td><td>%2</td></tr>")
 334                         .arg(QString::fromUtf8(dec->id),
 335                                 QString::fromUtf8(dec->longname)));
 336         }
 337         g_slist_free(sl);
 338 #endif
 339
 340         s.append("</table>");
 341
 342         QTextDocument *supported_doc = new QTextDocument();
 343         supported_doc->setHtml(s);
 344
 345         QTextBrowser *support_list = new QTextBrowser();
 346         support_list->setDocument(supported_doc);
 347
 348         QGridLayout *layout = new QGridLayout();
 349         layout->addWidget(icon, 0, 0, 1, 1);
 350         layout->addWidget(version_info, 0, 1, 1, 1);
 351         layout->addWidget(support_list, 1, 1, 1, 1);
 352
 353         QWidget *page = new QWidget(parent);
 354         page->setLayout(layout);
 355
 356         return page;
 357 }
 358
 359 void Settings::accept()
 360 {
 361         GlobalSettings settings;
 362         settings.stop_tracking();
 363
 364         QDialog::accept();
 365 }
 366
 367 void Settings::reject()
 368 {
 369         GlobalSettings settings;
 370         settings.undo_tracked_changes();
 371
 372         QDialog::reject();
 373 }
 374
 375 void Settings::on_page_changed(QListWidgetItem *current, QListWidgetItem *previous)
 376 {
 377         if (!current)
 378                 current = previous;
 379
 380         pages->setCurrentIndex(page_list->row(current));
 381 }
 382
 383 void Settings::on_view_zoomToFitDuringAcq_changed(int state)
 384 {
 385         GlobalSettings settings;
 386         settings.setValue(GlobalSettings::Key_View_ZoomToFitDuringAcq, state ? true : false);
 387 }
 388
 389 void Settings::on_view_zoomToFitAfterAcq_changed(int state)
 390 {
 391         GlobalSettings settings;
 392         settings.setValue(GlobalSettings::Key_View_ZoomToFitAfterAcq, state ? true : false);
 393 }
 394
 395 void Settings::on_view_colouredBG_changed(int state)
 396 {
 397         GlobalSettings settings;
 398         settings.setValue(GlobalSettings::Key_View_ColouredBG, state ? true : false);
 399 }
 400
 401 void Settings::on_view_stickyScrolling_changed(int state)
 402 {
 403         GlobalSettings settings;
 404         settings.setValue(GlobalSettings::Key_View_StickyScrolling, state ? true : false);
 405 }
 406
 407 void Settings::on_view_showSamplingPoints_changed(int state)
 408 {
 409         GlobalSettings settings;
 410         settings.setValue(GlobalSettings::Key_View_ShowSamplingPoints, state ? true : false);
 411 }
 412
 413 void Settings::on_view_showAnalogMinorGrid_changed(int state)
 414 {
 415         GlobalSettings settings;
 416         settings.setValue(GlobalSettings::Key_View_ShowAnalogMinorGrid, state ? true : false);
 417 }
 418
 419 void Settings::on_dec_initialStateConfigurable_changed(int state)
 420 {
 421         GlobalSettings settings;
 422         settings.setValue(GlobalSettings::Key_Dec_InitialStateConfigurable, state ? true : false);
 423 }
 424
 425 } // namespace dialogs
 426 } // namespace pv