xinto 0.2.0

// Copyright (C) 2020 Guillaume Valadon <guillaume@valadon.net>

use std::fs::File;
use std::io::prelude::*; // used to get the BufRead trait
use std::io::BufReader;
use std::path::Path;

extern crate err_derive;
use err_derive::Error;

extern crate hex;
use hex::FromHex;

extern crate serde;
extern crate serde_json;
use serde::{Deserialize, Serialize};

fn u8_from_hex(input: &str) -> Result<u8, std::num::ParseIntError> {
    u8::from_str_radix(input, 16)
}

fn u16_from_hex(input: &str) -> Result<u16, std::num::ParseIntError> {
    u16::from_str_radix(input, 16)
}

fn parse_u8(input: &str) -> Result<(&str, u8), RecordParsingError> {
    let size = std::mem::size_of::<u8>() * 2;
    if input.len() < size {
        return Err(RecordParsingError::TooSmall);
    }

    if !input.is_char_boundary(size) {
        return Err(RecordParsingError::NonASCIICharacter);
    }

    Ok((
        &input[size..],
        u8_from_hex(&input[0..size]).or_else(|_| Err(RecordParsingError::ParseIntError))?,
    ))
}

fn parse_u16(input: &str) -> Result<(&str, u16), RecordParsingError> {
    let size = std::mem::size_of::<u16>() * 2;
    if input.len() < size {
        return Err(RecordParsingError::TooSmall);
    }

    if !input.is_char_boundary(size) {
        return Err(RecordParsingError::NonASCIICharacter);
    }

    Ok((
        &input[size..],
        u16_from_hex(&input[0..size]).or_else(|_| Err(RecordParsingError::ParseIntError))?,
    ))
}

#[derive(Debug, PartialEq, Serialize, Deserialize)]
pub struct Record {
    pub length: u8,
    pub load_offset: u16,
    pub r#type: u8,
    pub data: Vec<u8>,
    pub checksum: u8,
}

#[derive(Clone, Debug, PartialEq, Error)]
pub enum RecordParsingError {
    #[error(display = "record too small")]
    TooSmall,
    #[error(display = "non ASCII character")]
    NonASCIICharacter,
    #[error(display = "missing record mark")]
    MissingTag,
    #[error(display = "invalid length format")]
    InvalidLengthFormat,
    #[error(display = "invalid length")]
    InvalidLength,
    #[error(display = "invalid load offset format")]
    InvalidLoadOffsetFormat,
    #[error(display = "invalid type")]
    InvalidType,
    #[error(display = "invalid type format")]
    InvalidTypeFormat,
    #[error(display = "invalid data format")]
    InvalidDataFormat,
    #[error(display = "invalid checksum")]
    InvalidChecksum,
    #[error(display = "invalid checksum format")]
    InvalidChecksumFormat,
    #[error(display = "record too large")]
    TooLarge,
    #[error(display = "invalid hex integer")]
    ParseIntError,
}

#[derive(Debug, Error, PartialEq)]
pub enum FileParsingError<'a> {
    #[error(display = "'{}' is not a valid file", _0)]
    InvalidFile(&'a str),
    #[error(display = "cannot open '{}'", _0)]
    ReadFileError(&'a str),
    #[error(display = "IO error at line {}", _0)]
    IOError(usize),
    #[error(display = "at line {}: {}", line_number, error)]
    RecordError {
        error: RecordParsingError,
        line_number: usize,
    },
    #[error(display = "last record is not an End of File Record")]
    NoEOFRecord,
}

impl<'a> From<FileParsingError<'a>> for String {
    fn from(error: FileParsingError) -> Self {
        error.to_string()
    }
}

impl Record {
    pub fn end_of_file() -> Self {
        Record {
            length: 0,
            load_offset: 0,
            r#type: 1,
            data: vec![],
            checksum: 0xFF,
        }
    }

    pub fn parse(input: &str) -> Result<Record, RecordParsingError> {
        if input.len() < 11 {
            return Err(RecordParsingError::TooSmall);
        }

        if !input.starts_with(':') {
            return Err(RecordParsingError::MissingTag);
        }
        let input = &input[1..];

        let (input, length) =
            parse_u8(input).or_else(|_| Err(RecordParsingError::InvalidLengthFormat))?;

        let (input, load_offset) =
            parse_u16(input).or_else(|_| Err(RecordParsingError::InvalidLoadOffsetFormat))?;

        let (input, r#type) =
            parse_u8(input).or_else(|_| Err(RecordParsingError::InvalidTypeFormat))?;
        if r#type > 5 {
            return Err(RecordParsingError::InvalidType);
        }

        let char_count: usize = length as usize * 2;
        if char_count > (input.len() - 2) {
            return Err(RecordParsingError::InvalidLength);
        }

        if !input.is_char_boundary(char_count) {
            return Err(RecordParsingError::NonASCIICharacter);
        }

        let (input, data) = (&input[char_count..], &input[0..char_count]);

        let (input, checksum) =
            parse_u8(input).or_else(|_| Err(RecordParsingError::InvalidChecksumFormat))?;

        let record = Record {
            length,
            load_offset,
            r#type,
            data: Vec::from_hex(data).or_else(|_| Err(RecordParsingError::InvalidDataFormat))?,
            checksum,
        };

        if !input.is_empty() {
            return Err(RecordParsingError::TooLarge);
        }

        if !record.verify_checksum() {
            return Err(RecordParsingError::InvalidChecksum);
        }

        Ok(record)
    }

    pub fn verify_checksum(&self) -> bool {
        let sum = self.length as u32
            + (self.load_offset & 0xFF) as u32
            + (self.load_offset >> 8) as u32
            + self.r#type as u32
            + self
                .data
                .iter()
                .fold(0 as u32, |s, value| s as u32 + (*value as u32))
            + self.checksum as u32;
        sum.trailing_zeros() >= 8
    }

    pub fn from_file(filename: &str) -> Result<Vec<Record>, FileParsingError> {
        // Check if the file exists
        if !Path::new(filename).is_file() {
            return Err(FileParsingError::InvalidFile(filename));
        }

        // Check if the file can be opened
        let file = File::open(filename);
        if file.is_err() {
            return Err(FileParsingError::ReadFileError(filename));
        }

        let mut records = vec![];
        let buf_reader = BufReader::new(file.unwrap());

        for (line_number, line) in buf_reader.lines().enumerate().map(|(ln, l)| (ln + 1, l)) {
            let line = line.or_else(|_| Err(FileParsingError::IOError(line_number)))?;

            let record = Record::parse(&line)
                .or_else(|error| Err(FileParsingError::RecordError { error, line_number }))?;

            records.push(record);
        }

        // Check that the file format is correct
        if !records.is_empty() && *records.last().unwrap() != Record::end_of_file() {
            return Err(FileParsingError::NoEOFRecord);
        }

        Ok(records)
    }
}