src/input/csv.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 Marc Schink <sigrok-dev@marcschink.de>
   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 <config.h>
  21 #include <stdlib.h>
  22 #include <string.h>
  23 #include <glib.h>
  24 #include <libsigrok/libsigrok.h>
  25 #include "libsigrok-internal.h"
  26
  27 #define LOG_PREFIX "input/csv"
  28
  29 /*
  30  * The CSV input module has the following options:
  31  *
  32  * single-column: Specifies the column number which stores the sample data for
  33  *                single column mode and enables single column mode. Multi
  34  *                column mode is used if this parameter is omitted.
  35  *
  36  * numchannels:   Specifies the number of channels to use. In multi column mode
  37  *                the number of channels are the number of columns and in single
  38  *                column mode the number of bits (LSB first) beginning at
  39  *                'first-channel'.
  40  *
  41  * delimiter:     Specifies the delimiter for columns. Must be at least one
  42  *                character. Comma is used as default delimiter.
  43  *
  44  * format:        Specifies the format of the sample data in single column mode.
  45  *                Available formats are: 'bin', 'hex' and 'oct'. The binary
  46  *                format is used by default. This option has no effect in multi
  47  *                column mode.
  48  *
  49  * comment:       Specifies the prefix character(s) for comments. No prefix
  50  *                characters are used by default which disables removing of
  51  *                comments.
  52  *
  53  * samplerate:    Samplerate which the sample data was captured with. Default
  54  *                value is 0.
  55  *
  56  * first-channel: Column number of the first channel in multi column mode and
  57  *                position of the bit for the first channel in single column mode.
  58  *                Default value is 0.
  59  *
  60  * header:        Determines if the first line should be treated as header
  61  *                and used for channel names in multi column mode. Empty header
  62  *                names will be replaced by the channel number. If enabled in
  63  *                single column mode the first line will be skipped. Usage of
  64  *                header is disabled by default.
  65  *
  66  * startline:     Line number to start processing sample data. Must be greater
  67  *                than 0. The default line number to start processing is 1.
  68  */
  69
  70 /*
  71  * TODO
  72  *
  73  * - Determine how the text line handling can get improved, regarding
  74  *   all of robustness and flexibility and correctness.
  75  *   - The current implementation splits on "any run of CR and LF". Which
  76  *     translates to: Line numbers are wrong in the presence of empty
  77  *     lines in the input stream. See below for an (expensive) fix.
  78  *   - Dropping support for CR style end-of-line markers could improve
  79  *     the situation a lot. Code could search for and split on LF, and
  80  *     trim optional trailing CR. This would result in proper support
  81  *     for CRLF (Windows) as well as LF (Unix), and allow for correct
  82  *     line number counts.
  83  *   - When support for CR-only line termination cannot get dropped,
  84  *     then the current implementation is inappropriate. Currently the
  85  *     input stream is scanned for the first occurance of either of the
  86  *     supported termination styles (which is good). For the remaining
  87  *     session a consistent encoding of the text lines is assumed (which
  88  *     is acceptable).
  89  *   - When line numbers need to be correct and reliable, _and_ the full
  90  *     set of previously supported line termination sequences are required,
  91  *     and potentially more are to get added for improved compatibility
  92  *     with more platforms or generators, then the current approach of
  93  *     splitting on runs of termination characters needs to get replaced,
  94  *     by the more expensive approach to scan for and count the initially
  95  *     determined termination sequence.
  96  *
  97  * - Add support for analog input data? (optional)
  98  *   - Needs a syntax first for user specs which channels (columns) are
  99  *     logic and which are analog. May need heuristics(?) to guess from
 100  *     input data in the absence of user provided specs.
 101  */
 102
 103 /* Single column formats. */
 104 enum {
 105         FORMAT_BIN,
 106         FORMAT_HEX,
 107         FORMAT_OCT
 108 };
 109
 110 struct context {
 111         gboolean started;
 112
 113         /* Current selected samplerate. */
 114         uint64_t samplerate;
 115
 116         /* Number of channels. */
 117         unsigned int num_channels;
 118
 119         /* Column delimiter character(s). */
 120         GString *delimiter;
 121
 122         /* Comment prefix character(s). */
 123         GString *comment;
 124
 125         /* Termination character(s) used in current stream. */
 126         char *termination;
 127
 128         /* Determines if sample data is stored in multiple columns. */
 129         gboolean multi_column_mode;
 130
 131         /* Column number of the sample data in single column mode. */
 132         unsigned int single_column;
 133
 134         /*
 135          * Number of the first column to parse. Equivalent to the number of the
 136          * first channel in multi column mode and the single column number in
 137          * single column mode.
 138          */
 139         unsigned int first_column;
 140
 141         /*
 142          * Column number of the first channel in multi column mode and position of
 143          * the bit for the first channel in single column mode.
 144          */
 145         unsigned int first_channel;
 146
 147         /* Line number to start processing. */
 148         size_t start_line;
 149
 150         /*
 151          * Determines if the first line should be treated as header and used for
 152          * channel names in multi column mode.
 153          */
 154         gboolean header;
 155
 156         /* Format sample data is stored in single column mode. */
 157         int format;
 158
 159         /* Size of the sample buffer. */
 160         size_t sample_buffer_size;
 161
 162         /* Buffer to store sample data. */
 163         uint8_t *sample_buffer;
 164
 165         /* Current line number. */
 166         size_t line_number;
 167 };
 168
 169 static void strip_comment(char *buf, const GString *prefix)
 170 {
 171         char *ptr;
 172
 173         if (!prefix->len)
 174                 return;
 175
 176         if ((ptr = strstr(buf, prefix->str)))
 177                 *ptr = '\0';
 178 }
 179
 180 static int parse_binstr(const char *str, struct context *inc)
 181 {
 182         gsize i, j, length;
 183
 184         length = strlen(str);
 185
 186         if (!length) {
 187                 sr_err("Column %u in line %zu is empty.", inc->single_column,
 188                         inc->line_number);
 189                 return SR_ERR;
 190         }
 191
 192         /* Clear buffer in order to set bits only. */
 193         memset(inc->sample_buffer, 0, (inc->num_channels + 7) >> 3);
 194
 195         i = inc->first_channel;
 196
 197         for (j = 0; i < length && j < inc->num_channels; i++, j++) {
 198                 if (str[length - i - 1] == '1') {
 199                         inc->sample_buffer[j / 8] |= (1 << (j % 8));
 200                 } else if (str[length - i - 1] != '0') {
 201                         sr_err("Invalid value '%s' in column %u in line %zu.",
 202                                 str, inc->single_column, inc->line_number);
 203                         return SR_ERR;
 204                 }
 205         }
 206
 207         return SR_OK;
 208 }
 209
 210 static int parse_hexstr(const char *str, struct context *inc)
 211 {
 212         gsize i, j, k, length;
 213         uint8_t value;
 214         char c;
 215
 216         length = strlen(str);
 217
 218         if (!length) {
 219                 sr_err("Column %u in line %zu is empty.", inc->single_column,
 220                         inc->line_number);
 221                 return SR_ERR;
 222         }
 223
 224         /* Clear buffer in order to set bits only. */
 225         memset(inc->sample_buffer, 0, (inc->num_channels + 7) >> 3);
 226
 227         /* Calculate the position of the first hexadecimal digit. */
 228         i = inc->first_channel / 4;
 229
 230         for (j = 0; i < length && j < inc->num_channels; i++) {
 231                 c = str[length - i - 1];
 232
 233                 if (!g_ascii_isxdigit(c)) {
 234                         sr_err("Invalid value '%s' in column %u in line %zu.",
 235                                 str, inc->single_column, inc->line_number);
 236                         return SR_ERR;
 237                 }
 238
 239                 value = g_ascii_xdigit_value(c);
 240
 241                 k = (inc->first_channel + j) % 4;
 242
 243                 for (; j < inc->num_channels && k < 4; k++) {
 244                         if (value & (1 << k))
 245                                 inc->sample_buffer[j / 8] |= (1 << (j % 8));
 246
 247                         j++;
 248                 }
 249         }
 250
 251         return SR_OK;
 252 }
 253
 254 static int parse_octstr(const char *str, struct context *inc)
 255 {
 256         gsize i, j, k, length;
 257         uint8_t value;
 258         char c;
 259
 260         length = strlen(str);
 261
 262         if (!length) {
 263                 sr_err("Column %u in line %zu is empty.", inc->single_column,
 264                         inc->line_number);
 265                 return SR_ERR;
 266         }
 267
 268         /* Clear buffer in order to set bits only. */
 269         memset(inc->sample_buffer, 0, (inc->num_channels + 7) >> 3);
 270
 271         /* Calculate the position of the first octal digit. */
 272         i = inc->first_channel / 3;
 273
 274         for (j = 0; i < length && j < inc->num_channels; i++) {
 275                 c = str[length - i - 1];
 276
 277                 if (c < '0' || c > '7') {
 278                         sr_err("Invalid value '%s' in column %u in line %zu.",
 279                                 str, inc->single_column, inc->line_number);
 280                         return SR_ERR;
 281                 }
 282
 283                 value = g_ascii_xdigit_value(c);
 284
 285                 k = (inc->first_channel + j) % 3;
 286
 287                 for (; j < inc->num_channels && k < 3; k++) {
 288                         if (value & (1 << k))
 289                                 inc->sample_buffer[j / 8] |= (1 << (j % 8));
 290
 291                         j++;
 292                 }
 293         }
 294
 295         return SR_OK;
 296 }
 297
 298 static char **parse_line(char *buf, struct context *inc, int max_columns)
 299 {
 300         const char *str, *remainder;
 301         GSList *list, *l;
 302         char **columns;
 303         char *column;
 304         gsize n, k;
 305
 306         n = 0;
 307         k = 0;
 308         list = NULL;
 309
 310         remainder = buf;
 311         str = strstr(remainder, inc->delimiter->str);
 312
 313         while (str && max_columns) {
 314                 if (n >= inc->first_column) {
 315                         column = g_strndup(remainder, str - remainder);
 316                         list = g_slist_prepend(list, g_strstrip(column));
 317
 318                         max_columns--;
 319                         k++;
 320                 }
 321
 322                 remainder = str + inc->delimiter->len;
 323                 str = strstr(remainder, inc->delimiter->str);
 324                 n++;
 325         }
 326
 327         if (buf[0] && max_columns && n >= inc->first_column) {
 328                 column = g_strdup(remainder);
 329                 list = g_slist_prepend(list, g_strstrip(column));
 330                 k++;
 331         }
 332
 333         if (!(columns = g_try_new(char *, k + 1)))
 334                 return NULL;
 335
 336         columns[k--] = NULL;
 337
 338         for (l = list; l; l = l->next)
 339                 columns[k--] = l->data;
 340
 341         g_slist_free(list);
 342
 343         return columns;
 344 }
 345
 346 static int parse_multi_columns(char **columns, struct context *inc)
 347 {
 348         gsize i;
 349         char *column;
 350
 351         /* Clear buffer in order to set bits only. */
 352         memset(inc->sample_buffer, 0, (inc->num_channels + 7) >> 3);
 353
 354         for (i = 0; i < inc->num_channels; i++) {
 355                 column = columns[i];
 356                 if (column[0] == '1') {
 357                         inc->sample_buffer[i / 8] |= (1 << (i % 8));
 358                 } else if (!strlen(column)) {
 359                         sr_err("Column %zu in line %zu is empty.",
 360                                 inc->first_channel + i, inc->line_number);
 361                         return SR_ERR;
 362                 } else if (column[0] != '0') {
 363                         sr_err("Invalid value '%s' in column %zu in line %zu.",
 364                                 column, inc->first_channel + i,
 365                                 inc->line_number);
 366                         return SR_ERR;
 367                 }
 368         }
 369
 370         return SR_OK;
 371 }
 372
 373 static int parse_single_column(const char *column, struct context *inc)
 374 {
 375         int res;
 376
 377         res = SR_ERR;
 378
 379         switch (inc->format) {
 380         case FORMAT_BIN:
 381                 res = parse_binstr(column, inc);
 382                 break;
 383         case FORMAT_HEX:
 384                 res = parse_hexstr(column, inc);
 385                 break;
 386         case FORMAT_OCT:
 387                 res = parse_octstr(column, inc);
 388                 break;
 389         }
 390
 391         return res;
 392 }
 393
 394 static int send_samples(const struct sr_dev_inst *sdi, uint8_t *buffer,
 395                 gsize buffer_size, gsize count)
 396 {
 397         struct sr_datafeed_packet packet;
 398         struct sr_datafeed_logic logic;
 399         int res;
 400         gsize i;
 401
 402         packet.type = SR_DF_LOGIC;
 403         packet.payload = &logic;
 404         logic.unitsize = buffer_size;
 405         logic.length = buffer_size;
 406         logic.data = buffer;
 407
 408         for (i = 0; i < count; i++) {
 409                 res = sr_session_send(sdi, &packet);
 410                 if (res != SR_OK)
 411                         return res;
 412         }
 413
 414         return SR_OK;
 415 }
 416
 417 static int init(struct sr_input *in, GHashTable *options)
 418 {
 419         struct context *inc;
 420         const char *s;
 421
 422         in->sdi = g_malloc0(sizeof(struct sr_dev_inst));
 423         in->priv = inc = g_malloc0(sizeof(struct context));
 424
 425         inc->single_column = g_variant_get_int32(g_hash_table_lookup(options, "single-column"));
 426         inc->multi_column_mode = inc->single_column == 0;
 427
 428         inc->num_channels = g_variant_get_int32(g_hash_table_lookup(options, "numchannels"));
 429
 430         inc->delimiter = g_string_new(g_variant_get_string(
 431                         g_hash_table_lookup(options, "delimiter"), NULL));
 432         if (inc->delimiter->len == 0) {
 433                 sr_err("Delimiter must be at least one character.");
 434                 return SR_ERR_ARG;
 435         }
 436
 437         s = g_variant_get_string(g_hash_table_lookup(options, "format"), NULL);
 438         if (!g_ascii_strncasecmp(s, "bin", 3)) {
 439                 inc->format = FORMAT_BIN;
 440         } else if (!g_ascii_strncasecmp(s, "hex", 3)) {
 441                 inc->format = FORMAT_HEX;
 442         } else if (!g_ascii_strncasecmp(s, "oct", 3)) {
 443                 inc->format = FORMAT_OCT;
 444         } else {
 445                 sr_err("Invalid format: '%s'", s);
 446                 return SR_ERR_ARG;
 447         }
 448
 449         inc->comment = g_string_new(g_variant_get_string(
 450                         g_hash_table_lookup(options, "comment"), NULL));
 451         if (g_string_equal(inc->comment, inc->delimiter)) {
 452                 /* That's never going to work. Likely the result of the user
 453                  * setting the delimiter to ; -- the default comment. Clearing
 454                  * the comment setting will work in that case. */
 455                 g_string_truncate(inc->comment, 0);
 456         }
 457
 458         inc->samplerate = g_variant_get_uint64(g_hash_table_lookup(options, "samplerate"));
 459
 460         inc->first_channel = g_variant_get_int32(g_hash_table_lookup(options, "first-channel"));
 461
 462         inc->header = g_variant_get_boolean(g_hash_table_lookup(options, "header"));
 463
 464         inc->start_line = g_variant_get_int32(g_hash_table_lookup(options, "startline"));
 465         if (inc->start_line < 1) {
 466                 sr_err("Invalid start line %zu.", inc->start_line);
 467                 return SR_ERR_ARG;
 468         }
 469
 470         if (inc->multi_column_mode)
 471                 inc->first_column = inc->first_channel;
 472         else
 473                 inc->first_column = inc->single_column;
 474
 475         if (!inc->multi_column_mode && !inc->num_channels) {
 476                 sr_err("Number of channels needs to be specified in single column mode.");
 477                 return SR_ERR_ARG;
 478         }
 479
 480         return SR_OK;
 481 }
 482
 483 static const char *delim_set = "\r\n";
 484
 485 static const char *get_line_termination(GString *buf)
 486 {
 487         const char *term;
 488
 489         term = NULL;
 490         if (g_strstr_len(buf->str, buf->len, "\r\n"))
 491                 term = "\r\n";
 492         else if (memchr(buf->str, '\n', buf->len))
 493                 term = "\n";
 494         else if (memchr(buf->str, '\r', buf->len))
 495                 term = "\r";
 496
 497         return term;
 498 }
 499
 500 static int initial_parse(const struct sr_input *in, GString *buf)
 501 {
 502         struct context *inc;
 503         GString *channel_name;
 504         unsigned int num_columns, i;
 505         size_t line_number, l;
 506         int ret;
 507         char **lines, *line, **columns, *column;
 508
 509         ret = SR_OK;
 510         inc = in->priv;
 511         columns = NULL;
 512
 513         line_number = 0;
 514         lines = g_strsplit_set(buf->str, delim_set, 0);
 515         for (l = 0; lines[l]; l++) {
 516                 line_number++;
 517                 line = lines[l];
 518                 if (inc->start_line > line_number) {
 519                         sr_spew("Line %zu skipped.", line_number);
 520                         continue;
 521                 }
 522                 if (line[0] == '\0') {
 523                         sr_spew("Blank line %zu skipped.", line_number);
 524                         continue;
 525                 }
 526                 strip_comment(line, inc->comment);
 527                 if (line[0] == '\0') {
 528                         sr_spew("Comment-only line %zu skipped.", line_number);
 529                         continue;
 530                 }
 531
 532                 /* Reached first proper line. */
 533                 break;
 534         }
 535         if (!lines[l]) {
 536                 /* Not enough data for a proper line yet. */
 537                 ret = SR_ERR_NA;
 538                 goto out;
 539         }
 540
 541         /*
 542          * In order to determine the number of columns parse the current line
 543          * without limiting the number of columns.
 544          */
 545         columns = parse_line(line, inc, -1);
 546         if (!columns) {
 547                 sr_err("Error while parsing line %zu.", line_number);
 548                 ret = SR_ERR;
 549                 goto out;
 550         }
 551         num_columns = g_strv_length(columns);
 552
 553         /* Ensure that the first column is not out of bounds. */
 554         if (!num_columns) {
 555                 sr_err("Column %u in line %zu is out of bounds.",
 556                         inc->first_column, line_number);
 557                 ret = SR_ERR;
 558                 goto out;
 559         }
 560
 561         if (inc->multi_column_mode) {
 562                 /*
 563                  * Detect the number of channels in multi column mode
 564                  * automatically if not specified.
 565                  */
 566                 if (!inc->num_channels) {
 567                         inc->num_channels = num_columns;
 568                         sr_dbg("Number of auto-detected channels: %u.",
 569                                 inc->num_channels);
 570                 }
 571
 572                 /*
 573                  * Ensure that the number of channels does not exceed the number
 574                  * of columns in multi column mode.
 575                  */
 576                 if (num_columns < inc->num_channels) {
 577                         sr_err("Not enough columns for desired number of channels in line %zu.",
 578                                 line_number);
 579                         ret = SR_ERR;
 580                         goto out;
 581                 }
 582         }
 583
 584         channel_name = g_string_sized_new(64);
 585         for (i = 0; i < inc->num_channels; i++) {
 586                 column = columns[i];
 587                 if (inc->header && inc->multi_column_mode && column[0] != '\0')
 588                         g_string_assign(channel_name, column);
 589                 else
 590                         g_string_printf(channel_name, "%u", i);
 591                 sr_channel_new(in->sdi, i, SR_CHANNEL_LOGIC, TRUE, channel_name->str);
 592         }
 593         g_string_free(channel_name, TRUE);
 594
 595         /*
 596          * Calculate the minimum buffer size to store the sample data of the
 597          * channels.
 598          */
 599         inc->sample_buffer_size = (inc->num_channels + 7) >> 3;
 600         inc->sample_buffer = g_malloc(inc->sample_buffer_size);
 601
 602 out:
 603         if (columns)
 604                 g_strfreev(columns);
 605         g_strfreev(lines);
 606
 607         return ret;
 608 }
 609
 610 /*
 611  * Gets called from initial_receive(), which runs until the end-of-line
 612  * encoding of the input stream could get determined. Assumes that this
 613  * routine receives enough buffered initial input data to either see the
 614  * BOM when there is one, or that no BOM will follow when a text line
 615  * termination sequence was seen. Silently drops the UTF-8 BOM sequence
 616  * from the input buffer if one was seen. Does not care to protect
 617  * against multiple execution or dropping the BOM multiple times --
 618  * there should be at most one in the input stream.
 619  */
 620 static void initial_bom_check(const struct sr_input *in)
 621 {
 622         static const char *utf8_bom = "\xef\xbb\xbf";
 623
 624         if (in->buf->len < strlen(utf8_bom))
 625                 return;
 626         if (strncmp(in->buf->str, utf8_bom, strlen(utf8_bom)) != 0)
 627                 return;
 628         g_string_erase(in->buf, 0, strlen(utf8_bom));
 629 }
 630
 631 static int initial_receive(const struct sr_input *in)
 632 {
 633         struct context *inc;
 634         GString *new_buf;
 635         int len, ret;
 636         char *p;
 637         const char *termination;
 638
 639         initial_bom_check(in);
 640
 641         inc = in->priv;
 642
 643         termination = get_line_termination(in->buf);
 644         if (!termination)
 645                 /* Don't have a full line yet. */
 646                 return SR_ERR_NA;
 647
 648         p = g_strrstr_len(in->buf->str, in->buf->len, termination);
 649         if (!p)
 650                 /* Don't have a full line yet. */
 651                 return SR_ERR_NA;
 652         len = p - in->buf->str - 1;
 653         new_buf = g_string_new_len(in->buf->str, len);
 654         g_string_append_c(new_buf, '\0');
 655
 656         inc->termination = g_strdup(termination);
 657
 658         if (in->buf->str[0] != '\0')
 659                 ret = initial_parse(in, new_buf);
 660         else
 661                 ret = SR_OK;
 662
 663         g_string_free(new_buf, TRUE);
 664
 665         return ret;
 666 }
 667
 668 static int process_buffer(struct sr_input *in, gboolean is_eof)
 669 {
 670         struct sr_datafeed_packet packet;
 671         struct sr_datafeed_meta meta;
 672         struct sr_config *src;
 673         struct context *inc;
 674         gsize num_columns;
 675         uint64_t samplerate;
 676         int max_columns, ret, l;
 677         char *p, **lines, *line, **columns;
 678
 679         inc = in->priv;
 680         if (!inc->started) {
 681                 std_session_send_df_header(in->sdi);
 682
 683                 if (inc->samplerate) {
 684                         packet.type = SR_DF_META;
 685                         packet.payload = &meta;
 686                         samplerate = inc->samplerate;
 687                         src = sr_config_new(SR_CONF_SAMPLERATE, g_variant_new_uint64(samplerate));
 688                         meta.config = g_slist_append(NULL, src);
 689                         sr_session_send(in->sdi, &packet);
 690                         g_slist_free(meta.config);
 691                         sr_config_free(src);
 692                 }
 693
 694                 inc->started = TRUE;
 695         }
 696
 697         /* Limit the number of columns to parse. */
 698         if (inc->multi_column_mode)
 699                 max_columns = inc->num_channels;
 700         else
 701                 max_columns = 1;
 702
 703         /*
 704          * Consider empty input non-fatal. Keep accumulating input until
 705          * at least one full text line has become available. Grab the
 706          * maximum amount of accumulated data that consists of full text
 707          * lines, and process what has been received so far, leaving not
 708          * yet complete lines for the next invocation.
 709          *
 710          * Enforce that all previously buffered data gets processed in
 711          * the "EOF" condition. Do not insist in the presence of the
 712          * termination sequence for the last line (may often be missing
 713          * on Windows). A present termination sequence will just result
 714          * in the "execution of an empty line", and does not harm.
 715          */
 716         if (!in->buf->len)
 717                 return SR_OK;
 718         if (is_eof) {
 719                 p = in->buf->str + in->buf->len;
 720         } else {
 721                 p = g_strrstr_len(in->buf->str, in->buf->len, inc->termination);
 722                 if (!p)
 723                         return SR_ERR;
 724                 *p = '\0';
 725                 p += strlen(inc->termination);
 726         }
 727         g_strstrip(in->buf->str);
 728
 729         ret = SR_OK;
 730         lines = g_strsplit_set(in->buf->str, delim_set, 0);
 731         for (l = 0; lines[l]; l++) {
 732                 inc->line_number++;
 733                 line = lines[l];
 734                 if (line[0] == '\0') {
 735                         sr_spew("Blank line %zu skipped.", inc->line_number);
 736                         continue;
 737                 }
 738
 739                 /* Remove trailing comment. */
 740                 strip_comment(line, inc->comment);
 741                 if (line[0] == '\0') {
 742                         sr_spew("Comment-only line %zu skipped.", inc->line_number);
 743                         continue;
 744                 }
 745
 746                 /* Skip the header line, its content was used as the channel names. */
 747                 if (inc->header) {
 748                         sr_spew("Header line %zu skipped.", inc->line_number);
 749                         inc->header = FALSE;
 750                         continue;
 751                 }
 752
 753                 columns = parse_line(line, inc, max_columns);
 754                 if (!columns) {
 755                         sr_err("Error while parsing line %zu.", inc->line_number);
 756                         return SR_ERR;
 757                 }
 758                 num_columns = g_strv_length(columns);
 759                 if (!num_columns) {
 760                         sr_err("Column %u in line %zu is out of bounds.",
 761                                 inc->first_column, inc->line_number);
 762                         g_strfreev(columns);
 763                         return SR_ERR;
 764                 }
 765                 /*
 766                  * Ensure that the number of channels does not exceed the number
 767                  * of columns in multi column mode.
 768                  */
 769                 if (inc->multi_column_mode && num_columns < inc->num_channels) {
 770                         sr_err("Not enough columns for desired number of channels in line %zu.",
 771                                 inc->line_number);
 772                         g_strfreev(columns);
 773                         return SR_ERR;
 774                 }
 775
 776                 if (inc->multi_column_mode)
 777                         ret = parse_multi_columns(columns, inc);
 778                 else
 779                         ret = parse_single_column(columns[0], inc);
 780                 if (ret != SR_OK) {
 781                         g_strfreev(columns);
 782                         return SR_ERR;
 783                 }
 784
 785                 /* Send sample data to the session bus. */
 786                 ret = send_samples(in->sdi, inc->sample_buffer,
 787                         inc->sample_buffer_size, 1);
 788                 if (ret != SR_OK) {
 789                         sr_err("Sending samples failed.");
 790                         return SR_ERR;
 791                 }
 792                 g_strfreev(columns);
 793         }
 794         g_strfreev(lines);
 795         g_string_erase(in->buf, 0, p - in->buf->str);
 796
 797         return ret;
 798 }
 799
 800 static int receive(struct sr_input *in, GString *buf)
 801 {
 802         struct context *inc;
 803         int ret;
 804
 805         g_string_append_len(in->buf, buf->str, buf->len);
 806
 807         inc = in->priv;
 808         if (!inc->termination) {
 809                 ret = initial_receive(in);
 810                 if (ret == SR_ERR_NA)
 811                         /* Not enough data yet. */
 812                         return SR_OK;
 813                 else if (ret != SR_OK)
 814                         return SR_ERR;
 815
 816                 /* sdi is ready, notify frontend. */
 817                 in->sdi_ready = TRUE;
 818                 return SR_OK;
 819         }
 820
 821         ret = process_buffer(in, FALSE);
 822
 823         return ret;
 824 }
 825
 826 static int end(struct sr_input *in)
 827 {
 828         struct context *inc;
 829         int ret;
 830
 831         if (in->sdi_ready)
 832                 ret = process_buffer(in, TRUE);
 833         else
 834                 ret = SR_OK;
 835
 836         inc = in->priv;
 837         if (inc->started)
 838                 std_session_send_df_end(in->sdi);
 839
 840         return ret;
 841 }
 842
 843 static void cleanup(struct sr_input *in)
 844 {
 845         struct context *inc;
 846
 847         inc = in->priv;
 848
 849         if (inc->delimiter)
 850                 g_string_free(inc->delimiter, TRUE);
 851
 852         if (inc->comment)
 853                 g_string_free(inc->comment, TRUE);
 854
 855         g_free(inc->termination);
 856         g_free(inc->sample_buffer);
 857 }
 858
 859 static int reset(struct sr_input *in)
 860 {
 861         struct context *inc = in->priv;
 862
 863         cleanup(in);
 864         inc->started = FALSE;
 865         g_string_truncate(in->buf, 0);
 866
 867         return SR_OK;
 868 }
 869
 870 static struct sr_option options[] = {
 871         { "single-column", "Single column", "Enable/specify single column", NULL, NULL },
 872         { "numchannels", "Max channels", "Number of channels", NULL, NULL },
 873         { "delimiter", "Delimiter", "Column delimiter", NULL, NULL },
 874         { "format", "Format", "Numeric format", NULL, NULL },
 875         { "comment", "Comment", "Comment prefix character", NULL, NULL },
 876         { "samplerate", "Samplerate", "Samplerate used during capture", NULL, NULL },
 877         { "first-channel", "First channel", "Column number of first channel", NULL, NULL },
 878         { "header", "Header", "Treat first line as header with channel names", NULL, NULL },
 879         { "startline", "Start line", "Line number at which to start processing samples", NULL, NULL },
 880         ALL_ZERO
 881 };
 882
 883 static const struct sr_option *get_options(void)
 884 {
 885         if (!options[0].def) {
 886                 options[0].def = g_variant_ref_sink(g_variant_new_int32(0));
 887                 options[1].def = g_variant_ref_sink(g_variant_new_int32(0));
 888                 options[2].def = g_variant_ref_sink(g_variant_new_string(","));
 889                 options[3].def = g_variant_ref_sink(g_variant_new_string("bin"));
 890                 options[4].def = g_variant_ref_sink(g_variant_new_string(";"));
 891                 options[5].def = g_variant_ref_sink(g_variant_new_uint64(0));
 892                 options[6].def = g_variant_ref_sink(g_variant_new_int32(0));
 893                 options[7].def = g_variant_ref_sink(g_variant_new_boolean(FALSE));
 894                 options[8].def = g_variant_ref_sink(g_variant_new_int32(1));
 895         }
 896
 897         return options;
 898 }
 899
 900 SR_PRIV struct sr_input_module input_csv = {
 901         .id = "csv",
 902         .name = "CSV",
 903         .desc = "Comma-separated values",
 904         .exts = (const char*[]){"csv", NULL},
 905         .options = get_options,
 906         .init = init,
 907         .receive = receive,
 908         .end = end,
 909         .cleanup = cleanup,
 910         .reset = reset,
 911 };