Update GPG key for signing flatpaks.
[pspp] / data / sys-file-writer.c
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 1997-9, 2000, 2006, 2007 Free Software Foundation, Inc.
3
4    This program is free software: you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation, either version 3 of the License, or
7    (at your option) any later version.
8
9    This program is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12    GNU General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
16
17 #include <config.h>
18
19 #include "sys-file-writer.h"
20 #include "sys-file-private.h"
21
22 #include <ctype.h>
23 #include <errno.h>
24 #include <stdint.h>
25 #include <stdlib.h>
26 #include <sys/stat.h>
27 #include <time.h>
28
29 #include <libpspp/float-format.h>
30 #include <libpspp/integer-format.h>
31 #include <libpspp/message.h>
32 #include <libpspp/misc.h>
33 #include <libpspp/str.h>
34 #include <libpspp/version.h>
35
36 #include <data/case.h>
37 #include <data/casewriter-provider.h>
38 #include <data/casewriter.h>
39 #include <data/dictionary.h>
40 #include <data/file-handle-def.h>
41 #include <data/file-name.h>
42 #include <data/format.h>
43 #include <data/make-file.h>
44 #include <data/missing-values.h>
45 #include <data/settings.h>
46 #include <data/short-names.h>
47 #include <data/value-labels.h>
48 #include <data/variable.h>
49
50 #include "minmax.h"
51 #include "unlocked-io.h"
52 #include "xalloc.h"
53
54 #include "gettext.h"
55 #define _(msgid) gettext (msgid)
56 #define N_(msgid) (msgid)
57
58 /* Compression bias used by PSPP.  Values between (1 -
59    COMPRESSION_BIAS) and (251 - COMPRESSION_BIAS) inclusive can be
60    compressed. */
61 #define COMPRESSION_BIAS 100
62
63 /* System file writer. */
64 struct sfm_writer
65   {
66     struct file_handle *fh;     /* File handle. */
67     struct fh_lock *lock;       /* Mutual exclusion for file. */
68     FILE *file;                 /* File stream. */
69     struct replace_file *rf;    /* Ticket for replacing output file. */
70
71     bool compress;              /* 1=compressed, 0=not compressed. */
72     casenumber case_cnt;        /* Number of cases written so far. */
73
74     /* Compression buffering.
75
76        Compressed data is output as groups of 8 1-byte opcodes
77        followed by up to 8 (depending on the opcodes) 8-byte data
78        items.  Data items and opcodes arrive at the same time but
79        must be reordered for writing to disk, thus a small amount
80        of buffering here. */
81     uint8_t opcodes[8];         /* Buffered opcodes. */
82     int opcode_cnt;             /* Number of buffered opcodes. */
83     uint8_t data[8][8];         /* Buffered data. */
84     int data_cnt;               /* Number of buffered data items. */
85
86     /* Variables. */
87     struct sfm_var *sfm_vars;   /* Variables. */
88     size_t sfm_var_cnt;         /* Number of variables. */
89     size_t segment_cnt;         /* Number of variables including extra segments
90                                    for long string variables. */
91   };
92
93 static const struct casewriter_class sys_file_casewriter_class;
94
95 static void write_header (struct sfm_writer *, const struct dictionary *);
96 static void write_variable (struct sfm_writer *, const struct variable *);
97 static void write_value_labels (struct sfm_writer *,
98                                 struct variable *, int idx);
99 static void write_integer_info_record (struct sfm_writer *);
100 static void write_float_info_record (struct sfm_writer *);
101
102 static void write_longvar_table (struct sfm_writer *w,
103                                  const struct dictionary *dict);
104
105 static void write_vls_length_table (struct sfm_writer *w,
106                               const struct dictionary *dict);
107
108
109 static void write_variable_display_parameters (struct sfm_writer *w,
110                                                const struct dictionary *dict);
111
112 static void write_documents (struct sfm_writer *, const struct dictionary *);
113
114 static void write_int (struct sfm_writer *, int32_t);
115 static inline void convert_double_to_output_format (double, uint8_t[8]);
116 static void write_float (struct sfm_writer *, double);
117 static void write_string (struct sfm_writer *, const char *, size_t);
118 static void write_bytes (struct sfm_writer *, const void *, size_t);
119 static void write_zeros (struct sfm_writer *, size_t);
120 static void write_spaces (struct sfm_writer *, size_t);
121 static void write_value (struct sfm_writer *, const union value *, int width);
122
123 static void write_case_uncompressed (struct sfm_writer *, struct ccase *);
124 static void write_case_compressed (struct sfm_writer *, struct ccase *);
125 static void flush_compressed (struct sfm_writer *);
126 static void put_cmp_opcode (struct sfm_writer *, uint8_t);
127 static void put_cmp_number (struct sfm_writer *, double);
128 static void put_cmp_string (struct sfm_writer *, const void *, size_t);
129
130 bool write_error (const struct sfm_writer *);
131 bool close_writer (struct sfm_writer *);
132
133 /* Returns default options for writing a system file. */
134 struct sfm_write_options
135 sfm_writer_default_options (void)
136 {
137   struct sfm_write_options opts;
138   opts.create_writeable = true;
139   opts.compress = settings_get_scompression ();
140   opts.version = 3;
141   return opts;
142 }
143
144 /* Opens the system file designated by file handle FH for writing
145    cases from dictionary D according to the given OPTS.  If
146    COMPRESS is nonzero, the system file will be compressed.
147
148    No reference to D is retained, so it may be modified or
149    destroyed at will after this function returns.  D is not
150    modified by this function, except to assign short names. */
151 struct casewriter *
152 sfm_open_writer (struct file_handle *fh, struct dictionary *d,
153                  struct sfm_write_options opts)
154 {
155   struct sfm_writer *w;
156   mode_t mode;
157   int idx;
158   int i;
159
160   /* Check version. */
161   if (opts.version != 2 && opts.version != 3)
162     {
163       msg (ME, _("Unknown system file version %d. Treating as version %d."),
164            opts.version, 3);
165       opts.version = 3;
166     }
167
168   /* Create and initialize writer. */
169   w = xmalloc (sizeof *w);
170   w->fh = fh_ref (fh);
171   w->lock = NULL;
172   w->file = NULL;
173   w->rf = NULL;
174
175   w->compress = opts.compress;
176   w->case_cnt = 0;
177
178   w->opcode_cnt = w->data_cnt = 0;
179
180   /* Figure out how to map in-memory case data to on-disk case
181      data.  Also count the number of segments.  Very long strings
182      occupy multiple segments, otherwise each variable only takes
183      one segment. */
184   w->segment_cnt = sfm_dictionary_to_sfm_vars (d, &w->sfm_vars,
185                                                &w->sfm_var_cnt);
186
187   /* Open file handle as an exclusive writer. */
188   /* TRANSLATORS: this fragment will be interpolated into
189      messages in fh_lock() that identify types of files. */
190   w->lock = fh_lock (fh, FH_REF_FILE, N_("system file"), FH_ACC_WRITE, true);
191   if (w->lock == NULL)
192     goto error;
193
194   /* Create the file on disk. */
195   mode = S_IRUSR | S_IRGRP | S_IROTH;
196   if (opts.create_writeable)
197     mode |= S_IWUSR | S_IWGRP | S_IWOTH;
198   w->rf = replace_file_start (fh_get_file_name (fh), "wb", mode,
199                               &w->file, NULL);
200   if (w->rf == NULL)
201     {
202       msg (ME, _("Error opening \"%s\" for writing as a system file: %s."),
203            fh_get_file_name (fh), strerror (errno));
204       goto error;
205     }
206
207   /* Write the file header. */
208   write_header (w, d);
209
210   /* Write basic variable info. */
211   short_names_assign (d);
212   for (i = 0; i < dict_get_var_cnt (d); i++)
213     write_variable (w, dict_get_var (d, i));
214
215   /* Write out value labels. */
216   idx = 0;
217   for (i = 0; i < dict_get_var_cnt (d); i++)
218     {
219       struct variable *v = dict_get_var (d, i);
220
221       write_value_labels (w, v, idx);
222       idx += sfm_width_to_octs (var_get_width (v));
223     }
224
225   if (dict_get_documents (d) != NULL)
226     write_documents (w, d);
227
228   write_integer_info_record (w);
229   write_float_info_record (w);
230
231   write_variable_display_parameters (w, d);
232
233   if (opts.version >= 3)
234     write_longvar_table (w, d);
235
236   write_vls_length_table (w, d);
237
238   /* Write end-of-headers record. */
239   write_int (w, 999);
240   write_int (w, 0);
241
242   if (write_error (w))
243     {
244       close_writer (w);
245       return NULL;
246     }
247
248   return casewriter_create (dict_get_next_value_idx (d),
249                             &sys_file_casewriter_class, w);
250
251 error:
252   close_writer (w);
253   return NULL;
254 }
255
256 /* Returns value of X truncated to two least-significant digits. */
257 static int
258 rerange (int x)
259 {
260   if (x < 0)
261     x = -x;
262   if (x >= 100)
263     x %= 100;
264   return x;
265 }
266
267 /* Calculates the offset of data for TARGET_VAR from the
268    beginning of each case's data for dictionary D.  The return
269    value is in "octs" (8-byte units). */
270 static int
271 calc_oct_idx (const struct dictionary *d, struct variable *target_var)
272 {
273   int oct_idx;
274   int i;
275
276   oct_idx = 0;
277   for (i = 0; i < dict_get_var_cnt (d); i++)
278     {
279       struct variable *var = dict_get_var (d, i);
280       if (var == target_var)
281         break;
282       oct_idx += sfm_width_to_octs (var_get_width (var));
283     }
284   return oct_idx;
285 }
286
287 /* Write the sysfile_header header to system file W. */
288 static void
289 write_header (struct sfm_writer *w, const struct dictionary *d)
290 {
291   char prod_name[61];
292   char creation_date[10];
293   char creation_time[9];
294   const char *file_label;
295   struct variable *weight;
296
297   time_t t;
298
299   /* Record-type code. */
300   write_string (w, "$FL2", 4);
301
302   /* Product identification. */
303   snprintf (prod_name, sizeof prod_name, "@(#) SPSS DATA FILE %s - %s",
304             version, host_system);
305   write_string (w, prod_name, 60);
306
307   /* Layout code. */
308   write_int (w, 2);
309
310   /* Number of `union value's per case. */
311   write_int (w, calc_oct_idx (d, NULL));
312
313   /* Compressed? */
314   write_int (w, w->compress);
315
316   /* Weight variable. */
317   weight = dict_get_weight (d);
318   write_int (w, weight != NULL ? calc_oct_idx (d, weight) + 1 : 0);
319
320   /* Number of cases.  We don't know this in advance, so we write
321      -1 to indicate an unknown number of cases.  Later we can
322      come back and overwrite it with the true value. */
323   write_int (w, -1);
324
325   /* Compression bias. */
326   write_float (w, COMPRESSION_BIAS);
327
328   /* Creation date and time. */
329   if (time (&t) == (time_t) -1)
330     {
331       strcpy (creation_date, "01 Jan 70");
332       strcpy (creation_time, "00:00:00");
333     }
334   else
335     {
336       static const char *const month_name[12] =
337         {
338           "Jan", "Feb", "Mar", "Apr", "May", "Jun",
339           "Jul", "Aug", "Sep", "Oct", "Nov", "Dec",
340         };
341       struct tm *tmp = localtime (&t);
342       int day = rerange (tmp->tm_mday);
343       int mon = rerange (tmp->tm_mon + 1);
344       int year = rerange (tmp->tm_year);
345       int hour = rerange (tmp->tm_hour + 1);
346       int min = rerange (tmp->tm_min + 1);
347       int sec = rerange (tmp->tm_sec + 1);
348
349       snprintf (creation_date, sizeof creation_date,
350                 "%02d %s %02d", day, month_name[mon - 1], year);
351       snprintf (creation_time, sizeof creation_time,
352                 "%02d:%02d:%02d", hour - 1, min - 1, sec - 1);
353     }
354   write_string (w, creation_date, 9);
355   write_string (w, creation_time, 8);
356
357   /* File label. */
358   file_label = dict_get_label (d);
359   if (file_label == NULL)
360     file_label = "";
361   write_string (w, file_label, 64);
362
363   /* Padding. */
364   write_zeros (w, 3);
365 }
366
367 /* Write format spec FMT to W, after adjusting it to be
368    compatible with the given WIDTH. */
369 static void
370 write_format (struct sfm_writer *w, struct fmt_spec fmt, int width)
371 {
372   assert (fmt_check_output (&fmt));
373   assert (sfm_width_to_segments (width) == 1);
374
375   if (width > 0)
376     fmt_resize (&fmt, width);
377   write_int (w, (fmt_to_io (fmt.type) << 16) | (fmt.w << 8) | fmt.d);
378 }
379
380 /* Write a string continuation variable record for each 8-byte
381    section beyond the initial 8 bytes, for a variable of the
382    given WIDTH. */
383 static void
384 write_variable_continuation_records (struct sfm_writer *w, int width)
385 {
386   int position;
387
388   assert (sfm_width_to_segments (width) == 1);
389   for (position = 8; position < width; position += 8)
390     {
391       write_int (w, 2);   /* Record type. */
392       write_int (w, -1);  /* Width. */
393       write_int (w, 0);   /* No variable label. */
394       write_int (w, 0);   /* No missing values. */
395       write_int (w, 0);   /* Print format. */
396       write_int (w, 0);   /* Write format. */
397       write_zeros (w, 8);   /* Name. */
398     }
399 }
400
401 /* Write the variable record(s) for variable V to system file
402    W. */
403 static void
404 write_variable (struct sfm_writer *w, const struct variable *v)
405 {
406   int width = var_get_width (v);
407   int segment_cnt = sfm_width_to_segments (width);
408   int seg0_width = sfm_segment_alloc_width (width, 0);
409   const struct missing_values *mv = var_get_missing_values (v);
410   int i;
411
412   /* Record type. */
413   write_int (w, 2);
414
415   /* Width. */
416   write_int (w, seg0_width);
417
418   /* Variable has a variable label? */
419   write_int (w, var_has_label (v));
420
421   /* Number of missing values.  If there is a range, then the
422      range counts as 2 missing values and causes the number to be
423      negated. */
424   write_int (w, mv_has_range (mv) ? -2 - mv_n_values (mv) : mv_n_values (mv));
425
426   /* Print and write formats. */
427   write_format (w, *var_get_print_format (v), seg0_width);
428   write_format (w, *var_get_write_format (v), seg0_width);
429
430   /* Short name.
431      The full name is in a translation table written
432      separately. */
433   write_string (w, var_get_short_name (v, 0), 8);
434
435   /* Value label. */
436   if (var_has_label (v))
437     {
438       const char *label = var_get_label (v);
439       size_t padded_len = ROUND_UP (MIN (strlen (label), 255), 4);
440       write_int (w, padded_len);
441       write_string (w, label, padded_len);
442     }
443
444   /* Write the missing values, if any, range first. */
445   if (mv_has_range (mv))
446     {
447       double x, y;
448       mv_get_range (mv, &x, &y);
449       write_float (w, x);
450       write_float (w, y);
451     }
452   for (i = 0; i < mv_n_values (mv); i++)
453     {
454       union value value;
455       mv_get_value (mv, &value, i);
456       write_value (w, &value, seg0_width);
457     }
458
459   write_variable_continuation_records (w, seg0_width);
460
461   /* Write additional segments for very long string variables. */
462   for (i = 1; i < segment_cnt; i++)
463     {
464       int seg_width = sfm_segment_alloc_width (width, i);
465       struct fmt_spec fmt = fmt_for_output (FMT_A, MAX (seg_width, 1), 0);
466
467       write_int (w, 2);           /* Variable record. */
468       write_int (w, seg_width);   /* Width. */
469       write_int (w, 0);           /* No variable label. */
470       write_int (w, 0);           /* No missing values. */
471       write_format (w, fmt, seg_width); /* Print format. */
472       write_format (w, fmt, seg_width); /* Write format. */
473       write_string (w, var_get_short_name (v, i), 8);
474
475       write_variable_continuation_records (w, seg_width);
476     }
477 }
478
479 /* Writes the value labels for variable V having system file
480    variable index IDX to system file W. */
481 static void
482 write_value_labels (struct sfm_writer *w, struct variable *v, int idx)
483 {
484   const struct val_labs *val_labs;
485   struct val_labs_iterator *i;
486   struct val_lab *vl;
487
488   val_labs = var_get_value_labels (v);
489   if (val_labs == NULL)
490     return;
491
492   /* Value label record. */
493   write_int (w, 3);             /* Record type. */
494   write_int (w, val_labs_count (val_labs));
495   for (vl = val_labs_first_sorted (val_labs, &i); vl != NULL;
496        vl = val_labs_next (val_labs, &i))
497     {
498       uint8_t len = MIN (strlen (vl->label), 255);
499
500       write_value (w, &vl->value, var_get_width (v));
501       write_bytes (w, &len, 1);
502       write_bytes (w, vl->label, len);
503       write_zeros (w, REM_RND_UP (len + 1, 8));
504     }
505
506   /* Value label variable record. */
507   write_int (w, 4);             /* Record type. */
508   write_int (w, 1);             /* Number of variables. */
509   write_int (w, idx + 1);       /* Variable's dictionary index. */
510 }
511
512 /* Writes record type 6, document record. */
513 static void
514 write_documents (struct sfm_writer *w, const struct dictionary *d)
515 {
516   size_t line_cnt = dict_get_document_line_cnt (d);
517
518   write_int (w, 6);             /* Record type. */
519   write_int (w, line_cnt);
520   write_bytes (w, dict_get_documents (d), line_cnt * DOC_LINE_LENGTH);
521 }
522
523 /* Write the alignment, width and scale values. */
524 static void
525 write_variable_display_parameters (struct sfm_writer *w,
526                                    const struct dictionary *dict)
527 {
528   int i;
529
530   write_int (w, 7);             /* Record type. */
531   write_int (w, 11);            /* Record subtype. */
532   write_int (w, 4);             /* Data item (int32) size. */
533   write_int (w, w->segment_cnt * 3); /* Number of data items. */
534
535   for (i = 0; i < dict_get_var_cnt (dict); ++i)
536     {
537       struct variable *v = dict_get_var (dict, i);
538       int width = var_get_width (v);
539       int segment_cnt = sfm_width_to_segments (width);
540       int measure = (var_get_measure (v) == MEASURE_NOMINAL ? 1
541                      : var_get_measure (v) == MEASURE_ORDINAL ? 2
542                      : 3);
543       int alignment = (var_get_alignment (v) == ALIGN_LEFT ? 0
544                        : var_get_alignment (v) == ALIGN_RIGHT ? 1
545                        : 2);
546       int i;
547
548       for (i = 0; i < segment_cnt; i++)
549         {
550           int width_left = width - sfm_segment_effective_offset (width, i);
551           write_int (w, measure);
552           write_int (w, (i == 0 ? var_get_display_width (v)
553                          : var_default_display_width (width_left)));
554           write_int (w, alignment);
555         }
556     }
557 }
558
559 /* Writes the table of lengths for very long string variables. */
560 static void
561 write_vls_length_table (struct sfm_writer *w,
562                         const struct dictionary *dict)
563 {
564   struct string map;
565   int i;
566
567   ds_init_empty (&map);
568   for (i = 0; i < dict_get_var_cnt (dict); ++i)
569     {
570       const struct variable *v = dict_get_var (dict, i);
571       if (sfm_width_to_segments (var_get_width (v)) > 1)
572         ds_put_format (&map, "%s=%05d%c\t",
573                        var_get_short_name (v, 0), var_get_width (v), 0);
574     }
575   if (!ds_is_empty (&map))
576     {
577       write_int (w, 7);         /* Record type. */
578       write_int (w, 14);        /* Record subtype. */
579       write_int (w, 1);         /* Data item (char) size. */
580       write_int (w, ds_length (&map)); /* Number of data items. */
581       write_bytes (w, ds_data (&map), ds_length (&map));
582     }
583   ds_destroy (&map);
584 }
585
586 /* Writes the long variable name table. */
587 static void
588 write_longvar_table (struct sfm_writer *w, const struct dictionary *dict)
589 {
590   struct string map;
591   size_t i;
592
593   ds_init_empty (&map);
594   for (i = 0; i < dict_get_var_cnt (dict); i++)
595     {
596       struct variable *v = dict_get_var (dict, i);
597
598       if (i)
599         ds_put_char (&map, '\t');
600       ds_put_format (&map, "%s=%s",
601                      var_get_short_name (v, 0), var_get_name (v));
602     }
603
604   write_int (w, 7);             /* Record type. */
605   write_int (w, 13);            /* Record subtype. */
606   write_int (w, 1);             /* Data item (char) size. */
607   write_int (w, ds_length (&map)); /* Number of data items. */
608   write_bytes (w, ds_data (&map), ds_length (&map));
609
610   ds_destroy (&map);
611 }
612
613 /* Write integer information record. */
614 static void
615 write_integer_info_record (struct sfm_writer *w)
616 {
617   int version_component[3];
618   int float_format;
619
620   /* Parse the version string. */
621   memset (version_component, 0, sizeof version_component);
622   sscanf (bare_version, "%d.%d.%d",
623           &version_component[0], &version_component[1], &version_component[2]);
624
625   /* Figure out the floating-point format. */
626   if (FLOAT_NATIVE_64_BIT == FLOAT_IEEE_DOUBLE_LE
627       || FLOAT_NATIVE_64_BIT == FLOAT_IEEE_DOUBLE_BE)
628     float_format = 1;
629   else if (FLOAT_NATIVE_64_BIT == FLOAT_Z_LONG)
630     float_format = 2;
631   else if (FLOAT_NATIVE_64_BIT == FLOAT_VAX_D)
632     float_format = 3;
633   else
634     abort ();
635
636   /* Write record. */
637   write_int (w, 7);             /* Record type. */
638   write_int (w, 3);             /* Record subtype. */
639   write_int (w, 4);             /* Data item (int32) size. */
640   write_int (w, 8);             /* Number of data items. */
641   write_int (w, version_component[0]);
642   write_int (w, version_component[1]);
643   write_int (w, version_component[2]);
644   write_int (w, -1);          /* Machine code. */
645   write_int (w, float_format);
646   write_int (w, 1);           /* Compression code. */
647   write_int (w, INTEGER_NATIVE == INTEGER_MSB_FIRST ? 1 : 2);
648   write_int (w, 2);           /* 7-bit ASCII. */
649 }
650
651 /* Write floating-point information record. */
652 static void
653 write_float_info_record (struct sfm_writer *w)
654 {
655   write_int (w, 7);             /* Record type. */
656   write_int (w, 4);             /* Record subtype. */
657   write_int (w, 8);             /* Data item (flt64) size. */
658   write_int (w, 3);             /* Number of data items. */
659   write_float (w, SYSMIS);      /* System-missing value. */
660   write_float (w, HIGHEST);     /* Value used for HIGHEST in missing values. */
661   write_float (w, LOWEST);      /* Value used for LOWEST in missing values. */
662 }
663 \f
664 /* Writes case C to system file W. */
665 static void
666 sys_file_casewriter_write (struct casewriter *writer, void *w_,
667                            struct ccase *c)
668 {
669   struct sfm_writer *w = w_;
670
671   if (ferror (w->file))
672     {
673       casewriter_force_error (writer);
674       case_destroy (c);
675       return;
676     }
677
678   w->case_cnt++;
679
680   if (!w->compress)
681     write_case_uncompressed (w, c);
682   else
683     write_case_compressed (w, c);
684
685   case_destroy (c);
686 }
687
688 /* Destroys system file writer W. */
689 static void
690 sys_file_casewriter_destroy (struct casewriter *writer, void *w_)
691 {
692   struct sfm_writer *w = w_;
693   if (!close_writer (w))
694     casewriter_force_error (writer);
695 }
696
697 /* Returns true if an I/O error has occurred on WRITER, false otherwise. */
698 bool
699 write_error (const struct sfm_writer *writer)
700 {
701   return ferror (writer->file);
702 }
703
704 /* Closes a system file after we're done with it.
705    Returns true if successful, false if an I/O error occurred. */
706 bool
707 close_writer (struct sfm_writer *w)
708 {
709   bool ok;
710
711   if (w == NULL)
712     return true;
713
714   ok = true;
715   if (w->file != NULL)
716     {
717       /* Flush buffer. */
718       if (w->opcode_cnt > 0)
719         flush_compressed (w);
720       fflush (w->file);
721
722       ok = !write_error (w);
723
724       /* Seek back to the beginning and update the number of cases.
725          This is just a courtesy to later readers, so there's no need
726          to check return values or report errors. */
727       if (ok && w->case_cnt <= INT32_MAX && !fseek (w->file, 80, SEEK_SET))
728         {
729           write_int (w, w->case_cnt);
730           clearerr (w->file);
731         }
732
733       if (fclose (w->file) == EOF)
734         ok = false;
735
736       if (!ok)
737         msg (ME, _("An I/O error occurred writing system file \"%s\"."),
738              fh_get_file_name (w->fh));
739
740       if (ok ? !replace_file_commit (w->rf) : !replace_file_abort (w->rf))
741         ok = false;
742     }
743
744   fh_unlock (w->lock);
745   fh_unref (w->fh);
746
747   free (w->sfm_vars);
748   free (w);
749
750   return ok;
751 }
752
753 /* System file writer casewriter class. */
754 static const struct casewriter_class sys_file_casewriter_class =
755   {
756     sys_file_casewriter_write,
757     sys_file_casewriter_destroy,
758     NULL,
759   };
760 \f
761 /* Writes case C to system file W, without compressing it. */
762 static void
763 write_case_uncompressed (struct sfm_writer *w, struct ccase *c)
764 {
765   size_t i;
766
767   for (i = 0; i < w->sfm_var_cnt; i++)
768     {
769       struct sfm_var *v = &w->sfm_vars[i];
770
771       if (v->width == 0)
772         write_float (w, case_num_idx (c, v->case_index));
773       else
774         {
775           write_bytes (w, case_str_idx (c, v->case_index) + v->offset,
776                        v->width);
777           write_spaces (w, v->padding);
778         }
779     }
780 }
781
782 /* Writes case C to system file W, with compression. */
783 static void
784 write_case_compressed (struct sfm_writer *w, struct ccase *c)
785 {
786   size_t i;
787
788   for (i = 0; i < w->sfm_var_cnt; i++)
789     {
790       struct sfm_var *v = &w->sfm_vars[i];
791
792       if (v->width == 0)
793         {
794           double d = case_num_idx (c, v->case_index);
795           if (d == SYSMIS)
796             put_cmp_opcode (w, 255);
797           else if (d >= 1 - COMPRESSION_BIAS
798                    && d <= 251 - COMPRESSION_BIAS
799                    && d == (int) d)
800             put_cmp_opcode (w, (int) d + COMPRESSION_BIAS);
801           else
802             {
803               put_cmp_opcode (w, 253);
804               put_cmp_number (w, d);
805             }
806         }
807       else
808         {
809           int offset = v->offset;
810           int width, padding;
811
812           /* This code properly deals with a width that is not a
813              multiple of 8, by ensuring that the final partial
814              oct (8 byte unit) is treated as padded with spaces
815              on the right. */
816           for (width = v->width; width > 0; width -= 8, offset += 8)
817             {
818               const void *data = case_str_idx (c, v->case_index) + offset;
819               int chunk_size = MIN (width, 8);
820               if (!memcmp (data, "        ", chunk_size))
821                 put_cmp_opcode (w, 254);
822               else
823                 {
824                   put_cmp_opcode (w, 253);
825                   put_cmp_string (w, data, chunk_size);
826                 }
827             }
828
829           /* This code deals properly with padding that is not a
830              multiple of 8 bytes, by discarding the remainder,
831              which was already effectively padded with spaces in
832              the previous loop.  (Note that v->width + v->padding
833              is always a multiple of 8.) */
834           for (padding = v->padding / 8; padding > 0; padding--)
835             put_cmp_opcode (w, 254);
836         }
837     }
838 }
839
840 /* Flushes buffered compressed opcodes and data to W.
841    The compression buffer must not be empty. */
842 static void
843 flush_compressed (struct sfm_writer *w)
844 {
845   assert (w->opcode_cnt > 0 && w->opcode_cnt <= 8);
846
847   write_bytes (w, w->opcodes, w->opcode_cnt);
848   write_zeros (w, 8 - w->opcode_cnt);
849
850   write_bytes (w, w->data, w->data_cnt * sizeof *w->data);
851
852   w->opcode_cnt = w->data_cnt = 0;
853 }
854
855 /* Appends OPCODE to the buffered set of compression opcodes in
856    W.  Flushes the compression buffer beforehand if necessary. */
857 static void
858 put_cmp_opcode (struct sfm_writer *w, uint8_t opcode)
859 {
860   if (w->opcode_cnt >= 8)
861     flush_compressed (w);
862
863   w->opcodes[w->opcode_cnt++] = opcode;
864 }
865
866 /* Appends NUMBER to the buffered compression data in W.  The
867    buffer must not be full; the way to assure that is to call
868    this function only just after a call to put_cmp_opcode, which
869    will flush the buffer as necessary. */
870 static void
871 put_cmp_number (struct sfm_writer *w, double number)
872 {
873   assert (w->opcode_cnt > 0);
874   assert (w->data_cnt < 8);
875
876   convert_double_to_output_format (number, w->data[w->data_cnt++]);
877 }
878
879 /* Appends SIZE bytes of DATA to the buffered compression data in
880    W, followed by enough spaces to pad the output data to exactly
881    8 bytes (thus, SIZE must be no greater than 8).  The buffer
882    must not be full; the way to assure that is to call this
883    function only just after a call to put_cmp_opcode, which will
884    flush the buffer as necessary. */
885 static void
886 put_cmp_string (struct sfm_writer *w, const void *data, size_t size)
887 {
888   assert (w->opcode_cnt > 0);
889   assert (w->data_cnt < 8);
890   assert (size <= 8);
891
892   memset (w->data[w->data_cnt], ' ', 8);
893   memcpy (w->data[w->data_cnt], data, size);
894   w->data_cnt++;
895 }
896 \f
897 /* Writes 32-bit integer X to the output file for writer W. */
898 static void
899 write_int (struct sfm_writer *w, int32_t x)
900 {
901   write_bytes (w, &x, sizeof x);
902 }
903
904 /* Converts NATIVE to the 64-bit format used in output files in
905    OUTPUT. */
906 static inline void
907 convert_double_to_output_format (double native, uint8_t output[8])
908 {
909   /* If "double" is not a 64-bit type, then convert it to a
910      64-bit type.  Otherwise just copy it. */
911   if (FLOAT_NATIVE_DOUBLE != FLOAT_NATIVE_64_BIT)
912     float_convert (FLOAT_NATIVE_DOUBLE, &native, FLOAT_NATIVE_64_BIT, output);
913   else
914     memcpy (output, &native, sizeof native);
915 }
916
917 /* Writes floating-point number X to the output file for writer
918    W. */
919 static void
920 write_float (struct sfm_writer *w, double x)
921 {
922   uint8_t output[8];
923   convert_double_to_output_format (x, output);
924   write_bytes (w, output, sizeof output);
925 }
926
927 /* Writes contents of VALUE with the given WIDTH to W, padding
928    with zeros to a multiple of 8 bytes.
929    To avoid a branch, and because we don't actually need to
930    support it, WIDTH must be no bigger than 8. */
931 static void
932 write_value (struct sfm_writer *w, const union value *value, int width)
933 {
934   assert (width <= 8);
935   if (width == 0)
936     write_float (w, value->f);
937   else
938     {
939       write_bytes (w, value->s, width);
940       write_zeros (w, 8 - width);
941     }
942 }
943
944 /* Writes null-terminated STRING in a field of the given WIDTH to
945    W.  If WIDTH is longer than WIDTH, it is truncated; if WIDTH
946    is narrowed, it is padded on the right with spaces. */
947 static void
948 write_string (struct sfm_writer *w, const char *string, size_t width)
949 {
950   size_t data_bytes = MIN (strlen (string), width);
951   size_t pad_bytes = width - data_bytes;
952   write_bytes (w, string, data_bytes);
953   while (pad_bytes-- > 0)
954     putc (' ', w->file);
955 }
956
957 /* Writes SIZE bytes of DATA to W's output file. */
958 static void
959 write_bytes (struct sfm_writer *w, const void *data, size_t size)
960 {
961   fwrite (data, 1, size, w->file);
962 }
963
964 /* Writes N zeros to W's output file. */
965 static void
966 write_zeros (struct sfm_writer *w, size_t n)
967 {
968   while (n-- > 0)
969     putc (0, w->file);
970 }
971
972 /* Writes N spaces to W's output file. */
973 static void
974 write_spaces (struct sfm_writer *w, size_t n)
975 {
976   while (n-- > 0)
977     putc (' ', w->file);
978 }