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;
163 QMainWindow *main_window = nullptr;
164 for (auto entry : session_windows_)
165 if (entry.first.get() == &session)
166 main_window = entry.second;
170 if (type == views::ViewTypeTrace) {
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 shared_ptr<views::TraceView::View> v =
180 make_shared<views::TraceView::View>(session, dock_main);
181 view_docks_[dock] = v;
182 session.register_view(v);
184 dock_main->setCentralWidget(v.get());
185 dock->setWidget(dock_main);
187 dock->setFeatures(QDockWidget::DockWidgetMovable |
188 QDockWidget::DockWidgetFloatable | QDockWidget::DockWidgetClosable);
190 QAbstractButton *close_btn =
191 dock->findChildren<QAbstractButton*>
192 ("qt_dockwidget_closebutton").front();
194 connect(close_btn, SIGNAL(clicked(bool)),
195 this, SLOT(on_view_close_clicked()));
197 if (type == views::ViewTypeTrace) {
198 connect(&session, SIGNAL(trigger_event(util::Timestamp)),
199 qobject_cast<views::ViewBase*>(v.get()),
200 SLOT(trigger_event(util::Timestamp)));
202 v->enable_sticky_scrolling(true);
203 v->enable_coloured_bg(settings.value(GlobalSettings::Key_View_ColouredBG).toBool());
205 shared_ptr<MainBar> main_bar = session.main_bar();
207 /* Initial view, create the main bar */
208 main_bar = make_shared<MainBar>(session, this, v.get());
209 dock_main->addToolBar(main_bar.get());
210 session.set_main_bar(main_bar);
212 connect(main_bar.get(), SIGNAL(new_view(Session*)),
213 this, SLOT(on_new_view(Session*)));
215 main_bar->action_view_show_cursors()->setChecked(v->cursors_shown());
217 /* For the main view we need to prevent the dock widget from
218 * closing itself when its close button is clicked. This is
219 * so we can confirm with the user first. Regular views don't
221 close_btn->disconnect(SIGNAL(clicked()), dock, SLOT(close()));
223 /* Additional view, create a standard bar */
224 pv::views::trace::StandardBar *standard_bar =
225 new pv::views::trace::StandardBar(session, this, v.get());
226 dock_main->addToolBar(standard_bar);
228 standard_bar->action_view_show_cursors()->setChecked(v->cursors_shown());
238 void MainWindow::remove_view(shared_ptr<views::ViewBase> view)
240 for (shared_ptr<Session> session : sessions_) {
241 if (!session->has_view(view))
244 // Find the dock the view is contained in and remove it
245 for (auto entry : view_docks_)
246 if (entry.second == view) {
247 // Remove the view from the session
248 session->deregister_view(view);
250 // Remove the view from its parent; otherwise, Qt will
251 // call deleteLater() on it, which causes a double free
252 // since the shared_ptr in view_docks_ doesn't know
253 // that Qt keeps a pointer to the view around
256 // Delete the view's dock widget and all widgets inside it
257 entry.first->deleteLater();
259 // Remove the dock widget from the list and stop iterating
260 view_docks_.erase(entry.first);
266 shared_ptr<Session> MainWindow::add_session()
268 static int last_session_id = 1;
269 QString name = tr("Session %1").arg(last_session_id++);
271 shared_ptr<Session> session = make_shared<Session>(device_manager_, name);
273 connect(session.get(), SIGNAL(add_view(const QString&, views::ViewType, Session*)),
274 this, SLOT(on_add_view(const QString&, views::ViewType, Session*)));
275 connect(session.get(), SIGNAL(name_changed()),
276 this, SLOT(on_session_name_changed()));
277 session_state_mapper_.setMapping(session.get(), session.get());
278 connect(session.get(), SIGNAL(capture_state_changed(int)),
279 &session_state_mapper_, SLOT(map()));
281 sessions_.push_back(session);
283 QMainWindow *window = new QMainWindow();
284 window->setWindowFlags(Qt::Widget); // Remove Qt::Window flag
285 session_windows_[session] = window;
287 int index = session_selector_.addTab(window, name);
288 session_selector_.setCurrentIndex(index);
289 last_focused_session_ = session;
291 window->setDockNestingEnabled(true);
293 shared_ptr<views::ViewBase> main_view =
294 add_view(name, views::ViewTypeTrace, *session);
299 void MainWindow::remove_session(shared_ptr<Session> session)
301 int h = new_session_button_->height();
303 for (shared_ptr<views::ViewBase> view : session->views())
306 QMainWindow *window = session_windows_.at(session);
307 session_selector_.removeTab(session_selector_.indexOf(window));
309 session_windows_.erase(session);
311 if (last_focused_session_ == session)
312 last_focused_session_.reset();
314 sessions_.remove_if([&](shared_ptr<Session> s) {
315 return s == session; });
317 if (sessions_.empty()) {
318 // When there are no more tabs, the height of the QTabWidget
319 // drops to zero. We must prevent this to keep the static
321 for (QWidget *w : static_tab_widget_->findChildren<QWidget*>())
322 w->setMinimumHeight(h);
324 int margin = static_tab_widget_->layout()->contentsMargins().bottom();
325 static_tab_widget_->setMinimumHeight(h + 2 * margin);
326 session_selector_.setMinimumHeight(h + 2 * margin);
328 // Update the window title if there is no view left to
329 // generate focus change events
330 setWindowTitle(WindowTitle);
334 void MainWindow::setup_ui()
336 setObjectName(QString::fromUtf8("MainWindow"));
338 setCentralWidget(&session_selector_);
340 // Set the window icon
342 icon.addFile(QString(":/icons/sigrok-logo-notext.png"));
345 view_sticky_scrolling_shortcut_ = new QShortcut(QKeySequence(Qt::Key_S), this, SLOT(on_view_sticky_scrolling_shortcut()));
346 view_sticky_scrolling_shortcut_->setAutoRepeat(false);
348 view_coloured_bg_shortcut_ = new QShortcut(QKeySequence(Qt::Key_B), this, SLOT(on_view_coloured_bg_shortcut()));
349 view_coloured_bg_shortcut_->setAutoRepeat(false);
351 action_about_->setObjectName(QString::fromUtf8("actionAbout"));
352 action_about_->setToolTip(tr("&About..."));
354 // Set up the tab area
355 new_session_button_ = new QToolButton();
356 new_session_button_->setIcon(QIcon::fromTheme("document-new",
357 QIcon(":/icons/document-new.png")));
358 new_session_button_->setToolTip(tr("Create New Session"));
359 new_session_button_->setAutoRaise(true);
361 run_stop_button_ = new QToolButton();
362 run_stop_button_->setAutoRaise(true);
363 run_stop_button_->setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
364 run_stop_button_->setToolTip(tr("Start/Stop Acquisition"));
366 run_stop_shortcut_ = new QShortcut(QKeySequence(Qt::Key_Space), run_stop_button_, SLOT(click()));
367 run_stop_shortcut_->setAutoRepeat(false);
369 settings_button_ = new QToolButton();
370 settings_button_->setIcon(QIcon::fromTheme("configure",
371 QIcon(":/icons/configure.png")));
372 settings_button_->setToolTip(tr("Settings"));
373 settings_button_->setAutoRaise(true);
375 QFrame *separator1 = new QFrame();
376 separator1->setFrameStyle(QFrame::VLine | QFrame::Raised);
377 QFrame *separator2 = new QFrame();
378 separator2->setFrameStyle(QFrame::VLine | QFrame::Raised);
380 QHBoxLayout* layout = new QHBoxLayout();
381 layout->setContentsMargins(2, 2, 2, 2);
382 layout->addWidget(new_session_button_);
383 layout->addWidget(separator1);
384 layout->addWidget(run_stop_button_);
385 layout->addWidget(separator2);
386 layout->addWidget(settings_button_);
388 static_tab_widget_ = new QWidget();
389 static_tab_widget_->setLayout(layout);
391 session_selector_.setCornerWidget(static_tab_widget_, Qt::TopLeftCorner);
392 session_selector_.setTabsClosable(true);
394 close_application_shortcut_ = new QShortcut(QKeySequence(Qt::CTRL + Qt::Key_Q), this, SLOT(close()));
395 close_application_shortcut_->setAutoRepeat(false);
397 close_current_tab_shortcut_ = new QShortcut(QKeySequence(Qt::CTRL + Qt::Key_W), this, SLOT(on_close_current_tab()));
399 connect(new_session_button_, SIGNAL(clicked(bool)),
400 this, SLOT(on_new_session_clicked()));
401 connect(run_stop_button_, SIGNAL(clicked(bool)),
402 this, SLOT(on_run_stop_clicked()));
403 connect(&session_state_mapper_, SIGNAL(mapped(QObject*)),
404 this, SLOT(on_capture_state_changed(QObject*)));
405 connect(settings_button_, SIGNAL(clicked(bool)),
406 this, SLOT(on_settings_clicked()));
408 connect(&session_selector_, SIGNAL(tabCloseRequested(int)),
409 this, SLOT(on_tab_close_requested(int)));
410 connect(&session_selector_, SIGNAL(currentChanged(int)),
411 this, SLOT(on_tab_changed(int)));
414 connect(static_cast<QApplication *>(QCoreApplication::instance()),
415 SIGNAL(focusChanged(QWidget*, QWidget*)),
416 this, SLOT(on_focus_changed()));
419 void MainWindow::save_ui_settings()
424 settings.beginGroup("MainWindow");
425 settings.setValue("state", saveState());
426 settings.setValue("geometry", saveGeometry());
429 for (shared_ptr<Session> session : sessions_) {
430 // Ignore sessions using the demo device or no device at all
431 if (session->device()) {
432 shared_ptr<devices::HardwareDevice> device =
433 dynamic_pointer_cast< devices::HardwareDevice >
437 device->hardware_device()->driver()->name() == "demo")
440 settings.beginGroup("Session" + QString::number(id++));
441 settings.remove(""); // Remove all keys in this group
442 session->save_settings(settings);
447 settings.setValue("sessions", id);
450 void MainWindow::restore_ui_settings()
453 int i, session_count;
455 settings.beginGroup("MainWindow");
457 if (settings.contains("geometry")) {
458 restoreGeometry(settings.value("geometry").toByteArray());
459 restoreState(settings.value("state").toByteArray());
465 session_count = settings.value("sessions", 0).toInt();
467 for (i = 0; i < session_count; i++) {
468 settings.beginGroup("Session" + QString::number(i));
469 shared_ptr<Session> session = add_session();
470 session->restore_settings(settings);
475 std::shared_ptr<Session> MainWindow::get_tab_session(int index) const
477 // Find the session that belongs to the tab's main window
478 for (auto entry : session_windows_)
479 if (entry.second == session_selector_.widget(index))
485 void MainWindow::closeEvent(QCloseEvent *event)
487 bool data_saved = true;
489 for (auto entry : session_windows_)
490 if (!entry.first->data_saved())
493 if (!data_saved && (QMessageBox::question(this, tr("Confirmation"),
494 tr("There is unsaved data. Close anyway?"),
495 QMessageBox::Yes | QMessageBox::No) == QMessageBox::No)) {
503 QMenu* MainWindow::createPopupMenu()
508 bool MainWindow::restoreState(const QByteArray &state, int version)
513 // Do nothing. We don't want Qt to handle this, or else it
514 // will try to restore all the dock widgets and create havoc.
519 void MainWindow::session_error(const QString text, const QString info_text)
521 QMetaObject::invokeMethod(this, "show_session_error",
522 Qt::QueuedConnection, Q_ARG(QString, text),
523 Q_ARG(QString, info_text));
526 void MainWindow::show_session_error(const QString text, const QString info_text)
528 QMessageBox msg(this);
530 msg.setInformativeText(info_text);
531 msg.setStandardButtons(QMessageBox::Ok);
532 msg.setIcon(QMessageBox::Warning);
536 void MainWindow::on_add_view(const QString &title, views::ViewType type,
539 // We get a pointer and need a reference
540 for (std::shared_ptr<Session> s : sessions_)
541 if (s.get() == session)
542 add_view(title, type, *s);
545 void MainWindow::on_focus_changed()
547 shared_ptr<views::ViewBase> view = get_active_view();
550 for (shared_ptr<Session> session : sessions_) {
551 if (session->has_view(view)) {
552 if (session != last_focused_session_) {
553 // Activate correct tab if necessary
554 shared_ptr<Session> tab_session = get_tab_session(
555 session_selector_.currentIndex());
556 if (tab_session != session)
557 session_selector_.setCurrentWidget(
558 session_windows_.at(session));
560 on_focused_session_changed(session);
568 if (sessions_.empty())
569 setWindowTitle(WindowTitle);
572 void MainWindow::on_focused_session_changed(shared_ptr<Session> session)
574 last_focused_session_ = session;
576 setWindowTitle(session->name() + " - " + WindowTitle);
578 // Update the state of the run/stop button, too
579 on_capture_state_changed(session.get());
582 void MainWindow::on_new_session_clicked()
587 void MainWindow::on_run_stop_clicked()
589 shared_ptr<Session> session = last_focused_session_;
594 switch (session->get_capture_state()) {
595 case Session::Stopped:
596 session->start_capture([&](QString message) {
597 session_error("Capture failed", message); });
599 case Session::AwaitingTrigger:
600 case Session::Running:
601 session->stop_capture();
606 void MainWindow::on_settings_clicked()
608 dialogs::Settings dlg;
612 void MainWindow::on_session_name_changed()
614 // Update the corresponding dock widget's name(s)
615 Session *session = qobject_cast<Session*>(QObject::sender());
618 for (shared_ptr<views::ViewBase> view : session->views()) {
619 // Get the dock that contains the view
620 for (auto entry : view_docks_)
621 if (entry.second == view) {
622 entry.first->setObjectName(session->name());
623 entry.first->setWindowTitle(session->name());
627 // Update the tab widget by finding the main window and the tab from that
628 for (auto entry : session_windows_)
629 if (entry.first.get() == session) {
630 QMainWindow *window = entry.second;
631 const int index = session_selector_.indexOf(window);
632 session_selector_.setTabText(index, session->name());
635 // Refresh window title if the affected session has focus
636 if (session == last_focused_session_.get())
637 setWindowTitle(session->name() + " - " + WindowTitle);
640 void MainWindow::on_capture_state_changed(QObject *obj)
642 Session *caller = qobject_cast<Session*>(obj);
644 // Ignore if caller is not the currently focused session
645 // unless there is only one session
646 if ((sessions_.size() > 1) && (caller != last_focused_session_.get()))
649 int state = caller->get_capture_state();
651 const QIcon *icons[] = {&icon_grey_, &icon_red_, &icon_green_};
652 run_stop_button_->setIcon(*icons[state]);
653 run_stop_button_->setText((state == pv::Session::Stopped) ?
654 tr("Run") : tr("Stop"));
657 void MainWindow::on_new_view(Session *session)
659 // We get a pointer and need a reference
660 for (std::shared_ptr<Session> s : sessions_)
661 if (s.get() == session)
662 add_view(session->name(), views::ViewTypeTrace, *s);
665 void MainWindow::on_view_close_clicked()
667 // Find the dock widget that contains the close button that was clicked
668 QObject *w = QObject::sender();
669 QDockWidget *dock = 0;
672 dock = qobject_cast<QDockWidget*>(w);
678 // Get the view contained in the dock widget
679 shared_ptr<views::ViewBase> view;
681 for (auto entry : view_docks_)
682 if (entry.first == dock)
685 // Deregister the view
686 for (shared_ptr<Session> session : sessions_) {
687 if (!session->has_view(view))
690 // Also destroy the entire session if its main view is closing...
691 if (view == session->main_view()) {
692 // ...but only if data is saved or the user confirms closing
693 if (session->data_saved() || (QMessageBox::question(this, tr("Confirmation"),
694 tr("This session contains unsaved data. Close it anyway?"),
695 QMessageBox::Yes | QMessageBox::No) == QMessageBox::Yes))
696 remove_session(session);
699 // All other views can be closed at any time as no data will be lost
704 void MainWindow::on_tab_changed(int index)
706 shared_ptr<Session> session = get_tab_session(index);
709 on_focused_session_changed(session);
712 void MainWindow::on_tab_close_requested(int index)
714 shared_ptr<Session> session = get_tab_session(index);
718 if (session->data_saved() || (QMessageBox::question(this, tr("Confirmation"),
719 tr("This session contains unsaved data. Close it anyway?"),
720 QMessageBox::Yes | QMessageBox::No) == QMessageBox::Yes))
721 remove_session(session);
724 void MainWindow::on_view_sticky_scrolling_shortcut()
726 shared_ptr<views::ViewBase> viewbase = get_active_view();
727 views::TraceView::View* view =
728 qobject_cast<views::TraceView::View*>(viewbase.get());
730 view->toggle_sticky_scrolling();
733 void MainWindow::on_view_coloured_bg_shortcut()
735 GlobalSettings settings;
737 bool state = settings.value(GlobalSettings::Key_View_ColouredBG).toBool();
738 settings.setValue(GlobalSettings::Key_View_ColouredBG, !state);
741 void MainWindow::on_settingViewColouredBg_changed(const QVariant new_value)
743 bool state = new_value.toBool();
745 for (auto entry : view_docks_) {
746 shared_ptr<views::ViewBase> viewbase = entry.second;
748 // Only trace views have this setting
749 views::TraceView::View* view =
750 qobject_cast<views::TraceView::View*>(viewbase.get());
752 view->enable_coloured_bg(state);
756 void MainWindow::on_actionAbout_triggered()
758 dialogs::About dlg(device_manager_.context(), this);
762 void MainWindow::on_close_current_tab()
764 int tab = session_selector_.currentIndex();
766 on_tab_close_requested(tab);