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