1 % (c) 2009-2025 Lehrstuhl fuer Softwaretechnik und Programmiersprachen,
2 % Heinrich Heine Universitaet Duesseldorf
3 % This software is licenced under EPL 1.0 (http://www.eclipse.org/org/documents/epl-v10.html)
4
5 :- module(bmachine_construction,[reset_bmachine_construction/0,
6 check_machine/4,
7 type_in_machine_l/7,
8 type_open_predicate_with_quantifier/6,
9 get_constructed_machine_name/2, get_constructed_machine_name_and_filenumber/3,
10 type_open_formula/8,
11 create_scope/6, % create type-checking scope
12 filter_linking_invariant/3,
13 machine_promotes_operations/2,
14 machine_hides_unpromoted_operation/4,
15 external_procedure_used/1,
16 abstract_variable_removed_in/3,
17 dummy_machine_name/2]).
18
19 :- use_module(module_information,[module_info/2]).
20 :- module_info(group,typechecker).
21 :- module_info(description,'This module contains the rules for loading, including, seeing, etc. B machines, scope of constants, variables, parameters, etc.').
22
23 :- use_module(library(lists)).
24 :- use_module(library(avl)).
25
26 :- use_module(self_check).
27 :- use_module(tools).
28 :- use_module(error_manager).
29 :- use_module(debug).
30 :- use_module(preferences).
31
32 :- use_module(btypechecker).
33 :- use_module(b_ast_cleanup).
34 :- use_module(bsyntaxtree).
35 :- use_module(bmachine_structure).
36 :- use_module(pragmas).
37 :- use_module(b_global_sets,[register_enumerated_sets/2]).
38
39 :- use_module(bmachine_static_checks).
40 :- use_module(tools_lists,[ord_member_nonvar_chk/2, remove_dups_keep_order/2]).
41
42 :- use_module(translate,[print_machine/1]).
43
44
45 :- set_prolog_flag(double_quotes, codes).
46
47 %maximum_type_errors(100).
48
49 :- dynamic debug_machine/0.
50 :- dynamic abstract_variable_removed_in/3.
51
52 :- use_module(pref_definitions,[b_get_important_preferences_from_raw_machine/2]).
53 set_important_prefs_from_machine(Main,Machines) :-
54 find_machine(Main,Machines,_MType,_Header,RawMachine),
55 ? get_raw_model_type(Main,Machines,RawModelType),!,
56 b_get_important_preferences_from_raw_machine(RawMachine,RawModelType),
57 check_important_annotions_from_machine(RawMachine).
58
59 check_important_annotions_from_machine(RawMachine) :-
60 ? member(definitions(_Pos,Defs),RawMachine),
61 member(expression_definition(DPOS,'PROB_REQUIRED_VERSION',[],RawValue),Defs),!,
62 (RawValue = string(VPos,Version)
63 -> add_message(bmachine_construction,'Checking PROB_REQUIRED_VERSION: ',Version,VPos),
64 (check_version(Version,VPos) -> true ; true)
65 ; add_warning(bmachine_construction,'PROB_REQUIRED_VERSION must provide a version number string.','',DPOS)
66 ).
67 check_important_annotions_from_machine(_).
68
69 :- use_module(version,[compare_against_current_version/2,full_version_str/1]).
70 check_version(VersAtom,DPOS) :- atom_codes(VersAtom,Codes),
71 split_chars(Codes,".",VCNrs),
72 maplist(codes_to_number(DPOS),VCNrs,VNrs),
73 compare_against_current_version(VNrs,Result),
74 (Result = current_older
75 -> full_version_str(Cur),
76 ajoin(['This model requires at newer version of ProB than ',Cur,'. Download at least version: '],Msg),
77 add_warning(prob_too_old,Msg,VersAtom,DPOS)
78 ; true).
79
80 codes_to_number(DPOS,C,A) :-
81 catch(number_codes(A,C), error(syntax_error(_N),_),
82 (atom_codes(AA,C),
83 add_warning(bmachine_construction,'Illegal part of version number (use only numbers separated by dots): ',AA,DPOS),fail)).
84
85 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
86
87 :- use_module(preferences,[temporary_set_preference/3,reset_temporary_preference/2]).
88
89 % typecheck complete machines (incl. includes)
90 check_machine(MainName,MachinesMayContainGenerated,Result,FinalErrors) :-
91 clear_warnings,
92 debug_println(9,checking_machine(MainName)),
93 temporary_set_preference(perform_stricter_static_checks,true,CHNG),
94 strip_global_pragmas(MachinesMayContainGenerated,Machines,_WasGenerated), % TODO: is generated still used?
95 set_important_prefs_from_machine(MainName,Machines), % set important prefs before type-checking,...
96 check_main_machine_file_origin(MainName,Machines),
97 % we need to find all SEES/USES declarations, because all references
98 % refer to the same machine and that has to be included exactly once.
99 find_uses(Machines,GlobalUses,NotIncluded,Errors,E1),
100 % if a seen/used machine was not included, we include it by constructing
101 % a dummy machine that extends the seen/used machine and the origional main machine
102 extend_not_included_uses(NotIncluded,MainName,NewMainName,Machines,IMachines),
103 % figure out the right order of machines, so that each machine is
104 % type-checked before a dependend machine is loaded
105 machine_order(IMachines,Order),
106 assert_machine_order(Order),
107 % expand (= type-check + includes) machines in the given order
108 expand_machines(Order,IMachines,GlobalUses,[],Results1,E1,E2),
109 % until now, the initialisation section consists of a list of init_stmt(MachineName,Desc,Substitution)
110 % fold_initialisation merges those to one substitution, respecting the dependencies
111 % between the machines
112 maplist(fold_initialisation(Order),Results1,Results),
113 % find main machine
114 memberchk(machine(NewMainName,MainMachine),Results), %nl,print('MAIN:'),nl,print_machine(MainMachine),
115 % if the main machine has parameters, we convert them to global sets resp. constants
116 convert_parameters_to_global_sets(E2,[],MainMachine,Result1),
117 % add some additional informations about the machine
118 add_machine_infos(MainName,Machines,Results,Result1,Result),
119 ( debug_machine -> print_machine(Result); true),
120 %% comment in to pretty print all machines:
121 %( member(machine(Name,Mchx),Results), format('~n*** Machine ~w~n',[Name]), print_machine(Mchx),nl,fail ; true),
122 % finalize the list of errors, remove duplicates
123 sort(Errors,FinalErrors),
124 % output warnings
125 show_warnings,
126 % run static checks on the resulting machine
127 static_check_main_machine(Result),
128 reset_temporary_preference(perform_stricter_static_checks,CHNG).
129 check_machine(Main,_,Result,FinalErrors) :-
130 add_internal_error('Internal error: Checking the machine failed: ',
131 check_machine(Main,_,Result,FinalErrors)),
132 fail.
133
134 % remove global pragrams at top-level and assert them
135 strip_global_pragmas([],[],false).
136 strip_global_pragmas([generated(POS,M)|Ms],MachinesOut,true) :- !, % @generated pragma used at top of file
137 assertz(pragmas:global_pragma(generated,POS)),
138 strip_global_pragmas([M|Ms],MachinesOut,_).
139 strip_global_pragmas([unit_alias(_,Alias,Content,M)|Ms],MachinesOut,true) :- !,
140 assertz(pragmas:global_pragma(unit_alias,[Alias|Content])),
141 strip_global_pragmas([M|Ms],MachinesOut,_).
142 strip_global_pragmas([M|Ms],[M|SMs],WasGenerated) :-
143 strip_global_pragmas(Ms,SMs,WasGenerated).
144
145
146 fold_initialisation(Order,machine(Name,Sections),machine(Name,NewSections)) :-
147 select_section(initialisation,List,Subst,Sections,NewSections),
148 maplist(extract_init_substitutions(List),Order,LSubstitutions),
149 append(LSubstitutions,Substitutions),
150 create_init_sequence(Substitutions,Subst).
151 extract_init_substitutions(Unsorted,Name,Substitutions) :-
152 convlist(unzip_init(Name),Unsorted,Substitutions). % keep inits for Name
153 unzip_init(Name,init_stmt(Name,Subst),Subst).
154 create_init_sequence([],Subst) :- !, create_texpr(skip,subst,[generated],Subst).
155 create_init_sequence([I],I) :- !.
156 create_init_sequence(L,Sequence) :-
157 (L = [First|_], get_texpr_info(First,AllInfos), extract_pos_infos(AllInfos,Pos) -> true ; Pos=[]),
158 % TODO: try and merge first and last position info
159 (get_preference(allow_overriding_initialisation,true),
160 override_initialisation_sequence(L,NL)
161 -> NewList=NL ; NewList=L),
162 create_texpr(sequence(NewList),subst,[initial_sequence|Pos],Sequence).
163
164 :- use_module(b_read_write_info,[get_accessed_vars/4]).
165 % override initialisation sequence, remove unnecessary earlier assignments (which may time-out, ...)
166 % in future we may inline equalities into becomes_such that, e.g., x :: S ; x := 1 --> x :: X /\ {1}
167 % currently x :: S ; x := 1 gets simplified to skip ; x := 1
168 override_initialisation_sequence(List,NewList) :-
169 append(Prefix,[Last],List),
170 Prefix = [_|_], % there are some earlier initialisation statements to simplify
171 get_accessed_vars(Last,[],LIds,Read),
172 ord_intersection(LIds,Read,RWIds),
173 (RWIds = []
174 -> true
175 ; add_warning(b_machine_construction,'Initialisation (override) statement reads written variables:',RWIds,Last)
176 ),
177 process_override(Last,Prefix, NewLast, SPrefix),
178 append(SPrefix,[NewLast],NewList).
179
180
181 process_override(b(parallel(List),subst,Info), Prefix,
182 b(parallel(NewList),subst,Info), NewPrefix) :- !,
183 l_process_override(List,Prefix,NewList,NewPrefix).
184 process_override(Subst, Prefix, NewSubst, NewPrefix) :-
185 create_after_pred(Subst,AfterPred),
186 get_accessed_vars(Subst,[],Ids,Read),
187 % write(after_pred(Ids, read(Read))),nl, translate:print_bexpr(AfterPred),nl,
188 ord_intersection(Read,Ids,RWIds),
189 (RWIds=[]
190 -> maplist(try_simplify_init_stmt(Ids,AfterPred,Keep),Prefix,NewPrefix),
191 !,
192 (Keep==merged_override_stmt
193 -> NewSubst = b(skip,subst,[was(Subst)])
194 ; NewSubst = Subst
195 )
196 ; add_warning(b_machine_construction,'Initialisation statement reads written variables:',RWIds,Subst),
197 fail % we actually have a before after predicate which may modify RWIds
198 ).
199 process_override(Subst, Prefix , Subst, Prefix) :- add_message(b_machine_construction,'Keeping: ',Subst,Subst).
200
201 l_process_override([],Prefix,[],Prefix).
202 l_process_override([H|List],Prefix,[H1|NewList],NewPrefix) :-
203 process_override(H,Prefix,H1,Prefix1),
204 l_process_override(List,Prefix1,NewList,NewPrefix).
205
206 :- use_module(library(ordsets)).
207 simplify_init_stmt(b(parallel(List),subst,I),OverrideIds,AfterPred,Keep,b(parallel(SList),subst,I)) :- !,
208 maplist(try_simplify_init_stmt(OverrideIds,AfterPred,Keep),List,SList).
209 simplify_init_stmt(Assign,OverrideIds,AfterPred,Keep,NewSubst) :-
210 get_accessed_vars(Assign,[],AssignIds,_Read),
211 (ord_subset(OverrideIds,AssignIds),
212 merge_statement(Assign,AssignIds,AfterPred,NewSubst),
213 Keep = merged_override_stmt
214 -> % we need to remove the override assign, if it is non-det.
215 add_message(b_machine_construction,'Adapting initialisation due to override: ',NewSubst,Assign)
216 ; ord_subset(AssignIds,OverrideIds)
217 % The assignment is useless, will be completely overriden
218 -> NewSubst = b(skip,subst,[was(Assign)]),
219 add_message(b_machine_construction,'Removing initialisation due to override: ',Assign,Assign),
220 Keep = keep_override_stmt
221 ).
222 % TODO: we could simplify IF-THEN-ELSE, ... and other constructs
223
224 % Note: the merging assumes the initialisation before the override assigns each overriden variable only once
225 try_simplify_init_stmt(OverrideIds,AfterPred,Keep,Stmt,NewStmt) :-
226 (simplify_init_stmt(Stmt,OverrideIds,AfterPred,Keep,N)
227 -> NewStmt=N ; NewStmt=Stmt).
228
229 merge_statement(b(Subst,subst,Info),AssignIds,AfterPred,b(NewSubst,subst,Info)) :-
230 merge_stmt_aux(Subst,AssignIds,AfterPred,NewSubst).
231
232 merge_stmt_aux(becomes_such(Ids,Pred),_AssignIds,AfterPred,becomes_such(Ids,NewPred)) :-
233 conjunct_predicates([AfterPred,Pred],NewPred).
234 merge_stmt_aux(becomes_element_of(Ids,Set),_,AfterPred2,becomes_such(Ids,NewPred)) :-
235 create_couple(Ids,Couple),
236 safe_create_texpr(member(Couple,Set),pred,AfterPred1),
237 conjunct_predicates([AfterPred1,AfterPred2],NewPred).
238
239 create_after_pred(b(Subst,subst,Info),Pred) :- create_after_pred_aux(Subst,Info,Pred).
240
241 create_after_pred_aux(assign_single_id(Id,RHS),Info,b(equal(Id,RHS),pred,Info)).
242 create_after_pred_aux(assign(LHS,RHS),_Info,Conj) :- % TODO: split assignments so that we can individually apply preds
243 maplist(create_equality,LHS,RHS,Eqs),
244 conjunct_predicates(Eqs,Conj).
245 % the following two are non-deterministic; hence we need to remove the substitutions
246 % in case we have managed to merge them into an earlier becomes_such,... (otherwise we may do a second non-det incompatible choice)
247 create_after_pred_aux(becomes_element_of(Id,Set),Info,b(member(Couple,Set),pred,Info)) :-
248 create_couple(Id,Couple).
249 create_after_pred_aux(becomes_such(_,Pred),_Info,Pred).
250
251
252 % -------------------------
253
254 add_machine_infos(MainName,Machines,CheckedMachines,Old,New) :-
255 ? get_raw_model_type(MainName,Machines,RawModelType), functor(RawModelType,ModelType,_), % argument is position
256 % model type could be machine or system (or model ?)
257 !,
258 append_to_section(meta,[model_type/ModelType,hierarchy/Hierarchy,header_pos/HeaderPosList],Old,NewT),
259 get_refinement_hierarchy(MainName,Machines,Hierarchy),
260 find_machine_header_positions(Machines,HeaderPosList),
261 add_refined_machine(Hierarchy,CheckedMachines,NewT,New).
262 get_refinement_hierarchy(Main,Machines,[Main|Abstractions]) :-
263 ( find_refinement(Machines,Main,Abstract) ->
264 get_refinement_hierarchy(Abstract,Machines,Abstractions)
265 ;
266 Abstractions = []).
267 find_refinement([M|Rest],Name,Abstract) :-
268 ( get_constructed_machine_name(M,Name) ->
269 refines(M,Abstract)
270 ;
271 find_refinement(Rest,Name,Abstract)).
272
273 find_machine_header_positions(Machines,SRes) :-
274 Header = machine_header(Pos,_Nm,_Paras),
275 findall(Name/Pos,find_machine(Name,Machines,_Type,Header,_Sections),Res),
276 sort(Res,SRes).
277
278 :- use_module(specfile,[animation_minor_mode/1]).
279 % check whether the main machine has filenumber 1; if not something strange is going on.
280 % an example can be found in prob_examples/public_examples/B/ErrorMachines/IllegalSeesIncludes/WrongNameM1.mch
281 check_main_machine_file_origin(MainName,Machines) :-
282 ? member(M,Machines), get_machine_parameters(M,MainName,_,Position),
283 !,
284 (Position = none -> true
285 ; get_nr_name(Position,Number,Name)
286 -> (Number=1 -> true
287 ; ajoin(['Main machine name ',MainName,' overriden by machine in file ',Number,' :'],Msg),
288 add_error(bmachine_construction,Msg,Name,Position))
289 ; add_error(bmachine_construction,'Could not extract file number and name:',Position)
290 ).
291 check_main_machine_file_origin(MainName,_) :-
292 add_error(bmachine_construction,'Could not extract file number and name for main machine:',MainName).
293 get_nr_name(none,Nr,Name) :- !, Nr=1,Name=none.
294 get_nr_name(1,Nr,Name) :- !, Nr=1,Name=none. % TLA mode, animation_minor_mode(tla) not yet set and positions are numbers
295 get_nr_name(Position,Number,Name) :- extract_file_number_and_name(Position,Number,Name).
296
297 add_refined_machine([_Main,Refined|_],Machines,Old,New) :-
298 member(machine(Refined,Body),Machines),!,
299 append_to_section(meta,[refined_machine/Body],Old,New).
300 add_refined_machine(_,_,M,M). % not refining
301
302 convert_parameters_to_global_sets(Ein,Eout) -->
303 % extract and remove parameters and constraints
304 select_section(parameters,PP,[]),
305 select_section(internal_parameters,IP,[]),
306 {create_texpr(truth,pred,[],Truth)},
307 select_section(constraints,C,Truth),
308 % split parameters into sets and scalars
309 { split_list(is_set_parameter,PP,Sets,Scalars),
310 foldl(type_set_parameter,Sets,Ein,Eout) },
311 % put the sets to the deferred sets
312 append_to_section(deferred_sets,Sets),
313 % and the scalars to the constants
314 append_to_section(concrete_constants,Scalars),
315 append_to_section(concrete_constants,IP),
316 % the scalars should be typed by constraints,
317 % so move the constraints to the properties
318 select_section(properties,OldProps,NewProps),
319 {conjunct_predicates([C,OldProps],NewProps)}.
320 is_set_parameter(TExpr) :-
321 % upper case identifiers denote set parameters, otherwise scalars
322 get_texpr_id(TExpr,Name),is_upper_case(Name).
323 type_set_parameter(TExpr,Ein,Eout) :-
324 get_texpr_id(TExpr,Name),
325 get_texpr_type(TExpr,Type),
326 get_texpr_pos(TExpr,Pos),
327 % we directly type the deferred set
328 unify_types_werrors(set(global(Name)),Type,Pos,'PARAMETER',Ein,Eout).
329
330
331 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
332 % included machines
333
334 expand_machines([],_,_,M,M,Errors,Errors).
335 expand_machines([M|Rest],Machines,GlobalUses,Typed,Result,Ein,Eout) :-
336 ? ( expand_machine(M,Machines,GlobalUses,Typed,New,Ein,E1) -> true
337 ; add_error(bmachine_construction,'Expansion of machine failed:',M),fail),
338 expand_machines(Rest,Machines,GlobalUses,[machine(M,New)|Typed],Result,E1,Eout).
339
340 % resolve all includes and typecheck the machine
341 % expand_machine(Name,Machines,TypeChecked,Expanded) :
342 % Name of the Machine to expand
343 % Machines contains the list of all loaded machines
344 % TypeChecked contains the list of all expanded machines so far
345 % Expanded is the resulting machine
346 expand_machine(Name,Machines,GlobalUses,TypeChecked,Expanded,Ein,Eout) :-
347 debug_format(9,'~nExpanding machine ~w~n',[Name]),
348 % find the machine in the list
349 find_machine(Name,Machines,MType,Header,RawMachineWithPragmas),
350 % remove pragmas for later reattachment
351 strip_machine_section_pragmas(RawMachineWithPragmas,RawMachine,_Pragmas),
352 % look for abstract machine
353 get_abstractions(Name,Machines,TypeChecked,Abstractions),
354 % merge all used and seen machines
355 use_and_see_machines(RawMachine,TypeChecked,SeenRefs),
356 % merge all included machines into one machine
357 include_machines(RawMachine, TypeChecked, GlobalUses, Includes, Parameters, Included, Promotes),
358 % Parameters contains now a list of parameters for each included machine
359 % Included contains now a machine that represents all included machines
360 % their parameters are renamed to internal_parameters
361 append([Abstractions,Included,SeenRefs],RefMachines),
362 % typecheck this machine
363 debug_stats(type_machine(Name)),
364 ? type_machine(Header,Name,MType,RawMachine,RefMachines,TypedLocal,RefMachines2,Ein,Err1),
365 % merge included and including machine
366 debug_stats(merge_included_machines(Name)),
367 merge_included_machines(Name,TypedLocal,Included,Promotes,Expanded2,Err1,Err2),
368 % add some predicates that state the equivalence between arguments
369 % in the include statement and the parameters of the included machine
370 add_link_constraints(Includes,MType,Parameters,RefMachines2,Expanded2,Expanded3,Err2,Err3),
371 % put together refinement and abstraction.
372 merge_refinement_and_abstraction(Name,Expanded3,[ref(local,TypedLocal)|RefMachines2],Expanded4,Err3,Eout),
373 % merge used machines, will also prefix
374 debug_stats(merge_used_machines(Name)),
375 merge_used_machines(Included,Expanded4,Expanded5),
376 % clean up the syntax tree
377 debug_stats(clean_up_machine(Name)),
378 clean_up_machine(Expanded5,RefMachines2,Expanded),
379 debug_stats(finished_clean_up_and_expand_machine(Name)).
380
381 strip_machine_section_pragmas(RawMachineWithPragmas,RawMachine,Pragmas) :-
382 selectchk(units(_Pos,RealVariables,Pragmas),RawMachineWithPragmas,TRawMachine), !,
383 RawMachine = [RealVariables|TRawMachine].
384 strip_machine_section_pragmas(Machine,Machine,[]).
385
386 merge_included_machines(Name, TypedLocal, RefMachines, Promotes, Merged, Ein, Eout) :-
387 (Promotes=[] -> true ; assertz(machine_promotes_operations(Name,Promotes))),
388 include(is_included_ref,RefMachines,Included),
389 create_machine(Name,Empty),
390 % move the included operations into the promoted or unpromoted section
391 move_operations(Included,Promotes,Included2,Ein,Eout),
392 LocalAndIncluded = [ref(local,TypedLocal)|Included2],
393 % TODO: make sure that the constants of two instances of the same machine do not repeat (check what should be done for distinct machines with same identifiers)
394 concat_sections_of_refs([identifiers,initialisation,operation_bodies,
395 assertions,used,values],LocalAndIncluded,Empty,Merged1),
396 conjunct_sections_of_refs([constraints,properties,invariant],LocalAndIncluded,Merged1,Merged2),
397 concat_section_of_simple_lists(freetypes,LocalAndIncluded,Merged2,Merged3),
398 get_section(definitions,TypedLocal,Defs),
399 write_section(definitions,Defs,Merged3,Merged).
400 is_included_ref(ref(included,_)).
401
402 concat_section_of_simple_lists(Sec,References,In,Out) :-
403 maplist(extract_machine_from_ref,References,Machines),
404 sort_machines_by_global_order(Machines,OMachines),
405 foldl(concat_section_of_simple_lists2(Sec),OMachines,In,Out).
406 concat_section_of_simple_lists2(Sec,Machine,In,Out) :-
407 get_section(Sec,In,Orig),
408 get_section(Sec,Machine,List),
409 append(Orig,List,NewList),
410 write_section(Sec,NewList,In,Out).
411
412 merge_used_machines(RefMachines,Old,New) :-
413 % get all included machines from the references
414 convlist(ref_to_included_machine,RefMachines,Included),
415 foldl(merge_used_machines2,Included,Old,New).
416 merge_used_machines2(Included,Old,New) :-
417 get_section(used,Included,IncludedUse),
418 map_split_list(useful_renaming,IncludedUse,RenamingList,_),
419 (RenamingList = [] -> New = Old ; rename_used(RenamingList,Old,New)).
420 ref_to_included_machine(ref(included,Inc),Inc).
421
422 % the renaming does not add a prefix; happens for constants in used/seen machines
423 useless_renaming(includeduse(_Mach,ID,TID)) :- get_texpr_id(TID,ID).
424 useful_renaming(includeduse(_Mach,ID,TID),rename(ID,NewID)) :- get_texpr_id(TID,NewID), NewID \= ID.
425
426
427 % will add prefixes to identifiers
428 % TODO: unclear to me why this cannot be done by rename_bt? Is it for treating SEEN machines not included?
429 rename_used(RenamingList,Old,New) :-
430 expand_shortcuts([properties,invariant, assertions,
431 initialisation,operation_bodies],Sections), % TO DO: also traverse GOAL ? should we later apply this at the REPL level as well ? should we apply it to other DEFINITIONS ?
432 foldl(rename_used_sec(RenamingList),Sections,Old,New).
433 rename_used_sec(RenamingList,Sec,Old,New) :-
434 select_section_texprs(Sec,TExprs,NewTExprs,Old,New),
435 rename_used2_l(TExprs,RenamingList,NewTExprs).
436
437 rename_used2(TExpr,RenamingList,NewTExpr) :-
438 get_texpr_expr(TExpr,operation(Id,Params,Results,Subst)),!,
439 get_texpr_exprs(Params,Ps),
440 remove_renamings(Ps,RenamingList,NRenamings0),
441 get_texpr_exprs(Results,Rs),
442 remove_renamings(Rs,NRenamings0,NRenamings),
443 rename_used2_l(Params,NRenamings,NParams), % should normally do nothing; unless variable capture occurs
444 rename_used2_l(Results,NRenamings,NResults), % ditto
445 rename_used2(Subst,NRenamings,NSubst),
446 get_texpr_type(TExpr,Type),
447 get_texpr_info(TExpr,Info),
448 l_rename_info(Info,NRenamings,NewInfo),
449 create_texpr(operation(Id,NParams,NResults,NSubst),Type,NewInfo,NewTExpr).
450 rename_used2(TExpr,RenamingList,NewTExpr) :-
451 % rename identifier by adding machine prefix M.id
452 get_texpr_id(TExpr,_), % result is also Id (always ??)
453 TExpr = b(_,Type,Info),
454 member(usesee(_MachName,Id,_UseOrSeeMode),Info), % TODO: do we need to check MachName matches includeduse/3 above?
455 member(rename(Id,NewId),RenamingList),
456 % we now rename Id to Name.Id
457 !, NewTExpr = b(identifier(NewId),Type,Info).
458 %add_message(rename,'Rename ID: ',TExpr,Info),add_message(rename,'Rename ID: ',NewTExpr,NewTExpr).
459 rename_used2(TExpr,RenamingList,NTExpr1) :-
460 remove_bt(TExpr,Expr,NExpr,NTExpr),
461 syntaxtransformation_for_renaming(Expr,Subs,TNames,NSubs,NExpr),!,
462 get_texpr_exprs(TNames,Names),
463 remove_renamings(Names,RenamingList,NRenamings),
464 rename_used2_l(Subs,NRenamings,NSubs),
465 rename_infos(NTExpr,NRenamings,NTExpr1).
466 rename_used2(TExpr,RenamingList,NTExpr) :-
467 add_internal_error('Rename failed: ',rename_used2(TExpr,RenamingList,NTExpr)),
468 NTExpr = TExpr.
469
470 % update infos, e.g., read/modifies for while loops
471 rename_infos(b(E,T,I),RenamingList,b(E,T,NI)) :-
472 l_rename_info(I,RenamingList,NI).
473
474 l_rename_info([],_,[]).
475 l_rename_info([Info|T],RenamingList,[NewInfo|NT]) :-
476 rename_info(RenamingList,Info,NewInfo),
477 l_rename_info(T,RenamingList,NT).
478
479 rename_info(RenamingList,Info,NewInfo) :- info_field_contains_ids(Info,I,NewInfo,SNI),!,
480 maplist(rename_usage_info(RenamingList),I,NI), sort(NI,SNI).
481 rename_info(_,I,I).
482
483 info_field_contains_ids(reads(I),I,reads(SNI),SNI).
484 info_field_contains_ids(modifies(I),I,modifies(SNI),SNI).
485 info_field_contains_ids(non_det_modifies(I),I,non_det_modifies(SNI),SNI).
486 info_field_contains_ids(modifies_locals(I),I,modifies_locals(SNI),SNI).
487 info_field_contains_ids(reads_locals(I),I,reads_locals(SNI),SNI).
488 info_field_contains_ids(used_ids(I),I,used_ids(SNI),SNI).
489
490 rename_usage_info(RenamingList,ID,NewID) :-
491 (member(rename(ID,NewID),RenamingList) -> true ; NewID = ID).
492
493
494 rename_used2_l([],_,R) :- !, R=[].
495 rename_used2_l([T|Rest],RenamingList,[NT|NRest]) :-
496 rename_used2(T,RenamingList,NT), !,
497 rename_used2_l(Rest,RenamingList,NRest).
498 rename_used2_l(X,Y,Z) :- add_internal_error('Rename failed: ', rename_used2_l(X,Y,Z)),Z=X.
499
500 rename_used_ids(InIds,RenamingList,OutIds) :-
501 maplist(rename_used_ids2(RenamingList),InIds,OutIds).
502 rename_used_ids2(RenamingList,InId,OutId) :-
503 memberchk(rename(InId,I2),RenamingList),!, OutId=I2.
504 rename_used_ids2(_RenamingList,Id,Id).
505
506 get_abstractions(CName,Machines,TypedMachines,[ref(abstraction,Abstraction)]) :-
507 ? refines(M,AName),
508 get_constructed_machine_name(M,CName),
509 memberchk(M,Machines),!,
510 memberchk(machine(AName,Abstraction),TypedMachines).
511 get_abstractions(_,_,_,[]).
512
513 get_includes_and_promotes(Sections,M,Includes,Promotes) :-
514 optional_rawmachine_section(includes,Sections,[],Includes1),
515 optional_rawmachine_section(imports,Sections,[],Imports),
516 optional_rawmachine_section(extends,Sections,[],Extends),
517 optional_rawmachine_section(promotes,Sections,[],Promotes1),
518 append([Includes1,Extends,Imports],Includes),
519 maplist(expand_extends(M),Extends,Promotes2),
520 append([Promotes1|Promotes2],Promotes).
521 expand_extends(Machines,machine_reference(_,Ref,_),Promotes) :-
522 split_prefix(Ref,Prefix,Name),
523 memberchk(machine(Name,Body),Machines),
524 get_section(promoted,Body,Promoted),
525 prefix_identifiers(Promoted,Prefix,Renamings),
526 rename_bt_l(Promoted,Renamings,TPromotes),
527 maplist(add_nonpos,TPromotes,Promotes).
528 add_nonpos(TId,identifier(none,Id)) :-
529 get_texpr_id(TId,op(Id)).
530
531 move_operations([],Promotes,[],Ein,Eout) :-
532 foldl(add_promotes_not_found_error,Promotes,Ein,Eout).
533 move_operations([ref(_,IncMachine)|IncRest],Promotes,[ref(included,NewIncMachine)|RefRest],Ein,Eout) :-
534 move_operations2(IncMachine,Promotes,NewIncMachine,RestPromotes),
535 move_operations(IncRest,RestPromotes,RefRest,Ein,Eout).
536 move_operations2(Included,Promotes,Result,RestPromotes) :-
537 select_section(promoted,IncOperations,Promoted,Included,Included1),
538 select_section(unpromoted,OldUnpromoted,Unpromoted,Included1,Result),
539 filter_promoted(IncOperations,Promotes,Promoted,NewUnpromoted,RestPromotes),
540 append(OldUnpromoted,NewUnpromoted,Unpromoted).
541 filter_promoted([],Promotes,[],[],Promotes).
542 filter_promoted([TExpr|OpsRest],Promotes,Promoted,Unpromoted,RestPromotes) :-
543 get_texpr_id(TExpr,op(P)),
544 ( select(identifier(_,P),Promotes,RestPromotes1) ->
545 !,Promoted = [TExpr|RestPromoted],
546 Unpromoted = RestUnpromoted
547 ;
548 RestPromotes1 = Promotes,
549 Promoted = RestPromoted,
550 Unpromoted = [TExpr|RestUnpromoted]),
551 filter_promoted(OpsRest,RestPromotes1,RestPromoted,RestUnpromoted,RestPromotes).
552 add_promotes_not_found_error(identifier(Pos,Id),[error(Msg,Pos)|E],E) :-
553 ajoin(['Promoted operation ',Id,' not found'],Msg).
554
555 find_machine(Name,Machines,Type,Header,Sections) :-
556 Header = machine_header(_,Name,_),
557 ? ( (member(abstract_machine(_,_ModelType,Header,Sections),Machines),
558 Type=machine)
559 ; (member(refinement_machine(_,Header,_Abstract,Sections),Machines),
560 Type=refinement)
561 ; (member(implementation_machine(_,Header,_Abstract,Sections),Machines),
562 Type=implementation)),
563 !.
564
565 include_machines(RawMachine, TypeChecked, GlobalUses, Includes, Parameters, Included, Promotes) :-
566 get_includes_and_promotes(RawMachine,TypeChecked,Includes,Promotes),
567 maplist(include_machine(TypeChecked, GlobalUses), Includes, Parameters, Singles),
568 remove_duplicate_set_inclusions(Singles,Singles1),
569 % duplicate constants inclusion is handled currently in concat_section_contents via section_can_have_duplicates
570 % create refs
571 maplist(create_ref,Singles1,Included).
572 create_ref(IncMachine,ref(included,IncMachine)).
573
574 % it is possible that a deferred or enumerated set is declared in an included machine
575 % that is included more than once. We remove all but one occurrences.
576 remove_duplicate_set_inclusions([],[]).
577 remove_duplicate_set_inclusions([M],[M]) :- !.
578 remove_duplicate_set_inclusions([M|Rest],[M|CleanedRest]) :-
579 get_section(deferred_sets,M,DSets),
580 get_section(enumerated_sets,M,ESets),
581 get_section(enumerated_elements,M,EElements),
582 append([DSets,ESets,EElements],Identifiers),
583 sort(Identifiers,SortedIds),
584 maplist(remove_duplicate_sets2(SortedIds),Rest,Rest2),
585 remove_duplicate_set_inclusions(Rest2,CleanedRest).
586 remove_duplicate_sets2(Identifiers,M,Cleaned) :-
587 remove_duplicate_sets_section(deferred_sets,Identifiers,M,M1),
588 remove_duplicate_sets_section(enumerated_sets,Identifiers,M1,M2),
589 remove_duplicate_sets_section(enumerated_elements,Identifiers,M2,Cleaned).
590 remove_duplicate_sets_section(Section,Identifiers,In,Out) :-
591 select_section(Section,Old,New,In,Out),
592 %get_texpr_ids(Identifiers,II),format('Removing duplicates ~w = ~w~n',[Section,II]),
593 exclude(element_is_duplicate(Identifiers),Old,New).
594
595 element_is_duplicate(Identifiers,TId) :-
596 get_texpr_id(TId,Name),
597 get_texpr_type(TId,Type),
598 get_texpr_id(ToRemove,Name),
599 get_texpr_type(ToRemove,Type),
600 ord_member_nonvar_chk(ToRemove,Identifiers),
601 get_texpr_info(TId,InfosA),
602 get_texpr_info(ToRemove,InfosB),
603 member(def(Sec,File),InfosA),
604 member(def(Sec,File),InfosB),
605 debug_format(5,'Removed duplicate included identifier: ~w~n',[Name]),
606 !.
607
608 include_machine(TypeChecked,GlobalUses,machine_reference(_Pos,FullRef,_Args),
609 parameters(FullRef,Parameters), TM) :-
610 split_prefix(FullRef,Prefix,Name),
611 % TM1 is the already typechecked included machine:
612 ? member(machine(Name,TM1),TypeChecked),!,
613 debug_println(9,including_machine(Name)),
614 % TM2 is a fresh copy, so we prevent unification of the parameter types:
615 (get_section(parameters,TM1,[]) -> TM2=TM1
616 ; copy_term(TM1,TM2) % this can be expensive; only copy if there are parameters
617 ),
618 % If the included machine is used somewhere, we store the identifiers
619 % to enable joining the different references later:
620 include_usings(Name,GlobalUses,TM2,TM3),
621 % TM3 is typechecked and all internal variables are renamed with a prefix
622 hide_private_information(Name,FullRef,TM3,TM4),
623 % TM4 is typechecked, and if it was referenced with a prefix (e.g. INCLUDES p.M2)
624 % all variables are prefixed
625 %print(prefixing(Prefix)),nl,
626 prefix_machine(Prefix,TM4,TM5),
627 % We need the parameters later to state their equivalence to the arguments
628 get_section(parameters,TM5,Parameters),
629 % We move the parameters to the internal parameters, because the resulting
630 % machine has only the parameters of the including machine.
631 parameters_to_internal(TM5,TM).
632
633 include_usings(Name,GlobalUses,Old,New) :-
634 ? ( member(usemch(Name,Prefix,_Kind,_FromMch,_Pos),GlobalUses) ->
635 add_machine_prefix(Name,Prefix,FullName),
636 store_usage_info(Old,FullName,UsedInfo),
637 append_to_section(used,UsedInfo,Old,New)
638 ;
639 Old = New).
640 % returns a list of which identifiers are used in the machine
641 % for each identifier, we have a trible includeuse(Name,Id,TExpr)
642 % where Name is the name of the used machine, Id is the
643 % original ID and TExpr is the currently used reference to this
644 % identifier
645 store_usage_info(Machine,Name,UsedInfo) :-
646 expand_shortcuts([identifiers],IdSections),
647 foldl(store_usage_info2(Machine,Name),IdSections,UsedInfo,[]).
648 store_usage_info2(Machine,Name,Sec,I,O) :-
649 get_section(Sec,Machine,Content),
650 foldl(store_usage_info3(Name),Content,I,O).
651 store_usage_info3(Name,TId,[includeduse(Name,Id,TId)|L],L) :-
652 get_texpr_id(TId,Id).
653
654 % conjunct sections that contain predicates (CONSTRAINTS, PROPERTIES, INVARIANT)
655 conjunct_sections_of_refs(Sections1,References,Old,New) :-
656 expand_shortcuts(Sections1,Sections),
657 maplist(extract_machine_from_ref,References,Machines),
658 sort_machines_by_global_order(Machines,OMachines),
659 foldl(conjunct_sections2(OMachines),Sections,Old,New).
660 conjunct_sections2(Machines,Section,Old,New) :-
661 % Section is constraints,properties,invariant, ...
662 write_section(Section,NewContent,Old,New), % prepare new section
663 get_section_of_machines(Machines,Section,Preds),
664 %maplist(get_machine_name,Machines,Ns),print(got_sections(Section,Ns)),nl,
665 %translate:l_print_bexpr_or_subst(Preds),nl,
666 conjunct_predicates(Preds,NewContent).
667
668
669 % merge sections that contain a list of expressions/formulas like identifiers, assertions, ...
670 concat_sections_of_refs(Sections1,References,Old,New) :-
671 maplist(extract_machine_from_ref,References,Machines),
672 maplist(create_tag_by_reference,References,Tags),
673 sort_machines_by_global_order(Machines,Tags,OMachines,STags),
674 % should we only sort for some sections, e.g., assertions
675 % for each machine, create a tag where the expression comes from
676 concat_sections(Sections1,OMachines,STags,Old,New).
677
678 extract_machine_from_ref(ref(_,M),M).
679
680 create_tag_by_reference(ref(local,_Machine),[]) :- !.
681 create_tag_by_reference(ref(RefType,Machine),[RefType/Name]) :-
682 get_machine_name(Machine,Name).
683
684 concat_sections(Sections1,Machines,Tags,Old,New) :-
685 expand_shortcuts(Sections1,Sections),
686 foldl(concat_section2(Machines,Tags),Sections,Old,New).
687 concat_section2(Machines,Tags,Section,Old,New) :-
688 write_section(Section,NewContent,Old,New),
689 maplist(get_tagged_lsection_of_machine(Section),Machines,Tags,Contents),
690 concat_section_contents(Section,Contents,NewContent).
691
692 concat_section_contents(_,[SingleContent],Res) :- !, Res=SingleContent. % no need to remove_dups
693 concat_section_contents(Section,Contents,NewContent) :-
694 append(Contents,ConcContents),
695 (section_can_have_duplicates(Section)
696 -> remove_dup_tids_keep_order(ConcContents,NewContent)
697 ; NewContent=ConcContents).
698
699 % remove_dups version which keeps order of original elements
700 % and works with typed identifiers
701 % used if a machine is seen multiple times with different prefixes for e.g. constants
702 % see Section 7.26 of Atelier-B handbook:
703 % nom des éléments énumérés et des constantes de MSees, sans le préfixe de
704 % renommage, si plusieurs instances de machines sont vues, les noms des
705 % données ne doivent pas être répétés,
706 remove_dup_tids_keep_order([],[]).
707 remove_dup_tids_keep_order([H|T],[H|Res]) :- empty_avl(E),
708 get_texpr_id(H,ID),avl_store(ID,E,true,A1),
709 rem_dups3(T,A1,Res).
710
711 rem_dups3([],_,[]).
712 rem_dups3([H|T],AVL,Res) :-
713 get_texpr_id(H,ID),
714 (avl_fetch(ID,AVL) -> rem_dups3(T,AVL,Res)
715 ; Res=[H|TRes],
716 avl_store(ID,AVL,true,AVL1),
717 rem_dups3(T,AVL1,TRes)).
718
719 % see issue PROB-403
720 section_can_have_duplicates(X) :- section_can_be_included_multiple_times_nonprefixed(X).
721 % should we also remove duplicates in PROPERTIES section ? cf. machines used in test 1857
722
723
724 get_tagged_lsection_of_machine(Section,Machine,Tags,TaggedContent) :-
725 get_section(Section,Machine,Content),
726 (Tags=[] -> TaggedContent=Content ; maplist(tag_with_origin(Tags),Content,TaggedContent)).
727
728 tag_with_origin(Origins,TExpr,TaggedExpr) :-
729 change_info_of_expression_or_init(TExpr,Info,TaggedInfo,TaggedExpr),
730 % add a new origin to the old tag or if not existent, add a new info field
731 ( Origins = [] -> TaggedInfo = Info
732 ; selectchk(origin(Orest),Info,origin(Onew),TaggedInfo) -> append(Origins,Orest,Onew)
733 ; TaggedInfo = [origin(Origins)|Info]).
734 % the substitutions in the initialisation are additionally wrapped by an init_stmt/2 term
735 % a small hack to work with those too.
736 % TODO: this became a very ugly hack -- redo!
737 change_info_of_expression_or_init(init_stmt(A,OExpr),Old,New,init_stmt(A,NExpr)) :- % ...
738 !,change_info_of_expression_or_init(OExpr,Old,New,NExpr).
739 % ignore the info for includeduse/3 completely
740 change_info_of_expression_or_init(includeduse(A,B,C),[],_,includeduse(A,B,C)) :- !.
741 change_info_of_expression_or_init(freetype(FTypeId,Cases),[],_,freetype(FTypeId,Cases)) :- !.
742 change_info_of_expression_or_init(OExpr,Old,New,NExpr) :-
743 create_texpr(Expr,Type,Old,OExpr),!,
744 create_texpr(Expr,Type,New,NExpr).
745 change_info_of_expression_or_init(OExpr,Old,New,NExpr) :-
746 add_internal_error('Illegal typed expression:',change_info_of_expression_or_init(OExpr,Old,New,NExpr)),
747 Old=[], NExpr=OExpr.
748
749 % adds a prefix to all variables and promoted operations
750 prefix_machine('',TM,TM) :- !.
751 prefix_machine(Prefix,Old,New) :-
752 debug_println(5,prefixing_machine(Prefix)),
753 expand_shortcuts([variables,promoted], RenamedIdentiferSections),
754 get_all_identifiers(RenamedIdentiferSections,Old,Identifiers),
755 prefix_identifiers(Identifiers,Prefix,Renamings),
756 find_relevant_sections(RenamedIdentiferSections,[machine],Sections1),
757 append(RenamedIdentiferSections,Sections1,Sections),
758 rename_in_sections(Sections,Renamings,Old,M),
759 rename_includeduse(M,Renamings,New).
760 rename_includeduse(Old,Renamings,New) :-
761 select_section(used,OldContent,NewContent,Old,New),
762 maplist(rename_includeduse2(Renamings),OldContent,NewContent).
763 rename_includeduse2(Renamings,includeduse(M,N,TExpr),includeduse(M,N,NExpr)) :-
764 rename_bt(TExpr,Renamings,NExpr).
765
766 get_all_identifiers(Sections1,M,Identifiers) :-
767 expand_shortcuts(Sections1,Sections),
768 maplist(get_all_identifiers2(M),Sections,LIdentifiers),
769 append(LIdentifiers,Identifiers).
770 get_all_identifiers2(M,Sec,Identifiers) :-
771 get_section(Sec,M,Identifiers).
772
773 % hide all parameters and unpromoted operations
774 hide_private_information(MachName,Prefix,Machine,NewMachine) :-
775 get_section(parameters,Machine,Params),
776 get_section(unpromoted,Machine,UnPromoted),
777 append(Params,UnPromoted,ToHide),
778 %debug_println(9,hide_private(Prefix,ToHide)),
779 ( ToHide = [] -> NewMachine=Machine
780 ;
781 debug_format(9,'Hiding private parameters ~w and unpromoted operations ~w of machine ~w~n',
782 [Params,UnPromoted,MachName]),
783 maplist(store_hides_operation_info(MachName,Prefix),UnPromoted),
784 prefix_identifiers(ToHide,Prefix,Renamings),
785 % we have to do the renaming in promoted operations, too, because
786 % those operations might use the renamed parameters and their reads/modifies
787 % info must be updated
788 rename_in_sections([parameters,promoted,unpromoted],Renamings,Machine,Machine1),
789 rename_includeduse(Machine1,Renamings,Machine2),
790 % now find sections that can see parameters,operations:
791 rename_relevant_sections([parameters,operations],Renamings,Machine2,NewMachine)
792 ).
793
794 % store information about which operations got renamed:
795 store_hides_operation_info(MachName,Prefix,TExpr) :- Prefix \= '',
796 prefix_identifier(Prefix,TExpr,rename(op(Old),op(New))),
797 get_texpr_pos(TExpr,Pos),
798 !,
799 debug_format(19,'Hiding unpromoted operation ~w in machine ~w, new name: ~w~n',[Old,MachName,New]),
800 assertz(machine_hides_unpromoted_operation(Old,MachName,New,Pos)).
801 store_hides_operation_info(_,_,_).
802
803 prefix_identifiers(Identifiers,'',Identifiers) :- !.
804 prefix_identifiers(Old,Prefix,New) :-
805 maplist(prefix_identifier(Prefix),Old,New).
806 prefix_identifier(Prefix,TExpr,rename(Old,New)) :-
807 get_texpr_expr(TExpr,identifier(Old)),
808 (Old=op(OI) -> New=op(NI) ; OI=Old,NI=New),
809 ajoin([Prefix,'.',OI],NI). % , print(rename(Old,New)),nl.
810
811 parameters_to_internal(M1,M2) :-
812 select_section(internal_parameters,OldParams,Params,M1,M3),
813 select_section(parameters,NewParams,[],M3,M2),
814 append(OldParams,NewParams,Params).
815
816 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
817 % uses and sees relations
818 find_uses(Machines,GlobalUses,NotIncludedWoDups,Ein,Eout) :-
819 findall(usemch(UsedMch,UPrefix,Kind,FromMchName,Pos),
820 use_usage(Machines,Pos,Kind,UsedMch,UPrefix,FromMchName), UnsortedUses),
821 sort(UnsortedUses,Uses),
822 check_include_use(Uses,Machines,NotIncluded,Ein,Eout),
823 remove_duplicate_uses(NotIncluded,NotIncludedWoDups),
824 GlobalUses = Uses. %maplist(remove_prefix,Uses,GlobalUses).
825
826 %remove_prefix(usemch(U,_,_,_,_),U).
827 same_usemch(usemch(U,Prefix,_,_,_),usemch(U,Prefix,_,_,_)). % use same machine with same prefix
828 same_usemch(usemch_not_inc(U,Prefix,_,_,_,_),usemch_not_inc(U,Prefix,_,_,_,_)).
829
830 % remove duplicate uses: a non-included/imported machine can be seen in many places;
831 % we only need to add it later once to the dummy machine
832 remove_duplicate_uses([],R) :- !, R=[].
833 remove_duplicate_uses([USE|T],Res) :- remove_dup_aux(T,USE,Res).
834 remove_dup_aux([],USE,[USE]).
835 remove_dup_aux([USE|T],PREVUSE,Res) :-
836 (same_usemch(USE,PREVUSE) -> remove_dup_aux(T,PREVUSE,Res)
837 ; Res = [PREVUSE|TR], remove_dup_aux(T,USE,TR)).
838
839
840 % check_include_use/5 checks if the used machines are included in any machine
841 % check_include_use(+Uses,+Machines,-NotIncluded,Ein,Eout)
842 % Uses: The list of machine names that are used
843 % Machines: The list of machines
844 % NotIncluded: The list of used machines (their names) that are not included
845 % Ein/Eout: The errors (as difference-list)
846 check_include_use([],_,[],Errors,Errors).
847 check_include_use([USEMCH|Rest],Machines,NotIncluded,Ein,Eout) :-
848 USEMCH = usemch(UsedMach,UsePrefix,Kind,FromMchName,Pos),
849 findall(i(MachName,UsePrefix,IPos),include_usage(Machines,UsedMach,UsePrefix,MachName,IPos),Inc),
850 ( Inc=[] -> Ein=E1,
851 % find all places where the machine is included with another prefix
852 findall(OtherPrefix,include_usage(Machines,UsedMach,OtherPrefix,_,_IPos),OtherInclusions),
853 NotIncluded = [usemch_not_inc(UsedMach,UsePrefix,Kind,FromMchName,Pos,OtherInclusions)|RestNotIncluded],
854 (debug_mode(off),OtherInclusions=[],UsePrefix='' -> true
855 ; add_machine_prefix(UsedMach,UsePrefix,FullName),
856 (OtherInclusions=[]
857 -> ajoin(['machine ',Kind, ' in ', FromMchName,
858 ' not included/imported anywhere else (will create dummy top-level machine to include it): '],Msg)
859 ; ajoin_with_sep(OtherInclusions,',',I2),
860 (UsePrefix=''
861 -> ajoin(['machine ',Kind, ' in ', FromMchName,
862 ' without prefix only included/imported with prefixes [',I2,
863 '] (will create dummy top-level machine to include it): '],Msg)
864 ; I2=''
865 -> ajoin(['machine ',Kind, ' in ', FromMchName,
866 ' only included/imported without prefix (will create dummy top-level machine to include it): '],Msg)
867 ; ajoin(['machine ',Kind, ' in ', FromMchName, ' only included/imported with other prefixes [',I2,
868 '] (will create dummy top-level machine to include it): '],Msg)
869 )
870 ),
871 add_message(bmachine_construction,Msg,FullName,Pos)
872 )
873 ; Inc=[_] -> NotIncluded = RestNotIncluded, Ein=E1
874 ; Inc=[i(_M1,_,Pos1),i(_M2,_,Pos2)|_],
875 NotIncluded = RestNotIncluded,
876 translate_span(Pos1,PS1),
877 translate_span(Pos2,PS2),
878 (UsePrefix = ''
879 -> ajoin([Kind,' machine ',UsedMach,' is included more than once: ',PS1,' and ',PS2],Msg)
880 ; ajoin([Kind,' machine ',UsedMach,' is included more than once with prefix ',UsePrefix,
881 ': ',PS1,' and ',PS2],Msg)
882 ),
883 Ein = [error(Msg,Pos)|E1]
884 ),
885 check_include_use(Rest,Machines,RestNotIncluded,E1,Eout).
886 % extend_not_included_uses(+Uses,+Main,-Name,+Machines,-AllMachines):
887 % Create a dummy machine that extends the main machine and extends or includes
888 % all seen/used machines that are not included if such machines exist.
889 % In case of refinement this is done for the whole refinement chain.
890 % Uses: List of machine names and prefix usemch/2 of the machines that are used/seen but not included
891 % Main: The name of the main machine
892 % Name: The name of the generated dummy machine (or Main if no dummy machine is generated)
893 % Machines: List of all specified Machines
894 % AllMachines: List of all Machines + the new dummy machine(s)
895 extend_not_included_uses([],Main,Main,Machines,Machines) :- !.
896 extend_not_included_uses(Uses,Main,NewMainName,Machines,AllMachines) :-
897 get_refinement_hierarchy(Main,Machines,RefChain),
898 maplist(extend_not_included_uses2(Uses,Machines),RefChain,NewMachines),
899 append(NewMachines,Machines,AllMachines),
900 dummy_machine_name(Main,NewMainName),
901 debug_format(19,'Creating dummy machine called ~w for main machine~n',[NewMainName]).
902 extend_not_included_uses2(Uses,Machines,Name,DummyMachine) :-
903 debug_format(19,'Creating dummy subsidiary machine for refined machine ~w~n',[Name]),
904 create_dummy_machine(Name,Machines,Parameters,DummyParameters,Sections,DummyMachine),
905 IncludeMain = machine_reference(none,Name,Parameters),
906 ( get_preference(seen_machines_included,true) ->
907 % extend just the main machine, include the used/seen machines
908 References = [extends(none,[IncludeMain]),includes(none,UReferences)]
909 ;
910 % extends the main machine and all used/seen machines
911 References = [extends(none,[IncludeMain|UReferences])]),
912 maplist(find_using(Machines),Uses,UReferences,LUParameters),
913 append([Parameters|LUParameters],DummyParameters),
914 copy_raw_definitions(Name,Machines,OptDefs),
915 % we store a flag "is_dummy" in the machine because we have a special case
916 % later, see type_constraints/7.
917 append([References,[is_dummy],OptDefs],Sections).
918 create_dummy_machine(Name,Machines,Parameters,DummyParameters,Sections,DummyMachine) :-
919 dummy_machine_name(Name,DummyName),
920 ? get_raw_model_type(Name,Machines,ModelType),
921 !,
922 Header = machine_header(_,Name,Parameters),
923 DummyHeader = machine_header(none,DummyName,DummyParameters),
924 ? member(Machine,Machines),
925 ? generate_raw_machine(Header,DummyHeader,ModelType,Sections,Machine,DummyMachine),!.
926
927 generate_raw_machine(OldHeader,NewHeader,_,NewSections,
928 abstract_machine(_, ModelType,OldHeader,_),
929 abstract_machine(none,ModelType,NewHeader,NewSections)).
930 generate_raw_machine(OldHeader,NewHeader,ModelType,NewSections,
931 refinement_machine(_, OldHeader,_Abstract, _),
932 abstract_machine(none,ModelType,NewHeader,NewSections)).
933 generate_raw_machine(OldHeader,NewHeader,ModelType,NewSections,
934 implementation_machine(_, OldHeader,_Abstract, _),
935 abstract_machine(none,ModelType,NewHeader,NewSections)).
936
937 dummy_machine_name(Name,DummyName) :-
938 atom_concat('MAIN_MACHINE_FOR_',Name,DummyName).
939
940 add_machine_prefix(UsedMch,'',Name) :- !, UsedMch=Name.
941 add_machine_prefix(UsedMch,UsePrefix,Name) :- ajoin([UsePrefix,'.',UsedMch],Name).
942
943 find_using(Machines,usemch_not_inc(UsedMch,UsePrefix,_,_,_,OtherPrefixes),
944 machine_reference(none,Name,Arguments),Arguments) :-
945 % invent a dummy prefix for the SEEN/USED machine which is not included
946 % to avoid name-clashes with main machine
947 % was using(U).U, but awkward to type in REPL
948 % try machine name itself; unless somewhere else it is included this way
949 (member(UsedMch,OtherPrefixes) % somewhere we already have an INCLUDES UsedMach.UsedMach
950 -> DummyPrefix = using(UsedMch)
951 ; DummyPrefix = UsedMch),
952 ajoin([DummyPrefix,'.',UsedMch],Name0),
953 add_machine_prefix(Name0,UsePrefix,Name),
954 ? member(M,Machines), get_machine_parameters(M,UsedMch,Params,_),!,
955 maplist(add_use_param,Params,Arguments).
956 add_use_param(identifier(_,Param),identifier(none,Name)) :-
957 ( is_upper_case(Param) ->
958 ajoin(['Useparam(',Param,')'],Name)
959 ;
960 ajoin(['useparam(',Param,')'],Name)).
961
962 % copy_raw_definitions(+Name,+Machines,-OptDefs):
963 % Get the definitions section from a raw (untyped) machine
964 % Name: Name of the machine
965 % Machines: List of Machines
966 % OptDefs: [] if no definitions are present or [Def] if a definition section Def is present
967 copy_raw_definitions(Name,Machines,OptDefs) :-
968 ? get_constructed_machine_name_and_body(M,Name,_,Sections),
969 memberchk(M,Machines),!,
970 Def = definitions(_,_),
971 ( memberchk(Def,Sections) ->
972 OptDefs = [Def]
973 ;
974 OptDefs = []).
975
976 add_def_dependency_information(DefsIn,DefsOut,Ein,Eout) :-
977 extract_def_name_set(DefsIn,DefNames,DN),
978 maplist(add_def_dep(DN),DefsIn,Defs1),
979 check_for_cyclic_def_dependency(Defs1,DefNames,DefsOut,Ein,Eout).
980
981 extract_def_name_set(Defs,DefNames,DN) :-
982 maplist(get_def_name,Defs,DefNames),
983 maplist(to_mapset_entry,DefNames,DN1),
984 list_to_avl(DN1,DN).
985
986 get_def_name(Def,Name) :- arg(1,Def,Name).
987 get_def_pos(Def,Pos) :- arg(3,Def,Pos).
988 get_def_dependencies(Def,Dependencies) :- arg(6,Def,Dependencies).
989 to_mapset_entry(Name,Name-true).
990
991 add_def_dep(DN,In,Out) :-
992 analyse_definition_dependencies(In,DN,Deps),
993 In = definition_decl(Name,DefType,Pos,Args,RawExpr),
994 Out = definition_decl(Name,DefType,Pos,Args,RawExpr,Deps).
995
996 check_for_cyclic_def_dependency(Defs,DefNames,DefsOut,Ein,Eout) :-
997 % check if we have a cyclic definition:
998 create_definitions_avl(Defs,DefsAvl),
999 search_for_cyclic_definition(DefNames,DefsAvl,[],Pos,RCycle),!,
1000 % if we have found a cyclic definition, generate an error message, ...
1001 reverse(RCycle,Cycle),add_arrows(Cycle,Msg0),
1002 ajoin(['Found cyclic definitions: '|Msg0],Msg),
1003 Ein = [error(Msg,Pos)|E1],
1004 % ... remove the definitions in the cycle (to prevent later infinite loops) ...
1005 exclude(definition_in_list(Cycle),Defs,Defs1),
1006 % ... and check the remaining definitions.
1007 check_for_cyclic_def_dependency(Defs1,DefNames,DefsOut,E1,Eout).
1008 check_for_cyclic_def_dependency(Defs,_DefNames,Defs,E,E).
1009 add_arrows([E],[E]) :- !.
1010 add_arrows([E|Erest],[E,'->'|Arest]) :- add_arrows(Erest,Arest).
1011 definition_in_list(List,Def) :-
1012 get_def_name(Def,Name),memberchk(Name,List).
1013
1014 create_definitions_avl(Defs,DefsAvl) :-
1015 maplist(split_def_name,Defs,Entries),
1016 list_to_avl(Entries,DefsAvl).
1017 split_def_name(Def,Name-Def) :- get_def_name(Def,Name).
1018
1019
1020 % just a depth-first search to find a cycle
1021 search_for_cyclic_definition(DefNames,Definitions,Visited,Pos,Cycle) :-
1022 ? member(Name,DefNames),avl_fetch(Name,Definitions,Definition),
1023 get_def_pos(Definition,Pos),
1024 ( memberchk(Name,Visited) ->
1025 Cycle = [Name|Visited]
1026 ;
1027 get_def_dependencies(Definition,Dependencies),
1028 search_for_cyclic_definition(Dependencies,Definitions,[Name|Visited],_,Cycle)
1029 ).
1030
1031 :- assert_must_succeed((
1032 list_to_avl([def1-true,def2-true,def3-true,def4-true],DefNames),
1033 analyse_definition_dependencies(
1034 conjunct(none,
1035 equals(none,
1036 identifier(none,x),
1037 identifier(none,def1)),
1038 equals(none,
1039 definition(none,def4,
1040 [function(none,
1041 identifier(none,def3),
1042 integer(none,5))]),
1043 identifier(y))),DefNames,Defs),
1044 Defs==[def1,def3,def4]
1045 )).
1046 % analyse_definition_dependencies(+Expr,+DefinitionNames,Deps):
1047 % Expr: raw (i.e. untyped) expression to analyse
1048 % DN: AVL set (i.e. mapping from elements to 'true') of the names of the definitions
1049 % This is needed to decide if an identifier is a reference to a definition
1050 % Deps: A list of used definitions (a list of their names)
1051 analyse_definition_dependencies(Expr,DN,Deps) :-
1052 analyse_definition_dependencies2(Expr,DN,Unsorted,[]),
1053 sort(Unsorted,Deps).
1054 analyse_definition_dependencies2(VAR,_DN) --> {var(VAR)},!,
1055 {add_internal_error('Variable DEFINITION expression in',analyse_definition_dependencies)}.
1056 analyse_definition_dependencies2([Expr|Rest],DN) -->
1057 !, analyse_definition_dependencies2(Expr,DN),
1058 analyse_definition_dependencies2(Rest,DN).
1059 analyse_definition_dependencies2(definition(_Pos,Name,Args),DN) -->
1060 !,[Name],analyse_definition_dependencies2(Args,DN).
1061 analyse_definition_dependencies2(identifier(_Pos,Name),DN) -->
1062 {avl_fetch(Name,DN),!},[Name].
1063 analyse_definition_dependencies2(Expr,DN) -->
1064 { compound(Expr),functor(Expr,_Functor,Arity),!},
1065 analyse_definition_dependencies_arg(2,Arity,Expr,DN).
1066 analyse_definition_dependencies2(_Expr,_DN) --> [].
1067
1068 analyse_definition_dependencies_arg(I,Arity,Expr,DN) -->
1069 { I =< Arity,!,arg(I,Expr,Arg),I2 is I+1 },
1070 analyse_definition_dependencies2(Arg,DN),
1071 analyse_definition_dependencies_arg(I2,Arity,Expr,DN).
1072 analyse_definition_dependencies_arg(_I,_Arity,_Expr,_DN) --> [].
1073
1074
1075 :- use_module(tools_positions, [get_position_filenumber/2]).
1076
1077 get_constructed_machine_name(MachineTerm,Name) :- get_constructed_machine_name_and_body(MachineTerm,Name,_Pos,_).
1078 % name and pos; pos can be used for filenumber
1079 get_constructed_machine_name_and_filenumber(MachineTerm,Name,Filenumber) :-
1080 get_constructed_machine_name_and_body(MachineTerm,Name,Pos,_),
1081 (get_position_filenumber(Pos,FN) -> Filenumber=FN ; Filenumber=unknown).
1082 get_constructed_machine_name_and_body(abstract_machine(_,_ModelType,machine_header(Pos,Name,_),Body),Name,Pos,Body).
1083 get_constructed_machine_name_and_body(refinement_machine(_,machine_header(Pos,Name,_),_Abstract,Body),Name,Pos,Body).
1084 get_constructed_machine_name_and_body(implementation_machine(_,machine_header(Pos,Name,_),_Abstract,Body),Name,Pos,Body).
1085
1086 refines(refinement_machine(_,machine_header(_,_Name,_),Abstract,_Body),Abstract).
1087 refines(implementation_machine(_,machine_header(_,_Name,_),Abstract,_Body),Abstract).
1088
1089 get_machine_parameters(abstract_machine(Pos,_ModelType,machine_header(_,Name,Parameters),_),Name,Parameters,Pos).
1090 get_machine_parameters(refinement_machine(Pos,machine_header(_,Name,Parameters),_,_),Name,Parameters,Pos).
1091 get_machine_parameters(implementation_machine(Pos,machine_header(_,Name,Parameters),_,_),Name,Parameters,Pos).
1092
1093 get_raw_model_type(Main,Machines,ModelType) :-
1094 ? get_constructed_machine_name_and_body(M,Main,_,_),
1095 memberchk(M,Machines),
1096 ( refines(M,RefName) ->
1097 get_raw_model_type(RefName,Machines,ModelType)
1098 ;
1099 M = abstract_machine(_,ModelType,_,_)).
1100
1101 some_machine_name_body(Machines,M,Name,Body) :-
1102 ? member(M,Machines),
1103 get_constructed_machine_name_and_body(M,Name,_,Body).
1104
1105 use_usage(Machines,Pos,Kind,UsedMch,UsePrefix,FromMchName) :-
1106 ? some_machine_name_body(Machines,_,FromMchName,Body),
1107 ? ( member(sees(Pos,R),Body),Kind=seen
1108 ; member(uses(Pos,R),Body),Kind=used),
1109 ? member(identifier(_,PrefixUse),R),
1110 split_prefix(PrefixUse,UsePrefix,UsedMch).
1111 % include_usage/4 checks if there is any machine in Machines that
1112 % includes/extends/imports the used machine
1113 % include_usage(+Machines,+Use,-Name):
1114 % Machines: The list of machines
1115 % UsedMch: The name of the used machine
1116 % UsePrefix: the prefix with which the machine is used
1117 % Name: The name of the machine that imports the used machine
1118 % include_usage/4 fails if there is not such an import
1119 include_usage(Machines,UsedMch,UsePrefix,MachName,Pos) :-
1120 ? some_machine_name_body(Machines,_,MachName,Body),
1121 ( member(includes(_,R),Body)
1122 ; member(extends(_,R), Body)
1123 ; member(imports(_,R), Body)),
1124 member(machine_reference(Pos,PrefixRef,_),R),
1125 % The name could be prefixed, we need it without prefix:
1126 split_prefix(PrefixRef,UsePrefix,UsedMch).
1127
1128 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1129 % uses and sees clauses
1130
1131 % returns a list of references to used and seen machines
1132 % the machines contain only identifier sections and
1133 % the identifier are prefixed accordingly
1134 % all identifier are marked as coming from a seen/used machine
1135 use_and_see_machines(Sections,Machines,References) :-
1136 get_uses_and_sees(Sections,Uses,Sees),
1137 maplist(use_or_see_machine(used,Machines),Uses,Used),
1138 maplist(use_or_see_machine(seen,Machines),Sees,Seen),
1139 append(Used,Seen,References).
1140
1141 % get uses and sees sections from the untyped machines
1142 get_uses_and_sees(Sections,Uses,Sees) :-
1143 get_uses_or_sees2(sees,Sections,Sees),
1144 get_uses_or_sees2(uses,Sections,Uses).
1145 get_uses_or_sees2(Mode,Sections,US) :-
1146 optional_rawmachine_section(Mode,Sections,[],US1),
1147 findall(I,member(identifier(_,I),US1),US).
1148
1149 % Mode is used or seen
1150 use_or_see_machine(Mode,TypedMachines,Ref,ref(Mode,Result)) :-
1151 split_prefix(Ref,Prefix,MachName),
1152 memberchk(machine(MachName,Typed),TypedMachines),
1153 create_machine(MachName,Empty),
1154 use_sections([sets],Mode,'',MachName,Typed,Empty,M1),
1155 use_sections([constants,variables,promoted],Mode,Prefix,MachName,Typed,M1,Result).
1156 use_sections(Sections,Mode,Prefix,MachName,Typed,Old,New) :-
1157 expand_shortcuts(Sections,AllSections),
1158 foldl(use_section(Mode,Prefix,MachName,Typed),AllSections,Old,New).
1159 use_section(Mode,Prefix,MachName,Machine,Section,OldM,NewM) :-
1160 get_section_texprs(Section,Machine,Identifiers),
1161 write_section(Section,NewIds,OldM,NewM),
1162 ( Prefix='' ->
1163 Ids1=Identifiers
1164 ;
1165 prefix_identifiers(Identifiers,Prefix,Renamings),
1166 rename_bt_l(Identifiers,Renamings,Ids1)),
1167 maplist(add_use_info_to_identifier(Mode,MachName),Ids1,NewIds).
1168 add_use_info_to_identifier(Mode,MachName,TExpr,New) :-
1169 get_texpr_id(TExpr,PId), get_texpr_type(TExpr,Type),
1170 get_texpr_id(New,PId), get_texpr_type(New,Type),
1171 split_prefix(PId,_Prefix,Id),
1172 get_texpr_info(TExpr,Info),
1173 get_texpr_info(New,[usesee(MachName,Id,Mode)|Info]).
1174
1175
1176 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1177 % add a section to the machine that describes the linking of
1178 % parameters and arguments
1179 add_link_constraints(Includes,MType,Parameters,RefMachines,Old,New,Ein,Eout) :-
1180 AllRefMachines = [ref(local,Old)|RefMachines],
1181 extract_parameter_types(RefMachines,NonGroundExceptions),
1182 foldl(add_link_section(MType,Parameters,AllRefMachines,NonGroundExceptions),
1183 Includes,Links/Ein,[]/Eout), % TO DO: Daniel check if [] is correct here
1184 %print(conjunct_predicates(Links,Link)),nl,
1185 conjunct_predicates(Links,Link),
1186 select_section(constraints,OConstraints,NConstraints,Old,New),
1187 conjunct_predicates([Link,OConstraints],NConstraints).
1188 add_link_section(MType,Parameters,RefMachines,NonGroundExceptions,
1189 machine_reference(Pos,Ref,Args),Links/Ein,RLinks/Eout) :-
1190 visible_env(MType,includes,RefMachines,Env,Ein,E1),
1191 memberchk(parameters(Ref,TParameters),Parameters),
1192 ( same_length(TParameters, Args) ->
1193 get_texpr_types(TParameters,Types),
1194 btype_ground_dl(Args,Env,NonGroundExceptions,Types,TArgs,E1,Eout),
1195 maplist(create_plink_equality,TParameters,TArgs,LLinks)
1196 ;
1197 E1 = [error('wrong number of machine arguments',Pos)|Eout],
1198 LLinks = []),
1199 append(LLinks,RLinks,Links).
1200 create_plink_equality(P,A,E) :-
1201 create_texpr(equal(P,A),pred,[parameterlink],E).
1202
1203 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1204 % type machines
1205
1206 type_machine(Header,Name,MType,RawMachine,RefMachines,TypedMachine,NewRefMachines,Ein,Eout) :-
1207 Header = machine_header(_,Name,_),
1208 create_machine(Name,Empty),
1209 % (optional) definitions
1210 extract_definitions(RawMachine,Empty,DefsOnly,Ein,E0),
1211 debug_stats(extracted_definitions(Name)),
1212 % create the identifiers that will be typed,
1213 % Local will contain the identifier sections
1214 create_id_sections(Header,RawMachine,Name,DefsOnly,Local),
1215 debug_stats(created_identifier_sections(Name)),
1216 ? create_freetypes(RawMachine,MType,RefMachines,Local,Local1,E0,E1),
1217 % in case of a refinement, check if all newly defined operations are refinements
1218 link_to_refinement(MType,Name,RawMachine,RefMachines,Local1,Local2,E1,E2),
1219 % extract types that can be variables
1220 debug_stats(created_link_to_refinement(Name)),
1221 extract_parameter_types([ref(local,Local2)|RefMachines],NonGroundExceptions),
1222 % check for a VALUES clause. They are a little bit tricky because they can replace
1223 % already defined deferred sets by integers or other deferred sets
1224 process_values_section(MType,RawMachine,NonGroundExceptions,
1225 Local2/E2/RefMachines,Local3/E3/NewRefMachines),
1226 % type-check the other sections (properties, invariant, operation_bodies, etc)
1227 type_sections(RawMachine,MType,[ref(local,Local3)|NewRefMachines],NonGroundExceptions,
1228 Name,E3,Eout,Local3,TypedMachine).
1229
1230 % extract definitions from a definition file
1231 extract_only_definitions(MainName,RawMachine,DefsOnlyMachine,FinalErrors) :-
1232 create_machine(MainName,Empty),
1233 extract_definitions(RawMachine,Empty,DefsOnlyMachine,Errors,[]),
1234 sort(Errors,FinalErrors),
1235 add_all_perrors(FinalErrors).
1236
1237 extract_definitions(RawMachine,In,Out,Ein,Eout) :-
1238 optional_rawmachine_section(definitions,RawMachine,[],AllDefinitions),
1239 write_section(definitions,Definitions,In,Out),
1240 % remove all references to definition files from definitions
1241 exclude(is_file_definition,AllDefinitions,Definitions1),
1242 % replace expression_definition(...) by defintion(expression,...), etc.
1243 change_definition_style(Definitions1,Definitions2),
1244 % analyse dependencies
1245 add_def_dependency_information(Definitions2,Definitions3,Ein,Eout),
1246 % replace external function definitions by calls to the external function
1247 replace_external_declarations(Definitions3,Definitions).
1248
1249 is_file_definition(file_definition(_Pos,_Filename)).
1250
1251 change_definition_style(DefsIn,DefsOut) :-
1252 maplist(change_definition_style2,DefsIn,DefsOut).
1253 change_definition_style2(conversion(Pos,InnerDef),definition_decl(Name,DefType,InnerPos,Args,conversion(Pos,RawExpr))) :-
1254 change_definition_style2(InnerDef,definition_decl(Name,DefType,InnerPos,Args,RawExpr)).
1255 change_definition_style2(Def,definition_decl(Name,DefType,Pos,Args,RawExpr)) :-
1256 Def =.. [Functor,Pos,Name,Args,RawExpr],
1257 maplist(check_def_argument(Name,Pos),Args),
1258 map_def_functor(Functor,DefType).
1259 map_def_functor(expression_definition,expression).
1260 map_def_functor(substitution_definition,substitution).
1261 map_def_functor(predicate_definition,predicate).
1262
1263 % check formal arguments of definitions , e.g., here xx in square2 is not an identifier: xx == 20; square2(xx) == xx*xx
1264 check_def_argument(_,_,identifier(_,_)) :- !.
1265 check_def_argument(DefName,DefPos,definition(_,ID,_)) :- !,
1266 tools:ajoin(['Formal parameter ', ID, ' is a definition call in Definition: '],Msg),
1267 add_error(bmachine_construction,Msg,DefName,DefPos).
1268 check_def_argument(DefName,DefPos,FP) :- !,
1269 tools:ajoin(['Formal parameter ', FP, ' is not an identifier in Definition: '],Msg),
1270 add_error(bmachine_construction,Msg,DefName,DefPos).
1271
1272 replace_external_declarations(Definitions,NewDefs) :-
1273 split_list(is_external_declaration,Definitions,ExtFunctionDecls,RestDefs),
1274 foldl(replace_external_declaration,ExtFunctionDecls,RestDefs,NewDefs).
1275 is_external_declaration(definition_decl(DefName,expression,_Pos,_Params,_Def,_Dependencies)) :-
1276 ? external_name(DefName,ExtType,_ExpectedDefType,_ExtCall,FunName),
1277 debug_format(4,'external ~w declared: ~w~n', [ExtType,FunName]).
1278 external_name(DefName,_,_,_,_) :-
1279 \+ atom(DefName),!,
1280 add_internal_error('Non-atomic DEFINITION id:',DefName),fail.
1281 external_name(DefName,function,expression,external_function_call,FunName) :-
1282 atom_concat('EXTERNAL_FUNCTION_',FunName,DefName).
1283 external_name(DefName,predicate,predicate,external_pred_call,FunName) :-
1284 atom_concat('EXTERNAL_PREDICATE_',FunName,DefName).
1285 external_name(DefName,substitution,substitution,external_subst_call,FunName) :-
1286 atom_concat('EXTERNAL_SUBSTITUTION_',FunName,DefName).
1287
1288 replace_external_declaration(definition_decl(DefName,expression,DefPos,TypeParams,Decl,_Deps),In,Out) :-
1289 OldDefinition = definition_decl(FunName,ExpectedDefType,Pos,FunParams,FunDef,Deps),
1290 NewDefinition = definition_decl(FunName,ExpectedDefType,Pos,FunParams,ExtCall,Deps),
1291 ? ( external_name(DefName,_ExtType,ExpectedDefType,ExtCallFunctor,FunName),
1292 ExtCall =.. [ExtCallFunctor,Pos,FunName,FunParams,FunDef,
1293 rewrite_protected(TypeParams),rewrite_protected(Decl)],
1294 selectchk(OldDefinition,In,NewDefinition,Out) ->
1295 assert_external_procedure_used(FunName)
1296 ; external_name(DefName,ExpectedKind,_,_,FunName),
1297 selectchk(definition_decl(FunName,OtherDefType,_OtherPos,_,_,_),In,_,_),!,
1298 % definition found for different type of external function
1299 ajoin(['No DEFINITION associated with external ',ExpectedKind,
1300 ' (but definition as ',OtherDefType,' exists):'],Msg),
1301 add_error(replace_external_declaration,Msg,DefName,DefPos), Out=In
1302 ; external_name(DefName,ExpectedKind,_,_,FunName) ->
1303 % no definition found for external function
1304 ajoin(['No DEFINITION associated with external ',ExpectedKind,':'],Msg),
1305 add_error(replace_external_declaration,Msg,DefName,DefPos), Out=In
1306 ; % no definition found for external function
1307 ajoin(['No DEFINITION associated with:'],Msg),
1308 add_error(replace_external_declaration,Msg,DefName,DefPos), Out=In
1309 ).
1310
1311 :- use_module(external_function_declarations,
1312 [external_function_library/2, safe_external_function_library/2,
1313 get_external_function_definition/3]).
1314 % store external definitions of a given library in the type environment, e.g. for debugging in Repl or VisB
1315 % Library could be "LibraryStrings.def"
1316
1317 store_ext_defs(Library,In,Out) :-
1318 (Library = all_available_libraries
1319 -> findall(extfun(Id,Lib),external_function_library(Id,Lib),Ids)
1320 ; Library = safe_available_libraries
1321 -> findall(extfun(Id,Lib),safe_external_function_library(Id,Lib),Ids)
1322 ; findall(extfun(Id,Library),external_function_library(Id,Library),Ids)
1323 ),
1324 (Ids=[] -> add_warning(store_ext_defs,'No external functions found for library: ',Library) ; true),
1325 foldl(store_ext_def,Ids,In,Out).
1326
1327 store_ext_def(extfun(Id,Library),In,Out) :- env_lookup_type(Id,In,_),!,
1328 debug_println(4,not_storing_ext_def(Id,Library)), % already imported from stdlib or user has other definition
1329 Out=In.
1330 store_ext_def(extfun(FunName,Library),In,Out) :-
1331 ? get_external_function_definition(FunName,Library,DEFINITION),!,
1332 debug_println(4,storing_ext_def(FunName,Library)),
1333 env_store(FunName,DEFINITION,[loc('automatically included',Library,definitions)],In,Out).
1334 store_ext_def(extfun(Id,_),In,Out) :-
1335 add_internal_error('Cannot add external definition: ',Id),
1336 Out=In.
1337
1338
1339 % store which machine promotes which operations
1340 :- dynamic machine_promotes_operations/2, machine_hides_unpromoted_operation/4, machine_global_order/1.
1341
1342 reset_bmachine_construction :-
1343 retractall(machine_promotes_operations(_,_)),
1344 retractall(machine_hides_unpromoted_operation(_,_,_,_)),
1345 retractall(abstract_variable_removed_in(_,_,_)),
1346 retractall(machine_global_order(_)),
1347 reset_external_procedure_used.
1348
1349
1350 % maybe this information should be stored somewhere else ??
1351 :- dynamic external_procedure_used/1.
1352 reset_external_procedure_used :- retractall(external_procedure_used(_)).
1353 assert_external_procedure_used(FunName) :-
1354 (external_procedure_used(FunName) -> true ; assertz(external_procedure_used(FunName))).
1355
1356 link_to_refinement(machine,_,_RawMachine,_RefMachines,Local,Local,Errors,Errors).
1357 link_to_refinement(refinement,Name,RawMachine,RefMachines,Local,NewLocal,Ein,Eout) :-
1358 link_to_refinement(implementation,Name,RawMachine,RefMachines,Local,NewLocal,Ein,Eout).
1359 link_to_refinement(implementation,Name,RawMachine,RefMachines,Local,NewLocal,Ein,Eout) :-
1360 link_to_refinement2(implementation,Name,RawMachine,RefMachines,Local,NewLocal,Ein,Eout).
1361 link_to_refinement2(_MType,Name,RawMachine,RefMachines,Local,NewLocal,Ein,Eout) :-
1362 memberchk(ref(abstraction,AbstractMachine),RefMachines),
1363 copy_constraints(Local,AbstractMachine,NewLocal,Ein,E1),
1364 type_vars_in_refinement(AbstractMachine,NewLocal),
1365 type_refinement_operations(Name,RawMachine,AbstractMachine,NewLocal,E1,Eout).
1366
1367 copy_constraints(Local,AbstractMachine,NewLocal,Ein,Eout) :-
1368 get_section(parameters,Local,LocalParameters),
1369 get_section(parameters,AbstractMachine,AbstractParameters),
1370 check_if_equal_identifiers(LocalParameters,AbstractParameters,Ein,Eout,Local),
1371 get_section(constraints,AbstractMachine,Constraints),
1372 write_section(constraints,Constraints,Local,NewLocal).
1373 check_if_equal_identifiers(Local,Abstract,Ein,Eout,LocalMachine) :-
1374 ( same_length(Local,Abstract) ->
1375 foldl(check_if_equal_identifiers2,Local,Abstract,Ein,Eout)
1376 ;
1377 get_texpr_ids(Abstract,AIDs),
1378 get_machine_name(LocalMachine,MachName),
1379 ajoin(['Refinement ',MachName,' must have same Parameters ', AIDs,' as abstract Machine'],Msg),
1380 Ein = [error(Msg,none)|Eout]
1381 ).
1382 check_if_equal_identifiers2(LParam,AParam,Ein,Eout) :-
1383 get_texpr_id(LParam,LName),
1384 get_texpr_id(AParam,AName),
1385 ( LName = AName ->
1386 % type in refinement is the same as in the abstraction
1387 get_texpr_type(LParam,Type),
1388 get_texpr_type(AParam,Type),
1389 Ein=Eout
1390 ;
1391 get_texpr_pos(LParam,Pos),
1392 ajoin(['Parameter ',LName,' of refinement machine must be ',
1393 AName,' like in the abstract machine'],Msg),
1394 Ein = [error(Msg,Pos)|Eout]
1395 ).
1396
1397 % in case of a refinement, give variables the same type as in the abstract machine
1398 % the same for constants
1399 type_vars_in_refinement(AbstractMachine,ConcreteMachine) :-
1400 pass_type(AbstractMachine,[abstract_variables,concrete_variables],
1401 ConcreteMachine,[abstract_variables,concrete_variables]),
1402 pass_type(AbstractMachine,[abstract_constants,concrete_constants],
1403 ConcreteMachine,[abstract_constants,concrete_constants]).
1404
1405 % pass the type from variables in Sections1 of Machine1 to
1406 % the variables of the same name in Sections2 of Machine2
1407 % Machine1,Machine2: a machine
1408 % Sections1, Sections2: a list of section names
1409 pass_type(Machine1,Sections1,Machine2,Sections2) :-
1410 get_sections_and_append(Sections1,Machine1,Vars1),
1411 get_sections_and_append(Sections2,Machine2,Vars2),
1412 maplist(pass_type2(Vars2),Vars1).
1413 get_sections_and_append([],_M,[]).
1414 get_sections_and_append([Sec|RestSections],M,R) :-
1415 get_section(Sec,M,L), append(L,Rest,R),
1416 get_sections_and_append(RestSections,M,Rest).
1417 pass_type2(DstVariables,SrcVariable) :-
1418 get_texpr_id(SrcVariable,Id),
1419 get_texpr_id(DstVariable,Id),
1420 ( memberchk(DstVariable,DstVariables) ->
1421 get_texpr_type(DstVariable,Type),
1422 get_texpr_type(SrcVariable,Type)
1423 ;
1424 true).
1425
1426
1427 % in case of a refinement, check if the defined operations are already defined
1428 % in the abstract machine and copy that type.
1429 type_refinement_operations(MName,RawMachine,AbstractMachine,Local,Ein,Eout) :-
1430 get_operation_identifiers(RawMachine,Operations),
1431 type_refinement_operations2(Operations,MName,Local,AbstractMachine,Ein,Eout).
1432 type_refinement_operations2([],_,_,_AbstractMachine,Errors,Errors).
1433 type_refinement_operations2([Op|Rest],MName,M,AbstractMachine,Ein,Eout) :-
1434 get_abstract_operation_name_wo_infos(Op,AOp),
1435 %print(treating_refines_operation(Op,AOp)),nl,
1436 get_texpr_pos(Op,Pos),
1437 % look up the abstract definition
1438 get_abstract_op(AOp,MName,AbstractMachine,Pos,Ein,E1),
1439 % store the type in the identifier section
1440 copy_texpr_wo_info(Op,SOp),
1441 ( get_section(promoted,M,Operations),
1442 memberchk(SOp, Operations) -> true
1443 ; get_section(unpromoted,M,Operations), % this is probably a LOCAL_OPERATION
1444 memberchk(SOp, Operations) -> true
1445 ; add_error(btypechecker,'Could not find operation for type checking:',Op),fail
1446 ),
1447 % do the rest
1448 type_refinement_operations2(Rest,MName,M,AbstractMachine,E1,Eout).
1449 % looks up the type of the operator in an abstract machine
1450 get_abstract_op(Op,_,Abstraction,_,Errors,Errors) :-
1451 % look for the operation in promoted and unpromoted
1452 ( get_section(promoted,Abstraction,AbstractOps), member(Op,AbstractOps)
1453 ; get_section(unpromoted,Abstraction,AbstractOps), member(Op,AbstractOps) ),
1454 % forget alternatives
1455 !.
1456 get_abstract_op(Op,_,_Abstraction,_Pos,Errors,Errors) :-
1457 % we might allow new operations
1458 get_preference(allow_new_ops_in_refinement,true),!, % ALLOW_NEW_OPERATIONS_IN_REFINEMENT
1459 get_texpr_type(Op,op(_,_)).
1460 get_abstract_op(Op,MName,AbstractMachine,Pos,[warning(Msg,Pos)|Eout],Eout) :-
1461 % in case we do not find the operation, store an error
1462 get_texpr_id(Op,op(Id)),
1463 get_machine_name(AbstractMachine,Name),
1464 ajoin(['operation ', Id, ' from ', MName, ' is not defined in the abstract machine ',Name,
1465 ' (set ALLOW_NEW_OPERATIONS_IN_REFINEMENT to TRUE to allow this)'], Msg).
1466 % copy a typed expression without the additional information (just expression and type)
1467 copy_texpr_wo_info(A,B) :-
1468 % copy the expression and type, the additional information may be different
1469 get_texpr_expr(A,Expr),get_texpr_expr(B,Expr),
1470 get_texpr_type(A,Type),get_texpr_type(B,Type).
1471
1472 get_abstract_operation_name_wo_infos(b(_,Type,Infos),Res) :-
1473 memberchk(refines_operation(RefID),Infos),!, % renaming occurs:
1474 Res = b(identifier(op(RefID)),Type,_).
1475 get_abstract_operation_name_wo_infos(ID,Copy) :- copy_texpr_wo_info(ID,Copy).
1476
1477 create_id_sections(Header,RawMachine,Name) -->
1478 create_id_sections_header(Header),
1479 %{print(created_header(Name)),nl},
1480 create_set_sections(RawMachine,Name),
1481 %{print(created_set(Name)),nl},
1482 create_constants_sections(RawMachine),
1483 %{print(created_constants(Name)),nl},
1484 create_variables_sections(RawMachine),
1485 %{print(created_variables(Name)),nl},
1486 create_operations_sections(RawMachine,Name).
1487
1488 extract_parameter_types(MachineRefs,ParameterTypes) :-
1489 maplist(extract_parameter_types2,MachineRefs,ParameterTypesL),
1490 append(ParameterTypesL,ParameterTypes).
1491 extract_parameter_types2(ref(_,Machine),ParameterTypes) :-
1492 get_section(parameters,Machine,VisibleParams),
1493 get_section(internal_parameters,Machine,InternalParams),
1494 append(VisibleParams,InternalParams,Params),
1495 include(is_a_parameter_set,Params,ParameterSets),
1496 maplist(get_texpr_set_type,ParameterSets,ParameterTypes).
1497 is_a_parameter_set(TExpr) :-
1498 get_texpr_info(TExpr,Info),
1499 memberchk(parameter_set,Info).
1500
1501 type_sections(RawMachine,MachineType,RefMachines,NonGroundExceptions,Name,Ein,Eout) -->
1502 {debug_stats('TYPING CONSTRAINTS'(Name))},
1503 type_constraints(MachineType,Name,RawMachine,RefMachines,NonGroundExceptions,Ein,E1),
1504 % Maybe the VALUES section must be moved up later because it may be used to
1505 % substitute types (e.g. deferred sets to integers) for later use
1506 {debug_stats('TYPING PROPERTIES'(Name))},
1507 type_section_with_single_predicate(properties,Name,[constants],MachineType,RawMachine,RefMachines,NonGroundExceptions,E1,E2),
1508 {debug_stats('TYPING INVARIANT'(Name))},
1509 type_section_with_single_predicate(invariant,Name,[variables],MachineType,RawMachine,RefMachines,NonGroundExceptions,E2,E3),
1510 {debug_stats('TYPING ASSERTIONS'(Name))},
1511 type_section_with_predicate_list(assertions,[],MachineType,RawMachine,RefMachines,NonGroundExceptions,E3,E4),
1512 {debug_stats('TYPING INITIALISATION'(Name))},
1513 type_initialisation_section(RawMachine,Name,MachineType,RefMachines,NonGroundExceptions,E4,E5),
1514 {debug_stats('TYPING OPERATIONS'(Name))},
1515 type_operations_section(RawMachine,MachineType,RefMachines,NonGroundExceptions,E5,Eout),
1516 {debug_stats('FINISHED TYPING SECTIONS'(Name))}.
1517
1518 % skip this section, it is copied from the abstract machine and
1519 % does not need to be typed again
1520 type_constraints(refinement,_,_RawMachine,_RefMachines,_NonGroundExceptions,Errors,Errors) --> !.
1521 type_constraints(implementation,_,_RawMachine,_RefMachines,_NonGroundExceptions,Errors,Errors) --> !.
1522 type_constraints(machine,Name,RawMachine,RefMachines,NonGroundExceptions,Ein,Eout) -->
1523 % if the machine is a dummy machine (in presence of a not included seen or used
1524 % machine), we must omit the check that the (lower case) parameters are all typed.
1525 % We can assume that they are properly typed by the included machine.
1526 {(is_dummy_machine(RawMachine) -> IdsToType = [] ; IdsToType = [parameters])},
1527 type_section_with_single_predicate(constraints,Name,IdsToType,machine,
1528 RawMachine,RefMachines,NonGroundExceptions,Ein,Eout).
1529
1530 ?is_dummy_machine(RawMachine) :- member(is_dummy,RawMachine),!.
1531
1532 % Header: Parameters
1533 create_id_sections_header(machine_header(_,_,Parameters),Old,New) :-
1534 write_section(parameters,TParams,Old,New),
1535 maplist(create_id_section_parameter,Parameters,TParams).
1536 create_id_section_parameter(Param,TParam) :-
1537 Expr=identifier(Name),
1538 ext2int_with_pragma(Param,Expr,_,Type,Expr,[ParameterType],TParam),
1539 ( is_upper_case(Name) ->
1540 ParameterType = parameter_set,
1541 Type = set(_)
1542 ;
1543 ParameterType = parameter_scalar).
1544 is_upper_case(Name) :- \+ atom(Name),!, add_internal_error('Illegal call:', is_upper_case(Name)),fail.
1545 is_upper_case(Name) :- atom_codes(Name,[C|_]),
1546 memberchk(C,"ABCDEFGHIJKLMNOPQRSTUVWXYZ").
1547
1548 % Body: Sets
1549 create_set_sections(Sections,MachineName) -->
1550 write_section(deferred_sets,DeferredSets),
1551 write_section(enumerated_sets,EnumeratedSets),
1552 write_section(enumerated_elements,EnumeratedElements),
1553 {optional_rawmachine_section(sets,Sections,[],Sets),
1554 split_list(is_deferred_set_element,Sets,RawDeferredSets,RawEnumeratedSets),
1555 maplist(create_deferred_set_section(MachineName),RawDeferredSets,DeferredSets),
1556 maplist(create_enumerated_set_section(Sections,MachineName),
1557 RawEnumeratedSets,EnumeratedSets,LEnumeratedElements),
1558 append(LEnumeratedElements,EnumeratedElements)}.
1559 is_deferred_set_element(AstElem) :- has_functor(AstElem,deferred_set,_).
1560 create_deferred_set_section(MachineName,DS,TExpr) :-
1561 unwrap_opt_description(DS,deferred_set(Pos,I),TInfos),
1562 Infos = [given_set,def(deferred_set,MachineName)|TInfos],
1563 create_global_id(I,Pos,Infos,TExpr).
1564 create_enumerated_set_section(Sections,MachineName,ES,TExpr,Elements) :-
1565 unwrap_opt_description(ES,EnumSetList,TInfos),
1566 create_enum_set_aux(EnumSetList,Sections,MachineName,TInfos,TExpr,Elements).
1567
1568 create_global_id(identifier(_,Id),Pos,Infos,TExpr) :- !,
1569 add_warning(bmachine_construction,'Identifier unexpectedly not atomic: ',Id,Pos), % happened e.g. in ANTLR parser
1570 create_identifier(Id,Pos,set(global(Id)),Infos,TExpr).
1571 create_global_id(Id,Pos,Infos,TExpr) :- !,
1572 create_identifier(Id,Pos,set(global(Id)),Infos,TExpr).
1573
1574 create_enum_set_aux(enumerated_set(Pos,I,Elems),_,MachineName,TInfos,TExpr,Elements) :- !,
1575 % regular case I = {Elems1, ...}
1576 Infos = [given_set,def(enumerated_set,MachineName)|TInfos],
1577 create_global_id(I,Pos,Infos,TExpr),
1578 maplist(create_enum_set_element(I,MachineName),Elems,Elements).
1579 create_enum_set_aux(enumerated_set_via_def(Pos,I,ElemsDEF),Sections,MachineName,TInfos,TExpr,Elements) :- !,
1580 % we have the case I = ElemsDEF and DEFINITIONS ElemsDEF == {Elems1, ...}
1581 Infos = [given_set,def(enumerated_set,MachineName)|TInfos],
1582 create_global_id(I,Pos,Infos,TExpr),
1583 (optional_rawmachine_section(definitions,Sections,[],Defs),
1584 member(expression_definition(DPos,ElemsDEF,Paras,DefBody),Defs)
1585 -> (Paras \= []
1586 -> add_error(bmachine_construction,
1587 'DEFINITION for enumerated set elements must not have parameters:',ElemsDEF,DPos),
1588 Elements=[]
1589 ; DefBody = set_extension(_,Elems),
1590 maplist(create_enum_set_element(I,MachineName),Elems,Elements)
1591 -> true
1592 ; add_error(bmachine_construction,
1593 'DEFINITION for enumerated set elements must be of the form {El1,El2,...}:',ElemsDEF,DPos),
1594 Elements=[]
1595 )
1596 ; add_error(bmachine_construction,'No DEFINITION for enumerated set elements found:',ElemsDEF,Pos),
1597 Elements=[]
1598 ).
1599 create_enum_set_aux(E,_,_,_,_,_) :- add_internal_error('Illegal enumerated set:',E),fail.
1600
1601
1602 % deal with optional description(Pos,Desc,A) wrapper
1603 has_functor(description(_,_Desc,A),Functor,Arity) :- !, functor(A,Functor,Arity).
1604 has_functor(A,Functor,Arity) :- functor(A,Functor,Arity).
1605
1606 % remove description wrapper and generate info field
1607 unwrap_opt_description(Pragma,Res,Infos) :-
1608 unwrap_pragma(Pragma,Expr,I),!, Res=Expr,Infos=I.
1609 unwrap_opt_description(A,A,[]).
1610
1611
1612 create_enum_set_element(Id,MachineName,Ext,Elem) :-
1613 (Id=identifier(none,RID)
1614 -> Type=global(RID), add_warning(bmachine_construction,'Unexpected non-atomic global set id: ',RID)
1615 ; Type=global(Id)),
1616 ext2int_with_pragma(Ext,Expr,_Pos,Type,Expr,[enumerated_set_element,def(enumerated_element,MachineName)],Elem).
1617
1618 create_identifier(Id,Pos,Type,Infos,TExpr) :-
1619 create_texpr(identifier(Id),Type,[nodeid(Pos)|Infos],TExpr).
1620
1621 % Constants
1622 create_constants_sections(RawMachine) -->
1623 create_section_identifiers(constants,concrete_constants,RawMachine),
1624 create_section_identifiers(abstract_constants,abstract_constants,RawMachine).
1625 % Variables
1626 create_variables_sections(RawMachine) -->
1627 create_section_identifiers(concrete_variables,concrete_variables,RawMachine),
1628 create_section_identifiers(variables,abstract_variables,RawMachine).
1629
1630 % Freetypes: Treat them as additional constants, plus add entries in the "freetypes"
1631 % section of the resulting machine
1632 create_freetypes(RawMachine,MType,RefMachines,Old,New,Ein,Eout) :-
1633 optional_rawmachine_section(freetypes,RawMachine,[],RawFreetypes),
1634 ? create_freetypes2(RawFreetypes,MType,[ref(local,Old)|RefMachines],Old,New,Ein,Eout).
1635 create_freetypes2([],_MType,_RefMachines,M,M,E,E) :- !.
1636 create_freetypes2(RawFreetypes,MType,RefMachines,Old,New,Ein,Eout) :-
1637 % we need the NonGroundExceptions for type checking
1638 extract_parameter_types(RefMachines,NonGroundExceptions),
1639 % create identifiers in the constants section
1640 ? maplist(create_ids_for_freetype,RawFreetypes,IdsFreetypes),
1641 % we just combined the results to keep the numbers of arguments low (too much for maplist)
1642 maplist(split_ft,IdsFreetypes,IdentifiersL,Freetypes),
1643 append(IdentifiersL,Identifiers),
1644 % create properties for each freetype
1645 foldl(create_properties_for_freetype(MType,RefMachines,NonGroundExceptions,Identifiers),
1646 RawFreetypes,IdsFreetypes,PropertiesL,Ein,Eout),
1647 conjunct_predicates(PropertiesL,Properties),
1648 (debug_mode(off) -> true
1649 ; format('Created PROPERTIES for FREETYPES:~n',[]), translate:nested_print_bexpr(Properties),nl),
1650 append_to_section(abstract_constants,Identifiers,Old,Inter),
1651 conjunct_to_section(properties,Properties,Inter,Inter2),
1652 write_section(freetypes,Freetypes,Inter2,New).
1653
1654 split_ft(ft(Ids,Freetype),Ids,Freetype).
1655
1656
1657 create_ids_for_freetype(FT,ft([TId|TCons],freetype(Id,Cases))) :-
1658 is_freetype_declaration(FT,_Pos,Id,_TypeParams,Constructors),
1659 !,
1660 create_typed_id_with_given_set_info(Id,set(freetype(Id)),TId),
1661 ? maplist(create_ids_for_constructor(Id),Constructors,TCons,Cases).
1662 create_ids_for_freetype(FT,_) :-
1663 add_internal_error('Illegal freetype term:',create_ids_for_freetype(FT,_)),fail.
1664
1665 % add given_set info so that is_just_type3 can detect this as a type
1666 create_typed_id_with_given_set_info(IDName,Type,b(identifier(IDName),Type,[given_set])).
1667
1668 % deconstruct a .prob Prolog encoding of a freetype declaration
1669 % new versions of parser generate freetype parameters
1670 is_freetype_declaration(freetype(Pos,Id,Constructors),Pos,Id,[],Constructors).
1671 is_freetype_declaration(freetype(Pos,Id,TypeParams,Constructors),Pos,Id,TypeParams,Constructors) :-
1672 (TypeParams=[] -> true ; add_warning(bmachine_construction,'Not yet supporting freetype parameters:',Id,Pos)).
1673
1674 create_ids_for_constructor(Id,constructor(_Pos,Name,_Arg),TCons,case(Name,Type)) :-
1675 create_typed_id(Name,set(couple(Type,freetype(Id))),TCons).
1676 create_ids_for_constructor(Id,element(_Pos,Name),TCons,case(Name,constant([Name]))) :-
1677 create_typed_id(Name,freetype(Id),TCons).
1678
1679 create_properties_for_freetype(MType,RefMachines,NonGroundExceptions, AllFTIdentifiers,
1680 FREETYPE,ft(Ids,_Freetypes),Properties,Ein,Eout) :-
1681 is_freetype_declaration(FREETYPE,_Pos,Id,_TypeParams,Constructors),
1682 debug_format(9,'Processing freetype ~w (one of ~w)~n',[Id,AllFTIdentifiers]),
1683 % The freetype type
1684 FType = freetype(Id),
1685 % We use the standard type environment of properties...
1686 visible_env(MType,properties,RefMachines,CEnv,Ein,E1),
1687 % ...plus the identifiers of the free type (type name and constructor names)
1688 add_identifiers_to_environment(Ids,CEnv,FEnv0),
1689 % ...plus the identifiers of all free type names (will overwrite Id, but not a problem)
1690 % Note: instead of adding all freetype ids, we could just add the ones preceding Id
1691 add_identifiers_to_environment(AllFTIdentifiers,FEnv0,FEnv),
1692 % We generate a comprehension set for all elements
1693 create_typed_id(Id,set(FType),TId),
1694 create_texpr(equal(TId,TComp),pred,[],FDef),
1695 unique_typed_id("_freetype_arg",FType,Element),
1696 create_recursive_compset([Element],ECond,set(FType),[],RecId,TComp),
1697 create_typed_id(RecId,set(FType),TRecId),
1698 % For each constructor, we generate a definition and a condition for the
1699 % comprehension set above
1700 foldl(create_properties_for_constructor(Id,FEnv,Element,TRecId,NonGroundExceptions),
1701 Constructors,Defs,Conds,E1,Eout),
1702 conjunct_predicates(Conds,ECond),
1703 conjunct_predicates([FDef|Defs],Properties).
1704
1705 /* create_properties_for_constructor(+Env,+Element,+RecId,+NGE,+Constructor,-Def,-Cond,Ein,Eout)
1706 Env: Type environment
1707 Element: A typed identifier "e" that is used in the definition of the freetype set:
1708 ft = {e | e has_freetype_constructor x => e:...}
1709 RecId: The typed identifier that can be used to refer to the freetype set (ft in the
1710 example above
1711 NGE: "Non ground exceptions", needed for type checking when having a parametrized machine
1712 Constructor: The constructor expression as it comes from the parser
1713 (constructor(Pos,Name,ArgSet) or element(Pos,Name))
1714 Def: The predicate that defines the constant for the constructor,
1715 e.g. "cons = {i,o | i:NAT & o = freetype(cons,i)}"
1716 Cond: The predicate that checks the argument of a freetype in the freetype set
1717 (That would be the part "e:..." in the example above.
1718 Ein,Eout: Used for type checker errors
1719 */
1720 create_properties_for_constructor(FID,Env,Element,RecId,NonGroundExceptions,
1721 Constructor,Def,Cond,Ein,Eout) :-
1722 constructor_name(Constructor,Name),
1723 env_lookup_type(Name,Env,CType),
1724 create_properties_for_constructor2(Constructor,Env,NonGroundExceptions,FID,
1725 Element,RecId,CDef,Cond,Ein,Eout),
1726 get_texpr_type(CDef,CType),
1727 create_typed_id(Name,CType,CId),
1728 create_texpr(equal(CId,CDef),pred,[],Def).
1729 constructor_name(element(_Pos,Name),Name).
1730 constructor_name(constructor(_Pos,Name,_Domain),Name).
1731 create_properties_for_constructor2(element(_Pos,Name),_Env,_NonGroundExceptions,FID,
1732 _Element,_RecId,CDef,Cond,Ein,Ein) :-
1733 create_texpr(value(freeval(FID,Name,term(Name))),freetype(FID),[],CDef),
1734 create_texpr(truth,pred,[],Cond).
1735 create_properties_for_constructor2(constructor(_Pos,Name,RArg),Env,NonGroundExceptions,
1736 FID,Element,RecId,CDef,Cond,Ein,Eout) :-
1737 % First, type check the given set of the domain:
1738 btype_ground_dl([RArg],Env,NonGroundExceptions,[set(DType)],[TDomain],Ein,Eout),
1739 % then create the RHS of "c = {i,o | i:Domain & o=freetype_constructor(Name,i)}"
1740 create_definition_for_constructor(Name,TDomain,FID,CDef),
1741 % The check in the freetype comprehension set is of the form
1742 % e "of_freetype_case" Name => "content_of"(e) : Domain
1743 create_texpr(implication(IsCase,DomainTest),pred,[],Cond),
1744 create_texpr(freetype_case(FID,Name,Element),pred,[],IsCase),
1745 create_texpr(freetype_destructor(FID,Name,Element),DType,[],Content),
1746 % all references to the freetype itself are replaced by the recursive reference
1747 replace_id_by_expr(TDomain,FID,RecId,TDomain2),
1748 create_texpr(member(Content,TDomain2),pred,[],DomainTest).
1749
1750 :- use_module(bsyntaxtree,[get_texpr_set_type/2]).
1751
1752 /* The constructor is a function to the freetype, defined with a comprehension set:
1753 The general form is "c = {i,o | i:Domain & o=freetype_constructor(Name,i)}"
1754 create_definition_for_constructor(+Name,+DType,+FID,-CType,-CDef) :-
1755 Name: Name of the constructor
1756 TDomain: The user-specified domain
1757 FID: The name of the free type
1758 CDef: The RHS of the definition "Name = CDef"
1759 */
1760 create_definition_for_constructor(Name,TDomain,FID,CDef) :-
1761 % get the type of the domain:
1762 get_texpr_set_type(TDomain,DType),
1763 % create argument and result identifiers:
1764 unique_typed_id("_constr_arg",DType,TArgId), % was constructor_arg and constructor_res
1765 unique_typed_id("_constr_res",freetype(FID),TResId),
1766 % The comprehension set as a whole
1767 CType = set(couple(DType,freetype(FID))),
1768 create_texpr(comprehension_set([TArgId,TResId],Pred),CType,
1769 [prob_annotation('SYMBOLIC')],CDef),
1770 create_texpr(conjunct(DomainCheck,Construction),pred,[],Pred),
1771 % "i:Domain"
1772 create_texpr(member(TArgId,TDomain),pred,[],DomainCheck),
1773 % "o=freetype_constructor(i)
1774 create_texpr(freetype_constructor(FID,Name,TArgId),freetype(FID),[],FreetypeCons),
1775 create_texpr(equal(TResId,FreetypeCons),pred,[],Construction).
1776
1777 % Operations
1778 create_operations_sections(RawMachine,Name,Old,New) :-
1779 write_section(promoted,PromotedOperationIds,Old,New0),
1780 get_operation_identifiers(RawMachine,operations,OperationIdentifiers),
1781 (get_operation_identifiers(RawMachine,local_operations,LocOpIDs),
1782 LocOpIDs \= [] % if there is a LOCAL_OPERATIONS section we assume user wants to call them
1783 -> maplist(add_infos_to_identifier([is_local_operation]),LocOpIDs,LocOpIds2),
1784 append_to_section(unpromoted,LocOpIds2,New0,New),
1785 % Now remove all LOCAL_OPERATIONS from the promoted ones
1786 % see for example prob_examples/examples/B/ClearSy/RoboSim/SRanger_case_Jul25/logic_i.imp
1787 exclude(duplicate_local_operation_id(Name,LocOpIDs),OperationIdentifiers,PromotedOperationIds)
1788 ; New = New0, PromotedOperationIds = OperationIdentifiers
1789 ).
1790
1791
1792
1793 % check if a LOCAL_OPERATION is already declared in the OPERATIONS section:
1794 % in this case: we use the operation body defined in the OPERATIONS section, but remove it from the promoted list
1795 duplicate_local_operation_id(Name,OpIds,TID) :-
1796 get_texpr_id(TID,op(OpID)),
1797 member(TID2,OpIds),
1798 get_texpr_id(TID2,op(OpID)),!,
1799 debug_println(9,duplicate_local_operation_id(OpID,Name)).
1800
1801 get_operation_identifiers(RawMachine,OperationIdentifiers) :-
1802 get_operation_identifiers(RawMachine,operations,OperationIdentifiers).
1803 get_operation_identifiers(RawMachine,SECTION,OperationIdentifiers) :-
1804 optional_rawmachine_section(SECTION,RawMachine,[],Ops),
1805 maplist(extract_operation_identifier,Ops,OperationIdentifiers).
1806 extract_operation_identifier(Ext,TId) :-
1807 remove_pos(Ext, operation(ExtId,_,_,_)),!,
1808 ext2int_with_pragma(ExtId,identifier(I),_,op(_,_),identifier(op(I)),Infos,TId),
1809 operation_infos(Infos).
1810 extract_operation_identifier(Ext,TId) :-
1811 remove_pos(Ext, refined_operation(ExtId,_,_,RefinesOp,_)),!,
1812 ext2int_with_pragma(ExtId,identifier(I),_,op(_,_),identifier(op(I)),[refines_operation(RefinesOp)|Infos],TId),
1813 operation_infos(Infos).
1814 extract_operation_identifier(Ext,TId) :-
1815 remove_pos(Ext, description_operation(_Desc,RealOp)),!,
1816 extract_operation_identifier(RealOp,TId).
1817 extract_operation_identifier(Ext,_) :- add_internal_error('Unknown operation node:',Ext),fail.
1818
1819 % VALUES section:
1820 % process_values_section(MachineType,RawMachine,NonGroundExceptions,Min/Ein/RefMIn,Mout/Eout/RefMOut):
1821 % Type-check the VALUES section and change the type of valuated deferred sets, if necessary
1822 % MachineType, RawMachine, NonGroundExceptions: as usual, see other comments
1823 % Min/Mout: The currently constructed machine
1824 % Ein/Eout: The difference list of errors
1825 % RefMin/RefMout: The list of already typechecked machines. These typechecked machines can be
1826 % altered by this predicate because if a deferred set is valuated by an integer set or
1827 % other deferred set, all occurrences of the original type are replaced by the new type,
1828 % even for the already typed machines.
1829 process_values_section(MachineType,RawMachine,NonGroundExceptions,Min/Ein/RefMIn,Mout/Eout/RefMOut) :-
1830 optional_rawmachine_section(values,RawMachine,[],RawValues),
1831 process_values_section_aux(RawValues,MachineType,NonGroundExceptions,
1832 Min/Ein/RefMIn,Mout/Eout/RefMOut).
1833 process_values_section_aux([],_MachineType,_NonGroundExceptions,In,Out) :- !,In=Out.
1834 process_values_section_aux(RawValues,MachineType,NonGroundExceptions,
1835 Min/Ein/RefMin,Mout/Eout/RefMout) :-
1836 debug_stats('TYPING VALUES'),
1837 type_values_section(MachineType,RawValues,RefMin,NonGroundExceptions,Min/Ein,Mout/Eout),
1838 % will be added as additional_property in bmachine
1839 RefMin=RefMout.
1840
1841 type_values_section(MachineType,RawValues,RefMachines,NonGroundExceptions,Min/Ein,Mout/Eout) :-
1842 write_section(values,Values,Min,Mout),
1843 visible_env(MachineType,values_expression,RefMachines,Env,Ein,E1),
1844 % We have to pass an environment that can be modified because in each
1845 % valuation the previously valuated constants can be used.
1846 foldl(extract_values_entry(NonGroundExceptions),RawValues,Values,Env/E1,_ResultingEnv/Eout).
1847
1848 extract_values_entry(NonGroundExceptions, values_entry(POS,ValueID,ValueExpr), Entry,
1849 EnvIn/Ein,EnvOut/Eout) :-
1850 % TODO: There seem to be a lot of additional constraints for valuations in VALUES that are not
1851 % yet handled here
1852 btype_ground_dl([ValueExpr],EnvIn,NonGroundExceptions,[Type],[TExpr],Ein,Eout),
1853 clean_up(TExpr,[],CTExpr), % ensure we remove things like mult_or_cart/2
1854 create_identifier(ValueID,POS,Type,[valuated_constant],TypedID),
1855 create_texpr(values_entry(TypedID,CTExpr),values_entry,[nodeid(POS)],Entry),
1856 debug_println(9,valued_constant(ValueID)),
1857 EnvOut=EnvIn.
1858 %add_identifiers_to_environment([TypedID],EnvIn,EnvOut). % ideally we should register the new type of TypedID
1859 % However: ProB can currently only process VALUES clauses where the type does not change
1860
1861 % type_section_with_single_predicate(+Sec,+Name,+SectionsToType,+MachineType,+Sections,
1862 % +RefMachines,+NonGroundExceptions,+Ein,-Eout,+Old,-New):
1863 % Type a section such as INVARIANT, PROPERTIES, CONSTRAINTS with a single predicate
1864 % Sec: section name in the raw (untyped) machine (e.g. invariant)
1865 % Name: name of machine from which this section comes
1866 % SectionsToType: list of section names that contain identifiers that must be typed
1867 % by this predicate (e.g. all variables must be typed by the invariant)
1868 % MachineType: machine type (machine, refinement, ...)
1869 % Sections: list of sections representing the raw (untyped) machine
1870 % RefMachines: list of already typed machines
1871 % NonGroundExceptions: list of types that may be not ground because the concrete type
1872 % is determinded by machine parameter
1873 % Ein/Eout: difference list of errors
1874 % Old/New: the new typed section is added (by conjunction) to the machine
1875 type_section_with_single_predicate(Sec,Name,SectionsToType,MachineType,Sections,
1876 RefMachines,NonGroundExceptions,Ein,Eout,Old,New) :-
1877 optional_rawmachine_section(Sec,Sections,truth(none),Predicate),
1878 ( Predicate = truth(_) ->
1879 % even if there is no content, we must check if all identifiers are typed
1880 check_if_all_ids_are_typed(SectionsToType,RefMachines,NonGroundExceptions,Ein,Eout),
1881 Old=New
1882 ;
1883 get_machine_infos(Sections,Infos),
1884 toplevel_raw_predicate_sanity_check(Sec,Name,Predicate,Infos),
1885 type_predicates(Sec,SectionsToType,MachineType,[Predicate],RefMachines,NonGroundExceptions,
1886 [Typed],Ein,Eout),
1887 conjunct_to_section(Sec,Typed,Old,New)
1888 ),
1889 !.
1890 type_section_with_single_predicate(Sec,Name,SectsToType,MchType,_,_,_,_,_,_,_) :-
1891 add_internal_error('type_section_with_single_predicate failed',
1892 type_section_with_single_predicate(Sec,Name,SectsToType,MchType,_,_,_,_,_,_,_)),
1893 fail.
1894
1895 % get some infos relevant for sanity check:
1896 get_machine_infos(Sections,Infos) :-
1897 ((rawmachine_section_exists(concrete_variables,Sections) ; rawmachine_section_exists(abstract_variables,Sections))
1898 -> Infos = [has_variables|I1] ; Infos = I1),
1899 ((rawmachine_section_exists(concrete_constants,Sections) ; rawmachine_section_exists(abstract_constants,Sections))
1900 -> I1 = [has_constants] ; I1 = []).
1901
1902 % Type a section with multiple predicates, such as ASSERTIONS
1903 type_section_with_predicate_list(Sec,SectionsToType,MachineType,Sections,
1904 RefMachines,NonGroundExceptions,Ein,Eout,Old,New) :-
1905 write_section(Sec,Typed,Old,New),
1906 optional_rawmachine_section(Sec,Sections,[],Predicates),
1907 type_predicates(Sec,SectionsToType,MachineType,Predicates,RefMachines,NonGroundExceptions,Typed,Ein,Eout),
1908 !.
1909 type_section_with_predicate_list(Sec,SectsToType,MchType,Sects,RefMchs,NonGrndExc,Ein,Eout,Old,New) :-
1910 add_internal_error('type_section_with_predicate_list failed',
1911 type_section_with_predicate_list(Sec,SectsToType,MchType,Sects,RefMchs,NonGrndExc,Ein,Eout,Old,New)),
1912 fail.
1913
1914
1915 type_predicates(_Sec,SectionsToType,_MachineType,[],RefMachines,NonGroundExceptions,Typed,Ein,Eout) :-
1916 !,Typed=[],
1917 check_if_all_ids_are_typed(SectionsToType,RefMachines,NonGroundExceptions,Ein,Eout).
1918 type_predicates(Sec,SectionsToType,MachineType,Predicates,RefMachines,NonGroundExceptions,Typed,Ein,Eout) :-
1919 visible_env(MachineType, Sec, RefMachines, Env, Ein, E1),
1920 same_length(Predicates,Types),maplist(is_pred_type,Types),
1921 btype_ground_dl_in_section(Sec,Predicates,Env,NonGroundExceptions,Types,Typed1,E1,E2),
1922 mark_with_section(Sec,Typed1,Typed),
1923 check_if_all_ids_are_typed(SectionsToType,RefMachines,NonGroundExceptions,E2,Eout),
1924 (no_perrors_occured(Ein,Eout)
1925 -> perform_post_static_check(Typed) % only run if no type errors, it makes use of find_typed_identifier_uses
1926 ; true
1927 ).
1928
1929 no_perrors_occured(Ein,Eout) :- Ein==Eout,!.
1930 no_perrors_occured([H|T],Eout) :- nonvar(H),not_a_perror(H),no_perrors_occured(T,Eout).
1931
1932 not_a_perror(warning(_,_)).
1933 % other possible values: error(Msg,Pos), internal_error(Msg,Pos); see get_perror/2
1934
1935 % check if the identifiers that should be typed by this section are completly typed
1936 check_if_all_ids_are_typed([],_RefMachines,_NonGroundExceptions,Ein,Eout) :- !,Ein=Eout.
1937 check_if_all_ids_are_typed(SectionsToType,RefMachines,NonGroundExceptions,Ein,Eout) :-
1938 memberchk(ref(local,Local),RefMachines),
1939 get_all_identifiers(SectionsToType,Local,IdentifiersToType),
1940 check_ground_types_dl(IdentifiersToType, NonGroundExceptions, Ein, Eout).
1941
1942
1943 mark_with_section(Sec,In,Out) :-
1944 maplist(mark_with_section2(Sec),In,Out).
1945 mark_with_section2(Sec,In,Out) :-
1946 remove_bt(In,conjunct(A,B),conjunct(NA,NB),Out),!,
1947 mark_with_section2(Sec,A,NA), mark_with_section2(Sec,B,NB).
1948 mark_with_section2(Sec,In,Out) :-
1949 add_texpr_infos(In,[section(Sec)],Out).
1950
1951 type_initialisation_section(Sections,Name,MType,RefMachines,NonGroundExceptions,Ein,Eout,Old,New) :-
1952 write_section(initialisation,Initialisation,Old,New),
1953 ( rawmachine_section_with_opt_desc(initialisation,Sections,Init,Desc,DescPos) ->
1954 visible_env(MType, initialisation, RefMachines, InitEnv, Ein, E1),
1955 btype_ground_dl([Init],InitEnv,NonGroundExceptions,[subst],[TypedInit],E1,Eout),
1956 (Desc='' -> TypedInit2 = TypedInit
1957 ; add_texpr_infos(TypedInit,[description(Desc),description_position(DescPos)],TypedInit2)
1958 ),
1959 Initialisation=[init_stmt(Name,TypedInit2)]
1960 ;
1961 Ein=Eout,
1962 Initialisation=[]).
1963
1964 :- use_module(library(ugraphs)).
1965
1966 type_operations_section(Sections,MType,RefMachines,NonGroundExceptions,Ein,Eout,Old,New) :-
1967 write_section(operation_bodies,Operations,Old,New),
1968 visible_env(MType, operation_bodies, RefMachines, Env, Ein, E1),
1969 optional_rawmachine_section(operations,Sections,[],Ops1),
1970 optional_rawmachine_section(local_operations,Sections,[], LocalOps2),
1971 exclude(duplicate_local_operation(Ops1),LocalOps2,FOps2),
1972 append(FOps2,Ops1,Ops),
1973 topological_sort_operations(Ops,LocalOps2,Env,SOps),
1974 (debug_mode(off) -> true ; length(SOps,NrOps),debug_stats(finished_topological_sorting(NrOps))),
1975 same_length(SOps,Types), maplist(is_op_type,Types),
1976 ? btype_ground_dl(SOps,Env,NonGroundExceptions,Types,Operations,E1,Eout),!.
1977
1978 % check if a LOCAL_OPERATION also exists as a regular operation; if so we can ignore it and
1979 % just use the full operation; see also duplicate_local_operation_id above
1980 duplicate_local_operation(NonLocalOps,LocalOperation) :-
1981 raw_op_id(LocalOperation,OpName),
1982 member(NonLocalOp,NonLocalOps),
1983 raw_op_id(NonLocalOp,OpName), % we found a non-local operation with the same name
1984 !,
1985 raw_op_pos(LocalOperation,LPos),
1986 raw_op_pos(NonLocalOp,NPos),
1987 translate_span(NPos,PS2),
1988 ajoin(['Ignoring LOCAL_OPERATION already defined in OPERATIONS section ',PS2,': '],Msg),
1989 add_message(bmachine_construction,Msg,OpName,LPos).
1990
1991
1992 allow_local_or_expr_op_calls :-
1993 (get_preference(allow_local_operation_calls,true) -> true
1994 ; get_preference(allow_operation_calls_in_expr,true)).
1995 % at the moment ProB allows local calls inside expressions, independently of the allow_local_operation_calls preference
1996
1997 % perform a topological sort of the operations: treat called operation before calling operation
1998 % only relevant when allow_local_operation_calls is set to true
1999 topological_sort_operations(Ops,LocalOps,Env,SortedOps) :-
2000 (LocalOps = [] % there are no LOCAL_OPERATIONS
2001 -> allow_local_or_expr_op_calls % unless call operations in machine itself, no need to perform a topological sort
2002 ; true % we have local_operations, we need topological sort to ensure they are processed before other operations
2003 ),
2004 findall(OtherID-ID, (member(Op,Ops),op_calls_op(Op,Env,ID,OtherID)),Edges),
2005 % print(edges(Edges)),nl,
2006 % TO DO: maybe only store edges where OtherID also appears in Ops (i.e., call within same machine)
2007 Edges \= [],
2008 !,
2009 findall(ID,(member(operation(_,RawID,_,_,_),Ops),raw_id(RawID,ID)),Vertices), %print(vertices(Vertices)),nl,
2010 vertices_edges_to_ugraph(Vertices,Edges,Graph),
2011 (top_sort(Graph,Sorted)
2012 -> sort_ops(Sorted,Ops,SortedOps)
2013 ; get_preference(allow_operation_calls_in_expr,true) ->
2014 add_warning(topological_sort,'Mutual recursion or cycle in the (local) operation call graph, this may cause problems computing reads information: ',Edges),
2015 SortedOps=Ops
2016 % not necessarily a problem, because operations called in expressions are not allowed to modify the state
2017 % TODO: however, we may have an issue with computing reads information correctly for mutual recursion !?
2018 % direct recursion should be ok
2019 ; add_error(topological_sort,'Cycle in the (local) operation call graph: ',Edges),
2020 SortedOps=Ops).
2021 topological_sort_operations(Ops,_,_,Ops).
2022
2023 sort_ops([],Ops,Ops). % Ops should be []
2024 sort_ops([OpID|T],Ops,Res) :-
2025 raw_op_id(Op1,OpID),
2026 (select(Op1,Ops,TOps)
2027 -> Res = [Op1|TSOps], sort_ops(T,TOps,TSOps)
2028 ; % operation from another machine
2029 % print(could_not_find(OpID,Ops)),nl,
2030 sort_ops(T,Ops,Res)
2031 ).
2032
2033 is_op_type(op(_,_)).
2034 is_pred_type(pred).
2035
2036 % compute which other operations are directly called
2037 op_calls_op(operation(_,RawID,_,_,RawBody),Env,ID,OtherID) :- raw_id(RawID,ID),
2038 raw_body_calls_operation(RawBody,ID,Env,OtherID).
2039
2040 raw_body_calls_operation(RawBody,ID,Env,OtherID) :-
2041 raw_member(OpCall,RawBody),
2042 raw_op_call(OpCall,ID,Env,RawOtherID), raw_id(RawOtherID,OtherID).
2043
2044 raw_op_call(operation_call(_,RawOtherID,_,_),_,_, RawOtherID).
2045 raw_op_call(operation_call_in_expr(_,RawOtherID,_),ID,_, RawOtherID) :-
2046 \+ raw_id(RawOtherID,ID). % we do not look at direct recursion: it poses no problem for computing reads/writes info
2047 raw_op_call(function(_,RawOtherID,_), ID, Env, RawOtherID) :- % function calls possibly not yet translated to operation_call_in_expr
2048 get_preference(allow_operation_calls_in_expr,true),
2049 \+ raw_id(RawOtherID,ID), % direct recursion ok
2050 btypechecker:is_operation_call(RawOtherID,Env).
2051 raw_op_call(identifier(Pos,OtherID), ID, Env, RawOtherID) :- % possible operation call in expr without arguments
2052 OtherID \= ID, % direct recursion ok
2053 get_preference(allow_operation_calls_in_expr,true),
2054 RawOtherID = identifier(Pos,OtherID),
2055 btypechecker:is_operation_call(RawOtherID,Env).
2056
2057
2058 raw_op_id(operation(_,RawID,_,_,_RawBody),ID) :- raw_id(RawID,ID).
2059 raw_id(identifier(_,ID),ID).
2060 raw_op_pos(operation(Pos,_RawID,_,_,_RawBody),Pos).
2061
2062 % a utility function to work on the raw AST Functor(POS,Arg1,...,Argn)
2063 % this will not be able to look inside DEFINITIONS !
2064 % TO DO: deal with more raw substitutions which have list arguments
2065 raw_member(X,X).
2066 raw_member(X,parallel(_,List)) :- !, member(Term,List), raw_member(X,Term).
2067 raw_member(X,sequence(_,List)) :- !, member(Term,List), raw_member(X,Term).
2068 raw_member(X,[H|T]) :- !, (raw_member(X,H) ; raw_member(X,T)).
2069 raw_member(X,Term) :- compound(Term), Term =.. [_Functor,_Pos|Args],
2070 member(A,Args), raw_member(X,A).
2071
2072
2073 create_section_identifiers(Section,DestSection,RawMachine,Old,New) :-
2074 write_section(DestSection,Vars,Old,New),
2075 optional_rawmachine_section(Section,RawMachine,[],Identifiers),
2076 create_section_ids2(Identifiers,[],Vars,DestSection,New).
2077
2078 create_section_ids2([],_,[],_,_).
2079 create_section_ids2([Ext|Rest],Infos,Res,DestSection,MachSections) :-
2080 expand_definition_to_variable_list(Ext,MachSections,List),!,
2081 append(List,Rest,NewList),
2082 create_section_ids2(NewList,Infos,Res,DestSection,MachSections).
2083 create_section_ids2([Ext|Rest],Infos,Res,DestSection,MachSections) :-
2084 create_section_id(Ext,Infos,DestSection,TId),
2085 ( TId = error(Msg,Term,Pos) ->
2086 Res = TRest, add_error(bmachine_construction,Msg,Term,Pos)
2087 ;
2088 Res = [TId|TRest]),
2089 create_section_ids2(Rest,Infos,TRest,DestSection,MachSections).
2090 create_section_id(Ext,Infos,DestSection,TId) :-
2091 (unwrap_pragma(Ext,Ext2,PragmaInfos) -> append(PragmaInfos,Infos,FullInfos)
2092 ; Ext2=Ext, FullInfos=Infos),
2093 I=identifier(_),
2094 ( ext2int(Ext2,I,_Pos,_Type,I,FullInfos,TId) ->
2095 true
2096 ; Ext2 = definition(POSINFO,ID,_) ->
2097 TId = error('Trying to use DEFINITION name as identifier: ',
2098 (ID,within(DestSection)), POSINFO)
2099 ;
2100 TId = error('Illegal identifier: ',
2101 (Ext2,within(DestSection)), Ext2)
2102 ).
2103
2104 % support using DEFINITIONS which are variable lists;
2105 % currently for ProB parser you need to write VARS == (x,y,..) for Atelier-B: VARS == x,y,..
2106 expand_definition_to_variable_list(definition(_POSINFO,ID,_),MachSections,List) :-
2107 get_section(definitions,MachSections,Defs),
2108 member(definition_decl(ID,expression,_InnerPos,[],RawExpr,_Deps),Defs),
2109 extract_identifier_list(RawExpr,List,[]).
2110
2111 % convert a raw tuple into a raw identifier list:
2112 extract_identifier_list(identifier(Pos,ID)) --> [identifier(Pos,ID)].
2113 extract_identifier_list(couple(_,List)) -->
2114 extract_identifier_list(List).
2115 extract_identifier_list([]) --> [].
2116 extract_identifier_list([H|T]) --> extract_identifier_list(H), extract_identifier_list(T).
2117
2118
2119 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2120 % sort the machines topologically
2121
2122 % can be used to store the result:
2123 assert_machine_order(Order) :-
2124 retractall(machine_global_order(_)),
2125 debug_print(9,machine_global_order(Order)),
2126 assertz(machine_global_order(Order)).
2127
2128 get_mach_position(Order,M,Ref,Pos-mch(M,Ref)) :-
2129 get_machine_name(M,Name),
2130 ? (nth1(Pos,Order,Name) -> true
2131 ; add_internal_error('Unknown machine:',Name:Order),
2132 Pos=0).
2133 get_machine(_-mch(M,_),M). % re-extract info after sorting
2134 get_reference(_-mch(_,R),R).
2135
2136 :- use_module(library(samsort),[samkeysort/2]).
2137 sort_machines_by_global_order(Machines,SortedMachines) :-
2138 sort_machines_by_global_order(Machines,_,SortedMachines,_).
2139 sort_machines_by_global_order(Machines,Refs,SortedMachines,SortedRefs) :-
2140 machine_global_order(Order),
2141 maplist(get_mach_position(Order),Machines,Refs,KM), % add position so that sorting works
2142 samkeysort(KM,SKM), % for test 925 it is important to keep duplicates and not use sort/2
2143 maplist(get_machine,SKM,SortedMachines),
2144 maplist(get_reference,SKM,SortedRefs),!.
2145 %maplist(get_machine_name,Sorted,SNs),print(sorted(SNs)),nl.
2146 sort_machines_by_global_order(M,R,M,R) :-
2147 add_internal_error('Sorting machines failed:',M).
2148
2149 % perform the actual computation:
2150 machine_order(Machines,Order) :-
2151 machine_dependencies(Machines,Dependencies),
2152 topsort(Dependencies,Order).
2153
2154 % sort the machines topologically
2155 topsort(Deps,Sorted) :-
2156 topsort2(Deps,[],Sorted).
2157 topsort2([],_,[]) :- !.
2158 topsort2(Deps,Known,Sorted) :-
2159 split_list(all_deps_known(Known),Deps,DAvailable,DNotAvailable),
2160 DAvailable = [_|_], % we have new machines available whose dependencies are all known
2161 !,
2162 maplist(dep_name,DAvailable,Available),
2163 append(Available,Known,NewKnown),
2164 append(Available,Rest,Sorted),
2165 topsort2(DNotAvailable,NewKnown,Rest).
2166 topsort2(Deps,_Known,_) :-
2167 member(dep(Name,NameDeps),Deps),
2168 add_error(bmachine_construction,'Could not resolve machine dependencies for: ',Name:depends_on(NameDeps)),
2169 fail.
2170
2171 ?all_deps_known(K,dep(_Name,Deps)) :- sort(Deps,DS),sort(K,KS),subseq0(KS,DS),!.
2172 dep_name(dep(Name,_Deps),Name).
2173
2174 % find dependencies between machines
2175 machine_dependencies(Machines,Dependencies) :-
2176 maplist(machine_dependencies2,Machines,Deps),
2177 sort(Deps,Dependencies).
2178 machine_dependencies2(M,dep(Name,Deps)) :-
2179 get_constructed_machine_name_and_body(M,Name,_,Body),
2180 findall(Ref,
2181 (refines(M,Ref);machine_reference(Body,Ref)),
2182 Deps).
2183
2184 machine_reference(MachineBody,Ref) :-
2185 ? ( member(sees(_,R),MachineBody)
2186 ; member(uses(_,R),MachineBody) ),
2187 ? member(identifier(_,PrefixRef),R),
2188 split_prefix(PrefixRef,_,Ref).
2189 machine_reference(MachineBody,Ref) :-
2190 ( member(includes(_,R),MachineBody)
2191 ? ; member(extends(_,R),MachineBody)
2192 ; member(imports(_,R),MachineBody) ),
2193 ? member(machine_reference(_,PrefixRef,_),R),
2194 split_prefix(PrefixRef,_,Ref).
2195
2196 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2197 % refinements
2198 merge_refinement_and_abstraction(Name,Concrete,RefMachines,Result,Ein,Eout) :-
2199 memberchk(ref(abstraction,Abstraction),RefMachines),
2200 append_sections([sets,concrete_constants,concrete_variables],Abstraction,Concrete,M1),
2201 append_if_new(abstract_constants,Abstraction,M1,M2),
2202 get_section(properties,Abstraction,AbstractProperties),
2203 conjunct_to_section(properties,AbstractProperties,M2,M3),
2204 % now get current invariant Invariant and filter out gluing/linking invariant
2205 % (the linking invariant talks about variables which no longer exist; hence we cannot check it anymore)
2206 select_section(invariant,Invariant,FullConcreteInvariant,M3,M4),
2207 write_section(linking_invariant,LinkingInvariant,M4,Merged),
2208 % we now also copy from the abstraction those invariants which are still valid
2209 get_machine_sorted_variables(Abstraction,SortedAbsVars),
2210 get_machine_sorted_variables(Concrete,SortedConcrVars),
2211 assert_removed_abs_vars(SortedAbsVars,SortedConcrVars,Name),
2212 get_section(invariant,Abstraction,AbstractInvariant),
2213 filter_abstract_invariant(AbstractInvariant,SortedConcrVars,AbsInvariantStillValid),
2214 filter_linking_invariant(Invariant,LinkingInvariant,ConcreteInvariant),
2215 conjunct_predicates([AbsInvariantStillValid,ConcreteInvariant],FullConcreteInvariant),
2216 propagate_abstract_operations(Abstraction,Merged,RefMachines,Result,Ein,Eout).
2217 merge_refinement_and_abstraction(_,Machine,_,Machine,Errors,Errors).
2218
2219 :- use_module(probsrc(bsyntaxtree), [same_id/3]).
2220 assert_removed_abs_vars([],_,_).
2221 assert_removed_abs_vars([TID1|H],[],Name) :- !,
2222 assert_abstract_variable_removed_in(Name,TID1),
2223 assert_removed_abs_vars(H,[],Name).
2224 assert_removed_abs_vars([TID1|T1],[TID2|T2],Name) :- same_id(TID1,TID2,_),!,
2225 assert_removed_abs_vars(T1,T2,Name).
2226 assert_removed_abs_vars([TID1|T1],[TID2|T2],Name) :- TID1 @< TID2,!,
2227 assert_abstract_variable_removed_in(Name,TID1),
2228 assert_removed_abs_vars(T1,[TID2|T2],Name).
2229 assert_removed_abs_vars([TID1|T1],[_|T2],Name) :- % TID2 added in Name
2230 assert_removed_abs_vars([TID1|T1],T2,Name).
2231
2232
2233 assert_abstract_variable_removed_in(Name,TID) :-
2234 get_texpr_id(TID,ID),
2235 ajoin(['Variable ',ID,' removed in refinement machine: '],Msg),
2236 add_debug_message(bmachine_construction,Msg,Name,TID),
2237 assertz(abstract_variable_removed_in(ID,Name,TID)).
2238
2239
2240 % append sections from abstract machine to concrete machine:
2241 append_sections(Sections,AbsMachine,Old,New) :-
2242 expand_shortcuts(Sections,AllSections),
2243 append_sections2(AllSections,AbsMachine,Old,New).
2244 append_sections2([],_,M,M).
2245 append_sections2([Section|Rest],AbsMachine,Old,New) :-
2246 get_section(Section,AbsMachine,Content),
2247 append_to_section3(Section,Content,Old,Inter),
2248 append_sections2(Rest,AbsMachine,Inter,New).
2249
2250 append_to_section3(Section,Content,Old,Inter) :- section_can_have_duplicates(Section),!,
2251 append_to_section_and_remove_dups(Section,Content,Old,Inter).
2252 append_to_section3(Section,Content,Old,Inter) :- append_to_section(Section,Content,Old,Inter).
2253
2254 :- assert_must_succeed((create_machine(abs,EA), create_machine(conc,EB),
2255 write_section(abstract_constants,[b(identifier(x),integer,[some_info])],EA,A),
2256 write_section(abstract_constants,[b(identifier(x),integer,[other_info]),
2257 b(identifier(y),integer,[info])],EB,B),
2258 append_if_new(abstract_constants,A,B,ResultM),
2259 get_section(abstract_constants,ResultM,ResultConst),
2260 ResultConst==[b(identifier(x),integer,[other_info]),
2261 b(identifier(y),integer,[info])]
2262 )).
2263
2264 append_if_new(Section,Machine,In,Out) :-
2265 get_section(Section,Machine,Content),
2266 select_section(Section,Old,New,In,Out),
2267 get_texpr_ids(Old,ExistingIds),
2268 exclude(is_in_existing_ids(ExistingIds),Content,NewElements),
2269 append(Old,NewElements,New).
2270 is_in_existing_ids(ExistingIds,TId) :-
2271 get_texpr_id(TId,Id),
2272 memberchk(Id,ExistingIds).
2273
2274 % filter linking and concrete invariant
2275 filter_linking_invariant(Invariant,Linking,Concrete) :-
2276 split_conjuncts(Invariant,Predicates),
2277 split_list(contains_abstraction_refs,Predicates,Linkings,Concretes),
2278 conjunct_predicates(Linkings,Linking),
2279 conjunct_predicates(Concretes,Concrete).
2280
2281
2282 % contains_abstraction_refs can be used on predicates of the current machine: the abstraction info field has been computed for this machine
2283 contains_abstraction_refs(TExpr) :-
2284 syntaxtraversion(TExpr,_,_,Infos,Subs,_),
2285 ( memberchk(abstraction,Infos) % This info field comes from the last argument of visibility/6
2286 -> true
2287 ; member(Sub,Subs),
2288 contains_abstraction_refs(Sub)).
2289
2290 % Determine which part of the abstract invariant can be imported into the refinement machine
2291 % TODO: should this be applied to WHILE loop INVARIANTS?
2292 filter_abstract_invariant(AbsInvariant,SortedConcrVars,ConcreteInv) :-
2293 split_conjuncts(AbsInvariant,Predicates),
2294 filter_abs_invs(Predicates,SortedConcrVars,Concretes),
2295 conjunct_predicates(Concretes,ConcreteInv). %, print('COPY: '), translate:print_bexpr(Concrete),nl.
2296 :- use_module(translate,[translate_bexpression/2]).
2297
2298 filter_abs_invs([],_,[]).
2299 filter_abs_invs([TExpr|TInv],SortedConcrVars,Res) :-
2300 contains_abstract_variables2(SortedConcrVars,TExpr,Cause),!,
2301 (silent_mode(on) -> true
2302 ; translate_bexpression(Cause,ID),
2303 ajoin(['Discarding abstract INVARIANT (requires variable `',ID,'`): '],Msg),
2304 add_message(bmachine_construction,Msg,TExpr,Cause)
2305 ),
2306 (adapt_invariant(SortedConcrVars,TExpr,NewTExpr)
2307 -> Res = [NewTExpr|TRes],
2308 add_message(bmachine_construction,'Replaced abstract INVARIANT by: ',NewTExpr,Cause)
2309 ; Res=TRes
2310 ),
2311 filter_abs_invs(TInv,SortedConcrVars,TRes).
2312 filter_abs_invs([TExpr|TInv],SortedConcrVars,[TExpr|TRes]) :-
2313 filter_abs_invs(TInv,SortedConcrVars,TRes).
2314
2315 contains_abstract_variables2(SortedConcrVars,TExpr,Cause) :-
2316 syntaxtraversion(TExpr,Expr,Type,Infos,Subs,_),
2317 ( memberchk(loc(_,_Mch,abstract_variables),Infos) % are there other things that pose problems: abstract_constants ?
2318 -> %print('Abs: '),translate:print_bexpr(TExpr),nl, print(SortedConcrVars),nl,
2319 Cause=TExpr,
2320 \+ ord_member_nonvar_chk(b(Expr,Type,_),SortedConcrVars) % otherwise variable is re-introduced with same type
2321 % in some Event-B models: VARIABLES keyword is used and in refinement VARIABLES are re-listed
2322 % TO DO: check what happens when variable not immediately re-introduced
2323 ; member(Sub,Subs),
2324 contains_abstract_variables2(SortedConcrVars,Sub,Cause)
2325 ).
2326
2327 % try and keep part of invariant, e.g., if f:ABS-->Ran translate to f: TYPE +-> Ran
2328 adapt_invariant(SortedConcrVars,b(member(LHS,RHS),pred,I),b(member(LHS,NewRHS),pred,I)) :-
2329 \+ contains_abstract_variables2(SortedConcrVars,LHS,_),
2330 adapt_to_concrete_superset(RHS,SortedConcrVars,NewRHS),
2331 \+ get_texpr_expr(NewRHS,typeset). % not really useful
2332
2333 adapt_to_concrete_superset(b(E,Type,Info),SortedConcrVars,b(NewE,Type,Info)) :-
2334 adapt_super2(E,SortedConcrVars,NewE). % TODO: adapt info fields?
2335 adapt_to_concrete_superset(b(_E,Type,_Info),_SortedConcrVars,b(typeset,Type,[])).
2336 % Range of function remains concrete, Domain is abstract and no longer available:
2337 adapt_super2(PFUN,SortedConcrVars,partial_function(NewDom,RAN)) :-
2338 is_fun(PFUN,partial,DOM,RAN),
2339 \+ contains_abstract_variables2(SortedConcrVars,RAN,_),
2340 adapt_to_concrete_superset(DOM,SortedConcrVars,NewDom).
2341 adapt_super2(TFUN,SortedConcrVars,partial_function(NewDom,RAN)) :-
2342 is_fun(TFUN,total,DOM,RAN),
2343 \+ contains_abstract_variables2(SortedConcrVars,RAN,_),
2344 adapt_to_concrete_superset(DOM,SortedConcrVars,NewDom).
2345 % Domain of function remains concrete, Range is abstract and no longer available:
2346 adapt_super2(PFUN,SortedConcrVars,partial_function(DOM,NewRan)) :-
2347 is_fun(PFUN,partial,DOM,RAN),
2348 \+ contains_abstract_variables2(SortedConcrVars,DOM,_),
2349 adapt_to_concrete_superset(RAN,SortedConcrVars,NewRan).
2350 adapt_super2(TFUN,SortedConcrVars,total_function(DOM,NewRan)) :-
2351 is_fun(TFUN,total,DOM,RAN),
2352 \+ contains_abstract_variables2(SortedConcrVars,DOM,_),
2353 adapt_to_concrete_superset(RAN,SortedConcrVars,NewRan).
2354 adapt_super2(FUN,SortedConcrVars,partial_function(NewDom,NewRan)) :-
2355 is_fun(FUN,_,DOM,RAN),
2356 adapt_to_concrete_superset(DOM,SortedConcrVars,NewDom),
2357 adapt_to_concrete_superset(RAN,SortedConcrVars,NewRan).
2358 % TODO: more cases, intersection(ABS,CONCR) -> CONCR, cartesian_product
2359
2360 is_fun(partial_function(DOM,RAN),partial,DOM,RAN).
2361 is_fun(partial_injection(DOM,RAN),partial,DOM,RAN).
2362 is_fun(partial_surjection(DOM,RAN),partial,DOM,RAN).
2363 is_fun(partial_bijection(DOM,RAN),partial,DOM,RAN).
2364 is_fun(total_function(DOM,RAN),total,DOM,RAN).
2365 is_fun(total_injection(DOM,RAN),total,DOM,RAN).
2366 is_fun(total_surjection(DOM,RAN),total,DOM,RAN).
2367 is_fun(total_bijection(DOM,RAN),total,DOM,RAN).
2368
2369 % ---------------------
2370
2371 get_machine_sorted_variables(Machine,SortedAllVars) :-
2372 get_section(abstract_variables,Machine,AbsVars),
2373 get_section(concrete_variables,Machine,ConcVars),
2374 append(ConcVars,AbsVars,AllVars),
2375 sort(AllVars,SortedAllVars).
2376
2377 split_conjuncts(Expr,List) :-
2378 split_conjuncts2(Expr,List,[]).
2379 split_conjuncts2(Expr) -->
2380 {get_texpr_expr(Expr,conjunct(A,B)),!},
2381 split_conjuncts2(A),
2382 split_conjuncts2(B).
2383 split_conjuncts2(Expr) --> [Expr].
2384
2385 % copy the abstract operations or re-use their preconditions
2386 % TODO: think about copying Initialisation?
2387 propagate_abstract_operations(Abstract,Concrete,RefMachines,Result,Ein,Eout) :-
2388 get_section(promoted,Abstract,APromoted),
2389 get_section(operation_bodies,Abstract,ABodies),
2390 % signature: select_section(SecName,OldContent,NewContent,OldMachine,NewMachine)
2391 select_section(promoted,CPromotedIn,CPromotedOut,Concrete,Concrete2),
2392 select_section(operation_bodies,CBodiesIn,CBodiesOut,Concrete2,Result),
2393 propagate_aops(APromoted,ABodies,RefMachines,CPromotedIn,CBodiesIn,CPromotedOut,CBodiesOut,Ein,Eout).
2394 propagate_aops([],_ABodies,_RefMachines,CPromoted,CBodies,CPromoted,CBodies,Errors,Errors).
2395 propagate_aops([APromoted|ApRest],ABodies,RefMachines,CPromotedIn,CBodiesIn,CPromotedOut,CBodiesOut,Ein,Eout) :-
2396 get_operation(APromoted,ABodies,AbstractOp),
2397 def_get_texpr_id(APromoted,op(APromotedOpName)),
2398 copy_texpr_wo_info(APromoted,CProm),
2399 ( member(CProm,CPromotedIn) ->
2400 debug_format(19,'Refining promoted abstract operation ~w to refinement machine.~n',[APromotedOpName]),
2401 extract_concrete_preconditions(AbstractOp,RefMachines,Pre),
2402 change_operation(APromoted,ConcreteOpOld,ConcreteOpNew,CBodiesIn,CBodiesRest),
2403 add_precondition(Pre,ConcreteOpOld,ConcreteOpNew), % propagate PRE down to concrete operation
2404 CPromotedIn = CPromotedRest,
2405 Ein = E1
2406 % TO DO: do not copy if event is refined at least once with renaming !
2407 ; is_refined_by_some_event(APromotedOpName,CPromotedIn,ConcreteOpName) ->
2408 debug_format(19,'Not copying abstract operation ~w to refinement machine, as it is refined by ~w.~n',[APromotedOpName,ConcreteOpName]),
2409 CPromotedRest=CPromotedIn, CBodiesRest=CBodiesIn,
2410 E1=Ein
2411 ;
2412 debug_format(19,'Copying abstract operation ~w to refinement machine, as it is not refined.~n',[APromotedOpName]),
2413 % TO DO: check that this is also the right thing to do for Atelier-B Event-B
2414 % TO DO: check that the variables are also still there
2415 check_copied_operation(APromoted,AbstractOp,RefMachines,Ein,E1),
2416 append(CPromotedIn,[APromoted],CPromotedRest),
2417 append(CBodiesIn,[AbstractOp],CBodiesRest)
2418 ),
2419 propagate_aops(ApRest,ABodies,RefMachines,CPromotedRest,CBodiesRest,CPromotedOut,CBodiesOut,E1,Eout).
2420
2421 is_refined_by_some_event(AbstractName,CPromotedList,ConcreteName) :-
2422 member(TID,CPromotedList),
2423 get_texpr_info(TID,Infos),
2424 memberchk(refines_operation(AbstractName),Infos),
2425 def_get_texpr_id(TID,ConcreteName).
2426
2427 get_operation(TId,Bodies,Operation) :-
2428 select_operation(TId,Bodies,Operation,_BodiesRest).
2429 change_operation(TId,OldOp,NewOp,OldBodies,[NewOp|NewBodies]) :-
2430 select_operation(TId,OldBodies,OldOp,NewBodies).
2431 select_operation(TId,Bodies,Operation,BodiesRest) :-
2432 copy_texpr_wo_info(TId,OpId),
2433 get_texpr_expr(Operation,operation(OpId,_,_,_)),
2434 select(Operation,Bodies,BodiesRest),!.
2435
2436 extract_concrete_preconditions(Op,RefMachines,FPre) :-
2437 extract_preconditions_op(Op,Pre),
2438 extract_op_arguments(Op,Args),
2439 conjunction_to_list(Pre,Pres),
2440 % todo: check the "machine" parameter
2441 visible_env(machine,operation_bodies,RefMachines,Env1,_Errors,[]),
2442 store_variables(Args,Env1,Env),
2443 filter_predicates_with_unknown_identifiers(Pres,Env,FPres),
2444 conjunct_predicates(FPres,FPre).
2445
2446 extract_op_arguments(Op,Params) :-
2447 get_texpr_expr(Op,operation(_,_,Params,_)).
2448
2449 extract_preconditions_op(OpExpr,Pre) :-
2450 get_texpr_expr(OpExpr,operation(_,_,_,Subst)),
2451 extract_preconditions(Subst,Pres,_),
2452 conjunct_predicates(Pres,Pre).
2453 extract_preconditions(TExpr,Pres,Inner) :-
2454 get_texpr_expr(TExpr,Expr),
2455 extract_preconditions2(Expr,TExpr,Pres,Inner).
2456 extract_preconditions2(precondition(Pre,Subst),_,[Pre|Pres],Inner) :- !,
2457 extract_preconditions(Subst,Pres,Inner).
2458 extract_preconditions2(block(Subst),_,Pres,Inner) :- !,
2459 extract_preconditions(Subst,Pres,Inner).
2460 extract_preconditions2(_,Inner,[],Inner).
2461
2462 :- use_module(btypechecker,[prime_atom0/2]).
2463 filter_predicates_with_unknown_identifiers([],_Env,[]).
2464 filter_predicates_with_unknown_identifiers([Pred|Prest],Env,Result) :-
2465 ( find_unknown_identifier(Pred,Env,_Id) ->
2466 !,Result = Rrest
2467 ;
2468 Result = [Pred|Rrest]),
2469 filter_predicates_with_unknown_identifiers(Prest,Env,Rrest).
2470 find_unknown_identifier(Pred,Env,Id) :-
2471 get_texpr_id(Pred,Id),!,
2472 \+ env_lookup_type(Id,Env,_),
2473 (atom(Id),prime_atom0(UnprimedId,Id)
2474 -> % we have an identifier with $0 at end
2475 \+ env_lookup_type(UnprimedId,Env,_) % check unprimed identifier also unknown
2476 ; true).
2477 find_unknown_identifier(Pred,Env,Id) :-
2478 syntaxtraversion(Pred,_,_,_,Subs,Names),
2479 store_variables(Names,Env,Subenv),
2480 find_unknown_identifier_l(Subs,Subenv,Id).
2481 find_unknown_identifier_l([S|_],Env,Id) :-
2482 find_unknown_identifier(S,Env,Id),!.
2483 find_unknown_identifier_l([_|Rest],Env,Id) :-
2484 find_unknown_identifier_l(Rest,Env,Id).
2485
2486 :- use_module(library(ordsets),[ord_union/3]).
2487 % we add a precondition to an existing operation
2488 % Note: we need to update the reads info computed by the type checker (compute_accessed_vars_infos_for_operation)
2489 add_precondition(b(truth,_,_),Old,New) :- !, Old=New.
2490 add_precondition(Pre,b(Old,T,I),b(New,T,I2)) :-
2491 Old=operation(Id,Res,Params,Subst),
2492 New=operation(Id,Res,Params,NewSubst),
2493 extract_preconditions(Subst,OldPres,Inner),
2494 conjunct_predicates([Pre|OldPres],NewPre),
2495 create_texpr(precondition(NewPre,Inner),subst,[],NewSubst),
2496 (select(reads(OldReads),I,I1) % we do not have to update modifies(.), non_det_modifies(.), reads_locals(.),...
2497 -> I2=[reads(NewReads)|I1],
2498 get_texpr_ids(Params,Ignore),
2499 find_identifier_uses(Pre,Ignore,PreUsedIds),
2500 ord_union(PreUsedIds,OldReads,NewReads)
2501 ; add_internal_error('No reads info for operation: ',add_precondition(Pre,b(Old,T,I),b(New,T,I2))),
2502 I2=I).
2503
2504
2505
2506 check_copied_operation(OpRef,Op,RefMachines,Ein,Eout) :-
2507 % todo: check the "refinement" parameter
2508 visible_env(refinement,operation_bodies,RefMachines,Env1,_Errors,[]),
2509 get_texpr_id(OpRef,OpId),get_texpr_type(OpRef,OpType),
2510 env_store(OpId,OpType,[],Env1,Env),
2511 findall(U, find_unknown_identifier(Op,Env,U), Unknown1),
2512 ( Unknown1=[] -> Ein=Eout
2513 ;
2514 sort(Unknown1,Unknown),
2515 op(OpName) = OpId,
2516 join_ids(Unknown,IdList),
2517 (Unknown = [_] -> Plural=[]; Plural=['s']),
2518 append([['Operation ',OpName,
2519 ' was copied from abstract machine but the identifier'],
2520 Plural,
2521 [' '],
2522 IdList,
2523 [' cannot be seen anymore']],Msgs),
2524 ajoin(Msgs,Msg), Ein = [error(Msg,none)|Eout]
2525 ).
2526 join_ids([I],[Msg]) :- !,opname(I,Msg).
2527 join_ids([A|Rest],[Msg,','|Mrest]) :- opname(A,Msg),join_ids(Rest,Mrest).
2528 opname(op(Id),Id) :- !.
2529 opname(Id,Id).
2530
2531 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2532 % split an identifier into a (possible empty) prefix and the name itself
2533 % e.g. split_prefix('path.to.machine', 'path.to', 'machine').
2534 split_prefix(Term,Prefix,Main) :-
2535 one_arg_term(Functor,Arg,Term),!,
2536 one_arg_term(Functor,MArg,Main),
2537 split_prefix(Arg,Prefix,MArg).
2538 split_prefix(PR,Prefix,Main) :-
2539 safe_atom_chars(PR,Chars,split_prefix1),
2540 split_prefix2(Chars,Chars,[],CPrefix,CMain),
2541 safe_atom_chars(Main,CMain,split_prefix2),
2542 safe_atom_chars(Prefix,CPrefix,split_prefix3).
2543 split_prefix2([],Main,_,[],Main).
2544 split_prefix2([C|Rest],Previous,PrefBefore,Prefix,Main) :-
2545 ( C='.' ->
2546 append(PrefBefore,RestPrefix,Prefix),
2547 split_prefix2(Rest,Rest,[C],RestPrefix,Main)
2548 ;
2549 append(PrefBefore,[C],NextPref),
2550 split_prefix2(Rest,Previous,NextPref,Prefix,Main)).
2551
2552 rawmachine_section(Elem,List,Result) :-
2553 rawmachine_section_with_opt_desc(Elem,List,Result,_,_).
2554
2555
2556 rawmachine_section_with_opt_desc(Elem,List,Result,Desc,Pos) :- section_can_have_description_pragma(Elem),
2557 functor(Pattern,Elem,2),
2558 arg(2,Pattern,Result),
2559 select(description_machine_clause(Pos,DescText,Pattern),List,_),!,
2560 (DescText = description_text(_Pos,Desc) -> true ; Desc='?illegal_desc?').
2561 rawmachine_section_with_opt_desc(Elem,List,Result,'',unknown) :-
2562 functor(Pattern,Elem,2),
2563 arg(2,Pattern,Result),
2564 ? select(Pattern,List,Rest),!,
2565 (functor(Pattern2,Elem,2),member(Pattern2,Rest)
2566 -> arg(1,Pattern2,Pos),
2567 add_error(bmachine_construction,'Multiple sections for: ',Elem,Pos)
2568 ; true).
2569
2570
2571 section_can_have_description_pragma(initialisation).
2572
2573 optional_rawmachine_section(Elem,List,Default,Result) :-
2574 ( rawmachine_section(Elem,List,Result1) -> Result=Result1
2575 ; Result=Default).
2576
2577
2578 one_arg_term(Functor,Arg,Term) :- %print(one_arg_term(Functor,Arg,Term)),nl,
2579 functor(Term,Functor,1),arg(1,Term,Arg).
2580
2581 % check if a rawmachine section list has a given section
2582 rawmachine_section_exists(Elem,List) :- %
2583 functor(Pattern,Elem,2),
2584 ? (member(Pattern,List) -> true).
2585
2586 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2587 % visibility rules
2588
2589 % the visibility/5 predicate declares what a part of a machine can see
2590 % visibility(MType, Scope, Section, Access, Info) means:
2591 % In a machine of type MType (machine, refinement, implementation),
2592 % an expression in a Section (like invariant) can see
2593 % the identifiers in the Access sections. Access is a list of
2594 % sections, where shortcuts are allowed (see shortcut/2, e.g., shortcut(operations,[unpromoted,promoted]).).
2595 % Scope defines where (in relation to the Section)
2596 % the section in Access are (local: same machine, included: in an
2597 % included machine, etc.)
2598 % Info is a list of additional information that is added to each
2599 % identifier in the environment to build up. E.g. in an operation
2600 % definition, constants are marked readonly.
2601 visibility(machine, local, constraints, [parameters],[]).
2602 visibility(machine, local, includes, [parameters,sets,constants],[]).
2603 visibility(machine, local, properties, [sets,constants],[]).
2604 visibility(machine, local, invariant, [parameters,sets,constants,variables],[]).
2605 visibility(machine, local, operation_bodies, [parameters,sets,constants],[readonly]).
2606 visibility(machine, local, operation_bodies, [operations],Info) :- Info =[readonly,dontcall].
2607 % an operation to be readonly: means we cannot assign to it; but the operation itself can change variables
2608 % for allow_operation_calls_in_expr=true we check that operation is inquiry in type checker
2609 % (get_preference(allow_operation_calls_in_expr,true) -> Info = [inquiry]
2610 % ; Info =[readonly,dontcall] ). % we check in btype(operation_call_in_expr)
2611 visibility(machine, local, operation_bodies, [variables],[]).
2612 ?visibility(machine, local, initialisation, Access,[not_initialised|Info]) :- visibility(machine,local,operation_bodies,Access,Info).
2613
2614 visibility(machine, Scope, assertions, [Allow],[inquiry|DC]) :-
2615 (Scope = local -> Allow=operations, DC=[dontcall] ; Allow=promoted, DC=[]),
2616 get_preference(allow_operation_calls_in_expr,true). % if we allow calling operations in expressions
2617 visibility(machine, Scope, invariant, [promoted],[inquiry]) :-
2618 Scope \= local, % do not allow calling local operations in invariant; their correctness relies on the invariant
2619 get_preference(allow_operation_calls_in_expr,true).
2620
2621 visibility(machine, included, properties, [sets,constants],[]).
2622 visibility(machine, included, invariant, [sets,constants,variables],[]).
2623 visibility(machine, included, operation_bodies, [sets,constants,variables],[readonly]).
2624 visibility(machine, included, operation_bodies, [promoted],Info) :- Info = [readonly].
2625 % for allow_operation_calls_in_expr=true we check that operation is inquiry in type checker
2626 % (get_preference(allow_operation_calls_in_expr,true) -> Info = [inquiry] ; Info=[readonly]).
2627 %visibility(machine, included, initialisation, [sets,constants,variables,promoted],[readonly]).
2628 visibility(machine, included, initialisation, [sets,constants,promoted],[readonly]).
2629 visibility(machine, included, initialisation, [variables],Info) :-
2630 (get_preference(allow_overriding_initialisation,true)
2631 -> Info = [] % allow overriding INITIALISATION / making it more concrete
2632 ; Info = [readonly]). % default Atelier-B semantics
2633
2634 visibility(machine, used, properties, [sets,constants],[]).
2635 visibility(machine, used, invariant, [parameters,sets,constants,variables],[]).
2636 visibility(machine, used, operation_bodies, [parameters,sets,constants,variables],[readonly]).
2637 visibility(machine, used, initialisation, [parameters,sets,constants,variables],[readonly]).
2638 visibility(machine, used, operation_bodies, [operations],[inquiry]) :-
2639 get_preference(allow_operation_calls_for_uses,true). %% added by leuschel, allowed in Schneider Book
2640 % but not allowed by Atelier-B; see test 2135
2641
2642 visibility(machine, seen, includes, [sets,constants],[]).
2643 visibility(machine, seen, properties, [sets,constants],[]).
2644 visibility(machine, seen, invariant, [sets,constants],[]).
2645 visibility(machine, seen, operation_bodies, [sets,constants,variables],[readonly]).
2646 visibility(machine, seen, initialisation, [sets,constants,variables],[readonly]).
2647 visibility(machine, seen, operation_bodies, [operations],[inquiry]). %% added by leuschel, allow query operation
2648
2649 visibility(refinement, local, Section, Access, Info) :-
2650 Section \= assertions, % assertions are handled below
2651 visibility(machine, local, Section, Access, Info).
2652
2653 visibility(refinement, abstraction, includes, [sets,concrete_constants],[]).
2654 visibility(refinement, abstraction, properties, [sets,constants],[]).
2655 visibility(refinement, abstraction, invariant, [sets,constants,concrete_variables],[]).
2656 visibility(refinement, abstraction, invariant, [abstract_variables],[abstraction]).
2657 visibility(refinement, abstraction, operation_bodies, [sets,concrete_constants],[readonly]).
2658 visibility(refinement, abstraction, operation_bodies, [concrete_variables],[]).
2659
2660 visibility(refinement, included, properties, [sets,constants],[]).
2661 visibility(refinement, included, invariant, [sets,constants,variables],[]).
2662 visibility(refinement, included, operation_bodies, [sets,constants,variables,promoted],[re]). % What is re ??? TO DO: investigate
2663
2664 visibility(refinement, seen, includes, [sets,constants],[]).
2665 visibility(refinement, seen, properties, [sets,constants],[]).
2666 visibility(refinement, seen, invariant, [sets,constants],[]).
2667 visibility(refinement, seen, operation_bodies, [sets,constants,variables],[readonly]).
2668 visibility(refinement, seen, operation_bodies, [operations],[inquiry]).
2669
2670 visibility(refinement, Ref, initialisation, Access, [not_initialised|Info]) :-
2671 visibility(refinement,Ref,operation_bodies,Access,Info).
2672
2673 % assertions have same visibility as invariant
2674 visibility(MType, Ref, assertions, Part, Access) :-
2675 ? visibility(MType,Ref,invariant,Part,Access).
2676
2677 visibility(implementation, Ref, Section, Part, Access) :-
2678 visibility(refinement, Ref, Section, Part, Access).
2679 visibility(implementation, local, values_expression, [concrete_constants,sets],[]). % seems to have no effect (yet); see ArrayValuationAImp
2680 visibility(implementation, included, values_expression, [concrete_constants,sets],[]).
2681 visibility(implementation, seen, values_expression, [concrete_constants,sets],[]).
2682 visibility(implementation, abstraction,values_expression, [concrete_constants,sets],[]).
2683
2684 % For predicates over pre- and post-states
2685 visibility(MType, Rev, prepost, Access, Info) :-
2686 ? visibility(MType, Rev, invariant, Access, Info).
2687 visibility(MType, Rev, prepost, Access, [primed,poststate|Info]) :-
2688 ? visibility(MType, Rev, invariant, Access, Info).
2689
2690 % add error messages for some common mistakes (access to parameters in the properties)
2691 visibility(machine, local, properties, [parameters], [error('a parameter cannot be accessed in the PROPERTIES section')]).
2692 % the following rule should be helpful for the user, but additionally it also
2693 % provides a mechanism to re-introduce abstract variables in the INVARIANT
2694 % section of a while loop (to enable this, an identifier is also marked with "abstraction")
2695 % in the predicate allow_access_to_abstract_var
2696 visibility(refinement, abstraction, operation_bodies, [abstract_variables],
2697 [error('illegal access to an abstract variable in an operation'),abstraction]).
2698 visibility(refinement, abstraction, operation_bodies, [abstract_constants],
2699 [error('illegal access to an abstract constant in an operation (only allowed in WHILE INVARIANT or ASSERT)'),abstraction]).
2700
2701
2702 % lookups up all identifier sections that are accessible from
2703 % the given section, removes all shortcuts and removes
2704 % duplicate entries
2705 %
2706 % Returns a list of vis(Section,Info) where Section is the
2707 % identifier section that can be seen with Info as a list
2708 % of additional information
2709 expanded_visibility(MType, Ref, Part, Access) :-
2710 findall(vis(Section,Infos),
2711 ( visibility(MType,Ref,Part,Sections1,Infos),
2712 expand_shortcuts(Sections1,Sections),
2713 member(Section,Sections)),
2714 Access1),
2715 sort(Access1,Access).
2716 %format('MType=~w, Ref=~w, Part=~w~n Vis=~w~n',[MType,Ref,Part,Access]).
2717
2718 % visible_env/6 creates a type environment for a certain
2719 % part of a machine by looking up which identifier should
2720 % be visible from there and what additional information should
2721 % be added (e.g. to restrict access to read-only)
2722 %
2723 % The visibility/6 facts are used to define which identifier are visible
2724 %
2725 % MType: machine type (machine, refinement, ...)
2726 % Part: part of the machine for which the environment should be created
2727 % RefMachines: referred machines that are already typed
2728 % Env: The created environment
2729 % Errors: errors might be added if multiple variables with the same identifier
2730 % are declared
2731 visible_env(MType, Part, RefMachines, Env, Err_in, Err_out) :-
2732 env_empty(Init),
2733 visible_env(MType, Part, RefMachines, Init, Env, Err_in, Err_out).
2734 % visible_env/7 is like visible_env/6, but an initial environment
2735 % can be given in "In"
2736 visible_env(MType, Part, RefMachines, In, Out, Err_in, Err_out) :-
2737 foldl(visible_env2(MType,Part),RefMachines,In/Err_in,Out/Err_out).
2738 visible_env2(MType,Part,extended_local_ref(Machine),InEnvErr,OutEnvErr) :- !,
2739 Scope=local,
2740 get_machine_name(Machine,MName),
2741 %format('adding identifiers from machine ~w for scope ~w~n',[MName,Scope]),
2742 get_section(definitions,Machine,Defs),
2743 foldl(env_add_def(MName),Defs,InEnvErr,InEnvErr2),
2744 (bmachine:additional_configuration_machine(_MchName,AddMachine),
2745 get_section(definitions,AddMachine,AdditionalDefs)
2746 -> foldl(env_add_def(MName),AdditionalDefs,InEnvErr2,InterEnvErr)
2747 ; InterEnvErr = InEnvErr2
2748 ),
2749 expanded_visibility(MType, Scope, Part, Access),
2750 foldl(create_vis_env(Scope,MName,Machine),Access,InterEnvErr,OutEnvErr).
2751 visible_env2(MType,Part,ref(Scope,Machine),InEnvErr,OutEnvErr) :-
2752 get_machine_name(Machine,MName),
2753 %format('adding identifiers from machine ~w for scope ~w~n',[MName,Scope]),
2754 ( Scope == local ->
2755 get_section(definitions,Machine,Defs),
2756 %nl,print(adding_defs(Defs)),nl,nl,
2757 foldl(env_add_def(MName),Defs,InEnvErr,InterEnvErr)
2758 ;
2759 InEnvErr=InterEnvErr),
2760 expanded_visibility(MType, Scope, Part, Access),
2761 foldl(create_vis_env(Scope,MName,Machine),Access,InterEnvErr,OutEnvErr).
2762 env_add_def(MName,definition_decl(Name,PType,Pos,Params,Body,_Deps),InEnvErr,OutEnvErr) :-
2763 Type = definition(PType,Params,Body),
2764 Info = [nodeid(Pos),loc(local,MName,definitions)],
2765 create_texpr(identifier(Name),Type,Info,TExpr),
2766 add_unique_variable(TExpr,InEnvErr,OutEnvErr),!.
2767 env_add_def(MName,Def,EnvErr,EnvErr) :-
2768 add_internal_error('Cannot deal with DEFINITION: ',env_add_def(MName,Def)).
2769
2770 create_vis_env(Scope,MName,IDS,vis(Section,Infos),InEnvErr,OutEnvErr) :-
2771 get_section(Section,IDS,Identifiers1),
2772 % get_texpr_ids(Identifiers1,II),format('Got identifiers for ~w:~w = ~w~n',[MName,Section,II]),
2773 (Section=freetypes
2774 -> generate_free_type_ids(Identifiers1,Identifiers2)
2775 ; Identifiers2=Identifiers1),
2776 maplist(add_infos_to_identifier([loc(Scope,MName,Section)|Infos]),Identifiers2,Identifiers),
2777 l_add_unique_variables(Identifiers,InEnvErr,OutEnvErr).
2778
2779 % optimized version of foldl(add_unique_variable,Identifiers,InEnvErr,OutEnvErr).
2780 l_add_unique_variables([],Env,Env).
2781 l_add_unique_variables([ID|T],InEnvErr,OutEnvErr) :-
2782 add_unique_variable(ID,InEnvErr,IntEnv),
2783 l_add_unique_variables(T,IntEnv,OutEnvErr).
2784
2785 % freetypes: generate IDs for Z freetype section
2786 % The classical B FREETYPE section is dealt with in another place (TODO: unify this)
2787 generate_free_type_ids([freetype(FTypeId,Cases)|T],[b(identifier(FTypeId),set(freetype(FTypeId)),[])|FT]) :- !,
2788 findall(b(identifier(CaseID),CaseType,[]),
2789 (member(case(CaseID,ArgType),Cases), gen_freecase_type(ArgType,FTypeId,CaseType)),
2790 FT, FT2),
2791 %write(generated_freetype_cases(FT)),nl,
2792 generate_free_type_ids(T,FT2).
2793 generate_free_type_ids(T,T).
2794
2795 gen_freecase_type(ArgType,FTypeId,Type) :- nonvar(ArgType), ArgType=constant(_),!, Type = freetype(FTypeId).
2796 gen_freecase_type(ArgType,FTypeId,set(couple(ArgType,freetype(FTypeId)))).
2797
2798 add_unique_variable(Var1,Old/Err_in,New/Err_out) :-
2799 optionally_rewrite_id(Var1,Var),
2800 get_texpr_id(Var,Id),
2801 get_texpr_type(Var,Type),
2802 get_texpr_info(Var,InfosOfNew),!,
2803 ( env_lookup_type(Id,Old,_) ->
2804 % we have a collision of two identifiers
2805 handle_collision(Var,Id,Type,Old,InfosOfNew,New,Err_in,Err_out)
2806 ;
2807 % no collision, just introduce the new identifier
2808 env_store(Id,Type,InfosOfNew,Old,New),
2809 %btypechecker:portray_env(New),nl,
2810 Err_in=Err_out
2811 ).
2812 add_unique_variable(Var,Env/Err,Env/Err) :- print(Var),nl,
2813 ( Var = b(definition(DEFNAME,_),_,INFO) ->
2814 add_error(add_unique_variable,'DEFINITION used in place of Identifier: ',DEFNAME,INFO)
2815 ; Var = b(description(Txt,_),_,INFO) ->
2816 add_error(add_unique_variable,'Unsupported @desc pragma: ',Txt,INFO)
2817 ;
2818 add_error(add_unique_variable,'Expected Identifier, but got: ',Var,Var)
2819 ).
2820
2821 add_infos_to_identifier(NewInfos,In,Out) :-
2822 add_texpr_infos(In,NewInfos,Out).
2823
2824 % get the ID of the variable, prime it if the infos contain "primed"
2825 optionally_rewrite_id(Var,NewVar) :-
2826 get_texpr_info(Var,InfosIn),
2827 ( selectchk(primed,InfosIn,InfosOut) ->
2828 get_texpr_id(Var,Id1),
2829 get_texpr_type(Var,Type),
2830 atom_concat(Id1,'\'',Id),
2831 create_texpr(identifier(Id),Type,InfosOut,NewVar)
2832 ;
2833 Var = NewVar).
2834
2835 :- use_module(translate,[translate_span/2]).
2836 % in case of a collision, we have three options:
2837 % - overwrite the old identifier,
2838 % - ignore the new identifier or
2839 % - generate an error message
2840 handle_collision(Var,Name,Type,OldEnv,InfosOfNew,NewEnv,Ein,Eout) :-
2841 env_lookup_infos(Name,OldEnv,InfosOfExisting),
2842 %btypechecker:portray_env(OldEnv),nl,
2843 ( collision_precedence(Name,InfosOfExisting,InfosOfNew) ->
2844 % this identifier should be ignored
2845 OldEnv = NewEnv,
2846 Ein = Eout
2847 ; collision_precedence(Name,InfosOfNew,InfosOfExisting) ->
2848 % the existing should be overwritten
2849 env_store(Name,Type,InfosOfNew,OldEnv,NewEnv),
2850 Ein = Eout
2851 ;
2852 % generate error and let the environment unchanged
2853 (Name = op(IName) -> Kind='Operation identifier'; Name=IName, Kind='Identifier'),
2854 get_texpr_pos(Var,Pos1),
2855 safe_get_info_pos(InfosOfExisting,Pos2),
2856 ( double_inclusion_allowed(Name,Pos1,Pos2,InfosOfExisting)
2857 -> %print(double_inclusion_of_id_allowed(Name,Type,Pos1,OldEnv,InfosOfExisting)),nl,
2858 OldEnv=NewEnv,
2859 Ein=Eout
2860 ; (better_pos(Pos2,Pos1), \+ better_pos(Pos1,Pos2)
2861 -> Pos = Pos2, translate_span(Pos1,PS1)
2862 ; Pos = Pos1,
2863 PS1='' % Pos1 is already part of error span
2864 ),
2865 translate_inclusion_path(InfosOfExisting,Path2),
2866 get_texpr_info(Var,Info1), translate_inclusion_path(Info1,Path1),
2867 (Pos1=Pos2, Path1=Path2
2868 -> ajoin([Kind,' \'', IName, '\'', PS1, Path1, ' included twice '],Msg)
2869 % This should probably not happen; internal error in machine construction?
2870 ; translate_span(Pos2,PS2),
2871 %ajoin(['Identifier \'', IName, '\' declared twice at (Line:Col[:File]) ', PS1, Path1, ' and ', PS2, Path2],Msg),
2872 ajoin([Kind,' \'', IName, '\'', PS1, Path1, ' already declared at ', PS2, Path2],Msg)
2873 ),
2874 %format(user_error,'*** ~w~n',[Msg]),trace,
2875 Ein = [error(Msg,Pos)|Eout],
2876 OldEnv = NewEnv
2877 )
2878 ).
2879
2880
2881 % example identifier: %b(identifier(aa),integer,[loc(seen,M2,concrete_constants),readonly,usesee(M2,aa,seen),origin([included/M1]),nodeid(pos(18,2,2,11,2,13))])
2882
2883 % try and infer inclusion path of identifier from Infos
2884 translate_inclusion_path(Infos,Str) :- member(loc(How,Machine,Section),Infos),!,
2885 (member(origin(Path),Infos) -> get_origin_path(Path,T) ; T=[')']),
2886 ajoin([' (', How,' from ', Section, ' section of ', Machine |T],Str).
2887 translate_inclusion_path(_,'').
2888
2889 get_origin_path([How/Machine|T],[', ', How,' from ',Machine|TRes]) :- !,
2890 get_origin_path(T,TRes).
2891 get_origin_path(_,[')']).
2892
2893
2894 % SEE ISSUE PROB-403, test 1857
2895 % Correct behaviour related to multiple instantiation is specified in
2896 % B Reference Manual (AtelierB 4.2.1), 8.3 B Project/Instantiating and renaming.
2897 % => Constants and Sets defined in machines instantiated multiple times CAN be used in the including machine with their original (non-prefixed names).
2898 % Note: this code did lead to the constants being added multiple times; this has been fixed in concat_section_contents
2899 double_inclusion_allowed(Name,Pos1,Pos2,InfosOfExisting) :-
2900 %print(check_double_inclusion(Name,Pos1,Pos2,InfosOfExisting)),nl,
2901 Pos1==Pos2,
2902 %print(chk(InfosOfExisting)),nl,
2903 member(loc(LOC,_,Section),InfosOfExisting),
2904 %print(try(LOC,Section)),nl,
2905 section_can_be_included_multiple_times_nonprefixed(Section),
2906 % check that we are in a context of an included machine identifier:
2907 (inclusion_directive(LOC,Name,Pos2)
2908 -> true
2909 ; %LOC is probably local
2910 member(origin([INCL/_MACHINE|_]),InfosOfExisting),
2911 inclusion_directive(INCL,Name,Pos2)
2912 ).
2913
2914 inclusion_directive(included,_,_).
2915 inclusion_directive(used,_,_).
2916 inclusion_directive(seen,_,_). % imports ??
2917 inclusion_directive(abstraction,Name,Pos) :- % probably not allowed by Atelier-B
2918 (debug_mode(off) -> true
2919 ; add_message(bmachine_construction,'Allowing double inclusion from abstraction of: ',Name,Pos)).
2920
2921 section_can_be_included_multiple_times_nonprefixed(abstract_constants).
2922 section_can_be_included_multiple_times_nonprefixed(concrete_constants).
2923 section_can_be_included_multiple_times_nonprefixed(sets).
2924 section_can_be_included_multiple_times_nonprefixed(enumerated_sets).
2925 section_can_be_included_multiple_times_nonprefixed(enumerated_elements).
2926 section_can_be_included_multiple_times_nonprefixed(deferred_sets). % added 2.12.2022
2927 section_can_be_included_multiple_times_nonprefixed(constants). % shortcut
2928
2929
2930 % decide which position info is better: prefer info in main file (highlighting)
2931 :- use_module(bmachine,[b_get_main_filenumber/1]).
2932 better_pos(Pos,_) :- get_position_filenumber(Pos,Filenumber),
2933 b_get_main_filenumber(Filenumber).
2934 better_pos(_,none).
2935
2936 safe_get_info_pos(Info,Pos) :- (get_info_pos(Info,Pos) -> true ; Pos=none).
2937
2938 % collision_precedence/3 decides if the first variable takes
2939 % precedence over the second in case of a collision
2940 % the decision is made by the additional information of both
2941 % variables
2942 collision_precedence(_Name,PreferredVarInfos,DroppedVarInfos) :-
2943 % in case of a re-introduced variable from the abstraction,
2944 % we prefer the concrete variable to the abstract one.
2945 is_abstraction(DroppedVarInfos,PreferredVarInfos),!.
2946 collision_precedence(_Name,PreferredVarInfos,DroppedVarInfos) :-
2947 % We are checking an Event-B model with multi-level support
2948 % and have the same variable in two different refinement levels.
2949 % Then the one in the more refined module takes precedence
2950 member(level(L1),PreferredVarInfos),
2951 member(level(L2),DroppedVarInfos),
2952 % Level 0 is the abstract level, level 1 the first refinement, etc.
2953 L1 > L2,!.
2954 collision_precedence(Name,PreferredVarInfos,DroppedVarInfos) :-
2955 % A local definition takes precedence over a non-local identifier
2956 % TODO:
2957 member(loc(local,_DefMachine,definitions),PreferredVarInfos),
2958 member(loc(_,_VarMachine,Section),DroppedVarInfos),
2959 Section \= definitions,!,
2960 (preferences:get_preference(warn_if_definition_hides_variable,true)
2961 % default is true; we could also check clash_strict_checks
2962 -> get_id_kind(Section,HiddenIdKind),
2963 (get_info_pos(PreferredVarInfos,Pos1), Pos1 \= none,
2964 get_info_pos(DroppedVarInfos,Pos2), Pos2 \= none
2965 -> translate:translate_span(Pos1,Pos1Str), translate:translate_span(Pos2,Pos2Str),
2966 ajoin(['Warning: DEFINITION of ', Name, ' at ', Pos1Str,
2967 ' hides ',HiddenIdKind,' with same name at ', Pos2Str, '.'], Msg)
2968 ; ajoin(['Warning: DEFINITION of ', Name, ' hides ',HiddenIdKind,' with same name.'], Msg),
2969 Pos1 = unknown
2970 ),
2971 store_warning(Msg,Pos1) % TO DO: add position info
2972 ; true
2973 ).
2974 % TO DO: allow identical DEFINITIONS ?
2975
2976 % translate section name into a name for the identifier
2977 get_id_kind(abstract_constants,'constant').
2978 get_id_kind(concrete_constants,'constant').
2979 get_id_kind(parameters,'parameter').
2980 get_id_kind(deferred_sets,'deferred set').
2981 get_id_kind(enumerated_sets,'enumerated set').
2982 get_id_kind(enumerated_elements,'enumerated set element').
2983 get_id_kind(freetypes,'freetype').
2984 get_id_kind(promoted,'operation').
2985 % TODO: complete and use in other places
2986 get_id_kind(_SectionName,'variable').
2987
2988
2989 % is_abstraction/2 tries to find out if (in case of a name clash of
2990 % two variables) the second variable is just the re-introduced abstract
2991 % variable in a refinement.
2992 % InfosAbs is the list of information about the abstract variable
2993 % InfosConc is the list of information about the concrete variable
2994 is_abstraction(InfosAbs,InfosConc) :-
2995 % one variable is an abstract variable, introduced in the abstraction
2996 member(loc(abstraction,_,abstract_variables),InfosAbs),
2997 % the other is either an abstract or concrete variable,
2998 member(VarType,[abstract_variables,concrete_variables]),
2999 % introduced either locally or in an included machine
3000 member(Scope,[local,included]),
3001 member(loc(Scope,_,VarType),InfosConc).
3002 % and the same for constants:
3003 is_abstraction(InfosAbs,InfosConc) :-
3004 % one variable is an abstract variable, introduced in the abstraction
3005 member(loc(abstraction,_,abstract_constants),InfosAbs),
3006 % the other is either an abstract or concrete variable,
3007 member(VarType,[abstract_constants,concrete_constants]),
3008 % introduced either locally or in an included machine
3009 member(Scope,[local,included]),
3010 member(loc(Scope,_,VarType),InfosConc).
3011
3012 % shortcuts for sections, to ease the use of typical combinations of
3013 % sections
3014 shortcut(all_parameters,[parameters,internal_parameters]).
3015 shortcut(sets,[deferred_sets,enumerated_sets,enumerated_elements|T]) :-
3016 (animation_minor_mode(M), (M=z ; M=eventb)
3017 -> T = [freetypes]
3018 ; T = []). % The FREETYPES section in classical B is unfortunately dealt with differently and
3019 % we currently have errors if add the freetypes section here
3020 shortcut(constants,[abstract_constants,concrete_constants]).
3021 shortcut(variables,[abstract_variables,concrete_variables]).
3022 shortcut(operations,[unpromoted,promoted]).
3023 shortcut(identifiers,[all_parameters,sets,constants,variables,operations]).
3024
3025 expand_shortcuts(Sections,Expanded) :-
3026 foldl(expand_shortcut,Sections,Expanded,[]).
3027 expand_shortcut(Section,Sections,RSections) :-
3028 ( shortcut(Section,Expanded) ->
3029 foldl(expand_shortcut,Expanded,Sections,RSections)
3030 ; valid_section(Section) ->
3031 Sections = [Section|RSections]
3032 ;
3033 add_internal_error('invalid section',expand_shortcut(Section,Sections,RSections)),fail).
3034
3035 % find sections that can see given sections
3036 find_relevant_sections(RSecs,MTypes,Result) :-
3037 expand_shortcuts(RSecs,Sections),
3038 findall(R,
3039 ( member(MType,MTypes),
3040 visibility(MType,local,R,SAccess,_),
3041 expand_shortcuts(SAccess,Access),
3042 member(S,Sections),
3043 member(S,Access),
3044 valid_section(R)),
3045 Result1),
3046 sort(Result1,Result).
3047
3048
3049 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3050 % renaming
3051
3052 rename_relevant_sections(DefSecs,Renamings,Machine,New) :-
3053 find_relevant_sections(DefSecs,[machine],Relevant),
3054 rename_in_sections(Relevant,Renamings,Machine,New).
3055 rename_in_sections([],_,M,M).
3056 rename_in_sections([Section|Rest],Renamings,Old,New) :-
3057 select_section_texprs(Section,OTExprs,NTExprs,Old,Inter),
3058 rename_bt_l(OTExprs,Renamings,NTExprs),
3059 rename_in_sections(Rest,Renamings,Inter,New).
3060
3061 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3062 :- use_module(kernel_freetypes,[register_freetypes/1]).
3063 % cleaning up machine
3064 clean_up_machine(In,RefMachines,Out) :-
3065 extract_parameter_types([ref(local,In)|RefMachines],NonGroundExceptions),
3066 clean_up_machine2(NonGroundExceptions,In,Out).
3067 clean_up_machine2(NonGroundExceptions) -->
3068 get_section_content(enumerated_sets,Enum),
3069 get_section_content(enumerated_elements,Elems),
3070 {register_enumerated_sets(Enum,Elems)}, % register name of enumerated sets, e.g., to detect finite in ast_cleanup
3071 get_section_content(freetypes,Freetypes),
3072 {register_freetypes(Freetypes)}, % so that info is available in ast_cleanup for eval_set_extension
3073 clean_up_section(constraints,NonGroundExceptions),
3074 clean_up_section(properties,NonGroundExceptions),
3075 clean_up_section(invariant,NonGroundExceptions),
3076 clean_up_section(initialisation,NonGroundExceptions),
3077 clean_up_section(assertions,NonGroundExceptions),
3078 clean_up_section(operation_bodies,NonGroundExceptions).
3079 :- load_files(library(system), [when(compile_time), imports([environ/2])]).
3080 :- if(environ(prob_safe_mode,true)).
3081 clean_up_section(Section,NonGroundExceptions,In,Out) :-
3082 select_section_texprs(Section,Old,New,In,Out),
3083 %format('Cleaning up and optimizing section ~w~n',[Section]), %maplist(check_ast,Old), % this will raise errors
3084 clean_up_l_with_optimizations(Old,NonGroundExceptions,New,Section),
3085 %format('Checking result of clean_up section ~w~n',[Section]),
3086 maplist(check_ast(true),New),
3087 formatsilent('Finished checking section ~w~n',[Section]).
3088 :- else.
3089 clean_up_section(Section,NonGroundExceptions,In,Out) :-
3090 % debug_stats(cleaning_up(Section)),
3091 select_section_texprs(Section,Old,New,In,Out),
3092 clean_up_l_with_optimizations(Old,NonGroundExceptions,New,Section).
3093 :- endif.
3094
3095 get_section_content(SecName,SectionContent,Mch,Mch) :- get_section(SecName,Mch,SectionContent).
3096
3097 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3098 % type expressions in context of an already type-checked machine
3099 % TO DO: maybe do some performance optimisations for identifiers, values, ... to avoid creating scope, see formula_typecheck2_for_eval optimisation
3100 % b_type_literal does it in bmachine before calling type_in_machine_l
3101 type_in_machine_l(Exprs,Scope,NonGroundExceptions,Machine,Types,TExprs,Errors) :-
3102 MType = machine,
3103 create_scope_if_necessary(Exprs,Scope,MType,Machine,Env,Errors,E1), % this can be expensive for big B machines
3104 %runtime_profiler:profile_single_call(create_scope,unknown,
3105 % bmachine_construction:create_scope(Scope,MType,Machine,Env,Errors,E1)),
3106 btype_ground_dl(Exprs,Env,NonGroundExceptions,Types,TExprUncleans,E1,[]),
3107 perform_post_static_check(TExprUncleans),
3108 ? maplist(clean_up_pred_or_expr(NonGroundExceptions),TExprUncleans,TExprs).
3109
3110 % detect a few common expressions which do not require creating a scope of all the identifiers
3111 create_scope_if_necessary([E],_Scope,MType,Machine,Env,Ein,Eout) :- raw_expr_wo_ids(E),!,
3112 create_scope([],MType,Machine,Env,Ein,Eout).
3113 create_scope_if_necessary(_Exprs,Scope,MType,Machine,Env,Ein,Eout) :-
3114 create_scope(Scope,MType,Machine,Env,Ein,Eout).
3115
3116 % a few common raw ASTs which do not refer to identifiers
3117 raw_expr_wo_ids(falsity(_)).
3118 raw_expr_wo_ids(truth(_)).
3119 raw_expr_wo_ids(empty_set(_)).
3120 raw_expr_wo_ids(equal(_,A,B)) :- raw_expr_wo_ids(A), raw_expr_wo_ids(B).
3121 raw_expr_wo_ids(not_equal(_,A,B)) :- raw_expr_wo_ids(A), raw_expr_wo_ids(B).
3122 raw_expr_wo_ids(interval(_,A,B)) :- raw_expr_wo_ids(A), raw_expr_wo_ids(B).
3123 raw_expr_wo_ids(add(_,A,B)) :- raw_expr_wo_ids(A), raw_expr_wo_ids(B).
3124 raw_expr_wo_ids(minus_or_set_subtract(_,A,B)) :- raw_expr_wo_ids(A), raw_expr_wo_ids(B).
3125 raw_expr_wo_ids(mult_or_cart(_,A,B)) :- raw_expr_wo_ids(A), raw_expr_wo_ids(B).
3126 raw_expr_wo_ids(unary_minus(_,A)) :- raw_expr_wo_ids(A).
3127 raw_expr_wo_ids(boolean_true(_)).
3128 raw_expr_wo_ids(boolean_false(_)).
3129 raw_expr_wo_ids(bool_set(_)).
3130 raw_expr_wo_ids(integer(_,_)).
3131 raw_expr_wo_ids(real(_,_)).
3132 raw_expr_wo_ids(string(_,_)).
3133
3134
3135 % note prob_ids(visible), external_library(all_available_libraries) scope is expanded somewhere else
3136 create_scope(pre_expanded_scope(PEnv,Errors),_MType,_Machine,Env,Ein,Eout) :-
3137 !, % already pre-expanded
3138 Env=PEnv, append(Errors,Eout, Ein).
3139 create_scope(Scope,MType,Machine,Env,Ein,Eout) :-
3140 env_empty(Init),
3141 add_theory_operators(Machine,Init,WithOperators),
3142 foldl(create_scope2(MType,Machine),Scope,WithOperators/Ein,Env/Eout).
3143 add_theory_operators(Machine,Ein,Eout) :-
3144 get_section(operators,Machine,Operators),
3145 keys_and_values(Operators,Ids,Ops),
3146 foldl(env_store_operator,Ids,Ops,Ein,Eout).
3147 create_scope2(MType,Machine,Scope,In/Ein,Out/Eout) :-
3148 ( Scope = constants ->
3149 visible_env(MType,properties,[ref(local,Machine)],In,Out,Ein,Eout)
3150 ; Scope = variables ->
3151 visible_env(MType,invariant,[ref(local,Machine)],In,Out,Ein,Eout)
3152 ; Scope = variables_and_additional_defs ->
3153 visible_env(MType,invariant,[extended_local_ref(Machine)],In,Out,Ein,Eout)
3154 ; Scope = assertions_scope_and_additional_defs ->
3155 visible_env(MType,assertions,[extended_local_ref(Machine)],In,Out,Ein,Eout)
3156 ; Scope = prepost ->
3157 visible_env(MType,prepost,[ref(local,Machine)],In,Out,Ein,Eout)
3158 ; Scope = operation_bodies ->
3159 visible_env(MType,operation_bodies,[ref(local,Machine)],In,Out,Ein,Eout)
3160 ; Scope = operation(Op) ->
3161 create_operation_scope(Op,Machine,In,Out), Ein=Eout
3162 ; Scope = env(ExplicitEnv) ->
3163 ExplicitEnv = Out, Ein=Eout
3164 ; Scope = identifier(Ids) ->
3165 store_variables(Ids,In,Out), Ein=Eout
3166 ; Scope = external_library(LibName) % be sure to make these last to avoid duplication errors
3167 -> store_ext_defs(LibName,In,Out), Ein=Eout
3168 ;
3169 add_error(bmachine_construction, 'invalid scope', Scope),fail).
3170 create_operation_scope(Op,Machine,In,Out) :-
3171 get_section(operation_bodies,Machine,OpBodies),
3172 get_texpr_id(OpId,op(Op)),
3173 get_texpr_expr(TOp,operation(OpId,Results,Params,_)),
3174 ( member(TOp,OpBodies) ->
3175 append(Results,Params,LocalVariables),
3176 store_variables(LocalVariables,In,Out)
3177 ;
3178 ajoin(['operation \'',Op,'\' not found for building scope'], Msg),
3179 add_error(bmachine_construction,Msg),fail).
3180 store_variables(Ids,In,Out) :- foldl(store_variable,Ids,In,Out).
3181 store_variable(Id,In,Out) :-
3182 get_texpr_id(Id,Name),get_texpr_type(Id,Type),
3183 env_store(Name,Type,[],In,Out).
3184
3185 type_open_predicate_with_quantifier(OptionalOuterQuantifier,Predicate,Scope,Machine,TResult,Errors) :-
3186 type_open_formula(Predicate,Scope,false,Machine,pred,Identifiers,TPred,Errors),
3187 ( Identifiers = [] ->
3188 TResult = TPred
3189 ; OptionalOuterQuantifier=forall ->
3190 create_forall(Identifiers,TPred,TResult)
3191 ; OptionalOuterQuantifier=no_quantifier ->
3192 TResult = TPred
3193 ; % OptionalOuterQuantifier=exists
3194 %perform_do_not_enumerate_analysis(Identifiers,TPred,'EXISTS',Span,TPred2), % now done by apply_kodkod_or_other_optimisations
3195 create_exists(Identifiers,TPred,TResult)
3196 ).
3197
3198 type_open_formula(Raw,Scope,AllowOpenIdsinExpressions,Machine,Type,Identifiers,Result,Errors) :-
3199 create_scope_if_necessary([Raw],Scope,machine,Machine,Env1,Errors,E1),
3200 ( Identifiers==[] -> Mode=closed, Env1=Env
3201 ; Mode=open, openenv(Env1,Env)),
3202 btype_ground_dl([Raw],Env,[],[Type],[TExprUnclean],E1,E2),
3203 ( Mode=closed -> true
3204 ;
3205 openenv_identifiers(Env,Identifiers), % TODO: treat theory operators ?
3206 check_ground_types_dl(Identifiers,[],E2,E3)
3207 ),
3208 %print(type_open_formula(Identifiers,TExprUnclean)),nl,
3209 mark_outer_quantifier_ids(TExprUnclean,TExprUnclean2),
3210 perform_post_static_check([TExprUnclean2]),
3211 clean_up_pred_or_expr([],TExprUnclean2,TResult), % TODO: only run if requested
3212 ( Identifiers = [] -> % no newly introduced identifiers, no problem
3213 E3 = []
3214 ; Type = pred -> % newly introduced identifiers in a predicate - ok
3215 E3 = []
3216 ; AllowOpenIdsinExpressions=true -> % we explicitly allow open ids in expressions
3217 E3 = []
3218 ; % newly introduced identifiers in expression make no sense
3219 % (is that so?)
3220 foldl(add_unknown_identifier_error,Identifiers,E3,[])
3221 ),
3222 Result = TResult.
3223 add_unknown_identifier_error(TId,[error(Msg,Pos)|E],E) :-
3224 get_texpr_id(TId,Id),
3225 ajoin(['Unknown identifier ',Id,'.'],Msg),
3226 % TO DO: generate fuzzy match and possible completions message
3227 get_texpr_pos(TId,Pos).
3228
3229 % mark outermost identfiers so that they don't get optimized away
3230 % e.g., ensure that we print the solution for something like #(y2,x2).(x2 : 0..10 & y2 : 0..10 & x2 = 10 & y2 = 10)
3231 mark_outer_quantifier_ids(b(exists(IDS,Pred),pred,Info),Res) :-
3232 maplist(mark_id,IDS,MIDS),!,
3233 Res = b(exists(MIDS,Pred),pred,Info).
3234 mark_outer_quantifier_ids(b(let_predicate(IDS,Exprs,Pred),pred,Info),Res) :-
3235 maplist(mark_id,IDS,MIDS),!,
3236 Res = b(let_predicate(MIDS,Exprs,Pred),pred,Info).
3237 mark_outer_quantifier_ids(b(forall(IDS,LHS,RHS),pred,Info),Res) :-
3238 maplist(mark_id,IDS,MIDS),!,
3239 Res = b(forall(MIDS,LHS,RHS),pred,Info).
3240 mark_outer_quantifier_ids(X,X).
3241
3242 mark_id(b(identifier(ID),TYPE,INFO),b(identifier(ID),TYPE,[do_not_optimize_away|INFO])).
3243
3244 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3245
3246 % some additional static checks; they should be run only once before ast_cleanup runs
3247 % TO DO: move maybe some of the exists/forall checks here; would be simpler and not require removed_typing inspection
3248
3249 :- use_module(bsyntaxtree,[map_over_typed_bexpr/2]).
3250 perform_post_static_check([Typed|_]) :- %print(t(Typed)),nl,
3251 preferences:get_preference(disprover_mode,false),
3252 map_over_typed_bexpr(post_static_check,Typed),
3253 fail.
3254 perform_post_static_check([_|T]) :- !, perform_post_static_check(T).
3255 perform_post_static_check(_).
3256
3257 post_static_check(b(E,T,I)) :-
3258 %bsyntaxtree:check_infos(I,post_static_check),
3259 post_static_check_aux(E,T,I).
3260
3261 :- use_module(bsyntaxtree,[find_identifier_uses/3, is_a_disjunct_or_implication/4]).
3262 :- use_module(library(ordsets),[ord_subtract/3]).
3263 % should detect patterns like { zz | # r__1, q__1, zz . ( ...)}
3264 % {x,z|z=1}[{TRUE}] = {1}
3265 % %x.(1=1|1)(TRUE) = 1
3266 post_static_check_aux(lambda(Ids,Body,Expr),_T,Info) :-
3267 get_texpr_ids(Ids,AtomicIds), sort(AtomicIds,SortedIds),
3268 find_identifier_uses(Body,[],UsedIds1),
3269 find_identifier_uses(Expr,[],UsedIds2), % relevant for tests 1106, 1264, 1372, 1622 to also look at Expr
3270 ord_subtract(SortedIds,UsedIds1,S2),
3271 ord_subtract(S2,UsedIds2,UnusedIds), UnusedIds \= [],
3272 add_warning_with_info('Condition of lambda does not use these identifiers: ',UnusedIds,Body,Info).
3273 post_static_check_aux(comprehension_set(Ids,Body),_T,Info) :-
3274 get_texpr_ids(Ids,AtomicIds), sort(AtomicIds,SortedIds),
3275 find_identifier_uses(Body,[],UsedIds),
3276 ord_subtract(SortedIds,UsedIds,UnusedIds), UnusedIds \= [],
3277 add_warning_with_info('Body of comprehension set does not use these identifiers: ',UnusedIds,Body,Info).
3278 post_static_check_aux(exists(Ids,P),_T,Info) :-
3279 is_a_disjunct_or_implication(P,Type,_Q,_R),
3280 exists_body_warning(Ids,P,Info,Type).
3281
3282 % see also check_implication_inside_exists ast cleanup rule
3283 exists_body_warning(_,_,_,_) :- animation_minor_mode(X),(X=eventb ; X=tla),!.
3284 exists_body_warning(Ids,P,I,Type) :-
3285 ajoin(['Body of existential quantifier is a(n) ',Type,
3286 ' (not allowed by Atelier-B): '],Msg),
3287 add_warning_with_info(Msg,b(exists(Ids,P),pred,I),P,I).
3288
3289
3290
3291 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3292 % Warnings
3293
3294 :- use_module(bsyntaxtree,[contains_info_pos/1]).
3295 add_warning_with_info(Msg1,Msg2,P,Info) :-
3296 (contains_info_pos(Info) -> Pos=Info ; Pos=P),
3297 add_warning(bmachine_construction,Msg1,Msg2,Pos).
3298
3299 :- dynamic warnings/2.
3300 clear_warnings :-
3301 retractall( warnings(_,_) ).
3302 show_warnings :-
3303 warnings(Warning,Span),
3304 add_warning(bmachine_construction, Warning,'',Span),
3305 fail.
3306 show_warnings.
3307
3308
3309 store_warning(Warning,Span) :-
3310 (warnings(Warning,Span) -> true ; assertz(warnings(Warning,Span))).