bms-rs 1.0.0

The BMS format parser.
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
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
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
//! This module handles the tokens:
//!
//! - `#BMP[00-ZZ] filename` - Image file definition. The black will be transparent.
//! - `#BGA[00-ZZ] bmp_index crop_top_left_x crop_top_left_y crop_bottom_right_x crop_bottom_right_y draw_top_left_x draw_top_left_y` - Cropped image definition.
//! - `#@BGA[00-ZZ] bmp_index crop_top_left_x crop_top_;eft_y crop_width crop_height draw_top_left_x draw_top_left_y` - Cropped image definition.
//! - `#EXBMP[00-ZZ] a,r,g,b filename` - Image file definition with the color to be transparent.
//! - `#POORBGA mode` / `#BGAPOOR mode` - Display option for POOR (MISS) image.
//! - `#xxx04:` - Base layer channel of BGA.
//! - `#xxx06:` - Poor layer channel of BGA.
//! - `#xxx07:` - Overlay layer channel of BGA.
//! - `#xxx0A:` - Secondary overlay layer channel of BGA.
//! - `#xxx0B:` - Opacity [01-FF] of base layer channel of BGA.
//! - `#xxx0C:` - Opacity [01-FF] of overlay layer channel of BGA.
//! - `#xxx0D:` - Opacity [01-FF] of secondary overlay layer channel of BGA.
//! - `#xxx0E:` - Opacity [01-FF] of poor channel of BGA.
//! - `#ARGB[01-ZZ] a,r,g,b` - Transparent color definition.
//! - `#xxxA1:` - Transparent color object channel for base layer of BGA.
//! - `#xxxA2:` - Transparent color object channel for overlay layer of BGA.
//! - `#xxxA3:` - Transparent color object channel for secondary overlay layer of BGA.
//! - `#xxxA4:` - Transparent color object channel for poor layer of BGA.
//! - `#SWBGA[01-ZZ] fr:time:line:loop:a,r,g,b pattern` - Key bound animated images.
//! - `#xxxA5:` - Key bound BGA animation trigger channel.

use std::{cell::RefCell, path::Path, rc::Rc, str::FromStr};

use super::{ProcessContext, TokenProcessor, parse_obj_ids};
use crate::{
    bms::{
        ParseErrorWithRange,
        model::bmp::BmpObjects,
        parse::{
            Result,
            prompt::{DefDuplication, Prompter},
        },
        prelude::*,
    },
    util::StrExtension,
};

/// It processes `#BMPxx`, `#BGAxx` and `#@BGAxx` definitions and objects on `BgaBase`, `BgaLayer`, `BgaPoor`, `BgaLayer2` and so on channels.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct BmpProcessor {
    case_sensitive_obj_id: Rc<RefCell<bool>>,
}

impl BmpProcessor {
    pub fn new(case_sensitive_obj_id: &Rc<RefCell<bool>>) -> Self {
        Self {
            case_sensitive_obj_id: Rc::clone(case_sensitive_obj_id),
        }
    }
}

impl TokenProcessor for BmpProcessor {
    type Output = BmpObjects;

    fn process<P: Prompter>(
        &self,
        ctx: &mut ProcessContext<'_, '_, P>,
    ) -> core::result::Result<Self::Output, ParseErrorWithRange> {
        let mut objects = BmpObjects::default();
        ctx.all_tokens(|token, prompter| match token.content() {
            Token::Header { name, args } => Ok(self
                .on_header(name.as_ref(), args.as_ref(), prompter, &mut objects)
                .err()
                .map(|warn| warn.into_wrapper(token))),
            Token::Message {
                track,
                channel,
                message,
            } => Ok(self
                .on_message(
                    *track,
                    *channel,
                    &message.as_ref().into_wrapper(token),
                    prompter,
                    &mut objects,
                )
                .err()
                .map(|warn| warn.into_wrapper(token))),
            Token::NotACommand(_) => Ok(None),
        })?;
        Ok(objects)
    }
}

impl BmpProcessor {
    fn bga_layer(channel: Channel) -> Result<BgaLayer> {
        BgaLayer::from_channel(channel).ok_or_else(|| {
            ParseWarning::SyntaxError(format!("invalid channel for BgaLayer: {channel:?}",))
        })
    }

