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