[sigrok-cli.git] / parsers.c

/*
 * This file is part of the sigrok-cli project.
 *
 * Copyright (C) 2011 Bert Vermeulen <bert@biot.com>
 *
 * 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 3 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/>.
 */

#include <config.h>
#include <stdio.h>
#include <stdlib.h>
#include <stdint.h>
#include <string.h>
#include <glib.h>
#include "sigrok-cli.h"

struct sr_channel *find_channel(GSList *channellist, const char *channelname)
{
	struct sr_channel *ch;
	GSList *l;

	ch = NULL;
	for (l = channellist; l; l = l->next) {
		ch = l->data;
		if (!strcmp(ch->name, channelname))
			break;
	}
	ch = l ? l->data : NULL;

	return ch;
}

GSList *parse_channelstring(struct sr_dev_inst *sdi, const char *channelstring)
{
	struct sr_channel *ch;
	GSList *channellist, *channels;
	int ret, n, b, e, i;
	char **tokens, **range, **names, *eptr, str[8];

	channels = sr_dev_inst_channels_get(sdi);

	if (!channelstring || !channelstring[0])
		/* Use all channels by default. */
		return g_slist_copy(channels);

	ret = SR_OK;
	range = NULL;
	names = NULL;
	channellist = NULL;
	tokens = g_strsplit(channelstring, ",", 0);
	for (i = 0; tokens[i]; i++) {
		if (tokens[i][0] == '\0') {
			g_critical("Invalid empty channel.");
			ret = SR_ERR;
			break;
		}
		if (strchr(tokens[i], '-')) {
			/*
			 * A range of channels in the form a-b. This will only work
			 * if the channels are named as numbers -- so every channel
			 * in the range must exist as a channel name string in the
			 * device.
			 */
			range = g_strsplit(tokens[i], "-", 2);
			if (!range[0] || !range[1] || range[2]) {
				/* Need exactly two arguments. */
				g_critical("Invalid channel syntax '%s'.", tokens[i]);
				ret = SR_ERR;
				goto range_fail;
			}

			b = strtol(range[0], &eptr, 10);
			if (eptr == range[0] || *eptr != '\0') {
				g_critical("Invalid channel '%s'.", range[0]);
				ret = SR_ERR;
				goto range_fail;
			}
			e = strtol(range[1], NULL, 10);
			if (eptr == range[1] || *eptr != '\0') {
				g_critical("Invalid channel '%s'.", range[1]);
				ret = SR_ERR;
				goto range_fail;
			}
			if (b < 0 || b >= e) {
				g_critical("Invalid channel range '%s'.", tokens[i]);
				ret = SR_ERR;
				goto range_fail;
			}

			while (b <= e) {
				n = snprintf(str, 8, "%d", b);
				if (n < 0 || n > 8) {
					g_critical("Invalid channel '%d'.", b);
					ret = SR_ERR;
					break;
				}
				ch = find_channel(channels, str);
				if (!ch) {
					g_critical("unknown channel '%d'.", b);
					ret = SR_ERR;
					break;
				}
				channellist = g_slist_append(channellist, ch);
				b++;
			}
range_fail:
			if (range)
				g_strfreev(range);

			if (ret != SR_OK)
				break;
		} else {
			names = g_strsplit(tokens[i], "=", 2);
			if (!names[0] || (names[1] && names[2])) {
				/* Need one or two arguments. */
				g_critical("Invalid channel '%s'.", tokens[i]);
				g_strfreev(names);
				ret = SR_ERR;
				break;
			}

			ch = find_channel(channels, names[0]);
			if (!ch) {
				g_critical("unknown channel '%s'.", names[0]);
				g_strfreev(names);
				ret = SR_ERR;
				break;
			}
			if (names[1]) {
				/* Rename channel. */
				g_free(ch->name);
				ch->name = g_strdup(names[1]);
			}
			channellist = g_slist_append(channellist, ch);

			g_strfreev(names);
		}
	}

	if (ret != SR_OK) {
		g_slist_free(channellist);
		channellist = NULL;
	}

	g_strfreev(tokens);

	return channellist;
}

int parse_trigger_match(char c)
{
	int match;

	if (c == '0')
		match = SR_TRIGGER_ZERO;
	else if (c == '1')
		match = SR_TRIGGER_ONE;
	else if (c == 'r')
		match = SR_TRIGGER_RISING;
	else if (c == 'f')
		match = SR_TRIGGER_FALLING;
	else if (c == 'e')
		match = SR_TRIGGER_EDGE;
	else if (c == 'o')
		match = SR_TRIGGER_OVER;
	else if (c == 'u')
		match = SR_TRIGGER_UNDER;
	else
		match = 0;

	return match;
}

int parse_triggerstring(const struct sr_dev_inst *sdi, const char *s,
		struct sr_trigger **trigger)
{
	struct sr_channel *ch;
	struct sr_trigger_stage *stage;
	GVariant *gvar;
	GSList *l, *channels;
	gsize num_matches;
	gboolean found_match, error;
	const int32_t *matches;
	int32_t match;
	unsigned int j;
	int t, i;
	char **tokens, *sep;
	struct sr_dev_driver *driver;

