hum 0.6.0

A music notation language and synthesizer written in Rust.
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

/*
Hum: A Music Markup Language Synthesizer
Copyright (C) 2018 Connor R. Bulakites

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.
*/

extern crate peg;


peg::parser!{
    pub grammar hum_grammar() for str {
        pub rule score() -> Vec<(String, String)>
            = commands:command()* {
                commands
            }

        rule command() -> (String, String)
            = comment()
            / tempo()
            / time()
            / checkpoint()
            / voice()
            / measure()
            / reset()
            / note()

        rule comment() -> (String, String)
            = ws()* "~" text:$((!['\n'][_])*) eol() {
                ("comment".to_string(), text.trim().to_string())
            }

        rule tempo() -> (String, String)
            = ws()* "[" ws()* text:$(number()) "_bpm" ws()* "]" ws()* {
                ("tempo".to_string(), text.to_string())
            }

        rule time() -> (String, String)
            = ws()* "[" ws()* text:$(fraction()) ws()* "]" ws()* {
                ("time".to_string(), text.to_string())
            }

        rule checkpoint() -> (String, String)
            = ws()* "*"+ ws()* {
                // The second value doesn't matter for this one :)
                ("checkpoint".to_string(), "(｡^‿^｡)".to_string())
            }

        rule voice() -> (String, String)
            = ws()* "%" ws()* text:$(name()) ws()* {
                ("voice".to_string(), text.to_string())
            }

        rule measure() -> (String, String)
            = ws()* "|" ws()* {
                // The second value doesn't matter for this one :)
                ("measure".to_string(), "(｡￣▽￣｡)θ～♪♪".to_string())
            }

        rule reset() -> (String, String)
            = ws()* ";" ws_not_newline()* (!['\n'][_])* eol() {
                // The second value doesn't matter for this one :)
                ("reset".to_string(), "ヽ(｡＾▽＾｡)ノ".to_string())
            }

        rule note() -> (String, String)
            = ws()*
            "(" ws()* note_name:$(name()) ws()+ length:$(fraction()) ws()* ")"
            dots:$("+"*) ws()* {
                (note_name.to_string(), format!("{}{}", length, dots).to_string())
            }

        rule name()
            = ['a'..='z' | 'A'..='Z' | '0'..='9' | '_']+

        rule fraction()
            = ['0'..='9' | '/']+

        rule number()
            = ['0'..='9']+

        rule ws()
            = " "
            / "-" // Special whitespace character allowed in hum scores
            / "\t"
            / "\r"
            / "\n"

        rule eol()
            = "\n"
            / ![_] // "End of file"

        rule ws_not_newline()
            = " "
            / "-" // Special whitespace character allowed in hum scores
            / "\t"
            / "\r"
    }
}