1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
//! Node attributes.

use std::io;

use crate::{
    low::v7400::{ArrayAttributeHeader, AttributeType, SpecialAttributeHeader},
    pull_parser::{
        error::DataError,
        v7400::{FromReader, Parser},
        ParserSource, Result, SyntacticPosition, Warning,
    },
};

use self::array::{ArrayAttributeValues, AttributeStreamDecoder, BooleanArrayAttributeValues};
pub use self::loader::LoadAttribute;

/// Use `low::v7400::AttributeValue` instead.
#[deprecated(
    since = "0.4.0",
    note = "`DirectAttributeValue` is moved to `low::v7400::AttributeValue`"
)]
pub type DirectAttributeValue = crate::low::v7400::AttributeValue;

mod array;
pub mod iter;
mod loader;
pub mod loaders;

/// Node attributes reader.
#[derive(Debug)]
pub struct Attributes<'a, R> {
    /// Total number of attributes of the current node.
    total_count: u64,
    /// Rest number of attributes of the current node.
    rest_count: u64,
    /// Beginning offset of the next attribute (if available).
    ///
    /// This is almost same as "end offset of the previous attribute (if
    /// available)".
    next_attr_start_offset: u64,
    /// Parser.
    parser: &'a mut Parser<R>,
}

impl<'a, R: 'a + ParserSource> Attributes<'a, R> {
    /// Creates a new `Attributes`.
    pub(crate) fn from_parser(parser: &'a mut Parser<R>) -> Self {
        let total_count = parser.current_attributes_count();
        let pos = parser.reader().position();
        Self {
            total_count,
            rest_count: total_count,
            next_attr_start_offset: pos,
            parser,
        }
    }

    /// Returns the total number of attributes.
    pub fn total_count(&self) -> u64 {
        self.total_count
    }

    /// Returns the number of the rest attributes.
    pub fn rest_count(&self) -> u64 {
        self.rest_count
    }

    /// Updates the next attribute start offset according to the given size (in
    /// bytes).
    fn update_next_attr_start_offset(&mut self, size: u64) {
        self.next_attr_start_offset = self
            .parser
            .reader()
            .position()
            .checked_add(size)
            .expect("FBX data too large");
    }

    /// Runs the given function with the health check and update.
    pub(crate) fn do_with_health_check<T, F>(&mut self, f: F) -> Result<T>
    where
        F: FnOnce(&mut Self, u64, usize) -> Result<T>,
    {
        self.parser.ensure_continuable()?;

        let start_pos = self.next_attr_start_offset;
        let attr_index = (self.total_count - self.rest_count) as usize;

        match f(self, start_pos, attr_index) {
            Ok(v) => Ok(v),
            Err(e) => {
                let err_pos = self.position(start_pos, attr_index);
                self.parser.set_aborted(err_pos.clone());
                Err(e.and_position(err_pos))
            }
        }
    }

    /// Returns the next attribute type.
    fn read_next_attr_type(&mut self) -> Result<Option<AttributeType>> {
        if self.rest_count() == 0 {
            return Ok(None);
        }

        // Skip the previous attribute value if it remains.
        if self.parser.reader().position() < self.next_attr_start_offset {
            self.parser.reader().skip_to(self.next_attr_start_offset)?;
        }

        let attr_type = self.parser.parse::<AttributeType>()?;

        // This never overflows because `rest_count > 0` holds here.
        // Update this count after parsing is done, so that
        // `total_count - rest_count` is same as attribute index during parsing.
        self.rest_count -= 1;

        Ok(Some(attr_type))
    }

    /// Lets loader load the next node attribute.
    pub fn load_next<V>(&mut self, loader: V) -> Result<Option<V::Output>>
    where
        V: LoadAttribute,
    {
        self.do_with_health_check(|this, start_pos, attr_index| {
            let attr_type = match this.read_next_attr_type()? {
                Some(v) => v,
                None => return Ok(None),
            };
            this.load_next_impl(attr_type, loader, start_pos, attr_index)
                .map(Some)
        })
    }

    /// Lets loader load the next node attribute.
    ///
    /// This method prefers `V::load_{binary,string}_buffered` to
    /// `V::load_{binary,string}`.
    pub fn load_next_buffered<V>(&mut self, loader: V) -> Result<Option<V::Output>>
    where
        R: io::BufRead,
        V: LoadAttribute,
    {
        self.do_with_health_check(|this, start_pos, attr_index| {
            let attr_type = match this.read_next_attr_type()? {
                Some(v) => v,
                None => return Ok(None),
            };
            this.load_next_buffered_impl(attr_type, loader, start_pos, attr_index)
                .map(Some)
        })
    }

    /// Internal implementation of `load_next`.
    fn load_next_impl<V>(
        &mut self,
        attr_type: AttributeType,
        loader: V,
        start_pos: u64,
        attr_index: usize,
    ) -> Result<V::Output>
    where
        V: LoadAttribute,
    {
        match attr_type {
            AttributeType::Bool => {
                let raw = self.parser.parse::<u8>()?;
                let value = (raw & 1) != 0;
                self.update_next_attr_start_offset(0);
                if raw != b'T' && raw != b'Y' {
                    self.parser.warn(
                        Warning::IncorrectBooleanRepresentation,
                        self.position(start_pos, attr_index),
                    )?;
                }
                loader.load_bool(value)
            }
            AttributeType::I16 => {
                let value = self.parser.parse::<i16>()?;
                self.update_next_attr_start_offset(0);
                loader.load_i16(value)
            }
            AttributeType::I32 => {
                let value = self.parser.parse::<i32>()?;
                self.update_next_attr_start_offset(0);
                loader.load_i32(value)
            }
            AttributeType::I64 => {
                let value = self.parser.parse::<i64>()?;
                self.update_next_attr_start_offset(0);
                loader.load_i64(value)
            }
            AttributeType::F32 => {
                let value = self.parser.parse::<f32>()?;
                self.update_next_attr_start_offset(0);
                loader.load_f32(value)
            }
            AttributeType::F64 => {
                let value = self.parser.parse::<f64>()?;
                self.update_next_attr_start_offset(0);
                loader.load_f64(value)
            }
            AttributeType::ArrBool => {
                let header = ArrayAttributeHeader::from_reader(self.parser.reader())?;
                self.update_next_attr_start_offset(u64::from(header.bytelen));
                let reader = AttributeStreamDecoder::create(header.encoding, self.parser.reader())?;
                let count = header.elements_count;
                let mut iter = BooleanArrayAttributeValues::new(reader, count);
                let res = loader.load_seq_bool(&mut iter, count as usize)?;
                // Save `has_error` to make `iter` discardable before
                // `self.parser.warn()` call.
                let has_error = iter.has_error();
                if iter.has_incorrect_boolean_value() {
                    self.parser.warn(
                        Warning::IncorrectBooleanRepresentation,
                        self.position(start_pos, attr_index),
                    )?;
                }
                if has_error {
                    return Err(DataError::NodeAttributeError.into());
                }
                Ok(res)
            }
            AttributeType::ArrI32 => {
                let header = ArrayAttributeHeader::from_reader(self.parser.reader())?;
                self.update_next_attr_start_offset(u64::from(header.bytelen));
                let reader = AttributeStreamDecoder::create(header.encoding, self.parser.reader())?;
                let count = header.elements_count;
                let mut iter = ArrayAttributeValues::<_, i32>::new(reader, count);
                let res = loader.load_seq_i32(&mut iter, count as usize)?;
                if iter.has_error() {
                    return Err(DataError::NodeAttributeError.into());
                }
                Ok(res)
            }
            AttributeType::ArrI64 => {
                let header = ArrayAttributeHeader::from_reader(self.parser.reader())?;
                self.update_next_attr_start_offset(u64::from(header.bytelen));
                let reader = AttributeStreamDecoder::create(header.encoding, self.parser.reader())?;
                let count = header.elements_count;
                let mut iter = ArrayAttributeValues::<_, i64>::new(reader, count);
                let res = loader.load_seq_i64(&mut iter, count as usize)?;
                if iter.has_error() {
                    return Err(DataError::NodeAttributeError.into());
                }
                Ok(res)
            }
            AttributeType::ArrF32 => {
                let header = ArrayAttributeHeader::from_reader(self.parser.reader())?;
                self.update_next_attr_start_offset(u64::from(header.bytelen));
                let reader = AttributeStreamDecoder::create(header.encoding, self.parser.reader())?;
                let count = header.elements_count;
                let mut iter = ArrayAttributeValues::<_, f32>::new(reader, count);
                let res = loader.load_seq_f32(&mut iter, count as usize)?;
                if iter.has_error() {
                    return Err(DataError::NodeAttributeError.into());
                }
                Ok(res)
            }
            AttributeType::ArrF64 => {
                let header = ArrayAttributeHeader::from_reader(self.parser.reader())?;
                self.update_next_attr_start_offset(u64::from(header.bytelen));
                let reader = AttributeStreamDecoder::create(header.encoding, self.parser.reader())?;
                let count = header.elements_count;
                let mut iter = ArrayAttributeValues::<_, f64>::new(reader, count);
                let res = loader.load_seq_f64(&mut iter, count as usize)?;
                if iter.has_error() {
                    return Err(DataError::NodeAttributeError.into());
                }
                Ok(res)
            }
            AttributeType::Binary => {
                let header = self.parser.parse::<SpecialAttributeHeader>()?;
                let bytelen = u64::from(header.bytelen);
                self.update_next_attr_start_offset(bytelen);
                // `self.parser.reader().by_ref().take(bytelen)` is rejected by
                // borrowck (of rustc 1.31.0-beta.15 (4b3a1d911 2018-11-20)).
                let reader = io::Read::take(self.parser.reader(), bytelen);
                loader.load_binary(reader, bytelen)
            }
            AttributeType::String => {
                let header = self.parser.parse::<SpecialAttributeHeader>()?;
                let bytelen = u64::from(header.bytelen);
                self.update_next_attr_start_offset(bytelen);
                // `self.parser.reader().by_ref().take(bytelen)` is rejected by
                // borrowck (of rustc 1.31.0-beta.15 (4b3a1d911 2018-11-20)).
                let reader = io::Read::take(self.parser.reader(), bytelen);
                loader.load_string(reader, bytelen)
            }
        }
    }

    /// Internal implementation of `load_next_buffered`.
    fn load_next_buffered_impl<V>(
        &mut self,
        attr_type: AttributeType,
        loader: V,
        start_pos: u64,
        attr_index: usize,
    ) -> Result<V::Output>
    where
        R: io::BufRead,
        V: LoadAttribute,
    {
        match attr_type {
            AttributeType::Binary => {
                let header = self.parser.parse::<SpecialAttributeHeader>()?;
                let bytelen = u64::from(header.bytelen);
                self.update_next_attr_start_offset(bytelen);
                // `self.parser.reader().by_ref().take(bytelen)` is rejected by
                // borrowck (of rustc 1.31.0-beta.15 (4b3a1d911 2018-11-20)).
                let reader = io::Read::take(self.parser.reader(), bytelen);
                loader.load_binary_buffered(reader, bytelen)
            }
            AttributeType::String => {
                let header = self.parser.parse::<SpecialAttributeHeader>()?;
                let bytelen = u64::from(header.bytelen);
                self.update_next_attr_start_offset(bytelen);
                // `self.parser.reader().by_ref().take(bytelen)` is rejected by
                // borrowck (of rustc 1.31.0-beta.15 (4b3a1d911 2018-11-20)).
                let reader = io::Read::take(self.parser.reader(), bytelen);
                loader.load_string_buffered(reader, bytelen)
            }
            _ => self.load_next_impl(attr_type, loader, start_pos, attr_index),
        }
    }

    /// Returns the syntactic position of the attribute currently reading.
    fn position(&self, start_pos: u64, index: usize) -> SyntacticPosition {
        SyntacticPosition {
            component_byte_pos: start_pos,
            attribute_index: Some(index),
            ..self.parser.position()
        }
    }

    /// Creates an iterator emitting attribute values.
    pub fn iter<V, I>(&mut self, loaders: I) -> iter::BorrowedIter<'_, 'a, R, I::IntoIter>
    where
        V: LoadAttribute,
        I: IntoIterator<Item = V>,
    {
        iter::BorrowedIter::new(self, loaders.into_iter())
    }

    /// Creates an iterator emitting attribute values with buffered I/O.
    pub fn iter_buffered<V, I>(
        &mut self,
        loaders: I,
    ) -> iter::BorrowedIterBuffered<'_, 'a, R, I::IntoIter>
    where
        R: io::BufRead,
        V: LoadAttribute,
        I: IntoIterator<Item = V>,
    {
        iter::BorrowedIterBuffered::new(self, loaders.into_iter())
    }

    /// Creates an iterator emitting attribute values.
    pub fn into_iter<V, I>(self, loaders: I) -> iter::OwnedIter<'a, R, I::IntoIter>
    where
        V: LoadAttribute,
        I: IntoIterator<Item = V>,
    {
        iter::OwnedIter::new(self, loaders.into_iter())
    }

    /// Creates an iterator emitting attribute values with buffered I/O.
    pub fn into_iter_buffered<V, I>(self, loaders: I) -> iter::OwnedIterBuffered<'a, R, I::IntoIter>
    where
        R: io::BufRead,
        V: LoadAttribute,
        I: IntoIterator<Item = V>,
    {
        iter::OwnedIterBuffered::new(self, loaders.into_iter())
    }
}