src/data/por-file-writer.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000, 2006, 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 #include "por-file-writer.h"
  19
  20 #include <ctype.h>
  21 #include <errno.h>
  22 #include <float.h>
  23 #include <math.h>
  24 #include <stdio.h>
  25 #include <stdlib.h>
  26 #include <sys/stat.h>
  27 #include <time.h>
  28
  29 #include <data/case.h>
  30 #include <data/casewriter-provider.h>
  31 #include <data/casewriter.h>
  32 #include <data/dictionary.h>
  33 #include <data/file-handle-def.h>
  34 #include <data/file-name.h>
  35 #include <data/format.h>
  36 #include <data/make-file.h>
  37 #include <data/missing-values.h>
  38 #include <data/short-names.h>
  39 #include <data/value-labels.h>
  40 #include <data/variable.h>
  41
  42 #include <libpspp/hash.h>
  43 #include <libpspp/message.h>
  44 #include <libpspp/misc.h>
  45 #include <libpspp/str.h>
  46 #include <libpspp/version.h>
  47
  48 #include "minmax.h"
  49 #include "xalloc.h"
  50
  51 #include "gettext.h"
  52 #define _(msgid) gettext (msgid)
  53 #define N_(msgid) (msgid)
  54
  55 /* Maximum width of a variable in a portable file. */
  56 #define MAX_POR_WIDTH 255
  57
  58 /* Portable file writer. */
  59 struct pfm_writer
  60   {
  61     struct file_handle *fh;     /* File handle. */
  62     struct fh_lock *lock;       /* Lock on file handle. */
  63     FILE *file;                 /* File stream. */
  64     struct replace_file *rf;    /* Ticket for replacing output file. */
  65
  66     int lc;                     /* Number of characters on this line so far. */
  67
  68     size_t var_cnt;             /* Number of variables. */
  69     struct pfm_var *vars;       /* Variables. */
  70
  71     int digits;                 /* Digits of precision. */
  72   };
  73
  74 /* A variable to write to the portable file. */
  75 struct pfm_var
  76   {
  77     int width;                  /* 0=numeric, otherwise string var width. */
  78     int fv;                     /* Starting case index. */
  79   };
  80
  81 static const struct casewriter_class por_file_casewriter_class;
  82
  83 static bool close_writer (struct pfm_writer *);
  84 static void buf_write (struct pfm_writer *, const void *, size_t);
  85 static void write_header (struct pfm_writer *);
  86 static void write_version_data (struct pfm_writer *);
  87 static void write_variables (struct pfm_writer *, struct dictionary *);
  88 static void write_value_labels (struct pfm_writer *,
  89                                 const struct dictionary *);
  90 static void write_documents (struct pfm_writer *,
  91                              const struct dictionary *);
  92
  93 static void format_trig_double (long double, int base_10_precision, char[]);
  94 static char *format_trig_int (int, bool force_sign, char[]);
  95
  96 /* Returns default options for writing a portable file. */
  97 struct pfm_write_options
  98 pfm_writer_default_options (void)
  99 {
 100   struct pfm_write_options opts;
 101   opts.create_writeable = true;
 102   opts.type = PFM_COMM;
 103   opts.digits = DBL_DIG;
 104   return opts;
 105 }
 106
 107 /* Writes the dictionary DICT to portable file HANDLE according
 108    to the given OPTS.  Returns nonzero only if successful.  DICT
 109    will not be modified, except to assign short names. */
 110 struct casewriter *
 111 pfm_open_writer (struct file_handle *fh, struct dictionary *dict,
 112                  struct pfm_write_options opts)
 113 {
 114   struct pfm_writer *w = NULL;
 115   mode_t mode;
 116   size_t i;
 117
 118   /* Initialize data structures. */
 119   w = xmalloc (sizeof *w);
 120   w->fh = fh_ref (fh);
 121   w->lock = NULL;
 122   w->file = NULL;
 123   w->rf = NULL;
 124   w->lc = 0;
 125   w->var_cnt = 0;
 126   w->vars = NULL;
 127
 128   w->var_cnt = dict_get_var_cnt (dict);
 129   w->vars = xnmalloc (w->var_cnt, sizeof *w->vars);
 130   for (i = 0; i < w->var_cnt; i++)
 131     {
 132       const struct variable *dv = dict_get_var (dict, i);
 133       struct pfm_var *pv = &w->vars[i];
 134       pv->width = MIN (var_get_width (dv), MAX_POR_WIDTH);
 135       pv->fv = var_get_case_index (dv);
 136     }
 137
 138   w->digits = opts.digits;
 139   if (w->digits < 1)
 140     {
 141       msg (ME, _("Invalid decimal digits count %d.  Treating as %d."),
 142            w->digits, DBL_DIG);
 143       w->digits = DBL_DIG;
 144     }
 145
 146   /* Lock file. */
 147   /* TRANSLATORS: this fragment will be interpolated into
 148      messages in fh_lock() that identify types of files. */
 149   w->lock = fh_lock (fh, FH_REF_FILE, N_("portable file"), FH_ACC_WRITE, true);
 150   if (w->lock == NULL)
 151     goto error;
 152
 153   /* Create file. */
 154   mode = S_IRUSR | S_IRGRP | S_IROTH;
 155   if (opts.create_writeable)
 156     mode |= S_IWUSR | S_IWGRP | S_IWOTH;
 157   w->rf = replace_file_start (fh_get_file_name (fh), "w", mode,
 158                               &w->file, NULL);
 159   if (w->rf == NULL)
 160     {
 161       msg (ME, _("Error opening \"%s\" for writing as a portable file: %s."),
 162            fh_get_file_name (fh), strerror (errno));
 163       goto error;
 164     }
 165
 166   /* Write file header. */
 167   write_header (w);
 168   write_version_data (w);
 169   write_variables (w, dict);
 170   write_value_labels (w, dict);
 171   if (dict_get_document_line_cnt (dict) > 0)
 172     write_documents (w, dict);
 173   buf_write (w, "F", 1);
 174   if (ferror (w->file))
 175     goto error;
 176   return casewriter_create (dict_get_proto (dict),
 177                             &por_file_casewriter_class, w);
 178
 179 error:
 180   close_writer (w);
 181   return NULL;
 182 }
 183 \f
 184 /* Write NBYTES starting at BUF to the portable file represented by
 185    H.  Break lines properly every 80 characters.  */
 186 static void
 187 buf_write (struct pfm_writer *w, const void *buf_, size_t nbytes)
 188 {
 189   const char *buf = buf_;
 190
 191   if (ferror (w->file))
 192     return;
 193
 194   assert (buf != NULL);
 195   while (nbytes + w->lc >= 80)
 196     {
 197       size_t n = 80 - w->lc;
 198
 199       if (n)
 200         fwrite (buf, n, 1, w->file);
 201       fwrite ("\r\n", 2, 1, w->file);
 202
 203       nbytes -= n;
 204       buf += n;
 205       w->lc = 0;
 206     }
 207   fwrite (buf, nbytes, 1, w->file);
 208
 209   w->lc += nbytes;
 210 }
 211
 212 /* Write D to the portable file as a floating-point field. */
 213 static void
 214 write_float (struct pfm_writer *w, double d)
 215 {
 216   char buffer[64];
 217   format_trig_double (d, floor (d) == d ? DBL_DIG : w->digits, buffer);
 218   buf_write (w, buffer, strlen (buffer));
 219   if (d != SYSMIS)
 220     buf_write (w, "/", 1);
 221 }
 222
 223 /* Write N to the portable file as an integer field. */
 224 static void
 225 write_int (struct pfm_writer *w, int n)
 226 {
 227   char buffer[64];
 228   format_trig_int (n, false, buffer);
 229   buf_write (w, buffer, strlen (buffer));
 230   buf_write (w, "/", 1);
 231 }
 232
 233 /* Write S to the portable file as a string field. */
 234 static void
 235 write_string (struct pfm_writer *w, const char *s)
 236 {
 237   size_t n = strlen (s);
 238   write_int (w, (int) n);
 239   buf_write (w, s, n);
 240 }
 241 \f
 242 /* Write file header. */
 243 static void
 244 write_header (struct pfm_writer *w)
 245 {
 246   static const char spss2ascii[256] =
 247     {
 248       "0000000000000000000000000000000000000000000000000000000000000000"
 249       "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ."
 250       "<(+|&[]!$*);^-/|,%_>?`:$@'=\"000000~-0000123456789000-()0{}\\00000"
 251       "0000000000000000000000000000000000000000000000000000000000000000"
 252     };
 253   int i;
 254
 255   for (i = 0; i < 5; i++)
 256     buf_write (w, "ASCII SPSS PORT FILE                    ", 40);
 257
 258   buf_write (w, spss2ascii, 256);
 259   buf_write (w, "SPSSPORT", 8);
 260 }
 261
 262 /* Writes version, date, and identification records. */
 263 static void
 264 write_version_data (struct pfm_writer *w)
 265 {
 266   char date_str[9];
 267   char time_str[7];
 268   time_t t;
 269   struct tm tm;
 270   struct tm *tmp;
 271
 272   if ((time_t) -1 == time (&t))
 273     {
 274       tm.tm_sec = tm.tm_min = tm.tm_hour = tm.tm_mon = tm.tm_year = 0;
 275       tm.tm_mday = 1;
 276       tmp = &tm;
 277     }
 278   else
 279     tmp = localtime (&t);
 280
 281   sprintf (date_str, "%04d%02d%02d",
 282            tmp->tm_year + 1900, tmp->tm_mon + 1, tmp->tm_mday);
 283   sprintf (time_str, "%02d%02d%02d", tmp->tm_hour, tmp->tm_min, tmp->tm_sec);
 284   buf_write (w, "A", 1);
 285   write_string (w, date_str);
 286   write_string (w, time_str);
 287
 288   /* Product identification. */
 289   buf_write (w, "1", 1);
 290   write_string (w, version);
 291
 292   /* Subproduct identification. */
 293   buf_write (w, "3", 1);
 294   write_string (w, host_system);
 295 }
 296
 297 /* Write format F to file H.  The format is first resized to fit
 298    a value of the given WIDTH, which is handy in case F
 299    represents a string longer than 255 bytes and thus WIDTH is
 300    truncated to 255 bytes.  */
 301 static void
 302 write_format (struct pfm_writer *w, struct fmt_spec f, int width)
 303 {
 304   fmt_resize (&f, width);
 305   write_int (w, fmt_to_io (f.type));
 306   write_int (w, f.w);
 307   write_int (w, f.d);
 308 }
 309
 310 /* Write value V for variable VV to file H. */
 311 static void
 312 write_value (struct pfm_writer *w, const union value *v, struct variable *vv)
 313 {
 314   if (var_is_numeric (vv))
 315     write_float (w, v->f);
 316   else
 317     {
 318       int width = MIN (var_get_width (vv), MAX_POR_WIDTH);
 319       write_int (w, width);
 320       buf_write (w, value_str (v, width), width);
 321     }
 322 }
 323
 324 /* Write variable records. */
 325 static void
 326 write_variables (struct pfm_writer *w, struct dictionary *dict)
 327 {
 328   int i;
 329
 330   short_names_assign (dict);
 331
 332   if (dict_get_weight (dict) != NULL)
 333     {
 334       buf_write (w, "6", 1);
 335       write_string (w, var_get_short_name (dict_get_weight (dict), 0));
 336     }
 337
 338   buf_write (w, "4", 1);
 339   write_int (w, dict_get_var_cnt (dict));
 340   write_int (w, 161);
 341
 342   for (i = 0; i < dict_get_var_cnt (dict); i++)
 343     {
 344       struct variable *v = dict_get_var (dict, i);
 345       struct missing_values mv;
 346       int width = MIN (var_get_width (v), MAX_POR_WIDTH);
 347
 348       buf_write (w, "7", 1);
 349       write_int (w, width);
 350       write_string (w, var_get_short_name (v, 0));
 351       write_format (w, *var_get_print_format (v), width);
 352       write_format (w, *var_get_write_format (v), width);
 353
 354       /* Write missing values. */
 355       mv_copy (&mv, var_get_missing_values (v));
 356       while (mv_has_range (&mv))
 357         {
 358           double x, y;
 359           mv_pop_range (&mv, &x, &y);
 360           if (x == LOWEST)
 361             {
 362               buf_write (w, "9", 1);
 363               write_float (w, y);
 364             }
 365           else if (y == HIGHEST)
 366             {
 367               buf_write (w, "A", 1);
 368               write_float (w, y);
 369             }
 370           else
 371             {
 372               buf_write (w, "B", 1);
 373               write_float (w, x);
 374               write_float (w, y);
 375             }
 376         }
 377       while (mv_has_value (&mv))
 378         {
 379           union value value;
 380           mv_pop_value (&mv, &value);
 381           buf_write (w, "8", 1);
 382           write_value (w, &value, v);
 383         }
 384
 385       /* Write variable label. */
 386       if (var_get_label (v) != NULL)
 387         {
 388           buf_write (w, "C", 1);
 389           write_string (w, var_get_label (v));
 390         }
 391     }
 392 }
 393
 394 /* Write value labels to disk.  FIXME: Inefficient. */
 395 static void
 396 write_value_labels (struct pfm_writer *w, const struct dictionary *dict)
 397 {
 398   int i;
 399
 400   for (i = 0; i < dict_get_var_cnt (dict); i++)
 401     {
 402       struct variable *v = dict_get_var (dict, i);
 403       const struct val_labs *val_labs = var_get_value_labels (v);
 404       size_t n_labels = val_labs_count (val_labs);
 405       const struct val_lab **labels;
 406
 407       if (n_labels == 0)
 408         continue;
 409
 410       buf_write (w, "D", 1);
 411       write_int (w, 1);
 412       write_string (w, var_get_short_name (v, 0));
 413       write_int (w, val_labs_count (val_labs));
 414
 415       n_labels = val_labs_count (val_labs);
 416       labels = val_labs_sorted (val_labs);
 417       for (i = 0; i < n_labels; i++)
 418         {
 419           const struct val_lab *vl = labels[i];
 420           write_value (w, val_lab_get_value (vl), v);
 421           write_string (w, val_lab_get_label (vl));
 422         }
 423       free (labels);
 424     }
 425 }
 426
 427 /* Write documents in DICT to portable file W. */
 428 static void
 429 write_documents (struct pfm_writer *w, const struct dictionary *dict)
 430 {
 431   size_t line_cnt = dict_get_document_line_cnt (dict);
 432   struct string line = DS_EMPTY_INITIALIZER;
 433   int i;
 434
 435   buf_write (w, "E", 1);
 436   write_int (w, line_cnt);
 437   for (i = 0; i < line_cnt; i++)
 438     {
 439       dict_get_document_line (dict, i, &line);
 440       write_string (w, ds_cstr (&line));
 441     }
 442   ds_destroy (&line);
 443 }
 444
 445 /* Writes case C to the portable file represented by WRITER. */
 446 static void
 447 por_file_casewriter_write (struct casewriter *writer, void *w_,
 448                            struct ccase *c)
 449 {
 450   struct pfm_writer *w = w_;
 451   int i;
 452
 453   if (!ferror (w->file))
 454     {
 455       for (i = 0; i < w->var_cnt; i++)
 456         {
 457           struct pfm_var *v = &w->vars[i];
 458
 459           if (v->width == 0)
 460             write_float (w, case_num_idx (c, v->fv));
 461           else
 462             {
 463               write_int (w, v->width);
 464               buf_write (w, case_str_idx (c, v->fv), v->width);
 465             }
 466         }
 467     }
 468   else
 469     casewriter_force_error (writer);
 470
 471   case_unref (c);
 472 }
 473
 474 static void
 475 por_file_casewriter_destroy (struct casewriter *writer, void *w_)
 476 {
 477   struct pfm_writer *w = w_;
 478   if (!close_writer (w))
 479     casewriter_force_error (writer);
 480 }
 481
 482 /* Closes a portable file after we're done with it.
 483    Returns true if successful, false if an I/O error occurred. */
 484 static bool
 485 close_writer (struct pfm_writer *w)
 486 {
 487   bool ok;
 488
 489   if (w == NULL)
 490     return true;
 491
 492   ok = true;
 493   if (w->file != NULL)
 494     {
 495       char buf[80];
 496       memset (buf, 'Z', sizeof buf);
 497       buf_write (w, buf, w->lc >= 80 ? 80 : 80 - w->lc);
 498
 499       ok = !ferror (w->file);
 500       if (fclose (w->file) == EOF)
 501         ok = false;
 502
 503       if (!ok)
 504         msg (ME, _("An I/O error occurred writing portable file \"%s\"."),
 505              fh_get_file_name (w->fh));
 506
 507       if (ok ? !replace_file_commit (w->rf) : !replace_file_abort (w->rf))
 508         ok = false;
 509     }
 510
 511   fh_unlock (w->lock);
 512   fh_unref (w->fh);
 513
 514   free (w->vars);
 515   free (w);
 516
 517   return ok;
 518 }
 519 \f
 520 /* Base-30 conversion.
 521
 522    Portable files represent numbers in base-30 format, so we need
 523    to be able to convert real and integer number to that base.
 524    Older versions of PSPP used libgmp to do so, but this added a
 525    big library dependency to do just one thing.  Now we do it
 526    ourselves internally.
 527
 528    Important fact: base 30 is called "trigesimal". */
 529
 530 /* Conversion base. */
 531 #define BASE 30                         /* As an integer. */
 532 #define LDBASE ((long double) BASE)     /* As a long double. */
 533
 534 /* This is floor(log30(2**31)), the minimum number of trigesimal
 535    digits that a `long int' can hold. */
 536 #define CHUNK_SIZE 6
 537
 538 /* pow_tab[i] = pow (30, pow (2, i)) */
 539 static long double pow_tab[16];
 540
 541 /* Initializes pow_tab[]. */
 542 static void
 543 init_pow_tab (void)
 544 {
 545   static bool did_init = false;
 546   long double power;
 547   size_t i;
 548
 549   /* Only initialize once. */
 550   if (did_init)
 551     return;
 552   did_init = true;
 553
 554   /* Set each element of pow_tab[] until we run out of numerical
 555      range. */
 556   i = 0;
 557   for (power = 30.0L; power < DBL_MAX; power *= power)
 558     {
 559       assert (i < sizeof pow_tab / sizeof *pow_tab);
 560       pow_tab[i++] = power;
 561     }
 562 }
 563
 564 /* Returns 30**EXPONENT, for 0 <= EXPONENT <= log30(DBL_MAX). */
 565 static long double
 566 pow30_nonnegative (int exponent)
 567 {
 568   long double power;
 569   int i;
 570
 571   assert (exponent >= 0);
 572   assert (exponent < 1L << (sizeof pow_tab / sizeof *pow_tab));
 573
 574   power = 1.L;
 575   for (i = 0; exponent > 0; exponent >>= 1, i++)
 576     if (exponent & 1)
 577       power *= pow_tab[i];
 578
 579   return power;
 580 }
 581
 582 /* Returns 30**EXPONENT, for log30(DBL_MIN) <= EXPONENT <=
 583    log30(DBL_MAX). */
 584 static long double
 585 pow30 (int exponent)
 586 {
 587   if (exponent >= 0)
 588     return pow30_nonnegative (exponent);
 589   else
 590     return 1.L / pow30_nonnegative (-exponent);
 591 }
 592
 593 /* Returns the character corresponding to TRIG. */
 594 static int
 595 trig_to_char (int trig)
 596 {
 597   assert (trig >= 0 && trig < 30);
 598   return "0123456789ABCDEFGHIJKLMNOPQRST"[trig];
 599 }
 600
 601 /* Formats the TRIG_CNT trigs in TRIGS[], writing them as
 602    null-terminated STRING.  The trigesimal point is inserted
 603    after TRIG_PLACES characters have been printed, if necessary
 604    adding extra zeros at either end for correctness.  Returns the
 605    character after the formatted number. */
 606 static char *
 607 format_trig_digits (char *string,
 608                     const char trigs[], int trig_cnt, int trig_places)
 609 {
 610   if (trig_places < 0)
 611     {
 612       *string++ = '.';
 613       while (trig_places++ < 0)
 614         *string++ = '0';
 615       trig_places = -1;
 616     }
 617   while (trig_cnt-- > 0)
 618     {
 619       if (trig_places-- == 0)
 620         *string++ = '.';
 621       *string++ = trig_to_char (*trigs++);
 622     }
 623   while (trig_places-- > 0)
 624     *string++ = '0';
 625   *string = '\0';
 626   return string;
 627 }
 628
 629 /* Helper function for format_trig_int() that formats VALUE as a
 630    trigesimal integer at CP.  VALUE must be nonnegative.
 631    Returns the character following the formatted integer. */
 632 static char *
 633 recurse_format_trig_int (char *cp, int value)
 634 {
 635   int trig = value % BASE;
 636   value /= BASE;
 637   if (value > 0)
 638     cp = recurse_format_trig_int (cp, value);
 639   *cp++ = trig_to_char (trig);
 640   return cp;
 641 }
 642
 643 /* Formats VALUE as a trigesimal integer in null-terminated
 644    STRING[].  VALUE must be in the range -DBL_MAX...DBL_MAX.  If
 645    FORCE_SIGN is true, a sign is always inserted; otherwise, a
 646    sign is only inserted if VALUE is negative. */
 647 static char *
 648 format_trig_int (int value, bool force_sign, char string[])
 649 {
 650   /* Insert sign. */
 651   if (value < 0)
 652     {
 653       *string++ = '-';
 654       value = -value;
 655     }
 656   else if (force_sign)
 657     *string++ = '+';
 658
 659   /* Format integer. */
 660   string = recurse_format_trig_int (string, value);
 661   *string = '\0';
 662   return string;
 663 }
 664
 665 /* Determines whether the TRIG_CNT trigesimals in TRIGS[] warrant
 666    rounding up or down.  Returns true if TRIGS[] represents a
 667    value greater than half, false if less than half.  If TRIGS[]
 668    is exactly half, examines TRIGS[-1] and returns true if odd,
 669    false if even ("round to even"). */
 670 static bool
 671 should_round_up (const char trigs[], int trig_cnt)
 672 {
 673   assert (trig_cnt > 0);
 674
 675   if (*trigs < BASE / 2)
 676     {
 677       /* Less than half: round down. */
 678       return false;
 679     }
 680   else if (*trigs > BASE / 2)
 681     {
 682       /* Greater than half: round up. */
 683       return true;
 684     }
 685   else
 686     {
 687       /* Approximately half: look more closely. */
 688       int i;
 689       for (i = 1; i < trig_cnt; i++)
 690         if (trigs[i] > 0)
 691           {
 692             /* Slightly greater than half: round up. */
 693             return true;
 694           }
 695
 696       /* Exactly half: round to even. */
 697       return trigs[-1] % 2;
 698     }
 699 }
 700
 701 /* Rounds up the rightmost trig in the TRIG_CNT trigs in TRIGS[],
 702    carrying to the left as necessary.  Returns true if
 703    successful, false on failure (due to a carry out of the
 704    leftmost position). */
 705 static bool
 706 try_round_up (char *trigs, int trig_cnt)
 707 {
 708   while (trig_cnt > 0)
 709     {
 710       char *round_trig = trigs + --trig_cnt;
 711       if (*round_trig != BASE - 1)
 712         {
 713           /* Round this trig up to the next value. */
 714           ++*round_trig;
 715           return true;
 716         }
 717
 718       /* Carry over to the next trig to the left. */
 719       *round_trig = 0;
 720     }
 721
 722   /* Ran out of trigs to carry. */
 723   return false;
 724 }
 725
 726 /* Converts VALUE to trigesimal format in string OUTPUT[] with the
 727    equivalent of at least BASE_10_PRECISION decimal digits of
 728    precision.  The output format may use conventional or
 729    scientific notation.  Missing, infinite, and extreme values
 730    are represented with "*.". */
 731 static void
 732 format_trig_double (long double value, int base_10_precision, char output[])
 733 {
 734   /* Original VALUE was negative? */
 735   bool negative;
 736
 737   /* Number of significant trigesimals. */
 738   int base_30_precision;
 739
 740   /* Base-2 significand and exponent for original VALUE. */
 741   double base_2_sig;
 742   int base_2_exp;
 743
 744   /* VALUE as a set of trigesimals. */
 745   char buffer[DBL_DIG + 16];
 746   char *trigs;
 747   int trig_cnt;
 748
 749   /* Number of trigesimal places for trigs.
 750      trigs[0] has coefficient 30**(trig_places - 1),
 751      trigs[1] has coefficient 30**(trig_places - 2),
 752      and so on.
 753      In other words, the trigesimal point is just before trigs[0].
 754    */
 755   int trig_places;
 756
 757   /* Number of trigesimal places left to write into BUFFER. */
 758   int trigs_to_output;
 759
 760   init_pow_tab ();
 761
 762   /* Handle special cases. */
 763   if (value == SYSMIS)
 764     goto missing_value;
 765   if (value == 0.)
 766     goto zero;
 767
 768   /* Make VALUE positive. */
 769   if (value < 0)
 770     {
 771       value = -value;
 772       negative = true;
 773     }
 774   else
 775     negative = false;
 776
 777   /* Adjust VALUE to roughly 30**3, by shifting the trigesimal
 778      point left or right as necessary.  We approximate the
 779      base-30 exponent by obtaining the base-2 exponent, then
 780      multiplying by log30(2).  This approximation is sufficient
 781      to ensure that the adjusted VALUE is always in the range
 782      0...30**6, an invariant of the loop below. */
 783   errno = 0;
 784   base_2_sig = frexp (value, &base_2_exp);
 785   if (errno != 0 || !isfinite (base_2_sig))
 786     goto missing_value;
 787   if (base_2_exp == 0 && base_2_sig == 0.)
 788     goto zero;
 789   if (base_2_exp <= INT_MIN / 20379L || base_2_exp >= INT_MAX / 20379L)
 790     goto missing_value;
 791   trig_places = (base_2_exp * 20379L / 100000L) + CHUNK_SIZE / 2;
 792   value *= pow30 (CHUNK_SIZE - trig_places);
 793
 794   /* Dump all the trigs to buffer[], CHUNK_SIZE at a time. */
 795   trigs = buffer;
 796   trig_cnt = 0;
 797   for (trigs_to_output = DIV_RND_UP (DBL_DIG * 2, 3) + 1 + (CHUNK_SIZE / 2);
 798        trigs_to_output > 0;
 799        trigs_to_output -= CHUNK_SIZE)
 800     {
 801       long chunk;
 802       int trigs_left;
 803
 804       /* The current chunk is just the integer part of VALUE,
 805          truncated to the nearest integer.  The chunk fits in a
 806          long. */
 807       chunk = value;
 808       assert (pow30 (CHUNK_SIZE) <= LONG_MAX);
 809       assert (chunk >= 0 && chunk < pow30 (CHUNK_SIZE));
 810
 811       value -= chunk;
 812
 813       /* Append the chunk, in base 30, to trigs[]. */
 814       for (trigs_left = CHUNK_SIZE; chunk > 0 && trigs_left > 0; )
 815         {
 816           trigs[trig_cnt + --trigs_left] = chunk % 30;
 817           chunk /= 30;
 818         }
 819       while (trigs_left > 0)
 820         trigs[trig_cnt + --trigs_left] = 0;
 821       trig_cnt += CHUNK_SIZE;
 822
 823       /* Proceed to the next chunk. */
 824       if (value == 0.)
 825         break;
 826       value *= pow (LDBASE, CHUNK_SIZE);
 827     }
 828
 829   /* Strip leading zeros. */
 830   while (trig_cnt > 1 && *trigs == 0)
 831     {
 832       trigs++;
 833       trig_cnt--;
 834       trig_places--;
 835     }
 836
 837   /* Round to requested precision, conservatively estimating the
 838      required base-30 precision as 2/3 of the base-10 precision
 839      (log30(10) = .68). */
 840   assert (base_10_precision > 0);
 841   if (base_10_precision > LDBL_DIG)
 842     base_10_precision = LDBL_DIG;
 843   base_30_precision = DIV_RND_UP (base_10_precision * 2, 3);
 844   if (trig_cnt > base_30_precision)
 845     {
 846       if (should_round_up (trigs + base_30_precision,
 847                            trig_cnt - base_30_precision))
 848         {
 849           /* Try to round up. */
 850           if (try_round_up (trigs, base_30_precision))
 851             {
 852               /* Rounding up worked. */
 853               trig_cnt = base_30_precision;
 854             }
 855           else
 856             {
 857               /* Couldn't round up because we ran out of trigs to
 858                  carry into.  Do the carry here instead. */
 859               *trigs = 1;
 860               trig_cnt = 1;
 861               trig_places++;
 862             }
 863         }
 864       else
 865         {
 866           /* Round down. */
 867           trig_cnt = base_30_precision;
 868         }
 869     }
 870   else
 871     {
 872       /* No rounding required: fewer digits available than
 873          requested. */
 874     }
 875
 876   /* Strip trailing zeros. */
 877   while (trig_cnt > 1 && trigs[trig_cnt - 1] == 0)
 878     trig_cnt--;
 879
 880   /* Write output. */
 881   if (negative)
 882     *output++ = '-';
 883   if (trig_places >= -1 && trig_places < trig_cnt + 3)
 884     {
 885       /* Use conventional notation. */
 886       format_trig_digits (output, trigs, trig_cnt, trig_places);
 887     }
 888   else
 889     {
 890       /* Use scientific notation. */
 891       char *op;
 892       op = format_trig_digits (output, trigs, trig_cnt, trig_cnt);
 893       op = format_trig_int (trig_places - trig_cnt, true, op);
 894     }
 895   return;
 896
 897  zero:
 898   strcpy (output, "0");
 899   return;
 900
 901  missing_value:
 902   strcpy (output, "*.");
 903   return;
 904 }
 905 \f
 906 static const struct casewriter_class por_file_casewriter_class =
 907   {
 908     por_file_casewriter_write,
 909     por_file_casewriter_destroy,
 910     NULL,
 911   };