]> sigrok.org Git - pulseview.git/blob - pv/mainwindow.cpp
MainWindow: Improve view removal
[pulseview.git] / pv / mainwindow.cpp
1 /*
2  * This file is part of the PulseView project.
3  *
4  * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
5  *
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.
10  *
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.
15  *
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/>.
18  */
19
20 #include <cassert>
21
22 #ifdef ENABLE_DECODE
23 #include <libsigrokdecode/libsigrokdecode.h>
24 #endif
25
26 #include <algorithm>
27 #include <iterator>
28
29 #include <QAction>
30 #include <QApplication>
31 #include <QCloseEvent>
32 #include <QDockWidget>
33 #include <QHBoxLayout>
34 #include <QMessageBox>
35 #include <QSettings>
36 #include <QWidget>
37
38 #include "mainwindow.hpp"
39
40 #include "devicemanager.hpp"
41 #include "util.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"
47
48 #include <stdint.h>
49 #include <stdarg.h>
50 #include <libsigrokcxx/libsigrokcxx.hpp>
51
52 using std::dynamic_pointer_cast;
53 using std::list;
54 using std::make_shared;
55 using std::map;
56 using std::shared_ptr;
57 using std::string;
58
59 namespace pv {
60
61 namespace view {
62 class ViewItem;
63 }
64
65 using toolbars::MainBar;
66
67 const QString MainWindow::WindowTitle = tr("PulseView");
68
69 MainWindow::MainWindow(DeviceManager &device_manager,
70         string open_file_name, string open_file_format,
71         QWidget *parent) :
72         QMainWindow(parent),
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")
82 {
83         qRegisterMetaType<util::Timestamp>("util::Timestamp");
84
85         setup_ui();
86         restore_ui_settings();
87
88         if (!open_file_name.empty()) {
89                 shared_ptr<Session> session = add_session();
90                 session->load_init_file(open_file_name, open_file_format);
91         }
92
93         // Add empty default session if there aren't any sessions
94         if (sessions_.size() == 0) {
95                 shared_ptr<Session> session = add_session();
96
97                 map<string, string> dev_info;
98                 shared_ptr<devices::HardwareDevice> other_device, demo_device;
99
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") {
103                                 demo_device = dev;
104                         } else {
105                                 other_device = dev;
106                         }
107                 }
108
109                 // ...and if there isn't any, just use demo then
110                 session->select_device(other_device ? other_device : demo_device);
111         }
112 }
113
114 MainWindow::~MainWindow()
115 {
116         while (!sessions_.empty())
117                 remove_session(sessions_.front());
118 }
119
120 QAction* MainWindow::action_view_sticky_scrolling() const
121 {
122         return action_view_sticky_scrolling_;
123 }
124
125 QAction* MainWindow::action_view_coloured_bg() const
126 {
127         return action_view_coloured_bg_;
128 }
129
130 QAction* MainWindow::action_about() const
131 {
132         return action_about_;
133 }
134
135 shared_ptr<views::ViewBase> MainWindow::get_active_view() const
136 {
137         // If there's only one view, use it...
138         if (view_docks_.size() == 1)
139                 return view_docks_.begin()->second;
140
141         // ...otherwise find the dock widget the widget with focus is contained in
142         QObject *w = QApplication::focusWidget();
143         QDockWidget *dock = 0;
144
145         while (w) {
146             dock = qobject_cast<QDockWidget*>(w);
147             if (dock)
148                 break;
149             w = w->parent();
150         }
151
152         // Get the view contained in the dock widget
153         for (auto entry : view_docks_)
154                 if (entry.first == dock)
155                         return entry.second;
156
157         return nullptr;
158 }
159
160 shared_ptr<views::ViewBase> MainWindow::add_view(const QString &title,
161         views::ViewType type, Session &session)
162 {
163         QMainWindow *main_window = nullptr;
164         for (auto entry : session_windows_)
165                 if (entry.first.get() == &session)
166                         main_window = entry.second;
167
168         assert(main_window);
169
170         if (type == views::ViewTypeTrace) {
171                 QDockWidget* dock = new QDockWidget(title, main_window);
172                 dock->setObjectName(title);
173                 main_window->addDockWidget(Qt::TopDockWidgetArea, dock);
174
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
178
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);
183
184                 dock_main->setCentralWidget(v.get());
185                 dock->setWidget(dock_main);
186
187                 dock->setFeatures(QDockWidget::DockWidgetMovable |
188                         QDockWidget::DockWidgetFloatable | QDockWidget::DockWidgetClosable);
189
190                 QAbstractButton *close_btn =
191                         dock->findChildren<QAbstractButton*>
192                                 ("qt_dockwidget_closebutton").front();
193
194                 connect(close_btn, SIGNAL(clicked(bool)),
195                         this, SLOT(on_view_close_clicked()));
196
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)));
201
202                         v->enable_sticky_scrolling(action_view_sticky_scrolling_->isChecked());
203                         v->enable_coloured_bg(action_view_coloured_bg_->isChecked());
204
205                         shared_ptr<MainBar> main_bar = session.main_bar();
206                         if (!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);
211
212                                 connect(main_bar.get(), SIGNAL(new_view(Session*)),
213                                         this, SLOT(on_new_view(Session*)));
214
215                                 main_bar->action_view_show_cursors()->setChecked(v->cursors_shown());
216                         } else {
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);
221
222                                 standard_bar->action_view_show_cursors()->setChecked(v->cursors_shown());
223                         }
224                 }
225
226                 return v;
227         }
228
229         return nullptr;
230 }
231
232 void MainWindow::remove_view(shared_ptr<views::ViewBase> view)
233 {
234         for (shared_ptr<Session> session : sessions_) {
235                 if (!session->has_view(view))
236                         continue;
237
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);
243
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
248                                 view->setParent(0);
249
250                                 // Delete the view's dock widget and all widgets inside it
251                                 entry.first->deleteLater();
252
253                                 // Remove the dock widget from the list and stop iterating
254                                 view_docks_.erase(entry.first);
255                                 break;
256                         }
257         }
258 }
259
260 shared_ptr<Session> MainWindow::add_session()
261 {
262         static int last_session_id = 1;
263         QString name = tr("Untitled-%1").arg(last_session_id++);
264
265         shared_ptr<Session> session = make_shared<Session>(device_manager_, name);
266
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()));
274
275         sessions_.push_back(session);
276
277         QMainWindow *window = new QMainWindow();
278         window->setWindowFlags(Qt::Widget);  // Remove Qt::Window flag
279         session_windows_[session] = window;
280
281         int index = session_selector_.addTab(window, name);
282         session_selector_.setCurrentIndex(index);
283         last_focused_session_ = session;
284
285         window->setDockNestingEnabled(true);
286
287         shared_ptr<views::ViewBase> main_view =
288                 add_view(name, views::ViewTypeTrace, *session);
289
290         return session;
291 }
292
293 void MainWindow::remove_session(shared_ptr<Session> session)
294 {
295         int h = new_session_button_->height();
296
297         for (shared_ptr<views::ViewBase> view : session->views())
298                 remove_view(view);
299
300         QMainWindow *window = session_windows_.at(session);
301         session_selector_.removeTab(session_selector_.indexOf(window));
302
303         session_windows_.erase(session);
304
305         if (last_focused_session_ == session)
306                 last_focused_session_.reset();
307
308         sessions_.remove_if([&](shared_ptr<Session> s) {
309                 return s == session; });
310
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
314                 // widgets visible
315                 for (QWidget *w : static_tab_widget_->findChildren<QWidget*>())
316                         w->setMinimumHeight(h);
317
318                 int margin = static_tab_widget_->layout()->contentsMargins().bottom();
319                 static_tab_widget_->setMinimumHeight(h + 2 * margin);
320                 session_selector_.setMinimumHeight(h + 2 * margin);
321
322                 // Update the window title if there is no view left to
323                 // generate focus change events
324                 setWindowTitle(WindowTitle);
325         }
326 }
327
328 void MainWindow::setup_ui()
329 {
330         setObjectName(QString::fromUtf8("MainWindow"));
331
332         setCentralWidget(&session_selector_);
333
334         // Set the window icon
335         QIcon icon;
336         icon.addFile(QString(":/icons/sigrok-logo-notext.png"));
337         setWindowIcon(icon);
338
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"));
345
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"));
352
353         action_about_->setObjectName(QString::fromUtf8("actionAbout"));
354         action_about_->setToolTip(tr("&About..."));
355
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);
362
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"));
368
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);
374
375         QFrame *separator1 = new QFrame();
376         separator1->setFrameStyle(QFrame::VLine | QFrame::Raised);
377         QFrame *separator2 = new QFrame();
378         separator2->setFrameStyle(QFrame::VLine | QFrame::Raised);
379
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_);
387
388         static_tab_widget_ = new QWidget();
389         static_tab_widget_->setLayout(layout);
390
391         session_selector_.setCornerWidget(static_tab_widget_, Qt::TopLeftCorner);
392         session_selector_.setTabsClosable(true);
393
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*)));
400
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)));
405
406
407         connect(static_cast<QApplication *>(QCoreApplication::instance()),
408                 SIGNAL(focusChanged(QWidget*, QWidget*)),
409                 this, SLOT(on_focus_changed()));
410 }
411
412 void MainWindow::save_ui_settings()
413 {
414         QSettings settings;
415         int id = 0;
416
417         settings.beginGroup("MainWindow");
418         settings.setValue("state", saveState());
419         settings.setValue("geometry", saveGeometry());
420         settings.endGroup();
421
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 >
427                                 (session->device());
428
429                         if (device &&
430                                 device->hardware_device()->driver()->name() == "demo")
431                                 continue;
432
433                         settings.beginGroup("Session" + QString::number(id++));
434                         settings.remove("");  // Remove all keys in this group
435                         session->save_settings(settings);
436                         settings.endGroup();
437                 }
438         }
439
440         settings.setValue("sessions", id);
441 }
442
443 void MainWindow::restore_ui_settings()
444 {
445         QSettings settings;
446         int i, session_count;
447
448         settings.beginGroup("MainWindow");
449
450         if (settings.contains("geometry")) {
451                 restoreGeometry(settings.value("geometry").toByteArray());
452                 restoreState(settings.value("state").toByteArray());
453         } else
454                 resize(1000, 720);
455
456         settings.endGroup();
457
458         session_count = settings.value("sessions", 0).toInt();
459
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);
464                 settings.endGroup();
465         }
466 }
467
468 std::shared_ptr<Session> MainWindow::get_tab_session(int index) const
469 {
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))
473                         return entry.first;
474
475         return nullptr;
476 }
477
478 void MainWindow::closeEvent(QCloseEvent *event)
479 {
480         save_ui_settings();
481         event->accept();
482 }
483
484 QMenu* MainWindow::createPopupMenu()
485 {
486         return nullptr;
487 }
488
489 bool MainWindow::restoreState(const QByteArray &state, int version)
490 {
491         (void)state;
492         (void)version;
493
494         // Do nothing. We don't want Qt to handle this, or else it
495         // will try to restore all the dock widgets and create havoc.
496
497         return false;
498 }
499
500 void MainWindow::session_error(const QString text, const QString info_text)
501 {
502         QMetaObject::invokeMethod(this, "show_session_error",
503                 Qt::QueuedConnection, Q_ARG(QString, text),
504                 Q_ARG(QString, info_text));
505 }
506
507 void MainWindow::show_session_error(const QString text, const QString info_text)
508 {
509         QMessageBox msg(this);
510         msg.setText(text);
511         msg.setInformativeText(info_text);
512         msg.setStandardButtons(QMessageBox::Ok);
513         msg.setIcon(QMessageBox::Warning);
514         msg.exec();
515 }
516
517 void MainWindow::on_add_view(const QString &title, views::ViewType type,
518         Session *session)
519 {
520         // We get a pointer and need a reference
521         for (std::shared_ptr<Session> s : sessions_)
522                 if (s.get() == session)
523                         add_view(title, type, *s);
524 }
525
526 void MainWindow::on_focus_changed()
527 {
528         shared_ptr<views::ViewBase> view = get_active_view();
529
530         if (view) {
531                 for (shared_ptr<Session> session : sessions_) {
532                         if (session->has_view(view)) {
533                                 if (session != last_focused_session_) {
534                                         // Activate correct tab if necessary
535                                         shared_ptr<Session> tab_session = get_tab_session(
536                                                 session_selector_.currentIndex());
537                                         if (tab_session != session)
538                                                 session_selector_.setCurrentWidget(
539                                                         session_windows_.at(session));
540
541                                         on_focused_session_changed(session);
542                                 }
543
544                                 break;
545                         }
546                 }
547         }
548
549         if (sessions_.empty())
550                 setWindowTitle(WindowTitle);
551 }
552
553 void MainWindow::on_focused_session_changed(shared_ptr<Session> session)
554 {
555         last_focused_session_ = session;
556
557         setWindowTitle(session->name() + " - " + WindowTitle);
558
559         // Update the state of the run/stop button, too
560         on_capture_state_changed(session.get());
561 }
562
563 void MainWindow::on_new_session_clicked()
564 {
565         add_session();
566 }
567
568 void MainWindow::on_run_stop_clicked()
569 {
570         shared_ptr<Session> session = last_focused_session_;
571
572         if (!session)
573                 return;
574
575         switch (session->get_capture_state()) {
576         case Session::Stopped:
577                 session->start_capture([&](QString message) {
578                         session_error("Capture failed", message); });
579                 break;
580         case Session::AwaitingTrigger:
581         case Session::Running:
582                 session->stop_capture();
583                 break;
584         }
585 }
586
587 void MainWindow::on_session_name_changed()
588 {
589         // Update the corresponding dock widget's name(s)
590         Session *session = qobject_cast<Session*>(QObject::sender());
591         assert(session);
592
593         for (shared_ptr<views::ViewBase> view : session->views()) {
594                 // Get the dock that contains the view
595                 for (auto entry : view_docks_)
596                         if (entry.second == view) {
597                                 entry.first->setObjectName(session->name());
598                                 entry.first->setWindowTitle(session->name());
599                         }
600         }
601
602         // Update the tab widget by finding the main window and the tab from that
603         for (auto entry : session_windows_)
604                 if (entry.first.get() == session) {
605                         QMainWindow *window = entry.second;
606                         const int index = session_selector_.indexOf(window);
607                         session_selector_.setTabText(index, session->name());
608                 }
609
610         // Refresh window title if the affected session has focus
611         if (session == last_focused_session_.get())
612                 setWindowTitle(session->name() + " - " + WindowTitle);
613 }
614
615 void MainWindow::on_capture_state_changed(QObject *obj)
616 {
617         Session *caller = qobject_cast<Session*>(obj);
618
619         // Ignore if caller is not the currently focused session
620         // unless there is only one session
621         if ((sessions_.size() > 1) && (caller != last_focused_session_.get()))
622                 return;
623
624         int state = caller->get_capture_state();
625
626         const QIcon *icons[] = {&icon_grey_, &icon_red_, &icon_green_};
627         run_stop_button_->setIcon(*icons[state]);
628         run_stop_button_->setText((state == pv::Session::Stopped) ?
629                 tr("Run") : tr("Stop"));
630 }
631
632 void MainWindow::on_new_view(Session *session)
633 {
634         // We get a pointer and need a reference
635         for (std::shared_ptr<Session> s : sessions_)
636                 if (s.get() == session)
637                         add_view(session->name(), views::ViewTypeTrace, *s);
638 }
639
640 void MainWindow::on_view_close_clicked()
641 {
642         // Find the dock widget that contains the close button that was clicked
643         QObject *w = QObject::sender();
644         QDockWidget *dock = 0;
645
646         while (w) {
647             dock = qobject_cast<QDockWidget*>(w);
648             if (dock)
649                 break;
650             w = w->parent();
651         }
652
653         // Get the view contained in the dock widget
654         shared_ptr<views::ViewBase> view;
655
656         for (auto entry : view_docks_)
657                 if (entry.first == dock)
658                         view = entry.second;
659
660         // Deregister the view
661         for (shared_ptr<Session> session : sessions_) {
662                 if (!session->has_view(view))
663                         continue;
664
665                 // Also destroy the entire session if its main view is closing
666                 if (view == session->main_view()) {
667                         remove_session(session);
668                         break;
669                 } else
670                         remove_view(view);
671         }
672 }
673
674 void MainWindow::on_tab_changed(int index)
675 {
676         shared_ptr<Session> session = get_tab_session(index);
677
678         if (session)
679                 on_focused_session_changed(session);
680 }
681
682 void MainWindow::on_tab_close_requested(int index)
683 {
684         // TODO Ask user if this is intended in case data is unsaved
685
686         shared_ptr<Session> session = get_tab_session(index);
687
688         if (session)
689                 remove_session(session);
690 }
691
692 void MainWindow::on_actionViewStickyScrolling_triggered()
693 {
694         shared_ptr<views::ViewBase> viewbase = get_active_view();
695         views::TraceView::View* view =
696                 qobject_cast<views::TraceView::View*>(viewbase.get());
697         if (view)
698                 view->enable_sticky_scrolling(action_view_sticky_scrolling_->isChecked());
699 }
700
701 void MainWindow::on_actionViewColouredBg_triggered()
702 {
703         shared_ptr<views::ViewBase> viewbase = get_active_view();
704         views::TraceView::View* view =
705                         qobject_cast<views::TraceView::View*>(viewbase.get());
706         if (view)
707                 view->enable_coloured_bg(action_view_coloured_bg_->isChecked());
708 }
709
710 void MainWindow::on_actionAbout_triggered()
711 {
712         dialogs::About dlg(device_manager_.context(), this);
713         dlg.exec();
714 }
715
716 } // namespace pv