77dc946213ef20850247fc0b5acf15f51b820df3
[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 <QSettings>
35 #include <QWidget>
36
37 #include "mainwindow.hpp"
38
39 #include "devicemanager.hpp"
40 #include "util.hpp"
41 #include "devices/hardwaredevice.hpp"
42 #include "dialogs/about.hpp"
43 #include "toolbars/mainbar.hpp"
44 #include "view/view.hpp"
45
46 #include <stdint.h>
47 #include <stdarg.h>
48 #include <libsigrokcxx/libsigrokcxx.hpp>
49
50 using std::dynamic_pointer_cast;
51 using std::list;
52 using std::make_shared;
53 using std::map;
54 using std::shared_ptr;
55 using std::string;
56
57 namespace pv {
58
59 namespace view {
60 class ViewItem;
61 }
62
63 using toolbars::MainBar;
64
65 MainWindow::MainWindow(DeviceManager &device_manager,
66         string open_file_name, string open_file_format,
67         QWidget *parent) :
68         QMainWindow(parent),
69         device_manager_(device_manager),
70         action_view_sticky_scrolling_(new QAction(this)),
71         action_view_coloured_bg_(new QAction(this)),
72         action_about_(new QAction(this))
73 {
74         qRegisterMetaType<util::Timestamp>("util::Timestamp");
75
76         setup_ui();
77         restore_ui_settings();
78
79         if (!open_file_name.empty()) {
80                 shared_ptr<Session> session = add_session();
81                 session->main_bar()->load_init_file(open_file_name, open_file_format);
82         }
83
84         // Add empty default session if there aren't any sessions
85         if (sessions_.size() == 0) {
86                 shared_ptr<Session> session = add_session();
87
88                 map<string, string> dev_info;
89                 shared_ptr<devices::HardwareDevice> other_device, demo_device;
90
91                 // Use any available device that's not demo
92                 for (shared_ptr<devices::HardwareDevice> dev : device_manager_.devices()) {
93                         if (dev->hardware_device()->driver()->name() == "demo") {
94                                 demo_device = dev;
95                         } else {
96                                 other_device = dev;
97                         }
98                 }
99
100                 // ...and if there isn't any, just use demo then
101                 session->main_bar()->select_device(other_device ?
102                         other_device : demo_device);
103         }
104 }
105
106 MainWindow::~MainWindow()
107 {
108         for (auto entry : view_docks_) {
109
110                 const std::shared_ptr<QDockWidget> dock = entry.first;
111
112                 // Remove view from the dock widget's QMainWindow
113                 QMainWindow *dock_main = dynamic_cast<QMainWindow*>(dock->widget());
114                 dock_main->setCentralWidget(0);
115
116                 // Remove the QMainWindow
117                 dock->setWidget(0);
118
119                 const std::shared_ptr<pv::view::View> view = entry.second;
120
121                 for (shared_ptr<Session> session : sessions_)
122                         if (session->has_view(view))
123                                 session->deregister_view(view);
124         }
125 }
126
127 QAction* MainWindow::action_view_sticky_scrolling() const
128 {
129         return action_view_sticky_scrolling_;
130 }
131
132 QAction* MainWindow::action_view_coloured_bg() const
133 {
134         return action_view_coloured_bg_;
135 }
136
137 QAction* MainWindow::action_about() const
138 {
139         return action_about_;
140 }
141
142 shared_ptr<pv::view::View> MainWindow::get_active_view() const
143 {
144         // If there's only one view, use it...
145         if (view_docks_.size() == 1)
146                 return view_docks_.begin()->second;
147
148         // ...otherwise find the dock widget the widget with focus is contained in
149         QObject *w = QApplication::focusWidget();
150         QDockWidget *dock = 0;
151
152         while (w) {
153             dock = qobject_cast<QDockWidget*>(w);
154             if (dock)
155                 break;
156             w = w->parent();
157         }
158
159         // Get the view contained in the dock widget
160         for (auto entry : view_docks_)
161                 if (entry.first.get() == dock)
162                         return entry.second;
163
164         return shared_ptr<pv::view::View>();
165 }
166
167 shared_ptr<pv::view::View> MainWindow::add_view(const QString &title,
168         view::ViewType type, Session &session)
169 {
170         shared_ptr<pv::view::View> v;
171
172         if (type == pv::view::TraceView) {
173                 shared_ptr<QDockWidget> dock = make_shared<QDockWidget>(title, this);
174                 dock->setObjectName(title);
175                 addDockWidget(Qt::TopDockWidgetArea, dock.get());
176
177                 // Insert a QMainWindow into the dock widget to allow for a tool bar
178                 QMainWindow *dock_main = new QMainWindow(dock.get());
179                 dock_main->setWindowFlags(Qt::Widget);  // Remove Qt::Window flag
180
181                 v = make_shared<pv::view::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);
190
191                 if (type == view::TraceView) {
192                         connect(&session, SIGNAL(trigger_event(util::Timestamp)), v.get(),
193                                 SLOT(trigger_event(util::Timestamp)));
194
195                         v->enable_sticky_scrolling(action_view_sticky_scrolling_->isChecked());
196                         v->enable_coloured_bg(action_view_coloured_bg_->isChecked());
197
198                         shared_ptr<MainBar> main_bar = session.main_bar();
199                         if (!main_bar) {
200                                 main_bar = make_shared<MainBar>(session, *this);
201                                 dock_main->addToolBar(main_bar.get());
202                                 session.set_main_bar(main_bar);
203                         }
204                         main_bar->action_view_show_cursors()->setChecked(v->cursors_shown());
205
206                         connect(v.get(), SIGNAL(always_zoom_to_fit_changed(bool)),
207                                 main_bar.get(), SLOT(on_always_zoom_to_fit_changed(bool)));
208                 }
209         }
210
211         return v;
212 }
213
214 shared_ptr<Session> MainWindow::add_session()
215 {
216         int id = sessions_.size();
217         QString name = tr("Untitled-%1").arg(id + 1);
218
219         shared_ptr<Session> session = make_shared<Session>(device_manager_, name);
220
221         sessions_.push_back(session);
222
223         shared_ptr<view::View> main_view =
224                 add_view(name, pv::view::TraceView, *session);
225
226         return session;
227 }
228
229 void MainWindow::setup_ui()
230 {
231         setObjectName(QString::fromUtf8("MainWindow"));
232
233         // Set the window icon
234         QIcon icon;
235         icon.addFile(QString(":/icons/sigrok-logo-notext.png"));
236         setWindowIcon(icon);
237
238         action_view_sticky_scrolling_->setCheckable(true);
239         action_view_sticky_scrolling_->setChecked(true);
240         action_view_sticky_scrolling_->setShortcut(QKeySequence(Qt::Key_S));
241         action_view_sticky_scrolling_->setObjectName(
242                 QString::fromUtf8("actionViewStickyScrolling"));
243         action_view_sticky_scrolling_->setText(tr("&Sticky Scrolling"));
244
245         action_view_coloured_bg_->setCheckable(true);
246         action_view_coloured_bg_->setChecked(true);
247         action_view_coloured_bg_->setShortcut(QKeySequence(Qt::Key_B));
248         action_view_coloured_bg_->setObjectName(
249                 QString::fromUtf8("actionViewColouredBg"));
250         action_view_coloured_bg_->setText(tr("Use &coloured backgrounds"));
251
252         action_about_->setObjectName(QString::fromUtf8("actionAbout"));
253         action_about_->setText(tr("&About..."));
254
255         // Set the title
256         setWindowTitle(tr("PulseView"));
257 }
258
259 void MainWindow::save_ui_settings()
260 {
261         QSettings settings;
262         int id = 0;
263
264         settings.beginGroup("MainWindow");
265         settings.setValue("state", saveState());
266         settings.setValue("geometry", saveGeometry());
267         settings.endGroup();
268
269         for (shared_ptr<Session> session : sessions_) {
270                 // Ignore sessions using the demo device
271                 if (session->device()) {
272                         shared_ptr<devices::HardwareDevice> device =
273                                 dynamic_pointer_cast< devices::HardwareDevice >
274                                 (session->device());
275
276                         if (device &&
277                                 device->hardware_device()->driver()->name() == "demo")
278                                 continue;
279                 }
280
281                 settings.beginGroup("Session" + QString::number(id++));
282                 settings.remove("");  // Remove all keys in this group
283                 session->save_settings(settings);
284                 settings.endGroup();
285         }
286
287         settings.setValue("sessions", id);
288 }
289
290 void MainWindow::restore_ui_settings()
291 {
292         QSettings settings;
293         int i, session_count;
294
295         settings.beginGroup("MainWindow");
296
297         if (settings.contains("geometry")) {
298                 restoreGeometry(settings.value("geometry").toByteArray());
299                 restoreState(settings.value("state").toByteArray());
300         } else
301                 resize(1000, 720);
302
303         settings.endGroup();
304
305         session_count = settings.value("sessions", 0).toInt();
306
307         for (i = 0; i < session_count; i++) {
308                 settings.beginGroup("Session" + QString::number(i));
309                 shared_ptr<Session> session = add_session();
310                 session->restore_settings(settings);
311                 settings.endGroup();
312         }
313 }
314
315 void MainWindow::closeEvent(QCloseEvent *event)
316 {
317         save_ui_settings();
318         event->accept();
319 }
320
321 QMenu* MainWindow::createPopupMenu()
322 {
323         return nullptr;
324 }
325
326 bool MainWindow::restoreState(const QByteArray &state, int version)
327 {
328         (void)state;
329         (void)version;
330
331         // Do nothing. We don't want Qt to handle this, or else it
332         // will try to restore all the dock widgets and create havoc.
333
334         return false;
335 }
336
337 void MainWindow::on_actionViewStickyScrolling_triggered()
338 {
339         shared_ptr<pv::view::View> view = get_active_view();
340         if (view)
341                 view->enable_sticky_scrolling(action_view_sticky_scrolling_->isChecked());
342 }
343
344 void MainWindow::on_actionViewColouredBg_triggered()
345 {
346         shared_ptr<pv::view::View> view = get_active_view();
347         if (view)
348                 view->enable_coloured_bg(action_view_coloured_bg_->isChecked());
349 }
350
351 void MainWindow::on_actionAbout_triggered()
352 {
353         dialogs::About dlg(device_manager_.context(), this);
354         dlg.exec();
355 }
356
357 } // namespace pv