src/data/sys-file-writer.c

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