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"
48 #include "devices/hardwaredevice.hpp"
49 #include "devices/inputfile.hpp"
50 #include "devices/sessionfile.hpp"
51 #include "dialogs/about.hpp"
52 #include "dialogs/connect.hpp"
53 #include "dialogs/inputoutputoptions.hpp"
54 #include "dialogs/storeprogress.hpp"
55 #include "toolbars/mainbar.hpp"
56 #include "view/logicsignal.hpp"
57 #include "view/view.hpp"
58 #include "widgets/exportmenu.hpp"
59 #include "widgets/importmenu.hpp"
61 #include "widgets/decodermenu.hpp"
63 #include "widgets/hidingmenubar.hpp"
69 #include <libsigrokcxx/libsigrokcxx.hpp>
76 using std::shared_ptr;
80 using boost::algorithm::join;
83 using sigrok::OutputFormat;
84 using sigrok::InputFormat;
92 const char *MainWindow::SettingOpenDirectory = "MainWindow/OpenDirectory";
93 const char *MainWindow::SettingSaveDirectory = "MainWindow/SaveDirectory";
95 MainWindow::MainWindow(DeviceManager &device_manager,
96 string open_file_name, string open_file_format,
99 device_manager_(device_manager),
100 session_(device_manager),
101 action_open_(new QAction(this)),
102 action_save_as_(new QAction(this)),
103 action_connect_(new QAction(this)),
104 action_quit_(new QAction(this)),
105 action_view_zoom_in_(new QAction(this)),
106 action_view_zoom_out_(new QAction(this)),
107 action_view_zoom_fit_(new QAction(this)),
108 action_view_zoom_one_to_one_(new QAction(this)),
109 action_view_show_cursors_(new QAction(this)),
110 action_about_(new QAction(this))
112 , menu_decoders_add_(new pv::widgets::DecoderMenu(this, true))
116 restore_ui_settings();
117 if (open_file_name.empty())
118 select_init_device();
120 load_init_file(open_file_name, open_file_format);
123 QAction* MainWindow::action_open() const
128 QAction* MainWindow::action_save_as() const
130 return action_save_as_;
133 QAction* MainWindow::action_connect() const
135 return action_connect_;
138 QAction* MainWindow::action_quit() const
143 QAction* MainWindow::action_view_zoom_in() const
145 return action_view_zoom_in_;
148 QAction* MainWindow::action_view_zoom_out() const
150 return action_view_zoom_out_;
153 QAction* MainWindow::action_view_zoom_fit() const
155 return action_view_zoom_fit_;
158 QAction* MainWindow::action_view_zoom_one_to_one() const
160 return action_view_zoom_one_to_one_;
163 QAction* MainWindow::action_view_show_cursors() const
165 return action_view_show_cursors_;
168 QAction* MainWindow::action_about() const
170 return action_about_;
174 QMenu* MainWindow::menu_decoder_add() const
176 return menu_decoders_add_;
180 void MainWindow::run_stop()
182 switch(session_.get_capture_state()) {
183 case Session::Stopped:
184 session_.start_capture([&](QString message) {
185 session_error("Capture failed", message); });
188 case Session::AwaitingTrigger:
189 case Session::Running:
190 session_.stop_capture();
195 void MainWindow::select_device(shared_ptr<devices::Device> device)
199 session_.set_device(device);
201 session_.set_default_device();
202 } catch(const QString &e) {
203 QMessageBox msg(this);
205 msg.setInformativeText(tr("Failed to Select Device"));
206 msg.setStandardButtons(QMessageBox::Ok);
207 msg.setIcon(QMessageBox::Warning);
212 void MainWindow::export_file(shared_ptr<OutputFormat> format)
214 using pv::dialogs::StoreProgress;
216 // Stop any currently running capture session
217 session_.stop_capture();
220 const QString dir = settings.value(SettingSaveDirectory).toString();
222 // Construct the filter
223 const vector<string> exts = format->extensions();
224 QString filter = tr("%1 files ").arg(
225 QString::fromStdString(format->description()));
230 filter += QString("(*.%1);;%2 (*.*)").arg(
231 QString::fromStdString(join(exts, ", *."))).arg(
234 // Show the file dialog
235 const QString file_name = QFileDialog::getSaveFileName(
236 this, tr("Save File"), dir, filter);
238 if (file_name.isEmpty())
241 const QString abs_path = QFileInfo(file_name).absolutePath();
242 settings.setValue(SettingSaveDirectory, abs_path);
244 // Show the options dialog
245 map<string, Glib::VariantBase> options;
246 if (!format->options().empty()) {
247 dialogs::InputOutputOptions dlg(
248 tr("Export %1").arg(QString::fromStdString(
249 format->description())),
250 format->options(), this);
253 options = dlg.options();
256 StoreProgress *dlg = new StoreProgress(file_name, format, options,
261 void MainWindow::import_file(shared_ptr<InputFormat> format)
266 const QString dir = settings.value(SettingOpenDirectory).toString();
268 // Construct the filter
269 const vector<string> exts = format->extensions();
270 const QString filter = exts.empty() ? "" :
271 tr("%1 files (*.%2)").arg(
272 QString::fromStdString(format->description())).arg(
273 QString::fromStdString(join(exts, ", *.")));
275 // Show the file dialog
276 const QString file_name = QFileDialog::getOpenFileName(
277 this, tr("Import File"), dir, tr(
278 "%1 files (*.*);;All Files (*.*)").arg(
279 QString::fromStdString(format->description())));
281 if (file_name.isEmpty())
284 // Show the options dialog
285 map<string, Glib::VariantBase> options;
286 if (!format->options().empty()) {
287 dialogs::InputOutputOptions dlg(
288 tr("Import %1").arg(QString::fromStdString(
289 format->description())),
290 format->options(), this);
293 options = dlg.options();
296 load_file(file_name, format, options);
298 const QString abs_path = QFileInfo(file_name).absolutePath();
299 settings.setValue(SettingOpenDirectory, abs_path);
302 void MainWindow::setup_ui()
304 setObjectName(QString::fromUtf8("MainWindow"));
306 // Set the window icon
308 icon.addFile(QString(":/icons/sigrok-logo-notext.svg"));
311 // Setup the central widget
312 central_widget_ = new QWidget(this);
313 vertical_layout_ = new QVBoxLayout(central_widget_);
314 vertical_layout_->setSpacing(6);
315 vertical_layout_->setContentsMargins(0, 0, 0, 0);
316 setCentralWidget(central_widget_);
318 view_ = new pv::view::View(session_, this);
320 vertical_layout_->addWidget(view_);
322 // Setup the menu bar
323 pv::widgets::HidingMenuBar *const menu_bar =
324 new pv::widgets::HidingMenuBar(this);
327 QMenu *const menu_file = new QMenu;
328 menu_file->setTitle(tr("&File"));
330 action_open_->setText(tr("&Open..."));
331 action_open_->setIcon(QIcon::fromTheme("document-open",
332 QIcon(":/icons/document-open.png")));
333 action_open_->setShortcut(QKeySequence(Qt::CTRL + Qt::Key_O));
334 action_open_->setObjectName(QString::fromUtf8("actionOpen"));
335 menu_file->addAction(action_open_);
337 action_save_as_->setText(tr("&Save As..."));
338 action_save_as_->setIcon(QIcon::fromTheme("document-save-as",
339 QIcon(":/icons/document-save-as.png")));
340 action_save_as_->setShortcut(QKeySequence(Qt::CTRL + Qt::Key_S));
341 action_save_as_->setObjectName(QString::fromUtf8("actionSaveAs"));
342 menu_file->addAction(action_save_as_);
344 menu_file->addSeparator();
346 widgets::ExportMenu *menu_file_export = new widgets::ExportMenu(this,
347 device_manager_.context());
348 menu_file_export->setTitle(tr("&Export"));
349 connect(menu_file_export,
350 SIGNAL(format_selected(std::shared_ptr<sigrok::OutputFormat>)),
351 this, SLOT(export_file(std::shared_ptr<sigrok::OutputFormat>)));
352 menu_file->addAction(menu_file_export->menuAction());
354 widgets::ImportMenu *menu_file_import = new widgets::ImportMenu(this,
355 device_manager_.context());
356 menu_file_import->setTitle(tr("&Import"));
357 connect(menu_file_import,
358 SIGNAL(format_selected(std::shared_ptr<sigrok::InputFormat>)),
359 this, SLOT(import_file(std::shared_ptr<sigrok::InputFormat>)));
360 menu_file->addAction(menu_file_import->menuAction());
362 menu_file->addSeparator();
364 action_connect_->setText(tr("&Connect to Device..."));
365 action_connect_->setObjectName(QString::fromUtf8("actionConnect"));
366 menu_file->addAction(action_connect_);
368 menu_file->addSeparator();
370 action_quit_->setText(tr("&Quit"));
371 action_quit_->setIcon(QIcon::fromTheme("application-exit",
372 QIcon(":/icons/application-exit.png")));
373 action_quit_->setShortcut(QKeySequence(Qt::CTRL + Qt::Key_Q));
374 action_quit_->setObjectName(QString::fromUtf8("actionQuit"));
375 menu_file->addAction(action_quit_);
378 QMenu *menu_view = new QMenu;
379 menu_view->setTitle(tr("&View"));
381 action_view_zoom_in_->setText(tr("Zoom &In"));
382 action_view_zoom_in_->setIcon(QIcon::fromTheme("zoom-in",
383 QIcon(":/icons/zoom-in.png")));
384 // simply using Qt::Key_Plus shows no + in the menu
385 action_view_zoom_in_->setShortcut(QKeySequence::ZoomIn);
386 action_view_zoom_in_->setObjectName(
387 QString::fromUtf8("actionViewZoomIn"));
388 menu_view->addAction(action_view_zoom_in_);
390 action_view_zoom_out_->setText(tr("Zoom &Out"));
391 action_view_zoom_out_->setIcon(QIcon::fromTheme("zoom-out",
392 QIcon(":/icons/zoom-out.png")));
393 action_view_zoom_out_->setShortcut(QKeySequence::ZoomOut);
394 action_view_zoom_out_->setObjectName(
395 QString::fromUtf8("actionViewZoomOut"));
396 menu_view->addAction(action_view_zoom_out_);
398 action_view_zoom_fit_->setText(tr("Zoom to &Fit"));
399 action_view_zoom_fit_->setIcon(QIcon::fromTheme("zoom-fit",
400 QIcon(":/icons/zoom-fit.png")));
401 action_view_zoom_fit_->setShortcut(QKeySequence(Qt::Key_F));
402 action_view_zoom_fit_->setObjectName(
403 QString::fromUtf8("actionViewZoomFit"));
404 menu_view->addAction(action_view_zoom_fit_);
406 action_view_zoom_one_to_one_->setText(tr("Zoom to O&ne-to-One"));
407 action_view_zoom_one_to_one_->setIcon(QIcon::fromTheme("zoom-original",
408 QIcon(":/icons/zoom-original.png")));
409 action_view_zoom_one_to_one_->setShortcut(QKeySequence(Qt::Key_O));
410 action_view_zoom_one_to_one_->setObjectName(
411 QString::fromUtf8("actionViewZoomOneToOne"));
412 menu_view->addAction(action_view_zoom_one_to_one_);
414 menu_view->addSeparator();
416 action_view_show_cursors_->setCheckable(true);
417 action_view_show_cursors_->setChecked(view_->cursors_shown());
418 action_view_show_cursors_->setIcon(QIcon::fromTheme("show-cursors",
419 QIcon(":/icons/show-cursors.svg")));
420 action_view_show_cursors_->setShortcut(QKeySequence(Qt::Key_C));
421 action_view_show_cursors_->setObjectName(
422 QString::fromUtf8("actionViewShowCursors"));
423 action_view_show_cursors_->setText(tr("Show &Cursors"));
424 menu_view->addAction(action_view_show_cursors_);
428 QMenu *const menu_decoders = new QMenu;
429 menu_decoders->setTitle(tr("&Decoders"));
431 menu_decoders_add_->setTitle(tr("&Add"));
432 connect(menu_decoders_add_, SIGNAL(decoder_selected(srd_decoder*)),
433 this, SLOT(add_decoder(srd_decoder*)));
435 menu_decoders->addMenu(menu_decoders_add_);
439 QMenu *const menu_help = new QMenu;
440 menu_help->setTitle(tr("&Help"));
442 action_about_->setObjectName(QString::fromUtf8("actionAbout"));
443 action_about_->setText(tr("&About..."));
444 menu_help->addAction(action_about_);
446 menu_bar->addAction(menu_file->menuAction());
447 menu_bar->addAction(menu_view->menuAction());
449 menu_bar->addAction(menu_decoders->menuAction());
451 menu_bar->addAction(menu_help->menuAction());
453 setMenuBar(menu_bar);
454 QMetaObject::connectSlotsByName(this);
456 // Also add all actions to the main window for always-enabled hotkeys
457 for (QAction* action : menu_bar->actions())
458 this->addAction(action);
461 main_bar_ = new toolbars::MainBar(session_, *this);
463 // Populate the device list and select the initially selected device
464 update_device_list();
466 addToolBar(main_bar_);
469 setWindowTitle(tr("PulseView"));
471 // Setup session_ events
472 connect(&session_, SIGNAL(capture_state_changed(int)), this,
473 SLOT(capture_state_changed(int)));
474 connect(&session_, SIGNAL(device_selected()), this,
475 SLOT(device_selected()));
478 void MainWindow::select_init_device() {
480 map<string, string> dev_info;
481 list<string> key_list;
483 // Re-select last used device if possible.
484 settings.beginGroup("Device");
485 key_list.push_back("vendor");
486 key_list.push_back("model");
487 key_list.push_back("version");
488 key_list.push_back("serial_num");
489 key_list.push_back("connection_id");
491 for (string key : key_list) {
492 const QString k = QString::fromStdString(key);
493 if (!settings.contains(k))
496 const string value = settings.value(k).toString().toStdString();
498 dev_info.insert(std::make_pair(key, value));
501 const shared_ptr<devices::HardwareDevice> device =
502 device_manager_.find_device_from_info(dev_info);
503 select_device(device);
504 update_device_list();
509 void MainWindow::load_init_file(const std::string &file_name,
510 const std::string &format) {
511 shared_ptr<InputFormat> input_format;
513 if (!format.empty()) {
514 const map<string, shared_ptr<InputFormat> > formats =
515 device_manager_.context()->input_formats();
516 const auto iter = find_if(formats.begin(), formats.end(),
517 [&](const pair<string, shared_ptr<InputFormat> > f) {
518 return f.first == format; });
519 if (iter == formats.end()) {
520 cerr << "Unexpected input format: " << format << endl;
524 input_format = (*iter).second;
527 load_file(QString::fromStdString(file_name), input_format);
531 void MainWindow::save_ui_settings()
535 map<string, string> dev_info;
536 list<string> key_list;
538 settings.beginGroup("MainWindow");
539 settings.setValue("state", saveState());
540 settings.setValue("geometry", saveGeometry());
543 if (session_.device()) {
544 settings.beginGroup("Device");
545 key_list.push_back("vendor");
546 key_list.push_back("model");
547 key_list.push_back("version");
548 key_list.push_back("serial_num");
549 key_list.push_back("connection_id");
551 dev_info = device_manager_.get_device_info(
554 for (string key : key_list) {
556 if (dev_info.count(key))
557 settings.setValue(QString::fromUtf8(key.c_str()),
558 QString::fromUtf8(dev_info.at(key).c_str()));
560 settings.remove(QString::fromUtf8(key.c_str()));
567 void MainWindow::restore_ui_settings()
571 settings.beginGroup("MainWindow");
573 if (settings.contains("geometry")) {
574 restoreGeometry(settings.value("geometry").toByteArray());
575 restoreState(settings.value("state").toByteArray());
582 void MainWindow::session_error(
583 const QString text, const QString info_text)
585 QMetaObject::invokeMethod(this, "show_session_error",
586 Qt::QueuedConnection, Q_ARG(QString, text),
587 Q_ARG(QString, info_text));
590 void MainWindow::update_device_list()
592 main_bar_->update_device_list();
595 void MainWindow::load_file(QString file_name,
596 std::shared_ptr<sigrok::InputFormat> format,
597 const std::map<std::string, Glib::VariantBase> &options)
599 const QString errorMessage(
600 QString("Failed to load file %1").arg(file_name));
601 const QString infoMessage;
605 session_.set_device(shared_ptr<devices::Device>(
606 new devices::InputFile(
607 device_manager_.context(),
608 file_name.toStdString(),
611 session_.set_device(shared_ptr<devices::Device>(
612 new devices::SessionFile(
613 device_manager_.context(),
614 file_name.toStdString())));
616 show_session_error(tr("Failed to load ") + file_name, e.what());
617 session_.set_default_device();
618 update_device_list();
622 update_device_list();
624 session_.start_capture([&, errorMessage, infoMessage](QString) {
625 session_error(errorMessage, infoMessage); });
628 void MainWindow::closeEvent(QCloseEvent *event)
634 void MainWindow::keyReleaseEvent(QKeyEvent *event)
636 if (event->key() == Qt::Key_Alt) {
637 menuBar()->setHidden(!menuBar()->isHidden());
638 menuBar()->setFocus();
640 QMainWindow::keyReleaseEvent(event);
643 void MainWindow::show_session_error(
644 const QString text, const QString info_text)
646 QMessageBox msg(this);
648 msg.setInformativeText(info_text);
649 msg.setStandardButtons(QMessageBox::Ok);
650 msg.setIcon(QMessageBox::Warning);
654 void MainWindow::on_actionOpen_triggered()
657 const QString dir = settings.value(SettingOpenDirectory).toString();
660 const QString file_name = QFileDialog::getOpenFileName(
661 this, tr("Open File"), dir, tr(
662 "Sigrok Sessions (*.sr);;"
665 if (!file_name.isEmpty()) {
666 load_file(file_name);
668 const QString abs_path = QFileInfo(file_name).absolutePath();
669 settings.setValue(SettingOpenDirectory, abs_path);
673 void MainWindow::on_actionSaveAs_triggered()
675 export_file(device_manager_.context()->output_formats()["srzip"]);
678 void MainWindow::on_actionConnect_triggered()
680 // Stop any currently running capture session
681 session_.stop_capture();
683 dialogs::Connect dlg(this, device_manager_);
685 // If the user selected a device, select it in the device list. Select the
686 // current device otherwise.
688 select_device(dlg.get_selected_device());
690 update_device_list();
693 void MainWindow::on_actionQuit_triggered()
698 void MainWindow::on_actionViewZoomIn_triggered()
703 void MainWindow::on_actionViewZoomOut_triggered()
708 void MainWindow::on_actionViewZoomFit_triggered()
713 void MainWindow::on_actionViewZoomOneToOne_triggered()
715 view_->zoom_one_to_one();
718 void MainWindow::on_actionViewShowCursors_triggered()
722 const bool show = !view_->cursors_shown();
724 view_->centre_cursors();
726 view_->show_cursors(show);
729 void MainWindow::on_actionAbout_triggered()
731 dialogs::About dlg(device_manager_.context(), this);
735 void MainWindow::add_decoder(srd_decoder *decoder)
739 session_.add_decoder(decoder);
745 void MainWindow::capture_state_changed(int state)
747 main_bar_->set_capture_state((pv::Session::capture_state)state);
750 void MainWindow::device_selected()
752 // Set the title to include the device/file name
753 const shared_ptr<devices::Device> device = session_.device();
757 const string display_name = device->display_name(device_manager_);
758 setWindowTitle(tr("%1 - PulseView").arg(display_name.c_str()));