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->main_bar()->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->main_bar()->select_device(other_device ?
111 other_device : demo_device);
115 MainWindow::~MainWindow()
117 while (!sessions_.empty())
118 remove_session(sessions_.front());
121 QAction* MainWindow::action_view_sticky_scrolling() const
123 return action_view_sticky_scrolling_;
126 QAction* MainWindow::action_view_coloured_bg() const
128 return action_view_coloured_bg_;
131 QAction* MainWindow::action_about() const
133 return action_about_;
136 shared_ptr<views::ViewBase> MainWindow::get_active_view() const
138 // If there's only one view, use it...
139 if (view_docks_.size() == 1)
140 return view_docks_.begin()->second;
142 // ...otherwise find the dock widget the widget with focus is contained in
143 QObject *w = QApplication::focusWidget();
144 QDockWidget *dock = 0;
147 dock = qobject_cast<QDockWidget*>(w);
153 // Get the view contained in the dock widget
154 for (auto entry : view_docks_)
155 if (entry.first == dock)
161 shared_ptr<views::ViewBase> MainWindow::add_view(const QString &title,
162 views::ViewType type, Session &session)
164 QMainWindow *main_window;
165 for (auto entry : session_windows_)
166 if (entry.first.get() == &session)
167 main_window = entry.second;
171 if (type == views::ViewTypeTrace) {
172 QDockWidget* dock = new QDockWidget(title, main_window);
173 dock->setObjectName(title);
174 main_window->addDockWidget(Qt::TopDockWidgetArea, dock);
176 // Insert a QMainWindow into the dock widget to allow for a tool bar
177 QMainWindow *dock_main = new QMainWindow(dock);
178 dock_main->setWindowFlags(Qt::Widget); // Remove Qt::Window flag
180 shared_ptr<views::TraceView::View> v =
181 make_shared<views::TraceView::View>(session, dock_main);
182 view_docks_[dock] = v;
183 session.register_view(v);
185 dock_main->setCentralWidget(v.get());
186 dock->setWidget(dock_main);
188 dock->setFeatures(QDockWidget::DockWidgetMovable |
189 QDockWidget::DockWidgetFloatable | QDockWidget::DockWidgetClosable);
191 QAbstractButton *close_btn =
192 dock->findChildren<QAbstractButton*>
193 ("qt_dockwidget_closebutton").front();
195 connect(close_btn, SIGNAL(clicked(bool)),
196 this, SLOT(on_view_close_clicked()));
198 if (type == views::ViewTypeTrace) {
199 connect(&session, SIGNAL(trigger_event(util::Timestamp)),
200 qobject_cast<views::ViewBase*>(v.get()),
201 SLOT(trigger_event(util::Timestamp)));
203 v->enable_sticky_scrolling(action_view_sticky_scrolling_->isChecked());
204 v->enable_coloured_bg(action_view_coloured_bg_->isChecked());
206 shared_ptr<MainBar> main_bar = session.main_bar();
208 main_bar = make_shared<MainBar>(session, *this);
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 connect(v.get(), SIGNAL(always_zoom_to_fit_changed(bool)),
218 main_bar.get(), SLOT(on_always_zoom_to_fit_changed(bool)));
227 shared_ptr<Session> MainWindow::add_session()
229 static int last_session_id = 1;
230 QString name = tr("Untitled-%1").arg(last_session_id++);
232 shared_ptr<Session> session = make_shared<Session>(device_manager_, name);
234 connect(session.get(), SIGNAL(add_view(const QString&, views::ViewType, Session*)),
235 this, SLOT(on_add_view(const QString&, views::ViewType, Session*)));
236 connect(session.get(), SIGNAL(name_changed()),
237 this, SLOT(on_session_name_changed()));
238 session_state_mapper_.setMapping(session.get(), session.get());
239 connect(session.get(), SIGNAL(capture_state_changed(int)),
240 &session_state_mapper_, SLOT(map()));
242 sessions_.push_back(session);
244 QMainWindow *window = new QMainWindow();
245 window->setWindowFlags(Qt::Widget); // Remove Qt::Window flag
246 session_windows_[session] = window;
248 int index = session_selector_.addTab(window, name);
249 session_selector_.setCurrentIndex(index);
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 sessions_.remove_if([&](shared_ptr<Session> s) {
287 return s == session; });
289 if (sessions_.empty()) {
290 // When there are no more tabs, the height of the QTabWidget
291 // drops to zero. We must prevent this to keep the static
293 for (QWidget *w : static_tab_widget_->findChildren<QWidget*>())
294 w->setMinimumHeight(h);
296 int margin = static_tab_widget_->layout()->contentsMargins().bottom();
297 static_tab_widget_->setMinimumHeight(h + 2 * margin);
298 session_selector_.setMinimumHeight(h + 2 * margin);
300 // Update the window title if there is no view left to
301 // generate focus change events
302 setWindowTitle(WindowTitle);
306 void MainWindow::setup_ui()
308 setObjectName(QString::fromUtf8("MainWindow"));
310 setCentralWidget(&session_selector_);
312 // Set the window icon
314 icon.addFile(QString(":/icons/sigrok-logo-notext.png"));
317 action_view_sticky_scrolling_->setCheckable(true);
318 action_view_sticky_scrolling_->setChecked(true);
319 action_view_sticky_scrolling_->setShortcut(QKeySequence(Qt::Key_S));
320 action_view_sticky_scrolling_->setObjectName(
321 QString::fromUtf8("actionViewStickyScrolling"));
322 action_view_sticky_scrolling_->setText(tr("&Sticky Scrolling"));
324 action_view_coloured_bg_->setCheckable(true);
325 action_view_coloured_bg_->setChecked(true);
326 action_view_coloured_bg_->setShortcut(QKeySequence(Qt::Key_B));
327 action_view_coloured_bg_->setObjectName(
328 QString::fromUtf8("actionViewColouredBg"));
329 action_view_coloured_bg_->setText(tr("Use &coloured backgrounds"));
331 action_about_->setObjectName(QString::fromUtf8("actionAbout"));
332 action_about_->setText(tr("&About..."));
334 // Set up the tab area
335 new_session_button_ = new QToolButton();
336 new_session_button_->setIcon(QIcon::fromTheme("document-new",
337 QIcon(":/icons/document-new.png")));
338 new_session_button_->setAutoRaise(true);
340 run_stop_button_ = new QToolButton();
341 run_stop_button_->setAutoRaise(true);
342 run_stop_button_->setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
343 run_stop_button_->setShortcut(QKeySequence(Qt::Key_Space));
345 QHBoxLayout* layout = new QHBoxLayout();
346 layout->setContentsMargins(2, 2, 2, 2);
347 layout->addWidget(new_session_button_);
348 layout->addWidget(run_stop_button_);
350 static_tab_widget_ = new QWidget();
351 static_tab_widget_->setLayout(layout);
353 session_selector_.setCornerWidget(static_tab_widget_, Qt::TopLeftCorner);
354 session_selector_.setTabsClosable(true);
356 connect(new_session_button_, SIGNAL(clicked(bool)),
357 this, SLOT(on_new_session_clicked()));
358 connect(run_stop_button_, SIGNAL(clicked(bool)),
359 this, SLOT(on_run_stop_clicked()));
360 connect(&session_state_mapper_, SIGNAL(mapped(QObject*)),
361 this, SLOT(on_capture_state_changed(QObject*)));
363 connect(&session_selector_, SIGNAL(tabCloseRequested(int)),
364 this, SLOT(on_tab_close_requested(int)));
365 connect(&session_selector_, SIGNAL(currentChanged(int)),
366 this, SLOT(on_tab_changed(int)));
369 connect(static_cast<QApplication *>(QCoreApplication::instance()),
370 SIGNAL(focusChanged(QWidget*, QWidget*)),
371 this, SLOT(on_focus_changed()));
374 void MainWindow::save_ui_settings()
379 settings.beginGroup("MainWindow");
380 settings.setValue("state", saveState());
381 settings.setValue("geometry", saveGeometry());
384 for (shared_ptr<Session> session : sessions_) {
385 // Ignore sessions using the demo device or no device at all
386 if (session->device()) {
387 shared_ptr<devices::HardwareDevice> device =
388 dynamic_pointer_cast< devices::HardwareDevice >
392 device->hardware_device()->driver()->name() == "demo")
395 settings.beginGroup("Session" + QString::number(id++));
396 settings.remove(""); // Remove all keys in this group
397 session->save_settings(settings);
402 settings.setValue("sessions", id);
405 void MainWindow::restore_ui_settings()
408 int i, session_count;
410 settings.beginGroup("MainWindow");
412 if (settings.contains("geometry")) {
413 restoreGeometry(settings.value("geometry").toByteArray());
414 restoreState(settings.value("state").toByteArray());
420 session_count = settings.value("sessions", 0).toInt();
422 for (i = 0; i < session_count; i++) {
423 settings.beginGroup("Session" + QString::number(i));
424 shared_ptr<Session> session = add_session();
425 session->restore_settings(settings);
430 std::shared_ptr<Session> MainWindow::get_tab_session(int index) const
432 // Find the session that belongs to the tab's main window
433 for (auto entry : session_windows_)
434 if (entry.second == session_selector_.widget(index))
440 void MainWindow::closeEvent(QCloseEvent *event)
446 QMenu* MainWindow::createPopupMenu()
451 bool MainWindow::restoreState(const QByteArray &state, int version)
456 // Do nothing. We don't want Qt to handle this, or else it
457 // will try to restore all the dock widgets and create havoc.
462 void MainWindow::session_error(const QString text, const QString info_text)
464 QMetaObject::invokeMethod(this, "show_session_error",
465 Qt::QueuedConnection, Q_ARG(QString, text),
466 Q_ARG(QString, info_text));
469 void MainWindow::show_session_error(const QString text, const QString info_text)
471 QMessageBox msg(this);
473 msg.setInformativeText(info_text);
474 msg.setStandardButtons(QMessageBox::Ok);
475 msg.setIcon(QMessageBox::Warning);
479 void MainWindow::on_add_view(const QString &title, views::ViewType type,
482 // We get a pointer and need a reference
483 for (std::shared_ptr<Session> s : sessions_)
484 if (s.get() == session)
485 add_view(title, type, *s);
488 void MainWindow::on_focus_changed()
490 static shared_ptr<Session> prev_session;
492 shared_ptr<views::ViewBase> view = get_active_view();
495 for (shared_ptr<Session> session : sessions_) {
496 if (session->has_view(view)) {
497 if (session != prev_session) {
498 // Activate correct tab if necessary
499 shared_ptr<Session> tab_session = get_tab_session(
500 session_selector_.currentIndex());
501 if (tab_session != session)
502 session_selector_.setCurrentWidget(
503 session_windows_.at(session));
505 on_focused_session_changed(session);
508 prev_session = session;
514 if (sessions_.empty())
515 setWindowTitle(WindowTitle);
518 void MainWindow::on_focused_session_changed(shared_ptr<Session> session)
520 setWindowTitle(session->name() + " - " + WindowTitle);
522 // Update the state of the run/stop button, too
523 on_capture_state_changed(session.get());
526 void MainWindow::on_new_session_clicked()
531 void MainWindow::on_run_stop_clicked()
533 Session &session = get_active_view()->session();
535 switch (session.get_capture_state()) {
536 case Session::Stopped:
537 session.start_capture([&](QString message) {
538 session_error("Capture failed", message); });
540 case Session::AwaitingTrigger:
541 case Session::Running:
542 session.stop_capture();
547 void MainWindow::on_session_name_changed()
549 // Update the corresponding dock widget's name(s)
550 Session *session = qobject_cast<Session*>(QObject::sender());
553 for (shared_ptr<views::ViewBase> view : session->views()) {
554 // Get the dock that contains the view
555 for (auto entry : view_docks_)
556 if (entry.second == view) {
557 entry.first->setObjectName(session->name());
558 entry.first->setWindowTitle(session->name());
562 // Refresh window title if the affected session has focus
563 shared_ptr<views::ViewBase> view = get_active_view();
565 if (view && session->has_view(view))
566 setWindowTitle(session->name() + " - " + WindowTitle);
569 void MainWindow::on_capture_state_changed(QObject *obj)
571 Session *caller = qobject_cast<Session*>(obj);
573 // Ignore if caller is not the currently focused session
574 // unless there is only one session
575 if (sessions_.size() > 1) {
576 Session &focused_session = get_active_view()->session();
578 if (caller != &focused_session)
582 int state = caller->get_capture_state();
584 const QIcon *icons[] = {&icon_grey_, &icon_red_, &icon_green_};
585 run_stop_button_->setIcon(*icons[state]);
586 run_stop_button_->setText((state == pv::Session::Stopped) ?
587 tr("Run") : tr("Stop"));
590 void MainWindow::on_new_view(Session *session)
592 // We get a pointer and need a reference
593 for (std::shared_ptr<Session> s : sessions_)
594 if (s.get() == session)
595 add_view(session->name(), views::ViewTypeTrace, *s);
598 void MainWindow::on_view_close_clicked()
600 // Find the dock widget that contains the close button that was clicked
601 QObject *w = QObject::sender();
602 QDockWidget *dock = 0;
605 dock = qobject_cast<QDockWidget*>(w);
611 // Get the view contained in the dock widget
612 shared_ptr<views::ViewBase> view;
614 for (auto entry : view_docks_)
615 if (entry.first == dock)
618 // Deregister the view
619 for (shared_ptr<Session> session : sessions_) {
620 if (!session->has_view(view))
623 // Also destroy the entire session if its main view is closing
624 if (view == session->main_view()) {
625 remove_session(session);
628 session->deregister_view(view);
632 void MainWindow::on_tab_changed(int index)
634 shared_ptr<Session> session = get_tab_session(index);
637 on_focused_session_changed(session);
640 void MainWindow::on_tab_close_requested(int index)
642 // TODO Ask user if this is intended in case data is unsaved
644 shared_ptr<Session> session = get_tab_session(index);
647 remove_session(session);
650 void MainWindow::on_actionViewStickyScrolling_triggered()
652 shared_ptr<views::ViewBase> viewbase = get_active_view();
653 views::TraceView::View* view =
654 qobject_cast<views::TraceView::View*>(viewbase.get());
656 view->enable_sticky_scrolling(action_view_sticky_scrolling_->isChecked());
659 void MainWindow::on_actionViewColouredBg_triggered()
661 shared_ptr<views::ViewBase> viewbase = get_active_view();
662 views::TraceView::View* view =
663 qobject_cast<views::TraceView::View*>(viewbase.get());
665 view->enable_coloured_bg(action_view_coloured_bg_->isChecked());
668 void MainWindow::on_actionAbout_triggered()
670 dialogs::About dlg(device_manager_.context(), this);