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