[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. */
				sr_dev_channel_name_set(ch, 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;
}

/**
 * Split an input text into a key and value respectively ('=' separator).
 *
 * @param[in] text Writeable copy of the input text, gets modified.
 * @param[out] key Position of the keyword.
 * @param[out] val Position of the value.
 *
 * TODO In theory the returned key/value locations could be const pointers.
 * Which even would be preferrable. Unfortunately most call sites deal with
 * glib hashes, and their insert API seriously lacks the const attribute.
 * So we drop it here as well to avoid clutter at callers'.
 */
static void split_key_value(char *text, char **key, char **val)
{
	char *k, *v;
	char *pos;

	if (key)
		*key = NULL;
	if (val)
		*val = NULL;
	if (!text || !*text)
		return;

	k = text;
	v = NULL;
	pos = strchr(k, '=');
	if (pos) {
		*pos = '\0';
		v = ++pos;
	}
	if (key)
		*key = k;
	if (val)
		*val = v;
}

/**
 * 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;
	char **elements;
	int i;
	char *k, *v;

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

	hash = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, g_free);
	elements = g_strsplit(arg, ":", 0);
	i = 0;
	if (sep_first) {
		k = g_strdup("sigrok_key");
		v = g_strdup(elements[i++]);
		g_hash_table_insert(hash, k, v);
	} else if (key_first) {
		split_key_value(elements[i], &k, &v);
		if (g_ascii_strcasecmp(k, key_first) == 0) {
			k = "sigrok_key";
		}
		k = g_strdup(k);
		v = g_strdup(v);
		g_hash_table_insert(hash, k, v);
		i++;
	}
	for (; elements[i]; i++) {
		if (!elements[i][0])
			continue;
		split_key_value(elements[i], &k, &v);
		k = g_strdup(k);
		v = v ? g_strdup(v) : NULL;
		g_hash_table_insert(hash, k, v);
	}
	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(strtol(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(strtoull(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	141	/* Rename channel. */
99595de1	142	sr_dev_channel_name_set(ch, names[1]);
43e5747a	143	}
029d73fe	144	channellist = g_slist_append(channellist, ch);
8ec20386	145
6df458b7	146	g_strfreev(names);
43e5747a UH	147	}
43e5747a UH	148	}
66149c20	149
497f5362	150	if (ret != SR_OK) {
029d73fe UH	151	g_slist_free(channellist);
029d73fe UH	152	channellist = NULL;
43e5747a UH	153	}
	154
	155	g_strfreev(tokens);
43e5747a	156
029d73fe	157	return channellist;
43e5747a UH	158	}
43e5747a UH	159
6b27bde4 BV	160	int parse_trigger_match(char c)
	161	{
	162	int match;
	163
	164	if (c == '0')
	165	match = SR_TRIGGER_ZERO;
	166	else if (c == '1')
	167	match = SR_TRIGGER_ONE;
	168	else if (c == 'r')
	169	match = SR_TRIGGER_RISING;
	170	else if (c == 'f')
	171	match = SR_TRIGGER_FALLING;
	172	else if (c == 'e')
	173	match = SR_TRIGGER_EDGE;
	174	else if (c == 'o')
	175	match = SR_TRIGGER_OVER;
	176	else if (c == 'u')
	177	match = SR_TRIGGER_UNDER;
	178	else
	179	match = 0;
	180
	181	return match;
	182	}
	183
