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 /* Additional view, create a standard bar */
218 pv::views::trace::StandardBar *standard_bar =
219 new pv::views::trace::StandardBar(session, this, v.get());
220 dock_main->addToolBar(standard_bar);
222 standard_bar->action_view_show_cursors()->setChecked(v->cursors_shown());
232 void MainWindow::remove_view(shared_ptr<views::ViewBase> view)
234 for (shared_ptr<Session> session : sessions_) {
235 if (!session->has_view(view))
238 // Find the dock the view is contained in and remove it
239 for (auto entry : view_docks_)
240 if (entry.second == view) {
241 // Remove the view from the session
242 session->deregister_view(view);
244 // Remove the view from its parent; otherwise, Qt will
245 // call deleteLater() on it, which causes a double free
246 // since the shared_ptr in view_docks_ doesn't know
247 // that Qt keeps a pointer to the view around
250 // Delete the view's dock widget and all widgets inside it
251 entry.first->deleteLater();
253 // Remove the dock widget from the list and stop iterating
254 view_docks_.erase(entry.first);
260 shared_ptr<Session> MainWindow::add_session()
262 static int last_session_id = 1;
263 QString name = tr("Untitled-%1").arg(last_session_id++);
265 shared_ptr<Session> session = make_shared<Session>(device_manager_, name);
267 connect(session.get(), SIGNAL(add_view(const QString&, views::ViewType, Session*)),
268 this, SLOT(on_add_view(const QString&, views::ViewType, Session*)));
269 connect(session.get(), SIGNAL(name_changed()),
270 this, SLOT(on_session_name_changed()));
271 session_state_mapper_.setMapping(session.get(), session.get());
272 connect(session.get(), SIGNAL(capture_state_changed(int)),
273 &session_state_mapper_, SLOT(map()));
275 sessions_.push_back(session);
277 QMainWindow *window = new QMainWindow();
278 window->setWindowFlags(Qt::Widget); // Remove Qt::Window flag
279 session_windows_[session] = window;
281 int index = session_selector_.addTab(window, name);
282 session_selector_.setCurrentIndex(index);
283 last_focused_session_ = session;
285 window->setDockNestingEnabled(true);
287 shared_ptr<views::ViewBase> main_view =
288 add_view(name, views::ViewTypeTrace, *session);
293 void MainWindow::remove_session(shared_ptr<Session> session)
295 int h = new_session_button_->height();
297 for (shared_ptr<views::ViewBase> view : session->views())
300 QMainWindow *window = session_windows_.at(session);
301 session_selector_.removeTab(session_selector_.indexOf(window));
303 session_windows_.erase(session);
305 if (last_focused_session_ == session)
306 last_focused_session_.reset();
308 sessions_.remove_if([&](shared_ptr<Session> s) {
309 return s == session; });
311 if (sessions_.empty()) {
312 // When there are no more tabs, the height of the QTabWidget
313 // drops to zero. We must prevent this to keep the static
315 for (QWidget *w : static_tab_widget_->findChildren<QWidget*>())
316 w->setMinimumHeight(h);
318 int margin = static_tab_widget_->layout()->contentsMargins().bottom();
319 static_tab_widget_->setMinimumHeight(h + 2 * margin);
320 session_selector_.setMinimumHeight(h + 2 * margin);
322 // Update the window title if there is no view left to
323 // generate focus change events
324 setWindowTitle(WindowTitle);
328 void MainWindow::setup_ui()
330 setObjectName(QString::fromUtf8("MainWindow"));
332 setCentralWidget(&session_selector_);
334 // Set the window icon
336 icon.addFile(QString(":/icons/sigrok-logo-notext.png"));
339 action_view_sticky_scrolling_->setCheckable(true);
340 action_view_sticky_scrolling_->setChecked(true);
341 action_view_sticky_scrolling_->setShortcut(QKeySequence(Qt::Key_S));
342 action_view_sticky_scrolling_->setObjectName(
343 QString::fromUtf8("actionViewStickyScrolling"));
344 action_view_sticky_scrolling_->setText(tr("&Sticky Scrolling"));
346 action_view_coloured_bg_->setCheckable(true);
347 action_view_coloured_bg_->setChecked(true);
348 action_view_coloured_bg_->setShortcut(QKeySequence(Qt::Key_B));
349 action_view_coloured_bg_->setObjectName(
350 QString::fromUtf8("actionViewColouredBg"));
351 action_view_coloured_bg_->setText(tr("Use &Coloured Backgrounds"));
353 action_about_->setObjectName(QString::fromUtf8("actionAbout"));
354 action_about_->setToolTip(tr("&About..."));
356 // Set up the tab area
357 new_session_button_ = new QToolButton();
358 new_session_button_->setIcon(QIcon::fromTheme("document-new",
359 QIcon(":/icons/document-new.png")));
360 new_session_button_->setToolTip(tr("Create New Session"));
361 new_session_button_->setAutoRaise(true);
363 run_stop_button_ = new QToolButton();
364 run_stop_button_->setAutoRaise(true);
365 run_stop_button_->setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
366 run_stop_button_->setShortcut(QKeySequence(Qt::Key_Space));
367 run_stop_button_->setToolTip(tr("Start/Stop Acquisition"));
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 connect(new_session_button_, SIGNAL(clicked(bool)),
395 this, SLOT(on_new_session_clicked()));
396 connect(run_stop_button_, SIGNAL(clicked(bool)),
397 this, SLOT(on_run_stop_clicked()));
398 connect(&session_state_mapper_, SIGNAL(mapped(QObject*)),
399 this, SLOT(on_capture_state_changed(QObject*)));
401 connect(&session_selector_, SIGNAL(tabCloseRequested(int)),
402 this, SLOT(on_tab_close_requested(int)));
403 connect(&session_selector_, SIGNAL(currentChanged(int)),
404 this, SLOT(on_tab_changed(int)));
407 connect(static_cast<QApplication *>(QCoreApplication::instance()),
408 SIGNAL(focusChanged(QWidget*, QWidget*)),
409 this, SLOT(on_focus_changed()));
412 void MainWindow::save_ui_settings()
417 settings.beginGroup("MainWindow");
418 settings.setValue("state", saveState());
419 settings.setValue("geometry", saveGeometry());
422 for (shared_ptr<Session> session : sessions_) {
423 // Ignore sessions using the demo device or no device at all
424 if (session->device()) {
425 shared_ptr<devices::HardwareDevice> device =
426 dynamic_pointer_cast< devices::HardwareDevice >
430 device->hardware_device()->driver()->name() == "demo")
433 settings.beginGroup("Session" + QString::number(id++));
434 settings.remove(""); // Remove all keys in this group
435 session->save_settings(settings);
440 settings.setValue("sessions", id);
443 void MainWindow::restore_ui_settings()
446 int i, session_count;
448 settings.beginGroup("MainWindow");
450 if (settings.contains("geometry")) {
451 restoreGeometry(settings.value("geometry").toByteArray());
452 restoreState(settings.value("state").toByteArray());
458 session_count = settings.value("sessions", 0).toInt();
460 for (i = 0; i < session_count; i++) {
461 settings.beginGroup("Session" + QString::number(i));
462 shared_ptr<Session> session = add_session();
463 session->restore_settings(settings);
468 std::shared_ptr<Session> MainWindow::get_tab_session(int index) const
470 // Find the session that belongs to the tab's main window
471 for (auto entry : session_windows_)
472 if (entry.second == session_selector_.widget(index))
478 void MainWindow::closeEvent(QCloseEvent *event)
480 bool data_saved = true;
482 for (auto entry : session_windows_)
483 if (!entry.first->data_saved())
486 if (!data_saved && (QMessageBox::question(this, tr("Confirmation"),
487 tr("There is unsaved data. Close anyway?"),
488 QMessageBox::Yes | QMessageBox::No) == QMessageBox::No)) {
496 QMenu* MainWindow::createPopupMenu()
501 bool MainWindow::restoreState(const QByteArray &state, int version)
506 // Do nothing. We don't want Qt to handle this, or else it
507 // will try to restore all the dock widgets and create havoc.
512 void MainWindow::session_error(const QString text, const QString info_text)
514 QMetaObject::invokeMethod(this, "show_session_error",
515 Qt::QueuedConnection, Q_ARG(QString, text),
516 Q_ARG(QString, info_text));
519 void MainWindow::show_session_error(const QString text, const QString info_text)
521 QMessageBox msg(this);
523 msg.setInformativeText(info_text);
524 msg.setStandardButtons(QMessageBox::Ok);
525 msg.setIcon(QMessageBox::Warning);
529 void MainWindow::on_add_view(const QString &title, views::ViewType type,
532 // We get a pointer and need a reference
533 for (std::shared_ptr<Session> s : sessions_)
534 if (s.get() == session)
535 add_view(title, type, *s);
538 void MainWindow::on_focus_changed()
540 shared_ptr<views::ViewBase> view = get_active_view();
543 for (shared_ptr<Session> session : sessions_) {
544 if (session->has_view(view)) {
545 if (session != last_focused_session_) {
546 // Activate correct tab if necessary
547 shared_ptr<Session> tab_session = get_tab_session(
548 session_selector_.currentIndex());
549 if (tab_session != session)
550 session_selector_.setCurrentWidget(
551 session_windows_.at(session));
553 on_focused_session_changed(session);
561 if (sessions_.empty())
562 setWindowTitle(WindowTitle);
565 void MainWindow::on_focused_session_changed(shared_ptr<Session> session)
567 last_focused_session_ = session;
569 setWindowTitle(session->name() + " - " + WindowTitle);
571 // Update the state of the run/stop button, too
572 on_capture_state_changed(session.get());
575 void MainWindow::on_new_session_clicked()
580 void MainWindow::on_run_stop_clicked()
582 shared_ptr<Session> session = last_focused_session_;
587 switch (session->get_capture_state()) {
588 case Session::Stopped:
589 session->start_capture([&](QString message) {
590 session_error("Capture failed", message); });
592 case Session::AwaitingTrigger:
593 case Session::Running:
594 session->stop_capture();
599 void MainWindow::on_session_name_changed()
601 // Update the corresponding dock widget's name(s)
602 Session *session = qobject_cast<Session*>(QObject::sender());
605 for (shared_ptr<views::ViewBase> view : session->views()) {
606 // Get the dock that contains the view
607 for (auto entry : view_docks_)
608 if (entry.second == view) {
609 entry.first->setObjectName(session->name());
610 entry.first->setWindowTitle(session->name());
614 // Update the tab widget by finding the main window and the tab from that
615 for (auto entry : session_windows_)
616 if (entry.first.get() == session) {
617 QMainWindow *window = entry.second;
618 const int index = session_selector_.indexOf(window);
619 session_selector_.setTabText(index, session->name());
622 // Refresh window title if the affected session has focus
623 if (session == last_focused_session_.get())
624 setWindowTitle(session->name() + " - " + WindowTitle);
627 void MainWindow::on_capture_state_changed(QObject *obj)
629 Session *caller = qobject_cast<Session*>(obj);
631 // Ignore if caller is not the currently focused session
632 // unless there is only one session
633 if ((sessions_.size() > 1) && (caller != last_focused_session_.get()))
636 int state = caller->get_capture_state();
638 const QIcon *icons[] = {&icon_grey_, &icon_red_, &icon_green_};
639 run_stop_button_->setIcon(*icons[state]);
640 run_stop_button_->setText((state == pv::Session::Stopped) ?
641 tr("Run") : tr("Stop"));
644 void MainWindow::on_new_view(Session *session)
646 // We get a pointer and need a reference
647 for (std::shared_ptr<Session> s : sessions_)
648 if (s.get() == session)
649 add_view(session->name(), views::ViewTypeTrace, *s);
652 void MainWindow::on_view_close_clicked()
654 // Find the dock widget that contains the close button that was clicked
655 QObject *w = QObject::sender();
656 QDockWidget *dock = 0;
659 dock = qobject_cast<QDockWidget*>(w);
665 // Get the view contained in the dock widget
666 shared_ptr<views::ViewBase> view;
668 for (auto entry : view_docks_)
669 if (entry.first == dock)
672 // Deregister the view
673 for (shared_ptr<Session> session : sessions_) {
674 if (!session->has_view(view))
677 // Also destroy the entire session if its main view is closing
678 if (view == session->main_view()) {
679 remove_session(session);
686 void MainWindow::on_tab_changed(int index)
688 shared_ptr<Session> session = get_tab_session(index);
691 on_focused_session_changed(session);
694 void MainWindow::on_tab_close_requested(int index)
696 shared_ptr<Session> session = get_tab_session(index);
700 if (session->data_saved() || (QMessageBox::question(this, tr("Confirmation"),
701 tr("This session contains unsaved data. Close it anyway?"),
702 QMessageBox::Yes | QMessageBox::No) == QMessageBox::Yes))
703 remove_session(session);
706 void MainWindow::on_actionViewStickyScrolling_triggered()
708 shared_ptr<views::ViewBase> viewbase = get_active_view();
709 views::TraceView::View* view =
710 qobject_cast<views::TraceView::View*>(viewbase.get());
712 view->enable_sticky_scrolling(action_view_sticky_scrolling_->isChecked());
715 void MainWindow::on_actionViewColouredBg_triggered()
717 shared_ptr<views::ViewBase> viewbase = get_active_view();
718 views::TraceView::View* view =
719 qobject_cast<views::TraceView::View*>(viewbase.get());
721 view->enable_coloured_bg(action_view_coloured_bg_->isChecked());
724 void MainWindow::on_actionAbout_triggered()
726 dialogs::About dlg(device_manager_.context(), this);