1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-2000, 2006-2007, 2009-2016 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/>. */
25 #include "data/any-reader.h"
26 #include "data/case.h"
27 #include "data/casereader-provider.h"
28 #include "data/casereader.h"
29 #include "data/dictionary.h"
30 #include "data/file-handle-def.h"
31 #include "data/file-name.h"
32 #include "data/format.h"
33 #include "data/identifier.h"
34 #include "data/missing-values.h"
35 #include "data/value-labels.h"
36 #include "data/value.h"
37 #include "data/variable.h"
38 #include "libpspp/float-format.h"
39 #include "libpspp/i18n.h"
40 #include "libpspp/integer-format.h"
41 #include "libpspp/message.h"
42 #include "libpspp/misc.h"
43 #include "libpspp/pool.h"
44 #include "libpspp/str.h"
46 #include "gl/localcharset.h"
47 #include "gl/minmax.h"
48 #include "gl/xalloc.h"
52 #define _(msgid) gettext (msgid)
53 #define N_(msgid) (msgid)
63 struct pcp_dir_entry main;
64 struct pcp_dir_entry variables;
65 struct pcp_dir_entry labels;
66 struct pcp_dir_entry data;
69 struct pcp_main_header
71 char product[63]; /* "PCSPSS SYSTEM FILE..." */
72 unsigned int nominal_case_size; /* Number of var positions. */
73 char creation_date[9]; /* "[m]m/dd/yy". */
74 char creation_time[9]; /* "[H]H:MM:SS". */
75 char file_label[65]; /* File label. */
76 unsigned int weight_index; /* Index of weighting variable, 0 if none. */
85 struct fmt_spec format;
91 struct pcp_value_label *val_labs;
95 struct pcp_value_label
101 /* System file reader. */
104 struct any_reader any_reader;
106 /* Resource tracking. */
107 struct pool *pool; /* All system file state. */
110 unsigned int file_size;
111 struct any_read_info info;
112 struct pcp_directory directory;
113 struct pcp_main_header header;
114 struct pcp_var_record *vars;
118 struct file_handle *fh; /* File handle. */
119 struct fh_lock *lock; /* Mutual exclusion for file handle. */
120 FILE *file; /* File stream. */
121 unsigned int pos; /* Position in file. */
122 bool error; /* I/O or corruption error? */
123 struct caseproto *proto; /* Format of output cases. */
126 unsigned int n_cases; /* Number of cases */
127 const char *encoding; /* String encoding. */
131 uint8_t opcodes[8]; /* Current block of opcodes. */
132 size_t opcode_idx; /* Next opcode to interpret, 8 if none left. */
133 bool corruption_warning; /* Warned about possible corruption? */
136 static struct pcp_reader *
137 pcp_reader_cast (const struct any_reader *r_)
139 assert (r_->klass == &pcp_file_reader_class);
140 return UP_CAST (r_, struct pcp_reader, any_reader);
143 static const struct casereader_class pcp_file_casereader_class;
145 static bool pcp_close (struct any_reader *);
147 static bool read_variables_record (struct pcp_reader *);
149 static void pcp_msg (struct pcp_reader *r, off_t, int class,
150 const char *format, va_list args)
151 PRINTF_FORMAT (4, 0);
152 static void pcp_warn (struct pcp_reader *, off_t, const char *, ...)
153 PRINTF_FORMAT (3, 4);
154 static void pcp_error (struct pcp_reader *, off_t, const char *, ...)
155 PRINTF_FORMAT (3, 4);
157 static bool read_bytes (struct pcp_reader *, void *, size_t)
159 static int try_read_bytes (struct pcp_reader *, void *, size_t)
161 static bool read_uint16 (struct pcp_reader *, unsigned int *)
163 static bool read_uint32 (struct pcp_reader *, unsigned int *)
165 static bool read_float (struct pcp_reader *, double *)
167 static double parse_float (const uint8_t number[8]);
168 static bool read_string (struct pcp_reader *, char *, size_t)
170 static bool skip_bytes (struct pcp_reader *, size_t) WARN_UNUSED_RESULT;
172 static bool pcp_seek (struct pcp_reader *, off_t);
174 static bool pcp_is_sysmis(const uint8_t *);
176 /* Dictionary reader. */
178 static bool read_dictionary (struct pcp_reader *);
179 static bool read_main_header (struct pcp_reader *, struct pcp_main_header *);
180 static void parse_header (struct pcp_reader *,
181 const struct pcp_main_header *,
182 struct any_read_info *, struct dictionary *);
183 static bool parse_variable_records (struct pcp_reader *, struct dictionary *,
184 struct pcp_var_record *, size_t n);
186 /* Tries to open FH for reading as an SPSS/PC+ system file. Returns a
187 pcp_reader if successful, otherwise NULL. */
188 static struct any_reader *
189 pcp_open (struct file_handle *fh)
193 /* Create and initialize reader. */
194 struct pcp_reader *r = XZALLOC (struct pcp_reader);
195 r->any_reader.klass = &pcp_file_reader_class;
196 r->pool = pool_create ();
197 pool_register (r->pool, free, r);
199 r->opcode_idx = sizeof r->opcodes;
201 /* TRANSLATORS: this fragment will be interpolated into
202 messages in fh_lock() that identify types of files. */
203 r->lock = fh_lock (fh, FH_REF_FILE, N_("SPSS/PC+ system file"),
209 r->file = fn_open (fh, "rb");
212 msg (ME, _("Error opening `%s' for reading as an SPSS/PC+ "
214 fh_get_file_name (r->fh), strerror (errno));
218 /* Fetch file size. */
219 if (fstat (fileno (r->file), &s))
221 pcp_error (r, 0, _("%s: stat failed (%s)."),
222 fh_get_file_name (r->fh), strerror (errno));
225 if (s.st_size > UINT_MAX)
227 pcp_error (r, 0, _("%s: file too large."), fh_get_file_name (r->fh));
230 r->file_size = s.st_size;
232 /* Read dictionary. */
233 if (!read_dictionary (r))
236 if (!pcp_seek (r, r->directory.data.ofs))
239 return &r->any_reader;
242 pcp_close (&r->any_reader);
247 pcp_read_dir_entry (struct pcp_reader *r, struct pcp_dir_entry *de)
249 if (!read_uint32 (r, &de->ofs) || !read_uint32 (r, &de->len))
252 if (de->len > r->file_size || de->ofs > r->file_size - de->len)
254 pcp_error (r, r->pos - 8, _("Directory entry is for a %u-byte record "
255 "starting at offset %u but file is only "
257 de->ofs, de->len, r->file_size);
265 read_dictionary (struct pcp_reader *r)
267 unsigned int two, zero;
269 if (!read_uint32 (r, &two) || !read_uint32 (r, &zero))
271 if (two != 2 || zero != 0)
272 pcp_warn (r, 0, _("Directory fields have unexpected values "
273 "(%u,%u)."), two, zero);
275 if (!pcp_read_dir_entry (r, &r->directory.main)
276 || !pcp_read_dir_entry (r, &r->directory.variables)
277 || !pcp_read_dir_entry (r, &r->directory.labels)
278 || !pcp_read_dir_entry (r, &r->directory.data))
281 if (!read_main_header (r, &r->header))
284 read_variables_record (r);
289 struct get_strings_aux
300 add_string__ (struct get_strings_aux *aux,
301 const char *string, bool id, char *title)
303 if (aux->n >= aux->allocated)
305 aux->allocated = 2 * (aux->allocated + 1);
306 aux->titles = pool_realloc (aux->pool, aux->titles,
307 aux->allocated * sizeof *aux->titles);
308 aux->strings = pool_realloc (aux->pool, aux->strings,
309 aux->allocated * sizeof *aux->strings);
310 aux->ids = pool_realloc (aux->pool, aux->ids,
311 aux->allocated * sizeof *aux->ids);
314 aux->titles[aux->n] = title;
315 aux->strings[aux->n] = pool_strdup (aux->pool, string);
316 aux->ids[aux->n] = id;
320 static void PRINTF_FORMAT (3, 4)
321 add_string (struct get_strings_aux *aux,
322 const char *string, const char *title, ...)
326 va_start (args, title);
327 add_string__ (aux, string, false, pool_vasprintf (aux->pool, title, args));
331 static void PRINTF_FORMAT (3, 4)
332 add_id (struct get_strings_aux *aux, const char *id, const char *title, ...)
336 va_start (args, title);
337 add_string__ (aux, id, true, pool_vasprintf (aux->pool, title, args));
341 /* Retrieves significant string data from R in its raw format, to allow the
342 caller to try to detect the encoding in use.
344 Returns the number of strings retrieved N. Sets each of *TITLESP, *IDSP,
345 and *STRINGSP to an array of N elements allocated from POOL. For each I in
346 0...N-1, UTF-8 string *TITLESP[I] describes *STRINGSP[I], which is in
347 whatever encoding system file R uses. *IDS[I] is true if *STRINGSP[I] must
348 be a valid PSPP language identifier, false if *STRINGSP[I] is free-form
351 pcp_get_strings (const struct any_reader *r_, struct pool *pool,
352 char ***titlesp, bool **idsp, char ***stringsp)
354 struct pcp_reader *r = pcp_reader_cast (r_);
355 struct get_strings_aux aux;
367 for (i = 0; i < r->n_vars; i++)
368 if (r->vars[i].width != -1)
369 add_id (&aux, r->vars[i].name, _("Variable %zu"), ++var_idx);
372 for (i = 0; i < r->n_vars; i++)
373 if (r->vars[i].width != -1)
376 if (r->vars[i].label)
377 add_string (&aux, r->vars[i].label, _("Variable %zu Label"),
380 for (j = 0; j < r->vars[i].n_val_labs; j++)
381 add_string (&aux, r->vars[i].label,
382 _("Variable %zu Value Label %zu"), var_idx, j);
385 add_string (&aux, r->header.creation_date, _("Creation Date"));
386 add_string (&aux, r->header.creation_time, _("Creation Time"));
387 add_string (&aux, r->header.product, _("Product"));
388 add_string (&aux, r->header.file_label, _("File Label"));
390 *titlesp = aux.titles;
392 *stringsp = aux.strings;
397 find_and_delete_var (struct dictionary *dict, const char *name)
399 struct variable *var = dict_lookup_var (dict, name);
401 dict_delete_var (dict, var);
404 /* Decodes the dictionary read from R, saving it into *DICT. Character
405 strings in R are decoded using ENCODING, or an encoding obtained from R if
406 ENCODING is null, or the locale encoding if R specifies no encoding.
408 If INFOP is non-null, then it receives additional info about the system
409 file, which the caller must eventually free with any_read_info_destroy()
410 when it is no longer needed.
412 This function consumes R. The caller must use it again later, even to
413 destroy it with pcp_close(). */
414 static struct casereader *
415 pcp_decode (struct any_reader *r_, const char *encoding,
416 struct dictionary **dictp, struct any_read_info *infop)
418 struct pcp_reader *r = pcp_reader_cast (r_);
419 struct dictionary *dict;
421 if (encoding == NULL)
423 encoding = locale_charset ();
424 pcp_warn (r, -1, _("Using default encoding %s to read this SPSS/PC+ "
425 "system file. For best results, specify an "
426 "encoding explicitly. Use SYSFILE INFO with "
427 "ENCODING=\"DETECT\" to analyze the possible "
432 dict = dict_create (encoding);
433 r->encoding = dict_get_encoding (dict);
435 parse_header (r, &r->header, &r->info, dict);
436 if (!parse_variable_records (r, dict, r->vars, r->n_vars))
439 /* Create an index of dictionary variable widths for
440 pcp_read_case to use. We cannot use the `struct variable's
441 from the dictionary we created, because the caller owns the
442 dictionary and may destroy or modify its variables. */
443 r->proto = caseproto_ref_pool (dict_get_proto (dict), r->pool);
445 find_and_delete_var (dict, "CASENUM_");
446 find_and_delete_var (dict, "DATE_");
447 find_and_delete_var (dict, "WEIGHT_");
453 memset (&r->info, 0, sizeof r->info);
456 return casereader_create_sequential
457 (NULL, r->proto, r->n_cases, &pcp_file_casereader_class, r);
460 pcp_close (&r->any_reader);
466 /* Closes R, which should have been returned by pcp_open() but not already
467 closed with pcp_decode() or this function.
468 Returns true if an I/O error has occurred on READER, false
471 pcp_close (struct any_reader *r_)
473 struct pcp_reader *r = pcp_reader_cast (r_);
478 if (fn_close (r->fh, r->file) == EOF)
480 msg (ME, _("Error closing system file `%s': %s."),
481 fh_get_file_name (r->fh), strerror (errno));
487 any_read_info_destroy (&r->info);
492 pool_destroy (r->pool);
497 /* Destroys READER. */
499 pcp_file_casereader_destroy (struct casereader *reader UNUSED, void *r_)
501 struct pcp_reader *r = r_;
502 pcp_close (&r->any_reader);
505 /* Detects whether FILE is an SPSS/PC+ system file. Returns 1 if so, 0 if
506 not, and a negative errno value if there is an error reading FILE. */
508 pcp_detect (FILE *file)
510 static const char signature[4] = "SPSS";
511 char buf[sizeof signature];
513 if (fseek (file, 0x104, SEEK_SET))
516 if (fread (buf, sizeof buf, 1, file) != 1)
517 return ferror (file) ? -errno : 0;
519 return !memcmp (buf, signature, sizeof buf);
522 /* Reads the main header of the SPSS/PC+ system file. Initializes *HEADER and
523 *INFO, except for the string fields in *INFO, which parse_header() will
524 initialize later once the file's encoding is known. */
526 read_main_header (struct pcp_reader *r, struct pcp_main_header *header)
528 unsigned int base_ofs = r->directory.main.ofs;
529 unsigned int zero0, zero1, zero2, zero3;
530 size_t min_values, min_data_size;
531 unsigned int one0, one1;
532 unsigned int compressed;
533 unsigned int n_cases1;
536 if (!pcp_seek (r, base_ofs))
539 if (r->directory.main.len < 0xb0)
541 pcp_error (r, r->pos, _("This is not an SPSS/PC+ system file."));
544 else if (r->directory.main.len > 0xb0)
545 pcp_warn (r, r->pos, _("Record 0 has unexpected length %u."),
546 r->directory.main.len);
548 if (!read_uint16 (r, &one0)
549 || !read_string (r, header->product, sizeof header->product)
550 || !read_bytes (r, sysmis, sizeof sysmis)
551 || !read_uint32 (r, &zero0)
552 || !read_uint32 (r, &zero1)
553 || !read_uint16 (r, &one1)
554 || !read_uint16 (r, &compressed)
555 || !read_uint16 (r, &header->nominal_case_size)
556 || !read_uint16 (r, &r->n_cases)
557 || !read_uint16 (r, &header->weight_index)
558 || !read_uint16 (r, &zero2)
559 || !read_uint16 (r, &n_cases1)
560 || !read_uint16 (r, &zero3)
561 || !read_string (r, header->creation_date, sizeof header->creation_date)
562 || !read_string (r, header->creation_time, sizeof header->creation_time)
563 || !read_string (r, header->file_label, sizeof header->file_label))
566 if (!pcp_is_sysmis (sysmis))
568 double d = parse_float (sysmis);
569 pcp_warn (r, base_ofs, _("Record 0 specifies unexpected system missing "
570 "value %g (%a)."), d, d);
572 if (one0 != 1 || one1 != 1
573 || zero0 != 0 || zero1 != 0 || zero2 != 0 || zero3 != 0)
574 pcp_warn (r, base_ofs, _("Record 0 reserved fields have unexpected values "
575 "(%u,%u,%u,%u,%u,%u)."),
576 one0, one1, zero0, zero1, zero2, zero3);
577 if (n_cases1 != r->n_cases)
578 pcp_warn (r, base_ofs, _("Record 0 case counts differ (%u versus %u)."),
579 r->n_cases, n_cases1);
580 if (compressed != 0 && compressed != 1)
582 pcp_error (r, base_ofs, _("Invalid compression type %u."), compressed);
586 r->compressed = compressed != 0;
588 min_values = xtimes (header->nominal_case_size, r->n_cases);
589 min_data_size = xtimes (compressed ? 1 : 8, min_values);
590 if (r->directory.data.len < min_data_size
591 || size_overflow_p (min_data_size))
593 pcp_warn (r, base_ofs, _("Record 0 claims %u cases with %u values per "
594 "case (requiring at least %zu bytes) but data "
595 "record is only %u bytes long."),
596 r->n_cases, header->nominal_case_size, min_data_size,
597 r->directory.data.len);
605 read_value_labels (struct pcp_reader *r, struct pcp_var_record *var,
606 unsigned int start, unsigned int end)
608 size_t allocated_val_labs = 0;
612 if (end > r->directory.labels.len)
614 pcp_warn (r, r->pos - 32,
615 _("Value labels claimed to end at offset %u in labels record "
616 "but labels record is only %u bytes."),
617 end, r->directory.labels.len);
621 start += r->directory.labels.ofs;
622 end += r->directory.labels.ofs;
623 if (start > end || end > r->file_size)
625 pcp_warn (r, r->pos - 32,
626 _("Value labels claimed to be at offset %u with length %u "
627 "but file size is only %u bytes."),
628 start, end - start, r->file_size);
632 if (!pcp_seek (r, start))
635 while (r->pos < end && end - r->pos > 8)
637 struct pcp_value_label *vl;
640 if (var->n_val_labs >= allocated_val_labs)
641 var->val_labs = pool_2nrealloc (r->pool, var->val_labs,
643 sizeof *var->val_labs);
644 vl = &var->val_labs[var->n_val_labs];
646 if (!read_bytes (r, vl->value, sizeof vl->value)
647 || !read_bytes (r, &len, 1))
650 if (end - r->pos < len)
653 _("Value labels end with partial label (%u bytes left in "
654 "record, label length %"PRIu8")."),
658 vl->label = pool_malloc (r->pool, len + 1);
659 if (!read_bytes (r, vl->label, len))
662 vl->label[len] = '\0';
666 pcp_warn (r, r->pos, _("%u leftover bytes following value labels."),
673 read_var_label (struct pcp_reader *r, struct pcp_var_record *var,
679 if (ofs >= r->directory.labels.len)
681 pcp_warn (r, r->pos - 32,
682 _("Variable label claimed to start at offset %u in labels "
683 "record but labels record is only %u bytes."),
684 ofs, r->directory.labels.len);
688 if (!pcp_seek (r, ofs + r->directory.labels.ofs) || !read_bytes (r, &len, 1))
691 if (len >= r->directory.labels.len - ofs)
693 pcp_warn (r, r->pos - 1,
694 _("Variable label with length %u starting at offset %u in "
695 "labels record overruns end of %u-byte labels record."),
696 len, ofs + 1, r->directory.labels.len);
700 var->label = pool_malloc (r->pool, len + 1);
701 var->label[len] = '\0';
702 return read_bytes (r, var->label, len);
705 /* Reads the variables record (record 1) into R. */
707 read_variables_record (struct pcp_reader *r)
712 if (!pcp_seek (r, r->directory.variables.ofs))
714 if (r->directory.variables.len != r->header.nominal_case_size * 32)
716 pcp_error (r, r->pos, _("Record 1 has length %u (expected %u)."),
717 r->directory.variables.len, r->header.nominal_case_size * 32);
721 r->vars = pool_calloc (r->pool,
722 r->header.nominal_case_size, sizeof *r->vars);
724 for (i = 0; i < r->header.nominal_case_size; i++)
726 struct pcp_var_record *var = &r->vars[r->n_vars++];
727 unsigned int value_label_start, value_label_end;
728 unsigned int var_label_ofs;
733 if (!read_uint32 (r, &value_label_start)
734 || !read_uint32 (r, &value_label_end)
735 || !read_uint32 (r, &var_label_ofs)
736 || !read_uint32 (r, &format)
737 || !read_string (r, var->name, sizeof var->name)
738 || !read_bytes (r, var->missing, sizeof var->missing))
741 var->weight = r->header.weight_index && i == r->header.weight_index - 1;
745 raw_type = format >> 16;
746 if (!fmt_from_io (raw_type, &var->format.type))
748 pcp_error (r, var->pos, _("Variable %u has invalid type %"PRIu8"."),
753 var->format.w = (format >> 8) & 0xff;
754 var->format.d = format & 0xff;
755 fmt_fix_output (&var->format);
756 var->width = fmt_var_width (var->format);
760 unsigned int save_pos = r->pos;
761 if (!read_var_label (r, var, var_label_ofs)
762 || !pcp_seek (r, save_pos))
766 if (value_label_end > value_label_start && var->width <= 8)
768 unsigned int save_pos = r->pos;
769 if (!read_value_labels (r, var, value_label_start, value_label_end)
770 || !pcp_seek (r, save_pos))
776 int extra = DIV_RND_UP (var->width - 8, 8);
778 if (!skip_bytes (r, 32 * extra))
783 if (r->header.weight_index && !weighted)
784 pcp_warn (r, -1, _("Invalid weight index %u."), r->header.weight_index);
790 recode_and_trim_string (struct pool *pool, const char *from, const char *in)
792 struct substring out;
794 out = recode_substring_pool ("UTF-8", from, ss_cstr (in), pool);
795 ss_trim (&out, ss_cstr (" "));
796 return ss_xstrdup (out);
800 parse_header (struct pcp_reader *r, const struct pcp_main_header *header,
801 struct any_read_info *info, struct dictionary *dict)
803 const char *dict_encoding = dict_get_encoding (dict);
806 memset (info, 0, sizeof *info);
808 info->integer_format = INTEGER_LSB_FIRST;
809 info->float_format = FLOAT_IEEE_DOUBLE_LE;
810 info->compression = r->compressed ? ANY_COMP_SIMPLE : ANY_COMP_NONE;
811 info->n_cases = r->n_cases;
813 /* Convert file label to UTF-8 and put it into DICT. */
814 label = recode_and_trim_string (r->pool, dict_encoding, header->file_label);
815 dict_set_label (dict, label);
818 /* Put creation date, time, and product in UTF-8 into INFO. */
819 info->creation_date = recode_and_trim_string (r->pool, dict_encoding,
820 header->creation_date);
821 info->creation_time = recode_and_trim_string (r->pool, dict_encoding,
822 header->creation_time);
823 info->product = recode_and_trim_string (r->pool, dict_encoding,
827 /* Reads a variable (type 2) record from R and adds the
828 corresponding variable to DICT.
829 Also skips past additional variable records for long string
832 parse_variable_records (struct pcp_reader *r, struct dictionary *dict,
833 struct pcp_var_record *var_recs, size_t n_var_recs)
835 const char *dict_encoding = dict_get_encoding (dict);
836 struct pcp_var_record *rec;
838 for (rec = var_recs; rec < &var_recs[n_var_recs]; rec++)
843 name = recode_string_pool ("UTF-8", dict_encoding,
844 rec->name, -1, r->pool);
845 name[strcspn (name, " ")] = '\0';
847 /* Transform $DATE => DATE_, $WEIGHT => WEIGHT_, $CASENUM => CASENUM_. */
849 name = pool_asprintf (r->pool, "%s_", name + 1);
851 if (!dict_id_is_valid (dict, name) || name[0] == '#')
853 pcp_error (r, rec->pos, _("Invalid variable name `%s'."), name);
857 struct variable *var = dict_create_var (dict, name, rec->width);
860 char *new_name = dict_make_unique_var_name (dict, NULL, NULL);
861 pcp_warn (r, rec->pos, _("Renaming variable with duplicate name "
864 var = dict_create_var_assert (dict, new_name, rec->width);
870 dict_set_weight (dict, var);
872 pcp_warn (r, rec->pos,
873 _("Cannot weight by string variable `%s'."), name);
876 /* Set the short name the same as the long name. */
877 var_set_short_name (var, 0, name);
879 /* Get variable label, if any. */
884 utf8_label = recode_string ("UTF-8", dict_encoding, rec->label, -1);
885 var_set_label (var, utf8_label);
889 /* Add value labels. */
890 for (i = 0; i < rec->n_val_labs; i++)
895 value_init (&value, rec->width);
896 if (var_is_numeric (var))
897 value.f = parse_float (rec->val_labs[i].value);
899 memcpy (value.s, rec->val_labs[i].value, rec->width);
901 utf8_label = recode_string ("UTF-8", dict_encoding,
902 rec->val_labs[i].label, -1);
903 var_add_value_label (var, &value, utf8_label);
906 value_destroy (&value, rec->width);
909 /* Set missing values. */
910 if (rec->width <= 8 && !pcp_is_sysmis (rec->missing))
912 int width = var_get_width (var);
913 struct missing_values mv;
915 mv_init_pool (r->pool, &mv, width);
916 if (var_is_numeric (var))
917 mv_add_num (&mv, parse_float (rec->missing));
919 mv_add_str (&mv, rec->missing, MIN (width, 8));
920 var_set_missing_values (var, &mv);
924 var_set_both_formats (var, rec->format);
932 static void read_error (struct casereader *, const struct pcp_reader *);
934 static bool read_case_number (struct pcp_reader *, double *);
935 static int read_case_string (struct pcp_reader *, uint8_t *, size_t);
936 static int read_opcode (struct pcp_reader *);
937 static bool read_compressed_number (struct pcp_reader *, double *);
938 static int read_compressed_string (struct pcp_reader *, uint8_t *);
939 static int read_whole_strings (struct pcp_reader *, uint8_t *, size_t);
941 /* Reads and returns one case from READER's file. Returns a null
942 pointer if not successful. */
943 static struct ccase *
944 pcp_file_casereader_read (struct casereader *reader, void *r_)
946 struct pcp_reader *r = r_;
947 unsigned int start_pos = r->pos;
952 if (r->error || !r->n_cases)
956 c = case_create (r->proto);
957 for (i = 0; i < r->n_vars; i++)
959 struct pcp_var_record *var = &r->vars[i];
960 union value *v = case_data_rw_idx (c, i);
963 retval = read_case_number (r, &v->f);
965 retval = read_case_string (r, v->s, var->width);
969 pcp_error (r, r->pos, _("File ends in partial case."));
973 if (r->pos > r->directory.data.ofs + r->directory.data.len)
975 pcp_error (r, r->pos, _("Case beginning at offset 0x%08x extends past "
976 "end of data record at offset 0x%08x."),
977 start_pos, r->directory.data.ofs + r->directory.data.len);
984 read_error (reader, r);
989 /* Issues an error that an unspecified error occurred PCP, and
992 read_error (struct casereader *r, const struct pcp_reader *pcp)
994 msg (ME, _("Error reading case from file %s."), fh_get_name (pcp->fh));
995 casereader_force_error (r);
998 /* Reads a number from R and stores its value in *D.
999 If R is compressed, reads a compressed number;
1000 otherwise, reads a number in the regular way.
1001 Returns true if successful, false if end of file is
1002 reached immediately. */
1004 read_case_number (struct pcp_reader *r, double *d)
1009 if (!try_read_bytes (r, number, sizeof number))
1011 *d = parse_float (number);
1015 return read_compressed_number (r, d);
1018 /* Reads LENGTH string bytes from R into S. Always reads a multiple of 8
1019 bytes; if LENGTH is not a multiple of 8, then extra bytes are read and
1020 discarded without being written to S. Reads compressed strings if S is
1021 compressed. Returns 1 if successful, 0 if end of file is reached
1022 immediately, or -1 for some kind of error. */
1024 read_case_string (struct pcp_reader *r, uint8_t *s, size_t length)
1026 size_t whole = ROUND_DOWN (length, 8);
1027 size_t partial = length % 8;
1031 int retval = read_whole_strings (r, s, whole);
1039 int retval = read_whole_strings (r, bounce, sizeof bounce);
1042 memcpy (s + whole, bounce, partial);
1048 /* Reads and returns the next compression opcode from R. */
1050 read_opcode (struct pcp_reader *r)
1052 assert (r->compressed);
1053 if (r->opcode_idx >= sizeof r->opcodes)
1055 int retval = try_read_bytes (r, r->opcodes, sizeof r->opcodes);
1060 return r->opcodes[r->opcode_idx++];
1063 /* Reads a compressed number from R and stores its value in D.
1064 Returns true if successful, false if end of file is
1065 reached immediately. */
1067 read_compressed_number (struct pcp_reader *r, double *d)
1069 int opcode = read_opcode (r);
1080 return read_float (r, d);
1083 *d = opcode - 105.0;
1088 /* Reads a compressed 8-byte string segment from R and stores it in DST. */
1090 read_compressed_string (struct pcp_reader *r, uint8_t *dst)
1095 opcode = read_opcode (r);
1102 retval = read_bytes (r, dst, 8);
1103 return retval == 1 ? 1 : -1;
1106 if (!r->corruption_warning)
1108 r->corruption_warning = true;
1109 pcp_warn (r, r->pos,
1110 _("Possible compressed data corruption: "
1111 "string contains compressed integer (opcode %d)."),
1114 memset (dst, ' ', 8);
1119 /* Reads LENGTH string bytes from R into S. LENGTH must be a multiple of 8.
1120 Reads compressed strings if S is compressed. Returns 1 if successful, 0 if
1121 end of file is reached immediately, or -1 for some kind of error. */
1123 read_whole_strings (struct pcp_reader *r, uint8_t *s, size_t length)
1125 assert (length % 8 == 0);
1127 return try_read_bytes (r, s, length);
1132 for (ofs = 0; ofs < length; ofs += 8)
1134 int retval = read_compressed_string (r, s + ofs);
1144 /* Displays a corruption message. */
1146 pcp_msg (struct pcp_reader *r, off_t offset,
1147 int class, const char *format, va_list args)
1150 ds_init_empty (&text);
1152 ds_put_format (&text, _("`%s' near offset 0x%llx: "),
1153 fh_get_file_name (r->fh), (long long int) offset);
1155 ds_put_format (&text, _("`%s': "), fh_get_file_name (r->fh));
1156 ds_put_vformat (&text, format, args);
1158 struct msg *m = xmalloc (sizeof *m);
1160 .category = msg_class_to_category (class),
1161 .severity = msg_class_to_severity (class),
1162 .text = ds_steal_cstr (&text),
1167 /* Displays a warning for offset OFFSET in the file. */
1169 pcp_warn (struct pcp_reader *r, off_t offset, const char *format, ...)
1173 va_start (args, format);
1174 pcp_msg (r, offset, MW, format, args);
1178 /* Displays an error for the current file position,
1179 marks it as in an error state,
1180 and aborts reading it using longjmp. */
1182 pcp_error (struct pcp_reader *r, off_t offset, const char *format, ...)
1186 va_start (args, format);
1187 pcp_msg (r, offset, ME, format, args);
1193 /* Reads BYTE_CNT bytes into BUF.
1194 Returns 1 if exactly BYTE_CNT bytes are successfully read.
1195 Returns -1 if an I/O error or a partial read occurs.
1196 Returns 0 for an immediate end-of-file and, if EOF_IS_OK is false, reports
1199 read_bytes_internal (struct pcp_reader *r, bool eof_is_ok,
1200 void *buf, size_t n_bytes)
1202 size_t bytes_read = fread (buf, 1, n_bytes, r->file);
1203 r->pos += bytes_read;
1204 if (bytes_read == n_bytes)
1206 else if (ferror (r->file))
1208 pcp_error (r, r->pos, _("System error: %s."), strerror (errno));
1211 else if (!eof_is_ok || bytes_read != 0)
1213 pcp_error (r, r->pos, _("Unexpected end of file."));
1220 /* Reads BYTE_CNT into BUF.
1221 Returns true if successful.
1222 Returns false upon I/O error or if end-of-file is encountered. */
1224 read_bytes (struct pcp_reader *r, void *buf, size_t n_bytes)
1226 return read_bytes_internal (r, false, buf, n_bytes) == 1;
1229 /* Reads BYTE_CNT bytes into BUF.
1230 Returns 1 if exactly BYTE_CNT bytes are successfully read.
1231 Returns 0 if an immediate end-of-file is encountered.
1232 Returns -1 if an I/O error or a partial read occurs. */
1234 try_read_bytes (struct pcp_reader *r, void *buf, size_t n_bytes)
1236 return read_bytes_internal (r, true, buf, n_bytes);
1239 /* Reads a 16-bit signed integer from R and stores its value in host format in
1240 *X. Returns true if successful, otherwise false. */
1242 read_uint16 (struct pcp_reader *r, unsigned int *x)
1245 if (read_bytes (r, integer, sizeof integer) != 1)
1247 *x = integer_get (INTEGER_LSB_FIRST, integer, sizeof integer);
1251 /* Reads a 32-bit signed integer from R and stores its value in host format in
1252 *X. Returns true if successful, otherwise false. */
1254 read_uint32 (struct pcp_reader *r, unsigned int *x)
1257 if (read_bytes (r, integer, sizeof integer) != 1)
1259 *x = integer_get (INTEGER_LSB_FIRST, integer, sizeof integer);
1263 /* Reads exactly SIZE - 1 bytes into BUFFER
1264 and stores a null byte into BUFFER[SIZE - 1]. */
1266 read_string (struct pcp_reader *r, char *buffer, size_t size)
1271 ok = read_bytes (r, buffer, size - 1);
1273 buffer[size - 1] = '\0';
1277 /* Skips BYTES bytes forward in R. */
1279 skip_bytes (struct pcp_reader *r, size_t bytes)
1284 size_t chunk = MIN (sizeof buffer, bytes);
1285 if (!read_bytes (r, buffer, chunk))
1294 pcp_seek (struct pcp_reader *r, off_t offset)
1296 if (fseeko (r->file, offset, SEEK_SET))
1298 pcp_error (r, 0, _("%s: seek failed (%s)."),
1299 fh_get_file_name (r->fh), strerror (errno));
1306 /* Reads a 64-bit floating-point number from R and returns its
1307 value in host format. */
1309 read_float (struct pcp_reader *r, double *d)
1313 if (!read_bytes (r, number, sizeof number))
1317 *d = parse_float (number);
1323 parse_float (const uint8_t number[8])
1325 return (pcp_is_sysmis (number)
1327 : float_get_double (FLOAT_IEEE_DOUBLE_LE, number));
1331 pcp_is_sysmis(const uint8_t *p)
1333 static const uint8_t sysmis[8]
1334 = { 0xf5, 0x1e, 0x26, 0x02, 0x8a, 0x8c, 0xed, 0xff };
1335 return !memcmp (p, sysmis, 8);
1338 static const struct casereader_class pcp_file_casereader_class =
1340 pcp_file_casereader_read,
1341 pcp_file_casereader_destroy,
1346 const struct any_reader_class pcp_file_reader_class =
1348 N_("SPSS/PC+ System File"),