	driver = sr_dev_inst_driver_get(sdi);
	channels = sr_dev_inst_channels_get(sdi);

	if (maybe_config_list(driver, sdi, NULL, SR_CONF_TRIGGER_MATCH,
			&gvar) != SR_OK) {
		g_critical("Device doesn't support any triggers.");
		return FALSE;
	}
	matches = g_variant_get_fixed_array(gvar, &num_matches, sizeof(int32_t));

	*trigger = sr_trigger_new(NULL);
	error = FALSE;
	tokens = g_strsplit(s, ",", -1);
	for (i = 0; tokens[i]; i++) {
		if (!(sep = strchr(tokens[i], '='))) {
			g_critical("Invalid trigger '%s'.", tokens[i]);
			error = TRUE;
			break;
		}
		*sep++ = 0;
		ch = NULL;
		for (l = channels; l; l = l->next) {
			ch = l->data;
			if (ch->enabled && !strcmp(ch->name, tokens[i]))
				break;
			ch = NULL;
		}
		if (!ch) {
			g_critical("Invalid channel '%s'.", tokens[i]);
			error = TRUE;
			break;
		}
		for (t = 0; sep[t]; t++) {
			if (!(match = parse_trigger_match(sep[t]))) {
				g_critical("Invalid trigger match '%c'.", sep[t]);
				error = TRUE;
				break;
			}
			found_match = FALSE;
			for (j = 0; j < num_matches; j++) {
				if (matches[j] == match) {
					found_match = TRUE;
					break;
				}
			}
			if (!found_match) {
				g_critical("Trigger match '%c' not supported by device.", sep[t]);
				error = TRUE;
				break;
			}
			/* Make sure this ends up in the right stage, creating
			 * them as needed. */
			while (!(stage = g_slist_nth_data((*trigger)->stages, t)))
				sr_trigger_stage_add(*trigger);
			if (sr_trigger_match_add(stage, ch, match, 0) != SR_OK) {
				error = TRUE;
				break;
			}
		}
	}
	g_strfreev(tokens);
	g_variant_unref(gvar);

	if (error)
		sr_trigger_free(*trigger);

	return !error;
}

/**
 * Create hash table from colon separated key-value pairs input text.
 *
 * Accepts input text as it was specified by users. Splits the colon
 * separated key-value pairs and creates a hash table from these items.
 * Optionally supports special forms which are useful for different CLI
 * features.
 *
 * Typical form: <key>=<val>[:<key>=<val>]*
 * Generic list of key-value pairs, all items being equal. Mere set.
 *
 * ID form: <id>[:<key>=<val>]*
 * First item is not a key-value pair, instead it's an identifier. Used
 * to specify a protocol decoder, or a device driver, or an input/output
 * file format, optionally followed by more parameters' values. The ID
 * part of the input spec is not optional.
 *
 * Optional ID: [<sel>=<id>][:<key>=<val>]*
 * All items are key-value pairs. The first item _may_ be an identifier,
 * if its key matches a caller specified key name. Otherwise the input
 * text is the above typical form, a mere list of key-value pairs while
 * none of them is special.
 *
 * @param[in] arg Input text.
 * @param[in] sep_first Boolean, whether ID form is required.
 * @param[in] key_first Keyword name if optional ID is applicable.
 *
 * @returns A hash table which contains the key/value pairs, or #NULL
 *   when the input is invalid.
 */
GHashTable *parse_generic_arg(const char *arg,
	gboolean sep_first, const char *key_first)
{
	GHashTable *hash;
	int i;
	char **elements, *e;
	int l;
	const char *s;

	if (!arg || !arg[0])
		return NULL;

	i = 0;
	hash = g_hash_table_new_full(g_str_hash, g_str_equal,
			g_free, g_free);
	elements = g_strsplit(arg, ":", 0);
	if (sep_first) {
		/*
		 * Caller requested "<id>[:<key>=<val>]*" case, Consume the
		 * first item, before processing more key-value pairs below.
		 */
		g_hash_table_insert(hash, g_strdup("sigrok_key"),
				g_strdup(elements[i++]));
	} else if (key_first && *key_first) {
		/*
		 * Caller requested "[<sig>=<id>][:<key>=<val>]*" case.
		 * Optional special handling of the first item, but only
		 * consume this first item here when its keyword matched
		 * the caller's specification.
		 */
		l = strlen(key_first);
		s = elements[i];
		e = strchr(s, '=');
		if (e && e - s == l && g_str_has_prefix(s, key_first)) {
			g_hash_table_insert(hash,
				g_strdup("sigrok_key"), g_strdup(++e));
			i++;
		}
	}
	for (; elements[i]; i++) {
		e = strchr(elements[i], '=');
		if (!e)
			g_hash_table_insert(hash, g_strdup(elements[i]), NULL);
		else {
			*e++ = '\0';
			g_hash_table_insert(hash, g_strdup(elements[i]), g_strdup(e));
		}
	}
	g_strfreev(elements);

	return hash;
}

