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