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 <QButtonGroup>
  33 #include <QCloseEvent>
  34 #include <QFileDialog>
  35 #include <QMessageBox>
  36 #include <QMenu>
  37 #include <QMenuBar>
  38 #include <QSettings>
  39 #include <QStatusBar>
  40 #include <QVBoxLayout>
  41 #include <QWidget>
  42
  43 #include "mainwindow.hpp"
  44
  45 #include "devicemanager.hpp"
  46 #include "dialogs/about.hpp"
  47 #include "dialogs/connect.hpp"
  48 #include "dialogs/storeprogress.hpp"
  49 #include "toolbars/mainbar.hpp"
  50 #include "view/logicsignal.hpp"
  51 #include "view/view.hpp"
  52 #ifdef ENABLE_DECODE
  53 #include "widgets/decodermenu.hpp"
  54 #endif
  55
  56 #include <inttypes.h>
  57 #include <stdint.h>
  58 #include <stdarg.h>
  59 #include <glib.h>
  60 #include <libsigrok/libsigrok.hpp>
  61
  62 using std::list;
  63 using std::map;
  64 using std::shared_ptr;
  65 using std::string;
  66
  67 using sigrok::Device;
  68 using sigrok::Error;
  69 using sigrok::HardwareDevice;
  70
  71 namespace pv {
  72
  73 namespace view {
  74 class ViewItem;
  75 }
  76
  77 const char *MainWindow::SettingOpenDirectory = "MainWindow/OpenDirectory";
  78 const char *MainWindow::SettingSaveDirectory = "MainWindow/SaveDirectory";
  79
  80 MainWindow::MainWindow(DeviceManager &device_manager,
  81         const char *open_file_name,
  82         QWidget *parent) :
  83         QMainWindow(parent),
  84         device_manager_(device_manager),
  85         session_(device_manager),
  86         action_open_(new QAction(this)),
  87         action_save_as_(new QAction(this)),
  88         action_connect_(new QAction(this)),
  89         action_quit_(new QAction(this)),
  90         action_view_zoom_in_(new QAction(this)),
  91         action_view_zoom_out_(new QAction(this)),
  92         action_view_zoom_fit_(new QAction(this)),
  93         action_view_zoom_one_to_one_(new QAction(this)),
  94         action_view_show_cursors_(new QAction(this)),
  95         action_about_(new QAction(this))
  96 {
  97         setup_ui();
  98         restore_ui_settings();
  99         if (open_file_name) {
 100                 const QString s(QString::fromUtf8(open_file_name));
 101                 QMetaObject::invokeMethod(this, "load_file",
 102                         Qt::QueuedConnection,
 103                         Q_ARG(QString, s));
 104         }
 105 }
 106
 107 QAction* MainWindow::action_open() const
 108 {
 109         return action_open_;
 110 }
 111
 112 QAction* MainWindow::action_save_as() const
 113 {
 114         return action_save_as_;
 115 }
 116
 117 QAction* MainWindow::action_connect() const
 118 {
 119         return action_connect_;
 120 }
 121
 122 QAction* MainWindow::action_quit() const
 123 {
 124         return action_quit_;
 125 }
 126
 127 QAction* MainWindow::action_view_zoom_in() const
 128 {
 129         return action_view_zoom_in_;
 130 }
 131
 132 QAction* MainWindow::action_view_zoom_out() const
 133 {
 134         return action_view_zoom_out_;
 135 }
 136
 137 QAction* MainWindow::action_view_zoom_fit() const
 138 {
 139         return action_view_zoom_fit_;
 140 }
 141
 142 QAction* MainWindow::action_view_zoom_one_to_one() const
 143 {
 144         return action_view_zoom_one_to_one_;
 145 }
 146
 147 QAction* MainWindow::action_view_show_cursors() const
 148 {
 149         return action_view_show_cursors_;
 150 }
 151
 152 QAction* MainWindow::action_about() const
 153 {
 154         return action_about_;
 155 }
 156
 157 void MainWindow::run_stop()
 158 {
 159         switch(session_.get_capture_state()) {
 160         case Session::Stopped:
 161                 session_.start_capture([&](QString message) {
 162                         session_error("Capture failed", message); });
 163                 break;
 164
 165         case Session::AwaitingTrigger:
 166         case Session::Running:
 167                 session_.stop_capture();
 168                 break;
 169         }
 170 }
 171
 172 void MainWindow::select_device(shared_ptr<Device> device)
 173 {
 174         try {
 175                 session_.set_device(device);
 176         } catch(const QString &e) {
 177                 QMessageBox msg(this);
 178                 msg.setText(e);
 179                 msg.setInformativeText(tr("Failed to Select Device"));
 180                 msg.setStandardButtons(QMessageBox::Ok);
 181                 msg.setIcon(QMessageBox::Warning);
 182                 msg.exec();
 183         }
 184 }
 185
 186 void MainWindow::setup_ui()
 187 {
 188         setObjectName(QString::fromUtf8("MainWindow"));
 189
 190         // Set the window icon
 191         QIcon icon;
 192         icon.addFile(QString::fromUtf8(":/icons/sigrok-logo-notext.png"),
 193                 QSize(), QIcon::Normal, QIcon::Off);
 194         setWindowIcon(icon);
 195
 196         // Setup the central widget
 197         central_widget_ = new QWidget(this);
 198         vertical_layout_ = new QVBoxLayout(central_widget_);
 199         vertical_layout_->setSpacing(6);
 200         vertical_layout_->setContentsMargins(0, 0, 0, 0);
 201         setCentralWidget(central_widget_);
 202
 203         view_ = new pv::view::View(session_, this);
 204
 205         vertical_layout_->addWidget(view_);
 206
 207         // Setup the menu bar
 208         QMenuBar *const menu_bar = new QMenuBar(this);
 209         menu_bar->setGeometry(QRect(0, 0, 400, 25));
 210
 211         // File Menu
 212         QMenu *const menu_file = new QMenu;
 213         menu_file->setTitle(tr("&File"));
 214
 215         action_open_->setText(tr("&Open..."));
 216         action_open_->setIcon(QIcon::fromTheme("document-open",
 217                 QIcon(":/icons/document-open.png")));
 218         action_open_->setShortcut(QKeySequence(Qt::CTRL + Qt::Key_O));
 219         action_open_->setObjectName(QString::fromUtf8("actionOpen"));
 220         menu_file->addAction(action_open_);
 221
 222         action_save_as_->setText(tr("&Save As..."));
 223         action_save_as_->setIcon(QIcon::fromTheme("document-save-as",
 224                 QIcon(":/icons/document-save-as.png")));
 225         action_save_as_->setShortcut(QKeySequence(Qt::CTRL + Qt::Key_S));
 226         action_save_as_->setObjectName(QString::fromUtf8("actionSaveAs"));
 227         menu_file->addAction(action_save_as_);
 228
 229         menu_file->addSeparator();
 230
 231         action_connect_->setText(tr("&Connect to Device..."));
 232         action_connect_->setObjectName(QString::fromUtf8("actionConnect"));
 233         menu_file->addAction(action_connect_);
 234
 235         menu_file->addSeparator();
 236
 237         action_quit_->setText(tr("&Quit"));
 238         action_quit_->setIcon(QIcon::fromTheme("application-exit",
 239                 QIcon(":/icons/application-exit.png")));
 240         action_quit_->setShortcut(QKeySequence(Qt::CTRL + Qt::Key_Q));
 241         action_quit_->setObjectName(QString::fromUtf8("actionQuit"));
 242         menu_file->addAction(action_quit_);
 243
 244         // View Menu
 245         QMenu *menu_view = new QMenu;
 246         menu_view->setTitle(tr("&View"));
 247
 248         action_view_zoom_in_->setText(tr("Zoom &In"));
 249         action_view_zoom_in_->setIcon(QIcon::fromTheme("zoom-in",
 250                 QIcon(":/icons/zoom-in.png")));
 251         // simply using Qt::Key_Plus shows no + in the menu
 252         action_view_zoom_in_->setShortcut(QKeySequence::ZoomIn);
 253         action_view_zoom_in_->setObjectName(
 254                 QString::fromUtf8("actionViewZoomIn"));
 255         menu_view->addAction(action_view_zoom_in_);
 256
 257         action_view_zoom_out_->setText(tr("Zoom &Out"));
 258         action_view_zoom_out_->setIcon(QIcon::fromTheme("zoom-out",
 259                 QIcon(":/icons/zoom-out.png")));
 260         action_view_zoom_out_->setShortcut(QKeySequence::ZoomOut);
 261         action_view_zoom_out_->setObjectName(
 262                 QString::fromUtf8("actionViewZoomOut"));
 263         menu_view->addAction(action_view_zoom_out_);
 264
 265         action_view_zoom_fit_->setText(tr("Zoom to &Fit"));
 266         action_view_zoom_fit_->setIcon(QIcon::fromTheme("zoom-fit",
 267                 QIcon(":/icons/zoom-fit.png")));
 268         action_view_zoom_fit_->setShortcut(QKeySequence(Qt::Key_F));
 269         action_view_zoom_fit_->setObjectName(
 270                 QString::fromUtf8("actionViewZoomFit"));
 271         menu_view->addAction(action_view_zoom_fit_);
 272
 273         action_view_zoom_one_to_one_->setText(tr("Zoom to &One-to-One"));
 274         action_view_zoom_one_to_one_->setIcon(QIcon::fromTheme("zoom-original",
 275                 QIcon(":/icons/zoom-original.png")));
 276         action_view_zoom_one_to_one_->setShortcut(QKeySequence(Qt::Key_O));
 277         action_view_zoom_one_to_one_->setObjectName(
 278                 QString::fromUtf8("actionViewZoomOneToOne"));
 279         menu_view->addAction(action_view_zoom_one_to_one_);
 280
 281         menu_view->addSeparator();
 282
 283         action_view_show_cursors_->setCheckable(true);
 284         action_view_show_cursors_->setChecked(view_->cursors_shown());
 285         action_view_show_cursors_->setIcon(QIcon::fromTheme("show-cursors",
 286                 QIcon(":/icons/show-cursors.svg")));
 287         action_view_show_cursors_->setShortcut(QKeySequence(Qt::Key_C));
 288         action_view_show_cursors_->setObjectName(
 289                 QString::fromUtf8("actionViewShowCursors"));
 290         action_view_show_cursors_->setText(tr("Show &Cursors"));
 291         menu_view->addAction(action_view_show_cursors_);
 292
 293         // Decoders Menu
 294 #ifdef ENABLE_DECODE
 295         QMenu *const menu_decoders = new QMenu;
 296         menu_decoders->setTitle(tr("&Decoders"));
 297
 298         pv::widgets::DecoderMenu *const menu_decoders_add =
 299                 new pv::widgets::DecoderMenu(menu_decoders, true);
 300         menu_decoders_add->setTitle(tr("&Add"));
 301         connect(menu_decoders_add, SIGNAL(decoder_selected(srd_decoder*)),
 302                 this, SLOT(add_decoder(srd_decoder*)));
 303
 304         menu_decoders->addMenu(menu_decoders_add);
 305 #endif
 306
 307         // Help Menu
 308         QMenu *const menu_help = new QMenu;
 309         menu_help->setTitle(tr("&Help"));
 310
 311         action_about_->setObjectName(QString::fromUtf8("actionAbout"));
 312         action_about_->setText(tr("&About..."));
 313         menu_help->addAction(action_about_);
 314
 315         menu_bar->addAction(menu_file->menuAction());
 316         menu_bar->addAction(menu_view->menuAction());
 317 #ifdef ENABLE_DECODE
 318         menu_bar->addAction(menu_decoders->menuAction());
 319 #endif
 320         menu_bar->addAction(menu_help->menuAction());
 321
 322         setMenuBar(menu_bar);
 323         QMetaObject::connectSlotsByName(this);
 324
 325         // Setup the toolbar
 326         QToolBar *const toolbar = new QToolBar(tr("Main Toolbar"), this);
 327         toolbar->setObjectName(QString::fromUtf8("MainToolbar"));
 328         toolbar->addAction(action_open_);
 329         toolbar->addAction(action_save_as_);
 330         toolbar->addSeparator();
 331         toolbar->addAction(action_view_zoom_in_);
 332         toolbar->addAction(action_view_zoom_out_);
 333         toolbar->addAction(action_view_zoom_fit_);
 334         toolbar->addAction(action_view_zoom_one_to_one_);
 335         addToolBar(toolbar);
 336
 337         // Setup the sampling bar
 338         main_bar_ = new toolbars::MainBar(session_, *this);
 339
 340         // Populate the device list and select the initially selected device
 341         update_device_list();
 342
 343         addToolBar(main_bar_);
 344
 345         // Set the title
 346         setWindowTitle(tr("PulseView"));
 347
 348         // Setup session_ events
 349         connect(&session_, SIGNAL(capture_state_changed(int)), this,
 350                 SLOT(capture_state_changed(int)));
 351         connect(&session_, SIGNAL(device_selected()), this,
 352                 SLOT(device_selected()));
 353 }
 354
 355 void MainWindow::save_ui_settings()
 356 {
 357         QSettings settings;
 358
 359         map<string, string> dev_info;
 360         list<string> key_list;
 361
 362         settings.beginGroup("MainWindow");
 363         settings.setValue("state", saveState());
 364         settings.setValue("geometry", saveGeometry());
 365         settings.endGroup();
 366
 367         if (session_.device()) {
 368                 settings.beginGroup("Device");
 369                 key_list.push_back("vendor");
 370                 key_list.push_back("model");
 371                 key_list.push_back("version");
 372                 key_list.push_back("serial_num");
 373                 key_list.push_back("connection_id");
 374
 375                 dev_info = device_manager_.get_device_info(
 376                         session_.device());
 377
 378                 for (string key : key_list) {
 379
 380                         if (dev_info.count(key))
 381                                 settings.setValue(QString::fromUtf8(key.c_str()),
 382                                                 QString::fromUtf8(dev_info.at(key).c_str()));
 383                         else
 384                                 settings.remove(QString::fromUtf8(key.c_str()));
 385                 }
 386
 387                 settings.endGroup();
 388         }
 389 }
 390
 391 void MainWindow::restore_ui_settings()
 392 {
 393         QSettings settings;
 394
 395         shared_ptr<HardwareDevice> device;
 396
 397         map<string, string> dev_info;
 398         list<string> key_list;
 399         string value;
 400
 401         settings.beginGroup("MainWindow");
 402
 403         if (settings.contains("geometry")) {
 404                 restoreGeometry(settings.value("geometry").toByteArray());
 405                 restoreState(settings.value("state").toByteArray());
 406         } else
 407                 resize(1000, 720);
 408
 409         settings.endGroup();
 410
 411         // Re-select last used device if possible.
 412         settings.beginGroup("Device");
 413         key_list.push_back("vendor");
 414         key_list.push_back("model");
 415         key_list.push_back("version");
 416         key_list.push_back("serial_num");
 417         key_list.push_back("connection_id");
 418
 419         for (string key : key_list) {
 420                 if (!settings.contains(QString::fromUtf8(key.c_str())))
 421                         continue;
 422
 423                 value = settings.value(QString::fromUtf8(key.c_str())).toString().toStdString();
 424
 425                 if (value.size() > 0)
 426                         dev_info.insert(std::make_pair(key, value));
 427         }
 428
 429         device = device_manager_.find_device_from_info(dev_info);
 430
 431         if (device) {
 432                 select_device(device);
 433                 update_device_list();
 434         }
 435
 436         settings.endGroup();
 437 }
 438
 439 void MainWindow::session_error(
 440         const QString text, const QString info_text)
 441 {
 442         QMetaObject::invokeMethod(this, "show_session_error",
 443                 Qt::QueuedConnection, Q_ARG(QString, text),
 444                 Q_ARG(QString, info_text));
 445 }
 446
 447 void MainWindow::update_device_list()
 448 {
 449         assert(main_bar_);
 450
 451         shared_ptr<Device> selected_device = session_.device();
 452         list< shared_ptr<Device> > devices;
 453
 454         if (device_manager_.devices().size() == 0)
 455                 return;
 456
 457         std::copy(device_manager_.devices().begin(),
 458                 device_manager_.devices().end(), std::back_inserter(devices));
 459
 460         if (std::find(devices.begin(), devices.end(), selected_device) ==
 461                 devices.end())
 462                 devices.push_back(selected_device);
 463         assert(selected_device);
 464
 465         main_bar_->set_device_list(devices, selected_device);
 466 }
 467
 468 void MainWindow::closeEvent(QCloseEvent *event)
 469 {
 470         save_ui_settings();
 471         event->accept();
 472 }
 473
 474 void MainWindow::load_file(QString file_name)
 475 {
 476         const QString errorMessage(
 477                 QString("Failed to load file %1").arg(file_name));
 478         const QString infoMessage;
 479
 480         try {
 481                 session_.set_file(file_name.toStdString());
 482         } catch(Error e) {
 483                 show_session_error(tr("Failed to load ") + file_name, e.what());
 484                 session_.set_default_device();
 485                 update_device_list();
 486                 return;
 487         }
 488
 489         update_device_list();
 490
 491         session_.start_capture([&, errorMessage, infoMessage](QString) {
 492                 session_error(errorMessage, infoMessage); });
 493 }
 494
 495 void MainWindow::show_session_error(
 496         const QString text, const QString info_text)
 497 {
 498         QMessageBox msg(this);
 499         msg.setText(text);
 500         msg.setInformativeText(info_text);
 501         msg.setStandardButtons(QMessageBox::Ok);
 502         msg.setIcon(QMessageBox::Warning);
 503         msg.exec();
 504 }
 505
 506 void MainWindow::on_actionOpen_triggered()
 507 {
 508         QSettings settings;
 509         const QString dir = settings.value(SettingOpenDirectory).toString();
 510
 511         // Show the dialog
 512         const QString file_name = QFileDialog::getOpenFileName(
 513                 this, tr("Open File"), dir, tr(
 514                         "Sigrok Sessions (*.sr);;"
 515                         "All Files (*.*)"));
 516
 517         if (!file_name.isEmpty()) {
 518                 load_file(file_name);
 519
 520                 const QString abs_path = QFileInfo(file_name).absolutePath();
 521                 settings.setValue(SettingOpenDirectory, abs_path);
 522         }
 523 }
 524
 525 void MainWindow::on_actionSaveAs_triggered()
 526 {
 527         using pv::dialogs::StoreProgress;
 528
 529         // Stop any currently running capture session
 530         session_.stop_capture();
 531
 532         QSettings settings;
 533         const QString dir = settings.value(SettingSaveDirectory).toString();
 534
 535         // Show the dialog
 536         const QString file_name = QFileDialog::getSaveFileName(
 537                 this, tr("Save File"), dir, tr("Sigrok Sessions (*.sr)"));
 538
 539         if (file_name.isEmpty())
 540                 return;
 541
 542         const QString abs_path = QFileInfo(file_name).absolutePath();
 543         settings.setValue(SettingSaveDirectory, abs_path);
 544
 545         StoreProgress *dlg = new StoreProgress(file_name, session_, this);
 546         dlg->run();
 547 }
 548
 549 void MainWindow::on_actionConnect_triggered()
 550 {
 551         // Stop any currently running capture session
 552         session_.stop_capture();
 553
 554         dialogs::Connect dlg(this, device_manager_);
 555
 556         // If the user selected a device, select it in the device list. Select the
 557         // current device otherwise.
 558         if (dlg.exec())
 559                 select_device(dlg.get_selected_device());
 560
 561         update_device_list();
 562 }
 563
 564 void MainWindow::on_actionQuit_triggered()
 565 {
 566         close();
 567 }
 568
 569 void MainWindow::on_actionViewZoomIn_triggered()
 570 {
 571         view_->zoom(1);
 572 }
 573
 574 void MainWindow::on_actionViewZoomOut_triggered()
 575 {
 576         view_->zoom(-1);
 577 }
 578
 579 void MainWindow::on_actionViewZoomFit_triggered()
 580 {
 581         view_->zoom_fit();
 582 }
 583
 584 void MainWindow::on_actionViewZoomOneToOne_triggered()
 585 {
 586         view_->zoom_one_to_one();
 587 }
 588
 589 void MainWindow::on_actionViewShowCursors_triggered()
 590 {
 591         assert(view_);
 592
 593         const bool show = !view_->cursors_shown();
 594         if(show)
 595                 view_->centre_cursors();
 596
 597         view_->show_cursors(show);
 598 }
 599
 600 void MainWindow::on_actionAbout_triggered()
 601 {
 602         dialogs::About dlg(device_manager_.context(), this);
 603         dlg.exec();
 604 }
 605
 606 void MainWindow::add_decoder(srd_decoder *decoder)
 607 {
 608 #ifdef ENABLE_DECODE
 609         assert(decoder);
 610         session_.add_decoder(decoder);
 611 #else
 612         (void)decoder;
 613 #endif
 614 }
 615
 616 void MainWindow::capture_state_changed(int state)
 617 {
 618         main_bar_->set_capture_state((pv::Session::capture_state)state);
 619 }
 620
 621 void MainWindow::device_selected()
 622 {
 623         // Set the title to include the device/file name
 624         const shared_ptr<sigrok::Device> device = session_.device();
 625         if (!device)
 626                 return;
 627
 628         const string display_name = device_manager_.get_display_name(device);
 629         setWindowTitle(tr("%1 - PulseView").arg(display_name.c_str()));
 630 }
 631
 632 } // namespace pv