pmd_wan 6.0.0

A library that can read wan file, a sprite format used in pokemon mystery dungeon games
Documentation 
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

use num_traits::{CheckedSub, Num};
use std::{fmt::Display, io};
use thiserror::Error;

#[derive(Debug, Error)]
pub enum WanError {
    #[error("an input/output error happened")]
    IOError(#[from] io::Error),
    #[error("an input error happened with binread")]
    BinReadError(#[from] binread::Error),
    #[error(
        "an fragment’s FragmentBytes id reference the previous one, but it is the first Fragment"
    )]
    FragmentBytesIDPointBackButFirstFragment,
    #[error("a metaframe is inferior to -1, but that is not valid (it is {0})")]
    FragmentLessThanLessOne(i16),
    #[error("While creating a meta frame store: the check for the offset of the pointer of the animation group are not valid!")]
    InvalidOffset,
    #[error("the resolution for a FragmentBytes wasn't found")]
    InvalidResolution,
    #[error("pointer to FragmentBytes parts are not coherent")]
    IncoherentPointerToFragmentBytesPart,
    #[error("An FragmentBytes buffer is empty")]
    EmptyFragmentBytes,
    #[error("an invalid alpha level was found in the picture")]
    ImpossibleAlphaLevel,
    #[error("an fragment bytes pointer is null")]
    NullFragmentBytesPointer,
    #[error("the FragmentBytes does not have a resolution")]
    FragmentBytesWithoutResolution,
    #[error("the palette data doesn't end with 0s")]
    PaletteDontEndWithZero,
    #[error("a reference to a color in a palette would overflow")]
    PaletteOOB,
    #[error("can't find a specific color in the palette")]
    CantFindColorInPalette,
    #[error("the sir0 header in invalid, expected SIR0, found {0:?}")]
    InvalidSir0([u8; 4]),
    #[error("the end of the sir0 header should be four 0, found {0:?}")]
    InvalidEndOfSir0Header([u8; 4]),
    #[error("the type of sprite is unknown (found the sprite type id {0}, but this program only known sprite for [0, 1, 3])")]
    TypeOfSpriteUnknown(u16),
    #[error("the 2 byte that indicate the number of color is invalid (found {0}, expected 0 or 1")]
    InvalidColorNumber(u16),
    #[error("the value of a substraction is less than 0: {0}-{1} ({2}-{3})")]
    OverflowSubstraction(String, String, &'static str, &'static str),
    #[error("the value of an addition is more than the maximum possible value: {0}+{1} ({2}+{3})")]
    OverflowAddition(u64, u64, &'static str, &'static str),
    #[error("the resolution of a sprite is too small accept all it's pixel")]
    SpriteTooSmall,
    #[error("an FragmentBytes doesn't have a constant depth index")]
    NonConstantIndexInFragmentBytes,
    #[error("The pointer to {0} is reference content after the end of the file")]
    PostFilePointer(&'static str),
    #[error("The resolution indices are invalid ({0} and {1})")]
    InvalidResolutionIndice(u8, u8),
    #[error(
        "There is a reference to a frame offset table while this sprite is not a Chara sprite"
    )]
    ExistenceFrameOffsetForNonChara,
    #[error("There is no reference to a frame offset table in a Chara sprite")]
    NonExistenceFrameOffsetForChara,
    #[error("There is a frame that doesn’t have a frame offset in a Chara sprite")]
    NoOffsetDataForFrame,
}

impl WanError {
    pub fn checked_sub<C: Num + CheckedSub + Display>(
        base: C,
        to_sub: C,
        base_name: &'static str,
        to_sub_name: &'static str,
    ) -> Result<C, Self> {
        base.checked_sub(&to_sub)
            .ok_or(WanError::OverflowSubstraction(
                base.to_string(),
                to_sub.to_string(),
                base_name,
                to_sub_name,
            ))
    }
}