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