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/>.
23 #include <libsigrokdecode/libsigrokdecode.h>
30 #include <QApplication>
31 #include <QCloseEvent>
32 #include <QDockWidget>
33 #include <QHBoxLayout>
34 #include <QMessageBox>
39 #include "mainwindow.hpp"
41 #include "devicemanager.hpp"
42 #include "globalsettings.hpp"
44 #include "devices/hardwaredevice.hpp"
45 #include "dialogs/about.hpp"
46 #include "dialogs/settings.hpp"
47 #include "toolbars/mainbar.hpp"
48 #include "view/view.hpp"
49 #include "views/trace/standardbar.hpp"
53 #include <libsigrokcxx/libsigrokcxx.hpp>
55 using std::dynamic_pointer_cast;
57 using std::make_shared;
59 using std::shared_ptr;
68 using toolbars::MainBar;
71 using std::placeholders::_1;
73 const QString MainWindow::WindowTitle = tr("PulseView");
75 MainWindow::MainWindow(DeviceManager &device_manager,
76 string open_file_name, string open_file_format,
79 device_manager_(device_manager),
80 session_selector_(this),
81 session_state_mapper_(this),
82 action_about_(new QAction(this)),
83 icon_red_(":/icons/status-red.svg"),
84 icon_green_(":/icons/status-green.svg"),
85 icon_grey_(":/icons/status-grey.svg")
87 qRegisterMetaType<util::Timestamp>("util::Timestamp");
88 qRegisterMetaType<uint64_t>("uint64_t");
90 GlobalSettings::register_change_handler(GlobalSettings::Key_View_ColouredBG,
91 bind(&MainWindow::on_settingViewColouredBg_changed, this, _1));
94 restore_ui_settings();
96 if (!open_file_name.empty()) {
97 shared_ptr<Session> session = add_session();
98 session->load_init_file(open_file_name, open_file_format);
101 // Add empty default session if there aren't any sessions
102 if (sessions_.size() == 0) {
103 shared_ptr<Session> session = add_session();
105 map<string, string> dev_info;
106 shared_ptr<devices::HardwareDevice> other_device, demo_device;
108 // Use any available device that's not demo
109 for (shared_ptr<devices::HardwareDevice> dev : device_manager_.devices()) {
110 if (dev->hardware_device()->driver()->name() == "demo") {
117 // ...and if there isn't any, just use demo then
118 session->select_device(other_device ? other_device : demo_device);
122 MainWindow::~MainWindow()
124 while (!sessions_.empty())
125 remove_session(sessions_.front());
128 QAction* MainWindow::action_about() const
130 return action_about_;
133 shared_ptr<views::ViewBase> MainWindow::get_active_view() const
135 // If there's only one view, use it...
136 if (view_docks_.size() == 1)
137 return view_docks_.begin()->second;
139 // ...otherwise find the dock widget the widget with focus is contained in
140 QObject *w = QApplication::focusWidget();
141 QDockWidget *dock = 0;
144 dock = qobject_cast<QDockWidget*>(w);
150 // Get the view contained in the dock widget
151 for (auto entry : view_docks_)
152 if (entry.first == dock)
158 shared_ptr<views::ViewBase> MainWindow::add_view(const QString &title,
159 views::ViewType type, Session &session)
161 GlobalSettings settings;
162 shared_ptr<views::ViewBase> v;
164 QMainWindow *main_window = nullptr;
165 for (auto entry : session_windows_)
166 if (entry.first.get() == &session)
167 main_window = entry.second;
171 QDockWidget* dock = new QDockWidget(title, main_window);
172 dock->setObjectName(title);
173 main_window->addDockWidget(Qt::TopDockWidgetArea, dock);
175 // Insert a QMainWindow into the dock widget to allow for a tool bar
176 QMainWindow *dock_main = new QMainWindow(dock);
177 dock_main->setWindowFlags(Qt::Widget); // Remove Qt::Window flag
179 if (type == views::ViewTypeTrace)
180 v = make_shared<views::TraceView::View>(session, 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->setFeatures(QDockWidget::DockWidgetMovable |
192 QDockWidget::DockWidgetFloatable | QDockWidget::DockWidgetClosable);
194 QAbstractButton *close_btn =
195 dock->findChildren<QAbstractButton*>
196 ("qt_dockwidget_closebutton").front();
198 connect(close_btn, SIGNAL(clicked(bool)),
199 this, SLOT(on_view_close_clicked()));
201 connect(&session, SIGNAL(trigger_event(util::Timestamp)),
202 qobject_cast<views::ViewBase*>(v.get()),
203 SLOT(trigger_event(util::Timestamp)));
205 if (type == views::ViewTypeTrace) {
206 views::TraceView::View *tv =
207 qobject_cast<views::TraceView::View*>(v.get());
209 tv->enable_sticky_scrolling(true);
210 tv->enable_coloured_bg(settings.value(GlobalSettings::Key_View_ColouredBG).toBool());
212 shared_ptr<MainBar> main_bar = session.main_bar();
214 /* Initial view, create the main bar */
215 main_bar = make_shared<MainBar>(session, this, tv);
216 dock_main->addToolBar(main_bar.get());
217 session.set_main_bar(main_bar);
219 connect(main_bar.get(), SIGNAL(new_view(Session*)),
220 this, SLOT(on_new_view(Session*)));
222 main_bar->action_view_show_cursors()->setChecked(tv->cursors_shown());
224 /* For the main view we need to prevent the dock widget from
225 * closing itself when its close button is clicked. This is
226 * so we can confirm with the user first. Regular views don't
228 close_btn->disconnect(SIGNAL(clicked()), dock, SLOT(close()));
230 /* Additional view, create a standard bar */
231 pv::views::trace::StandardBar *standard_bar =
232 new pv::views::trace::StandardBar(session, this, tv);
233 dock_main->addToolBar(standard_bar);
235 standard_bar->action_view_show_cursors()->setChecked(tv->cursors_shown());
242 void MainWindow::remove_view(shared_ptr<views::ViewBase> view)
244 for (shared_ptr<Session> session : sessions_) {
245 if (!session->has_view(view))
248 // Find the dock the view is contained in and remove it
249 for (auto entry : view_docks_)
250 if (entry.second == view) {
251 // Remove the view from the session
252 session->deregister_view(view);
254 // Remove the view from its parent; otherwise, Qt will
255 // call deleteLater() on it, which causes a double free
256 // since the shared_ptr in view_docks_ doesn't know
257 // that Qt keeps a pointer to the view around
260 // Delete the view's dock widget and all widgets inside it
261 entry.first->deleteLater();
263 // Remove the dock widget from the list and stop iterating
264 view_docks_.erase(entry.first);
270 shared_ptr<Session> MainWindow::add_session()
272 static int last_session_id = 1;
273 QString name = tr("Session %1").arg(last_session_id++);
275 shared_ptr<Session> session = make_shared<Session>(device_manager_, name);
277 connect(session.get(), SIGNAL(add_view(const QString&, views::ViewType, Session*)),
278 this, SLOT(on_add_view(const QString&, views::ViewType, Session*)));
279 connect(session.get(), SIGNAL(name_changed()),
280 this, SLOT(on_session_name_changed()));
281 session_state_mapper_.setMapping(session.get(), session.get());
282 connect(session.get(), SIGNAL(capture_state_changed(int)),
283 &session_state_mapper_, SLOT(map()));
285 sessions_.push_back(session);
287 QMainWindow *window = new QMainWindow();
288 window->setWindowFlags(Qt::Widget); // Remove Qt::Window flag
289 session_windows_[session] = window;
291 int index = session_selector_.addTab(window, name);
292 session_selector_.setCurrentIndex(index);
293 last_focused_session_ = session;
295 window->setDockNestingEnabled(true);
297 shared_ptr<views::ViewBase> main_view =
298 add_view(name, views::ViewTypeTrace, *session);
303 void MainWindow::remove_session(shared_ptr<Session> session)
305 int h = new_session_button_->height();
307 for (shared_ptr<views::ViewBase> view : session->views())
310 QMainWindow *window = session_windows_.at(session);
311 session_selector_.removeTab(session_selector_.indexOf(window));
313 session_windows_.erase(session);
315 if (last_focused_session_ == session)
316 last_focused_session_.reset();
318 sessions_.remove_if([&](shared_ptr<Session> s) {
319 return s == session; });
321 if (sessions_.empty()) {
322 // When there are no more tabs, the height of the QTabWidget
323 // drops to zero. We must prevent this to keep the static
325 for (QWidget *w : static_tab_widget_->findChildren<QWidget*>())
326 w->setMinimumHeight(h);
328 int margin = static_tab_widget_->layout()->contentsMargins().bottom();
329 static_tab_widget_->setMinimumHeight(h + 2 * margin);
330 session_selector_.setMinimumHeight(h + 2 * margin);
332 // Update the window title if there is no view left to
333 // generate focus change events
334 setWindowTitle(WindowTitle);
338 void MainWindow::setup_ui()
340 setObjectName(QString::fromUtf8("MainWindow"));
342 setCentralWidget(&session_selector_);
344 // Set the window icon
346 icon.addFile(QString(":/icons/sigrok-logo-notext.png"));
349 view_sticky_scrolling_shortcut_ = new QShortcut(QKeySequence(Qt::Key_S), this, SLOT(on_view_sticky_scrolling_shortcut()));
350 view_sticky_scrolling_shortcut_->setAutoRepeat(false);
352 view_coloured_bg_shortcut_ = new QShortcut(QKeySequence(Qt::Key_B), this, SLOT(on_view_coloured_bg_shortcut()));
353 view_coloured_bg_shortcut_->setAutoRepeat(false);
355 action_about_->setObjectName(QString::fromUtf8("actionAbout"));
356 action_about_->setToolTip(tr("&About..."));
358 // Set up the tab area
359 new_session_button_ = new QToolButton();
360 new_session_button_->setIcon(QIcon::fromTheme("document-new",
361 QIcon(":/icons/document-new.png")));
362 new_session_button_->setToolTip(tr("Create New Session"));
363 new_session_button_->setAutoRaise(true);
365 run_stop_button_ = new QToolButton();
366 run_stop_button_->setAutoRaise(true);
367 run_stop_button_->setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
368 run_stop_button_->setToolTip(tr("Start/Stop Acquisition"));
370 run_stop_shortcut_ = new QShortcut(QKeySequence(Qt::Key_Space), run_stop_button_, SLOT(click()));
371 run_stop_shortcut_->setAutoRepeat(false);
373 settings_button_ = new QToolButton();
374 settings_button_->setIcon(QIcon::fromTheme("configure",
375 QIcon(":/icons/configure.png")));
376 settings_button_->setToolTip(tr("Settings"));
377 settings_button_->setAutoRaise(true);
379 QFrame *separator1 = new QFrame();
380 separator1->setFrameStyle(QFrame::VLine | QFrame::Raised);
381 QFrame *separator2 = new QFrame();
382 separator2->setFrameStyle(QFrame::VLine | QFrame::Raised);
384 QHBoxLayout* layout = new QHBoxLayout();
385 layout->setContentsMargins(2, 2, 2, 2);
386 layout->addWidget(new_session_button_);
387 layout->addWidget(separator1);
388 layout->addWidget(run_stop_button_);
389 layout->addWidget(separator2);
390 layout->addWidget(settings_button_);
392 static_tab_widget_ = new QWidget();
393 static_tab_widget_->setLayout(layout);
395 session_selector_.setCornerWidget(static_tab_widget_, Qt::TopLeftCorner);
396 session_selector_.setTabsClosable(true);
398 close_application_shortcut_ = new QShortcut(QKeySequence(Qt::CTRL + Qt::Key_Q), this, SLOT(close()));
399 close_application_shortcut_->setAutoRepeat(false);
401 close_current_tab_shortcut_ = new QShortcut(QKeySequence(Qt::CTRL + Qt::Key_W), this, SLOT(on_close_current_tab()));
403 connect(new_session_button_, SIGNAL(clicked(bool)),
404 this, SLOT(on_new_session_clicked()));
405 connect(run_stop_button_, SIGNAL(clicked(bool)),
406 this, SLOT(on_run_stop_clicked()));
407 connect(&session_state_mapper_, SIGNAL(mapped(QObject*)),
408 this, SLOT(on_capture_state_changed(QObject*)));
409 connect(settings_button_, SIGNAL(clicked(bool)),
410 this, SLOT(on_settings_clicked()));
412 connect(&session_selector_, SIGNAL(tabCloseRequested(int)),
413 this, SLOT(on_tab_close_requested(int)));
414 connect(&session_selector_, SIGNAL(currentChanged(int)),
415 this, SLOT(on_tab_changed(int)));
418 connect(static_cast<QApplication *>(QCoreApplication::instance()),
419 SIGNAL(focusChanged(QWidget*, QWidget*)),
420 this, SLOT(on_focus_changed()));
423 void MainWindow::save_ui_settings()
428 settings.beginGroup("MainWindow");
429 settings.setValue("state", saveState());
430 settings.setValue("geometry", saveGeometry());
433 for (shared_ptr<Session> session : sessions_) {
434 // Ignore sessions using the demo device or no device at all
435 if (session->device()) {
436 shared_ptr<devices::HardwareDevice> device =
437 dynamic_pointer_cast< devices::HardwareDevice >
441 device->hardware_device()->driver()->name() == "demo")
444 settings.beginGroup("Session" + QString::number(id++));
445 settings.remove(""); // Remove all keys in this group
446 session->save_settings(settings);
451 settings.setValue("sessions", id);
454 void MainWindow::restore_ui_settings()
457 int i, session_count;
459 settings.beginGroup("MainWindow");
461 if (settings.contains("geometry")) {
462 restoreGeometry(settings.value("geometry").toByteArray());
463 restoreState(settings.value("state").toByteArray());
469 session_count = settings.value("sessions", 0).toInt();
471 for (i = 0; i < session_count; i++) {
472 settings.beginGroup("Session" + QString::number(i));
473 shared_ptr<Session> session = add_session();
474 session->restore_settings(settings);
479 std::shared_ptr<Session> MainWindow::get_tab_session(int index) const
481 // Find the session that belongs to the tab's main window
482 for (auto entry : session_windows_)
483 if (entry.second == session_selector_.widget(index))
489 void MainWindow::closeEvent(QCloseEvent *event)
491 bool data_saved = true;
493 for (auto entry : session_windows_)
494 if (!entry.first->data_saved())
497 if (!data_saved && (QMessageBox::question(this, tr("Confirmation"),
498 tr("There is unsaved data. Close anyway?"),
499 QMessageBox::Yes | QMessageBox::No) == QMessageBox::No)) {
507 QMenu* MainWindow::createPopupMenu()
512 bool MainWindow::restoreState(const QByteArray &state, int version)
517 // Do nothing. We don't want Qt to handle this, or else it
518 // will try to restore all the dock widgets and create havoc.
523 void MainWindow::session_error(const QString text, const QString info_text)
525 QMetaObject::invokeMethod(this, "show_session_error",
526 Qt::QueuedConnection, Q_ARG(QString, text),
527 Q_ARG(QString, info_text));
530 void MainWindow::show_session_error(const QString text, const QString info_text)
532 QMessageBox msg(this);
534 msg.setInformativeText(info_text);
535 msg.setStandardButtons(QMessageBox::Ok);
536 msg.setIcon(QMessageBox::Warning);
540 void MainWindow::on_add_view(const QString &title, views::ViewType type,
543 // We get a pointer and need a reference
544 for (std::shared_ptr<Session> s : sessions_)
545 if (s.get() == session)
546 add_view(title, type, *s);
549 void MainWindow::on_focus_changed()
551 shared_ptr<views::ViewBase> view = get_active_view();
554 for (shared_ptr<Session> session : sessions_) {
555 if (session->has_view(view)) {
556 if (session != last_focused_session_) {
557 // Activate correct tab if necessary
558 shared_ptr<Session> tab_session = get_tab_session(
559 session_selector_.currentIndex());
560 if (tab_session != session)
561 session_selector_.setCurrentWidget(
562 session_windows_.at(session));
564 on_focused_session_changed(session);
572 if (sessions_.empty())
573 setWindowTitle(WindowTitle);
576 void MainWindow::on_focused_session_changed(shared_ptr<Session> session)
578 last_focused_session_ = session;
580 setWindowTitle(session->name() + " - " + WindowTitle);
582 // Update the state of the run/stop button, too
583 on_capture_state_changed(session.get());
586 void MainWindow::on_new_session_clicked()
591 void MainWindow::on_run_stop_clicked()
593 shared_ptr<Session> session = last_focused_session_;
598 switch (session->get_capture_state()) {
599 case Session::Stopped:
600 session->start_capture([&](QString message) {
601 session_error("Capture failed", message); });
603 case Session::AwaitingTrigger:
604 case Session::Running:
605 session->stop_capture();
610 void MainWindow::on_settings_clicked()
612 dialogs::Settings dlg;
616 void MainWindow::on_session_name_changed()
618 // Update the corresponding dock widget's name(s)
619 Session *session = qobject_cast<Session*>(QObject::sender());
622 for (shared_ptr<views::ViewBase> view : session->views()) {
623 // Get the dock that contains the view
624 for (auto entry : view_docks_)
625 if (entry.second == view) {
626 entry.first->setObjectName(session->name());
627 entry.first->setWindowTitle(session->name());
631 // Update the tab widget by finding the main window and the tab from that
632 for (auto entry : session_windows_)
633 if (entry.first.get() == session) {
634 QMainWindow *window = entry.second;
635 const int index = session_selector_.indexOf(window);
636 session_selector_.setTabText(index, session->name());
639 // Refresh window title if the affected session has focus
640 if (session == last_focused_session_.get())
641 setWindowTitle(session->name() + " - " + WindowTitle);
644 void MainWindow::on_capture_state_changed(QObject *obj)
646 Session *caller = qobject_cast<Session*>(obj);
648 // Ignore if caller is not the currently focused session
649 // unless there is only one session
650 if ((sessions_.size() > 1) && (caller != last_focused_session_.get()))
653 int state = caller->get_capture_state();
655 const QIcon *icons[] = {&icon_grey_, &icon_red_, &icon_green_};
656 run_stop_button_->setIcon(*icons[state]);
657 run_stop_button_->setText((state == pv::Session::Stopped) ?
658 tr("Run") : tr("Stop"));
661 void MainWindow::on_new_view(Session *session)
663 // We get a pointer and need a reference
664 for (std::shared_ptr<Session> s : sessions_)
665 if (s.get() == session)
666 add_view(session->name(), views::ViewTypeTrace, *s);
669 void MainWindow::on_view_close_clicked()
671 // Find the dock widget that contains the close button that was clicked
672 QObject *w = QObject::sender();
673 QDockWidget *dock = 0;
676 dock = qobject_cast<QDockWidget*>(w);
682 // Get the view contained in the dock widget
683 shared_ptr<views::ViewBase> view;
685 for (auto entry : view_docks_)
686 if (entry.first == dock)
689 // Deregister the view
690 for (shared_ptr<Session> session : sessions_) {
691 if (!session->has_view(view))
694 // Also destroy the entire session if its main view is closing...
695 if (view == session->main_view()) {
696 // ...but only if data is saved or the user confirms closing
697 if (session->data_saved() || (QMessageBox::question(this, tr("Confirmation"),
698 tr("This session contains unsaved data. Close it anyway?"),
699 QMessageBox::Yes | QMessageBox::No) == QMessageBox::Yes))
700 remove_session(session);
703 // All other views can be closed at any time as no data will be lost
708 void MainWindow::on_tab_changed(int index)
710 shared_ptr<Session> session = get_tab_session(index);
713 on_focused_session_changed(session);
716 void MainWindow::on_tab_close_requested(int index)
718 shared_ptr<Session> session = get_tab_session(index);
722 if (session->data_saved() || (QMessageBox::question(this, tr("Confirmation"),
723 tr("This session contains unsaved data. Close it anyway?"),
724 QMessageBox::Yes | QMessageBox::No) == QMessageBox::Yes))
725 remove_session(session);
728 void MainWindow::on_view_sticky_scrolling_shortcut()
730 shared_ptr<views::ViewBase> viewbase = get_active_view();
731 views::TraceView::View* view =
732 qobject_cast<views::TraceView::View*>(viewbase.get());
734 view->toggle_sticky_scrolling();
737 void MainWindow::on_view_coloured_bg_shortcut()
739 GlobalSettings settings;
741 bool state = settings.value(GlobalSettings::Key_View_ColouredBG).toBool();
742 settings.setValue(GlobalSettings::Key_View_ColouredBG, !state);
745 void MainWindow::on_settingViewColouredBg_changed(const QVariant new_value)
747 bool state = new_value.toBool();
749 for (auto entry : view_docks_) {
750 shared_ptr<views::ViewBase> viewbase = entry.second;
752 // Only trace views have this setting
753 views::TraceView::View* view =
754 qobject_cast<views::TraceView::View*>(viewbase.get());
756 view->enable_coloured_bg(state);
760 void MainWindow::on_actionAbout_triggered()
762 dialogs::About dlg(device_manager_.context(), this);
766 void MainWindow::on_close_current_tab()
768 int tab = session_selector_.currentIndex();
770 on_tab_close_requested(tab);