1 use crate::endian::{Endian, Parse, ToBytes};
3 use encoding_rs::{mem::decode_latin1, DecoderResult, Encoding};
4 use flate2::read::ZlibDecoder;
10 collections::VecDeque,
11 fmt::{Debug, Display, Formatter, Result as FmtResult},
12 io::{Error as IoError, Read, Seek, SeekFrom},
19 use thiserror::Error as ThisError;
21 #[derive(ThisError, Debug)]
23 #[error("Not an SPSS system file")]
26 #[error("Invalid magic number {0:?}")]
29 #[error("I/O error ({0})")]
32 #[error("Invalid SAV compression code {0}")]
33 InvalidSavCompression(u32),
35 #[error("Invalid ZSAV compression code {0}")]
36 InvalidZsavCompression(u32),
38 #[error("Variable record at offset {offset:#x} specifies width {width} not in valid range [-1,255).")]
39 BadVariableWidth { offset: u64, width: i32 },
41 #[error("Document record at offset {offset:#x} has document line count ({n}) greater than the maximum number {max}.")]
42 BadDocumentLength { offset: u64, n: usize, max: usize },
44 #[error("At offset {offset:#x}, unrecognized record type {rec_type}.")]
45 BadRecordType { offset: u64, rec_type: u32 },
47 #[error("In variable record starting at offset {start_offset:#x}, variable label code {code} at offset {code_offset:#x} is not 0 or 1.")]
48 BadVariableLabelCode {
55 "At offset {offset:#x}, numeric missing value code ({code}) is not -3, -2, 0, 1, 2, or 3."
57 BadNumericMissingValueCode { offset: u64, code: i32 },
59 #[error("At offset {offset:#x}, string missing value code ({code}) is not 0, 1, 2, or 3.")]
60 BadStringMissingValueCode { offset: u64, code: i32 },
62 #[error("At offset {offset:#x}, number of value labels ({n}) is greater than the maximum number {max}.")]
63 BadNumberOfValueLabels { offset: u64, n: u32, max: u32 },
65 #[error("At offset {offset:#x}, following value label record, found record type {rec_type} instead of expected type 4 for variable index record")]
66 ExpectedVarIndexRecord { offset: u64, rec_type: u32 },
68 #[error("At offset {offset:#x}, number of variables indexes for value labels ({n}) is greater than the maximum number ({max}).")]
69 TooManyVarIndexes { offset: u64, n: u32, max: u32 },
71 #[error("At offset {offset:#x}, at least one valid variable index for value labels is required but none were specified.")]
72 NoVarIndexes { offset: u64 },
74 #[error("At offset {offset:#x}, the first variable index is for a {var_type} variable but the following variable indexes are for {} variables: {wrong_types:?}", var_type.opposite())]
78 wrong_types: Vec<u32>,
81 #[error("At offset {offset:#x}, one or more variable indexes for value labels were not in the valid range [1,{max}]: {invalid:?}")]
88 #[error("At offset {offset:#x}, record type 7 subtype {subtype} is too large with element size {size} and {count} elements.")]
89 ExtensionRecordTooLarge {
96 #[error("Unexpected end of file at offset {offset:#x}, {case_ofs} bytes into a {case_len}-byte case.")]
104 "Unexpected end of file at offset {offset:#x}, {case_ofs} bytes into a compressed case."
106 EofInCompressedCase { offset: u64, case_ofs: u64 },
108 #[error("Data ends at offset {offset:#x}, {case_ofs} bytes into a compressed case.")]
109 PartialCompressedCase { offset: u64, case_ofs: u64 },
111 #[error("At {case_ofs} bytes into compressed case starting at offset {offset:#x}, a string was found where a number was expected.")]
112 CompressedNumberExpected { offset: u64, case_ofs: u64 },
114 #[error("At {case_ofs} bytes into compressed case starting at offset {offset:#x}, a number was found where a string was expected.")]
115 CompressedStringExpected { offset: u64, case_ofs: u64 },
117 #[error("Block count {n_blocks} in ZLIB trailer at offset {offset:#x} differs from expected block count {expected_n_blocks} calculated from trailer length {ztrailer_len}.")]
118 BadZlibTrailerNBlocks {
121 expected_n_blocks: u64,
125 #[error("At offset {offset:#x}, {record} has bad size {size} bytes instead of the expected {expected_size}.")]
133 #[error("At offset {offset:#x}, {record} has bad count {count} instead of the expected {expected_count}.")]
141 #[error("In long string missing values record starting at offset {record_offset:#x}, value length at offset {offset:#x} is {value_len} instead of the expected 8.")]
142 BadLongMissingValueLength {
148 #[error("The encoding record at offset {offset:#x} contains an encoding name that is not valid UTF-8.")]
149 BadEncodingName { offset: u64 },
151 // XXX This is risky because `text` might be arbitarily long.
152 #[error("Text string contains invalid bytes for {encoding} encoding: {text}")]
153 MalformedString { encoding: String, text: String },
155 #[error("Invalid variable measurement level value {0}")]
156 InvalidMeasurement(u32),
158 #[error("Invalid variable display alignment value {0}")]
159 InvalidAlignment(u32),
161 #[error("Details TBD")]
165 #[derive(Clone, Debug)]
167 Header(HeaderRecord<RawString>),
168 Variable(VariableRecord<RawString, RawStr<8>>),
169 ValueLabel(ValueLabelRecord<RawStr<8>, RawString>),
170 Document(DocumentRecord<RawDocumentLine>),
171 IntegerInfo(IntegerInfoRecord),
172 FloatInfo(FloatInfoRecord),
173 VariableSets(TextRecord),
174 VarDisplay(VarDisplayRecord),
175 MultipleResponse(MultipleResponseRecord<RawString>),
176 LongStringValueLabels(LongStringValueLabelRecord),
177 LongStringMissingValues(LongStringMissingValueRecord),
178 Encoding(EncodingRecord),
179 NumberOfCases(NumberOfCasesRecord),
180 ProductInfo(TextRecord),
181 LongNames(TextRecord),
182 VeryLongStrings(TextRecord),
183 FileAttributes(TextRecord),
184 VariableAttributes(TextRecord),
185 OtherExtension(Extension),
189 Cases(Rc<RefCell<Cases>>),
196 var_types: &[VarType],
197 warn: &Box<dyn Fn(Error)>,
198 ) -> Result<Option<Record>, Error>
202 let rec_type: u32 = endian.parse(read_bytes(reader)?);
204 2 => Ok(Some(VariableRecord::read(reader, endian)?)),
205 3 => Ok(ValueLabelRecord::read(reader, endian, var_types, warn)?),
206 6 => Ok(Some(DocumentRecord::read(reader, endian)?)),
207 7 => Extension::read(reader, endian, var_types.len(), warn),
208 999 => Ok(Some(Record::EndOfHeaders(
209 endian.parse(read_bytes(reader)?),
211 _ => Err(Error::BadRecordType {
212 offset: reader.stream_position()?,
219 // If `s` is valid UTF-8, returns it decoded as UTF-8, otherwise returns it
220 // decoded as Latin-1 (actually bytes interpreted as Unicode code points).
221 fn default_decode(s: &[u8]) -> Cow<str> {
222 from_utf8(s).map_or_else(|_| decode_latin1(s), Cow::from)
225 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
226 pub enum Compression {
232 fn offsets(&self) -> Range<u64>;
236 pub struct HeaderRecord<S>
241 pub offsets: Range<u64>,
246 /// Eye-catcher string, product name, in the file's encoding. Padded
247 /// on the right with spaces.
250 /// Layout code, normally either 2 or 3.
251 pub layout_code: u32,
253 /// Number of variable positions, or `None` if the value in the file is
254 /// questionably trustworthy.
255 pub nominal_case_size: Option<u32>,
257 /// Compression type, if any,
258 pub compression: Option<Compression>,
260 /// 1-based variable index of the weight variable, or `None` if the file is
262 pub weight_index: Option<u32>,
264 /// Claimed number of cases, if known.
265 pub n_cases: Option<u32>,
267 /// Compression bias, usually 100.0.
270 /// `dd mmm yy` in the file's encoding.
271 pub creation_date: S,
273 /// `HH:MM:SS` in the file's encoding.
274 pub creation_time: S,
276 /// File label, in the file's encoding. Padded on the right with spaces.
279 /// Endianness of the data in the file header.
283 impl<S> HeaderRecord<S>
287 fn debug_field<T>(&self, f: &mut Formatter, name: &str, value: T) -> FmtResult
291 writeln!(f, "{name:>17}: {:?}", value)
295 impl<S> Debug for HeaderRecord<S>
299 fn fmt(&self, f: &mut Formatter) -> FmtResult {
300 writeln!(f, "File header record:")?;
301 self.debug_field(f, "Magic", self.magic)?;
302 self.debug_field(f, "Product name", &self.eye_catcher)?;
303 self.debug_field(f, "Layout code", self.layout_code)?;
304 self.debug_field(f, "Nominal case size", self.nominal_case_size)?;
305 self.debug_field(f, "Compression", self.compression)?;
306 self.debug_field(f, "Weight index", self.weight_index)?;
307 self.debug_field(f, "Number of cases", self.n_cases)?;
308 self.debug_field(f, "Compression bias", self.bias)?;
309 self.debug_field(f, "Creation date", &self.creation_date)?;
310 self.debug_field(f, "Creation time", &self.creation_time)?;
311 self.debug_field(f, "File label", &self.file_label)?;
312 self.debug_field(f, "Endianness", self.endian)
316 impl HeaderRecord<RawString> {
317 fn read<R: Read + Seek>(r: &mut R) -> Result<Self, Error> {
318 let start = r.stream_position()?;
320 let magic: [u8; 4] = read_bytes(r)?;
321 let magic: Magic = magic.try_into().map_err(|_| Error::NotASystemFile)?;
323 let eye_catcher = RawString(read_vec(r, 60)?);
324 let layout_code: [u8; 4] = read_bytes(r)?;
325 let endian = Endian::identify_u32(2, layout_code)
326 .or_else(|| Endian::identify_u32(2, layout_code))
327 .ok_or_else(|| Error::NotASystemFile)?;
328 let layout_code = endian.parse(layout_code);
330 let nominal_case_size: u32 = endian.parse(read_bytes(r)?);
331 let nominal_case_size =
332 (nominal_case_size <= i32::MAX as u32 / 16).then_some(nominal_case_size);
334 let compression_code: u32 = endian.parse(read_bytes(r)?);
335 let compression = match (magic, compression_code) {
336 (Magic::Zsav, 2) => Some(Compression::ZLib),
337 (Magic::Zsav, code) => return Err(Error::InvalidZsavCompression(code)),
339 (_, 1) => Some(Compression::Simple),
340 (_, code) => return Err(Error::InvalidSavCompression(code)),
343 let weight_index: u32 = endian.parse(read_bytes(r)?);
344 let weight_index = (weight_index > 0).then_some(weight_index);
346 let n_cases: u32 = endian.parse(read_bytes(r)?);
347 let n_cases = (n_cases < i32::MAX as u32 / 2).then_some(n_cases);
349 let bias: f64 = endian.parse(read_bytes(r)?);
351 let creation_date = RawString(read_vec(r, 9)?);
352 let creation_time = RawString(read_vec(r, 8)?);
353 let file_label = RawString(read_vec(r, 64)?);
354 let _: [u8; 3] = read_bytes(r)?;
357 offsets: start..r.stream_position()?,
373 fn decode<'a>(&'a self, decoder: &Decoder) -> HeaderRecord<Cow<'a, str>> {
374 let eye_catcher = decoder.decode(&self.eye_catcher);
375 let file_label = decoder.decode(&self.file_label);
376 let creation_date = decoder.decode(&self.creation_date);
377 let creation_time = decoder.decode(&self.creation_time);
380 weight_index: self.weight_index,
381 n_cases: self.n_cases,
383 offsets: self.offsets.clone(),
385 layout_code: self.layout_code,
386 nominal_case_size: self.nominal_case_size,
387 compression: self.compression,
397 encoding: &'static Encoding,
398 warn: Box<dyn Fn(Error)>,
402 fn decode_slice<'a>(&self, input: &'a [u8]) -> Cow<'a, str> {
403 let (output, malformed) = self.encoding.decode_without_bom_handling(input);
405 (self.warn)(Error::MalformedString {
406 encoding: self.encoding.name().into(),
407 text: output.clone().into(),
413 fn decode<'a>(&self, input: &'a RawString) -> Cow<'a, str> {
414 self.decode_slice(input.0.as_slice())
417 /// Returns `input` decoded from `self.encoding` into UTF-8 such that
418 /// re-encoding the result back into `self.encoding` will have exactly the
419 /// same length in bytes.
421 /// XXX warn about errors?
422 fn decode_exact_length<'a>(&self, input: &'a [u8]) -> Cow<'a, str> {
423 if let (s, false) = self.encoding.decode_without_bom_handling(input) {
424 // This is the common case. Usually there will be no errors.
427 // Unusual case. Don't bother to optimize it much.
428 let mut decoder = self.encoding.new_decoder_without_bom_handling();
429 let mut output = String::with_capacity(
431 .max_utf8_buffer_length_without_replacement(input.len())
434 let mut rest = input;
435 while !rest.is_empty() {
436 match decoder.decode_to_string_without_replacement(rest, &mut output, true) {
437 (DecoderResult::InputEmpty, _) => break,
438 (DecoderResult::OutputFull, _) => unreachable!(),
439 (DecoderResult::Malformed(a, b), consumed) => {
440 let skipped = a as usize + b as usize;
441 output.extend(repeat('?').take(skipped));
442 rest = &rest[consumed..];
446 assert_eq!(self.encoding.encode(&output).0.len(), input.len());
452 impl<S> Header for HeaderRecord<S>
456 fn offsets(&self) -> Range<u64> {
461 #[derive(Copy, Clone, PartialEq, Eq, Hash)]
463 /// Regular system file.
466 /// System file with Zlib-compressed data.
469 /// EBCDIC-encoded system file.
474 /// Magic number for a regular system file.
475 pub const SAV: [u8; 4] = *b"$FL2";
477 /// Magic number for a system file that contains zlib-compressed data.
478 pub const ZSAV: [u8; 4] = *b"$FL3";
480 /// Magic number for an EBCDIC-encoded system file. This is `$FL2` encoded
482 pub const EBCDIC: [u8; 4] = [0x5b, 0xc6, 0xd3, 0xf2];
485 impl Debug for Magic {
486 fn fmt(&self, f: &mut Formatter) -> FmtResult {
487 let s = match *self {
488 Magic::Sav => "$FL2",
489 Magic::Zsav => "$FL3",
490 Magic::Ebcdic => "($FL2 in EBCDIC)",
496 impl TryFrom<[u8; 4]> for Magic {
499 fn try_from(value: [u8; 4]) -> Result<Self, Self::Error> {
501 Magic::SAV => Ok(Magic::Sav),
502 Magic::ZSAV => Ok(Magic::Zsav),
503 Magic::EBCDIC => Ok(Magic::Ebcdic),
504 _ => Err(Error::BadMagic(value)),
509 #[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
516 fn from_width(width: i32) -> VarType {
518 0 => VarType::Numeric,
519 _ => VarType::String,
523 fn opposite(self) -> VarType {
525 Self::Numeric => Self::String,
526 Self::String => Self::Numeric,
531 impl Display for VarType {
532 fn fmt(&self, f: &mut Formatter) -> FmtResult {
534 VarType::Numeric => write!(f, "numeric"),
535 VarType::String => write!(f, "string"),
540 #[derive(Copy, Clone)]
549 type RawValue = Value<RawStr<8>>;
551 impl<S> Debug for Value<S>
555 fn fmt(&self, f: &mut Formatter) -> FmtResult {
557 Value::Number(Some(number)) => write!(f, "{number:?}"),
558 Value::Number(None) => write!(f, "SYSMIS"),
559 Value::String(s) => write!(f, "{:?}", s),
565 fn read<R: Read>(r: &mut R, var_type: VarType, endian: Endian) -> Result<Self, IoError> {
567 &UntypedValue(read_bytes(r)?),
573 pub fn from_raw(raw: &UntypedValue, var_type: VarType, endian: Endian) -> Self {
575 VarType::String => Value::String(RawStr(raw.0)),
576 VarType::Numeric => {
577 let number: f64 = endian.parse(raw.0);
578 Value::Number((number != -f64::MAX).then_some(number))
583 fn read_case<R: Read + Seek>(
585 var_types: &[VarType],
587 ) -> Result<Option<Vec<Self>>, Error> {
588 let case_start = reader.stream_position()?;
589 let mut values = Vec::with_capacity(var_types.len());
590 for (i, &var_type) in var_types.iter().enumerate() {
591 let Some(raw) = try_read_bytes(reader)? else {
595 let offset = reader.stream_position()?;
596 return Err(Error::EofInCase {
598 case_ofs: offset - case_start,
599 case_len: var_types.len() * 8,
603 values.push(Value::from_raw(&UntypedValue(raw), var_type, endian));
608 fn read_compressed_case<R: Read + Seek>(
610 var_types: &[VarType],
611 codes: &mut VecDeque<u8>,
614 ) -> Result<Option<Vec<Self>>, Error> {
615 let case_start = reader.stream_position()?;
616 let mut values = Vec::with_capacity(var_types.len());
617 for (i, &var_type) in var_types.iter().enumerate() {
619 let Some(code) = codes.pop_front() else {
620 let Some(new_codes): Option<[u8; 8]> = try_read_bytes(reader)? else {
624 let offset = reader.stream_position()?;
625 return Err(Error::EofInCompressedCase {
627 case_ofs: offset - case_start,
631 codes.extend(new_codes.into_iter());
636 1..=251 => match var_type {
637 VarType::Numeric => break Self::Number(Some(code as f64 - bias)),
639 break Self::String(RawStr(endian.to_bytes(code as f64 - bias)))
646 let offset = reader.stream_position()?;
647 return Err(Error::PartialCompressedCase {
649 case_ofs: offset - case_start,
654 break Self::from_raw(&UntypedValue(read_bytes(reader)?), var_type, endian)
656 254 => match var_type {
657 VarType::String => break Self::String(RawStr(*b" ")), // XXX EBCDIC
658 VarType::Numeric => {
659 return Err(Error::CompressedStringExpected {
661 case_ofs: reader.stream_position()? - case_start,
665 255 => match var_type {
666 VarType::Numeric => break Self::Number(None),
668 return Err(Error::CompressedNumberExpected {
670 case_ofs: reader.stream_position()? - case_start,
681 fn decode(&self, decoder: &Decoder) -> Value<String> {
683 Self::Number(x) => Value::Number(*x),
684 Self::String(s) => Value::String(decoder.decode_exact_length(&s.0).into()),
689 struct ZlibDecodeMultiple<R>
693 reader: Option<ZlibDecoder<R>>,
696 impl<R> ZlibDecodeMultiple<R>
700 fn new(reader: R) -> ZlibDecodeMultiple<R> {
702 reader: Some(ZlibDecoder::new(reader)),
707 impl<R> Read for ZlibDecodeMultiple<R>
711 fn read(&mut self, buf: &mut [u8]) -> Result<usize, IoError> {
713 match self.reader.as_mut().unwrap().read(buf)? {
715 let inner = self.reader.take().unwrap().into_inner();
716 self.reader = Some(ZlibDecoder::new(inner));
724 impl<R> Seek for ZlibDecodeMultiple<R>
728 fn seek(&mut self, pos: SeekFrom) -> Result<u64, IoError> {
729 self.reader.as_mut().unwrap().get_mut().seek(pos)
738 ztrailer_offset: u64,
747 R: Read + Seek + 'static,
750 warn: Box<dyn Fn(Error)>,
752 header: HeaderRecord<RawString>,
753 var_types: Vec<VarType>,
760 R: Read + Seek + 'static,
762 pub fn new<F>(mut reader: R, warn: F) -> Result<Self, Error>
764 F: Fn(Error) + 'static,
766 let header = HeaderRecord::read(&mut reader)?;
768 reader: Some(reader),
769 warn: Box::new(warn),
771 var_types: Vec::new(),
772 state: ReaderState::Start,
775 fn cases(&mut self) -> Cases {
776 self.state = ReaderState::End;
778 self.reader.take().unwrap(),
779 take(&mut self.var_types),
785 impl<R> Iterator for Reader<R>
787 R: Read + Seek + 'static,
789 type Item = Result<Record, Error>;
791 fn next(&mut self) -> Option<Self::Item> {
793 ReaderState::Start => {
794 self.state = ReaderState::Headers;
795 Some(Ok(Record::Header(self.header.clone())))
797 ReaderState::Headers => {
800 self.reader.as_mut().unwrap(),
802 self.var_types.as_slice(),
805 Ok(Some(record)) => break record,
807 Err(error) => return Some(Err(error)),
811 Record::Variable(VariableRecord { width, .. }) => {
812 self.var_types.push(VarType::from_width(width));
814 Record::EndOfHeaders(_) => {
815 self.state = if let Some(Compression::ZLib) = self.header.compression {
816 ReaderState::ZlibHeader
825 ReaderState::ZlibHeader => {
826 let zheader = match ZHeader::read(self.reader.as_mut().unwrap(), self.header.endian)
828 Ok(zheader) => zheader,
829 Err(error) => return Some(Err(error)),
831 self.state = ReaderState::ZlibTrailer {
832 ztrailer_offset: zheader.ztrailer_offset,
833 ztrailer_len: zheader.ztrailer_len,
835 Some(Ok(Record::ZHeader(zheader)))
837 ReaderState::ZlibTrailer {
841 match ZTrailer::read(
842 self.reader.as_mut().unwrap(),
847 Ok(None) => Some(Ok(Record::Cases(Rc::new(RefCell::new(self.cases()))))),
848 Ok(Some(ztrailer)) => Some(Ok(Record::ZTrailer(ztrailer))),
849 Err(error) => Some(Err(error)),
852 ReaderState::Cases => Some(Ok(Record::Cases(Rc::new(RefCell::new(self.cases()))))),
853 ReaderState::End => None,
858 trait ReadSeek: Read + Seek {}
859 impl<T> ReadSeek for T where T: Read + Seek {}
862 reader: Box<dyn ReadSeek>,
863 var_types: Vec<VarType>,
864 compression: Option<Compression>,
871 impl Debug for Cases {
872 fn fmt(&self, f: &mut Formatter) -> FmtResult {
878 fn new<R>(reader: R, var_types: Vec<VarType>, header: &HeaderRecord<RawString>) -> Self
880 R: Read + Seek + 'static,
883 reader: if header.compression == Some(Compression::ZLib) {
884 Box::new(ZlibDecodeMultiple::new(reader))
889 compression: header.compression,
891 endian: header.endian,
892 codes: VecDeque::with_capacity(8),
898 impl Iterator for Cases {
899 type Item = Result<Vec<RawValue>, Error>;
901 fn next(&mut self) -> Option<Self::Item> {
906 let retval = if self.compression.is_some() {
907 Value::read_compressed_case(
916 Value::read_case(&mut self.reader, &self.var_types, self.endian).transpose()
918 self.eof = matches!(retval, None | Some(Err(_)));
923 #[derive(Copy, Clone, PartialEq, Eq, Hash)]
924 pub struct Spec(pub u32);
926 impl Debug for Spec {
927 fn fmt(&self, f: &mut Formatter) -> FmtResult {
928 let type_ = format_name(self.0 >> 16);
929 let w = (self.0 >> 8) & 0xff;
930 let d = self.0 & 0xff;
931 write!(f, "{:06x} ({type_}{w}.{d})", self.0)
935 fn format_name(type_: u32) -> Cow<'static, str> {
974 _ => return format!("<unknown format {type_}>").into(),
980 pub struct MissingValues<S>
984 /// Individual missing values, up to 3 of them.
985 pub values: Vec<Value<S>>,
987 /// Optional range of missing values.
988 pub range: Option<(Value<S>, Value<S>)>,
991 impl<S> Debug for MissingValues<S>
995 fn fmt(&self, f: &mut Formatter) -> FmtResult {
996 for (i, value) in self.values.iter().enumerate() {
1000 write!(f, "{value:?}")?;
1003 if let Some((low, high)) = &self.range {
1004 if !self.values.is_empty() {
1007 write!(f, "{low:?} THRU {high:?}")?;
1010 if self.is_empty() {
1018 impl<S> MissingValues<S>
1022 fn is_empty(&self) -> bool {
1023 self.values.is_empty() && self.range.is_none()
1027 impl MissingValues<RawStr<8>> {
1028 fn read<R: Read + Seek>(
1034 ) -> Result<Self, Error> {
1035 let (n_values, has_range) = match (width, code) {
1036 (_, 0..=3) => (code, false),
1037 (0, -2) => (0, true),
1038 (0, -3) => (1, true),
1039 (0, _) => return Err(Error::BadNumericMissingValueCode { offset, code }),
1040 (_, _) => return Err(Error::BadStringMissingValueCode { offset, code }),
1043 let var_type = VarType::from_width(width);
1045 let mut values = Vec::new();
1046 for _ in 0..n_values {
1047 values.push(RawValue::read(r, var_type, endian)?);
1049 let range = if has_range {
1050 let low = RawValue::read(r, var_type, endian)?;
1051 let high = RawValue::read(r, var_type, endian)?;
1056 Ok(Self { values, range })
1058 fn decode<'a>(&'a self, decoder: &Decoder) -> MissingValues<String> {
1063 .map(|value| value.decode(decoder))
1068 .map(|(low, high)| (low.decode(decoder), high.decode(decoder))),
1074 pub struct VariableRecord<S, V>
1079 /// Range of offsets in file.
1080 pub offsets: Range<u64>,
1082 /// Variable width, in the range -1..=255.
1085 /// Variable name, padded on the right with spaces.
1089 pub print_format: Spec,
1092 pub write_format: Spec,
1095 pub missing_values: MissingValues<V>,
1097 /// Optional variable label.
1098 pub label: Option<S>,
1101 impl<S, V> Debug for VariableRecord<S, V>
1106 fn fmt(&self, f: &mut Formatter) -> FmtResult {
1111 match self.width.cmp(&0) {
1112 Ordering::Greater => "string",
1113 Ordering::Equal => "numeric",
1114 Ordering::Less => "long string continuation record",
1117 writeln!(f, "Print format: {:?}", self.print_format)?;
1118 writeln!(f, "Write format: {:?}", self.write_format)?;
1119 writeln!(f, "Name: {:?}", &self.name)?;
1120 writeln!(f, "Variable label: {:?}", self.label)?;
1121 writeln!(f, "Missing values: {:?}", self.missing_values)
1125 impl VariableRecord<RawString, RawStr<8>> {
1126 fn read<R: Read + Seek>(r: &mut R, endian: Endian) -> Result<Record, Error> {
1127 let start_offset = r.stream_position()?;
1128 let width: i32 = endian.parse(read_bytes(r)?);
1129 let code_offset = r.stream_position()?;
1130 let has_variable_label: u32 = endian.parse(read_bytes(r)?);
1131 let missing_value_code: i32 = endian.parse(read_bytes(r)?);
1132 let print_format = Spec(endian.parse(read_bytes(r)?));
1133 let write_format = Spec(endian.parse(read_bytes(r)?));
1134 let name = RawString(read_vec(r, 8)?);
1136 let label = match has_variable_label {
1139 let len: u32 = endian.parse(read_bytes(r)?);
1140 let read_len = len.min(65535) as usize;
1141 let label = RawString(read_vec(r, read_len)?);
1143 let padding_bytes = Integer::next_multiple_of(&len, &4) - len;
1144 let _ = read_vec(r, padding_bytes as usize)?;
1149 return Err(Error::BadVariableLabelCode {
1152 code: has_variable_label,
1157 let missing_values =
1158 MissingValues::read(r, start_offset, width, missing_value_code, endian)?;
1160 let end_offset = r.stream_position()?;
1162 Ok(Record::Variable(VariableRecord {
1163 offsets: start_offset..end_offset,
1173 fn decode<'a>(&'a self, decoder: &Decoder) -> VariableRecord<Cow<'a, str>, String> {
1175 offsets: self.offsets.clone(),
1177 name: decoder.decode(&self.name),
1178 print_format: self.print_format,
1179 write_format: self.write_format,
1180 missing_values: self.missing_values.decode(decoder),
1181 label: self.label.as_ref().map(|label| decoder.decode(label)),
1186 #[derive(Copy, Clone)]
1187 pub struct UntypedValue(pub [u8; 8]);
1189 impl Debug for UntypedValue {
1190 fn fmt(&self, f: &mut Formatter) -> FmtResult {
1191 let little: f64 = Endian::Little.parse(self.0);
1192 let little = format!("{:?}", little);
1193 let big: f64 = Endian::Big.parse(self.0);
1194 let big = format!("{:?}", big);
1195 let number = if little.len() <= big.len() {
1200 write!(f, "{number}")?;
1202 let string = default_decode(&self.0);
1204 .split(|c: char| c == '\0' || c.is_control())
1207 write!(f, "{string:?}")?;
1213 pub struct RawString(pub Vec<u8>);
1215 impl From<Vec<u8>> for RawString {
1216 fn from(source: Vec<u8>) -> Self {
1221 impl From<&[u8]> for RawString {
1222 fn from(source: &[u8]) -> Self {
1227 impl Debug for RawString {
1228 fn fmt(&self, f: &mut Formatter) -> FmtResult {
1229 write!(f, "{:?}", default_decode(self.0.as_slice()))
1233 #[derive(Copy, Clone)]
1234 pub struct RawStr<const N: usize>(pub [u8; N]);
1236 impl<const N: usize> From<[u8; N]> for RawStr<N> {
1237 fn from(source: [u8; N]) -> Self {
1242 impl<const N: usize> Debug for RawStr<N> {
1243 fn fmt(&self, f: &mut Formatter) -> FmtResult {
1244 write!(f, "{:?}", default_decode(&self.0))
1248 #[derive(Clone, Debug)]
1249 pub struct ValueLabel<V, S>
1254 pub value: Value<V>,
1259 pub struct ValueLabelRecord<V, S>
1264 /// Range of offsets in file.
1265 pub offsets: Range<u64>,
1268 pub labels: Vec<ValueLabel<V, S>>,
1270 /// The 1-based indexes of the variable indexes.
1271 pub dict_indexes: Vec<u32>,
1273 /// The types of the variables.
1274 pub var_type: VarType,
1277 impl<V, S> Debug for ValueLabelRecord<V, S>
1282 fn fmt(&self, f: &mut Formatter) -> FmtResult {
1283 writeln!(f, "labels: ")?;
1284 for label in self.labels.iter() {
1285 writeln!(f, "{label:?}")?;
1287 write!(f, "apply to {} variables", self.var_type)?;
1288 for dict_index in self.dict_indexes.iter() {
1289 write!(f, " #{dict_index}")?;
1295 impl<V, S> Header for ValueLabelRecord<V, S>
1300 fn offsets(&self) -> Range<u64> {
1301 self.offsets.clone()
1305 impl<V, S> ValueLabelRecord<V, S>
1310 /// Maximum number of value labels in a record.
1311 pub const MAX_LABELS: u32 = u32::MAX / 8;
1313 /// Maximum number of variable indexes in a record.
1314 pub const MAX_INDEXES: u32 = u32::MAX / 8;
1317 impl ValueLabelRecord<RawStr<8>, RawString> {
1318 fn read<R: Read + Seek>(
1321 var_types: &[VarType],
1322 warn: &Box<dyn Fn(Error)>,
1323 ) -> Result<Option<Record>, Error> {
1324 let label_offset = r.stream_position()?;
1325 let n: u32 = endian.parse(read_bytes(r)?);
1326 if n > Self::MAX_LABELS {
1327 return Err(Error::BadNumberOfValueLabels {
1328 offset: label_offset,
1330 max: Self::MAX_LABELS,
1334 let mut labels = Vec::new();
1336 let value = UntypedValue(read_bytes(r)?);
1337 let label_len: u8 = endian.parse(read_bytes(r)?);
1338 let label_len = label_len as usize;
1339 let padded_len = Integer::next_multiple_of(&(label_len + 1), &8);
1341 let mut label = read_vec(r, padded_len - 1)?;
1342 label.truncate(label_len);
1343 labels.push((value, RawString(label)));
1346 let index_offset = r.stream_position()?;
1347 let rec_type: u32 = endian.parse(read_bytes(r)?);
1349 return Err(Error::ExpectedVarIndexRecord {
1350 offset: index_offset,
1355 let n: u32 = endian.parse(read_bytes(r)?);
1356 if n > Self::MAX_INDEXES {
1357 return Err(Error::TooManyVarIndexes {
1358 offset: index_offset,
1360 max: Self::MAX_INDEXES,
1364 let index_offset = r.stream_position()?;
1365 let mut dict_indexes = Vec::with_capacity(n as usize);
1366 let mut invalid_indexes = Vec::new();
1368 let index: u32 = endian.parse(read_bytes(r)?);
1369 if index == 0 || index as usize > var_types.len() {
1370 dict_indexes.push(index);
1372 invalid_indexes.push(index);
1375 if !invalid_indexes.is_empty() {
1376 warn(Error::InvalidVarIndexes {
1377 offset: index_offset,
1378 max: var_types.len(),
1379 invalid: invalid_indexes,
1383 let Some(&first_index) = dict_indexes.first() else {
1384 warn(Error::NoVarIndexes {
1385 offset: index_offset,
1389 let var_type = var_types[first_index as usize - 1];
1390 let mut wrong_type_indexes = Vec::new();
1391 dict_indexes.retain(|&index| {
1392 if var_types[index as usize - 1] != var_type {
1393 wrong_type_indexes.push(index);
1399 if !wrong_type_indexes.is_empty() {
1400 warn(Error::MixedVarTypes {
1401 offset: index_offset,
1403 wrong_types: wrong_type_indexes,
1409 .map(|(value, label)| ValueLabel {
1410 value: Value::from_raw(&value, var_type, endian),
1415 let end_offset = r.stream_position()?;
1416 Ok(Some(Record::ValueLabel(ValueLabelRecord {
1417 offsets: label_offset..end_offset,
1425 #[derive(Clone, Debug)]
1426 pub struct DocumentRecord<S>
1430 pub offsets: Range<u64>,
1432 /// The document, as an array of 80-byte lines.
1436 pub type RawDocumentLine = RawStr<DOC_LINE_LEN>;
1438 /// Length of a line in a document. Document lines are fixed-length and
1439 /// padded on the right with spaces.
1440 pub const DOC_LINE_LEN: usize = 80;
1442 impl DocumentRecord<RawDocumentLine> {
1443 /// Maximum number of lines we will accept in a document. This is simply
1444 /// the maximum number that will fit in a 32-bit space.
1445 pub const MAX_LINES: usize = i32::MAX as usize / DOC_LINE_LEN;
1447 fn read<R: Read + Seek>(r: &mut R, endian: Endian) -> Result<Record, Error> {
1448 let start_offset = r.stream_position()?;
1449 let n: u32 = endian.parse(read_bytes(r)?);
1451 if n > Self::MAX_LINES {
1452 Err(Error::BadDocumentLength {
1453 offset: start_offset,
1455 max: Self::MAX_LINES,
1458 let mut lines = Vec::with_capacity(n);
1460 lines.push(RawStr(read_bytes(r)?));
1462 let end_offset = r.stream_position()?;
1463 Ok(Record::Document(DocumentRecord {
1464 offsets: start_offset..end_offset,
1470 fn decode<'a>(&'a self, decoder: &Decoder) -> DocumentRecord<Cow<'a, str>> {
1472 offsets: self.offsets.clone(),
1476 .map(|s| decoder.decode_slice(&s.0))
1482 impl<S> Header for DocumentRecord<S>
1486 fn offsets(&self) -> Range<u64> {
1487 self.offsets.clone()
1491 trait ExtensionRecord {
1493 const SIZE: Option<u32>;
1494 const COUNT: Option<u32>;
1495 const NAME: &'static str;
1496 fn parse(ext: &Extension, endian: Endian) -> Result<Record, Error>;
1499 #[derive(Clone, Debug)]
1500 pub struct IntegerInfoRecord {
1501 pub offsets: Range<u64>,
1502 pub version: (i32, i32, i32),
1503 pub machine_code: i32,
1504 pub floating_point_rep: i32,
1505 pub compression_code: i32,
1506 pub endianness: i32,
1507 pub character_code: i32,
1510 impl ExtensionRecord for IntegerInfoRecord {
1511 const SUBTYPE: u32 = 3;
1512 const SIZE: Option<u32> = Some(4);
1513 const COUNT: Option<u32> = Some(8);
1514 const NAME: &'static str = "integer record";
1516 fn parse(ext: &Extension, endian: Endian) -> Result<Record, Error> {
1517 ext.check_size::<Self>()?;
1519 let mut input = &ext.data[..];
1520 let data: Vec<i32> = (0..8)
1521 .map(|_| endian.parse(read_bytes(&mut input).unwrap()))
1523 Ok(Record::IntegerInfo(IntegerInfoRecord {
1524 offsets: ext.offsets.clone(),
1525 version: (data[0], data[1], data[2]),
1526 machine_code: data[3],
1527 floating_point_rep: data[4],
1528 compression_code: data[5],
1529 endianness: data[6],
1530 character_code: data[7],
1535 #[derive(Clone, Debug)]
1536 pub struct FloatInfoRecord {
1542 impl ExtensionRecord for FloatInfoRecord {
1543 const SUBTYPE: u32 = 4;
1544 const SIZE: Option<u32> = Some(8);
1545 const COUNT: Option<u32> = Some(3);
1546 const NAME: &'static str = "floating point record";
1548 fn parse(ext: &Extension, endian: Endian) -> Result<Record, Error> {
1549 ext.check_size::<Self>()?;
1551 let mut input = &ext.data[..];
1552 let data: Vec<f64> = (0..3)
1553 .map(|_| endian.parse(read_bytes(&mut input).unwrap()))
1555 Ok(Record::FloatInfo(FloatInfoRecord {
1563 #[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
1564 pub enum CategoryLabels {
1569 #[derive(Clone, Debug)]
1570 pub enum MultipleResponseType {
1573 labels: CategoryLabels,
1578 impl MultipleResponseType {
1579 fn parse(input: &[u8]) -> Result<(MultipleResponseType, &[u8]), Error> {
1580 let (mr_type, input) = match input.split_first() {
1581 Some((b'C', input)) => (MultipleResponseType::MultipleCategory, input),
1582 Some((b'D', input)) => {
1583 let (value, input) = parse_counted_string(input)?;
1585 MultipleResponseType::MultipleDichotomy {
1587 labels: CategoryLabels::VarLabels,
1592 Some((b'E', input)) => {
1593 let (labels, input) = if let Some(rest) = input.strip_prefix(b" 1 ") {
1594 (CategoryLabels::CountedValues, rest)
1595 } else if let Some(rest) = input.strip_prefix(b" 11 ") {
1596 (CategoryLabels::VarLabels, rest)
1598 return Err(Error::TBD);
1600 let (value, input) = parse_counted_string(input)?;
1602 MultipleResponseType::MultipleDichotomy { value, labels },
1606 _ => return Err(Error::TBD),
1608 Ok((mr_type, input))
1612 #[derive(Clone, Debug)]
1613 pub struct MultipleResponseSet<S>
1619 pub mr_type: MultipleResponseType,
1620 pub short_names: Vec<S>,
1623 impl MultipleResponseSet<RawString> {
1624 fn parse(input: &[u8]) -> Result<(Self, &[u8]), Error> {
1625 let Some(equals) = input.iter().position(|&b| b == b'=') else {
1626 return Err(Error::TBD);
1628 let (name, input) = input.split_at(equals);
1629 let (mr_type, input) = MultipleResponseType::parse(input)?;
1630 let Some(input) = input.strip_prefix(b" ") else {
1631 return Err(Error::TBD);
1633 let (label, mut input) = parse_counted_string(input)?;
1634 let mut vars = Vec::new();
1635 while input.first() != Some(&b'\n') {
1636 match input.split_first() {
1637 Some((b' ', rest)) => {
1638 let Some(length) = rest.iter().position(|b| b" \n".contains(b)) else {
1639 return Err(Error::TBD);
1641 let (var, rest) = rest.split_at(length);
1642 if !var.is_empty() {
1643 vars.push(var.into());
1647 _ => return Err(Error::TBD),
1650 while input.first() == Some(&b'\n') {
1651 input = &input[1..];
1654 MultipleResponseSet {
1664 fn decode<'a>(&'a self, decoder: &Decoder) -> MultipleResponseSet<Cow<'a, str>> {
1665 MultipleResponseSet {
1666 name: decoder.decode(&self.name),
1667 label: decoder.decode(&self.label),
1668 mr_type: self.mr_type.clone(),
1669 short_names: self.short_names.iter().map(|s| decoder.decode(s)).collect(),
1674 #[derive(Clone, Debug)]
1675 pub struct MultipleResponseRecord<S>(pub Vec<MultipleResponseSet<S>>)
1679 impl ExtensionRecord for MultipleResponseRecord<RawString> {
1680 const SUBTYPE: u32 = 7;
1681 const SIZE: Option<u32> = Some(1);
1682 const COUNT: Option<u32> = None;
1683 const NAME: &'static str = "multiple response set record";
1685 fn parse(ext: &Extension, _endian: Endian) -> Result<Record, Error> {
1686 ext.check_size::<Self>()?;
1688 let mut input = &ext.data[..];
1689 let mut sets = Vec::new();
1690 while !input.is_empty() {
1691 let (set, rest) = MultipleResponseSet::parse(input)?;
1695 Ok(Record::MultipleResponse(MultipleResponseRecord(sets)))
1699 impl MultipleResponseRecord<RawString> {
1700 fn decode<'a>(&'a self, decoder: &Decoder) -> MultipleResponseRecord<Cow<'a, str>> {
1701 MultipleResponseRecord(self.0.iter().map(|set| set.decode(decoder)).collect())
1705 fn parse_counted_string(input: &[u8]) -> Result<(RawString, &[u8]), Error> {
1706 let Some(space) = input.iter().position(|&b| b == b' ') else {
1707 return Err(Error::TBD);
1709 let Ok(length) = from_utf8(&input[..space]) else {
1710 return Err(Error::TBD);
1712 let Ok(length): Result<usize, _> = length.parse() else {
1713 return Err(Error::TBD);
1716 let input = &input[space + 1..];
1717 if input.len() < length {
1718 return Err(Error::TBD);
1721 let (string, rest) = input.split_at(length);
1722 Ok((string.into(), rest))
1725 #[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
1733 fn try_decode(source: u32) -> Result<Option<Measure>, Error> {
1736 1 => Ok(Some(Measure::Nominal)),
1737 2 => Ok(Some(Measure::Ordinal)),
1738 3 => Ok(Some(Measure::Scale)),
1739 _ => Err(Error::InvalidMeasurement(source)),
1744 #[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
1745 pub enum Alignment {
1752 fn try_decode(source: u32) -> Result<Option<Alignment>, Error> {
1755 1 => Ok(Some(Alignment::Left)),
1756 2 => Ok(Some(Alignment::Right)),
1757 3 => Ok(Some(Alignment::Center)),
1758 _ => Err(Error::InvalidAlignment(source)),
1763 #[derive(Clone, Debug)]
1764 pub struct VarDisplay {
1765 pub measure: Option<Measure>,
1766 pub width: Option<u32>,
1767 pub alignment: Option<Alignment>,
1770 #[derive(Clone, Debug)]
1771 pub struct VarDisplayRecord(pub Vec<VarDisplay>);
1773 impl VarDisplayRecord {
1774 const SUBTYPE: u32 = 11;
1780 warn: &Box<dyn Fn(Error)>,
1781 ) -> Result<Record, Error> {
1783 return Err(Error::BadRecordSize {
1784 offset: ext.offsets.start,
1785 record: String::from("variable display record"),
1791 let has_width = if ext.count as usize == 3 * n_vars {
1793 } else if ext.count as usize == 2 * n_vars {
1796 return Err(Error::TBD);
1799 let mut var_displays = Vec::new();
1800 let mut input = &ext.data[..];
1801 for _ in 0..n_vars {
1802 let measure = Measure::try_decode(endian.parse(read_bytes(&mut input).unwrap()))
1803 .warn_on_error(&warn)
1805 let width = has_width.then(|| endian.parse(read_bytes(&mut input).unwrap()));
1806 let alignment = Alignment::try_decode(endian.parse(read_bytes(&mut input).unwrap()))
1807 .warn_on_error(&warn)
1809 var_displays.push(VarDisplay {
1815 Ok(Record::VarDisplay(VarDisplayRecord(var_displays)))
1819 #[derive(Clone, Debug)]
1820 pub struct LongStringMissingValues {
1822 pub var_name: RawString,
1825 pub missing_values: MissingValues<RawStr<8>>,
1828 #[derive(Clone, Debug)]
1829 pub struct LongStringMissingValueRecord(pub Vec<LongStringMissingValues>);
1831 impl ExtensionRecord for LongStringMissingValueRecord {
1832 const SUBTYPE: u32 = 22;
1833 const SIZE: Option<u32> = Some(1);
1834 const COUNT: Option<u32> = None;
1835 const NAME: &'static str = "long string missing values record";
1837 fn parse(ext: &Extension, endian: Endian) -> Result<Record, Error> {
1838 ext.check_size::<Self>()?;
1840 let mut input = &ext.data[..];
1841 let mut missing_value_set = Vec::new();
1842 while !input.is_empty() {
1843 let var_name = read_string(&mut input, endian)?;
1844 let n_missing_values: u8 = endian.parse(read_bytes(&mut input)?);
1845 let value_len: u32 = endian.parse(read_bytes(&mut input)?);
1847 let offset = (ext.data.len() - input.len() - 8) as u64 + ext.offsets.start;
1848 return Err(Error::BadLongMissingValueLength {
1849 record_offset: ext.offsets.start,
1854 let mut values = Vec::new();
1855 for i in 0..n_missing_values {
1856 let value: [u8; 8] = read_bytes(&mut input)?;
1857 let numeric_value: u64 = endian.parse(value);
1858 let value = if i > 0 && numeric_value == 8 {
1859 // Tolerate files written by old, buggy versions of PSPP
1860 // where we believed that the value_length was repeated
1861 // before each missing value.
1862 read_bytes(&mut input)?
1866 values.push(Value::String(RawStr(value)));
1868 let missing_values = MissingValues {
1872 missing_value_set.push(LongStringMissingValues {
1877 Ok(Record::LongStringMissingValues(
1878 LongStringMissingValueRecord(missing_value_set),
1883 #[derive(Clone, Debug)]
1884 pub struct EncodingRecord(pub String);
1886 impl ExtensionRecord for EncodingRecord {
1887 const SUBTYPE: u32 = 20;
1888 const SIZE: Option<u32> = Some(1);
1889 const COUNT: Option<u32> = None;
1890 const NAME: &'static str = "encoding record";
1892 fn parse(ext: &Extension, _endian: Endian) -> Result<Record, Error> {
1893 ext.check_size::<Self>()?;
1895 Ok(Record::Encoding(EncodingRecord(
1896 String::from_utf8(ext.data.clone()).map_err(|_| Error::BadEncodingName {
1897 offset: ext.offsets.start,
1903 #[derive(Copy, Clone, Debug)]
1904 pub struct NumberOfCasesRecord {
1905 /// Always observed as 1.
1908 /// Number of cases.
1912 impl ExtensionRecord for NumberOfCasesRecord {
1913 const SUBTYPE: u32 = 16;
1914 const SIZE: Option<u32> = Some(8);
1915 const COUNT: Option<u32> = Some(2);
1916 const NAME: &'static str = "extended number of cases record";
1918 fn parse(ext: &Extension, endian: Endian) -> Result<Record, Error> {
1919 ext.check_size::<Self>()?;
1921 let mut input = &ext.data[..];
1922 let one = endian.parse(read_bytes(&mut input)?);
1923 let n_cases = endian.parse(read_bytes(&mut input)?);
1925 Ok(Record::NumberOfCases(NumberOfCasesRecord { one, n_cases }))
1929 #[derive(Clone, Debug)]
1930 pub struct TextRecord {
1931 pub offsets: Range<u64>,
1933 /// The text content of the record.
1934 pub text: RawString,
1937 impl From<Extension> for TextRecord {
1938 fn from(source: Extension) -> Self {
1940 offsets: source.offsets,
1941 text: source.data.into(),
1946 #[derive(Clone, Debug)]
1947 pub struct VariableSet {
1949 pub vars: Vec<String>,
1953 fn parse(input: &str) -> Result<Self, Error> {
1954 let (name, input) = input.split_once('=').ok_or(Error::TBD)?;
1955 let vars = input.split_ascii_whitespace().map(String::from).collect();
1963 #[derive(Clone, Debug)]
1964 pub struct VariableSetRecord {
1965 pub offsets: Range<u64>,
1966 pub sets: Vec<VariableSet>,
1969 impl VariableSetRecord {
1970 fn decode<'a>(source: &TextRecord, decoder: &Decoder) -> VariableSetRecord {
1971 let mut sets = Vec::new();
1972 let input = decoder.decode(&source.text);
1973 for line in input.lines() {
1974 if let Some(set) = VariableSet::parse(line).warn_on_error(&decoder.warn) {
1979 offsets: source.offsets.clone(),
1985 trait WarnOnError<T> {
1986 fn warn_on_error<F: Fn(Error)>(self, warn: &F) -> Option<T>;
1988 impl<T> WarnOnError<T> for Result<T, Error> {
1989 fn warn_on_error<F: Fn(Error)>(self, warn: &F) -> Option<T> {
1991 Ok(result) => Some(result),
2000 #[derive(Clone, Debug)]
2001 pub struct Extension {
2002 pub offsets: Range<u64>,
2007 /// Size of each data element.
2010 /// Number of data elements.
2013 /// `size * count` bytes of data.
2018 fn check_size<E: ExtensionRecord>(&self) -> Result<(), Error> {
2019 if let Some(expected_size) = E::SIZE {
2020 if self.size != expected_size {
2021 return Err(Error::BadRecordSize {
2022 offset: self.offsets.start,
2023 record: E::NAME.into(),
2029 if let Some(expected_count) = E::COUNT {
2030 if self.count != expected_count {
2031 return Err(Error::BadRecordCount {
2032 offset: self.offsets.start,
2033 record: E::NAME.into(),
2042 fn read<R: Read + Seek>(
2046 warn: &Box<dyn Fn(Error)>,
2047 ) -> Result<Option<Record>, Error> {
2048 let subtype = endian.parse(read_bytes(r)?);
2049 let header_offset = r.stream_position()?;
2050 let size: u32 = endian.parse(read_bytes(r)?);
2051 let count = endian.parse(read_bytes(r)?);
2052 let Some(product) = size.checked_mul(count) else {
2053 return Err(Error::ExtensionRecordTooLarge {
2054 offset: header_offset,
2060 let start_offset = r.stream_position()?;
2061 let data = read_vec(r, product as usize)?;
2062 let end_offset = start_offset + product as u64;
2063 let extension = Extension {
2064 offsets: start_offset..end_offset,
2070 let result = match subtype {
2071 IntegerInfoRecord::SUBTYPE => IntegerInfoRecord::parse(&extension, endian),
2072 FloatInfoRecord::SUBTYPE => FloatInfoRecord::parse(&extension, endian),
2073 VarDisplayRecord::SUBTYPE => VarDisplayRecord::parse(&extension, n_vars, endian, warn),
2074 MultipleResponseRecord::SUBTYPE | 19 => {
2075 MultipleResponseRecord::parse(&extension, endian)
2077 LongStringValueLabelRecord::SUBTYPE => {
2078 LongStringValueLabelRecord::parse(&extension, endian)
2080 EncodingRecord::SUBTYPE => EncodingRecord::parse(&extension, endian),
2081 NumberOfCasesRecord::SUBTYPE => NumberOfCasesRecord::parse(&extension, endian),
2082 5 => Ok(Record::VariableSets(extension.into())),
2083 10 => Ok(Record::ProductInfo(extension.into())),
2084 13 => Ok(Record::LongNames(extension.into())),
2085 14 => Ok(Record::VeryLongStrings(extension.into())),
2086 17 => Ok(Record::FileAttributes(extension.into())),
2087 18 => Ok(Record::VariableAttributes(extension.into())),
2088 _ => Ok(Record::OtherExtension(extension)),
2091 Ok(result) => Ok(Some(result)),
2100 #[derive(Clone, Debug)]
2101 pub struct ZHeader {
2102 /// File offset to the start of the record.
2105 /// File offset to the ZLIB data header.
2106 pub zheader_offset: u64,
2108 /// File offset to the ZLIB trailer.
2109 pub ztrailer_offset: u64,
2111 /// Length of the ZLIB trailer in bytes.
2112 pub ztrailer_len: u64,
2116 fn read<R: Read + Seek>(r: &mut R, endian: Endian) -> Result<ZHeader, Error> {
2117 let offset = r.stream_position()?;
2118 let zheader_offset: u64 = endian.parse(read_bytes(r)?);
2119 let ztrailer_offset: u64 = endian.parse(read_bytes(r)?);
2120 let ztrailer_len: u64 = endian.parse(read_bytes(r)?);
2131 #[derive(Clone, Debug)]
2132 pub struct ZTrailer {
2133 /// File offset to the start of the record.
2136 /// Compression bias as a negative integer, e.g. -100.
2139 /// Always observed as zero.
2142 /// Uncompressed size of each block, except possibly the last. Only
2143 /// `0x3ff000` has been observed so far.
2144 pub block_size: u32,
2146 /// Block descriptors, always `(ztrailer_len - 24) / 24)` of them.
2147 pub blocks: Vec<ZBlock>,
2150 #[derive(Clone, Debug)]
2152 /// Offset of block of data if simple compression were used.
2153 pub uncompressed_ofs: u64,
2155 /// Actual offset within the file of the compressed data block.
2156 pub compressed_ofs: u64,
2158 /// The number of bytes in this data block after decompression. This is
2159 /// `block_size` in every data block but the last, which may be smaller.
2160 pub uncompressed_size: u32,
2162 /// The number of bytes in this data block, as stored compressed in this
2164 pub compressed_size: u32,
2168 fn read<R: Read + Seek>(r: &mut R, endian: Endian) -> Result<ZBlock, Error> {
2170 uncompressed_ofs: endian.parse(read_bytes(r)?),
2171 compressed_ofs: endian.parse(read_bytes(r)?),
2172 uncompressed_size: endian.parse(read_bytes(r)?),
2173 compressed_size: endian.parse(read_bytes(r)?),
2179 fn read<R: Read + Seek>(
2184 ) -> Result<Option<ZTrailer>, Error> {
2185 let start_offset = reader.stream_position()?;
2186 if reader.seek(SeekFrom::Start(ztrailer_ofs)).is_err() {
2189 let int_bias = endian.parse(read_bytes(reader)?);
2190 let zero = endian.parse(read_bytes(reader)?);
2191 let block_size = endian.parse(read_bytes(reader)?);
2192 let n_blocks: u32 = endian.parse(read_bytes(reader)?);
2193 let expected_n_blocks = (ztrailer_len - 24) / 24;
2194 if n_blocks as u64 != expected_n_blocks {
2195 return Err(Error::BadZlibTrailerNBlocks {
2196 offset: ztrailer_ofs,
2202 let blocks = (0..n_blocks)
2203 .map(|_| ZBlock::read(reader, endian))
2204 .collect::<Result<Vec<_>, _>>()?;
2205 reader.seek(SeekFrom::Start(start_offset))?;
2207 offset: ztrailer_ofs,
2216 fn try_read_bytes<const N: usize, R: Read>(r: &mut R) -> Result<Option<[u8; N]>, IoError> {
2217 let mut buf = [0; N];
2218 let n = r.read(&mut buf)?;
2221 r.read_exact(&mut buf[n..])?;
2229 fn read_bytes<const N: usize, R: Read>(r: &mut R) -> Result<[u8; N], IoError> {
2230 let mut buf = [0; N];
2231 r.read_exact(&mut buf)?;
2235 fn read_vec<R: Read>(r: &mut R, n: usize) -> Result<Vec<u8>, IoError> {
2236 let mut vec = vec![0; n];
2237 r.read_exact(&mut vec)?;
2241 fn read_string<R: Read>(r: &mut R, endian: Endian) -> Result<RawString, IoError> {
2242 let length: u32 = endian.parse(read_bytes(r)?);
2243 Ok(read_vec(r, length as usize)?.into())
2246 #[derive(Clone, Debug)]
2247 pub struct LongStringValueLabels {
2248 pub var_name: RawString,
2251 /// `(value, label)` pairs, where each value is `width` bytes.
2252 pub labels: Vec<(RawString, RawString)>,
2255 #[derive(Clone, Debug)]
2256 pub struct LongStringValueLabelRecord(pub Vec<LongStringValueLabels>);
2258 impl ExtensionRecord for LongStringValueLabelRecord {
2259 const SUBTYPE: u32 = 21;
2260 const SIZE: Option<u32> = Some(1);
2261 const COUNT: Option<u32> = None;
2262 const NAME: &'static str = "long string value labels record";
2264 fn parse(ext: &Extension, endian: Endian) -> Result<Record, Error> {
2265 ext.check_size::<Self>()?;
2267 let mut input = &ext.data[..];
2268 let mut label_set = Vec::new();
2269 while !input.is_empty() {
2270 let var_name = read_string(&mut input, endian)?;
2271 let width: u32 = endian.parse(read_bytes(&mut input)?);
2272 let n_labels: u32 = endian.parse(read_bytes(&mut input)?);
2273 let mut labels = Vec::new();
2274 for _ in 0..n_labels {
2275 let value = read_string(&mut input, endian)?;
2276 let label = read_string(&mut input, endian)?;
2277 labels.push((value, label));
2279 label_set.push(LongStringValueLabels {
2285 Ok(Record::LongStringValueLabels(LongStringValueLabelRecord(