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