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