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>
38 #include "mainwindow.hpp"
40 #include "devicemanager.hpp"
42 #include "devices/hardwaredevice.hpp"
43 #include "dialogs/about.hpp"
44 #include "toolbars/mainbar.hpp"
45 #include "view/view.hpp"
46 #include "views/trace/standardbar.hpp"
50 #include <libsigrokcxx/libsigrokcxx.hpp>
52 using std::dynamic_pointer_cast;
54 using std::make_shared;
56 using std::shared_ptr;
65 using toolbars::MainBar;
67 const QString MainWindow::WindowTitle = tr("PulseView");
69 MainWindow::MainWindow(DeviceManager &device_manager,
70 string open_file_name, string open_file_format,
73 device_manager_(device_manager),
74 session_selector_(this),
75 session_state_mapper_(this),
76 action_view_sticky_scrolling_(new QAction(this)),
77 action_view_coloured_bg_(new QAction(this)),
78 action_about_(new QAction(this)),
79 icon_red_(":/icons/status-red.svg"),
80 icon_green_(":/icons/status-green.svg"),
81 icon_grey_(":/icons/status-grey.svg")
83 qRegisterMetaType<util::Timestamp>("util::Timestamp");
86 restore_ui_settings();
88 if (!open_file_name.empty()) {
89 shared_ptr<Session> session = add_session();
90 session->load_init_file(open_file_name, open_file_format);
93 // Add empty default session if there aren't any sessions
94 if (sessions_.size() == 0) {
95 shared_ptr<Session> session = add_session();
97 map<string, string> dev_info;
98 shared_ptr<devices::HardwareDevice> other_device, demo_device;
100 // Use any available device that's not demo
101 for (shared_ptr<devices::HardwareDevice> dev : device_manager_.devices()) {
102 if (dev->hardware_device()->driver()->name() == "demo") {
109 // ...and if there isn't any, just use demo then
110 session->select_device(other_device ? other_device : demo_device);
114 MainWindow::~MainWindow()
116 while (!sessions_.empty())
117 remove_session(sessions_.front());
120 QAction* MainWindow::action_view_sticky_scrolling() const
122 return action_view_sticky_scrolling_;
125 QAction* MainWindow::action_view_coloured_bg() const
127 return action_view_coloured_bg_;
130 QAction* MainWindow::action_about() const
132 return action_about_;
135 shared_ptr<views::ViewBase> MainWindow::get_active_view() const
137 // If there's only one view, use it...
138 if (view_docks_.size() == 1)
139 return view_docks_.begin()->second;
141 // ...otherwise find the dock widget the widget with focus is contained in
142 QObject *w = QApplication::focusWidget();
143 QDockWidget *dock = 0;
146 dock = qobject_cast<QDockWidget*>(w);
152 // Get the view contained in the dock widget
153 for (auto entry : view_docks_)
154 if (entry.first == dock)
160 shared_ptr<views::ViewBase> MainWindow::add_view(const QString &title,
161 views::ViewType type, Session &session)
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(action_view_sticky_scrolling_->isChecked());
203 v->enable_coloured_bg(action_view_coloured_bg_->isChecked());
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("Untitled-%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 action_view_sticky_scrolling_->setCheckable(true);
346 action_view_sticky_scrolling_->setChecked(true);
347 action_view_sticky_scrolling_->setShortcut(QKeySequence(Qt::Key_S));
348 action_view_sticky_scrolling_->setObjectName(
349 QString::fromUtf8("actionViewStickyScrolling"));
350 action_view_sticky_scrolling_->setText(tr("&Sticky Scrolling"));
352 action_view_coloured_bg_->setCheckable(true);
353 action_view_coloured_bg_->setChecked(true);
354 action_view_coloured_bg_->setShortcut(QKeySequence(Qt::Key_B));
355 action_view_coloured_bg_->setObjectName(
356 QString::fromUtf8("actionViewColouredBg"));
357 action_view_coloured_bg_->setText(tr("Use &Coloured Backgrounds"));
359 action_about_->setObjectName(QString::fromUtf8("actionAbout"));
360 action_about_->setToolTip(tr("&About..."));
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_->setShortcut(QKeySequence(Qt::Key_Space));
373 run_stop_button_->setToolTip(tr("Start/Stop Acquisition"));
375 settings_button_ = new QToolButton();
376 settings_button_->setIcon(QIcon::fromTheme("configure",
377 QIcon(":/icons/configure.png")));
378 settings_button_->setToolTip(tr("Settings"));
379 settings_button_->setAutoRaise(true);
381 QFrame *separator1 = new QFrame();
382 separator1->setFrameStyle(QFrame::VLine | QFrame::Raised);
383 QFrame *separator2 = new QFrame();
384 separator2->setFrameStyle(QFrame::VLine | QFrame::Raised);
386 QHBoxLayout* layout = new QHBoxLayout();
387 layout->setContentsMargins(2, 2, 2, 2);
388 layout->addWidget(new_session_button_);
389 layout->addWidget(separator1);
390 layout->addWidget(run_stop_button_);
391 layout->addWidget(separator2);
392 layout->addWidget(settings_button_);
394 static_tab_widget_ = new QWidget();
395 static_tab_widget_->setLayout(layout);
397 session_selector_.setCornerWidget(static_tab_widget_, Qt::TopLeftCorner);
398 session_selector_.setTabsClosable(true);
400 connect(new_session_button_, SIGNAL(clicked(bool)),
401 this, SLOT(on_new_session_clicked()));
402 connect(run_stop_button_, SIGNAL(clicked(bool)),
403 this, SLOT(on_run_stop_clicked()));
404 connect(&session_state_mapper_, SIGNAL(mapped(QObject*)),
405 this, SLOT(on_capture_state_changed(QObject*)));
407 connect(&session_selector_, SIGNAL(tabCloseRequested(int)),
408 this, SLOT(on_tab_close_requested(int)));
409 connect(&session_selector_, SIGNAL(currentChanged(int)),
410 this, SLOT(on_tab_changed(int)));
413 connect(static_cast<QApplication *>(QCoreApplication::instance()),
414 SIGNAL(focusChanged(QWidget*, QWidget*)),
415 this, SLOT(on_focus_changed()));
418 void MainWindow::save_ui_settings()
423 settings.beginGroup("MainWindow");
424 settings.setValue("state", saveState());
425 settings.setValue("geometry", saveGeometry());
428 for (shared_ptr<Session> session : sessions_) {
429 // Ignore sessions using the demo device or no device at all
430 if (session->device()) {
431 shared_ptr<devices::HardwareDevice> device =
432 dynamic_pointer_cast< devices::HardwareDevice >
436 device->hardware_device()->driver()->name() == "demo")
439 settings.beginGroup("Session" + QString::number(id++));
440 settings.remove(""); // Remove all keys in this group
441 session->save_settings(settings);
446 settings.setValue("sessions", id);
449 void MainWindow::restore_ui_settings()
452 int i, session_count;
454 settings.beginGroup("MainWindow");
456 if (settings.contains("geometry")) {
457 restoreGeometry(settings.value("geometry").toByteArray());
458 restoreState(settings.value("state").toByteArray());
464 session_count = settings.value("sessions", 0).toInt();
466 for (i = 0; i < session_count; i++) {
467 settings.beginGroup("Session" + QString::number(i));
468 shared_ptr<Session> session = add_session();
469 session->restore_settings(settings);
474 std::shared_ptr<Session> MainWindow::get_tab_session(int index) const
476 // Find the session that belongs to the tab's main window
477 for (auto entry : session_windows_)
478 if (entry.second == session_selector_.widget(index))
484 void MainWindow::closeEvent(QCloseEvent *event)
486 bool data_saved = true;
488 for (auto entry : session_windows_)
489 if (!entry.first->data_saved())
492 if (!data_saved && (QMessageBox::question(this, tr("Confirmation"),
493 tr("There is unsaved data. Close anyway?"),
494 QMessageBox::Yes | QMessageBox::No) == QMessageBox::No)) {
502 QMenu* MainWindow::createPopupMenu()
507 bool MainWindow::restoreState(const QByteArray &state, int version)
512 // Do nothing. We don't want Qt to handle this, or else it
513 // will try to restore all the dock widgets and create havoc.
518 void MainWindow::session_error(const QString text, const QString info_text)
520 QMetaObject::invokeMethod(this, "show_session_error",
521 Qt::QueuedConnection, Q_ARG(QString, text),
522 Q_ARG(QString, info_text));
525 void MainWindow::show_session_error(const QString text, const QString info_text)
527 QMessageBox msg(this);
529 msg.setInformativeText(info_text);
530 msg.setStandardButtons(QMessageBox::Ok);
531 msg.setIcon(QMessageBox::Warning);
535 void MainWindow::on_add_view(const QString &title, views::ViewType type,
538 // We get a pointer and need a reference
539 for (std::shared_ptr<Session> s : sessions_)
540 if (s.get() == session)
541 add_view(title, type, *s);
544 void MainWindow::on_focus_changed()
546 shared_ptr<views::ViewBase> view = get_active_view();
549 for (shared_ptr<Session> session : sessions_) {
550 if (session->has_view(view)) {
551 if (session != last_focused_session_) {
552 // Activate correct tab if necessary
553 shared_ptr<Session> tab_session = get_tab_session(
554 session_selector_.currentIndex());
555 if (tab_session != session)
556 session_selector_.setCurrentWidget(
557 session_windows_.at(session));
559 on_focused_session_changed(session);
567 if (sessions_.empty())
568 setWindowTitle(WindowTitle);
571 void MainWindow::on_focused_session_changed(shared_ptr<Session> session)
573 last_focused_session_ = session;
575 setWindowTitle(session->name() + " - " + WindowTitle);
577 // Update the state of the run/stop button, too
578 on_capture_state_changed(session.get());
581 void MainWindow::on_new_session_clicked()
586 void MainWindow::on_run_stop_clicked()
588 shared_ptr<Session> session = last_focused_session_;
593 switch (session->get_capture_state()) {
594 case Session::Stopped:
595 session->start_capture([&](QString message) {
596 session_error("Capture failed", message); });
598 case Session::AwaitingTrigger:
599 case Session::Running:
600 session->stop_capture();
605 void MainWindow::on_session_name_changed()
607 // Update the corresponding dock widget's name(s)
608 Session *session = qobject_cast<Session*>(QObject::sender());
611 for (shared_ptr<views::ViewBase> view : session->views()) {
612 // Get the dock that contains the view
613 for (auto entry : view_docks_)
614 if (entry.second == view) {
615 entry.first->setObjectName(session->name());
616 entry.first->setWindowTitle(session->name());
620 // Update the tab widget by finding the main window and the tab from that
621 for (auto entry : session_windows_)
622 if (entry.first.get() == session) {
623 QMainWindow *window = entry.second;
624 const int index = session_selector_.indexOf(window);
625 session_selector_.setTabText(index, session->name());
628 // Refresh window title if the affected session has focus
629 if (session == last_focused_session_.get())
630 setWindowTitle(session->name() + " - " + WindowTitle);
633 void MainWindow::on_capture_state_changed(QObject *obj)
635 Session *caller = qobject_cast<Session*>(obj);
637 // Ignore if caller is not the currently focused session
638 // unless there is only one session
639 if ((sessions_.size() > 1) && (caller != last_focused_session_.get()))
642 int state = caller->get_capture_state();
644 const QIcon *icons[] = {&icon_grey_, &icon_red_, &icon_green_};
645 run_stop_button_->setIcon(*icons[state]);
646 run_stop_button_->setText((state == pv::Session::Stopped) ?
647 tr("Run") : tr("Stop"));
650 void MainWindow::on_new_view(Session *session)
652 // We get a pointer and need a reference
653 for (std::shared_ptr<Session> s : sessions_)
654 if (s.get() == session)
655 add_view(session->name(), views::ViewTypeTrace, *s);
658 void MainWindow::on_view_close_clicked()
660 // Find the dock widget that contains the close button that was clicked
661 QObject *w = QObject::sender();
662 QDockWidget *dock = 0;
665 dock = qobject_cast<QDockWidget*>(w);
671 // Get the view contained in the dock widget
672 shared_ptr<views::ViewBase> view;
674 for (auto entry : view_docks_)
675 if (entry.first == dock)
678 // Deregister the view
679 for (shared_ptr<Session> session : sessions_) {
680 if (!session->has_view(view))
683 // Also destroy the entire session if its main view is closing...
684 if (view == session->main_view()) {
685 // ...but only if data is saved or the user confirms closing
686 if (session->data_saved() || (QMessageBox::question(this, tr("Confirmation"),
687 tr("This session contains unsaved data. Close it anyway?"),
688 QMessageBox::Yes | QMessageBox::No) == QMessageBox::Yes))
689 remove_session(session);
692 // All other views can be closed at any time as no data will be lost
697 void MainWindow::on_tab_changed(int index)
699 shared_ptr<Session> session = get_tab_session(index);
702 on_focused_session_changed(session);
705 void MainWindow::on_tab_close_requested(int index)
707 shared_ptr<Session> session = get_tab_session(index);
711 if (session->data_saved() || (QMessageBox::question(this, tr("Confirmation"),
712 tr("This session contains unsaved data. Close it anyway?"),
713 QMessageBox::Yes | QMessageBox::No) == QMessageBox::Yes))
714 remove_session(session);
717 void MainWindow::on_actionViewStickyScrolling_triggered()
719 shared_ptr<views::ViewBase> viewbase = get_active_view();
720 views::TraceView::View* view =
721 qobject_cast<views::TraceView::View*>(viewbase.get());
723 view->enable_sticky_scrolling(action_view_sticky_scrolling_->isChecked());
726 void MainWindow::on_actionViewColouredBg_triggered()
728 shared_ptr<views::ViewBase> viewbase = get_active_view();
729 views::TraceView::View* view =
730 qobject_cast<views::TraceView::View*>(viewbase.get());
732 view->enable_coloured_bg(action_view_coloured_bg_->isChecked());
735 void MainWindow::on_actionAbout_triggered()
737 dialogs::About dlg(device_manager_.context(), this);