v2 / vlib / v / parser / enum.v
364 lines · 351 sloc · 10.81 KB · 4fa8167abbaced0ea99afe662c6ee3a2e2700f40
Raw
1module parser
2
3import v.ast
4import v.token
5import v.util
6import strings
7
8struct EnumDeclFieldState {
9mut:
10 uses_exprs bool
11}
12
13fn (mut p Parser) enum_val_expr(mod string) ast.EnumVal {
14 // `Color.green`
15 mut enum_name := p.check_name()
16 enum_name_pos := p.prev_tok.pos()
17 if mod != '' {
18 enum_name = mod + '.' + enum_name
19 } else {
20 enum_name = p.imported_symbols[enum_name] or { p.prepend_mod(enum_name) }
21 }
22 p.check(.dot)
23 val := p.check_name()
24 p.expr_mod = ''
25 p.last_enum_name = enum_name
26 p.last_enum_mod = mod
27 return ast.EnumVal{
28 enum_name: enum_name
29 val: val
30 pos: enum_name_pos.extend(p.prev_tok.pos())
31 mod: mod
32 }
33}
34
35// `.green`
36// `pref.BuildMode.default_mode`
37fn (mut p Parser) enum_val() ast.EnumVal {
38 start_pos := p.tok.pos()
39 p.check(.dot)
40 val := p.check_name()
41 return ast.EnumVal{
42 val: val
43 pos: start_pos.extend(p.prev_tok.pos())
44 }
45}
46
47fn (mut p Parser) enum_decl_field(mut enum_attrs map[string][]ast.Attr, mut state EnumDeclFieldState) ast.EnumField {
48 pre_comments := p.eat_comments()
49 pos := p.tok.pos()
50 has_prev_newline := p.has_prev_newline()
51 has_break_line := has_prev_newline || p.has_prev_line_comment_or_label()
52 val := p.check_name()
53 mut expr := ast.empty_expr
54 mut has_expr := false
55 if p.tok.kind == .assign {
56 p.next()
57 old_assign_rhs := p.inside_assign_rhs
58 p.inside_assign_rhs = true
59 expr = p.expr(0)
60 p.inside_assign_rhs = old_assign_rhs
61 has_expr = true
62 state.uses_exprs = true
63 }
64 mut attrs := []ast.Attr{}
65 if p.tok.kind == .lsbr || p.tok.kind == .at {
66 p.attributes()
67 attrs << p.attrs
68 enum_attrs[val] = attrs
69 p.attrs = []
70 }
71 comments := p.eat_comments(same_line: true)
72 next_comments := p.eat_comments(follow_up: true)
73 return ast.EnumField{
74 name: val
75 source_name: source_name(val)
76 pos: pos
77 expr: expr
78 has_expr: has_expr
79 has_prev_newline: has_prev_newline
80 has_break_line: has_break_line
81 pre_comments: pre_comments
82 comments: comments
83 next_comments: next_comments
84 attrs: attrs
85 }
86}
87
88fn (mut p Parser) enum_decl_fields(mut vals []string, mut fields []ast.EnumField, mut enum_attrs map[string][]ast.Attr, mut state EnumDeclFieldState) {
89 for p.tok.kind != .eof && p.tok.kind != .rcbr {
90 if p.tok.kind == .dollar && p.peek_tok.kind == .key_if {
91 p.enum_decl_comptime_fields(mut vals, mut fields, mut enum_attrs, mut state)
92 continue
93 }
94 field := p.enum_decl_field(mut enum_attrs, mut state)
95 if field.name == '' {
96 return
97 }
98 vals << field.name
99 fields << field
100 }
101}
102
103fn (mut p Parser) enum_decl_comptime_fields(mut vals []string, mut fields []ast.EnumField, mut enum_attrs map[string][]ast.Attr, mut state EnumDeclFieldState) {
104 p.check(.dollar)
105 mut has_true_branch := false
106 for {
107 if p.tok.kind == .key_else {
108 p.check(.key_else)
109 if p.tok.kind == .lcbr {
110 if has_true_branch {
111 p.skip_scope()
112 } else {
113 p.check(.lcbr)
114 p.enum_decl_fields(mut vals, mut fields, mut enum_attrs, mut state)
115 p.check(.rcbr)
116 }
117 break
118 }
119 p.check(.dollar)
120 }
121 old_inside_ct_if_expr := p.inside_ct_if_expr
122 p.inside_ct_if_expr = true
123 p.check(.key_if)
124 mut cond := p.expr(0)
125 p.inside_ct_if_expr = old_inside_ct_if_expr
126 is_true := p.comptime_if_cond(mut cond)
127 if is_true && !has_true_branch {
128 has_true_branch = true
129 p.check(.lcbr)
130 p.enum_decl_fields(mut vals, mut fields, mut enum_attrs, mut state)
131 p.check(.rcbr)
132 } else if p.tok.kind == .lcbr {
133 p.skip_scope()
134 } else {
135 p.check(.lcbr)
136 }
137 if p.tok.kind == .dollar && p.peek_tok.kind == .key_else {
138 p.check(.dollar)
139 continue
140 }
141 break
142 }
143}
144
145fn (mut p Parser) enum_decl() ast.EnumDecl {
146 p.top_level_statement_start()
147 is_pub := p.tok.kind == .key_pub
148 start_pos := p.tok.pos()
149 if is_pub {
150 p.next()
151 }
152 p.check(.key_enum)
153 end_pos := p.tok.pos()
154 mut comments_before_key_enum := if p.pref.is_vls {
155 p.cur_comments.clone()
156 } else {
157 []
158 }
159 if p.disallow_declarations_in_script_mode() {
160 return ast.EnumDecl{}
161 }
162 enum_name := p.check_name()
163 if enum_name.len == 0 {
164 p.error_with_pos('enum names can not be empty', end_pos)
165 return ast.EnumDecl{}
166 }
167 if enum_name.len == 1 {
168 p.error_with_pos('single letter capital names are reserved for generic template types.',
169 end_pos)
170 return ast.EnumDecl{}
171 }
172 if p.is_imported_symbol(enum_name) {
173 p.error_with_pos('cannot register enum `${enum_name}`, this type was already imported',
174 end_pos)
175 return ast.EnumDecl{}
176 }
177 name := p.prepend_mod(enum_name)
178 already_exists := if _ := p.table.enum_decls[name] { true } else { false }
179 mut enum_type := ast.int_type
180 mut typ_pos := token.Pos{}
181 if p.tok.kind == .key_as {
182 p.next()
183 typ_pos = p.tok.pos()
184 enum_type = p.parse_type()
185 }
186 mut enum_decl_comments := p.eat_comments()
187 p.check(.lcbr)
188 enum_decl_comments << p.eat_comments()
189 senum_type := p.table.get_type_name(enum_type)
190 mut vals := []string{}
191 // mut default_exprs := []ast.Expr{}
192 mut fields := []ast.EnumField{}
193 mut state := EnumDeclFieldState{}
194 mut enum_attrs := map[string][]ast.Attr{}
195 p.enum_decl_fields(mut vals, mut fields, mut enum_attrs, mut state)
196 p.top_level_statement_end()
197 p.check(.rcbr)
198 is_flag := p.attrs.contains('flag')
199 is_typedef := p.attrs.contains('typedef')
200 is_multi_allowed := p.attrs.contains('_allow_multiple_values')
201 pubfn := if p.mod == 'main' { '@[flag_enum_fn] fn' } else { '@[flag_enum_fn] pub fn' }
202 if is_flag {
203 if fields.len > 64 {
204 p.error('when an enum is used as bit field, it must have a max of 64 fields')
205 return ast.EnumDecl{}
206 }
207 for f in fields {
208 if f.has_expr {
209 p.error_with_pos('when an enum is used as a bit field, you can not assign custom values',
210 f.pos)
211 return ast.EnumDecl{}
212 }
213 }
214 if !already_exists {
215 // enum already exists, skip method creation to avoid duplicate method errors
216 all_bits_set_value := '0b' + '1'.repeat(fields.len)
217 p.codegen('
218//
219@[inline] ${pubfn} ( e &${enum_name}) is_empty() bool { return ${senum_type}(*e) == 0 }
220@[inline] ${pubfn} ( e &${enum_name}) has(flag_ ${enum_name}) bool { return (${senum_type}(*e) & (${senum_type}(flag_))) != 0 }
221@[inline] ${pubfn} ( e &${enum_name}) all(flag_ ${enum_name}) bool { return (${senum_type}(*e) & (${senum_type}(flag_))) == ${senum_type}(flag_) }
222@[inline] ${pubfn} (mut e ${enum_name}) set(flag_ ${enum_name}) { unsafe{ *e = ${enum_name}(${senum_type}(*e) | (${senum_type}(flag_))) } }
223@[inline] ${pubfn} (mut e ${enum_name}) set_all() { unsafe{ *e = ${enum_name}(${all_bits_set_value}) } }
224@[inline] ${pubfn} (mut e ${enum_name}) clear(flag_ ${enum_name}) { unsafe{ *e = ${enum_name}(${senum_type}(*e) & ~(${senum_type}(flag_))) } }
225@[inline] ${pubfn} (mut e ${enum_name}) clear_all() { unsafe{ *e = ${enum_name}(0) } }
226@[inline] ${pubfn} (mut e ${enum_name}) toggle(flag_ ${enum_name}) { unsafe{ *e = ${enum_name}(${senum_type}(*e) ^ (${senum_type}(flag_))) } }
227//
228')
229 }
230 }
231 // Add the generic `Enum.from[T](x T) !T {` static method too:
232 mut isb := strings.new_builder(1024)
233 isb.write_string('\n')
234 if is_flag {
235 isb.write_string('@[inline] ${pubfn} ${enum_name}.zero() ${enum_name} {\n')
236 isb.write_string(' return unsafe{ ${enum_name}(0) }\n')
237 isb.write_string('}\n')
238 }
239 // TODO: see why changing `W` to `T` below, later fails with seemingly unrelated error
240 isb.write_string('${pubfn} ${enum_name}.from[W](input W) !${enum_name} {\n')
241 isb.write_string(' \$if input is \$int {\n')
242 isb.write_string(' val := unsafe{ ${enum_name}(input) }\n')
243 if is_flag {
244 isb.write_string(' if input == 0 { return val }\n')
245 all_bits_set_value := '0b' + '1'.repeat(fields.len)
246 isb.write_string(' if input & ~${all_bits_set_value} == 0 { return val }\n')
247 } else {
248 isb.write_string(' match val {\n')
249 for f in fields {
250 isb.write_string(' .${f.source_name} { return ${enum_name}.${f.source_name} }\n')
251 }
252 if is_flag {
253 isb.write_string(' else{}\n')
254 }
255 isb.write_string(' }\n')
256 }
257 isb.write_string(' }\n')
258 isb.write_string(' \$if input is \$string {\n')
259 isb.write_string(' val := input.str()\n') // TODO: this should not be needed, the `$if input is $string` above should have already smartcasted `input`
260 if is_flag {
261 isb.write_string(' if val == \'\' { return unsafe{ ${enum_name}(0) } }\n')
262 }
263 isb.write_string(' match val {\n')
264 for f in fields {
265 isb.write_string(' \'${f.name}\' { return ${enum_name}.${f.source_name} }\n')
266 }
267 isb.write_string(' else{}\n')
268 isb.write_string(' }\n')
269 isb.write_string(' }\n')
270 isb.write_string(" return error('invalid value')\n")
271 isb.write_string('}\n')
272 isb.write_string('\n')
273 code_for_from_fn := isb.str()
274 $if debug_enumcodegen ? {
275 if p.mod == 'main' {
276 dump(code_for_from_fn)
277 }
278 }
279 if enum_name[0].is_capital() && fields.len > 0 {
280 p.codegen(code_for_from_fn)
281 }
282
283 idx := p.table.register_sym(ast.TypeSymbol{
284 kind: .enum
285 name: name
286 cname: util.no_dots(name)
287 mod: p.mod
288 info: ast.Enum{
289 vals: vals
290 is_flag: is_flag
291 is_typedef: is_typedef
292 is_multi_allowed: is_multi_allowed
293 uses_exprs: state.uses_exprs
294 typ: enum_type
295 attrs: enum_attrs
296 }
297 is_pub: is_pub
298 })
299
300 if idx in [ast.string_type_idx, ast.rune_type_idx, ast.array_type_idx, ast.map_type_idx]
301 && !p.pref.is_fmt {
302 p.error_with_pos('cannot register enum `${name}`, another type with this name exists',
303 end_pos)
304 }
305
306 if idx == ast.invalid_type_idx {
307 enum_type = idx
308 }
309
310 enum_decl := ast.EnumDecl{
311 name: name
312 typ: enum_type
313 typ_pos: typ_pos
314 is_pub: is_pub
315 is_flag: is_flag
316 is_multi_allowed: is_multi_allowed
317 fields: fields
318 pos: start_pos.extend_with_last_line(end_pos, p.prev_tok.line_nr)
319 attrs: p.attrs
320 comments: enum_decl_comments
321 }
322
323 if !already_exists {
324 p.table.register_enum_decl(enum_decl)
325 if p.pref.is_vls {
326 key := 'enum_${name}'
327 mut has_decl_end_comment := false
328 if enum_decl.comments.len > 0
329 && enum_decl.comments[0].pos.line_nr == enum_decl.pos.line_nr {
330 // enum MyEnum { // MyEnum end_comment1
331 comments_before_key_enum << enum_decl.comments[0]
332 has_decl_end_comment = true
333 }
334 val := ast.VlsInfo{
335 pos: typ_pos
336 doc: p.keyword_comments_to_string(enum_name, comments_before_key_enum)
337 }
338 p.table.register_vls_info(key, val)
339 for i, f in fields {
340 f_key := 'enum_${name}.${f.name}'
341 f_val := if i == 0 {
342 first_field_pre_comment := if has_decl_end_comment {
343 enum_decl.comments[1..].clone()
344 } else {
345 enum_decl.comments
346 }
347 ast.VlsInfo{
348 pos: f.pos
349 doc: p.comments_to_string(first_field_pre_comment) +
350 p.comments_to_string(f.comments)
351 }
352 } else {
353 ast.VlsInfo{
354 pos: f.pos
355 doc: p.comments_to_string(fields[i - 1].next_comments) +
356 p.comments_to_string(f.comments)
357 }
358 }
359 p.table.register_vls_info(f_key, f_val)
360 }
361 }
362 }
363 return enum_decl
364}
365