src/data/sys-file-writer.c

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