parsers.c

   1 /*
   2  * This file is part of the sigrok-cli project.
   3  *
   4  * Copyright (C) 2011 Bert Vermeulen <bert@biot.com>
   5  *
   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.
  10  *
  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.
  15  *
  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/>.
  18  */
  19
  20 #include "sigrok-cli.h"
  21 #include <stdio.h>
  22 #include <stdlib.h>
  23 #include <stdint.h>
  24 #include <string.h>
  25 #include <glib.h>
  26
  27 extern struct sr_context *sr_ctx;
  28
  29 struct sr_channel *find_channel(GSList *channellist, const char *channelname)
  30 {
  31         struct sr_channel *ch;
  32         GSList *l;
  33
  34         ch = NULL;
  35         for (l = channellist; l; l = l->next) {
  36                 ch = l->data;
  37                 if (!strcmp(ch->name, channelname))
  38                         break;
  39         }
  40         ch = l ? l->data : NULL;
  41
  42         return ch;
  43 }
  44
  45 GSList *parse_channelstring(struct sr_dev_inst *sdi, const char *channelstring)
  46 {
  47         struct sr_channel *ch;
  48         GSList *channellist, *channels;
  49         int ret, n, b, e, i;
  50         char **tokens, **range, **names, *eptr, str[8];
  51
  52         channels = sr_dev_inst_channels_get(sdi);
  53
  54         if (!channelstring || !channelstring[0])
  55                 /* Use all channels by default. */
  56                 return g_slist_copy(channels);
  57
  58         ret = SR_OK;
  59         range = NULL;
  60         names = NULL;
  61         channellist = NULL;
  62         tokens = g_strsplit(channelstring, ",", 0);
  63         for (i = 0; tokens[i]; i++) {
  64                 if (tokens[i][0] == '\0') {
  65                         g_critical("Invalid empty channel.");
  66                         ret = SR_ERR;
  67                         break;
  68                 }
  69                 if (strchr(tokens[i], '-')) {
  70                         /* A range of channels in the form a-b. This will only work
  71                          * if the channels are named as numbers -- so every channel
  72                          * in the range must exist as a channel name string in the
  73                          * device. */
  74                         range = g_strsplit(tokens[i], "-", 2);
  75                         if (!range[0] || !range[1] || range[2]) {
  76                                 /* Need exactly two arguments. */
  77                                 g_critical("Invalid channel syntax '%s'.", tokens[i]);
  78                                 ret = SR_ERR;
  79                                 goto range_fail;
  80                         }
  81
  82                         b = strtol(range[0], &eptr, 10);
  83                         if (eptr == range[0] || *eptr != '\0') {
  84                                 g_critical("Invalid channel '%s'.", range[0]);
  85                                 ret = SR_ERR;
  86                                 goto range_fail;
  87                         }
  88                         e = strtol(range[1], NULL, 10);
  89                         if (eptr == range[1] || *eptr != '\0') {
  90                                 g_critical("Invalid channel '%s'.", range[1]);
  91                                 ret = SR_ERR;
  92                                 goto range_fail;
  93                         }
  94                         if (b < 0 || b >= e) {
  95                                 g_critical("Invalid channel range '%s'.", tokens[i]);
  96                                 ret = SR_ERR;
  97                                 goto range_fail;
  98                         }
  99
 100                         while (b <= e) {
 101                                 n = snprintf(str, 8, "%d", b);
 102                                 if (n < 0 || n > 8) {
 103                                         g_critical("Invalid channel '%d'.", b);
 104                                         ret = SR_ERR;
 105                                         break;
 106                                 }
 107                                 ch = find_channel(channels, str);
 108                                 if (!ch) {
 109                                         g_critical("unknown channel '%d'.", b);
 110                                         ret = SR_ERR;
 111                                         break;
 112                                 }
 113                                 channellist = g_slist_append(channellist, ch);
 114                                 b++;
 115                         }
 116 range_fail:
 117                         if (range)
 118                                 g_strfreev(range);
 119
 120                         if (ret != SR_OK)
 121                                 break;
 122                 } else {
 123                         names = g_strsplit(tokens[i], "=", 2);
 124                         if (!names[0] || (names[1] && names[2])) {
 125                                 /* Need one or two arguments. */
 126                                 g_critical("Invalid channel '%s'.", tokens[i]);
 127                                 g_strfreev(names);
 128                                 ret = SR_ERR;
 129                                 break;
 130                         }
 131
 132                         ch = find_channel(channels, names[0]);
 133                         if (!ch) {
 134                                 g_critical("unknown channel '%s'.", names[0]);
 135                                 g_strfreev(names);
 136                                 ret = SR_ERR;
 137                                 break;
 138                         }
 139                         if (names[1]) {
 140                                 /* Rename channel. */
 141                                 g_free(ch->name);
 142                                 ch->name = g_strdup(names[1]);
 143                         }
 144                         channellist = g_slist_append(channellist, ch);
 145
 146                         g_strfreev(names);
 147                 }
 148         }
 149
 150         if (ret != SR_OK) {
 151                 g_slist_free(channellist);
 152                 channellist = NULL;
 153         }
 154
 155         g_strfreev(tokens);
 156
 157         return channellist;
 158 }
 159
 160 int parse_trigger_match(char c)
 161 {
 162         int match;
 163
 164         if (c == '0')
 165                 match = SR_TRIGGER_ZERO;
 166         else if (c == '1')
 167                 match = SR_TRIGGER_ONE;
 168         else if (c == 'r')
 169                 match = SR_TRIGGER_RISING;
 170         else if (c == 'f')
 171                 match = SR_TRIGGER_FALLING;
 172         else if (c == 'e')
 173                 match = SR_TRIGGER_EDGE;
 174         else if (c == 'o')
 175                 match = SR_TRIGGER_OVER;
 176         else if (c == 'u')
 177                 match = SR_TRIGGER_UNDER;
 178         else
 179                 match = 0;
 180
 181         return match;
 182 }
 183
 184 int parse_triggerstring(const struct sr_dev_inst *sdi, const char *s,
 185                 struct sr_trigger **trigger)
 186 {
 187         struct sr_channel *ch;
 188         struct sr_trigger_stage *stage;
 189         GVariant *gvar;
 190         GSList *l, *channels;
 191         gsize num_matches;
 192         gboolean found_match, error;
 193         const int32_t *matches;
 194         int32_t match;
 195         unsigned int j;
 196         int t, i;
 197         char **tokens, *sep;
 198         struct sr_dev_driver *driver;
 199
 200         driver = sr_dev_inst_driver_get(sdi);
 201         channels = sr_dev_inst_channels_get(sdi);
 202
 203         if (maybe_config_list(driver, sdi, NULL, SR_CONF_TRIGGER_MATCH,
 204                         &gvar) != SR_OK) {
 205                 g_critical("Device doesn't support any triggers.");
 206                 return FALSE;
 207         }
 208         matches = g_variant_get_fixed_array(gvar, &num_matches, sizeof(int32_t));
 209
 210         *trigger = sr_trigger_new(NULL);
 211         error = FALSE;
 212         tokens = g_strsplit(s, ",", -1);
 213         for (i = 0; tokens[i]; i++) {
 214                 if (!(sep = strchr(tokens[i], '='))) {
 215                         g_critical("Invalid trigger '%s'.", tokens[i]);
 216                         error = TRUE;
 217                         break;
 218                 }
 219                 *sep++ = 0;
 220                 ch = NULL;
 221                 for (l = channels; l; l = l->next) {
 222                         ch = l->data;
 223                         if (ch->enabled && !strcmp(ch->name, tokens[i]))
 224                                 break;
 225                         ch = NULL;
 226                 }
 227                 if (!ch) {
 228                         g_critical("Invalid channel '%s'.", tokens[i]);
 229                         error = TRUE;
 230                         break;
 231                 }
 232                 for (t = 0; sep[t]; t++) {
 233                         if (!(match = parse_trigger_match(sep[t]))) {
 234                                 g_critical("Invalid trigger match '%c'.", sep[t]);
 235                                 error = TRUE;
 236                                 break;
 237                         }
 238                         found_match = FALSE;
 239                         for (j = 0; j < num_matches; j++) {
 240                                 if (matches[j] == match) {
 241                                         found_match = TRUE;
 242                                         break;
 243                                 }
 244                         }
 245                         if (!found_match) {
 246                                 g_critical("Trigger match '%c' not supported by device.", sep[t]);
 247                                 error = TRUE;
 248                                 break;
 249                         }
 250                         /* Make sure this ends up in the right stage, creating
 251                          * them as needed. */
 252                         while (!(stage = g_slist_nth_data((*trigger)->stages, t)))
 253                                 sr_trigger_stage_add(*trigger);
 254                         if (sr_trigger_match_add(stage, ch, match, 0) != SR_OK) {
 255                                 error = TRUE;
 256                                 break;
 257                         }
 258                 }
 259         }
 260         g_strfreev(tokens);
 261         g_variant_unref(gvar);
 262
 263         if (error)
 264                 sr_trigger_free(*trigger);
 265
 266         return !error;
 267 }
 268
 269 GHashTable *parse_generic_arg(const char *arg, gboolean sep_first)
 270 {
 271         GHashTable *hash;
 272         int i;
 273         char **elements, *e;
 274
 275         if (!arg || !arg[0])
 276                 return NULL;
 277
 278         i = 0;
 279         hash = g_hash_table_new_full(g_str_hash, g_str_equal,
 280                         g_free, g_free);
 281         elements = g_strsplit(arg, ":", 0);
 282         if (sep_first)
 283                 g_hash_table_insert(hash, g_strdup("sigrok_key"),
 284                                 g_strdup(elements[i++]));
 285         for (; elements[i]; i++) {
 286                 e = strchr(elements[i], '=');
 287                 if (!e)
 288                         g_hash_table_insert(hash, g_strdup(elements[i]), NULL);
 289                 else {
 290                         *e++ = '\0';
 291                         g_hash_table_insert(hash, g_strdup(elements[i]), g_strdup(e));
 292                 }
 293         }
 294         g_strfreev(elements);
 295
 296         return hash;
 297 }
 298
 299 GHashTable *generic_arg_to_opt(const struct sr_option **opts, GHashTable *genargs)
 300 {
 301         GHashTable *hash;
 302         GVariant *gvar;
 303         int i;
 304         char *s;
 305         gboolean b;
 306
 307         hash = g_hash_table_new_full(g_str_hash, g_str_equal, g_free,
 308                         (GDestroyNotify)g_variant_unref);
 309         for (i = 0; opts[i]; i++) {
 310                 if (!(s = g_hash_table_lookup(genargs, opts[i]->id)))
 311                         continue;
 312                 if (g_variant_is_of_type(opts[i]->def, G_VARIANT_TYPE_UINT32)) {
 313                         gvar = g_variant_new_uint32(strtoul(s, NULL, 10));
 314                         g_hash_table_insert(hash, g_strdup(opts[i]->id),
 315                                         g_variant_ref_sink(gvar));
 316                 } else if (g_variant_is_of_type(opts[i]->def, G_VARIANT_TYPE_INT32)) {
 317                         gvar = g_variant_new_int32(strtoul(s, NULL, 10));
 318                         g_hash_table_insert(hash, g_strdup(opts[i]->id),
 319                                         g_variant_ref_sink(gvar));
 320                 } else if (g_variant_is_of_type(opts[i]->def, G_VARIANT_TYPE_UINT64)) {
 321                         gvar = g_variant_new_uint64(strtoul(s, NULL, 10));
 322                         g_hash_table_insert(hash, g_strdup(opts[i]->id),
 323                                         g_variant_ref_sink(gvar));
 324                 } else if (g_variant_is_of_type(opts[i]->def, G_VARIANT_TYPE_DOUBLE)) {
 325                         gvar = g_variant_new_double(strtod(s, NULL));
 326                         g_hash_table_insert(hash, g_strdup(opts[i]->id),
 327                                         g_variant_ref_sink(gvar));
 328                 } else if (g_variant_is_of_type(opts[i]->def, G_VARIANT_TYPE_STRING)) {
 329                         gvar = g_variant_new_string(s);
 330                         g_hash_table_insert(hash, g_strdup(opts[i]->id),
 331                                         g_variant_ref_sink(gvar));
 332                 } else if (g_variant_is_of_type(opts[i]->def, G_VARIANT_TYPE_BOOLEAN)) {
 333                         b = TRUE;
 334                         if (0 == strcmp(s, "false") || 0 == strcmp(s, "no")) {
 335                                 b = FALSE;
 336                         } else if (!(0 == strcmp(s, "true") || 0 == strcmp(s, "yes"))) {
 337                                 g_critical("Unable to convert '%s' to boolean!", s);
 338                         }
 339
 340                         gvar = g_variant_new_boolean(b);
 341                         g_hash_table_insert(hash, g_strdup(opts[i]->id),
 342                                         g_variant_ref_sink(gvar));
 343                 } else {
 344                         g_critical("Don't know GVariant type for option '%s'!", opts[i]->id);
 345                  }
 346         }
 347
 348         return hash;
 349 }
 350
 351 static char *strcanon(const char *str)
 352 {
 353         int p0, p1;
 354         char *s;
 355
 356         /* Returns newly allocated string. */
 357         s = g_ascii_strdown(str, -1);
 358         for (p0 = p1 = 0; str[p0]; p0++) {
 359                 if ((s[p0] >= 'a' && s[p0] <= 'z')
 360                                 || (s[p0] >= '0' && s[p0] <= '9'))
 361                         s[p1++] = s[p0];
 362         }
 363         s[p1] = '\0';
 364
 365         return s;
 366 }
 367
 368 int canon_cmp(const char *str1, const char *str2)
 369 {
 370         int ret;
 371         char *s1, *s2;
 372
 373         s1 = strcanon(str1);
 374         s2 = strcanon(str2);
 375         ret = g_ascii_strcasecmp(s1, s2);
 376         g_free(s2);
 377         g_free(s1);
 378
 379         return ret;
 380 }
 381
 382 /* Convert driver options hash to GSList of struct sr_config. */
 383 static GSList *hash_to_hwopt(GHashTable *hash)
 384 {
 385         struct sr_config *src;
 386         GList *gl, *keys;
 387         GSList *opts;
 388         char *key;
 389
 390         keys = g_hash_table_get_keys(hash);
 391         opts = NULL;
 392         for (gl = keys; gl; gl = gl->next) {
 393                 key = gl->data;
 394                 src = g_malloc(sizeof(struct sr_config));
 395                 if (opt_to_gvar(key, g_hash_table_lookup(hash, key), src) != 0)
 396                         return NULL;
 397                 opts = g_slist_append(opts, src);
 398         }
 399         g_list_free(keys);
 400
 401         return opts;
 402 }
 403
 404 int parse_driver(char *arg, struct sr_dev_driver **driver, GSList **drvopts)
 405 {
 406         struct sr_dev_driver **drivers;
 407         GHashTable *drvargs;
 408         int i;
 409         char *drvname;
 410
 411         drvargs = parse_generic_arg(arg, TRUE);
 412
 413         drvname = g_strdup(g_hash_table_lookup(drvargs, "sigrok_key"));
 414         g_hash_table_remove(drvargs, "sigrok_key");
 415         *driver = NULL;
 416         drivers = sr_driver_list();
 417         for (i = 0; drivers[i]; i++) {
 418                 if (strcmp(drivers[i]->name, drvname))
 419                         continue;
 420                 *driver = drivers[i];
 421         }
 422         if (!*driver) {
 423                 g_critical("Driver %s not found.", drvname);
 424                 g_hash_table_destroy(drvargs);
 425                 g_free(drvname);
 426                 return FALSE;
 427         }
 428         g_free(drvname);
 429         if (sr_driver_init(sr_ctx, *driver) != SR_OK) {
 430                 g_critical("Failed to initialize driver.");
 431                 g_hash_table_destroy(drvargs);
 432                 return FALSE;
 433         }
 434
 435         if (drvopts) {
 436                 *drvopts = NULL;
 437                 if (g_hash_table_size(drvargs) > 0) {
 438                         if (!(*drvopts = hash_to_hwopt(drvargs))) {
 439                                 /* Unknown options, already logged. */
 440                                 g_hash_table_destroy(drvargs);
 441                                 return FALSE;
 442                         }
 443                 }
 444         }
 445
 446         g_hash_table_destroy(drvargs);
 447
 448         return TRUE;
 449 }
 450