Fix #770 by adding a vertical hover line and a setting for it
[pulseview.git] / main.cpp
index f4506787364fa11ea01286cf2e569ffed5587c15..cdc750aa80aade18b21916708463189c78a41f9a 100644 (file)
--- a/main.cpp
+++ b/main.cpp
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+ * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 
-extern "C" {
-#include <sigrokdecode.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
-#include <stdint.h>
-#include <libsigrok/libsigrok.h>
-}
+#ifdef ENABLE_DECODE
+#include <libsigrokdecode/libsigrokdecode.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
+#endif
 
+#include <cstdint>
+#include <fstream>
 #include <getopt.h>
+#include <vector>
+
+#include <libsigrokcxx/libsigrokcxx.hpp>
 
-#include <QtGui/QApplication>
+#include <QCheckBox>
 #include <QDebug>
+#include <QFile>
+#include <QFileInfo>
+#include <QMessageBox>
+#include <QSettings>
+#include <QTextStream>
+
+#ifdef ENABLE_SIGNALS
+#include "signalhandler.hpp"
+#endif
+
+#ifdef ENABLE_STACKTRACE
+#include <signal.h>
+#include <boost/stacktrace.hpp>
+#include <QStandardPaths>
+#endif
+
+#include "pv/application.hpp"
+#include "pv/devicemanager.hpp"
+#include "pv/globalsettings.hpp"
+#include "pv/logging.hpp"
+#include "pv/mainwindow.hpp"
+#include "pv/session.hpp"
 
-#include "pv/mainwindow.h"
+#ifdef ANDROID
+#include <libsigrokandroidutils/libsigrokandroidutils.h>
+#include "android/assetreader.hpp"
+#include "android/loghandler.hpp"
+#endif
 
 #include "config.h"
 
