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