GSList *check_unknown_keys(const struct sr_option **avail, GHashTable *used)
{
	GSList *unknown;
	GHashTableIter iter;
	void *key;
	const char *used_id;
	size_t avail_idx;
	const char *avail_id, *found_id;

	/* Collect a list of used but not available keywords. */
	unknown = NULL;
	g_hash_table_iter_init(&iter, used);
	while (g_hash_table_iter_next(&iter, &key, NULL)) {
		used_id = key;
		found_id = NULL;
		for (avail_idx = 0; avail[avail_idx] && avail[avail_idx]->id; avail_idx++) {
			avail_id = avail[avail_idx]->id;
			if (strcmp(avail_id, used_id) == 0) {
				found_id = avail_id;
				break;
			}
		}
		if (!found_id)
			unknown = g_slist_append(unknown, g_strdup(used_id));
	}

	/* Return the list of unknown keywords, or NULL if empty. */
	return unknown;
}

gboolean warn_unknown_keys(const struct sr_option **avail, GHashTable *used,
	const char *caption)
{
	GSList *unknown, *l;
	gboolean had_unknown;
	const char *s;

	if (!caption || !*caption)
		caption = "Unknown keyword";

	unknown = check_unknown_keys(avail, used);
	had_unknown = unknown != NULL;
	for (l = unknown; l; l = l->next) {
		s = l->data;
		g_warning("%s: %s.", caption, s);
	}
	g_slist_free_full(unknown, g_free);

	return had_unknown;
}

GHashTable *generic_arg_to_opt(const struct sr_option **opts, GHashTable *genargs)
{
	GHashTable *hash;
	GVariant *gvar;
	int i;
	char *s;
	gboolean b;

	hash = g_hash_table_new_full(g_str_hash, g_str_equal, g_free,
			(GDestroyNotify)g_variant_unref);
	for (i = 0; opts[i]; i++) {
		if (!(s = g_hash_table_lookup(genargs, opts[i]->id)))
			continue;
		if (g_variant_is_of_type(opts[i]->def, G_VARIANT_TYPE_UINT32)) {
			gvar = g_variant_new_uint32(strtoul(s, NULL, 10));
			g_hash_table_insert(hash, g_strdup(opts[i]->id),
					g_variant_ref_sink(gvar));
		} else if (g_variant_is_of_type(opts[i]->def, G_VARIANT_TYPE_INT32)) {
			gvar = g_variant_new_int32(strtoul(s, NULL, 10));
			g_hash_table_insert(hash, g_strdup(opts[i]->id),
					g_variant_ref_sink(gvar));
		} else if (g_variant_is_of_type(opts[i]->def, G_VARIANT_TYPE_UINT64)) {
			gvar = g_variant_new_uint64(strtoul(s, NULL, 10));
			g_hash_table_insert(hash, g_strdup(opts[i]->id),
					g_variant_ref_sink(gvar));
		} else if (g_variant_is_of_type(opts[i]->def, G_VARIANT_TYPE_DOUBLE)) {
			gvar = g_variant_new_double(strtod(s, NULL));
			g_hash_table_insert(hash, g_strdup(opts[i]->id),
					g_variant_ref_sink(gvar));
		} else if (g_variant_is_of_type(opts[i]->def, G_VARIANT_TYPE_STRING)) {
			gvar = g_variant_new_string(s);
			g_hash_table_insert(hash, g_strdup(opts[i]->id),
					g_variant_ref_sink(gvar));
		} else if (g_variant_is_of_type(opts[i]->def, G_VARIANT_TYPE_BOOLEAN)) {
			b = TRUE;
			if (0 == strcmp(s, "false") || 0 == strcmp(s, "no")) {
				b = FALSE;
			} else if (!(0 == strcmp(s, "true") || 0 == strcmp(s, "yes"))) {
				g_critical("Unable to convert '%s' to boolean!", s);
			}

			gvar = g_variant_new_boolean(b);
			g_hash_table_insert(hash, g_strdup(opts[i]->id),
					g_variant_ref_sink(gvar));
		} else {
			g_critical("Don't know GVariant type for option '%s'!", opts[i]->id);
		 }
	}

	return hash;
}

static char *strcanon(const char *str)
{
	int p0, p1;
	char *s;

	/* Returns newly allocated string. */
	s = g_ascii_strdown(str, -1);
	for (p0 = p1 = 0; str[p0]; p0++) {
		if ((s[p0] >= 'a' && s[p0] <= 'z')
				|| (s[p0] >= '0' && s[p0] <= '9'))
			s[p1++] = s[p0];
	}
	s[p1] = '\0';

	return s;
}

int canon_cmp(const char *str1, const char *str2)
{
	int ret;
	char *s1, *s2;

	s1 = strcanon(str1);
	s2 = strcanon(str2);
	ret = g_ascii_strcasecmp(s1, s2);
	g_free(s2);
	g_free(s1);

	return ret;
}

