]> sigrok.org Git - sigrok-cli.git/blobdiff - decode.c
configure.ac: Bump package version to 0.7.1.
[sigrok-cli.git] / decode.c
index 67d8f1ef33c196310bfa24ee1a12f7663e2bbeeb..2b95f2346fb2d22d3fd8b5bf4199aa980ba0bd88 100644 (file)
--- a/decode.c
+++ b/decode.c
@@ -109,26 +109,20 @@ static GHashTable *extract_channel_map(struct srd_decoder *dec, GHashTable *hash
        return channel_map;
 }
 
-/*
- * Register the given PDs for this session.
- * Accepts a string of the form: "spi:sck=3:sdata=4,spi:sck=3:sdata=5"
- * That will instantiate two SPI decoders on the clock but different data
- * lines.
- */
-int register_pds(const char *opt_pds, char *opt_pd_annotations)
+static int register_pd(char *opt_pds, char *opt_pd_annotations)
 {
+       int ret;
        struct srd_decoder *dec;
+       struct srd_decoder_inst *di, *di_prior;
+       char **pdtokens, **pdtok, *pd_name;
        GHashTable *pd_opthash, *options, *channels;
        GList *leftover, *l;
-       struct srd_decoder_inst *di;
-       int ret;
-       char **pdtokens, **pdtok, *pd_name;
 
-       pd_ann_visible = g_hash_table_new_full(g_str_hash, g_str_equal,
-                                              g_free, NULL);
        ret = 0;
        pd_name = NULL;
-       pd_opthash = options = channels = pd_channel_maps = NULL;
+       di_prior = NULL;
+       pd_opthash = options = channels = NULL;
+
        pdtokens = g_strsplit(opt_pds, ",", 0);
        for (pdtok = pdtokens; *pdtok; pdtok++) {
                if (!(pd_opthash = parse_generic_arg(*pdtok, TRUE))) {
@@ -175,8 +169,6 @@ int register_pds(const char *opt_pds, char *opt_pd_annotations)
                         * Save the channel setup for later, but only on the
                         * first decoder (stacked decoders don't get channels).
                         */
-                       pd_channel_maps = g_hash_table_new_full(g_str_hash,
-                                       g_str_equal, g_free, (GDestroyNotify)g_hash_table_destroy);
                        g_hash_table_insert(pd_channel_maps, g_strdup(di->inst_id), channels);
                        channels = NULL;
                }
@@ -186,19 +178,57 @@ int register_pds(const char *opt_pds, char *opt_pd_annotations)
                 * This will be pared down later to leave only the last PD
                 * in the stack.
                 */
-               if (!opt_pd_annotations)
-                       g_hash_table_insert(pd_ann_visible, g_strdup(di->inst_id),
+               if (!opt_pd_annotations) {
+                       g_hash_table_insert(pd_ann_visible, g_strdup(di->decoder->id),
                                        g_slist_append(NULL, GINT_TO_POINTER(-1)));
+               }
+               if (di_prior) {
+                       if (srd_inst_stack(srd_sess, di_prior, di) != SRD_OK) {
+                               g_critical("Failed to stack %s -> %s.",
+                                       di_prior->inst_id, di->inst_id);
+                               ret = 1;
+                               break;
+                       }
+                       /* Remove annotations from prior levels. */
+                       if (!opt_pd_annotations)
+                               g_hash_table_remove(pd_ann_visible, di_prior->inst_id);
+               }
+               di_prior = di;
+               g_free(pd_name);
+               g_hash_table_destroy(pd_opthash);
+               g_hash_table_destroy(options);
+               pd_opthash = options = NULL;
        }
 
-       g_strfreev(pdtokens);
        if (pd_opthash)
                g_hash_table_destroy(pd_opthash);
        if (options)
                g_hash_table_destroy(options);
        if (channels)
                g_hash_table_destroy(channels);
-       g_free(pd_name);
+
+       g_strfreev(pdtokens);
+
+       return ret;
+}
+
+/*
+ * Register all the PDs from all stacks.
+ *
+ * Each PD string is a single stack such as "uart:baudrate=19200,modbus".
+ */
+int register_pds(gchar **all_pds, char *opt_pd_annotations)
+{
+       int ret;
+
+       ret = 0;
+       pd_ann_visible = g_hash_table_new_full(g_str_hash, g_str_equal,
+                                              g_free, NULL);
+       pd_channel_maps = g_hash_table_new_full(g_str_hash,
+               g_str_equal, g_free, (GDestroyNotify)g_hash_table_destroy);
+
+       for (int i = 0; all_pds[i]; i++)
+               ret += register_pd(all_pds[i], opt_pd_annotations);
 
        return ret;
 }
@@ -245,6 +275,7 @@ static void map_pd_inst_channels(void *key, void *value, void *user_data)
        }
 
        srd_inst_channel_set_all(di, channel_indices);
+       g_hash_table_destroy(channel_indices);
 }
 
 void map_pd_channels(struct sr_dev_inst *sdi)
