src/data/por-file-writer.c

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