/* Convert driver options hash to GSList of struct sr_config. */
static GSList *hash_to_hwopt(GHashTable *hash)
{
	struct sr_config *src;
	GList *gl, *keys;
	GSList *opts;
	char *key;

	keys = g_hash_table_get_keys(hash);
	opts = NULL;
	for (gl = keys; gl; gl = gl->next) {
		key = gl->data;
		src = g_malloc(sizeof(struct sr_config));
		if (opt_to_gvar(key, g_hash_table_lookup(hash, key), src) != 0)
			return NULL;
		opts = g_slist_append(opts, src);
	}
	g_list_free(keys);

	return opts;
}

int parse_driver(char *arg, struct sr_dev_driver **driver, GSList **drvopts)
{
	struct sr_dev_driver **drivers;
	GHashTable *drvargs;
	int i;
	char *drvname;

	if (!arg)
		return FALSE;

	drvargs = parse_generic_arg(arg, TRUE, NULL);

	drvname = g_strdup(g_hash_table_lookup(drvargs, "sigrok_key"));
	g_hash_table_remove(drvargs, "sigrok_key");
	*driver = NULL;
	drivers = sr_driver_list(sr_ctx);
	for (i = 0; drivers[i]; i++) {
		if (strcmp(drivers[i]->name, drvname))
			continue;
		*driver = drivers[i];
	}
	if (!*driver) {
		g_critical("Driver %s not found.", drvname);
		g_hash_table_destroy(drvargs);
		g_free(drvname);
		return FALSE;
	}
	g_free(drvname);
	if (sr_driver_init(sr_ctx, *driver) != SR_OK) {
		g_critical("Failed to initialize driver.");
		g_hash_table_destroy(drvargs);
		return FALSE;
	}

	if (drvopts) {
		*drvopts = NULL;
		if (g_hash_table_size(drvargs) > 0) {
			if (!(*drvopts = hash_to_hwopt(drvargs))) {
				/* Unknown options, already logged. */
				g_hash_table_destroy(drvargs);
				return FALSE;
			}
		}
	}

	g_hash_table_destroy(drvargs);

	return TRUE;
}
Commit	Line	Data
43e5747a	1	/*
630293b4	2	* This file is part of the sigrok-cli project.
43e5747a UH	3	*
	4	* Copyright (C) 2011 Bert Vermeulen <bert@biot.com>
	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 3 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
d486cbdd	20	#include <config.h>
43e5747a UH	21	#include <stdio.h>
	22	#include <stdlib.h>
	23	#include <stdint.h>
	24	#include <string.h>
	25	#include <glib.h>
662a1e27	26	#include "sigrok-cli.h"
43e5747a	27
029d73fe	28	struct sr_channel find_channel(GSList channellist, const char *channelname)
43e5747a	29	{
029d73fe	30	struct sr_channel *ch;
497f5362	31	GSList *l;
43e5747a	32
029d73fe UH	33	ch = NULL;
	34	for (l = channellist; l; l = l->next) {
	35	ch = l->data;
	36	if (!strcmp(ch->name, channelname))
497f5362	37	break;
c2c4a0de	38	}
029d73fe	39	ch = l ? l->data : NULL;
497f5362	40
029d73fe	41	return ch;
497f5362 BV	42	}
497f5362 BV	43
029d73fe	44	GSList parse_channelstring(struct sr_dev_inst sdi, const char *channelstring)
497f5362	45	{
029d73fe	46	struct sr_channel *ch;
c6fa2b2e	47	GSList channellist, channels;
497f5362 BV	48	int ret, n, b, e, i;
497f5362 BV	49	char tokens, range, *names, eptr, str[8];
43e5747a	50
c6fa2b2e UH	51	channels = sr_dev_inst_channels_get(sdi);
c6fa2b2e UH	52
029d73fe UH	53	if (!channelstring \|\| !channelstring[0])
029d73fe UH	54	/* Use all channels by default. */
c6fa2b2e	55	return g_slist_copy(channels);
497f5362 BV	56
	57	ret = SR_OK;
	58	range = NULL;
