]> sigrok.org Git - libsigrok.git/blobdiff - src/input/csv.c
input/csv: Concentrate text line encoding in a single spot
[libsigrok.git] / src / input / csv.c
index 2db908547f39be6d5a6b898c2fe715951d8263c2..fa1d51fd05a787ca7a7241f263308d2f9170137e 100644 (file)
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+#include <config.h>
 #include <stdlib.h>
 #include <string.h>
 #include <glib.h>
-#include "libsigrok.h"
+#include <libsigrok/libsigrok.h>
 #include "libsigrok-internal.h"
 
 #define LOG_PREFIX "input/csv"
@@ -80,7 +81,7 @@ struct context {
        uint64_t samplerate;
 
        /* Number of channels. */
-       gsize num_channels;
+       unsigned int num_channels;
 
        /* Column delimiter character(s). */
        GString *delimiter;
@@ -88,30 +89,30 @@ struct context {
        /* Comment prefix character(s). */
        GString *comment;
 
-       /* Termination  character(s) used in current stream. */
+       /* Termination character(s) used in current stream. */
        char *termination;
 
        /* Determines if sample data is stored in multiple columns. */
        gboolean multi_column_mode;
 
        /* Column number of the sample data in single column mode. */
-       gsize single_column;
+       unsigned int single_column;
 
        /*
         * Number of the first column to parse. Equivalent to the number of the
         * first channel in multi column mode and the single column number in
         * single column mode.
         */
-       gsize first_column;
+       unsigned int first_column;
 
        /*
         * Column number of the first channel in multi column mode and position of
         * the bit for the first channel in single column mode.
         */
-       gsize first_channel;
+       unsigned int first_channel;
 
        /* Line number to start processing. */
-       gsize start_line;
+       size_t start_line;
 
        /*
         * Determines if the first line should be treated as header and used for
@@ -123,26 +124,15 @@ struct context {
        int format;
 
        /* Size of the sample buffer. */
-       gsize sample_buffer_size;
+       size_t sample_buffer_size;
 
        /* Buffer to store sample data. */
        uint8_t *sample_buffer;
 
        /* Current line number. */
-       gsize line_number;
+       size_t line_number;
 };
 
-static int format_match(GHashTable *metadata)
-{
-       char *buf;
-
-       buf = g_hash_table_lookup(metadata, GINT_TO_POINTER(SR_INPUT_META_MIMETYPE));
-       if (!strcmp(buf, "text/csv"))
-               return SR_OK;
-
-       return SR_ERR;
-}
-
 static void strip_comment(char *buf, const GString *prefix)
 {
        char *ptr;
@@ -161,7 +151,7 @@ static int parse_binstr(const char *str, struct context *inc)
        length = strlen(str);
 
        if (!length) {
-               sr_err("Column %zu in line %zu is empty.", inc->single_column,
+               sr_err("Column %u in line %zu is empty.", inc->single_column,
                        inc->line_number);
                return SR_ERR;
        }
@@ -175,7 +165,7 @@ static int parse_binstr(const char *str, struct context *inc)
                if (str[length - i - 1] == '1') {
                        inc->sample_buffer[j / 8] |= (1 << (j % 8));
                } else if (str[length - i - 1] != '0') {
-                       sr_err("Invalid value '%s' in column %zu in line %zu.",
+                       sr_err("Invalid value '%s' in column %u in line %zu.",
                                str, inc->single_column, inc->line_number);
                        return SR_ERR;
                }
@@ -193,7 +183,7 @@ static int parse_hexstr(const char *str, struct context *inc)
        length = strlen(str);
 
        if (!length) {
-               sr_err("Column %zu in line %zu is empty.", inc->single_column,
+               sr_err("Column %u in line %zu is empty.", inc->single_column,
                        inc->line_number);
                return SR_ERR;
        }
@@ -208,7 +198,7 @@ static int parse_hexstr(const char *str, struct context *inc)
                c = str[length - i - 1];
 
                if (!g_ascii_isxdigit(c)) {
-                       sr_err("Invalid value '%s' in column %zu in line %zu.",
+                       sr_err("Invalid value '%s' in column %u in line %zu.",
                                str, inc->single_column, inc->line_number);
                        return SR_ERR;
                }
@@ -237,7 +227,7 @@ static int parse_octstr(const char *str, struct context *inc)
        length = strlen(str);
 
        if (!length) {
-               sr_err("Column %zu in line %zu is empty.", inc->single_column,
+               sr_err("Column %u in line %zu is empty.", inc->single_column,
                        inc->line_number);
                return SR_ERR;
        }
@@ -252,7 +242,7 @@ static int parse_octstr(const char *str, struct context *inc)
                c = str[length - i - 1];
 
                if (c < '0' || c > '7') {
-                       sr_err("Invalid value '%s' in column %zu in line %zu.",
+                       sr_err("Invalid value '%s' in column %u in line %zu.",
                                str, inc->single_column, inc->line_number);
                        return SR_ERR;
                }
@@ -323,20 +313,22 @@ static char **parse_line(char *buf, struct context *inc, int max_columns)
 static int parse_multi_columns(char **columns, struct context *inc)
 {
        gsize i;
+       char *column;
 
        /* Clear buffer in order to set bits only. */
        memset(inc->sample_buffer, 0, (inc->num_channels + 7) >> 3);
 
        for (i = 0; i < inc->num_channels; i++) {
-               if (columns[i][0] == '1') {
+               column = columns[i];
+               if (column[0] == '1') {
                        inc->sample_buffer[i / 8] |= (1 << (i % 8));
-               } else if (!strlen(columns[i])) {
+               } else if (!strlen(column)) {
                        sr_err("Column %zu in line %zu is empty.",
                                inc->first_channel + i, inc->line_number);
                        return SR_ERR;
-               } else if (columns[i][0] != '0') {
+               } else if (column[0] != '0') {
                        sr_err("Invalid value '%s' in column %zu in line %zu.",
-                               columns[i], inc->first_channel + i,
+                               column, inc->first_channel + i,
                                inc->line_number);
                        return SR_ERR;
                }
@@ -351,7 +343,7 @@ static int parse_single_column(const char *column, struct context *inc)
 
        res = SR_ERR;
 
-       switch(inc->format) {
+       switch (inc->format) {
        case FORMAT_BIN:
                res = parse_binstr(column, inc);
                break;
@@ -381,7 +373,8 @@ static int send_samples(const struct sr_dev_inst *sdi, uint8_t *buffer,
        logic.data = buffer;
 
        for (i = 0; i < count; i++) {
-               if ((res = sr_session_send(sdi, &packet)) != SR_OK)
+               res = sr_session_send(sdi, &packet);
+               if (res != SR_OK)
                        return res;
        }
 
@@ -393,7 +386,7 @@ static int init(struct sr_input *in, GHashTable *options)
        struct context *inc;
        const char *s;
 
-       in->sdi = sr_dev_inst_new(0, SR_ST_ACTIVE, NULL, NULL, NULL);
+       in->sdi = g_malloc0(sizeof(struct sr_dev_inst));
        in->priv = inc = g_malloc0(sizeof(struct context));
 
        inc->single_column = g_variant_get_int32(g_hash_table_lookup(options, "single-column"));
@@ -429,11 +422,7 @@ static int init(struct sr_input *in, GHashTable *options)
                g_string_truncate(inc->comment, 0);
        }
 
-       s = g_variant_get_string(g_hash_table_lookup(options, "samplerate"), NULL);
-       if (sr_parse_sizestring(s, &inc->samplerate) != SR_OK) {
-               sr_err("Invalid samplerate '%s'.", s);
-               return SR_ERR_ARG;
-       }
+       inc->samplerate = g_variant_get_uint64(g_hash_table_lookup(options, "samplerate"));
 
        inc->first_channel = g_variant_get_int32(g_hash_table_lookup(options, "first-channel"));
 
@@ -441,7 +430,7 @@ static int init(struct sr_input *in, GHashTable *options)
 
        inc->start_line = g_variant_get_int32(g_hash_table_lookup(options, "startline"));
        if (inc->start_line < 1) {
-               sr_err("Invalid start line %d.", inc->start_line);
+               sr_err("Invalid start line %zu.", inc->start_line);
                return SR_ERR_ARG;
        }
 
@@ -458,9 +447,11 @@ static int init(struct sr_input *in, GHashTable *options)
        return SR_OK;
 }
 
-static char *get_line_termination(GString *buf)
+static const char *delim_set = "\r\n";
+
+static const char *get_line_termination(GString *buf)
 {
-       char *term;
+       const char *term;
 
        term = NULL;
        if (g_strstr_len(buf->str, buf->len, "\r\n"))
@@ -476,31 +467,31 @@ static char *get_line_termination(GString *buf)
 static int initial_parse(const struct sr_input *in, GString *buf)
 {
        struct context *inc;
-       struct sr_channel *ch;
        GString *channel_name;
-       gsize num_columns, l, i;
-       unsigned int line_number;
+       unsigned int num_columns, i;
+       size_t line_number, l;
        int ret;
-       char **lines, **columns;
+       char **lines, *line, **columns, *column;
 
        ret = SR_OK;
        inc = in->priv;
        columns = NULL;
 
        line_number = 0;
-       lines = g_strsplit_set(buf->str, "\r\n", 0);
+       lines = g_strsplit_set(buf->str, delim_set, 0);
        for (l = 0; lines[l]; l++) {
                line_number++;
+               line = lines[l];
                if (inc->start_line > line_number) {
                        sr_spew("Line %zu skipped.", line_number);
                        continue;
                }
-               if (lines[l][0] == '\0') {
+               if (line[0] == '\0') {
                        sr_spew("Blank line %zu skipped.", line_number);
                        continue;
                }
-               strip_comment(lines[l], inc->comment);
-               if (lines[l][0] == '\0') {
+               strip_comment(line, inc->comment);
+               if (line[0] == '\0') {
                        sr_spew("Comment-only line %zu skipped.", line_number);
                        continue;
                }
@@ -510,7 +501,7 @@ static int initial_parse(const struct sr_input *in, GString *buf)
        }
        if (!lines[l]) {
                /* Not enough data for a proper line yet. */
-               ret = SR_OK_CONTINUE;
+               ret = SR_ERR_NA;
                goto out;
        }
 
@@ -518,7 +509,8 @@ static int initial_parse(const struct sr_input *in, GString *buf)
         * In order to determine the number of columns parse the current line
         * without limiting the number of columns.
         */
-       if (!(columns = parse_line(lines[l], inc, -1))) {
+       columns = parse_line(line, inc, -1);
+       if (!columns) {
                sr_err("Error while parsing line %zu.", line_number);
                ret = SR_ERR;
                goto out;
@@ -527,7 +519,7 @@ static int initial_parse(const struct sr_input *in, GString *buf)
 
        /* Ensure that the first column is not out of bounds. */
        if (!num_columns) {
-               sr_err("Column %zu in line %zu is out of bounds.",
+               sr_err("Column %u in line %zu is out of bounds.",
                        inc->first_column, line_number);
                ret = SR_ERR;
                goto out;
@@ -540,7 +532,7 @@ static int initial_parse(const struct sr_input *in, GString *buf)
                 */
                if (!inc->num_channels) {
                        inc->num_channels = num_columns;
-                       sr_dbg("Number of auto-detected channels: %zu.",
+                       sr_dbg("Number of auto-detected channels: %u.",
                                inc->num_channels);
                }
 
@@ -558,12 +550,12 @@ static int initial_parse(const struct sr_input *in, GString *buf)
 
        channel_name = g_string_sized_new(64);
        for (i = 0; i < inc->num_channels; i++) {
-               if (inc->header && inc->multi_column_mode && strlen(columns[i]))
-                       g_string_assign(channel_name, columns[i]);
+               column = columns[i];
+               if (inc->header && inc->multi_column_mode && column[0] != '\0')
+                       g_string_assign(channel_name, column);
                else
-                       g_string_printf(channel_name, "%lu", i);
-               ch = sr_channel_new(i, SR_CHANNEL_LOGIC, TRUE, channel_name->str);
-               in->sdi->channels = g_slist_append(in->sdi->channels, ch);
+                       g_string_printf(channel_name, "%u", i);
+               sr_channel_new(in->sdi, i, SR_CHANNEL_LOGIC, TRUE, channel_name->str);
        }
        g_string_free(channel_name, TRUE);
 
@@ -587,17 +579,20 @@ static int initial_receive(const struct sr_input *in)
        struct context *inc;
        GString *new_buf;
        int len, ret;
-       char *termination, *p;
+       char *p;
+       const char *termination;
 
        inc = in->priv;
 
-       if (!(termination = get_line_termination(in->buf)))
+       termination = get_line_termination(in->buf);
+       if (!termination)
                /* Don't have a full line yet. */
-               return SR_OK_CONTINUE;
+               return SR_ERR_NA;
 
-       if (!(p = g_strrstr_len(in->buf->str, in->buf->len, termination)))
+       p = g_strrstr_len(in->buf->str, in->buf->len, termination);
+       if (!p)
                /* Don't have a full line yet. */
-               return SR_OK_CONTINUE;
+               return SR_ERR_NA;
        len = p - in->buf->str - 1;
        new_buf = g_string_new_len(in->buf->str, len);
        g_string_append_c(new_buf, '\0');
@@ -614,7 +609,7 @@ static int initial_receive(const struct sr_input *in)
        return ret;
 }
 
-static int receive(const struct sr_input *in, GString *buf)
+static int process_buffer(struct sr_input *in)
 {
        struct sr_datafeed_packet packet;
        struct sr_datafeed_meta meta;
@@ -623,21 +618,11 @@ static int receive(const struct sr_input *in, GString *buf)
        gsize num_columns;
        uint64_t samplerate;
        int max_columns, ret, l;
-       char *p, **lines, **columns;
-
-       g_string_append_len(in->buf, buf->str, buf->len);
+       char *p, **lines, *line, **columns;
 
        inc = in->priv;
-       if (!inc->termination) {
-               ret = initial_receive(in);
-               if (ret == SR_OK_CONTINUE)
-                       /* Not enough data yet. */
-                       return SR_OK_CONTINUE;
-               else if (ret != SR_OK)
-                       return SR_ERR;
-
-               inc->started = TRUE;
-               std_session_send_df_header(in->sdi, LOG_PREFIX);
+       if (!inc->started) {
+               std_session_send_df_header(in->sdi);
 
                if (inc->samplerate) {
                        packet.type = SR_DF_META;
@@ -646,11 +631,15 @@ static int receive(const struct sr_input *in, GString *buf)
                        src = sr_config_new(SR_CONF_SAMPLERATE, g_variant_new_uint64(samplerate));
                        meta.config = g_slist_append(NULL, src);
                        sr_session_send(in->sdi, &packet);
+                       g_slist_free(meta.config);
                        sr_config_free(src);
                }
+
+               inc->started = TRUE;
        }
 
-       if (!(p = g_strrstr_len(in->buf->str, in->buf->len, inc->termination)))
+       p = g_strrstr_len(in->buf->str, in->buf->len, inc->termination);
+       if (!p)
                /* Don't have a full line. */
                return SR_ERR;
 
@@ -663,28 +652,38 @@ static int receive(const struct sr_input *in, GString *buf)
        else
                max_columns = 1;
 
-       lines = g_strsplit_set(in->buf->str, "\r\n", 0);
+       ret = SR_OK;
+       lines = g_strsplit_set(in->buf->str, delim_set, 0);
        for (l = 0; lines[l]; l++) {
                inc->line_number++;
-               if (lines[l][0] == '\0') {
+               line = lines[l];
+               if (line[0] == '\0') {
                        sr_spew("Blank line %zu skipped.", inc->line_number);
                        continue;
                }
 
                /* Remove trailing comment. */
-               strip_comment(lines[l], inc->comment);
-               if (lines[l][0] == '\0') {
+               strip_comment(line, inc->comment);
+               if (line[0] == '\0') {
                        sr_spew("Comment-only line %zu skipped.", inc->line_number);
                        continue;
                }
 
-               if (!(columns = parse_line(lines[l], inc, max_columns))) {
+               /* Skip the header line, its content was used as the channel names. */
+               if (inc->header) {
+                       sr_spew("Header line %zu skipped.", inc->line_number);
+                       inc->header = FALSE;
+                       continue;
+               }
+
+               columns = parse_line(line, inc, max_columns);
+               if (!columns) {
                        sr_err("Error while parsing line %zu.", inc->line_number);
                        return SR_ERR;
                }
                num_columns = g_strv_length(columns);
                if (!num_columns) {
-                       sr_err("Column %zu in line %zu is out of bounds.",
+                       sr_err("Column %u in line %zu is out of bounds.",
                                inc->first_column, inc->line_number);
                        g_strfreev(columns);
                        return SR_ERR;
@@ -721,38 +720,75 @@ static int receive(const struct sr_input *in, GString *buf)
        g_strfreev(lines);
        g_string_erase(in->buf, 0, p - in->buf->str + 1);
 
-       return SR_OK;
+       return ret;
 }
 
-static int cleanup(struct sr_input *in)
+static int receive(struct sr_input *in, GString *buf)
 {
        struct context *inc;
-       struct sr_datafeed_packet packet;
+       int ret;
+
+       g_string_append_len(in->buf, buf->str, buf->len);
 
        inc = in->priv;
-       if (!inc)
-               return SR_OK;
+       if (!inc->termination) {
+               ret = initial_receive(in);
+               if (ret == SR_ERR_NA)
+                       /* Not enough data yet. */
+                       return SR_OK;
+               else if (ret != SR_OK)
+                       return SR_ERR;
 
-       if (inc->started) {
-               /* End of stream. */
-               packet.type = SR_DF_END;
-               sr_session_send(in->sdi, &packet);
+               /* sdi is ready, notify frontend. */
+               in->sdi_ready = TRUE;
+               return SR_OK;
        }
 
+       ret = process_buffer(in);
+
+       return ret;
+}
+
+static int end(struct sr_input *in)
+{
+       struct context *inc;
+       int ret;
+
+       if (in->sdi_ready)
+               ret = process_buffer(in);
+       else
+               ret = SR_OK;
+
+       inc = in->priv;
+       if (inc->started)
+               std_session_send_df_end(in->sdi);
+
+       return ret;
+}
+
+static void cleanup(struct sr_input *in)
+{
+       struct context *inc;
+
+       inc = in->priv;
+
        if (inc->delimiter)
                g_string_free(inc->delimiter, TRUE);
 
        if (inc->comment)
                g_string_free(inc->comment, TRUE);
 
-       if (inc->termination)
-               g_free(inc->termination);
+       g_free(inc->termination);
+       g_free(inc->sample_buffer);
+}
 
-       if (inc->sample_buffer)
-               g_free(inc->sample_buffer);
+static int reset(struct sr_input *in)
+{
+       struct context *inc = in->priv;
 
-       g_free(inc);
-       in->priv = NULL;
+       cleanup(in);
+       inc->started = FALSE;
+       g_string_truncate(in->buf, 0);
 
        return SR_OK;
 }
@@ -770,7 +806,7 @@ static struct sr_option options[] = {
        ALL_ZERO
 };
 
-static struct sr_option *get_options(void)
+static const struct sr_option *get_options(void)
 {
        if (!options[0].def) {
                options[0].def = g_variant_ref_sink(g_variant_new_int32(0));
@@ -778,7 +814,7 @@ static struct sr_option *get_options(void)
                options[2].def = g_variant_ref_sink(g_variant_new_string(","));
                options[3].def = g_variant_ref_sink(g_variant_new_string("bin"));
                options[4].def = g_variant_ref_sink(g_variant_new_string(";"));
-               options[5].def = g_variant_ref_sink(g_variant_new_string("0"));
+               options[5].def = g_variant_ref_sink(g_variant_new_uint64(0));
                options[6].def = g_variant_ref_sink(g_variant_new_int32(0));
                options[7].def = g_variant_ref_sink(g_variant_new_boolean(FALSE));
                options[8].def = g_variant_ref_sink(g_variant_new_int32(1));
@@ -791,10 +827,11 @@ SR_PRIV struct sr_input_module input_csv = {
        .id = "csv",
        .name = "CSV",
        .desc = "Comma-separated values",
-       .metadata = { SR_INPUT_META_MIMETYPE },
+       .exts = (const char*[]){"csv", NULL},
        .options = get_options,
-       .format_match = format_match,
        .init = init,
        .receive = receive,
+       .end = end,
        .cleanup = cleanup,
+       .reset = reset,
 };