1 # This file is part of NIT ( http://www.nitlanguage.org ).
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
7 # http://www.apache.org/licenses/LICENSE-2.0
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.
15 # Module to build contract
16 # This module provide extension of the modele to add contracts, the building phase and the "re-driving" to call the contract.
18 # FIXME Split the module in three parts: extension of the modele, building phase and the "re-driving"
21 import parse_annotations
24 intrude import model_contract
25 intrude import astbuilder
26 intrude import modelize_property
30 redef class ToolContext
31 # Parses contracts annotations.
32 var contracts_phase
: Phase = new ContractsPhase(self, [modelize_property_phase
,typing_phase
])
35 private class ContractsPhase
38 # The entry point of the contract phase
39 # In reality, the contract phase is executed on each module
40 # FIXME: Actually all method is checked to add method if any contract is inherited
41 redef fun process_nmodule
(nmodule
)do
42 # Check if the contracts are disabled
43 if toolcontext
.opt_no_contract
.value
then return
44 nmodule
.do_contracts
(self.toolcontext
)
49 # Compile all contracts
51 # The implementation of the contracts is done in two visits.
53 # - First step, the visitor analyzes and constructs the contracts
54 # for each class (invariant) and method (expect, ensure).
56 # - Second step the visitor analyzes each `ASendExpr` to see
57 # if the callsite calls a method with a contract. If this is
58 # the case the callsite is replaced by another callsite to the contract method.
59 fun do_contracts
(toolcontext
: ToolContext) do
61 var contract_visitor
= new ContractsVisitor(toolcontext
, toolcontext
.modelbuilder
.identified_modules
.first
, self, new ASTBuilder(mmodule
.as(not null)))
62 contract_visitor
.enter_visit
(self)
64 var callsite_visitor
= new CallSiteVisitor(toolcontext
)
65 callsite_visitor
.enter_visit
(self)
69 # Visitor to build all contracts.
70 private class ContractsVisitor
73 # Instance of the toolcontext
74 var toolcontext
: ToolContext
77 # It's strore to define if the contract need to be build depending on the selected policy `--no-contract` `--full-contract` or default
78 var mainmodule
: MModule
80 # Actual visited module
81 var visited_module
: AModule
83 var ast_builder
: ASTBuilder
85 # The `ASignature` of the actual build contract
86 var n_signature
: ASignature is noinit
88 # The `MSignature` of the actual build contract
89 var m_signature
: MSignature is noinit
91 # The `current_location` can corresponding of the annotation or method location.
92 var current_location
: Location is noinit
94 # Is the contrat is an introduction or not?
95 # This attribute has the same value as the `is_intro` of the propdef attached to the contract.
96 # Note : For MClassDef `is_intro_contract == false`. This is due to the fact that a method for checking invariants is systematically added to the root object class.
97 var is_intro_contract
: Bool is noinit
99 # Actual visited class
100 var visited_class
: nullable AClassdef
102 # is `no_contract` annotation was found
103 var find_no_contract
= false
105 # The reference to the `in_contract` attribute.
106 # This attribute is used to disable contract verification when you are already in a contract verification.
107 # Keep the `in_contract` attribute to avoid searching at each contrat
108 var in_contract_attribute
: nullable MAttribute = null
110 redef fun visit
(node
)
112 node
.create_contracts
(self)
116 # Method use to define the signature part of the method `ASignature` and `MSignature`
117 # The given `mcontract` provided `adapt_nsignature` and `adapt_msignature` to copy and adapt the given signature (`nsignature` and `msignature`)
118 fun define_signature
(mcontract
: MContract, nsignature
: nullable ASignature, msignature
: nullable MSignature)
120 if nsignature
!= null and msignature
!= null then nsignature
.ret_type
= msignature
.return_mtype
121 self.n_signature
= mcontract
.adapt_nsignature
(nsignature
)
122 self.m_signature
= mcontract
.adapt_msignature
(msignature
)
125 # Define the new contract take in consideration that an old contract exist or not
126 private fun build_contract
(n_annotation
: AAnnotation, mcontract
: MContract, mclassdef
: MClassDef): MMethodDef
128 self.current_location
= n_annotation
.location
129 # Retrieving the expression provided in the annotation
130 var n_condition
= n_annotation
.construct_condition
(self)
131 var m_contractdef
: AMethPropdef
132 if is_intro_contract
then
133 # Create new contract method
134 m_contractdef
= mcontract
.create_intro_contract
(self, n_condition
, mclassdef
)
136 # Create a redef of contract to take in consideration the new condition
137 m_contractdef
= mcontract
.create_subcontract
(self, n_condition
, mclassdef
)
139 var contract_propdef
= m_contractdef
.mpropdef
140 # The contract has a null mpropdef, this should never happen
141 assert contract_propdef
!= null
142 return contract_propdef
145 # Verification if the construction of the contract is necessary.
146 # Three cases are checked for `expect`:
148 # - Was the `--full-contract` option passed?
149 # - Is the method is in the main package?
150 # - Is the method is in a direct imported package?
152 fun check_usage_expect
(actual_mmodule
: MModule): Bool
154 var main_package
= mainmodule
.mpackage
155 var actual_package
= actual_mmodule
.mpackage
156 if main_package
!= null and actual_package
!= null then
157 var condition_direct_arc
= toolcontext
.modelbuilder
.model
.mpackage_importation_graph
.has_arc
(main_package
, actual_package
)
158 return toolcontext
.opt_full_contract
.value
or condition_direct_arc
or main_package
== actual_package
163 # Verification if the construction of the contract is necessary.
164 # Two cases are checked for `ensure`:
166 # - Was the `--full-contract` option passed?
167 # - Is the method is in the main package?
169 fun check_usage_ensure
(actual_mmodule
: MModule): Bool
171 return toolcontext
.opt_full_contract
.value
or mainmodule
.mpackage
== actual_mmodule
.mpackage
174 # Inject the incontract attribute (`_in_contract_`) in the `Sys` class
175 # This attribute allows to check if the contract need to be executed
176 private fun inject_incontract_in_sys
178 # If the `in_contract_attribute` already know just return
179 if in_contract_attribute
!= null then return
181 var sys_class
= toolcontext
.modelbuilder
.get_mclass_by_name
(visited_module
, mainmodule
, "Sys")
183 # Try to get the `in_contract` property, if it has already defined in a previously visited module.
184 var in_contract_property
= toolcontext
.modelbuilder
.try_get_mproperty_by_name
(visited_module
, sys_class
.intro
, "__in_contract_")
185 if in_contract_property
!= null then
186 self.in_contract_attribute
= in_contract_property
.as(MAttribute)
190 var bool_false
= new AFalseExpr.make
(mainmodule
.bool_type
)
191 var n_in_contract_attribute
= toolcontext
.modelbuilder
.create_attribute_from_name
("__in_contract_", sys_class
.intro
, mainmodule
.bool_type
, public_visibility
).create_setter
(toolcontext
.modelbuilder
, true).define_default
(bool_false
)
193 in_contract_attribute
= n_in_contract_attribute
.mpropdef
.mproperty
196 # Return the `_in_contract_` attribute.
197 # If the attribute `_in_contract_` does not exist it's injected with `inject_incontract_in_sys`
198 private fun get_incontract
: MAttribute
200 if self.in_contract_attribute
== null then inject_incontract_in_sys
201 return in_contract_attribute
.as(not null)
204 # Return an `AIfExpr` with the contract encapsulated by an `if` to check if it's already in a contract verification.
209 # fun bar([...]) is except([...])
211 # fun _contract_bar([...])
213 # if not sys._in_contract_ then
214 # sys._in_contract_ = true
216 # sys._in_contract_ = false
221 # fun _bar_expect([...])
225 private fun encapsulated_contract_call
(visited_method
: AMethPropdef, call_to_contracts
: Array[ACallExpr]): AIfExpr
227 var sys_property
= toolcontext
.modelbuilder
.model
.get_mproperties_by_name
("sys").first
.as(MMethod)
228 var callsite_sys
= ast_builder
.create_callsite
(toolcontext
.modelbuilder
, visited_method
, sys_property
, true)
230 var incontract_attribute
= get_incontract
232 var callsite_get_incontract
= ast_builder
.create_callsite
(toolcontext
.modelbuilder
, visited_method
, incontract_attribute
.getter
.as(MMethod), false)
233 var callsite_set_incontract
= ast_builder
.create_callsite
(toolcontext
.modelbuilder
, visited_method
, incontract_attribute
.setter
.as(MMethod), false)
235 var n_condition
= ast_builder
.make_not
(ast_builder
.make_call
(ast_builder
.make_call
(new ASelfExpr, callsite_sys
, null), callsite_get_incontract
, null))
237 var n_if
= ast_builder
.make_if
(n_condition
, null)
239 var if_then_block
= n_if
.n_then
.as(ABlockExpr)
241 if_then_block
.add
(ast_builder
.make_call
(ast_builder
.make_call
(new ASelfExpr, callsite_sys
, null), callsite_set_incontract
, [new ATrueExpr.make
(mainmodule
.bool_type
)]))
242 if_then_block
.add_all
(call_to_contracts
)
243 if_then_block
.add
(ast_builder
.make_call
(ast_builder
.make_call
(new ASelfExpr, callsite_sys
, null), callsite_set_incontract
, [new AFalseExpr.make
(mainmodule
.bool_type
)]))
249 # This visitor checks the `callsite` to see if the target `mpropdef` has a contract.
250 private class CallSiteVisitor
254 # Instance of the toolcontext
255 var toolcontext
: ToolContext
257 # Actual visited method
258 var visited_method
: APropdef is noinit
260 redef fun visit
(node
)
262 node
.check_callsite
(self)
266 # Check if the callsite calls a method with a contract.
267 # If it's the case the callsite is replaced by another callsite to the contract method.
268 private fun drive_method_contract
(callsite
: CallSite): CallSite
270 if callsite
.mproperty
.mcontract_facet
!= null then
271 var contract_facet
= callsite
.mproperty
.mcontract_facet
272 var visited_mpropdef
= visited_method
.mpropdef
273 assert contract_facet
!= null and visited_mpropdef
!= null
275 var type_visitor
= new TypeVisitor(toolcontext
.modelbuilder
, visited_mpropdef
)
276 var drived_callsite
= type_visitor
.build_callsite_by_property
(visited_method
, callsite
.recv
, contract_facet
, callsite
.recv_is_self
)
277 # This never happen this check is here for debug
278 assert drived_callsite
!= null
279 return drived_callsite
286 private fun create_contracts
(v
: ContractsVisitor) do end
287 private fun check_callsite
(v
: CallSiteVisitor) do end
290 redef class AAnnotation
292 # Returns the conditions of annotation parameters. If there are several parameters, the result is an `AAndExpr`
294 # the contract `ensure(true, i == 10, f >= 1.0)`
295 # return this condition `(true and i == 10 and f >= 1.0)`
296 private fun construct_condition
(v
: ContractsVisitor): AExpr
298 var n_condition
= n_args
.first
300 for n_arg
in n_args
do n_condition
= v
.ast_builder
.make_and
(n_condition
, n_arg
)
305 redef class MContract
307 # Define the name of the contract
308 fun contract_name
: String is abstract
310 # Method use to diplay warning when the contract is not present at the introduction
311 private fun no_intro_contract
(v
: ContractsVisitor, a
: AAnnotation)do end
313 # Creating specific inheritance block contract
314 private fun create_nblock
(v
: ContractsVisitor, n_condition
: AExpr, args
: Array[AExpr]): ABlockExpr is abstract
316 # Method to adapt the `n_mpropdef.n_block` to the contract
317 private fun adapt_block_to_contract
(v
: ContractsVisitor, n_mpropdef
: AMethPropdef) is abstract
319 # Adapt the msignature specifically for the contract method
320 private fun adapt_specific_msignature
(m_signature
: MSignature): MSignature do return m_signature
.adapt_to_contract
322 # Adapt the nsignature specifically for the contract method
323 private fun adapt_specific_nsignature
(n_signature
: ASignature): ASignature do return n_signature
.adapt_to_contract
325 # Adapt the `m_signature` to the contract
326 # If it is not null call the specific adapt `m_signature` for the contract
327 private fun adapt_msignature
(m_signature
: nullable MSignature): MSignature
329 if m_signature
== null then return new MSignature(new Array[MParameter])
330 return adapt_specific_msignature
(m_signature
)
333 # Adapt the `n_signature` to the contract
334 # If it is not null call the specific adapt `n_signature` for the contract
335 private fun adapt_nsignature
(n_signature
: nullable ASignature): ASignature
337 if n_signature
== null then return new ASignature
338 return adapt_specific_nsignature
(n_signature
)
341 # Create a new empty contract
342 private fun create_empty_contract
(v
: ContractsVisitor, mclassdef
: MClassDef, msignature
: nullable MSignature, n_signature
: ASignature)
344 var n_contract_def
= intro_mclassdef
.mclass
.create_empty_method
(v
, self, mclassdef
, msignature
, n_signature
)
345 n_contract_def
.do_all
(v
.toolcontext
)
348 # Create the initial contract (intro)
349 # All contracts have the same implementation for the introduction.
355 # assert contract_condition
359 private fun create_intro_contract
(v
: ContractsVisitor, n_condition
: nullable AExpr, mclassdef
: MClassDef): AMethPropdef
361 var n_block
= v
.ast_builder
.make_block
362 if n_condition
!= null then
363 # Create a new tid to set the name of the assert for more explicit error
364 var tid
= new TId.init_tk
(self.location
)
365 tid
.text
= "{self.contract_name}"
366 n_block
.add v
.ast_builder
.make_assert
(tid
, n_condition
, null)
368 return make_contract
(v
, n_block
, mclassdef
)
371 # Create a contract with old (super) and the new conditions
372 private fun create_subcontract
(v
: ContractsVisitor, ncondition
: nullable AExpr, mclassdef
: MClassDef): AMethPropdef
374 var args
= v
.n_signature
.make_parameter_read
(v
.ast_builder
)
375 var n_block
= v
.ast_builder
.make_block
376 if ncondition
!= null then n_block
= self.create_nblock
(v
, ncondition
, args
)
377 return make_contract
(v
, n_block
, mclassdef
)
380 # Build a method with a specific block `n_block` in a specified `mclassdef`
381 private fun make_contract
(v
: ContractsVisitor, n_block
: AExpr, mclassdef
: MClassDef): AMethPropdef
383 var n_contractdef
= intro_mclassdef
.mclass
.create_empty_method
(v
, self, mclassdef
, v
.m_signature
, v
.n_signature
)
384 n_contractdef
.n_block
= n_block
385 # Define the location of the new method for corresponding of the annotation location
386 n_contractdef
.location
= v
.current_location
387 n_contractdef
.do_all
(v
.toolcontext
)
394 # Define the name of the contract
395 redef fun contract_name
: String do return "expect"
397 # Display warning if no contract is defined at introduction `expect`,
398 # because if no contract is defined at the introduction the added
399 # contracts will not cause any error even if they are not satisfied.
405 # fun _bar_expect([...])
412 # redef fun bar is expect(contract_condition)
413 # redef fun _bar_expect([...])
415 # if (contract_condition) then return
421 redef fun no_intro_contract
(v
: ContractsVisitor, a
: AAnnotation)
423 v
.toolcontext
.warning
(a
.location
,"","Useless contract: No contract defined at the introduction of the method")
426 redef fun create_nblock
(v
: ContractsVisitor, n_condition
: AExpr, args
: Array[AExpr]): ABlockExpr
428 # Creating the if expression with the new condition
429 var if_block
= v
.ast_builder
.make_if
(n_condition
, n_condition
.mtype
)
430 # Creating and adding return expr to the then case
431 if_block
.n_then
= v
.ast_builder
.make_return
(null)
432 # Creating the super call to the contract and adding this to else case
433 if_block
.n_else
= v
.ast_builder
.make_super_call
(args
,null)
434 var n_block
= v
.ast_builder
.make_block
439 redef fun adapt_block_to_contract
(v
: ContractsVisitor, n_mpropdef
: AMethPropdef)
441 var callsite
= v
.ast_builder
.create_callsite
(v
.toolcontext
.modelbuilder
, n_mpropdef
, self, true)
442 var n_self
= new ASelfExpr
443 var args
= n_mpropdef
.n_signature
.make_parameter_read
(v
.ast_builder
)
444 var n_callexpect
= v
.ast_builder
.make_call
(n_self
,callsite
,args
)
445 # Creation of the new instruction block with the call to expect condition
446 var actual_expr
= n_mpropdef
.n_block
447 var new_block
= new ABlockExpr
448 new_block
.n_expr
.push n_callexpect
449 if actual_expr
isa ABlockExpr then
450 new_block
.n_expr
.add_all
(actual_expr
.n_expr
)
451 else if actual_expr
!= null then
452 new_block
.n_expr
.push
(actual_expr
)
454 n_mpropdef
.n_block
= new_block
458 redef class BottomMContract
460 redef fun create_nblock
(v
: ContractsVisitor, n_condition
: AExpr, args
: Array[AExpr]): ABlockExpr
462 var tid
= new TId.init_tk
(v
.current_location
)
463 tid
.text
= "{contract_name}"
464 # Creating the assert expression with the new condition
465 var assert_block
= v
.ast_builder
.make_assert
(tid
,n_condition
,null)
466 # Creating the super call to the contract
467 var super_call
= v
.ast_builder
.make_super_call
(args
,null)
468 # Define contract block
469 var n_block
= v
.ast_builder
.make_block
470 # Adding the expressions to the block
471 n_block
.add super_call
472 n_block
.add assert_block
476 # Inject the `result` variable into the `n_block` of the given n_mpropdef`.
478 # The purpose of the variable is to capture return values to use it in contracts.
479 private fun inject_result
(v
: ContractsVisitor, n_mpropdef
: AMethPropdef, ret_type
: MType): Variable
481 var actual_block
= n_mpropdef
.n_block
482 # never happen. If it's the case the problem is in the contract facet building
483 assert actual_block
isa ABlockExpr
485 var return_var
: nullable Variable = null
487 var return_expr
= actual_block
.n_expr
.last
.as(AReturnExpr)
489 var returned_expr
= return_expr
.n_expr
490 # The return node has no returned expression
491 assert returned_expr
!= null
493 # Check if the result variable already exit
494 if returned_expr
isa AVarExpr then
495 if returned_expr
.variable
.name
== "result" then
496 return_var
= returned_expr
.variable
500 return_var
= new Variable("result")
501 # Creating a new variable to keep the old return of the method
502 var assign_result
= v
.ast_builder
.make_var_assign
(return_var
, returned_expr
)
503 # Remove the actual return
504 actual_block
.n_expr
.pop
505 # Set the return type
506 return_var
.declared_type
= ret_type
507 # Adding the reading expr of result variable to the block
508 actual_block
.add assign_result
509 # Expr to read the result variable
510 var read_result
= v
.ast_builder
.make_var_read
(return_var
, ret_type
)
511 # Definition of the new return
512 return_expr
= v
.ast_builder
.make_return
(read_result
)
513 actual_block
.add return_expr
520 # Define the name of the contract
521 redef fun contract_name
: String do return "ensure"
523 redef fun adapt_specific_msignature
(m_signature
: MSignature): MSignature
525 return m_signature
.adapt_to_ensurecondition
528 redef fun adapt_specific_nsignature
(n_signature
: ASignature): ASignature
530 return n_signature
.adapt_to_ensurecondition
533 redef fun adapt_block_to_contract
(v
: ContractsVisitor, n_mpropdef
: AMethPropdef)
535 var callsite
= v
.ast_builder
.create_callsite
(v
.toolcontext
.modelbuilder
, n_mpropdef
, self, true)
536 var n_self
= new ASelfExpr
537 # argument to call the contract method
538 var args
= n_mpropdef
.n_signature
.make_parameter_read
(v
.ast_builder
)
539 # Inject the variable result
540 # The cast is always safe because the online adapted method is the contract facet
542 var actual_block
= n_mpropdef
.n_block
543 # never happen. If it's the case the problem is in the contract facet building
544 assert actual_block
isa ABlockExpr
546 var ret_type
= n_mpropdef
.mpropdef
.mproperty
.intro
.msignature
.return_mtype
547 if ret_type
!= null then
548 var result_var
= inject_result
(v
, n_mpropdef
, ret_type
)
549 # Expr to read the result variable
550 var read_result
= v
.ast_builder
.make_var_read
(result_var
, ret_type
)
551 var return_expr
= actual_block
.n_expr
.pop
552 # Adding the read return to argument
553 args
.add
(read_result
)
554 var n_callcontract
= v
.ast_builder
.make_call
(n_self
,callsite
,args
)
555 actual_block
.add_all
([n_callcontract
,return_expr
])
557 # build the call to the contract method
558 var n_callcontract
= v
.ast_builder
.make_call
(n_self
,callsite
,args
)
559 actual_block
.add n_callcontract
566 # This method create an abstract method representation with this MMethodDef an this AMethoddef
567 private fun create_abstract_method
(v
: ContractsVisitor, mproperty
: MMethod, mclassdef
: MClassDef, msignature
: nullable MSignature, n_signature
: ASignature): AMethPropdef
569 # new methoddef definition
570 var m_def
= new MMethodDef(mclassdef
, mproperty
, v
.current_location
)
572 if msignature
!= null then m_def
.msignature
= msignature
.clone
573 # set the abstract flag
574 m_def
.is_abstract
= true
575 # Build the new node method
576 var n_def
= v
.ast_builder
.make_method
(null,null,m_def
,n_signature
,null,null,null,null)
577 # Define the location of the new method for corresponding of the actual method
578 n_def
.location
= v
.current_location
579 # Association new npropdef to mpropdef
580 v
.toolcontext
.modelbuilder
.unsafe_add_mpropdef2npropdef
(m_def
,n_def
)
584 # Create method with an empty block
585 # the `mproperty` i.e the global property definition. The mclassdef to set where the method is declared and it's model `msignature` and ast `n_signature` signature
586 private fun create_empty_method
(v
: ContractsVisitor, mproperty
: MMethod, mclassdef
: MClassDef, msignature
: nullable MSignature, n_signature
: ASignature): AMethPropdef
588 var n_def
= create_abstract_method
(v
, mproperty
, mclassdef
, msignature
, n_signature
)
589 n_def
.mpropdef
.is_abstract
= false
590 n_def
.n_block
= v
.ast_builder
.make_block
595 redef class MMethodDef
597 # Verification of the contract facet
598 # Check if a contract facet already exists to use it again or if it is necessary to create it.
599 private fun check_contract_facet
(v
: ContractsVisitor, n_signature
: ASignature, classdef
: MClassDef, mcontract
: MContract, exist_contract
: Bool)
601 var exist_contract_facet
= mproperty
.has_contract_facet
602 if exist_contract_facet
and exist_contract
then return
604 var contract_facet
: AMethPropdef
605 if not exist_contract_facet
then
606 # If has no contract facet in intro just create it
607 if classdef
!= mproperty
.intro_mclassdef
then create_contract_facet
(v
, mproperty
.intro_mclassdef
, n_signature
)
608 # If has no contract facet just create it
609 contract_facet
= create_contract_facet
(v
, classdef
, n_signature
)
611 # Check if the contract facet already exist in this context (in this classdef)
612 if classdef
.mpropdefs_by_property
.has_key
(mproperty
.mcontract_facet
) then
614 contract_facet
= v
.toolcontext
.modelbuilder
.mpropdef2node
(classdef
.mpropdefs_by_property
[mproperty
.mcontract_facet
]).as(AMethPropdef)
616 # create a new contract facet definition
617 contract_facet
= create_contract_facet
(v
, classdef
, n_signature
)
618 var block
= v
.ast_builder
.make_block
619 # super call to the contract facet
620 var n_super_call
= v
.ast_builder
.make_super_call
(n_signature
.make_parameter_read
(v
.ast_builder
), null)
621 # verification for add a return or not
622 if contract_facet
.mpropdef
.msignature
.return_mtype
!= null then
623 block
.add
(v
.ast_builder
.make_return
(n_super_call
))
625 block
.add
(n_super_call
)
627 contract_facet
.n_block
= block
630 contract_facet
.adapt_block_to_contract
(v
, mcontract
, contract_facet
)
631 contract_facet
.location
= v
.current_location
632 contract_facet
.do_all
(v
.toolcontext
)
635 # Method to create a contract facet of the method
636 private fun create_contract_facet
(v
: ContractsVisitor, classdef
: MClassDef, n_signature
: ASignature): AMethPropdef
638 var contract_facet
= mproperty
.build_contract_facet
639 # Defines the contract phase is an init or not
640 # it is necessary to use the contracts on constructor
641 contract_facet
.is_init
= self.mproperty
.is_init
643 # check if the method has an `msignature` to copy it.
644 var m_signature
: nullable MSignature = null
645 if mproperty
.intro
.msignature
!= null then m_signature
= mproperty
.intro
.msignature
.clone
647 var n_contractdef
= classdef
.mclass
.create_empty_method
(v
, contract_facet
, classdef
, m_signature
, n_signature
)
648 # FIXME set the location because the callsite creation need the node location
649 n_contractdef
.location
= v
.current_location
650 n_contractdef
.validate
652 var block
= v
.ast_builder
.make_block
653 var n_self
= new ASelfExpr
654 var args
= n_contractdef
.n_signature
.make_parameter_read
(v
.ast_builder
)
655 var callsite
= v
.ast_builder
.create_callsite
(v
.toolcontext
.modelbuilder
, n_contractdef
, mproperty
, true)
656 var n_call
= v
.ast_builder
.make_call
(n_self
, callsite
, args
)
658 if m_signature
.return_mtype
== null then
661 block
.add
(v
.ast_builder
.make_return
(n_call
))
664 n_contractdef
.n_block
= block
665 n_contractdef
.do_all
(v
.toolcontext
)
669 # Entry point to build contract (define the contract facet and define the contract method verification)
670 private fun construct_contract
(v
: ContractsVisitor, n_signature
: ASignature, n_annotation
: AAnnotation, mcontract
: MContract, exist_contract
: Bool)
672 if check_same_contract
(v
, n_annotation
, mcontract
) then return
673 if not exist_contract
and not is_intro
then no_intro_contract
(v
, n_signature
, mcontract
, n_annotation
)
674 v
.define_signature
(mcontract
, n_signature
, mproperty
.intro
.msignature
)
676 var conditiondef
= v
.build_contract
(n_annotation
, mcontract
, mclassdef
)
677 check_contract_facet
(v
, n_signature
.clone
, mclassdef
, mcontract
, exist_contract
)
681 # Create a contract on the introduction classdef of the property.
682 # Display an warning message if necessary
683 private fun no_intro_contract
(v
: ContractsVisitor, n_signature
: ASignature, mcontract
: MContract, n_annotation
: AAnnotation)
685 mcontract
.create_empty_contract
(v
, mcontract
.intro_mclassdef
, mcontract
.adapt_msignature
(self.mproperty
.intro
.msignature
), mcontract
.adapt_nsignature
(n_signature
))
686 mcontract
.no_intro_contract
(v
, n_annotation
)
687 mproperty
.intro
.has_contract
= true
690 # Is the contract already defined in the context
693 # fun foo is expect([...]), expect([...])
695 # Here `check_same_contract` display an error when the second expect is processed
696 private fun check_same_contract
(v
: ContractsVisitor, n_annotation
: AAnnotation ,mcontract
: MContract): Bool
698 if self.mclassdef
.mpropdefs_by_property
.has_key
(mcontract
) then
699 v
.toolcontext
.error
(n_annotation
.location
, "The method already has a defined `{mcontract.contract_name}` contract at line {self.mclassdef.mpropdefs_by_property[mcontract].location.line_start}")
707 # flag to indicate is the `MPropDef` has a contract
708 var has_contract
= false
712 redef fun check_callsite
(v
)
714 v
.visited_method
= self
718 redef class AMethPropdef
720 # Entry point to create a contract (verification of inheritance, or new contract).
721 redef fun create_contracts
(v
)
723 v
.ast_builder
.check_mmodule
(mpropdef
.mclassdef
.mmodule
)
725 v
.current_location
= self.location
726 v
.is_intro_contract
= mpropdef
.is_intro
728 if n_annotations
!= null then
729 for n_annotation
in n_annotations
.n_items
do
730 check_annotation
(v
,n_annotation
)
734 if not mpropdef
.is_intro
and not v
.find_no_contract
then
739 v
.find_no_contract
= false
742 # Verification of the annotation to know if it is a contract annotation.
743 # If this is the case, we built the appropriate contract.
744 private fun check_annotation
(v
: ContractsVisitor, n_annotation
: AAnnotation)
746 if n_annotation
.name
== "expect" then
747 if not v
.check_usage_expect
(mpropdef
.mclassdef
.mmodule
) then return
748 var exist_contract
= mpropdef
.mproperty
.has_expect
749 mpropdef
.construct_contract
(v
, self.n_signature
.as(not null), n_annotation
, mpropdef
.mproperty
.build_expect
, exist_contract
)
750 else if n_annotation
.name
== "ensure" then
751 if not v
.check_usage_ensure
(mpropdef
.mclassdef
.mmodule
) then return
752 var exist_contract
= mpropdef
.mproperty
.has_ensure
753 mpropdef
.construct_contract
(v
, self.n_signature
.as(not null), n_annotation
, mpropdef
.mproperty
.build_ensure
, exist_contract
)
754 else if n_annotation
.name
== "no_contract" then
755 # no_contract found set the flag to true
756 v
.find_no_contract
= true
760 # Verification if the method have an inherited contract to apply it.
761 private fun check_redef
(v
: ContractsVisitor)
763 # Check if the method has an attached contract
764 if not mpropdef
.has_contract
then
765 if mpropdef
.mproperty
.intro
.has_contract
then
766 mpropdef
.has_contract
= true
771 # Adapt the block to use the contracts
772 private fun adapt_block_to_contract
(v
: ContractsVisitor, contract
: MContract, n_mpropdef
: AMethPropdef)
774 contract
.adapt_block_to_contract
(v
, n_mpropdef
)
775 mpropdef
.has_contract
= true
776 n_mpropdef
.do_all
(v
.toolcontext
)
780 redef class MSignature
782 # Adapt signature for an contract
784 # The returned `MSignature` is the copy of `self` without return type.
785 private fun adapt_to_contract
: MSignature do return new MSignature(mparameters
.to_a
, null)
787 # Adapt signature for a ensure contract
789 # The returned `MSignature` is the copy of `self` without return type.
790 # The return type is replaced by a new parameter `result`
791 private fun adapt_to_ensurecondition
: MSignature
793 var rtype
= return_mtype
794 var msignature
= adapt_to_contract
795 if rtype
!= null then
796 msignature
.mparameters
.add
(new MParameter("result", rtype
, false))
801 # The returned `MSignature` is the exact copy of `self`.
802 private fun clone
: MSignature do return new MSignature(mparameters
.to_a
, return_mtype
)
805 redef class ASignature
807 # Create an array of AVarExpr representing the read of every parameters
808 private fun make_parameter_read
(ast_builder
: ASTBuilder): Array[AVarExpr]
810 var args
= new Array[AVarExpr]
811 for n_param
in self.n_params
do
812 var mtype
= n_param
.variable
.declared_type
813 var variable
= n_param
.variable
814 if variable
!= null and mtype
!= null then
815 args
.push ast_builder
.make_var_read
(variable
, mtype
)
821 # Create a new ASignature adapted for contract
823 # The returned `ASignature` is the copy of `self` without return type.
824 private fun adapt_to_contract
: ASignature
826 var adapt_nsignature
= self.clone
827 if adapt_nsignature
.n_type
!= null then adapt_nsignature
.n_type
.detach
828 return adapt_nsignature
831 # Create a new ASignature adapted for ensure
833 # The returned `ASignature` is the copy of `self` without return type.
834 # The return type is replaced by a new parameter `result`
835 private fun adapt_to_ensurecondition
: ASignature do
836 var nsignature
= adapt_to_contract
837 if ret_type
!= null then
838 var variable
= new Variable("result")
839 variable
.declared_type
= ret_type
840 nsignature
.n_params
.add
new AParam.make
(variable
, ret_type
.create_ast_representation
)
846 redef class ASendExpr
847 redef fun check_callsite
(v
)
849 var actual_callsite
= callsite
850 if actual_callsite
!= null then
851 callsite
= v
.drive_method_contract
(actual_callsite
)
857 redef fun check_callsite
(v
)
859 var actual_callsite
= callsite
860 if actual_callsite
!= null then
861 callsite
= v
.drive_method_contract
(actual_callsite
)