66149c20	59	names = NULL;
029d73fe UH	60	channellist = NULL;
029d73fe UH	61	tokens = g_strsplit(channelstring, ",", 0);
43e5747a	62	for (i = 0; tokens[i]; i++) {
497f5362	63	if (tokens[i][0] == '\0') {
029d73fe	64	g_critical("Invalid empty channel.");
497f5362 BV	65	ret = SR_ERR;
	66	break;
	67	}
43e5747a	68	if (strchr(tokens[i], '-')) {
f0f54487 UH	69	/*
f0f54487 UH	70	* A range of channels in the form a-b. This will only work
029d73fe UH	71	* if the channels are named as numbers -- so every channel
029d73fe UH	72	* in the range must exist as a channel name string in the
f0f54487 UH	73	* device.
f0f54487 UH	74	*/
43e5747a UH	75	range = g_strsplit(tokens[i], "-", 2);
	76	if (!range[0] \|\| !range[1] \|\| range[2]) {
	77	/* Need exactly two arguments. */
029d73fe	78	g_critical("Invalid channel syntax '%s'.", tokens[i]);
497f5362	79	ret = SR_ERR;
8ec20386	80	goto range_fail;
43e5747a UH	81	}
43e5747a UH	82
497f5362 BV	83	b = strtol(range[0], &eptr, 10);
497f5362 BV	84	if (eptr == range[0] \|\| *eptr != '\0') {
029d73fe	85	g_critical("Invalid channel '%s'.", range[0]);
497f5362	86	ret = SR_ERR;
8ec20386	87	goto range_fail;
497f5362	88	}
43e5747a	89	e = strtol(range[1], NULL, 10);
497f5362	90	if (eptr == range[1] \|\| *eptr != '\0') {
029d73fe	91	g_critical("Invalid channel '%s'.", range[1]);
497f5362	92	ret = SR_ERR;
8ec20386	93	goto range_fail;
497f5362 BV	94	}
497f5362 BV	95	if (b < 0 \|\| b >= e) {
029d73fe	96	g_critical("Invalid channel range '%s'.", tokens[i]);
497f5362	97	ret = SR_ERR;
8ec20386	98	goto range_fail;
43e5747a UH	99	}
	100
	101	while (b <= e) {
497f5362 BV	102	n = snprintf(str, 8, "%d", b);
497f5362 BV	103	if (n < 0 \|\| n > 8) {
029d73fe	104	g_critical("Invalid channel '%d'.", b);
497f5362 BV	105	ret = SR_ERR;
	106	break;
	107	}
c6fa2b2e	108	ch = find_channel(channels, str);
029d73fe UH	109	if (!ch) {
029d73fe UH	110	g_critical("unknown channel '%d'.", b);
497f5362 BV	111	ret = SR_ERR;
	112	break;
	113	}
029d73fe	114	channellist = g_slist_append(channellist, ch);
43e5747a UH	115	b++;
43e5747a UH	116	}
8ec20386 DJ	117	range_fail:
	118	if (range)
	119	g_strfreev(range);
	120
497f5362 BV	121	if (ret != SR_OK)
497f5362 BV	122	break;
43e5747a	123	} else {
497f5362 BV	124	names = g_strsplit(tokens[i], "=", 2);
	125	if (!names[0] \|\| (names[1] && names[2])) {
	126	/* Need one or two arguments. */
029d73fe	127	g_critical("Invalid channel '%s'.", tokens[i]);
6df458b7	128	g_strfreev(names);
497f5362	129	ret = SR_ERR;
43e5747a UH	130	break;
	131	}
	132
c6fa2b2e	133	ch = find_channel(channels, names[0]);
029d73fe UH	134	if (!ch) {
029d73fe UH	135	g_critical("unknown channel '%s'.", names[0]);
6df458b7	136	g_strfreev(names);
497f5362 BV	137	ret = SR_ERR;
	138	break;
	139	}
	140	if (names[1]) {
029d73fe UH	141	/* Rename channel. */
	142	g_free(ch->name);
	143	ch->name = g_strdup(names[1]);
43e5747a	144	}
029d73fe	145	channellist = g_slist_append(channellist, ch);
8ec20386	146
6df458b7	147	g_strfreev(names);
43e5747a UH	148	}
43e5747a UH	149	}
66149c20	150
497f5362	151	if (ret != SR_OK) {
029d73fe UH	152	g_slist_free(channellist);
029d73fe UH	153	channellist = NULL;
43e5747a UH	154	}
	155
	156	g_strfreev(tokens);
43e5747a	157
029d73fe	158	return channellist;
43e5747a UH	159	}
43e5747a UH	160
6b27bde4 BV	161	int parse_trigger_match(char c)
	162	{
	163	int match;
	164
	165	if (c == '0')
	166	match = SR_TRIGGER_ZERO;
	167	else if (c == '1')
	168	match = SR_TRIGGER_ONE;
	169	else if (c == 'r')
	170	match = SR_TRIGGER_RISING;
	171	else if (c == 'f')
	172	match = SR_TRIGGER_FALLING;
	173	else if (c == 'e')
	174	match = SR_TRIGGER_EDGE;
	175	else if (c == 'o')
	176	match = SR_TRIGGER_OVER;
	177	else if (c == 'u')
	178	match = SR_TRIGGER_UNDER;
	179	else
	180	match = 0;
	181
	182	return match;
	183	}
	184
