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
// Copyright (C) 2019-2022 Aleo Systems Inc.
// This file is part of the snarkVM library.

// The snarkVM library 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.

// The snarkVM library 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 the snarkVM library. If not, see <https://www.gnu.org/licenses/>.

use super::*;

impl<N: Network> Parser for Finalize<N> {
    /// Parses a string into finalize.
    #[inline]
    fn parse(string: &str) -> ParserResult<Self> {
        // Parse the whitespace and comments from the string.
        let (string, _) = Sanitizer::parse(string)?;
        // Parse the 'finalize' keyword from the string.
        let (string, _) = tag(Self::type_name())(string)?;
        // Parse the whitespace from the string.
        let (string, _) = Sanitizer::parse_whitespaces(string)?;
        // Parse the associated function name from the string.
        let (string, name) = Identifier::<N>::parse(string)?;
        // Parse the whitespace from the string.
        let (string, _) = Sanitizer::parse_whitespaces(string)?;
        // Parse the colon ':' keyword from the string.
        let (string, _) = tag(":")(string)?;

        // Parse the inputs from the string.
        let (string, inputs) = many0(Input::parse)(string)?;
        // Parse the commands from the string.
        let (string, commands) = many1(Command::parse)(string)?;
        // Parse the outputs from the string.
        let (string, outputs) = many0(Output::parse)(string)?;

        map_res(take(0usize), move |_| {
            // Initialize a new finalize.
            let mut finalize = Self::new(name);
            if let Err(error) = inputs.iter().cloned().try_for_each(|input| finalize.add_input(input)) {
                eprintln!("{error}");
                return Err(error);
            }
            if let Err(error) = commands.iter().cloned().try_for_each(|command| finalize.add_command(command)) {
                eprintln!("{error}");
                return Err(error);
            }
            if let Err(error) = outputs.iter().cloned().try_for_each(|output| finalize.add_output(output)) {
                eprintln!("{error}");
                return Err(error);
            }
            Ok::<_, Error>(finalize)
        })(string)
    }
}

impl<N: Network> FromStr for Finalize<N> {
    type Err = Error;

    /// Returns a finalize from a string literal.
    fn from_str(string: &str) -> Result<Self> {
        match Self::parse(string) {
            Ok((remainder, object)) => {
                // Ensure the remainder is empty.
                ensure!(remainder.is_empty(), "Failed to parse string. Found invalid character in: \"{remainder}\"");
                // Return the object.
                Ok(object)
            }
            Err(error) => bail!("Failed to parse string. {error}"),
        }
    }
}

impl<N: Network> Debug for Finalize<N> {
    /// Prints the finalize as a string.
    fn fmt(&self, f: &mut Formatter) -> fmt::Result {
        Display::fmt(self, f)
    }
}

impl<N: Network> Display for Finalize<N> {
    /// Prints the finalize as a string.
    fn fmt(&self, f: &mut Formatter) -> fmt::Result {
        // Write the finalize to a string.
        write!(f, "{} {}:", Self::type_name(), self.name)?;
        self.inputs.iter().try_for_each(|input| write!(f, "\n    {input}"))?;
        self.commands.iter().try_for_each(|command| write!(f, "\n    {command}"))?;
        self.outputs.iter().try_for_each(|output| write!(f, "\n    {output}"))
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use console::network::Testnet3;

    type CurrentNetwork = Testnet3;

    #[test]
    fn test_finalize_parse() {
        let finalize = Finalize::<CurrentNetwork>::parse(
            r"
finalize foo:
    input r0 as field.public;
    input r1 as field.public;
    add r0 r1 into r2;
    output r2 as field.public;",
        )
        .unwrap()
        .1;
        assert_eq!("foo", finalize.name().to_string());
        assert_eq!(2, finalize.inputs.len());
        assert_eq!(1, finalize.commands.len());
        assert_eq!(1, finalize.outputs.len());

        // Finalize with 0 inputs.
        let finalize = Finalize::<CurrentNetwork>::parse(
            r"
finalize foo:
    add 1u32 2u32 into r0;
    output r0 as u32.public;",
        )
        .unwrap()
        .1;
        assert_eq!("foo", finalize.name().to_string());
        assert_eq!(0, finalize.inputs.len());
        assert_eq!(1, finalize.commands.len());
        assert_eq!(1, finalize.outputs.len());
    }

    #[test]
    fn test_finalize_parse_cast() {
        let finalize = Finalize::<CurrentNetwork>::parse(
            r"
finalize foo:
    input r0 as token.record;
    cast r0.owner r0.gates r0.token_amount into r1 as token.record;
    output r1 as token.record;",
        )
        .unwrap()
        .1;
        assert_eq!("foo", finalize.name().to_string());
        assert_eq!(1, finalize.inputs.len());
        assert_eq!(1, finalize.commands.len());
        assert_eq!(1, finalize.outputs.len());
    }

    #[test]
    fn test_finalize_display() {
        let expected = r"finalize foo:
    input r0 as field.public;
    input r1 as field.public;
    add r0 r1 into r2;
    output r2 as field.public;";
        let finalize = Finalize::<CurrentNetwork>::parse(expected).unwrap().1;
        assert_eq!(expected, format!("{finalize}"),);
    }
}