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 <data/sys-file-reader.h>
20 #include <data/sys-file-private.h>
28 #include <libpspp/assertion.h>
29 #include <libpspp/message.h>
30 #include <libpspp/compiler.h>
31 #include <libpspp/misc.h>
32 #include <libpspp/pool.h>
33 #include <libpspp/str.h>
34 #include <libpspp/hash.h>
35 #include <libpspp/array.h>
37 #include <data/case.h>
38 #include <data/casereader-provider.h>
39 #include <data/casereader.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/missing-values.h>
45 #include <data/short-names.h>
46 #include <data/value-labels.h>
47 #include <data/variable.h>
48 #include <data/value.h>
53 #include "unlocked-io.h"
58 #define _(msgid) gettext (msgid)
59 #define N_(msgid) (msgid)
61 /* System file reader. */
64 /* Resource tracking. */
65 struct pool *pool; /* All system file state. */
66 jmp_buf bail_out; /* longjmp() target for error handling. */
69 struct file_handle *fh; /* File handle. */
70 struct fh_lock *lock; /* Mutual exclusion for file handle. */
71 FILE *file; /* File stream. */
72 bool error; /* I/O or corruption error? */
73 size_t value_cnt; /* Number of "union value"s in struct case. */
76 enum integer_format integer_format; /* On-disk integer format. */
77 enum float_format float_format; /* On-disk floating point format. */
78 int oct_cnt; /* Number of 8-byte units per case. */
79 struct sfm_var *sfm_vars; /* Variables. */
80 size_t sfm_var_cnt; /* Number of variables. */
81 casenumber case_cnt; /* Number of cases */
82 bool has_long_var_names; /* File has a long variable name map */
85 bool compressed; /* File is compressed? */
86 double bias; /* Compression bias, usually 100.0. */
87 uint8_t opcodes[8]; /* Current block of opcodes. */
88 size_t opcode_idx; /* Next opcode to interpret, 8 if none left. */
91 static const struct casereader_class sys_file_casereader_class;
93 static bool close_reader (struct sfm_reader *);
95 static struct variable **make_var_by_value_idx (struct sfm_reader *,
97 static struct variable *lookup_var_by_value_idx (struct sfm_reader *,
101 static void sys_warn (struct sfm_reader *, const char *, ...)
102 PRINTF_FORMAT (2, 3);
104 static void sys_error (struct sfm_reader *, const char *, ...)
108 static void read_bytes (struct sfm_reader *, void *, size_t);
109 static bool try_read_bytes (struct sfm_reader *, void *, size_t);
110 static int read_int (struct sfm_reader *);
111 static double read_float (struct sfm_reader *);
112 static void read_string (struct sfm_reader *, char *, size_t);
113 static void skip_bytes (struct sfm_reader *, size_t);
115 static struct variable_to_value_map *open_variable_to_value_map (
116 struct sfm_reader *, size_t size);
117 static void close_variable_to_value_map (struct sfm_reader *r,
118 struct variable_to_value_map *);
119 static bool read_variable_to_value_map (struct sfm_reader *,
121 struct variable_to_value_map *,
122 struct variable **var, char **value,
125 static bool close_reader (struct sfm_reader *r);
127 /* Dictionary reader. */
135 static void read_header (struct sfm_reader *, struct dictionary *,
136 int *weight_idx, int *claimed_oct_cnt,
137 struct sfm_read_info *);
138 static void read_variable_record (struct sfm_reader *, struct dictionary *,
139 int *format_warning_cnt);
140 static void parse_format_spec (struct sfm_reader *, unsigned int,
141 enum which_format, struct variable *,
142 int *format_warning_cnt);
143 static void setup_weight (struct sfm_reader *, int weight_idx,
144 struct variable **var_by_value_idx,
145 struct dictionary *);
146 static void read_documents (struct sfm_reader *, struct dictionary *);
147 static void read_value_labels (struct sfm_reader *, struct dictionary *,
148 struct variable **var_by_value_idx);
150 static void read_extension_record (struct sfm_reader *, struct dictionary *,
151 struct sfm_read_info *);
152 static void read_machine_integer_info (struct sfm_reader *,
153 size_t size, size_t count,
154 struct sfm_read_info *);
155 static void read_machine_float_info (struct sfm_reader *,
156 size_t size, size_t count);
157 static void read_display_parameters (struct sfm_reader *,
158 size_t size, size_t count,
159 struct dictionary *);
160 static void read_long_var_name_map (struct sfm_reader *,
161 size_t size, size_t count,
162 struct dictionary *);
163 static void read_long_string_map (struct sfm_reader *,
164 size_t size, size_t count,
165 struct dictionary *);
168 /* Opens the system file designated by file handle FH for
169 reading. Reads the system file's dictionary into *DICT.
170 If INFO is non-null, then it receives additional info about the
173 sfm_open_reader (struct file_handle *fh, struct dictionary **dict,
174 struct sfm_read_info *volatile info)
176 struct sfm_reader *volatile r = NULL;
177 struct variable **var_by_value_idx;
178 struct sfm_read_info local_info;
179 int format_warning_cnt = 0;
184 *dict = dict_create ();
186 /* Create and initialize reader. */
187 r = pool_create_container (struct sfm_reader, pool);
193 r->has_long_var_names = false;
194 r->opcode_idx = sizeof r->opcodes;
196 /* TRANSLATORS: this fragment will be interpolated into
197 messages in fh_lock() that identify types of files. */
198 r->lock = fh_lock (fh, FH_REF_FILE, N_("system file"), FH_ACC_READ, false);
202 r->file = fn_open (fh_get_file_name (fh), "rb");
205 msg (ME, _("Error opening \"%s\" for reading as a system file: %s."),
206 fh_get_file_name (r->fh), strerror (errno));
210 /* Initialize info. */
213 memset (info, 0, sizeof *info);
215 if (setjmp (r->bail_out))
220 read_header (r, *dict, &weight_idx, &claimed_oct_cnt, info);
222 /* Read all the variable definition records. */
223 rec_type = read_int (r);
224 while (rec_type == 2)
226 read_variable_record (r, *dict, &format_warning_cnt);
227 rec_type = read_int (r);
230 /* Figure out the case format. */
231 var_by_value_idx = make_var_by_value_idx (r, *dict);
232 setup_weight (r, weight_idx, var_by_value_idx, *dict);
234 /* Read all the rest of the dictionary records. */
235 while (rec_type != 999)
240 read_value_labels (r, *dict, var_by_value_idx);
244 sys_error (r, _("Misplaced type 4 record."));
247 read_documents (r, *dict);
251 read_extension_record (r, *dict, info);
255 sys_error (r, _("Unrecognized record type %d."), rec_type);
257 rec_type = read_int (r);
261 if ( ! r->has_long_var_names )
264 for (i = 0; i < dict_get_var_cnt (*dict); i++)
266 struct variable *var = dict_get_var (*dict, i);
267 char short_name[SHORT_NAME_LEN + 1];
268 char long_name[SHORT_NAME_LEN + 1];
270 strcpy (short_name, var_get_name (var));
272 strcpy (long_name, short_name);
273 str_lowercase (long_name);
275 /* Set long name. Renaming a variable may clear the short
276 name, but we want to retain it, so re-set it
278 dict_rename_var (*dict, var, long_name);
279 var_set_short_name (var, 0, short_name);
282 r->has_long_var_names = true;
285 /* Read record 999 data, which is just filler. */
288 /* Warn if the actual amount of data per case differs from the
289 amount that the header claims. SPSS version 13 gets this
290 wrong when very long strings are involved, so don't warn in
292 if (claimed_oct_cnt != -1 && claimed_oct_cnt != r->oct_cnt
293 && info->version_major != 13)
294 sys_warn (r, _("File header claims %d variable positions but "
295 "%d were read from file."),
296 claimed_oct_cnt, r->oct_cnt);
298 /* Create an index of dictionary variable widths for
299 sfm_read_case to use. We cannot use the `struct variable's
300 from the dictionary we created, because the caller owns the
301 dictionary and may destroy or modify its variables. */
302 sfm_dictionary_to_sfm_vars (*dict, &r->sfm_vars, &r->sfm_var_cnt);
303 pool_register (r->pool, free, r->sfm_vars);
305 pool_free (r->pool, var_by_value_idx);
306 r->value_cnt = dict_get_next_value_idx (*dict);
307 return casereader_create_sequential
309 r->case_cnt == -1 ? CASENUMBER_MAX: r->case_cnt,
310 &sys_file_casereader_class, r);
314 dict_destroy (*dict);
319 /* Closes a system file after we're done with it.
320 Returns true if an I/O error has occurred on READER, false
323 close_reader (struct sfm_reader *r)
332 if (fn_close (fh_get_file_name (r->fh), r->file) == EOF)
334 msg (ME, _("Error closing system file \"%s\": %s."),
335 fh_get_file_name (r->fh), strerror (errno));
345 pool_destroy (r->pool);
350 /* Destroys READER. */
352 sys_file_casereader_destroy (struct casereader *reader UNUSED, void *r_)
354 struct sfm_reader *r = r_;
358 /* Returns true if FILE is an SPSS system file,
361 sfm_detect (FILE *file)
365 if (fread (rec_type, 4, 1, file) != 1)
369 return !strcmp ("$FL2", rec_type);
372 /* Reads the global header of the system file.
373 Sets DICT's file label to the system file's label.
374 Sets *WEIGHT_IDX to 0 if the system file is unweighted,
375 or to the value index of the weight variable otherwise.
376 Sets *CLAIMED_OCT_CNT to the number of "octs" (8-byte units)
377 per case that the file claims to have (although it is not
379 Initializes INFO with header information. */
381 read_header (struct sfm_reader *r, struct dictionary *dict,
382 int *weight_idx, int *claimed_oct_cnt,
383 struct sfm_read_info *info)
386 char eye_catcher[61];
387 uint8_t raw_layout_code[4];
389 char creation_date[10];
390 char creation_time[9];
392 struct substring file_label_ss;
393 struct substring product;
395 read_string (r, rec_type, sizeof rec_type);
396 read_string (r, eye_catcher, sizeof eye_catcher);
398 if (strcmp ("$FL2", rec_type) != 0)
399 sys_error (r, _("This is not an SPSS system file."));
401 /* Identify integer format. */
402 read_bytes (r, raw_layout_code, sizeof raw_layout_code);
403 if ((!integer_identify (2, raw_layout_code, sizeof raw_layout_code,
405 && !integer_identify (3, raw_layout_code, sizeof raw_layout_code,
407 || (r->integer_format != INTEGER_MSB_FIRST
408 && r->integer_format != INTEGER_LSB_FIRST))
409 sys_error (r, _("This is not an SPSS system file."));
411 *claimed_oct_cnt = read_int (r);
412 if (*claimed_oct_cnt < 0 || *claimed_oct_cnt > INT_MAX / 16)
413 *claimed_oct_cnt = -1;
415 r->compressed = read_int (r) != 0;
417 *weight_idx = read_int (r);
419 r->case_cnt = read_int (r);
420 if ( r->case_cnt > INT_MAX / 2)
424 /* Identify floating-point format and obtain compression bias. */
425 read_bytes (r, raw_bias, sizeof raw_bias);
426 if (float_identify (100.0, raw_bias, sizeof raw_bias, &r->float_format) == 0)
428 sys_warn (r, _("Compression bias is not the usual "
429 "value of 100, or system file uses unrecognized "
430 "floating-point format."));
431 if (r->integer_format == INTEGER_MSB_FIRST)
432 r->float_format = FLOAT_IEEE_DOUBLE_BE;
434 r->float_format = FLOAT_IEEE_DOUBLE_LE;
436 float_convert (r->float_format, raw_bias, FLOAT_NATIVE_DOUBLE, &r->bias);
438 read_string (r, creation_date, sizeof creation_date);
439 read_string (r, creation_time, sizeof creation_time);
440 read_string (r, file_label, sizeof file_label);
443 file_label_ss = ss_cstr (file_label);
444 ss_trim (&file_label_ss, ss_cstr (" "));
445 if (!ss_is_empty (file_label_ss))
447 ss_data (file_label_ss)[ss_length (file_label_ss)] = '\0';
448 dict_set_label (dict, ss_data (file_label_ss));
451 strcpy (info->creation_date, creation_date);
452 strcpy (info->creation_time, creation_time);
453 info->integer_format = r->integer_format;
454 info->float_format = r->float_format;
455 info->compressed = r->compressed;
456 info->case_cnt = r->case_cnt;
458 product = ss_cstr (eye_catcher);
459 ss_match_string (&product, ss_cstr ("@(#) SPSS DATA FILE"));
460 ss_trim (&product, ss_cstr (" "));
461 str_copy_buf_trunc (info->product, sizeof info->product,
462 ss_data (product), ss_length (product));
465 /* Reads a variable (type 2) record from R and adds the
466 corresponding variable to DICT.
467 Also skips past additional variable records for long string
470 read_variable_record (struct sfm_reader *r, struct dictionary *dict,
471 int *format_warning_cnt)
474 int has_variable_label;
475 int missing_value_code;
480 struct variable *var;
483 width = read_int (r);
484 has_variable_label = read_int (r);
485 missing_value_code = read_int (r);
486 print_format = read_int (r);
487 write_format = read_int (r);
488 read_string (r, name, sizeof name);
489 name[strcspn (name, " ")] = '\0';
491 /* Check variable name. */
492 if (name[0] == '$' || name[0] == '#')
493 sys_error (r, "Variable name begins with invalid character `%c'.",
495 if (!var_is_plausible_name (name, false))
496 sys_error (r, _("Invalid variable name `%s'."), name);
498 /* Create variable. */
499 if (width < 0 || width > 255)
500 sys_error (r, _("Bad variable width %d."), width);
501 var = dict_create_var (dict, name, width);
504 _("Duplicate variable name `%s' within system file."),
507 /* Set the short name the same as the long name. */
508 var_set_short_name (var, 0, var_get_name (var));
510 /* Get variable label, if any. */
511 if (has_variable_label != 0 && has_variable_label != 1)
512 sys_error (r, _("Variable label indicator field is not 0 or 1."));
513 if (has_variable_label == 1)
519 if (len >= sizeof label)
520 sys_error (r, _("Variable %s has label of invalid length %zu."),
522 read_string (r, label, len + 1);
523 var_set_label (var, label);
525 skip_bytes (r, ROUND_UP (len, 4) - len);
528 /* Set missing values. */
529 if (missing_value_code != 0)
531 struct missing_values mv;
534 mv_init (&mv, var_get_width (var));
535 if (var_is_numeric (var))
537 if (missing_value_code < -3 || missing_value_code > 3
538 || missing_value_code == -1)
539 sys_error (r, _("Numeric missing value indicator field is not "
540 "-3, -2, 0, 1, 2, or 3."));
541 if (missing_value_code < 0)
543 double low = read_float (r);
544 double high = read_float (r);
545 mv_add_range (&mv, low, high);
546 missing_value_code = -missing_value_code - 2;
548 for (i = 0; i < missing_value_code; i++)
549 mv_add_num (&mv, read_float (r));
553 if (missing_value_code < 1 || missing_value_code > 3)
554 sys_error (r, _("String missing value indicator field is not "
556 if (var_is_long_string (var))
557 sys_warn (r, _("Ignoring missing values on long string variable "
558 "%s, which PSPP does not yet support."), name);
559 for (i = 0; i < missing_value_code; i++)
562 read_string (r, string, sizeof string);
563 mv_add_str (&mv, string);
566 if (!var_is_long_string (var))
567 var_set_missing_values (var, &mv);
571 parse_format_spec (r, print_format, PRINT_FORMAT, var, format_warning_cnt);
572 parse_format_spec (r, write_format, WRITE_FORMAT, var, format_warning_cnt);
574 /* Account for values.
575 Skip long string continuation records, if any. */
576 nv = width == 0 ? 1 : DIV_RND_UP (width, 8);
582 for (i = 1; i < nv; i++)
584 /* Check for record type 2 and width -1. */
585 if (read_int (r) != 2 || read_int (r) != -1)
586 sys_error (r, _("Missing string continuation record."));
588 /* Skip and ignore remaining continuation data. */
589 has_variable_label = read_int (r);
590 missing_value_code = read_int (r);
591 print_format = read_int (r);
592 write_format = read_int (r);
593 read_string (r, name, sizeof name);
595 /* Variable label fields on continuation records have
596 been spotted in system files created by "SPSS Power
597 Macintosh Release 6.1". */
598 if (has_variable_label)
599 skip_bytes (r, ROUND_UP (read_int (r), 4));
604 /* Translates the format spec from sysfile format to internal
607 parse_format_spec (struct sfm_reader *r, unsigned int s,
608 enum which_format which, struct variable *v,
609 int *format_warning_cnt)
611 const int max_format_warnings = 8;
613 uint8_t raw_type = s >> 16;
619 if (!fmt_from_io (raw_type, &f.type))
620 sys_error (r, _("Unknown variable format %"PRIu8"."), raw_type);
625 ok = fmt_check_output (&f) && fmt_check_width_compat (&f, var_get_width (v));
630 if (which == PRINT_FORMAT)
631 var_set_print_format (v, &f);
633 var_set_write_format (v, &f);
635 else if (*++format_warning_cnt <= max_format_warnings)
637 char fmt_string[FMT_STRING_LEN_MAX + 1];
638 sys_warn (r, _("%s variable %s has invalid %s format %s."),
639 var_is_numeric (v) ? _("Numeric") : _("String"),
641 which == PRINT_FORMAT ? _("print") : _("write"),
642 fmt_to_string (&f, fmt_string));
644 if (*format_warning_cnt == max_format_warnings)
645 sys_warn (r, _("Suppressing further invalid format warnings."));
649 /* Sets the weighting variable in DICT to the variable
650 corresponding to the given 1-based VALUE_IDX, if VALUE_IDX is
653 setup_weight (struct sfm_reader *r, int weight_idx,
654 struct variable **var_by_value_idx, struct dictionary *dict)
658 struct variable *weight_var
659 = lookup_var_by_value_idx (r, var_by_value_idx, weight_idx);
660 if (var_is_numeric (weight_var))
661 dict_set_weight (dict, weight_var);
663 sys_error (r, _("Weighting variable must be numeric."));
667 /* Reads a document record, type 6, from system file R, and sets up
668 the documents and n_documents fields in the associated
671 read_documents (struct sfm_reader *r, struct dictionary *dict)
676 if (dict_get_documents (dict) != NULL)
677 sys_error (r, _("Multiple type 6 (document) records."));
679 line_cnt = read_int (r);
681 sys_error (r, _("Number of document lines (%d) "
682 "must be greater than 0."), line_cnt);
684 documents = pool_nmalloc (r->pool, line_cnt + 1, DOC_LINE_LENGTH);
685 read_string (r, documents, DOC_LINE_LENGTH * line_cnt + 1);
686 if (strlen (documents) == DOC_LINE_LENGTH * line_cnt)
687 dict_set_documents (dict, documents);
689 sys_error (r, _("Document line contains null byte."));
690 pool_free (r->pool, documents);
693 /* Read a type 7 extension record. */
695 read_extension_record (struct sfm_reader *r, struct dictionary *dict,
696 struct sfm_read_info *info)
698 int subtype = read_int (r);
699 size_t size = read_int (r);
700 size_t count = read_int (r);
701 size_t bytes = size * count;
703 /* Check that SIZE * COUNT + 1 doesn't overflow. Adding 1
704 allows an extra byte for a null terminator, used by some
705 extension processing routines. */
706 if (size != 0 && size_overflow_p (xsum (1, xtimes (count, size))))
707 sys_error (r, "Record type 7 subtype %d too large.", subtype);
712 read_machine_integer_info (r, size, count, info);
716 read_machine_float_info (r, size, count);
720 /* Variable sets information. We don't use these yet.
721 They only apply to GUIs; see VARSETS on the APPLY
722 DICTIONARY command in SPSS documentation. */
726 /* DATE variable information. We don't use it yet, but we
731 /* Unknown purpose. */
735 read_display_parameters (r, size, count, dict);
739 read_long_var_name_map (r, size, count, dict);
743 read_long_string_map (r, size, count, dict);
747 /* New in SPSS v14? Unknown purpose. */
751 /* Text field that defines variable attributes. New in
756 /* New in SPSS 16. Contains a single string that describes
757 the character encoding, e.g. "windows-1252". */
761 /* New in SPSS 16. Encodes value labels for long string
763 sys_warn (r, _("Ignoring value labels for long string variables, "
764 "which PSPP does not yet support."));
768 sys_warn (r, _("Unrecognized record type 7, subtype %d."), subtype);
772 skip_bytes (r, bytes);
775 /* Read record type 7, subtype 3. */
777 read_machine_integer_info (struct sfm_reader *r, size_t size, size_t count,
778 struct sfm_read_info *info)
780 int version_major = read_int (r);
781 int version_minor = read_int (r);
782 int version_revision = read_int (r);
783 int machine_code UNUSED = read_int (r);
784 int float_representation = read_int (r);
785 int compression_code UNUSED = read_int (r);
786 int integer_representation = read_int (r);
787 int character_code UNUSED = read_int (r);
789 int expected_float_format;
790 int expected_integer_format;
792 if (size != 4 || count != 8)
793 sys_error (r, _("Bad size (%zu) or count (%zu) field on record type 7, "
797 /* Save version info. */
798 info->version_major = version_major;
799 info->version_minor = version_minor;
800 info->version_revision = version_revision;
802 /* Check floating point format. */
803 if (r->float_format == FLOAT_IEEE_DOUBLE_BE
804 || r->float_format == FLOAT_IEEE_DOUBLE_LE)
805 expected_float_format = 1;
806 else if (r->float_format == FLOAT_Z_LONG)
807 expected_float_format = 2;
808 else if (r->float_format == FLOAT_VAX_G || r->float_format == FLOAT_VAX_D)
809 expected_float_format = 3;
812 if (float_representation != expected_float_format)
813 sys_error (r, _("Floating-point representation indicated by "
814 "system file (%d) differs from expected (%d)."),
815 r->float_format, expected_float_format);
817 /* Check integer format. */
818 if (r->integer_format == INTEGER_MSB_FIRST)
819 expected_integer_format = 1;
820 else if (r->integer_format == INTEGER_LSB_FIRST)
821 expected_integer_format = 2;
824 if (integer_representation != expected_integer_format)
826 static const char *const endian[] = {N_("little-endian"), N_("big-endian")};
827 sys_warn (r, _("Integer format indicated by system file (%s) "
828 "differs from expected (%s)."),
829 gettext (endian[integer_representation == 1]),
830 gettext (endian[expected_integer_format == 1]));
834 /* Read record type 7, subtype 4. */
836 read_machine_float_info (struct sfm_reader *r, size_t size, size_t count)
838 double sysmis = read_float (r);
839 double highest = read_float (r);
840 double lowest = read_float (r);
842 if (size != 8 || count != 3)
843 sys_error (r, _("Bad size (%zu) or count (%zu) on extension 4."),
846 if (sysmis != SYSMIS)
847 sys_warn (r, _("File specifies unexpected value %g as SYSMIS."), sysmis);
848 if (highest != HIGHEST)
849 sys_warn (r, _("File specifies unexpected value %g as HIGHEST."), highest);
850 if (lowest != LOWEST)
851 sys_warn (r, _("File specifies unexpected value %g as LOWEST."), lowest);
854 /* Read record type 7, subtype 11, which specifies how variables
855 should be displayed in GUI environments. */
857 read_display_parameters (struct sfm_reader *r, size_t size, size_t count,
858 struct dictionary *dict)
867 sys_warn (r, _("Bad size %zu on extension 11."), size);
868 skip_bytes (r, size * count);
872 n_vars = dict_get_var_cnt (dict);
873 if (count == 3 * n_vars)
874 includes_width = true;
875 else if (count == 2 * n_vars)
876 includes_width = false;
879 sys_warn (r, _("Extension 11 has bad count %zu (for %zu variables)."),
881 skip_bytes (r, size * count);
885 for (i = 0; i < n_vars; ++i)
887 struct variable *v = dict_get_var (dict, i);
888 int measure = read_int (r);
889 int width = includes_width ? read_int (r) : 0;
890 int align = read_int (r);
892 /* SPSS 14 sometimes seems to set string variables' measure
894 if (0 == measure && var_is_alpha (v))
897 if (measure < 1 || measure > 3 || align < 0 || align > 2)
900 sys_warn (r, _("Invalid variable display parameters "
901 "for variable %zu (%s). "
902 "Default parameters substituted."),
903 i, var_get_name (v));
908 var_set_measure (v, (measure == 1 ? MEASURE_NOMINAL
909 : measure == 2 ? MEASURE_ORDINAL
911 var_set_alignment (v, (align == 0 ? ALIGN_LEFT
912 : align == 1 ? ALIGN_RIGHT
915 /* Older versions (SPSS 9.0) sometimes set the display
916 width to zero. This causes confusion in the GUI, so
917 only set the width if it is nonzero. */
919 var_set_display_width (v, width);
923 /* Reads record type 7, subtype 13, which gives the long name
924 that corresponds to each short name. Modifies variable names
925 in DICT accordingly. */
927 read_long_var_name_map (struct sfm_reader *r, size_t size, size_t count,
928 struct dictionary *dict)
930 struct variable_to_value_map *map;
931 struct variable *var;
935 map = open_variable_to_value_map (r, size * count);
936 while (read_variable_to_value_map (r, dict, map, &var, &long_name,
940 size_t short_name_cnt;
943 /* Validate long name. */
944 if (!var_is_valid_name (long_name, false))
946 sys_warn (r, _("Long variable mapping from %s to invalid "
947 "variable name `%s'."),
948 var_get_name (var), long_name);
952 /* Identify any duplicates. */
953 if (strcasecmp (var_get_short_name (var, 0), long_name)
954 && dict_lookup_var (dict, long_name) != NULL)
956 sys_warn (r, _("Duplicate long variable name `%s' "
957 "within system file."), long_name);
961 /* Renaming a variable may clear its short names, but we
962 want to retain them, so we save them and re-set them
964 short_name_cnt = var_get_short_name_cnt (var);
965 short_names = xnmalloc (short_name_cnt, sizeof *short_names);
966 for (i = 0; i < short_name_cnt; i++)
968 const char *s = var_get_short_name (var, i);
969 short_names[i] = s != NULL ? xstrdup (s) : NULL;
973 dict_rename_var (dict, var, long_name);
975 /* Restore short names. */
976 for (i = 0; i < short_name_cnt; i++)
978 var_set_short_name (var, i, short_names[i]);
979 free (short_names[i]);
983 close_variable_to_value_map (r, map);
984 r->has_long_var_names = true;
987 /* Reads record type 7, subtype 14, which gives the real length
988 of each very long string. Rearranges DICT accordingly. */
990 read_long_string_map (struct sfm_reader *r, size_t size, size_t count,
991 struct dictionary *dict)
993 struct variable_to_value_map *map;
994 struct variable *var;
998 map = open_variable_to_value_map (r, size * count);
999 while (read_variable_to_value_map (r, dict, map, &var, &length_s,
1002 size_t idx = var_get_dict_index (var);
1008 length = strtol (length_s, NULL, 10);
1009 if (length < 1 || length > MAX_STRING)
1011 sys_warn (r, _("%s listed as string of invalid length %s "
1012 "in very length string record."),
1013 var_get_name (var), length_s);
1017 /* Check segments. */
1018 segment_cnt = sfm_width_to_segments (length);
1019 if (segment_cnt == 1)
1021 sys_warn (r, _("%s listed in very long string record with width %s, "
1022 "which requires only one segment."),
1023 var_get_name (var), length_s);
1026 if (idx + segment_cnt > dict_get_var_cnt (dict))
1027 sys_error (r, _("Very long string %s overflows dictionary."),
1028 var_get_name (var));
1030 /* Get the short names from the segments and check their
1032 for (i = 0; i < segment_cnt; i++)
1034 struct variable *seg = dict_get_var (dict, idx + i);
1035 int alloc_width = sfm_segment_alloc_width (length, i);
1036 int width = var_get_width (seg);
1039 var_set_short_name (var, i, var_get_short_name (seg, 0));
1040 if (ROUND_UP (width, 8) != ROUND_UP (alloc_width, 8))
1041 sys_error (r, _("Very long string with width %ld has segment %d "
1042 "of width %d (expected %d)"),
1043 length, i, width, alloc_width);
1045 dict_delete_consecutive_vars (dict, idx + 1, segment_cnt - 1);
1046 var_set_width (var, length);
1048 close_variable_to_value_map (r, map);
1049 dict_compact_values (dict);
1052 /* Reads value labels from sysfile H and inserts them into the
1053 associated dictionary. */
1055 read_value_labels (struct sfm_reader *r,
1056 struct dictionary *dict, struct variable **var_by_value_idx)
1058 struct pool *subpool;
1062 char raw_value[8]; /* Value as uninterpreted bytes. */
1063 union value value; /* Value. */
1064 char *label; /* Null-terminated label string. */
1067 struct label *labels = NULL;
1068 int label_cnt; /* Number of labels. */
1070 struct variable **var = NULL; /* Associated variables. */
1071 int var_cnt; /* Number of associated variables. */
1075 subpool = pool_create_subpool (r->pool);
1077 /* Read the type 3 record and record its contents. We can't do
1078 much with the data yet because we don't know whether it is
1079 of numeric or string type. */
1081 /* Read number of labels. */
1082 label_cnt = read_int (r);
1084 if (size_overflow_p (xtimes (label_cnt, sizeof *labels)))
1086 sys_warn (r, _("Invalid number of labels: %d. Ignoring labels."),
1091 /* Read each value/label tuple into labels[]. */
1092 labels = pool_nalloc (subpool, label_cnt, sizeof *labels);
1093 for (i = 0; i < label_cnt; i++)
1095 struct label *label = labels + i;
1096 unsigned char label_len;
1100 read_bytes (r, label->raw_value, sizeof label->raw_value);
1102 /* Read label length. */
1103 read_bytes (r, &label_len, sizeof label_len);
1104 padded_len = ROUND_UP (label_len + 1, 8);
1106 /* Read label, padding. */
1107 label->label = pool_alloc (subpool, padded_len + 1);
1108 read_bytes (r, label->label, padded_len - 1);
1109 label->label[label_len] = 0;
1112 /* Now, read the type 4 record that has the list of variables
1113 to which the value labels are to be applied. */
1115 /* Read record type of type 4 record. */
1116 if (read_int (r) != 4)
1117 sys_error (r, _("Variable index record (type 4) does not immediately "
1118 "follow value label record (type 3) as it should."));
1120 /* Read number of variables associated with value label from type 4
1122 var_cnt = read_int (r);
1123 if (var_cnt < 1 || var_cnt > dict_get_var_cnt (dict))
1124 sys_error (r, _("Number of variables associated with a value label (%d) "
1125 "is not between 1 and the number of variables (%zu)."),
1126 var_cnt, dict_get_var_cnt (dict));
1128 /* Read the list of variables. */
1129 var = pool_nalloc (subpool, var_cnt, sizeof *var);
1130 for (i = 0; i < var_cnt; i++)
1132 var[i] = lookup_var_by_value_idx (r, var_by_value_idx, read_int (r));
1133 if (var_is_long_string (var[i]))
1134 sys_error (r, _("Value labels are not allowed on long string "
1135 "variables (%s)."), var_get_name (var[i]));
1138 /* Type check the variables. */
1139 for (i = 1; i < var_cnt; i++)
1140 if (var_get_type (var[i]) != var_get_type (var[0]))
1141 sys_error (r, _("Variables associated with value label are not all of "
1142 "identical type. Variable %s is %s, but variable "
1144 var_get_name (var[0]),
1145 var_is_numeric (var[0]) ? _("numeric") : _("string"),
1146 var_get_name (var[i]),
1147 var_is_numeric (var[i]) ? _("numeric") : _("string"));
1149 /* Fill in labels[].value, now that we know the desired type. */
1150 for (i = 0; i < label_cnt; i++)
1152 struct label *label = labels + i;
1154 if (var_is_alpha (var[0]))
1155 buf_copy_rpad (label->value.s, sizeof label->value.s,
1156 label->raw_value, sizeof label->raw_value);
1158 label->value.f = float_get_double (r->float_format, label->raw_value);
1161 /* Assign the `value_label's to each variable. */
1162 for (i = 0; i < var_cnt; i++)
1164 struct variable *v = var[i];
1167 /* Add each label to the variable. */
1168 for (j = 0; j < label_cnt; j++)
1170 struct label *label = &labels[j];
1171 if (!var_add_value_label (v, &label->value, label->label))
1173 if (var_is_numeric (var[0]))
1174 sys_warn (r, _("Duplicate value label for %g on %s."),
1175 label->value.f, var_get_name (v));
1177 sys_warn (r, _("Duplicate value label for \"%.*s\" on %s."),
1178 var_get_width (v), label->value.s,
1184 pool_destroy (subpool);
1189 static void partial_record (struct sfm_reader *r)
1192 static void read_error (struct casereader *, const struct sfm_reader *);
1194 static bool read_case_number (struct sfm_reader *, double *);
1195 static bool read_case_string (struct sfm_reader *, char *, size_t);
1196 static int read_opcode (struct sfm_reader *);
1197 static bool read_compressed_number (struct sfm_reader *, double *);
1198 static bool read_compressed_string (struct sfm_reader *, char *);
1199 static bool read_whole_strings (struct sfm_reader *, char *, size_t);
1200 static bool skip_whole_strings (struct sfm_reader *, size_t);
1202 /* Reads one case from READER's file into C. Returns true only
1205 sys_file_casereader_read (struct casereader *reader, void *r_,
1208 struct sfm_reader *r = r_;
1214 case_create (c, r->value_cnt);
1215 if (setjmp (r->bail_out))
1217 casereader_force_error (reader);
1222 for (i = 0; i < r->sfm_var_cnt; i++)
1224 struct sfm_var *sv = &r->sfm_vars[i];
1225 union value *v = case_data_rw_idx (c, sv->case_index);
1229 if (!read_case_number (r, &v->f))
1234 if (!read_case_string (r, v->s + sv->offset, sv->width))
1236 if (!skip_whole_strings (r, ROUND_DOWN (sv->padding, 8)))
1246 if (r->case_cnt != -1)
1247 read_error (reader, r);
1251 /* Issues an error that R ends in a partial record. */
1253 partial_record (struct sfm_reader *r)
1255 sys_error (r, _("File ends in partial case."));
1258 /* Issues an error that an unspecified error occurred SFM, and
1261 read_error (struct casereader *r, const struct sfm_reader *sfm)
1263 msg (ME, _("Error reading case from file %s."), fh_get_name (sfm->fh));
1264 casereader_force_error (r);
1267 /* Reads a number from R and stores its value in *D.
1268 If R is compressed, reads a compressed number;
1269 otherwise, reads a number in the regular way.
1270 Returns true if successful, false if end of file is
1271 reached immediately. */
1273 read_case_number (struct sfm_reader *r, double *d)
1278 if (!try_read_bytes (r, number, sizeof number))
1280 float_convert (r->float_format, number, FLOAT_NATIVE_DOUBLE, d);
1284 return read_compressed_number (r, d);
1287 /* Reads LENGTH string bytes from R into S.
1288 Always reads a multiple of 8 bytes; if LENGTH is not a
1289 multiple of 8, then extra bytes are read and discarded without
1291 Reads compressed strings if S is compressed.
1292 Returns true if successful, false if end of file is
1293 reached immediately. */
1295 read_case_string (struct sfm_reader *r, char *s, size_t length)
1297 size_t whole = ROUND_DOWN (length, 8);
1298 size_t partial = length % 8;
1302 if (!read_whole_strings (r, s, whole))
1309 if (!read_whole_strings (r, bounce, sizeof bounce))
1315 memcpy (s + whole, bounce, partial);
1321 /* Reads and returns the next compression opcode from R. */
1323 read_opcode (struct sfm_reader *r)
1325 assert (r->compressed);
1329 if (r->opcode_idx >= sizeof r->opcodes)
1331 if (!try_read_bytes (r, r->opcodes, sizeof r->opcodes))
1335 opcode = r->opcodes[r->opcode_idx++];
1342 /* Reads a compressed number from R and stores its value in D.
1343 Returns true if successful, false if end of file is
1344 reached immediately. */
1346 read_compressed_number (struct sfm_reader *r, double *d)
1348 int opcode = read_opcode (r);
1356 *d = read_float (r);
1360 sys_error (r, _("Compressed data is corrupt."));
1367 *d = opcode - r->bias;
1374 /* Reads a compressed 8-byte string segment from R and stores it
1376 Returns true if successful, false if end of file is
1377 reached immediately. */
1379 read_compressed_string (struct sfm_reader *r, char *dst)
1381 switch (read_opcode (r))
1388 read_bytes (r, dst, 8);
1392 memset (dst, ' ', 8);
1396 sys_error (r, _("Compressed data is corrupt."));
1402 /* Reads LENGTH string bytes from R into S.
1403 LENGTH must be a multiple of 8.
1404 Reads compressed strings if S is compressed.
1405 Returns true if successful, false if end of file is
1406 reached immediately. */
1408 read_whole_strings (struct sfm_reader *r, char *s, size_t length)
1410 assert (length % 8 == 0);
1412 return try_read_bytes (r, s, length);
1416 for (ofs = 0; ofs < length; ofs += 8)
1417 if (!read_compressed_string (r, s + ofs))
1427 /* Skips LENGTH string bytes from R.
1428 LENGTH must be a multiple of 8.
1429 (LENGTH is also limited to 1024, but that's only because the
1430 current caller never needs more than that many bytes.)
1431 Returns true if successful, false if end of file is
1432 reached immediately. */
1434 skip_whole_strings (struct sfm_reader *r, size_t length)
1437 assert (length < sizeof buffer);
1438 return read_whole_strings (r, buffer, length);
1441 /* Creates and returns a table that can be used for translating a value
1442 index into a case to a "struct variable *" for DICT. Multiple
1443 system file fields reference variables this way.
1445 This table must be created before processing the very long
1446 string extension record, because that record causes some
1447 values to be deleted from the case and the dictionary to be
1449 static struct variable **
1450 make_var_by_value_idx (struct sfm_reader *r, struct dictionary *dict)
1452 struct variable **var_by_value_idx;
1456 var_by_value_idx = pool_nmalloc (r->pool,
1457 r->oct_cnt, sizeof *var_by_value_idx);
1458 for (i = 0; i < dict_get_var_cnt (dict); i++)
1460 struct variable *v = dict_get_var (dict, i);
1461 int nv = var_is_numeric (v) ? 1 : DIV_RND_UP (var_get_width (v), 8);
1464 var_by_value_idx[value_idx++] = v;
1465 for (j = 1; j < nv; j++)
1466 var_by_value_idx[value_idx++] = NULL;
1468 assert (value_idx == r->oct_cnt);
1470 return var_by_value_idx;
1473 /* Returns the "struct variable" corresponding to the given
1474 1-basd VALUE_IDX in VAR_BY_VALUE_IDX. Verifies that the index
1476 static struct variable *
1477 lookup_var_by_value_idx (struct sfm_reader *r,
1478 struct variable **var_by_value_idx, int value_idx)
1480 struct variable *var;
1482 if (value_idx < 1 || value_idx > r->oct_cnt)
1483 sys_error (r, _("Variable index %d not in valid range 1...%d."),
1484 value_idx, r->oct_cnt);
1486 var = var_by_value_idx[value_idx - 1];
1488 sys_error (r, _("Variable index %d refers to long string "
1495 /* Returns the variable in D with the given SHORT_NAME,
1496 or a null pointer if there is none. */
1497 static struct variable *
1498 lookup_var_by_short_name (struct dictionary *d, const char *short_name)
1500 struct variable *var;
1504 /* First try looking up by full name. This often succeeds. */
1505 var = dict_lookup_var (d, short_name);
1506 if (var != NULL && !strcasecmp (var_get_short_name (var, 0), short_name))
1509 /* Iterate through the whole dictionary as a fallback. */
1510 var_cnt = dict_get_var_cnt (d);
1511 for (i = 0; i < var_cnt; i++)
1513 var = dict_get_var (d, i);
1514 if (!strcasecmp (var_get_short_name (var, 0), short_name))
1521 /* Helpers for reading records that contain "variable=value"
1525 struct variable_to_value_map
1527 struct substring buffer; /* Record contents. */
1528 size_t pos; /* Current position in buffer. */
1531 /* Reads SIZE bytes into a "variable=value" map for R,
1532 and returns the map. */
1533 static struct variable_to_value_map *
1534 open_variable_to_value_map (struct sfm_reader *r, size_t size)
1536 struct variable_to_value_map *map = pool_alloc (r->pool, sizeof *map);
1537 char *buffer = pool_malloc (r->pool, size + 1);
1538 read_bytes (r, buffer, size);
1539 map->buffer = ss_buffer (buffer, size);
1544 /* Closes MAP and frees its storage.
1545 Not really needed, because the pool will free the map anyway,
1546 but can be used to free it earlier. */
1548 close_variable_to_value_map (struct sfm_reader *r,
1549 struct variable_to_value_map *map)
1551 pool_free (r->pool, ss_data (map->buffer));
1554 /* Reads the next variable=value pair from MAP.
1555 Looks up the variable in DICT and stores it into *VAR.
1556 Stores a null-terminated value into *VALUE. */
1558 read_variable_to_value_map (struct sfm_reader *r, struct dictionary *dict,
1559 struct variable_to_value_map *map,
1560 struct variable **var, char **value,
1563 int max_warnings = 5;
1567 struct substring short_name_ss, value_ss;
1569 if (!ss_tokenize (map->buffer, ss_cstr ("="), &map->pos, &short_name_ss)
1570 || !ss_tokenize (map->buffer, ss_buffer ("\t\0", 2), &map->pos,
1573 if (*warning_cnt > max_warnings)
1574 sys_warn (r, _("Suppressed %d additional variable map warnings."),
1575 *warning_cnt - max_warnings);
1579 map->pos += ss_span (ss_substr (map->buffer, map->pos, SIZE_MAX),
1580 ss_buffer ("\t\0", 2));
1582 ss_data (short_name_ss)[ss_length (short_name_ss)] = '\0';
1583 *var = lookup_var_by_short_name (dict, ss_data (short_name_ss));
1586 if (++*warning_cnt <= max_warnings)
1587 sys_warn (r, _("Variable map refers to unknown variable %s."),
1588 ss_data (short_name_ss));
1592 ss_data (value_ss)[ss_length (value_ss)] = '\0';
1593 *value = ss_data (value_ss);
1601 /* Displays a corruption message. */
1603 sys_msg (struct sfm_reader *r, int class, const char *format, va_list args)
1608 ds_init_empty (&text);
1609 ds_put_format (&text, "\"%s\" near offset 0x%lx: ",
1610 fh_get_file_name (r->fh), (unsigned long) ftell (r->file));
1611 ds_put_vformat (&text, format, args);
1613 m.category = msg_class_to_category (class);
1614 m.severity = msg_class_to_severity (class);
1615 m.where.file_name = NULL;
1616 m.where.line_number = 0;
1617 m.text = ds_cstr (&text);
1622 /* Displays a warning for the current file position. */
1624 sys_warn (struct sfm_reader *r, const char *format, ...)
1628 va_start (args, format);
1629 sys_msg (r, MW, format, args);
1633 /* Displays an error for the current file position,
1634 marks it as in an error state,
1635 and aborts reading it using longjmp. */
1637 sys_error (struct sfm_reader *r, const char *format, ...)
1641 va_start (args, format);
1642 sys_msg (r, ME, format, args);
1646 longjmp (r->bail_out, 1);
1649 /* Reads BYTE_CNT bytes into BUF.
1650 Returns true if exactly BYTE_CNT bytes are successfully read.
1651 Aborts if an I/O error or a partial read occurs.
1652 If EOF_IS_OK, then an immediate end-of-file causes false to be
1653 returned; otherwise, immediate end-of-file causes an abort
1656 read_bytes_internal (struct sfm_reader *r, bool eof_is_ok,
1657 void *buf, size_t byte_cnt)
1659 size_t bytes_read = fread (buf, 1, byte_cnt, r->file);
1660 if (bytes_read == byte_cnt)
1662 else if (ferror (r->file))
1663 sys_error (r, _("System error: %s."), strerror (errno));
1664 else if (!eof_is_ok || bytes_read != 0)
1665 sys_error (r, _("Unexpected end of file."));
1670 /* Reads BYTE_CNT into BUF.
1671 Aborts upon I/O error or if end-of-file is encountered. */
1673 read_bytes (struct sfm_reader *r, void *buf, size_t byte_cnt)
1675 read_bytes_internal (r, false, buf, byte_cnt);
1678 /* Reads BYTE_CNT bytes into BUF.
1679 Returns true if exactly BYTE_CNT bytes are successfully read.
1680 Returns false if an immediate end-of-file is encountered.
1681 Aborts if an I/O error or a partial read occurs. */
1683 try_read_bytes (struct sfm_reader *r, void *buf, size_t byte_cnt)
1685 return read_bytes_internal (r, true, buf, byte_cnt);
1688 /* Reads a 32-bit signed integer from R and returns its value in
1691 read_int (struct sfm_reader *r)
1694 read_bytes (r, integer, sizeof integer);
1695 return integer_get (r->integer_format, integer, sizeof integer);
1698 /* Reads a 64-bit floating-point number from R and returns its
1699 value in host format. */
1701 read_float (struct sfm_reader *r)
1704 read_bytes (r, number, sizeof number);
1705 return float_get_double (r->float_format, number);
1708 /* Reads exactly SIZE - 1 bytes into BUFFER
1709 and stores a null byte into BUFFER[SIZE - 1]. */
1711 read_string (struct sfm_reader *r, char *buffer, size_t size)
1714 read_bytes (r, buffer, size - 1);
1715 buffer[size - 1] = '\0';
1718 /* Skips BYTES bytes forward in R. */
1720 skip_bytes (struct sfm_reader *r, size_t bytes)
1725 size_t chunk = MIN (sizeof buffer, bytes);
1726 read_bytes (r, buffer, chunk);
1731 static const struct casereader_class sys_file_casereader_class =
1733 sys_file_casereader_read,
1734 sys_file_casereader_destroy,