4bf77ec6 BV	185	int parse_triggerstring(const struct sr_dev_inst sdi, const char s,
4bf77ec6 BV	186	struct sr_trigger **trigger)
6b27bde4 BV	187	{
6b27bde4 BV	188	struct sr_channel *ch;
6b27bde4 BV	189	struct sr_trigger_stage *stage;
6b27bde4 BV	190	GVariant *gvar;
c6fa2b2e	191	GSList l, channels;
6b27bde4 BV	192	gsize num_matches;
	193	gboolean found_match, error;
	194	const int32_t *matches;
	195	int32_t match;
	196	unsigned int j;
	197	int t, i;
	198	char *tokens, sep;
c6fa2b2e UH	199	struct sr_dev_driver *driver;
	200
	201	driver = sr_dev_inst_driver_get(sdi);
	202	channels = sr_dev_inst_channels_get(sdi);
6b27bde4	203
24bd9719	204	if (maybe_config_list(driver, sdi, NULL, SR_CONF_TRIGGER_MATCH,
6b27bde4 BV	205	&gvar) != SR_OK) {
	206	g_critical("Device doesn't support any triggers.");
	207	return FALSE;
	208	}
	209	matches = g_variant_get_fixed_array(gvar, &num_matches, sizeof(int32_t));
	210
4bf77ec6	211	*trigger = sr_trigger_new(NULL);
6b27bde4 BV	212	error = FALSE;
	213	tokens = g_strsplit(s, ",", -1);
	214	for (i = 0; tokens[i]; i++) {
	215	if (!(sep = strchr(tokens[i], '='))) {
	216	g_critical("Invalid trigger '%s'.", tokens[i]);
	217	error = TRUE;
	218	break;
	219	}
	220	*sep++ = 0;
	221	ch = NULL;
c6fa2b2e	222	for (l = channels; l; l = l->next) {
6b27bde4 BV	223	ch = l->data;
	224	if (ch->enabled && !strcmp(ch->name, tokens[i]))
	225	break;
	226	ch = NULL;
	227	}
	228	if (!ch) {
	229	g_critical("Invalid channel '%s'.", tokens[i]);
	230	error = TRUE;
	231	break;
	232	}
	233	for (t = 0; sep[t]; t++) {
	234	if (!(match = parse_trigger_match(sep[t]))) {
	235	g_critical("Invalid trigger match '%c'.", sep[t]);
	236	error = TRUE;
	237	break;
	238	}
	239	found_match = FALSE;
	240	for (j = 0; j < num_matches; j++) {
	241	if (matches[j] == match) {
	242	found_match = TRUE;
	243	break;
	244	}
	245	}
	246	if (!found_match) {
	247	g_critical("Trigger match '%c' not supported by device.", sep[t]);
	248	error = TRUE;
	249	break;
	250	}
	251	/* Make sure this ends up in the right stage, creating
	252	* them as needed. */
4bf77ec6 BV	253	while (!(stage = g_slist_nth_data((*trigger)->stages, t)))
4bf77ec6 BV	254	sr_trigger_stage_add(*trigger);
6b27bde4 BV	255	if (sr_trigger_match_add(stage, ch, match, 0) != SR_OK) {
	256	error = TRUE;
	257	break;
	258	}
	259	}
	260	}
	261	g_strfreev(tokens);
	262	g_variant_unref(gvar);
	263
	264	if (error)
4bf77ec6	265	sr_trigger_free(*trigger);
6b27bde4 BV	266
	267	return !error;
	268	}
	269
cad0cba6 GS	270	/**
	271	* Create hash table from colon separated key-value pairs input text.
	272	*
	273	* Accepts input text as it was specified by users. Splits the colon
	274	* separated key-value pairs and creates a hash table from these items.
	275	* Optionally supports special forms which are useful for different CLI
	276	* features.
	277	*
	278	* Typical form: <key>=<val>[:<key>=<val>]*
	279	* Generic list of key-value pairs, all items being equal. Mere set.
	280	*
	281	* ID form: <id>[:<key>=<val>]*
	282	* First item is not a key-value pair, instead it's an identifier. Used
	283	* to specify a protocol decoder, or a device driver, or an input/output
	284	* file format, optionally followed by more parameters' values. The ID
	285	* part of the input spec is not optional.
	286	*
	287	* Optional ID: [<sel>=<id>][:<key>=<val>]*
	288	* All items are key-value pairs. The first item _may_ be an identifier,
	289	* if its key matches a caller specified key name. Otherwise the input
	290	* text is the above typical form, a mere list of key-value pairs while
	291	* none of them is special.
	292	*
	293	* @param[in] arg Input text.
	294	* @param[in] sep_first Boolean, whether ID form is required.
	295	* @param[in] key_first Keyword name if optional ID is applicable.
	296	*
	297	* @returns A hash table which contains the key/value pairs, or #NULL
	298	* when the input is invalid.
	299	*/
	300	GHashTable parse_generic_arg(const char arg,
	301	gboolean sep_first, const char *key_first)
