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/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 label_len = MIN (strlen (label), 255);
 440       size_t padded_len = ROUND_UP (label_len, 4);
 441       write_int (w, label_len);
 442       write_string (w, label, padded_len);
 443     }
 444
 445   /* Write the missing values, if any, range first. */
 446   if (mv_has_range (mv))
 447     {
 448       double x, y;
 449       mv_get_range (mv, &x, &y);
 450       write_float (w, x);
 451       write_float (w, y);
 452     }
 453   for (i = 0; i < mv_n_values (mv); i++)
 454     {
 455       union value value;
 456       mv_get_value (mv, &value, i);
 457       write_value (w, &value, seg0_width);
 458     }
 459
 460   write_variable_continuation_records (w, seg0_width);
 461
 462   /* Write additional segments for very long string variables. */
 463   for (i = 1; i < segment_cnt; i++)
 464     {
 465       int seg_width = sfm_segment_alloc_width (width, i);
 466       struct fmt_spec fmt = fmt_for_output (FMT_A, MAX (seg_width, 1), 0);
 467
 468       write_int (w, 2);           /* Variable record. */
 469       write_int (w, seg_width);   /* Width. */
 470       write_int (w, 0);           /* No variable label. */
 471       write_int (w, 0);           /* No missing values. */
 472       write_format (w, fmt, seg_width); /* Print format. */
 473       write_format (w, fmt, seg_width); /* Write format. */
 474       write_string (w, var_get_short_name (v, i), 8);
 475
 476       write_variable_continuation_records (w, seg_width);
 477     }
 478 }
 479
 480 /* Writes the value labels for variable V having system file
 481    variable index IDX to system file W. */
 482 static void
 483 write_value_labels (struct sfm_writer *w, struct variable *v, int idx)
 484 {
 485   const struct val_labs *val_labs;
 486   struct val_labs_iterator *i;
 487   struct val_lab *vl;
 488
 489   val_labs = var_get_value_labels (v);
 490   if (val_labs == NULL)
 491     return;
 492
 493   /* Value label record. */
 494   write_int (w, 3);             /* Record type. */
 495   write_int (w, val_labs_count (val_labs));
 496   for (vl = val_labs_first_sorted (val_labs, &i); vl != NULL;
 497        vl = val_labs_next (val_labs, &i))
 498     {
 499       uint8_t len = MIN (strlen (vl->label), 255);
 500
 501       write_value (w, &vl->value, var_get_width (v));
 502       write_bytes (w, &len, 1);
 503       write_bytes (w, vl->label, len);
 504       write_zeros (w, REM_RND_UP (len + 1, 8));
 505     }
 506
 507   /* Value label variable record. */
 508   write_int (w, 4);             /* Record type. */
 509   write_int (w, 1);             /* Number of variables. */
 510   write_int (w, idx + 1);       /* Variable's dictionary index. */
 511 }
 512
 513 /* Writes record type 6, document record. */
 514 static void
 515 write_documents (struct sfm_writer *w, const struct dictionary *d)
 516 {
 517   size_t line_cnt = dict_get_document_line_cnt (d);
 518
 519   write_int (w, 6);             /* Record type. */
 520   write_int (w, line_cnt);
 521   write_bytes (w, dict_get_documents (d), line_cnt * DOC_LINE_LENGTH);
 522 }
 523
 524 /* Write the alignment, width and scale values. */
 525 static void
 526 write_variable_display_parameters (struct sfm_writer *w,
 527                                    const struct dictionary *dict)
 528 {
 529   int i;
 530
 531   write_int (w, 7);             /* Record type. */
 532   write_int (w, 11);            /* Record subtype. */
 533   write_int (w, 4);             /* Data item (int32) size. */
 534   write_int (w, w->segment_cnt * 3); /* Number of data items. */
 535
 536   for (i = 0; i < dict_get_var_cnt (dict); ++i)
 537     {
 538       struct variable *v = dict_get_var (dict, i);
 539       int width = var_get_width (v);
 540       int segment_cnt = sfm_width_to_segments (width);
 541       int measure = (var_get_measure (v) == MEASURE_NOMINAL ? 1
 542                      : var_get_measure (v) == MEASURE_ORDINAL ? 2
 543                      : 3);
 544       int alignment = (var_get_alignment (v) == ALIGN_LEFT ? 0
 545                        : var_get_alignment (v) == ALIGN_RIGHT ? 1
 546                        : 2);
 547       int i;
 548
 549       for (i = 0; i < segment_cnt; i++)
 550         {
 551           int width_left = width - sfm_segment_effective_offset (width, i);
 552           write_int (w, measure);
 553           write_int (w, (i == 0 ? var_get_display_width (v)
 554                          : var_default_display_width (width_left)));
 555           write_int (w, alignment);
 556         }
 557     }
 558 }
 559
 560 /* Writes the table of lengths for very long string variables. */
 561 static void
 562 write_vls_length_table (struct sfm_writer *w,
 563                         const struct dictionary *dict)
 564 {
 565   struct string map;
 566   int i;
 567
 568   ds_init_empty (&map);
 569   for (i = 0; i < dict_get_var_cnt (dict); ++i)
 570     {
 571       const struct variable *v = dict_get_var (dict, i);
 572       if (sfm_width_to_segments (var_get_width (v)) > 1)
 573         ds_put_format (&map, "%s=%05d%c\t",
 574                        var_get_short_name (v, 0), var_get_width (v), 0);
 575     }
 576   if (!ds_is_empty (&map))
 577     {
 578       write_int (w, 7);         /* Record type. */
 579       write_int (w, 14);        /* Record subtype. */
 580       write_int (w, 1);         /* Data item (char) size. */
 581       write_int (w, ds_length (&map)); /* Number of data items. */
 582       write_bytes (w, ds_data (&map), ds_length (&map));
 583     }
 584   ds_destroy (&map);
 585 }
 586
 587 /* Writes the long variable name table. */
 588 static void
 589 write_longvar_table (struct sfm_writer *w, const struct dictionary *dict)
 590 {
 591   struct string map;
 592   size_t i;
 593
 594   ds_init_empty (&map);
 595   for (i = 0; i < dict_get_var_cnt (dict); i++)
 596     {
 597       struct variable *v = dict_get_var (dict, i);
 598
 599       if (i)
 600         ds_put_char (&map, '\t');
 601       ds_put_format (&map, "%s=%s",
 602                      var_get_short_name (v, 0), var_get_name (v));
 603     }
 604
 605   write_int (w, 7);             /* Record type. */
 606   write_int (w, 13);            /* Record subtype. */
 607   write_int (w, 1);             /* Data item (char) size. */
 608   write_int (w, ds_length (&map)); /* Number of data items. */
 609   write_bytes (w, ds_data (&map), ds_length (&map));
 610
 611   ds_destroy (&map);
 612 }
 613
 614 /* Write integer information record. */
 615 static void
 616 write_integer_info_record (struct sfm_writer *w)
 617 {
 618   int version_component[3];
 619   int float_format;
 620
 621   /* Parse the version string. */
 622   memset (version_component, 0, sizeof version_component);
 623   sscanf (bare_version, "%d.%d.%d",
 624           &version_component[0], &version_component[1], &version_component[2]);
 625
 626   /* Figure out the floating-point format. */
 627   if (FLOAT_NATIVE_64_BIT == FLOAT_IEEE_DOUBLE_LE
 628       || FLOAT_NATIVE_64_BIT == FLOAT_IEEE_DOUBLE_BE)
 629     float_format = 1;
 630   else if (FLOAT_NATIVE_64_BIT == FLOAT_Z_LONG)
 631     float_format = 2;
 632   else if (FLOAT_NATIVE_64_BIT == FLOAT_VAX_D)
 633     float_format = 3;
 634   else
 635     abort ();
 636
 637   /* Write record. */
 638   write_int (w, 7);             /* Record type. */
 639   write_int (w, 3);             /* Record subtype. */
 640   write_int (w, 4);             /* Data item (int32) size. */
 641   write_int (w, 8);             /* Number of data items. */
 642   write_int (w, version_component[0]);
 643   write_int (w, version_component[1]);
 644   write_int (w, version_component[2]);
 645   write_int (w, -1);          /* Machine code. */
 646   write_int (w, float_format);
 647   write_int (w, 1);           /* Compression code. */
 648   write_int (w, INTEGER_NATIVE == INTEGER_MSB_FIRST ? 1 : 2);
 649   write_int (w, 2);           /* 7-bit ASCII. */
 650 }
 651
 652 /* Write floating-point information record. */
 653 static void
 654 write_float_info_record (struct sfm_writer *w)
 655 {
 656   write_int (w, 7);             /* Record type. */
 657   write_int (w, 4);             /* Record subtype. */
 658   write_int (w, 8);             /* Data item (flt64) size. */
 659   write_int (w, 3);             /* Number of data items. */
 660   write_float (w, SYSMIS);      /* System-missing value. */
 661   write_float (w, HIGHEST);     /* Value used for HIGHEST in missing values. */
 662   write_float (w, LOWEST);      /* Value used for LOWEST in missing values. */
 663 }
 664 \f
 665 /* Writes case C to system file W. */
 666 static void
 667 sys_file_casewriter_write (struct casewriter *writer, void *w_,
 668                            struct ccase *c)
 669 {
 670   struct sfm_writer *w = w_;
 671
 672   if (ferror (w->file))
 673     {
 674       casewriter_force_error (writer);
 675       case_destroy (c);
 676       return;
 677     }
 678
 679   w->case_cnt++;
 680
 681   if (!w->compress)
 682     write_case_uncompressed (w, c);
 683   else
 684     write_case_compressed (w, c);
 685
 686   case_destroy (c);
 687 }
 688
 689 /* Destroys system file writer W. */
 690 static void
 691 sys_file_casewriter_destroy (struct casewriter *writer, void *w_)
 692 {
 693   struct sfm_writer *w = w_;
 694   if (!close_writer (w))
 695     casewriter_force_error (writer);
 696 }
 697
 698 /* Returns true if an I/O error has occurred on WRITER, false otherwise. */
 699 bool
 700 write_error (const struct sfm_writer *writer)
 701 {
 702   return ferror (writer->file);
 703 }
 704
 705 /* Closes a system file after we're done with it.
 706    Returns true if successful, false if an I/O error occurred. */
 707 bool
 708 close_writer (struct sfm_writer *w)
 709 {
 710   bool ok;
 711
 712   if (w == NULL)
 713     return true;
 714
 715   ok = true;
 716   if (w->file != NULL)
 717     {
 718       /* Flush buffer. */
 719       if (w->opcode_cnt > 0)
 720         flush_compressed (w);
 721       fflush (w->file);
 722
 723       ok = !write_error (w);
 724
 725       /* Seek back to the beginning and update the number of cases.
 726          This is just a courtesy to later readers, so there's no need
 727          to check return values or report errors. */
 728       if (ok && w->case_cnt <= INT32_MAX && !fseek (w->file, 80, SEEK_SET))
 729         {
 730           write_int (w, w->case_cnt);
 731           clearerr (w->file);
 732         }
 733
 734       if (fclose (w->file) == EOF)
 735         ok = false;
 736
 737       if (!ok)
 738         msg (ME, _("An I/O error occurred writing system file \"%s\"."),
 739              fh_get_file_name (w->fh));
 740
 741       if (ok ? !replace_file_commit (w->rf) : !replace_file_abort (w->rf))
 742         ok = false;
 743     }
 744
 745   fh_unlock (w->lock);
 746   fh_unref (w->fh);
 747
 748   free (w->sfm_vars);
 749   free (w);
 750
 751   return ok;
 752 }
 753
 754 /* System file writer casewriter class. */
 755 static const struct casewriter_class sys_file_casewriter_class =
 756   {
 757     sys_file_casewriter_write,
 758     sys_file_casewriter_destroy,
 759     NULL,
 760   };
 761 \f
 762 /* Writes case C to system file W, without compressing it. */
 763 static void
 764 write_case_uncompressed (struct sfm_writer *w, struct ccase *c)
 765 {
 766   size_t i;
 767
 768   for (i = 0; i < w->sfm_var_cnt; i++)
 769     {
 770       struct sfm_var *v = &w->sfm_vars[i];
 771
 772       if (v->width == 0)
 773         write_float (w, case_num_idx (c, v->case_index));
 774       else
 775         {
 776           write_bytes (w, case_str_idx (c, v->case_index) + v->offset,
 777                        v->width);
 778           write_spaces (w, v->padding);
 779         }
 780     }
 781 }
 782
 783 /* Writes case C to system file W, with compression. */
 784 static void
 785 write_case_compressed (struct sfm_writer *w, struct ccase *c)
 786 {
 787   size_t i;
 788
 789   for (i = 0; i < w->sfm_var_cnt; i++)
 790     {
 791       struct sfm_var *v = &w->sfm_vars[i];
 792
 793       if (v->width == 0)
 794         {
 795           double d = case_num_idx (c, v->case_index);
 796           if (d == SYSMIS)
 797             put_cmp_opcode (w, 255);
 798           else if (d >= 1 - COMPRESSION_BIAS
 799                    && d <= 251 - COMPRESSION_BIAS
 800                    && d == (int) d)
 801             put_cmp_opcode (w, (int) d + COMPRESSION_BIAS);
 802           else
 803             {
 804               put_cmp_opcode (w, 253);
 805               put_cmp_number (w, d);
 806             }
 807         }
 808       else
 809         {
 810           int offset = v->offset;
 811           int width, padding;
 812
 813           /* This code properly deals with a width that is not a
 814              multiple of 8, by ensuring that the final partial
 815              oct (8 byte unit) is treated as padded with spaces
 816              on the right. */
 817           for (width = v->width; width > 0; width -= 8, offset += 8)
 818             {
 819               const void *data = case_str_idx (c, v->case_index) + offset;
 820               int chunk_size = MIN (width, 8);
 821               if (!memcmp (data, "        ", chunk_size))
 822                 put_cmp_opcode (w, 254);
 823               else
 824                 {
 825                   put_cmp_opcode (w, 253);
 826                   put_cmp_string (w, data, chunk_size);
 827                 }
 828             }
 829
 830           /* This code deals properly with padding that is not a
 831              multiple of 8 bytes, by discarding the remainder,
 832              which was already effectively padded with spaces in
 833              the previous loop.  (Note that v->width + v->padding
 834              is always a multiple of 8.) */
 835           for (padding = v->padding / 8; padding > 0; padding--)
 836             put_cmp_opcode (w, 254);
 837         }
 838     }
 839 }
 840
 841 /* Flushes buffered compressed opcodes and data to W.
 842    The compression buffer must not be empty. */
 843 static void
 844 flush_compressed (struct sfm_writer *w)
 845 {
 846   assert (w->opcode_cnt > 0 && w->opcode_cnt <= 8);
 847
 848   write_bytes (w, w->opcodes, w->opcode_cnt);
 849   write_zeros (w, 8 - w->opcode_cnt);
 850
 851   write_bytes (w, w->data, w->data_cnt * sizeof *w->data);
 852
 853   w->opcode_cnt = w->data_cnt = 0;
 854 }
 855
 856 /* Appends OPCODE to the buffered set of compression opcodes in
 857    W.  Flushes the compression buffer beforehand if necessary. */
 858 static void
 859 put_cmp_opcode (struct sfm_writer *w, uint8_t opcode)
 860 {
 861   if (w->opcode_cnt >= 8)
 862     flush_compressed (w);
 863
 864   w->opcodes[w->opcode_cnt++] = opcode;
 865 }
 866
 867 /* Appends NUMBER to the buffered compression data in W.  The
 868    buffer must not be full; the way to assure that is to call
 869    this function only just after a call to put_cmp_opcode, which
 870    will flush the buffer as necessary. */
 871 static void
 872 put_cmp_number (struct sfm_writer *w, double number)
 873 {
 874   assert (w->opcode_cnt > 0);
 875   assert (w->data_cnt < 8);
 876
 877   convert_double_to_output_format (number, w->data[w->data_cnt++]);
 878 }
 879
 880 /* Appends SIZE bytes of DATA to the buffered compression data in
 881    W, followed by enough spaces to pad the output data to exactly
 882    8 bytes (thus, SIZE must be no greater than 8).  The buffer
 883    must not be full; the way to assure that is to call this
 884    function only just after a call to put_cmp_opcode, which will
 885    flush the buffer as necessary. */
 886 static void
 887 put_cmp_string (struct sfm_writer *w, const void *data, size_t size)
 888 {
 889   assert (w->opcode_cnt > 0);
 890   assert (w->data_cnt < 8);
 891   assert (size <= 8);
 892
 893   memset (w->data[w->data_cnt], ' ', 8);
 894   memcpy (w->data[w->data_cnt], data, size);
 895   w->data_cnt++;
 896 }
 897 \f
 898 /* Writes 32-bit integer X to the output file for writer W. */
 899 static void
 900 write_int (struct sfm_writer *w, int32_t x)
 901 {
 902   write_bytes (w, &x, sizeof x);
 903 }
 904
 905 /* Converts NATIVE to the 64-bit format used in output files in
 906    OUTPUT. */
 907 static inline void
 908 convert_double_to_output_format (double native, uint8_t output[8])
 909 {
 910   /* If "double" is not a 64-bit type, then convert it to a
 911      64-bit type.  Otherwise just copy it. */
 912   if (FLOAT_NATIVE_DOUBLE != FLOAT_NATIVE_64_BIT)
 913     float_convert (FLOAT_NATIVE_DOUBLE, &native, FLOAT_NATIVE_64_BIT, output);
 914   else
 915     memcpy (output, &native, sizeof native);
 916 }
 917
 918 /* Writes floating-point number X to the output file for writer
 919    W. */
 920 static void
 921 write_float (struct sfm_writer *w, double x)
 922 {
 923   uint8_t output[8];
 924   convert_double_to_output_format (x, output);
 925   write_bytes (w, output, sizeof output);
 926 }
 927
 928 /* Writes contents of VALUE with the given WIDTH to W, padding
 929    with zeros to a multiple of 8 bytes.
 930    To avoid a branch, and because we don't actually need to
 931    support it, WIDTH must be no bigger than 8. */
 932 static void
 933 write_value (struct sfm_writer *w, const union value *value, int width)
 934 {
 935   assert (width <= 8);
 936   if (width == 0)
 937     write_float (w, value->f);
 938   else
 939     {
 940       write_bytes (w, value->s, width);
 941       write_zeros (w, 8 - width);
 942     }
 943 }
 944
 945 /* Writes null-terminated STRING in a field of the given WIDTH to
 946    W.  If WIDTH is longer than WIDTH, it is truncated; if WIDTH
 947    is narrowed, it is padded on the right with spaces. */
 948 static void
 949 write_string (struct sfm_writer *w, const char *string, size_t width)
 950 {
 951   size_t data_bytes = MIN (strlen (string), width);
 952   size_t pad_bytes = width - data_bytes;
 953   write_bytes (w, string, data_bytes);
 954   while (pad_bytes-- > 0)
 955     putc (' ', w->file);
 956 }
 957
 958 /* Writes SIZE bytes of DATA to W's output file. */
 959 static void
 960 write_bytes (struct sfm_writer *w, const void *data, size_t size)
 961 {
 962   fwrite (data, 1, size, w->file);
 963 }
 964
 965 /* Writes N zeros to W's output file. */
 966 static void
 967 write_zeros (struct sfm_writer *w, size_t n)
 968 {
 969   while (n-- > 0)
 970     putc (0, w->file);
 971 }
 972
 973 /* Writes N spaces to W's output file. */
 974 static void
 975 write_spaces (struct sfm_writer *w, size_t n)
 976 {
 977   while (n-- > 0)
 978     putc (' ', w->file);
 979 }