+#ifdef _WIN32
+#include <QtPlugin>
+Q_IMPORT_PLUGIN(QWindowsIntegrationPlugin)
+Q_IMPORT_PLUGIN(QSvgPlugin)
+#endif
+
+using std::exception;
+using std::ifstream;
+using std::ofstream;
+using std::shared_ptr;
+using std::string;
+
+#if ENABLE_STACKTRACE
+QString stacktrace_filename;
+
+void signal_handler(int signum)
+{
+       ::signal(signum, SIG_DFL);
+       boost::stacktrace::safe_dump_to(stacktrace_filename.toLocal8Bit().data());
+       ::raise(SIGABRT);
+}
+
+void process_stacktrace(QString temp_path)
+{
+       const QString stacktrace_outfile = temp_path + "/pv_stacktrace.txt";
+
+       ifstream ifs(stacktrace_filename.toLocal8Bit().data());
+       ofstream ofs(stacktrace_outfile.toLocal8Bit().data(),
+               ofstream::out | ofstream::trunc);
+
+       boost::stacktrace::stacktrace st =
+               boost::stacktrace::stacktrace::from_dump(ifs);
+       ofs << st;
+
+       ofs.close();
+       ifs.close();
+
+       QFile f(stacktrace_outfile);
+       f.open(QFile::ReadOnly | QFile::Text);
+       QTextStream fs(&f);
+       QString stacktrace = fs.readAll();
+       stacktrace = stacktrace.trimmed().replace('\n', "<br />");
+
+       qDebug() << QObject::tr("Stack trace of previous crash:");
+       qDebug() << "---------------------------------------------------------";
+       // Note: qDebug() prints quotation marks for QString output, so we feed it char*
+       qDebug() << stacktrace.toLocal8Bit().data();
+       qDebug() << "---------------------------------------------------------";
+
+       f.close();
+
+       // Remove stack trace so we don't process it again the next time we run
+       QFile::remove(stacktrace_filename.toLocal8Bit().data());
+
+       // Show notification dialog if permitted
+       pv::GlobalSettings settings;
+       if (settings.value(pv::GlobalSettings::Key_Log_NotifyOfStacktrace).toBool()) {
+               QCheckBox *cb = new QCheckBox(QObject::tr("Don't show this message again"));
+
+               QMessageBox msgbox;
+               msgbox.setText(QObject::tr("When %1 last crashed, it created a stack trace.\n" \
+                       "A human-readable form has been saved to disk and was written to " \
+                       "the log. You may access it from the settings dialog.").arg(PV_TITLE));
+               msgbox.setIcon(QMessageBox::Icon::Information);
+               msgbox.addButton(QMessageBox::Ok);
+               msgbox.setCheckBox(cb);
+
+               QObject::connect(cb, &QCheckBox::stateChanged, [](int state){
+                       pv::GlobalSettings settings;
+                       settings.setValue(pv::GlobalSettings::Key_Log_NotifyOfStacktrace,
+                               !state); });
+
+               msgbox.exec();
+       }
+}
+#endif
+
 void usage()
 {
-       fprintf(stderr,
+       fprintf(stdout,
                "Usage:\n"
-               "  %s — %s\n"
+               "  %s [OPTIONS] [FILE]\n"
                "\n"
                "Help Options:\n"
-               "  -V, --version                   Show release version\n"
                "  -h, -?, --help                  Show help option\n"
-               "\n", PV_BIN_NAME, PV_DESCRIPTION);
+               "\n"
+               "Application Options:\n"
+               "  -V, --version                   Show release version\n"
+               "  -l, --loglevel                  Set libsigrok/libsigrokdecode loglevel\n"
+               "  -d, --driver                    Specify the device driver to use\n"
+               "  -D, --no-scan                   Don't auto-scan for devices, use -d spec only\n"
+               "  -i, --input-file                Load input from file\n"
+               "  -I, --input-format              Input format\n"
+               "  -c, --clean                     Don't restore previous sessions on startup\n"
+               "  -s, --log-to-stdout             Don't use logging, output to stdout instead\n"
+               "\n", PV_BIN_NAME);
 }
 
 int main(int argc, char *argv[])
 {
        int ret = 0;
-       struct sr_context *sr_ctx = NULL;
+       shared_ptr<sigrok::Context> context;
+       string open_file_format, driver;
+       vector<string> open_files;
+       bool restore_sessions = true;
+       bool do_scan = true;
+       bool do_logging = true;
 
-       QApplication a(argc, argv);
+       Application a(argc, argv);
 
-       // Set some application metadata
-       QApplication::setApplicationVersion(PV_VERSION_STRING);
-       QApplication::setApplicationName("PulseView");
-       QApplication::setOrganizationDomain("http://www.sigrok.org");
+#ifdef ANDROID
+       srau_init_environment();
+       pv::AndroidLogHandler::install_callbacks();
+       pv::AndroidAssetReader asset_reader;
+#endif
 
        // Parse arguments
-       while (1) {
+       while (true) {
                static const struct option long_options[] = {
-                       {"version", no_argument, 0, 'V'},
-                       {"help", no_argument, 0, 'h'},
-                       {0, 0, 0, 0}
+                       {"help", no_argument, nullptr, 'h'},
+                       {"version", no_argument, nullptr, 'V'},
+                       {"loglevel", required_argument, nullptr, 'l'},
+                       {"driver", required_argument, nullptr, 'd'},
+                       {"no-scan", no_argument, nullptr, 'D'},
+                       {"input-file", required_argument, nullptr, 'i'},
+                       {"input-format", required_argument, nullptr, 'I'},
+                       {"clean", no_argument, nullptr, 'c'},
+                       {"log-to-stdout", no_argument, nullptr, 's'},
+                       {nullptr, 0, nullptr, 0}
                };
 
-               const char c = getopt_long(argc, argv,
-                       "Vh?", long_options, NULL);
+               const int c = getopt_long(argc, argv,
+                       "h?VDcsl:d:i:I:", long_options, nullptr);
                if (c == -1)
                        break;
 
                switch (c) {
-               case 'V':
-                       // Print version info
-                       fprintf(stderr, "%s %s\n", PV_TITLE, PV_VERSION_STRING);
-                       return 0;
-
                case 'h':
                case '?':
                        usage();
                        return 0;
+
+               case 'V':
+                       // Print version info
+                       fprintf(stdout, "%s %s\n", PV_TITLE, PV_VERSION_STRING);
+                       return 0;
+
+               case 'l':
+               {
+                       const int loglevel = atoi(optarg);
+                       if (loglevel < 0 || loglevel > 5) {
+                               qDebug() << "ERROR: invalid log level spec.";
+                               break;
+                       }
+                       context->set_log_level(sigrok::LogLevel::get(loglevel));
+
+#ifdef ENABLE_DECODE
+                       srd_log_loglevel_set(loglevel);
+#endif
+
+                       if (loglevel >= 5) {
+                               const QSettings settings;
+                               qDebug() << "Settings:" << settings.fileName()
+                                       << "format" << settings.format();
+                       }
+                       break;
+               }
+
+               case 'd':
+                       driver = optarg;
+                       break;
+
+               case 'D':
+                       do_scan = false;
+                       break;
+
+               case 'i':
+                       open_files.push_back(optarg);
+                       break;
+
+               case 'I':
+                       open_file_format = optarg;
+                       break;
+
+               case 'c':
+                       restore_sessions = false;
+                       break;
+
+               case 's':
+                       do_logging = false;
+                       break;
                }
        }
 
-       // Initialise libsigrok
-       if (sr_init(&sr_ctx) != SR_OK) {
-               qDebug() << "ERROR: libsigrok init failed.";
-               return 1;
+       while (argc - optind > 0) {
+               open_files.push_back(argv[optind]);
+               optind++;
        }
 
-       // Initialise libsigrokdecode
-       if (srd_init(NULL) == SRD_OK) {
+       // Prepare the global settings since logging needs them early on
+       pv::GlobalSettings settings;
+       settings.set_defaults_where_needed();
+
+       if (do_logging)
+               pv::logging.init();
+
+       // Initialise libsigrok
+       context = sigrok::Context::create();
+       pv::Session::sr_context = context;
+
+#if ENABLE_STACKTRACE
+       QString temp_path = QStandardPaths::standardLocations(
+               QStandardPaths::TempLocation).at(0);
+       stacktrace_filename = temp_path + "/pv_stacktrace.dmp";
+       qDebug() << "Stack trace file is" << stacktrace_filename;
+
+       ::signal(SIGSEGV, &signal_handler);
+       ::signal(SIGABRT, &signal_handler);
+
+       if (QFileInfo::exists(stacktrace_filename))
+               process_stacktrace(temp_path);
+#endif
+
+#ifdef ANDROID
+       context->set_resource_reader(&asset_reader);
+#endif
+       do {
+
+#ifdef ENABLE_DECODE
+               // Initialise libsigrokdecode
+               if (srd_init(nullptr) != SRD_OK) {
+                       qDebug() << "ERROR: libsigrokdecode init failed.";
+                       break;
+               }
 
                // Load the protocol decoders
                srd_decoder_load_all();
+#endif
 
-               // Initialize all libsigrok drivers
-               sr_dev_driver **const drivers = sr_driver_list();
-               for (sr_dev_driver **driver = drivers; *driver; driver++) {
-                       if (sr_driver_init(sr_ctx, *driver) != SR_OK) {
-                               qDebug("Failed to initialize driver %s",
-                                       (*driver)->name);
-                               ret = 1;
-                               break;
-                       }
-               }
+#ifndef ENABLE_STACKTRACE
+               try {
+#endif
+
+               // Create the device manager, initialise the drivers
+               pv::DeviceManager device_manager(context, driver, do_scan);
+
+               // Initialise the main window
+               pv::MainWindow w(device_manager);
+               w.show();
+
+               if (restore_sessions)
+                       w.restore_sessions();
 
-               if (ret == 0) {
-                       // Initialise the main window
-                       pv::MainWindow w;
-                       w.show();
+               if (open_files.empty())
+                       w.add_default_session();
+               else
+                       for (string open_file : open_files)
+                               w.add_session_with_file(open_file, open_file_format);
 
-                       // Run the application
-                       ret = a.exec();
+#ifdef ENABLE_SIGNALS
+               if (SignalHandler::prepare_signals()) {
+                       SignalHandler *const handler = new SignalHandler(&w);
+                       QObject::connect(handler, SIGNAL(int_received()),
+                               &w, SLOT(close()));
+                       QObject::connect(handler, SIGNAL(term_received()),
+                               &w, SLOT(close()));
+               } else
+                       qWarning() << "Could not prepare signal handler.";
+#endif
+
+               // Run the application
+               ret = a.exec();
+
+#ifndef ENABLE_STACKTRACE
+               } catch (exception& e) {
+                       qDebug() << "Exception:" << e.what();
                }
+#endif
 
-               // Destroy libsigrokdecode and libsigrok
+#ifdef ENABLE_DECODE
+               // Destroy libsigrokdecode
                srd_exit();
+#endif
 
-       } else {
-               qDebug() << "ERROR: libsigrokdecode init failed.";
-       }
-
-       if (sr_ctx)
-               sr_exit(sr_ctx);
+       } while (false);
 
        return ret;
 }