43e5747a UH	302	{
	303	GHashTable *hash;
	304	int i;
	305	char *elements, e;
cad0cba6 GS	306	int l;
cad0cba6 GS	307	const char *s;
43e5747a UH	308
	309	if (!arg \|\| !arg[0])
	310	return NULL;
	311
63bb454c BV	312	i = 0;
	313	hash = g_hash_table_new_full(g_str_hash, g_str_equal,
	314	g_free, g_free);
43e5747a	315	elements = g_strsplit(arg, ":", 0);
cad0cba6 GS	316	if (sep_first) {
	317	/*
	318	* Caller requested "<id>[:<key>=<val>]*" case, Consume the
	319	* first item, before processing more key-value pairs below.
	320	*/
63bb454c BV	321	g_hash_table_insert(hash, g_strdup("sigrok_key"),
63bb454c BV	322	g_strdup(elements[i++]));
cad0cba6 GS	323	} else if (key_first && *key_first) {
	324	/*
	325	* Caller requested "[<sig>=<id>][:<key>=<val>]*" case.
	326	* Optional special handling of the first item, but only
	327	* consume this first item here when its keyword matched
	328	* the caller's specification.
	329	*/
	330	l = strlen(key_first);
	331	s = elements[i];
	332	e = strchr(s, '=');
	333	if (e && e - s == l && g_str_has_prefix(s, key_first)) {
	334	g_hash_table_insert(hash,
	335	g_strdup("sigrok_key"), g_strdup(++e));
	336	i++;
	337	}
	338	}
63bb454c	339	for (; elements[i]; i++) {
43e5747a UH	340	e = strchr(elements[i], '=');
	341	if (!e)
	342	g_hash_table_insert(hash, g_strdup(elements[i]), NULL);
	343	else {
	344	*e++ = '\0';
	345	g_hash_table_insert(hash, g_strdup(elements[i]), g_strdup(e));
	346	}
	347	}
	348	g_strfreev(elements);
	349
	350	return hash;
	351	}
	352
cfad6a30 GS	353	GSList check_unknown_keys(const struct sr_option avail, GHashTable used)
	354	{
	355	GSList *unknown;
	356	GHashTableIter iter;
	357	void *key;
	358	const char *used_id;
	359	size_t avail_idx;
	360	const char avail_id, found_id;
	361
	362	/* Collect a list of used but not available keywords. */
	363	unknown = NULL;
	364	g_hash_table_iter_init(&iter, used);
	365	while (g_hash_table_iter_next(&iter, &key, NULL)) {
	366	used_id = key;
	367	found_id = NULL;
	368	for (avail_idx = 0; avail[avail_idx] && avail[avail_idx]->id; avail_idx++) {
	369	avail_id = avail[avail_idx]->id;
	370	if (strcmp(avail_id, used_id) == 0) {
	371	found_id = avail_id;
	372	break;
	373	}
	374	}
	375	if (!found_id)
	376	unknown = g_slist_append(unknown, g_strdup(used_id));
	377	}
	378
	379	/* Return the list of unknown keywords, or NULL if empty. */
	380	return unknown;
	381	}
	382
	383	gboolean warn_unknown_keys(const struct sr_option *avail, GHashTable used,
	384	const char *caption)
	385	{
	386	GSList unknown, l;
	387	gboolean had_unknown;
	388	const char *s;
	389
	390	if (!caption \|\| !*caption)
	391	caption = "Unknown keyword";
	392
	393	unknown = check_unknown_keys(avail, used);
	394	had_unknown = unknown != NULL;
	395	for (l = unknown; l; l = l->next) {
	396	s = l->data;
	397	g_warning("%s: %s.", caption, s);
	398	}
	399	g_slist_free_full(unknown, g_free);
	400
	401	return had_unknown;
	402	}
	403
87e24fed BV	404	GHashTable generic_arg_to_opt(const struct sr_option opts, GHashTable genargs)
	405	{
	406	GHashTable *hash;
	407	GVariant *gvar;
	408	int i;
	409	char *s;
41ef1ae4	410	gboolean b;
87e24fed BV	411
	412	hash = g_hash_table_new_full(g_str_hash, g_str_equal, g_free,
	413	(GDestroyNotify)g_variant_unref);
	414	for (i = 0; opts[i]; i++) {
	415	if (!(s = g_hash_table_lookup(genargs, opts[i]->id)))
	416	continue;
	417	if (g_variant_is_of_type(opts[i]->def, G_VARIANT_TYPE_UINT32)) {
	418	gvar = g_variant_new_uint32(strtoul(s, NULL, 10));
	419	g_hash_table_insert(hash, g_strdup(opts[i]->id),
	420	g_variant_ref_sink(gvar));
	421	} else if (g_variant_is_of_type(opts[i]->def, G_VARIANT_TYPE_INT32)) {
	422	gvar = g_variant_new_int32(strtoul(s, NULL, 10));
	423	g_hash_table_insert(hash, g_strdup(opts[i]->id),
	424	g_variant_ref_sink(gvar));
902e368e BV	425	} else if (g_variant_is_of_type(opts[i]->def, G_VARIANT_TYPE_UINT64)) {
	426	gvar = g_variant_new_uint64(strtoul(s, NULL, 10));
	427	g_hash_table_insert(hash, g_strdup(opts[i]->id),
	428	g_variant_ref_sink(gvar));
87e24fed BV	429	} else if (g_variant_is_of_type(opts[i]->def, G_VARIANT_TYPE_DOUBLE)) {
	430	gvar = g_variant_new_double(strtod(s, NULL));
	431	g_hash_table_insert(hash, g_strdup(opts[i]->id),
	432	g_variant_ref_sink(gvar));
	433	} else if (g_variant_is_of_type(opts[i]->def, G_VARIANT_TYPE_STRING)) {
	434	gvar = g_variant_new_string(s);
	435	g_hash_table_insert(hash, g_strdup(opts[i]->id),
	436	g_variant_ref_sink(gvar));
41ef1ae4 JS	437	} else if (g_variant_is_of_type(opts[i]->def, G_VARIANT_TYPE_BOOLEAN)) {
	438	b = TRUE;
	439	if (0 == strcmp(s, "false") \|\| 0 == strcmp(s, "no")) {
	440	b = FALSE;
	441	} else if (!(0 == strcmp(s, "true") \|\| 0 == strcmp(s, "yes"))) {
	442	g_critical("Unable to convert '%s' to boolean!", s);
	443	}
	444
	445	gvar = g_variant_new_boolean(b);
	446	g_hash_table_insert(hash, g_strdup(opts[i]->id),
	447	g_variant_ref_sink(gvar));
87e24fed BV	448	} else {
	449	g_critical("Don't know GVariant type for option '%s'!", opts[i]->id);
	450	}
	451	}
	452
	453	return hash;
	454	}
	455
