ffmml 0.1.1

Famicon (a.k.a. NES) Flavored Music Macro Language
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

use crate::{
    channel::ChannelNames,
    comment::{Comment, MaybeComment},
    types::OscillatorKind,
};
use std::marker::PhantomData;
use textparse::{
    components::{Char, NonEmpty, OneOfThree, Str, While},
    Parse, Parser, Position, Span,
};

#[derive(Debug, Clone, Span, Parse)]
pub enum Definition {
    Title(Title),
    Composer(Composer),
    Programer(Programer),
    Channel(Channel),
}

#[derive(Debug, Clone, Span, Parse)]
#[parse(name = "#TITLE")]
pub struct Title(DefineString<Str<'T', 'I', 'T', 'L', 'E'>>);

impl Title {
    pub fn get(&self) -> &str {
        &self.0.value
    }
}

#[derive(Debug, Clone, Span, Parse)]
#[parse(name = "#COMPOSER")]
pub struct Composer(DefineString<Str<'C', 'O', 'M', 'P', 'O', 'S', 'E', 'R'>>);

impl Composer {
    pub fn get(&self) -> &str {
        &self.0.value
    }
}

#[derive(Debug, Clone, Span, Parse)]
#[parse(name = "#PROGRAMER")]
pub struct Programer(DefineString<Str<'P', 'R', 'O', 'G', 'R', 'A', 'M', 'E', 'R'>>);

impl Programer {
    pub fn get(&self) -> &str {
        &self.0.value
    }
}

#[derive(Debug, Clone, Span)]
pub struct Channel {
    start: Position,
    channel_names: ChannelNames,
    oscillator_kind: OscillatorKind,
    end: Position,
}

impl Channel {
    pub fn channel_names(&self) -> &ChannelNames {
        &self.channel_names
    }

    pub fn oscillator_kind(&self) -> OscillatorKind {
        self.oscillator_kind
    }
}

impl Parse for Channel {
    fn parse(parser: &mut Parser) -> Option<Self> {
        let start = parser.current_position();
        let _: Str<'#', 'C', 'A', 'N', 'N', 'E', 'L'> = parser.parse()?;
        let _: NonEmpty<While<SpaceOrTabOrComment>> = parser.parse()?;
        let channel_names = parser.parse()?;
        let _: NonEmpty<While<SpaceOrTabOrComment>> = parser.parse()?;
        let oscillator_kind = parser.parse()?;
        let end = parser.current_position();

        Some(Self {
            start,
            channel_names,
            oscillator_kind,
            end,
        })
    }

    fn name() -> Option<fn() -> String> {
        Some(|| "#CHANNEL".to_owned())
    }
}

#[derive(Debug, Clone, Span)]
struct DefineString<T> {
    start: Position,
    label: PhantomData<T>,
    value: String,
    end: Position,
}

impl<T: Parse> Parse for DefineString<T> {
    fn parse(parser: &mut Parser) -> Option<Self> {
        let start = parser.current_position();
        let _: (Char<'#'>, T, NonEmpty<While<SpaceOrTabOrComment>>) = parser.parse()?;
        let mut end;
        let mut value = String::new();
        loop {
            let _: MaybeComment = parser.parse()?;

            end = parser.current_position();
            let c = parser.read_char().unwrap_or('\n');
            if c == '\n' {
                break;
            }
            value.push(c);
        }
        if value.is_empty() {
            return None;
        }
        Some(Self {
            start,
            label: PhantomData,
            value,
            end,
        })
    }
}

type SpaceOrTabOrComment = OneOfThree<Char<' ', false>, Char<'\t', false>, Comment>;