2 * This file is part of the sigrok-cli project.
4 * Copyright (C) 2011 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
26 #include "sigrok-cli.h"
28 struct sr_channel *find_channel(GSList *channellist, const char *channelname,
31 struct sr_channel *ch;
35 for (l = channellist; l; l = l->next) {
38 if (strcmp(ch->name, channelname) == 0)
41 if (g_ascii_strcasecmp(ch->name, channelname) == 0)
45 ch = l ? l->data : NULL;
50 GSList *parse_channelstring(struct sr_dev_inst *sdi, const char *channelstring)
52 struct sr_channel *ch;
53 GSList *channellist, *channels;
55 char **tokens, **range, **names, *eptr, str[8];
57 channels = sr_dev_inst_channels_get(sdi);
59 if (!channelstring || !channelstring[0])
60 /* Use all channels by default. */
61 return g_slist_copy(channels);
67 tokens = g_strsplit(channelstring, ",", 0);
68 for (i = 0; tokens[i]; i++) {
69 if (tokens[i][0] == '\0') {
70 g_critical("Invalid empty channel.");
74 if (strchr(tokens[i], '-')) {
76 * A range of channels in the form a-b. This will only work
77 * if the channels are named as numbers -- so every channel
78 * in the range must exist as a channel name string in the
81 range = g_strsplit(tokens[i], "-", 2);
82 if (!range[0] || !range[1] || range[2]) {
83 /* Need exactly two arguments. */
84 g_critical("Invalid channel syntax '%s'.", tokens[i]);
89 b = strtol(range[0], &eptr, 10);
90 if (eptr == range[0] || *eptr != '\0') {
91 g_critical("Invalid channel '%s'.", range[0]);
95 e = strtol(range[1], NULL, 10);
96 if (eptr == range[1] || *eptr != '\0') {
97 g_critical("Invalid channel '%s'.", range[1]);
101 if (b < 0 || b >= e) {
102 g_critical("Invalid channel range '%s'.", tokens[i]);
108 n = snprintf(str, 8, "%d", b);
109 if (n < 0 || n > 8) {
110 g_critical("Invalid channel '%d'.", b);
114 ch = find_channel(channels, str, TRUE);
116 g_critical("unknown channel '%d'.", b);
120 channellist = g_slist_append(channellist, ch);
130 names = g_strsplit(tokens[i], "=", 2);
131 if (!names[0] || (names[1] && names[2])) {
132 /* Need one or two arguments. */
133 g_critical("Invalid channel '%s'.", tokens[i]);
139 ch = find_channel(channels, names[0], TRUE);
141 g_critical("unknown channel '%s'.", names[0]);
147 /* Rename channel. */
148 sr_dev_channel_name_set(ch, names[1]);
150 channellist = g_slist_append(channellist, ch);
157 g_slist_free(channellist);
166 int parse_trigger_match(char c)
171 match = SR_TRIGGER_ZERO;
173 match = SR_TRIGGER_ONE;
175 match = SR_TRIGGER_RISING;
177 match = SR_TRIGGER_FALLING;
179 match = SR_TRIGGER_EDGE;
181 match = SR_TRIGGER_OVER;
183 match = SR_TRIGGER_UNDER;
190 int parse_triggerstring(const struct sr_dev_inst *sdi, const char *s,
191 struct sr_trigger **trigger)
193 struct sr_channel *ch;
194 struct sr_trigger_stage *stage;
196 GSList *l, *channels;
198 gboolean found_match, error;
199 const int32_t *matches;
204 struct sr_dev_driver *driver;
206 driver = sr_dev_inst_driver_get(sdi);
207 channels = sr_dev_inst_channels_get(sdi);
209 if (maybe_config_list(driver, sdi, NULL, SR_CONF_TRIGGER_MATCH,
211 g_critical("Device doesn't support any triggers.");
214 matches = g_variant_get_fixed_array(gvar, &num_matches, sizeof(int32_t));
216 *trigger = sr_trigger_new(NULL);
218 tokens = g_strsplit(s, ",", -1);
219 for (i = 0; tokens[i]; i++) {
220 if (!(sep = strchr(tokens[i], '='))) {
221 g_critical("Invalid trigger '%s'.", tokens[i]);
227 for (l = channels; l; l = l->next) {
229 if (ch->enabled && !strcmp(ch->name, tokens[i]))
234 g_critical("Invalid channel '%s'.", tokens[i]);
238 for (t = 0; sep[t]; t++) {
239 if (!(match = parse_trigger_match(sep[t]))) {
240 g_critical("Invalid trigger match '%c'.", sep[t]);
245 for (j = 0; j < num_matches; j++) {
246 if (matches[j] == match) {
252 g_critical("Trigger match '%c' not supported by device.", sep[t]);
256 /* Make sure this ends up in the right stage, creating
258 while (!(stage = g_slist_nth_data((*trigger)->stages, t)))
259 sr_trigger_stage_add(*trigger);
260 if (sr_trigger_match_add(stage, ch, match, 0) != SR_OK) {
267 g_variant_unref(gvar);
270 sr_trigger_free(*trigger);
276 * Split an input text into a key and value respectively ('=' separator).
278 * @param[in] text Writeable copy of the input text, gets modified.
279 * @param[out] key Position of the keyword.
280 * @param[out] val Position of the value.
282 * TODO In theory the returned key/value locations could be const pointers.
283 * Which even would be preferrable. Unfortunately most call sites deal with
284 * glib hashes, and their insert API seriously lacks the const attribute.
285 * So we drop it here as well to avoid clutter at callers'.
287 static void split_key_value(char *text, char **key, char **val)
301 pos = strchr(k, '=');
313 * Create hash table from colon separated key-value pairs input text.
315 * Accepts input text as it was specified by users. Splits the colon
316 * separated key-value pairs and creates a hash table from these items.
317 * Optionally supports special forms which are useful for different CLI
320 * Typical form: <key>=<val>[:<key>=<val>]*
321 * Generic list of key-value pairs, all items being equal. Mere set.
323 * ID form: <id>[:<key>=<val>]*
324 * First item is not a key-value pair, instead it's an identifier. Used
325 * to specify a protocol decoder, or a device driver, or an input/output
326 * file format, optionally followed by more parameters' values. The ID
327 * part of the input spec is not optional.
329 * Optional ID: [<sel>=<id>][:<key>=<val>]*
330 * All items are key-value pairs. The first item _may_ be an identifier,
331 * if its key matches a caller specified key name. Otherwise the input
332 * text is the above typical form, a mere list of key-value pairs while
333 * none of them is special.
335 * @param[in] arg Input text.
336 * @param[in] sep_first Boolean, whether ID form is required.
337 * @param[in] key_first Keyword name if optional ID is applicable.
339 * @returns A hash table which contains the key/value pairs, or #NULL
340 * when the input is invalid.
342 GHashTable *parse_generic_arg(const char *arg,
343 gboolean sep_first, const char *key_first)
352 if (key_first && !key_first[0])
355 hash = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, g_free);
356 elements = g_strsplit(arg, ":", 0);
359 k = g_strdup("sigrok_key");
360 v = g_strdup(elements[i++]);
361 g_hash_table_insert(hash, k, v);
362 } else if (key_first) {
363 split_key_value(elements[i], &k, &v);
364 if (g_ascii_strcasecmp(k, key_first) == 0) {
369 g_hash_table_insert(hash, k, v);
372 for (; elements[i]; i++) {
375 split_key_value(elements[i], &k, &v);
377 v = v ? g_strdup(v) : NULL;
378 g_hash_table_insert(hash, k, v);
380 g_strfreev(elements);
385 GSList *check_unknown_keys(const struct sr_option **avail, GHashTable *used)
392 const char *avail_id, *found_id;
394 /* Collect a list of used but not available keywords. */
396 g_hash_table_iter_init(&iter, used);
397 while (g_hash_table_iter_next(&iter, &key, NULL)) {
400 for (avail_idx = 0; avail[avail_idx] && avail[avail_idx]->id; avail_idx++) {
401 avail_id = avail[avail_idx]->id;
402 if (strcmp(avail_id, used_id) == 0) {
408 unknown = g_slist_append(unknown, g_strdup(used_id));
411 /* Return the list of unknown keywords, or NULL if empty. */
415 gboolean warn_unknown_keys(const struct sr_option **avail, GHashTable *used,
419 gboolean had_unknown;
422 if (!caption || !*caption)
423 caption = "Unknown keyword";
425 unknown = check_unknown_keys(avail, used);
426 had_unknown = unknown != NULL;
427 for (l = unknown; l; l = l->next) {
429 g_warning("%s: %s.", caption, s);
431 g_slist_free_full(unknown, g_free);
436 GHashTable *generic_arg_to_opt(const struct sr_option **opts, GHashTable *genargs)
444 hash = g_hash_table_new_full(g_str_hash, g_str_equal, g_free,
445 (GDestroyNotify)g_variant_unref);
446 for (i = 0; opts[i]; i++) {
447 if (!(s = g_hash_table_lookup(genargs, opts[i]->id)))
449 if (g_variant_is_of_type(opts[i]->def, G_VARIANT_TYPE_UINT32)) {
450 gvar = g_variant_new_uint32(strtoul(s, NULL, 10));
451 g_hash_table_insert(hash, g_strdup(opts[i]->id),
452 g_variant_ref_sink(gvar));
453 } else if (g_variant_is_of_type(opts[i]->def, G_VARIANT_TYPE_INT32)) {
454 gvar = g_variant_new_int32(strtol(s, NULL, 10));
455 g_hash_table_insert(hash, g_strdup(opts[i]->id),
456 g_variant_ref_sink(gvar));
457 } else if (g_variant_is_of_type(opts[i]->def, G_VARIANT_TYPE_UINT64)) {
458 gvar = g_variant_new_uint64(strtoull(s, NULL, 10));
459 g_hash_table_insert(hash, g_strdup(opts[i]->id),
460 g_variant_ref_sink(gvar));
461 } else if (g_variant_is_of_type(opts[i]->def, G_VARIANT_TYPE_DOUBLE)) {
462 gvar = g_variant_new_double(strtod(s, NULL));
463 g_hash_table_insert(hash, g_strdup(opts[i]->id),
464 g_variant_ref_sink(gvar));
465 } else if (g_variant_is_of_type(opts[i]->def, G_VARIANT_TYPE_STRING)) {
466 gvar = g_variant_new_string(s);
467 g_hash_table_insert(hash, g_strdup(opts[i]->id),
468 g_variant_ref_sink(gvar));
469 } else if (g_variant_is_of_type(opts[i]->def, G_VARIANT_TYPE_BOOLEAN)) {
471 if (0 == strcmp(s, "false") || 0 == strcmp(s, "no")) {
473 } else if (!(0 == strcmp(s, "true") || 0 == strcmp(s, "yes"))) {
474 g_critical("Unable to convert '%s' to boolean!", s);
477 gvar = g_variant_new_boolean(b);
478 g_hash_table_insert(hash, g_strdup(opts[i]->id),
479 g_variant_ref_sink(gvar));
481 g_critical("Don't know GVariant type for option '%s'!", opts[i]->id);
488 static char *strcanon(const char *str)
493 /* Returns newly allocated string. */
494 s = g_ascii_strdown(str, -1);
495 for (p0 = p1 = 0; str[p0]; p0++) {
496 if ((s[p0] >= 'a' && s[p0] <= 'z')
497 || (s[p0] >= '0' && s[p0] <= '9'))
505 int canon_cmp(const char *str1, const char *str2)
512 ret = g_ascii_strcasecmp(s1, s2);
519 /* Convert driver options hash to GSList of struct sr_config. */
520 static GSList *hash_to_hwopt(GHashTable *hash)
522 struct sr_config *src;
527 keys = g_hash_table_get_keys(hash);
529 for (gl = keys; gl; gl = gl->next) {
531 src = g_malloc(sizeof(struct sr_config));
532 if (opt_to_gvar(key, g_hash_table_lookup(hash, key), src) != 0)
534 opts = g_slist_append(opts, src);
541 int parse_driver(char *arg, struct sr_dev_driver **driver, GSList **drvopts)
543 struct sr_dev_driver **drivers;
551 drvargs = parse_generic_arg(arg, TRUE, NULL);
553 drvname = g_strdup(g_hash_table_lookup(drvargs, "sigrok_key"));
554 g_hash_table_remove(drvargs, "sigrok_key");
556 drivers = sr_driver_list(sr_ctx);
557 for (i = 0; drivers[i]; i++) {
558 if (strcmp(drivers[i]->name, drvname))
560 *driver = drivers[i];
563 g_critical("Driver %s not found.", drvname);
564 g_hash_table_destroy(drvargs);
569 if (sr_driver_init(sr_ctx, *driver) != SR_OK) {
570 g_critical("Failed to initialize driver.");
571 g_hash_table_destroy(drvargs);
577 if (g_hash_table_size(drvargs) > 0) {
578 if (!(*drvopts = hash_to_hwopt(drvargs))) {
579 /* Unknown options, already logged. */
580 g_hash_table_destroy(drvargs);
586 g_hash_table_destroy(drvargs);