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