3 use std::io::prelude::*;
17 pub type ByteIOResult<T> = Result<T, ByteIOError>;
20 fn read_buf(&mut self, buf: &mut [u8]) -> ByteIOResult<usize>;
21 fn read_buf_some(&mut self, buf: &mut [u8]) -> ByteIOResult<usize>;
22 fn peek_buf(&mut self, buf: &mut [u8]) -> ByteIOResult<usize>;
23 fn read_byte(&mut self) -> ByteIOResult<u8>;
24 fn peek_byte(&mut self) -> ByteIOResult<u8>;
25 fn write_buf(&mut self, buf: &[u8]) -> ByteIOResult<()>;
26 fn tell(&mut self) -> u64;
27 fn seek(&mut self, pos: SeekFrom) -> ByteIOResult<u64>;
28 fn is_eof(&self) -> bool;
29 fn is_seekable(&mut self) -> bool;
30 fn size(&mut self) -> i64;
34 pub struct ByteReader<'a> {
38 pub struct MemoryReader<'a> {
44 pub struct FileReader<'a> {
49 macro_rules! read_int {
50 ($s: ident, $inttype: ty, $size: expr, $which: ident) => ({
52 let mut buf: $inttype = 0;
53 $s.read_buf(&mut *(&mut buf as *mut $inttype as *mut [u8; $size]))?;
59 macro_rules! peek_int {
60 ($s: ident, $inttype: ty, $size: expr, $which: ident) => ({
62 let mut buf: $inttype = 0;
63 $s.peek_buf(&mut *(&mut buf as *mut $inttype as *mut [u8; $size]))?;
69 macro_rules! read_int_func {
70 ($s: ident, $inttype: ty, $size: expr, $which: ident) => {
71 pub fn $s(src: &[u8]) -> ByteIOResult<$inttype> {
72 if src.len() < $size { return Err(ByteIOError::ReadError); }
74 let mut buf: $inttype = 0;
75 ptr::copy_nonoverlapping(src.as_ptr(), &mut buf as *mut $inttype as *mut u8, 1);
82 read_int_func!(read_u16be, u16, 2, to_be);
83 read_int_func!(read_u16le, u16, 2, to_le);
84 read_int_func!(read_u32be, u32, 4, to_be);
85 read_int_func!(read_u32le, u32, 4, to_le);
86 read_int_func!(read_u64be, u64, 8, to_be);
87 read_int_func!(read_u64le, u64, 8, to_le);
89 pub fn read_u24be(src: &[u8]) -> ByteIOResult<u32> {
90 if src.len() < 3 { return Err(ByteIOError::ReadError); }
91 Ok((u32::from(src[0]) << 16) | (u32::from(src[1]) << 8) | u32::from(src[2]))
93 pub fn read_u24le(src: &[u8]) -> ByteIOResult<u32> {
94 if src.len() < 3 { return Err(ByteIOError::ReadError); }
95 Ok((u32::from(src[2]) << 16) | (u32::from(src[1]) << 8) | u32::from(src[0]))
98 impl<'a> ByteReader<'a> {
99 pub fn new(io: &'a mut ByteIO) -> Self { ByteReader { io } }
101 pub fn read_buf(&mut self, buf: &mut [u8]) -> ByteIOResult<usize> {
102 self.io.read_buf(buf)
105 pub fn read_buf_some(&mut self, buf: &mut [u8]) -> ByteIOResult<usize> {
106 self.io.read_buf_some(buf)
109 pub fn peek_buf(&mut self, buf: &mut [u8]) -> ByteIOResult<usize> {
110 self.io.peek_buf(buf)
113 pub fn read_byte(&mut self) -> ByteIOResult<u8> {
117 pub fn peek_byte(&mut self) -> ByteIOResult<u8> {
121 pub fn read_u16be(&mut self) -> ByteIOResult<u16> {
122 read_int!(self, u16, 2, to_be)
125 pub fn peek_u16be(&mut self) -> ByteIOResult<u16> {
126 peek_int!(self, u16, 2, to_be)
129 pub fn read_u24be(&mut self) -> ByteIOResult<u32> {
130 let p16 = self.read_u16be()?;
131 let p8 = self.read_byte()?;
132 Ok((u32::from(p16) << 8) | u32::from(p8))
135 pub fn peek_u24be(&mut self) -> ByteIOResult<u32> {
136 let mut src: [u8; 3] = [0; 3];
137 self.peek_buf(&mut src)?;
138 Ok((u32::from(src[0]) << 16) | (u32::from(src[1]) << 8) | u32::from(src[2]))
141 pub fn read_u32be(&mut self) -> ByteIOResult<u32> {
142 read_int!(self, u32, 4, to_be)
145 pub fn peek_u32be(&mut self) -> ByteIOResult<u32> {
146 peek_int!(self, u32, 4, to_be)
149 pub fn read_u64be(&mut self) -> ByteIOResult<u64> {
150 read_int!(self, u64, 8, to_be)
153 pub fn peek_u64be(&mut self) -> ByteIOResult<u64> {
154 peek_int!(self, u64, 8, to_be)
157 pub fn read_u16le(&mut self) -> ByteIOResult<u16> {
158 read_int!(self, u16, 2, to_le)
161 pub fn peek_u16le(&mut self) -> ByteIOResult<u16> {
162 peek_int!(self, u16, 2, to_le)
165 pub fn read_u24le(&mut self) -> ByteIOResult<u32> {
166 let p8 = self.read_byte()?;
167 let p16 = self.read_u16le()?;
168 Ok((u32::from(p16) << 8) | u32::from(p8))
171 pub fn peek_u24le(&mut self) -> ByteIOResult<u32> {
172 let mut src: [u8; 3] = [0; 3];
173 self.peek_buf(&mut src)?;
174 Ok(u32::from(src[0]) | (u32::from(src[1]) << 8) | (u32::from(src[2]) << 16))
177 pub fn read_u32le(&mut self) -> ByteIOResult<u32> {
178 read_int!(self, u32, 4, to_le)
181 pub fn peek_u32le(&mut self) -> ByteIOResult<u32> {
182 peek_int!(self, u32, 4, to_le)
185 pub fn read_u64le(&mut self) -> ByteIOResult<u64> {
186 read_int!(self, u64, 8, to_le)
189 pub fn peek_u64le(&mut self) -> ByteIOResult<u64> {
190 peek_int!(self, u64, 8, to_le)
193 pub fn read_skip(&mut self, len: usize) -> ByteIOResult<()> {
194 if self.io.is_seekable() {
195 self.io.seek(SeekFrom::Current(len as i64))?;
198 let mut buf : [u8; 16] = [0; 16];
200 while ssize > bref.len() {
201 self.io.read_buf(bref)?;
205 self.io.read_byte()?;
212 pub fn tell(&mut self) -> u64 {
216 pub fn seek(&mut self, pos: SeekFrom) -> ByteIOResult<u64> {
220 pub fn is_eof(&self) -> bool {
224 pub fn size(&mut self) -> i64 {
228 pub fn left(&mut self) -> i64 {
229 let size = self.io.size();
230 if size == -1 { return -1; }
231 size - (self.io.tell() as i64)
235 impl<'a> MemoryReader<'a> {
237 pub fn new_read(buf: &'a [u8]) -> Self {
238 MemoryReader { buf, size: buf.len(), pos: 0 }
241 fn real_seek(&mut self, pos: i64) -> ByteIOResult<u64> {
242 if pos < 0 || (pos as usize) > self.size {
243 return Err(ByteIOError::WrongRange);
245 self.pos = pos as usize;
250 impl<'a> ByteIO for MemoryReader<'a> {
251 fn read_byte(&mut self) -> ByteIOResult<u8> {
252 if self.is_eof() { return Err(ByteIOError::EOF); }
253 let res = self.buf[self.pos];
258 fn peek_byte(&mut self) -> ByteIOResult<u8> {
259 if self.is_eof() { return Err(ByteIOError::EOF); }
260 Ok(self.buf[self.pos])
263 fn peek_buf(&mut self, buf: &mut [u8]) -> ByteIOResult<usize> {
264 let copy_size = if self.size - self.pos < buf.len() { self.size } else { buf.len() };
265 if copy_size == 0 { return Err(ByteIOError::EOF); }
266 let dst = &mut buf[0..copy_size];
267 dst.copy_from_slice(&self.buf[self.pos..][..copy_size]);
271 fn read_buf(&mut self, buf: &mut [u8]) -> ByteIOResult<usize> {
272 let read_size = self.peek_buf(buf)?;
273 if read_size < buf.len() { return Err(ByteIOError::EOF); }
274 self.pos += read_size;
278 fn read_buf_some(&mut self, buf: &mut [u8]) -> ByteIOResult<usize> {
279 let read_size = self.peek_buf(buf)?;
280 self.pos += read_size;
284 #[allow(unused_variables)]
285 fn write_buf(&mut self, buf: &[u8]) -> ByteIOResult<()> {
286 Err(ByteIOError::NotImplemented)
289 fn tell(&mut self) -> u64 {
293 fn seek(&mut self, pos: SeekFrom) -> ByteIOResult<u64> {
294 let cur_pos = self.pos as i64;
295 let cur_size = self.size as i64;
297 SeekFrom::Start(x) => self.real_seek(x as i64),
298 SeekFrom::Current(x) => self.real_seek(cur_pos + x),
299 SeekFrom::End(x) => self.real_seek(cur_size + x),
303 fn is_eof(&self) -> bool {
304 self.pos >= self.size
307 fn is_seekable(&mut self) -> bool {
311 fn size(&mut self) -> i64 {
312 self.buf.len() as i64
316 impl<'a> FileReader<'a> {
318 pub fn new_read(file: &'a mut File) -> Self {
319 FileReader { file, eof : false }
323 impl<'a> ByteIO for FileReader<'a> {
324 fn read_byte(&mut self) -> ByteIOResult<u8> {
325 let mut byte : [u8; 1] = [0];
326 let ret = self.file.read(&mut byte);
327 if ret.is_err() { return Err(ByteIOError::ReadError); }
328 let sz = ret.unwrap();
329 if sz == 0 { self.eof = true; return Err(ByteIOError::EOF); }
333 fn peek_byte(&mut self) -> ByteIOResult<u8> {
334 let b = self.read_byte()?;
335 self.seek(SeekFrom::Current(-1))?;
339 fn read_buf(&mut self, buf: &mut [u8]) -> ByteIOResult<usize> {
340 let ret = self.file.read(buf);
341 if ret.is_err() { return Err(ByteIOError::ReadError); }
342 let sz = ret.unwrap();
343 if sz < buf.len() { self.eof = true; return Err(ByteIOError::EOF); }
347 fn read_buf_some(&mut self, buf: &mut [u8]) -> ByteIOResult<usize> {
348 let ret = self.file.read(buf);
349 if ret.is_err() { return Err(ByteIOError::ReadError); }
350 let sz = ret.unwrap();
351 if sz < buf.len() { self.eof = true; }
355 fn peek_buf(&mut self, buf: &mut [u8]) -> ByteIOResult<usize> {
356 let size = self.read_buf(buf)?;
357 self.seek(SeekFrom::Current(-(size as i64)))?;
361 #[allow(unused_variables)]
362 fn write_buf(&mut self, buf: &[u8]) -> ByteIOResult<()> {
363 Err(ByteIOError::NotImplemented)
366 fn tell(&mut self) -> u64 {
367 self.file.seek(SeekFrom::Current(0)).unwrap()
370 fn seek(&mut self, pos: SeekFrom) -> ByteIOResult<u64> {
371 let res = self.file.seek(pos);
374 Err(_) => Err(ByteIOError::SeekError),
378 fn is_eof(&self) -> bool {
382 fn is_seekable(&mut self) -> bool {
386 fn size(&mut self) -> i64 {
392 pub struct ByteWriter<'a> {
396 pub struct MemoryWriter<'a> {
402 pub struct FileWriter {
406 impl<'a> ByteWriter<'a> {
407 pub fn new(io: &'a mut ByteIO) -> Self { ByteWriter { io } }
409 pub fn write_buf(&mut self, buf: &[u8]) -> ByteIOResult<()> {
410 self.io.write_buf(buf)
413 pub fn write_byte(&mut self, val: u8) -> ByteIOResult<()> {
414 let buf: [u8; 1] = [val];
415 self.io.write_buf(&buf)
418 pub fn write_u16be(&mut self, val: u16) -> ByteIOResult<()> {
419 let buf: [u8; 2] = [((val >> 8) & 0xFF) as u8, (val & 0xFF) as u8];
420 self.io.write_buf(&buf)
423 pub fn write_u16le(&mut self, val: u16) -> ByteIOResult<()> {
424 let buf: [u8; 2] = [(val & 0xFF) as u8, ((val >> 8) & 0xFF) as u8];
425 self.io.write_buf(&buf)
428 pub fn write_u24be(&mut self, val: u32) -> ByteIOResult<()> {
429 let buf: [u8; 3] = [((val >> 16) & 0xFF) as u8, ((val >> 8) & 0xFF) as u8, (val & 0xFF) as u8];
433 pub fn write_u24le(&mut self, val: u32) -> ByteIOResult<()> {
434 let buf: [u8; 3] = [(val & 0xFF) as u8, ((val >> 8) & 0xFF) as u8, ((val >> 16) & 0xFF) as u8];
438 pub fn write_u32be(&mut self, val: u32) -> ByteIOResult<()> {
439 self.write_u16be(((val >> 16) & 0xFFFF) as u16)?;
440 self.write_u16be((val & 0xFFFF) as u16)
443 pub fn write_u32le(&mut self, val: u32) -> ByteIOResult<()> {
444 self.write_u16le((val & 0xFFFF) as u16)?;
445 self.write_u16le(((val >> 16) & 0xFFFF) as u16)
448 pub fn write_u64be(&mut self, val: u64) -> ByteIOResult<()> {
449 self.write_u32be((val >> 32) as u32)?;
450 self.write_u32be(val as u32)
453 pub fn write_u64le(&mut self, val: u64) -> ByteIOResult<()> {
454 self.write_u32le(val as u32)?;
455 self.write_u32le((val >> 32) as u32)
458 pub fn tell(&mut self) -> u64 {
462 pub fn seek(&mut self, pos: SeekFrom) -> ByteIOResult<u64> {
466 pub fn size_left(&mut self) -> i64 {
467 let sz = self.io.size();
468 if sz == -1 { return -1; }
469 sz - (self.tell() as i64)
473 impl<'a> MemoryWriter<'a> {
475 pub fn new_write(buf: &'a mut [u8]) -> Self {
477 MemoryWriter { buf, size: len, pos: 0 }
480 fn real_seek(&mut self, pos: i64) -> ByteIOResult<u64> {
481 if pos < 0 || (pos as usize) > self.size {
482 return Err(ByteIOError::WrongRange)
484 self.pos = pos as usize;
489 impl<'a> ByteIO for MemoryWriter<'a> {
490 #[allow(unused_variables)]
491 fn read_byte(&mut self) -> ByteIOResult<u8> {
492 Err(ByteIOError::NotImplemented)
495 #[allow(unused_variables)]
496 fn peek_byte(&mut self) -> ByteIOResult<u8> {
497 Err(ByteIOError::NotImplemented)
500 #[allow(unused_variables)]
501 fn read_buf(&mut self, buf: &mut [u8]) -> ByteIOResult<usize> {
502 Err(ByteIOError::NotImplemented)
505 #[allow(unused_variables)]
506 fn read_buf_some(&mut self, buf: &mut [u8]) -> ByteIOResult<usize> {
507 Err(ByteIOError::NotImplemented)
510 #[allow(unused_variables)]
511 fn peek_buf(&mut self, buf: &mut [u8]) -> ByteIOResult<usize> {
512 Err(ByteIOError::NotImplemented)
515 fn write_buf(&mut self, buf: &[u8]) -> ByteIOResult<()> {
516 if self.pos + buf.len() > self.size { return Err(ByteIOError::WriteError); }
517 for i in 0..buf.len() {
518 self.buf[self.pos + i] = buf[i];
520 self.pos += buf.len();
524 fn tell(&mut self) -> u64 {
528 fn seek(&mut self, pos: SeekFrom) -> ByteIOResult<u64> {
529 let cur_pos = self.pos as i64;
530 let cur_size = self.size as i64;
532 SeekFrom::Start(x) => self.real_seek(x as i64),
533 SeekFrom::Current(x) => self.real_seek(cur_pos + x),
534 SeekFrom::End(x) => self.real_seek(cur_size + x),
538 fn is_eof(&self) -> bool {
539 self.pos >= self.size
542 fn is_seekable(&mut self) -> bool {
546 fn size(&mut self) -> i64 {
547 self.buf.len() as i64
552 pub fn new_write(file: File) -> Self {
557 impl ByteIO for FileWriter {
558 #[allow(unused_variables)]
559 fn read_byte(&mut self) -> ByteIOResult<u8> {
560 Err(ByteIOError::NotImplemented)
563 #[allow(unused_variables)]
564 fn peek_byte(&mut self) -> ByteIOResult<u8> {
565 Err(ByteIOError::NotImplemented)
568 #[allow(unused_variables)]
569 fn read_buf(&mut self, buf: &mut [u8]) -> ByteIOResult<usize> {
570 Err(ByteIOError::NotImplemented)
573 #[allow(unused_variables)]
574 fn read_buf_some(&mut self, buf: &mut [u8]) -> ByteIOResult<usize> {
575 Err(ByteIOError::NotImplemented)
578 #[allow(unused_variables)]
579 fn peek_buf(&mut self, buf: &mut [u8]) -> ByteIOResult<usize> {
580 Err(ByteIOError::NotImplemented)
583 fn write_buf(&mut self, buf: &[u8]) -> ByteIOResult<()> {
584 match self.file.write_all(buf) {
586 Err(_) => Err(ByteIOError::WriteError),
590 fn tell(&mut self) -> u64 {
591 self.file.seek(SeekFrom::Current(0)).unwrap()
594 fn seek(&mut self, pos: SeekFrom) -> ByteIOResult<u64> {
595 let res = self.file.seek(pos);
598 Err(_) => Err(ByteIOError::SeekError),
602 fn is_eof(&self) -> bool {
606 fn is_seekable(&mut self) -> bool {
610 fn size(&mut self) -> i64 {
622 //const DATA : &'static [u8] = include_bytes!("../../assets/file");
623 let buf: [u8; 64] = [1; 64];
624 let mut mr = MemoryReader::new_read(&buf);
625 let mut reader = ByteReader::new(&mut mr);
626 assert_eq!(reader.read_byte().unwrap(), 0x01u8);
627 assert_eq!(reader.read_u16le().unwrap(), 0x0101u16);
628 assert_eq!(reader.read_u24le().unwrap(), 0x010101u32);
629 assert_eq!(reader.read_u32le().unwrap(), 0x01010101u32);
630 assert_eq!(reader.read_u64le().unwrap(), 0x0101010101010101u64);
631 let mut file = File::open("assets/Misc/MaoMacha.asx").unwrap();
632 let mut fr = FileReader::new_read(&mut file);
633 let mut br2 = ByteReader::new(&mut fr);
634 assert_eq!(br2.read_byte().unwrap(), 0x30);
635 assert_eq!(br2.read_u24be().unwrap(), 0x26B275);
636 assert_eq!(br2.read_u24le().unwrap(), 0xCF668E);
637 assert_eq!(br2.read_u32be().unwrap(), 0x11A6D900);
638 assert_eq!(br2.read_u32le().unwrap(), 0xCE6200AA);
642 let mut buf: [u8; 64] = [0; 64];
644 let mut mw = MemoryWriter::new_write(&mut buf);
645 let mut bw = ByteWriter::new(&mut mw);
646 bw.write_byte(0x00).unwrap();
647 bw.write_u16be(0x0102).unwrap();
648 bw.write_u24be(0x030405).unwrap();
649 bw.write_u32be(0x06070809).unwrap();
650 bw.write_u64be(0x0A0B0C0D0E0F1011).unwrap();
651 bw.write_byte(0x00).unwrap();
652 bw.write_u16le(0x0201).unwrap();
653 bw.write_u24le(0x050403).unwrap();
654 bw.write_u32le(0x09080706).unwrap();
655 bw.write_u64le(0x11100F0E0D0C0B0A).unwrap();
656 assert_eq!(bw.size_left(), 28);
659 assert_eq!(buf[(i + 0x00) as usize], i);
660 assert_eq!(buf[(i + 0x12) as usize], i);