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