[pulseview.git] / main.cpp

/*
 * This file is part of the PulseView project.
 *
 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * 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, see <http://www.gnu.org/licenses/>.
 */

#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 <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"

#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(stdout,
		"Usage:\n"
		"  %s [OPTIONS] [FILE]\n"
		"\n"
		"Help Options:\n"
		"  -h, -?, --help                  Show help option\n"
		"\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;
	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;

	Application a(argc, argv);

#ifdef ANDROID
	srau_init_environment();
	pv::AndroidLogHandler::install_callbacks();
	pv::AndroidAssetReader asset_reader;
#endif

	// Parse arguments
	while (true) {
		static const struct option long_options[] = {
			{"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 int c = getopt_long(argc, argv,
			"h?VDcsl:d:i:I:", long_options, nullptr);
		if (c == -1)
			break;

		switch (c) {
		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;
		}
	}
	argc -= optind;
	argv += optind;

	for (int i = 0; i < argc; i++)
		open_files.push_back(argv[i]);

	// 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

#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 (open_files.empty())
			w.add_default_session();
		else
			for (string open_file : open_files)
				w.add_session_with_file(open_file, open_file_format);

#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

#ifdef ENABLE_DECODE
		// Destroy libsigrokdecode
		srd_exit();
#endif

	} while (false);

	return ret;
}
Commit	Line	Data
	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, see <http://www.gnu.org/licenses/>.
	18	*/
	19
	20	#ifdef ENABLE_DECODE
	21	#include <libsigrokdecode/libsigrokdecode.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
	22	#endif
	23
	24	#include <cstdint>
	25	#include <fstream>
	26	#include <getopt.h>
	27	#include <vector>
	28
	29	#include <libsigrokcxx/libsigrokcxx.hpp>
	30
	31	#include <QCheckBox>
	32	#include <QDebug>
	33	#include <QFile>
	34	#include <QFileInfo>
	35	#include <QMessageBox>
	36	#include <QSettings>
	37	#include <QTextStream>
	38
	39	#ifdef ENABLE_SIGNALS
	40	#include "signalhandler.hpp"
	41	#endif
	42
	43	#ifdef ENABLE_STACKTRACE
	44	#include <signal.h>
	45	#include <boost/stacktrace.hpp>
	46	#include <QStandardPaths>
	47	#endif
	48
	49	#include "pv/application.hpp"
	50	#include "pv/devicemanager.hpp"
	51	#include "pv/globalsettings.hpp"
	52	#include "pv/logging.hpp"
	53	#include "pv/mainwindow.hpp"
	54	#include "pv/session.hpp"
	55
	56	#ifdef ANDROID
	57	#include <libsigrokandroidutils/libsigrokandroidutils.h>
	58	#include "android/assetreader.hpp"
	59	#include "android/loghandler.hpp"
	60	#endif
	61
	62	#include "config.h"
	63
	64	#ifdef _WIN32
	65	#include <QtPlugin>
	66	Q_IMPORT_PLUGIN(QWindowsIntegrationPlugin)
	67	Q_IMPORT_PLUGIN(QSvgPlugin)
	68	#endif
	69
	70	using std::exception;
	71	using std::ifstream;
	72	using std::ofstream;
	73	using std::shared_ptr;
	74	using std::string;
	75
	76	#if ENABLE_STACKTRACE
	77	QString stacktrace_filename;
	78
	79	void signal_handler(int signum)
	80	{
	81	::signal(signum, SIG_DFL);
	82	boost::stacktrace::safe_dump_to(stacktrace_filename.toLocal8Bit().data());
	83	::raise(SIGABRT);
	84	}
	85
	86	void process_stacktrace(QString temp_path)
	87	{
	88	const QString stacktrace_outfile = temp_path + "/pv_stacktrace.txt";
	89
	90	ifstream ifs(stacktrace_filename.toLocal8Bit().data());
	91	ofstream ofs(stacktrace_outfile.toLocal8Bit().data(),
	92	ofstream::out \| ofstream::trunc);
	93
	94	boost::stacktrace::stacktrace st =
	95	boost::stacktrace::stacktrace::from_dump(ifs);
	96	ofs << st;
	97
	98	ofs.close();
	99	ifs.close();
	100
	101	QFile f(stacktrace_outfile);
	102	f.open(QFile::ReadOnly \| QFile::Text);
	103	QTextStream fs(&f);
	104	QString stacktrace = fs.readAll();
	105	stacktrace = stacktrace.trimmed().replace('\n', "<br />");
	106
	107	qDebug() << QObject::tr("Stack trace of previous crash:");
	108	qDebug() << "---------------------------------------------------------";
	109	// Note: qDebug() prints quotation marks for QString output, so we feed it char*
	110	qDebug() << stacktrace.toLocal8Bit().data();
	111	qDebug() << "---------------------------------------------------------";
	112
	113	f.close();
	114
	115	// Remove stack trace so we don't process it again the next time we run
	116	QFile::remove(stacktrace_filename.toLocal8Bit().data());
	117
	118	// Show notification dialog if permitted
	119	pv::GlobalSettings settings;
	120	if (settings.value(pv::GlobalSettings::Key_Log_NotifyOfStacktrace).toBool()) {
	121	QCheckBox *cb = new QCheckBox(QObject::tr("Don't show this message again"));
	122
	123	QMessageBox msgbox;
	124	msgbox.setText(QObject::tr("When %1 last crashed, it created a stack trace.\n" \
	125	"A human-readable form has been saved to disk and was written to " \
	126	"the log. You may access it from the settings dialog.").arg(PV_TITLE));
	127	msgbox.setIcon(QMessageBox::Icon::Information);
	128	msgbox.addButton(QMessageBox::Ok);
	129	msgbox.setCheckBox(cb);
	130
	131	QObject::connect(cb, &QCheckBox::stateChanged, [](int state){
	132	pv::GlobalSettings settings;
	133	settings.setValue(pv::GlobalSettings::Key_Log_NotifyOfStacktrace,
	134	!state); });
	135
	136	msgbox.exec();
	137	}
	138	}
	139	#endif
	140
	141	void usage()
	142	{
	143	fprintf(stdout,
	144	"Usage:\n"
	145	" %s [OPTIONS] [FILE]\n"
	146	"\n"
	147	"Help Options:\n"
	148	" -h, -?, --help Show help option\n"
	149	"\n"
	150	"Application Options:\n"
	151	" -V, --version Show release version\n"
	152	" -l, --loglevel Set libsigrok/libsigrokdecode loglevel\n"
	153	" -d, --driver Specify the device driver to use\n"
	154	" -D, --no-scan Don't auto-scan for devices, use -d spec only\n"
	155	" -i, --input-file Load input from file\n"
	156	" -I, --input-format Input format\n"
	157	" -c, --clean Don't restore previous sessions on startup\n"
	158	" -s, --log-to-stdout Don't use logging, output to stdout instead\n"
	159	"\n", PV_BIN_NAME);
	160	}
	161
	162	int main(int argc, char *argv[])
	163	{
	164	int ret = 0;
	165	shared_ptr<sigrok::Context> context;
	166	string open_file_format, driver;
	167	vector<string> open_files;
	168	bool restore_sessions = true;
	169	bool do_scan = true;
	170	bool do_logging = true;
	171
	172	Application a(argc, argv);
	173
	174	#ifdef ANDROID
	175	srau_init_environment();
	176	pv::AndroidLogHandler::install_callbacks();
	177	pv::AndroidAssetReader asset_reader;
	178	#endif
	179
	180	// Parse arguments
	181	while (true) {
	182	static const struct option long_options[] = {
	183	{"help", no_argument, nullptr, 'h'},
	184	{"version", no_argument, nullptr, 'V'},
	185	{"loglevel", required_argument, nullptr, 'l'},
	186	{"driver", required_argument, nullptr, 'd'},
	187	{"no-scan", no_argument, nullptr, 'D'},
	188	{"input-file", required_argument, nullptr, 'i'},
	189	{"input-format", required_argument, nullptr, 'I'},
	190	{"clean", no_argument, nullptr, 'c'},
	191	{"log-to-stdout", no_argument, nullptr, 's'},
	192	{nullptr, 0, nullptr, 0}
	193	};
	194
	195	const int c = getopt_long(argc, argv,
	196	"h?VDcsl:d:i:I:", long_options, nullptr);
	197	if (c == -1)
	198	break;
	199
	200	switch (c) {
	201	case 'h':
	202	case '?':
	203	usage();
	204	return 0;
	205
	206	case 'V':
	207	// Print version info
	208	fprintf(stdout, "%s %s\n", PV_TITLE, PV_VERSION_STRING);
	209	return 0;
	210
	211	case 'l':
	212	{
	213	const int loglevel = atoi(optarg);
	214	if (loglevel < 0 \|\| loglevel > 5) {
	215	qDebug() << "ERROR: invalid log level spec.";
	216	break;
	217	}
	218	context->set_log_level(sigrok::LogLevel::get(loglevel));
	219
	220	#ifdef ENABLE_DECODE
	221	srd_log_loglevel_set(loglevel);
	222	#endif
	223
	224	if (loglevel >= 5) {
	225	const QSettings settings;
	226	qDebug() << "Settings:" << settings.fileName()
	227	<< "format" << settings.format();
	228	}
	229	break;
	230	}
	231
	232	case 'd':
	233	driver = optarg;
	234	break;
	235
	236	case 'D':
	237	do_scan = false;
	238	break;
	239
	240	case 'i':
	241	open_files.push_back(optarg);
	242	break;
	243
	244	case 'I':
	245	open_file_format = optarg;
	246	break;
	247
	248	case 'c':
	249	restore_sessions = false;
	250	break;
	251
	252	case 's':
	253	do_logging = false;
	254	break;
	255	}
	256	}
	257	argc -= optind;
	258	argv += optind;
	259
	260	for (int i = 0; i < argc; i++)
	261	open_files.push_back(argv[i]);
	262
	263	// Prepare the global settings since logging needs them early on
	264	pv::GlobalSettings settings;
	265	settings.set_defaults_where_needed();
	266
	267	if (do_logging)
	268	pv::logging.init();
	269
	270	// Initialise libsigrok
	271	context = sigrok::Context::create();
	272	pv::Session::sr_context = context;
	273
	274	#if ENABLE_STACKTRACE
	275	QString temp_path = QStandardPaths::standardLocations(
	276	QStandardPaths::TempLocation).at(0);
	277	stacktrace_filename = temp_path + "/pv_stacktrace.dmp";
	278	qDebug() << "Stack trace file is" << stacktrace_filename;
	279
	280	::signal(SIGSEGV, &signal_handler);
	281	::signal(SIGABRT, &signal_handler);
	282
	283	if (QFileInfo::exists(stacktrace_filename))
	284	process_stacktrace(temp_path);
	285	#endif
	286
	287	#ifdef ANDROID
	288	context->set_resource_reader(&asset_reader);
	289	#endif
	290	do {
	291
	292	#ifdef ENABLE_DECODE
	293	// Initialise libsigrokdecode
	294	if (srd_init(nullptr) != SRD_OK) {
	295	qDebug() << "ERROR: libsigrokdecode init failed.";
	296	break;
	297	}
	298
	299	// Load the protocol decoders
	300	srd_decoder_load_all();
	301	#endif
	302
	303	#ifndef ENABLE_STACKTRACE
	304	try {
	305	#endif
	306
	307	// Create the device manager, initialise the drivers
	308	pv::DeviceManager device_manager(context, driver, do_scan);
	309
	310	// Initialise the main window
	311	pv::MainWindow w(device_manager);
	312	w.show();
	313
	314	if (restore_sessions)
	315	w.restore_sessions();
	316
	317	if (open_files.empty())
	318	w.add_default_session();
	319	else
	320	for (string open_file : open_files)
	321	w.add_session_with_file(open_file, open_file_format);
	322
	323	#ifdef ENABLE_SIGNALS
	324	if (SignalHandler::prepare_signals()) {
	325	SignalHandler *const handler = new SignalHandler(&w);
	326	QObject::connect(handler, SIGNAL(int_received()),
	327	&w, SLOT(close()));
	328	QObject::connect(handler, SIGNAL(term_received()),
	329	&w, SLOT(close()));
	330	} else
	331	qWarning() << "Could not prepare signal handler.";
	332	#endif
	333
	334	// Run the application
	335	ret = a.exec();
	336
	337	#ifndef ENABLE_STACKTRACE
	338	} catch (exception& e) {
	339	qDebug() << "Exception:" << e.what();
	340	}
	341	#endif
	342
	343	#ifdef ENABLE_DECODE
	344	// Destroy libsigrokdecode
	345	srd_exit();
	346	#endif
	347
	348	} while (false);
	349
	350	return ret;
	351	}