2 * This file is part of the PulseView project.
4 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
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.
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.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
24 #include <libsigrokdecode/libsigrokdecode.h>
30 #include <boost/algorithm/string/join.hpp>
33 #include <QApplication>
34 #include <QButtonGroup>
35 #include <QCloseEvent>
36 #include <QFileDialog>
37 #include <QMessageBox>
42 #include <QVBoxLayout>
45 #include "mainwindow.hpp"
47 #include "devicemanager.hpp"
49 #include "data/segment.hpp"
50 #include "devices/hardwaredevice.hpp"
51 #include "devices/inputfile.hpp"
52 #include "devices/sessionfile.hpp"
53 #include "dialogs/about.hpp"
54 #include "dialogs/connect.hpp"
55 #include "dialogs/inputoutputoptions.hpp"
56 #include "dialogs/storeprogress.hpp"
57 #include "toolbars/mainbar.hpp"
58 #include "view/logicsignal.hpp"
59 #include "view/view.hpp"
60 #include "widgets/exportmenu.hpp"
61 #include "widgets/importmenu.hpp"
63 #include "widgets/decodermenu.hpp"
65 #include "widgets/hidingmenubar.hpp"
71 #include <libsigrokcxx/libsigrokcxx.hpp>
78 using std::shared_ptr;
82 using boost::algorithm::join;
85 using sigrok::OutputFormat;
86 using sigrok::InputFormat;
94 const char *MainWindow::SettingOpenDirectory = "MainWindow/OpenDirectory";
95 const char *MainWindow::SettingSaveDirectory = "MainWindow/SaveDirectory";
97 MainWindow::MainWindow(DeviceManager &device_manager,
98 string open_file_name, string open_file_format,
101 device_manager_(device_manager),
102 session_(device_manager),
103 action_open_(new QAction(this)),
104 action_save_as_(new QAction(this)),
105 action_save_selection_as_(new QAction(this)),
106 action_connect_(new QAction(this)),
107 action_quit_(new QAction(this)),
108 action_view_zoom_in_(new QAction(this)),
109 action_view_zoom_out_(new QAction(this)),
110 action_view_zoom_fit_(new QAction(this)),
111 action_view_zoom_one_to_one_(new QAction(this)),
112 action_view_sticky_scrolling_(new QAction(this)),
113 action_view_show_cursors_(new QAction(this)),
114 action_about_(new QAction(this))
116 , menu_decoders_add_(new pv::widgets::DecoderMenu(this, true))
119 qRegisterMetaType<util::Timestamp>("util::Timestamp");
122 restore_ui_settings();
123 if (open_file_name.empty())
124 select_init_device();
126 load_init_file(open_file_name, open_file_format);
129 QAction* MainWindow::action_open() const
134 QAction* MainWindow::action_save_as() const
136 return action_save_as_;
139 QAction* MainWindow::action_save_selection_as() const
141 return action_save_selection_as_;
144 QAction* MainWindow::action_connect() const
146 return action_connect_;
149 QAction* MainWindow::action_quit() const
154 QAction* MainWindow::action_view_zoom_in() const
156 return action_view_zoom_in_;
159 QAction* MainWindow::action_view_zoom_out() const
161 return action_view_zoom_out_;
164 QAction* MainWindow::action_view_zoom_fit() const
166 return action_view_zoom_fit_;
169 QAction* MainWindow::action_view_zoom_one_to_one() const
171 return action_view_zoom_one_to_one_;
174 QAction* MainWindow::action_view_sticky_scrolling() const
176 return action_view_sticky_scrolling_;
179 QAction* MainWindow::action_view_show_cursors() const
181 return action_view_show_cursors_;
184 QAction* MainWindow::action_about() const
186 return action_about_;
190 QMenu* MainWindow::menu_decoder_add() const
192 return menu_decoders_add_;
196 void MainWindow::run_stop()
198 switch(session_.get_capture_state()) {
199 case Session::Stopped:
200 session_.start_capture([&](QString message) {
201 session_error("Capture failed", message); });
204 case Session::AwaitingTrigger:
205 case Session::Running:
206 session_.stop_capture();
211 void MainWindow::select_device(shared_ptr<devices::Device> device)
215 session_.set_device(device);
217 session_.set_default_device();
218 } catch(const QString &e) {
219 QMessageBox msg(this);
221 msg.setInformativeText(tr("Failed to Select Device"));
222 msg.setStandardButtons(QMessageBox::Ok);
223 msg.setIcon(QMessageBox::Warning);
228 void MainWindow::export_file(shared_ptr<OutputFormat> format,
231 using pv::dialogs::StoreProgress;
233 // Stop any currently running capture session
234 session_.stop_capture();
237 const QString dir = settings.value(SettingSaveDirectory).toString();
239 std::pair<uint64_t, uint64_t> sample_range;
241 // Selection only? Verify that the cursors are active and fetch their values
242 if (selection_only) {
243 if (!view_->cursors()->enabled()) {
244 show_session_error(tr("Missing Cursors"), tr("You need to set the " \
245 "cursors before you can save the data enclosed by them " \
246 "to a session file (e.g. using ALT-V - Show Cursors)."));
250 const double samplerate = session_.get_samplerate();
252 const pv::util::Timestamp& start_time = view_->cursors()->first()->time();
253 const pv::util::Timestamp& end_time = view_->cursors()->second()->time();
255 const uint64_t start_sample = start_time.convert_to<double>() * samplerate;
256 const uint64_t end_sample = end_time.convert_to<double>() * samplerate;
258 sample_range = std::make_pair(start_sample, end_sample);
260 sample_range = std::make_pair(0, 0);
263 // Construct the filter
264 const vector<string> exts = format->extensions();
265 QString filter = tr("%1 files ").arg(
266 QString::fromStdString(format->description()));
271 filter += QString("(*.%1);;%2 (*.*)").arg(
272 QString::fromStdString(join(exts, ", *."))).arg(
275 // Show the file dialog
276 const QString file_name = QFileDialog::getSaveFileName(
277 this, tr("Save File"), dir, filter);
279 if (file_name.isEmpty())
282 const QString abs_path = QFileInfo(file_name).absolutePath();
283 settings.setValue(SettingSaveDirectory, abs_path);
285 // Show the options dialog
286 map<string, Glib::VariantBase> options;
287 if (!format->options().empty()) {
288 dialogs::InputOutputOptions dlg(
289 tr("Export %1").arg(QString::fromStdString(
290 format->description())),
291 format->options(), this);
294 options = dlg.options();
297 StoreProgress *dlg = new StoreProgress(file_name, format, options,
298 sample_range, session_, this);
302 void MainWindow::import_file(shared_ptr<InputFormat> format)
307 const QString dir = settings.value(SettingOpenDirectory).toString();
309 // Construct the filter
310 const vector<string> exts = format->extensions();
311 const QString filter = exts.empty() ? "" :
312 tr("%1 files (*.%2)").arg(
313 QString::fromStdString(format->description())).arg(
314 QString::fromStdString(join(exts, ", *.")));
316 // Show the file dialog
317 const QString file_name = QFileDialog::getOpenFileName(
318 this, tr("Import File"), dir, tr(
319 "%1 files (*.*);;All Files (*.*)").arg(
320 QString::fromStdString(format->description())));
322 if (file_name.isEmpty())
325 // Show the options dialog
326 map<string, Glib::VariantBase> options;
327 if (!format->options().empty()) {
328 dialogs::InputOutputOptions dlg(
329 tr("Import %1").arg(QString::fromStdString(
330 format->description())),
331 format->options(), this);
334 options = dlg.options();
337 load_file(file_name, format, options);
339 const QString abs_path = QFileInfo(file_name).absolutePath();
340 settings.setValue(SettingOpenDirectory, abs_path);
343 void MainWindow::setup_ui()
345 setObjectName(QString::fromUtf8("MainWindow"));
347 // Set the window icon
349 icon.addFile(QString(":/icons/sigrok-logo-notext.svg"));
352 // Setup the central widget
353 central_widget_ = new QWidget(this);
354 vertical_layout_ = new QVBoxLayout(central_widget_);
355 vertical_layout_->setSpacing(6);
356 vertical_layout_->setContentsMargins(0, 0, 0, 0);
357 setCentralWidget(central_widget_);
359 view_ = new pv::view::View(session_, this);
361 vertical_layout_->addWidget(view_);
363 // Setup the menu bar
364 pv::widgets::HidingMenuBar *const menu_bar =
365 new pv::widgets::HidingMenuBar(this);
368 QMenu *const menu_file = new QMenu;
369 menu_file->setTitle(tr("&File"));
371 action_open_->setText(tr("&Open..."));
372 action_open_->setIcon(QIcon::fromTheme("document-open",
373 QIcon(":/icons/document-open.png")));
374 action_open_->setShortcut(QKeySequence(Qt::CTRL + Qt::Key_O));
375 action_open_->setObjectName(QString::fromUtf8("actionOpen"));
376 menu_file->addAction(action_open_);
378 action_save_as_->setText(tr("&Save As..."));
379 action_save_as_->setIcon(QIcon::fromTheme("document-save-as",
380 QIcon(":/icons/document-save-as.png")));
381 action_save_as_->setShortcut(QKeySequence(Qt::CTRL + Qt::Key_S));
382 action_save_as_->setObjectName(QString::fromUtf8("actionSaveAs"));
383 menu_file->addAction(action_save_as_);
385 action_save_selection_as_->setText(tr("Save Selected &Range As..."));
386 action_save_selection_as_->setIcon(QIcon::fromTheme("document-save-as",
387 QIcon(":/icons/document-save-as.png")));
388 action_save_selection_as_->setShortcut(QKeySequence(Qt::CTRL + Qt::Key_R));
389 action_save_selection_as_->setObjectName(QString::fromUtf8("actionSaveSelectionAs"));
390 menu_file->addAction(action_save_selection_as_);
392 menu_file->addSeparator();
394 widgets::ExportMenu *menu_file_export = new widgets::ExportMenu(this,
395 device_manager_.context());
396 menu_file_export->setTitle(tr("&Export"));
397 connect(menu_file_export,
398 SIGNAL(format_selected(std::shared_ptr<sigrok::OutputFormat>)),
399 this, SLOT(export_file(std::shared_ptr<sigrok::OutputFormat>)));
400 menu_file->addAction(menu_file_export->menuAction());
402 widgets::ImportMenu *menu_file_import = new widgets::ImportMenu(this,
403 device_manager_.context());
404 menu_file_import->setTitle(tr("&Import"));
405 connect(menu_file_import,
406 SIGNAL(format_selected(std::shared_ptr<sigrok::InputFormat>)),
407 this, SLOT(import_file(std::shared_ptr<sigrok::InputFormat>)));
408 menu_file->addAction(menu_file_import->menuAction());
410 menu_file->addSeparator();
412 action_connect_->setText(tr("&Connect to Device..."));
413 action_connect_->setObjectName(QString::fromUtf8("actionConnect"));
414 menu_file->addAction(action_connect_);
416 menu_file->addSeparator();
418 action_quit_->setText(tr("&Quit"));
419 action_quit_->setIcon(QIcon::fromTheme("application-exit",
420 QIcon(":/icons/application-exit.png")));
421 action_quit_->setShortcut(QKeySequence(Qt::CTRL + Qt::Key_Q));
422 action_quit_->setObjectName(QString::fromUtf8("actionQuit"));
423 menu_file->addAction(action_quit_);
426 QMenu *menu_view = new QMenu;
427 menu_view->setTitle(tr("&View"));
429 action_view_zoom_in_->setText(tr("Zoom &In"));
430 action_view_zoom_in_->setIcon(QIcon::fromTheme("zoom-in",
431 QIcon(":/icons/zoom-in.png")));
432 // simply using Qt::Key_Plus shows no + in the menu
433 action_view_zoom_in_->setShortcut(QKeySequence::ZoomIn);
434 action_view_zoom_in_->setObjectName(
435 QString::fromUtf8("actionViewZoomIn"));
436 menu_view->addAction(action_view_zoom_in_);
438 action_view_zoom_out_->setText(tr("Zoom &Out"));
439 action_view_zoom_out_->setIcon(QIcon::fromTheme("zoom-out",
440 QIcon(":/icons/zoom-out.png")));
441 action_view_zoom_out_->setShortcut(QKeySequence::ZoomOut);
442 action_view_zoom_out_->setObjectName(
443 QString::fromUtf8("actionViewZoomOut"));
444 menu_view->addAction(action_view_zoom_out_);
446 action_view_zoom_fit_->setCheckable(true);
447 action_view_zoom_fit_->setText(tr("Zoom to &Fit"));
448 action_view_zoom_fit_->setIcon(QIcon::fromTheme("zoom-fit",
449 QIcon(":/icons/zoom-fit.png")));
450 action_view_zoom_fit_->setShortcut(QKeySequence(Qt::Key_F));
451 action_view_zoom_fit_->setObjectName(
452 QString::fromUtf8("actionViewZoomFit"));
453 menu_view->addAction(action_view_zoom_fit_);
455 action_view_zoom_one_to_one_->setText(tr("Zoom to O&ne-to-One"));
456 action_view_zoom_one_to_one_->setIcon(QIcon::fromTheme("zoom-original",
457 QIcon(":/icons/zoom-original.png")));
458 action_view_zoom_one_to_one_->setShortcut(QKeySequence(Qt::Key_O));
459 action_view_zoom_one_to_one_->setObjectName(
460 QString::fromUtf8("actionViewZoomOneToOne"));
461 menu_view->addAction(action_view_zoom_one_to_one_);
463 menu_file->addSeparator();
465 action_view_sticky_scrolling_->setCheckable(true);
466 action_view_sticky_scrolling_->setChecked(true);
467 action_view_sticky_scrolling_->setShortcut(QKeySequence(Qt::Key_S));
468 action_view_sticky_scrolling_->setObjectName(
469 QString::fromUtf8("actionViewStickyScrolling"));
470 action_view_sticky_scrolling_->setText(tr("&Sticky Scrolling"));
471 menu_view->addAction(action_view_sticky_scrolling_);
473 view_->enable_sticky_scrolling(action_view_sticky_scrolling_->isChecked());
475 menu_view->addSeparator();
477 action_view_show_cursors_->setCheckable(true);
478 action_view_show_cursors_->setChecked(view_->cursors_shown());
479 action_view_show_cursors_->setIcon(QIcon::fromTheme("show-cursors",
480 QIcon(":/icons/show-cursors.svg")));
481 action_view_show_cursors_->setShortcut(QKeySequence(Qt::Key_C));
482 action_view_show_cursors_->setObjectName(
483 QString::fromUtf8("actionViewShowCursors"));
484 action_view_show_cursors_->setText(tr("Show &Cursors"));
485 menu_view->addAction(action_view_show_cursors_);
489 QMenu *const menu_decoders = new QMenu;
490 menu_decoders->setTitle(tr("&Decoders"));
492 menu_decoders_add_->setTitle(tr("&Add"));
493 connect(menu_decoders_add_, SIGNAL(decoder_selected(srd_decoder*)),
494 this, SLOT(add_decoder(srd_decoder*)));
496 menu_decoders->addMenu(menu_decoders_add_);
500 QMenu *const menu_help = new QMenu;
501 menu_help->setTitle(tr("&Help"));
503 action_about_->setObjectName(QString::fromUtf8("actionAbout"));
504 action_about_->setText(tr("&About..."));
505 menu_help->addAction(action_about_);
507 menu_bar->addAction(menu_file->menuAction());
508 menu_bar->addAction(menu_view->menuAction());
510 menu_bar->addAction(menu_decoders->menuAction());
512 menu_bar->addAction(menu_help->menuAction());
514 setMenuBar(menu_bar);
515 QMetaObject::connectSlotsByName(this);
517 // Also add all actions to the main window for always-enabled hotkeys
518 for (QAction* action : menu_bar->actions())
519 this->addAction(action);
522 main_bar_ = new toolbars::MainBar(session_, *this);
524 // Populate the device list and select the initially selected device
525 update_device_list();
527 addToolBar(main_bar_);
530 setWindowTitle(tr("PulseView"));
532 // Setup session_ events
533 connect(&session_, SIGNAL(capture_state_changed(int)), this,
534 SLOT(capture_state_changed(int)));
535 connect(&session_, SIGNAL(device_selected()), this,
536 SLOT(device_selected()));
537 connect(&session_, SIGNAL(trigger_event(util::Timestamp)), view_,
538 SLOT(trigger_event(util::Timestamp)));
540 // Setup view_ events
541 connect(view_, SIGNAL(sticky_scrolling_changed(bool)), this,
542 SLOT(sticky_scrolling_changed(bool)));
543 connect(view_, SIGNAL(always_zoom_to_fit_changed(bool)), this,
544 SLOT(always_zoom_to_fit_changed(bool)));
548 void MainWindow::select_init_device() {
550 map<string, string> dev_info;
551 list<string> key_list;
553 // Re-select last used device if possible.
554 settings.beginGroup("Device");
555 key_list.push_back("vendor");
556 key_list.push_back("model");
557 key_list.push_back("version");
558 key_list.push_back("serial_num");
559 key_list.push_back("connection_id");
561 for (string key : key_list) {
562 const QString k = QString::fromStdString(key);
563 if (!settings.contains(k))
566 const string value = settings.value(k).toString().toStdString();
568 dev_info.insert(std::make_pair(key, value));
571 const shared_ptr<devices::HardwareDevice> device =
572 device_manager_.find_device_from_info(dev_info);
573 select_device(device);
574 update_device_list();
579 void MainWindow::load_init_file(const std::string &file_name,
580 const std::string &format) {
581 shared_ptr<InputFormat> input_format;
583 if (!format.empty()) {
584 const map<string, shared_ptr<InputFormat> > formats =
585 device_manager_.context()->input_formats();
586 const auto iter = find_if(formats.begin(), formats.end(),
587 [&](const pair<string, shared_ptr<InputFormat> > f) {
588 return f.first == format; });
589 if (iter == formats.end()) {
590 cerr << "Unexpected input format: " << format << endl;
594 input_format = (*iter).second;
597 load_file(QString::fromStdString(file_name), input_format);
601 void MainWindow::save_ui_settings()
605 map<string, string> dev_info;
606 list<string> key_list;
608 settings.beginGroup("MainWindow");
609 settings.setValue("state", saveState());
610 settings.setValue("geometry", saveGeometry());
613 if (session_.device()) {
614 settings.beginGroup("Device");
615 key_list.push_back("vendor");
616 key_list.push_back("model");
617 key_list.push_back("version");
618 key_list.push_back("serial_num");
619 key_list.push_back("connection_id");
621 dev_info = device_manager_.get_device_info(
624 for (string key : key_list) {
626 if (dev_info.count(key))
627 settings.setValue(QString::fromUtf8(key.c_str()),
628 QString::fromUtf8(dev_info.at(key).c_str()));
630 settings.remove(QString::fromUtf8(key.c_str()));
637 void MainWindow::restore_ui_settings()
641 settings.beginGroup("MainWindow");
643 if (settings.contains("geometry")) {
644 restoreGeometry(settings.value("geometry").toByteArray());
645 restoreState(settings.value("state").toByteArray());
652 void MainWindow::session_error(
653 const QString text, const QString info_text)
655 QMetaObject::invokeMethod(this, "show_session_error",
656 Qt::QueuedConnection, Q_ARG(QString, text),
657 Q_ARG(QString, info_text));
660 void MainWindow::update_device_list()
662 main_bar_->update_device_list();
665 void MainWindow::load_file(QString file_name,
666 std::shared_ptr<sigrok::InputFormat> format,
667 const std::map<std::string, Glib::VariantBase> &options)
669 const QString errorMessage(
670 QString("Failed to load file %1").arg(file_name));
674 session_.set_device(shared_ptr<devices::Device>(
675 new devices::InputFile(
676 device_manager_.context(),
677 file_name.toStdString(),
680 session_.set_device(shared_ptr<devices::Device>(
681 new devices::SessionFile(
682 device_manager_.context(),
683 file_name.toStdString())));
685 show_session_error(tr("Failed to load ") + file_name, e.what());
686 session_.set_default_device();
687 update_device_list();
691 update_device_list();
693 session_.start_capture([&, errorMessage](QString infoMessage) {
694 session_error(errorMessage, infoMessage); });
697 void MainWindow::closeEvent(QCloseEvent *event)
703 void MainWindow::keyReleaseEvent(QKeyEvent *event)
705 if (event->key() == Qt::Key_Alt) {
706 menuBar()->setHidden(!menuBar()->isHidden());
707 menuBar()->setFocus();
709 QMainWindow::keyReleaseEvent(event);
712 void MainWindow::show_session_error(
713 const QString text, const QString info_text)
715 QMessageBox msg(this);
717 msg.setInformativeText(info_text);
718 msg.setStandardButtons(QMessageBox::Ok);
719 msg.setIcon(QMessageBox::Warning);
723 void MainWindow::on_actionOpen_triggered()
726 const QString dir = settings.value(SettingOpenDirectory).toString();
729 const QString file_name = QFileDialog::getOpenFileName(
730 this, tr("Open File"), dir, tr(
731 "Sigrok Sessions (*.sr);;"
734 if (!file_name.isEmpty()) {
735 load_file(file_name);
737 const QString abs_path = QFileInfo(file_name).absolutePath();
738 settings.setValue(SettingOpenDirectory, abs_path);
742 void MainWindow::on_actionSaveAs_triggered()
744 export_file(device_manager_.context()->output_formats()["srzip"]);
747 void MainWindow::on_actionSaveSelectionAs_triggered()
749 export_file(device_manager_.context()->output_formats()["srzip"], true);
752 void MainWindow::on_actionConnect_triggered()
754 // Stop any currently running capture session
755 session_.stop_capture();
757 dialogs::Connect dlg(this, device_manager_);
759 // If the user selected a device, select it in the device list. Select the
760 // current device otherwise.
762 select_device(dlg.get_selected_device());
764 update_device_list();
767 void MainWindow::on_actionQuit_triggered()
772 void MainWindow::on_actionViewZoomIn_triggered()
777 void MainWindow::on_actionViewZoomOut_triggered()
782 void MainWindow::on_actionViewZoomFit_triggered()
784 view_->zoom_fit(action_view_zoom_fit_->isChecked());
787 void MainWindow::on_actionViewZoomOneToOne_triggered()
789 view_->zoom_one_to_one();
792 void MainWindow::on_actionViewStickyScrolling_triggered()
794 view_->enable_sticky_scrolling(action_view_sticky_scrolling_->isChecked());
797 void MainWindow::on_actionViewShowCursors_triggered()
801 const bool show = !view_->cursors_shown();
803 view_->centre_cursors();
805 view_->show_cursors(show);
808 void MainWindow::on_actionAbout_triggered()
810 dialogs::About dlg(device_manager_.context(), this);
814 void MainWindow::sticky_scrolling_changed(bool state)
816 action_view_sticky_scrolling_->setChecked(state);
819 void MainWindow::always_zoom_to_fit_changed(bool state)
821 action_view_zoom_fit_->setChecked(state);
824 void MainWindow::add_decoder(srd_decoder *decoder)
828 session_.add_decoder(decoder);
834 void MainWindow::capture_state_changed(int state)
836 main_bar_->set_capture_state((pv::Session::capture_state)state);
839 void MainWindow::device_selected()
841 // Set the title to include the device/file name
842 const shared_ptr<devices::Device> device = session_.device();
846 const string display_name = device->display_name(device_manager_);
847 setWindowTitle(tr("%1 - PulseView").arg(display_name.c_str()));