    fn on_header(
        &self,
        name: &str,
        args: &str,
        prompter: &impl Prompter,
        objects: &mut BmpObjects,
    ) -> Result<()> {
        if let Some(id) = name.strip_prefix_ignore_case("BMP") {
            if args.is_empty() {
                return Err(ParseWarning::SyntaxError("expected image filename".into()));
            }
            let path = Path::new(args);
            if id == "00" {
                objects.poor_bmp = Some(path.into());
                return Ok(());
            }

            let bmp_obj_id = ObjId::try_from(id, *self.case_sensitive_obj_id.borrow())?;
            let to_insert = Bmp {
                file: path.into(),
                transparent_color: Argb::default(),
            };
            if let Some(older) = objects.bmp_files.get_mut(&bmp_obj_id) {
                prompter
                    .handle_def_duplication(DefDuplication::Bmp {
                        id: bmp_obj_id,
                        older,
                        newer: &to_insert,
                    })
                    .apply_def(older, to_insert, bmp_obj_id)?;
            } else {
                objects.bmp_files.insert(bmp_obj_id, to_insert);
            }
        }
        if let Some(id) = name.strip_prefix_ignore_case("EXBMP") {
            let args: Vec<_> = args.split_whitespace().collect();
            let [argb_spec, path] = args.as_slice() else {
                return Err(ParseWarning::SyntaxError(format!(
                    "expected 2 arguments but got {args:?}"
                )));
            };

            let parts: Vec<&str> = argb_spec.split(',').collect();
            let [alpha_s, red_s, green_s, blue_s] = parts.as_slice() else {
                return Err(ParseWarning::SyntaxError(
                    "expected 4 comma-separated values".into(),
                ));
            };
            let alpha = alpha_s
                .parse()
                .map_err(|_| ParseWarning::SyntaxError("invalid alpha value".into()))?;
            let red = red_s
                .parse()
                .map_err(|_| ParseWarning::SyntaxError("invalid red value".into()))?;
            let green = green_s
                .parse()
                .map_err(|_| ParseWarning::SyntaxError("invalid green value".into()))?;
            let blue = blue_s
                .parse()
                .map_err(|_| ParseWarning::SyntaxError("invalid blue value".into()))?;
            let transparent_color = Argb {
                alpha,
                red,
                green,
                blue,
            };

            let bmp_obj_id = ObjId::try_from(id, *self.case_sensitive_obj_id.borrow())?;
            let to_insert = Bmp {
                file: path.into(),
                transparent_color,
            };
            if let Some(older) = objects.bmp_files.get_mut(&bmp_obj_id) {
                prompter
                    .handle_def_duplication(DefDuplication::Bmp {
                        id: bmp_obj_id,
                        older,
                        newer: &to_insert,
                    })
                    .apply_def(older, to_insert, bmp_obj_id)?;
            } else {
                objects.bmp_files.insert(bmp_obj_id, to_insert);
            }
        }
        if let Some(id) = name.strip_prefix_ignore_case("ARGB") {
            let parts: Vec<_> = args.split(',').collect();
            let [alpha_s, red_s, green_s, blue_s] = parts.as_slice() else {
                return Err(ParseWarning::SyntaxError(
                    "expected 4 comma-separated values".into(),
                ));
            };
            let alpha = alpha_s
                .parse()
                .map_err(|_| ParseWarning::SyntaxError("expected u8 alpha value".into()))?;
            let red = red_s
                .parse()
                .map_err(|_| ParseWarning::SyntaxError("expected u8 red value".into()))?;
            let green = green_s
                .parse()
                .map_err(|_| ParseWarning::SyntaxError("expected u8 green value".into()))?;
            let blue = blue_s
                .parse()
                .map_err(|_| ParseWarning::SyntaxError("expected u8 blue value".into()))?;
            let id = ObjId::try_from(id, *self.case_sensitive_obj_id.borrow())?;
            let argb = Argb {
                alpha,
                red,
                green,
                blue,
            };

            if let Some(older) = objects.argb_defs.get_mut(&id) {
                prompter
                    .handle_def_duplication(DefDuplication::BgaArgb {
                        id,
                        older,
                        newer: &argb,
                    })
                    .apply_def(older, argb, id)?;
            } else {
                objects.argb_defs.insert(id, argb);
            }
        }
        if name.eq_ignore_ascii_case("POORBGA") {
            objects.poor_bga_mode = PoorMode::from_str(args)?;
        }
        if let Some(id) = name.strip_prefix_ignore_case("@BGA") {
            let args: Vec<_> = args.split_whitespace().collect();
            let [bmp_index, sx_s, sy_s, w_s, h_s, dx_s, dy_s] = args.as_slice() else {
                return Err(ParseWarning::SyntaxError(format!(
                    "expected 7 arguments but found: {args:?}"
                )));
            };

            let sx = sx_s
                .parse()
                .map_err(|_| ParseWarning::SyntaxError("expected integer".into()))?;
            let sy = sy_s
                .parse()
                .map_err(|_| ParseWarning::SyntaxError("expected integer".into()))?;
            let w = w_s
                .parse()
                .map_err(|_| ParseWarning::SyntaxError("expected integer".into()))?;
            let h = h_s
                .parse()
                .map_err(|_| ParseWarning::SyntaxError("expected integer".into()))?;
            let dx = dx_s
                .parse()
                .map_err(|_| ParseWarning::SyntaxError("expected integer".into()))?;
            let dy = dy_s
                .parse()
                .map_err(|_| ParseWarning::SyntaxError("expected integer".into()))?;
            let id = ObjId::try_from(id, *self.case_sensitive_obj_id.borrow())?;
            let source_bmp = ObjId::try_from(bmp_index, *self.case_sensitive_obj_id.borrow())?;
            let trim_top_left = (sx, sy);
            let trim_size = (w, h);
            let draw_point = (dx, dy);
            let to_insert = AtBgaDef {
                id,
                source_bmp,
                trim_top_left: trim_top_left.to_owned().into(),
                trim_size: trim_size.to_owned().into(),
                draw_point: draw_point.to_owned().into(),
            };
            if let Some(older) = objects.atbga_defs.get_mut(&id) {
                prompter
                    .handle_def_duplication(DefDuplication::AtBga {
                        id,
                        older,
                        newer: &to_insert,
                    })
                    .apply_def(older, to_insert, id)?;
            } else {
                objects.atbga_defs.insert(id, to_insert);
            }
        }
        if !name.starts_with_ignore_case("BGAPOOR")
            && let Some(id) = name.strip_prefix_ignore_case("BGA")
        {
            let args: Vec<_> = args.split_whitespace().collect();
            let [bmp_index, x1_s, y1_s, x2_s, y2_s, dx_s, dy_s] = args.as_slice() else {
                return Err(ParseWarning::SyntaxError(format!(
                    "expected 7 arguments but found: {args:?}"
                )));
            };

            let x1 = x1_s
                .parse()
                .map_err(|_| ParseWarning::SyntaxError("expected integer".into()))?;
            let y1 = y1_s
                .parse()
                .map_err(|_| ParseWarning::SyntaxError("expected integer".into()))?;
            let x2 = x2_s
                .parse()
                .map_err(|_| ParseWarning::SyntaxError("expected integer".into()))?;
            let y2 = y2_s
                .parse()
                .map_err(|_| ParseWarning::SyntaxError("expected integer".into()))?;
            let dx = dx_s
                .parse()
                .map_err(|_| ParseWarning::SyntaxError("expected integer".into()))?;
            let dy = dy_s
                .parse()
                .map_err(|_| ParseWarning::SyntaxError("expected integer".into()))?;
            let id = ObjId::try_from(id, *self.case_sensitive_obj_id.borrow())?;
            let source_bmp = ObjId::try_from(bmp_index, *self.case_sensitive_obj_id.borrow())?;
            let to_insert = BgaDef {
                id,
                source_bmp,
                trim_top_left: PixelPoint::new(x1, y1),
                trim_bottom_right: PixelPoint::new(x2, y2),
                draw_point: PixelPoint::new(dx, dy),
            };
            if let Some(older) = objects.bga_defs.get_mut(&id) {
                prompter
                    .handle_def_duplication(DefDuplication::Bga {
                        id,
                        older,
                        newer: &to_insert,
                    })
                    .apply_def(older, to_insert, id)?;
            } else {
                objects.bga_defs.insert(id, to_insert);
            }
        }
        if let Some(id) = name.strip_prefix_ignore_case("SWBGA") {
            let args: Vec<_> = args.split_whitespace().collect();
            let [spec, pattern] = args.as_slice() else {
                return Err(ParseWarning::SyntaxError(format!(
                    "expected 2 arguments but found: {args:?}"
                )));
            };

            // Parse fr:time:line:loop:a,r,g,b pattern
            let mut parts = spec.split(':');
            let frame_rate = parts
                .next()
                .ok_or_else(|| ParseWarning::SyntaxError("swbga frame_rate".into()))?
                .parse()
                .map_err(|_| ParseWarning::SyntaxError("swbga frame_rate u32".into()))?;
            let total_time = parts
                .next()
                .ok_or_else(|| ParseWarning::SyntaxError("swbga total_time".into()))?
                .parse()
                .map_err(|_| ParseWarning::SyntaxError("swbga total_time u32".into()))?;
            let line = parts
                .next()
                .ok_or_else(|| ParseWarning::SyntaxError("swbga line".into()))?
                .parse()
                .map_err(|_| ParseWarning::SyntaxError("swbga line u8".into()))?;
            let loop_mode = parts
                .next()
                .ok_or_else(|| ParseWarning::SyntaxError("swbga loop".into()))?
                .parse::<u8>()
                .map_err(|_| ParseWarning::SyntaxError("swbga loop 0/1".into()))?;
            let loop_mode = match loop_mode {
                0 => false,
                1 => true,
                _ => return Err(ParseWarning::SyntaxError("swbga loop 0/1".into())),
            };
            let argb_str = parts
                .next()
                .ok_or_else(|| ParseWarning::SyntaxError("swbga argb".into()))?;
            let argb_parts: Vec<_> = argb_str.split(',').collect();
            let [alpha_s, red_s, green_s, blue_s] = argb_parts.as_slice() else {
                return Err(ParseWarning::SyntaxError("swbga argb 4 values".into()));
            };
            let alpha = alpha_s
                .parse()
                .map_err(|_| ParseWarning::SyntaxError("swbga argb alpha".into()))?;
            let red = red_s
                .parse()
                .map_err(|_| ParseWarning::SyntaxError("swbga argb red".into()))?;
            let green = green_s
                .parse()
                .map_err(|_| ParseWarning::SyntaxError("swbga argb green".into()))?;
            let blue = blue_s
                .parse()
                .map_err(|_| ParseWarning::SyntaxError("swbga argb blue".into()))?;

            let pattern = pattern.to_string();
            let sw_obj_id = ObjId::try_from(id, *self.case_sensitive_obj_id.borrow())?;
            let ev = SwBgaEvent {
                frame_rate,
                total_time,
                line,
                loop_mode,
                argb: Argb {
                    alpha,
                    red,
                    green,
                    blue,
                },
                pattern,
            };

            if let Some(older) = objects.swbga_events.get_mut(&sw_obj_id) {
                prompter
                    .handle_def_duplication(DefDuplication::SwBgaEvent {
                        id: sw_obj_id,
                        older,
                        newer: &ev,
                    })
                    .apply_def(older, ev, sw_obj_id)?;
            } else {
                objects.swbga_events.insert(sw_obj_id, ev);
            }
        }
        Ok(())
    }

