From: Gerhard Sittig <redacted>
Date: Sun, 25 Jun 2017 17:40:14 +0000 (+0200)
Subject: session: Add support for input format options (-I cmdline parameter)
X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=724f29f311db4f8b47169e58f3f3b50e6a50ed08;p=pulseview.git

session: Add support for input format options (-I cmdline parameter)

The previous implementation supported the selection of an input format
by means of the -I command line option. This commit extends the feature
by adding support for colon separated input format options similar to
sigrok-cli.

This allows users to open files from the command line which previously
became only available after filling in dialogs, and resulted in errors
in the absence of options. Here is an example of how to use the option:

  $ pulseview -I csv:header:first-channel=2 -i filename.csv

This fixes bug #951.
---

diff --git a/pv/session.cpp b/pv/session.cpp
index aa528d19..516e1acd 100644
--- a/pv/session.cpp
+++ b/pv/session.cpp
@@ -434,26 +434,76 @@ void Session::set_default_device()
 	set_device((iter == devices.end()) ? devices.front() : *iter);
 }
 
+/**
+ * Convert generic options to data types that are specific to InputFormat.
+ *
+ * @param[in] user_spec vector of tokenized words, string format
+ * @param[in] fmt_opts input format's options, result of InputFormat::options()
+ *
+ * @return map of options suitable for InputFormat::create_input()
+ */
+map<string, Glib::VariantBase>
+Session::input_format_options(vector<string> user_spec,
+		map<string, shared_ptr<Option>> fmt_opts)
+{
+	map<string, Glib::VariantBase> result;
+
+	for (auto entry : user_spec) {
+		/*
+		 * Split key=value specs. Accept entries without separator
+		 * (for simplified boolean specifications).
+		 */
+		string key, val;
+		size_t pos = entry.find("=");
+		if (pos == std::string::npos) {
+			key = entry;
+			val = "";
+		} else {
+			key = entry.substr(0, pos);
+			val = entry.substr(pos + 1);
+		}
+
+		/*
+		 * Skip user specifications that are not a member of the
+		 * format's set of supported options. Have the text input
+		 * spec converted to the required input format specific
+		 * data type.
+		 */
+		auto found = fmt_opts.find(key);
+		if (found == fmt_opts.end())
+			continue;
+		shared_ptr<Option> opt = found->second;
+		result[key] = opt->parse_string(val);
+	}
+
+	return result;
+}
+
 void Session::load_init_file(const string &file_name, const string &format)
 {
 	shared_ptr<InputFormat> input_format;
+	map<string, Glib::VariantBase> input_opts;
 
 	if (!format.empty()) {
 		const map<string, shared_ptr<InputFormat> > formats =
 			device_manager_.context()->input_formats();
+		auto user_opts = pv::util::split_string(format, ":");
+		string user_name = user_opts.front();
+		user_opts.erase(user_opts.begin());
 		const auto iter = find_if(formats.begin(), formats.end(),
 			[&](const pair<string, shared_ptr<InputFormat> > f) {
-				return f.first == format; });
+				return f.first == user_name; });
 		if (iter == formats.end()) {
 			main_bar_->session_error(tr("Error"),
 				tr("Unexpected input format: %s").arg(QString::fromStdString(format)));
 			return;
 		}
-
 		input_format = (*iter).second;
+		input_opts = input_format_options(user_opts,
+			input_format->options());
 	}
 
-	load_file(QString::fromStdString(file_name), input_format);
+	load_file(QString::fromStdString(file_name), input_format, input_opts);
 }
 
 void Session::load_file(QString file_name,
diff --git a/pv/session.hpp b/pv/session.hpp
index c7e1699b..c4f2bed8 100644
--- a/pv/session.hpp
+++ b/pv/session.hpp
@@ -55,11 +55,14 @@ class Device;
 class InputFormat;
 class Logic;
 class Meta;
+class Option;
 class OutputFormat;
 class Packet;
 class Session;
 }  // namespace sigrok
 
+using sigrok::Option;
+
 namespace pv {
 
 class DeviceManager;
@@ -179,6 +182,10 @@ private:
 	shared_ptr<data::SignalBase> signalbase_from_channel(
 		shared_ptr<sigrok::Channel> channel) const;
 
+	static map<string, Glib::VariantBase> input_format_options(
+		vector<string> user_spec,
+		map<string, shared_ptr<Option>> fmt_opts);
+
 private:
 	void sample_thread_proc(function<void (const QString)> error_handler);