f3b35eac313052989b0211d7f2b3623aa8102846
[nit.git] / src / astbuilder.nit
1 # This file is part of NIT ( http://www.nitlanguage.org ).
2 #
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
6 #
7 # http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
14
15 # Instantiation and transformation of semantic nodes in the AST of expressions and statements
16 module astbuilder
17
18 intrude import semantize::typing
19 intrude import literal
20 intrude import parser
21 intrude import semantize::scope
22 intrude import modelbuilder_base
23 intrude import modelize_property
24
25 # General factory to build semantic nodes in the AST of expressions
26 class ASTBuilder
27 # The module used as reference for the building
28 # It is used to gather types and other stuff
29 var mmodule: MModule
30
31 # The anchor used for some mechanism relying on types
32 var anchor: nullable MClassType
33
34 # Check mmodule to avoid a new instantiation of ASTBuilder
35 fun check_mmodule(mmodule: MModule)
36 do
37 if self.mmodule != mmodule then self.mmodule = mmodule
38 end
39
40 # Make a new Int literal
41 fun make_int(value: Int): AIntegerExpr
42 do
43 return new AIntegerExpr.make(value, mmodule.int_type)
44 end
45
46 # Make a new instantiation
47 fun make_new(callsite: CallSite, args: nullable Array[AExpr]): ANewExpr
48 do
49 return new ANewExpr.make(callsite, args)
50 end
51
52 # Make a new message send
53 fun make_call(recv: AExpr, callsite: CallSite, args: nullable Array[AExpr]): ACallExpr
54 do
55 return new ACallExpr.make(recv, callsite, args)
56 end
57
58 # Make a new, empty, sequence of statements
59 fun make_block: ABlockExpr
60 do
61 return new ABlockExpr.make
62 end
63
64 # Make a new, empty, loop of statements
65 fun make_loop: ALoopExpr
66 do
67 return new ALoopExpr.make
68 end
69
70 # Make a new variable read
71 fun make_var_read(variable: Variable, mtype: MType): AVarExpr
72 do
73 return new AVarExpr.make(variable, mtype)
74 end
75
76 # Make a new variable assignment
77 fun make_var_assign(variable: Variable, value: AExpr): AVarAssignExpr
78 do
79 return new AVarAssignExpr.make(variable, value)
80 end
81
82 # Make a new attribute read
83 fun make_attr_read(recv: AExpr, attribute: MAttribute): AAttrExpr
84 do
85 var mtype = attribute.intro.static_mtype.resolve_for(recv.mtype.as(not null), anchor, mmodule, true)
86 return new AAttrExpr.make(recv, attribute, mtype)
87 end
88
89 # Make a new attribute assignment
90 fun make_attr_assign(recv: AExpr, attribute: MAttribute, value: AExpr): AAttrAssignExpr
91 do
92 return new AAttrAssignExpr.make(recv, attribute, value)
93 end
94
95 # Make a new escapable block
96 fun make_do: ADoExpr
97 do
98 return new ADoExpr.make
99 end
100
101 # Make a new break for a given escapemark
102 fun make_break(escapemark: EscapeMark): ABreakExpr
103 do
104 return new ABreakExpr.make(escapemark)
105 end
106
107 # Make a new conditional
108 # `mtype` is the return type of the whole if, in case of a ternary operator.
109 fun make_if(condition: AExpr, mtype: nullable MType): AIfExpr
110 do
111 return new AIfExpr.make(condition, mtype)
112 end
113
114 # Make a new assert
115 fun make_assert(n_id : nullable TId , n_expr : AExpr , n_else : nullable AExpr): AAssertExpr
116 do
117 return new AAssertExpr.make(n_id , n_expr , n_else)
118 end
119
120 # Make a new method
121 fun make_method(n_visibility: nullable AVisibility,
122 tk_redef: nullable TKwredef,
123 mmethoddef: nullable MMethodDef,
124 n_signature: nullable ASignature,
125 n_annotations: nullable AAnnotations,
126 n_extern_calls: nullable AExternCalls,
127 n_extern_code_block: nullable AExternCodeBlock,
128 n_block: nullable AExpr): AMethPropdef
129 do
130 return new AMethPropdef.make(n_visibility, tk_redef, mmethoddef, n_signature, n_annotations, n_extern_calls, n_extern_code_block, n_block)
131 end
132
133 # Make a new or with two expr
134 fun make_or(right_expr: AExpr, left_expr: AExpr): AOrExpr
135 do
136 return new AOrExpr.make(right_expr,left_expr)
137 end
138
139 # Make a new and with two expr
140 fun make_and(right_expr: AExpr, left_expr: AExpr): AAndExpr
141 do
142 return new AAndExpr.make(right_expr,left_expr)
143 end
144
145 # Make a new parenthesis expr
146 fun make_parenthesis(expr: AExpr, annotations: nullable AAnnotations): AParExpr
147 do
148 return new AParExpr.make(expr,annotations)
149 end
150
151 # Make a new message super
152 fun make_super_call(args: nullable Array[AExpr], n_qualified: nullable AQualified): ASuperExpr
153 do
154 return new ASuperExpr.make(args,n_qualified)
155 end
156
157 # Make a new return
158 fun make_return(expr: nullable AExpr): AReturnExpr
159 do
160 return new AReturnExpr.make(expr)
161 end
162
163 # Make a new not
164 fun make_not(expr: AExpr): ANotExpr
165 do
166 return new ANotExpr.make(expr)
167 end
168
169 # Make a new attribute
170 fun make_attribute(name: String,
171 n_type: nullable AType,
172 n_visibility: nullable AVisibility,
173 initial_value: nullable AExpr,
174 n_block: nullable AExpr,
175 m_attributedef: nullable MAttributeDef,
176 m_setterdef: nullable MMethodDef,
177 m_getterdef: nullable MMethodDef): AAttrPropdef
178 do
179 return new AAttrPropdef.make(name, n_type, n_visibility, initial_value, n_block, m_attributedef, m_setterdef, m_getterdef)
180 end
181
182 # Make a new class (AStdClassdef)
183 fun make_class(mclassdef: nullable MClassDef,
184 n_visibility: nullable AVisibility,
185 n_formaldefs : Collection[AFormaldef],
186 n_extern_code_block : nullable AExternCodeBlock,
187 n_propdefs : Collection[APropdef],
188 n_classkind: nullable AClasskind): AStdClassdef
189 do
190 return new AStdClassdef.make(mclassdef, n_visibility, n_formaldefs, n_extern_code_block, n_propdefs, n_classkind)
191 end
192
193 fun make_var(variable: Variable, mtype: MType): AVarExpr
194 do
195 return new AVarExpr.make(variable, mtype)
196 end
197
198 # Make a call assignment i.e `a = 10`
199 fun make_call_assign(recv: AExpr, callsite: CallSite, n_args: nullable Collection[AExpr], n_value: AExpr): ACallAssignExpr
200 do
201 return new ACallAssignExpr.make(recv, callsite, n_args, n_value)
202 end
203
204 # Build a callsite to call the `mproperty` in the current method `caller_method`.
205 # `is_self_call` indicate if the method caller is a property of `self`
206 fun create_callsite(modelbuilder: ModelBuilder, caller_method : AMethPropdef, mproperty: MMethod, is_self_call: Bool): CallSite
207 do
208 # FIXME It's not the better solution to call `TypeVisitor` here to build a model entity, but some make need to have a callsite
209 var type_visitor = new TypeVisitor(modelbuilder, caller_method.mpropdef.as(not null))
210 var callsite = type_visitor.build_callsite_by_property(caller_method, mproperty.intro_mclassdef.bound_mtype, mproperty, is_self_call)
211 assert callsite != null
212 return callsite
213 end
214 end
215
216 redef class AExpr
217 # Return a new variable read that contains the value of the expression
218 # This method take care efficiently of creating and initalising an anonymous local variable
219 #
220 # Note: since this method do side-effects (AST replacement), there could be unexpected effects when used as
221 # argument of other methods related to AST transformations.
222 fun make_var_read: AVarExpr
223 do
224 var variable = self.variable_cache
225 if variable == null then
226 assert parent != null
227 var place = detach_with_placeholder
228 variable = new Variable("")
229 variable.declared_type = self.mtype
230 var nvar = new AVarAssignExpr.make(variable, self)
231 place.replace_with(nvar)
232 self.variable_cache = variable
233 end
234 return new AVarExpr.make(variable, variable.declared_type.as(not null))
235 end
236
237 private var variable_cache: nullable Variable
238
239 # The `detach` method completely remove the node in the parent.
240 # However, sometime, it is useful to keep the emplacement of the removed child.
241 #
242 # The standard use case is the insertion of a node between a parent `p` and a child `p.c`.
243 # To create the new node `n`, we need to attach the child to it.
244 # But, to put `n` where `c` was in `p`, the place has to be remembered.
245 #
246 # ~~~nitish
247 # var p: AExpr
248 # var c = p.c
249 # var h = c.detach_with_placeholder
250 # var n = astbuilder.make_XXX(c)
251 # h.replace_with(n)
252 # ~~~
253 fun detach_with_placeholder: AExpr
254 do
255 var h = new APlaceholderExpr.make
256 self.replace_with(h)
257 return h
258 end
259
260
261 # Add `expr` at the end of the block
262 #
263 # REQUIRE: self isa ABlockExpr
264 #
265 # Note: this method, aimed to `ABlockExpr` is promoted to `AExpr` because of the limitations of the hierarchies generated by sablecc3
266 fun add(expr: AExpr)
267 do
268 print "add not implemented in {inspect}"
269 abort
270 end
271
272 redef fun accept_ast_validation(v)
273 do
274 super
275 if mtype == null and not is_typed then
276 #debug "TYPING: untyped expression"
277 end
278 end
279 end
280
281 # A placeholder for a `AExpr` node
282 # Instances are transiantly used to mark some specific emplacements in the AST
283 # during complex transformations.
284 #
285 # Their must not appear in a valid AST
286 #
287 # @see AExpr::detach_with_placeholder
288 class APlaceholderExpr
289 super AExpr
290 private init make
291 do
292 end
293
294 redef fun accept_ast_validation(v)
295 do
296 super
297 debug "PARENT: remaining placeholder"
298 end
299 end
300
301 redef class ACallAssignExpr
302 private init make(recv: AExpr, callsite: CallSite, args: nullable Collection[AExpr], n_value: AExpr)
303 do
304 _callsite = callsite
305 _mtype = callsite.recv
306 _is_typed = true
307 var n_args = new AListExprs
308 if args != null then
309 n_args.n_exprs.add_all(args)
310 end
311 var n_qid = new AQid
312 n_qid.n_id = new TId
313 n_qid.n_id.text = callsite.mproperty.name
314 init_acallassignexpr(recv, n_qid, n_args, new TAssign, n_value)
315 end
316 end
317
318 redef class AStdClassdef
319 private init make(mclassdef: nullable MClassDef,
320 n_visibility: nullable AVisibility,
321 n_formaldefs : Collection[Object],
322 n_extern_code_block : nullable AExternCodeBlock,
323 n_propdefs : Collection[Object],
324 n_classkind: nullable AClasskind)
325 do
326 if n_visibility == null then n_visibility = new APublicVisibility
327 if n_classkind == null then n_classkind = new AConcreteClasskind.init_aconcreteclasskind(new TKwclass)
328 var n_qid = new AQclassid.init_aqclassid(null, new TClassid)
329 init_astdclassdef(null, null, n_visibility, n_classkind, n_qid, null, n_formaldefs, null, n_extern_code_block, n_propdefs, new TKwend)
330 _mclassdef = mclassdef
331 _mclass = mclassdef.mclass
332 end
333 end
334
335 redef class AAttrPropdef
336
337 # Create a new `AAttrPropdef`
338 # Note: By default if the `AVisibility` is not given the visibility is set to public
339 private init make(name: String,
340 n_type: nullable AType,
341 n_visibility: nullable AVisibility,
342 initial_value: nullable AExpr,
343 n_block: nullable AExpr,
344 m_attributedef: nullable MAttributeDef,
345 m_setterdef: nullable MMethodDef,
346 m_getterdef: nullable MMethodDef)
347 do
348 # Set the model type
349 if n_type != null then mtype = n_type.mtype
350 # Define the visibility default is public
351 if n_visibility == null then n_visibility = new APublicVisibility
352 init_aattrpropdef(null, null, n_visibility, new TKwvar, new TId, n_type, null, initial_value, null, null , n_block, null)
353 # Set the name of the attribute
354 _n_id2.text = name
355 _mpropdef = m_attributedef
356 _mreadpropdef = m_getterdef
357 _mwritepropdef = m_setterdef
358 if initial_value != null or n_block != null then has_value = true
359 if m_attributedef != null then self.location = m_attributedef.location
360 end
361 end
362
363 redef class ANotExpr
364 private init make(expr: AExpr)
365 do
366 self.init_anotexpr(new TKwnot, expr)
367 end
368 end
369
370 redef class AReturnExpr
371 private init make(expr: nullable AExpr)
372 do
373 self.init_areturnexpr(null, expr)
374 end
375 end
376
377 redef class ASuperExpr
378 private init make(args: nullable Array[AExpr], n_qualified: nullable AQualified, mpropdef: nullable MMethodDef)
379 do
380 var n_args = new AListExprs
381 if args != null then
382 n_args.n_exprs.add_all(args)
383 end
384 _mpropdef = mpropdef
385 self.init_asuperexpr(n_qualified, new TKwsuper, n_args)
386 end
387 end
388
389 redef class AOrExpr
390 private init make(right_expr: AExpr, left_expr: AExpr)
391 do
392 self.init_aorexpr(right_expr,new TKwor,left_expr)
393 end
394 end
395
396 redef class AAndExpr
397 private init make(right_expr: AExpr, left_expr: AExpr)
398 do
399 self.init_aandexpr(right_expr,new TKwand ,left_expr)
400 end
401 end
402
403 redef class AMethPropdef
404 private init make(n_visibility: nullable AVisibility,
405 tk_redef: nullable TKwredef,
406 mmethoddef: nullable MMethodDef,
407 n_signature: nullable ASignature,
408 n_annotations: nullable AAnnotations,
409 n_extern_calls: nullable AExternCalls,
410 n_extern_code_block: nullable AExternCodeBlock,
411 n_block: nullable AExpr)
412 do
413 var n_tid = new TId
414 var n_methid = new AIdMethid.init_aidmethid(n_tid)
415 if n_signature == null then n_signature = new ASignature
416 if n_visibility == null then n_visibility = new APublicVisibility
417 self.init_amethpropdef(null,tk_redef,n_visibility,new TKwmeth,null,null,null,n_methid,n_signature,n_annotations,n_extern_calls,n_extern_code_block,new TKwdo,n_block,new TKwend)
418 self.mpropdef = mmethoddef
419 if mpropdef != null then self.location = mmethoddef.location
420 end
421 end
422
423 redef class AAssertExpr
424 private init make(n_id : nullable TId , n_expr : nullable AExpr , n_else : nullable AExpr)
425 do
426 n_kwassert = new TKwassert
427 n_kwelse = null
428 if n_else != null then n_kwelse = new TKwelse
429 self.init_aassertexpr(n_kwassert, n_id , n_expr , n_kwelse , n_else)
430 end
431 end
432
433 redef class ALoopExpr
434 private init make
435 do
436 _n_kwloop = new TKwloop
437 self.is_typed = true
438 n_block = new ABlockExpr
439 n_block.is_typed = true
440 end
441
442 redef fun add(expr)
443 do
444 n_block.add expr
445 end
446 end
447
448 redef class ADoExpr
449 private init make
450 do
451 _n_kwdo = new TKwdo
452 self.is_typed = true
453 n_block = new ABlockExpr
454 n_block.is_typed = true
455 end
456
457 # Make a new break expression of the given do
458 fun make_break: ABreakExpr
459 do
460 var escapemark = self.break_mark
461 if escapemark == null then
462 escapemark = new EscapeMark(null)
463 self.break_mark = escapemark
464 end
465 return new ABreakExpr.make(escapemark)
466 end
467
468 redef fun add(expr)
469 do
470 n_block.add expr
471 end
472 end
473
474 redef class ABreakExpr
475 private init make(escapemark: EscapeMark)
476 do
477 _n_kwbreak = new TKwbreak
478 self.escapemark = escapemark
479 escapemark.escapes.add self
480 self.is_typed = true
481 end
482 end
483
484 redef class AIfExpr
485 private init make(condition: AExpr, mtype: nullable MType)
486 do
487 _n_kwif = new TKwif
488 _n_expr = condition
489 _n_expr.parent = self
490 _n_kwthen = new TKwthen
491 _n_then = new ABlockExpr.make
492 _n_kwelse = new TKwelse
493 _n_else = new ABlockExpr.make
494 self.mtype = mtype
495 if mtype != null then self.is_typed = true
496 end
497 end
498
499 redef class AType
500
501 private init make(t: nullable MType)
502 do
503 var n_id = new TClassid
504 var n_qid = new AQclassid
505 n_qid.n_id = n_id
506 _n_qid = n_qid
507 _mtype = t
508 end
509
510 redef fun clone: SELF
511 do
512 return new AType.make(mtype)
513 end
514 end
515
516 # Primitive type
517
518 redef class AIntegerExpr
519
520 private init make(value: nullable Numeric, t: nullable MType)
521 do
522 _mtype = t
523 if t != null then self.is_typed = true
524 _value = value
525 _n_integer = new TInteger # dummy
526 end
527
528 redef fun clone: SELF
529 do
530 return new AIntegerExpr.make(value, mtype)
531 end
532 end
533
534 redef class AFloatExpr
535
536 private init make(value: nullable Float, t: nullable MType)
537 do
538 _mtype = t
539 if t != null then self.is_typed = true
540 _value = value
541 _n_float = new TFloat # dummy
542 end
543
544 redef fun clone: SELF
545 do
546 return new AFloatExpr.make(value, mtype)
547 end
548 end
549
550 redef class ATrueExpr
551
552 private init make(t: nullable MType)
553 do
554 init_atrueexpr(new TKwtrue, null)
555 _mtype = t
556 if t != null then self.is_typed = true
557 end
558
559 redef fun clone: SELF
560 do
561 return new ATrueExpr.make(mtype)
562 end
563 end
564
565 redef class AFalseExpr
566
567 private init make(t: nullable MType)
568 do
569 init_afalseexpr(new TKwfalse, null)
570 _mtype = t
571 if t != null then self.is_typed = true
572 end
573
574 redef fun clone: SELF
575 do
576 return new AFalseExpr.make(mtype)
577 end
578 end
579
580 redef class ACharExpr
581
582 # `token_text` represent the real value as it's present in a file not only the char.
583 # `token_text` is needed if you want to use some methods (for exemple: `prefix`, `suffix` or `is_code_point methods`)
584 private init make(value: nullable Char, t: nullable MType, token_text: nullable String)
585 do
586 _value = value
587 _mtype = t
588 _n_char = new TChar
589 if token_text != null then n_char.text = token_text
590 if t != null then self.is_typed = true
591 end
592
593 redef fun clone: SELF
594 do
595 var self_clone = new ACharExpr.make(self.value, mtype, n_char.text)
596 return self_clone
597 end
598 end
599
600 redef class ANewExpr
601 private init make(callsite: CallSite, args: nullable Array[AExpr])
602 do
603 _n_kwnew = new TKwnew
604 _n_type = new AType.make
605 _n_args = new AListExprs
606 if args != null then
607 n_args.n_exprs.add_all(args)
608 end
609 self.callsite = callsite
610 self.recvtype = callsite.recv.as(MClassType)
611 if callsite.mproperty.is_new then
612 self.mtype = callsite.msignature.return_mtype
613 else
614 self.mtype = callsite.recv
615 end
616 self.is_typed = true
617 end
618 end
619
620 redef class ACallExpr
621 private init make(recv: AExpr, callsite: nullable CallSite, args: nullable Array[AExpr])
622 do
623 self._n_expr = recv
624 _n_args = new AListExprs
625 _n_qid = new AQid
626 _n_qid.n_id = new TId
627 _n_qid.n_id.text = callsite.mproperty.name
628 if args != null then
629 self.n_args.n_exprs.add_all(args)
630 end
631
632 if callsite != null then
633 self.callsite = callsite
634 self.mtype = callsite.msignature.return_mtype
635 self.is_typed = true
636 end
637 end
638 end
639
640 redef class AAsNotnullExpr
641 private init make(n_expr: AExpr, t: nullable MType)
642 do
643 init_aasnotnullexpr(n_expr, new TKwas, null, new TKwnot, new TKwnull, null)
644 _mtype = t
645 if t != null then _is_typed = true
646 end
647 end
648
649 redef class ANullExpr
650
651 private init make(t: nullable MType)
652 do
653 init_anullexpr(new TKwnull, null)
654 _mtype = t
655 if t != null then self.is_typed = true
656 end
657 end
658
659 redef class ASelfExpr
660
661 private init make(v: nullable Variable, t: nullable MType)
662 do
663 init_aselfexpr(new TKwself, null)
664 _mtype = t
665 if t != null then is_typed =true
666 end
667
668 redef fun clone: SELF
669 do
670 return new ASelfExpr.make(self.variable, self.mtype)
671 end
672 end
673
674 redef class AImplicitSelfExpr
675
676 redef fun clone: SELF
677 do
678 var self_clone = new AImplicitSelfExpr.make(variable, mtype)
679 self_clone.is_sys = is_sys
680 return self_clone
681 end
682 end
683
684
685 redef class AAttrExpr
686 private init make(recv: AExpr, attribute: nullable MAttribute, t: nullable MType)
687 do
688 _n_expr = recv
689 recv.parent = self
690 _n_id = new TAttrid
691 _mproperty = attribute
692 _mtype = t
693 if t != null then _is_typed = true
694 end
695 end
696
697 redef class AAttrAssignExpr
698 private init make(recv: AExpr, attribute: nullable MAttribute, value: AExpr)
699 do
700 _n_expr = recv
701 recv.parent = self
702 _n_id = new TAttrid
703 _n_value = value
704 value.parent = self
705 _n_assign = new TAssign
706 _mproperty = attribute
707 _mtype = value.mtype
708 end
709 end
710
711 redef class AVarExpr
712 private init make(v: nullable Variable, t: nullable MType)
713 do
714 _n_id = new TId
715 if v != null then _n_id.text = v.name
716 _variable = v
717 _mtype = t
718 if t != null then is_typed = true
719 end
720 end
721
722 redef class AVarAssignExpr
723 private init make(v: nullable Variable, value: AExpr)
724 do
725 _n_id = new TId
726 if v != null then _n_id.text = v.name
727 _n_value = value
728 value.parent = self
729 _n_assign = new TAssign
730 _variable = v
731 _mtype = value.mtype
732 if _mtype != null then _is_typed = true
733 end
734 end
735
736 redef class ASignature
737
738 init make_from_msignature(msignature: MSignature)
739 do
740 var nparams = new Array[AParam]
741 for mparam in msignature.mparameters do
742 var variable = new Variable(mparam.name)
743 variable.declared_type = mparam.mtype
744 n_params.add(new AParam.make(variable, new AType.make(mparam.mtype)))
745 end
746 var return_type = null
747 if msignature.return_mtype != null then return_type = new AType.make(msignature.return_mtype)
748 init_asignature(null, nparams, null, return_type)
749 end
750
751 redef fun clone: SELF
752 do
753 var ntype = n_type
754 if ntype != null then ntype = n_type.clone
755 return new ASignature.init_asignature(null, n_params.clone, null, ntype)
756 end
757 end
758
759 redef class AParam
760
761 private init make(v: nullable Variable, t: nullable AType)
762 do
763 _n_id = new TId
764 if v != null then _n_id.text = v.name
765 _variable = v
766 _n_type = t
767 end
768
769 redef fun clone: SELF
770 do
771 var ntype = n_type
772 if ntype != null then ntype = n_type.clone
773 return new AParam.make(variable, ntype)
774 end
775 end
776
777 redef class ABlockExpr
778 private init make(t: nullable MType)
779 do
780 if t != null then
781 _mtype = t
782 _is_typed = true
783 end
784 end
785
786 redef fun add(expr)
787 do
788 n_expr.add expr
789 expr.parent = self
790 end
791
792 fun add_all(exprs: Array[AExpr])
793 do
794 for expr in exprs do
795 add(expr)
796 end
797 end
798
799 redef fun clone: SELF
800 do
801 var clone = new ABlockExpr.make(mtype)
802 for expr in self.n_expr do
803 clone.add(expr.clone)
804 end
805 return clone
806 end
807 end
808
809 redef class AQclassid
810 redef fun clone: SELF
811 do
812 return new AQclassid.init_aqclassid(n_qualified.clone, n_id)
813 end
814 end
815
816 redef class AQualified
817 redef fun clone: SELF
818 do
819 return new AQualified.init_aqualified(n_id.clone, n_classid)
820 end
821 end
822
823 redef class AQid
824 redef fun clone: SELF
825 do
826 var clone_n_qualified = n_qualified
827 if n_qualified != null then clone_n_qualified = n_qualified.clone
828 return new AQid.init_aqid(clone_n_qualified, n_id.clone)
829 end
830 end
831
832 redef class TId
833 redef fun clone: SELF
834 do
835 return new TId.init_tk(location)
836 end
837 end
838
839 redef class AParExpr
840 private init make(expr: AExpr, annotations: nullable AAnnotations)
841 do
842 self.init_aparexpr(new TOpar, expr, new TCpar, annotations)
843 end
844 end
845
846 # Check the consitency of AST
847 class ASTValidationVisitor
848 super Visitor
849 redef fun visit(node)
850 do
851 node.accept_ast_validation(self)
852 end
853 private var path = new CircularArray[ANode]
854 private var seen = new HashSet[ANode]
855 end
856
857 redef class ANodes
858 super Cloneable
859
860 redef fun clone: SELF
861 do
862 var clone_anodes = new ANodes[E](self.parent)
863 for node in self do
864 clone_anodes.add(node.clone)
865 end
866 return clone_anodes
867 end
868 end
869
870 redef class ANode
871 super Cloneable
872
873 redef fun clone: SELF
874 do
875 # By default the clone abort to avoid surprises
876 print "The clone method is not implemented for the `{self.class_name}` class"
877 abort
878 end
879 # Recursively validate a AST node.
880 # This ensure that location and parenting are defined and coherent.
881 #
882 # After complex low-level AST manipulation and construction,
883 # it is recommended to call it.
884 #
885 # Note: this just instantiate and run an `ASTValidationVisitor`.
886 fun validate
887 do
888 (new ASTValidationVisitor).enter_visit(self)
889 end
890
891 private fun accept_ast_validation(v: ASTValidationVisitor)
892 do
893 var parent = self.parent
894 var path = v.path
895
896 if path.length > 0 then
897 var path_parent = v.path.first
898 if parent == null then
899 self.parent = path_parent
900 #debug "PARENT: expected parent: {path_parent}"
901 v.seen.add(self)
902 else if parent != path_parent then
903 self.parent = path_parent
904 if v.seen.has(self) then
905 debug "DUPLICATE (NOTATREE): already seen node with parent {parent} now with {path_parent}."
906 else
907 v.seen.add(self)
908 debug "PARENT: expected parent: {path_parent}, got {parent}"
909 end
910 end
911 end
912
913 if not isset _location then
914 #debug "LOCATION: unlocated node {v.path.join(", ")}"
915 _location = self.parent.location
916 end
917
918 path.unshift(self)
919 visit_all(v)
920 path.shift
921 end
922 end
923
924 redef class AAnnotation
925
926 redef fun accept_ast_validation(v)
927 do
928 # Do not enter in annotations
929 end
930
931 private init make(n_args : ANodes[AExpr])
932 do
933 _n_visibility = new APublicVisibility
934 _n_args = n_args
935 end
936 end