Settings: Fix description text
[pulseview.git] / pv / dialogs / settings.cpp
index d3ed1f4eb086e639096bacd896c25f889b92ea95..1ac8a4c35f8b4203761cd36e2d877d6f1a6deb08 100644 (file)
 #include <boost/version.hpp>
 
 #include <QApplication>
+#include <QComboBox>
 #include <QDialogButtonBox>
+#include <QFileDialog>
 #include <QFormLayout>
 #include <QGroupBox>
 #include <QHBoxLayout>
 #include <QLabel>
+#include <QMainWindow>
+#include <QMessageBox>
+#include <QPushButton>
+#include <QScrollBar>
+#include <QSpinBox>
 #include <QString>
 #include <QTextBrowser>
 #include <QTextDocument>
+#include <QTextStream>
 #include <QVBoxLayout>
 
 #include "settings.hpp"
 
 #include "pv/devicemanager.hpp"
 #include "pv/globalsettings.hpp"
+#include "pv/logging.hpp"
 
 #include <libsigrokcxx/libsigrokcxx.hpp>
 
@@ -49,25 +58,49 @@ using std::shared_ptr;
 namespace pv {
 namespace dialogs {
 
+/**
+ * Special version of a QListView that has the width of the first column as minimum size.
+ *
+ * @note Inspired by https://github.com/qt-creator/qt-creator/blob/master/src/plugins/coreplugin/dialogs/settingsdialog.cpp
+ */
+class PageListWidget: public QListWidget
+{
+public:
+       PageListWidget() :
+               QListWidget()
+       {
+               setSizePolicy(QSizePolicy::MinimumExpanding, QSizePolicy::Expanding);
+       }
+
+       QSize sizeHint() const final
+       {
+               int width = sizeHintForColumn(0) + frameWidth() * 2 + 5;
+               if (verticalScrollBar()->isVisible())
+                       width += verticalScrollBar()->width();
+               return QSize(width, 100);
+       }
+};
+
 Settings::Settings(DeviceManager &device_manager, QWidget *parent) :
        QDialog(parent, nullptr),
        device_manager_(device_manager)
 {
-       const int icon_size = 64;
-
        resize(600, 400);
 
-       page_list = new QListWidget;
-       page_list->setViewMode(QListView::IconMode);
-       page_list->setIconSize(QSize(icon_size, icon_size));
+       // Create log view
+       log_view_ = create_log_view();
+
+       // Create pages
+       page_list = new PageListWidget();
+       page_list->setViewMode(QListView::ListMode);
        page_list->setMovement(QListView::Static);
-       page_list->setMaximumWidth(icon_size + (icon_size / 2));
-       page_list->setSpacing(12);
+       page_list->setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
 
        pages = new QStackedWidget;
        create_pages();
        page_list->setCurrentIndex(page_list->model()->index(0, 0));
 
+       // Create the rest of the dialog
        QHBoxLayout *tab_layout = new QHBoxLayout;
        tab_layout->addWidget(page_list);
        tab_layout->addWidget(pages, Qt::AlignLeft);
@@ -97,7 +130,7 @@ void Settings::create_pages()
        QListWidgetItem *viewButton = new QListWidgetItem(page_list);
        viewButton->setIcon(QIcon(":/icons/settings-views.svg"));
        viewButton->setText(tr("Views"));
-       viewButton->setTextAlignment(Qt::AlignHCenter);
+       viewButton->setTextAlignment(Qt::AlignVCenter);
        viewButton->setFlags(Qt::ItemIsSelectable | Qt::ItemIsEnabled);
 
 #ifdef ENABLE_DECODE
@@ -107,7 +140,7 @@ void Settings::create_pages()
        QListWidgetItem *decoderButton = new QListWidgetItem(page_list);
        decoderButton->setIcon(QIcon(":/icons/add-decoder.svg"));
        decoderButton->setText(tr("Decoders"));
-       decoderButton->setTextAlignment(Qt::AlignHCenter);
+       decoderButton->setTextAlignment(Qt::AlignVCenter);
        decoderButton->setFlags(Qt::ItemIsSelectable | Qt::ItemIsEnabled);
 #endif
 
@@ -117,8 +150,17 @@ void Settings::create_pages()
        QListWidgetItem *aboutButton = new QListWidgetItem(page_list);
        aboutButton->setIcon(QIcon(":/icons/information.svg"));
        aboutButton->setText(tr("About"));
-       aboutButton->setTextAlignment(Qt::AlignHCenter);
+       aboutButton->setTextAlignment(Qt::AlignVCenter);
        aboutButton->setFlags(Qt::ItemIsSelectable | Qt::ItemIsEnabled);
+
+       // Logging page
+       pages->addWidget(get_logging_page(pages));
+
+       QListWidgetItem *loggingButton = new QListWidgetItem(page_list);
+       loggingButton->setIcon(QIcon(":/icons/information.svg"));
+       loggingButton->setText(tr("Logging"));
+       loggingButton->setTextAlignment(Qt::AlignVCenter);
+       loggingButton->setFlags(Qt::ItemIsSelectable | Qt::ItemIsEnabled);
 }
 
 QCheckBox *Settings::create_checkbox(const QString& key, const char* slot) const
@@ -131,8 +173,26 @@ QCheckBox *Settings::create_checkbox(const QString& key, const char* slot) const
        return cb;
 }
 
+QPlainTextEdit *Settings::create_log_view() const
+{
+       GlobalSettings settings;
+
+       QPlainTextEdit *log_view = new QPlainTextEdit();
+
+       log_view->setReadOnly(true);
+       log_view->setWordWrapMode(QTextOption::NoWrap);
+       log_view->setCenterOnScroll(true);
+
+       log_view->appendHtml(logging.get_log());
+       connect(&logging, SIGNAL(logged_text(QString)),
+               log_view, SLOT(appendHtml(QString)));
+
+       return log_view;
+}
+
 QWidget *Settings::get_view_settings_form(QWidget *parent) const
 {
+       GlobalSettings settings;
        QCheckBox *cb;
 
        QWidget *form = new QWidget(parent);
@@ -145,18 +205,22 @@ QWidget *Settings::get_view_settings_form(QWidget *parent) const
        QFormLayout *trace_view_layout = new QFormLayout();
        trace_view_group->setLayout(trace_view_layout);
 
-       cb = create_checkbox(GlobalSettings::Key_View_ColouredBG,
-               SLOT(on_view_colouredBG_changed(int)));
-       trace_view_layout->addRow(tr("Use coloured trace &background"), cb);
+       cb = create_checkbox(GlobalSettings::Key_View_ColoredBG,
+               SLOT(on_view_coloredBG_changed(int)));
+       trace_view_layout->addRow(tr("Use colored trace &background"), cb);
 
-       cb = create_checkbox(GlobalSettings::Key_View_AlwaysZoomToFit,
-               SLOT(on_view_alwaysZoomToFit_changed(int)));
-       trace_view_layout->addRow(tr("Constantly perform &zoom-to-fit during capture"), cb);
+       cb = create_checkbox(GlobalSettings::Key_View_ZoomToFitDuringAcq,
+               SLOT(on_view_zoomToFitDuringAcq_changed(int)));
+       trace_view_layout->addRow(tr("Constantly perform &zoom-to-fit during acquisition"), cb);
 
        cb = create_checkbox(GlobalSettings::Key_View_ZoomToFitAfterAcq,
                SLOT(on_view_zoomToFitAfterAcq_changed(int)));
        trace_view_layout->addRow(tr("Perform a zoom-to-&fit when acquisition stops"), cb);
 
+       cb = create_checkbox(GlobalSettings::Key_View_TriggerIsZeroTime,
+               SLOT(on_view_triggerIsZero_changed(int)));
+       trace_view_layout->addRow(tr("Show time zero at the trigger"), cb);
+
        cb = create_checkbox(GlobalSettings::Key_View_StickyScrolling,
                SLOT(on_view_stickyScrolling_changed(int)));
        trace_view_layout->addRow(tr("Always keep &newest samples at the right edge during capture"), cb);
@@ -167,14 +231,47 @@ QWidget *Settings::get_view_settings_form(QWidget *parent) const
 
        cb = create_checkbox(GlobalSettings::Key_View_ShowAnalogMinorGrid,
                SLOT(on_view_showAnalogMinorGrid_changed(int)));
-       trace_view_layout->addRow(tr("Show analog minor grid in addition to vdiv grid"), cb);
+       trace_view_layout->addRow(tr("Show analog minor grid in addition to div grid"), cb);
+
+       cb = create_checkbox(GlobalSettings::Key_View_ShowHoverMarker,
+               SLOT(on_view_showHoverMarker_changed(int)));
+       trace_view_layout->addRow(tr("Highlight mouse cursor using a vertical marker line"), cb);
+
+       QComboBox *thr_disp_mode_cb = new QComboBox();
+       thr_disp_mode_cb->addItem(tr("None"), GlobalSettings::ConvThrDispMode_None);
+       thr_disp_mode_cb->addItem(tr("Background"), GlobalSettings::ConvThrDispMode_Background);
+       thr_disp_mode_cb->addItem(tr("Dots"), GlobalSettings::ConvThrDispMode_Dots);
+       thr_disp_mode_cb->setCurrentIndex(
+               settings.value(GlobalSettings::Key_View_ConversionThresholdDispMode).toInt());
+       connect(thr_disp_mode_cb, SIGNAL(currentIndexChanged(int)),
+               this, SLOT(on_view_conversionThresholdDispMode_changed(int)));
+       trace_view_layout->addRow(tr("Conversion threshold display mode (analog traces only)"), thr_disp_mode_cb);
+
+       QSpinBox *default_div_height_sb = new QSpinBox();
+       default_div_height_sb->setRange(20, 1000);
+       default_div_height_sb->setSuffix(tr(" pixels"));
+       default_div_height_sb->setValue(
+               settings.value(GlobalSettings::Key_View_DefaultDivHeight).toInt());
+       connect(default_div_height_sb, SIGNAL(valueChanged(int)), this,
+               SLOT(on_view_defaultDivHeight_changed(int)));
+       trace_view_layout->addRow(tr("Default analog trace div height"), default_div_height_sb);
+
+       QSpinBox *default_logic_height_sb = new QSpinBox();
+       default_logic_height_sb->setRange(5, 1000);
+       default_logic_height_sb->setSuffix(tr(" pixels"));
+       default_logic_height_sb->setValue(
+               settings.value(GlobalSettings::Key_View_DefaultLogicHeight).toInt());
+       connect(default_logic_height_sb, SIGNAL(valueChanged(int)), this,
+               SLOT(on_view_defaultLogicHeight_changed(int)));
+       trace_view_layout->addRow(tr("Default logic trace height"), default_logic_height_sb);
 
        return form;
 }
 
-QWidget *Settings::get_decoder_settings_form(QWidget *parent) const
+QWidget *Settings::get_decoder_settings_form(QWidget *parent)
 {
 #ifdef ENABLE_DECODE
+       GlobalSettings settings;
        QCheckBox *cb;
 
        QWidget *form = new QWidget(parent);
@@ -191,9 +288,24 @@ QWidget *Settings::get_decoder_settings_form(QWidget *parent) const
                SLOT(on_dec_initialStateConfigurable_changed(int)));
        decoder_layout->addRow(tr("Allow configuration of &initial signal state"), cb);
 
+       // Annotation export settings
+       ann_export_format_ = new QLineEdit();
+       ann_export_format_->setText(
+               settings.value(GlobalSettings::Key_Dec_ExportFormat).toString());
+       connect(ann_export_format_, SIGNAL(textChanged(const QString&)),
+               this, SLOT(on_dec_exportFormat_changed(const QString&)));
+       decoder_layout->addRow(tr("Annotation export format"), ann_export_format_);
+       QLabel *description_1 = new QLabel(tr("%s = sample range; %d: decoder name; %c: row name; %q: use quotations marks"));
+       description_1->setAlignment(Qt::AlignRight);
+       decoder_layout->addRow(description_1);
+       QLabel *description_2 = new QLabel(tr("%1: longest annotation text; %a: all annotation texts"));
+       description_2->setAlignment(Qt::AlignRight);
+       decoder_layout->addRow(description_2);
+
        return form;
 #else
        (void)parent;
+       return nullptr;
 #endif
 }
 
