manpage: add --protocol-decoder-jsontrace command line option

[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;
}