2be182e6	456	static char strcanon(const char str)
432de709 BV	457	{
	458	int p0, p1;
	459	char *s;
	460
	461	/* Returns newly allocated string. */
	462	s = g_ascii_strdown(str, -1);
	463	for (p0 = p1 = 0; str[p0]; p0++) {
	464	if ((s[p0] >= 'a' && s[p0] <= 'z')
	465	\|\| (s[p0] >= '0' && s[p0] <= '9'))
	466	s[p1++] = s[p0];
	467	}
	468	s[p1] = '\0';
	469
	470	return s;
	471	}
	472
d2ee5eea	473	int canon_cmp(const char str1, const char str2)
432de709 BV	474	{
	475	int ret;
	476	char s1, s2;
	477
	478	s1 = strcanon(str1);
	479	s2 = strcanon(str2);
	480	ret = g_ascii_strcasecmp(s1, s2);
	481	g_free(s2);
	482	g_free(s1);
	483
	484	return ret;
	485	}
d75c8529 BV	486
	487	/* Convert driver options hash to GSList of struct sr_config. */
	488	static GSList hash_to_hwopt(GHashTable hash)
	489	{
	490	struct sr_config *src;
	491	GList gl, keys;
	492	GSList *opts;
	493	char *key;
	494
	495	keys = g_hash_table_get_keys(hash);
	496	opts = NULL;
	497	for (gl = keys; gl; gl = gl->next) {
	498	key = gl->data;
	499	src = g_malloc(sizeof(struct sr_config));
	500	if (opt_to_gvar(key, g_hash_table_lookup(hash, key), src) != 0)
	501	return NULL;
	502	opts = g_slist_append(opts, src);
	503	}
	504	g_list_free(keys);
	505
	506	return opts;
	507	}
	508
	509	int parse_driver(char arg, struct sr_dev_driver driver, GSList *drvopts)
	510	{
	511	struct sr_dev_driver **drivers;
	512	GHashTable *drvargs;
	513	int i;
	514	char *drvname;
	515
bc5b66d7 JS	516	if (!arg)
	517	return FALSE;
	518
cad0cba6	519	drvargs = parse_generic_arg(arg, TRUE, NULL);
d75c8529 BV	520
	521	drvname = g_strdup(g_hash_table_lookup(drvargs, "sigrok_key"));
	522	g_hash_table_remove(drvargs, "sigrok_key");
	523	*driver = NULL;
59e421bb	524	drivers = sr_driver_list(sr_ctx);
d75c8529 BV	525	for (i = 0; drivers[i]; i++) {
	526	if (strcmp(drivers[i]->name, drvname))
	527	continue;
	528	*driver = drivers[i];
	529	}
	530	if (!*driver) {
	531	g_critical("Driver %s not found.", drvname);
	532	g_hash_table_destroy(drvargs);
	533	g_free(drvname);
	534	return FALSE;
	535	}
	536	g_free(drvname);
	537	if (sr_driver_init(sr_ctx, *driver) != SR_OK) {
	538	g_critical("Failed to initialize driver.");
	539	g_hash_table_destroy(drvargs);
	540	return FALSE;
	541	}
	542
	543	if (drvopts) {
	544	*drvopts = NULL;
	545	if (g_hash_table_size(drvargs) > 0) {
	546	if (!(*drvopts = hash_to_hwopt(drvargs))) {
	547	/* Unknown options, already logged. */
	548	g_hash_table_destroy(drvargs);
	549	return FALSE;
	550	}
	551	}
	552	}
	553
	554	g_hash_table_destroy(drvargs);
	555
	556	return TRUE;
	557	}