sway_parse/
module.rs

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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
use crate::{Parse, ParseResult, ParseToEnd, Parser, ParserConsumed};

use sway_ast::{
    attribute::{Annotated, Attribute, AttributeArg, AttributeHashKind},
    brackets::SquareBrackets,
    keywords::{HashBangToken, Token},
    token::{DocComment, DocStyle},
    AttributeDecl, Module, ModuleKind, Parens, Punctuated,
};
use sway_error::parser_error::ParseErrorKind;
use sway_types::{constants::DOC_COMMENT_ATTRIBUTE_NAME, Ident};

impl Parse for ModuleKind {
    fn parse(parser: &mut Parser) -> ParseResult<Self> {
        if let Some(script_token) = parser.take() {
            Ok(Self::Script { script_token })
        } else if let Some(contract_token) = parser.take() {
            Ok(Self::Contract { contract_token })
        } else if let Some(predicate_token) = parser.take() {
            Ok(Self::Predicate { predicate_token })
        } else if let Some(library_token) = parser.take() {
            Ok(Self::Library { library_token })
        } else {
            Err(parser.emit_error(ParseErrorKind::ExpectedModuleKind))
        }
    }
}

impl ParseToEnd for Annotated<Module> {
    fn parse_to_end<'a, 'e>(mut parser: Parser<'a, '_>) -> ParseResult<(Self, ParserConsumed<'a>)> {
        // Parse the attribute list.
        let mut attribute_list = Vec::new();
        while let Some(DocComment { .. }) = parser.peek() {
            let doc_comment = parser.parse::<DocComment>()?;
            // TODO: Use a Literal instead of an Ident when Attribute args
            // start supporting them and remove `Ident::new_no_trim`.
            let name = Ident::new_no_trim(doc_comment.content_span.clone());
            match &doc_comment.doc_style {
                DocStyle::Inner => attribute_list.push(AttributeDecl {
                    hash_kind: AttributeHashKind::Inner(HashBangToken::new(
                        doc_comment.span.clone(),
                    )),
                    attribute: SquareBrackets::new(
                        Punctuated::single(Attribute {
                            name: Ident::new_with_override(
                                DOC_COMMENT_ATTRIBUTE_NAME.to_string(),
                                doc_comment.span.clone(),
                            ),
                            args: Some(Parens::new(
                                Punctuated::single(AttributeArg { name, value: None }),
                                doc_comment.content_span,
                            )),
                        }),
                        doc_comment.span,
                    ),
                }),
                DocStyle::Outer => {
                    parser.emit_error(ParseErrorKind::ExpectedModuleDocComment);
                }
            }
        }
        let (kind, semicolon_token) = parser.parse()?;
        let (items, consumed) = parser.parse_to_end()?;
        let module = Annotated {
            attribute_list,
            value: Module {
                kind,
                semicolon_token,
                items,
            },
        };
        Ok((module, consumed))
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::test_utils::parse_to_end;
    use insta::*;

    #[test]
    fn parse_noop_script_module() {
        assert_ron_snapshot!(parse_to_end::<Annotated<Module>>(r#"
            script;
        
            fn main() {
                ()
            }
        "#,), @r#"
        Annotated(
          attribute_list: [],
          value: Module(
            kind: Script(
              script_token: ScriptToken(
                span: Span(
                  src: "\n            script;\n        \n            fn main() {\n                ()\n            }\n        ",
                  start: 13,
                  end: 19,
                  source_id: None,
                ),
              ),
            ),
            semicolon_token: SemicolonToken(
              span: Span(
                src: "\n            script;\n        \n            fn main() {\n                ()\n            }\n        ",
                start: 19,
                end: 20,
                source_id: None,
              ),
            ),
            items: [
              Annotated(
                attribute_list: [],
                value: Fn(ItemFn(
                  fn_signature: FnSignature(
                    visibility: None,
                    fn_token: FnToken(
                      span: Span(
                        src: "\n            script;\n        \n            fn main() {\n                ()\n            }\n        ",
                        start: 42,
                        end: 44,
                        source_id: None,
                      ),
                    ),
                    name: BaseIdent(
                      name_override_opt: None,
                      span: Span(
                        src: "\n            script;\n        \n            fn main() {\n                ()\n            }\n        ",
                        start: 45,
                        end: 49,
                        source_id: None,
                      ),
                      is_raw_ident: false,
                    ),
                    generics: None,
                    arguments: Parens(
                      inner: Static(Punctuated(
                        value_separator_pairs: [],
                        final_value_opt: None,
                      )),
                      span: Span(
                        src: "\n            script;\n        \n            fn main() {\n                ()\n            }\n        ",
                        start: 49,
                        end: 51,
                        source_id: None,
                      ),
                    ),
                    return_type_opt: None,
                    where_clause_opt: None,
                  ),
                  body: Braces(
                    inner: CodeBlockContents(
                      statements: [],
                      final_expr_opt: Some(Tuple(Parens(
                        inner: Nil,
                        span: Span(
                          src: "\n            script;\n        \n            fn main() {\n                ()\n            }\n        ",
                          start: 70,
                          end: 72,
                          source_id: None,
                        ),
                      ))),
                      span: Span(
                        src: "\n            script;\n        \n            fn main() {\n                ()\n            }\n        ",
                        start: 53,
                        end: 85,
                        source_id: None,
                      ),
                    ),
                    span: Span(
                      src: "\n            script;\n        \n            fn main() {\n                ()\n            }\n        ",
                      start: 52,
                      end: 86,
                      source_id: None,
                    ),
                  ),
                )),
              ),
            ],
          ),
        )
        "#);
    }
}