4bf77ec6 BV	184	int parse_triggerstring(const struct sr_dev_inst sdi, const char s,
4bf77ec6 BV	185	struct sr_trigger **trigger)
6b27bde4 BV	186	{
6b27bde4 BV	187	struct sr_channel *ch;
6b27bde4 BV	188	struct sr_trigger_stage *stage;
6b27bde4 BV	189	GVariant *gvar;
c6fa2b2e	190	GSList l, channels;
6b27bde4 BV	191	gsize num_matches;
	192	gboolean found_match, error;
	193	const int32_t *matches;
	194	int32_t match;
	195	unsigned int j;
	196	int t, i;
	197	char *tokens, sep;
c6fa2b2e UH	198	struct sr_dev_driver *driver;
	199
	200	driver = sr_dev_inst_driver_get(sdi);
	201	channels = sr_dev_inst_channels_get(sdi);
6b27bde4	202
24bd9719	203	if (maybe_config_list(driver, sdi, NULL, SR_CONF_TRIGGER_MATCH,
6b27bde4 BV	204	&gvar) != SR_OK) {
	205	g_critical("Device doesn't support any triggers.");
	206	return FALSE;
	207	}
	208	matches = g_variant_get_fixed_array(gvar, &num_matches, sizeof(int32_t));
	209
4bf77ec6	210	*trigger = sr_trigger_new(NULL);
6b27bde4 BV	211	error = FALSE;
	212	tokens = g_strsplit(s, ",", -1);
	213	for (i = 0; tokens[i]; i++) {
	214	if (!(sep = strchr(tokens[i], '='))) {
	215	g_critical("Invalid trigger '%s'.", tokens[i]);
	216	error = TRUE;
	217	break;
	218	}
	219	*sep++ = 0;
	220	ch = NULL;
c6fa2b2e	221	for (l = channels; l; l = l->next) {
6b27bde4 BV	222	ch = l->data;
	223	if (ch->enabled && !strcmp(ch->name, tokens[i]))
	224	break;
	225	ch = NULL;
	226	}
	227	if (!ch) {
	228	g_critical("Invalid channel '%s'.", tokens[i]);
	229	error = TRUE;
	230	break;
	231	}
	232	for (t = 0; sep[t]; t++) {
	233	if (!(match = parse_trigger_match(sep[t]))) {
	234	g_critical("Invalid trigger match '%c'.", sep[t]);
	235	error = TRUE;
	236	break;
	237	}
	238	found_match = FALSE;
	239	for (j = 0; j < num_matches; j++) {
	240	if (matches[j] == match) {
	241	found_match = TRUE;
	242	break;
	243	}
	244	}
	245	if (!found_match) {
	246	g_critical("Trigger match '%c' not supported by device.", sep[t]);
	247	error = TRUE;
	248	break;
	249	}
	250	/* Make sure this ends up in the right stage, creating
	251	* them as needed. */
4bf77ec6 BV	252	while (!(stage = g_slist_nth_data((*trigger)->stages, t)))
4bf77ec6 BV	253	sr_trigger_stage_add(*trigger);
6b27bde4 BV	254	if (sr_trigger_match_add(stage, ch, match, 0) != SR_OK) {
	255	error = TRUE;
	256	break;
	257	}
	258	}
	259	}
	260	g_strfreev(tokens);
	261	g_variant_unref(gvar);
	262
	263	if (error)
4bf77ec6	264	sr_trigger_free(*trigger);
6b27bde4 BV	265
	266	return !error;
	267	}
	268
c9c30f53 GS	269	/**
	270	* Split an input text into a key and value respectively ('=' separator).
	271	*
	272	* @param[in] text Writeable copy of the input text, gets modified.
	273	* @param[out] key Position of the keyword.
	274	* @param[out] val Position of the value.
	275	*
	276	* TODO In theory the returned key/value locations could be const pointers.
	277	* Which even would be preferrable. Unfortunately most call sites deal with
	278	* glib hashes, and their insert API seriously lacks the const attribute.
	279	* So we drop it here as well to avoid clutter at callers'.
	280	*/
	281	static void split_key_value(char text, char key, char *val)
	282	{
	283	char k, v;
	284	char *pos;
	285
	286	if (key)
	287	*key = NULL;
	288	if (val)
	289	*val = NULL;
	290	if (!text \|\| !*text)
	291	return;
	292
	293	k = text;
	294	v = NULL;
	295	pos = strchr(k, '=');
	296	if (pos) {
	297	*pos = '\0';
	298	v = ++pos;
	299	}
	300	if (key)
	301	*key = k;
	302	if (val)
	303	*val = v;
	304	}
	305
