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"
60 #include "widgets/decodermenu.hpp"
62 #include "widgets/hidingmenubar.hpp"
68 #include <libsigrokcxx/libsigrokcxx.hpp>
72 using std::shared_ptr;
76 using boost::algorithm::join;
79 using sigrok::OutputFormat;
80 using sigrok::InputFormat;
88 const char *MainWindow::SettingOpenDirectory = "MainWindow/OpenDirectory";
89 const char *MainWindow::SettingSaveDirectory = "MainWindow/SaveDirectory";
91 MainWindow::MainWindow(DeviceManager &device_manager,
92 const char *open_file_name,
95 device_manager_(device_manager),
96 session_(device_manager),
97 action_open_(new QAction(this)),
98 action_save_as_(new QAction(this)),
99 action_connect_(new QAction(this)),
100 action_quit_(new QAction(this)),
101 action_view_zoom_in_(new QAction(this)),
102 action_view_zoom_out_(new QAction(this)),
103 action_view_zoom_fit_(new QAction(this)),
104 action_view_zoom_one_to_one_(new QAction(this)),
105 action_view_show_cursors_(new QAction(this)),
106 action_about_(new QAction(this))
108 , menu_decoders_add_(new pv::widgets::DecoderMenu(this, true))
112 restore_ui_settings();
113 if (open_file_name) {
114 const QString s(QString::fromUtf8(open_file_name));
115 QMetaObject::invokeMethod(this, "load_file",
116 Qt::QueuedConnection,
121 QAction* MainWindow::action_open() const
126 QAction* MainWindow::action_save_as() const
128 return action_save_as_;
131 QAction* MainWindow::action_connect() const
133 return action_connect_;
136 QAction* MainWindow::action_quit() const
141 QAction* MainWindow::action_view_zoom_in() const
143 return action_view_zoom_in_;
146 QAction* MainWindow::action_view_zoom_out() const
148 return action_view_zoom_out_;
151 QAction* MainWindow::action_view_zoom_fit() const
153 return action_view_zoom_fit_;
156 QAction* MainWindow::action_view_zoom_one_to_one() const
158 return action_view_zoom_one_to_one_;
161 QAction* MainWindow::action_view_show_cursors() const
163 return action_view_show_cursors_;
166 QAction* MainWindow::action_about() const
168 return action_about_;
172 QMenu* MainWindow::menu_decoder_add() const
174 return menu_decoders_add_;
178 void MainWindow::run_stop()
180 switch(session_.get_capture_state()) {
181 case Session::Stopped:
182 session_.start_capture([&](QString message) {
183 session_error("Capture failed", message); });
186 case Session::AwaitingTrigger:
187 case Session::Running:
188 session_.stop_capture();
193 void MainWindow::select_device(shared_ptr<devices::Device> device)
196 session_.set_device(device);
197 } catch(const QString &e) {
198 QMessageBox msg(this);
200 msg.setInformativeText(tr("Failed to Select Device"));
201 msg.setStandardButtons(QMessageBox::Ok);
202 msg.setIcon(QMessageBox::Warning);
207 void MainWindow::export_file(shared_ptr<OutputFormat> format)
209 using pv::dialogs::StoreProgress;
211 // Stop any currently running capture session
212 session_.stop_capture();
215 const QString dir = settings.value(SettingSaveDirectory).toString();
217 // Construct the filter
218 const vector<string> exts = format->extensions();
219 QString filter = tr("%1 files ").arg(
220 QString::fromStdString(format->description()));
225 filter += QString("(*.%1);;%2 (*.*)").arg(
226 QString::fromStdString(join(exts, ", *."))).arg(
229 // Show the file dialog
230 const QString file_name = QFileDialog::getSaveFileName(
231 this, tr("Save File"), dir, filter);
233 if (file_name.isEmpty())
236 const QString abs_path = QFileInfo(file_name).absolutePath();
237 settings.setValue(SettingSaveDirectory, abs_path);
239 // Show the options dialog
240 map<string, Glib::VariantBase> options;
241 if (!format->options().empty()) {
242 dialogs::InputOutputOptions dlg(
243 tr("Export %1").arg(QString::fromStdString(
244 format->description())),
245 format->options(), this);
248 options = dlg.options();
251 StoreProgress *dlg = new StoreProgress(file_name, format, options,
256 void MainWindow::setup_ui()
258 setObjectName(QString::fromUtf8("MainWindow"));
260 // Set the window icon
262 icon.addFile(QString(":/icons/sigrok-logo-notext.svg"));
265 // Setup the central widget
266 central_widget_ = new QWidget(this);
267 vertical_layout_ = new QVBoxLayout(central_widget_);
268 vertical_layout_->setSpacing(6);
269 vertical_layout_->setContentsMargins(0, 0, 0, 0);
270 setCentralWidget(central_widget_);
272 view_ = new pv::view::View(session_, this);
274 vertical_layout_->addWidget(view_);
276 // Setup the menu bar
277 pv::widgets::HidingMenuBar *const menu_bar =
278 new pv::widgets::HidingMenuBar(this);
281 QMenu *const menu_file = new QMenu;
282 menu_file->setTitle(tr("&File"));
284 action_open_->setText(tr("&Open..."));
285 action_open_->setIcon(QIcon::fromTheme("document-open",
286 QIcon(":/icons/document-open.png")));
287 action_open_->setShortcut(QKeySequence(Qt::CTRL + Qt::Key_O));
288 action_open_->setObjectName(QString::fromUtf8("actionOpen"));
289 menu_file->addAction(action_open_);
291 action_save_as_->setText(tr("&Save As..."));
292 action_save_as_->setIcon(QIcon::fromTheme("document-save-as",
293 QIcon(":/icons/document-save-as.png")));
294 action_save_as_->setShortcut(QKeySequence(Qt::CTRL + Qt::Key_S));
295 action_save_as_->setObjectName(QString::fromUtf8("actionSaveAs"));
296 menu_file->addAction(action_save_as_);
298 menu_file->addSeparator();
300 widgets::ExportMenu *menu_file_export = new widgets::ExportMenu(this,
301 device_manager_.context());
302 menu_file_export->setTitle(tr("&Export"));
303 connect(menu_file_export,
304 SIGNAL(format_selected(std::shared_ptr<sigrok::OutputFormat>)),
305 this, SLOT(export_file(std::shared_ptr<sigrok::OutputFormat>)));
306 menu_file->addAction(menu_file_export->menuAction());
308 menu_file->addSeparator();
310 action_connect_->setText(tr("&Connect to Device..."));
311 action_connect_->setObjectName(QString::fromUtf8("actionConnect"));
312 menu_file->addAction(action_connect_);
314 menu_file->addSeparator();
316 action_quit_->setText(tr("&Quit"));
317 action_quit_->setIcon(QIcon::fromTheme("application-exit",
318 QIcon(":/icons/application-exit.png")));
319 action_quit_->setShortcut(QKeySequence(Qt::CTRL + Qt::Key_Q));
320 action_quit_->setObjectName(QString::fromUtf8("actionQuit"));
321 menu_file->addAction(action_quit_);
324 QMenu *menu_view = new QMenu;
325 menu_view->setTitle(tr("&View"));
327 action_view_zoom_in_->setText(tr("Zoom &In"));
328 action_view_zoom_in_->setIcon(QIcon::fromTheme("zoom-in",
329 QIcon(":/icons/zoom-in.png")));
330 // simply using Qt::Key_Plus shows no + in the menu
331 action_view_zoom_in_->setShortcut(QKeySequence::ZoomIn);
332 action_view_zoom_in_->setObjectName(
333 QString::fromUtf8("actionViewZoomIn"));
334 menu_view->addAction(action_view_zoom_in_);
336 action_view_zoom_out_->setText(tr("Zoom &Out"));
337 action_view_zoom_out_->setIcon(QIcon::fromTheme("zoom-out",
338 QIcon(":/icons/zoom-out.png")));
339 action_view_zoom_out_->setShortcut(QKeySequence::ZoomOut);
340 action_view_zoom_out_->setObjectName(
341 QString::fromUtf8("actionViewZoomOut"));
342 menu_view->addAction(action_view_zoom_out_);
344 action_view_zoom_fit_->setText(tr("Zoom to &Fit"));
345 action_view_zoom_fit_->setIcon(QIcon::fromTheme("zoom-fit",
346 QIcon(":/icons/zoom-fit.png")));
347 action_view_zoom_fit_->setShortcut(QKeySequence(Qt::Key_F));
348 action_view_zoom_fit_->setObjectName(
349 QString::fromUtf8("actionViewZoomFit"));
350 menu_view->addAction(action_view_zoom_fit_);
352 action_view_zoom_one_to_one_->setText(tr("Zoom to O&ne-to-One"));
353 action_view_zoom_one_to_one_->setIcon(QIcon::fromTheme("zoom-original",
354 QIcon(":/icons/zoom-original.png")));
355 action_view_zoom_one_to_one_->setShortcut(QKeySequence(Qt::Key_O));
356 action_view_zoom_one_to_one_->setObjectName(
357 QString::fromUtf8("actionViewZoomOneToOne"));
358 menu_view->addAction(action_view_zoom_one_to_one_);
360 menu_view->addSeparator();
362 action_view_show_cursors_->setCheckable(true);
363 action_view_show_cursors_->setChecked(view_->cursors_shown());
364 action_view_show_cursors_->setIcon(QIcon::fromTheme("show-cursors",
365 QIcon(":/icons/show-cursors.svg")));
366 action_view_show_cursors_->setShortcut(QKeySequence(Qt::Key_C));
367 action_view_show_cursors_->setObjectName(
368 QString::fromUtf8("actionViewShowCursors"));
369 action_view_show_cursors_->setText(tr("Show &Cursors"));
370 menu_view->addAction(action_view_show_cursors_);
374 QMenu *const menu_decoders = new QMenu;
375 menu_decoders->setTitle(tr("&Decoders"));
377 menu_decoders_add_->setTitle(tr("&Add"));
378 connect(menu_decoders_add_, SIGNAL(decoder_selected(srd_decoder*)),
379 this, SLOT(add_decoder(srd_decoder*)));
381 menu_decoders->addMenu(menu_decoders_add_);
385 QMenu *const menu_help = new QMenu;
386 menu_help->setTitle(tr("&Help"));
388 action_about_->setObjectName(QString::fromUtf8("actionAbout"));
389 action_about_->setText(tr("&About..."));
390 menu_help->addAction(action_about_);
392 menu_bar->addAction(menu_file->menuAction());
393 menu_bar->addAction(menu_view->menuAction());
395 menu_bar->addAction(menu_decoders->menuAction());
397 menu_bar->addAction(menu_help->menuAction());
399 setMenuBar(menu_bar);
400 QMetaObject::connectSlotsByName(this);
403 main_bar_ = new toolbars::MainBar(session_, *this);
405 // Populate the device list and select the initially selected device
406 update_device_list();
408 addToolBar(main_bar_);
411 setWindowTitle(tr("PulseView"));
413 // Setup session_ events
414 connect(&session_, SIGNAL(capture_state_changed(int)), this,
415 SLOT(capture_state_changed(int)));
416 connect(&session_, SIGNAL(device_selected()), this,
417 SLOT(device_selected()));
420 void MainWindow::save_ui_settings()
424 map<string, string> dev_info;
425 list<string> key_list;
427 settings.beginGroup("MainWindow");
428 settings.setValue("state", saveState());
429 settings.setValue("geometry", saveGeometry());
432 if (session_.device()) {
433 settings.beginGroup("Device");
434 key_list.push_back("vendor");
435 key_list.push_back("model");
436 key_list.push_back("version");
437 key_list.push_back("serial_num");
438 key_list.push_back("connection_id");
440 dev_info = device_manager_.get_device_info(
443 for (string key : key_list) {
445 if (dev_info.count(key))
446 settings.setValue(QString::fromUtf8(key.c_str()),
447 QString::fromUtf8(dev_info.at(key).c_str()));
449 settings.remove(QString::fromUtf8(key.c_str()));
456 void MainWindow::restore_ui_settings()
460 map<string, string> dev_info;
461 list<string> key_list;
464 settings.beginGroup("MainWindow");
466 if (settings.contains("geometry")) {
467 restoreGeometry(settings.value("geometry").toByteArray());
468 restoreState(settings.value("state").toByteArray());
474 // Re-select last used device if possible.
475 settings.beginGroup("Device");
476 key_list.push_back("vendor");
477 key_list.push_back("model");
478 key_list.push_back("version");
479 key_list.push_back("serial_num");
480 key_list.push_back("connection_id");
482 for (string key : key_list) {
483 if (!settings.contains(QString::fromUtf8(key.c_str())))
486 value = settings.value(QString::fromUtf8(key.c_str())).toString().toStdString();
488 if (value.size() > 0)
489 dev_info.insert(std::make_pair(key, value));
492 const shared_ptr<devices::HardwareDevice> device =
493 device_manager_.find_device_from_info(dev_info);
495 select_device(device);
496 update_device_list();
502 void MainWindow::session_error(
503 const QString text, const QString info_text)
505 QMetaObject::invokeMethod(this, "show_session_error",
506 Qt::QueuedConnection, Q_ARG(QString, text),
507 Q_ARG(QString, info_text));
510 void MainWindow::update_device_list()
512 main_bar_->update_device_list();
515 void MainWindow::closeEvent(QCloseEvent *event)
521 void MainWindow::keyReleaseEvent(QKeyEvent *event)
523 if (event->key() == Qt::Key_Alt) {
524 menuBar()->setHidden(!menuBar()->isHidden());
525 menuBar()->setFocus();
527 QMainWindow::keyReleaseEvent(event);
530 void MainWindow::load_file(QString file_name,
531 std::shared_ptr<sigrok::InputFormat> format,
532 const std::map<std::string, Glib::VariantBase> &options)
534 const QString errorMessage(
535 QString("Failed to load file %1").arg(file_name));
536 const QString infoMessage;
540 session_.set_device(shared_ptr<devices::Device>(
541 new devices::InputFile(
542 device_manager_.context(),
543 file_name.toStdString(),
546 session_.set_device(shared_ptr<devices::Device>(
547 new devices::SessionFile(
548 device_manager_.context(),
549 file_name.toStdString())));
551 show_session_error(tr("Failed to load ") + file_name, e.what());
552 session_.set_default_device();
553 update_device_list();
557 update_device_list();
559 session_.start_capture([&, errorMessage, infoMessage](QString) {
560 session_error(errorMessage, infoMessage); });
563 void MainWindow::show_session_error(
564 const QString text, const QString info_text)
566 QMessageBox msg(this);
568 msg.setInformativeText(info_text);
569 msg.setStandardButtons(QMessageBox::Ok);
570 msg.setIcon(QMessageBox::Warning);
574 void MainWindow::on_actionOpen_triggered()
577 const QString dir = settings.value(SettingOpenDirectory).toString();
580 const QString file_name = QFileDialog::getOpenFileName(
581 this, tr("Open File"), dir, tr(
582 "Sigrok Sessions (*.sr);;"
585 if (!file_name.isEmpty()) {
586 load_file(file_name);
588 const QString abs_path = QFileInfo(file_name).absolutePath();
589 settings.setValue(SettingOpenDirectory, abs_path);
593 void MainWindow::on_actionSaveAs_triggered()
595 export_file(device_manager_.context()->output_formats()["srzip"]);
598 void MainWindow::on_actionConnect_triggered()
600 // Stop any currently running capture session
601 session_.stop_capture();
603 dialogs::Connect dlg(this, device_manager_);
605 // If the user selected a device, select it in the device list. Select the
606 // current device otherwise.
608 select_device(dlg.get_selected_device());
610 update_device_list();
613 void MainWindow::on_actionQuit_triggered()
618 void MainWindow::on_actionViewZoomIn_triggered()
623 void MainWindow::on_actionViewZoomOut_triggered()
628 void MainWindow::on_actionViewZoomFit_triggered()
633 void MainWindow::on_actionViewZoomOneToOne_triggered()
635 view_->zoom_one_to_one();
638 void MainWindow::on_actionViewShowCursors_triggered()
642 const bool show = !view_->cursors_shown();
644 view_->centre_cursors();
646 view_->show_cursors(show);
649 void MainWindow::on_actionAbout_triggered()
651 dialogs::About dlg(device_manager_.context(), this);
655 void MainWindow::add_decoder(srd_decoder *decoder)
659 session_.add_decoder(decoder);
665 void MainWindow::capture_state_changed(int state)
667 main_bar_->set_capture_state((pv::Session::capture_state)state);
670 void MainWindow::device_selected()
672 // Set the title to include the device/file name
673 const shared_ptr<devices::Device> device = session_.device();
677 const string display_name = device->display_name(device_manager_);
678 setWindowTitle(tr("%1 - PulseView").arg(display_name.c_str()));