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, see <http://www.gnu.org/licenses/>.
21 #include <libsigrokdecode/libsigrokdecode.h>
31 #include <QApplication>
32 #include <QCloseEvent>
33 #include <QDockWidget>
34 #include <QHBoxLayout>
35 #include <QMessageBox>
40 #include "mainwindow.hpp"
42 #include "devicemanager.hpp"
43 #include "devices/hardwaredevice.hpp"
44 #include "dialogs/settings.hpp"
45 #include "globalsettings.hpp"
46 #include "toolbars/mainbar.hpp"
48 #include "view/view.hpp"
49 #include "views/trace/standardbar.hpp"
51 #include <libsigrokcxx/libsigrokcxx.hpp>
54 using std::dynamic_pointer_cast;
55 using std::make_shared;
57 using std::placeholders::_1;
58 using std::shared_ptr;
67 using toolbars::MainBar;
69 const QString MainWindow::WindowTitle = tr("PulseView");
71 MainWindow::MainWindow(DeviceManager &device_manager,
72 string open_file_name, string open_file_format,
75 device_manager_(device_manager),
76 session_selector_(this),
77 session_state_mapper_(this),
78 icon_red_(":/icons/status-red.svg"),
79 icon_green_(":/icons/status-green.svg"),
80 icon_grey_(":/icons/status-grey.svg")
82 qRegisterMetaType<util::Timestamp>("util::Timestamp");
83 qRegisterMetaType<uint64_t>("uint64_t");
85 GlobalSettings::register_change_handler(GlobalSettings::Key_View_ColouredBG,
86 bind(&MainWindow::on_settingViewColouredBg_changed, this, _1));
88 GlobalSettings::register_change_handler(GlobalSettings::Key_View_ShowSamplingPoints,
89 bind(&MainWindow::on_settingViewShowSamplingPoints_changed, this, _1));
91 GlobalSettings::register_change_handler(GlobalSettings::Key_View_ShowAnalogMinorGrid,
92 bind(&MainWindow::on_settingViewShowAnalogMinorGrid_changed, this, _1));
95 restore_ui_settings();
97 if (!open_file_name.empty()) {
98 shared_ptr<Session> session = add_session();
99 session->load_init_file(open_file_name, open_file_format);
102 // Add empty default session if there aren't any sessions
103 if (sessions_.size() == 0) {
104 shared_ptr<Session> session = add_session();
106 map<string, string> dev_info;
107 shared_ptr<devices::HardwareDevice> other_device, demo_device;
109 // Use any available device that's not demo
110 for (shared_ptr<devices::HardwareDevice> dev : device_manager_.devices()) {
111 if (dev->hardware_device()->driver()->name() == "demo") {
118 // ...and if there isn't any, just use demo then
119 session->select_device(other_device ? other_device : demo_device);
123 MainWindow::~MainWindow()
125 while (!sessions_.empty())
126 remove_session(sessions_.front());
129 shared_ptr<views::ViewBase> MainWindow::get_active_view() const
131 // If there's only one view, use it...
132 if (view_docks_.size() == 1)
133 return view_docks_.begin()->second;
135 // ...otherwise find the dock widget the widget with focus is contained in
136 QObject *w = QApplication::focusWidget();
137 QDockWidget *dock = nullptr;
140 dock = qobject_cast<QDockWidget*>(w);
146 // Get the view contained in the dock widget
147 for (auto entry : view_docks_)
148 if (entry.first == dock)
154 shared_ptr<views::ViewBase> MainWindow::add_view(const QString &title,
155 views::ViewType type, Session &session)
157 GlobalSettings settings;
158 shared_ptr<views::ViewBase> v;
160 QMainWindow *main_window = nullptr;
161 for (auto entry : session_windows_)
162 if (entry.first.get() == &session)
163 main_window = entry.second;
167 shared_ptr<MainBar> main_bar = session.main_bar();
169 QDockWidget* dock = new QDockWidget(title, main_window);
170 dock->setObjectName(title);
171 main_window->addDockWidget(Qt::TopDockWidgetArea, dock);
173 // Insert a QMainWindow into the dock widget to allow for a tool bar
174 QMainWindow *dock_main = new QMainWindow(dock);
175 dock_main->setWindowFlags(Qt::Widget); // Remove Qt::Window flag
177 if (type == views::ViewTypeTrace)
178 // This view will be the main view if there's no main bar yet
179 v = make_shared<views::TraceView::View>(session,
180 (main_bar ? false : true), dock_main);
185 view_docks_[dock] = v;
186 session.register_view(v);
188 dock_main->setCentralWidget(v.get());
189 dock->setWidget(dock_main);
191 dock->setContextMenuPolicy(Qt::PreventContextMenu);
192 dock->setFeatures(QDockWidget::DockWidgetMovable |
193 QDockWidget::DockWidgetFloatable | QDockWidget::DockWidgetClosable);
195 QAbstractButton *close_btn =
196 dock->findChildren<QAbstractButton*>
197 ("qt_dockwidget_closebutton").front();
199 connect(close_btn, SIGNAL(clicked(bool)),
200 this, SLOT(on_view_close_clicked()));
202 connect(&session, SIGNAL(trigger_event(util::Timestamp)),
203 qobject_cast<views::ViewBase*>(v.get()),
204 SLOT(trigger_event(util::Timestamp)));
206 if (type == views::ViewTypeTrace) {
207 views::TraceView::View *tv =
208 qobject_cast<views::TraceView::View*>(v.get());
210 tv->enable_coloured_bg(settings.value(GlobalSettings::Key_View_ColouredBG).toBool());
211 tv->enable_show_sampling_points(settings.value(GlobalSettings::Key_View_ShowSamplingPoints).toBool());
212 tv->enable_show_analog_minor_grid(settings.value(GlobalSettings::Key_View_ShowAnalogMinorGrid).toBool());
215 /* Initial view, create the main bar */
216 main_bar = make_shared<MainBar>(session, this, tv);
217 dock_main->addToolBar(main_bar.get());
218 session.set_main_bar(main_bar);
220 connect(main_bar.get(), SIGNAL(new_view(Session*)),
221 this, SLOT(on_new_view(Session*)));
223 main_bar->action_view_show_cursors()->setChecked(tv->cursors_shown());
225 /* For the main view we need to prevent the dock widget from
226 * closing itself when its close button is clicked. This is
227 * so we can confirm with the user first. Regular views don't
229 close_btn->disconnect(SIGNAL(clicked()), dock, SLOT(close()));
231 /* Additional view, create a standard bar */
232 pv::views::trace::StandardBar *standard_bar =
233 new pv::views::trace::StandardBar(session, this, tv);
234 dock_main->addToolBar(standard_bar);
236 standard_bar->action_view_show_cursors()->setChecked(tv->cursors_shown());
243 void MainWindow::remove_view(shared_ptr<views::ViewBase> view)
245 for (shared_ptr<Session> session : sessions_) {
246 if (!session->has_view(view))
249 // Find the dock the view is contained in and remove it
250 for (auto entry : view_docks_)
251 if (entry.second == view) {
252 // Remove the view from the session
253 session->deregister_view(view);
255 // Remove the view from its parent; otherwise, Qt will
256 // call deleteLater() on it, which causes a double free
257 // since the shared_ptr in view_docks_ doesn't know
258 // that Qt keeps a pointer to the view around
259 view->setParent(nullptr);
261 // Delete the view's dock widget and all widgets inside it
262 entry.first->deleteLater();
264 // Remove the dock widget from the list and stop iterating
265 view_docks_.erase(entry.first);
271 shared_ptr<Session> MainWindow::add_session()
273 static int last_session_id = 1;
274 QString name = tr("Session %1").arg(last_session_id++);
276 shared_ptr<Session> session = make_shared<Session>(device_manager_, name);
278 connect(session.get(), SIGNAL(add_view(const QString&, views::ViewType, Session*)),
279 this, SLOT(on_add_view(const QString&, views::ViewType, Session*)));
280 connect(session.get(), SIGNAL(name_changed()),
281 this, SLOT(on_session_name_changed()));
282 session_state_mapper_.setMapping(session.get(), session.get());
283 connect(session.get(), SIGNAL(capture_state_changed(int)),
284 &session_state_mapper_, SLOT(map()));
286 sessions_.push_back(session);
288 QMainWindow *window = new QMainWindow();
289 window->setWindowFlags(Qt::Widget); // Remove Qt::Window flag
290 session_windows_[session] = window;
292 int index = session_selector_.addTab(window, name);
293 session_selector_.setCurrentIndex(index);
294 last_focused_session_ = session;
296 window->setDockNestingEnabled(true);
298 shared_ptr<views::ViewBase> main_view =
299 add_view(name, views::ViewTypeTrace, *session);
304 void MainWindow::remove_session(shared_ptr<Session> session)
306 int h = new_session_button_->height();
308 for (shared_ptr<views::ViewBase> view : session->views())
311 QMainWindow *window = session_windows_.at(session);
312 session_selector_.removeTab(session_selector_.indexOf(window));
314 session_windows_.erase(session);
316 if (last_focused_session_ == session)
317 last_focused_session_.reset();
319 sessions_.remove_if([&](shared_ptr<Session> s) {
320 return s == session; });
322 if (sessions_.empty()) {
323 // When there are no more tabs, the height of the QTabWidget
324 // drops to zero. We must prevent this to keep the static
326 for (QWidget *w : static_tab_widget_->findChildren<QWidget*>())
327 w->setMinimumHeight(h);
329 int margin = static_tab_widget_->layout()->contentsMargins().bottom();
330 static_tab_widget_->setMinimumHeight(h + 2 * margin);
331 session_selector_.setMinimumHeight(h + 2 * margin);
333 // Update the window title if there is no view left to
334 // generate focus change events
335 setWindowTitle(WindowTitle);
339 void MainWindow::setup_ui()
341 setObjectName(QString::fromUtf8("MainWindow"));
343 setCentralWidget(&session_selector_);
345 // Set the window icon
347 icon.addFile(QString(":/icons/sigrok-logo-notext.png"));
350 view_sticky_scrolling_shortcut_ = new QShortcut(QKeySequence(Qt::Key_S), this, SLOT(on_view_sticky_scrolling_shortcut()));
351 view_sticky_scrolling_shortcut_->setAutoRepeat(false);
353 view_show_sampling_points_shortcut_ = new QShortcut(QKeySequence(Qt::Key_Period), this, SLOT(on_view_show_sampling_points_shortcut()));
354 view_show_sampling_points_shortcut_->setAutoRepeat(false);
356 view_show_analog_minor_grid_shortcut_ = new QShortcut(QKeySequence(Qt::Key_G), this, SLOT(on_view_show_analog_minor_grid_shortcut()));
357 view_show_analog_minor_grid_shortcut_->setAutoRepeat(false);
359 view_coloured_bg_shortcut_ = new QShortcut(QKeySequence(Qt::Key_B), this, SLOT(on_view_coloured_bg_shortcut()));
360 view_coloured_bg_shortcut_->setAutoRepeat(false);
362 // Set up the tab area
363 new_session_button_ = new QToolButton();
364 new_session_button_->setIcon(QIcon::fromTheme("document-new",
365 QIcon(":/icons/document-new.png")));
366 new_session_button_->setToolTip(tr("Create New Session"));
367 new_session_button_->setAutoRaise(true);
369 run_stop_button_ = new QToolButton();
370 run_stop_button_->setAutoRaise(true);
371 run_stop_button_->setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
372 run_stop_button_->setToolTip(tr("Start/Stop Acquisition"));
374 run_stop_shortcut_ = new QShortcut(QKeySequence(Qt::Key_Space), run_stop_button_, SLOT(click()));
375 run_stop_shortcut_->setAutoRepeat(false);
377 settings_button_ = new QToolButton();
378 settings_button_->setIcon(QIcon::fromTheme("preferences-system",
379 QIcon(":/icons/preferences-system.png")));
380 settings_button_->setToolTip(tr("Settings"));
381 settings_button_->setAutoRaise(true);
383 QFrame *separator1 = new QFrame();
384 separator1->setFrameStyle(QFrame::VLine | QFrame::Raised);
385 QFrame *separator2 = new QFrame();
386 separator2->setFrameStyle(QFrame::VLine | QFrame::Raised);
388 QHBoxLayout* layout = new QHBoxLayout();
389 layout->setContentsMargins(2, 2, 2, 2);
390 layout->addWidget(new_session_button_);
391 layout->addWidget(separator1);
392 layout->addWidget(run_stop_button_);
393 layout->addWidget(separator2);
394 layout->addWidget(settings_button_);
396 static_tab_widget_ = new QWidget();
397 static_tab_widget_->setLayout(layout);
399 session_selector_.setCornerWidget(static_tab_widget_, Qt::TopLeftCorner);
400 session_selector_.setTabsClosable(true);
402 close_application_shortcut_ = new QShortcut(QKeySequence(Qt::CTRL + Qt::Key_Q), this, SLOT(close()));
403 close_application_shortcut_->setAutoRepeat(false);
405 close_current_tab_shortcut_ = new QShortcut(QKeySequence(Qt::CTRL + Qt::Key_W), this, SLOT(on_close_current_tab()));
407 connect(new_session_button_, SIGNAL(clicked(bool)),
408 this, SLOT(on_new_session_clicked()));
409 connect(run_stop_button_, SIGNAL(clicked(bool)),
410 this, SLOT(on_run_stop_clicked()));
411 connect(&session_state_mapper_, SIGNAL(mapped(QObject*)),
412 this, SLOT(on_capture_state_changed(QObject*)));
413 connect(settings_button_, SIGNAL(clicked(bool)),
414 this, SLOT(on_settings_clicked()));
416 connect(&session_selector_, SIGNAL(tabCloseRequested(int)),
417 this, SLOT(on_tab_close_requested(int)));
418 connect(&session_selector_, SIGNAL(currentChanged(int)),
419 this, SLOT(on_tab_changed(int)));
422 connect(static_cast<QApplication *>(QCoreApplication::instance()),
423 SIGNAL(focusChanged(QWidget*, QWidget*)),
424 this, SLOT(on_focus_changed()));
427 void MainWindow::save_ui_settings()
432 settings.beginGroup("MainWindow");
433 settings.setValue("state", saveState());
434 settings.setValue("geometry", saveGeometry());
437 for (shared_ptr<Session> session : sessions_) {
438 // Ignore sessions using the demo device or no device at all
439 if (session->device()) {
440 shared_ptr<devices::HardwareDevice> device =
441 dynamic_pointer_cast< devices::HardwareDevice >
445 device->hardware_device()->driver()->name() == "demo")
448 settings.beginGroup("Session" + QString::number(id++));
449 settings.remove(""); // Remove all keys in this group
450 session->save_settings(settings);
455 settings.setValue("sessions", id);
458 void MainWindow::restore_ui_settings()
461 int i, session_count;
463 settings.beginGroup("MainWindow");
465 if (settings.contains("geometry")) {
466 restoreGeometry(settings.value("geometry").toByteArray());
467 restoreState(settings.value("state").toByteArray());
473 session_count = settings.value("sessions", 0).toInt();
475 for (i = 0; i < session_count; i++) {
476 settings.beginGroup("Session" + QString::number(i));
477 shared_ptr<Session> session = add_session();
478 session->restore_settings(settings);
483 shared_ptr<Session> MainWindow::get_tab_session(int index) const
485 // Find the session that belongs to the tab's main window
486 for (auto entry : session_windows_)
487 if (entry.second == session_selector_.widget(index))
493 void MainWindow::closeEvent(QCloseEvent *event)
495 bool data_saved = true;
497 for (auto entry : session_windows_)
498 if (!entry.first->data_saved())
501 if (!data_saved && (QMessageBox::question(this, tr("Confirmation"),
502 tr("There is unsaved data. Close anyway?"),
503 QMessageBox::Yes | QMessageBox::No) == QMessageBox::No)) {
511 QMenu* MainWindow::createPopupMenu()
516 bool MainWindow::restoreState(const QByteArray &state, int version)
521 // Do nothing. We don't want Qt to handle this, or else it
522 // will try to restore all the dock widgets and create havoc.
527 void MainWindow::session_error(const QString text, const QString info_text)
529 QMetaObject::invokeMethod(this, "show_session_error",
530 Qt::QueuedConnection, Q_ARG(QString, text),
531 Q_ARG(QString, info_text));
534 void MainWindow::show_session_error(const QString text, const QString info_text)
536 QMessageBox msg(this);
538 msg.setInformativeText(info_text);
539 msg.setStandardButtons(QMessageBox::Ok);
540 msg.setIcon(QMessageBox::Warning);
544 void MainWindow::on_add_view(const QString &title, views::ViewType type,
547 // We get a pointer and need a reference
548 for (shared_ptr<Session> s : sessions_)
549 if (s.get() == session)
550 add_view(title, type, *s);
553 void MainWindow::on_focus_changed()
555 shared_ptr<views::ViewBase> view = get_active_view();
558 for (shared_ptr<Session> session : sessions_) {
559 if (session->has_view(view)) {
560 if (session != last_focused_session_) {
561 // Activate correct tab if necessary
562 shared_ptr<Session> tab_session = get_tab_session(
563 session_selector_.currentIndex());
564 if (tab_session != session)
565 session_selector_.setCurrentWidget(
566 session_windows_.at(session));
568 on_focused_session_changed(session);
576 if (sessions_.empty())
577 setWindowTitle(WindowTitle);
580 void MainWindow::on_focused_session_changed(shared_ptr<Session> session)
582 last_focused_session_ = session;
584 setWindowTitle(session->name() + " - " + WindowTitle);
586 // Update the state of the run/stop button, too
587 on_capture_state_changed(session.get());
590 void MainWindow::on_new_session_clicked()
595 void MainWindow::on_run_stop_clicked()
597 shared_ptr<Session> session = last_focused_session_;
602 switch (session->get_capture_state()) {
603 case Session::Stopped:
604 session->start_capture([&](QString message) {
605 session_error("Capture failed", message); });
607 case Session::AwaitingTrigger:
608 case Session::Running:
609 session->stop_capture();
614 void MainWindow::on_settings_clicked()
616 dialogs::Settings dlg(device_manager_);
620 void MainWindow::on_session_name_changed()
622 // Update the corresponding dock widget's name(s)
623 Session *session = qobject_cast<Session*>(QObject::sender());
626 for (shared_ptr<views::ViewBase> view : session->views()) {
627 // Get the dock that contains the view
628 for (auto entry : view_docks_)
629 if (entry.second == view) {
630 entry.first->setObjectName(session->name());
631 entry.first->setWindowTitle(session->name());
635 // Update the tab widget by finding the main window and the tab from that
636 for (auto entry : session_windows_)
637 if (entry.first.get() == session) {
638 QMainWindow *window = entry.second;
639 const int index = session_selector_.indexOf(window);
640 session_selector_.setTabText(index, session->name());
643 // Refresh window title if the affected session has focus
644 if (session == last_focused_session_.get())
645 setWindowTitle(session->name() + " - " + WindowTitle);
648 void MainWindow::on_capture_state_changed(QObject *obj)
650 Session *caller = qobject_cast<Session*>(obj);
652 // Ignore if caller is not the currently focused session
653 // unless there is only one session
654 if ((sessions_.size() > 1) && (caller != last_focused_session_.get()))
657 int state = caller->get_capture_state();
659 const QIcon *icons[] = {&icon_grey_, &icon_red_, &icon_green_};
660 run_stop_button_->setIcon(*icons[state]);
661 run_stop_button_->setText((state == pv::Session::Stopped) ?
662 tr("Run") : tr("Stop"));
665 void MainWindow::on_new_view(Session *session)
667 // We get a pointer and need a reference
668 for (shared_ptr<Session> s : sessions_)
669 if (s.get() == session)
670 add_view(session->name(), views::ViewTypeTrace, *s);
673 void MainWindow::on_view_close_clicked()
675 // Find the dock widget that contains the close button that was clicked
676 QObject *w = QObject::sender();
677 QDockWidget *dock = nullptr;
680 dock = qobject_cast<QDockWidget*>(w);
686 // Get the view contained in the dock widget
687 shared_ptr<views::ViewBase> view;
689 for (auto entry : view_docks_)
690 if (entry.first == dock)
693 // Deregister the view
694 for (shared_ptr<Session> session : sessions_) {
695 if (!session->has_view(view))
698 // Also destroy the entire session if its main view is closing...
699 if (view == session->main_view()) {
700 // ...but only if data is saved or the user confirms closing
701 if (session->data_saved() || (QMessageBox::question(this, tr("Confirmation"),
702 tr("This session contains unsaved data. Close it anyway?"),
703 QMessageBox::Yes | QMessageBox::No) == QMessageBox::Yes))
704 remove_session(session);
707 // All other views can be closed at any time as no data will be lost
712 void MainWindow::on_tab_changed(int index)
714 shared_ptr<Session> session = get_tab_session(index);
717 on_focused_session_changed(session);
720 void MainWindow::on_tab_close_requested(int index)
722 shared_ptr<Session> session = get_tab_session(index);
726 if (session->data_saved() || (QMessageBox::question(this, tr("Confirmation"),
727 tr("This session contains unsaved data. Close it anyway?"),
728 QMessageBox::Yes | QMessageBox::No) == QMessageBox::Yes))
729 remove_session(session);
732 void MainWindow::on_view_coloured_bg_shortcut()
734 GlobalSettings settings;
736 bool state = settings.value(GlobalSettings::Key_View_ColouredBG).toBool();
737 settings.setValue(GlobalSettings::Key_View_ColouredBG, !state);
740 void MainWindow::on_view_sticky_scrolling_shortcut()
742 GlobalSettings settings;
744 bool state = settings.value(GlobalSettings::Key_View_StickyScrolling).toBool();
745 settings.setValue(GlobalSettings::Key_View_StickyScrolling, !state);
748 void MainWindow::on_view_show_sampling_points_shortcut()
750 GlobalSettings settings;
752 bool state = settings.value(GlobalSettings::Key_View_ShowSamplingPoints).toBool();
753 settings.setValue(GlobalSettings::Key_View_ShowSamplingPoints, !state);
756 void MainWindow::on_view_show_analog_minor_grid_shortcut()
758 GlobalSettings settings;
760 bool state = settings.value(GlobalSettings::Key_View_ShowAnalogMinorGrid).toBool();
761 settings.setValue(GlobalSettings::Key_View_ShowAnalogMinorGrid, !state);
764 void MainWindow::on_settingViewColouredBg_changed(const QVariant new_value)
766 bool state = new_value.toBool();
768 for (auto entry : view_docks_) {
769 shared_ptr<views::ViewBase> viewbase = entry.second;
771 // Only trace views have this setting
772 views::TraceView::View* view =
773 qobject_cast<views::TraceView::View*>(viewbase.get());
775 view->enable_coloured_bg(state);
779 void MainWindow::on_settingViewShowSamplingPoints_changed(const QVariant new_value)
781 bool state = new_value.toBool();
783 for (auto entry : view_docks_) {
784 shared_ptr<views::ViewBase> viewbase = entry.second;
786 // Only trace views have this setting
787 views::TraceView::View* view =
788 qobject_cast<views::TraceView::View*>(viewbase.get());
790 view->enable_show_sampling_points(state);
794 void MainWindow::on_settingViewShowAnalogMinorGrid_changed(const QVariant new_value)
796 bool state = new_value.toBool();
798 for (auto entry : view_docks_) {
799 shared_ptr<views::ViewBase> viewbase = entry.second;
801 // Only trace views have this setting
802 views::TraceView::View* view =
803 qobject_cast<views::TraceView::View*>(viewbase.get());
805 view->enable_show_analog_minor_grid(state);
809 void MainWindow::on_close_current_tab()
811 int tab = session_selector_.currentIndex();
813 on_tab_close_requested(tab);