cad0cba6 GS	306	/**
	307	* Create hash table from colon separated key-value pairs input text.
	308	*
	309	* Accepts input text as it was specified by users. Splits the colon
	310	* separated key-value pairs and creates a hash table from these items.
	311	* Optionally supports special forms which are useful for different CLI
	312	* features.
	313	*
	314	* Typical form: <key>=<val>[:<key>=<val>]*
	315	* Generic list of key-value pairs, all items being equal. Mere set.
	316	*
	317	* ID form: <id>[:<key>=<val>]*
	318	* First item is not a key-value pair, instead it's an identifier. Used
	319	* to specify a protocol decoder, or a device driver, or an input/output
	320	* file format, optionally followed by more parameters' values. The ID
	321	* part of the input spec is not optional.
	322	*
	323	* Optional ID: [<sel>=<id>][:<key>=<val>]*
	324	* All items are key-value pairs. The first item _may_ be an identifier,
	325	* if its key matches a caller specified key name. Otherwise the input
	326	* text is the above typical form, a mere list of key-value pairs while
	327	* none of them is special.
	328	*
	329	* @param[in] arg Input text.
	330	* @param[in] sep_first Boolean, whether ID form is required.
	331	* @param[in] key_first Keyword name if optional ID is applicable.
	332	*
	333	* @returns A hash table which contains the key/value pairs, or #NULL
	334	* when the input is invalid.
	335	*/
	336	GHashTable parse_generic_arg(const char arg,
	337	gboolean sep_first, const char *key_first)
43e5747a UH	338	{
43e5747a UH	339	GHashTable *hash;
c9c30f53	340	char **elements;
43e5747a	341	int i;
c9c30f53	342	char k, v;
43e5747a UH	343
	344	if (!arg \|\| !arg[0])
	345	return NULL;
c9c30f53 GS	346	if (key_first && !key_first[0])
c9c30f53 GS	347	key_first = NULL;
43e5747a	348
c9c30f53	349	hash = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, g_free);
43e5747a	350	elements = g_strsplit(arg, ":", 0);
c9c30f53	351	i = 0;
cad0cba6	352	if (sep_first) {
c9c30f53 GS	353	k = g_strdup("sigrok_key");
	354	v = g_strdup(elements[i++]);
	355	g_hash_table_insert(hash, k, v);
	356	} else if (key_first) {
	357	split_key_value(elements[i], &k, &v);
	358	if (g_ascii_strcasecmp(k, key_first) == 0) {
	359	k = "sigrok_key";
cad0cba6	360	}
c9c30f53 GS	361	k = g_strdup(k);
	362	v = g_strdup(v);
	363	g_hash_table_insert(hash, k, v);
	364	i++;
cad0cba6	365	}
63bb454c	366	for (; elements[i]; i++) {
af9fa8c5 GS	367	if (!elements[i][0])
af9fa8c5 GS	368	continue;
c9c30f53 GS	369	split_key_value(elements[i], &k, &v);
	370	k = g_strdup(k);
	371	v = v ? g_strdup(v) : NULL;
	372	g_hash_table_insert(hash, k, v);
43e5747a UH	373	}
	374	g_strfreev(elements);
	375
	376	return hash;
	377	}
	378
