src/data/por-file-writer.c

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