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

//! This module handles the tokens:
//!
//! - `#BASE 62` - Marks the BMS source as object ids must be treated as case-sensitive.
//! - `#LNTYPE 1` - Declares the long-notes are pair-wise placements. Deprecated.
//! - `#LNTYPE 2` - Declares the long-notes are continuous placements. Obsolete.
//! - `#LNMODE mode` - Long note judgement option for beatoraja.
//! - `#CHARSET charset` - Declares charset used in the BMS source. It doesn't have any meaning to this library.
//!
//! Also [`RepresentationProcessor`] bears the responsibility of the first processor to record raw command lines.
use std::{cell::RefCell, rc::Rc};

use super::{ProcessContext, TokenProcessor};
use crate::bms::ParseErrorWithRange;
use crate::bms::{
    model::repr::BmsSourceRepresentation,
    parse::{ParseWarning, Result},
    prelude::*,
};

/// It processes representation of BMS source such as `#BASE`, `#LNMODE` and so on.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct RepresentationProcessor {
    case_sensitive_obj_id: Rc<RefCell<bool>>,
}

impl RepresentationProcessor {
    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 RepresentationProcessor {
    type Output = BmsSourceRepresentation;

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

impl RepresentationProcessor {
    fn on_header(&self, name: &str, args: &str, repr: &mut BmsSourceRepresentation) -> Result<()> {
        if args.is_empty() {
            repr.raw_command_lines.push(format!("#{name}"));
        } else {
            repr.raw_command_lines.push(format!("#{name} {args}"));
        }
        if name.eq_ignore_ascii_case("BASE") {
            if args != "62" {
                return Err(ParseWarning::OutOfBase62);
            }
            *self.case_sensitive_obj_id.borrow_mut() = true;
        }
        if name.eq_ignore_ascii_case("LNMODE") {
            let mode: u8 = args.parse().map_err(|_| {
                ParseWarning::SyntaxError("expected integer between 1 and 3".into())
            })?;
            let mode = match mode {
                1 => LnMode::Ln,
                2 => LnMode::Cn,
                3 => LnMode::Hcn,
                _ => {
                    return Err(ParseWarning::SyntaxError(
                        "expected long note mode between 1 and 3".into(),
                    ));
                }
            };
            repr.ln_mode = mode;
        }
        if name.eq_ignore_ascii_case("LNTYPE") {
            repr.ln_type = if args == "2" {
                LnType::Mgq
            } else {
                LnType::Rdm
            };
        }
        if name.eq_ignore_ascii_case("CHARSET") {
            repr.charset = Some(args.into());
        }
        Ok(())
    }
}