* than 0. The default line number to start processing is 1.
*/
+/*
+ * TODO
+ *
+ * - Determine how the text line handling can get improved, regarding
+ * all of robustness and flexibility and correctness.
+ * - The current implementation splits on "any run of CR and LF". Which
+ * translates to: Line numbers are wrong in the presence of empty
+ * lines in the input stream.
+ * - The current implementation insists in the presence of end-of-line
+ * markers on _every_ line in the input stream. "Incomplete" text
+ * files that are so typical on the Windows platform get rejected as
+ * invalid.
+ * - Dropping support for CR style end-of-line markers could improve
+ * the situation a lot. Code could search for and split on LF, and
+ * trim optional trailing CR. This would result in proper support
+ * for CRLF (Windows) as well as LF (Unix), and allow for correct
+ * line number counts.
+ * - When support for CR-only line termination cannot get dropped,
+ * then the current implementation is inappropriate. Currently the
+ * input stream is scanned for the first occurance of either of the
+ * supported termination styles (which is good). For the remaining
+ * session a consistent encoding of the text lines is assumed (which
+ * is acceptable). Potential absence of the terminator for the last
+ * line is orthogonal, and can get handled by a "force" flag when
+ * the end() routine calls the process_buffer() routine.
+ * - When line numbers need to be correct and reliable, _and_ the full
+ * set of previously supported line termination sequences are required,
+ * and potentially more are to get added for improved compatibility
+ * with more platforms or generators, then the current approach of
+ * splitting on runs of termination characters needs to get replaced,
+ * by the more expensive approach to scan for and count the initially
+ * determined termination sequence.
+ *
+ * - Add support for analog input data? (optional)
+ * - Needs a syntax first for user specs which channels (columns) are
+ * logic and which are analog. May need heuristics(?) to guess from
+ * input data in the absence of user provided specs.
+ */
+
/* Single column formats. */
enum {
FORMAT_BIN,
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;
}
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;
}
return SR_OK;
}
+static const char *delim_set = "\r\n";
+
static const char *get_line_termination(GString *buf)
{
const char *term;
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;
}
* 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;
channel_name = g_string_sized_new(64);
for (i = 0; i < inc->num_channels; i++) {
- if (inc->header && inc->multi_column_mode && columns[i][0] != '\0')
- 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, "%u", i);
sr_channel_new(in->sdi, i, SR_CHANNEL_LOGIC, TRUE, channel_name->str);
return ret;
}
+/*
+ * Gets called from initial_receive(), which runs until the end-of-line
+ * encoding of the input stream could get determined. Assumes that this
+ * routine receives enough buffered initial input data to either see the
+ * BOM when there is one, or that no BOM will follow when a text line
+ * termination sequence was seen. Silently drops the UTF-8 BOM sequence
+ * from the input buffer if one was seen. Does not care to protect
+ * against multiple execution or dropping the BOM multiple times --
+ * there should be at most one in the input stream.
+ */
+static void initial_bom_check(const struct sr_input *in)
+{
+ static const char *utf8_bom = "\xef\xbb\xbf";
+
+ if (in->buf->len < strlen(utf8_bom))
+ return;
+ if (strncmp(in->buf->str, utf8_bom, strlen(utf8_bom)) != 0)
+ return;
+ g_string_erase(in->buf, 0, strlen(utf8_bom));
+}
+
static int initial_receive(const struct sr_input *in)
{
struct context *inc;
char *p;
const char *termination;
+ initial_bom_check(in);
+
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_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_ERR_NA;
len = p - in->buf->str - 1;
gsize num_columns;
uint64_t samplerate;
int max_columns, ret, l;
- char *p, **lines, **columns;
+ char *p, **lines, *line, **columns;
inc = in->priv;
if (!inc->started) {
inc->started = TRUE;
}
- if (!(p = g_strrstr_len(in->buf->str, in->buf->len, inc->termination)))
- /* Don't have a full line. */
- return SR_ERR;
-
- *p = '\0';
- g_strstrip(in->buf->str);
-
/* Limit the number of columns to parse. */
if (inc->multi_column_mode)
max_columns = inc->num_channels;
else
max_columns = 1;
+ /*
+ * Consider empty input non-fatal. Keep accumulating input until
+ * at least one full text line has become available. Grab the
+ * maximum amount of accumulated data that consists of full text
+ * lines, and process what has been received so far, leaving not
+ * yet complete lines for the next invocation.
+ */
+ if (!in->buf->len)
+ return SR_OK;
+ p = g_strrstr_len(in->buf->str, in->buf->len, inc->termination);
+ if (!p)
+ return SR_ERR;
+ *p = '\0';
+ p += strlen(inc->termination);
+ g_strstrip(in->buf->str);
+
ret = SR_OK;
- lines = g_strsplit_set(in->buf->str, "\r\n", 0);
+ 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;
}
continue;
}
- if (!(columns = parse_line(lines[l], inc, max_columns))) {
+ columns = parse_line(line, inc, max_columns);
+ if (!columns) {
sr_err("Error while parsing line %zu.", inc->line_number);
return SR_ERR;
}
g_strfreev(columns);
}
g_strfreev(lines);
- g_string_erase(in->buf, 0, p - in->buf->str + 1);
+ g_string_erase(in->buf, 0, p - in->buf->str);
return ret;
}
inc = in->priv;
if (!inc->termination) {
- if ((ret = initial_receive(in)) == SR_ERR_NA)
+ ret = initial_receive(in);
+ if (ret == SR_ERR_NA)
/* Not enough data yet. */
return SR_OK;
else if (ret != SR_OK)
projects / libsigrok.git / blobdiff