1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2006, 2007 Free Software Foundation, Inc.
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.
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.
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/>. */
19 #include "sys-file-writer.h"
20 #include "sys-file-private.h"
29 #include <libpspp/float-format.h>
30 #include <libpspp/integer-format.h>
31 #include <libpspp/message.h>
32 #include <libpspp/misc.h>
33 #include <libpspp/str.h>
34 #include <libpspp/version.h>
36 #include <data/attributes.h>
37 #include <data/case.h>
38 #include <data/casewriter-provider.h>
39 #include <data/casewriter.h>
40 #include <data/dictionary.h>
41 #include <data/file-handle-def.h>
42 #include <data/file-name.h>
43 #include <data/format.h>
44 #include <data/make-file.h>
45 #include <data/missing-values.h>
46 #include <data/settings.h>
47 #include <data/short-names.h>
48 #include <data/value-labels.h>
49 #include <data/variable.h>
52 #include "unlocked-io.h"
56 #define _(msgid) gettext (msgid)
57 #define N_(msgid) (msgid)
59 /* Compression bias used by PSPP. Values between (1 -
60 COMPRESSION_BIAS) and (251 - COMPRESSION_BIAS) inclusive can be
62 #define COMPRESSION_BIAS 100
64 /* System file writer. */
67 struct file_handle *fh; /* File handle. */
68 struct fh_lock *lock; /* Mutual exclusion for file. */
69 FILE *file; /* File stream. */
70 struct replace_file *rf; /* Ticket for replacing output file. */
72 bool compress; /* 1=compressed, 0=not compressed. */
73 casenumber case_cnt; /* Number of cases written so far. */
75 /* Compression buffering.
77 Compressed data is output as groups of 8 1-byte opcodes
78 followed by up to 8 (depending on the opcodes) 8-byte data
79 items. Data items and opcodes arrive at the same time but
80 must be reordered for writing to disk, thus a small amount
82 uint8_t opcodes[8]; /* Buffered opcodes. */
83 int opcode_cnt; /* Number of buffered opcodes. */
84 uint8_t data[8][8]; /* Buffered data. */
85 int data_cnt; /* Number of buffered data items. */
88 struct sfm_var *sfm_vars; /* Variables. */
89 size_t sfm_var_cnt; /* Number of variables. */
90 size_t segment_cnt; /* Number of variables including extra segments
91 for long string variables. */
94 static const struct casewriter_class sys_file_casewriter_class;
96 static void write_header (struct sfm_writer *, const struct dictionary *);
97 static void write_variable (struct sfm_writer *, const struct variable *);
98 static void write_value_labels (struct sfm_writer *,
99 struct variable *, int idx);
100 static void write_integer_info_record (struct sfm_writer *);
101 static void write_float_info_record (struct sfm_writer *);
103 static void write_longvar_table (struct sfm_writer *w,
104 const struct dictionary *dict);
106 static void write_vls_length_table (struct sfm_writer *w,
107 const struct dictionary *dict);
110 static void write_variable_display_parameters (struct sfm_writer *w,
111 const struct dictionary *dict);
113 static void write_documents (struct sfm_writer *, const struct dictionary *);
115 static void write_data_file_attributes (struct sfm_writer *,
116 const struct dictionary *);
117 static void write_variable_attributes (struct sfm_writer *,
118 const struct dictionary *);
120 static void write_int (struct sfm_writer *, int32_t);
121 static inline void convert_double_to_output_format (double, uint8_t[8]);
122 static void write_float (struct sfm_writer *, double);
123 static void write_string (struct sfm_writer *, const char *, size_t);
124 static void write_bytes (struct sfm_writer *, const void *, size_t);
125 static void write_zeros (struct sfm_writer *, size_t);
126 static void write_spaces (struct sfm_writer *, size_t);
127 static void write_value (struct sfm_writer *, const union value *, int width);
129 static void write_case_uncompressed (struct sfm_writer *, struct ccase *);
130 static void write_case_compressed (struct sfm_writer *, struct ccase *);
131 static void flush_compressed (struct sfm_writer *);
132 static void put_cmp_opcode (struct sfm_writer *, uint8_t);
133 static void put_cmp_number (struct sfm_writer *, double);
134 static void put_cmp_string (struct sfm_writer *, const void *, size_t);
136 bool write_error (const struct sfm_writer *);
137 bool close_writer (struct sfm_writer *);
139 /* Returns default options for writing a system file. */
140 struct sfm_write_options
141 sfm_writer_default_options (void)
143 struct sfm_write_options opts;
144 opts.create_writeable = true;
145 opts.compress = settings_get_scompression ();
150 /* Opens the system file designated by file handle FH for writing
151 cases from dictionary D according to the given OPTS. If
152 COMPRESS is nonzero, the system file will be compressed.
154 No reference to D is retained, so it may be modified or
155 destroyed at will after this function returns. D is not
156 modified by this function, except to assign short names. */
158 sfm_open_writer (struct file_handle *fh, struct dictionary *d,
159 struct sfm_write_options opts)
161 struct sfm_writer *w;
167 if (opts.version != 2 && opts.version != 3)
169 msg (ME, _("Unknown system file version %d. Treating as version %d."),
174 /* Create and initialize writer. */
175 w = xmalloc (sizeof *w);
181 w->compress = opts.compress;
184 w->opcode_cnt = w->data_cnt = 0;
186 /* Figure out how to map in-memory case data to on-disk case
187 data. Also count the number of segments. Very long strings
188 occupy multiple segments, otherwise each variable only takes
190 w->segment_cnt = sfm_dictionary_to_sfm_vars (d, &w->sfm_vars,
193 /* Open file handle as an exclusive writer. */
194 /* TRANSLATORS: this fragment will be interpolated into
195 messages in fh_lock() that identify types of files. */
196 w->lock = fh_lock (fh, FH_REF_FILE, N_("system file"), FH_ACC_WRITE, true);
200 /* Create the file on disk. */
201 mode = S_IRUSR | S_IRGRP | S_IROTH;
202 if (opts.create_writeable)
203 mode |= S_IWUSR | S_IWGRP | S_IWOTH;
204 w->rf = replace_file_start (fh_get_file_name (fh), "wb", mode,
208 msg (ME, _("Error opening \"%s\" for writing as a system file: %s."),
209 fh_get_file_name (fh), strerror (errno));
213 /* Write the file header. */
216 /* Write basic variable info. */
217 short_names_assign (d);
218 for (i = 0; i < dict_get_var_cnt (d); i++)
219 write_variable (w, dict_get_var (d, i));
221 /* Write out value labels. */
223 for (i = 0; i < dict_get_var_cnt (d); i++)
225 struct variable *v = dict_get_var (d, i);
227 write_value_labels (w, v, idx);
228 idx += sfm_width_to_octs (var_get_width (v));
231 if (dict_get_documents (d) != NULL)
232 write_documents (w, d);
234 write_integer_info_record (w);
235 write_float_info_record (w);
237 write_variable_display_parameters (w, d);
239 if (opts.version >= 3)
240 write_longvar_table (w, d);
242 write_vls_length_table (w, d);
244 if (attrset_count (dict_get_attributes (d)))
245 write_data_file_attributes (w, d);
246 write_variable_attributes (w, d);
248 /* Write end-of-headers record. */
258 return casewriter_create (dict_get_next_value_idx (d),
259 &sys_file_casewriter_class, w);
266 /* Returns value of X truncated to two least-significant digits. */
277 /* Calculates the offset of data for TARGET_VAR from the
278 beginning of each case's data for dictionary D. The return
279 value is in "octs" (8-byte units). */
281 calc_oct_idx (const struct dictionary *d, struct variable *target_var)
287 for (i = 0; i < dict_get_var_cnt (d); i++)
289 struct variable *var = dict_get_var (d, i);
290 if (var == target_var)
292 oct_idx += sfm_width_to_octs (var_get_width (var));
297 /* Write the sysfile_header header to system file W. */
299 write_header (struct sfm_writer *w, const struct dictionary *d)
302 char creation_date[10];
303 char creation_time[9];
304 const char *file_label;
305 struct variable *weight;
309 /* Record-type code. */
310 write_string (w, "$FL2", 4);
312 /* Product identification. */
313 snprintf (prod_name, sizeof prod_name, "@(#) SPSS DATA FILE %s - %s",
314 version, host_system);
315 write_string (w, prod_name, 60);
320 /* Number of `union value's per case. */
321 write_int (w, calc_oct_idx (d, NULL));
324 write_int (w, w->compress);
326 /* Weight variable. */
327 weight = dict_get_weight (d);
328 write_int (w, weight != NULL ? calc_oct_idx (d, weight) + 1 : 0);
330 /* Number of cases. We don't know this in advance, so we write
331 -1 to indicate an unknown number of cases. Later we can
332 come back and overwrite it with the true value. */
335 /* Compression bias. */
336 write_float (w, COMPRESSION_BIAS);
338 /* Creation date and time. */
339 if (time (&t) == (time_t) -1)
341 strcpy (creation_date, "01 Jan 70");
342 strcpy (creation_time, "00:00:00");
346 static const char *const month_name[12] =
348 "Jan", "Feb", "Mar", "Apr", "May", "Jun",
349 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec",
351 struct tm *tmp = localtime (&t);
352 int day = rerange (tmp->tm_mday);
353 int mon = rerange (tmp->tm_mon + 1);
354 int year = rerange (tmp->tm_year);
355 int hour = rerange (tmp->tm_hour + 1);
356 int min = rerange (tmp->tm_min + 1);
357 int sec = rerange (tmp->tm_sec + 1);
359 snprintf (creation_date, sizeof creation_date,
360 "%02d %s %02d", day, month_name[mon - 1], year);
361 snprintf (creation_time, sizeof creation_time,
362 "%02d:%02d:%02d", hour - 1, min - 1, sec - 1);
364 write_string (w, creation_date, 9);
365 write_string (w, creation_time, 8);
368 file_label = dict_get_label (d);
369 if (file_label == NULL)
371 write_string (w, file_label, 64);
377 /* Write format spec FMT to W, after adjusting it to be
378 compatible with the given WIDTH. */
380 write_format (struct sfm_writer *w, struct fmt_spec fmt, int width)
382 assert (fmt_check_output (&fmt));
383 assert (sfm_width_to_segments (width) == 1);
386 fmt_resize (&fmt, width);
387 write_int (w, (fmt_to_io (fmt.type) << 16) | (fmt.w << 8) | fmt.d);
390 /* Write a string continuation variable record for each 8-byte
391 section beyond the initial 8 bytes, for a variable of the
394 write_variable_continuation_records (struct sfm_writer *w, int width)
398 assert (sfm_width_to_segments (width) == 1);
399 for (position = 8; position < width; position += 8)
401 write_int (w, 2); /* Record type. */
402 write_int (w, -1); /* Width. */
403 write_int (w, 0); /* No variable label. */
404 write_int (w, 0); /* No missing values. */
405 write_int (w, 0); /* Print format. */
406 write_int (w, 0); /* Write format. */
407 write_zeros (w, 8); /* Name. */
411 /* Write the variable record(s) for variable V to system file
414 write_variable (struct sfm_writer *w, const struct variable *v)
416 int width = var_get_width (v);
417 int segment_cnt = sfm_width_to_segments (width);
418 int seg0_width = sfm_segment_alloc_width (width, 0);
419 const struct missing_values *mv = var_get_missing_values (v);
426 write_int (w, seg0_width);
428 /* Variable has a variable label? */
429 write_int (w, var_has_label (v));
431 /* Number of missing values. If there is a range, then the
432 range counts as 2 missing values and causes the number to be
434 write_int (w, mv_has_range (mv) ? -2 - mv_n_values (mv) : mv_n_values (mv));
436 /* Print and write formats. */
437 write_format (w, *var_get_print_format (v), seg0_width);
438 write_format (w, *var_get_write_format (v), seg0_width);
441 The full name is in a translation table written
443 write_string (w, var_get_short_name (v, 0), 8);
446 if (var_has_label (v))
448 const char *label = var_get_label (v);
449 size_t padded_len = ROUND_UP (MIN (strlen (label), 255), 4);
450 write_int (w, padded_len);
451 write_string (w, label, padded_len);
454 /* Write the missing values, if any, range first. */
455 if (mv_has_range (mv))
458 mv_get_range (mv, &x, &y);
462 for (i = 0; i < mv_n_values (mv); i++)
465 mv_get_value (mv, &value, i);
466 write_value (w, &value, seg0_width);
469 write_variable_continuation_records (w, seg0_width);
471 /* Write additional segments for very long string variables. */
472 for (i = 1; i < segment_cnt; i++)
474 int seg_width = sfm_segment_alloc_width (width, i);
475 struct fmt_spec fmt = fmt_for_output (FMT_A, MAX (seg_width, 1), 0);
477 write_int (w, 2); /* Variable record. */
478 write_int (w, seg_width); /* Width. */
479 write_int (w, 0); /* No variable label. */
480 write_int (w, 0); /* No missing values. */
481 write_format (w, fmt, seg_width); /* Print format. */
482 write_format (w, fmt, seg_width); /* Write format. */
483 write_string (w, var_get_short_name (v, i), 8);
485 write_variable_continuation_records (w, seg_width);
489 /* Writes the value labels for variable V having system file
490 variable index IDX to system file W. */
492 write_value_labels (struct sfm_writer *w, struct variable *v, int idx)
494 const struct val_labs *val_labs;
495 struct val_labs_iterator *i;
498 val_labs = var_get_value_labels (v);
499 if (val_labs == NULL)
502 /* Value label record. */
503 write_int (w, 3); /* Record type. */
504 write_int (w, val_labs_count (val_labs));
505 for (vl = val_labs_first_sorted (val_labs, &i); vl != NULL;
506 vl = val_labs_next (val_labs, &i))
508 uint8_t len = MIN (strlen (vl->label), 255);
510 write_value (w, &vl->value, var_get_width (v));
511 write_bytes (w, &len, 1);
512 write_bytes (w, vl->label, len);
513 write_zeros (w, REM_RND_UP (len + 1, 8));
516 /* Value label variable record. */
517 write_int (w, 4); /* Record type. */
518 write_int (w, 1); /* Number of variables. */
519 write_int (w, idx + 1); /* Variable's dictionary index. */
522 /* Writes record type 6, document record. */
524 write_documents (struct sfm_writer *w, const struct dictionary *d)
526 size_t line_cnt = dict_get_document_line_cnt (d);
528 write_int (w, 6); /* Record type. */
529 write_int (w, line_cnt);
530 write_bytes (w, dict_get_documents (d), line_cnt * DOC_LINE_LENGTH);
534 put_attrset (struct string *string, const struct attrset *attrs)
536 const struct attribute *attr;
537 struct attrset_iterator i;
539 for (attr = attrset_first (attrs, &i); attr != NULL;
540 attr = attrset_next (attrs, &i))
542 size_t n_values = attribute_get_n_values (attr);
545 ds_put_cstr (string, attribute_get_name (attr));
546 ds_put_char (string, '(');
547 for (j = 0; j < n_values; j++)
548 ds_put_format (string, "'%s'\n", attribute_get_value (attr, j));
549 ds_put_char (string, ')');
554 write_attribute_record (struct sfm_writer *w, const struct string *content,
558 write_int (w, subtype);
560 write_int (w, ds_length (content));
561 write_bytes (w, ds_data (content), ds_length (content));
565 write_data_file_attributes (struct sfm_writer *w,
566 const struct dictionary *d)
568 struct string s = DS_EMPTY_INITIALIZER;
569 put_attrset (&s, dict_get_attributes (d));
570 write_attribute_record (w, &s, 17);
575 write_variable_attributes (struct sfm_writer *w, const struct dictionary *d)
577 struct string s = DS_EMPTY_INITIALIZER;
578 size_t n_vars = dict_get_var_cnt (d);
579 size_t n_attrsets = 0;
582 for (i = 0; i < n_vars; i++)
584 struct variable *v = dict_get_var (d, i);
585 struct attrset *attrs = var_get_attributes (v);
586 if (attrset_count (attrs))
589 ds_put_char (&s, '/');
590 ds_put_format (&s, "%s:", var_get_short_name (v, 0));
591 put_attrset (&s, attrs);
595 write_attribute_record (w, &s, 18);
599 /* Write the alignment, width and scale values. */
601 write_variable_display_parameters (struct sfm_writer *w,
602 const struct dictionary *dict)
606 write_int (w, 7); /* Record type. */
607 write_int (w, 11); /* Record subtype. */
608 write_int (w, 4); /* Data item (int32) size. */
609 write_int (w, w->segment_cnt * 3); /* Number of data items. */
611 for (i = 0; i < dict_get_var_cnt (dict); ++i)
613 struct variable *v = dict_get_var (dict, i);
614 int width = var_get_width (v);
615 int segment_cnt = sfm_width_to_segments (width);
616 int measure = (var_get_measure (v) == MEASURE_NOMINAL ? 1
617 : var_get_measure (v) == MEASURE_ORDINAL ? 2
619 int alignment = (var_get_alignment (v) == ALIGN_LEFT ? 0
620 : var_get_alignment (v) == ALIGN_RIGHT ? 1
624 for (i = 0; i < segment_cnt; i++)
626 int width_left = width - sfm_segment_effective_offset (width, i);
627 write_int (w, measure);
628 write_int (w, (i == 0 ? var_get_display_width (v)
629 : var_default_display_width (width_left)));
630 write_int (w, alignment);
635 /* Writes the table of lengths for very long string variables. */
637 write_vls_length_table (struct sfm_writer *w,
638 const struct dictionary *dict)
643 ds_init_empty (&map);
644 for (i = 0; i < dict_get_var_cnt (dict); ++i)
646 const struct variable *v = dict_get_var (dict, i);
647 if (sfm_width_to_segments (var_get_width (v)) > 1)
648 ds_put_format (&map, "%s=%05d%c\t",
649 var_get_short_name (v, 0), var_get_width (v), 0);
651 if (!ds_is_empty (&map))
653 write_int (w, 7); /* Record type. */
654 write_int (w, 14); /* Record subtype. */
655 write_int (w, 1); /* Data item (char) size. */
656 write_int (w, ds_length (&map)); /* Number of data items. */
657 write_bytes (w, ds_data (&map), ds_length (&map));
662 /* Writes the long variable name table. */
664 write_longvar_table (struct sfm_writer *w, const struct dictionary *dict)
669 ds_init_empty (&map);
670 for (i = 0; i < dict_get_var_cnt (dict); i++)
672 struct variable *v = dict_get_var (dict, i);
675 ds_put_char (&map, '\t');
676 ds_put_format (&map, "%s=%s",
677 var_get_short_name (v, 0), var_get_name (v));
680 write_int (w, 7); /* Record type. */
681 write_int (w, 13); /* Record subtype. */
682 write_int (w, 1); /* Data item (char) size. */
683 write_int (w, ds_length (&map)); /* Number of data items. */
684 write_bytes (w, ds_data (&map), ds_length (&map));
689 /* Write integer information record. */
691 write_integer_info_record (struct sfm_writer *w)
693 int version_component[3];
696 /* Parse the version string. */
697 memset (version_component, 0, sizeof version_component);
698 sscanf (bare_version, "%d.%d.%d",
699 &version_component[0], &version_component[1], &version_component[2]);
701 /* Figure out the floating-point format. */
702 if (FLOAT_NATIVE_64_BIT == FLOAT_IEEE_DOUBLE_LE
703 || FLOAT_NATIVE_64_BIT == FLOAT_IEEE_DOUBLE_BE)
705 else if (FLOAT_NATIVE_64_BIT == FLOAT_Z_LONG)
707 else if (FLOAT_NATIVE_64_BIT == FLOAT_VAX_D)
713 write_int (w, 7); /* Record type. */
714 write_int (w, 3); /* Record subtype. */
715 write_int (w, 4); /* Data item (int32) size. */
716 write_int (w, 8); /* Number of data items. */
717 write_int (w, version_component[0]);
718 write_int (w, version_component[1]);
719 write_int (w, version_component[2]);
720 write_int (w, -1); /* Machine code. */
721 write_int (w, float_format);
722 write_int (w, 1); /* Compression code. */
723 write_int (w, INTEGER_NATIVE == INTEGER_MSB_FIRST ? 1 : 2);
724 write_int (w, 2); /* 7-bit ASCII. */
727 /* Write floating-point information record. */
729 write_float_info_record (struct sfm_writer *w)
731 write_int (w, 7); /* Record type. */
732 write_int (w, 4); /* Record subtype. */
733 write_int (w, 8); /* Data item (flt64) size. */
734 write_int (w, 3); /* Number of data items. */
735 write_float (w, SYSMIS); /* System-missing value. */
736 write_float (w, HIGHEST); /* Value used for HIGHEST in missing values. */
737 write_float (w, LOWEST); /* Value used for LOWEST in missing values. */
740 /* Writes case C to system file W. */
742 sys_file_casewriter_write (struct casewriter *writer, void *w_,
745 struct sfm_writer *w = w_;
747 if (ferror (w->file))
749 casewriter_force_error (writer);
757 write_case_uncompressed (w, c);
759 write_case_compressed (w, c);
764 /* Destroys system file writer W. */
766 sys_file_casewriter_destroy (struct casewriter *writer, void *w_)
768 struct sfm_writer *w = w_;
769 if (!close_writer (w))
770 casewriter_force_error (writer);
773 /* Returns true if an I/O error has occurred on WRITER, false otherwise. */
775 write_error (const struct sfm_writer *writer)
777 return ferror (writer->file);
780 /* Closes a system file after we're done with it.
781 Returns true if successful, false if an I/O error occurred. */
783 close_writer (struct sfm_writer *w)
794 if (w->opcode_cnt > 0)
795 flush_compressed (w);
798 ok = !write_error (w);
800 /* Seek back to the beginning and update the number of cases.
801 This is just a courtesy to later readers, so there's no need
802 to check return values or report errors. */
803 if (ok && w->case_cnt <= INT32_MAX && !fseek (w->file, 80, SEEK_SET))
805 write_int (w, w->case_cnt);
809 if (fclose (w->file) == EOF)
813 msg (ME, _("An I/O error occurred writing system file \"%s\"."),
814 fh_get_file_name (w->fh));
816 if (ok ? !replace_file_commit (w->rf) : !replace_file_abort (w->rf))
829 /* System file writer casewriter class. */
830 static const struct casewriter_class sys_file_casewriter_class =
832 sys_file_casewriter_write,
833 sys_file_casewriter_destroy,
837 /* Writes case C to system file W, without compressing it. */
839 write_case_uncompressed (struct sfm_writer *w, struct ccase *c)
843 for (i = 0; i < w->sfm_var_cnt; i++)
845 struct sfm_var *v = &w->sfm_vars[i];
848 write_float (w, case_num_idx (c, v->case_index));
851 write_bytes (w, case_str_idx (c, v->case_index) + v->offset,
853 write_spaces (w, v->padding);
858 /* Writes case C to system file W, with compression. */
860 write_case_compressed (struct sfm_writer *w, struct ccase *c)
864 for (i = 0; i < w->sfm_var_cnt; i++)
866 struct sfm_var *v = &w->sfm_vars[i];
870 double d = case_num_idx (c, v->case_index);
872 put_cmp_opcode (w, 255);
873 else if (d >= 1 - COMPRESSION_BIAS
874 && d <= 251 - COMPRESSION_BIAS
876 put_cmp_opcode (w, (int) d + COMPRESSION_BIAS);
879 put_cmp_opcode (w, 253);
880 put_cmp_number (w, d);
885 int offset = v->offset;
888 /* This code properly deals with a width that is not a
889 multiple of 8, by ensuring that the final partial
890 oct (8 byte unit) is treated as padded with spaces
892 for (width = v->width; width > 0; width -= 8, offset += 8)
894 const void *data = case_str_idx (c, v->case_index) + offset;
895 int chunk_size = MIN (width, 8);
896 if (!memcmp (data, " ", chunk_size))
897 put_cmp_opcode (w, 254);
900 put_cmp_opcode (w, 253);
901 put_cmp_string (w, data, chunk_size);
905 /* This code deals properly with padding that is not a
906 multiple of 8 bytes, by discarding the remainder,
907 which was already effectively padded with spaces in
908 the previous loop. (Note that v->width + v->padding
909 is always a multiple of 8.) */
910 for (padding = v->padding / 8; padding > 0; padding--)
911 put_cmp_opcode (w, 254);
916 /* Flushes buffered compressed opcodes and data to W.
917 The compression buffer must not be empty. */
919 flush_compressed (struct sfm_writer *w)
921 assert (w->opcode_cnt > 0 && w->opcode_cnt <= 8);
923 write_bytes (w, w->opcodes, w->opcode_cnt);
924 write_zeros (w, 8 - w->opcode_cnt);
926 write_bytes (w, w->data, w->data_cnt * sizeof *w->data);
928 w->opcode_cnt = w->data_cnt = 0;
931 /* Appends OPCODE to the buffered set of compression opcodes in
932 W. Flushes the compression buffer beforehand if necessary. */
934 put_cmp_opcode (struct sfm_writer *w, uint8_t opcode)
936 if (w->opcode_cnt >= 8)
937 flush_compressed (w);
939 w->opcodes[w->opcode_cnt++] = opcode;
942 /* Appends NUMBER to the buffered compression data in W. The
943 buffer must not be full; the way to assure that is to call
944 this function only just after a call to put_cmp_opcode, which
945 will flush the buffer as necessary. */
947 put_cmp_number (struct sfm_writer *w, double number)
949 assert (w->opcode_cnt > 0);
950 assert (w->data_cnt < 8);
952 convert_double_to_output_format (number, w->data[w->data_cnt++]);
955 /* Appends SIZE bytes of DATA to the buffered compression data in
956 W, followed by enough spaces to pad the output data to exactly
957 8 bytes (thus, SIZE must be no greater than 8). The buffer
958 must not be full; the way to assure that is to call this
959 function only just after a call to put_cmp_opcode, which will
960 flush the buffer as necessary. */
962 put_cmp_string (struct sfm_writer *w, const void *data, size_t size)
964 assert (w->opcode_cnt > 0);
965 assert (w->data_cnt < 8);
968 memset (w->data[w->data_cnt], ' ', 8);
969 memcpy (w->data[w->data_cnt], data, size);
973 /* Writes 32-bit integer X to the output file for writer W. */
975 write_int (struct sfm_writer *w, int32_t x)
977 write_bytes (w, &x, sizeof x);
980 /* Converts NATIVE to the 64-bit format used in output files in
983 convert_double_to_output_format (double native, uint8_t output[8])
985 /* If "double" is not a 64-bit type, then convert it to a
986 64-bit type. Otherwise just copy it. */
987 if (FLOAT_NATIVE_DOUBLE != FLOAT_NATIVE_64_BIT)
988 float_convert (FLOAT_NATIVE_DOUBLE, &native, FLOAT_NATIVE_64_BIT, output);
990 memcpy (output, &native, sizeof native);
993 /* Writes floating-point number X to the output file for writer
996 write_float (struct sfm_writer *w, double x)
999 convert_double_to_output_format (x, output);
1000 write_bytes (w, output, sizeof output);
1003 /* Writes contents of VALUE with the given WIDTH to W, padding
1004 with zeros to a multiple of 8 bytes.
1005 To avoid a branch, and because we don't actually need to
1006 support it, WIDTH must be no bigger than 8. */
1008 write_value (struct sfm_writer *w, const union value *value, int width)
1010 assert (width <= 8);
1012 write_float (w, value->f);
1015 write_bytes (w, value->s, width);
1016 write_zeros (w, 8 - width);
1020 /* Writes null-terminated STRING in a field of the given WIDTH to
1021 W. If WIDTH is longer than WIDTH, it is truncated; if WIDTH
1022 is narrowed, it is padded on the right with spaces. */
1024 write_string (struct sfm_writer *w, const char *string, size_t width)
1026 size_t data_bytes = MIN (strlen (string), width);
1027 size_t pad_bytes = width - data_bytes;
1028 write_bytes (w, string, data_bytes);
1029 while (pad_bytes-- > 0)
1030 putc (' ', w->file);
1033 /* Writes SIZE bytes of DATA to W's output file. */
1035 write_bytes (struct sfm_writer *w, const void *data, size_t size)
1037 fwrite (data, 1, size, w->file);
1040 /* Writes N zeros to W's output file. */
1042 write_zeros (struct sfm_writer *w, size_t n)
1048 /* Writes N spaces to W's output file. */
1050 write_spaces (struct sfm_writer *w, size_t n)
1053 putc (' ', w->file);