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 "globalsettings.hpp"
45 #include "devices/hardwaredevice.hpp"
46 #include "dialogs/settings.hpp"
47 #include "toolbars/mainbar.hpp"
48 #include "view/view.hpp"
49 #include "views/trace/standardbar.hpp"
51 #include <libsigrokcxx/libsigrokcxx.hpp>
53 using std::dynamic_pointer_cast;
55 using std::make_shared;
57 using std::shared_ptr;
66 using toolbars::MainBar;
69 using std::placeholders::_1;
71 const QString MainWindow::WindowTitle = tr("PulseView");
73 MainWindow::MainWindow(DeviceManager &device_manager,
74 string open_file_name, string open_file_format,
77 device_manager_(device_manager),
78 session_selector_(this),
79 session_state_mapper_(this),
80 icon_red_(":/icons/status-red.svg"),
81 icon_green_(":/icons/status-green.svg"),
82 icon_grey_(":/icons/status-grey.svg")
84 qRegisterMetaType<util::Timestamp>("util::Timestamp");
85 qRegisterMetaType<uint64_t>("uint64_t");
87 GlobalSettings::register_change_handler(GlobalSettings::Key_View_ColouredBG,
88 bind(&MainWindow::on_settingViewColouredBg_changed, this, _1));
89 GlobalSettings::register_change_handler(GlobalSettings::Key_View_StickyScrolling,
90 bind(&MainWindow::on_settingViewStickyScrolling_changed, this, _1));
93 restore_ui_settings();
95 if (!open_file_name.empty()) {
96 shared_ptr<Session> session = add_session();
97 session->load_init_file(open_file_name, open_file_format);
100 // Add empty default session if there aren't any sessions
101 if (sessions_.size() == 0) {
102 shared_ptr<Session> session = add_session();
104 map<string, string> dev_info;
105 shared_ptr<devices::HardwareDevice> other_device, demo_device;
107 // Use any available device that's not demo
108 for (shared_ptr<devices::HardwareDevice> dev : device_manager_.devices()) {
109 if (dev->hardware_device()->driver()->name() == "demo") {
116 // ...and if there isn't any, just use demo then
117 session->select_device(other_device ? other_device : demo_device);
121 MainWindow::~MainWindow()
123 while (!sessions_.empty())
124 remove_session(sessions_.front());
127 shared_ptr<views::ViewBase> MainWindow::get_active_view() const
129 // If there's only one view, use it...
130 if (view_docks_.size() == 1)
131 return view_docks_.begin()->second;
133 // ...otherwise find the dock widget the widget with focus is contained in
134 QObject *w = QApplication::focusWidget();
135 QDockWidget *dock = nullptr;
138 dock = qobject_cast<QDockWidget*>(w);
144 // Get the view contained in the dock widget
145 for (auto entry : view_docks_)
146 if (entry.first == dock)
152 shared_ptr<views::ViewBase> MainWindow::add_view(const QString &title,
153 views::ViewType type, Session &session)
155 GlobalSettings settings;
156 shared_ptr<views::ViewBase> v;
158 QMainWindow *main_window = nullptr;
159 for (auto entry : session_windows_)
160 if (entry.first.get() == &session)
161 main_window = entry.second;
165 shared_ptr<MainBar> main_bar = session.main_bar();
167 QDockWidget* dock = new QDockWidget(title, main_window);
168 dock->setObjectName(title);
169 main_window->addDockWidget(Qt::TopDockWidgetArea, dock);
171 // Insert a QMainWindow into the dock widget to allow for a tool bar
172 QMainWindow *dock_main = new QMainWindow(dock);
173 dock_main->setWindowFlags(Qt::Widget); // Remove Qt::Window flag
175 if (type == views::ViewTypeTrace)
176 // This view will be the main view if there's no main bar yet
177 v = make_shared<views::TraceView::View>(session,
178 (main_bar ? false : true), dock_main);
183 view_docks_[dock] = v;
184 session.register_view(v);
186 dock_main->setCentralWidget(v.get());
187 dock->setWidget(dock_main);
189 dock->setFeatures(QDockWidget::DockWidgetMovable |
190 QDockWidget::DockWidgetFloatable | QDockWidget::DockWidgetClosable);
192 QAbstractButton *close_btn =
193 dock->findChildren<QAbstractButton*>
194 ("qt_dockwidget_closebutton").front();
196 connect(close_btn, SIGNAL(clicked(bool)),
197 this, SLOT(on_view_close_clicked()));
199 connect(&session, SIGNAL(trigger_event(util::Timestamp)),
200 qobject_cast<views::ViewBase*>(v.get()),
201 SLOT(trigger_event(util::Timestamp)));
203 if (type == views::ViewTypeTrace) {
204 views::TraceView::View *tv =
205 qobject_cast<views::TraceView::View*>(v.get());
207 tv->enable_sticky_scrolling(true);
208 tv->enable_coloured_bg(settings.value(GlobalSettings::Key_View_ColouredBG).toBool());
211 /* Initial view, create the main bar */
212 main_bar = make_shared<MainBar>(session, this, tv);
213 dock_main->addToolBar(main_bar.get());
214 session.set_main_bar(main_bar);
216 connect(main_bar.get(), SIGNAL(new_view(Session*)),
217 this, SLOT(on_new_view(Session*)));
219 main_bar->action_view_show_cursors()->setChecked(tv->cursors_shown());
221 /* For the main view we need to prevent the dock widget from
222 * closing itself when its close button is clicked. This is
223 * so we can confirm with the user first. Regular views don't
225 close_btn->disconnect(SIGNAL(clicked()), dock, SLOT(close()));
227 /* Additional view, create a standard bar */
228 pv::views::trace::StandardBar *standard_bar =
229 new pv::views::trace::StandardBar(session, this, tv);
230 dock_main->addToolBar(standard_bar);
232 standard_bar->action_view_show_cursors()->setChecked(tv->cursors_shown());
239 void MainWindow::remove_view(shared_ptr<views::ViewBase> view)
241 for (shared_ptr<Session> session : sessions_) {
242 if (!session->has_view(view))
245 // Find the dock the view is contained in and remove it
246 for (auto entry : view_docks_)
247 if (entry.second == view) {
248 // Remove the view from the session
249 session->deregister_view(view);
251 // Remove the view from its parent; otherwise, Qt will
252 // call deleteLater() on it, which causes a double free
253 // since the shared_ptr in view_docks_ doesn't know
254 // that Qt keeps a pointer to the view around
255 view->setParent(nullptr);
257 // Delete the view's dock widget and all widgets inside it
258 entry.first->deleteLater();
260 // Remove the dock widget from the list and stop iterating
261 view_docks_.erase(entry.first);
267 shared_ptr<Session> MainWindow::add_session()
269 static int last_session_id = 1;
270 QString name = tr("Session %1").arg(last_session_id++);
272 shared_ptr<Session> session = make_shared<Session>(device_manager_, name);
274 connect(session.get(), SIGNAL(add_view(const QString&, views::ViewType, Session*)),
275 this, SLOT(on_add_view(const QString&, views::ViewType, Session*)));
276 connect(session.get(), SIGNAL(name_changed()),
277 this, SLOT(on_session_name_changed()));
278 session_state_mapper_.setMapping(session.get(), session.get());
279 connect(session.get(), SIGNAL(capture_state_changed(int)),
280 &session_state_mapper_, SLOT(map()));
282 sessions_.push_back(session);
284 QMainWindow *window = new QMainWindow();
285 window->setWindowFlags(Qt::Widget); // Remove Qt::Window flag
286 session_windows_[session] = window;
288 int index = session_selector_.addTab(window, name);
289 session_selector_.setCurrentIndex(index);
290 last_focused_session_ = session;
292 window->setDockNestingEnabled(true);
294 shared_ptr<views::ViewBase> main_view =
295 add_view(name, views::ViewTypeTrace, *session);
300 void MainWindow::remove_session(shared_ptr<Session> session)
302 int h = new_session_button_->height();
304 for (shared_ptr<views::ViewBase> view : session->views())
307 QMainWindow *window = session_windows_.at(session);
308 session_selector_.removeTab(session_selector_.indexOf(window));
310 session_windows_.erase(session);
312 if (last_focused_session_ == session)
313 last_focused_session_.reset();
315 sessions_.remove_if([&](shared_ptr<Session> s) {
316 return s == session; });
318 if (sessions_.empty()) {
319 // When there are no more tabs, the height of the QTabWidget
320 // drops to zero. We must prevent this to keep the static
322 for (QWidget *w : static_tab_widget_->findChildren<QWidget*>())
323 w->setMinimumHeight(h);
325 int margin = static_tab_widget_->layout()->contentsMargins().bottom();
326 static_tab_widget_->setMinimumHeight(h + 2 * margin);
327 session_selector_.setMinimumHeight(h + 2 * margin);
329 // Update the window title if there is no view left to
330 // generate focus change events
331 setWindowTitle(WindowTitle);
335 void MainWindow::setup_ui()
337 setObjectName(QString::fromUtf8("MainWindow"));
339 setCentralWidget(&session_selector_);
341 // Set the window icon
343 icon.addFile(QString(":/icons/sigrok-logo-notext.png"));
346 view_sticky_scrolling_shortcut_ = new QShortcut(QKeySequence(Qt::Key_S), this, SLOT(on_view_sticky_scrolling_shortcut()));
347 view_sticky_scrolling_shortcut_->setAutoRepeat(false);
349 view_coloured_bg_shortcut_ = new QShortcut(QKeySequence(Qt::Key_B), this, SLOT(on_view_coloured_bg_shortcut()));
350 view_coloured_bg_shortcut_->setAutoRepeat(false);
352 // Set up the tab area
353 new_session_button_ = new QToolButton();
354 new_session_button_->setIcon(QIcon::fromTheme("document-new",
355 QIcon(":/icons/document-new.png")));
356 new_session_button_->setToolTip(tr("Create New Session"));
357 new_session_button_->setAutoRaise(true);
359 run_stop_button_ = new QToolButton();
360 run_stop_button_->setAutoRaise(true);
361 run_stop_button_->setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
362 run_stop_button_->setToolTip(tr("Start/Stop Acquisition"));
364 run_stop_shortcut_ = new QShortcut(QKeySequence(Qt::Key_Space), run_stop_button_, SLOT(click()));
365 run_stop_shortcut_->setAutoRepeat(false);
367 settings_button_ = new QToolButton();
368 settings_button_->setIcon(QIcon::fromTheme("configure",
369 QIcon(":/icons/configure.png")));
370 settings_button_->setToolTip(tr("Settings"));
371 settings_button_->setAutoRaise(true);
373 QFrame *separator1 = new QFrame();
374 separator1->setFrameStyle(QFrame::VLine | QFrame::Raised);
375 QFrame *separator2 = new QFrame();
376 separator2->setFrameStyle(QFrame::VLine | QFrame::Raised);
378 QHBoxLayout* layout = new QHBoxLayout();
379 layout->setContentsMargins(2, 2, 2, 2);
380 layout->addWidget(new_session_button_);
381 layout->addWidget(separator1);
382 layout->addWidget(run_stop_button_);
383 layout->addWidget(separator2);
384 layout->addWidget(settings_button_);
386 static_tab_widget_ = new QWidget();
387 static_tab_widget_->setLayout(layout);
389 session_selector_.setCornerWidget(static_tab_widget_, Qt::TopLeftCorner);
390 session_selector_.setTabsClosable(true);
392 close_application_shortcut_ = new QShortcut(QKeySequence(Qt::CTRL + Qt::Key_Q), this, SLOT(close()));
393 close_application_shortcut_->setAutoRepeat(false);
395 close_current_tab_shortcut_ = new QShortcut(QKeySequence(Qt::CTRL + Qt::Key_W), this, SLOT(on_close_current_tab()));
397 connect(new_session_button_, SIGNAL(clicked(bool)),
398 this, SLOT(on_new_session_clicked()));
399 connect(run_stop_button_, SIGNAL(clicked(bool)),
400 this, SLOT(on_run_stop_clicked()));
401 connect(&session_state_mapper_, SIGNAL(mapped(QObject*)),
402 this, SLOT(on_capture_state_changed(QObject*)));
403 connect(settings_button_, SIGNAL(clicked(bool)),
404 this, SLOT(on_settings_clicked()));
406 connect(&session_selector_, SIGNAL(tabCloseRequested(int)),
407 this, SLOT(on_tab_close_requested(int)));
408 connect(&session_selector_, SIGNAL(currentChanged(int)),
409 this, SLOT(on_tab_changed(int)));
412 connect(static_cast<QApplication *>(QCoreApplication::instance()),
413 SIGNAL(focusChanged(QWidget*, QWidget*)),
414 this, SLOT(on_focus_changed()));
417 void MainWindow::save_ui_settings()
422 settings.beginGroup("MainWindow");
423 settings.setValue("state", saveState());
424 settings.setValue("geometry", saveGeometry());
427 for (shared_ptr<Session> session : sessions_) {
428 // Ignore sessions using the demo device or no device at all
429 if (session->device()) {
430 shared_ptr<devices::HardwareDevice> device =
431 dynamic_pointer_cast< devices::HardwareDevice >
435 device->hardware_device()->driver()->name() == "demo")
438 settings.beginGroup("Session" + QString::number(id++));
439 settings.remove(""); // Remove all keys in this group
440 session->save_settings(settings);
445 settings.setValue("sessions", id);
448 void MainWindow::restore_ui_settings()
451 int i, session_count;
453 settings.beginGroup("MainWindow");
455 if (settings.contains("geometry")) {
456 restoreGeometry(settings.value("geometry").toByteArray());
457 restoreState(settings.value("state").toByteArray());
463 session_count = settings.value("sessions", 0).toInt();
465 for (i = 0; i < session_count; i++) {
466 settings.beginGroup("Session" + QString::number(i));
467 shared_ptr<Session> session = add_session();
468 session->restore_settings(settings);
473 std::shared_ptr<Session> MainWindow::get_tab_session(int index) const
475 // Find the session that belongs to the tab's main window
476 for (auto entry : session_windows_)
477 if (entry.second == session_selector_.widget(index))
483 void MainWindow::closeEvent(QCloseEvent *event)
485 bool data_saved = true;
487 for (auto entry : session_windows_)
488 if (!entry.first->data_saved())
491 if (!data_saved && (QMessageBox::question(this, tr("Confirmation"),
492 tr("There is unsaved data. Close anyway?"),
493 QMessageBox::Yes | QMessageBox::No) == QMessageBox::No)) {
501 QMenu* MainWindow::createPopupMenu()
506 bool MainWindow::restoreState(const QByteArray &state, int version)
511 // Do nothing. We don't want Qt to handle this, or else it
512 // will try to restore all the dock widgets and create havoc.
517 void MainWindow::session_error(const QString text, const QString info_text)
519 QMetaObject::invokeMethod(this, "show_session_error",
520 Qt::QueuedConnection, Q_ARG(QString, text),
521 Q_ARG(QString, info_text));
524 void MainWindow::show_session_error(const QString text, const QString info_text)
526 QMessageBox msg(this);
528 msg.setInformativeText(info_text);
529 msg.setStandardButtons(QMessageBox::Ok);
530 msg.setIcon(QMessageBox::Warning);
534 void MainWindow::on_add_view(const QString &title, views::ViewType type,
537 // We get a pointer and need a reference
538 for (std::shared_ptr<Session> s : sessions_)
539 if (s.get() == session)
540 add_view(title, type, *s);
543 void MainWindow::on_focus_changed()
545 shared_ptr<views::ViewBase> view = get_active_view();
548 for (shared_ptr<Session> session : sessions_) {
549 if (session->has_view(view)) {
550 if (session != last_focused_session_) {
551 // Activate correct tab if necessary
552 shared_ptr<Session> tab_session = get_tab_session(
553 session_selector_.currentIndex());
554 if (tab_session != session)
555 session_selector_.setCurrentWidget(
556 session_windows_.at(session));
558 on_focused_session_changed(session);
566 if (sessions_.empty())
567 setWindowTitle(WindowTitle);
570 void MainWindow::on_focused_session_changed(shared_ptr<Session> session)
572 last_focused_session_ = session;
574 setWindowTitle(session->name() + " - " + WindowTitle);
576 // Update the state of the run/stop button, too
577 on_capture_state_changed(session.get());
580 void MainWindow::on_new_session_clicked()
585 void MainWindow::on_run_stop_clicked()
587 shared_ptr<Session> session = last_focused_session_;
592 switch (session->get_capture_state()) {
593 case Session::Stopped:
594 session->start_capture([&](QString message) {
595 session_error("Capture failed", message); });
597 case Session::AwaitingTrigger:
598 case Session::Running:
599 session->stop_capture();
604 void MainWindow::on_settings_clicked()
606 dialogs::Settings dlg(device_manager_);
610 void MainWindow::on_session_name_changed()
612 // Update the corresponding dock widget's name(s)
613 Session *session = qobject_cast<Session*>(QObject::sender());
616 for (shared_ptr<views::ViewBase> view : session->views()) {
617 // Get the dock that contains the view
618 for (auto entry : view_docks_)
619 if (entry.second == view) {
620 entry.first->setObjectName(session->name());
621 entry.first->setWindowTitle(session->name());
625 // Update the tab widget by finding the main window and the tab from that
626 for (auto entry : session_windows_)
627 if (entry.first.get() == session) {
628 QMainWindow *window = entry.second;
629 const int index = session_selector_.indexOf(window);
630 session_selector_.setTabText(index, session->name());
633 // Refresh window title if the affected session has focus
634 if (session == last_focused_session_.get())
635 setWindowTitle(session->name() + " - " + WindowTitle);
638 void MainWindow::on_capture_state_changed(QObject *obj)
640 Session *caller = qobject_cast<Session*>(obj);
642 // Ignore if caller is not the currently focused session
643 // unless there is only one session
644 if ((sessions_.size() > 1) && (caller != last_focused_session_.get()))
647 int state = caller->get_capture_state();
649 const QIcon *icons[] = {&icon_grey_, &icon_red_, &icon_green_};
650 run_stop_button_->setIcon(*icons[state]);
651 run_stop_button_->setText((state == pv::Session::Stopped) ?
652 tr("Run") : tr("Stop"));
655 void MainWindow::on_new_view(Session *session)
657 // We get a pointer and need a reference
658 for (std::shared_ptr<Session> s : sessions_)
659 if (s.get() == session)
660 add_view(session->name(), views::ViewTypeTrace, *s);
663 void MainWindow::on_view_close_clicked()
665 // Find the dock widget that contains the close button that was clicked
666 QObject *w = QObject::sender();
667 QDockWidget *dock = nullptr;
670 dock = qobject_cast<QDockWidget*>(w);
676 // Get the view contained in the dock widget
677 shared_ptr<views::ViewBase> view;
679 for (auto entry : view_docks_)
680 if (entry.first == dock)
683 // Deregister the view
684 for (shared_ptr<Session> session : sessions_) {
685 if (!session->has_view(view))
688 // Also destroy the entire session if its main view is closing...
689 if (view == session->main_view()) {
690 // ...but only if data is saved or the user confirms closing
691 if (session->data_saved() || (QMessageBox::question(this, tr("Confirmation"),
692 tr("This session contains unsaved data. Close it anyway?"),
693 QMessageBox::Yes | QMessageBox::No) == QMessageBox::Yes))
694 remove_session(session);
697 // All other views can be closed at any time as no data will be lost
702 void MainWindow::on_tab_changed(int index)
704 shared_ptr<Session> session = get_tab_session(index);
707 on_focused_session_changed(session);
710 void MainWindow::on_tab_close_requested(int index)
712 shared_ptr<Session> session = get_tab_session(index);
716 if (session->data_saved() || (QMessageBox::question(this, tr("Confirmation"),
717 tr("This session contains unsaved data. Close it anyway?"),
718 QMessageBox::Yes | QMessageBox::No) == QMessageBox::Yes))
719 remove_session(session);
722 void MainWindow::on_view_coloured_bg_shortcut()
724 GlobalSettings settings;
726 bool state = settings.value(GlobalSettings::Key_View_ColouredBG).toBool();
727 settings.setValue(GlobalSettings::Key_View_ColouredBG, !state);
730 void MainWindow::on_view_sticky_scrolling_shortcut()
732 GlobalSettings settings;
734 bool state = settings.value(GlobalSettings::Key_View_StickyScrolling).toBool();
735 settings.setValue(GlobalSettings::Key_View_StickyScrolling, !state);
738 void MainWindow::on_settingViewColouredBg_changed(const QVariant new_value)
740 bool state = new_value.toBool();
742 for (auto entry : view_docks_) {
743 shared_ptr<views::ViewBase> viewbase = entry.second;
745 // Only trace views have this setting
746 views::TraceView::View* view =
747 qobject_cast<views::TraceView::View*>(viewbase.get());
749 view->enable_coloured_bg(state);
753 void MainWindow::on_settingViewStickyScrolling_changed(const QVariant new_value)
755 bool state = new_value.toBool();
757 for (auto entry : view_docks_) {
758 shared_ptr<views::ViewBase> viewbase = entry.second;
760 // Only trace views have this setting
761 views::TraceView::View* view =
762 qobject_cast<views::TraceView::View*>(viewbase.get());
764 view->enable_sticky_scrolling(state);
768 void MainWindow::on_close_current_tab()
770 int tab = session_selector_.currentIndex();
772 on_tab_close_requested(tab);