X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Finput%2Fcsv.c;h=6d3264902362f04363deb6e2b28e7c22748cf82c;hb=19267272d39e3ff16874f538b22b407ff242e87c;hp=93288973b685c330c17c4495fe5a8e5b3ffe6201;hpb=e05f18273d0a8bef34060ff539aa2cdc591be559;p=libsigrok.git diff --git a/src/input/csv.c b/src/input/csv.c index 93288973..6d326490 100644 --- a/src/input/csv.c +++ b/src/input/csv.c @@ -105,10 +105,10 @@ */ /* Single column formats. */ -enum { +enum single_col_format { FORMAT_BIN, FORMAT_HEX, - FORMAT_OCT + FORMAT_OCT, }; struct context { @@ -118,7 +118,7 @@ struct context { uint64_t samplerate; /* Number of channels. */ - unsigned int num_channels; + size_t num_channels; /* Column delimiter character(s). */ GString *delimiter; @@ -133,20 +133,20 @@ struct context { gboolean multi_column_mode; /* Column number of the sample data in single column mode. */ - unsigned int single_column; + size_t 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. */ - unsigned int first_column; + size_t 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. */ - unsigned int first_channel; + size_t first_channel; /* Line number to start processing. */ size_t start_line; @@ -158,7 +158,7 @@ struct context { gboolean header; /* Format sample data is stored in single column mode. */ - int format; + enum single_col_format format; size_t sample_unit_size; /**!< Byte count for a single sample. */ uint8_t *sample_buffer; /**!< Buffer for a single sample. */ @@ -174,6 +174,12 @@ struct context { GSList *prev_sr_channels; }; +/* + * Primitive operations for text input: Strip comments off text lines. + * Split text lines into columns. Process input text for individual + * columns. + */ + static void strip_comment(char *buf, const GString *prefix) { char *ptr; @@ -181,10 +187,26 @@ static void strip_comment(char *buf, const GString *prefix) if (!prefix->len) return; - if ((ptr = strstr(buf, prefix->str))) + if ((ptr = strstr(buf, prefix->str))) { *ptr = '\0'; + g_strstrip(buf); + } } +/* TODO Move parse_line() here. */ + +/** + * @brief Parse a text field into multiple bits, binary presentation. + * + * @param[in] str The input text, a run of 0/1 digits. + * @param[in] inc The input module's context. + * + * @retval SR_OK Success. + * @retval SR_ERR Invalid input data (empty, or format error). + * + * This routine modifies the logic levels in the current sample set, + * based on the text input which consists of binary digits. + */ static int parse_binstr(const char *str, struct context *inc) { gsize i, j, length; @@ -192,7 +214,7 @@ static int parse_binstr(const char *str, struct context *inc) length = strlen(str); if (!length) { - sr_err("Column %u in line %zu is empty.", inc->single_column, + sr_err("Column %zu in line %zu is empty.", inc->single_column, inc->line_number); return SR_ERR; } @@ -206,7 +228,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 %u in line %zu.", + sr_err("Invalid value '%s' in column %zu in line %zu.", str, inc->single_column, inc->line_number); return SR_ERR; } @@ -215,6 +237,18 @@ static int parse_binstr(const char *str, struct context *inc) return SR_OK; } +/** + * @brief Parse a text field into multiple bits, hexadecimal presentation. + * + * @param[in] str The input text, a run of hex digits. + * @param[in] inc The input module's context. + * + * @retval SR_OK Success. + * @retval SR_ERR Invalid input data (empty, or format error). + * + * This routine modifies the logic levels in the current sample set, + * based on the text input which consists of hexadecimal digits. + */ static int parse_hexstr(const char *str, struct context *inc) { gsize i, j, k, length; @@ -224,7 +258,7 @@ static int parse_hexstr(const char *str, struct context *inc) length = strlen(str); if (!length) { - sr_err("Column %u in line %zu is empty.", inc->single_column, + sr_err("Column %zu in line %zu is empty.", inc->single_column, inc->line_number); return SR_ERR; } @@ -239,7 +273,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 %u in line %zu.", + sr_err("Invalid value '%s' in column %zu in line %zu.", str, inc->single_column, inc->line_number); return SR_ERR; } @@ -259,6 +293,18 @@ static int parse_hexstr(const char *str, struct context *inc) return SR_OK; } +/** + * @brief Parse a text field into multiple bits, octal presentation. + * + * @param[in] str The input text, a run of oct digits. + * @param[in] inc The input module's context. + * + * @retval SR_OK Success. + * @retval SR_ERR Invalid input data (empty, or format error). + * + * This routine modifies the logic levels in the current sample set, + * based on the text input which consists of octal digits. + */ static int parse_octstr(const char *str, struct context *inc) { gsize i, j, k, length; @@ -268,7 +314,7 @@ static int parse_octstr(const char *str, struct context *inc) length = strlen(str); if (!length) { - sr_err("Column %u in line %zu is empty.", inc->single_column, + sr_err("Column %zu in line %zu is empty.", inc->single_column, inc->line_number); return SR_ERR; } @@ -283,7 +329,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 %u in line %zu.", + sr_err("Invalid value '%s' in column %zu in line %zu.", str, inc->single_column, inc->line_number); return SR_ERR; } @@ -303,54 +349,93 @@ static int parse_octstr(const char *str, struct context *inc) return SR_OK; } -static char **parse_line(char *buf, struct context *inc, int max_columns) +static int parse_single_column(const char *column, struct context *inc) +{ + switch (inc->format) { + case FORMAT_BIN: + return parse_binstr(column, inc); + case FORMAT_HEX: + return parse_hexstr(column, inc); + case FORMAT_OCT: + return parse_octstr(column, inc); + } + + return SR_ERR; +} + +/** + * @brief Splits a text line into a set of columns. + * + * @param[in] buf The input text line to split. + * @param[in] inc The input module's context. + * @param[in] max_cols The maximum column count, negative to get all of them. + * + * @returns An array of strings, representing the columns' text. + * + * This routine splits a text line on previously determined separators. + * A previously determined set of columns gets isolated (starting at a + * first position and spanning a given number of columns). A negative + * value for the maximum number of columns results in no restriction on + * the result set's length (the first columns still get trimmed off). + */ +static char **parse_line(char *buf, struct context *inc, ssize_t max_cols) { const char *str, *remainder; GSList *list, *l; char **columns; char *column; - gsize n, k; + gsize seen, taken; - n = 0; - k = 0; + seen = 0; + taken = 0; list = NULL; remainder = buf; str = strstr(remainder, inc->delimiter->str); - - while (str && max_columns) { - if (n >= inc->first_column) { + while (str && max_cols) { + if (seen >= inc->first_column) { column = g_strndup(remainder, str - remainder); list = g_slist_prepend(list, g_strstrip(column)); - max_columns--; - k++; + max_cols--; + taken++; } remainder = str + inc->delimiter->len; str = strstr(remainder, inc->delimiter->str); - n++; + seen++; } - if (buf[0] && max_columns && n >= inc->first_column) { + if (buf[0] && max_cols && seen >= inc->first_column) { column = g_strdup(remainder); list = g_slist_prepend(list, g_strstrip(column)); - k++; + taken++; } - if (!(columns = g_try_new(char *, k + 1))) + if (!(columns = g_try_new(char *, taken + 1))) return NULL; - - columns[k--] = NULL; - + columns[taken--] = NULL; for (l = list; l; l = l->next) - columns[k--] = l->data; + columns[taken--] = l->data; g_slist_free(list); return columns; } +/** + * @brief Picks logic levels from multiple binary colomns, one channel per column. + * + * @param[in] columns The text fields which are kept in the columns. + * @param[in] inc The input module's context. + * + * @retval SR_OK Success. + * @retval SR_ERR Insufficient input, or syntax errors. + * + * This routine exclusively handles binary input where one logic channel + * occupies one column each. All channels are expected to reside in one + * consequtive run of columns. + */ static int parse_multi_columns(char **columns, struct context *inc) { gsize i; @@ -378,27 +463,6 @@ static int parse_multi_columns(char **columns, struct context *inc) return SR_OK; } -static int parse_single_column(const char *column, struct context *inc) -{ - int res; - - res = SR_ERR; - - switch (inc->format) { - case FORMAT_BIN: - res = parse_binstr(column, inc); - break; - case FORMAT_HEX: - res = parse_hexstr(column, inc); - break; - case FORMAT_OCT: - res = parse_octstr(column, inc); - break; - } - - return res; -} - static int flush_samples(const struct sr_input *in) { struct context *inc; @@ -451,10 +515,10 @@ static int init(struct sr_input *in, GHashTable *options) 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")); + inc->single_column = g_variant_get_uint32(g_hash_table_lookup(options, "single-column")); inc->multi_column_mode = inc->single_column == 0; - inc->num_channels = g_variant_get_int32(g_hash_table_lookup(options, "numchannels")); + inc->num_channels = g_variant_get_uint32(g_hash_table_lookup(options, "numchannels")); inc->delimiter = g_string_new(g_variant_get_string( g_hash_table_lookup(options, "delimiter"), NULL)); @@ -486,11 +550,11 @@ static int init(struct sr_input *in, GHashTable *options) 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")); + inc->first_channel = g_variant_get_uint32(g_hash_table_lookup(options, "first-channel")); inc->header = g_variant_get_boolean(g_hash_table_lookup(options, "header")); - inc->start_line = g_variant_get_int32(g_hash_table_lookup(options, "startline")); + inc->start_line = g_variant_get_uint32(g_hash_table_lookup(options, "startline")); if (inc->start_line < 1) { sr_err("Invalid start line %zu.", inc->start_line); return SR_ERR_ARG; @@ -568,7 +632,7 @@ static int initial_parse(const struct sr_input *in, GString *buf) { struct context *inc; GString *channel_name; - unsigned int num_columns, i; + size_t num_columns, i; size_t line_number, l; int ret; char **lines, *line, **columns, *column; @@ -619,7 +683,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 %u in line %zu is out of bounds.", + sr_err("Column %zu in line %zu is out of bounds.", inc->first_column, line_number); ret = SR_ERR; goto out; @@ -632,7 +696,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: %u.", + sr_dbg("Number of auto-detected channels: %zu.", inc->num_channels); } @@ -654,7 +718,7 @@ static int initial_parse(const struct sr_input *in, GString *buf) if (inc->header && inc->multi_column_mode && column[0] != '\0') g_string_assign(channel_name, column); else - g_string_printf(channel_name, "%u", i); + g_string_printf(channel_name, "%zu", i); sr_channel_new(in->sdi, i, SR_CHANNEL_LOGIC, TRUE, channel_name->str); } g_string_free(channel_name, TRUE); @@ -751,7 +815,8 @@ static int process_buffer(struct sr_input *in, gboolean is_eof) struct context *inc; gsize num_columns; uint64_t samplerate; - int max_columns, ret, l; + size_t max_columns, l; + int ret; char *p, **lines, *line, **columns; inc = in->priv; @@ -836,7 +901,7 @@ static int process_buffer(struct sr_input *in, gboolean is_eof) } num_columns = g_strv_length(columns); if (!num_columns) { - sr_err("Column %u in line %zu is out of bounds.", + sr_err("Column %zu in line %zu is out of bounds.", inc->first_column, inc->line_number); g_strfreev(columns); g_strfreev(lines); @@ -955,17 +1020,30 @@ static int reset(struct sr_input *in) return SR_OK; } +enum option_index { + OPT_SINGLE_COL, + OPT_NUM_LOGIC, + OPT_DELIM, + OPT_FORMAT, + OPT_COMMENT, + OPT_RATE, + OPT_FIRST_LOGIC, + OPT_HEADER, + OPT_START, + OPT_MAX, +}; + static struct sr_option options[] = { - { "single-column", "Single column", "Enable single-column mode, using the specified column (>= 1); 0: multi-col. mode", NULL, NULL }, - { "numchannels", "Number of logic channels", "The number of (logic) channels (single-col. mode: number of bits beginning at 'first channel', LSB-first)", NULL, NULL }, - { "delimiter", "Column delimiter", "The column delimiter (>= 1 characters)", NULL, NULL }, - { "format", "Data format (single-col. mode)", "The numeric format of the data (single-col. mode): bin, hex, oct", NULL, NULL }, - { "comment", "Comment character(s)", "The comment prefix character(s)", NULL, NULL }, - { "samplerate", "Samplerate (Hz)", "The sample rate (used during capture) in Hz", NULL, NULL }, - { "first-channel", "First channel", "The column number of the first channel (multi-col. mode); bit position for the first channel (single-col. mode)", NULL, NULL }, - { "header", "Interpret first line as header (multi-col. mode)", "Treat the first line as header with channel names (multi-col. mode)", NULL, NULL }, - { "startline", "Start line", "The line number at which to start processing samples (>= 1)", NULL, NULL }, - ALL_ZERO + [OPT_SINGLE_COL] = { "single-column", "Single column", "Enable single-column mode, using the specified column (>= 1); 0: multi-col. mode", NULL, NULL }, + [OPT_NUM_LOGIC] = { "numchannels", "Number of logic channels", "The number of (logic) channels (single-col. mode: number of bits beginning at 'first channel', LSB-first)", NULL, NULL }, + [OPT_DELIM] = { "delimiter", "Column delimiter", "The column delimiter (>= 1 characters)", NULL, NULL }, + [OPT_FORMAT] = { "format", "Data format (single-col. mode)", "The numeric format of the data (single-col. mode): bin, hex, oct", NULL, NULL }, + [OPT_COMMENT] = { "comment", "Comment character(s)", "The comment prefix character(s)", NULL, NULL }, + [OPT_RATE] = { "samplerate", "Samplerate (Hz)", "The sample rate (used during capture) in Hz", NULL, NULL }, + [OPT_FIRST_LOGIC] = { "first-channel", "First channel", "The column number of the first channel (multi-col. mode); bit position for the first channel (single-col. mode)", NULL, NULL }, + [OPT_HEADER] = { "header", "Interpret first line as header (multi-col. mode)", "Treat the first line as header with channel names (multi-col. mode)", NULL, NULL }, + [OPT_START] = { "startline", "Start line", "The line number at which to start processing samples (>= 1)", NULL, NULL }, + [OPT_MAX] = ALL_ZERO, }; static const struct sr_option *get_options(void) @@ -973,20 +1051,20 @@ static const struct sr_option *get_options(void) GSList *l; if (!options[0].def) { - options[0].def = g_variant_ref_sink(g_variant_new_int32(0)); - options[1].def = g_variant_ref_sink(g_variant_new_int32(0)); - options[2].def = g_variant_ref_sink(g_variant_new_string(",")); - options[3].def = g_variant_ref_sink(g_variant_new_string("bin")); + options[OPT_SINGLE_COL].def = g_variant_ref_sink(g_variant_new_int32(0)); + options[OPT_NUM_LOGIC].def = g_variant_ref_sink(g_variant_new_int32(0)); + options[OPT_DELIM].def = g_variant_ref_sink(g_variant_new_string(",")); + options[OPT_FORMAT].def = g_variant_ref_sink(g_variant_new_string("bin")); l = NULL; l = g_slist_append(l, g_variant_ref_sink(g_variant_new_string("bin"))); l = g_slist_append(l, g_variant_ref_sink(g_variant_new_string("hex"))); l = g_slist_append(l, g_variant_ref_sink(g_variant_new_string("oct"))); - options[3].values = l; - options[4].def = g_variant_ref_sink(g_variant_new_string(";")); - 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)); + options[OPT_FORMAT].values = l; + options[OPT_COMMENT].def = g_variant_ref_sink(g_variant_new_string(";")); + options[OPT_RATE].def = g_variant_ref_sink(g_variant_new_uint64(0)); + options[OPT_FIRST_LOGIC].def = g_variant_ref_sink(g_variant_new_int32(0)); + options[OPT_HEADER].def = g_variant_ref_sink(g_variant_new_boolean(FALSE)); + options[OPT_START].def = g_variant_ref_sink(g_variant_new_int32(1)); } return options;