@@ -217,14 +329,12 @@ QWidget *Settings::get_about_page(QWidget *parent) const
        QLabel *icon = new QLabel();
        icon->setPixmap(QPixmap(QString::fromUtf8(":/icons/pulseview.svg")));
 
-       /* Setup the version field */
-       QLabel *version_info = new QLabel();
-       version_info->setText(tr("%1 %2<br />%3<br /><a href=\"http://%4\">%4</a>")
-               .arg(QApplication::applicationName(),
-               QApplication::applicationVersion(),
+       /* Setup the license field, with the project homepage link. */
+       QLabel *gpl_home_info = new QLabel();
+       gpl_home_info->setText(tr("%1<br /><a href=\"http://%2\">%2</a>").arg(
                tr("GNU GPL, version 3 or later"),
                QApplication::organizationDomain()));
-       version_info->setOpenExternalLinks(true);
+       gpl_home_info->setOpenExternalLinks(true);
 
        shared_ptr<sigrok::Context> context = device_manager_.context();
 
@@ -234,10 +344,13 @@ QWidget *Settings::get_about_page(QWidget *parent) const
 
        s.append("<table>");
 
-       /* Library info */
+       /* Version, library, and feature info */
        s.append("<tr><td colspan=\"2\"><b>" +
-               tr("Libraries and features:") + "</b></td></tr>");
+               tr("Versions, libraries and features:") + "</b></td></tr>");
 
+       s.append(QString("<tr><td><i>%1</i></td><td>%2</td></tr>")
+               .arg(QApplication::applicationName(),
+               QApplication::applicationVersion()));
        s.append(QString("<tr><td><i>%1</i></td><td>%2</td></tr>")
                .arg(QString("Qt"), qVersion()));
        s.append(QString("<tr><td><i>%1</i></td><td>%2</td></tr>")
@@ -294,6 +407,28 @@ QWidget *Settings::get_about_page(QWidget *parent) const
        g_free(host);
 #endif
 
+       s.append("<tr><td colspan=\"2\"></td></tr>");
+       s.append("<tr><td colspan=\"2\"><b>" +
+               tr("Firmware search paths:") + "</b></td></tr>");
+
+       l_orig = sr_resourcepaths_get(SR_RESOURCE_FIRMWARE);
+       for (GSList *l = l_orig; l; l = l->next)
+               s.append(QString("<tr><td colspan=\"2\">%1</td></tr>").arg(
+                       QString((char*)l->data)));
+       g_slist_free_full(l_orig, g_free);
+
+#ifdef ENABLE_DECODE
+       s.append("<tr><td colspan=\"2\"></td></tr>");
+       s.append("<tr><td colspan=\"2\"><b>" +
+               tr("Protocol decoder search paths:") + "</b></td></tr>");
+
+       l_orig = srd_searchpaths_get();
+       for (GSList *l = l_orig; l; l = l->next)
+               s.append(QString("<tr><td colspan=\"2\">%1</td></tr>").arg(
+                       QString((char*)l->data)));
+       g_slist_free_full(l_orig, g_free);
+#endif
+
        /* Set up the supported field */
        s.append("<tr><td colspan=\"2\"></td></tr>");
        s.append("<tr><td colspan=\"2\"><b>" +
@@ -345,10 +480,14 @@ QWidget *Settings::get_about_page(QWidget *parent) const
        QTextBrowser *support_list = new QTextBrowser();
        support_list->setDocument(supported_doc);
 
-       QGridLayout *layout = new QGridLayout();
-       layout->addWidget(icon, 0, 0, 1, 1);
-       layout->addWidget(version_info, 0, 1, 1, 1);
-       layout->addWidget(support_list, 1, 1, 1, 1);
+       QHBoxLayout *h_layout = new QHBoxLayout();
+       h_layout->setAlignment(Qt::AlignLeft);
+       h_layout->addWidget(icon);
+       h_layout->addWidget(gpl_home_info);
+
+       QVBoxLayout *layout = new QVBoxLayout();
+       layout->addLayout(h_layout);
+       layout->addWidget(support_list);
 
        QWidget *page = new QWidget(parent);
        page->setLayout(layout);
@@ -356,6 +495,65 @@ QWidget *Settings::get_about_page(QWidget *parent) const
        return page;
 }
 
+QWidget *Settings::get_logging_page(QWidget *parent) const
+{
+       GlobalSettings settings;
+
+       // Log level
+       QSpinBox *loglevel_sb = new QSpinBox();
+       loglevel_sb->setMaximum(SR_LOG_SPEW);
+       loglevel_sb->setValue(logging.get_log_level());
+       connect(loglevel_sb, SIGNAL(valueChanged(int)), this,
+               SLOT(on_log_logLevel_changed(int)));
+
+       QHBoxLayout *loglevel_layout = new QHBoxLayout();
+       loglevel_layout->addWidget(new QLabel(tr("Log level:")));
+       loglevel_layout->addWidget(loglevel_sb);
+
+       // Background buffer size
+       QSpinBox *buffersize_sb = new QSpinBox();
+       buffersize_sb->setSuffix(tr(" lines"));
+       buffersize_sb->setMinimum(Logging::MIN_BUFFER_SIZE);
+       buffersize_sb->setMaximum(Logging::MAX_BUFFER_SIZE);
+       buffersize_sb->setValue(
+               settings.value(GlobalSettings::Key_Log_BufferSize).toInt());
+       connect(buffersize_sb, SIGNAL(valueChanged(int)), this,
+               SLOT(on_log_bufferSize_changed(int)));
+
+       QHBoxLayout *buffersize_layout = new QHBoxLayout();
+       buffersize_layout->addWidget(new QLabel(tr("Length of background buffer:")));
+       buffersize_layout->addWidget(buffersize_sb);
+
+       // Save to file
+       QPushButton *save_log_pb = new QPushButton(
+               QIcon::fromTheme("document-save-as", QIcon(":/icons/document-save-as.png")),
+               tr("&Save to File"));
+       connect(save_log_pb, SIGNAL(clicked(bool)),
+               this, SLOT(on_log_saveToFile_clicked(bool)));
+
+       // Pop out
+       QPushButton *pop_out_pb = new QPushButton(
+               QIcon::fromTheme("window-new", QIcon(":/icons/window-new.png")),
+               tr("&Pop out"));
+       connect(pop_out_pb, SIGNAL(clicked(bool)),
+               this, SLOT(on_log_popOut_clicked(bool)));
+
+       QHBoxLayout *control_layout = new QHBoxLayout();
+       control_layout->addLayout(loglevel_layout);
+       control_layout->addLayout(buffersize_layout);
+       control_layout->addWidget(save_log_pb);
+       control_layout->addWidget(pop_out_pb);
+
+       QVBoxLayout *root_layout = new QVBoxLayout();
+       root_layout->addLayout(control_layout);
+       root_layout->addWidget(log_view_);
+
+       QWidget *page = new QWidget(parent);
+       page->setLayout(root_layout);
+
+       return page;
+}
+
 void Settings::accept()
 {
        GlobalSettings settings;
@@ -380,10 +578,10 @@ void Settings::on_page_changed(QListWidgetItem *current, QListWidgetItem *previo
        pages->setCurrentIndex(page_list->row(current));
 }
 
-void Settings::on_view_alwaysZoomToFit_changed(int state)
+void Settings::on_view_zoomToFitDuringAcq_changed(int state)
 {
        GlobalSettings settings;
-       settings.setValue(GlobalSettings::Key_View_AlwaysZoomToFit, state ? true : false);
+       settings.setValue(GlobalSettings::Key_View_ZoomToFitDuringAcq, state ? true : false);
 }
 
 void Settings::on_view_zoomToFitAfterAcq_changed(int state)
@@ -392,10 +590,16 @@ void Settings::on_view_zoomToFitAfterAcq_changed(int state)
        settings.setValue(GlobalSettings::Key_View_ZoomToFitAfterAcq, state ? true : false);
 }
 
-void Settings::on_view_colouredBG_changed(int state)
+void Settings::on_view_triggerIsZero_changed(int state)
+{
+       GlobalSettings settings;
+       settings.setValue(GlobalSettings::Key_View_TriggerIsZeroTime, state ? true : false);
+}
+
+void Settings::on_view_coloredBG_changed(int state)
 {
        GlobalSettings settings;
-       settings.setValue(GlobalSettings::Key_View_ColouredBG, state ? true : false);
+       settings.setValue(GlobalSettings::Key_View_ColoredBG, state ? true : false);
 }
 
 void Settings::on_view_stickyScrolling_changed(int state)
@@ -416,11 +620,106 @@ void Settings::on_view_showAnalogMinorGrid_changed(int state)
        settings.setValue(GlobalSettings::Key_View_ShowAnalogMinorGrid, state ? true : false);
 }
 
+void Settings::on_view_showHoverMarker_changed(int state)
+{
+       GlobalSettings settings;
+       settings.setValue(GlobalSettings::Key_View_ShowHoverMarker, state ? true : false);
+}
+
+void Settings::on_view_conversionThresholdDispMode_changed(int state)
+{
+       GlobalSettings settings;
+       settings.setValue(GlobalSettings::Key_View_ConversionThresholdDispMode, state);
+}
+
+void Settings::on_view_defaultDivHeight_changed(int value)
+{
+       GlobalSettings settings;
+       settings.setValue(GlobalSettings::Key_View_DefaultDivHeight, value);
+}
+
+void Settings::on_view_defaultLogicHeight_changed(int value)
+{
+       GlobalSettings settings;
+       settings.setValue(GlobalSettings::Key_View_DefaultLogicHeight, value);
+}
+
+#ifdef ENABLE_DECODE
 void Settings::on_dec_initialStateConfigurable_changed(int state)
 {
        GlobalSettings settings;
        settings.setValue(GlobalSettings::Key_Dec_InitialStateConfigurable, state ? true : false);
 }
 
+void Settings::on_dec_exportFormat_changed(const QString &text)
+{
+       GlobalSettings settings;
+       settings.setValue(GlobalSettings::Key_Dec_ExportFormat, text);
+}
+#endif
+
+void Settings::on_log_logLevel_changed(int value)
+{
+       logging.set_log_level(value);
+}
+
+void Settings::on_log_bufferSize_changed(int value)
+{
+       GlobalSettings settings;
+       settings.setValue(GlobalSettings::Key_Log_BufferSize, value);
+}
+
+void Settings::on_log_saveToFile_clicked(bool checked)
+{
+       (void)checked;
+
+       const QString file_name = QFileDialog::getSaveFileName(
+               this, tr("Save Log"), "", tr("Log Files (*.txt *.log);;All Files (*)"));
+
+       if (file_name.isEmpty())
+               return;
+
+       QFile file(file_name);
+       if (file.open(QIODevice::WriteOnly | QIODevice::Truncate | QIODevice::Text)) {
+               QTextStream out_stream(&file);
+               out_stream << log_view_->toPlainText();
+
+               if (out_stream.status() == QTextStream::Ok) {
+                       QMessageBox msg(this);
+                       msg.setText(tr("Success"));
+                       msg.setInformativeText(tr("Log saved to %1.").arg(file_name));
+                       msg.setStandardButtons(QMessageBox::Ok);
+                       msg.setIcon(QMessageBox::Information);
+                       msg.exec();
+
+                       return;
+               }
+       }
+
+       QMessageBox msg(this);
+       msg.setText(tr("Error"));
+       msg.setInformativeText(tr("File %1 could not be written to.").arg(file_name));
+       msg.setStandardButtons(QMessageBox::Ok);
+       msg.setIcon(QMessageBox::Warning);
+       msg.exec();
+}
+
+void Settings::on_log_popOut_clicked(bool checked)
+{
+       (void)checked;
+
+       // Create the window as a sub-window so it closes when the main window closes
+       QMainWindow *window = new QMainWindow(nullptr, Qt::SubWindow);
+
+       window->setObjectName(QString::fromUtf8("Log Window"));
+       window->setWindowTitle(tr("%1 Log").arg(PV_TITLE));
+
+       // Use same width/height as the settings dialog
+       window->resize(width(), height());
+
+       window->setCentralWidget(create_log_view());
+       window->show();
+}
+
 } // namespace dialogs
 } // namespace pv