1 % (c) 2009-2024 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 % bmachine provides access to the currently loaded B-machine and all its subsidiary machines
6
7 :- module(bmachine,[bmachine_is_precompiled/0,
8 b_enumerated_sets_precompiled/0,
9 b_set_initial_machine/0,
10 b_set_empty_machine/0,
11 b_set_machine/3,
12 b_set_typed_machine/2,
13 b_load_eventb_project/1, % used for loading .eventb files
14 b_set_eventb_project_flat/3, % set an Event-B project from terms
15
16 get_full_b_machine/2,
17 full_b_machine/1,
18 get_full_b_machine_sha_hash/1, % get SHA hash of loaded and type-checked B machine
19 b_machine_is_loaded/0,
20
21 get_proven_invariant/2,
22 get_unproven_invariants/1,
23 get_invariant_list_with_proof_info/1,
24 load_additional_information/1,
25 %% generate_specialized_invariants/0, %% no longer exists
26 get_operation_info/2,
27 b_get_operation_description/2,
28 get_operation_description_template_expr/2,
29
30 b_load_machine_from_file/1, b_load_machine_from_file/2,
31 b_load_machine_probfile/1, b_load_machine_probfile/2,
32 b_load_machine_from_list_of_facts/2,
33 b_load_machine_from_term/2, % used for Alloy
34 b_machine_precompile/0, other_spec_precompile/0,
35 b_machine_reset/0,
36
37 b_machine_name/1,
38
39 b_get_all_used_filenames/1, b_get_main_filename/1,
40 add_additional_filename/2,
41 set_additional_filename_as_parsing_default/3, reset_filename_parsing_default/2,
42 b_get_main_filenumber/1, b_filenumber/4, portray_filenumbers/0,
43 get_machine_file_number/4,
44 b_absolute_file_name_relative_to_main_machine/2,
45 b_get_animated_sections/1,
46
47 b_get_machine_set/1, b_get_machine_set/2,
48 b_get_named_machine_set/2, b_get_named_machine_set/3,
49 b_get_disjoint_constants_of_type/3, b_get_constant_represented_inside_global_set/2,
50 b_get_machine_constants/1, b_get_machine_all_constants/1,
51 b_machine_has_constants/0, b_machine_has_constants_or_properties/0,
52 b_is_constant/2, b_is_constant/1, b_is_unused_constant/1,
53 get_constant_span/2,
54 b_machine_has_variables/0,
55 b_is_variable/1, b_is_variable/2,
56 b_get_constant_variable_description/2,
57 constant_variable_marked_as_memo/1, constant_variable_marked_as_expand/1,
58 b_get_machine_variables_in_original_order/1, b_get_machine_variables/1,
59 get_primed_machine_variables/1,
60 get_nr_of_machine_variables/1, get_nr_of_machine_constants/1,
61 b_get_all_used_identifiers/1, % Note: may contain var$0 instead of var for becomes_such
62 b_get_all_used_identifiers_in_section/2, % ditto
63 get_machine_identifiers/2, get_machine_identifiers_with_pp_type/2,
64 source_code_for_identifier/6,
65
66 b_get_properties_from_machine/1,
67 b_get_invariant_from_machine/1,
68 b_get_linking_invariant_from_machine/1,
69 b_machine_has_assertions/0,
70 b_get_static_assertions_from_machine/1, b_machine_has_static_assertions/0,
71 b_get_unproven_static_assertions_from_machine/1,
72 b_get_dynamic_assertions_from_machine/1, b_machine_has_dynamic_assertions/0,
73 b_get_unproven_dynamic_assertions_from_machine/1,
74 b_get_assertions_from_main_machine/2, b_main_machine_has_no_assertions/0,
75 b_machine_has_unproven_assertions/0, get_assertions_from_machine/2,
76 get_all_assertions_from_machine/1,
77 b_machine_has_proven_invariants/0,
78 b_get_assertions/3,
79 b_get_assertion_count/3,
80 is_discharged_assertion/1,
81
82 b_get_initialisation_from_machine/2,
83 b_machine_has_operations/0,
84 b_get_machine_operation/4, b_get_machine_operation/6,
85 b_get_machine_operation_for_animation/4, % does some rewriting for ANY parameters
86 b_get_machine_operation_for_animation/6, % does some rewriting for ANY parameters for TopLevel=true
87 b_get_machine_operation_for_animation/7, % additional Pos parameter
88 b_get_promoted_machine_operations/1,
89 b_top_level_operation/1, b_top_level_feasible_operation/1,
90 b_is_initialisation_name/1,
91 b_is_operation_name/1, b_get_operation_pos/2,
92 b_get_machine_operation_parameter_types/2,
93 b_get_machine_operation_parameter_names/2,
94 b_get_machine_operation_parameter_names_for_animation/2,
95 b_get_machine_operation_result_names/2,
96 b_get_machine_operation_typed_parameters/2,
97 b_get_machine_operation_typed_parameters_for_animation/2,
98 b_get_machine_operation_typed_results/2,
99 b_get_machine_operation_signature/2,
100 b_machine_operation_names_in_reverse_order/1,
101 b_get_operation_variant/3,
102
103 b_get_machine_setscope/2,
104 b_get_machine_operation_max/2,
105 b_get_machine_goal/1,
106 b_set_machine_goal/1, b_set_machine_goal/2,
107 b_set_machine_searchscope/1, b_set_machine_searchscope/2,
108 b_set_parsed_typed_machine_goal/1, b_unset_machine_goal/0,
109 b_reset_machine_goal_from_DEFINITIONS/0,
110 b_parse_machine_expression_from_codes/2,
111 b_parse_machine_expression_from_codes_with_prob_ids/2,
112 b_parse_machine_expression_from_codes_with_prob_ids/3,
113 b_parse_machine_expression_from_codes_with_prob_ids/4,
114 b_parse_machine_expression_from_codes/5,
115 b_parse_machine_expression_from_codes/6,
116 b_parse_machine_subsitutions_from_codes/6,
117 b_parse_machine_formula/3, b_parse_machine_formula_from_codes/7,
118 b_parse_machine_predicate/2, b_parse_machine_predicate/3,
119 b_parse_optional_machine_predicate/2,
120 b_parse_machine_predicate_from_codes/3,
121 b_parse_machine_predicate_from_codes_open/5,
122 b_parse_machine_operation_pre_post_predicate/3, b_parse_machine_operation_pre_post_predicate/5,
123 get_machine_operation_additional_identifiers/2,
124
125 determine_type_of_formula/2, determine_type_of_formula/3,
126
127 parse_expression_raw_or_atom_with_prob_ids/2,
128
129 % a version where parsing and type checking are separate:
130 b_parse_wo_type_machine_predicate_from_codes_to_raw_expr/2,
131 b_type_check_raw_expr/4,
132
133 b_get_machine_searchscope/1,
134 b_get_machine_animation_function/2,
135 b_get_machine_heuristic_function/1,
136 b_get_machine_animation_expression/2,
137 b_get_machine_custom_edges_function/2,
138 b_get_machine_custom_nodes_function/2,
139 b_get_machine_custom_graph_function/2,
140 b_machine_temp_predicate/1,
141 %set_temp_predicate/2,
142 assert_temp_typed_predicate/1,
143 reset_temp_predicate/0,
144 add_additional_property/2, b_machine_additional_property/1,
145
146 get_animation_image/2, get_animation_image_source_file/2,
147 b_get_definition/5, b_get_definition_with_pos/6,
148 b_get_definition_string_from_machine/2, b_get_definition_string_from_machine/3,
149 b_definition_prefixed/5, b_sorted_b_definition_prefixed/4,
150 % get typed definitions without parameters:
151 b_get_typed_definition/3, b_get_typed_definition_with_error_list/5,
152 b_get_typed_predicate_definition/3,
153 b_get_typed_expression_definition/3, b_get_true_expression_definition/1,
154
155 b_nth1_invariant/3, % get nth invariant with used Ids
156 b_invariant_number_list/1,
157 b_specialized_invariant_for_op/2,
158 b_specialized_invariant_mask_for_op/2,
159 b_operation_preserves_full_invariant/1, b_operation_preserves_invariant/2,
160 tcltk_get_specialized_invariant_for_op/2, tcltk_get_specialized_invariants_for_ops/1,
161 b_get_operation_normalized_read_write_info/3, % used to be b_normalized_rwsets_for_op/3,
162 b_get_operation_unchanged_variables/2,
163 b_operation_cannot_modify_state/1,
164 b_operation_reads_output_variables/3,
165 b_get_operation_non_det_modifies/2,
166
167 b_extract_values_clause_assignment/3,
168
169 b_type_expression/5,b_type_expression_for_full_b_machine/6,
170 b_type_open_predicate/5,b_type_open_predicate_with_errors/4,
171 b_type_open_exists_predicate/3,
172 type_with_errors/4,
173
174 b_show_machine_representation_unicode/4, b_show_machine_representation/4,
175 b_get_internal_prolog_representation_as_codes/1,
176 b_write_machine_representation_to_file/2,
177 b_write_machine_representation_to_file/3,
178 b_write_eventb_machine_to_classicalb_to_file/1,
179 b_show_eventb_as_classicalb/2,
180
181 b_get_machine_refinement_hierarchy/1,
182 b_get_refined_machine/1, b_get_refined_machine_name/1, b_get_refined_ancestors_names/1,
183 b_get_machine_header_position/2,
184 b_get_model_type/1,
185 b_machine_statistics/2,
186
187 % More Proof Information:
188 discharged_guard_strengthening/4,
189
190 % Flow information
191 wp_untyped/3, clear_wp/0,
192 nonchanging_guard/2,
193 typecheck_predicates/4
194 ]).
195
196 :- use_module(library(lists)).
197 :- use_module(library(ordsets)).
198
199 :- use_module(self_check).
200 :- use_module(error_manager).
201 :- use_module(debug).
202 :- use_module(bmachine_construction,[check_machine/4,type_in_machine_l/6,type_open_predicate_with_quantifier/6]).
203 :- use_module(bsyntaxtree).
204 :- use_module(bmachine_structure,[get_section/3,write_section/4,get_section_texprs/3]).
205 :- use_module(parsercall).
206 :- use_module(tools).
207 :- use_module(translate,[translate_machine/3,translate_eventb_to_classicalb/3]).
208 :- use_module(bmachine_eventb,[check_event_b_project/4,is_eventb_additional_info/1]).
209 :- use_module(kernel_freetypes,[register_freetypes/1]).
210 :- use_module(b_machine_hierarchy).
211 :- use_module(kodkodsrc(kodkod), [replace_by_kodkod/3]).
212
213 :- use_module(b_global_sets,[find_inequal_global_set_identifiers/4,
214 b_get_prob_deferred_set_elements/2,
215 b_check_and_precompile_enumerated_sets/0,
216 b_check_and_precompile_deferred_sets/0,
217 b_check_and_precompile_global_set_symmetry/0]).
218
219 % for applying transformations on the machines
220 :- use_module(record_detection,[replace_sets_by_records/2]).
221 :- use_module(partition_detection,[detect_partitions/2]).
222
223 :- use_module(module_information,[module_info/2]).
224 :- module_info(group,ast).
225 :- module_info(description,'This module provides access to the various parts of the loaded B machine.').
226
227 :- set_prolog_flag(double_quotes, codes).
228
229 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
230 % bmachine: module for storing the currently loaded machine
231 % Contains predicates for getting (already typed) information about
232 % different parts of the machine
233 % many predicates are precompiled by b_precompile_machine/0, see below for
234 % details.
235
236 :- volatile bmachine_is_precompiled/0.
237 :- dynamic bmachine_is_precompiled/0. /* TRUE if the precompiled predicates have been set */
238
239 assert_bmachine_is_precompiled :-
240 (bmachine_is_precompiled -> true ; assertz(bmachine_is_precompiled), debug_println(4,bmachine_is_precompiled)).
241
242 :- volatile machine/2.
243 :- dynamic machine/2.
244 % there is only one main machine fact
245
246 % true if a machine is loaded
247 b_machine_is_loaded :- (machine(_,_) -> true).
248
249 get_full_b_machine(Name,Res) :-
250 (machine(Name,M) -> Res=M
251 ; ground(Name) -> add_error(bmachine,'No B machine with this name loaded:',Name), fail
252 ; add_error(bmachine,'No B machine loaded'), fail
253 ).
254
255 full_b_machine(machine(Name,M)) :- get_full_b_machine(Name,M).
256
257 :- use_module(extension('probhash/probhash'),[raw_sha_hash/2]).
258 get_full_b_machine_sha_hash(Hash) :- full_b_machine(FM), raw_sha_hash(FM,Hash).
259
260 b_set_machine(Main,Machines,Errors) :-
261 b_machine_reset,
262 ? check_machine(Main,Machines,M1,Errors1),!,
263 apply_machine_transformations(M1,ResultMachine),
264 ( no_real_perror_occurred(Errors1) ->
265 %% get_memory_used(M1), %%
266 assert_main_machine(ResultMachine)
267 %%, get_memory_used(M2),print_memory_used(M2), print_memory_used_difference(M1,M2),nl %%
268 ;
269 true),
270 Errors=Errors1.
271
272 assert_main_machine(X) :- %tools_printing:trace_print(X),nl,
273 nonvar(X), X=machine(A,B),
274 !,
275 assertz(machine(A,B)). %, print(machine_asserted),nl.
276 assert_main_machine(X) :- add_internal_error('Illegal format: ',assert_main_machine(X)),fail.
277
278 :- meta_predicate apply_transformation_step(*,2,*,*).
279 % apply some transformations on the machine that require global information
280 % (other local transformations can be found in ast_cleanup)
281 apply_machine_transformations -->
282 apply_transformation_step('record definition detection', replace_sets_by_records),
283 apply_transformation_step('partition detection', detect_partitions). % is this necessary?? done in ast_cleanup
284
285 apply_transformation_step(Name,Pred,In,Out) :-
286 ( call(Pred, In, Out) -> true
287 ;
288 ajoin(['applying ', Name, ' failed, skipping.'], Msg),
289 add_error(bmachine,Msg),
290 In=Out).
291
292 % try to translate (parts of) the properties to Kodkod
293 % if it succeeds, replace the translated predicates by
294 % calls to the Kodkod process
295 try_kodkod :-
296 get_preference(use_solver_on_load,kodkod),
297 b_get_machine_constants(Constants),
298 Constants = [_|_],!,
299 b_get_properties_from_machine(OldPredicate),
300 ( replace_by_kodkod(Constants,OldPredicate,NewPredicate) ->
301 retract(machine(N,OldMachine)),
302 retractall( b_get_properties_from_machine(_) ),
303 write_section(properties,NewPredicate,machine(N,OldMachine),NewMachine),
304 assertz( NewMachine ),
305 assertz( b_get_properties_from_machine(NewPredicate) )
306 ;
307 true).
308 try_kodkod.
309
310 :- use_module(bmachine_static_checks, [static_check_main_machine/1]).
311 % set a machine term as current machine, without calling type checking
312 % (used for Z translations)
313 b_set_typed_machine(M1,FromFile) :-
314 b_machine_clear,
315 static_check_main_machine(M1), % done by check_machine in b_set_machine above
316 apply_machine_transformations(M1,ResultMachine),
317 assert_main_machine(ResultMachine),
318 set_all_used_filenames([FromFile]).
319
320 b_set_eventb_project_flat(Models,Contextes,Proofs) :-
321 b_machine_clear,
322 set_animation_mode(b), set_animation_minor_mode(eventb),
323 analyse_eventb_hierarchy(Models,Contextes),
324 ( check_event_b_project(Models,Contextes,Proofs,M1) ->
325 apply_machine_transformations(M1,ResultMachine),
326 assert_main_machine(ResultMachine) % has the form machine/2
327 ;
328 % Note: if there are typecheck errors due to missing .ptm files for axiomatic operators it is not an internal error!
329 fail).
330
331 b_load_eventb_project(Filename) :-
332 read_eventb_project_from_file(Filename,Machines,Contexts,Proofs,Errors,Prefs),
333 (Errors=[] -> true ; add_error(b_load_eventb_project,'Errors in Event-B Package: ',Errors)),
334 set_stored_prefs(Prefs),
335 set_all_used_filenames([Filename]),
336 b_set_eventb_project_flat(Machines,Contexts,Proofs),
337 clear_wp,
338 (load_additional_information(Proofs) -> true ; add_error(b_load_eventb_project,'Failed to load proof information',Proofs)).
339 % generate_specialized_invariants.
340
341 read_eventb_project_from_file(Filename, Machines, Contexts, Proofs, Errors, Prefs) :-
342 open(Filename, read, Stream, [encoding(utf8)]),
343 call_cleanup(read_eventb_project_from_stream(Stream, Filename, LoadCommand, Prefs), close(Stream)),
344 (eventb_load_command(LoadCommand, Machines, Contexts, Proofs, Errors)
345 -> true
346 ; add_error_and_fail(b_load_eventb_project, 'This is not a valid EventB Project file:', Filename)
347 ).
348
349 read_eventb_project_from_stream(Stream, Filename, LC, Prefs) :-
350 safe_read(Stream, Filename, Term),
351 (Term == end_of_file
352 -> Prefs = []
353 ; process_eventb_project_term(Term, LC, Prefs, PrefsTail),
354 read_eventb_project_from_stream(Stream, Filename, LC, PrefsTail)
355 ).
356
357 safe_read(Stream,Filename,T) :-
358 catch(read(Stream,T), E, (
359 ajoin(['.eventb file "', Filename, '" is corrupted; exception occurred while reading:'],Msg),
360 add_error(safe_read,Msg,E),
361 T=end_of_file
362 )).
363
364 process_eventb_project_term(Term, _LC, Prefs, Prefs) :-
365 %tools_printing:nested_write_term_to_codes(Term,Cs), format('~s~n',[Cs]),
366 var(Term),
367 !,
368 add_warning(b_load_eventb_project, 'Bare variable term in Event-B project: ', Term).
369 process_eventb_project_term(package(LoadCommand), LC, Prefs, Prefs) :-
370 !,
371 (nonvar(LC)
372 -> add_error_and_fail(b_load_eventb_project, 'Duplicate package/1 term in Event-B project: ', package(LoadCommand))
373 ; LC = LoadCommand
374 ).
375 process_eventb_project_term(stored_preference(Pref,Val), _LC, [stored_preference(Pref,Val)|Prefs], Prefs) :- !.
376 process_eventb_project_term(emf_model(_Name,_Base64Xml), _LC, Prefs, Prefs) :- !. % not used
377 process_eventb_project_term(Term, _LC, Prefs, Prefs) :-
378 functor(Term, F, N),
379 add_warning(b_load_eventb_project, 'Unrecognized term in Event-B project: ', F/N).
380
381 eventb_load_command(LoadCommand, _, _, _, _) :- var(LoadCommand), !, fail.
382 eventb_load_command(load_event_b_project(Machines,Contexts,Proofs,Errors), Machines, Contexts, Proofs, Errors).
383 eventb_load_command(load_event_b_project(Machines,Contexts,Errors), Machines, Contexts, [], Errors) :-
384 print('% Deprecated EventB Project without Proof Info.'), nl.
385
386 set_stored_prefs([stored_preference(Pref,Val)|Prefs]) :-
387 printsilent(stored_preference(Pref,Val)), nls,
388 preferences:set_preference(Pref,Val),
389 set_stored_prefs(Prefs).
390 set_stored_prefs([]).
391
392 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
393 % Collect Proof Information from Event B
394
395 :- volatile discharged/3.
396 :- volatile discharged_theorem/3, wd_po/3, wp_untyped/3.
397 :- volatile nonchanging_guard/2, discharged_guard_strengthening/4.
398 :- dynamic discharged/3.
399 % discharged(Model,Event,Name) : invariant Name in model Model is preserved by Event (no matter which Event at which refinement level)
400 :- dynamic discharged_theorem/3.
401 :- dynamic wd_po/3.
402 :- dynamic wp_untyped/3.
403 :- dynamic nonchanging_guard/2.
404 :- dynamic discharged_guard_strengthening/4.
405
406 :- volatile b_specialized_invariant_for_op/2, b_operation_preserves_invariant/2.
407 :- dynamic b_specialized_invariant_for_op/2, b_operation_preserves_invariant/2.
408 :- volatile b_nth1_invariant/3, b_invariant_number_list/1,
409 b_specialized_invariant_mask_for_op/2, get_proven_invariant/2.
410 :- dynamic b_nth1_invariant/3, b_invariant_number_list/1, b_specialized_invariant_mask_for_op/2, get_proven_invariant/2.
411 :- volatile complete_discharged_info/0.
412 :- dynamic complete_discharged_info/0.
413
414
415 clear_wp :-
416 retractall( wp_untyped(_,_,_) ).
417 %retractall( wp_typed(_,_,_) ). only in flow.pl
418
419 load_additional_information([]) :- !.
420 load_additional_information([H|T]) :-
421 ? load_additional_information_fact(H),!,
422 load_additional_information(T).
423 load_additional_information([H|T]) :- !,
424 add_internal_error('Unknown additional info: ',load_additional_information_fact(H)),
425 load_additional_information(T).
426 load_additional_information(I) :- !,
427 add_internal_error('Additional info not a list: ',load_additional_information_fact(I)).
428
429 % old style proof info
430 load_additional_information_fact(discharged(Machine,Theorem)) :- % a discharged theorem
431 debug_println(9,discharged_theorem(Machine,old_style_proof_info,Theorem)),
432 assertz(discharged_theorem(Machine,invariant,Theorem)).
433 load_additional_information_fact(discharged(Machine,Event,Invariant)) :-
434 debug_println(9,discharged(Machine,Event,Invariant)),
435 assertz(discharged(Machine,Event,Invariant)).
436 load_additional_information_fact(Term) :- % theories are handled in bmachine_eventb.pl already
437 is_eventb_additional_info(Term).
438
439 % new style proof info po(Machine,Info,SourceList,Discharged)
440
441 load_additional_information_fact(po(Machine,'Invariant preservation',Source,true)) :- % invariant preservation
442 add_discharged_po_infos(Source,Machine).
443
444 load_additional_information_fact(po(Machine,'Invariant establishment',Source,true)) :- % invariant establishment
445 add_discharged_po_infos(Source,Machine).
446
447 load_additional_information_fact(po(Machine,Text,Source,Proven)) :- % invariant or theorem wd
448 ( Text = 'Well-definedness of Invariant'
449 ; Text = 'Well-definedness of Theorem'),
450 member(invariant(Invariant),Source),
451 debug_println(9,wd_po(Machine,Invariant,Proven)),
452 assertz(wd_po(Machine,Invariant,Proven)).
453 load_additional_information_fact(po(Machine,Text,Source,Proven)) :- % axiom or axiom theorem wd
454 ( Text = 'Well-definedness of Axiom'
455 ; Text = 'Well-definedness of Theorem'),
456 member(axiom(Axiom),Source),
457 debug_println(9,wd_axiom(Machine,Axiom,Proven)). % TO DO: assert and use
458 load_additional_information_fact(po(Machine,Text,Source,Proven)) :- % proven theorem as guard
459 Text = 'Well-definedness of Theorem',
460 member(guard(Grd),Source),
461 member(event(Evt),Source),
462 debug_println(9,wd_axiom(Machine,Evt/Grd,Proven)). % TO DO: assert and use
463 load_additional_information_fact(po(Machine,Text,Source,Proven)) :- % wd of action
464 Text = 'Well-definedness of action',
465 (member(action(ACT),Source) % probably the guard in the last event with discharged info ??
466 -> debug_println(9,wd_action(Machine,ACT,Proven)) % TO DO: assert and use, if false: discard proven invariants?!
467 ; format('Illegal Rodin PO source in ~w for ~w: ~w~n',[Machine,Text,Source])
468 ).
469 load_additional_information_fact(po(Machine,Text,Source,Proven)) :- % wd of guard
470 Text = 'Well-definedness of Guard',
471 (member(guard(GRD),Source) % probably the guard in the last event with discharged info ??
472 -> debug_println(9,wd_guard(Machine,GRD,Proven)) % TO DO: assert and use
473 ; format('Illegal Rodin PO source in ~w for ~w: ~w~n',[Machine,Text,Source])
474 ).
475 load_additional_information_fact(po(Machine,'Theorem',[invariant(Theorem)],true)) :- % a theorem
476 debug_println(9,discharged_theorem(Machine,invariant,Theorem)),
477 assertz(discharged_theorem(Machine,invariant,Theorem)).
478 load_additional_information_fact(po(Machine,'Theorem',[axiom(Theorem)],true)) :- % a theorem
479 debug_println(9,discharged_theorem(Machine,axiom,Theorem)),
480 assertz(discharged_theorem(Machine,axiom,Theorem)).
481 load_additional_information_fact(po(Machine,'Theorem',[guard(GuardTheorem),event(Event)],true)) :- % a theorem in a guard
482 debug_println(9,discharged_theorem(Machine,guard(Event),GuardTheorem)),
483 assertz(discharged_theorem(Machine,guard(Event),GuardTheorem)).
484
485 % stuff we don't yet care about
486 load_additional_information_fact(po(Machine,Text,Infos,Proven)) :-
487 ( Text = 'Guard strengthening (split)'
488 ; Text = 'Guard strengthening (merge)'
489 ; Text = 'Guard strengthening' ),
490 !,
491 (Proven=true, Infos = [event(AbsEvent),guard(Guard),event(ConcreteEvent)]
492 -> assertz(discharged_guard_strengthening(Machine,AbsEvent,Guard,ConcreteEvent)),
493 debug_println(19,discharged_guard_strengthening(Machine,AbsEvent,Guard,ConcreteEvent))
494 ; true
495 ).
496 load_additional_information_fact(po(_,'Variant of event',_,_)).
497 load_additional_information_fact(po(_,'Natural number variant of event',_,_)).
498 load_additional_information_fact(po(_,'Action simulation',_,_)).
499 load_additional_information_fact(po(_,'Feasibility of witness',_,_)).
500 load_additional_information_fact(po(_,'Feasibility of action',_,_)).
501 load_additional_information_fact(po(_,'Well-definedness of witness',_,_)).
502 load_additional_information_fact(po(_,'Well-definedness of variant',_,_)).
503 load_additional_information_fact(po(_,'Finiteness of variant',_,_)).
504 load_additional_information_fact(po(_,'Equality of common variables',_,_)).
505
506 load_additional_information_fact(po(_Machine,_Kind,_Source,false)). % ignore everything that is not proven
507
508 load_additional_information_fact(po(_Machine,_Kind,_Source,reviewed)). % ignore everything that is only reviewed
509
510 % ignore exporter version for now
511 % we are compatible to both versions 2 and 3 (added abstract constants)
512 load_additional_information_fact(exporter_version(V)) :- V=2 ; V=3.
513
514 % ignored because the pragmas are attached to the machine in load_event_b_project/4
515 load_additional_information_fact(pragma(_Type,_Source,_AttachedTo,_Content)).
516
517 load_additional_information_fact(wp(S,D,P)) :-
518 assertz( wp_untyped(S,D,P) ).
519
520 load_additional_information_fact(nonchanging_guard(E,P)) :-
521 typecheck_predicates(P,TypedPred,E,_),
522 assertz(nonchanging_guard(E,TypedPred)).
523
524 load_additional_information_fact(invariant(_I)). %ignore
525
526 typecheck_predicates([],[],_,_).
527 typecheck_predicates([H|T],[TH|TT],S,D) :-
528 (S='INITIALISATION' -> Scope1 = []; Scope1=[operation(S)]),
529 ((D='INITIALISATION';var(D)) -> Scope2 = Scope1; Scope2=[operation(D)|Scope1]),
530 Scope = [variables|Scope2],
531 b_type_expression(H,Scope, _, TH, _),
532 typecheck_predicates(T,TT,S,D).
533
534
535 add_discharged_po_infos(Source,Machine) :-
536 % Source = [event(A1),...,event(CurMachineEvent),invariant(Inv)]
537 % note that CurMachineEvent could be equal to A1; A1 can be split up into multiple events (one of which could have the same name as A1; see Ticket PROB-292)
538 get_bottom_event(Source,Event),
539 member(invariant(Invariant),Source),
540 debug_println(9,discharged(Machine,Event,Invariant)),
541 assertz(discharged(Machine,Event,Invariant)),
542 % TO DO: should we propagate info up to abstract events which are not split up or where all refinements preserve a certain invariant ??
543 fail.
544 add_discharged_po_infos(_Source,_Machine).
545
546 % get the last event entry in proof info source list
547 get_bottom_event(Source,Event) :-
548 (bottom_event(Source,'$NONE'(none),Event) -> true
549 ; add_error(bmachine,'Could not determine event for proof info: ',Source),fail).
550 bottom_event([],Ev,Ev) :- Ev \= '$NONE'(none).
551 bottom_event([event(E)|T],_,Res) :- !,bottom_event(T,E,Res).
552 bottom_event([_|T],E,Res) :- bottom_event(T,E,Res).
553
554 :- use_module(debug).
555
556 tcltk_get_specialized_invariants_for_ops(list(Res)) :-
557 findall([Name,InvHeader,TI | Tail],
558 ((b_top_level_operation(Name) ; Name='$initialise_machine'),
559 tcltk_get_specialized_invariant_for_op_single(Name,TI,NrUnProven),
560 tcltk_get_proven_invariant_for_op(Name,PI),
561 ajoin([' INVARIANT (',NrUnProven,')'],InvHeader),
562 (PI='none' -> Tail = ['END;']
563 ; Tail = [' NON-TRIVIAL PROVEN INVARIANT:', PI, 'END;']
564 )
565 ), Res).
566 tcltk_get_specialized_invariant_for_op_single(Event,TI,NrUnProven) :-
567 (b_specialized_invariant_for_op(Event,Invariant) ->
568 conjunction_to_list(Invariant,IL), length(IL,NrUnProven),
569 translate:translate_bexpression(Invariant,TI)
570 ; TI = 'not_simplified', NrUnProven='-').
571 tcltk_get_specialized_invariant_for_op(Event,list(TI)) :-
572 (b_specialized_invariant_for_op(Event,Invariant) ->
573 conjunction_to_list(Invariant,IL),
574 (IL=[] -> TI = ['fully_proven']
575 ; maplist(translate:translate_bexpression,IL,TI))
576 ; TI = ['not_simplified']).
577 tcltk_get_proven_invariant_for_op(Event,TI) :- % get non-trivially proven invariants
578 (get_proven_invariant(Event,Invariant), \+ is_truth(Invariant) ->
579 translate:translate_bexpression(Invariant,TI)
580 ; TI = 'none').
581
582
583 :- public b_nth1_invariant_calc/3.
584 b_nth1_invariant_calc(Nr,Invariant,UsedIds) :-
585 get_invariant_list_with_used_ids(IL,IL_Ids),
586 ? nth1(Nr,IL,Invariant),
587 nth1(Nr,IL_Ids,UsedIds).
588
589 % bmachine:b_nth1_invariant(Nr,Inv,Used), format('~nInvariant ~w over ~w~n',[Nr,Used]), translate:print_bexpr(Inv),nl,fail
590 % bmachine:b_specialized_invariant_mask_for_op(Op,Mask), format('Mask ~w : ~w~n',[Op,Mask]),fail
591
592 :- public b_invariant_number_list_calc/1.
593 b_invariant_number_list_calc(InvList) :-
594 findall(nth1_invariant(Nr),b_nth1_invariant(Nr,_,_),InvList).
595
596 % use proof information to compute subset of invariant that needs to be checked for operations
597
598 % one fact including the position of all unproven invariants
599 :- public b_specialized_invariant_mask_for_op_calc/2.
600 b_specialized_invariant_mask_for_op_calc(Event,Mask) :-
601 preferences:get_preference(use_po,true),
602 get_invariant_list_with_used_ids(IL,IL_Ids),
603 % Note: we can have interference with CSE here, as lazy_let_pred at top-level can merge several conjuncts (but CSE is now disabled for the invariant if PROOF_INFO = TRUE)
604 IL \= [], % otherwise: Invariant already trivial; no sense in keeping track of information
605 ? get_op_or_init_and_syntax_filter(Event,ProofInfoEventName,IL,IL_Ids,RIL),
606 exclude(is_proven_invariant(ProofInfoEventName),RIL,RL), % Warning !! The invariants are not all from Model; the discharged information could be for a proven invariant with the same label from another model, see examples/EventBPrologPackages/ProofDirected/TestR_label_reuse.eventb; this should now properly be dealt with by filter_proven_invariants
607 IL\=RL, /* something filtered out */
608 (RL=[]
609 -> Mask = [] % fully proven
610 ; findall(Nr,(nth1(Nr,IL,Inv),member(Inv,RL)),Mask)
611 ),
612 debug_println(4,b_specialized_invariant_mask_for_op(Event,Mask)).
613
614 % TODO: investigate whether we should pre-compute this or simply re-compute it as needed
615 :- public b_specialized_invariant_for_op_calc/2.
616 b_specialized_invariant_for_op_calc(Event,Invariant) :-
617 ? b_specialized_invariant_mask_for_op(Event,Mask),
618 findall(Inv,(member(Nr,Mask),b_nth1_invariant(Nr,Inv,_)),RL),
619 conjunct_predicates(RL,Invariant). %, print(simplified),nl,translate:print_bexpr(Invariant),nl.
620
621
622 get_op_or_init_and_syntax_filter('$initialise_machine','INITIALISATION',IL,_,IL). % INIT always sets all variables
623 get_op_or_init_and_syntax_filter(Event,Event,IL,IL_Ids,RIL) :-
624 ? b_is_operation_name(Event),
625 filter_syntactically_relevant_invariants(IL,IL_Ids,Event,RIL). % filter out all invariants not modified by Event
626
627 :- public b_operation_preserves_invariant_calc/2.
628 % check if an operation preserves the full invariant; according to proof information
629 b_operation_preserves_invariant_calc(Event,Preserved) :-
630 ? b_specialized_invariant_mask_for_op(Event,Mask),
631 (Mask=[] -> Preserved=full_invariant ; Preserved=partial_invariant).
632
633 b_operation_preserves_full_invariant(Op) :- b_specialized_invariant_mask_for_op(Op,[]).
634
635 :- public get_proven_invariant_calc/2.
636 % computes proven, relevant invariants (not trivial ones which are unaffected by Event) for main model
637 get_proven_invariant_calc(Event, Invariant) :-
638 preferences:get_preference(use_po,true),
639 b_machine_name(Model),
640 get_invariant_list_with_used_ids(IL,IL_Ids),
641 ? b_is_operation_name(Event),
642 %print(filter_syntactically_relevant_invariants(Event,Model)),debug:nl_time,
643 filter_syntactically_relevant_invariants(IL,IL_Ids,Event,RIL),
644 %print(select_proven_invariants(Event,Model)),debug:nl_time,
645 select_proven_invariants(RIL,Model,Event,RL),
646 %print(conjunct_predicates(Event,Model)),debug:nl_time,
647 conjunct_predicates(RL,Invariant).
648
649 get_invariant_list_with_used_ids(IL,IL_Ids) :-
650 b_get_invariant_from_machine(I),
651 conjunction_to_list_with_rodin_labels(I,IL),
652 maplist(find_id_uses_for_maplist,IL,IL_Ids).
653 find_id_uses_for_maplist(Inv,IDs) :- find_identifier_uses(Inv,[],IDs).
654
655 % get list of invariants with proof info (discharged(_)) added
656 get_invariant_list_with_proof_info(InvariantList) :-
657 findall(I,get_invariant_with_proof_status_calc(I,_),InvariantList).
658
659 :- use_module(probsrc(tools_lists),[count_occurences/2]).
660
661 % compute all invariants which are not fully proven for events (initialisation is not examined!):
662 get_unproven_invariants(UnProvenList) :-
663 findall(I,get_invariant_with_proof_status_calc(I,unproven),UnProvenList).
664
665 get_invariant_with_proof_status_calc(Invariant,Proven) :- % not precompiled at the moment
666 b_machine_name(Model),
667 b_get_invariant_from_machine(I),
668 conjunction_to_list_with_rodin_labels(I,IL), % ensure rodin labels are propagated down for proof info
669 ? member(Inv,IL),
670 findall(Status,invariant_proof_status_for_event(Inv,Model,_Event,Status),StatusList),
671 count_occurences(StatusList,Occs),
672 (member(unproven-_,Occs)
673 -> Proven=unproven
674 ; (debug_mode(on) -> print('INVARIANT proven for all events: '), translate:print_bexpr(Inv),nl ; true),
675 Proven=proven
676 ),
677 add_texpr_info_if_new(Inv,proof_status(Proven,Occs),Invariant).
678
679 %is_unproven_inv_for_model(_Invariant,_Model,_Event) :-
680 % preferences:get_preference(use_po,false),!. % information is used in bvisual2,...
681 invariant_proof_status_for_event(Invariant,Model,Event,Status) :-
682 ? b_is_operation_name(Event),
683 proof_status_for_inv2(Invariant,Model,Event,Status).
684
685 proof_status_for_inv2(Invariant,_,Event,unchanged) :-
686 \+ is_syntactically_relevant_invariant_for_event(Event,Invariant),!. % invariant unaffected by Event/Operation
687 proof_status_for_inv2(Invariant,Model,Event,proven) :-
688 ? is_proven_invariant_for_model(Model,Event,Invariant),!.
689 proof_status_for_inv2(_,_,_,unproven).
690
691
692 % filter_syntactically_relevant_invariants(+InvariantsList, +UsedIDs, +EventName, -RelevantItemsFromInvariantsList)
693 filter_syntactically_relevant_invariants(Invariants,IL_Ids,Event,Result) :-
694 get_operation_info(Event,SubstitutionInfo),
695 get_modifies_from_info(SubstitutionInfo,SortedModIds),
696 filter_syntactically_relevant_invariants2(Invariants,IL_Ids,SortedModIds,Result).
697 % noticeably faster than include, see e.g. public_examples/B/PerformanceTests/Generated/Generated4000.mch
698 %include(is_syntactically_relevant_inv(SortedModIds),Invariants,IL_Ids,Result).
699
700 is_syntactically_relevant_inv(SortedModIds,_Inv,IDs) :-
701 ord_intersect(SortedModIds,IDs).
702
703 filter_syntactically_relevant_invariants2([],_,_,[]).
704 filter_syntactically_relevant_invariants2([Inv|T],[IDs|TI],SortedModIds,R) :-
705 (is_syntactically_relevant_inv(SortedModIds,Inv,IDs)
706 -> R=[Inv|TR] ; R=TR),
707 filter_syntactically_relevant_invariants2(T,TI,SortedModIds,TR).
708
709 is_syntactically_relevant_invariant_for_event(Event,Inv) :-
710 get_operation_info(Event,SubstitutionInfo),
711 get_modifies_from_info(SubstitutionInfo,SortedModIds),
712 find_id_uses_for_maplist(Inv,IDs),
713 is_syntactically_relevant_inv(SortedModIds,_Inv,IDs).
714
715 get_modifies_from_info(SubstitutionInfo,SortedModIds) :-
716 ((memberchk(modifies(ModID),SubstitutionInfo) -> ground(ModID))
717 -> list_to_ord_set(ModID,SortedModIds) % is this necessary ?
718 ; SortedModIds=[]).
719
720 % filter_proven_invariants(+InvariantsList, +ModelName, +EventName, -RelevantItemsFromInvariantsList)
721 % this gets called during model checking time
722 is_proven_invariant(Event,E) :-
723 % print('Filter Check: '), print(Event), print(' : '),translate:print_bexpr(E),nl,
724 get_precise_rodin_model_and_name(E,Model,Name),
725 !,
726 ? discharged_invariant(Model,Name,Event),
727 % now check that if E is not always well-defined that there are no unproven WD proof obligations !
728 check_wd_discharged_inv_or_thm(E,Model,Name,Event). %% print('DISCHARGED'(Model,Event,Name)),nl.
729
730 check_wd_discharged_inv_or_thm(E,_,_,_) :- always_well_defined(E),!.
731 check_wd_discharged_inv_or_thm(_,Model,Name,_Event) :- wd_po(Model,Name,ProofStatus),!,
732 ProofStatus=true.
733 check_wd_discharged_inv_or_thm(_,Model,Name,Event) :-
734 % no WD_PO associated or stored
735 % TO DO: we could try ProB-WD prover; but this situation only happens with old-style exports; we could use add_message
736 format('% Assuming invariant/theorem ~w is well-defined for event ~w:~w (no WD PO found).~n',[Name,Model,Event]).
737
738 % select_proven_invariants(+InvariantsList, +ModelName, +EventName, -RelevantItemsFromInvariantsList)
739 select_proven_invariants(Invariants,Model,Event,Result) :-
740 include(is_proven_invariant_for_model(Model,Event),Invariants,Result).
741
742 % Note: different from is_proven_invariant; TO DO: merge (here we assume main model)
743 is_proven_invariant_for_model(MainModel,Event,E) :-
744 ? get_rodin_name(E,Name), % if we do not have a rodin position we consider this as not proved
745 (get_rodin_model_name(E,Model) -> true
746 ; debug_format(19,'Could not get Rodin model name for invariant (deprecated .eventb format): ~w~n',[Name]),
747 Model=MainModel,
748 fail % we have an old style .eventb file; safer to assume not proven as there can be clashes of labels
749 ),
750 ? discharged_invariant(Model,Name,Event).
751
752 is_discharged_assertion(Theorem) :-
753 if( get_precise_rodin_model_and_name(Theorem,Model,Name),
754 (discharged_theorem(Model,_,Name), % does not matter if invariant or axiom
755 check_wd_discharged_inv_or_thm(Theorem,Model,Name,assertion) ) % check that well-defined
756 , (animation_minor_mode(eventb),
757 (silent_mode(on) -> true
758 ; print('Could not get position information for theorem: '),
759 translate:print_bexpr(Theorem),nl,
760 get_texpr_pos(Theorem,POS),debug_println(19,get_texpr_pos(POS))
761 ),
762 fail)
763 ).
764
765 get_precise_rodin_model_and_name(Theorem,Model,Name) :-
766 get_texpr_pos(Theorem,Pos),
767 (Pos = rodinpos(Model,Name,_)
768 -> true % only accept new rodinpos information with three parameters !
769 % the old one with two parameters could lead to confusion as labels can be reused
770 % we also do not accept rodin_derived_context_pos(Model,_Context,Name); not sure if this would be sound
771 ).
772
773 % derived predicate
774 discharged_invariant(Model,InvariantName,Event) :-
775 % InvariantName from model Model is preserved by Event and any of its refinements
776 discharged(Model,Event,InvariantName).
777 discharged_invariant(Model,InvariantName,Event) :-
778 % InvariantName from model Model is preserved by Event and any of its refinements
779 also_discharged(Model,Event,InvariantName).
780
781 b_machine_has_proven_invariants :-
782 (discharged(_,_,_) -> true).
783
784 % complete the discharged/3 information: propagating information from abstract events
785 % down to refined top-level events
786 :- public complete_discharged_info/0.
787 :- public complete_discharged_info_calc/0.
788 complete_discharged_info_calc :- debug_println(4,'completing discharged info: '),
789 statistics(runtime,[Start,_]),
790 (complete_discharged_info2 -> true ; true),
791 statistics(runtime,[Stop,_]), T is Stop-Start, debug_print(4,T), debug_println(4,' ms').
792 :- volatile discharged2/2, also_discharged/3.
793 :- dynamic discharged2/2.
794 :- dynamic also_discharged/3.
795 ?discharged_info_exists :- discharged2(_,_),!.
796 complete_discharged_info2 :- retractall(also_discharged(_,_,_)),
797 retractall(discharged2(_,_)),
798 ? discharged(Model,Event,_), % find out which Model and Events are used in discharged info
799 \+ discharged2(Model,Event), %print(discharged(Model,Event)),nl,
800 assertz(discharged2(Model,Event)),fail.
801 complete_discharged_info2 :- discharged_info_exists,
802 b_get_animated_sections(Sections),
803 ? discharged2(Model,Event), % Event in Model was proven to preserve an invariant in Model
804 b_get_abstract_events(Event,RModel,AbstractEvents), % search for a refinement of Model where the same event exists
805 RModel \= Model,
806 % i.e., invariant Name was proven in an abstract Model for Event
807 \+ is_abstract_event_in_list(Event,Model,AbstractEvents), % this event is *NOT* a refinement of the proven one
808 debug_println(4,removing_discharged(Model,Event)),
809 retractall(discharged(Model,Event,_Name)),
810 member(model(Model),Sections), % only generate error message if the Model is also animated using b_get_animated_sections, see example EventBPrologPackages/ProofDirected/TestInvPreserv_M2_ko_mch.eventb
811 % (otherwise the refinement may well exist but has been filtered out by restricting the animation levels)
812 add_error(event_refinement,'An event does not refine an abstract event of the same name: ',Event:Model:RModel),
813 % This will could cause errors in the proof information usage !
814 %print(AbstractEvents),nl,
815 fail.
816 complete_discharged_info2 :- discharged_info_exists,
817 complete_discharged_info3(_Model,_Event,_Name).
818 complete_discharged_info3(InvNameModel,AbsEvent,Name) :-
819 ? b_get_abstract_events(EventInRefinement,_RefModel,AbstrEvents),
820 ? is_abstract_event_in_list(AbsEvent,InvNameModel,AbstrEvents), % Event in InvNameModel is an abstract event of EventInRefinement
821 %print(check(InvNameModel,Event, EventInRefinement,RefModel)),nl,
822 discharged(InvNameModel,AbsEvent,Name), % print(chck2(Model,Event,Name)),nl,
823 %InvNameModel:Name has been proven for AbsEvent *at all relevant* levels
824 \+ discharged(InvNameModel,EventInRefinement,Name),
825 \+ also_discharged(InvNameModel,EventInRefinement,Name),
826 % this invariant has not yet been marked as proven for EventInRefinement
827 debug_println(4,also_discharged_in_refinement(InvNameModel:Name,EventInRefinement,refined_from(AbsEvent))),
828 assertz(also_discharged(InvNameModel,EventInRefinement,Name)),
829 fail.
830
831 %abstract_event_of_calc(TopLevelEvent,RModel,Event,Model) :-
832 % b_get_abstract_events(TopLevelEvent,RModel,AbstrEvents),
833 % is_abstract_event_in_list(Event,Model,AbstrEvents) , print(abs(TopLevelEvent,RModel,Event,Model)),nl.
834
835 is_abstract_event_in_list(Event,Model,AbstractEvents) :-
836 member(b(rlevent(AEvent,AModel,_S,_P,_G,_Thm,_Act,_VW,_PW,_Unm,AbstractEvents2),_,_),AbstractEvents),
837 (Event=AEvent, Model=AModel;
838 is_abstract_event_in_list(Event,Model,AbstractEvents2)).
839
840 % get events that are refined by an event
841 b_get_abstract_events(Name,Section,AbsEvents) :-
842 ? b_get_machine_operation(Name,_R,_P,Body,_OType,_OpPos),
843 get_texpr_expr(Body,RLEVENT),
844 RLEVENT = rlevent(_Name,Section,_Stat,_Parameters,_Grd,_Thm,_Act,_VWit,_PWit,_Unmod,AbsEvents).
845
846 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
847
848 :- volatile b_operation_reads_output_variables/3, b_operation_cannot_modify_state/1.
849 :- dynamic b_operation_reads_output_variables/3, b_operation_cannot_modify_state/1.
850
851 % test if we have a query or skip operation which cannot modify the state
852 % (preconditions, assertions could still fail though !)
853 :- public b_operation_cannot_modify_state_calc/1.
854 b_operation_cannot_modify_state_calc(Event) :-
855 ? b_get_operation_normalized_read_write_info(Event,_ReadVariables,[]).
856
857 :- use_module(b_read_write_info, [get_accessed_vars/4]).
858 % check if classical B operation reads its output variables
859 :- public b_operation_reads_output_variables_calc/3.
860 b_operation_reads_output_variables_calc(Event,ReadOutputVariablesIds,ReadOutputTypedInfo) :-
861 ? b_get_machine_operation(Event,ResultTuple,_TParas,TBody,_OType,_Pos),
862 def_get_texpr_ids(ResultTuple,ResIds),
863 sort(ResIds,SResIds),
864 get_operation_info(Event,SubstitutionInfo),
865 member(reads_locals(Reads),SubstitutionInfo), % locals are either arguments or return output variables
866 ord_intersection(Reads,SResIds,ReadOutputVariablesIds),
867 ReadOutputVariablesIds \= [],
868 % now recompute the information based on TBody after ast_cleanup: typing predicates have been removed
869 get_accessed_vars(TBody,[],_,AllReadsAfterAstCleanup), % important to pass [] as local variables
870 ord_intersection(AllReadsAfterAstCleanup,ReadOutputVariablesIds,ReadOutputVariablesIds2),
871 ReadOutputVariablesIds2 \= [],
872 (get_preference(allow_operations_to_read_outputs,true), debug_mode(off) -> true
873 ; ajoin(['Operation ', Event, ' is possibly reading or not always assigning to output parameters: '],Msg),
874 add_message(bmachine,Msg,ReadOutputVariablesIds2,ResultTuple)
875 % Note: analysis is not always precise: /public_examples/B/NewSyntax/CallOperationInExprSimple2.mch
876 ),
877 findall(reads_result(Index,ID,Type),
878 (nth1(Index,ResultTuple,b(identifier(ID),Type,_)), ord_member(ID,ReadOutputVariablesIds2)),
879 ReadOutputTypedInfo).
880
881
882
883 :- volatile b_get_operation_normalized_read_write_info/3, b_get_operation_unchanged_variables/2.
884 :- dynamic b_get_operation_normalized_read_write_info/3, b_get_operation_unchanged_variables/2.
885
886
887 :- use_module(bsyntaxtree,[get_global_identifiers/1]).
888
889 :- public b_get_operation_normalized_read_write_info_calc/3.
890 /* compute Read and Written Variables by an operation */
891 b_get_operation_normalized_read_write_info_calc(Event,SortedReadVariables,SortedWrittenVariables) :-
892 get_global_identifiers(IS), % Note: find identifier uses was called before global sets precompiled
893 ? get_operation_info(Event,SubstitutionInfo),
894 (memberchk(modifies(WrittenVariables),SubstitutionInfo)
895 -> sort(WrittenVariables,SWV), % normally not necessary; just to be sure
896 ord_subtract(SWV,IS,SortedWrittenVariables)
897 ; print(no_modifies_info(Event)),nl,fail),
898 (memberchk(reads(ReadVariables),SubstitutionInfo)
899 -> sort(ReadVariables,SWR),
900 ord_subtract(SWR,IS,SortedReadVariables)
901 ; debug_println(9,no_reads_info(Event)),fail). % happens currently in Event-B !
902 %% , print(read_write_set(Event,ReadVariables,WrittenVariables)),nl.
903
904 :- public b_get_operation_unchanged_variables_calc/2.
905 b_get_operation_unchanged_variables_calc(Event,UnchangedVariables) :-
906 b_get_machine_variables(TVars),
907 def_get_texpr_ids(TVars,V),
908 sort(V,SAllVars),
909 ? b_get_operation_normalized_read_write_info(Event,_,WrittenVars),
910 ord_subtract(SAllVars,WrittenVars,UnchangedVariables).
911
912
913
914 :- volatile b_get_operation_non_det_modifies/2.
915 :- dynamic b_get_operation_non_det_modifies/2.
916 :- public b_get_operation_non_det_modifies_calc/2.
917 :- use_module(b_read_write_info,[get_nondet_modified_vars/3]).
918 % determine which variables are non-deterministically written by an operation
919 % note: this can depend on the parameters, hence show_eventb_any_arguments is relevant
920 b_get_operation_non_det_modifies_calc(OpName,NonDetModifies) :-
921 ? b_get_machine_operation_for_animation(OpName,Results,Parameters,Body),
922 append(Results,Parameters,TLocalVars),
923 get_texpr_ids(TLocalVars,LocalVars),
924 get_nondet_modified_vars(Body,LocalVars,NonDetModifies).
925 b_get_operation_non_det_modifies_calc('$initialise_machine',NonDetModifies) :-
926 b_get_initialisation_from_machine(Body,_),
927 get_nondet_modified_vars(Body,[],NonDetModifies),debug_println(19,init_not_det_modifies(NonDetModifies)).
928
929
930 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
931
932
933 :- volatile b_get_all_used_filenames/1, b_get_main_filename/1, b_get_main_filenumber/1.
934 :- dynamic b_get_all_used_filenames/1. % can be used, e.g., for second argument of pos info field
935 :- dynamic b_get_main_filename/1. % can be used in above list; there is also specfile:currently_opened_file
936 :- dynamic b_get_main_filenumber/1. % the number of the main_file in the b_get_all_used_filenames list (useful for pos information)
937 b_get_all_used_filenames([]).
938
939 % add an additional filename and obtain its number
940 add_additional_filename(Filename,ResNr) :- functor(Filename,unknown,_),!,
941 format('Unknown additional filename: ~w~n',[Filename]),
942 ResNr = -1.
943 add_additional_filename(Filename,ResNr) :-
944 b_get_all_used_filenames(Fs),
945 nth1(Nr,Fs,Filename),!,
946 ResNr=Nr.
947 add_additional_filename(Filename,ResNr) :-
948 retract(b_get_all_used_filenames(Fs)),
949 length(Fs,Len),
950 append(Fs,[Filename],NewFs),
951 assert(b_get_all_used_filenames(NewFs)),
952 ResNr is Len+1,
953 format('Registering new filename ~w with number ~w~n',[Filename,ResNr]).
954
955 % add additional filename and add as default for parsercalls
956 set_additional_filename_as_parsing_default(Filename,NewNr,OldNr) :-
957 add_additional_filename(Filename,NewNr),
958 set_default_filenumber(NewNr,OldNr).
959 reset_filename_parsing_default(NewNr,OldNr) :- % reset default filenumber back
960 reset_default_filenumber(NewNr,OldNr).
961
962 b_load_machine_from_file(Filename) :- b_load_machine_from_file(Filename,[]).
963 b_load_machine_from_file(Filename,Options) :-
964 (debug_mode(on)
965 -> get_parser_version(Version),
966 format('Java Parser Version: ~w~n',[Version]) % used to be called unconditionally to be sure to catch error if java or BParser.jar not available; but now we do not want the Java startup time unless really necessary
967 ; true),
968 b_reset_filenames_and_numbers,
969 debug_stats(loading(Filename)),
970 catch(load_b_machine_as_term(Filename,Machine,Options),
971 parse_errors(Errors),
972 (add_all_perrors_in_context_of_used_filenames(Errors,parse_error),fail)),
973 b_load_machine_from_term(Filename,Machine).
974
975
976 % add parse errors in context of current machine and its filenames
977 add_all_perrors_in_context_of_used_filenames(Errors,TypeOfError) :- Errors\=[],
978 b_get_all_used_filenames(Filenames), Filenames \= [],
979 !,
980 add_all_perrors(Errors,Filenames,TypeOfError).
981 add_all_perrors_in_context_of_used_filenames(Errors,TypeOfError) :-
982 (Errors=[] -> true ; debug_println(19,'Unable to obtain filenames for parse errors, probably preparse_error')),
983 add_all_perrors(Errors,[],TypeOfError).
984
985
986 % a way to load .prob files directly
987 b_load_machine_probfile(Filename) :- b_load_machine_probfile(Filename,[]).
988 b_load_machine_probfile(Filename,Options) :- b_reset_filenames_and_numbers,
989 load_b_machine_probfile_as_term(Filename,Options,Machine),
990 Machine = complete_machine(_MainName,_,Filenames),
991 Filenames = [BFilename|_], % assume first file is the main file
992 b_load_machine_from_term(BFilename,Machine).
993
994
995 % a way to load form a list of Facts which would be found in the .prob file
996 b_load_machine_from_list_of_facts(Filename,ListOfFacts) :- % Filename only used below for find_main_file_name and later to find out about position infos if they are in the main file or not
997 load_b_machine_list_of_facts_as_term(ListOfFacts,Machine),
998 b_load_machine_from_term(Filename,Machine).
999
1000
1001 b_reset_filenames_and_numbers :-
1002 set_all_used_filenames([]),
1003 retractall(b_get_main_filename(_)),
1004 retractall(b_get_main_filenumber(_)),
1005 retractall(b_filenumber(_,_,_,_)).
1006
1007 set_all_used_filenames(AllFilenames) :-
1008 retractall(b_get_all_used_filenames(_)),
1009 assertz(b_get_all_used_filenames(AllFilenames)).
1010
1011
1012 b_load_machine_from_term(Filename,complete_machine(MainName,Machines,Filenames)) :-
1013 b_reset_filenames_and_numbers, % call in case we call this predicate directly from outside
1014 !,
1015 assertz(b_get_main_filename(Filename)),
1016 set_all_used_filenames(Filenames),
1017 store_filenumbers(Filenames),
1018 (find_main_file_name(Nr,Filenames,Filename) -> assertz(b_get_main_filenumber(Nr))
1019 ; ajoin(['Main filename ', Filename, ' does not appear in filenames list: '],Msg),
1020 add_warning(bmachine,Msg,Filenames)
1021 ),
1022 %print(find_main_file_name(Nr,Filenames,Filename)),nl,
1023 check_valid_machine_name(MainName),
1024 debug_stats(analyse_hierarchy(MainName,Filename)),
1025 (rewrite_complete_machine(MainName,Machines,Machines1) -> true ; Machines1 = Machines),
1026 (analyse_hierarchy(MainName,Machines1)
1027 -> true ; add_error(b_load_machine,'Analyse Hierarchy failed'),fail),
1028 debug_stats(type_check(MainName,Filename)),
1029 b_set_machine(MainName,Machines1,Errors), % Typechecking
1030 debug_stats(checked_machine(MainName,Filename)),
1031 add_all_perrors(Errors,Filenames,type_error), % TO DO: use type_check as source as this may also generate warnings
1032 no_real_perror_occurred(Errors).
1033 b_load_machine_from_term(F,X) :- add_internal_error('Illegal machine: ',b_load_machine_from_term(F,X)),
1034 fail.
1035
1036 rewrite_complete_machine(MainName,[DefMachine],[NewMachine]) :-
1037 DefMachine=definition_file(Pos,Defs),
1038 %print(defs(Defs)),nl,
1039 % Generate virtual abstract machine when loading a .def DEFINITION file
1040 debug_println(19,creating_virtual_abstract_machine_for_definition_file),
1041 Header = machine_header(Pos,MainName,[]),
1042 NewMachine = abstract_machine(Pos,machine(Pos),Header,[Defs]).
1043
1044 check_valid_machine_name(Name) :- atom(Name),atom_codes(Name,Codes),
1045 invalid_chars(Invalid),
1046 ? (member(C,Codes),ord_member(C,Invalid)
1047 -> ajoin(['Machine name ', Name, ' contains illegal character: '],Msg),
1048 atom_codes(IChar,[C]),
1049 add_warning(bmachine,Msg,IChar)
1050 ; true),
1051 !.
1052 check_valid_machine_name(Name) :- add_internal_error('Illegal machine name:',check_valid_machine_name(Name)).
1053
1054 invalid_chars(".").
1055
1056 :- use_module(tools_matching,[codes_to_lower_case/2]).
1057 find_main_file_name(Nr,_Filenames,File) :- safe_absolute_file_name(File,AF),
1058 tools:get_modulename_filename(AF,TAF), tools:get_filename_extension(AF,ExtF),
1059 (ExtF = prob
1060 -> when(nonvar(EXT), member(EXT,[mch,ref,imp,tla,rmch])) % any machine extension is ok for .prob file
1061 ; EXT =ExtF),
1062 (b_filenumber(TAF,EXT,Nr,_) -> true
1063 ; atom_codes(TAF,TAFCodes), codes_to_lower_case(TAFCodes,Low),
1064 b_filenumber(TAF2,EXT,Nr,_),
1065 atom_codes(TAF2,C2), codes_to_lower_case(C2,Low)
1066 -> ajoin(['Case mis-match between main filename ',TAF,' and stored filename: '],Msg),
1067 % can happen on some file-systems which are case-insensitive or when transferring .prob files from one OS to another
1068 add_message(bmachine,Msg,TAF2)
1069 ).
1070
1071
1072
1073 % remember as facts all B filenames, their extension and their number
1074 :- volatile b_filenumber/4.
1075 :- dynamic b_filenumber/4.
1076 store_filenumbers(Filenames) :- retractall(b_filenumber(_,_,_,_)),
1077 store_filenumbers(Filenames,1).
1078 store_filenumbers([],_).
1079 store_filenumbers([H|T],Nr) :-
1080 safe_absolute_file_name(H,AbsFname),tools:get_modulename_filename(AbsFname,ModuleName),
1081 tools:get_filename_extension(AbsFname,ExtF),
1082 assertz(b_filenumber(ModuleName,ExtF,Nr,AbsFname)),
1083 debug_println(9,b_filenumber(ModuleName,ExtF,Nr,AbsFname)),
1084 N1 is Nr+1,
1085 store_filenumbers(T,N1).
1086
1087 portray_filenumbers :-
1088 format('~w : ~w : ~w (~w)~n',['Nr','ext','Name','Full path']),
1089 b_filenumber(ModuleName,ExtF,Nr,AbsFname),
1090 format('~w : ~w : ~w (~w)~n',[Nr,ExtF,ModuleName,AbsFname]),
1091 fail.
1092 portray_filenumbers.
1093
1094 :- use_module(tools,[same_file_name/2]).
1095 get_machine_file_number(Name,Ext,Nr,File) :-
1096 ? if(b_filenumber(Name,Ext,Nr,File),
1097 true,
1098 (b_filenumber(StoredName,Ext,Nr,File),
1099 % on Windows the capitalisation of the stored name maybe different from the name in machine
1100 same_file_name(Name,StoredName)
1101 )).
1102
1103
1104 :- use_module(tools,[safe_absolute_file_name/3, get_parent_directory/2]).
1105 % open a file relateive to the main B file
1106 b_absolute_file_name_relative_to_main_machine(File,AbsFileName) :-
1107 b_get_main_filename(MainFileName),
1108 get_parent_directory(MainFileName,Directory),
1109 % in Jupyter: MainFileName does not exist; SICStus then treats it as a directory
1110 safe_absolute_file_name(File,AbsFileName,[relative_to(Directory)]).
1111
1112 % call to clear all data stored for machine
1113 b_machine_clear :-
1114 b_machine_reset,
1115 b_reset_filenames_and_numbers.
1116
1117 :- use_module(btypechecker,[reset_typechecker/0]).
1118 :- use_module(b_global_sets,[b_clear_global_set_type_definitions/0]).
1119 :- use_module(bmachine_construction,[reset_bmachine_construction/0]).
1120 b_machine_reset :- % print(b_machine_reset),nl,
1121 retractall(machine(_,_)),
1122 retractall(discharged_theorem(_,_,_)),
1123 retractall(discharged_guard_strengthening(_,_,_,_)),
1124 retractall(discharged(_,_,_)),
1125 retractall(wd_po(_,_,_)),
1126 retractall(also_discharged(_,_,_)),
1127 reset_temp_predicate,
1128 retractall(b_machine_additional_property(_)),
1129 reset_typechecker,
1130 b_clear_global_set_type_definitions,
1131 reset_bmachine_construction,
1132 startup_precompiled. % change so that error messages generated if we call them
1133
1134 :- use_module(eventhandling,[register_event_listener/3]).
1135 :- register_event_listener(clear_specification,b_machine_clear,
1136 'Reset bmachine facts.').
1137
1138 % :- use_module(library(random)).
1139 :- use_module(preferences,[get_preference/2]).
1140
1141
1142
1143
1144 % precompiled
1145 :- volatile b_machine_name/1.
1146 :- dynamic b_machine_name/1.
1147 :- public b_machine_name_calc/1.
1148 b_machine_name_calc(Name) :-
1149 get_full_b_machine(Name,_).
1150
1151 b_get_animated_sections(Sections) :-
1152 get_section_from_current_machine(meta,MetaInfos),
1153 ( member(animated_sections(Sections), MetaInfos) -> true
1154 ; add_error(bmachine,'No animated sections available'), fail).
1155
1156 :- volatile b_get_named_machine_set/3.
1157 :- dynamic b_get_named_machine_set/3.
1158 :- public b_get_named_machine_set_calc/3.
1159 ?b_get_named_machine_set(Set,Members) :- b_get_named_machine_set(Set,_,Members).
1160 % precompiled: all enumerated sets with their elements (all in atomic form)
1161 b_get_named_machine_set_calc(Set,TExpr,Members) :-
1162 get_section_from_current_machine(enumerated_sets,Sets),
1163 get_section_from_current_machine(enumerated_elements,Elems),
1164 get_texpr_id(TExpr,Set),
1165 get_texpr_type(TExpr,set(Type)),
1166 get_texpr_type(TElem,Type),
1167 ? member(TExpr,Sets),
1168 findall(E, (member(TElem,Elems), get_texpr_id(TElem,E)), Members).
1169
1170 :- volatile b_enumerated_sets_precompiled/0.
1171 :- dynamic b_enumerated_sets_precompiled/0.
1172 :- public b_enumerated_sets_precompiled_calc/0.
1173 b_enumerated_sets_precompiled_calc :-
1174 b_check_and_precompile_enumerated_sets.
1175
1176 :- volatile b_get_machine_set/2.
1177 :- dynamic b_get_machine_set/2.
1178 :- public b_get_machine_set_calc/2.
1179 ?b_get_machine_set(Set) :- b_get_machine_set(Set,_).
1180 % precompiled: all deferred and enumerated sets (in atomic form)
1181 b_get_machine_set_calc(Set,TExpr) :-
1182 get_section_from_current_machine(deferred_sets,Sets),
1183 get_texpr_id(TExpr,Set),
1184 ? member(TExpr,Sets).
1185 b_get_machine_set_calc(Set,TExpr) :-
1186 ? b_get_named_machine_set(Set,TExpr,_).
1187
1188 :- volatile b_get_machine_constants/1, b_get_machine_all_constants/1, b_get_machine_variables/1, b_get_machine_variables_in_original_order/1, b_is_constant/2, b_is_variable/2, b_get_constant_variable_description/2.
1189 :- dynamic b_get_machine_constants/1, b_get_machine_all_constants/1, b_get_machine_variables/1, b_get_machine_variables_in_original_order/1, b_is_constant/2, b_is_variable/2, b_get_constant_variable_description/2.
1190 b_machine_has_constants :- b_get_machine_constants([_|_]).
1191 :- public b_get_machine_all_constants_calc/1.
1192 % precompiled: all constants (abstract and concrete) in typed form
1193 b_get_machine_all_constants_calc(Csts) :-
1194 findall(C,get_multi_sections([abstract_constants,concrete_constants],C),Csts).
1195 :- public b_get_machine_constants_calc/1.
1196 % precompiled: all constants (abstract and concrete) in typed form; except for constant_represented inside global set
1197 b_get_machine_constants_calc(Csts) :-
1198 findall(C,
1199 (get_multi_sections([abstract_constants,concrete_constants],C),
1200 get_texpr_id(C,CID),
1201 \+ b_get_constant_represented_inside_global_set(CID,_)), % ignore constants detected as enumerated set elements
1202 Csts).
1203
1204 b_machine_has_variables :- b_get_machine_variables([_|_]).
1205
1206 :- public b_get_machine_variables_in_original_order_calc/1.
1207 % precompiled: all variables (abstract and concrete) in typed form
1208 b_get_machine_variables_in_original_order_calc(Vars) :-
1209 findall(V,get_multi_sections([abstract_variables,concrete_variables],V),Vars).
1210
1211 :- public b_get_machine_variables_calc/1.
1212 % get variables in order suitable for ord_member and optimized update storing
1213 b_get_machine_variables_calc(SVars) :-
1214 b_get_machine_variables_in_original_order(Vars),
1215 sort(Vars,SVars).
1216
1217 get_nr_of_machine_variables(Nr) :- b_get_machine_variables(L), length(L,Nr).
1218 get_nr_of_machine_constants(Nr) :- b_get_machine_constants(L), length(L,Nr).
1219
1220 ?b_is_constant(C) :- b_is_constant(C,_).
1221 :- public b_is_constant_calc/2.
1222 % precompiled: all constants (abstract and concrete) in atomic form
1223 b_is_constant_calc(Cst,Type) :-
1224 b_get_machine_constants(Constants),
1225 get_texpr_id(Term,Cst),
1226 get_texpr_type(Term,Type),
1227 ? member(Term,Constants).
1228 b_is_variable(V) :- b_is_variable(V,_).
1229 :- public b_is_variable_calc/2.
1230 % precompiled: all variables (abstract and concrete) in atomic form
1231 b_is_variable_calc(Var,Type) :-
1232 b_get_machine_variables(Vars), % b_get_machine_variables_in_original_order
1233 get_texpr_id(Term,Var),
1234 get_texpr_type(Term,Type),
1235 ? member(Term,Vars).
1236 % look up elements in several sections of the machine
1237 get_multi_sections(Sections,Elem) :-
1238 ? member(Section,Sections),
1239 get_section_from_current_machine(Section,List),
1240 ? member(Elem,List).
1241
1242 :- public b_get_constant_variable_description_calc/2.
1243 % get value of description pragmas @desc for variables and constants:
1244 b_get_constant_variable_description_calc(ID,Desc) :-
1245 (b_get_machine_constants(L) ; b_get_machine_variables(L)),
1246 get_texpr_id(Term,ID),
1247 ? member(Term,L),
1248 get_texpr_description(Term,TDesc),
1249 (simplify_desc(TDesc,Desc) -> true ; TDesc=Desc).
1250
1251 :- use_module(probsrc(tools_strings), [atom_prefix/2]).
1252 simplify_desc(memoize,memo).
1253 simplify_desc(memoise,memo).
1254 simplify_desc('"memoize"',memo).
1255 simplify_desc('"memoise"',memo).
1256 simplify_desc('"expand"',expand).
1257 simplify_desc('"memo"',memo). % allow /*@desc "memo" */
1258 simplify_desc(Atom,memo) :- atom_prefix('"memo ',Atom). % allow /*@desc "memo ...additional text" */
1259
1260 % check if a constant or variable is annotated for memoization:
1261 constant_variable_marked_as_memo(ID) :- b_get_constant_variable_description(ID,memo).
1262
1263 % check if a constant or variable is annotated for expansion using @desc expand
1264 constant_variable_marked_as_expand(ID) :- b_get_constant_variable_description(ID,EXPAND), EXPAND=expand.
1265
1266
1267 :- volatile b_get_invariant_from_machine/1,
1268 b_get_linking_invariant_from_machine/1,
1269 b_get_properties_from_machine/1,
1270 b_get_static_assertions_from_machine/1,
1271 b_extract_values_clause_assignment/3,
1272 b_get_unproven_static_assertions_from_machine/1,
1273 b_get_dynamic_assertions_from_machine/1,
1274 b_get_unproven_dynamic_assertions_from_machine/1,
1275 b_get_assertions_from_main_machine/2,
1276 b_get_initialisation_from_machine/2,
1277 b_get_machine_operation/6,b_top_level_operation/1,
1278 b_get_machine_operation_for_animation/7,
1279 b_is_operation_name/1,
1280 b_get_promoted_machine_operations/1.
1281 :- dynamic b_get_invariant_from_machine/1,
1282 b_get_linking_invariant_from_machine/1,
1283 b_get_properties_from_machine/1,
1284 b_get_static_assertions_from_machine/1,
1285 b_extract_values_clause_assignment/3,
1286 b_get_unproven_static_assertions_from_machine/1,
1287 b_get_dynamic_assertions_from_machine/1,
1288 b_get_unproven_dynamic_assertions_from_machine/1,
1289 b_get_assertions_from_main_machine/2,
1290 b_get_initialisation_from_machine/2,
1291 b_get_machine_operation/6,b_top_level_operation/1,
1292 b_get_machine_operation_for_animation/7,
1293 b_is_operation_name/1,
1294 b_get_promoted_machine_operations/1.
1295
1296 :- public b_get_invariant_from_machine_calc/1.
1297 % precompiled: typed invariant (a predicate)
1298 b_get_invariant_from_machine_calc(Inv) :-
1299 get_section_from_current_machine(invariant,Inv).
1300
1301 :- public b_get_linking_invariant_from_machine_calc/1.
1302 % precompiled: typed linking invariant (a predicate)
1303 b_get_linking_invariant_from_machine_calc(Inv) :-
1304 get_section_from_current_machine(linking_invariant,Inv).
1305
1306 :- public b_get_properties_from_machine_calc/1.
1307 % precompiled: typed properties (a predicate)
1308 b_get_properties_from_machine_calc(SortedProp) :-
1309 get_section_from_current_machine(properties,Prop),
1310 (sort_properties(Prop,SortedProp) -> true %(Prop=SortedProp->true ; print(sorted(SortedProp)))
1311 ; add_error(sort_properties,'sort_properties failed: ',Prop),
1312 SortedProp=Prop).
1313
1314 sort_properties(Prop,SortedProp) :- % print(sort_properties),nl,statistics(runtime, [R1,_]),
1315 weigh_properties(Prop,1,_,[],SProp),
1316 % statistics(runtime, [R2,_]), RDiff is R2-R1,print(done_weigh(RDiff,SProp)),nl,
1317 sort(SProp,SSProp),
1318 % statistics(runtime, [R3,_]), RDiff2 is R3-R2,print(done_sort(RDiff2)),nl,
1319 remove_weights(SSProp,PropList),
1320 conjunct_predicates(PropList,SortedProp).
1321 % translate:print_bexpr(SortedProp).
1322
1323 remove_weights([],[]).
1324 remove_weights([prop(_W,_Nr,E)|T],[E|RT]) :- remove_weights(T,RT).
1325
1326 weigh_properties(Pred,Nr,ONr,InL,OutL) :-
1327 decompose_conjunct(Pred,LHS,RHS), % will propagate labels down to conjuncts LHS,RHS
1328 !,
1329 weigh_properties(LHS,Nr,N1,InL,L2),
1330 weigh_properties(RHS,N1,ONr,L2,OutL).
1331 weigh_properties(b(Pred,S,I),Nr,N1,T,[prop(Weight,Nr,b(Pred,S,I))|T]) :-
1332 N1 is Nr+1,
1333 ? (member(contains_wd_condition,I) -> Weight=32000 % do not move properties with WD info
1334 ; weigh_properties2(Pred,Weight)).
1335 % translate:print_bexpr(b(Pred,S,I)), print(' WEIGHT: '), print(Weight),nl
1336
1337 weigh_properties2(truth,W) :- !, W=1.
1338 weigh_properties2(falsity,W) :- !, W=1.
1339 weigh_properties2(equal(L,R),W) :- weigh_term(L,W1), !,
1340 ( weigh_term(R,W2) -> W is W1*W2
1341 ; W is 3200).
1342 % ; W is W1*20). %causes issue with ParityFunction test
1343 %weigh_properties2(equal(_,R),W) :- weigh_term(R,W2), !, W is W2*20.
1344 weigh_properties2(SOp,W) :- comparison(SOp,L,R),!,
1345 ( (weigh_term(L,W1), weigh_term(R,W2))
1346 -> W is 7+W1+W2 % try and give things like x>10 priority over x>y (to overcome CLP(FD) limitations)
1347 ; W=10).
1348 weigh_properties2(partition(LHS,RHS),W) :- weigh_term(LHS,W1), l_weigh_term(RHS,W2), !, W is W1*W2.
1349 ?weigh_properties2(not_equal(L,R),W) :- ((id(L),empty(R)) ; (id(R),empty(L))),!, W=1.
1350 weigh_properties2(not_equal(L,R),W) :- weigh_term(L,W1), weigh_term(R,W2),!,
1351 W is 20+W1*W2.
1352 weigh_properties2(_Rest,W) :- W=32000.
1353
1354 comparison(less(L,R),L,R).
1355 comparison(less_equal(L,R),L,R).
1356 comparison(greater(L,R),L,R).
1357 comparison(greater_equal(L,R),L,R).
1358
1359
1360 id(b(identifier(_),_,_)).
1361 empty(b(empty_set,_,_)).
1362 empty(b(empty_sequence,_,_)).
1363
1364 l_weigh_term([],0).
1365 l_weigh_term([H|T],R) :- l_weigh_term(T,TR), weigh_term(H,TH), R is TH+TR.
1366
1367 weigh_term(b(T,_,_),R) :- (weigh_term2(T,R) -> true ; fail). %R=20).
1368
1369 weigh_term2(value(_),1).
1370 weigh_term2(boolean_true,1).
1371 weigh_term2(boolean_false,1).
1372 weigh_term2(empty_set,1).
1373 weigh_term2(empty_sequence,1).
1374 weigh_term2(integer(_),1).
1375 weigh_term2(min_int,1).
1376 weigh_term2(max_int,1).
1377 weigh_term2(string(_),1).
1378 weigh_term2(real(_),1).
1379 weigh_term2(bool_set,2).
1380 weigh_term2(identifier(_),2).
1381 weigh_term2(set_extension(_),3).
1382 weigh_term2(integer_set(_),3).
1383 weigh_term2(interval(L,R),W) :- weigh_term(L,WL), weigh_term(R,WR), W is WL*WR.
1384
1385
1386
1387 b_machine_has_constants_or_properties :-
1388 (b_machine_has_constants -> true
1389 ; (b_get_properties_from_machine(Prop)), \+ is_truth(Prop)).
1390
1391 b_get_machine_operation_parameter_types(OpName,ParTypes) :-
1392 ? b_get_machine_operation_typed_parameters(OpName,Parameters),
1393 maplist(get_texpr_type,Parameters,ParTypes).
1394
1395 b_get_machine_operation_typed_parameters(Operation,Res) :-
1396 ? b_get_machine_operation_typed_parameters3(Operation,real_paras_only,Res).
1397 b_get_machine_operation_typed_parameters_for_animation(Operation,Res) :-
1398 b_get_machine_operation_typed_parameters3(Operation,for_animation,Res).
1399
1400 b_get_machine_operation_typed_parameters3(Operation,ForAnim,Res) :-
1401 ? if(b_get_machine_operation_typed_parameters_aux(Operation,ForAnim,Paras),Res=Paras,
1402 (add_internal_error('Cannot get paras: ',b_get_machine_operation_typed_parameters(Operation,ForAnim,Res)),fail)).
1403 % also recognises SETUP_CONSTANTS & INITIALISE_MACHINE
1404 b_get_machine_operation_typed_parameters_aux('$setup_constants',_,Constants) :-
1405 b_machine_has_constants_or_properties,
1406 b_get_machine_constants(Constants).
1407 b_get_machine_operation_typed_parameters_aux('$initialise_machine',_,Variables) :-
1408 b_get_machine_variables(Variables).
1409 b_get_machine_operation_typed_parameters_aux(OpName,real_paras_only,Parameters) :-
1410 b_get_machine_operation(OpName,_R,Parameters,_Body,_OType,_OpPos).
1411 b_get_machine_operation_typed_parameters_aux(OpName,for_animation,Parameters) :-
1412 b_get_machine_operation_for_animation(OpName,_R,Parameters,_Body).
1413
1414 b_get_machine_operation_parameter_names(OpName,ParaNames) :-
1415 b_get_machine_operation_parameter_names(OpName,real_paras_only,ParaNames).
1416 b_get_machine_operation_parameter_names_for_animation(OpName,ParaNames) :-
1417 b_get_machine_operation_parameter_names(OpName,for_animation,ParaNames).
1418
1419 b_get_machine_operation_parameter_names('@INITIALISATION',ForAnim,ParaNames) :- % for Tcl/Tk
1420 b_get_machine_operation_parameter_names('$initialise_machine',ForAnim,ParaNames).
1421 b_get_machine_operation_parameter_names('@PROPERTIES',ForAnim,ParaNames) :- % for Tcl/Tk
1422 b_get_machine_operation_parameter_names('$setup_constants',ForAnim,ParaNames).
1423 b_get_machine_operation_parameter_names(OpName,ForAnim,ParaNames) :-
1424 b_get_machine_operation_typed_parameters3(OpName,ForAnim,Parameters),
1425 get_texpr_ids(Parameters,ParaNames).
1426
1427 b_get_machine_operation_typed_results('$setup_constants',[]).
1428 b_get_machine_operation_typed_results('$initialise_machine',[]).
1429 b_get_machine_operation_typed_results(OpName,Results) :-
1430 b_get_machine_operation(OpName,Results,_Parameters,_Body,_OType,_OpPos).
1431
1432 b_get_machine_operation_result_names('$setup_constants',[]).
1433 b_get_machine_operation_result_names('$initialise_machine',[]).
1434 b_get_machine_operation_result_names(OpName,ResultNames) :-
1435 b_get_machine_operation(OpName,Results,_Parameters,_Body,_OType,_OpPos),
1436 get_texpr_ids(Results,ResultNames).
1437
1438 b_get_machine_operation(Name,Results,Parameters,Body) :-
1439 ? b_get_machine_operation(Name,Results,Parameters,Body,_OType,_OpPos).
1440
1441 :- public b_get_assertions_from_main_machine_calc/2.
1442 b_get_assertions_from_main_machine_calc(static,FProp) :-
1443 ((b_get_static_assertions_from_machine(Prop),
1444 exclude(is_not_main_assertion,Prop,FProp)) -> true
1445 ; add_error(bmachine,'b_get_assertions_from_main_machine_calc static fails'), FProp=[]).
1446 b_get_assertions_from_main_machine_calc(dynamic,FProp) :-
1447 ((b_get_dynamic_assertions_from_machine(Prop),
1448 exclude(is_not_main_assertion,Prop,FProp)) -> true
1449 ; add_error(bmachine,'b_get_assertions_from_main_machine_calc dynamic fails'), FProp=[]).
1450 is_not_main_assertion(Assertion) :-
1451 get_texpr_pos(Assertion,Pos),
1452 error_manager:position_is_not_in_main_file(Pos).
1453
1454 % get nr of assertions and nr of main assertions for static/dynamic
1455 b_get_assertion_count(StaticOrDynamic,NrAll,NrMain) :-
1456 ? b_get_assertions(all,StaticOrDynamic,A), length(A,NrAll),
1457 b_get_assertions_from_main_machine(StaticOrDynamic,MA),length(MA,NrMain).
1458
1459 b_get_assertions(main,Mode,Ass) :- !,
1460 b_get_assertions_from_main_machine(Mode,Ass).
1461 b_get_assertions(specific(Label),Mode,LabelAss) :- !,
1462 b_get_assertions(all,Mode,Ass),
1463 %maplist(get_texpr_label,Ass,Labels), print(labels(Labels)),nl,
1464 include(has_label(Label),Ass,LabelAss),
1465 (LabelAss=[] -> ajoin(['No ',Mode,' assertion has label: '],Msg),
1466 add_warning(b_get_assertions,Msg,Label) ; true).
1467 b_get_assertions(_,static,Ass) :- b_get_static_assertions_from_machine(Ass).
1468 b_get_assertions(_,dynamic,Ass) :- b_get_dynamic_assertions_from_machine(Ass).
1469 b_main_machine_has_no_assertions :-
1470 b_get_assertions_from_main_machine(static,[]),
1471 b_get_assertions_from_main_machine(dynamic,[]).
1472
1473
1474 %has_label(Label,Expr) :- get_texpr_label(Expr,Label1), format('Labels ~w =? ~w~n',[Label1,Label]), fail.
1475 has_label(Label,Expr) :- get_texpr_label(Expr,Label).
1476
1477 :- public b_get_static_assertions_from_machine_calc/1.
1478 % precompiled: typed assertions (a list of predicates)
1479 b_get_static_assertions_from_machine_calc(Prop) :-
1480 get_section_from_current_machine(assertions,Prop1),
1481 exclude(predicate_uses_variables,Prop1,Prop),!.
1482 b_get_static_assertions_from_machine_calc(Prop) :-
1483 add_error(bmachine,'b_get_static_assertions_from_machine_calc fails'), Prop=[].
1484
1485 :- dynamic b_machine_has_static_assertions/0.
1486 :- public b_machine_has_static_assertions_calc/0.
1487 b_machine_has_static_assertions_calc :-
1488 b_get_static_assertions_from_machine([_|_]).
1489
1490 :- public b_get_unproven_static_assertions_from_machine_calc/1.
1491 b_get_unproven_static_assertions_from_machine_calc(FAssertions) :-
1492 b_get_static_assertions_from_machine(Assertions),
1493 filter_out_proven_assertions(Assertions,FAssertions),!.
1494 b_get_unproven_static_assertions_from_machine_calc(Prop) :-
1495 add_error(bmachine,'b_get_unproven_static_assertions_from_machine_calc fails'), Prop=[].
1496
1497 filter_out_proven_assertions([],[]).
1498 filter_out_proven_assertions([A1|T],R) :-
1499 (is_discharged_assertion(A1)
1500 -> R = TR %, print('Proven: '), translate:print_bexpr(A1),nl
1501 ; R = [A1|TR]),
1502 filter_out_proven_assertions(T,TR).
1503
1504 :- public b_get_dynamic_assertions_from_machine_calc/1.
1505 b_get_dynamic_assertions_from_machine_calc(Prop) :-
1506 get_section_from_current_machine(assertions,Prop1),
1507 include(predicate_uses_variables,Prop1,Prop),!.
1508 b_get_dynamic_assertions_from_machine_calc(Prop) :-
1509 add_error(bmachine,'b_get_dynamic_assertions_from_machine_calc fails'), Prop=[].
1510
1511
1512 :- dynamic b_machine_has_dynamic_assertions/0.
1513 :- public b_machine_has_dynamic_assertions_calc/0.
1514 b_machine_has_dynamic_assertions_calc :-
1515 b_get_dynamic_assertions_from_machine([_|_]).
1516
1517 b_machine_has_assertions :- (b_machine_has_static_assertions -> true ; b_machine_has_dynamic_assertions).
1518
1519 b_machine_has_unproven_assertions :-
1520 b_get_unproven_dynamic_assertions_from_machine([_|_]) -> true
1521 ; b_get_unproven_static_assertions_from_machine([_|_]).
1522
1523
1524 get_all_assertions_from_machine(Assertions) :-
1525 findall(A,((SD=static;SD=dynamic),get_assertions_from_machine(SD,SS),member(A,SS)),Assertions).
1526
1527 get_assertions_from_machine(Type,Assertions) :-
1528 ( Type=(dynamic) ->
1529 (get_preference(use_po,true)
1530 -> b_get_unproven_dynamic_assertions_from_machine(Assertions)
1531 ; b_get_dynamic_assertions_from_machine(Assertions)
1532 )
1533 ; Type=(static) ->
1534 (get_preference(use_po,true)
1535 -> b_get_unproven_static_assertions_from_machine(Assertions)
1536 ; b_get_static_assertions_from_machine(Assertions)
1537 )
1538 ),
1539 Assertions = [_|_].
1540
1541 :- public b_get_unproven_dynamic_assertions_from_machine_calc/1.
1542 b_get_unproven_dynamic_assertions_from_machine_calc(FAssertions) :-
1543 b_get_dynamic_assertions_from_machine(Assertions),
1544 filter_out_proven_assertions(Assertions,FAssertions),!.
1545 b_get_unproven_dynamic_assertions_from_machine_calc(Prop) :-
1546 add_error(bmachine,'b_get_unproven_dynamic_assertions_from_machine_calc fails'), Prop=[].
1547
1548 predicate_uses_variables(Pred) :-
1549 b_get_machine_variables(Vars),
1550 get_texpr_ids(Vars,Ids),
1551 list_to_ord_set(Ids,OrdVars),
1552 find_identifier_uses(Pred,[],UsedVars),
1553 list_to_ord_set(UsedVars,OrdUsedVars),
1554 ord_intersect(OrdVars,OrdUsedVars).
1555
1556 :- public b_get_initialisation_from_machine_calc/2.
1557 % precompiled: typed initialisation (a substitution)
1558 b_get_initialisation_from_machine_calc(Init,OType) :-
1559 get_section_from_current_machine(initialisation,Init),
1560 ( get_texpr_expr(Init,rlevent(_Name,_Section,_Status,Params,_Guard,_Theorems,_Actions,_VWitnesses,_PWitnesses,_Unmod,_AbstractEvents)) ->
1561 get_operation_type(Init,'INITIALISATION',Params,OType)
1562 ;
1563 OType = classic).
1564 % precompiled: operations, Name is in atomic form, Results and Parameters are lists
1565 % of typed identifiers, Body is a typed substitution
1566
1567 :- volatile b_machine_operation_names_in_reverse_order/1.
1568 :- dynamic b_machine_operation_names_in_reverse_order/1.
1569 % a list of operation names in reverse order; this way we can randomize the
1570 % generation of the successor states
1571 precompile_operation_names_in_reverse_order :-
1572 retractall(b_machine_operation_names_in_reverse_order(_)),
1573 ? b_get_machine_operation(Name,_Results,_Parameters,_Body,_OType,_OpPos),
1574 asserta(b_machine_operation_names_in_reverse_order(Name)),
1575 fail.
1576 precompile_operation_names_in_reverse_order.
1577
1578 :- use_module(specfile, [animation_minor_mode/1, classical_b_mode/0]).
1579 :- use_module(extrasrc(b_expression_sharing),[cse_optimize_substitution/2]).
1580 :- public b_get_machine_operation_calc/6.
1581 b_get_machine_operation_calc(Name,Results,Parameters,NewBody,OType,OpPos) :-
1582 %well_def_analyser:get_hyps_for_top_level_operations([],Hyps),
1583 is_ground(Name,NameGround),
1584 get_section_from_current_machine(operation_bodies,Ops),
1585 get_texpr_expr(Op,operation(TId,Results,Parameters,Body)),
1586 get_texpr_id(TId,op(Name)),
1587 ? member(Op,Ops),
1588 % remove choicepoints when name was ground
1589 (NameGround==ground -> !; true),
1590 get_operation_type(Op,Name,Parameters,OType),
1591 (get_texpr_pos(TId,OpPos) -> true ; OpPos = unknown),
1592 ( get_preference(use_common_subexpression_also_for_substitutions,true),
1593 get_preference(use_common_subexpression_elimination,true),
1594 \+ animation_minor_mode(eventb) % CSE_SUBST not yet available for Event-B
1595 -> debug_println(19,applying_cse_to(Name)),
1596 cse_optimize_substitution(Body,OpBody)
1597 ; OpBody = Body),
1598 NewBody=OpBody.
1599
1600 b_get_machine_operation_signature(Name,SignatureStr) :-
1601 b_get_machine_operation_calc(Name,Results,Parameters,_,_,_),
1602 get_texpr_ids(Parameters,PIds),
1603 ajoin_with_sep(PIds,',',Args),
1604 (Results = []
1605 -> ajoin([Name,'(',Args,')'],SignatureStr)
1606 ; get_texpr_ids(Results,RIds),
1607 ajoin_with_sep(RIds,',',Res),
1608 ajoin([Res,'<--',Name,'(',Args,')'],SignatureStr)
1609 ).
1610
1611 %well_def_analyser:transform_machine_operation(Name,Results,Parameters,OpBody,Hyps,[create_not_discharged_msg(message)],NewBody).
1612 get_operation_type([],_Name,_Parameters,classic).
1613 get_operation_type(Op,Name,Parameters,OType) :-
1614 get_texpr_info(Op,Info),
1615 ? ( member(eventb(_),Info) ->
1616 OType=eventb_operation(SortedChangeSet,Ps,OpPattern),
1617 ? member(modifies(ChangeSet),Info),!,
1618 sort(ChangeSet,SortedChangeSet), % maybe not necessary ?
1619 same_length(Parameters,Ps),
1620 OpPattern =.. [Name|Ps]
1621 ;
1622 OType=classic).
1623
1624 :- volatile get_operation_info/2, get_operation_description_template_expr/2.
1625 :- dynamic get_operation_info/2, get_operation_description_template_expr/2.
1626 :- public get_operation_info_calc/2, get_operation_description_template_expr_calc/2.
1627 % precompiled: operation infos
1628 get_operation_info_calc(OpName,Info) :-
1629 get_section_from_current_machine(operation_bodies,Ops),
1630 create_texpr(operation(TId,_Results,_Parameters,_Body),_,Info1,TOp), % rlevent()
1631 get_texpr_id(TId,op(OpName)),
1632 ? member(TOp,Ops),
1633 (get_texpr_description(TOp,Desc) % description_operation
1634 -> Info = [description(Desc)|Info1], debug_format(19,'Operation ~w has description: ~w~n',[OpName,Desc])
1635 ; Info=Info1).
1636
1637 b_get_operation_description(OpName,Desc) :-
1638 get_operation_info(OpName,Infos),
1639 member(description(Desc),Infos).
1640
1641 % get a typed string expression that can compute an operation description (based on vars, paras, ...)
1642 get_operation_description_template_expr_calc(OpName,TemplateStringExpr) :-
1643 get_error_context(Context),
1644 call_cleanup(get_op_desc_template_expr_calc2(OpName,TemplateStringExpr),restore_error_context(Context)).
1645
1646 get_op_desc_template_expr_calc2(OpName,TemplateStringExpr) :-
1647 ? get_operation_info(OpName,Infos),
1648 member(description(Desc),Infos),
1649 (member(description_position(OpPos),Infos)
1650 -> true
1651 ; get_info_pos(Infos,OpPos)
1652 % Unfortunately this is the entire position from beginning of operation to desc label */
1653 ),
1654 atom(Desc),
1655 set_error_context(checking_context('Checking description template for operation: ',OpName)),
1656 transform_string_template(Desc,OpPos,RawTemplateExpr),
1657 %translate:print_raw_bexpr(RawTemplateExpr),nl,
1658 GenerateParseErrors=true,
1659 get_machine_operation_typing_scope(OpName,Scope,[]),
1660 b_type_only(RawTemplateExpr,Scope,Type,TemplateStringExpr,GenerateParseErrors),
1661 (debug_mode(off) -> true
1662 ; format('Template description expression for operation ~w:~n ',[OpName]),
1663 translate:print_bexpr(TemplateStringExpr),nl
1664 ),
1665 (Type=string -> true ; add_internal_error('Not string type:',Type)).
1666
1667
1668 :- public b_top_level_operation_calc/1.
1669 % precompiled: operation names (in atomic form) of top-level operations (promoted operations)
1670 b_top_level_operation_calc(Name) :-
1671 is_ground(Name,NameGround),
1672 get_section_from_current_machine(promoted,Promoted),
1673 get_texpr_id(TId,op(Name)),
1674 ? member(TId,Promoted),
1675 (NameGround==ground -> !; true).
1676 :- public b_get_promoted_machine_operations_calc/1.
1677 b_get_promoted_machine_operations_calc(Ops) :-
1678 get_section_from_current_machine(promoted,Ops).
1679
1680 :- volatile b_top_level_feasible_operation/1.
1681 :- dynamic b_top_level_feasible_operation/1.
1682 :- public b_top_level_feasible_operation_calc/1.
1683 % filter out operations which are commented out statically by using 1=2 or similar in guard
1684 ?b_top_level_feasible_operation_calc(Name) :- b_top_level_operation(Name),
1685 b_get_machine_operation(Name,_,_,Body,_,_Pos),
1686 \+ infeasible_tsubst(Body).
1687 % TO DO: investigate how to link up with cbc feasibility analysis
1688
1689 infeasible_tsubst(b(S,_,_)) :- infeasible_subst(S).
1690 infeasible_subst(precondition(G,_)) :- is_falsity(G).
1691 infeasible_subst(select([b(select_when(G,_),_,_)])) :- is_falsity(G).
1692 infeasible_subst(any(_,G,_)) :- is_falsity(G).
1693
1694 % this succeeds not just for top-level operations
1695 %b_is_operation_name(Name) :- b_get_machine_operation(Name,_,_,_,_,_). is slower
1696 :- public b_is_operation_name_calc/1.
1697 b_is_operation_name_calc(Name) :-
1698 ? b_get_machine_operation(Name,_,_,_,_,_).
1699
1700 b_get_operation_pos(Name,Pos) :-
1701 b_get_machine_operation(Name,_,_,_,_,Pos).
1702
1703 b_get_operation_variant(Name,ConvOrAnt,Variant) :-
1704 ? b_get_machine_operation(Name,_,_,TBody),
1705 get_texpr_expr(TBody,Body),
1706 Body = rlevent(Name,_Section,Status,
1707 _Params,_Guard,_Theorems,_Actions,_VWitnesses,_PWitnesses,_Unmod,_AbstractEvents),
1708 % TO DO: look maybe higher up in refinement hierarchy
1709 get_texpr_expr(Status,S),
1710 functor(S,ConvOrAnt,1),
1711 (ConvOrAnt = convergent ; ConvOrAnt = anticipated),
1712 arg(1,S,Variant).
1713
1714 b_machine_has_operations :-
1715 (b_is_operation_name(_) -> true).
1716 % -----------------------------
1717
1718
1719 % the names of definitions which have a given Prefix,
1720 % Type is expression or predicate, Name is an atomic name
1721 b_definition_prefixed(Type,Prefix,Suffix,Name,Pos) :-
1722 safe_atom_chars(Prefix,PrefixChars,b_definition_prefixed1),
1723 append(PrefixChars,SuffixChars,FullChars),
1724 (ground(Suffix) -> safe_atom_chars(Suffix,SuffixChars,b_definition_prefixed2),
1725 safe_atom_chars(Name,FullChars,b_definition_prefixed3)
1726 ; true),
1727 ? b_get_definition_with_pos(Name,Type,Pos,_,_,_),
1728 safe_atom_chars(Name,FullChars,b_definition_prefixed4),
1729 safe_atom_chars(Suffix,SuffixChars,b_definition_prefixed5).
1730
1731 % TODO: should we also look for theory direct definitions for Event-B models?
1732 % :- use_module(bmachine_eventb,[stored_operator_direct_definition/8]).
1733 % stored_operator_direct_definition(Id,_Proj,_Thy,Parameters,_Def,_WD,_TP,_Kind),
1734 % or add auxiliary definition files for Event-B models
1735
1736
1737 % get definitions in alphabetical order of name:
1738 % predictable order is relevant for SVG_OBJECTS to know which objects are on top of each other
1739 b_sorted_b_definition_prefixed(Type,DEFPREFIX,DefName,DefPos) :-
1740 b_or_z_mode, % fail silently if we are not B/Z/TLA+/Alloy mode as machine not pre-compiled
1741 sorted_list_of_defs(Type,DEFPREFIX,SortedList),
1742 ? member(def(DefName,DefPos),SortedList).
1743 sorted_list_of_defs(Type,DEFPREFIX,SortedList) :-
1744 findall(def(DefName,DefPos),
1745 b_definition_prefixed(Type,DEFPREFIX,_Tail,DefName,DefPos),
1746 List),
1747 sort(List,SortedList).
1748
1749 :- use_module(bmachine_construction,[type_open_formula/8]).
1750 type_check_definitions :-
1751 temporary_set_preference(allow_untyped_identifiers,true_with_string_type,CHNG), % we may not have all identifiers visible
1752 get_error_context(Context),
1753 call_cleanup(type_check_definitions2,restore_error_context(Context)),
1754 reset_temporary_preference(allow_untyped_identifiers,CHNG).
1755 type_check_definitions2 :-
1756 get_preference(type_check_definitions,true),
1757 full_b_machine(Machine),
1758 b_get_definition_with_pos(Name,Type,DefPos,Args,RawExpr,_Deps),
1759 % TO DO: do not re-analyse definitions already analysed for ANIMATION_FUNCTION,...
1760 (Type = predicate ; Type=expression), % can we also allow substitutions ?
1761 debug_format(9,'Type checking DEFINITION ~w~n',[Name]),
1762 set_error_context(checking_context('Type checking DEFINITION: ',Name)),
1763 Scope = [variables], % prob_ids(visible),
1764 %type_with_errors(RawExpr,Scope,_,_TExpr),
1765 AllowNewIds=true,
1766 % TO DO: improve solution below, e.g., delete Args from visible variables or rename Args to fresh ids!
1767 (Args=[] -> RawExpr2=RawExpr
1768 ; Type=predicate -> RawExpr2 = exists(none,Args,conjunct(none,truth(none),RawExpr)) % wrap Args into quantifier, avoid clash with variables,... ; conjunct used to avoid warnings about body of exists
1769 ; RawExpr2=exists(none,Args,equal(none,RawExpr,RawExpr)) % TODO: better solution to avoid duplicating RawExpr
1770 ),
1771 (type_open_formula(RawExpr2,Scope,AllowNewIds,Machine,FType,Identifiers,_TPred,Errors) % maybe no need to run cleanup?
1772 -> Errors = [_|_],
1773 format('Error for DEFINITION ~w of type ~w over identifiers ~w~n',[Name,FType,Identifiers]),
1774 add_all_perrors_in_context_of_used_filenames(Errors,definition_type_error),
1775 fail
1776 % TO DO: check for local clashes?
1777 ; add_error(bmachine,'Type checking DEFINITION failed: ',Name,DefPos)
1778 ),
1779 fail.
1780 type_check_definitions2 :- debug_format(9,'Finished type checking DEFINITIONs~n',[]).
1781
1782 b_get_definition(Name,DefType,Args,RawExpr,Deps) :-
1783 ? b_get_definition_with_pos(Name,DefType,_DefPos,Args,RawExpr,Deps).
1784
1785 :- public portray_defs/0. % debugging utility
1786 portray_defs :-
1787 b_get_definition_with_pos(Name,DefType,DefPos,_Args,_RawExpr,_),
1788 add_message(bmachine,'DEFINITION: ',Name:DefType,DefPos),fail.
1789 portray_defs.
1790
1791 b_get_definition_with_pos(Name,DefType,DefPos,Args,RawExpr,Deps) :- %print(get_def(Name)),nl,
1792 get_section_from_current_machine(definitions,Defs),
1793 ? member(definition_decl(Name,DefType,DefPos,Args,RawExpr,Deps),Defs).
1794 % the next calls get typed definitions without parameters:
1795 % (To treat definitions with parameters one would have to add the parameters to the type environment, see type_check_definitions2)
1796 b_get_typed_predicate_definition(Name,Scope,ResTExpr) :-
1797 ? b_get_definition(Name,predicate,[],RawExpr,_Deps),
1798 type_with_errors_in_context(RawExpr,Scope,_,TExpr,machine_context),
1799 ResTExpr=TExpr. % Do unification after to not prevent generation of type errors.
1800 b_get_typed_expression_definition(Name,Scope,ResTExpr) :-
1801 b_get_definition(Name,expression,[],RawExpr,_Deps),
1802 type_with_errors_in_context(RawExpr,Scope,_,TExpr,machine_context),
1803 ResTExpr=TExpr. % Do unification after to not prevent generation of type errors, e.g., test 1691
1804 b_get_true_expression_definition(Name) :-
1805 b_get_typed_expression_definition(Name,[variables],PF),
1806 PF = b(boolean_true,boolean,_).
1807 %b_get_typed_subst_definition(Name,Scope,Parameters,TExpr) :-
1808 % temporary_set_preference(allow_local_operation_calls,true,CHNG),
1809 % b_get_definition(Name,substitution,Parameters,RawExpr,_Deps),
1810 % type_with_errors(RawExpr,[operation_bodies|Scope],_,TExpr), % need to remove variables to avoid clash warnings
1811 % reset_temporary_preference(allow_local_operation_calls,CHNG).
1812 b_get_typed_definition(Name,Scope,TExpr) :-
1813 ? b_get_definition(Name,_DefType,[],RawExpr,_Deps),
1814 type_with_errors_in_context(RawExpr,Scope,_,TExpr,machine_context).
1815
1816 % the following does not send errors to error_manager:
1817 b_get_typed_definition_with_error_list(Name,Scope,TExpr,ErrorsAndWarnings,Success) :-
1818 ? b_get_definition(Name,_DefType,[],RawExpr,_Deps),
1819 b_type_expression(RawExpr,Scope,_Type,TExpr,ErrorsAndWarnings),
1820 (no_real_perror_occurred(ErrorsAndWarnings) -> Success=true ; Success=false).
1821
1822 type_with_errors(RawExpr,Scope,Type,TExpr) :-
1823 type_with_errors_in_context(RawExpr,Scope,Type,TExpr,not_in_machine_context([])).
1824
1825 type_with_errors_in_context(RawExpr,Scope,Type,TExpr,Context) :- % print(scope(Scope)),nl,
1826 b_type_expression(RawExpr,Scope,Type,TExpr,Errors),!,
1827 (Context=not_in_machine_context(Filenames)
1828 -> add_all_perrors(Errors,Filenames,type_expression_error) % [] for REPL, or JSON file for VisB
1829 ; add_all_perrors_in_context_of_used_filenames(Errors,type_expression_error)
1830 ),
1831 no_real_perror_occurred(Errors). % check that we have no errors, just warnings
1832
1833 % here we do not add perrors; just fail
1834 type_without_errors(RawExpr,Scope,Type,TExpr) :-
1835 b_type_expression(RawExpr,Scope,Type,TExpr,Errors),!,
1836 no_real_perror_occurred(Errors).
1837
1838
1839 b_type_open_predicate_with_errors(OptionalQuantifier,RawPred,Scope,TPred) :-
1840 b_type_open_predicate(OptionalQuantifier,RawPred,Scope,TPred,Errors),
1841 add_all_perrors(Errors,[],type_expression_error),
1842 no_real_perror_occurred(Errors).
1843 b_type_open_predicate(OptionalQuantifier,RawPred,Scope,TPred,Errors) :-
1844 b_type_open_predicate_for_full_b_machine(_Machine,OptionalQuantifier,RawPred,Scope,TPred,Errors).
1845 b_type_open_predicate_for_full_b_machine(Machine,OptionalQuantifier,RawPred,Scope,TPred,Errors) :-
1846 (var(Machine) -> full_b_machine(Machine) ; true),
1847 replace_prob_set_elements_in_scope(Scope,Scope1),
1848 type_open_predicate_with_quantifier(OptionalQuantifier,RawPred,Scope1,Machine,TPred,Errors),!.
1849 b_type_open_exists_predicate(Raw,Typed,Errors) :-
1850 b_type_open_predicate(open(exists),Raw,[prob_ids(visible),variables],Typed,Errors).
1851
1852 b_type_expression(RawExpr,_Scope,Type,TExpr,Errors) :-
1853 b_type_literal(RawExpr,T,TE),!,
1854 Type=T,TExpr=TE,Errors=[].
1855 b_type_expression(RawExpr,Scope,Type,TExpr,Errors) :-
1856 b_type_expression_for_full_b_machine(_,RawExpr,Scope,Type,TExpr,Errors).
1857
1858 % type literals without setting up scope, ...
1859 % TODO: also use for type_in_machine_l
1860 b_type_literal(boolean_false(Pos),boolean,b(boolean_false,boolean,[nodeid(Pos)])).
1861 b_type_literal(boolean_true(Pos),boolean,b(boolean_true,boolean,[nodeid(Pos)])).
1862 b_type_literal(integer(Pos,Int),integer,b(integer(Int),integer,[nodeid(Pos)])).
1863 b_type_literal(real(Pos,R),real,b(real(R),real,[nodeid(Pos)])).
1864 b_type_literal(string(Pos,Atom),string,b(string(Atom),string,[nodeid(Pos)])).
1865
1866
1867 b_type_expression_for_full_b_machine(M,RawExpr,Scope,Type,TExpr,Errors) :-
1868 b_type_expressions_l(M,[RawExpr],Scope,[Type],[TExpr],Errors).
1869
1870 b_type_expressions_l(Machine,RawExprs,Scope,Types,TExprs,Errors) :-
1871 (var(Machine) -> full_b_machine(Machine) ; true),
1872 % in case you type check multiple expressions for a complex machine it is better to extract the machine once
1873 replace_prob_set_elements_in_scope(Scope,Scope1),
1874 % we need this, for example for tcltk_check_state_sequence_from_file, when deferred set elements written by TLC are in the file
1875 ? type_in_machine_l(RawExprs,Scope1,Machine,Types,TExprs,Errors),!.
1876
1877 replace_prob_set_elements_in_scope(Scope,Res) :- var(Scope),!,
1878 add_internal_error('Scope is a variable (use, e.g., [constants,variables,operation_bodies,...]):',replace_prob_set_elements_in_scope(Scope,Res)),
1879 Res=Scope.
1880 replace_prob_set_elements_in_scope(Scope,NewScope) :-
1881 ? ( select(prob_ids(AllOrVisible),Scope,identifier(Ids),NewScope) -> % replaces prob by deferred set element identifiers
1882 % for example if we have SETS PID then we would have PID1,... in Ids unless PID1 is known to be another identifier
1883 b_get_prob_deferred_set_elements(DefIDs,AllOrVisible),
1884 exclude(known_identifier,DefIDs,Ids) % exclude those ids that would clash
1885 % TO DO: add option to translate_identifiers using translate:keyword_to_id_cache
1886 ;
1887 Scope = NewScope).
1888
1889
1890 known_identifier(X) :- get_texpr_id(X,ID),
1891 (bmachine:b_is_constant(ID,_) ;
1892 bmachine:b_is_variable(ID,_)).
1893
1894 % ------------------------
1895
1896 % a generic predicate to find all kinds of identifiers
1897
1898 :- use_module(b_global_sets,[b_global_set/1, is_b_global_constant/3]).
1899 :- use_module(probsrc(kernel_freetypes),[registered_freetype/2, freetype_case_db/3]).
1900 :- use_module(probsrc(bmachine_eventb), [ stored_operator/2]).
1901 %! mode get_machine_identifiers(+Category, -ListOfIdentifiers)
1902 get_machine_identifiers(machines,MN) :-
1903 findall(FID, (b_filenumber(FID,Type,_,_),Type \= def),MN).
1904 get_machine_identifiers(definition_files,DFN) :-
1905 findall(FID, b_filenumber(FID,def,_,_),DFN).
1906 get_machine_identifiers(definitions,DN) :-
1907 findall(DefID,b_get_definition(DefID,_,_,_,_),DN).
1908 get_machine_identifiers(sets,Sets) :-
1909 findall(GS,b_global_set(GS),Sets).
1910 get_machine_identifiers(set_constants,Csts) :-
1911 findall(Cst,is_b_global_constant(_GS,_,Cst),Csts).
1912 get_machine_identifiers(constants,CN) :-
1913 b_get_machine_constants(Constants),
1914 get_texpr_ids(Constants,CN).
1915 get_machine_identifiers(freetypes,FN) :-
1916 findall(FID,((registered_freetype(F,_) ; freetype_case_db(F,_,_)),functor(F,FID,_)),FN).
1917 get_machine_identifiers(operators,FN) :-
1918 findall(Name,stored_operator(Name,_Kind),FN). % we could exclude Kind=datatype_definition, as listed in freetypes?
1919 get_machine_identifiers(variables,VN) :-
1920 b_get_machine_variables(Variables),
1921 get_texpr_ids(Variables,VN).
1922 get_machine_identifiers(operations,Ops) :-
1923 findall(Op,b_top_level_operation(Op),Ops).
1924
1925 get_machine_identifiers_with_pp_type(machines,MN) :-
1926 findall([FID,'Machine'], (b_filenumber(FID,Type,_,_),Type \= def),MN).
1927 get_machine_identifiers_with_pp_type(definition_files,DFN) :-
1928 findall([FID,'Definition file'], b_filenumber(FID,def,_,_),DFN).
1929 get_machine_identifiers_with_pp_type(definitions,DN) :-
1930 findall([DefID,DefType],b_get_definition(DefID,DefType,_,_,_),DN).
1931 get_machine_identifiers_with_pp_type(sets,Sets) :-
1932 findall([GS,GS],b_global_set(GS),Sets).
1933 get_machine_identifiers_with_pp_type(set_constants,Csts) :-
1934 findall([Cst,GS],is_b_global_constant(GS,_,Cst),Csts).
1935 get_machine_identifiers_with_pp_type(constants,CN) :-
1936 b_get_machine_constants(Constants),
1937 maplist(extract_id_and_pp_type,Constants,CN).
1938 %get_machine_identifiers_with_pp_type(freetypes,FN) :-
1939 % findall([FID,FID],((registered_freetype(F,_) ; freetype_case_db(F,_,_)),functor(F,FID,_)),FN).
1940 get_machine_identifiers_with_pp_type(operators,FN) :-
1941 findall([Name,''],stored_operator(Name,_Kind),FN). % we could exclude Kind=datatype_definition, as listed in freetypes?
1942 get_machine_identifiers_with_pp_type(variables,VN) :-
1943 b_get_machine_variables(Variables),
1944 maplist(extract_id_and_pp_type,Variables,VN).
1945 get_machine_identifiers_with_pp_type(operations,Ops) :-
1946 findall([Op,'Operation'],b_top_level_operation(Op),Ops).
1947
1948 :- use_module(bsyntaxtree,[get_texpr_id/2, get_texpr_type/2]).
1949 :- use_module(translate,[pretty_type/2]).
1950 extract_id_and_pp_type(TId,[Id,PPType]) :-
1951 get_texpr_id(TId,Id),
1952 get_texpr_type(TId,Type),
1953 pretty_type(Type,PPType).
1954
1955 :- use_module(b_global_sets,[b_global_deferred_set/1,all_elements_of_type/2]).
1956 :- use_module(input_syntax_tree,[get_raw_position_info/2]).
1957 % try and get source code for an identifier
1958 source_code_for_identifier(ID,constant,Type,OriginStr,OriginTerm,Source) :- b_is_constant(ID),!,
1959 get_constant_type_and_origin(ID,Type,OriginStr,OriginTerm),
1960 findall(Def,get_constant_definition(ID,Def),AllDefs),
1961 (AllDefs=[_|_] -> conjunct_predicates(AllDefs,Source)
1962 ; % try and find other type of predicates defining ID
1963 findall(Pred,get_constant_predicate(ID,Pred),AllPreds),
1964 conjunct_predicates(AllPreds,Source)).
1965 source_code_for_identifier(ID,variable,Type,OriginStr,OriginTerm,Source) :- b_is_variable(ID),!,
1966 get_variable_type_and_origin(ID,Type,OriginStr,OriginTerm),
1967 Source = b(truth,pred,[]). % TO DO: improve
1968 source_code_for_identifier(ID,Kind,Type,OriginStr,OriginTerm,Source) :- b_get_machine_set(ID,TID),!,
1969 (b_global_deferred_set(ID) -> Kind = deferred_set ; Kind = enumerated_set),
1970 Type = set(global(ID)),
1971 all_elements_of_type(ID,All),
1972 translate:translate_span_with_filename(TID,OriginStr), OriginTerm=TID,
1973 Source = b(equal(TID,b(value(All),Type,[])),pred,[]).
1974 source_code_for_identifier(ID,Kind,Type,OriginStr,OriginTerm,Source) :-
1975 global_set_element(ID,GID),!,
1976 (b_global_deferred_set(GID)
1977 -> Kind = deferred_set_element ; Kind = enumerated_set_element),
1978 b_get_machine_set(GID,TGID),
1979 Type = global(ID),
1980 all_elements_of_type(GID,All),
1981 translate:translate_span_with_filename(TGID,OriginStr), OriginTerm=TGID,
1982 Source = b(equal(TGID,b(value(All),set(Type),[])),pred,[]).
1983 source_code_for_identifier(ID,definition,Type,OriginStr,OriginTerm,Source) :-
1984 b_get_definition(ID,DefType,Args,RawExpr,_Deps),!,
1985 Type = DefType,
1986 % Definitions are only present in RAW form
1987 get_raw_position_info(RawExpr,PosInfo),
1988 translate:translate_span_with_filename(PosInfo,OriginStr), % the position info does not always seem to be valid (when coming from DEFINITION FILE) !??! TO DO fix
1989 OriginTerm=PosInfo,
1990 source_code_for_definition(DefType,ID,Args,RawExpr,Source).
1991 source_code_for_identifier(ID,file,Type,OriginStr,OriginTerm,b(string(Source),string,[])) :-
1992 b_filenumber(ID,Kind,_,Filename),
1993 extension_kind(Kind,Type),
1994 !,
1995 ajoin([Type,' ',ID],Source),
1996 OriginTerm =src_position_with_filename(1,0,0,Filename),
1997 OriginStr = Filename.
1998 source_code_for_identifier(ID,Kind,subst,OriginStr,OriginTerm,Source) :-
1999 b_find_operation(ID,Res,TParas,Body,OType),
2000 (OType=classic -> Kind = operation ; Kind=event),
2001 translate:translate_span_with_filename(Body,OriginStr),Body=OriginTerm,
2002 get_texpr_info(Body,Info),
2003 Source=b(operation(b(identifier(ID),subst,[]),Res,TParas,Body),subst,Info).
2004 source_code_for_identifier(ID,assertion,pred,OriginStr,OriginTerm,Assertion) :-
2005 b_get_assertions(all,_,Ass), member(Assertion,Ass),
2006 get_texpr_label(Assertion,ID), OriginTerm = Assertion,
2007 translate:translate_span_with_filename(Assertion,OriginStr).
2008 source_code_for_identifier(ID,invariant,pred,OriginStr,OriginTerm,Invariant) :-
2009 b_get_invariant_from_machine(C), conjunction_to_list(C,L), member(Invariant,L),
2010 get_texpr_label(Invariant,ID), OriginTerm = Invariant,
2011 translate:translate_span_with_filename(Invariant,OriginStr).
2012 % TO DO: look for invariant labels as ids ?
2013
2014 :- use_module(tools,[ split_last/4 ]).
2015 b_find_operation(ID,Res,TParas,Body,OType) :-
2016 b_get_machine_operation(ID,Res,TParas,Body,OType,_Pos).
2017 b_find_operation(ID,Res,TParas,Body,OType) :-
2018 b_get_machine_operation(ID2,Res,TParas,Body,OType,_Pos),
2019 split_last(ID2, '.', _, ID).
2020
2021 extension_kind(mch,'MACHINE').
2022 extension_kind(ref,'REFINEMENT').
2023 extension_kind(def,'DEFINITIONS FILE').
2024 extension_kind(imp,'IMPLEMENTATION').
2025
2026 source_code_for_definition(predicate,ID,_,RawExpr,Source) :-
2027 b_type_open_exists_predicate(RawExpr,Typed,Errors),
2028 (no_real_perror_occurred(Errors) -> true ; debug_println(9,errs(ID,Errors))),
2029 Source=Typed.
2030 source_code_for_definition(expression,ID,Args,RawExpr,Source) :-
2031 % TO DO: add parameters to avoid type errors; but we get Typed anyway
2032 b_type_expression(RawExpr,[prob_ids(visible),variables],Type,Typed,Errors),
2033 (no_real_perror_occurred(Errors) -> true ; debug_println(9,errs(ID,Args,Type,Errors))),
2034 Source=Typed.
2035 % TO DO: treate substitutions
2036 source_code_for_definition(DefType,ID,_Args,_RawExpr,Source) :-
2037 Source=b(identifier(ID),DefType,[]).
2038
2039 :- use_module(b_global_sets,[lookup_global_constant/2,prob_deferred_set_element/4]).
2040 global_set_element(ID,GlobalSetID) :- lookup_global_constant(ID,fd(_,GlobalSetID)).
2041 global_set_element(ID,GlobalSetID) :-
2042 prob_deferred_set_element(GlobalSetID,_Elem,ID,all).
2043
2044 get_constant_span(ID,Span) :-
2045 b_get_machine_constants(Constants),
2046 TID = b(identifier(ID),_,Span),
2047 member(TID,Constants).
2048
2049 get_constant_type_and_origin(ID,Type,OriginStr,OriginTerm) :-
2050 b_get_machine_constants(Constants),
2051 TID = b(identifier(ID),Type,_Infos),
2052 member(TID,Constants),
2053 % we could also use member(origin(Origin),Infos)
2054 translate:translate_span_with_filename(TID,OriginStr), OriginTerm=TID.
2055 get_variable_type_and_origin(ID,Type,OriginStr,OriginTerm) :-
2056 b_get_machine_variables(Vars),
2057 TID = b(identifier(ID),Type,_Infos),
2058 member(TID,Vars),
2059 % we could also use member(origin(Origin),Infos)
2060 translate:translate_span_with_filename(TID,OriginStr), OriginTerm=TID.
2061
2062 get_constant_definition(ID,FullDef) :-
2063 b_get_properties_from_machine(Prop),
2064 EqDef = b(equal(LHS,RHS),pred,_),
2065 member_in_conjunction_cse(FullDef,EqDef,Prop),
2066 (get_texpr_id(LHS,ID) ; get_texpr_id(RHS,ID)).
2067
2068 get_constant_predicate(ID,FullPred) :-
2069 b_get_properties_from_machine(Prop),
2070 member_in_conjunction_cse(FullPred,Pred,Prop),
2071 involves_id(Pred,ID).
2072 involves_id(ID,b(E,_,_)) :- involves_id_aux(E,ID).
2073 involves_id_aux(member(LHS,_),ID) :- get_texpr_id(LHS,ID).
2074 involves_id_aux(subset(LHS,_),ID) :- get_texpr_id(LHS,ID).
2075 involves_id_aux(subset_strict(LHS,_),ID) :- get_texpr_id(LHS,ID).
2076
2077 :- volatile b_get_machine_setscope/2.
2078 :- dynamic b_get_machine_setscope/2.
2079 :- public b_get_machine_setscope_calc/2.
2080 % precompiled: definitions of the form "scope_SET == Expr",
2081 % Set is the name of the Set, TExpr the typed expression
2082 b_get_machine_setscope_calc(Set,TExpr) :-
2083 b_definition_prefixed(expression, scope_, Set, Name,_),
2084 % TO DO: check if it is a SET
2085 b_get_typed_definition(Name,[],TExpr).
2086
2087 % get a specific MAX_OPERATIONS Value for an operation
2088 :- volatile b_get_machine_operation_max/2.
2089 :- dynamic b_get_machine_operation_max/2.
2090 :- public b_get_machine_operation_max_calc/2.
2091 % precompiled: definitions of the form "scope_SET == Expr",
2092 % Set is the name of the Set, TExpr the typed expression
2093 b_get_machine_operation_max_calc(Set,MaxOp) :-
2094 b_definition_prefixed(expression, 'MAX_OPERATIONS_', Set, Name,DefPos),
2095 (b_get_typed_definition(Name,[constants],DEF), % scope=constants allows to use other definitions
2096 DEF=b(integer(MaxOp),integer,_)
2097 % TO DO: check if it is an operation
2098 %, MaxOp >= 0 we now use negative numbers for randomised restart
2099 -> true
2100 ; add_warning(b_get_machine_operation_max_calc,'Definition must specify an integer (negative numbers means using randomised restart) ',Name,DefPos),
2101 fail
2102 ).
2103
2104 :- volatile b_get_machine_goal/1.
2105 :- dynamic b_get_machine_goal/1.
2106 :- public b_get_machine_goal_calc/1.
2107 % precompiled: definition of GOAL, a typed predicate
2108 ?b_get_machine_goal_calc(TPred) :- get_goal(TPred).
2109
2110 b_reset_machine_goal_from_DEFINITIONS :-
2111 get_goal(TPred),
2112 b_set_parsed_typed_machine_goal(TPred).
2113 get_goal(Goal) :-
2114 get_proz_settings(Settings),memberchk(goal(Goal),Settings),!.
2115 get_goal(Goal) :- % print(getting_goal),nl,
2116 get_texpr_type(Goal,pred),
2117 ? b_get_typed_predicate_definition('GOAL',[variables],Goal).
2118
2119 :- volatile b_get_machine_searchscope/1.
2120 :- dynamic b_get_machine_searchscope/1.
2121 :- public b_get_machine_searchscope_calc/1.
2122 % precompiled: definition of SCOPE, a typed predicate
2123 b_get_machine_searchscope_calc(TPred) :-
2124 get_texpr_type(TPred,pred),
2125 b_get_typed_definition('SCOPE',[variables],TPred).
2126
2127 :- volatile b_get_definition_string_from_machine/3.
2128 :- dynamic b_get_definition_string_from_machine/3.
2129 :- public b_get_definition_string_from_machine_calc/3.
2130 % precompiled: string definitions, Name == "String"
2131 b_get_definition_string_from_machine(Name,String) :-
2132 b_get_definition_string_from_machine(Name,_,String).
2133 b_get_definition_string_from_machine_calc(Name,Pos,String) :-
2134 ? b_get_definition(Name,expression,[],string(Pos,Str),_Deps),
2135 get_texpr_expr(TExpr,string(String)),
2136 type_with_errors_in_context(string(Pos,Str),[],_,TExpr,machine_context).
2137
2138 get_animation_image(Nr,S) :-
2139 animation_minor_mode(z),
2140 get_proz_animation_function(_,_,Images),!,
2141 nth1(Nr,Images,S).
2142 get_animation_image(Nr,S) :- number(Nr),!,
2143 number_codes(Nr,TailCodes),
2144 /* ANIMATION_IMG */
2145 atom_codes(Def_Name,[65,78,73,77,65,84,73,79,78,95,73,77,71|TailCodes]),
2146 b_get_definition_string_from_machine(Def_Name,S).
2147 get_animation_image(Nr,S) :-
2148 b_get_definition_string_from_machine(Def_Name,S),
2149 /* ANIMATION_IMG */
2150 atom_codes(Def_Name,[65,78,73,77,65,84,73,79,78,95,73,77,71|TailCodes]),
2151 number_codes(Nr,TailCodes).
2152
2153 :- use_module(error_manager,[extract_file_number_and_name/3]).
2154 :- use_module(specfile,[b_or_z_mode/0]).
2155 get_animation_image_source_file(Nr,File) :- b_or_z_mode,
2156 % get source file where Animation image is defined; relevant for finding images
2157 b_get_definition_string_from_machine(Def_Name,Pos,_),
2158 atom_codes(Def_Name,[65,78,73,77,65,84,73,79,78,95,73,77,71|TailCodes]),
2159 number_codes(Nr,TailCodes),
2160 extract_file_number_and_name(Pos,_,File).
2161
2162 get_proz_animation_function(Function,Default,Images) :-
2163 get_proz_settings(Settings),
2164 memberchk(animation_function(Function,Default,Images),Settings).
2165 get_proz_settings(Settings) :-
2166 machine(_,Sections),memberchk(meta/Meta,Sections),
2167 memberchk(proz_settings(Settings),Meta).
2168
2169
2170 :- volatile b_get_machine_animation_function/2.
2171 :- dynamic b_get_machine_animation_function/2.
2172 :- public b_get_machine_animation_function_calc/2.
2173 :- use_module(tools,[safe_number_codes/2]).
2174 :- use_module(bsyntaxtree,[is_set_type/2]).
2175 % precompiled: definition of ANIMATION_FUNCTION, a typed expression
2176 b_get_machine_animation_function_calc(AFun,Nr) :-
2177 get_proz_animation_function(TFun,Default,_),!,
2178 ( Nr = -1, AFun = Default
2179 ; Nr = 0, TFun \= none, AFun=TFun
2180 ).
2181 b_get_machine_animation_function_calc(TFun,Nr) :-
2182 get_definition_with_nr_suffix("ANIMATION_FUNCTION",Nr,Def_Name),
2183 b_get_typed_expression_definition(Def_Name,[variables],TFun), % only type it afterwards; avoid throwing type errors for other definitions
2184 get_texpr_type(TFun,Type),
2185 (is_set_type(Type,couple(_,_)) -> true
2186 ; add_warning(b_get_machine_animation_function_calc,'Illegal type for ANIMATION_FUNCTION: ',Def_Name:Type,TFun),
2187 fail).
2188
2189
2190 :- volatile b_get_machine_heuristic_function/1.
2191 :- dynamic b_get_machine_heuristic_function/1.
2192 :- public b_get_machine_heuristic_function_calc/1.
2193 b_get_machine_heuristic_function_calc(TFun) :- %print(extracting_heuristic_fun(TFun)),nl,
2194 get_texpr_type(TFun,integer),
2195 b_get_typed_expression_definition('HEURISTIC_FUNCTION',[variables],TFun).
2196
2197 :- volatile b_get_machine_animation_expression/2.
2198 :- dynamic b_get_machine_animation_expression/2.
2199 :- public b_get_machine_animation_expression_calc/2.
2200 b_get_machine_animation_expression_calc(STR,AExpr) :- %print(extracting_heuristic_fun(TFun)),nl,
2201 ? useful_animation_expression(STR),
2202 b_get_typed_expression_definition(STR,[variables],AExpr).
2203 b_get_machine_animation_expression_calc(DefName,AExpr) :-
2204 b_definition_prefixed(_,'ANIMATION_EXPRESSION',_,DefName,_DefPos),
2205 b_get_typed_expression_definition(DefName,[variables],AExpr).
2206
2207 %useful_animation_expression('ANIMATION_EXPRESSION'). % for state viewer
2208 useful_animation_expression('GAME_PLAYER'). % for MCTS, should return "min" or "max"
2209 useful_animation_expression('GAME_OVER').
2210 useful_animation_expression('GAME_VALUE').
2211 useful_animation_expression('GAME_MCTS_RUNS').
2212 useful_animation_expression('GAME_MCTS_TIMEOUT').
2213 useful_animation_expression('GAME_MCTS_CACHE_LAST_TREE').
2214
2215
2216 % Custom nodes and edges for a custom graph representation of a state
2217 :- volatile b_get_machine_custom_nodes_function/2, b_get_machine_custom_edges_function/2,
2218 b_get_machine_custom_graph_function/2.
2219 :- dynamic b_get_machine_custom_nodes_function/2, b_get_machine_custom_edges_function/2,
2220 b_get_machine_custom_graph_function/2.
2221 :- public b_get_machine_custom_nodes_function_calc/2.
2222 b_get_machine_custom_nodes_function_calc(TFun,Nr) :-
2223 get_definition_with_nr_suffix("CUSTOM_GRAPH_NODES",Nr,Def_Name),
2224 b_get_typed_expression_definition(Def_Name,[variables],TFun).
2225 :- public b_get_machine_custom_edges_function_calc/2.
2226 b_get_machine_custom_edges_function_calc(TFun,Nr) :-
2227 get_definition_with_nr_suffix("CUSTOM_GRAPH_EDGES",Nr,Def_Name),
2228 b_get_typed_expression_definition(Def_Name,[variables],TFun).
2229 :- public b_get_machine_custom_graph_function_calc/2.
2230 b_get_machine_custom_graph_function_calc(TFun,Nr) :-
2231 get_definition_with_nr_suffix("CUSTOM_GRAPH",Nr,Def_Name), % single function for graph attributes, possibly edges and nodes
2232 b_get_typed_expression_definition(Def_Name,[variables],TFun).
2233
2234
2235 get_definition_with_nr_suffix(Prefix,Nr,Def_Name) :-
2236 ? b_get_definition(Def_Name,expression,[],_RawExpr,_Deps),
2237 atom_codes(Def_Name,AC),
2238 append(Prefix,TailCodes,AC),
2239 (TailCodes=[] -> Nr=0
2240 ; TailCodes = "_DEFAULT" -> Nr = -1
2241 ; safe_number_codes(Nr,TailCodes)).
2242
2243
2244 % ------------------------
2245
2246 :- volatile b_get_constant_represented_inside_global_set/2.
2247 :- dynamic b_get_constant_represented_inside_global_set/2.
2248
2249 :- public b_get_constant_represented_inside_global_set_calc/2.
2250 b_get_constant_represented_inside_global_set_calc(X,GlobalSetName) :-
2251 b_get_disjoint_constants_of_type(GlobalSetName, DisjointConstants,_),
2252 ? member(X,DisjointConstants). /* X will be integrated into the global_set */
2253
2254
2255 :- volatile b_get_disjoint_constants_of_type/3.
2256 :- dynamic b_get_disjoint_constants_of_type/3.
2257 :- public b_get_disjoint_constants_of_type_calc/3.
2258 b_get_disjoint_constants_of_type_calc(GlobalSetName, DisjointConstants, AllConstantsIDs) :-
2259 b_get_machine_all_constants(Constants), /* get all the constants */
2260 b_get_properties_from_machine(Properties),
2261 ? b_get_machine_set(GlobalSetName),
2262 \+ b_get_named_machine_set(GlobalSetName,_), % not an explicitly enumerated set
2263 find_constants_of_type(Constants,GlobalSetName,AllConstantsIDs,_GSConstants),
2264 find_inequal_global_set_identifiers(AllConstantsIDs,global(GlobalSetName),Properties,DisjointConstants),
2265 DisjointConstants \= [],
2266 debug_println(9,disjoint_enumerated_constants(GlobalSetName,DisjointConstants)).
2267 % TO DO: remove from Properties irrelevant conjuncts; sort AllConstantsIDs by having first those with max disequalities
2268
2269 find_constants_of_type([],_GS,[],[]) :- !.
2270 find_constants_of_type([b(identifier(ID),global(GS),INFO)|T], GS, [ID|IT],
2271 [b(identifier(ID),global(GS),INFO)|TT]) :- !,
2272 find_constants_of_type(T,GS,IT,TT).
2273 find_constants_of_type([b(_,_,_)|T], GS, IT, TT) :- !,
2274 find_constants_of_type(T,GS,IT,TT).
2275 find_constants_of_type(X,GS,_,_) :- print(find_constants_of_type_error(X,GS)),nl,fail.
2276
2277
2278 % ------------------------
2279 :- volatile b_get_all_used_identifiers_in_section/2.
2280 :- dynamic b_get_all_used_identifiers_in_section/2.
2281 :- public b_get_all_used_identifiers_in_section_calc/2.
2282
2283 % Note: may contain var$0 instead of var for becomes_such
2284 b_get_all_used_identifiers_in_section_calc(SECTION,Identifiers) :-
2285 full_b_machine(BMachine),
2286 ? member(SECTION,[constraints,properties,invariant,assertions,
2287 initialisation,operation_bodies]),
2288 findall(I, find_used_identifier_in_machine_section(BMachine,SECTION,I), Ids),
2289 %print(section_ids(SECTION,Ids)),nl,
2290 sort(Ids,Identifiers).
2291
2292 :- volatile b_get_all_used_identifiers/1.
2293 :- dynamic b_get_all_used_identifiers/1.
2294 :- public b_get_all_used_identifiers_calc/1.
2295 :- use_module(library(ordsets),[ord_union/2]).
2296 % Precompiled: b_get_all_used_identifiers_calc/1 returns a list of all
2297 % identifiers used in machine sections that contain expressions and predicates
2298 b_get_all_used_identifiers_calc(Identifiers) :-
2299 findall(I, b_get_all_used_identifiers_in_section(_,I), ListOfList),
2300 ord_union(ListOfList,Identifiers). % ,print(all(Identifiers)),nl.
2301
2302 find_used_identifier_in_machine_section(Machine,Sec,Identifier) :-
2303 % treat it like a list of expressions
2304 ? get_section_texprs(Sec,Machine,TExprs),
2305 % and find all identifiers in each expression
2306 ? member(TExpr,TExprs),
2307 find_identifier_uses(TExpr,[],Ids),
2308 ? member(Identifier,Ids).
2309
2310 :- volatile b_is_unused_constant/1.
2311 :- dynamic b_is_unused_constant/1.
2312 :- public b_is_unused_constant_calc/1.
2313 b_is_unused_constant_calc(UnusedConstant) :-
2314 findall(C,b_is_constant(C),CL), %b_get_machine_constants(Constants), gives typed ids
2315 CL\=[] ,sort(CL,Constants),
2316 b_get_all_used_identifiers_in_section(invariant,I1),
2317 b_get_all_used_identifiers_in_section(assertions,I2),
2318 b_get_all_used_identifiers_in_section(initialisation,I3),
2319 b_get_all_used_identifiers_in_section(operation_bodies,I4),
2320 % TODO: get constants used in VisB definitions
2321 ord_union([I1,I2,I3,I4],UsedIds),
2322 %print(used(UsedIds)),nl,
2323 ord_subtract(Constants,UsedIds,UnusedConstants),
2324 UnusedConstants\=[],
2325 (b_get_machine_variables([]) -> true
2326 ; length(UnusedConstants,NrUC),
2327 (silent_mode(on) -> true
2328 ; (NrUC>10,debug_mode(off),UnusedConstants=[C1,C2|_]) ->
2329 print_message_with_max_depth(unused_constants(NrUC,[C1,C2,'...']),500)
2330 ; print_message_with_max_depth(unused_constants(NrUC,UnusedConstants),500))
2331 ),
2332 ? member(UnusedConstant,UnusedConstants).
2333
2334
2335 % precompiled: Skel is the operation skeleton, SpecializedInv a typed predicate
2336 % (Skel,SpecializedInv) :-
2337 % b_get_machine_operation(Name,_Res,Params,_Body),
2338 % atom_concat('SIMPLIFIED_INV_OP_',Name,ASNC),
2339 % b_get_typed_definition(ASNC,[variables,identifiers(Params)],SpecializedInv),
2340 % length(Params,Len),
2341 % functor(Skel,Name,Len),
2342 % print(b_specialized_invariant_for_op(Skel)).
2343
2344
2345 get_section_from_current_machine(Section,Content) :-
2346 full_b_machine(BMachine),
2347 get_section(Section,BMachine,Content).
2348
2349 is_ground(X,R) :- ground(X),!,R=ground.
2350 is_ground(_,nonground).
2351
2352 b_set_empty_machine :- debug_println(9,setting_empty_machine),
2353 empty_machine(Main,Machines),
2354 b_set_machine(Main,Machines,[]).
2355
2356 b_get_machine_refinement_hierarchy(Hierarchy) :-
2357 \+ machine(_Name,_M),!,Hierarchy=[]. %No B Machine loaded
2358 b_get_machine_refinement_hierarchy(Hierarchy) :-
2359 get_section_from_current_machine(meta,Infos),
2360 member(hierarchy/Hierarchy,Infos),!.
2361
2362 b_get_refined_machine_name(Machine) :-
2363 b_get_machine_refinement_hierarchy([_Main,Machine|_Rest]).
2364 b_get_refined_ancestors_names(list(AncestorList)) :-
2365 b_get_machine_refinement_hierarchy([_Main|AncestorList]).
2366 b_get_refined_machine(M) :-
2367 get_section_from_current_machine(meta,Infos),
2368 member(refined_machine/M,Infos), !.
2369
2370
2371
2372 b_get_machine_header_position(MachName,Position) :-
2373 get_section_from_current_machine(meta,Infos),
2374 member(header_pos/HeaderPosList,Infos),
2375 % List with elements MachineName/PositionOfMachineHeader
2376 member(MachName/Position,HeaderPosList).
2377
2378 % model type can be system for Atelier-B Event-B
2379 b_get_model_type(M) :-
2380 get_section_from_current_machine(meta,Infos),
2381 member(model_type/M,Infos), !.
2382
2383 % TODO(DP,6.8.2008)
2384 :- volatile b_machine_temp_predicate/1.
2385 :- dynamic b_machine_temp_predicate/1.
2386
2387 %set_temp_predicate(CustomPredicate) :-
2388 % b_parse_machine_predicate(CustomPredicate,TypedPred),
2389 % assert_temp_typed_predicate(TypedPred).
2390 %
2391 %% set a temporary predicate as additional guard
2392 %set_temp_predicate(CustomPredicate,'$initialise_machine') :- !,set_temp_predicate(CustomPredicate).
2393 %set_temp_predicate(CustomPredicate,'$setup_constants') :- !,set_temp_predicate(CustomPredicate).
2394 %set_temp_predicate(CustomPredicate,OpName) :-
2395 % b_parse_machine_operation_pre_post_predicate(CustomPredicate,TypedPred, OpName,true),
2396 % assert_temp_typed_predicate(TypedPred).
2397
2398 % Note: it can be a good idea to use inline_prob_deferred_set_elements_into_bexpr/2 before:
2399 assert_temp_typed_predicate(TypedPred) :-
2400 reset_temp_predicate,
2401 assertz(b_machine_temp_predicate(TypedPred)).
2402
2403
2404 reset_temp_predicate :- retractall(b_machine_temp_predicate(_)).
2405
2406 :- volatile b_machine_additional_property/1.
2407 :- dynamic b_machine_additional_property/1.
2408
2409 % additional properties for set_up_constants
2410 % TO DO: check if there are constants/properties; otherwise raise warning
2411 add_additional_property(CustomPredicate,Description) :-
2412 format('Adding Property: ~w~n',[CustomPredicate]),
2413 b_parse_machine_predicate(CustomPredicate,TypedPred),
2414 add_texpr_info_if_new(TypedPred,description(Description),TP2),
2415 assertz(b_machine_additional_property(TP2)).
2416
2417 :- use_module(btypechecker, [unify_types_strict/2]).
2418 :- use_module(bsyntaxtree, [safe_create_texpr/4]).
2419 :- use_module(probsrc(translate), [pretty_type/2]).
2420
2421 :- public b_extract_values_clause_assignment_calc/3.
2422 b_extract_values_clause_assignment_calc(ID,Type,TVal) :-
2423 % extract equalities from VALUES clause
2424 get_section_from_current_machine(values,Values),
2425 member(b(values_entry(TID,TVal),_,Info),Values),
2426 get_texpr_id(TID,ID),
2427 get_texpr_type(TID,Type),
2428 debug_println(20,values_entry(ID,Type,TVal)),
2429 (b_is_constant(ID,OtherType),
2430 unify_types_strict(Type,OtherType)
2431 -> (member(description(_),Info) -> Info1=Info
2432 ; Info1=[description('from VALUES clause') | Info]),
2433 safe_create_texpr(equal(TID,TVal),pred,Info1,Equality),
2434 (debug_mode(off) -> true ; add_message(bmachine,'Adding property for VALUES: ',Equality,Equality)),
2435 assertz(b_machine_additional_property(Equality)),
2436 (b_extract_values_clause_assignment(ID,_,_)
2437 -> add_error(bmachine,'Multiple VALUES entries for constant: ',ID,TID)
2438 ; true)
2439 ; b_get_machine_set(ID) -> true % will be dealt with in b_global_sets for deferred sets
2440 ; b_get_constant_represented_inside_global_set(ID,_) ->
2441 add_message(bmachine,'Ignoring VALUES entry for constant (already detected as enumerated set element): ',ID,TID)
2442 ; lookup_global_constant(ID,fd(_,GSET)) ->
2443 ajoin(['Ignoring VALUES entry for element of enumerated set ',GSET,': '],Msg),
2444 add_message(bmachine,Msg,ID,TID)
2445 % TODO: detect case when this is a deferred set element not detected as (virtual) enumerated element
2446 ; b_is_constant(ID,OtherType) -> pretty_type(OtherType,OT), pretty_type(Type,TT),
2447 ajoin(['Cannot adapt value type ',TT,' to abstract type ',OT,', ignoring VALUES entry for: '],Msg),
2448 add_warning(bmachine,Msg,ID,TID)
2449 ; add_error(bmachine,'VALUES clause for unknown constant: ',ID,TID),
2450 fail
2451 ).
2452
2453
2454 % -------------------
2455
2456 :- use_module(specfile,[unset_animation_minor_modes/1,reset_animation_minor_modes/1]).
2457 :- use_module(translate,[set_unicode_mode/0, unset_unicode_mode/0, set_print_type_infos/1]).
2458 b_show_machine_representation_unicode(Rep,AdditionalInfo,UnsetMinorModes,Unicode) :-
2459 Unicode=true,!,
2460 set_unicode_mode,
2461 call_cleanup(b_show_machine_representation(Rep,AdditionalInfo,UnsetMinorModes,none),unset_unicode_mode).
2462 b_show_machine_representation_unicode(Rep,AdditionalInfo,UnsetMinorModes,_) :-
2463 b_show_machine_representation(Rep,AdditionalInfo,UnsetMinorModes,none).
2464
2465
2466 % AdditionalInfo=true means show additional information as comments (promoted, ...)
2467 % UnsetMinorModes will print in default classical B style
2468 % TypeInfos: none, needed or all
2469 b_show_machine_representation(Rep,AdditionalInfo,UnsetMinorModes,TypeInfos) :-
2470 full_b_machine(BMachine),
2471 (UnsetMinorModes==true -> unset_animation_minor_modes(L) ; L=[]),
2472 set_print_type_infos(TypeInfos),
2473 translate_machine(BMachine,Rep,AdditionalInfo),
2474 set_print_type_infos(none),
2475 (UnsetMinorModes==true -> reset_animation_minor_modes(L) ; true).
2476
2477 :- use_module(tools_printing,[nested_write_term_to_codes/2]).
2478 b_get_internal_prolog_representation_as_codes(Codes) :-
2479 full_b_machine(BMachine),
2480 nested_write_term_to_codes(BMachine,Codes).
2481
2482 :- use_module(tools,[get_tail_filename/2,split_filename/3,safe_atom_chars/3]).
2483 % TypingLevel = none, needed or all
2484 b_write_machine_representation_to_file(TypingLevel,PPFILE) :-
2485 b_write_machine_representation_to_file('$auto',TypingLevel,PPFILE).
2486 b_write_machine_representation_to_file('$auto',TypingLevel,PPFILE) :- !, % automatically infer machine name
2487 %get_full_b_machine(Name,M),
2488 get_tail_filename(PPFILE,Tail),
2489 split_filename(Tail,MachName,_Ext),
2490 b_write_machine_representation_to_file3(MachName,TypingLevel,PPFILE).
2491 b_write_machine_representation_to_file(MachName,TypingLevel,PPFILE) :-
2492 % provide explicit machine name; useful for diff checks
2493 b_write_machine_representation_to_file3(MachName,TypingLevel,PPFILE).
2494
2495 :- use_module(translate,[set_print_type_infos/1]).
2496 :- use_module(tools_files, [write_to_utf8_file_or_user_output/2]).
2497 b_write_machine_representation_to_file3(MachName,Level,PPFILE) :-
2498 debug_println(20,'% Pretty-Printing Internal Representation to File: '),
2499 debug_println(20,PPFILE),
2500 translate:set_print_type_infos(Level), % none, needed or all
2501 get_full_b_machine(_Name,M),
2502 (translate_machine_to_classicalb(MachName,M,Rep)
2503 -> translate:set_print_type_infos(none)
2504 ; add_internal_error('Translating machine failed: ',b_write_machine_representation_to_file3(MachName,Level,PPFILE)),
2505 set_print_type_infos(none),
2506 fail),
2507 write_to_utf8_file_or_user_output(PPFILE,Rep).
2508
2509 :- use_module(specfile).
2510 translate_machine_to_classicalb(MachName,M,Rep) :-
2511 temporary_set_preference(expand_avl_upto,-1,CHNG), % avoid printing sets using condensed #
2512 (animation_minor_mode(X)
2513 -> remove_animation_minor_mode,
2514 call_cleanup(translate_machine(machine(MachName,M),Rep,false), set_animation_minor_mode(X))
2515 ; translate_machine(machine(MachName,M),Rep,false)),
2516 reset_temporary_preference(expand_avl_upto,CHNG).
2517
2518 b_write_eventb_machine_to_classicalb_to_file(PPFILE) :-
2519 get_tail_filename(PPFILE,Tail),
2520 split_filename(Tail,MachName,_Ext),
2521 b_show_eventb_as_classicalb1(MachName,Rep,_AdditionalInfo),
2522 write_to_utf8_file_or_user_output(PPFILE,Rep).
2523
2524 :- use_module(preferences,[temporary_set_preference/3,reset_temporary_preference/2]).
2525 b_show_eventb_as_classicalb1(MachName,Rep,AdditionalInfo) :-
2526 full_b_machine(machine(_Name,MachineBody)),
2527 % limit abstract level to 0
2528 b_limit_abstract_level_to_zero(MachineBody,MachineBodyLevel0),
2529 temporary_set_preference(translate_print_typing_infos,true,CHNG),
2530 temporary_set_preference(translate_ids_to_parseable_format,true,CHNG2),
2531 temporary_set_preference(expand_avl_upto,-1,CHNG3), % avoid printing sets using condensed #
2532 (translate_eventb_to_classicalb(machine(MachName,MachineBodyLevel0),AdditionalInfo,Rep)
2533 -> reset_temporary_preference(translate_print_typing_infos,CHNG),
2534 reset_temporary_preference(translate_ids_to_parseable_format,CHNG2),
2535 reset_temporary_preference(expand_avl_upto,CHNG3)
2536 ; add_internal_error('Translating Event-B machine to Classical B failed: ',b_show_eventb_as_classicalb1(MachName,Rep,AdditionalInfo)),
2537 reset_temporary_preference(translate_print_typing_infos,CHNG),
2538 reset_temporary_preference(translate_ids_to_parseable_format,CHNG2),
2539 reset_temporary_preference(expand_avl_upto,CHNG3),
2540 fail).
2541
2542 b_limit_abstract_level_to_zero(MachineBody,MachineBodyLevel0) :-
2543 maplist(b_set_to_level_zero,MachineBody,MachineBodyLevel0).
2544
2545 % TODO: set to level zero also the other events of the Event-B machine
2546 b_set_to_level_zero(initialisation/InitEvent,initialisation/InitEventLevelZero) :-
2547 get_texpr_expr(InitEvent,rlevent(Id,Sec,St,Par,Grd,Thms,Act,VW,PW,Ums,_Abs)),
2548 get_texpr_info(InitEvent,Info),
2549 create_texpr(rlevent(Id,Sec,St,Par,Grd,Thms,Act,VW,PW,Ums,[]),subst,Info,InitEventLevelZero).
2550 b_set_to_level_zero(X,X).
2551
2552 b_show_eventb_as_classicalb(Rep,AdditionalInfo) :-
2553 full_b_machine(BMachine),
2554 translate_eventb_to_classicalb(BMachine,AdditionalInfo,Rep).
2555
2556 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2557
2558 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2559 % precompilation: predicates are precompiled by calling the ..._calc predicate
2560
2561 :- use_module(state_packing).
2562 :- use_module(tools,[start_ms_timer/1,stop_ms_walltimer_with_msg/2]).
2563 % maybe this predicate should be directly called by b_load_machine
2564 b_machine_precompile :- debug_println(9,'Precompiling B Machine'),
2565 start_ms_timer(T1),
2566 get_full_b_machine(_,_),
2567 auto_precompile,
2568 (debug_mode(on) -> stop_ms_walltimer_with_msg(T1,'auto_precompile: ') ; true),
2569 precompile_operation_names_in_reverse_order,
2570 % TODO(DP, 14.8.2008): remove reference to b_global_sets
2571 start_ms_timer(T2),
2572 b_check_and_precompile_deferred_sets,
2573 (debug_mode(on) -> stop_ms_walltimer_with_msg(T2,'precompiling global sets: ') ; true),
2574 % Now done in bmachine_construction:clean_up_machine but not yet for Event-B:
2575 get_section_from_current_machine(freetypes,Freetypes),register_freetypes(Freetypes),
2576 auto_precompile_phase2,
2577 b_check_and_precompile_global_set_symmetry,
2578 state_packing:precompile_state_packing,
2579 do_machine_consistency_check,
2580 try_kodkod,
2581 (debug_mode(on) -> stop_ms_walltimer_with_msg(T1,'complete precompiling B machine: ') ; true).
2582
2583
2584
2585 other_spec_precompile :- retractall(bmachine_is_precompiled),
2586 /* call if you do not animate a B specification */
2587 is_precompiled_predicate(Pred/Arity),
2588 functor(Pattern,Pred,Arity),
2589 retractall(Pattern),
2590 (precompiled_predicate_no_error_when_not_precompiled(Pred/Arity)
2591 -> assertz( (Pattern :- fail ))
2592 ; assertz( (Pattern :- print_message('No B machine available for '),print_message(Pattern),fail) )
2593 ),
2594 fail.
2595 other_spec_precompile :-
2596 retractall(b_get_machine_constants(_)),
2597 assertz( b_get_machine_constants([]) ),
2598 retractall(b_get_machine_variables_in_original_order(_)),
2599 assertz( b_get_machine_variables_in_original_order([]) ),
2600 retractall(b_get_machine_variables(_)),
2601 assertz( b_get_machine_variables([]) ),
2602 retractall(b_get_static_assertions_from_machine(_)),
2603 assertz( b_get_static_assertions_from_machine([]) ),
2604 retractall(b_machine_has_static_assertions),
2605 retractall(b_get_unproven_static_assertions_from_machine(_)),
2606 assertz( b_get_unproven_static_assertions_from_machine([]) ),
2607 retractall(b_get_dynamic_assertions_from_machine(_)),
2608 assertz( b_get_dynamic_assertions_from_machine([]) ),
2609 retractall(b_machine_has_dynamic_assertions),
2610 retractall(b_get_unproven_dynamic_assertions_from_machine(_)),
2611 assertz( b_get_unproven_dynamic_assertions_from_machine([]) ),
2612 retractall( b_get_machine_searchscope(_) ),
2613 retractall( b_get_machine_goal(_) ),
2614 assert_bmachine_is_precompiled, debug_println(4,other_spec_precompile).
2615
2616 ?is_precompiled_predicate(P) :- precompiled_predicate(P).
2617 ?is_precompiled_predicate(P) :- precompiled_predicate_phase2(P).
2618
2619 % phase 1 precompilation: required by b_global_sets
2620 precompiled_predicate(b_machine_name/1).
2621 precompiled_predicate(b_get_named_machine_set/3).
2622 precompiled_predicate(b_enumerated_sets_precompiled/0).
2623 precompiled_predicate(b_get_properties_from_machine/1).
2624 precompiled_predicate(b_get_machine_all_constants/1).
2625 precompiled_predicate(b_get_machine_set/2).
2626 precompiled_predicate(b_get_disjoint_constants_of_type/3).
2627 precompiled_predicate(b_get_constant_represented_inside_global_set/2).
2628 precompiled_predicate(b_get_machine_constants/1).
2629 precompiled_predicate(b_get_machine_variables_in_original_order/1).
2630 precompiled_predicate(b_get_machine_variables/1).
2631 precompiled_predicate(b_get_invariant_from_machine/1).
2632 precompiled_predicate(b_get_linking_invariant_from_machine/1).
2633 precompiled_predicate(b_is_constant/2).
2634 precompiled_predicate(b_is_variable/2).
2635 precompiled_predicate(b_get_constant_variable_description/2).
2636 precompiled_predicate(b_get_static_assertions_from_machine/1).
2637 precompiled_predicate(b_machine_has_static_assertions/0).
2638 precompiled_predicate(b_get_unproven_static_assertions_from_machine/1).
2639 precompiled_predicate(b_get_dynamic_assertions_from_machine/1).
2640 precompiled_predicate(b_machine_has_dynamic_assertions/0).
2641 precompiled_predicate(b_get_unproven_dynamic_assertions_from_machine/1).
2642 precompiled_predicate(b_get_assertions_from_main_machine/2).
2643 precompiled_predicate(b_get_initialisation_from_machine/2).
2644 precompiled_predicate(b_get_machine_operation/6).
2645 precompiled_predicate(b_top_level_operation/1).
2646 precompiled_predicate(b_is_operation_name/1).
2647 precompiled_predicate(b_top_level_feasible_operation/1).
2648 precompiled_predicate(b_get_promoted_machine_operations/1).
2649 precompiled_predicate(get_operation_info/2).
2650 precompiled_predicate(b_get_machine_operation_for_animation/7).
2651 precompiled_predicate(get_operation_description_template_expr/2).
2652 precompiled_predicate(b_get_machine_goal/1).
2653 precompiled_predicate(b_get_machine_setscope/2).
2654 precompiled_predicate(b_get_machine_operation_max/2).
2655 precompiled_predicate(b_get_machine_searchscope/1).
2656 precompiled_predicate(b_get_definition_string_from_machine/3).
2657 precompiled_predicate(b_get_machine_animation_function/2).
2658 precompiled_predicate(b_get_machine_heuristic_function/1).
2659 precompiled_predicate(b_get_machine_animation_expression/2).
2660 precompiled_predicate(b_get_machine_custom_nodes_function/2).
2661 precompiled_predicate(b_get_machine_custom_edges_function/2).
2662 precompiled_predicate(b_get_machine_custom_graph_function/2).
2663 precompiled_predicate(complete_discharged_info/0). % just call it before calling b_specialized_invariant_for_op_calc !
2664 precompiled_predicate(get_proven_invariant/2).
2665 precompiled_predicate(b_nth1_invariant/3).
2666 precompiled_predicate(b_invariant_number_list/1).
2667 precompiled_predicate(b_specialized_invariant_mask_for_op/2).
2668 precompiled_predicate(b_specialized_invariant_for_op/2).
2669 precompiled_predicate(b_operation_preserves_invariant/2).
2670 precompiled_predicate(b_get_all_used_identifiers_in_section/2).
2671 precompiled_predicate(b_get_all_used_identifiers/1).
2672 precompiled_predicate(b_is_unused_constant/1).
2673 precompiled_predicate(b_extract_values_clause_assignment/3). % depends on b_is_constant/1
2674 precompiled_predicate(b_machine_statistics/2).
2675
2676 % require b_global_sets to be initialised
2677 precompiled_predicate_phase2(b_get_operation_normalized_read_write_info/3).
2678 precompiled_predicate_phase2(b_get_operation_unchanged_variables/2).
2679 precompiled_predicate_phase2(b_operation_cannot_modify_state/1).
2680 precompiled_predicate_phase2(b_operation_reads_output_variables/3).
2681 precompiled_predicate_phase2(b_get_operation_non_det_modifies/2).
2682
2683 % these functions sometimes get called also in csp mode; simply fail silently for those cases in other_spec_precompile
2684 precompiled_predicate_no_error_when_not_precompiled(b_get_machine_animation_function/2).
2685 precompiled_predicate_no_error_when_not_precompiled(b_get_machine_heuristic_function/1).
2686 precompiled_predicate_no_error_when_not_precompiled(b_get_machine_animation_expression/2).
2687 precompiled_predicate_no_error_when_not_precompiled(b_get_machine_custom_nodes_function/2).
2688 precompiled_predicate_no_error_when_not_precompiled(b_get_machine_custom_edges_function/2).
2689 precompiled_predicate_no_error_when_not_precompiled(b_get_machine_custom_graph_function/2).
2690
2691 % on startup, all precompiled predicates yield error message
2692 startup_precompiled :- retractall(bmachine_is_precompiled),
2693 ? is_precompiled_predicate(Pred/Arity),
2694 functor(Pattern,Pred,Arity),
2695 retractall(Pattern),
2696 assertz( (Pattern :- add_error(bmachine,'B machine not precompiled for ',Pattern),fail) ),
2697 fail.
2698 startup_precompiled :- debug_println(4,startup_precompiled).
2699
2700 :- startup_precompiled.
2701
2702 % for each predicate in "precompiled_predicate", auto_precompile computes
2703 % all solutions by calling the predicate with an appended _calc
2704 auto_precompile :- % startup_precompiled,
2705 % failure-driven loop
2706 ? precompiled_predicate(Pred/Arity), %print(precompile(Pred/Arity)),nl,
2707 %statistics(walltime,[Tot,Delta]), format('Precompiling ~w/~w [~w ms (Delta ~w) ms]~n',[Pred,Arity,Tot,Delta]),
2708 ? auto_precompile2(Pred,Arity,Pattern),
2709 (Pattern -> true /* this pattern already asserted */
2710 ; assertz(Pattern)), fail.
2711 auto_precompile :-
2712 assert_bmachine_is_precompiled, debug_println(4,auto_precompile).
2713 auto_precompile_phase2 :-
2714 % failure-driven loop
2715 ? precompiled_predicate_phase2(Pred/Arity), %print(precompile(Pred/Arity)),nl,
2716 ? auto_precompile2(Pred,Arity,Pattern),
2717 (Pattern -> true /* this pattern already asserted */
2718 ; assertz(Pattern)), fail.
2719 auto_precompile_phase2.
2720
2721 % if the precompiled predicates is e.g. foo/2 then
2722 % Pattern=foo(A,B) and Call=foo_calc(A,B)
2723 auto_precompile2(Pred,Arity,Pattern) :-
2724 atom_concat(Pred,'_calc',CallFunctor),
2725 functor(Pattern,Pred,Arity),
2726 functor(Call,CallFunctor,Arity),
2727 unify_args(Arity,Call,Pattern),
2728 retractall(Pattern), % probably just removes clause added by startup_precompiled
2729 % the failure-driven loop for one predicate
2730 ? call(Call).
2731
2732 unify_args(0,_,_) :- !.
2733 unify_args(N,A,B) :-
2734 arg(N,A,Arg), arg(N,B,Arg),
2735 N1 is N-1, unify_args(N1,A,B).
2736
2737
2738 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2739 % set machine goal
2740
2741 b_set_machine_goal(Goal) :- b_set_machine_goal(Goal,false).
2742 b_set_machine_goal(Goal,WithDeferredSets) :-
2743 get_tc_scope(WithDeferredSets,Scope),
2744 b_parse_machine_predicate(Goal,Scope,TypedPred),
2745 b_set_parsed_typed_machine_goal(TypedPred).
2746
2747 b_set_parsed_typed_machine_goal(TypedPred) :-
2748 retractall(b_get_machine_goal(_)),
2749 assertz(b_get_machine_goal(TypedPred)).
2750
2751 b_unset_machine_goal :-
2752 retractall(b_get_machine_goal(_)).
2753
2754
2755 % get typechecking scope:
2756 get_tc_scope(with_deferred,Scope) :- !,
2757 Scope = [prob_ids(visible),variables,external_library(all_available_libraries)].
2758 % with external libraries we can use e.g. GET_IS_DET_OUTPUT("OpName")=FALSE
2759 get_tc_scope(with_deferred_and_primed,Scope) :- !,
2760 get_primed_machine_variables(PV), % this can be useful for visualisation, but will not work during mc
2761 Scope = [prob_ids(visible),identifier(PV),variables,external_library(all_available_libraries)].
2762 get_tc_scope(_,[variables]).
2763
2764 % set search_scope, restricting model checking to states which satisfy the SCOPE DEFINITION predicate
2765 b_set_machine_searchscope(Goal) :- b_set_machine_searchscope(Goal,with_deferred).
2766 b_set_machine_searchscope(Goal,WithDeferredSets) :-
2767 get_tc_scope(WithDeferredSets,Scope),
2768 b_parse_machine_predicate(Goal,Scope,TypedPred),
2769 b_set_parsed_typed_machine_searchscope(TypedPred).
2770 b_set_parsed_typed_machine_searchscope(TypedPred) :-
2771 retractall(b_get_machine_searchscope(_)),
2772 assertz(b_get_machine_searchscope(TypedPred)).
2773
2774 % also allow empty string, and #invariant and #not_invariant
2775 b_parse_optional_machine_predicate(TargetString,Target) :-
2776 is_empty_string(TargetString),!,create_texpr(truth,pred,[],Target).
2777 b_parse_optional_machine_predicate('#invariant',Invariant) :- !,
2778 b_get_invariant_from_machine(Invariant).
2779 b_parse_optional_machine_predicate('#not_invariant',TargetPredicate) :- !,
2780 b_get_invariant_from_machine(Invariant),
2781 bsyntaxtree:create_negation(Invariant,TargetPredicate).
2782 b_parse_optional_machine_predicate(TargetString,Target) :-
2783 b_parse_machine_predicate(TargetString,Target).
2784
2785 is_empty_string(Atom) :-
2786 atom_codes(Atom,Codes),
2787 is_empty_string2(Codes).
2788 is_empty_string2([]).
2789 is_empty_string2([32|Codes]) :- is_empty_string2(Codes).
2790
2791
2792 % parsing a string as predicate with deferred set elements
2793 b_parse_machine_predicate(Pred,TypedPred) :- b_parse_machine_predicate(Pred,[variables],TypedPred).
2794 b_parse_machine_predicate(Pred,Scope,TypedPred) :-
2795 atom_codes(Pred,Codes),
2796 b_parse_machine_predicate_from_codes(Codes,Scope,TypedPred).
2797 b_parse_machine_predicate_from_codes(Codes,Scope,TypedPred) :-
2798 b_parse_machine_predicate_from_codes2(Codes,[],Scope,TypedPred,closed).
2799 b_parse_machine_predicate_from_codes_open(OptionalQuantifier,Codes,Defs,Scope,TypedPred) :-
2800 b_parse_machine_predicate_from_codes2(Codes,Defs,Scope,TypedPred,open(OptionalQuantifier)).
2801
2802 b_parse_machine_predicate_from_codes2(Codes,Defs,Scope,TypedPred,Mode) :-
2803 debug_println(9,parse_predicate(Mode)),
2804 (Defs=[] -> true ; debug_println(9,'% Ignoring DEFINITIONS')),
2805 b_parse_wo_type_machine_predicate_from_codes_to_raw_expr(Codes,Parsed),
2806 %format('Raw Parsed AST = ~w~n',[Parsed]),
2807 b_type_check_raw_expr(Parsed,Scope,TypedPred,Mode).
2808
2809 check_codes(X) :- (X=[] ; X=[H|_], number(H)),!.
2810 check_codes(X) :- add_error(bmachine,'Error while parsing: not a code list: ',X),fail.
2811
2812 b_parse_wo_type_machine_predicate_from_codes_to_raw_expr(Codes,ParsedRaw) :-
2813 check_codes(Codes),
2814 catch(
2815 parse_predicate(Codes,ParsedRaw), % ,print(ParsedRaw),nl),
2816 Exception,
2817 ( Exception = parse_errors(Errors) -> %print(errors(Errors)),nl,
2818 add_all_perrors(Errors,[],parse_machine_predicate_error),fail
2819 ;
2820 add_error(bmachine,'Exception while parsing predicate: ',Exception),
2821 fail)).
2822
2823 b_type_check_raw_expr(ParsedRaw,Scope,TypedPred,Mode) :-
2824 debug_println(9,type_with_errors(ParsedRaw)),
2825 ( Mode == closed ->
2826 type_with_errors(ParsedRaw,Scope,pred,TypedPred)
2827 ; Mode = open(OptionalQuantifier) ->
2828 b_type_open_predicate_with_errors(OptionalQuantifier,ParsedRaw,Scope,TypedPred)).
2829
2830 % a flexible version: convert atom to codes, but also accept codes list
2831 flexible_atom_codes([],R) :- !, R=[].
2832 flexible_atom_codes(A,R) :- atom(A), !, atom_codes(A,R).
2833 flexible_atom_codes([H|T],List) :- !, List=[H|T].
2834 flexible_atom_codes(Other,List) :- add_internal_error('Not atom or codes list: ',flexible_atom_codes(Other,List)),
2835 List=Other.
2836
2837 b_parse_machine_operation_pre_post_predicate(AtomOrCodes,TypedPred,OpName) :-
2838 b_parse_machine_operation_pre_post_predicate(AtomOrCodes,[],TypedPred,OpName,true).
2839 b_parse_machine_operation_pre_post_predicate(AtomOrCodes,ExtraScope,TypedPred,OpName,GenerateParseErrors) :-
2840 flexible_atom_codes(AtomOrCodes,Codes),
2841 b_parse_predicate(Codes,Parsed,GenerateParseErrors),
2842 get_machine_operation_typing_scope(OpName,Scope,ExtraScope),
2843 b_type_only(Parsed,Scope,pred,TypedPred,GenerateParseErrors).
2844
2845 % Note: B and Event-B have different way of priming; this is aimed at classical B
2846 % and supposes predicate used together with execute_operation_by_predicate_in_state
2847 % in classical B x$0 refers to the value before a substitution (e.g., becomes_such)
2848 get_primed_machine_variables(Ids) :-
2849 b_get_machine_variables(Vars),
2850 maplist(prime_variable,Vars,Ids).
2851 :- use_module(btypechecker,[prime_atom0/2]). % add $0 at end of variable
2852 prime_variable(b(identifier(ID),T,I),b(identifier(PID),T,I)) :- prime_atom0(ID,PID).
2853
2854 is_initialisation_op('$setup_constants').
2855 is_initialisation_op('$initialise_machine').
2856
2857 % analog version to b_is_operation_name:
2858 b_is_initialisation_name('$initialise_machine').
2859
2860
2861 get_machine_operation_typing_scope(OpName,Scope,ExtraScope) :-
2862 ( get_machine_operation_additional_identifiers(OpName,V) -> true
2863 ; add_error_fail(get_machine_operation_typing_scope,'Unknown operation:', OpName)),
2864 Scope = [prob_ids(visible),identifier(V),variables,external_library(all_available_libraries)|ExtraScope].
2865
2866 % get additional ids to add to Scope for typing with identifier(V)
2867 get_machine_operation_additional_identifiers(OpName,V) :-
2868 is_initialisation_op(OpName),!, V=[].
2869 get_machine_operation_additional_identifiers(OpName,V) :-
2870 b_get_machine_operation_for_animation(OpName,Results,Paras,_),
2871 append(Paras,Results,PR), % b_get_machine_operation_typed_parameters
2872 get_primed_machine_variables(PV),
2873 append(PV,PR,V).
2874
2875 b_get_machine_operation_for_animation(Name,Results,Parameters,Body) :-
2876 ? b_get_machine_operation_for_animation(Name,Results,Parameters,Body,_OType,true).
2877 % interface predicate b_get_machine_operation_for_animation/6
2878 b_get_machine_operation_for_animation(Name,Results,Parameters,Body,OType,TopLevel) :-
2879 ? b_get_machine_operation_for_animation(Name,Results,Parameters,Body,OType,TopLevel,_OpPos).
2880
2881 :- public b_get_machine_operation_for_animation_calc/7.
2882 % adds some additional ANY parameters if preference is set
2883 b_get_machine_operation_for_animation_calc('$initialise_machine',[],Parameters,Body,OType,_TopLevel,OpPos) :-
2884 b_get_machine_variables(DeclaredVars), Parameters=DeclaredVars,
2885 OpPos = unknown, % TODO: improve
2886 b_get_initialisation_from_machine(Body,OType).
2887 b_get_machine_operation_for_animation_calc(Name,Results,Parameters,Body,OType,TopLevel,OpPos) :-
2888 get_preference(show_eventb_any_arguments,EVENTB),
2889 ? b_get_machine_operation(Name,Results,RealParameters,RealBody,OType,OpPos),
2890 % TO DO: check whether we should only keep b_top_level_operation(Name) in case TopLevel==true !
2891 %length(RealParameters,P), format('Get Mach Op ~w ; paras ~w ; EB ~w, TopLevel=~w~n',[Name,P,EVENTB,TopLevel]),
2892 ((Results=[_|_] ; RealParameters=[_|_] ; EVENTB=false)
2893 -> Parameters=RealParameters, Body=RealBody
2894 ; translate_any_into_parameters(RealBody,FakeParameters,FakeBody),
2895 length(FakeParameters,Len),
2896 (Len > 255
2897 -> add_message(bmachine,'Not adding any parameters to operation, max_arity (255) exceeded: ',Name:Len,OpPos),
2898 Parameters=RealParameters, Body=RealBody
2899 ; ( TopLevel=true, Parameters=FakeParameters, Body=FakeBody
2900 ; TopLevel=false, Parameters=RealParameters, Body=RealBody
2901 )
2902 )
2903 ; Parameters=RealParameters, Body=RealBody
2904 ).
2905
2906 % TO DO: limit to max_arity
2907 translate_any_into_parameters(b(E,Type,Info),Parameters,NewSubst) :-
2908 translate_any_into_parameters_aux(E,Type,Info,Parameters,NewSubst).
2909 translate_any_into_parameters_aux(any(Parameters,PreCond,ABody),Type,Info,Parameters,NewSubst) :-
2910 NewSubst=b(select([b(select_when(PreCond,ABody),Type,Info)]),Type,Info). % TO DO: go deeper ? (nested ANY ?)
2911 translate_any_into_parameters_aux(let(Parameters,Defs,LBody),Type,Info,Parameters,NewSubst) :-
2912 NewSubst=b(select([b(select_when(Defs,LBody),Type,Info)]),Type,Info). % TO DO: go deeper ? ANY could have been translated into several LETs ?
2913 translate_any_into_parameters_aux(lazy_let_subst(Id,IdExpr,Body),Type,Info,Parameters,NewSubst) :-
2914 NewSubst=b(lazy_let_subst(Id,IdExpr,NewInnerSubst),Type,Info),
2915 translate_any_into_parameters(Body,Parameters,NewInnerSubst).
2916
2917
2918 % add deferred set prob_ids and external libraries as well
2919 % ExtraScope could e.g. be [identifier(TypedIDLIst)]
2920 b_parse_machine_expression_from_codes_with_prob_ids(Codes,ExtraScope,TypedExpr,GenerateParseErrors) :-
2921 extend_typing_scope_for_stored_lets([prob_ids(visible),variables,
2922 external_library(all_available_libraries)|ExtraScope],
2923 Scope),
2924 b_parse_machine_expression_from_codes4(Codes,Scope,TypedExpr,GenerateParseErrors).
2925 b_parse_machine_expression_from_codes_with_prob_ids(Codes,ExtraScope,TypedExpr) :-
2926 b_parse_machine_expression_from_codes_with_prob_ids(Codes,ExtraScope,TypedExpr,true).
2927 b_parse_machine_expression_from_codes_with_prob_ids(Codes,TypedExpr) :-
2928 b_parse_machine_expression_from_codes_with_prob_ids(Codes,[],TypedExpr,true).
2929
2930 b_parse_machine_expression_from_codes(Codes,TypedExpr) :-
2931 b_parse_machine_expression_from_codes4(Codes,[variables],TypedExpr,true).
2932
2933 b_parse_machine_expression_from_codes4(Codes,Scope,TypedExpr,GenerateParseErrors) :-
2934 b_parse_machine_expression_from_codes(Codes,Scope,TypedExpr,_Type,GenerateParseErrors,Error),!,
2935 (Error=none -> true
2936 ; generate_parse_errors_for(GenerateParseErrors,Position),
2937 add_error(b_parse_machine_expression_from_codes,'Errors occured during parsing:', Error,Position),
2938 % format(user_error,'Parsing: ~s~n',[Codes]),
2939 fail).
2940
2941
2942 %b_parse_machine_expression_from_codes(Codes,TypedExpr) :-
2943 % b_parse_machine_expression_from_codes(Codes,TypedExpr,_Type,false,Error), Error=none.
2944
2945 b_parse_machine_expression_from_codes(Codes,Typed,Type,GenerateParseErrors,Error) :-
2946 b_parse_machine_expression_from_codes(Codes,[variables],
2947 Typed,Type,GenerateParseErrors,Error).
2948 b_parse_machine_expression_from_codes(Codes,Scope,
2949 Typed,Type,GenerateParseErrors,Error) :-
2950 b_parse_machine_formula_from_codes(expression,Codes,Scope,
2951 Typed,Type,GenerateParseErrors,Error).
2952
2953 % parse substitutions so as to allow operation calls; useful for REPL or trace files:
2954 b_parse_machine_subsitutions_from_codes(Codes,Scope,
2955 Typed,Type,GenerateParseErrors,Error) :-
2956 temporary_set_preference(allow_local_operation_calls,true,CHNG),
2957 call_cleanup(
2958 b_parse_machine_formula_from_codes(substitution,Codes,Scope,
2959 Typed,Type,GenerateParseErrors,Error),
2960 reset_temporary_preference(allow_local_operation_calls,CHNG)).
2961
2962 % a variant of b_parse_machine_predicate that allows also expressions
2963 b_parse_machine_formula(PredOrExpr,Scope,TypedPredOrExpr) :-
2964 atom_codes(PredOrExpr,Codes),
2965 b_parse_machine_formula_from_codes(formula,Codes,Scope,
2966 TypedPredOrExpr,_Type,true,Error), Error=none.
2967
2968 % Kind = expression, predicate, formula, substitution
2969 % GnerateParseErrors = true, false, type_errors_only, gen_parse_errors_for/2
2970 b_parse_machine_formula_from_codes(Kind,Codes,Scope,
2971 Typed,Type,GenerateParseErrors,Error) :-
2972 b_parse_only(Kind,Codes, ParsedAST, GenerateParseErrors, Error),
2973 %print(parsed(Parsed,Error)),nl,
2974 ( nonvar(Error) -> true /* either exception or parse error occured */
2975 ; generate_no_parse_errors(GenerateParseErrors), type_without_errors(ParsedAST,Scope,Type,Typed) -> Error=none
2976 ; b_type_only(ParsedAST,Scope,Type,Typed,GenerateParseErrors) -> Error=none
2977 ; Error=type_error).
2978
2979 % typing with or without errors, depending on GenerateParseErrors flag
2980 b_type_only(ParsedAST,Scope,Type,Typed,gen_parse_errors_for(_Pos)) :- !,
2981 % ParsedAST now contains filenumber for additional file
2982 type_with_errors_in_context(ParsedAST,Scope,Type,Typed,machine_context).
2983 b_type_only(ParsedAST,Scope,Type,Typed,false) :- !,
2984 type_without_errors(ParsedAST,Scope,Type,Typed).
2985 b_type_only(ParsedAST,Scope,Type,Typed,_GenerateParseErrors) :-
2986 type_with_errors_in_context(ParsedAST,Scope,Type,Typed,no_machine_context([])).
2987
2988 % GenerateParseErrors can also provide context filename
2989 b_parse_predicate(Codes,ParsedAST,GenerateParseErrors) :-
2990 b_parse_only(predicate,Codes, ParsedAST, GenerateParseErrors,Error),
2991 Error=none.
2992
2993 b_parse_only(Kind,Codes, ParsedAST, _,Error) :- (Codes \= [] , Codes \= [_|_]),!,
2994 add_internal_error('Not a codes list: ',b_parse_only(Kind,Codes, ParsedAST, _, Error)),
2995 Error = internal_error.
2996 b_parse_only(Kind,Codes, ParsedAST, GenerateParseErrors,Error) :-
2997 generate_parse_errors_for(GenerateParseErrors,Position),!,
2998 % we should generate errors in a particular file context
2999 (extract_file_number_and_name(Position,FileNr,Filename)
3000 -> Files=[Filename] ; FileNr = -1, Files=[]),
3001 (number(FileNr) -> NewFileNr=FileNr ; add_additional_filename(Filename,NewFileNr)),
3002 catch( parse_at_position_in_file(Kind,Codes,ParsedAST,Position,NewFileNr),
3003 Exception,
3004 ((Exception = parse_errors(Errors) ->
3005 add_all_perrors(Errors,Files,parse_machine_formula_error),
3006 Error=parse_error
3007 ;
3008 ajoin(['Exception while parsing ',Kind,': '],Msg),
3009 add_error(bmachine,Msg,Exception,Position),
3010 Error=exception))).
3011 b_parse_only(Kind,Codes, ParsedAST, _GenerateParseErrors,_Error) :-
3012 catch( parse(Kind,Codes,ParsedAST),
3013 Exception,
3014 (debug_println(19,parse_exception(Exception)),fail)).
3015
3016 %generate_type_errors_for(type_errors_only,unknown,[]).
3017 %generate_type_errors_for(GenerateParseErrors,Pos) :- generate_parse_errors_for(GenerateParseErrors,Pos).
3018
3019 generate_parse_errors_for(true,unknown).
3020 generate_parse_errors_for(gen_parse_errors_for(Pos),Pos).
3021
3022 generate_no_parse_errors(false).
3023
3024 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3025
3026 % a flexible parsing predicate, useful for dot and table tools to be called from
3027 % either probcli or prob2 with either atoms or with raw ASTs:
3028
3029 :- use_module(eval_let_store,[extend_typing_scope_for_stored_lets/2]).
3030 parse_expression_raw_or_atom_with_prob_ids(Expr,TypedExpr) :-
3031 extend_typing_scope_for_stored_lets([prob_ids(visible),variables,external_library(all_available_libraries)],Scope),
3032 parse_expression_raw_or_atom3(Expr,Scope,TypedExpr).
3033
3034 parse_expression_raw_or_atom3('$VARIABLES',_,TypedExpr) :- !,
3035 b_get_machine_variables(DeclaredVars),
3036 gen_couple_from_list(DeclaredVars,TypedExpr).
3037 parse_expression_raw_or_atom3(RawAST,Scope,TypedExpr) :- compound(RawAST),!, % allow to pass raw AST as well
3038 type_with_errors(RawAST,Scope,Type,TypedExpr),
3039 ((Type=pred ; Type=subst)
3040 -> add_error(parse_expression,'Expected expression formula but obtained: ',Type),fail
3041 ; true ).
3042 parse_expression_raw_or_atom3(VorE,Scope,TypedExpr) :-
3043 atom_codes(VorE,VorECodes),
3044 % to do: maybe support b_parse_machine_expression_from_codes_with_prob_ids
3045 b_parse_machine_expression_from_codes4(VorECodes,Scope,TypedExpr,true).
3046
3047 :- use_module(bsyntaxtree, [create_couple/3]).
3048 gen_couple_from_list([],string('NO VARIABLES')).
3049 gen_couple_from_list([TID],Res) :- !, Res=TID.
3050 gen_couple_from_list([TID|T],Couple) :-
3051 gen_couple_from_list(T,Rest),
3052 create_couple(TID,Rest,Couple).
3053
3054
3055 :- use_module(btypechecker,[prime_atom0/2]). % add $0 at end of variable
3056 :- use_module(bsyntaxtree, [find_typed_identifier_uses/2,get_texpr_id/2]).
3057 % compute requirements for evaluating formula
3058 % requires_nothing, requires_constants, requires_variables
3059 determine_type_of_formula(TypedExpr,Class) :-
3060 determine_type_of_formula(TypedExpr,_,Class).
3061 determine_type_of_formula(TypedExpr,Identifiers,Class) :-
3062 find_typed_identifier_uses(TypedExpr,Identifiers),
3063 determine_type_of_formula2(Identifiers,Class).
3064 determine_type_of_formula2([],Res) :- !, Res = requires_nothing.
3065 determine_type_of_formula2(Ids,Res) :-
3066 member(TID,Ids), get_texpr_id(TID,ID),
3067 (b_is_variable(ID,_) -> true
3068 ; prime_atom0(Original,ID),
3069 (b_is_variable(Original,_) -> true ; add_warning(bmachine,'Unknown primed variable: ',ID))
3070 ),
3071 !, Res = requires_variables.
3072 determine_type_of_formula2(Ids,Res) :-
3073 member(TID,Ids), get_texpr_id(TID,ID),
3074 b_is_constant(ID,_),
3075 !, Res = requires_constants.
3076 determine_type_of_formula2(_,requires_nothing).
3077 % only open, implicitly existentially quantified variables
3078 % also, TO DO: check that insert_before_substitution_variables / $0 variables are properly treated
3079 % TODO: there are external functions like ENABLED(.) which implicitly require a state with variables
3080
3081 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3082 % consistency check to spot some errors
3083 do_machine_consistency_check :-
3084 specfile:animation_mode(b), % TODO (dp,27.09.2012): this is just an ugly hack
3085 type_check_definitions,
3086 ? minor_mode_to_check,
3087 %debug:time(bmachine:all_operations_have_valid_read_modifies_infos).
3088 !,
3089 all_operations_have_valid_read_modifies_infos.
3090 do_machine_consistency_check.
3091
3092 % In future, all formalisms should provide the relevent data
3093 minor_mode_to_check :- animation_minor_mode(eventb),!.
3094 ?minor_mode_to_check :- classical_b_mode.
3095
3096 all_operations_have_valid_read_modifies_infos :-
3097 %findall(O,b_get_machine_operation(O,_,_,_,_),OpNames),
3098 %maplist(operation_has_valid_read_modifies_infos,OpNames).
3099 ? b_is_operation_name(OpName),
3100 operation_has_valid_read_modifies_infos(OpName),fail.
3101 all_operations_have_valid_read_modifies_infos.
3102
3103 operation_has_valid_read_modifies_infos(OpName) :- % print(check(OpName)),nl,
3104 ( operation_has_valid_read_modifies_infos2(OpName) -> true
3105 ; add_failed_call_error(operation_has_valid_read_modifies_infos2(OpName))).
3106 operation_has_valid_read_modifies_infos2(OpName) :-
3107 b_get_operation_normalized_read_write_info(OpName,Reads,Writes),
3108 maplist(check_read(OpName),Reads),
3109 %print(operation(OpName,reads(Reads),writes(Writes))),nl,
3110 maplist(check_write(OpName),Writes).
3111
3112
3113 check_read(OpName,Id) :-
3114 ? ( (check_is_var(Id); check_is_constant(Id) ; check_is_operation(Id)) -> true
3115 ;
3116 ajoin(['Unknown identifier "',Id,'" in "reads" information of operation:'],Msg),
3117 add_internal_error(bmachine,Msg,OpName,unknown)).
3118 check_write(OpName,Id) :-
3119 ( check_is_var(Id) -> true
3120 ;
3121 ajoin(['Unknown variable "',Id,'" in "modifies" information of operation:'],Msg),
3122 add_internal_error(bmachine,Msg,OpName,unknown)).
3123
3124 check_is_var(Id) :-
3125 b_is_variable(Id,_).
3126 %get_texpr_id(E,Id),
3127 %b_get_machine_variables(Vars),
3128 %memberchk(E,Vars).
3129 check_is_constant(Id) :- b_is_constant(Id,_).
3130 check_is_constant(Id) :- b_get_constant_represented_inside_global_set(Id,_).
3131 % b_get_machine_all_constants(Constants),
3132 % get_texpr_id(TId,Id),
3133 % memberchk(TId,Constants).
3134 check_is_constant(Id) :- b_get_machine_set(Id).
3135 check_is_constant(Id) :- b_get_named_machine_set(Id,_).
3136 check_is_constant(Id) :-
3137 b_get_named_machine_set(_,Elems),member(Id,Elems).
3138 %check_is_constant(Id) :- % add later when we deal FREETYPE section in classical B as in Z
3139 % kernel_freetypes:freetype_register_db(Id,_) ;
3140 % kernel_freetypes:freetype_case_db(Id,_,_).
3141
3142 check_is_operation(op(ID)) :-
3143 b_is_operation_name(ID), % TO DO: check that other predicates can deal with op(Id) infos
3144 get_preference(allow_operation_calls_in_expr,true).
3145
3146 % provide access to number of constants, ....:
3147
3148 :- volatile b_machine_statistics/2.
3149 :- dynamic b_machine_statistics/2.
3150 :- public b_machine_statistics_calc/2.
3151 b_machine_statistics_calc(files,Nr) :-
3152 b_get_all_used_filenames(L),length(L,Nr).
3153 b_machine_statistics_calc(deferred_sets,Nr) :-
3154 get_section_from_current_machine(deferred_sets,L),length(L,Nr).
3155 b_machine_statistics_calc(enumerated_sets,Nr) :-
3156 get_section_from_current_machine(enumerated_sets,L),length(L,Nr).
3157 b_machine_statistics_calc(definitions,Nr) :-
3158 get_section_from_current_machine(definitions,L),length(L,Nr).
3159 b_machine_statistics_calc(constants,Nr) :- b_get_machine_constants(L), length(L,Nr).
3160 b_machine_statistics_calc(variables,Nr) :- b_get_machine_variables(L), length(L,Nr).
3161 b_machine_statistics_calc(properties,Nr) :-
3162 b_get_properties_from_machine(C), conjunction_to_list(C,L),length(L,Nr).
3163 b_machine_statistics_calc(invariants,Nr) :-
3164 b_get_invariant_from_machine(C), conjunction_to_list(C,L),length(L,Nr).
3165 b_machine_statistics_calc(static_assertions,Nr) :-
3166 b_get_static_assertions_from_machine(L), length(L,Nr).
3167 b_machine_statistics_calc(dynamic_assertions,Nr) :-
3168 b_get_dynamic_assertions_from_machine(L), length(L,Nr).
3169 b_machine_statistics_calc(operations,Nr) :- findall(N,b_is_operation_name(N),L),length(L,Nr).
3170
3171 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3172 % default and initial machines
3173 b_set_initial_machine :-
3174 initial_machine(Main,Machines),
3175 b_set_machine(Main,Machines,[]).
3176
3177 initial_machine(phonebook,[M]) :-
3178 M = abstract_machine(none,machine(none),machine_header(none,phonebook,[]),Body),
3179 Body = [sets(none, [deferred_set(none,'Name'),
3180 deferred_set(none,'Code')]),
3181 definitions(none,[ScopeName,ScopeCode,TraceTest0]),
3182 variables(none, [identifier(none, db)]),
3183 invariant(none, member(none,
3184 identifier(none, db),
3185 partial_function(none,
3186 identifier(none, 'Name'),
3187 identifier(none, 'Code')))),
3188 initialisation(none,
3189 assign(none, [identifier(none, db)], [empty_set(none)])),
3190 operations(none, [Add,Lookup,Update,Reset])],
3191
3192 % definitions
3193 ScopeName = expression_definition(none,
3194 scope_Name,
3195 [],
3196 interval(none, integer(none, 1), integer(none, 3))),
3197 ScopeCode = expression_definition(none,
3198 scope_Code,
3199 [],
3200 interval(none, integer(none, 1), integer(none, 2))),
3201 TraceTest0 = expression_definition(none, trace_Test0, [], empty_sequence(none)),
3202
3203 % add operation
3204 Add = operation(none,
3205 identifier(none, add),
3206 [],
3207 [identifier(none,cc),identifier(none,nn)],
3208 precondition(none, AddPre, AddAssign)),
3209 AddPre = conjunct(none,
3210 conjunct(none,
3211 member(none, identifier(none,nn), identifier(none,'Name')),
3212 member(none, identifier(none,cc), identifier(none,'Code'))),
3213 not_member(none,
3214 identifier(none,nn),
3215 domain(none, identifier(none,db)))),
3216 AddAssign = assign(none,
3217 [identifier(none,db)],
3218 [union(none,
3219 identifier(none,db),
3220 set_extension(none,
3221 [couple(none,[identifier(none,nn),
3222 identifier(none,cc)])]))]),
3223
3224 % lookup operation
3225 Lookup = operation(none,
3226 identifier(none, lookup),
3227 [identifier(none, cc)],
3228 [identifier(none, nn)],
3229 precondition(none, LookupPre, LookupAssign)),
3230 LookupPre = member(none, identifier(none,nn), domain(none,identifier(none,db))),
3231 LookupAssign = assign(none,
3232 [identifier(none, cc)],
3233 [function(none, identifier(none, db), identifier(none, nn))]),
3234
3235 % update operation
3236 Update = operation(none,
3237 identifier(none, update),
3238 [],
3239 [identifier(none,nn),identifier(none,cc)],
3240 precondition(none, UpdatePre, UpdateAssign)),
3241 UpdatePre = conjunct(none,
3242 conjunct(none,
3243 member(none, identifier(none,nn), identifier(none,'Name')),
3244 member(none, identifier(none,cc), identifier(none,'Code'))),
3245 member(none,
3246 identifier(none,nn),
3247 domain(none, identifier(none,db)))),
3248 UpdateAssign = assign(none,
3249 [function(none, identifier(none,db), identifier(none,nn))],
3250 [identifier(none, cc)]),
3251
3252 % reset operation
3253 Reset = operation(none,
3254 identifier(none,reset),
3255 [],
3256 [],
3257 precondition(none, ResetPre, ResetAssign)),
3258 ResetPre = member(none,
3259 identifier(none, db),
3260 total_function(none, identifier(none,'Name'), identifier(none,'Code'))),
3261 ResetAssign = assign(none,[identifier(none,db)],[empty_set(none)]).
3262
3263 empty_machine(empty_machine,[M]) :-
3264 M = abstract_machine(none,machine(none),machine_header(none,empty_machine,[]),Body),
3265 Body = [].
3266
3267 % after transformation this gives
3268 % machine(empty_machine,[deferred_sets/[],enumerated_sets/[],enumerated_elements/[],parameters/[],internal_parameters/[],abstract_constants/[],concrete_constants/[],abstract_variables/[],concrete_variables/[],promoted/[],unpromoted/[],(constraints)/b(truth,pred,[]),properties/b(truth,pred,[initial]),invariant/b(truth,pred,[initial]),linking_invariant/b(truth,pred,[initial]),assertions/[],initialisation/b(skip,subst,[generated]),operation_bodies/[],definitions/[],used/[],freetypes/[],operators/[],values/[],meta/[model_type/machine,hierarchy/[empty_machine],header_pos/[empty_machine/none]]])
3269
3270 % Code to inspect sizes of operations:
3271 % findall(op(Sz,Op),(bmachine:b_get_machine_operation_for_animation(Op,_,_,Body,_,_Top), terms:term_size(Body,Sz)),L), sort(L,SL), print(SL),nl.