@@ -261,65 +292,6 @@ void map_pd_channels(struct sr_dev_inst *sdi)
        }
 }
 
-int setup_pd_stack(char *opt_pds, char *opt_pd_stack, char *opt_pd_annotations)
-{
-       struct srd_decoder_inst *di_from, *di_to;
-       int ret, i;
-       char **pds, **ids;
-
-       /* Set up the protocol decoder stack. */
-       pds = g_strsplit(opt_pds, ",", 0);
-       if (g_strv_length(pds) > 1) {
-               if (opt_pd_stack) {
-                       /* A stack setup was specified, use that. */
-                       g_strfreev(pds);
-                       pds = g_strsplit(opt_pd_stack, ",", 0);
-                       if (g_strv_length(pds) < 2) {
-                               g_strfreev(pds);
-                               g_critical("Specify at least two protocol decoders to stack.");
-                               return 1;
-                       }
-               }
-
-               /* First PD goes at the bottom of the stack. */
-               ids = g_strsplit(pds[0], ":", 0);
-               if (!(di_from = srd_inst_find_by_id(srd_sess, ids[0]))) {
-                       g_strfreev(ids);
-                       g_critical("Cannot stack protocol decoder '%s': "
-                                       "instance not found.", pds[0]);
-                       return 1;
-               }
-               g_strfreev(ids);
-
-               /* Every subsequent PD goes on top. */
-               for (i = 1; pds[i]; i++) {
-                       ids = g_strsplit(pds[i], ":", 0);
-                       if (!(di_to = srd_inst_find_by_id(srd_sess, ids[0]))) {
-                               g_strfreev(ids);
-                               g_critical("Cannot stack protocol decoder '%s': "
-                                               "instance not found.", pds[i]);
-                               return 1;
-                       }
-                       g_strfreev(ids);
-                       if ((ret = srd_inst_stack(srd_sess, di_from, di_to)) != SRD_OK)
-                               return 1;
-
-                       /*
-                        * Don't show annotation from this PD. Only the last PD in
-                        * the stack will be left on the annotation list (unless
-                        * the annotation list was specifically provided).
-                        */
-                       if (!opt_pd_annotations)
-                               g_hash_table_remove(pd_ann_visible, di_from->inst_id);
-
-                       di_from = di_to;
-               }
-       }
-       g_strfreev(pds);
-
-       return 0;
-}
-
 int setup_pd_annotations(char *opt_pd_annotations)
 {
        GSList *l, *l_ann;
@@ -451,47 +423,75 @@ void show_pd_annotations(struct srd_proto_data *pdata, void *cb_data)
        GSList *ann_list, *l;
        int i;
        char **ann_descr;
-       gboolean show;
+       gboolean show_ann, show_snum, show_class, show_quotes, show_abbrev;
+       const char *quote;
 
        (void)cb_data;
 
        if (!pd_ann_visible)
                return;
 
-       if (!g_hash_table_lookup_extended(pd_ann_visible, pdata->pdo->di->inst_id,
-                       NULL, (void **)&ann_list))
+       if (!g_hash_table_lookup_extended(pd_ann_visible, pdata->pdo->di->decoder->id,
+                       NULL, (void **)&ann_list)) {
                /* Not in the list of PDs whose annotations we're showing. */
                return;
+       }
 
        dec = pdata->pdo->di->decoder;
        pda = pdata->data;
-       show = FALSE;
+       show_ann = FALSE;
        for (l = ann_list; l; l = l->next) {
                if (GPOINTER_TO_INT(l->data) == -1
                                || GPOINTER_TO_INT(l->data) == pda->ann_class) {
-                       show = TRUE;
+                       show_ann = TRUE;
                        break;
                }
        }
-       if (!show)
+       if (!show_ann)
                return;
 
-       if (opt_loglevel <= SR_LOG_WARN) {
-               /* Show only the longest annotation. */
-               printf("%s", pda->ann_text[0]);
-       } else if (opt_loglevel >= SR_LOG_INFO) {
-               /* Sample numbers and quotes around the longest annotation. */
-               printf("%"PRIu64"-%"PRIu64"", pdata->start_sample, pdata->end_sample);
-               if (opt_loglevel == SR_LOG_INFO) {
-                       printf(" \"%s\"", pda->ann_text[0]);
-               } else {
-                       /* Protocol decoder id, annotation class,
-                        * all annotation strings. */
-                       ann_descr = g_slist_nth_data(dec->annotations, pda->ann_class);
-                       printf(" %s: %s:", pdata->pdo->proto_id, ann_descr[0]);
-                       for (i = 0; pda->ann_text[i]; i++)
-                               printf(" \"%s\"", pda->ann_text[i]);
-               }
+       /*
+        * Determine which fields of the annotation to display. Inspect
+        * user specified options as well as the verbosity of the log level:
+        * - Optionally show the sample numbers for the annotation's span.
+        * - Always show the protocol decoder ID.
+        * - Optionally show the annotation's class description.
+        * - Always show the longest annotation text.
+        * - Optionally show alternative annotation text (abbreviations
+        *   for different zoom levels).
+        * - Optionally put quote marks around annotation text, when
+        *   recipients might have to deal with a set of text variants.
+        */
+       show_snum = show_class = show_quotes = show_abbrev = FALSE;
+       if (opt_pd_samplenum || opt_loglevel > SR_LOG_WARN) {
+               show_snum = TRUE;
+       }
+       if (opt_loglevel > SR_LOG_WARN) {
+               show_quotes = TRUE;
+       }
+       if (opt_loglevel > SR_LOG_INFO) {
+               show_class = TRUE;
+               show_abbrev = TRUE;
+       }
+
+       /*
+        * Display the annotation's fields after the layout was
+        * determined above.
+        */
+       if (show_snum) {
+               printf("%" PRIu64 "-%" PRIu64 " ",
+                       pdata->start_sample, pdata->end_sample);
+       }
+       printf("%s: ", pdata->pdo->proto_id);
+       if (show_class) {
+               ann_descr = g_slist_nth_data(dec->annotations, pda->ann_class);
+               printf("%s: ", ann_descr[0]);
+       }
+       quote = show_quotes ? "\"" : "";
+       printf("%s%s%s", quote, pda->ann_text[0], quote);
+       if (show_abbrev) {
+               for (i = 1; pda->ann_text[i]; i++)
+                       printf(" %s%s%s", quote, pda->ann_text[i], quote);
        }
        printf("\n");
        fflush(stdout);
@@ -506,7 +506,7 @@ void show_pd_meta(struct srd_proto_data *pdata, void *cb_data)
                /* Not in the list of PDs whose meta output we're showing. */
                return;
 
-       if (opt_loglevel > SR_LOG_WARN)
+       if (opt_pd_samplenum || opt_loglevel > SR_LOG_WARN)
                printf("%"PRIu64"-%"PRIu64" ", pdata->start_sample, pdata->end_sample);
        printf("%s: ", pdata->pdo->proto_id);
        printf("%s: %s", pdata->pdo->meta_name, g_variant_print(pdata->data, FALSE));
@@ -518,7 +518,7 @@ void show_pd_binary(struct srd_proto_data *pdata, void *cb_data)
 {
        struct srd_proto_data_binary *pdb;
        gpointer classp;
-       int class;
+       int classi;
 
        (void)cb_data;
 
@@ -527,9 +527,9 @@ void show_pd_binary(struct srd_proto_data *pdata, void *cb_data)
                /* Not in the list of PDs whose meta output we're showing. */
                return;
 
-       class = GPOINTER_TO_INT(classp);
+       classi = GPOINTER_TO_INT(classp);
        pdb = pdata->data;
-       if (class != -1 && class != pdb->bin_class)
+       if (classi != -1 && classi != pdb->bin_class)
                /* Not showing this binary class. */
                return;