]> sigrok.org Git - pulseview.git/blob - pv/mainwindow.cpp
TraceView: Fix variable name
[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 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 and stop iterating.
283                                 view_docks_.erase(entry.first);
284                                 break;
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_->setToolTip(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_->setToolTip(tr("Create New Session"));
349         new_session_button_->setAutoRaise(true);
350
351         run_stop_button_ = new QToolButton();
352         run_stop_button_->setAutoRaise(true);
353         run_stop_button_->setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
354         run_stop_button_->setShortcut(QKeySequence(Qt::Key_Space));
355         run_stop_button_->setToolTip(tr("Start/Stop Acquisition"));
356
357         settings_button_ = new QToolButton();
358         settings_button_->setIcon(QIcon::fromTheme("configure",
359                 QIcon(":/icons/configure.png")));
360         settings_button_->setToolTip(tr("Settings"));
361         settings_button_->setAutoRaise(true);
362
363         QFrame *separator1 = new QFrame();
364         separator1->setFrameStyle(QFrame::VLine | QFrame::Raised);
365         QFrame *separator2 = new QFrame();
366         separator2->setFrameStyle(QFrame::VLine | QFrame::Raised);
367
368         QHBoxLayout* layout = new QHBoxLayout();
369         layout->setContentsMargins(2, 2, 2, 2);
370         layout->addWidget(new_session_button_);
371         layout->addWidget(separator1);
372         layout->addWidget(run_stop_button_);
373         layout->addWidget(separator2);
374         layout->addWidget(settings_button_);
375
376         static_tab_widget_ = new QWidget();
377         static_tab_widget_->setLayout(layout);
378
379         session_selector_.setCornerWidget(static_tab_widget_, Qt::TopLeftCorner);
380         session_selector_.setTabsClosable(true);
381
382         connect(new_session_button_, SIGNAL(clicked(bool)),
383                 this, SLOT(on_new_session_clicked()));
384         connect(run_stop_button_, SIGNAL(clicked(bool)),
385                 this, SLOT(on_run_stop_clicked()));
386         connect(&session_state_mapper_, SIGNAL(mapped(QObject*)),
387                 this, SLOT(on_capture_state_changed(QObject*)));
388
389         connect(&session_selector_, SIGNAL(tabCloseRequested(int)),
390                 this, SLOT(on_tab_close_requested(int)));
391         connect(&session_selector_, SIGNAL(currentChanged(int)),
392                 this, SLOT(on_tab_changed(int)));
393
394
395         connect(static_cast<QApplication *>(QCoreApplication::instance()),
396                 SIGNAL(focusChanged(QWidget*, QWidget*)),
397                 this, SLOT(on_focus_changed()));
398 }
399
400 void MainWindow::save_ui_settings()
401 {
402         QSettings settings;
403         int id = 0;
404
405         settings.beginGroup("MainWindow");
406         settings.setValue("state", saveState());
407         settings.setValue("geometry", saveGeometry());
408         settings.endGroup();
409
410         for (shared_ptr<Session> session : sessions_) {
411                 // Ignore sessions using the demo device or no device at all
412                 if (session->device()) {
413                         shared_ptr<devices::HardwareDevice> device =
414                                 dynamic_pointer_cast< devices::HardwareDevice >
415                                 (session->device());
416
417                         if (device &&
418                                 device->hardware_device()->driver()->name() == "demo")
419                                 continue;
420
421                         settings.beginGroup("Session" + QString::number(id++));
422                         settings.remove("");  // Remove all keys in this group
423                         session->save_settings(settings);
424                         settings.endGroup();
425                 }
426         }
427
428         settings.setValue("sessions", id);
429 }
430
431 void MainWindow::restore_ui_settings()
432 {
433         QSettings settings;
434         int i, session_count;
435
436         settings.beginGroup("MainWindow");
437
438         if (settings.contains("geometry")) {
439                 restoreGeometry(settings.value("geometry").toByteArray());
440                 restoreState(settings.value("state").toByteArray());
441         } else
442                 resize(1000, 720);
443
444         settings.endGroup();
445
446         session_count = settings.value("sessions", 0).toInt();
447
448         for (i = 0; i < session_count; i++) {
449                 settings.beginGroup("Session" + QString::number(i));
450                 shared_ptr<Session> session = add_session();
451                 session->restore_settings(settings);
452                 settings.endGroup();
453         }
454 }
455
456 std::shared_ptr<Session> MainWindow::get_tab_session(int index) const
457 {
458         // Find the session that belongs to the tab's main window
459         for (auto entry : session_windows_)
460                 if (entry.second == session_selector_.widget(index))
461                         return entry.first;
462
463         return nullptr;
464 }
465
466 void MainWindow::closeEvent(QCloseEvent *event)
467 {
468         save_ui_settings();
469         event->accept();
470 }
471
472 QMenu* MainWindow::createPopupMenu()
473 {
474         return nullptr;
475 }
476
477 bool MainWindow::restoreState(const QByteArray &state, int version)
478 {
479         (void)state;
480         (void)version;
481
482         // Do nothing. We don't want Qt to handle this, or else it
483         // will try to restore all the dock widgets and create havoc.
484
485         return false;
486 }
487
488 void MainWindow::session_error(const QString text, const QString info_text)
489 {
490         QMetaObject::invokeMethod(this, "show_session_error",
491                 Qt::QueuedConnection, Q_ARG(QString, text),
492                 Q_ARG(QString, info_text));
493 }
494
495 void MainWindow::show_session_error(const QString text, const QString info_text)
496 {
497         QMessageBox msg(this);
498         msg.setText(text);
499         msg.setInformativeText(info_text);
500         msg.setStandardButtons(QMessageBox::Ok);
501         msg.setIcon(QMessageBox::Warning);
502         msg.exec();
503 }
504
505 void MainWindow::on_add_view(const QString &title, views::ViewType type,
506         Session *session)
507 {
508         // We get a pointer and need a reference
509         for (std::shared_ptr<Session> s : sessions_)
510                 if (s.get() == session)
511                         add_view(title, type, *s);
512 }
513
514 void MainWindow::on_focus_changed()
515 {
516         shared_ptr<views::ViewBase> view = get_active_view();
517
518         if (view) {
519                 for (shared_ptr<Session> session : sessions_) {
520                         if (session->has_view(view)) {
521                                 if (session != last_focused_session_) {
522                                         // Activate correct tab if necessary
523                                         shared_ptr<Session> tab_session = get_tab_session(
524                                                 session_selector_.currentIndex());
525                                         if (tab_session != session)
526                                                 session_selector_.setCurrentWidget(
527                                                         session_windows_.at(session));
528
529                                         on_focused_session_changed(session);
530                                 }
531
532                                 break;
533                         }
534                 }
535         }
536
537         if (sessions_.empty())
538                 setWindowTitle(WindowTitle);
539 }
540
541 void MainWindow::on_focused_session_changed(shared_ptr<Session> session)
542 {
543         last_focused_session_ = session;
544
545         setWindowTitle(session->name() + " - " + WindowTitle);
546
547         // Update the state of the run/stop button, too
548         on_capture_state_changed(session.get());
549 }
550
551 void MainWindow::on_new_session_clicked()
552 {
553         add_session();
554 }
555
556 void MainWindow::on_run_stop_clicked()
557 {
558         shared_ptr<Session> session = last_focused_session_;
559
560         if (!session)
561                 return;
562
563         switch (session->get_capture_state()) {
564         case Session::Stopped:
565                 session->start_capture([&](QString message) {
566                         session_error("Capture failed", message); });
567                 break;
568         case Session::AwaitingTrigger:
569         case Session::Running:
570                 session->stop_capture();
571                 break;
572         }
573 }
574
575 void MainWindow::on_session_name_changed()
576 {
577         // Update the corresponding dock widget's name(s)
578         Session *session = qobject_cast<Session*>(QObject::sender());
579         assert(session);
580
581         for (shared_ptr<views::ViewBase> view : session->views()) {
582                 // Get the dock that contains the view
583                 for (auto entry : view_docks_)
584                         if (entry.second == view) {
585                                 entry.first->setObjectName(session->name());
586                                 entry.first->setWindowTitle(session->name());
587                         }
588         }
589
590         // Update the tab widget by finding the main window and the tab from that
591         for (auto entry : session_windows_)
592                 if (entry.first.get() == session) {
593                         QMainWindow *window = entry.second;
594                         const int index = session_selector_.indexOf(window);
595                         session_selector_.setTabText(index, session->name());
596                 }
597
598         // Refresh window title if the affected session has focus
599         if (session == last_focused_session_.get())
600                 setWindowTitle(session->name() + " - " + WindowTitle);
601 }
602
603 void MainWindow::on_capture_state_changed(QObject *obj)
604 {
605         Session *caller = qobject_cast<Session*>(obj);
606
607         // Ignore if caller is not the currently focused session
608         // unless there is only one session
609         if ((sessions_.size() > 1) && (caller != last_focused_session_.get()))
610                 return;
611
612         int state = caller->get_capture_state();
613
614         const QIcon *icons[] = {&icon_grey_, &icon_red_, &icon_green_};
615         run_stop_button_->setIcon(*icons[state]);
616         run_stop_button_->setText((state == pv::Session::Stopped) ?
617                 tr("Run") : tr("Stop"));
618 }
619
620 void MainWindow::on_new_view(Session *session)
621 {
622         // We get a pointer and need a reference
623         for (std::shared_ptr<Session> s : sessions_)
624                 if (s.get() == session)
625                         add_view(session->name(), views::ViewTypeTrace, *s);
626 }
627
628 void MainWindow::on_view_close_clicked()
629 {
630         // Find the dock widget that contains the close button that was clicked
631         QObject *w = QObject::sender();
632         QDockWidget *dock = 0;
633
634         while (w) {
635             dock = qobject_cast<QDockWidget*>(w);
636             if (dock)
637                 break;
638             w = w->parent();
639         }
640
641         // Get the view contained in the dock widget
642         shared_ptr<views::ViewBase> view;
643
644         for (auto entry : view_docks_)
645                 if (entry.first == dock)
646                         view = entry.second;
647
648         // Deregister the view
649         for (shared_ptr<Session> session : sessions_) {
650                 if (!session->has_view(view))
651                         continue;
652
653                 // Also destroy the entire session if its main view is closing
654                 if (view == session->main_view()) {
655                         remove_session(session);
656                         break;
657                 } else
658                         session->deregister_view(view);
659         }
660 }
661
662 void MainWindow::on_tab_changed(int index)
663 {
664         shared_ptr<Session> session = get_tab_session(index);
665
666         if (session)
667                 on_focused_session_changed(session);
668 }
669
670 void MainWindow::on_tab_close_requested(int index)
671 {
672         // TODO Ask user if this is intended in case data is unsaved
673
674         shared_ptr<Session> session = get_tab_session(index);
675
676         if (session)
677                 remove_session(session);
678 }
679
680 void MainWindow::on_actionViewStickyScrolling_triggered()
681 {
682         shared_ptr<views::ViewBase> viewbase = get_active_view();
683         views::TraceView::View* view =
684                 qobject_cast<views::TraceView::View*>(viewbase.get());
685         if (view)
686                 view->enable_sticky_scrolling(action_view_sticky_scrolling_->isChecked());
687 }
688
689 void MainWindow::on_actionViewColouredBg_triggered()
690 {
691         shared_ptr<views::ViewBase> viewbase = get_active_view();
692         views::TraceView::View* view =
693                         qobject_cast<views::TraceView::View*>(viewbase.get());
694         if (view)
695                 view->enable_coloured_bg(action_view_coloured_bg_->isChecked());
696 }
697
698 void MainWindow::on_actionAbout_triggered()
699 {
700         dialogs::About dlg(device_manager_.context(), this);
701         dlg.exec();
702 }
703
704 } // namespace pv