cfad6a30 GS	379	GSList check_unknown_keys(const struct sr_option avail, GHashTable used)
	380	{
	381	GSList *unknown;
	382	GHashTableIter iter;
	383	void *key;
	384	const char *used_id;
	385	size_t avail_idx;
	386	const char avail_id, found_id;
	387
	388	/* Collect a list of used but not available keywords. */
	389	unknown = NULL;
	390	g_hash_table_iter_init(&iter, used);
	391	while (g_hash_table_iter_next(&iter, &key, NULL)) {
	392	used_id = key;
	393	found_id = NULL;
	394	for (avail_idx = 0; avail[avail_idx] && avail[avail_idx]->id; avail_idx++) {
	395	avail_id = avail[avail_idx]->id;
	396	if (strcmp(avail_id, used_id) == 0) {
	397	found_id = avail_id;
	398	break;
	399	}
	400	}
	401	if (!found_id)
	402	unknown = g_slist_append(unknown, g_strdup(used_id));
	403	}
	404
	405	/* Return the list of unknown keywords, or NULL if empty. */
	406	return unknown;
	407	}
	408
	409	gboolean warn_unknown_keys(const struct sr_option *avail, GHashTable used,
	410	const char *caption)
	411	{
	412	GSList unknown, l;
	413	gboolean had_unknown;
	414	const char *s;
	415
	416	if (!caption \|\| !*caption)
	417	caption = "Unknown keyword";
	418
	419	unknown = check_unknown_keys(avail, used);
	420	had_unknown = unknown != NULL;
	421	for (l = unknown; l; l = l->next) {
	422	s = l->data;
	423	g_warning("%s: %s.", caption, s);
	424	}
	425	g_slist_free_full(unknown, g_free);
	426
	427	return had_unknown;
	428	}
	429
87e24fed BV	430	GHashTable generic_arg_to_opt(const struct sr_option opts, GHashTable genargs)
	431	{
	432	GHashTable *hash;
	433	GVariant *gvar;
	434	int i;
	435	char *s;
41ef1ae4	436	gboolean b;
87e24fed BV	437
	438	hash = g_hash_table_new_full(g_str_hash, g_str_equal, g_free,
	439	(GDestroyNotify)g_variant_unref);
	440	for (i = 0; opts[i]; i++) {
	441	if (!(s = g_hash_table_lookup(genargs, opts[i]->id)))
	442	continue;
	443	if (g_variant_is_of_type(opts[i]->def, G_VARIANT_TYPE_UINT32)) {
	444	gvar = g_variant_new_uint32(strtoul(s, NULL, 10));
	445	g_hash_table_insert(hash, g_strdup(opts[i]->id),
	446	g_variant_ref_sink(gvar));
	447	} else if (g_variant_is_of_type(opts[i]->def, G_VARIANT_TYPE_INT32)) {
e8e8b5e1	448	gvar = g_variant_new_int32(strtol(s, NULL, 10));
87e24fed BV	449	g_hash_table_insert(hash, g_strdup(opts[i]->id),
87e24fed BV	450	g_variant_ref_sink(gvar));
902e368e	451	} else if (g_variant_is_of_type(opts[i]->def, G_VARIANT_TYPE_UINT64)) {
e8e8b5e1	452	gvar = g_variant_new_uint64(strtoull(s, NULL, 10));
902e368e BV	453	g_hash_table_insert(hash, g_strdup(opts[i]->id),
902e368e BV	454	g_variant_ref_sink(gvar));
87e24fed BV	455	} else if (g_variant_is_of_type(opts[i]->def, G_VARIANT_TYPE_DOUBLE)) {
	456	gvar = g_variant_new_double(strtod(s, NULL));
	457	g_hash_table_insert(hash, g_strdup(opts[i]->id),
	458	g_variant_ref_sink(gvar));
	459	} else if (g_variant_is_of_type(opts[i]->def, G_VARIANT_TYPE_STRING)) {
	460	gvar = g_variant_new_string(s);
	461	g_hash_table_insert(hash, g_strdup(opts[i]->id),
	462	g_variant_ref_sink(gvar));
41ef1ae4 JS	463	} else if (g_variant_is_of_type(opts[i]->def, G_VARIANT_TYPE_BOOLEAN)) {
	464	b = TRUE;
	465	if (0 == strcmp(s, "false") \|\| 0 == strcmp(s, "no")) {
	466	b = FALSE;
	467	} else if (!(0 == strcmp(s, "true") \|\| 0 == strcmp(s, "yes"))) {
	468	g_critical("Unable to convert '%s' to boolean!", s);
	469	}
	470
	471	gvar = g_variant_new_boolean(b);
	472	g_hash_table_insert(hash, g_strdup(opts[i]->id),
	473	g_variant_ref_sink(gvar));
87e24fed BV	474	} else {
	475	g_critical("Don't know GVariant type for option '%s'!", opts[i]->id);
	476	}
	477	}
	478
	479	return hash;
	480	}
	481
