phonet 1.0.2

A CLI tool and library to validate phonotactic patterns for constructed languages
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

#[cfg(test)]
mod tests;

/// Split file into list of statements
pub(super) fn split_statements(file: &str) -> Vec<(String, usize)> {
    // Vector of statements
    // Multiline statements are treated as single line, with linebreaks removed
    let mut statements = vec![];

    // Building single line (and multiline, before '&' character)
    let mut build_line = String::new();
    // Building multiline, optional
    let mut build_multiline: Option<(String, usize)> = None;

    // Canon line number of statement
    // Multiline uses line number of beginning of statement
    let mut current_line_number = 1;

    // Current statement is a comment
    // Discard before pushing to list
    let mut is_comment = false;

    // Loop characters of file
    for ch in file.chars() {
        match ch {
            // Newline or semicolon without multiline
            '\n' | ';' if build_multiline.is_none() => {
                // Clear comment
                is_comment = false;

                // If single line is not empty
                if !build_line.is_empty() {
                    // Push single line to statement
                    statements.push((build_line, current_line_number));
                    // Reset single line
                    build_line = String::new();
                }
            }

            // Newline with multiline - Ignore
            '\n' => (),

            // Semicolon with multiline
            ';' => {
                // Clear comment
                is_comment = false;

                // Multiline is active
                // Unwrap should not fail due to above match guard
                let (multiline, number) = build_multiline.unwrap();

                // Add multiline to single line, without linebreaks
                build_line.push_str(&multiline);
                // Reset multiline
                build_multiline = None;

                // If single line (including multiline) is not empty
                // This mirrors the statement in arm of '\n' match, above
                if !build_line.is_empty() {
                    // Push single line to statement
                    statements.push((build_line, number));
                    // Reset single line
                    build_line = String::new();
                }
            }

            // Start multiline
            // Only if not a comment
            '&' if !is_comment => match &mut build_multiline {
                // Multiline is not already active
                None => {
                    // Start multiline, with current line number
                    build_multiline = Some((String::new(), current_line_number))
                }

                // Multiline is already active
                Some(_) => {
                    // Add '&' character to single line build
                    build_line.push(ch);
                }
            },

            // Comment at start of statement
            '#' if build_line.trim().is_empty() => {
                is_comment = true;
            }

            // Statement is a comment, ignore regular characters
            _ if is_comment => continue,

            // Add other character to single line build
            _ => build_line.push(ch),
        }

        // Increase canon line number
        if ch == '\n' {
            current_line_number += 1;
        }
    }

    // Get line number of statement
    let start_line_number = match build_multiline {
        // Multiline is not active - Use current line number (last line)
        None => current_line_number,
        // Multiline is active
        Some((multiline, number)) => {
            // Add multiline to single line, without linebreaks
            build_line.push_str(&multiline);
            // Use line number of beginning of statement
            number
        }
    };

    // If single line (including multiline) is not empty
    if !build_line.is_empty() {
        // Push single line to statement
        statements.push((build_line, start_line_number));
    }

    statements
}