]> sigrok.org Git - sigrok-cli.git/blobdiff - parsers.c
doc: update sigrok-cli(1) for channel assignment to decoder inputs
[sigrok-cli.git] / parsers.c
index f0e2a7f8ebccb10073a44ecb8968e0a008336294..2aacefb089f184eeb18dfb8d5be8855dc5623811 100644 (file)
--- a/parsers.c
+++ b/parsers.c
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "sigrok-cli.h"
+#include <config.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <stdint.h>
 #include <string.h>
 #include <glib.h>
+#include "sigrok-cli.h"
 
-extern struct sr_context *sr_ctx;
-
-struct sr_channel *find_channel(GSList *channellist, const char *channelname)
+struct sr_channel *find_channel(GSList *channellist, const char *channelname,
+       gboolean exact_case)
 {
        struct sr_channel *ch;
        GSList *l;
@@ -34,8 +34,13 @@ struct sr_channel *find_channel(GSList *channellist, const char *channelname)
        ch = NULL;
        for (l = channellist; l; l = l->next) {
                ch = l->data;
-               if (!strcmp(ch->name, channelname))
-                       break;
+               if (exact_case) {
+                       if (strcmp(ch->name, channelname) == 0)
+                               break;
+               } else {
+                       if (g_ascii_strcasecmp(ch->name, channelname) == 0)
+                               break;
+               }
        }
        ch = l ? l->data : NULL;
 
@@ -106,7 +111,7 @@ GSList *parse_channelstring(struct sr_dev_inst *sdi, const char *channelstring)
                                        ret = SR_ERR;
                                        break;
                                }
-                               ch = find_channel(channels, str);
+                               ch = find_channel(channels, str, TRUE);
                                if (!ch) {
                                        g_critical("unknown channel '%d'.", b);
                                        ret = SR_ERR;
@@ -131,7 +136,7 @@ range_fail:
                                break;
                        }
 
-                       ch = find_channel(channels, names[0]);
+                       ch = find_channel(channels, names[0], TRUE);
                        if (!ch) {
                                g_critical("unknown channel '%s'.", names[0]);
                                g_strfreev(names);
@@ -140,8 +145,7 @@ range_fail:
                        }
                        if (names[1]) {
                                /* Rename channel. */
-                               g_free(ch->name);
-                               ch->name = g_strdup(names[1]);
+                               sr_dev_channel_name_set(ch, names[1]);
                        }
                        channellist = g_slist_append(channellist, ch);
 
@@ -268,36 +272,167 @@ 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: <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 **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++) {
+               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;
@@ -316,11 +451,11 @@ GHashTable *generic_arg_to_opt(const struct sr_option **opts, GHashTable *genarg
                        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));
+                       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(strtoul(s, NULL, 10));
+                       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)) {
@@ -410,12 +545,15 @@ int parse_driver(char *arg, struct sr_dev_driver **driver, GSList **drvopts)
        int i;
        char *drvname;
 
-       drvargs = parse_generic_arg(arg, TRUE);
+       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();
+       drivers = sr_driver_list(sr_ctx);
        for (i = 0; drivers[i]; i++) {
                if (strcmp(drivers[i]->name, drvname))
                        continue;