]> sigrok.org Git - pulseview.git/blob - pv/mainwindow.cpp
DecoderStack: Fix "data may be unitialized" error
[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 = nullptr;
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
216                                 main_bar->action_view_show_cursors()->setChecked(v->cursors_shown());
217                         } else {
218                                 /* Additional view, create a standard bar */
219                                 pv::views::trace::StandardBar *standard_bar =
220                                         new pv::views::trace::StandardBar(session, this, v.get());
221                                 dock_main->addToolBar(standard_bar);
222
223                                 standard_bar->action_view_show_cursors()->setChecked(v->cursors_shown());
224                         }
225                 }
226
227                 return v;
228         }
229
230         return nullptr;
231 }
232
233 shared_ptr<Session> MainWindow::add_session()
234 {
235         static int last_session_id = 1;
236         QString name = tr("Untitled-%1").arg(last_session_id++);
237
238         shared_ptr<Session> session = make_shared<Session>(device_manager_, name);
239
240         connect(session.get(), SIGNAL(add_view(const QString&, views::ViewType, Session*)),
241                 this, SLOT(on_add_view(const QString&, views::ViewType, Session*)));
242         connect(session.get(), SIGNAL(name_changed()),
243                 this, SLOT(on_session_name_changed()));
244         session_state_mapper_.setMapping(session.get(), session.get());
245         connect(session.get(), SIGNAL(capture_state_changed(int)),
246                 &session_state_mapper_, SLOT(map()));
247
248         sessions_.push_back(session);
249
250         QMainWindow *window = new QMainWindow();
251         window->setWindowFlags(Qt::Widget);  // Remove Qt::Window flag
252         session_windows_[session] = window;
253
254         int index = session_selector_.addTab(window, name);
255         session_selector_.setCurrentIndex(index);
256         last_focused_session_ = session;
257
258         window->setDockNestingEnabled(true);
259
260         shared_ptr<views::ViewBase> main_view =
261                 add_view(name, views::ViewTypeTrace, *session);
262
263         return session;
264 }
265
266 void MainWindow::remove_session(shared_ptr<Session> session)
267 {
268         int h = new_session_button_->height();
269
270         for (shared_ptr<views::ViewBase> view : session->views()) {
271                 // Find the dock the view is contained in and remove it
272                 for (auto entry : view_docks_)
273                         if (entry.second == view) {
274                                 // Remove the view from the session
275                                 session->deregister_view(view);
276
277                                 // Remove the view from its parent; otherwise, Qt will
278                                 // call deleteLater() on it, which causes a double free
279                                 // since the shared_ptr in view_docks_ doesn't know
280                                 // that Qt keeps a pointer to the view around
281                                 entry.second->setParent(0);
282
283                                 // Remove this entry from the container
284                                 view_docks_.erase(entry.first);
285                         }
286         }
287
288         QMainWindow *window = session_windows_.at(session);
289         session_selector_.removeTab(session_selector_.indexOf(window));
290
291         session_windows_.erase(session);
292
293         if (last_focused_session_ == session)
294                 last_focused_session_.reset();
295
296         sessions_.remove_if([&](shared_ptr<Session> s) {
297                 return s == session; });
298
299         if (sessions_.empty()) {
300                 // When there are no more tabs, the height of the QTabWidget
301                 // drops to zero. We must prevent this to keep the static
302                 // widgets visible
303                 for (QWidget *w : static_tab_widget_->findChildren<QWidget*>())
304                         w->setMinimumHeight(h);
305
306                 int margin = static_tab_widget_->layout()->contentsMargins().bottom();
307                 static_tab_widget_->setMinimumHeight(h + 2 * margin);
308                 session_selector_.setMinimumHeight(h + 2 * margin);
309
310                 // Update the window title if there is no view left to
311                 // generate focus change events
312                 setWindowTitle(WindowTitle);
313         }
314 }
315
316 void MainWindow::setup_ui()
317 {
318         setObjectName(QString::fromUtf8("MainWindow"));
319
320         setCentralWidget(&session_selector_);
321
322         // Set the window icon
323         QIcon icon;
324         icon.addFile(QString(":/icons/sigrok-logo-notext.png"));
325         setWindowIcon(icon);
326
327         action_view_sticky_scrolling_->setCheckable(true);
328         action_view_sticky_scrolling_->setChecked(true);
329         action_view_sticky_scrolling_->setShortcut(QKeySequence(Qt::Key_S));
330         action_view_sticky_scrolling_->setObjectName(
331                 QString::fromUtf8("actionViewStickyScrolling"));
332         action_view_sticky_scrolling_->setText(tr("&Sticky Scrolling"));
333
334         action_view_coloured_bg_->setCheckable(true);
335         action_view_coloured_bg_->setChecked(true);
336         action_view_coloured_bg_->setShortcut(QKeySequence(Qt::Key_B));
337         action_view_coloured_bg_->setObjectName(
338                 QString::fromUtf8("actionViewColouredBg"));
339         action_view_coloured_bg_->setText(tr("Use &coloured backgrounds"));
340
341         action_about_->setObjectName(QString::fromUtf8("actionAbout"));
342         action_about_->setText(tr("&About..."));
343
344         // Set up the tab area
345         new_session_button_ = new QToolButton();
346         new_session_button_->setIcon(QIcon::fromTheme("document-new",
347                 QIcon(":/icons/document-new.png")));
348         new_session_button_->setAutoRaise(true);
349
350         run_stop_button_ = new QToolButton();
351         run_stop_button_->setAutoRaise(true);
352         run_stop_button_->setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
353         run_stop_button_->setShortcut(QKeySequence(Qt::Key_Space));
354
355         settings_button_ = new QToolButton();
356         settings_button_->setIcon(QIcon::fromTheme("configure",
357                 QIcon(":/icons/configure.png")));
358         settings_button_->setAutoRaise(true);
359
360         QFrame *separator1 = new QFrame();
361         separator1->setFrameStyle(QFrame::VLine | QFrame::Raised);
362         QFrame *separator2 = new QFrame();
363         separator2->setFrameStyle(QFrame::VLine | QFrame::Raised);
364
365         QHBoxLayout* layout = new QHBoxLayout();
366         layout->setContentsMargins(2, 2, 2, 2);
367         layout->addWidget(new_session_button_);
368         layout->addWidget(separator1);
369         layout->addWidget(run_stop_button_);
370         layout->addWidget(separator2);
371         layout->addWidget(settings_button_);
372
373         static_tab_widget_ = new QWidget();
374         static_tab_widget_->setLayout(layout);
375
376         session_selector_.setCornerWidget(static_tab_widget_, Qt::TopLeftCorner);
377         session_selector_.setTabsClosable(true);
378
379         connect(new_session_button_, SIGNAL(clicked(bool)),
380                 this, SLOT(on_new_session_clicked()));
381         connect(run_stop_button_, SIGNAL(clicked(bool)),
382                 this, SLOT(on_run_stop_clicked()));
383         connect(&session_state_mapper_, SIGNAL(mapped(QObject*)),
384                 this, SLOT(on_capture_state_changed(QObject*)));
385
386         connect(&session_selector_, SIGNAL(tabCloseRequested(int)),
387                 this, SLOT(on_tab_close_requested(int)));
388         connect(&session_selector_, SIGNAL(currentChanged(int)),
389                 this, SLOT(on_tab_changed(int)));
390
391
392         connect(static_cast<QApplication *>(QCoreApplication::instance()),
393                 SIGNAL(focusChanged(QWidget*, QWidget*)),
394                 this, SLOT(on_focus_changed()));
395 }
396
397 void MainWindow::save_ui_settings()
398 {
399         QSettings settings;
400         int id = 0;
401
402         settings.beginGroup("MainWindow");
403         settings.setValue("state", saveState());
404         settings.setValue("geometry", saveGeometry());
405         settings.endGroup();
406
407         for (shared_ptr<Session> session : sessions_) {
408                 // Ignore sessions using the demo device or no device at all
409                 if (session->device()) {
410                         shared_ptr<devices::HardwareDevice> device =
411                                 dynamic_pointer_cast< devices::HardwareDevice >
412                                 (session->device());
413
414                         if (device &&
415                                 device->hardware_device()->driver()->name() == "demo")
416                                 continue;
417
418                         settings.beginGroup("Session" + QString::number(id++));
419                         settings.remove("");  // Remove all keys in this group
420                         session->save_settings(settings);
421                         settings.endGroup();
422                 }
423         }
424
425         settings.setValue("sessions", id);
426 }
427
428 void MainWindow::restore_ui_settings()
429 {
430         QSettings settings;
431         int i, session_count;
432
433         settings.beginGroup("MainWindow");
434
435         if (settings.contains("geometry")) {
436                 restoreGeometry(settings.value("geometry").toByteArray());
437                 restoreState(settings.value("state").toByteArray());
438         } else
439                 resize(1000, 720);
440
441         settings.endGroup();
442
443         session_count = settings.value("sessions", 0).toInt();
444
445         for (i = 0; i < session_count; i++) {
446                 settings.beginGroup("Session" + QString::number(i));
447                 shared_ptr<Session> session = add_session();
448                 session->restore_settings(settings);
449                 settings.endGroup();
450         }
451 }
452
453 std::shared_ptr<Session> MainWindow::get_tab_session(int index) const
454 {
455         // Find the session that belongs to the tab's main window
456         for (auto entry : session_windows_)
457                 if (entry.second == session_selector_.widget(index))
458                         return entry.first;
459
460         return nullptr;
461 }
462
463 void MainWindow::closeEvent(QCloseEvent *event)
464 {
465         save_ui_settings();
466         event->accept();
467 }
468
469 QMenu* MainWindow::createPopupMenu()
470 {
471         return nullptr;
472 }
473
474 bool MainWindow::restoreState(const QByteArray &state, int version)
475 {
476         (void)state;
477         (void)version;
478
479         // Do nothing. We don't want Qt to handle this, or else it
480         // will try to restore all the dock widgets and create havoc.
481
482         return false;
483 }
484
485 void MainWindow::session_error(const QString text, const QString info_text)
486 {
487         QMetaObject::invokeMethod(this, "show_session_error",
488                 Qt::QueuedConnection, Q_ARG(QString, text),
489                 Q_ARG(QString, info_text));
490 }
491
492 void MainWindow::show_session_error(const QString text, const QString info_text)
493 {
494         QMessageBox msg(this);
495         msg.setText(text);
496         msg.setInformativeText(info_text);
497         msg.setStandardButtons(QMessageBox::Ok);
498         msg.setIcon(QMessageBox::Warning);
499         msg.exec();
500 }
501
502 void MainWindow::on_add_view(const QString &title, views::ViewType type,
503         Session *session)
504 {
505         // We get a pointer and need a reference
506         for (std::shared_ptr<Session> s : sessions_)
507                 if (s.get() == session)
508                         add_view(title, type, *s);
509 }
510
511 void MainWindow::on_focus_changed()
512 {
513         shared_ptr<views::ViewBase> view = get_active_view();
514
515         if (view) {
516                 for (shared_ptr<Session> session : sessions_) {
517                         if (session->has_view(view)) {
518                                 if (session != last_focused_session_) {
519                                         // Activate correct tab if necessary
520                                         shared_ptr<Session> tab_session = get_tab_session(
521                                                 session_selector_.currentIndex());
522                                         if (tab_session != session)
523                                                 session_selector_.setCurrentWidget(
524                                                         session_windows_.at(session));
525
526                                         on_focused_session_changed(session);
527                                 }
528
529                                 break;
530                         }
531                 }
532         }
533
534         if (sessions_.empty())
535                 setWindowTitle(WindowTitle);
536 }
537
538 void MainWindow::on_focused_session_changed(shared_ptr<Session> session)
539 {
540         last_focused_session_ = session;
541
542         setWindowTitle(session->name() + " - " + WindowTitle);
543
544         // Update the state of the run/stop button, too
545         on_capture_state_changed(session.get());
546 }
547
548 void MainWindow::on_new_session_clicked()
549 {
550         add_session();
551 }
552
553 void MainWindow::on_run_stop_clicked()
554 {
555         shared_ptr<Session> session = last_focused_session_;
556
557         if (!session)
558                 return;
559
560         switch (session->get_capture_state()) {
561         case Session::Stopped:
562                 session->start_capture([&](QString message) {
563                         session_error("Capture failed", message); });
564                 break;
565         case Session::AwaitingTrigger:
566         case Session::Running:
567                 session->stop_capture();
568                 break;
569         }
570 }
571
572 void MainWindow::on_session_name_changed()
573 {
574         // Update the corresponding dock widget's name(s)
575         Session *session = qobject_cast<Session*>(QObject::sender());
576         assert(session);
577
578         for (shared_ptr<views::ViewBase> view : session->views()) {
579                 // Get the dock that contains the view
580                 for (auto entry : view_docks_)
581                         if (entry.second == view) {
582                                 entry.first->setObjectName(session->name());
583                                 entry.first->setWindowTitle(session->name());
584                         }
585         }
586
587         // Update the tab widget by finding the main window and the tab from that
588         for (auto entry : session_windows_)
589                 if (entry.first.get() == session) {
590                         QMainWindow *window = entry.second;
591                         const int index = session_selector_.indexOf(window);
592                         session_selector_.setTabText(index, session->name());
593                 }
594
595         // Refresh window title if the affected session has focus
596         if (session == last_focused_session_.get())
597                 setWindowTitle(session->name() + " - " + WindowTitle);
598 }
599
600 void MainWindow::on_capture_state_changed(QObject *obj)
601 {
602         Session *caller = qobject_cast<Session*>(obj);
603
604         // Ignore if caller is not the currently focused session
605         // unless there is only one session
606         if ((sessions_.size() > 1) && (caller != last_focused_session_.get()))
607                 return;
608
609         int state = caller->get_capture_state();
610
611         const QIcon *icons[] = {&icon_grey_, &icon_red_, &icon_green_};
612         run_stop_button_->setIcon(*icons[state]);
613         run_stop_button_->setText((state == pv::Session::Stopped) ?
614                 tr("Run") : tr("Stop"));
615 }
616
617 void MainWindow::on_new_view(Session *session)
618 {
619         // We get a pointer and need a reference
620         for (std::shared_ptr<Session> s : sessions_)
621                 if (s.get() == session)
622                         add_view(session->name(), views::ViewTypeTrace, *s);
623 }
624
625 void MainWindow::on_view_close_clicked()
626 {
627         // Find the dock widget that contains the close button that was clicked
628         QObject *w = QObject::sender();
629         QDockWidget *dock = 0;
630
631         while (w) {
632             dock = qobject_cast<QDockWidget*>(w);
633             if (dock)
634                 break;
635             w = w->parent();
636         }
637
638         // Get the view contained in the dock widget
639         shared_ptr<views::ViewBase> view;
640
641         for (auto entry : view_docks_)
642                 if (entry.first == dock)
643                         view = entry.second;
644
645         // Deregister the view
646         for (shared_ptr<Session> session : sessions_) {
647                 if (!session->has_view(view))
648                         continue;
649
650                 // Also destroy the entire session if its main view is closing
651                 if (view == session->main_view()) {
652                         remove_session(session);
653                         break;
654                 } else
655                         session->deregister_view(view);
656         }
657 }
658
659 void MainWindow::on_tab_changed(int index)
660 {
661         shared_ptr<Session> session = get_tab_session(index);
662
663         if (session)
664                 on_focused_session_changed(session);
665 }
666
667 void MainWindow::on_tab_close_requested(int index)
668 {
669         // TODO Ask user if this is intended in case data is unsaved
670
671         shared_ptr<Session> session = get_tab_session(index);
672
673         if (session)
674                 remove_session(session);
675 }
676
677 void MainWindow::on_actionViewStickyScrolling_triggered()
678 {
679         shared_ptr<views::ViewBase> viewbase = get_active_view();
680         views::TraceView::View* view =
681                 qobject_cast<views::TraceView::View*>(viewbase.get());
682         if (view)
683                 view->enable_sticky_scrolling(action_view_sticky_scrolling_->isChecked());
684 }
685
686 void MainWindow::on_actionViewColouredBg_triggered()
687 {
688         shared_ptr<views::ViewBase> viewbase = get_active_view();
689         views::TraceView::View* view =
690                         qobject_cast<views::TraceView::View*>(viewbase.get());
691         if (view)
692                 view->enable_coloured_bg(action_view_coloured_bg_->isChecked());
693 }
694
695 void MainWindow::on_actionAbout_triggered()
696 {
697         dialogs::About dlg(device_manager_.context(), this);
698         dlg.exec();
699 }
700
701 } // namespace pv