solar-parse 0.1.8

Solidity and Yul lexer and parser
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
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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223

use super::*;
use snapbox::{IntoData, str};
use std::fmt::Write;

fn check(src: &str, data: impl IntoData) {
    let mut actual = String::new();
    for token in Cursor::new(src) {
        writeln!(actual, "{token:?}").unwrap();
    }
    snapbox::assert_data_eq!(actual.trim(), data);
}

#[test]
fn smoke_test() {
    check(
        "/* my source file */ fn main() { print(\"zebra\"); }\n",
        str![[r#"
RawToken { kind: BlockComment { is_doc: false, terminated: true }, len: 20 }
RawToken { kind: Whitespace, len: 1 }
RawToken { kind: Ident, len: 2 }
RawToken { kind: Whitespace, len: 1 }
RawToken { kind: Ident, len: 4 }
RawToken { kind: OpenDelim(Parenthesis), len: 1 }
RawToken { kind: CloseDelim(Parenthesis), len: 1 }
RawToken { kind: Whitespace, len: 1 }
RawToken { kind: OpenDelim(Brace), len: 1 }
RawToken { kind: Whitespace, len: 1 }
RawToken { kind: Ident, len: 5 }
RawToken { kind: OpenDelim(Parenthesis), len: 1 }
RawToken { kind: Literal { kind: Str { kind: Str, terminated: true } }, len: 7 }
RawToken { kind: CloseDelim(Parenthesis), len: 1 }
RawToken { kind: Semi, len: 1 }
RawToken { kind: Whitespace, len: 1 }
RawToken { kind: CloseDelim(Brace), len: 1 }
RawToken { kind: Whitespace, len: 1 }
"#]],
    );
}

#[test]
fn comment_flavors() {
    check(
        r"
// line
//// line as well
/// doc line
/* block */
/**/
/*** also block */
/** doc block */
",
        str![[r#"
RawToken { kind: Whitespace, len: 1 }
RawToken { kind: LineComment { is_doc: false }, len: 7 }
RawToken { kind: Whitespace, len: 1 }
RawToken { kind: LineComment { is_doc: false }, len: 17 }
RawToken { kind: Whitespace, len: 1 }
RawToken { kind: LineComment { is_doc: true }, len: 12 }
RawToken { kind: Whitespace, len: 1 }
RawToken { kind: BlockComment { is_doc: false, terminated: true }, len: 11 }
RawToken { kind: Whitespace, len: 1 }
RawToken { kind: BlockComment { is_doc: false, terminated: true }, len: 4 }
RawToken { kind: Whitespace, len: 1 }
RawToken { kind: BlockComment { is_doc: false, terminated: true }, len: 18 }
RawToken { kind: Whitespace, len: 1 }
RawToken { kind: BlockComment { is_doc: true, terminated: true }, len: 16 }
RawToken { kind: Whitespace, len: 1 }
"#]],
    )
}

#[test]
fn single_str() {
    check(
        "'a' ' ' '\\n'",
        str![[r#"
RawToken { kind: Literal { kind: Str { kind: Str, terminated: true } }, len: 3 }
RawToken { kind: Whitespace, len: 1 }
RawToken { kind: Literal { kind: Str { kind: Str, terminated: true } }, len: 3 }
RawToken { kind: Whitespace, len: 1 }
RawToken { kind: Literal { kind: Str { kind: Str, terminated: true } }, len: 4 }
"#]],
    );
}

#[test]
fn double_str() {
    check(
        r#""a" " " "\n""#,
        str![[r#"
RawToken { kind: Literal { kind: Str { kind: Str, terminated: true } }, len: 3 }
RawToken { kind: Whitespace, len: 1 }
RawToken { kind: Literal { kind: Str { kind: Str, terminated: true } }, len: 3 }
RawToken { kind: Whitespace, len: 1 }
RawToken { kind: Literal { kind: Str { kind: Str, terminated: true } }, len: 4 }
"#]],
    );
}

#[test]
fn hex_str() {
    check(
        r#"hex'' hex"ab" h"a" he"a"#,
        str![[r#"
RawToken { kind: Literal { kind: Str { kind: Hex, terminated: true } }, len: 5 }
RawToken { kind: Whitespace, len: 1 }
RawToken { kind: Literal { kind: Str { kind: Hex, terminated: true } }, len: 7 }
RawToken { kind: Whitespace, len: 1 }
RawToken { kind: Ident, len: 1 }
RawToken { kind: Literal { kind: Str { kind: Str, terminated: true } }, len: 3 }
RawToken { kind: Whitespace, len: 1 }
RawToken { kind: Ident, len: 2 }
RawToken { kind: Literal { kind: Str { kind: Str, terminated: false } }, len: 2 }
"#]],
    );
}

#[test]
fn unicode_str() {
    check(
        r#"unicode'' unicode"ab" u"a" uni"a"#,
        str![[r#"
RawToken { kind: Literal { kind: Str { kind: Unicode, terminated: true } }, len: 9 }
RawToken { kind: Whitespace, len: 1 }
RawToken { kind: Literal { kind: Str { kind: Unicode, terminated: true } }, len: 11 }
RawToken { kind: Whitespace, len: 1 }
RawToken { kind: Ident, len: 1 }
RawToken { kind: Literal { kind: Str { kind: Str, terminated: true } }, len: 3 }
RawToken { kind: Whitespace, len: 1 }
RawToken { kind: Ident, len: 3 }
RawToken { kind: Literal { kind: Str { kind: Str, terminated: false } }, len: 2 }
"#]],
    );
}

#[test]
fn random_unicode() {
    check(
        r#"
è

"è"
hex"è"
unicode"è"

'è'
hex'è'
unicode'è'

hex👀
unicode👀

//è
/*è */

///è
/**è */

.è
0.è
1.eè
1.e1è
"#,
        str![[r#"
RawToken { kind: Whitespace, len: 1 }
RawToken { kind: Unknown, len: 2 }
RawToken { kind: Whitespace, len: 2 }
RawToken { kind: Literal { kind: Str { kind: Str, terminated: true } }, len: 4 }
RawToken { kind: Whitespace, len: 1 }
RawToken { kind: Literal { kind: Str { kind: Hex, terminated: true } }, len: 7 }
RawToken { kind: Whitespace, len: 1 }
RawToken { kind: Literal { kind: Str { kind: Unicode, terminated: true } }, len: 11 }
RawToken { kind: Whitespace, len: 2 }
RawToken { kind: Literal { kind: Str { kind: Str, terminated: true } }, len: 4 }
RawToken { kind: Whitespace, len: 1 }
RawToken { kind: Literal { kind: Str { kind: Hex, terminated: true } }, len: 7 }
RawToken { kind: Whitespace, len: 1 }
RawToken { kind: Literal { kind: Str { kind: Unicode, terminated: true } }, len: 11 }
RawToken { kind: Whitespace, len: 2 }
RawToken { kind: Ident, len: 3 }
RawToken { kind: Unknown, len: 4 }
RawToken { kind: Whitespace, len: 1 }
RawToken { kind: Ident, len: 7 }
RawToken { kind: Unknown, len: 4 }
RawToken { kind: Whitespace, len: 2 }
RawToken { kind: LineComment { is_doc: false }, len: 4 }
RawToken { kind: Whitespace, len: 1 }
RawToken { kind: BlockComment { is_doc: false, terminated: true }, len: 7 }
RawToken { kind: Whitespace, len: 2 }
RawToken { kind: LineComment { is_doc: true }, len: 5 }
RawToken { kind: Whitespace, len: 1 }
RawToken { kind: BlockComment { is_doc: true, terminated: true }, len: 8 }
RawToken { kind: Whitespace, len: 2 }
RawToken { kind: Dot, len: 1 }
RawToken { kind: Unknown, len: 2 }
RawToken { kind: Whitespace, len: 1 }
RawToken { kind: Literal { kind: Rational { base: Decimal, empty_exponent: false } }, len: 2 }
RawToken { kind: Unknown, len: 2 }
RawToken { kind: Whitespace, len: 1 }
RawToken { kind: Literal { kind: Int { base: Decimal, empty_int: false } }, len: 1 }
RawToken { kind: Dot, len: 1 }
RawToken { kind: Ident, len: 1 }
RawToken { kind: Unknown, len: 2 }
RawToken { kind: Whitespace, len: 1 }
RawToken { kind: Literal { kind: Int { base: Decimal, empty_int: false } }, len: 1 }
RawToken { kind: Dot, len: 1 }
RawToken { kind: Ident, len: 2 }
RawToken { kind: Unknown, len: 2 }
RawToken { kind: Whitespace, len: 1 }
"#]],
    );
}

#[test]
fn windows_line_ending() {
    check(
        "/// doc line\r\n",
        str![[r#"
RawToken { kind: LineComment { is_doc: true }, len: 12 }
RawToken { kind: Whitespace, len: 2 }
"#]],
    );
}