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, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
24 #include <libsigrokdecode/libsigrokdecode.h>
31 #include <QApplication>
32 #include <QCloseEvent>
33 #include <QDockWidget>
34 #include <QHBoxLayout>
35 #include <QMessageBox>
39 #include "mainwindow.hpp"
41 #include "devicemanager.hpp"
43 #include "devices/hardwaredevice.hpp"
44 #include "dialogs/about.hpp"
45 #include "toolbars/mainbar.hpp"
46 #include "view/view.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;
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 main_bar = make_shared<MainBar>(session, *this);
208 dock_main->addToolBar(main_bar.get());
209 session.set_main_bar(main_bar);
211 connect(main_bar.get(), SIGNAL(new_view(Session*)),
212 this, SLOT(on_new_view(Session*)));
214 main_bar->action_view_show_cursors()->setChecked(v->cursors_shown());
216 connect(v.get(), SIGNAL(always_zoom_to_fit_changed(bool)),
217 main_bar.get(), SLOT(on_always_zoom_to_fit_changed(bool)));
226 shared_ptr<Session> MainWindow::add_session()
228 static int last_session_id = 1;
229 QString name = tr("Untitled-%1").arg(last_session_id++);
231 shared_ptr<Session> session = make_shared<Session>(device_manager_, name);
233 connect(session.get(), SIGNAL(add_view(const QString&, views::ViewType, Session*)),
234 this, SLOT(on_add_view(const QString&, views::ViewType, Session*)));
235 connect(session.get(), SIGNAL(name_changed()),
236 this, SLOT(on_session_name_changed()));
237 session_state_mapper_.setMapping(session.get(), session.get());
238 connect(session.get(), SIGNAL(capture_state_changed(int)),
239 &session_state_mapper_, SLOT(map()));
241 sessions_.push_back(session);
243 QMainWindow *window = new QMainWindow();
244 window->setWindowFlags(Qt::Widget); // Remove Qt::Window flag
245 session_windows_[session] = window;
247 int index = session_selector_.addTab(window, name);
248 session_selector_.setCurrentIndex(index);
249 last_focused_session_ = session;
251 window->setDockNestingEnabled(true);
253 shared_ptr<views::ViewBase> main_view =
254 add_view(name, views::ViewTypeTrace, *session);
259 void MainWindow::remove_session(shared_ptr<Session> session)
261 int h = new_session_button_->height();
263 for (shared_ptr<views::ViewBase> view : session->views()) {
264 // Find the dock the view is contained in and remove it
265 for (auto entry : view_docks_)
266 if (entry.second == view) {
267 // Remove the view from the session
268 session->deregister_view(view);
270 // Remove the view from its parent; otherwise, Qt will
271 // call deleteLater() on it, which causes a double free
272 // since the shared_ptr in view_docks_ doesn't know
273 // that Qt keeps a pointer to the view around
274 entry.second->setParent(0);
276 // Remove this entry from the container
277 view_docks_.erase(entry.first);
281 QMainWindow *window = session_windows_.at(session);
282 session_selector_.removeTab(session_selector_.indexOf(window));
284 session_windows_.erase(session);
286 if (last_focused_session_ == session)
287 last_focused_session_.reset();
289 sessions_.remove_if([&](shared_ptr<Session> s) {
290 return s == session; });
292 if (sessions_.empty()) {
293 // When there are no more tabs, the height of the QTabWidget
294 // drops to zero. We must prevent this to keep the static
296 for (QWidget *w : static_tab_widget_->findChildren<QWidget*>())
297 w->setMinimumHeight(h);
299 int margin = static_tab_widget_->layout()->contentsMargins().bottom();
300 static_tab_widget_->setMinimumHeight(h + 2 * margin);
301 session_selector_.setMinimumHeight(h + 2 * margin);
303 // Update the window title if there is no view left to
304 // generate focus change events
305 setWindowTitle(WindowTitle);
309 void MainWindow::setup_ui()
311 setObjectName(QString::fromUtf8("MainWindow"));
313 setCentralWidget(&session_selector_);
315 // Set the window icon
317 icon.addFile(QString(":/icons/sigrok-logo-notext.png"));
320 action_view_sticky_scrolling_->setCheckable(true);
321 action_view_sticky_scrolling_->setChecked(true);
322 action_view_sticky_scrolling_->setShortcut(QKeySequence(Qt::Key_S));
323 action_view_sticky_scrolling_->setObjectName(
324 QString::fromUtf8("actionViewStickyScrolling"));
325 action_view_sticky_scrolling_->setText(tr("&Sticky Scrolling"));
327 action_view_coloured_bg_->setCheckable(true);
328 action_view_coloured_bg_->setChecked(true);
329 action_view_coloured_bg_->setShortcut(QKeySequence(Qt::Key_B));
330 action_view_coloured_bg_->setObjectName(
331 QString::fromUtf8("actionViewColouredBg"));
332 action_view_coloured_bg_->setText(tr("Use &coloured backgrounds"));
334 action_about_->setObjectName(QString::fromUtf8("actionAbout"));
335 action_about_->setText(tr("&About..."));
337 // Set up the tab area
338 new_session_button_ = new QToolButton();
339 new_session_button_->setIcon(QIcon::fromTheme("document-new",
340 QIcon(":/icons/document-new.png")));
341 new_session_button_->setAutoRaise(true);
343 run_stop_button_ = new QToolButton();
344 run_stop_button_->setAutoRaise(true);
345 run_stop_button_->setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
346 run_stop_button_->setShortcut(QKeySequence(Qt::Key_Space));
348 settings_button_ = new QToolButton();
349 settings_button_->setIcon(QIcon::fromTheme("configure",
350 QIcon(":/icons/configure.png")));
351 settings_button_->setAutoRaise(true);
353 QFrame *separator1 = new QFrame();
354 separator1->setFrameStyle(QFrame::VLine | QFrame::Raised);
355 QFrame *separator2 = new QFrame();
356 separator2->setFrameStyle(QFrame::VLine | QFrame::Raised);
358 QHBoxLayout* layout = new QHBoxLayout();
359 layout->setContentsMargins(2, 2, 2, 2);
360 layout->addWidget(new_session_button_);
361 layout->addWidget(separator1);
362 layout->addWidget(run_stop_button_);
363 layout->addWidget(separator2);
364 layout->addWidget(settings_button_);
366 static_tab_widget_ = new QWidget();
367 static_tab_widget_->setLayout(layout);
369 session_selector_.setCornerWidget(static_tab_widget_, Qt::TopLeftCorner);
370 session_selector_.setTabsClosable(true);
372 connect(new_session_button_, SIGNAL(clicked(bool)),
373 this, SLOT(on_new_session_clicked()));
374 connect(run_stop_button_, SIGNAL(clicked(bool)),
375 this, SLOT(on_run_stop_clicked()));
376 connect(&session_state_mapper_, SIGNAL(mapped(QObject*)),
377 this, SLOT(on_capture_state_changed(QObject*)));
379 connect(&session_selector_, SIGNAL(tabCloseRequested(int)),
380 this, SLOT(on_tab_close_requested(int)));
381 connect(&session_selector_, SIGNAL(currentChanged(int)),
382 this, SLOT(on_tab_changed(int)));
385 connect(static_cast<QApplication *>(QCoreApplication::instance()),
386 SIGNAL(focusChanged(QWidget*, QWidget*)),
387 this, SLOT(on_focus_changed()));
390 void MainWindow::save_ui_settings()
395 settings.beginGroup("MainWindow");
396 settings.setValue("state", saveState());
397 settings.setValue("geometry", saveGeometry());
400 for (shared_ptr<Session> session : sessions_) {
401 // Ignore sessions using the demo device or no device at all
402 if (session->device()) {
403 shared_ptr<devices::HardwareDevice> device =
404 dynamic_pointer_cast< devices::HardwareDevice >
408 device->hardware_device()->driver()->name() == "demo")
411 settings.beginGroup("Session" + QString::number(id++));
412 settings.remove(""); // Remove all keys in this group
413 session->save_settings(settings);
418 settings.setValue("sessions", id);
421 void MainWindow::restore_ui_settings()
424 int i, session_count;
426 settings.beginGroup("MainWindow");
428 if (settings.contains("geometry")) {
429 restoreGeometry(settings.value("geometry").toByteArray());
430 restoreState(settings.value("state").toByteArray());
436 session_count = settings.value("sessions", 0).toInt();
438 for (i = 0; i < session_count; i++) {
439 settings.beginGroup("Session" + QString::number(i));
440 shared_ptr<Session> session = add_session();
441 session->restore_settings(settings);
446 std::shared_ptr<Session> MainWindow::get_tab_session(int index) const
448 // Find the session that belongs to the tab's main window
449 for (auto entry : session_windows_)
450 if (entry.second == session_selector_.widget(index))
456 void MainWindow::closeEvent(QCloseEvent *event)
462 QMenu* MainWindow::createPopupMenu()
467 bool MainWindow::restoreState(const QByteArray &state, int version)
472 // Do nothing. We don't want Qt to handle this, or else it
473 // will try to restore all the dock widgets and create havoc.
478 void MainWindow::session_error(const QString text, const QString info_text)
480 QMetaObject::invokeMethod(this, "show_session_error",
481 Qt::QueuedConnection, Q_ARG(QString, text),
482 Q_ARG(QString, info_text));
485 void MainWindow::show_session_error(const QString text, const QString info_text)
487 QMessageBox msg(this);
489 msg.setInformativeText(info_text);
490 msg.setStandardButtons(QMessageBox::Ok);
491 msg.setIcon(QMessageBox::Warning);
495 void MainWindow::on_add_view(const QString &title, views::ViewType type,
498 // We get a pointer and need a reference
499 for (std::shared_ptr<Session> s : sessions_)
500 if (s.get() == session)
501 add_view(title, type, *s);
504 void MainWindow::on_focus_changed()
506 shared_ptr<views::ViewBase> view = get_active_view();
509 for (shared_ptr<Session> session : sessions_) {
510 if (session->has_view(view)) {
511 if (session != last_focused_session_) {
512 // Activate correct tab if necessary
513 shared_ptr<Session> tab_session = get_tab_session(
514 session_selector_.currentIndex());
515 if (tab_session != session)
516 session_selector_.setCurrentWidget(
517 session_windows_.at(session));
519 on_focused_session_changed(session);
527 if (sessions_.empty())
528 setWindowTitle(WindowTitle);
531 void MainWindow::on_focused_session_changed(shared_ptr<Session> session)
533 last_focused_session_ = session;
535 setWindowTitle(session->name() + " - " + WindowTitle);
537 // Update the state of the run/stop button, too
538 on_capture_state_changed(session.get());
541 void MainWindow::on_new_session_clicked()
546 void MainWindow::on_run_stop_clicked()
548 shared_ptr<Session> session = last_focused_session_;
553 switch (session->get_capture_state()) {
554 case Session::Stopped:
555 session->start_capture([&](QString message) {
556 session_error("Capture failed", message); });
558 case Session::AwaitingTrigger:
559 case Session::Running:
560 session->stop_capture();
565 void MainWindow::on_session_name_changed()
567 // Update the corresponding dock widget's name(s)
568 Session *session = qobject_cast<Session*>(QObject::sender());
571 for (shared_ptr<views::ViewBase> view : session->views()) {
572 // Get the dock that contains the view
573 for (auto entry : view_docks_)
574 if (entry.second == view) {
575 entry.first->setObjectName(session->name());
576 entry.first->setWindowTitle(session->name());
580 // Update the tab widget by finding the main window and the tab from that
581 for (auto entry : session_windows_)
582 if (entry.first.get() == session) {
583 QMainWindow *window = entry.second;
584 const int index = session_selector_.indexOf(window);
585 session_selector_.setTabText(index, session->name());
588 // Refresh window title if the affected session has focus
589 if (session == last_focused_session_.get())
590 setWindowTitle(session->name() + " - " + WindowTitle);
593 void MainWindow::on_capture_state_changed(QObject *obj)
595 Session *caller = qobject_cast<Session*>(obj);
597 // Ignore if caller is not the currently focused session
598 // unless there is only one session
599 if ((sessions_.size() > 1) && (caller != last_focused_session_.get()))
602 int state = caller->get_capture_state();
604 const QIcon *icons[] = {&icon_grey_, &icon_red_, &icon_green_};
605 run_stop_button_->setIcon(*icons[state]);
606 run_stop_button_->setText((state == pv::Session::Stopped) ?
607 tr("Run") : tr("Stop"));
610 void MainWindow::on_new_view(Session *session)
612 // We get a pointer and need a reference
613 for (std::shared_ptr<Session> s : sessions_)
614 if (s.get() == session)
615 add_view(session->name(), views::ViewTypeTrace, *s);
618 void MainWindow::on_view_close_clicked()
620 // Find the dock widget that contains the close button that was clicked
621 QObject *w = QObject::sender();
622 QDockWidget *dock = 0;
625 dock = qobject_cast<QDockWidget*>(w);
631 // Get the view contained in the dock widget
632 shared_ptr<views::ViewBase> view;
634 for (auto entry : view_docks_)
635 if (entry.first == dock)
638 // Deregister the view
639 for (shared_ptr<Session> session : sessions_) {
640 if (!session->has_view(view))
643 // Also destroy the entire session if its main view is closing
644 if (view == session->main_view()) {
645 remove_session(session);
648 session->deregister_view(view);
652 void MainWindow::on_tab_changed(int index)
654 shared_ptr<Session> session = get_tab_session(index);
657 on_focused_session_changed(session);
660 void MainWindow::on_tab_close_requested(int index)
662 // TODO Ask user if this is intended in case data is unsaved
664 shared_ptr<Session> session = get_tab_session(index);
667 remove_session(session);
670 void MainWindow::on_actionViewStickyScrolling_triggered()
672 shared_ptr<views::ViewBase> viewbase = get_active_view();
673 views::TraceView::View* view =
674 qobject_cast<views::TraceView::View*>(viewbase.get());
676 view->enable_sticky_scrolling(action_view_sticky_scrolling_->isChecked());
679 void MainWindow::on_actionViewColouredBg_triggered()
681 shared_ptr<views::ViewBase> viewbase = get_active_view();
682 views::TraceView::View* view =
683 qobject_cast<views::TraceView::View*>(viewbase.get());
685 view->enable_coloured_bg(action_view_coloured_bg_->isChecked());
688 void MainWindow::on_actionAbout_triggered()
690 dialogs::About dlg(device_manager_.context(), this);