2 * A Swiss-Army Knife for CSV-like Files
4 * (c) 2012 Martin Mares <mj@ucw.cz>
20 #define NONRET __attribute__((noreturn))
21 #define UNUSED __attribute__((unused))
27 /*** General functions ***/
29 static void NONRET die(char *msg, ...)
33 fprintf(stderr, "xsv: ");
34 vfprintf(stderr, msg, args);
40 /*** Memory allocation ***/
42 static void *xmalloc(size_t bytes)
44 void *p = malloc(bytes);
46 die("Out of memory (cannot allocate %zu bytes)", bytes);
50 static void *xmalloc_zero(size_t bytes)
52 void *p = xmalloc(bytes);
57 static void *xrealloc(void *old, size_t bytes)
59 void *p = realloc(old, bytes);
61 die("Out of memory (cannot allocate %zu bytes)", bytes);
65 #define DECLARE_BUF(name, type) \
66 typedef struct { type *start; int count; int max; } name##_t; \
67 static inline void name##_init(name##_t *b) { b->start = NULL; b->count = b->max = 0; } \
68 static inline void name##_reset(name##_t *b) { b->count = 0; } \
69 static inline int name##_count(name##_t *b) { return b->count; } \
70 static void name##_extend(name##_t *b) { \
71 b->max = b->max ? 2*b->max : 16; \
72 b->start = xrealloc(b->start, b->max * sizeof(type)); \
74 static inline type *name##_push(name##_t *b) { \
75 if (b->count >= b->max) name##_extend(b); \
76 return &b->start[b->count++]; \
78 static inline type *name##_first(name##_t *b) { return b->start; } \
79 static inline type *name##_nth(name##_t *b, int n) { return &b->start[n]; } \
82 DECLARE_BUF(intarray, int);
83 DECLARE_BUF(stringarray, char *);
85 /*** Formats and their parameters ***/
102 int (*read_line)(struct format *fmt);
103 void (*write_line)(struct format *fmt);
104 void (*write_grid)(struct format *fmt, int pos); // -1=above, 1=below, 0=after header
109 char *set_field_names;
110 struct field_names *field_names;
120 pcre_extra *pcre_extra;
122 // Temporary file backend:
130 static struct format *in_format, *out_format;
131 static int want_trim;
138 DECLARE_BUF(fields, struct field);
139 DECLARE_BUF(line, unsigned char);
141 static fields_t in_fields, out_fields;
142 static struct field *in_field;
143 static line_t in_line;
144 static int line_number;
146 static int read_line(void)
148 fields_reset(&in_fields);
149 line_reset(&in_line);
151 if (!in_format->read_line(in_format))
153 if (ferror_unlocked(stdin))
154 die("I/O error when reading standard input");
158 static void write_line(void)
160 out_format->write_line(out_format);
161 if (ferror_unlocked(stdout))
162 die("I/O error when writing standard input");
165 static void write_grid(int pos)
167 if (out_format->write_grid) {
168 out_format->write_grid(out_format, pos);
169 if (ferror_unlocked(stdout))
170 die("I/O error when writing standard input");
174 static void new_field(int pos)
176 in_field = fields_push(&in_fields);
177 in_field->start_pos = pos;
181 static void ensure_field(int pos)
187 // FIXME: Use elsewhere
188 static unsigned char *get_field(fields_t *fields, int i, int *len)
190 struct field *f = fields_nth(fields, i);
192 return line_nth(&in_line, f->start_pos);
195 static void warn(struct format *fmt, char *msg, ...)
198 fprintf(stderr, "Warning at line %d: ", line_number);
201 vfprintf(stderr, msg, args);
207 static int next_line(void)
210 int c = getchar_unlocked();
214 return !!line_count(&in_line);
217 *line_push(&in_line) = c;
221 static int field_chars(struct field *f)
223 unsigned char *s = line_nth(&in_line, f->start_pos);
226 memset(&mbs, 0, sizeof(mbs));
230 size_t k = mbrlen((char *) s + i, f->len - i, &mbs);
240 /*** Field statistics ***/
242 static intarray_t column_widths;
244 static void update_stats(void)
246 for (int i = 0; i < fields_count(&out_fields); i++) {
247 struct field *f = fields_nth(&out_fields, i);
248 intarray_t *w = &column_widths;
250 while (i >= intarray_count(w))
251 *intarray_push(w) = 0;
252 int fw = field_chars(f);
253 if (*intarray_nth(w, i) < fw)
254 *intarray_nth(w, i) = fw;
258 /*** CSV/TSV back-end */
260 static int csv_read(struct format *fmt)
264 int c = getchar_unlocked();
265 int i = line_count(&in_line);
269 if (c < 0 || c == '\n') {
271 warn(fmt, "Missing closing quote.");
273 return !!fields_count(&in_fields);
278 if (c == fmt->quote) {
279 c = getchar_unlocked();
280 if (c != fmt->quote) {
284 // Two quotes assimilate to one
286 // Fall through to pushing the character
287 } else if (c == fmt->quote) {
290 } else if (c == fmt->fs && !quoted) {
296 *line_push(&in_line) = c;
301 static int is_ws(int c)
303 return (c == ' ' || c == '\t' || c == '\f');
306 static void csv_write(struct format *fmt)
308 unsigned char *line = line_first(&in_line);
309 int n = fields_count(&out_fields);
310 for (int i=0; i<n; i++) {
311 struct field *f = fields_nth(&out_fields, i);
313 if (fmt->quote >= 0) {
314 need_quotes = fmt->always_quote;
315 for (int j=0; !need_quotes && j < f->len; j++) {
316 int c = line[f->start_pos + j];
317 if (c == fmt->fs || c == fmt->quote)
322 putchar_unlocked(fmt->fs);
324 putchar_unlocked(fmt->quote);
325 for (int j=0; j < f->len; j++) {
326 int c = line[f->start_pos + j];
327 if (c == fmt->fs && !need_quotes)
328 warn(fmt, "Field separator found inside field and quoting is turned off.");
334 putchar_unlocked(fmt->quote);
336 putchar_unlocked('\n');
339 /*** White-space back-end ***/
341 static int ws_read(struct format *fmt)
346 unsigned char *line = line_first(&in_line);
347 int n = line_count(&in_line);
353 for (int i=0; i<n; i++) {
359 if (!in_field->start_pos &&
362 in_field->start_pos = i;
371 if (ws && fmt->strict_ws)
376 /*** Regex back-end ***/
378 static const char *regex_set(struct format *f, char *rx)
382 f->pcre = pcre_compile(rx, PCRE_DOLLAR_ENDONLY, &err, &errpos, NULL);
386 f->pcre_extra = pcre_study(f->pcre, 0, &err);
393 static int regex_read(struct format *fmt)
398 unsigned char *c = line_first(&in_line);
399 int n = line_count(&in_line);
406 int sep = pcre_exec(fmt->pcre, fmt->pcre_extra, (char *) c, n, i, 0, ovec, 3);
408 if (sep != PCRE_ERROR_NOMATCH)
409 warn(fmt, "PCRE matching error %d", sep);
410 // No further occurrence of the separator: the rest is a single field
412 in_field->len = n - i;
416 in_field->len = ovec[0] - i;
421 /*** Table back-end ***/
423 static void table_write(struct format *fmt)
425 for (int i = 0; i < intarray_count(&column_widths); i++) {
426 if (fmt->table_grid) {
427 putchar_unlocked('|');
428 printf("%*s", fmt->table_sep / 2, "");
430 printf("%*s", fmt->table_sep, "");
432 int cw = *intarray_nth(&column_widths, i);
434 if (i < fields_count(&out_fields)) {
436 unsigned char *p = get_field(&out_fields, i, &len);
437 fw = field_chars(fields_nth(&out_fields, i));
439 warn(fmt, "Internal error: Wrongly calculated column width (%d > %d)", fw, cw);
446 putchar_unlocked(' ');
451 printf("%*s", fmt->table_sep - fmt->table_sep / 2, "");
455 putchar_unlocked('|');
456 putchar_unlocked('\n');
459 static void table_write_grid(struct format *fmt, int pos UNUSED)
461 if (!fmt->table_grid)
464 for (int i = 0; i < intarray_count(&column_widths); i++) {
465 putchar_unlocked('+');
466 int w = fmt->table_sep + *intarray_nth(&column_widths, i); // FIXME: Avoid the *
470 putchar_unlocked('+');
471 putchar_unlocked('\n');
474 /*** Temporary file back-end ***/
476 static int tmp_read(struct format *fmt)
478 FILE *tf = fmt->tmp_file;
481 int c = getc_unlocked(tf);
487 c = getc_unlocked(tf);
488 c = (c << 8) | getc_unlocked(tf);
489 c = (c << 8) | getc_unlocked(tf);
490 c = (c << 8) | getc_unlocked(tf);
492 new_field(line_count(&in_line));
495 int x = getc_unlocked(tf);
497 warn(fmt, "Truncated temporary file");
500 *line_push(&in_line) = x;
504 if (ferror_unlocked(tf))
505 die("I/O error when reading temporary file");
508 static void tmp_write(struct format *fmt)
510 FILE *tf = fmt->tmp_file;
512 for (int i = 0; i < fields_count(&out_fields); i++) {
513 struct field *f = fields_nth(&out_fields, i);
515 putc_unlocked(f->len, tf);
517 putc_unlocked(0xfe, tf);
518 putc_unlocked((f->len >> 24) & 0xff, tf);
519 putc_unlocked((f->len >> 16) & 0xff, tf);
520 putc_unlocked((f->len >> 8) & 0xff, tf);
521 putc_unlocked(f->len & 0xff, tf);
524 unsigned char *p = line_nth(&in_line, f->start_pos);
525 for (int j = 0; j < f->len; j++)
526 putc_unlocked(*p++, tf);
528 putc_unlocked(0xff, tf);
530 if (ferror_unlocked(tf))
531 die("I/O error when writing temporary file");
536 static void trim_fields(void)
538 unsigned char *line = line_first(&in_line);
539 for (int i = 0; i < fields_count(&in_fields); i++) {
540 struct field *f = fields_nth(&in_fields, i);
541 while (f->len && is_ws(line[f->start_pos]))
542 f->start_pos++, f->len--;
543 while (f->len && is_ws(line[f->start_pos + f->len - 1]))
548 /*** Field names and headers ***/
554 static void add_field(struct field_names *fn, char *name, int namelen)
556 char *n = xmalloc(namelen + 1);
557 memcpy(n, name, namelen);
559 *stringarray_push(&fn->names) = n;
562 static void add_field_names(struct field_names *fn, char *names)
566 char *q = strchr(p, ',');
567 int len = q ? q-p : (int) strlen(p);
568 add_field(fn, p, len);
573 static void read_header(void)
575 if (!(in_format->has_header || in_format->set_field_names))
578 struct field_names *fn = xmalloc_zero(sizeof(*fn));
579 in_format->field_names = fn;
581 if (in_format->has_header) {
583 die("Missing input header");
586 if (in_format->set_field_names) {
587 add_field_names(fn, in_format->set_field_names);
589 for (int i = 0; i < fields_count(&in_fields); i++) {
591 char *s = (char *) get_field(&in_fields, i, &len);
592 add_field(fn, s, len);
597 static void write_header(void)
599 if (!out_format->has_header) {
604 if (out_format->set_field_names) {
605 struct field_names *fn = xmalloc_zero(sizeof(*fn));
606 out_format->field_names = fn;
607 add_field_names(fn, out_format->set_field_names);
608 } else if (in_format->field_names)
609 out_format->field_names = in_format->field_names;
611 die("Output header requested, but no field names specified");
613 line_reset(&in_line);
614 fields_reset(&out_fields);
615 struct field_names *fn = out_format->field_names;
616 for (int i = 0; i < stringarray_count(&fn->names); i++) {
617 struct field *f = fields_push(&out_fields);
618 f->start_pos = line_count(&in_line);
620 char *s = *stringarray_nth(&fn->names, i);
622 *line_push(&in_line) = *s++;
627 // This is tricky: when we are formatting a table, field names are normally
628 // calculated in pass 1, but the header is written in pass 2, so we have to
629 // update column statistics, because field name can be too wide to fit.
636 static void write_footer(void)
641 static int find_field_by_name(struct field_names *fn, char *name)
643 for (int i = 0; i < stringarray_count(&fn->names); i++)
644 if (!strcmp(*stringarray_nth(&fn->names, i), name))
649 /*** Field selection ***/
652 int first_field, last_field; // 0 means "boundary"
655 DECLARE_BUF(selectors, struct selector);
656 static selectors_t selectors;
658 static int parse_field_num(char *str)
663 if (*str < '0' || *str > '9')
667 f = 10*f + *str - '0';
673 static int parse_field(char *str)
678 int f = parse_field_num(str);
682 if (in_format->field_names && (f = find_field_by_name(in_format->field_names, str)) > 0)
685 die("Unknown field %s", str);
688 static char *parse_selector(char *str)
690 char buf[strlen(str) + 1];
693 struct selector *s = selectors_push(&selectors);
694 char *sep = strchr(buf, '-');
697 s->first_field = parse_field(buf);
698 s->last_field = parse_field(sep);
700 s->first_field = s->last_field = parse_field(buf);
705 static void finish_parse_selectors(void)
707 if (!selectors_count(&selectors))
711 static void select_fields(void)
713 for (int i = 0; i < selectors_count(&selectors); i++) {
714 struct selector *s = selectors_nth(&selectors, i);
715 int first = s->first_field;
718 int last = s->last_field;
720 last = fields_count(&in_fields);
721 for (int j = first; j <= last; j++) {
722 struct field *f = fields_push(&out_fields);
723 if (j >= 1 && j <= fields_count(&in_fields))
724 *f = *fields_nth(&in_fields, j-1);
726 f->start_pos = f->len = 0;
731 static void select_all_fields(void)
733 for (int i = 0; i < fields_count(&in_fields); i++)
734 *fields_push(&out_fields) = *fields_nth(&in_fields, i);
737 /*** Processing of files ***/
739 static void one_pass(int pass)
749 if (want_trim && (pass & 1))
752 fields_reset(&out_fields);
758 if (out_format->needs_stats)
768 static void two_pass(void)
770 struct format *final_format = out_format;
772 // We need to use character set info from the current locale
773 setlocale(LC_CTYPE, "");
775 // Pass 1: Set up writer of intermediate format
776 out_format = xmalloc_zero(sizeof(*out_format));
777 out_format->id = FORM_TMP;
778 out_format->read_line = tmp_read;
779 out_format->write_line = tmp_write;
780 out_format->tmp_file = tmpfile();
781 out_format->needs_stats = final_format->needs_stats;
782 out_format->field_names = in_format->field_names;
785 // Pass 2: Set up reader of intermediate format
786 in_format = out_format;
787 rewind(in_format->tmp_file);
789 out_format = final_format;
790 out_format->needs_stats = 0;
792 fclose(in_format->tmp_file);
795 /*** Parsing of arguments ***/
797 static void NONRET usage(void)
800 Usage: xsv <in-format> [<out-format>] <options> [<fields>]\n\
803 -t, --tsv TAB-separated values (default)\n\
804 -c, --csv Comma-separated values\n\
805 -w, --ws Values separated by arbitrary whitespace\n\
806 -W, --strict-ws Like --ws, but recognize empty columns at start/end\n\
807 -r, --regex=<rx> Separator given by Perl regular expression (input only)\n\
808 --table Format a table (output only)\n\
810 Format parameters:\n\
811 -d, --fs=<char> Delimiter of fields\n\
812 -f, --fields=<f>,... Set field names\n\
813 -h, --header The first line contains field names\n\
814 -q, --quiet Do not show warnings\n\
815 --always-quote Put quotes around all fields (CSV output only)\n\
816 --table-sep=<n> Separate table columns by <n> spaces (default: 2)\n\
817 --grid Separate table columns by grid lines\n\
820 --trim Trim leading and trailing whitespaces in fields\n\
825 static void NONRET bad_args(const char *msg, ...)
830 fprintf(stderr, "xsv: ");
831 vfprintf(stderr, msg, args);
835 fprintf(stderr, "Try `xsv --help' for more information.\n");
839 static const char short_options[] = "cd:f:hqr:twW";
850 static const struct option long_options[] = {
851 { "always-quote", 0, NULL, OPT_ALWAYS_QUOTE },
852 { "csv", 0, NULL, 'c' },
853 { "fields", 1, NULL, 'f' },
854 { "fs", 1, NULL, 'd' },
855 { "grid", 0, NULL, OPT_GRID },
856 { "header", 0, NULL, 'h' },
857 { "quiet", 0, NULL, 'q' },
858 { "regex", 1, NULL, 'r' },
859 { "strict-ws", 0, NULL, 'W' },
860 { "table", 0, NULL, OPT_TABLE },
861 { "table-sep", 1, NULL, OPT_TABLE_SEP },
862 { "trim", 0, NULL, OPT_TRIM },
863 { "tsv", 0, NULL, 't' },
864 { "ws", 0, NULL, 'w' },
865 { "help", 0, NULL, OPT_HELP },
866 { NULL, 0, NULL, 0 },
869 static void set_format(int format_id)
871 struct format *f = xmalloc_zero(sizeof(*f));
878 f->read_line = csv_read;
879 f->write_line = csv_write;
884 f->read_line = csv_read;
885 f->write_line = csv_write;
890 f->read_line = ws_read;
891 f->write_line = csv_write;
894 f->read_line = regex_read;
897 f->write_line = table_write;
898 f->write_grid = table_write_grid;
906 else if (!out_format)
909 bad_args("At most two formats may be given.");
912 static struct format *current_format(void)
918 set_format(FORM_TSV);
922 int main(int argc, char **argv)
927 while ((opt = getopt_long(argc, argv, short_options, long_options, NULL)) >= 0)
930 set_format(FORM_CSV);
934 current_format()->fs = optarg[0];
936 bad_args("No field delimiter given.");
939 current_format()->set_field_names = optarg;
942 current_format()->has_header = 1;
945 current_format()->quiet = 1;
948 set_format(FORM_REGEX);
949 err = regex_set(current_format(), optarg);
951 bad_args("Error compiling regex: %s", err);
954 set_format(FORM_TSV);
961 current_format()->strict_ws = 1;
963 case OPT_ALWAYS_QUOTE:
964 if (current_format()->id != FORM_CSV)
965 bad_args("--always-quote makes sense only for CSV.");
966 current_format()->always_quote = 1;
974 set_format(FORM_TABLE);
977 current_format()->table_sep = atoi(optarg);
980 current_format()->table_grid = 1;
988 out_format = in_format;
989 if (!in_format->read_line)
990 bad_args("Write-only format selected for input.");
991 if (!out_format->write_line)
992 bad_args("Read-only format selected for output.");
995 for (int i = optind; i < argc; i++) {
996 err = parse_selector(argv[i]);
1000 finish_parse_selectors();
1002 if (out_format->needs_stats)