d2522c23f82d1093be8edcea269c5841fc3fde69
[pspp-builds.git] / src / data / sys-file-writer.c
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 1997-9, 2000, 2006, 2007, 2009, 2010, 2011 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 "data/sys-file-writer.h"
20 #include "data/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 "data/attributes.h"
30 #include "data/case.h"
31 #include "data/casewriter-provider.h"
32 #include "data/casewriter.h"
33 #include "data/dictionary.h"
34 #include "data/file-handle-def.h"
35 #include "data/file-name.h"
36 #include "data/format.h"
37 #include "data/make-file.h"
38 #include "data/missing-values.h"
39 #include "data/mrset.h"
40 #include "data/settings.h"
41 #include "data/short-names.h"
42 #include "data/value-labels.h"
43 #include "data/variable.h"
44 #include "libpspp/float-format.h"
45 #include "libpspp/i18n.h"
46 #include "libpspp/integer-format.h"
47 #include "libpspp/message.h"
48 #include "libpspp/misc.h"
49 #include "libpspp/str.h"
50 #include "libpspp/string-array.h"
51 #include "libpspp/version.h"
52
53 #include "gl/xmemdup0.h"
54 #include "gl/minmax.h"
55 #include "gl/unlocked-io.h"
56 #include "gl/xalloc.h"
57
58 #include "gettext.h"
59 #define _(msgid) gettext (msgid)
60 #define N_(msgid) (msgid)
61
62 /* Compression bias used by PSPP.  Values between (1 -
63    COMPRESSION_BIAS) and (251 - COMPRESSION_BIAS) inclusive can be
64    compressed. */
65 #define COMPRESSION_BIAS 100
66
67 /* System file writer. */
68 struct sfm_writer
69   {
70     struct file_handle *fh;     /* File handle. */
71     struct fh_lock *lock;       /* Mutual exclusion for file. */
72     FILE *file;                 /* File stream. */
73     struct replace_file *rf;    /* Ticket for replacing output file. */
74
75     bool compress;              /* 1=compressed, 0=not compressed. */
76     casenumber case_cnt;        /* Number of cases written so far. */
77
78     /* Compression buffering.
79
80        Compressed data is output as groups of 8 1-byte opcodes
81        followed by up to 8 (depending on the opcodes) 8-byte data
82        items.  Data items and opcodes arrive at the same time but
83        must be reordered for writing to disk, thus a small amount
84        of buffering here. */
85     uint8_t opcodes[8];         /* Buffered opcodes. */
86     int opcode_cnt;             /* Number of buffered opcodes. */
87     uint8_t data[8][8];         /* Buffered data. */
88     int data_cnt;               /* Number of buffered data items. */
89
90     /* Variables. */
91     struct sfm_var *sfm_vars;   /* Variables. */
92     size_t sfm_var_cnt;         /* Number of variables. */
93     size_t segment_cnt;         /* Number of variables including extra segments
94                                    for long string variables. */
95   };
96
97 static const struct casewriter_class sys_file_casewriter_class;
98
99 static void write_header (struct sfm_writer *, const struct dictionary *);
100 static void write_variable (struct sfm_writer *, const struct variable *);
101 static void write_value_labels (struct sfm_writer *, struct variable *,
102                                 int idx);
103 static void write_integer_info_record (struct sfm_writer *);
104 static void write_float_info_record (struct sfm_writer *);
105
106 static void write_longvar_table (struct sfm_writer *w,
107                                  const struct dictionary *dict);
108
109 static void write_encoding_record (struct sfm_writer *w,
110                                    const struct dictionary *);
111
112 static void write_vls_length_table (struct sfm_writer *w,
113                               const struct dictionary *dict);
114
115 static void write_long_string_value_labels (struct sfm_writer *,
116                                             const struct dictionary *);
117
118 static void write_mrsets (struct sfm_writer *, const struct dictionary *,
119                           bool pre_v14);
120
121 static void write_variable_display_parameters (struct sfm_writer *w,
122                                                const struct dictionary *dict);
123
124 static void write_documents (struct sfm_writer *, const struct dictionary *);
125
126 static void write_data_file_attributes (struct sfm_writer *,
127                                         const struct dictionary *);
128 static void write_variable_attributes (struct sfm_writer *,
129                                        const struct dictionary *);
130
131 static void write_int (struct sfm_writer *, int32_t);
132 static inline void convert_double_to_output_format (double, uint8_t[8]);
133 static void write_float (struct sfm_writer *, double);
134 static void write_string (struct sfm_writer *, const char *, size_t);
135 static void write_bytes (struct sfm_writer *, const void *, size_t);
136 static void write_zeros (struct sfm_writer *, size_t);
137 static void write_spaces (struct sfm_writer *, size_t);
138 static void write_value (struct sfm_writer *, const union value *, int width);
139
140 static void write_case_uncompressed (struct sfm_writer *,
141                                      const struct ccase *);
142 static void write_case_compressed (struct sfm_writer *, const struct ccase *);
143 static void flush_compressed (struct sfm_writer *);
144 static void put_cmp_opcode (struct sfm_writer *, uint8_t);
145 static void put_cmp_number (struct sfm_writer *, double);
146 static void put_cmp_string (struct sfm_writer *, const void *, size_t);
147
148 static bool write_error (const struct sfm_writer *);
149 static bool close_writer (struct sfm_writer *);
150
151 /* Returns default options for writing a system file. */
152 struct sfm_write_options
153 sfm_writer_default_options (void)
154 {
155   struct sfm_write_options opts;
156   opts.create_writeable = true;
157   opts.compress = settings_get_scompression ();
158   opts.version = 3;
159   return opts;
160 }
161
162 /* Opens the system file designated by file handle FH for writing
163    cases from dictionary D according to the given OPTS.
164
165    No reference to D is retained, so it may be modified or
166    destroyed at will after this function returns.  D is not
167    modified by this function, except to assign short names. */
168 struct casewriter *
169 sfm_open_writer (struct file_handle *fh, struct dictionary *d,
170                  struct sfm_write_options opts)
171 {
172   struct sfm_writer *w;
173   mode_t mode;
174   int idx;
175   int i;
176
177   /* Check version. */
178   if (opts.version != 2 && opts.version != 3)
179     {
180       msg (ME, _("Unknown system file version %d. Treating as version %d."),
181            opts.version, 3);
182       opts.version = 3;
183     }
184
185   /* Create and initialize writer. */
186   w = xmalloc (sizeof *w);
187   w->fh = fh_ref (fh);
188   w->lock = NULL;
189   w->file = NULL;
190   w->rf = NULL;
191
192   w->compress = opts.compress;
193   w->case_cnt = 0;
194
195   w->opcode_cnt = w->data_cnt = 0;
196
197   /* Figure out how to map in-memory case data to on-disk case
198      data.  Also count the number of segments.  Very long strings
199      occupy multiple segments, otherwise each variable only takes
200      one segment. */
201   w->segment_cnt = sfm_dictionary_to_sfm_vars (d, &w->sfm_vars,
202                                                &w->sfm_var_cnt);
203
204   /* Open file handle as an exclusive writer. */
205   /* TRANSLATORS: this fragment will be interpolated into
206      messages in fh_lock() that identify types of files. */
207   w->lock = fh_lock (fh, FH_REF_FILE, N_("system file"), FH_ACC_WRITE, true);
208   if (w->lock == NULL)
209     goto error;
210
211   /* Create the file on disk. */
212   mode = 0444;
213   if (opts.create_writeable)
214     mode |= 0222;
215   w->rf = replace_file_start (fh_get_file_name (fh), "wb", mode,
216                               &w->file, NULL);
217   if (w->rf == NULL)
218     {
219       msg (ME, _("Error opening `%s' for writing as a system file: %s."),
220            fh_get_file_name (fh), strerror (errno));
221       goto error;
222     }
223
224   /* Write the file header. */
225   write_header (w, d);
226
227   /* Write basic variable info. */
228   short_names_assign (d);
229   for (i = 0; i < dict_get_var_cnt (d); i++)
230     write_variable (w, dict_get_var (d, i));
231
232   /* Write out value labels. */
233   idx = 0;
234   for (i = 0; i < dict_get_var_cnt (d); i++)
235     {
236       struct variable *v = dict_get_var (d, i);
237
238       write_value_labels (w, v, idx);
239       idx += sfm_width_to_octs (var_get_width (v));
240     }
241
242   if (dict_get_document_line_cnt (d) > 0)
243     write_documents (w, d);
244
245   write_integer_info_record (w);
246   write_float_info_record (w);
247
248   write_mrsets (w, d, true);
249
250   write_variable_display_parameters (w, d);
251
252   if (opts.version >= 3)
253     write_longvar_table (w, d);
254
255   write_vls_length_table (w, d);
256
257   write_long_string_value_labels (w, d);
258
259   if (attrset_count (dict_get_attributes (d)))
260     write_data_file_attributes (w, d);
261   write_variable_attributes (w, d);
262
263   write_mrsets (w, d, false);
264
265   write_encoding_record (w, d);
266
267   /* Write end-of-headers record. */
268   write_int (w, 999);
269   write_int (w, 0);
270
271   if (write_error (w))
272     goto error;
273
274   return casewriter_create (dict_get_proto (d), &sys_file_casewriter_class, w);
275
276 error:
277   close_writer (w);
278   return NULL;
279 }
280
281 /* Returns value of X truncated to two least-significant digits. */
282 static int
283 rerange (int x)
284 {
285   if (x < 0)
286     x = -x;
287   if (x >= 100)
288     x %= 100;
289   return x;
290 }
291
292 /* Calculates the offset of data for TARGET_VAR from the
293    beginning of each case's data for dictionary D.  The return
294    value is in "octs" (8-byte units). */
295 static int
296 calc_oct_idx (const struct dictionary *d, struct variable *target_var)
297 {
298   int oct_idx;
299   int i;
300
301   oct_idx = 0;
302   for (i = 0; i < dict_get_var_cnt (d); i++)
303     {
304       struct variable *var = dict_get_var (d, i);
305       if (var == target_var)
306         break;
307       oct_idx += sfm_width_to_octs (var_get_width (var));
308     }
309   return oct_idx;
310 }
311
312 /* Write the sysfile_header header to system file W. */
313 static void
314 write_header (struct sfm_writer *w, const struct dictionary *d)
315 {
316   char prod_name[61];
317   char creation_date[10];
318   char creation_time[9];
319   const char *file_label;
320   struct variable *weight;
321
322   time_t t;
323
324   /* Record-type code. */
325   write_string (w, "$FL2", 4);
326
327   /* Product identification. */
328   snprintf (prod_name, sizeof prod_name, "@(#) SPSS DATA FILE %s - %s",
329             version, host_system);
330   write_string (w, prod_name, 60);
331
332   /* Layout code. */
333   write_int (w, 2);
334
335   /* Number of `union value's per case. */
336   write_int (w, calc_oct_idx (d, NULL));
337
338   /* Compressed? */
339   write_int (w, w->compress);
340
341   /* Weight variable. */
342   weight = dict_get_weight (d);
343   write_int (w, weight != NULL ? calc_oct_idx (d, weight) + 1 : 0);
344
345   /* Number of cases.  We don't know this in advance, so we write
346      -1 to indicate an unknown number of cases.  Later we can
347      come back and overwrite it with the true value. */
348   write_int (w, -1);
349
350   /* Compression bias. */
351   write_float (w, COMPRESSION_BIAS);
352
353   /* Creation date and time. */
354   if (time (&t) == (time_t) -1)
355     {
356       strcpy (creation_date, "01 Jan 70");
357       strcpy (creation_time, "00:00:00");
358     }
359   else
360     {
361       static const char *const month_name[12] =
362         {
363           "Jan", "Feb", "Mar", "Apr", "May", "Jun",
364           "Jul", "Aug", "Sep", "Oct", "Nov", "Dec",
365         };
366       struct tm *tmp = localtime (&t);
367       int day = rerange (tmp->tm_mday);
368       int mon = rerange (tmp->tm_mon + 1);
369       int year = rerange (tmp->tm_year);
370       int hour = rerange (tmp->tm_hour + 1);
371       int min = rerange (tmp->tm_min + 1);
372       int sec = rerange (tmp->tm_sec + 1);
373
374       snprintf (creation_date, sizeof creation_date,
375                 "%02d %s %02d", day, month_name[mon - 1], year);
376       snprintf (creation_time, sizeof creation_time,
377                 "%02d:%02d:%02d", hour - 1, min - 1, sec - 1);
378     }
379   write_string (w, creation_date, 9);
380   write_string (w, creation_time, 8);
381
382   /* File label. */
383   file_label = dict_get_label (d);
384   if (file_label == NULL)
385     file_label = "";
386   write_string (w, file_label, 64);
387
388   /* Padding. */
389   write_zeros (w, 3);
390 }
391
392 /* Write format spec FMT to W, after adjusting it to be
393    compatible with the given WIDTH. */
394 static void
395 write_format (struct sfm_writer *w, struct fmt_spec fmt, int width)
396 {
397   assert (fmt_check_output (&fmt));
398   assert (sfm_width_to_segments (width) == 1);
399
400   if (width > 0)
401     fmt_resize (&fmt, width);
402   write_int (w, (fmt_to_io (fmt.type) << 16) | (fmt.w << 8) | fmt.d);
403 }
404
405 /* Write a string continuation variable record for each 8-byte
406    section beyond the initial 8 bytes, for a variable of the
407    given WIDTH. */
408 static void
409 write_variable_continuation_records (struct sfm_writer *w, int width)
410 {
411   int position;
412
413   assert (sfm_width_to_segments (width) == 1);
414   for (position = 8; position < width; position += 8)
415     {
416       write_int (w, 2);   /* Record type. */
417       write_int (w, -1);  /* Width. */
418       write_int (w, 0);   /* No variable label. */
419       write_int (w, 0);   /* No missing values. */
420       write_int (w, 0);   /* Print format. */
421       write_int (w, 0);   /* Write format. */
422       write_zeros (w, 8);   /* Name. */
423     }
424 }
425
426 /* Write the variable record(s) for variable V to system file
427    W. */
428 static void
429 write_variable (struct sfm_writer *w, const struct variable *v)
430 {
431   int width = var_get_width (v);
432   int segment_cnt = sfm_width_to_segments (width);
433   int seg0_width = sfm_segment_alloc_width (width, 0);
434   struct missing_values mv;
435   int i;
436
437   /* Record type. */
438   write_int (w, 2);
439
440   /* Width. */
441   write_int (w, seg0_width);
442
443   /* Variable has a variable label? */
444   write_int (w, var_has_label (v));
445
446   /* Number of missing values.  If there is a range, then the
447      range counts as 2 missing values and causes the number to be
448      negated. */
449   mv_copy (&mv, var_get_missing_values (v));
450   if (mv_get_width (&mv) > 8)
451     mv_resize (&mv, 8);
452   if (mv_has_range (&mv))
453     write_int (w, -2 - mv_n_values (&mv));
454   else
455     write_int (w, mv_n_values (&mv));
456
457   /* Print and write formats. */
458   write_format (w, *var_get_print_format (v), seg0_width);
459   write_format (w, *var_get_write_format (v), seg0_width);
460
461   /* Short name.
462      The full name is in a translation table written
463      separately. */
464   write_string (w, var_get_short_name (v, 0), 8);
465
466   /* Value label. */
467   if (var_has_label (v))
468     {
469       char *label = recode_string (var_get_encoding (v), UTF8, var_get_label (v), -1);
470       size_t label_len = MIN (strlen (label), 255);
471       size_t padded_len = ROUND_UP (label_len, 4);
472       write_int (w, label_len);
473       write_string (w, label, padded_len);
474       free (label);
475     }
476
477   /* Write the missing values, if any, range first. */
478   if (mv_has_range (&mv))
479     {
480       double x, y;
481       mv_get_range (&mv, &x, &y);
482       write_float (w, x);
483       write_float (w, y);
484     }
485   for (i = 0; i < mv_n_values (&mv); i++)
486     write_value (w, mv_get_value (&mv, i), mv_get_width (&mv));
487
488   write_variable_continuation_records (w, seg0_width);
489
490   /* Write additional segments for very long string variables. */
491   for (i = 1; i < segment_cnt; i++)
492     {
493       int seg_width = sfm_segment_alloc_width (width, i);
494       struct fmt_spec fmt = fmt_for_output (FMT_A, MAX (seg_width, 1), 0);
495
496       write_int (w, 2);           /* Variable record. */
497       write_int (w, seg_width);   /* Width. */
498       write_int (w, 0);           /* No variable label. */
499       write_int (w, 0);           /* No missing values. */
500       write_format (w, fmt, seg_width); /* Print format. */
501       write_format (w, fmt, seg_width); /* Write format. */
502       write_string (w, var_get_short_name (v, i), 8);
503
504       write_variable_continuation_records (w, seg_width);
505     }
506
507   mv_destroy (&mv);
508 }
509
510 /* Writes the value labels for variable V having system file
511    variable index IDX to system file W.
512
513    Value labels for long string variables are written separately,
514    by write_long_string_value_labels. */
515 static void
516 write_value_labels (struct sfm_writer *w, struct variable *v, int idx)
517 {
518   const struct val_labs *val_labs;
519   const struct val_lab **labels;
520   size_t n_labels;
521   size_t i;
522
523   val_labs = var_get_value_labels (v);
524   n_labels = val_labs_count (val_labs);
525   if (n_labels == 0 || var_get_width (v) > 8)
526     return;
527
528   /* Value label record. */
529   write_int (w, 3);             /* Record type. */
530   write_int (w, val_labs_count (val_labs));
531   labels = val_labs_sorted (val_labs);
532   for (i = 0; i < n_labels; i++)
533     {
534       const struct val_lab *vl = labels[i];
535       char *label = recode_string (var_get_encoding (v), UTF8,
536                                    val_lab_get_escaped_label (vl), -1);
537       uint8_t len = MIN (strlen (label), 255);
538
539       write_value (w, val_lab_get_value (vl), var_get_width (v));
540       write_bytes (w, &len, 1);
541       write_bytes (w, label, len);
542       write_zeros (w, REM_RND_UP (len + 1, 8));
543       free (label);
544     }
545   free (labels);
546
547   /* Value label variable record. */
548   write_int (w, 4);             /* Record type. */
549   write_int (w, 1);             /* Number of variables. */
550   write_int (w, idx + 1);       /* Variable's dictionary index. */
551 }
552
553 /* Writes record type 6, document record. */
554 static void
555 write_documents (struct sfm_writer *w, const struct dictionary *d)
556 {
557   const struct string_array *docs = dict_get_documents (d);
558   const char *enc = dict_get_encoding (d);
559   size_t i;
560
561   write_int (w, 6);             /* Record type. */
562   write_int (w, docs->n);
563   for (i = 0; i < docs->n; i++)
564     {
565       char *s = recode_string (enc, "UTF-8", docs->strings[i], -1);
566       size_t s_len = strlen (s);
567       size_t write_len = MIN (s_len, DOC_LINE_LENGTH);
568
569       write_bytes (w, s, write_len);
570       write_spaces (w, DOC_LINE_LENGTH - write_len);
571       free (s);
572     }
573 }
574
575 static void
576 put_attrset (struct string *string, const struct attrset *attrs)
577 {
578   const struct attribute *attr;
579   struct attrset_iterator i;
580
581   for (attr = attrset_first (attrs, &i); attr != NULL;
582        attr = attrset_next (attrs, &i)) 
583     {
584       size_t n_values = attribute_get_n_values (attr);
585       size_t j;
586
587       ds_put_cstr (string, attribute_get_name (attr));
588       ds_put_byte (string, '(');
589       for (j = 0; j < n_values; j++) 
590         ds_put_format (string, "'%s'\n", attribute_get_value (attr, j));
591       ds_put_byte (string, ')');
592     }
593 }
594
595 static void
596 write_attribute_record (struct sfm_writer *w, const struct string *content,
597                         int subtype) 
598 {
599   write_int (w, 7);
600   write_int (w, subtype);
601   write_int (w, 1);
602   write_int (w, ds_length (content));
603   write_bytes (w, ds_data (content), ds_length (content));
604 }
605
606 static void
607 write_data_file_attributes (struct sfm_writer *w,
608                             const struct dictionary *d)
609 {
610   struct string s = DS_EMPTY_INITIALIZER;
611   put_attrset (&s, dict_get_attributes (d));
612   write_attribute_record (w, &s, 17);
613   ds_destroy (&s);
614 }
615
616 static void
617 write_variable_attributes (struct sfm_writer *w, const struct dictionary *d)
618 {
619   struct string s = DS_EMPTY_INITIALIZER;
620   size_t n_vars = dict_get_var_cnt (d);
621   size_t n_attrsets = 0;
622   size_t i;
623
624   for (i = 0; i < n_vars; i++)
625     { 
626       struct variable *v = dict_get_var (d, i);
627       struct attrset *attrs = var_get_attributes (v);
628       if (attrset_count (attrs)) 
629         {
630           if (n_attrsets++)
631             ds_put_byte (&s, '/');
632           ds_put_format (&s, "%s:", var_get_short_name (v, 0));
633           put_attrset (&s, attrs);
634         }
635     }
636   if (n_attrsets) 
637     write_attribute_record (w, &s, 18);
638   ds_destroy (&s);
639 }
640
641 /* Write multiple response sets.  If PRE_V14 is true, writes sets supported by
642    SPSS before release 14, otherwise writes sets supported only by later
643    versions. */
644 static void
645 write_mrsets (struct sfm_writer *w, const struct dictionary *dict,
646               bool pre_v14)
647 {
648   struct string s = DS_EMPTY_INITIALIZER;
649   size_t n_mrsets;
650   size_t i;
651
652   n_mrsets = dict_get_n_mrsets (dict);
653   if (n_mrsets == 0)
654     return;
655
656   for (i = 0; i < n_mrsets; i++)
657     {
658       const struct mrset *mrset = dict_get_mrset (dict, i);
659       const char *label;
660       size_t j;
661
662       if ((mrset->type != MRSET_MD || mrset->cat_source != MRSET_COUNTEDVALUES)
663           != pre_v14)
664         continue;
665
666       ds_put_format (&s, "%s=", mrset->name);
667       if (mrset->type == MRSET_MD)
668         {
669           char *counted;
670
671           if (mrset->cat_source == MRSET_COUNTEDVALUES)
672             ds_put_format (&s, "E %d ", mrset->label_from_var_label ? 11 : 1);
673           else
674             ds_put_byte (&s, 'D');
675
676           if (mrset->width == 0)
677             counted = xasprintf ("%.0f", mrset->counted.f);
678           else
679             counted = xmemdup0 (value_str (&mrset->counted, mrset->width),
680                                 mrset->width);
681           ds_put_format (&s, "%zu %s", strlen (counted), counted);
682           free (counted);
683         }
684       else
685         ds_put_byte (&s, 'C');
686       ds_put_byte (&s, ' ');
687
688       label = mrset->label && !mrset->label_from_var_label ? mrset->label : "";
689       ds_put_format (&s, "%zu %s", strlen (label), label);
690
691       for (j = 0; j < mrset->n_vars; j++)
692         ds_put_format (&s, " %s", var_get_short_name (mrset->vars[j], 0));
693       ds_put_byte (&s, '\n');
694     }
695   write_attribute_record (w, &s, pre_v14 ? 7 : 19);
696   ds_destroy (&s);
697 }
698
699 /* Write the alignment, width and scale values. */
700 static void
701 write_variable_display_parameters (struct sfm_writer *w,
702                                    const struct dictionary *dict)
703 {
704   int i;
705
706   write_int (w, 7);             /* Record type. */
707   write_int (w, 11);            /* Record subtype. */
708   write_int (w, 4);             /* Data item (int32) size. */
709   write_int (w, w->segment_cnt * 3); /* Number of data items. */
710
711   for (i = 0; i < dict_get_var_cnt (dict); ++i)
712     {
713       struct variable *v = dict_get_var (dict, i);
714       int width = var_get_width (v);
715       int segment_cnt = sfm_width_to_segments (width);
716       int measure = (var_get_measure (v) == MEASURE_NOMINAL ? 1
717                      : var_get_measure (v) == MEASURE_ORDINAL ? 2
718                      : 3);
719       int alignment = (var_get_alignment (v) == ALIGN_LEFT ? 0
720                        : var_get_alignment (v) == ALIGN_RIGHT ? 1
721                        : 2);
722       int i;
723
724       for (i = 0; i < segment_cnt; i++)
725         {
726           int width_left = width - sfm_segment_effective_offset (width, i);
727           write_int (w, measure);
728           write_int (w, (i == 0 ? var_get_display_width (v)
729                          : var_default_display_width (width_left)));
730           write_int (w, alignment);
731         }
732     }
733 }
734
735 /* Writes the table of lengths for very long string variables. */
736 static void
737 write_vls_length_table (struct sfm_writer *w,
738                         const struct dictionary *dict)
739 {
740   struct string map;
741   int i;
742
743   ds_init_empty (&map);
744   for (i = 0; i < dict_get_var_cnt (dict); ++i)
745     {
746       const struct variable *v = dict_get_var (dict, i);
747       if (sfm_width_to_segments (var_get_width (v)) > 1)
748         ds_put_format (&map, "%s=%05d%c\t",
749                        var_get_short_name (v, 0), var_get_width (v), 0);
750     }
751   if (!ds_is_empty (&map))
752     {
753       write_int (w, 7);         /* Record type. */
754       write_int (w, 14);        /* Record subtype. */
755       write_int (w, 1);         /* Data item (char) size. */
756       write_int (w, ds_length (&map)); /* Number of data items. */
757       write_bytes (w, ds_data (&map), ds_length (&map));
758     }
759   ds_destroy (&map);
760 }
761
762
763 static void
764 write_long_string_value_labels (struct sfm_writer *w,
765                                 const struct dictionary *dict)
766 {
767   size_t n_vars = dict_get_var_cnt (dict);
768   size_t size, i;
769   off_t start UNUSED;
770
771   /* Figure out the size in advance. */
772   size = 0;
773   for (i = 0; i < n_vars; i++)
774     {
775       struct variable *var = dict_get_var (dict, i);
776       const struct val_labs *val_labs = var_get_value_labels (var);
777       int width = var_get_width (var);
778       const struct val_lab *val_lab;
779
780       if (val_labs_count (val_labs) == 0 || width < 9)
781         continue;
782
783       size += 12 + strlen (var_get_name (var));
784       for (val_lab = val_labs_first (val_labs); val_lab != NULL;
785            val_lab = val_labs_next (val_labs, val_lab))
786         size += 8 + width + strlen (val_lab_get_escaped_label (val_lab));
787     }
788   if (size == 0)
789     return;
790
791   write_int (w, 7);             /* Record type. */
792   write_int (w, 21);            /* Record subtype */
793   write_int (w, 1);             /* Data item (byte) size. */
794   write_int (w, size);          /* Number of data items. */
795
796   start = ftello (w->file);
797   for (i = 0; i < n_vars; i++)
798     {
799       struct variable *var = dict_get_var (dict, i);
800       const struct val_labs *val_labs = var_get_value_labels (var);
801       const char *var_name = var_get_name (var);
802       int width = var_get_width (var);
803       const struct val_lab *val_lab;
804
805       if (val_labs_count (val_labs) == 0 || width < 9)
806         continue;
807
808       write_int (w, strlen (var_name));
809       write_bytes (w, var_name, strlen (var_name));
810       write_int (w, width);
811       write_int (w, val_labs_count (val_labs));
812       for (val_lab = val_labs_first (val_labs); val_lab != NULL;
813            val_lab = val_labs_next (val_labs, val_lab))
814         {
815           const char *label = val_lab_get_escaped_label (val_lab);
816           size_t label_length = strlen (label);
817
818           write_int (w, width);
819           write_bytes (w, value_str (val_lab_get_value (val_lab), width),
820                        width);
821           write_int (w, label_length);
822           write_bytes (w, label, label_length);
823         }
824     }
825   assert (ftello (w->file) == start + size);
826 }
827
828 static void
829 write_encoding_record (struct sfm_writer *w,
830                        const struct dictionary *d)
831 {
832   const char *enc = dict_get_encoding (d);
833
834   if ( NULL == enc)
835     return;
836
837   write_int (w, 7);             /* Record type. */
838   write_int (w, 20);            /* Record subtype. */
839   write_int (w, 1);             /* Data item (char) size. */
840   write_int (w, strlen (enc));  /* Number of data items. */
841   write_string (w, enc, strlen (enc));
842 }
843
844
845 /* Writes the long variable name table. */
846 static void
847 write_longvar_table (struct sfm_writer *w, const struct dictionary *dict)
848 {
849   struct string map;
850   size_t i;
851
852   ds_init_empty (&map);
853   for (i = 0; i < dict_get_var_cnt (dict); i++)
854     {
855       struct variable *v = dict_get_var (dict, i);
856       char *longname = recode_string (dict_get_encoding (dict), UTF8, var_get_name (v), -1);
857
858       if (i)
859         ds_put_byte (&map, '\t');
860       ds_put_format (&map, "%s=%s",
861                      var_get_short_name (v, 0), longname);
862       free (longname);
863     }
864
865   write_int (w, 7);             /* Record type. */
866   write_int (w, 13);            /* Record subtype. */
867   write_int (w, 1);             /* Data item (char) size. */
868   write_int (w, ds_length (&map)); /* Number of data items. */
869   write_bytes (w, ds_data (&map), ds_length (&map));
870
871   ds_destroy (&map);
872 }
873
874 /* Write integer information record. */
875 static void
876 write_integer_info_record (struct sfm_writer *w)
877 {
878   int version_component[3];
879   int float_format;
880
881   /* Parse the version string. */
882   memset (version_component, 0, sizeof version_component);
883   sscanf (bare_version, "%d.%d.%d",
884           &version_component[0], &version_component[1], &version_component[2]);
885
886   /* Figure out the floating-point format. */
887   if (FLOAT_NATIVE_64_BIT == FLOAT_IEEE_DOUBLE_LE
888       || FLOAT_NATIVE_64_BIT == FLOAT_IEEE_DOUBLE_BE)
889     float_format = 1;
890   else if (FLOAT_NATIVE_64_BIT == FLOAT_Z_LONG)
891     float_format = 2;
892   else if (FLOAT_NATIVE_64_BIT == FLOAT_VAX_D)
893     float_format = 3;
894   else
895     abort ();
896
897   /* Write record. */
898   write_int (w, 7);             /* Record type. */
899   write_int (w, 3);             /* Record subtype. */
900   write_int (w, 4);             /* Data item (int32) size. */
901   write_int (w, 8);             /* Number of data items. */
902   write_int (w, version_component[0]);
903   write_int (w, version_component[1]);
904   write_int (w, version_component[2]);
905   write_int (w, -1);          /* Machine code. */
906   write_int (w, float_format);
907   write_int (w, 1);           /* Compression code. */
908   write_int (w, INTEGER_NATIVE == INTEGER_MSB_FIRST ? 1 : 2);
909   write_int (w, 2);           /* 7-bit ASCII. */
910 }
911
912 /* Write floating-point information record. */
913 static void
914 write_float_info_record (struct sfm_writer *w)
915 {
916   write_int (w, 7);             /* Record type. */
917   write_int (w, 4);             /* Record subtype. */
918   write_int (w, 8);             /* Data item (flt64) size. */
919   write_int (w, 3);             /* Number of data items. */
920   write_float (w, SYSMIS);      /* System-missing value. */
921   write_float (w, HIGHEST);     /* Value used for HIGHEST in missing values. */
922   write_float (w, LOWEST);      /* Value used for LOWEST in missing values. */
923 }
924 \f
925 /* Writes case C to system file W. */
926 static void
927 sys_file_casewriter_write (struct casewriter *writer, void *w_,
928                            struct ccase *c)
929 {
930   struct sfm_writer *w = w_;
931
932   if (ferror (w->file))
933     {
934       casewriter_force_error (writer);
935       case_unref (c);
936       return;
937     }
938
939   w->case_cnt++;
940
941   if (!w->compress)
942     write_case_uncompressed (w, c);
943   else
944     write_case_compressed (w, c);
945
946   case_unref (c);
947 }
948
949 /* Destroys system file writer W. */
950 static void
951 sys_file_casewriter_destroy (struct casewriter *writer, void *w_)
952 {
953   struct sfm_writer *w = w_;
954   if (!close_writer (w))
955     casewriter_force_error (writer);
956 }
957
958 /* Returns true if an I/O error has occurred on WRITER, false otherwise. */
959 static bool
960 write_error (const struct sfm_writer *writer)
961 {
962   return ferror (writer->file);
963 }
964
965 /* Closes a system file after we're done with it.
966    Returns true if successful, false if an I/O error occurred. */
967 static bool
968 close_writer (struct sfm_writer *w)
969 {
970   bool ok;
971
972   if (w == NULL)
973     return true;
974
975   ok = true;
976   if (w->file != NULL)
977     {
978       /* Flush buffer. */
979       if (w->opcode_cnt > 0)
980         flush_compressed (w);
981       fflush (w->file);
982
983       ok = !write_error (w);
984
985       /* Seek back to the beginning and update the number of cases.
986          This is just a courtesy to later readers, so there's no need
987          to check return values or report errors. */
988       if (ok && w->case_cnt <= INT32_MAX && !fseeko (w->file, 80, SEEK_SET))
989         {
990           write_int (w, w->case_cnt);
991           clearerr (w->file);
992         }
993
994       if (fclose (w->file) == EOF)
995         ok = false;
996
997       if (!ok)
998         msg (ME, _("An I/O error occurred writing system file `%s'."),
999              fh_get_file_name (w->fh));
1000
1001       if (ok ? !replace_file_commit (w->rf) : !replace_file_abort (w->rf))
1002         ok = false;
1003     }
1004
1005   fh_unlock (w->lock);
1006   fh_unref (w->fh);
1007
1008   free (w->sfm_vars);
1009   free (w);
1010
1011   return ok;
1012 }
1013
1014 /* System file writer casewriter class. */
1015 static const struct casewriter_class sys_file_casewriter_class =
1016   {
1017     sys_file_casewriter_write,
1018     sys_file_casewriter_destroy,
1019     NULL,
1020   };
1021 \f
1022 /* Writes case C to system file W, without compressing it. */
1023 static void
1024 write_case_uncompressed (struct sfm_writer *w, const struct ccase *c)
1025 {
1026   size_t i;
1027
1028   for (i = 0; i < w->sfm_var_cnt; i++)
1029     {
1030       struct sfm_var *v = &w->sfm_vars[i];
1031
1032       if (v->var_width == 0)
1033         write_float (w, case_num_idx (c, v->case_index));
1034       else
1035         {
1036           write_bytes (w, case_str_idx (c, v->case_index) + v->offset,
1037                        v->segment_width);
1038           write_spaces (w, v->padding);
1039         }
1040     }
1041 }
1042
1043 /* Writes case C to system file W, with compression. */
1044 static void
1045 write_case_compressed (struct sfm_writer *w, const struct ccase *c)
1046 {
1047   size_t i;
1048
1049   for (i = 0; i < w->sfm_var_cnt; i++)
1050     {
1051       struct sfm_var *v = &w->sfm_vars[i];
1052
1053       if (v->var_width == 0)
1054         {
1055           double d = case_num_idx (c, v->case_index);
1056           if (d == SYSMIS)
1057             put_cmp_opcode (w, 255);
1058           else if (d >= 1 - COMPRESSION_BIAS
1059                    && d <= 251 - COMPRESSION_BIAS
1060                    && d == (int) d)
1061             put_cmp_opcode (w, (int) d + COMPRESSION_BIAS);
1062           else
1063             {
1064               put_cmp_opcode (w, 253);
1065               put_cmp_number (w, d);
1066             }
1067         }
1068       else
1069         {
1070           int offset = v->offset;
1071           int width, padding;
1072
1073           /* This code properly deals with a width that is not a
1074              multiple of 8, by ensuring that the final partial
1075              oct (8 byte unit) is treated as padded with spaces
1076              on the right. */
1077           for (width = v->segment_width; width > 0; width -= 8, offset += 8)
1078             {
1079               const void *data = case_str_idx (c, v->case_index) + offset;
1080               int chunk_size = MIN (width, 8);
1081               if (!memcmp (data, "        ", chunk_size))
1082                 put_cmp_opcode (w, 254);
1083               else
1084                 {
1085                   put_cmp_opcode (w, 253);
1086                   put_cmp_string (w, data, chunk_size);
1087                 }
1088             }
1089
1090           /* This code deals properly with padding that is not a
1091              multiple of 8 bytes, by discarding the remainder,
1092              which was already effectively padded with spaces in
1093              the previous loop.  (Note that v->width + v->padding
1094              is always a multiple of 8.) */
1095           for (padding = v->padding / 8; padding > 0; padding--)
1096             put_cmp_opcode (w, 254);
1097         }
1098     }
1099 }
1100
1101 /* Flushes buffered compressed opcodes and data to W.
1102    The compression buffer must not be empty. */
1103 static void
1104 flush_compressed (struct sfm_writer *w)
1105 {
1106   assert (w->opcode_cnt > 0 && w->opcode_cnt <= 8);
1107
1108   write_bytes (w, w->opcodes, w->opcode_cnt);
1109   write_zeros (w, 8 - w->opcode_cnt);
1110
1111   write_bytes (w, w->data, w->data_cnt * sizeof *w->data);
1112
1113   w->opcode_cnt = w->data_cnt = 0;
1114 }
1115
1116 /* Appends OPCODE to the buffered set of compression opcodes in
1117    W.  Flushes the compression buffer beforehand if necessary. */
1118 static void
1119 put_cmp_opcode (struct sfm_writer *w, uint8_t opcode)
1120 {
1121   if (w->opcode_cnt >= 8)
1122     flush_compressed (w);
1123
1124   w->opcodes[w->opcode_cnt++] = opcode;
1125 }
1126
1127 /* Appends NUMBER to the buffered compression data in W.  The
1128    buffer must not be full; the way to assure that is to call
1129    this function only just after a call to put_cmp_opcode, which
1130    will flush the buffer as necessary. */
1131 static void
1132 put_cmp_number (struct sfm_writer *w, double number)
1133 {
1134   assert (w->opcode_cnt > 0);
1135   assert (w->data_cnt < 8);
1136
1137   convert_double_to_output_format (number, w->data[w->data_cnt++]);
1138 }
1139
1140 /* Appends SIZE bytes of DATA to the buffered compression data in
1141    W, followed by enough spaces to pad the output data to exactly
1142    8 bytes (thus, SIZE must be no greater than 8).  The buffer
1143    must not be full; the way to assure that is to call this
1144    function only just after a call to put_cmp_opcode, which will
1145    flush the buffer as necessary. */
1146 static void
1147 put_cmp_string (struct sfm_writer *w, const void *data, size_t size)
1148 {
1149   assert (w->opcode_cnt > 0);
1150   assert (w->data_cnt < 8);
1151   assert (size <= 8);
1152
1153   memset (w->data[w->data_cnt], ' ', 8);
1154   memcpy (w->data[w->data_cnt], data, size);
1155   w->data_cnt++;
1156 }
1157 \f
1158 /* Writes 32-bit integer X to the output file for writer W. */
1159 static void
1160 write_int (struct sfm_writer *w, int32_t x)
1161 {
1162   write_bytes (w, &x, sizeof x);
1163 }
1164
1165 /* Converts NATIVE to the 64-bit format used in output files in
1166    OUTPUT. */
1167 static inline void
1168 convert_double_to_output_format (double native, uint8_t output[8])
1169 {
1170   /* If "double" is not a 64-bit type, then convert it to a
1171      64-bit type.  Otherwise just copy it. */
1172   if (FLOAT_NATIVE_DOUBLE != FLOAT_NATIVE_64_BIT)
1173     float_convert (FLOAT_NATIVE_DOUBLE, &native, FLOAT_NATIVE_64_BIT, output);
1174   else
1175     memcpy (output, &native, sizeof native);
1176 }
1177
1178 /* Writes floating-point number X to the output file for writer
1179    W. */
1180 static void
1181 write_float (struct sfm_writer *w, double x)
1182 {
1183   uint8_t output[8];
1184   convert_double_to_output_format (x, output);
1185   write_bytes (w, output, sizeof output);
1186 }
1187
1188 /* Writes contents of VALUE with the given WIDTH to W, padding
1189    with zeros to a multiple of 8 bytes.
1190    To avoid a branch, and because we don't actually need to
1191    support it, WIDTH must be no bigger than 8. */
1192 static void
1193 write_value (struct sfm_writer *w, const union value *value, int width)
1194 {
1195   assert (width <= 8);
1196   if (width == 0)
1197     write_float (w, value->f);
1198   else
1199     {
1200       write_bytes (w, value_str (value, width), width);
1201       write_zeros (w, 8 - width);
1202     }
1203 }
1204
1205 /* Writes null-terminated STRING in a field of the given WIDTH to
1206    W.  If STRING is longer than WIDTH, it is truncated; if WIDTH
1207    is narrowed, it is padded on the right with spaces. */
1208 static void
1209 write_string (struct sfm_writer *w, const char *string, size_t width)
1210 {
1211   size_t data_bytes = MIN (strlen (string), width);
1212   size_t pad_bytes = width - data_bytes;
1213   write_bytes (w, string, data_bytes);
1214   while (pad_bytes-- > 0)
1215     putc (' ', w->file);
1216 }
1217
1218 /* Writes SIZE bytes of DATA to W's output file. */
1219 static void
1220 write_bytes (struct sfm_writer *w, const void *data, size_t size)
1221 {
1222   fwrite (data, 1, size, w->file);
1223 }
1224
1225 /* Writes N zeros to W's output file. */
1226 static void
1227 write_zeros (struct sfm_writer *w, size_t n)
1228 {
1229   while (n-- > 0)
1230     putc (0, w->file);
1231 }
1232
1233 /* Writes N spaces to W's output file. */
1234 static void
1235 write_spaces (struct sfm_writer *w, size_t n)
1236 {
1237   while (n-- > 0)
1238     putc (' ', w->file);
1239 }