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 <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
  47 #include <stdint.h>
  48 #include <stdarg.h>
  49 #include <libsigrokcxx/libsigrokcxx.hpp>
  50
  51 using std::dynamic_pointer_cast;
  52 using std::list;
  53 using std::make_shared;
  54 using std::map;
  55 using std::shared_ptr;
  56 using std::string;
  57
  58 namespace pv {
  59
  60 namespace view {
  61 class ViewItem;
  62 }
  63
  64 using toolbars::MainBar;
  65
  66 const QString MainWindow::WindowTitle = tr("PulseView");
  67
  68 MainWindow::MainWindow(DeviceManager &device_manager,
  69         string open_file_name, string open_file_format,
  70         QWidget *parent) :
  71         QMainWindow(parent),
  72         device_manager_(device_manager),
  73         session_selector_(this),
  74         action_view_sticky_scrolling_(new QAction(this)),
  75         action_view_coloured_bg_(new QAction(this)),
  76         action_about_(new QAction(this))
  77 {
  78         qRegisterMetaType<util::Timestamp>("util::Timestamp");
  79
  80         setup_ui();
  81         restore_ui_settings();
  82
  83         if (!open_file_name.empty()) {
  84                 shared_ptr<Session> session = add_session();
  85                 session->main_bar()->load_init_file(open_file_name, open_file_format);
  86         }
  87
  88         // Add empty default session if there aren't any sessions
  89         if (sessions_.size() == 0) {
  90                 shared_ptr<Session> session = add_session();
  91
  92                 map<string, string> dev_info;
  93                 shared_ptr<devices::HardwareDevice> other_device, demo_device;
  94
  95                 // Use any available device that's not demo
  96                 for (shared_ptr<devices::HardwareDevice> dev : device_manager_.devices()) {
  97                         if (dev->hardware_device()->driver()->name() == "demo") {
  98                                 demo_device = dev;
  99                         } else {
 100                                 other_device = dev;
 101                         }
 102                 }
 103
 104                 // ...and if there isn't any, just use demo then
 105                 session->main_bar()->select_device(other_device ?
 106                         other_device : demo_device);
 107         }
 108 }
 109
 110 MainWindow::~MainWindow()
 111 {
 112         while (!sessions_.empty())
 113                 remove_session(sessions_.front());
 114 }
 115
 116 QAction* MainWindow::action_view_sticky_scrolling() const
 117 {
 118         return action_view_sticky_scrolling_;
 119 }
 120
 121 QAction* MainWindow::action_view_coloured_bg() const
 122 {
 123         return action_view_coloured_bg_;
 124 }
 125
 126 QAction* MainWindow::action_about() const
 127 {
 128         return action_about_;
 129 }
 130
 131 shared_ptr<views::ViewBase> MainWindow::get_active_view() const
 132 {
 133         // If there's only one view, use it...
 134         if (view_docks_.size() == 1)
 135                 return view_docks_.begin()->second;
 136
 137         // ...otherwise find the dock widget the widget with focus is contained in
 138         QObject *w = QApplication::focusWidget();
 139         QDockWidget *dock = 0;
 140
 141         while (w) {
 142             dock = qobject_cast<QDockWidget*>(w);
 143             if (dock)
 144                 break;
 145             w = w->parent();
 146         }
 147
 148         // Get the view contained in the dock widget
 149         for (auto entry : view_docks_)
 150                 if (entry.first == dock)
 151                         return entry.second;
 152
 153         return nullptr;
 154 }
 155
 156 shared_ptr<views::ViewBase> MainWindow::add_view(const QString &title,
 157         views::ViewType type, Session &session)
 158 {
 159         QMainWindow *main_window;
 160         for (auto entry : session_windows_)
 161                 if (entry.first.get() == &session)
 162                         main_window = entry.second;
 163
 164         assert(main_window);
 165
 166         if (type == views::ViewTypeTrace) {
 167                 QDockWidget* dock = new QDockWidget(title, main_window);
 168                 dock->setObjectName(title);
 169                 main_window->addDockWidget(Qt::TopDockWidgetArea, dock);
 170
 171                 // Insert a QMainWindow into the dock widget to allow for a tool bar
 172                 QMainWindow *dock_main = new QMainWindow(dock);
 173                 dock_main->setWindowFlags(Qt::Widget);  // Remove Qt::Window flag
 174
 175                 shared_ptr<views::TraceView::View> v =
 176                         make_shared<views::TraceView::View>(session, dock_main);
 177                 view_docks_[dock] = v;
 178                 session.register_view(v);
 179
 180                 dock_main->setCentralWidget(v.get());
 181                 dock->setWidget(dock_main);
 182
 183                 dock->setFeatures(QDockWidget::DockWidgetMovable |
 184                         QDockWidget::DockWidgetFloatable | QDockWidget::DockWidgetClosable);
 185
 186                 QAbstractButton *close_btn =
 187                         dock->findChildren<QAbstractButton*>
 188                                 ("qt_dockwidget_closebutton").front();
 189
 190                 connect(close_btn, SIGNAL(clicked(bool)),
 191                         this, SLOT(on_view_close_clicked()));
 192
 193                 if (type == views::ViewTypeTrace) {
 194                         connect(&session, SIGNAL(trigger_event(util::Timestamp)),
 195                                 qobject_cast<views::ViewBase*>(v.get()),
 196                                 SLOT(trigger_event(util::Timestamp)));
 197
 198                         v->enable_sticky_scrolling(action_view_sticky_scrolling_->isChecked());
 199                         v->enable_coloured_bg(action_view_coloured_bg_->isChecked());
 200
 201                         shared_ptr<MainBar> main_bar = session.main_bar();
 202                         if (!main_bar) {
 203                                 main_bar = make_shared<MainBar>(session, *this);
 204                                 dock_main->addToolBar(main_bar.get());
 205                                 session.set_main_bar(main_bar);
 206
 207                                 connect(main_bar.get(), SIGNAL(new_view(Session*)),
 208                                         this, SLOT(on_new_view(Session*)));
 209                         }
 210                         main_bar->action_view_show_cursors()->setChecked(v->cursors_shown());
 211
 212                         connect(v.get(), SIGNAL(always_zoom_to_fit_changed(bool)),
 213                                 main_bar.get(), SLOT(on_always_zoom_to_fit_changed(bool)));
 214                 }
 215
 216                 return v;
 217         }
 218
 219         return nullptr;
 220 }
 221
 222 shared_ptr<Session> MainWindow::add_session()
 223 {
 224         static int last_session_id = 1;
 225         QString name = tr("Untitled-%1").arg(last_session_id++);
 226
 227         shared_ptr<Session> session = make_shared<Session>(device_manager_, name);
 228
 229         connect(session.get(), SIGNAL(add_view(const QString&, views::ViewType, Session*)),
 230                 this, SLOT(on_add_view(const QString&, views::ViewType, Session*)));
 231         connect(session.get(), SIGNAL(name_changed()),
 232                 this, SLOT(on_session_name_changed()));
 233
 234         sessions_.push_back(session);
 235
 236         QMainWindow *window = new QMainWindow();
 237         window->setWindowFlags(Qt::Widget);  // Remove Qt::Window flag
 238         session_windows_[session] = window;
 239         session_selector_.addTab(window, name);
 240
 241         window->setDockNestingEnabled(true);
 242
 243         shared_ptr<views::ViewBase> main_view =
 244                 add_view(name, views::ViewTypeTrace, *session);
 245
 246         return session;
 247 }
 248
 249 void MainWindow::remove_session(shared_ptr<Session> session)
 250 {
 251         for (shared_ptr<views::ViewBase> view : session->views()) {
 252                 // Find the dock the view is contained in and remove it
 253                 for (auto entry : view_docks_)
 254                         if (entry.second == view) {
 255                                 // Remove the view from the session
 256                                 session->deregister_view(view);
 257
 258                                 // Remove the view from its parent; otherwise, Qt will
 259                                 // call deleteLater() on it, which causes a double free
 260                                 // since the shared_ptr in view_docks_ doesn't know
 261                                 // that Qt keeps a pointer to the view around
 262                                 entry.second->setParent(0);
 263
 264                                 // Remove this entry from the container
 265                                 view_docks_.erase(entry.first);
 266                         }
 267         }
 268
 269         QMainWindow *window = session_windows_.at(session);
 270         session_selector_.removeTab(session_selector_.indexOf(window));
 271
 272         session_windows_.erase(session);
 273
 274         sessions_.remove_if([&](shared_ptr<Session> s) {
 275                 return s == session; });
 276
 277         // Update the window title if there is no view left to
 278         // generate focus change events
 279         if (sessions_.empty())
 280                 setWindowTitle(WindowTitle);
 281 }
 282
 283 void MainWindow::setup_ui()
 284 {
 285         setObjectName(QString::fromUtf8("MainWindow"));
 286
 287         setCentralWidget(&session_selector_);
 288
 289         // Set the window icon
 290         QIcon icon;
 291         icon.addFile(QString(":/icons/sigrok-logo-notext.png"));
 292         setWindowIcon(icon);
 293
 294         action_view_sticky_scrolling_->setCheckable(true);
 295         action_view_sticky_scrolling_->setChecked(true);
 296         action_view_sticky_scrolling_->setShortcut(QKeySequence(Qt::Key_S));
 297         action_view_sticky_scrolling_->setObjectName(
 298                 QString::fromUtf8("actionViewStickyScrolling"));
 299         action_view_sticky_scrolling_->setText(tr("&Sticky Scrolling"));
 300
 301         action_view_coloured_bg_->setCheckable(true);
 302         action_view_coloured_bg_->setChecked(true);
 303         action_view_coloured_bg_->setShortcut(QKeySequence(Qt::Key_B));
 304         action_view_coloured_bg_->setObjectName(
 305                 QString::fromUtf8("actionViewColouredBg"));
 306         action_view_coloured_bg_->setText(tr("Use &coloured backgrounds"));
 307
 308         action_about_->setObjectName(QString::fromUtf8("actionAbout"));
 309         action_about_->setText(tr("&About..."));
 310
 311         // Set up the tab area
 312         new_session_button_ = new QToolButton();
 313         new_session_button_->setIcon(QIcon::fromTheme("document-new",
 314                 QIcon(":/icons/document-new.png")));
 315         new_session_button_->setAutoRaise(true);
 316
 317         QHBoxLayout* layout = new QHBoxLayout();
 318         layout->setContentsMargins(2, 2, 2, 2);
 319         layout->addWidget(new_session_button_);
 320
 321         QWidget* static_tab_widget_ = new QWidget();
 322         static_tab_widget_->setLayout(layout);
 323
 324         session_selector_.setCornerWidget(static_tab_widget_, Qt::TopLeftCorner);
 325
 326         session_selector_.setTabsClosable(true);
 327
 328         connect(new_session_button_, SIGNAL(clicked(bool)),
 329                 this, SLOT(on_new_session_clicked()));
 330
 331         connect(&session_selector_, SIGNAL(tabCloseRequested(int)),
 332                 this, SLOT(on_tab_close_requested(int)));
 333         connect(&session_selector_, SIGNAL(currentChanged(int)),
 334                 this, SLOT(on_tab_changed(int)));
 335
 336
 337         connect(static_cast<QApplication *>(QCoreApplication::instance()),
 338                 SIGNAL(focusChanged(QWidget*, QWidget*)),
 339                 this, SLOT(on_focus_changed()));
 340 }
 341
 342 void MainWindow::save_ui_settings()
 343 {
 344         QSettings settings;
 345         int id = 0;
 346
 347         settings.beginGroup("MainWindow");
 348         settings.setValue("state", saveState());
 349         settings.setValue("geometry", saveGeometry());
 350         settings.endGroup();
 351
 352         for (shared_ptr<Session> session : sessions_) {
 353                 // Ignore sessions using the demo device or no device at all
 354                 if (session->device()) {
 355                         shared_ptr<devices::HardwareDevice> device =
 356                                 dynamic_pointer_cast< devices::HardwareDevice >
 357                                 (session->device());
 358
 359                         if (device &&
 360                                 device->hardware_device()->driver()->name() == "demo")
 361                                 continue;
 362
 363                         settings.beginGroup("Session" + QString::number(id++));
 364                         settings.remove("");  // Remove all keys in this group
 365                         session->save_settings(settings);
 366                         settings.endGroup();
 367                 }
 368         }
 369
 370         settings.setValue("sessions", id);
 371 }
 372
 373 void MainWindow::restore_ui_settings()
 374 {
 375         QSettings settings;
 376         int i, session_count;
 377
 378         settings.beginGroup("MainWindow");
 379
 380         if (settings.contains("geometry")) {
 381                 restoreGeometry(settings.value("geometry").toByteArray());
 382                 restoreState(settings.value("state").toByteArray());
 383         } else
 384                 resize(1000, 720);
 385
 386         settings.endGroup();
 387
 388         session_count = settings.value("sessions", 0).toInt();
 389
 390         for (i = 0; i < session_count; i++) {
 391                 settings.beginGroup("Session" + QString::number(i));
 392                 shared_ptr<Session> session = add_session();
 393                 session->restore_settings(settings);
 394                 settings.endGroup();
 395         }
 396 }
 397
 398 std::shared_ptr<Session> MainWindow::get_tab_session(int index) const
 399 {
 400         // Find the session that belongs to the tab's main window
 401         for (auto entry : session_windows_)
 402                 if (entry.second == session_selector_.widget(index))
 403                         return entry.first;
 404
 405         return nullptr;
 406 }
 407
 408 void MainWindow::closeEvent(QCloseEvent *event)
 409 {
 410         save_ui_settings();
 411         event->accept();
 412 }
 413
 414 QMenu* MainWindow::createPopupMenu()
 415 {
 416         return nullptr;
 417 }
 418
 419 bool MainWindow::restoreState(const QByteArray &state, int version)
 420 {
 421         (void)state;
 422         (void)version;
 423
 424         // Do nothing. We don't want Qt to handle this, or else it
 425         // will try to restore all the dock widgets and create havoc.
 426
 427         return false;
 428 }
 429
 430 void MainWindow::on_add_view(const QString &title, views::ViewType type,
 431         Session *session)
 432 {
 433         // We get a pointer and need a reference
 434         for (std::shared_ptr<Session> s : sessions_)
 435                 if (s.get() == session)
 436                         add_view(title, type, *s);
 437 }
 438
 439 void MainWindow::on_focus_changed()
 440 {
 441         static shared_ptr<Session> prev_session;
 442
 443         shared_ptr<views::ViewBase> view = get_active_view();
 444
 445         if (view) {
 446                 for (shared_ptr<Session> session : sessions_) {
 447                         if (session->has_view(view)) {
 448                                 if (session != prev_session) {
 449                                         // Activate correct tab if necessary
 450                                         shared_ptr<Session> tab_session = get_tab_session(
 451                                                 session_selector_.currentIndex());
 452                                         if (tab_session != session)
 453                                                 session_selector_.setCurrentWidget(
 454                                                         session_windows_.at(session));
 455
 456                                         on_focused_session_changed(session);
 457                                 }
 458
 459                                 prev_session = session;
 460                                 break;
 461                         }
 462                 }
 463         }
 464
 465         if (sessions_.empty())
 466                 setWindowTitle(WindowTitle);
 467 }
 468
 469 void MainWindow::on_focused_session_changed(shared_ptr<Session> session)
 470 {
 471         setWindowTitle(session->name() + " - " + WindowTitle);
 472 }
 473
 474 void MainWindow::on_new_session_clicked()
 475 {
 476         add_session();
 477 }
 478
 479 void MainWindow::on_session_name_changed()
 480 {
 481         // Update the corresponding dock widget's name(s)
 482         Session *session = qobject_cast<Session*>(QObject::sender());
 483         assert(session);
 484
 485         for (shared_ptr<views::ViewBase> view : session->views()) {
 486                 // Get the dock that contains the view
 487                 for (auto entry : view_docks_)
 488                         if (entry.second == view) {
 489                                 entry.first->setObjectName(session->name());
 490                                 entry.first->setWindowTitle(session->name());
 491                         }
 492         }
 493
 494         // Refresh window title if the affected session has focus
 495         shared_ptr<views::ViewBase> view = get_active_view();
 496
 497         if (view && session->has_view(view))
 498                 setWindowTitle(session->name() + " - " + WindowTitle);
 499 }
 500
 501 void MainWindow::on_new_view(Session *session)
 502 {
 503         // We get a pointer and need a reference
 504         for (std::shared_ptr<Session> s : sessions_)
 505                 if (s.get() == session)
 506                         add_view(session->name(), views::ViewTypeTrace, *s);
 507 }
 508
 509 void MainWindow::on_view_close_clicked()
 510 {
 511         // Find the dock widget that contains the close button that was clicked
 512         QObject *w = QObject::sender();
 513         QDockWidget *dock = 0;
 514
 515         while (w) {
 516             dock = qobject_cast<QDockWidget*>(w);
 517             if (dock)
 518                 break;
 519             w = w->parent();
 520         }
 521
 522         // Get the view contained in the dock widget
 523         shared_ptr<views::ViewBase> view;
 524
 525         for (auto entry : view_docks_)
 526                 if (entry.first == dock)
 527                         view = entry.second;
 528
 529         // Deregister the view
 530         for (shared_ptr<Session> session : sessions_) {
 531                 if (!session->has_view(view))
 532                         continue;
 533
 534                 // Also destroy the entire session if its main view is closing
 535                 if (view == session->main_view()) {
 536                         remove_session(session);
 537                         break;
 538                 } else
 539                         session->deregister_view(view);
 540         }
 541 }
 542
 543 void MainWindow::on_tab_changed(int index)
 544 {
 545         shared_ptr<Session> session = get_tab_session(index);
 546
 547         if (session)
 548                 on_focused_session_changed(session);
 549 }
 550
 551 void MainWindow::on_tab_close_requested(int index)
 552 {
 553         // TODO Ask user if this is intended in case data is unsaved
 554
 555         shared_ptr<Session> session = get_tab_session(index);
 556
 557         if (session)
 558                 remove_session(session);
 559 }
 560
 561 void MainWindow::on_actionViewStickyScrolling_triggered()
 562 {
 563         shared_ptr<views::ViewBase> viewbase = get_active_view();
 564         views::TraceView::View* view =
 565                 qobject_cast<views::TraceView::View*>(viewbase.get());
 566         if (view)
 567                 view->enable_sticky_scrolling(action_view_sticky_scrolling_->isChecked());
 568 }
 569
 570 void MainWindow::on_actionViewColouredBg_triggered()
 571 {
 572         shared_ptr<views::ViewBase> viewbase = get_active_view();
 573         views::TraceView::View* view =
 574                         qobject_cast<views::TraceView::View*>(viewbase.get());
 575         if (view)
 576                 view->enable_coloured_bg(action_view_coloured_bg_->isChecked());
 577 }
 578
 579 void MainWindow::on_actionAbout_triggered()
 580 {
 581         dialogs::About dlg(device_manager_.context(), this);
 582         dlg.exec();
 583 }
 584
 585 } // namespace pv