X-Git-Url: https://sigrok.org/gitweb/?p=sigrok-cli.git;a=blobdiff_plain;f=parsers.c;h=5ec655f78ad3dce8a05f01186a2a7ec61febb437;hp=8d654eec5f3804c1ce80958a006610e8ec7def0d;hb=refs%2Fheads%2Fsigrok-cli-0.7.x;hpb=41ef1ae49a4973e136ffb99849ad98aa570f9f99 diff --git a/parsers.c b/parsers.c index 8d654ee..d92218f 100644 --- a/parsers.c +++ b/parsers.c @@ -17,12 +17,13 @@ * along with this program. If not, see . */ -#include "sigrok-cli.h" +#include #include #include #include #include #include +#include "sigrok-cli.h" struct sr_channel *find_channel(GSList *channellist, const char *channelname) { @@ -43,13 +44,15 @@ struct sr_channel *find_channel(GSList *channellist, const char *channelname) GSList *parse_channelstring(struct sr_dev_inst *sdi, const char *channelstring) { struct sr_channel *ch; - GSList *channellist; + 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(sdi->channels); + return g_slist_copy(channels); ret = SR_OK; range = NULL; @@ -63,10 +66,12 @@ GSList *parse_channelstring(struct sr_dev_inst *sdi, const char *channelstring) break; } if (strchr(tokens[i], '-')) { - /* A range of channels in the form a-b. This will only work + /* + * 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. */ + * device. + */ range = g_strsplit(tokens[i], "-", 2); if (!range[0] || !range[1] || range[2]) { /* Need exactly two arguments. */ @@ -100,7 +105,7 @@ GSList *parse_channelstring(struct sr_dev_inst *sdi, const char *channelstring) ret = SR_ERR; break; } - ch = find_channel(sdi->channels, str); + ch = find_channel(channels, str); if (!ch) { g_critical("unknown channel '%d'.", b); ret = SR_ERR; @@ -125,7 +130,7 @@ range_fail: break; } - ch = find_channel(sdi->channels, names[0]); + ch = find_channel(channels, names[0]); if (!ch) { g_critical("unknown channel '%s'.", names[0]); g_strfreev(names); @@ -183,7 +188,7 @@ int parse_triggerstring(const struct sr_dev_inst *sdi, const char *s, struct sr_channel *ch; struct sr_trigger_stage *stage; GVariant *gvar; - GSList *l; + GSList *l, *channels; gsize num_matches; gboolean found_match, error; const int32_t *matches; @@ -191,8 +196,12 @@ int parse_triggerstring(const struct sr_dev_inst *sdi, const char *s, unsigned int j; int t, i; char **tokens, *sep; + struct sr_dev_driver *driver; - if (sr_config_list(sdi->driver, sdi, NULL, SR_CONF_TRIGGER_MATCH, + 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; @@ -210,7 +219,7 @@ int parse_triggerstring(const struct sr_dev_inst *sdi, const char *s, } *sep++ = 0; ch = NULL; - for (l = sdi->channels; l; l = l->next) { + for (l = channels; l; l = l->next) { ch = l->data; if (ch->enabled && !strcmp(ch->name, tokens[i])) break; @@ -258,36 +267,165 @@ int parse_triggerstring(const struct sr_dev_inst *sdi, const char *s, return !error; } -GHashTable *parse_generic_arg(const char *arg, gboolean sep_first) +/** + * 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: =[:=]* + * Generic list of key-value pairs, all items being equal. Mere set. + * + * ID form: [:=]* + * 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: [=][:=]* + * 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 **elements, *e; + char *k, *v; if (!arg || !arg[0]) return NULL; + if (key_first && !key_first[0]) + key_first = NULL; - i = 0; - hash = g_hash_table_new_full(g_str_hash, g_str_equal, - g_free, g_free); + hash = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, g_free); elements = g_strsplit(arg, ":", 0); - if (sep_first) - g_hash_table_insert(hash, g_strdup("sigrok_key"), - g_strdup(elements[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)); + 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++) { + 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; @@ -370,3 +508,75 @@ int canon_cmp(const char *str1, const char *str2) 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; +}