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
use crate::errors::IndexedImageError;
use crate::errors::IndexedImageError::*;
use crate::palette::FilePalette::*;
use crate::IciColor;

pub(crate) const PAL_NO_DATA: u8 = 0;
pub(crate) const PAL_ID: u8 = 1;
pub(crate) const PAL_NAME: u8 = 2;
pub(crate) const PAL_COLORS: u8 = 3;

/// How palette data is stored in an ICI file
#[derive(Debug, Clone, Eq, PartialEq)]
pub enum FilePalette {
    /// Include no palette information
    NoData,
    /// Include palette id (reader will need to know what the id refers to)
    ID(u16),
    /// Include palette name (reader will need to know what the name refers to) 1..=255 chars
    Name(String),
    /// Include palette colors
    Colors,
}

impl FilePalette {
    pub(crate) fn to_byte(&self) -> u8 {
        match self {
            NoData => PAL_NO_DATA,
            ID(_) => PAL_ID,
            Name(_) => PAL_NAME,
            Colors => PAL_COLORS,
        }
    }
}

pub(crate) fn write(
    palette: &FilePalette,
    colors: &[IciColor],
    output: &mut Vec<u8>,
) -> Result<(), IndexedImageError> {
    output.push(palette.to_byte());
    match palette {
        NoData => {}
        ID(id) => output.extend_from_slice(&id.to_be_bytes()),
        Name(name) => {
            let len = name.len();
            if len < 1 {
                return Err(PaletteNameTooShort);
            }
            if len > 255 {
                return Err(PaletteNameTooLong);
            }
            output.push(len as u8);
            output.extend_from_slice(name.as_bytes())
        }
        Colors => {
            output.push(colors.len() as u8);
            for color in colors {
                output.push(color.r);
                output.push(color.g);
                output.push(color.b);
                output.push(color.a);
            }
        }
    }

    Ok(())
}

pub(crate) fn read(
    mut start_idx: usize,
    bytes: &[u8],
) -> Result<(usize, FilePalette, Option<Vec<IciColor>>), IndexedImageError> {
    if bytes.len() <= start_idx {
        return Err(InvalidFileFormat(
            start_idx,
            "No data after header, expected palette format".to_string(),
        ));
    }
    let pal_type = bytes[start_idx];
    start_idx += 1;
    match pal_type {
        PAL_NO_DATA => Ok((1, NoData, None)),
        PAL_ID => {
            if bytes.len() < start_idx + 1 {
                return Err(InvalidFileFormat(
                    start_idx,
                    "No data after palette format, expected ID".to_string(),
                ));
            }
            let bytes = &bytes[start_idx..=start_idx + 1];
            let id = u16::from_be_bytes([bytes[0], bytes[1]]);
            Ok((3, ID(id), None))
        }
        PAL_NAME => {
            if bytes.len() < start_idx {
                return Err(InvalidFileFormat(
                    start_idx,
                    "No data after palette format, expected palette name length".to_string(),
                ));
            }
            let len = bytes[start_idx];
            start_idx += 1;
            let end = len as usize;
            if bytes.len() < start_idx + end {
                return Err(InvalidFileFormat(
                    start_idx,
                    "Incomplete data after palette name length, expected palette name".to_string(),
                ));
            }
            let name = String::from_utf8(bytes[start_idx..start_idx + end].to_vec())
                .map_err(PaletteNameNotUtf8)?;
            Ok((end + 2, Name(name), None))
        }
        PAL_COLORS => {
            if bytes.len() < start_idx {
                return Err(InvalidFileFormat(
                    start_idx,
                    "No data after palette format, expected color count".to_string(),
                ));
            }
            let count = bytes[start_idx];
            start_idx += 1;
            let end = count as usize * 4;
            if bytes.len() < start_idx + end {
                return Err(InvalidFileFormat(
                    start_idx,
                    format!("Incomplete data after palette color count, expected {count} colors"),
                ));
            }
            let mut colors = vec![];
            let color_bytes: Vec<&u8> = bytes.iter().skip(start_idx).take(end).collect();
            for color in color_bytes.chunks_exact(4) {
                colors.push(IciColor::new(*color[0], *color[1], *color[2], *color[3]));
            }
            Ok((end + 2, Colors, Some(colors)))
        }
        _ => Err(InvalidFileFormat(
            start_idx,
            format!("Unsupport palette type {pal_type}"),
        )),
    }
}