2be182e6	482	static char strcanon(const char str)
432de709 BV	483	{
	484	int p0, p1;
	485	char *s;
	486
	487	/* Returns newly allocated string. */
	488	s = g_ascii_strdown(str, -1);
	489	for (p0 = p1 = 0; str[p0]; p0++) {
	490	if ((s[p0] >= 'a' && s[p0] <= 'z')
	491	\|\| (s[p0] >= '0' && s[p0] <= '9'))
	492	s[p1++] = s[p0];
	493	}
	494	s[p1] = '\0';
	495
	496	return s;
	497	}
	498
d2ee5eea	499	int canon_cmp(const char str1, const char str2)
432de709 BV	500	{
	501	int ret;
	502	char s1, s2;
	503
	504	s1 = strcanon(str1);
	505	s2 = strcanon(str2);
	506	ret = g_ascii_strcasecmp(s1, s2);
	507	g_free(s2);
	508	g_free(s1);
	509
	510	return ret;
	511	}
d75c8529 BV	512
	513	/* Convert driver options hash to GSList of struct sr_config. */
	514	static GSList hash_to_hwopt(GHashTable hash)
	515	{
	516	struct sr_config *src;
	517	GList gl, keys;
	518	GSList *opts;
	519	char *key;
	520
	521	keys = g_hash_table_get_keys(hash);
	522	opts = NULL;
	523	for (gl = keys; gl; gl = gl->next) {
	524	key = gl->data;
	525	src = g_malloc(sizeof(struct sr_config));
	526	if (opt_to_gvar(key, g_hash_table_lookup(hash, key), src) != 0)
	527	return NULL;
	528	opts = g_slist_append(opts, src);
	529	}
	530	g_list_free(keys);
	531
	532	return opts;
	533	}
	534
	535	int parse_driver(char arg, struct sr_dev_driver driver, GSList *drvopts)
	536	{
	537	struct sr_dev_driver **drivers;
	538	GHashTable *drvargs;
	539	int i;
	540	char *drvname;
	541
bc5b66d7 JS	542	if (!arg)
	543	return FALSE;
	544
cad0cba6	545	drvargs = parse_generic_arg(arg, TRUE, NULL);
d75c8529 BV	546
	547	drvname = g_strdup(g_hash_table_lookup(drvargs, "sigrok_key"));
	548	g_hash_table_remove(drvargs, "sigrok_key");
	549	*driver = NULL;
59e421bb	550	drivers = sr_driver_list(sr_ctx);
d75c8529 BV	551	for (i = 0; drivers[i]; i++) {
	552	if (strcmp(drivers[i]->name, drvname))
	553	continue;
	554	*driver = drivers[i];
	555	}
	556	if (!*driver) {
	557	g_critical("Driver %s not found.", drvname);
	558	g_hash_table_destroy(drvargs);
	559	g_free(drvname);
	560	return FALSE;
	561	}
	562	g_free(drvname);
	563	if (sr_driver_init(sr_ctx, *driver) != SR_OK) {
	564	g_critical("Failed to initialize driver.");
	565	g_hash_table_destroy(drvargs);
	566	return FALSE;
	567	}
	568
	569	if (drvopts) {
	570	*drvopts = NULL;
	571	if (g_hash_table_size(drvargs) > 0) {
	572	if (!(*drvopts = hash_to_hwopt(drvargs))) {
	573	/* Unknown options, already logged. */
	574	g_hash_table_destroy(drvargs);
	575	return FALSE;
	576	}
	577	}
	578	}
	579
	580	g_hash_table_destroy(drvargs);
	581
	582	return TRUE;
	583	}