    fn on_message(
        &self,
        track: Track,
        channel: Channel,
        message: &SourceRangeMixin<&str>,
        prompter: &impl Prompter,
        objects: &mut BmpObjects,
    ) -> Result<Vec<ParseWarningWithRange>> {
        let mut warnings: Vec<ParseWarningWithRange> = Vec::new();
        match channel {
            channel @ (Channel::BgaBase
            | Channel::BgaPoor
            | Channel::BgaLayer
            | Channel::BgaLayer2) => {
                let (pairs, w) = parse_obj_ids(track, message, &self.case_sensitive_obj_id);
                warnings.extend(w);
                for (time, obj) in pairs {
                    if !objects.bmp_files.contains_key(&obj) {
                        return Err(ParseWarning::UndefinedObject(obj));
                    }
                    let layer = Self::bga_layer(channel)?;
                    objects.push_bga_change(
                        BgaObj {
                            time,
                            id: obj,
                            layer,
                        },
                        channel,
                        prompter,
                    )?;
                }
            }
            channel @ (Channel::BgaBaseOpacity
            | Channel::BgaLayerOpacity
            | Channel::BgaLayer2Opacity
            | Channel::BgaPoorOpacity) => {
                use super::parse_hex_values;
                let (pairs, w) = parse_hex_values(track, message);
                warnings.extend(w);
                for (time, opacity_value) in pairs {
                    let layer = Self::bga_layer(channel)?;
                    objects.push_bga_opacity_change(
                        BgaOpacityObj {
                            time,
                            layer,
                            opacity: opacity_value,
                        },
                        channel,
                        prompter,
                    )?;
                }
            }
            channel @ (Channel::BgaBaseArgb
            | Channel::BgaLayerArgb
            | Channel::BgaLayer2Argb
            | Channel::BgaPoorArgb) => {
                use super::parse_obj_ids;
                let (pairs, w) = parse_obj_ids(track, message, &self.case_sensitive_obj_id);
                warnings.extend(w);
                for (time, argb_id) in pairs {
                    let layer = Self::bga_layer(channel)?;
                    let argb = objects
                        .argb_defs
                        .get(&argb_id)
                        .copied()
                        .ok_or(ParseWarning::UndefinedObject(argb_id))?;
                    objects.push_bga_argb_change(
                        BgaArgbObj { time, layer, argb },
                        channel,
                        prompter,
                    )?;
                }
            }
            Channel::BgaKeybound => {
                use super::parse_obj_ids;
                let (pairs, w) = parse_obj_ids(track, message, &self.case_sensitive_obj_id);
                warnings.extend(w);
                for (time, keybound_id) in pairs {
                    let event = objects
                        .swbga_events
                        .get(&keybound_id)
                        .cloned()
                        .ok_or(ParseWarning::UndefinedObject(keybound_id))?;
                    objects.push_bga_keybound_event(BgaKeyboundObj { time, event }, prompter)?;
                }
            }
            _ => {}
        }
        Ok(warnings)
    }
}