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