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