#[cfg(test)]
mod test {
    use super::*;

    #[test]
    fn write_no_data() {
        let mut output = vec![];
        write(&NoData, &[], &mut output).unwrap();
        assert_eq!(output, vec![PAL_NO_DATA]);

        let mut output = vec![];
        write(&NoData, &[IciColor::new(255, 45, 231, 2)], &mut output).unwrap();
        assert_eq!(output, vec![PAL_NO_DATA]);
    }

    #[test]
    fn write_id() {
        let mut output = vec![];
        write(&ID(5), &[], &mut output).unwrap();
        assert_eq!(output, vec![PAL_ID, 0, 5]);

        let mut output = vec![];
        write(&ID(256), &[IciColor::new(255, 45, 231, 2)], &mut output).unwrap();
        assert_eq!(output, vec![PAL_ID, 1, 0]);
    }

    #[test]
    fn write_name() {
        let mut output = vec![];
        write(&Name("test".to_string()), &[], &mut output).unwrap();
        assert_eq!(
            output,
            vec![PAL_NAME, 4, 't' as u8, 'e' as u8, 's' as u8, 't' as u8]
        );

        let mut output = vec![];
        write(
            &Name("😺".to_string()),
            &[IciColor::new(255, 45, 231, 2)],
            &mut output,
        )
        .unwrap();
        assert_eq!(output, vec![PAL_NAME, 4, 240, 159, 152, 186]);
    }

    #[test]
    fn write_colors() {
        let mut output = vec![];
        write(&Colors, &[IciColor::new(100, 101, 102, 103)], &mut output).unwrap();
        assert_eq!(output, vec![PAL_COLORS, 1, 100, 101, 102, 103]);

        let mut output = vec![];
        write(
            &Colors,
            &[
                IciColor::new(100, 101, 102, 103),
                IciColor::new(0, 0, 0, 255),
            ],
            &mut output,
        )
        .unwrap();
        assert_eq!(
            output,
            vec![PAL_COLORS, 2, 100, 101, 102, 103, 0, 0, 0, 255]
        );
    }

    #[test]
    fn read_no_data() {
        let (skip, pal_type, colors) = read(0, &[PAL_NO_DATA]).unwrap();
        assert_eq!(skip, 1);
        assert_eq!(pal_type, NoData);
        assert_eq!(colors, None);
    }

    #[test]
    fn read_id() {
        let (skip, pal_type, colors) = read(0, &[PAL_ID, 0, 5]).unwrap();
        assert_eq!(skip, 3);
        assert_eq!(pal_type, ID(5));
        assert_eq!(colors, None);
    }

    #[test]
    fn read_name() {
        let (skip, pal_type, colors) = read(0, &[PAL_NAME, 4, 240, 159, 152, 186]).unwrap();
        assert_eq!(skip, 6);
        assert_eq!(pal_type, Name("😺".to_string()));
        assert_eq!(colors, None);
    }

    #[test]
    fn read_colors() {
        let (skip, pal_type, colors) =
            read(0, &[PAL_COLORS, 2, 100, 101, 102, 103, 0, 0, 0, 255]).unwrap();
        assert_eq!(skip, 10);
        assert_eq!(pal_type, Colors);
        assert_eq!(
            colors,
            Some(vec![
                IciColor::new(100, 101, 102, 103),
                IciColor::new(0, 0, 0, 255)
            ])
        );
    }

    #[test]
    fn write_data_before() {
        let mut output = vec![1, 1, 1, 1];
        write(&ID(5), &[], &mut output).unwrap();
        assert_eq!(output, vec![1, 1, 1, 1, PAL_ID, 0, 5]);
    }

    #[test]
    fn read_data_either_side() {
        let bytes = [
            1, 1, 1, 1, PAL_COLORS, 2, 100, 101, 102, 103, 0, 0, 0, 255, 2, 2, 2, 2,
        ];
        let start = 4;
        let (skip, pal_type, colors) = read(start, &bytes).unwrap();
        assert_eq!(skip, 10);
        assert_eq!(pal_type, Colors);
        assert_eq!(
            colors,
            Some(vec![
                IciColor::new(100, 101, 102, 103),
                IciColor::new(0, 0, 0, 255)
            ])
        );
        assert_eq!(bytes[start + skip..], [2, 2, 2, 2]);
    }
}