1		% (c) 2009-2025 Lehrstuhl fuer Softwaretechnik und Programmiersprachen,
2		% Heinrich Heine Universitaet Duesseldorf
3		% This software is licenced under EPL 1.0 (http://www.eclipse.org/org/documents/epl-v10.html)
4
5
6		:- module(b_interpreter,
7		[b_test_boolean_expression/4, b_test_boolean_expression/6,
8		%b_test_boolean_expression_wf/3,
9		b_test_boolean_expression_cs/5,
10		b_test_boolean_expression_for_ground_state/4, b_test_boolean_expression_for_ground_state/5,
11		% b_det_test_boolean_expression/6,
12		b_not_test_boolean_expression/4, b_not_test_boolean_expression/6,
13		%b_not_test_boolean_expression_wf/3,
14		b_not_test_boolean_expression_cs/5,
15
16		b_convert_bool/5,
17		b_convert_bool_timeout/7,
18		b_compute_expression/5,
19
20		b_execute_top_level_statement/7,
21		b_execute_statement_nowf/5,
22
23		b_compute_expression_nowf/4, b_compute_expression_nowf/6, b_compute_expression_nowf/7,
24		b_compute_explicit_epression_no_wf/6, b_compute_explicit_epression_no_wf/7,
25
26		b_set_up_concrete_constants/2, b_partial_set_up_concrete_constants/1,
27		b_initialise_machine/4,
28
29		b_execute_top_level_operation_update/5, b_execute_top_level_operation_wf/8,
30
31		convert_list_of_expressions_into_set_wf/4,
32		%state_satisfies_negation_of_invariant/1,
33
34		b_state_violates_invariant/2,
35		state_violates_assertions/2,
36		analyse_invariant_for_state/1,
37
38		insert_before_substitution_variables/5, % add $0 values to a store
39
40		try_lookup_value_in_store_and_global_sets/3, lookup_value_in_store_and_global_sets_wf/7,
41		set_up_typed_localstate/6, set_up_typed_localstate2/8,
42		%set_up_localstate_for_let/7,
43
44		set_projection_on_static_assertions/1,
45
46		tcltk_unsatisfiable_components_exist/0,
47		tcltk_quick_describe_unsat_properties/2,
48
49		get_unsat_component_predicate/3,
50		properties_were_filtered/1, % true if PROPERTIES / axioms filtered due to prob-ignore pragmas
51		b_generate_for_all_list_domain_nolwf/8 % for predicate_evaluator
52		]).
53
54		:- meta_predicate not_with_enum_warning_and_possible_delay(0,-,?,?,?).
55		:- meta_predicate not_with_enum_warning_delay(0,-,?,?,?,?).
56
57		%:- use_module('../extensions/profiler/profiler.pl').
58		%:- use_module('../extensions/profiler/profiler_te.pl').
59		%:- enable_profiling(b_test_boolean_expression/4).
60		%:- enable_profiling(b_test_boolean_expression_cs/5).
61
62		:- use_module(kernel_objects).
63		:- use_module(bsets_clp).
64		:- use_module(delay).
65
66
67		:- use_module(kernel_mappings).
68		:- use_module(b_global_sets).
69		:- use_module(store).
70		:- use_module(library(lists)).
71		:- use_module(library(ordsets)).
72		:- use_module(library(avl)).
73
74		:- use_module(b_global_sets).
75		:- use_module(bmachine).
76		:- use_module(b_enumerate, [b_enumerate_values_in_store/5,
77		b_tighter_enumerate_all_values/2, b_tighter_enumerate_values_in_ctxt/3]).
78		:- use_module(debug).
79		:- use_module(performance_messages).
80		:- use_module(self_check).
81		:- use_module(tools).
82
83		:- use_module(module_information,[module_info/2]).
84		:- module_info(group,interpreter).
85		:- module_info(description,'This module provides the basic interpreter for expressions, predicates and substitutions.').
86
87		:- use_module(preferences).
88		:- use_module(error_manager).
89		:- use_module(typechecker).
90		:- use_module(specfile,[state_corresponds_to_initialised_b_machine/2
91		,state_corresponds_to_set_up_constants_only/2]).
92
93		:- use_module(bsyntaxtree).
94
95		:- use_module(translate).
96
97		:- use_module(kernel_waitflags).
98		:- use_module(kernel_reals).
99		:- use_module(kernel_records).
100
101		:- use_module(kodkodsrc(kodkod),[kodkod_request/5]).
102
103		:- use_module(custom_explicit_sets).
104		:- use_module(closures,[is_symbolic_closure/1,
105		mark_closure_as_symbolic/2, mark_closure_as_recursive/2, mark_closure/3]).
106
107		:- use_module(state_space).
108		:- use_module(b_interpreter_eventb).
109		:- use_module(tools_printing,[print_term_summary/1,print_functor/1]).
110		:- use_module(value_persistance,[load_partial_constants/3,lookup_cached_transitions/4]).
111		:- use_module(extrasrc(b_expression_sharing),[is_lazy_let_identifier/1]).
112		:- use_module(bool_pred,[negate/2]).
113		:- use_module(smt_solvers_interface(smt_solvers_interface),[smt_add_predicate/5]).
114
115		:- use_module(debug).
116		:- use_module(external_functions).
117
118		:- use_module(static_ordering,[sort_ids_by_usage/4,reorder_state/3]).
119		%:- use_module(bsyntaxtree,[predicate_has_ignore_pragma/1]).
120		:- use_module(tools_lists,[exclude_count/4, optimized_nth1/3]).
121		:- use_module(tools_meta, [safe_time_out/3]).
122
123		:- set_prolog_flag(double_quotes, codes).
124
125		/* ----------------------------------*/
126
127		/* For partial evaluation */
128
129		%:- use_module('~/cvs_root/cogen2/logen_source/runtime/logen_dispatcher.pl').
130
131		% new profiler
132		%:- use_module('../extensions/profiler/profiler.pl').
133		%:- use_module('../extensions/profiler/profiler_te.pl').
134		%:- enable_profiling_naming(b_interpreter:b_state_violates_invariant_aux/2,name).
135
136		%name(b_interpreter:b_state_violates_invariant_aux,_,INVERIANT).
137
138		%b_state_violates_invariant(ID,State) :-
139		% b_intepreter:b_state_violates_invariant_aux(ID,State).
140
141		% old profiler
142		:- use_module(runtime_profiler,[profile_single_call/3]).
143
144		% called by force_check_invariantKO and indirectly by model_checker (State was prepare_state_for_specfile_trans )
145		b_state_violates_invariant(ID,State) :-
146		b_state_violates_invariant_aux(ID,State).
147
148		b_state_violates_invariant_aux(ID,CurBState) :-
149		retract(specialized_inv(ID,AVL)), % Note: when we assert this we check that invariant holds in predecessor state
150		intersect_invs(AVL,SPO), !,
151		(SPO = b(truth,_,_) -> fail
152		; profile_single_call('INVARIANT-Specialized',ID,b_interpreter:b_state_violates_spec_invariant(ID,SPO,CurBState))).
153		b_state_violates_invariant_aux(ID,CurBState) :-
154		profile_single_call('INVARIANT',ID,b_interpreter:state_violates_invariant(ID,CurBState)).
155
156		b_state_violates_spec_invariant(ID,SPO,CurBState) :-
157		\+ check_invariant_predicate_with_time_out(ID,SPO,CurBState).
158
159		intersect_invs(invariant_preserved,Inv) :- !, Inv= b(truth,pred,[]).
160		intersect_invs([],Inv) :- !, add_internal_error('Illegal empty specialized inv list:', intersect_invs([],Inv)),
161		Inv = b(falsity,pred,[]).
162		intersect_invs(A,InvList) :-
163		avl_domain(A,OpList),
164		get_mask(OpList,Mask), %print(check(OpList,Mask)),nl,
165		findall(nth1_invariant(Nr), member(Nr,Mask), InvList).
166
167		% intersect all masks of specialized invariant nrs to be checked
168		get_mask([],[]).
169		get_mask([H|T],Res) :-
170		b_specialized_invariant_mask_for_op(H,Mask),get_mask3(T,Mask,Res).
171		get_mask3([],Acc,Acc).
172		get_mask3([H|T],Acc,Res) :-
173		b_specialized_invariant_mask_for_op(H,Mask),
174		ord_intersection(Mask,Acc,A1),
175		get_mask3(T,A1,Res).
176		/* ----------------------------------*/
177
178		:- load_files(library(system), [when(compile_time), imports([environ/2])]).
179
180
181		state_satisfies_invariant_aux(ID,State) :-
182		check_invariant_with_time_out(ID,State). % version without partial evaluation
183
184
185		:- use_module(library(timeout)).
186
187		:- use_module(tools_printing,[format_with_colour_nl/4]).
188		:- use_module(probsrc(specfile),[prepare_state_for_specfile_trans/3]).
189		% called by prob_cli when invariant violation found:
190		% we no longer have access to the specialized_inv facts
191		analyse_invariant_for_state(ID) :-
192		b_invariant_number_list(InvList),
193		visited_expression(ID,State),
194		prepare_state_for_specfile_trans(State,ID,PreparedCurState),
195		maplist(check_invariant(ID,PreparedCurState),InvList).
196		check_invariant(ID,State,InvariantNr) :-
197		enter_new_error_scope(L,check_invariant),
198		check_invariant_predicate_with_time_out_res(InvariantNr,State,TimeOutRes),
199		(TimeOutRes=success -> true
200		; InvariantNr = nth1_invariant(Nr),
201		b_nth1_invariant(Nr,Invariant,_UsedIds),
202		translate_bexpression_with_limit(Invariant,TS),
203		translate_span(Invariant,SpanStr),
204		(TimeOutRes=failure -> InvRes=false ; InvRes=unknown),
205		format_with_colour_nl(user_output,[red,bold],
206		'*** Invariant ~w ~w is ~w (in state with id ~w):~n ~w',[Nr,SpanStr,InvRes,ID,TS]),
207		% add_message(check_invariant,'Invariant false: ',Nr,TS),
208		(debug_mode(off) -> true
209		; translate:print_bstate(State),nl
210		)
211		% TODO: pass check dot_file_prefix or similar to analyse_invariant_for_state and call:
212		% bvisual:get_tree_from_expr(Tree, Invariant, [], State),
213		% bvisual:write_dot_graph_to_file(Tree,'invariant.dot')
214		), exit_error_scope(L,_ErrOcc,check_invariant).
215
216
217
218		check_invariant_with_time_out(ID,State) :-
219		%b_get_invariant_from_machine(Invariant),
220		b_invariant_number_list(InvList), % ensures operation caching can be applied
221		% TO DO: we could just get unproven invariants; unless we are in an initial state
222		check_invariant_predicate_with_time_out(ID,InvList,State).
223
224
225		check_invariant_predicate_with_time_out(ID,Invariant,State) :-
226		(check_invariant_predicate_with_time_out_res(Invariant,State,TimeOutRes)
227		-> check_time_out_res(TimeOutRes,ID)).
228
229		check_invariant_predicate_with_time_out_res(b(truth,_,_),_State,TimeOutRes) :- !, % only typing in invariant
230		TimeOutRes = success.
231		check_invariant_predicate_with_time_out_res(Invariant,State,TimeOutRes) :-
232		set_error_context(checking_invariant),
233		preferences:get_computed_preference(debug_time_out,DebugTimeOut),
234		call_cleanup(
235		(time_out_with_enum_warning_one_solution_no_new_error_scope(
236		b_interpreter:check_invariant_predicate_aux(Invariant,State ),
237		DebugTimeOut,TimeOutRes)
238		-> true
239		; TimeOutRes = failure),
240		clear_error_context).
241
242		% process typed predicates, lists and special invariant(Nr) terms
243		check_invariant_predicate_aux(nth1_invariant(Nr),State) :- !,
244		(get_preference(try_operation_reuse,false)
245	?	-> check_nth1_invariant(Nr,State)
246	?	; \+ b_operation_cache:check_invariant_violated_cache(Nr,State) % will call check_nth1_invariant if necessary
247		% note : for performance it is important that the State is prepared but not expanded
248		% (e.g. it should be expanded_const_and_vars with the info field containing the packed state)
249		).
250		check_invariant_predicate_aux([],_) :- !.
251		check_invariant_predicate_aux([H|T],State) :- !,
252	?	check_invariant_predicate_aux(H,State),
253	?	check_invariant_predicate_aux(T,State).
254		check_invariant_predicate_aux(Invariant,State) :-
255		b_test_boolean_expression_for_ground_state(Invariant,[],State,'INVARIANT',0).
256
257		% check the nth invariant
258		check_nth1_invariant(Nr,State) :-
259		if(b_nth1_invariant(Nr,Invariant,_UsedIds),
260	?	b_test_boolean_expression_for_ground_state(Invariant,[],State,'INVARIANT',Nr), % add Nr to call_stack
261		add_internal_error('Invariant does not exist:',Nr)).
262
263
264		check_time_out_res(time_out,ID) :- !,
265		format('**** TIMEOUT during invariant evaluation in state ~w!~n',[ID]),
266		assert_time_out_for_invariant(ID),
267		fail.
268		check_time_out_res(virtual_time_out(_WARNING),ID) :- !,
269		format('**** VIRTUAL TIMEOUT during invariant evaluation in state ~w!~n',[ID]),
270		assert_time_out_for_invariant(ID),
271		fail.
272		check_time_out_res(failure,_) :- !, fail.
273		check_time_out_res(_,_).
274
275		% b_test_boolean_expression_for_ground_state:
276		% idea: check each conjunct individually; avoids multiplication of choice points between conjuncts
277
278		:- use_module(specfile,[expand_const_and_vars_to_full_store/2]).
279		b_test_boolean_expression_for_ground_state(b(Expr,_,Infos),LS,S,PredKind) :-
280		b_test_boolean_expression_for_ground_state(b(Expr,_,Infos),LS,S,PredKind,0).
281		b_test_boolean_expression_for_ground_state(b(Expr,_,Infos),LS,S,PredKind,Nr) :-
282		expand_const_and_vars_to_full_store(S,FS), % ensure we have full store
283	?	b_test_boolean_expression_for_ground_state2(Expr,Infos,LS,FS,PredKind,Nr).
284
285		b_test_boolean_expression_for_ground_state1(b(Expr,_,Infos),LS,S,Kind,Nr) :- !,
286	?	b_test_boolean_expression_for_ground_state2(Expr,Infos,LS,S,Kind,Nr).
287
288		b_test_boolean_expression_for_ground_state2(conjunct(LHS,RHS),_,LocalState,State,Kind,Nr) :- !,
289		% usually LHS is the nested conjunct and RHS atomic:
290		%it would be better to swap LHS and RHS: but does not seem to buy anything
291	?	b_test_boolean_expression_for_ground_state1(LHS,LocalState,State,Kind,Nr),
292		!, % do we need this cut; it makes partial evaluation more tricky
293	?	b_test_boolean_expression_for_ground_state1(RHS,LocalState,State,Kind,Nr).
294		% TO DO: treate lazy_let_pred ?
295		b_test_boolean_expression_for_ground_state2(BE,Infos,LS,S,Kind,Nr) :-
296	?	b_test_boolean_expression_cs(b(BE,pred,Infos),LS,S,Kind,Nr).
297
298		state_violates_invariant(ID,State) :-
299		State \== root,
300		State \= concrete_constants(_), % machine not yet initialised (cf state_corresponds_to_initialised_b_machine)
301		\+(state_satisfies_invariant_aux(ID,State)).
302
303
304		% new profiler
305		%:- use_module('../extensions/profiler/profiler.pl').
306		%:- use_module('../extensions/profiler/profiler_te.pl').
307		%:- enable_profiling_naming(b_interpreter:state_violates_assertions_aux/2,name2).
308
309		%name2(b_interpreter:state_violates_assertions_aux,_,ASSERTIONS).
310
311		%state_violates_assertions(ID,State) :-
312		% b_interpreter:state_violates_assertions_aux(ID,State).
313
314		% old profiler
315		:- use_module(runtime_profiler,[profile_single_call/3]).
316		:- use_module(bmachine,[get_assertions_from_machine/2, b_machine_has_dynamic_assertions/0, b_machine_has_static_assertions/0]).
317		state_violates_assertions(ID,State) :-
318		profile_single_call('ASSERTIONS',ID,b_interpreter:state_violates_assertions_aux(ID,State)).
319		state_violates_assertions_aux(ID,State) :-
320		b_machine_has_dynamic_assertions,
321		state_corresponds_to_initialised_b_machine(State,BState), !,
322		\+(state_satisfies_assertions(ID,dynamic,BState)).
323		state_violates_assertions_aux(ID,State) :-
324		b_machine_has_static_assertions,
325		state_corresponds_to_set_up_constants_only(State,BState),
326		\+(state_satisfies_assertions(ID,static,BState)).
327		state_satisfies_assertions(ID,Type,State) :-
328		( get_assertions_from_machine(Type,Ass) ->
329		set_error_context(checking_assertions),
330		%enter_new_error_scope(Level,checking_assertions),
331		preferences:get_computed_preference(debug_time_out,DebugTimeOut),
332		%print(checking_assertions(ID)),nl,
333		time_out_with_enum_warning_one_solution(
334		b_test_list_of_boolean_expression_for_ground_state(Ass,'ASSERTION ',[],State),
335		DebugTimeOut,TimeOutRes, clear_errors),
336		% TO DO: in case of a virtual time-out (cf UML-B/drone_2_error.eventb) we could try and continue with the next assertion
337		clear_error_context,
338		(nonvar(TimeOutRes),
339		(TimeOutRes == time_out, Kind='TIMEOUT' ; TimeOutRes = virtual_time_out(_), Kind = 'Virtual TIMEOUT')
340		-> format('~n*** ~w during assertion checking for state id ~w!~n',[Kind,ID]),
341		assert_time_out_for_assertions(ID)
342		; true
343		)
344		; true
345		).
346
347
348
349		/* ----------------------------------*/
350		/* b_test_boolean_expression */
351		/* ----------------------------------*/
352
353
354		:- type variable_id_list +--> list(type(variable_id)).
355
356		:- type boolean_expression +--> call(bsyntaxtree:check_if_typed_predicate).
357
358		% used for testing ASSERTIONS on a fully ground state
359		b_test_list_of_boolean_expression_for_ground_state(List,PredKind,LS,S) :-
360		b_test_list_of_boolean_expression_aux(List,PredKind,1,LS,S).
361
362		b_test_list_of_boolean_expression_aux([],_,_,_,_).
363		b_test_list_of_boolean_expression_aux([B1|T],PredKind,Nr,LS,S) :- %nl,print(nr(PredKind,Nr)),nl,
364	?	(b_test_boolean_expression_for_ground_state1(B1,LS,S,PredKind,Nr)
365		-> N1 is Nr+1, b_test_list_of_boolean_expression_aux(T,PredKind,N1,LS,S)
366		; silent_mode(off),
367		(critical_enumeration_warning_occured_in_error_scope -> Res='UNKNOWN'
368		; abort_error_occured_in_error_scope -> Res ='NOT-WELL-DEFINED'
369		; Res='false'),
370		ajoin([PredKind, Nr, ' is ', Res,': '],Msg),
371		add_message(b_interpreter,Msg,B1,B1), % TO DO: get just label/location?
372		fail).
373
374
375		:- use_module(b_interpreter_components).
376
377
378		:- assert_pre(b_interpreter:b_test_boolean_expression_cs(E,LS,S,_,_),
379		(bsyntaxtree:check_if_typed_predicate(E),type_check(LS,store),type_check(S,store) )).
380		:- assert_post(b_interpreter:b_test_boolean_expression_cs(_,_,_,_,_), true ).
381
382
383		% --------------------- BOOLEAN EXPRESSIONS ----------------------------
384
385		:- use_module(b_interpreter_check).
386		:- use_module(kernel_propagation, [do_not_enumerate_binary_boolean_operator/3]).
387
388		% a version where we can provide an initial call stack entry for context
389		b_test_boolean_expression_cs(E,LS,S,PredKind,Nr) :-
390		init_wait_flags_cs(E,PredKind,Nr,b_test_boolean_expression_cs,WF),
391		% TO DO: call b_trace_test_components ?
392	?	b_test_boolean_expression(E,LS,S,WF),
393	?	ground_wait_flags(WF).
394
395		init_wait_flags_cs(E,PredKind,Nr,PP,WF) :-
396		(PredKind=none -> init_wait_flags(WF,[PP])
397		; get_texpr_pos(E,Pos),
398		CallStackEntry = prob_command_context(check_pred_command(PredKind,Nr),Pos),
399		init_wait_flags_and_push_call_stack(no_wf_available,CallStackEntry,WF)
400		).
401
402
403		b_test_boolean_expression(b(Expr,_,Infos),LS,S,WF) :- !,
404		(b_interpreter_check:composed(Expr) -> empty_avl(Ai)
405		; Ai = no_avl), % simple expression: no sharing is possible: no need to register expressions
406	?	b_test_boolean_expression2(Expr,Infos,LS,S,WF,Ai,_).
407		b_test_boolean_expression(E,LS,S,WF) :- % will generate error message
408		empty_avl(Ai), b_test_boolean_expression(E,LS,S,WF,Ai,_).
409
410		:- assert_pre(b_interpreter:b_test_boolean_expression(E,LS,S,WF),
411		(nonvar(E),bsyntaxtree:check_if_typed_predicate(E),type_check(LS,store),type_check(S,store),
412		type_check(WF,wait_flag))).
413		:- assert_post(b_interpreter:b_test_boolean_expression(_,_,_,WF), type_check(WF,wait_flag)).
414
415
416		%b_test_boolean_expression(Expr,_,_,_) :- print('test: '),translate:print_bexpr(Expr),nl,print(Expr),nl,fail. %%
417
418		:- load_files(library(system), [when(compile_time), imports([environ/2])]).
419		:- if(environ(prob_debug_watch_flag,true)).
420		b_test_boolean_expressiond(b(Expr,_,Infos),LS,S,WF,Ai,Ao) :- !,
421		b_test_boolean_expression2(Expr,Infos,LS,S,WF,Ai,Ao).
422		b_test_boolean_expression(Expr,LS,S,WF,Ai,Ao) :- !,
423		(waitflag0_is_set(WF)
424		-> debug:watch(300,b_interpreter:b_test_boolean_expressiond(Expr,LS,S,WF,Ai,Ao))
425		; debug:watch_det(300,b_interpreter:b_test_boolean_expressiond(Expr,LS,S,WF,Ai,Ao)) ).
426		:- else.
427		b_test_boolean_expression(b(Expr,Type,Infos),LS,S,WF,Ai,Ao) :- !,
428		(preference(smt_supported_interpreter,true)
429		-> b_test_boolean_expression2(Expr,Infos,LS,S,WF,Ai,Ao),
430		get_wait_flag1(smt_call,WF,BeforeEnumWF),
431		gensym:gensym(smt_assertion_name,Symbol),
432		smt_add_predicate(BeforeEnumWF,b(Expr,Type,Infos),LS,S,Symbol)
433		;
434	?	b_test_boolean_expression2(Expr,Infos,LS,S,WF,Ai,Ao)).
435		:- endif.
436		b_test_boolean_expression(E,LS,S,WF,Ai,Ao) :-
437		add_internal_error('Boolean expression not properly wrapped: ',
438		b_test_boolean_expression(E,LS,S,WF,Ai,Ao)),
439		b_test_boolean_expression2(E,[],LS,S,WF,Ai,Ao).
440
441
442		b_test_boolean_expression2(truth,_,_,_,_WF,Ai,Ao) :- !,Ai=Ao.
443		b_test_boolean_expression2(falsity,_,_,_,_WF,_Ai,_Ao) :- !,fail.
444		b_test_boolean_expression2(negation(BExpr),_,LocalState,State,WF,Ai,Ao) :- !,
445	?	b_not_test_boolean_expression(BExpr,LocalState,State,WF,Ai,Ao).
446		b_test_boolean_expression2(conjunct(LHS,RHS),_,LocalState,State,WF,Ai,Ao) :- !,
447	?	b_test_boolean_expression(LHS,LocalState,State,WF,Ai,Aii),
448	?	b_test_boolean_expression(RHS,LocalState,State,WF,Aii,Ao).
449		b_test_boolean_expression2(implication(LHS,RHS),Info,LocalState,State,WF,Ai,Ao) :-
450		%b_compiler:b_compile(LHS,[],LocalState,State,CLHS), % this slows down Cruise benchmark from 3.75 s to 4.3
451		!,
452	?	b_test_implication(LHS,RHS,Info,LocalState,State,WF,Ai,Ao).
453		b_test_boolean_expression2(equivalence(LHS,RHS),_,LocalState,State,WF,Ai,Ao) :- !,
454	?	b_test_equivalence(LHS,RHS,LocalState,State,WF,Ai,Ao).
455		b_test_boolean_expression2(disjunct(LHS,RHS),Info,LocalState,State,WF,Ai,Ao) :- !,
456		% TO DO: normalise disjunct first ?
457		copy_wf_start(WF,disjunct,CWF),
458	?	if(b_check_boolean_expression(LHS,LocalState,State,CWF,PredRes,Ai,Aii),
459		% we can check lhs
460	?	if(b_interpreter_check:b_check_boolean_expression0(pred_false,PredRes,RHS,LocalState,State,CWF,RR,Aii,Ao),
461		( /* we can also check rhs */
462	?	b_interpreter_check:disjoin(PredRes,RR,pred_true,LHS,RHS,WF),
463		copy_wf_finish(WF,CWF)
464		),
465		(
466		Ao=Aii,
467		copy_wf_finish(WF,CWF),
468		imply_test_boolean_expression(PredRes,pred_false,RHS,LocalState,State,WF,Aii),
469		perfmessagecall(choice_point,reification_of_disjunction_rhs_failed,translate:print_bexpr(RHS),Info),
470		enumerate_bool(PredRes,15,WF)
471		)
472		),
473		% we cannot check lhs
474		if((always_well_defined(RHS),
475		b_check_boolean_expression(RHS,LocalState,State,CWF,PredRes,Ai,Aii)),
476		(
477		Ao=Aii,
478		copy_wf_finish(WF,CWF),
479		imply_test_boolean_expression(PredRes,pred_false,LHS,LocalState,State,WF,Aii),
480		perfmessagecall(choice_point,reification_of_disjunction_lhs_failed,translate:print_bexpr(LHS),Info),
481		enumerate_bool(PredRes,15,WF)
482		),
483		% we cannot check neither lhs nor rhs:
484		(Ai=Ao,
485		get_priority_of_boolean_expression2(disjunct(LHS,RHS),StartPrio),
486		%get_wait_flag(Prio,disjunct,WF,WF2),
487		get_binary_choice_wait_flag_exp_backoff(StartPrio,disjunct,WF,WF2),
488		% be sure that e.g. for (x=2 or x=3) both branches will be tested once deterministic propagation is over
489		%print(prio(Prio)), print(' : '),print_bexpr(LHS), print(' or '), print_bexpr(RHS),nl,
490		perfmessagecall(choice_point,reification_of_disjunction_failed,translate:print_bexpr(b(disjunct(LHS,RHS),pred,Info)),Info),
491		b_test_disjunction(LHS,RHS,LocalState,State,WF,WF2,Ai)
492		)
493		)
494		).
495		b_test_boolean_expression2(exists(Parameters,RHS),Infos,LocalState,State,WF,Ai,Ao) :- !,Ai=Ao,
496	?	b_test_exists(Parameters,RHS,Infos,LocalState,State,WF).
497		%b_test_boolean_expression2(forall(PARS,LHS,RHS),_Inf,LocalState,State,WF) :-
498		% PARS = [b(identifier(R1),integer,_),b(identifier(R2),integer,_)],
499		% LHS = b(conjunct(b(conjunct(MEM1,MEM2),pred,_I1),NEQ),pred,_I2),
500		% NEQ = b(not_equal(b(identifier(RR1),integer,_I3),b(identifier(RR2),integer,_I4)),pred,_I5),
501		% (RR1=R1, RR2=R2 ; RR1=R2, RR2=R1),
502		% MEM1 = b(member(b(identifier(RRR1),integer,_),b(SET,set(integer),_)),pred,_),
503		% MEM2 = b(member(b(identifier(RRR2),integer,_),b(SET,set(integer),_)),pred,_),
504		% (RRR1=R1, RRR2=R2 ; RRR1=R2, RRR2=R1),
505		% /* TO DO: check that RHS is symmetric ! */ /* TO DO : generalize symmetry breaking */
506		% !, % print(symmetry_breaking_forall(R1,R2)),nl,
507		% GT = b(less(b(identifier(R1),integer,_I3),b(identifier(R2),integer,_I4)),pred,_I5),
508		% NewLHS = b(conjunct(b(conjunct(MEM1,MEM2),pred,_I1),GT),pred,_I2),
509		% b_test_boolean_expression2(forall(PARS,NewLHS,RHS),_Inf,LocalState,State,WF).
510		b_test_boolean_expression2(forall(Parameters,LHS,RHS),Infos,LocalState,State,WF,Ai,Ao) :- !,Ai=Ao,
511		/* !ID.(LHS => RHS) */
512		% print_message(forall(Parameters,LHS,RHS)),
513		% get_wait_flag0(WF,WF0), when(nonvar(WF0),
514	?	b_for_all(Parameters,Infos,LHS,RHS,LocalState,State,WF). %).
515		b_test_boolean_expression2(let_predicate(Ids,AssignmentExprs,Pred),Infos,LocalState,State,WF,Ai,Ao) :- !,
516		Ai=Ao, % any expression inside the LET cannot be safely reused
517		(is_truth(Pred)
518		-> % useless let, only sense of computations below is in detecting WD errors
519		get_enumeration_starting_wait_flag(useless_let_predicate(Ids),WF,ESWF),
520		when(nonvar(ESWF),set_up_localstate_for_let(Ids,_,AssignmentExprs,LocalState,State,_LetState,WF))
521	?	; set_up_localstate_for_let(Ids,ParaValues,AssignmentExprs,LocalState,State,LetState,WF),
522		opt_push_wait_flag_call_stack_quantifier_info(WF,let_quantifier,Ids,ParaValues,Infos,WF2),
523	?	b_test_boolean_expression(Pred,LetState,State,WF2)). % we could pass Ai in if Ids fresh
524
525		b_test_boolean_expression2(lazy_let_pred(Id,AssignmentExpr,Expr),_I,LocalState,State,WF,Ai,Ao) :- !,
526		add_lazy_let_id_and_expression(Id,AssignmentExpr,LocalState,State,NewLocalState,WF,Ai),
527	?	b_test_boolean_expression(Expr,NewLocalState,State,WF,Ai,Ao). % we could use Ai,Ao version as lazy lets never interfere with each other and never invalidate existing expressions
528		b_test_boolean_expression2(lazy_lookup_pred(Id),_Info,LocalState,_State,WF,Ai,Ao) :- !, Ai=Ao,
529		lookup_value_for_existing_id_wf(Id,LocalState,(Trigger,Value),WF), % should normally only occur in LocalState; value introduced by lazy_let
530		(Trigger,Value) = (pred_true,pred_true). % force evaluation
531		b_test_boolean_expression2(value(PredVal),_Info,_LocalState,_State,_WF,Ai,Ao) :- !, % this can occur when lazy_lookup_pred gets compiled by b_compiler
532		is_pred_true(PredVal),Ai=Ao.
533		b_test_boolean_expression2(Pred,Info,LocalState,State,WF,Ai,Ao) :-
534		% TO DO: we could put some of the operators into the Ai store (comparison operators)
535	?	b_interpreter_check:register_predicate(Pred,Info,pred_true,Reused,Ai,Ao),
536		(Reused==true
537		-> %% print('REUSED: '), translate:print_bexpr(Pred),nl
538		true
539	?	; b_test_atomic_boolean_expression2(Pred,Info,LocalState,State,WF)).
540
541		:- block is_pred_true(-).
542		is_pred_true(X) :- (X=pred_true -> true ; X=pred_false -> fail ; add_internal_error('Illegal call: ',is_pred_true(X)),fail).
543		:- block is_pred_false(-).
544		is_pred_false(X) :- (X=pred_false -> true ; X=pred_true -> fail ; add_internal_error('Illegal call: ',is_pred_false(X)),fail).
545
546
547		% we could simply call disjunct(NegLHS,RHS) ?
548		% A => B has more of a feeling of a passive constraint than A or B
549		% hence we use a lower priority here for enumerate_bool below and do not
550		% try to reify rhs if lhs reification failed (but maybe we should)
551		b_test_implication(LHS,RHS,_Info,LocalState,State,WF,Ai,Ao) :-
552		copy_wf_start(WF,implication,CWF),
553	?	if(b_check_boolean_expression(LHS,LocalState,State,CWF,PredRes,Ai,Aii),
554		%% print('checking => '), print_bexpr(LHS), print(' '), print(PredRes),nl,
555		%% The following improves constraint propagation; but can be tricky with undefinedness
556		if((var(PredRes),always_well_defined(RHS),
557		b_check_boolean_expression(RHS,LocalState,State,CWF,RHSPredRes,Aii,Ao)),
558		(/* also propagate from right to left */
559	?	b_interpreter_check:imply_true(PredRes,RHSPredRes),
560		perfmessage_bexpr(good(reify),'Fully reified implication with LHS: ',LHS),
561	?	copy_wf_finish(WF,CWF)
562		),
563		( Aii=Ao,
564	?	copy_wf_finish(WF,CWF),
565	?	imply_test_boolean_expression(PredRes,pred_true,RHS,LocalState,State,WF,Aii),
566		(nonvar(PredRes) -> true
567		; performance_monitoring_on,
568		\+always_well_defined(RHS) -> perfmessage_bexpr(reify,'Cannot reify RHS of => due to WD condition, creating choice point:',RHS)
569		; perfmessage_bexpr(reify,'Cannot reify RHS of =>, creating choice point:',RHS)
570		),
571		enumerate_bool(PredRes,10000,WF) % lower priority than disjunction (15); we could use last_finite_priority ?
572		)
573		),
574		( Ai=Ao,
575		perfmessage_bexpr(reify,'Cannot reify LHS of =>, creating binary choice point:',LHS),
576		get_binary_choice_wait_flag(implication,WF,WF2),
577		block_test_implication(LHS,RHS,LocalState,State,WF,WF2)
578		)
579		).
580
581		% ------------
582
583		:- discontiguous b_test_atomic_boolean_expression2/5.
584		%b_test_atomic_boolean_expression2(Expr,T,LocalState,State,WF) :- print(eval(Expr,T)),nl,fail.
585		b_test_atomic_boolean_expression2(partition(LHS,RHS),_,LocalState,State,WF) :- !,
586		b_compute_expression(LHS,LocalState,State,SV1,WF), %print(lhs(SV1)),nl,
587		l_compute_expression(RHS,LocalState,State,SV2,WF), % RHS is Prolog list of expressions
588	?	kernel_call_predicate(partition_wf(SV1,SV2,WF),kernel_objects,WF,partition(LHS,RHS)).
589		b_test_atomic_boolean_expression2(member(TElem,TSet),_,LocalState,State,WF) :- !,
590	?	b_test_member_expression(TElem,TSet,LocalState,State,WF).
591		b_test_atomic_boolean_expression2(not_member(TElem,TSet),Info,LocalState,State,WF) :- !,
592		get_texpr_expr(TSet,Set),
593	?	b_test_notmember_expression(Set,TElem,TSet,Info,LocalState,State,WF).
594		b_test_atomic_boolean_expression2(freetype_case(Freetype,Case,Expr),_,LocalState,State,WF) :-
595		!,equal_object_wf(Value,freeval(Freetype,Case,_),b_test_atomic_boolean_expression2,WF),
596		b_compute_expression(Expr,LocalState,State,Value,WF). % NOT COVERED (16)
597		b_test_atomic_boolean_expression2(finite(SetExpr),_,LocalState,State,WF) :-
598		!, b_compute_expression(SetExpr,LocalState,State,Value,WF),
599		kernel_call_predicate(is_finite_set_wf(Value,WF),kernel_objects,WF,finite(SetExpr)).
600		/* Extension for Kodkod */
601		b_test_atomic_boolean_expression2(kodkod(ProblemId,_),_,LocalState,State,WF) :-
602		!,get_wait_flag1(kodkod_call,WF,WF0),
603		kodkod_request(ProblemId,pos,LocalState,State,WF0). % NOT COVERED (17)
604		%b_test_atomic_boolean_expression2(equal(Arg1,Arg2),_,LocalState,State,WF) :- get_texpr_type(Arg1,integer),!,
605		% b_compute_expression(Arg1,LocalState,State,ExprRes,WF),
606		% b_compute_expression(Arg2,LocalState,State,ExprRes,WF). /* avoids one extra variable compared to code below + could fail earlier ; but problem as b_compute_expression still uses = in some places */
607
608		:- include(b_arithmetic_expressions).
609		%The following clause improves Nqueens performance by about 50 %; by avoiding intermediate variables
610		% TO DO: do the same for >, <, >= ...
611		b_test_atomic_boolean_expression2(equal(Arg1,Arg2),Info,LocalState,State,WF) :- !,
612	?	b_test_atomic_equal_boolean_expression(Arg1,Arg2,Info,LocalState,State,WF).
613		b_test_atomic_boolean_expression2(not_equal(Arg1,Arg2),Info,LocalState,State,WF) :- !,
614	?	b_test_atomic_not_equal_boolean_expression(Arg1,Arg2,Info,LocalState,State,WF).
615		b_test_atomic_boolean_expression2(less_equal(Arg1,Arg2),_Info,LocalState,State,WF) :-
616		%get_texpr_type(Arg1,integer), % type checker already checks this
617		preferences:preference(use_clpfd_solver,true),
618		!,
619	?	b_compute_arith_expression(Arg1,LocalState,State,CLPFD_Expr1,WF),
620	?	b_compute_arith_expression(Arg2,LocalState,State,CLPFD_Expr2,WF),
621		clpfd_interface:clpfd_leq_expr(CLPFD_Expr1,CLPFD_Expr2).
622		b_test_atomic_boolean_expression2(greater_equal(Arg1,Arg2),_Info,LocalState,State,WF) :-
623		%get_texpr_type(Arg1,integer), % type checker already checks this
624		preferences:preference(use_clpfd_solver,true),
625		!,
626	?	b_compute_arith_expression(Arg1,LocalState,State,CLPFD_Expr1,WF),
627	?	b_compute_arith_expression(Arg2,LocalState,State,CLPFD_Expr2,WF),
628		clpfd_interface:clpfd_leq_expr(CLPFD_Expr2,CLPFD_Expr1).
629		b_test_atomic_boolean_expression2(less(Arg1,Arg2),_Info,LocalState,State,WF) :-
630		%get_texpr_type(Arg1,integer), % type checker already checks this
631		preferences:preference(use_clpfd_solver,true),
632		!,
633	?	b_compute_arith_expression(Arg1,LocalState,State,CLPFD_Expr1,WF),
634	?	b_compute_arith_expression(Arg2,LocalState,State,CLPFD_Expr2,WF),
635		clpfd_interface:clpfd_lt_expr(CLPFD_Expr1,CLPFD_Expr2).
636		b_test_atomic_boolean_expression2(greater(Arg1,Arg2),_Info,LocalState,State,WF) :-
637		%get_texpr_type(Arg1,integer), % type checker already checks this
638		preferences:preference(use_clpfd_solver,true),
639		!,
640	?	b_compute_arith_expression(Arg1,LocalState,State,CLPFD_Expr1,WF),
641		b_compute_arith_expression(Arg2,LocalState,State,CLPFD_Expr2,WF),
642		clpfd_interface:clpfd_lt_expr(CLPFD_Expr2,CLPFD_Expr1).
643		b_test_atomic_boolean_expression2(external_pred_call(FunName,Args),Info,LocalState,State,WF) :-
644		!,
645		(do_not_evaluate_args(FunName) -> EvaluatedArgs=[]
646	?	; b_compute_expressions(Args, LocalState,State, EvaluatedArgs, WF)),
647		push_wait_flag_call_stack_info(WF,external_call(FunName,EvaluatedArgs,Info),WF2),
648	?	call_external_predicate(FunName,Args,EvaluatedArgs,LocalState,State,pred_true,Info,WF2).
649		b_test_atomic_boolean_expression2(Expression,Info,LocalState,State,WF) :-
650		preferences:preference(use_clpfd_solver,false),
651		special_binary_predicate(Expression,Module:Kernel_predicate,Arg1,T1,Arg2,T2),
652		(nonmember(contains_wd_condition,Info) -> true ; preference(disprover_mode,true)),
653		!,
654		% print('Special call: '), print_bexpr(Expression),nl, print(Kernel_predicate),print(' : '),nl,
655		%(Arg1==list_of_expressions -> b_compute_expressions ... % no longer needed
656		b_compute_expression(Arg1,LocalState,State,SV1,WF),
657		b_compute_expression(Arg2,LocalState,State,SV2,WF),
658		KernelCall =.. [Kernel_predicate,SV1,T1,SV2,T2,WF],
659		kernel_call_predicate(KernelCall,Module,WF,Expression).
660		b_test_atomic_boolean_expression2(Expression,_,LocalState,State,WF) :-
661		functor(Expression,BOP,2),
662		kernel_mappings:binary_boolean_operator(BOP,Module:Kernel_predicate,WFEnabled),!,
663		arg(1,Expression,Arg1), arg(2,Expression,Arg2),
664	?	b_compute_expression(Arg1,LocalState,State,SV1,WF), % TODO: symbolic for some BOP: <:, <<: ?
665		(binary_boolean_operator_trivially_true(BOP,SV1)
666		-> check_well_defined(Arg2,LocalState,State,WF)
667	?	; b_compute_expression(Arg2,LocalState,State,SV2,WF),
668		( WFEnabled==yes ->
669		KernelCall =.. [Kernel_predicate,SV1,SV2,WF2],
670		(do_not_enumerate_binary_boolean_operator(BOP,Arg1,Arg2) % we assume: this is only true for WFEnabled predicates
671		-> add_wait_flag_info(WF,wfx_no_enumeration,WF2)
672		; WF2=WF)
673		; KernelCall =.. [Kernel_predicate,SV1,SV2], WF2=WF % note: WF2 still used in kernel_call_predicate
674		),
675	?	kernel_call_predicate(KernelCall,Module,WF2,Expression)
676		).
677		b_test_atomic_boolean_expression2(E,Info,_LS,_S,_WF) :-
678		add_internal_error('Uncovered boolean expression: ',b(E,pred,Info)),
679		print_functor(E),nl,
680		fail.
681
682
683		binary_boolean_operator_trivially_true(subset,X) :- X==[].
684
685		check_well_defined(Arg,_LocalState,_State,_WF) :-
686		always_well_defined(Arg),!.
687		check_well_defined(Arg,LocalState,State,WF) :-
688		b_compute_expression(Arg,LocalState,State,_,WF).
689
690		%:- use_module(specfile,[animation_minor_mode/1]).
691		:- use_module(b_machine_hierarchy,[abstract_constant/2, concrete_constant/2]).
692		b_test_atomic_equal_boolean_expression(Arg1,Arg2,_Info,LocalState,State,WF) :-
693		Arg1 = b(_,integer,_), %get_texpr_type(Arg1,integer),
694		preferences:preference(use_clpfd_solver,true),!,
695		(Arg2 = b(_,integer,_) -> true ; add_internal_error('Type error in AST, not wrapped integer: ',Arg2)),
696	?	b_test_arith_equal_boolean_expression(Arg1,Arg2,LocalState,State,WF).
697		b_test_atomic_equal_boolean_expression(Arg1,Arg2,Info,LocalState,State,WF) :-
698	?	member(prob_annotation('LAMBDA-EQUALITY'),Info),
699		\+ simple_expression(Arg2),
700		is_lambda_result_id(Arg1), %get_texpr_id(Arg1,'_lambda_result_'), % ensure we have not renamed it to was_lambda_result ?
701		!, % this is an equality for the result of a lambda abstraction; only evaluate at the end
702		b_compute_expression(Arg1,LocalState,State,SV1,WF), % this is the lambda result identifier _lambda_result_
703		%get_enumeration_finished_wait_flag(WF,EWF),
704		%get_wait_flag(10000,lambda_result,WF,EWF),
705		% compute deterministic parts of Arg2 in wf0 phase: avoid computing this stuff over again
706		%print('DELAY: '), translate:print_bexpr(Arg2),nl,
707	?	kernel_waitflags:copy_wf01e_wait_flags(WF,WF2), b_compute_expression(Arg2,LocalState,State,SV2,WF2),
708		get_last_wait_flag(lambda_result,WF,EWF),
709		ground_value_check(SV2,G2),
710		when((nonvar(G2);nonvar(SV1);nonvar(EWF)),b_lambda_result_equal_boolean_expression(SV1,SV2,WF,EWF,WF2)).
711		b_test_atomic_equal_boolean_expression(Arg1,Arg2,Info,LocalState,State,WF) :-
712		(LocalState = []
713		-> true % only check if we are at the outer level
714		% (not inside a quantifier,...) or if we have CSE introduzed lazy_lets:
715		; preferences:preference(use_common_subexpression_elimination,true)
716		% TO DO: check that we have only added @nr to local state from lazy_let; ADD INFO FIELD
717		),
718		get_texpr_type(Arg1,Type1), is_set_type(Type1,SetType1),
719		% previously we required SetType1 = couple(_,_)
720		get_texpr_id(Arg1,ID),
721		% we could check: \+ get_texpr_id(Arg2,_), we do not need to treat simple equations like ID=ID2; unless for memo?
722	?	(abstract_constant(ID,_) % check if ABSTRACT_CONSTANT
723		-> Kind=abstract,
724	?	kernel_objects:max_cardinality(Type1,MaxCard1),
725		(number(MaxCard1) % check that type is large enough to warrant recursive or symbolic treatment
726		-> (MaxCard1>100 -> true ; constant_variable_marked_as_memo(ID))
727		; true)
728		; %fail,
729	?	concrete_constant(ID,_)
730		-> Kind=concrete,
731		(constant_variable_marked_as_expand(ID)
732		-> true % note: we also check for expand annotation in store (expand_closure_value),
733		% but it is useful to expand ID already here to ease checking PROPERTIES
734		; constant_variable_marked_as_memo(ID))
735		%; b_is_unused_constant(ID) -> ABSTRACT=true % TO DO: check if ID not used somewhere else in Properties ??!!
736		),
737		% in future: we may do size change analysis, or something like that to check that we have properly defined
738		% recursive function
739		debug_format(19,'Equation defining ~w constant: ~w~n',[Kind,ID]),
740		!,
741		(constant_variable_marked_as_expand(ID) -> SymArg2 = Arg2 ; mark_bexpr_as_symbolic(Arg2,SymArg2)),
742	?	b_add_constant_definition(Kind,ID,Info,Arg1,SetType1,SymArg2,LocalState,State,WF).
743		b_test_atomic_equal_boolean_expression(Arg1,Arg2,Info,LocalState,State,WF) :-
744		constants_profiling_on,
745		get_texpr_id(Arg1,ID),b_is_constant(ID), !,
746		% Note: does not yet keep track of arithmetic equalities above
747		b_compute_expression(Arg1,LocalState,State,SV1,WF),
748		push_constant_def_equality_call_stack(WF,ID,Info,WF2),
749		start_profile(ID,T1),
750		b_compute_expression(Arg2,LocalState,State,SV2,WF2),
751		get_waitflags_phase(WF,Phase),
752		stop_constant_profile(SV2,Phase,ID,[],T1), % normal constant, not symbolic, memoized or recursive
753		start_propagation_profile(ID,T2,CstL1),
754		kernel_call_predicate_equal_object_optimized(SV1,SV2,WF),
755		stop_propagation_profile(SV2,ID,T2,CstL1).
756		b_test_atomic_equal_boolean_expression(Arg1,Arg2,_Info,LocalState,State,WF) :-
757	?	b_compute_expression(Arg1,LocalState,State,SV1,WF),
758	?	b_compute_expression(Arg2,LocalState,State,SV2,WF),
759	?	kernel_call_predicate_equal_object_optimized(SV1,SV2,WF).
760
761
762
763		% treat equality ID = Symbolic Function (or relation/set)
764		b_add_constant_definition(Kind,ID,Info,Arg1,SetType1,SymArg2,LocalState,State,WF) :-
765		% observe CTRL-C: e.g., in data validation models these abstract functions can be very large and costly to compute
766	?	observe_user_interrupt_signal(computing_value_for_abstract_constant(ID),SymArg2,
767		b_add_constant_definition_aux(Kind,ID,Info,Arg1,SetType1,SymArg2,LocalState,State,WF)).
768
769		:- use_module(runtime_profiler,[start_profile/2,
770		stop_constant_profile/5, constants_profiling_on/0]).
771		b_add_constant_definition_aux(Kind,ID,_Info,Arg1,SetType1,SymArg2,LocalState,State,WF) :-
772		preference(use_function_memoization,MemoPref), % true, false or default
773		MemoPref \= false, % turned off
774		( MemoPref = true, Kind=abstract ;
775		constant_variable_marked_as_memo(ID)), % description(memo) as info field using @desc memo pragma; see
776		!,
777		start_profile(ID,T1),
778		b_compute_expression(Arg1,LocalState,State,SV1,WF), % the identifier
779		(SymArg2 = b(recursive_let(TID,Body),_,_)
780		-> get_texpr_id(TID,RecID),
781		b_compute_expression(Body,[bind(RecID,RedIDVal)|LocalState],State,SV2,WF),
782		RecValue='$recursion_value'(RedIDVal), IDInfo = [recursive_memo]
783		; b_compute_expression(SymArg2,LocalState,State,SV2,WF),
784		RecValue='$no_recursion', IDInfo = [memoized]
785		),
786		get_waitflags_phase(WF,Phase), stop_constant_profile(SV2,Phase,ID,IDInfo,T1),
787		(nonvar(SV2), SV2 \= closure(_,_,_)
788		-> % value fully computed; no need to memoize
789		debug_println(19,not_memoizing(ID)),
790		kernel_call_predicate_equal_object_optimized(SV1,SV2,WF)
791		; (nonvar(SV2) -> mark_closure_as_symbolic(SV2,SV3) ; SV3=SV2),
792		memoization:register_memoization_function(ID,SV3,SetType1,RecValue,MEMOID,SV4),
793		debug_println(19,marking_for_memoization(ID,MEMOID)),
794		kernel_call_predicate_equal_object_optimized(SV1,SV4,WF)
795		).
796		b_add_constant_definition_aux(_Kind,ID,Info,Arg1,_,SymArg2,LocalState,State,WF) :-
797		start_profile(ID,T1),
798		b_compute_expression(Arg1,LocalState,State,SV1,WF), % the identifier ID
799		push_constant_def_equality_call_stack(WF,ID,Info,WF2),
800	?	b_compute_expression(SymArg2,LocalState,State,SV2,WF2),
801		(constant_variable_marked_as_expand(ID)
802		-> IDInfo = [marked_as_expand],
803		b_expand_compute_comprehension_set(SV2,Info,SV3,WF)
804		; definitely_expand_this_explicit_set(SV2) % check for a few patterns which should definitely be expanded;
805		% in case user puts a set accidentally into the ABSTRACT_CONSTANTS section
806		-> IDInfo = [automatic_expand],
807		b_expand_compute_comprehension_set(SV2,Info,SV3,WF)
808		; var(SV2) -> IDInfo = [], SV3=SV2
809		; IDInfo = [], % it is from ABSTRACT_CONSTANTS, but this info is already stored
810		mark_closure_as_symbolic(SV2,SV3)
811		),
812		get_waitflags_phase(WF,Phase), stop_constant_profile(SV3,Phase,ID,IDInfo,T1),
813		start_propagation_profile(ID,T2,CstL1),
814		kernel_call_predicate_equal_object_optimized(SV1,SV3,WF),
815		% profile propagation time and what constants are grounded
816		stop_propagation_profile(SV3,ID,T2,CstL1).
817
818		push_constant_def_equality_call_stack(WF,ID,Pos,WF2) :-
819		(constants_profiling_on
820		-> push_wait_flag_call_stack_info(WF,
821		id_equality_evaluation(ID,constant,Pos),WF2)
822		; WF2=WF).
823
824		start_propagation_profile(ID,T1,CstL1) :-
825		(constants_profiling_on -> findall(Cst1,det_solution_for_constant_was_stored(Cst1),CstL1) ; CstL1=[]),
826		start_profile(ID,T1).
827		stop_propagation_profile(SV3,ID,T1,CstL1) :-
828		(constants_profiling_on
829		-> findall(Cst2,det_solution_for_constant_was_stored(Cst2),L2),
830		append(CstL1,New,L2), debug_format(9,'Propagation of value for ~w instantiated ~w~n',[ID,New]),
831		IDInfo2 = [instantiates(New)]
832		; IDInfo2 = []),
833		stop_constant_profile(SV3,propagate_value,ID,IDInfo2,T1).
834
835		% treat not(Arg1 = Arg2) predicates
836		b_test_atomic_not_equal_boolean_expression(Arg1,Arg2,_Info,LocalState,State,WF) :-
837		get_texpr_type(Arg1,boolean),!, % special treatment : not_equal_object has no type information
838		b_compute_expression(Arg1,LocalState,State,B1,WF),
839		b_compute_expression(Arg2,LocalState,State,B2,WF),
840		negate(B1,B2). % from bool_pred
841		b_test_atomic_not_equal_boolean_expression(Arg1,Arg2,_Info,LocalState,State,WF) :-
842		get_texpr_type(Arg1,integer),
843		preferences:preference(use_clpfd_solver,true),
844		!,
845		% Note: calling b_compute_arith_expression will also instantiate a variable to at least the int(_) skeleton; thereby enabling propagation
846		% this is potentially better than calling the default versions of the predicates, which may wait until the int(_) skeleton is set up before propagation
847	?	b_compute_arith_expression(Arg1,LocalState,State,CLPFD_Expr1,WF),
848	?	b_compute_arith_expression(Arg2,LocalState,State,CLPFD_Expr2,WF),
849		clpfd_interface:clpfd_neq_expr(CLPFD_Expr1,CLPFD_Expr2).
850		b_test_atomic_not_equal_boolean_expression(Arg1,Arg2,_Info,LocalState,State,WF) :-
851	?	b_compute_expression_symbolic(Arg1,LocalState,State,SV1,WF),
852	?	b_compute_expression_symbolic(Arg2,LocalState,State,SV2,WF),
853		kernel_call_predicate_not_equal_object(SV1,SV2,WF,not_equal(Arg1,Arg2)).
854		% Note: symbolic case occurs for symbolic abstract constants f when using DOUBLE_EVALUATION
855		% in the evaluation view which are defined by f = %x... when checking f /=
856
857		% a version of b_compute_expression which does not try to expand comprehension sets
858		% TODO: deal with other constructs which merit symbolic treatment; union of comprehension sets, ...
859		% (see line 147 in AMASS_mchs/oriented_abscissa.mch)
860		b_compute_expression_symbolic(Arg,LocalState,State,Val,WF) :-
861		(Arg = b(comprehension_set(PP,CC),_,InfoCS) % second arg is a comprehension set;
862		-> % print(symbolic(PP)),nl,
863	?	b_compute_comprehension_set_symbolic(PP,CC,InfoCS,LocalState,State,Val,WF)
864	?	; b_compute_expression(Arg,LocalState,State,Val,WF)
865		).
866		% ditto for already de-constructed b/3 expression:
867		b_compute_expression2_symbolic(comprehension_set(PP,CC),_,InfoCS,LocalState,State,Val,WF) :- !,
868		b_compute_comprehension_set_symbolic(PP,CC,InfoCS,LocalState,State,Val,WF).
869		b_compute_expression2_symbolic(Arg,Type,Info,LocalState,State,Val,WF) :-
870		b_compute_expression2(Arg,Type,Info,LocalState,State,Val,WF).
871
872		simple_expression(b(A,_,_)) :- simple_expression_aux(A).
873		simple_expression_aux(boolean_true).
874		simple_expression_aux(boolean_false).
875		simple_expression_aux(empty_set).
876		simple_expression_aux(empty_sequence).
877		simple_expression_aux(integer(_)).
878		simple_expression_aux(max_int).
879		simple_expression_aux(min_int).
880		simple_expression_aux(string(_)).
881		simple_expression_aux(value(_)).
882
883
884		is_lambda_result_id(b(identifier('_lambda_result_'),_,_)).
885		% at the moment we only detect those identifiers; the info field is currently not updated for _was_lambda_result_
886		% and not available in other treatmens of _lambda_result_ (in b_enumerate)
887		%is_lambda_result_id(b(identifier(X),_,Info)) :-
888		% memberchk(lambda_result,Info).
889		% (X=='_lambda_result_' -> (memberchk(lambda_result,Info) -> true ; format('~n*** _lambda_result_ without info: ~w~n~N',[Info])) ; memberchk(lambda_result,Info)).
890
891		%:- block b_lambda_result_equal_boolean_expression(-,?,?, -,?). % we now use when above
892		% only compute lambda result when finished finding domain element, i.e., _EWF is grounded
893		b_lambda_result_equal_boolean_expression(SV1,SV2,WF,EWF,WF2) :-
894		kernel_call_predicate_equal_object_optimized(SV1,SV2,WF),
895		% print(' LAMBDA : '), print((SV1,_EWF)),nl,
896		% the inner waitflags are for evaluating the lambda_result Expression; unless there is a WD issue this should
897		% never fail; we can delay the enumeration as much as possible
898		% NOTE: even if SV2 is ground, Arg2 may not be (e.g., if Arg2 = prj2(..,..)(NotGr,Ground))
899	?	blocking_ground_copied_wait_flags(WF2,EWF). % without when we will ground WF0 which is shared with outer WF-store
900		:- block blocking_ground_copied_wait_flags(?,-).
901		blocking_ground_copied_wait_flags(WF2,_) :-
902	?	ground_constraintprop_wait_flags(WF2). % do not ground EF flag, as shared with outer WF and WF2 is copied
903
904		% TO DO: add avl_set+closure expansion
905		%b_test_member_expression(Expr,El,_Set,_LocalState,_State,_WF) :-
906		% print('test member: '),print_bexpr(Expr),nl,fail.
907		b_test_member_expression(TElem,b(Set,Type,Info),LocalState,State,WF) :-
908	?	b_test_member_expression2(Set,Type,Info,TElem,LocalState,State,WF).
909
910		% new profiler
911		%:- use_module('../extensions/profiler/profiler.pl').
912		%:- use_module('../extensions/profiler/profiler_te.pl').
913		%:- enable_profiling(b_test_member_expression2/7).
914
915		% old profiler
916		%:- use_module(covsrc(hit_profiler)).
917
918		b_test_member_expression2(comprehension_set(Par,Cond),_Type,_Info,El,LocalState,State,WF) :-
919		% used to call in next clause below: b_generate_closure_if_necessary(Par,Cond,LocalState,State,SetValue,WF) /* will not expand closure */
920		/* optimized case for dealing with comprehension_set ; however, does not seem to buy anything over older version with b_generate_closure_if_necessary in test 1079 */
921		/* new version buys about 6 % for {x| x:1..400000 & x:{n|n >= 9000 & n<= 600000 & n mod 100 = 0}} (Sep 3 2014) */
922		set_up_typed_localstate(Par,ValueList,_TypedVals,LocalState,NewLocalState,positive),
923		!,
924		convert_list_into_pairs(ValueList,ElementVal),
925		b_compute_expression(El,LocalState,State,ElementVal,WF),
926		b_test_boolean_expression(Cond,NewLocalState,State,WF).
927		b_test_member_expression2(SymbolicSetConstant,_Type,_Info,El,LocalState,State,WF) :-
928		%hit_profiler:add_profile_hit(SymbolicSetConstant),
929		cst_in_boolean_type(SymbolicSetConstant,Module:Kernel_predicate),!, % two cases : string_set and integer_set
930		b_compute_expression(El,LocalState,State,ElValue,WF),
931		functor(KernelCall,Kernel_predicate,2),
932		arg(1,KernelCall,ElValue),
933		arg(2,KernelCall,WF),
934		% print_message(cst_in_boolean_type_call(KernelCall)),
935		kernel_call_predicate(KernelCall,Module,WF,SymbolicSetConstant). % should be member(... SymbolicSetConstant)
936		b_test_member_expression2(Expression,_Type,Info,El,LocalState,State,WF) :-
937		functor(Expression,BOP,2),
938		binary_in_boolean_type(BOP,Module:Kernel_predicate),!,
939	?	b_compute_expression(El,LocalState,State,ElValue,WF),
940		arg(1,Expression,Arg1),arg(2,Expression,Arg2),
941		(binary_in_definitely_true(BOP,ElValue)
942		-> % no need to compute arguments; unless required for WD:
943		check_well_defined(Arg1,LocalState,State,WF),
944		check_well_defined(Arg2,LocalState,State,WF)
945		; b_compute_expression(Arg1,LocalState,State,SV1,WF),
946	?	b_compute_expression(Arg2,LocalState,State,SV2,WF),
947		opt_push_wait_flag_call_stack_info(WF,b_operator_call(member,[ElValue,b_operator(BOP,[SV1,SV2])],Info),WF2),
948		% for constant profiling: we could catch partial/total_fun checks here translate:print_bexpr(El),nl,translate:print_bexpr(b(Expression,_Type,Info)),nl,nl,
949	?	binary_in_kernel_call(Module,Kernel_predicate,ElValue,SV1,SV2,WF2,Expression)
950		).
951		b_test_member_expression2(Expression,_Type,Info,El,LocalState,State,WF) :-
952		functor(Expression,UnOP,1),
953		unary_in_boolean_type(UnOP,Module:Kernel_predicate),!,
954		b_compute_expression(El,LocalState,State,ElValue,WF),
955		arg(1,Expression,Arg1),
956		(unary_in_definitely_true(UnOP,ElValue)
957		-> % no need to compute arguments; unless required for WD:
958		check_well_defined(Arg1,LocalState,State,WF)
959	?	; b_compute_expression(Arg1,LocalState,State,SV1,WF),
960		opt_push_wait_flag_call_stack_info(WF,b_operator_call(member,[ElValue,b_operator(UnOP,[SV1])],Info),WF2),
961	?	unary_in_kernel_call(Module,Kernel_predicate,ElValue,SV1,WF2,Expression)
962		).
963		b_test_member_expression2(SetExpression,Type,Info,El,LocalState,State,WF) :-
964	?	b_compute_expression2(SetExpression,Type,Info,LocalState,State,SetValue,WF),
965		(always_well_defined_or_disprover_mode(El)
966		-> SetValue \== [] % if we have the empty set: check_element will always fail
967		; true % we could check SetValue \== [] if find_abort_values=false ??
968		),
969	?	b_compute_expression(El,LocalState,State,Element,WF),
970		Span = El, % Info is quite often the empty list
971		(not_invertible(El) % then no sense in setting up member constraint f(...) : SetValue ;
972		% we cannot used the info anyway; but we could enumerate
973		-> % we wait until Element is fully known before doing the check
974		ground_value_check(Element,GrEl),
975		when(nonvar(GrEl),kernel_call_predicate_check_element_of_wf(Element,SetValue,WF,Span))
976	?	; kernel_call_predicate_check_element_of_wf(Element,SetValue,WF,Span)).
977
978		:- use_module(external_functions,[external_fun_can_be_inverted/1]).
979		not_invertible(b(E,_,_)) :- not_inv_aux(E).
980		not_inv_aux(external_function_call(FunName,_Args)) :- \+ external_fun_can_be_inverted(FunName).
981		% TO DO: capture other cases like function applications
982		% TO DO: also do this in b_interpreter_check ?
983		% TO DO: We should compute this information in ast_cleanup; e.g., what if we do STRING_TO_INT(s)+1 : SET
984
985		% TO DO: >>> 2:{x,v} --> special case for set_extension([b(identifier(x),integer,[nodeid(none)]),b(identifier(v),integer,[nodeid(none)])]) --> 2=x or 2=v --> evaluate [x,v] -> sort and then use list member (or should b_ast_cleanup do this) ?
986
987		:- use_module(kernel_lists,[not_element_of_list_wf/3]).
988		b_test_notmember_expression(set_extension(Ex),El,_Set,_,LocalState,State,WF) :- !,
989		b_compute_expressions(Ex,LocalState,State,ExValueList,WF),
990		b_compute_expression(El,LocalState,State,ElementVal,WF),
991		not_element_of_list_wf(ElementVal,ExValueList,WF).
992		b_test_notmember_expression(SymbolicSetCst,El,_Set,_,LocalState,State,WF) :-
993		kernel_mappings:cst_not_in_boolean_type(SymbolicSetCst,Module:Kernel_predicate),!,
994		b_compute_expression(El,LocalState,State,ElValue,WF),
995		functor(KernelCall,Kernel_predicate,1),
996		arg(1,KernelCall,ElValue),
997		% debug_print(cst_not_in_boolean_type(9,KernelCall)),
998		kernel_call_predicate(KernelCall,Module,WF,SymbolicSetCst).
999		b_test_notmember_expression(Expression,El,_Set,Info,LocalState,State,WF) :-
1000		functor(Expression,BOP,2),
1001		kernel_mappings:binary_not_in_boolean_type(BOP,Module:Kernel_predicate),!,
1002		b_compute_expression(El,LocalState,State,ElValue,WF),
1003		\+ binary_in_definitely_true(BOP,ElValue),
1004		arg(1,Expression,Arg1),arg(2,Expression,Arg2),
1005		b_compute_expression(Arg1,LocalState,State,SV1,WF),
1006		b_compute_expression(Arg2,LocalState,State,SV2,WF),
1007		% KernelCall =.. [Kernel_predicate,ElValue,SV1,SV2,WF],
1008		opt_push_wait_flag_call_stack_info(WF,b_operator_call(not_member,[ElValue,b_operator(BOP,[SV1,SV2])],Info),WF2),
1009	?	kernel_call_predicate3(Kernel_predicate,ElValue,SV1,SV2,Module,WF2,Expression).
1010		b_test_notmember_expression(Expression,El,_Set,Info,LocalState,State,WF) :-
1011		functor(Expression,UnOP,1),
1012		unary_not_in_boolean_type(UnOP,Module:Kernel_predicate),!,
1013		b_compute_expression(El,LocalState,State,ElValue,WF),
1014		\+ unary_in_definitely_true(UnOP,ElValue),
1015		arg(1,Expression,Arg1),
1016		b_compute_expression(Arg1,LocalState,State,SV1,WF),
1017		%KernelCall =.. [Kernel_predicate,ElValue,SV1,WF],
1018		%kernel_call_predicate(KernelCall,Module,WF,Expression).
1019		opt_push_wait_flag_call_stack_info(WF,b_operator_call(not_member,[ElValue,b_operator(UnOP,[SV1])],Info),WF2),
1020		kernel_call_predicate2(Kernel_predicate,ElValue,SV1,Module,WF2,Expression).
1021		b_test_notmember_expression(Expr,Elem,Set,_Info,LocalState,State,WF) :-
1022		(Expr=comprehension_set(Par,Cond)
1023		-> b_generate_closure_if_necessary(Par,Cond,LocalState,State,SetValue,WF) /* will not expand closure */
1024		; b_compute_expression(Set,LocalState,State,SetValue,WF)
1025		),
1026		(SetValue == []
1027		-> /* nothing can be member of empty set */
1028		check_well_defined(Elem,LocalState,State,WF)
1029		% we could disable this check if find_abort_values=true
1030		; b_compute_expression(Elem,LocalState,State,ElemValue,WF),
1031		%kernel_call_predicate2(not_element_of_wf,ElemValue,SetValue,kernel_objects,WF,Expr)
1032		%kernel_call_predicate(not_element_of_wf(ElemValue,SetValue,WF),kernel_objects,WF,Expr)
1033		kernel_call_predicate_not_element_of_wf(ElemValue,SetValue,WF)
1034		).
1035
1036		:- block block_test_implication(?,?,?,?,?,-).
1037		block_test_implication(LHS,RHS,LocalState,State,WF,_WF2) :-
1038	?	b_test_inner_boolean_expression(LHS,LocalState,State,WF),
1039		b_test_inner_boolean_expression(RHS,LocalState,State,WF).
1040		block_test_implication(LHS,_RHS,LocalState,State,WF,_WF2) :-
1041	?	b_not_test_inner_boolean_expression(LHS,LocalState,State,WF).
1042
1043
1044		b_test_equivalence(LHS,RHS,LocalState,State,WF,Ai,Ao) :-
1045		copy_wf_start(WF,equivalence,CWF),
1046	?	if(b_check_boolean_expression(LHS,LocalState,State,CWF,PredRes,Ai,Aii),
1047	?	(b_check_test_equivalence(PredRes,LHS,RHS,LocalState,State,CWF,Aii,Ao),
1048		copy_wf_finish(WF,CWF)),
1049		(% check LHS fails, We could check if RHS can be checked with b_check_boolean_expression
1050		Ai=Ao, get_binary_choice_wait_flag(equivalence,WF,WF2),
1051		b_enum_test_equivalence(LHS,RHS,LocalState,State,WF,WF2,Ai))).
1052		b_not_test_equivalence(LHS,RHS,LocalState,State,WF,Ai,Ao) :-
1053		copy_wf_start(WF,not_equivalence,CWF),
1054		if(b_check_boolean_expression(LHS,LocalState,State,CWF,PredRes,Ai,Aii),
1055		(negate(PredRes,NegPredRes), % from bool_pred
1056		b_check_test_equivalence(NegPredRes,LHS,RHS,LocalState,State,CWF,Aii,Ao),
1057		copy_wf_finish(WF,CWF)),
1058		(% check LHS fails, We could check if RHS can be checked with b_check_boolean_expression
1059		Ai=Ao, get_binary_choice_wait_flag(not_equivalence,WF,WF2),
1060		b_enum_not_test_equivalence(LHS,RHS,LocalState,State,WF,WF2,Ai))).
1061		b_check_test_equivalence(PredRes,LHS,RHS,LocalState,State,WF,Aii,Ao) :-
1062		% print('checking <=> '), print_bexpr(LHS), print(' '), print(PredRes),nl,
1063	?	(var(PredRes),b_check_boolean_expression(RHS,LocalState,State,WF,PredRes2,Aii,Ao) % TO DO <---- REPLACE CUT
1064		-> /* also propagate from right to left */
1065	?	equiv_bidrectional_test_boolean_expression(PredRes,PredRes2,LHS,RHS,LocalState,State,WF)
1066		; Aii=Ao,
1067	?	equiv_test_boolean_expression(PredRes,pred_true,RHS,LocalState,State,WF,Aii)
1068		). % should we also add a binary choice flag ?? what about a=2 <=> b/=3 ??
1069
1070		:- block b_enum_test_equivalence(?,?,?,?,?,-,?).
1071		b_enum_test_equivalence(LHS,RHS,LocalState,State,WF,_WF2,Ai) :-
1072		b_test_boolean_expression(LHS,LocalState,State,WF,Ai,Aii), % TO DO: we could call b_test_inner_boolean_expression with Ai
1073		b_test_boolean_expression(RHS,LocalState,State,WF,Aii,_).
1074		b_enum_test_equivalence(LHS,RHS,LocalState,State,WF,_WF2,Ai) :-
1075		b_not_test_boolean_expression(LHS,LocalState,State,WF,Ai,Aii),
1076		b_not_test_boolean_expression(RHS,LocalState,State,WF,Aii,_).
1077
1078		%enumerate_bool(X,WF) :- !.
1079		enumerate_bool(X,Prio,WF) :- (nonvar(X) -> true /* already set */
1080		; get_wait_flag0(WF,WF0),
1081		enumerate_bool0(X,Prio,WF,WF0)).
1082
1083		:- block enumerate_bool0(?,?,?,-).
1084		enumerate_bool0(X,Prio,WF,_) :- (nonvar(X) -> true /* already set */
1085		; %print(enum_bool(X)), translate:print_bexpr(LHS),nl,
1086		% get_binary_choice_wait_flag(enumerate_bool,WF,WF2),
1087		get_wait_flag(Prio,enumerate_bool,WF,WF2), % what priority should we use ?? give time for other enumerators to decide the lhs of the disjunct; actions_cbtc is slower to setup with low priority
1088		enumerate_bool_aux(X,WF2)).
1089		:- block enumerate_bool_aux(-,-).
1090		%enumerate_bool_aux(P,WF) :- var(P),print(forcing_bool(P,WF)),nl,fail. %
1091		enumerate_bool_aux(pred_true,_).
1092		enumerate_bool_aux(pred_false,_).
1093
1094		:- block b_test_disjunction(?,?,?,?,?,-,?).
1095		b_test_disjunction(LHS,_RHS,LocalState,State,WF,_WF2,Ai) :-
1096	?	b_test_boolean_expression(LHS,LocalState,State,WF,Ai,_).
1097		b_test_disjunction(LHS,RHS,LocalState,State,WF,_WF2,Ai) :-
1098	?	b_not_test_boolean_expression(LHS,LocalState,State,WF,Ai,Aii),
1099	?	b_test_boolean_expression(RHS,LocalState,State,WF,Aii,_).
1100
1101		:- block b_not_test_conjunction(?,?,?,?,?,-,?).
1102		b_not_test_conjunction(LHS,_RHS,LocalState,State,WF,_WF2,Ai) :-
1103		b_not_test_boolean_expression(LHS,LocalState,State,WF,Ai,_).
1104		b_not_test_conjunction(LHS,RHS,LocalState,State,WF,_WF2,Ai) :-
1105	?	b_test_boolean_expression(LHS,LocalState,State,WF,Ai,Aii),
1106	?	b_not_test_boolean_expression(RHS,LocalState,State,WF,Aii,_).
1107
1108		:- block b_enum_not_test_equivalence(?,?,?,?,?,-,?).
1109		b_enum_not_test_equivalence(LHS,RHS,LocalState,State,WF,_WF2,Ai) :-
1110		b_test_boolean_expression(LHS,LocalState,State,WF,Ai,Aii), % we could call b_test_inner_boolean_expression with Ai
1111		b_not_test_boolean_expression(RHS,LocalState,State,WF,Aii,_).
1112		b_enum_not_test_equivalence(LHS,RHS,LocalState,State,WF,_WF2,Ai) :-
1113		b_not_test_boolean_expression(LHS,LocalState,State,WF,Ai,Aii),
1114		b_test_boolean_expression(RHS,LocalState,State,WF,Aii,_).
1115
1116
1117
1118		/* --------------------------------------*/
1119		/* b_not_test_boolean_expression */
1120		/* --------------------------------------*/
1121
1122		b_not_test_list_of_boolean_expression([],_,_,_WF).
1123		b_not_test_list_of_boolean_expression([B1|T],LS,S,WF) :-
1124		b_not_test_boolean_expression(B1,LS,S,WF),
1125		b_not_test_list_of_boolean_expression(T,LS,S,WF).
1126
1127		:- assert_pre(b_interpreter:b_not_test_boolean_expression_cs(E,LS,S,_,_),
1128		(bsyntaxtree:check_if_typed_predicate(E),type_check(LS,store),type_check(S,store))).
1129		:- assert_post(b_interpreter:b_not_test_boolean_expression_cs(_,_,_,_,_), true).
1130
1131
1132		% a version where we can provide an initial call stack entry for context
1133		b_not_test_boolean_expression_cs(E,LS,S,PredKind,Nr) :-
1134		init_wait_flags_cs(E,PredKind,Nr,b_not_test_boolean_expression_cs,WF), % TODO: we could register negation info
1135		% TO DO: call b_trace_test_components ?
1136	?	b_not_test_boolean_expression(E,LS,S,WF),
1137	?	ground_wait_flags(WF).
1138
1139		b_not_test_boolean_expression(E,LS,S,WF) :-
1140	?	empty_avl(Ai), b_not_test_boolean_expression(E,LS,S,WF,Ai,_).
1141
1142		:- assert_pre(b_interpreter:b_not_test_boolean_expression(E,LS,S,WF),
1143		(type_check(E,boolean_expression),type_check(LS,store),type_check(S,store), type_check(WF,wait_flag))).
1144		:- assert_post(b_interpreter:b_not_test_boolean_expression(_,_,_,_), true).
1145
1146		:- if(environ(prob_debug_watch_flag,true)).
1147		b_not_test_boolean_expression(b(Expr,_,Infos),LS,S,WF,Ai,Ao) :- !,
1148		(waitflag0_is_set(WF)
1149		-> debug:watch(400,b_interpreter:b_not_test_boolean_expression2(Expr,Infos,LS,S,WF,Ai,Ao))
1150		; debug:watch_det(400,b_interpreter:b_not_test_boolean_expression2(Expr,Infos,LS,S,WF,Ai,Ao)) ).
1151		:- else.
1152		b_not_test_boolean_expression(b(Expr,Type,Infos),LS,S,WF,Ai,Ao) :- !,
1153		(preference(smt_supported_interpreter,true)
1154		-> b_not_test_boolean_expression2(Expr,Infos,LS,S,WF,Ai,Ao),create_negation(b(Expr,Type,Infos),Neg),
1155		get_wait_flag1(smt_call,WF,BeforeEnumWF),
1156		gensym:gensym(smt_assertion_name,Symbol),
1157		smt_add_predicate(BeforeEnumWF,Neg,LS,S,Symbol)
1158	?	; b_not_test_boolean_expression2(Expr,Infos,LS,S,WF,Ai,Ao)).
1159		:- endif.
1160		b_not_test_boolean_expression(E,LS,S,WF,Ai,Ao) :-
1161		add_internal_error('Boolean (not) expression not properly wrapped: ',
1162		b_not_test_boolean_expression(E,LS,S,WF,Ai,Ao)),
1163		b_not_test_boolean_expression2(E,[],LS,S,WF,Ai,Ao).
1164
1165		b_not_test_boolean_expression2(truth,_,_,_,_WF,_Ai,_Ao) :- !,fail.
1166		b_not_test_boolean_expression2(falsity,_,_,_,_WF,Ai,Ao) :- !,Ai=Ao. % NOT COVERED (2)
1167		b_not_test_boolean_expression2(negation(BExpr),_,LocalState,State,WF,Ai,Ao) :- !,
1168		b_test_boolean_expression(BExpr,LocalState,State,WF,Ai,Ao).
1169		% following makes test 349 fail:
1170		%b_not_test_boolean_expression2(conjunct(LHS,RHS),Infos,LocalState,State,WF,Ai,Ao) :- !,
1171		% nl, print(' NOT: '),translate:print_bexpr(b(conjunct(LHS,RHS),pred,Infos)),nl,
1172		% create_negation(LHS,NegLHS), % TO DO: avoid this construction by generalising code for disjunct
1173		% create_negation(RHS,NegRHS),
1174		% b_test_boolean_expression2(disjunct(NegLHS,NegRHS),Infos,LocalState,State,WF,Ai,Ao).
1175		b_not_test_boolean_expression2(conjunct(LHS,RHS),Infos,LocalState,State,WF,Ai,Ao) :- !,
1176		b(conjunct(LHS,RHS),pred,Infos) = Conj,
1177		copy_wf_start(WF,not_conjunct,CWF),
1178	?	if(b_check_boolean_expression(Conj,LocalState,State,CWF,PredRes,Ai,Ao),
1179		(PredRes=pred_false,
1180	?	copy_wf_finish(WF,CWF)
1181		),
1182		if(b_check_boolean_expression(LHS,LocalState,State,CWF,LHSPredRes,Ai,Ao), % some redundant work with call above: TODO: avoid !
1183		(copy_wf_finish(WF,CWF),
1184		get_last_wait_flag(not_conjunct_rhs,WF,WF2), % before starting to enumerate infinite types: better try both possibilities:
1185	?	b_not_test_conjunction_rhs(LHSPredRes,RHS,LocalState,State,WF,Ai,WF2)
1186		),
1187		(Ai=Ao,
1188		get_priority_of_boolean_expression2(disjunct(LHS,RHS),StartPrio),
1189		%get_wait_flag(Prio,not_conjunct,WF,WF2),
1190		get_binary_choice_wait_flag_exp_backoff(StartPrio,not_conjunct,WF,WF2),
1191		% TO DO: we could check if LHS or RHS are registered in Ai as pred_true/pred_false ??
1192		b_not_test_conjunction(LHS,RHS,LocalState,State,WF,WF2,Ai))
1193		)
1194		).
1195
1196		b_not_test_boolean_expression2(implication(LHS,RHS),_,LocalState,State,WF,Ai,Ao) :- !,
1197		b_test_boolean_expression(LHS,LocalState,State,WF,Ai,Aii),
1198	?	b_not_test_boolean_expression(RHS,LocalState,State,WF,Aii,Ao).
1199		b_not_test_boolean_expression2(equivalence(LHS,RHS),_,LocalState,State,WF,Ai,Ao) :- !,
1200		b_not_test_equivalence(LHS,RHS,LocalState,State,WF,Ai,Ao).
1201		b_not_test_boolean_expression2(disjunct(LHS,RHS),_,LocalState,State,WF,Ai,Ao) :- !,
1202		b_not_test_boolean_expression(LHS,LocalState,State,WF,Ai,Aii),
1203		b_not_test_boolean_expression(RHS,LocalState,State,WF,Aii,Ao).
1204		b_not_test_boolean_expression2(lazy_let_pred(Id,AssignmentExpr,Expr),_I,LocalState,State,WF,Ai,Ao) :- !,
1205		add_lazy_let_id_and_expression(Id,AssignmentExpr,LocalState,State,NewLocalState,WF,Ai),
1206		b_not_test_boolean_expression(Expr,NewLocalState,State,WF,Ai,Ao). % we could use Ai,Ao version as lazy lets never interfere with each other and never invalidate existing expressions
1207		b_not_test_boolean_expression2(lazy_lookup_pred(Id),_Info,LocalState,_State,WF,Ai,Ao) :- !, Ai=Ao,
1208		lookup_value_for_existing_id_wf(Id,LocalState,(Trigger,Value),WF), % should normally only occur in LocalState; value introduced by lazy_let
1209		(Trigger,Value) = (pred_true,pred_false). % force evaluation
1210		b_not_test_boolean_expression2(value(PredVal),_Info,_LocalState,_State,_WF,Ai,Ao) :- !, % this can occur when lazy_lookup_pred gets compiled by b_compiler
1211		is_pred_false(PredVal),Ai=Ao.
1212		b_not_test_boolean_expression2(Expr,Info,LocalState,State,WF,Ai,Ao) :-
1213		% TO DO: we could put some of the operators into the Ai store (comparison operators)
1214	?	b_not_test_atomic_boolean_expression2(Expr,Info,LocalState,State,WF,Ai,Ao).
1215
1216		% Other boolean expressions, not involving boolean connectives
1217		b_not_test_atomic_boolean_expression2(exists(Parameters,RHS),Infos,LocalState,State,WF,Ai,Ao) :- !,
1218		/* #ID.(RHS) */
1219		Ai=Ao,
1220	?	b_not_test_exists(Parameters,RHS,Infos,LocalState,State,compile,WF).
1221		b_not_test_atomic_boolean_expression2(forall(Parameters,LHS,RHS),Infos,LocalState,State,WF,Ai,Ao) :- !,
1222		/* !ID.(LHS => RHS) */
1223		Ai=Ao,
1224		safe_create_texpr(negation(RHS),pred,Negation),
1225		conjunct_predicates_with_pos_info(LHS,Negation,Condition),
1226		% conjunct_predicates merges the used_ids Info in Condition
1227	?	b_test_exists(Parameters,Condition,Infos,LocalState,State,WF).
1228		/* TODO(DP, 2.8.2008): Extension for Z: a let-statement as predicate */
1229		b_not_test_atomic_boolean_expression2(let_predicate(Ids,AssignmentExprs,Pred),Infos,LocalState,State,WF,Ai,Ao) :-
1230		!,Ai=Ao, % any expression inside the LET cannot be safely reused
1231	?	set_up_localstate_for_let(Ids,ParaValues,AssignmentExprs,LocalState,State,LetState,WF),
1232		opt_push_wait_flag_call_stack_quantifier_info(WF,let_quantifier,Ids,ParaValues,Infos,WF2),
1233	?	b_not_test_boolean_expression(Pred,LetState,State,WF2). % NOT COVERED (10)
1234		/* TODO(DP, 2.8.2008): */
1235		b_not_test_atomic_boolean_expression2(freetype_case(Freetype,Case,Expr),_,LocalState,State,WF,Ai,Ao) :-
1236		!,Ai=Ao,b_compute_expression(Expr,LocalState,State,freeval(Freetype,RealCase,_),WF),
1237		dif(RealCase,Case). % NOT COVERED (11)
1238		b_not_test_atomic_boolean_expression2(finite(SetExpr),_,LocalState,State,WF,Ai,Ao) :-
1239		!, Ai=Ao,b_compute_expression(SetExpr,LocalState,State,Value,WF),
1240		kernel_call_predicate(is_infinite_set_wf(Value,WF),kernel_objects,WF,finite(SetExpr)).
1241		/* Extension for Kodkod */
1242		b_not_test_atomic_boolean_expression2(kodkod(ProblemId,_),_,LocalState,State,WF,Ai,Ao) :-
1243		!,Ai=Ao,get_wait_flag1(kodkod_negative_call,WF,WF0),
1244		kodkod_request(ProblemId,neg,LocalState,State,WF0). % NOT COVERED (12)
1245		b_not_test_atomic_boolean_expression2(partition(LHS,RHS),Info,LocalState,State,WF,Ai,Ao) :- !,
1246		b_interpreter_check:register_predicate(partition(LHS,RHS),Info,pred_false,Reused,Ai,Ao),
1247		(Reused==true -> true
1248		; b_compute_expression(LHS,LocalState,State,SV1,WF),
1249		l_compute_expression(RHS,LocalState,State,SV2,WF), % RHS is Prolog list of expressions
1250		kernel_call_predicate(not_partition_wf(SV1,SV2,WF),kernel_objects,WF,partition(LHS,RHS))
1251		).
1252		b_not_test_atomic_boolean_expression2(external_pred_call(FunName,Args),Info,LocalState,State,WF,Ai,Ao) :-
1253		!, Ai=Ao,
1254		(do_not_evaluate_args(FunName) -> EvaluatedArgs=[]
1255		; b_compute_expressions(Args, LocalState,State, EvaluatedArgs, WF)),
1256		push_wait_flag_call_stack_info(WF,external_call(FunName,EvaluatedArgs,Info),WF2),
1257		call_external_predicate(FunName,Args,EvaluatedArgs,LocalState,State,pred_false,Info,WF2).
1258		b_not_test_atomic_boolean_expression2(Pred,Info,LocalState,State,WF,Ai,Ao) :-
1259		b_interpreter_check:register_predicate(Pred,Info,pred_false,Reused,Ai,Ao),
1260		(Reused==true
1261		-> %% print('REUSED (not): '), translate:print_bexpr(Pred),nl,
1262		true
1263	?	; b_not_test_atomic_boolean_expression3(Pred,Info,LocalState,State,WF)).
1264		b_not_test_atomic_boolean_expression3(Expression,Info,LocalState,State,WF) :-
1265		functor(Expression,BOP,2),
1266	?	kernel_mappings:negate_binary_boolean_operator(BOP,NBOP),
1267		arg(1,Expression,Arg1),arg(2,Expression,Arg2),!,
1268		NExpression =.. [NBOP,Arg1,Arg2],
1269	?	b_test_atomic_boolean_expression2(NExpression,Info,LocalState,State,WF).
1270		b_not_test_atomic_boolean_expression3(Expression,Info,LocalState,State,WF) :-
1271		functor(Expression,BOP,2),
1272		kernel_mappings:negate_binary_boolean_operator_swap(BOP,NBOP),
1273		arg(1,Expression,Arg1),arg(2,Expression,Arg2),!,
1274		NExpression =.. [NBOP,Arg2,Arg1],
1275		b_test_atomic_boolean_expression2(NExpression,Info,LocalState,State,WF).
1276		b_not_test_atomic_boolean_expression3(E,_,_,_,_WF) :-
1277		add_internal_error('Uncovered boolean expression (not): ',E),
1278		print_functor(E),nl,fail.
1279
1280
1281		% test RHS of not-conjunction depending on outcome of LHS
1282		:- block b_not_test_conjunction_rhs(-,?,?,?,?,?,-).
1283		b_not_test_conjunction_rhs(pred_false,_RHS,_LocalState,_State,_WF,_Ai,_LWF).
1284		b_not_test_conjunction_rhs(pred_true,RHS,LocalState,State,WF,Ai,_LWF) :-
1285	?	b_not_test_boolean_expression(RHS,LocalState,State,WF,Ai,_).
1286
1287		/* -----------------------------*/
1288		/* b_compute_expression */
1289		/* -----------------------------*/
1290
1291
1292
1293		:- assert_must_succeed((b_interpreter:b_compute_expression(b(pow_subset(
1294		b(identifier(nm),set(integer),[])),set(set(integer)),[]),
1295		[], [bind(nm,[])],R,_WF),
1296		nonvar(R), custom_explicit_sets:expand_custom_set_to_list(R,[[]]))).
1297		:- assert_must_succeed((b_interpreter:b_compute_expression(b(pow_subset(
1298		b(identifier(nm),set(boolean),[])),set(set(boolean)),[]),[],
1299		[bind(nm,[pred_false /* bool_false */])],R,_WF),
1300		nonvar(R), custom_explicit_sets:expand_custom_set_to_list(R,ER),
1301		kernel_objects:equal_object(ER,[[pred_false /* bool_false */],[]]))).
1302
1303		:- assert_pre(b_interpreter:b_compute_expression(Exp,LS,State,_Val,WF),
1304		(nonvar(Exp),
1305		bsyntaxtree:check_if_typed_expression(Exp),
1306		type_check(LS,store),type_check(State,store), type_check(WF,wait_flag))).
1307		:- assert_post(b_interpreter:b_compute_expression(_E,_LS,_State,Val,WF),
1308		(b_interpreter:value_type(Val), type_check(WF,wait_flag))). %, nonvar(Val)
1309
1310		b_compute_expression_nowf(E,LS,S,R) :-
1311		b_compute_expression_nowf(E,LS,S,R,none,0).
1312
1313		b_compute_expression_nowf(E,LS,S,R,FormulaKind,Nr) :-
1314		get_texpr_info(E,Info),
1315	?	b_compute_expression_nowf(E,LS,S,R,FormulaKind,Nr,Info).
1316		b_compute_expression_nowf(E,LS,S,R,FormulaKind,Nr,Span) :-
1317	?	b_compute_expression_no_wf8(E,LS,S,R,FormulaKind,Nr,default,Span).
1318		% a variation where we tell ProB to expect non-symbolic / explicit values
1319		b_compute_explicit_epression_no_wf(E,LS,S,R,FormulaKind,Nr) :-
1320		get_texpr_info(E,Info),
1321	?	b_compute_explicit_epression_no_wf(E,LS,S,R,FormulaKind,Nr,Info).
1322		b_compute_explicit_epression_no_wf(E,LS,S,R,FormulaKind,Nr,Span) :-
1323	?	b_compute_expression_no_wf8(E,LS,S,R,FormulaKind,Nr,expect_explicit_value,Span).
1324		b_compute_expression_no_wf8(E,LS,S,R,FormulaKind,Nr,Expect,Span) :-
1325		%add_message(b_compute_expression,'Called Version wo WFLAGS: ', b_compute_expression(E,LS,S,R)),
1326		(Expect=expect_explicit_value -> WFInfos = [expect_explicit_value] ; WFInfos = []),
1327		(FormulaKind = none -> init_wait_flags(WF,WFInfos)
1328		; CallStackEntry = prob_command_context(eval_expr_command(FormulaKind,Nr),Span),
1329		init_wait_flags_and_push_call_stack(no_wf_available,CallStackEntry,WFInfos,WF)
1330		),
1331	?	b_compute_expression(E,LS,S,R,WF),
1332	?	ground_wait_flags(WF), % this will add abort errors and fail before enumerating the result:
1333		init_wait_flags(WF2,[b_compute_expression_nowf2]),
1334		get_texpr_type(E,Type),
1335		b_enumerate:b_tighter_enumerate_single_value(R,Type,Span,b_compute_expression_nowf,WF2), %should rarely be necessary
1336		% a non-ground result only occurs when WD error appears and in this case ground_wait_flags will fail after
1337		% adding the abort error (and thus no value is returned)
1338		% exceptions are test 1066 with a complicated set comprehension used in a function application
1339		% test 1861 relies on two phase enumeration
1340		ground_wait_flags(WF2).
1341
1342		l_compute_expression([],_LS,_S,[],_WF).
1343		l_compute_expression([H|T],LS,S,[CH|CT],WF) :-
1344		b_compute_expression(H,LS,S,CH,WF),
1345		l_compute_expression(T,LS,S,CT,WF).
1346
1347		:- if(environ(prob_debug_watch_flag,true)).
1348		b_compute_expressiond(b(Expr,Type,Info),LS,S,R,WF) :- !,
1349		((ground(Type), Type \== pred, Type \== subst) -> true
1350		; add_error_wf(b_compute_expression,'Expression has illegal type: ',b(Expr,Type,Info),WF)),
1351		check_value(R,b(Expr,Type,Info)),
1352		b_compute_expression2(Expr,Type,Info,LS,S,R,WF).
1353		:- block check_value(-,?).
1354		check_value(pred_true,_) :- !. check_value(pred_false,_) :- !.
1355		check_value(string(_),_) :- !.
1356		check_value([],_) :- !.
1357		check_value([H|T],E) :- !, check_value(H,E), check_value(T,E).
1358		check_value((A,B),E) :- !, check_value(A,E), check_value(B,E).
1359		check_value(fd(N,T),E) :- !, (nonvar(T) -> check_fd(N,T,E) ; check_err(fd(N,T),E)).
1360		check_value(global_set(GS),E) :- !,(nonvar(GS) -> true ; check_err(global_set(GS),E)).
1361		check_value(avl_set(AS),E) :- !,((nonvar(AS),AS=node(_,_,_,_,_)) -> true ; check_err(global_set(AS),E)).
1362		check_value(int(X),E) :- !,check_int(X,E).
1363		check_value(closure(P,T,B),E) :- !,
1364		(ground(P),ground(T),nonvar(B)
1365		-> (same_length(P,T) -> bsyntaxtree:check_ast(B) ; check_err(closure_not_same_length(P,T)))
1366		; check_err(closure(P,T,B),E)).
1367		check_value(rec(_),_) :- !. %TODO: check
1368		check_value(X,E) :- check_err(uncovered(X),E).
1369		% TO DO: add records + more thorough checking of global_set and closures and avl_sets
1370		:- block check_int(-,?).
1371		check_int(X,E) :- (number(X) -> true ; check_err(int(X),E)).
1372		:- block check_fd(-,?,?).
1373		check_fd(X,T,E) :- (number(X),b_get_fd_type_bounds(T,Low,Up),X>=Low,X=<Up -> true ; check_err(fd(X,T),E)).
1374
1375		check_err(V,E) :- add_internal_error('Illegal value when computing expression: ',V:E).
1376		b_compute_expression(E,LS,S,R,WF) :- !,
1377		(waitflag0_is_set(WF)
1378		-> debug:watch(100,b_interpreter:b_compute_expressiond(E,LS,S,R,WF))
1379		; debug:watch_det(100,b_interpreter:b_compute_expressiond(E,LS,S,R,WF))).
1380		:- else.
1381		b_compute_expression(b(Expr,Type,Info),LS,S,R,WF) :- !,
1382		((ground(Type), Type \== pred, Type \== subst) -> true
1383		; Type==pred -> add_internal_error_wf(b_interpreter,'Expected expression, not predicate: ',b(Expr,Type,Info),Info,WF)
1384		; Type==subst -> add_internal_error_wf(b_interpreter,'Expected expression, not substitution: ',b(Expr,Type,Info),Info,WF)
1385		; add_internal_error_wf(b_interpreter,'Expression has non-ground type: ',b(Expr,Type,Info),Info,WF)
1386		),
1387	?	b_compute_expression2(Expr,Type,Info,LS,S,R,WF).
1388		:- endif.
1389		b_compute_expression(Expr,LS,S,R,WF) :-
1390		add_internal_error('Expression not properly wrapped: ',b_compute_expression(Expr,LS,S,R,WF)),
1391		b_compute_expression2(Expr,unknown,[],LS,S,R,WF).
1392
1393
1394		:- use_module(bsyntaxtree,[get_texpr_set_type/2]).
1395
1396		%:- use_module(b_global_sets,[b_type2_set/2]).
1397		%b_compute_expression2(V,T,I,LS,S,R,_WF) :- nonvar(R), print('result_instantiated: '(R:V)),nl,fail.
1398	?	b_compute_expression2(value(Val),_T,_I,_LS,_S,V,WF) :- !, equal_object_wf(Val,V,WF). %Val=V.
1399		b_compute_expression2(boolean_true,_T,_I,_LState,_State,Res,_WF) :- !, Res = pred_true /* bool_true */. % for simple types we can use ordinary unification
1400		b_compute_expression2(boolean_false,_T,_I,_LState,_State,Res,_WF) :- !, Res = pred_false /* bool_false */.
1401		b_compute_expression2(integer_set(NSET),_T,_I,_LState,_State,Res,WF) :- !, equal_object_wf(Res,global_set(NSET),WF). %Res = global_set(NSET).
1402		b_compute_expression2(bool_set,_T,_I,_LState,_State,Res,WF) :- !, % b_type2_set(bool,Res).
1403		equal_object_wf(Res,avl_set(node(pred_false,true,1,empty,node(pred_true,true,0,empty,empty))),WF).
1404		% was equal_object(Res,[pred_true /* bool_true */,pred_false /* bool_false */]) % changing this to avl used to break test 800 Bosch Deadlock v9; probably because of identity closure detection instantiation
1405		b_compute_expression2(float_set,_T,_I,_LState,_State,Res,WF) :- !, equal_object_wf(Res,global_set('FLOAT'),WF).
1406		b_compute_expression2(real_set,_T,_I,_LState,_State,Res,WF) :- !, equal_object_wf(Res,global_set('REAL'),WF).
1407		b_compute_expression2(string_set,_T,_I,_LState,_State,Res,WF) :- !, equal_object_wf(Res,global_set('STRING'),WF).
1408		% was all_strings(Res). %% NOT COVERED (6)
1409		b_compute_expression2(string(S),_T,_I,_LState,_State,Res,_WF) :- !,
1410		% TODO(ML,26.8.2008): Check if we should use a different functor for syntax tree vs data
1411		Res = string(S).
1412		b_compute_expression2(typeset,Type,_I,_LState,_State,Res,WF) :- !,
1413		is_set_type(Type,ElType), % we could generate global_set('STRING'),... for certain types
1414		equal_object_wf(Res,closure('_zzzz_unary',[ElType],b(truth,pred,[])),WF).
1415		b_compute_expression2(empty_set,_T,_I,_LState,_State,Res,_WF) :- !, empty_set(Res).
1416		b_compute_expression2(empty_sequence,_T,_I,_LState,_State,Res,_WF) :- !, empty_sequence(Res).
1417		b_compute_expression2(event_b_identity,EType,_I,_LState,_State,Res,WF) :-
1418		get_set_type(EType,couple(Type,Type)),!,
1419		event_b_identity_for_type(Type,Res,WF).
1420		b_compute_expression2(integer(Val),_T,_I,_LocalState,_State,Res,_WF) :- !, Res = int(Val).
1421		b_compute_expression2(max_int,_T,_I,_LS,_S,Res,_WF) :-
1422		preferences:get_preference(maxint,CVal),!, Res = int(CVal).
1423		b_compute_expression2(min_int,_T,_I,_LS,_S,Res,_WF) :-
1424		preferences:get_preference(minint,CVal),!, Res = int(CVal).
1425		b_compute_expression2(identifier(Id),Type,Info,LocalState,State,Res,WF) :- !,
1426		lookup_value_in_store_and_global_sets_wf(Id,Type,LocalState,State,Value,Info,WF),
1427		equal_object_wf(Res,Value,WF).
1428		b_compute_expression2(lazy_lookup_expr(Id),_Type,_Info,LocalState,_State,Res,WF) :- !,
1429		lookup_value_for_existing_id_wf(Id,LocalState,(Trigger,Value),WF), % should normally only occur in LocalState; value introduced by lazy_let
1430		Trigger = pred_true, % force evaluation
1431		equal_object_wf(Res,Value,WF).
1432		b_compute_expression2(lazy_let_expr(Id,AssignmentExpr,Expr),_T,_I,LocalState,State,Value,WF) :-
1433		!,
1434		add_lazy_let_id_and_expression(Id,AssignmentExpr,LocalState,State,NewLocalState,WF),
1435		%Trigger = pred_true, % expressions cannot be delayed !? (TO DO: more refined check)
1436		%block_lazy_compute_expression(Trigger,_,AssignmentExpr,LocalState,State,IdValue,WF,Ai),
1437		b_compute_expression(Expr,NewLocalState,State,Value,WF).
1438		b_compute_expression2(real(Atom),_T,_I,_LocalState,_State,Res,_WF) :- !, construct_real(Atom,Res).
1439		b_compute_expression2(rec(Fields),_T,_I,LocalState,State,Record,WF) :- !,
1440	?	l_compute_field(Fields,LocalState,State,FieldValues,WF),
1441	?	construct_record_wf(FieldValues,Record,WF).
1442		b_compute_expression2(record_field(RecEx,Name),_T,_I,LocalState,State,Value,WF) :- !,
1443	?	b_compute_expression(RecEx,LocalState,State,RecValue,WF),
1444		access_record_wf(RecValue,Name,Value,WF).
1445		b_compute_expression2(freetype_set(Id),_T,_I,_LState,_State,Val,_WF) :- !, Val=freetype(Id). %% NOT COVERED (17)
1446		b_compute_expression2(function(Function,FunArg),Type,Info,LocalState,State,Res,WF) :- !,
1447	?	b_compute_expression_function(Function,FunArg,Type,Info,LocalState,State,Res,WF).
1448		b_compute_expression2(card(b(Arg1,Type,Info)),integer,OuterInfo,LocalState,State,Card,WF) :- !,
1449	?	b_compute_card(Arg1,Type,Info,OuterInfo,LocalState,State,Card,WF).
1450		b_compute_expression2(max(b(Arg1,Type,Info)),integer,_I,LocalState,State,Max,WF) :- !,
1451		b_compute_max(Arg1,Type,Info,LocalState,State,Max,WF).
1452		b_compute_expression2(min(b(Arg1,Type,Info)),integer,_I,LocalState,State,Min,WF) :- !,
1453	?	b_compute_min(Arg1,Type,Info,LocalState,State,Min,WF).
1454		b_compute_expression2(set_extension(Ex),Type,_I,LocalState,State,Res,WF) :- !,
1455	?	b_compute_expressions(Ex,LocalState,State,ExValue,WF),
1456		kernel_call(b_interpreter:convert_list_of_expressions_into_set_wf(ExValue,ValueSet,Type,WF),ExValue,WF, set_extension(Ex)),
1457	?	equal_object_wf(Res,ValueSet,WF).
1458		%kernel_call_convert_list_of_expressions_into_set_wf(ExValue,ValueSet,Type, WF).
1459		%b_compute_expression('ListTermes'(ListOfEx),LocalState,State,ValueSet,WF) :- !,
1460		% /* convert list of expressions of CASE statement into set of elements */
1461		% b_compute_expression(ListOfEx,LocalState,State,Value,WF),
1462		% init_wait_flags(WF),convert_list_of_expressions_into_set_wf(Value,ValueSet,set(any),WF),ground_wait_flags(WF).
1463		b_compute_expression2(sequence_extension(Ex),_T,_I,LocalState,State,ValueSeq,WF) :- !,
1464	?	b_compute_expressions(Ex,LocalState,State,Value,WF),
1465		kernel_call(b_interpreter:convert_list_of_expressions_into_sequence(Value,ValueSeq),Value,WF,sequence_extension(Ex)).
1466		b_compute_expression2(convert_bool(PRED),_T,_I,LocalState,State,Val,WF) :- !, /* B bool(.) operator */
1467	?	b_convert_bool(PRED,LocalState,State,WF,Val).
1468		b_compute_expression2(couple(El1,El2),_T,_I,LocalState,State,Result,WF) :- !, Result = (Val1,Val2),
1469	?	b_compute_expression(El1,LocalState,State,Val1,WF),
1470	?	b_compute_expression(El2,LocalState,State,Val2,WF).
1471		b_compute_expression2(comprehension_set(Parameters,Condition),_T,Info,LocalState,State,Result,WF) :- !,
1472	?	b_compute_comprehension_set(Parameters,Condition,Info,LocalState,State,Result,WF).
1473		b_compute_expression2(recursive_let(TId,TSet),OrigType,OrigInfo,LocalState,State,Result,WF) :- !,
1474		% LET TId = TSet in TSet
1475		( get_texpr_expr(TSet,comprehension_set(Parameters,Condition)) ->
1476		true % if the argument TSet is a comprehension set,
1477		% we just add a recursive parameter
1478		; get_texpr_set_type(TSet,Type) ->
1479		% if not, we construct a new comprehension set {x | x:TSet}
1480		unique_typed_id("_tmparg_",Type,TArg),
1481		Parameters=[TArg],
1482		safe_create_texpr(member(TArg,TSet),pred,Condition)
1483		;
1484		add_internal_error('Expected set as argument to recursive_let',
1485		b_compute_expression2(recursive_let(TId,TSet),OrigType,OrigInfo,LocalState,State,Result,WF)),fail
1486		),
1487		% Generate closure where the references to the recursion are kept
1488		% add recursion ID to parameters to prevent removal of references during compilation
1489		generate_recursive_closure(TId,recursion,[TId|Parameters],Condition,LocalState,State,Closure1,WF),
1490		% add_message(b_interpreter,'Recursive Let for: ',TId,TId),
1491		% remove recursion ID from parameters after compilation
1492		Closure1=closure([_|P],[_|T],Cond),RClosure=closure(P,T,Cond),
1493		% Generate closure where the references to the recursion are kept
1494		generate_recursive_closure(TId,RClosure,Parameters,Condition,LocalState,State,Result,WF).
1495		b_compute_expression2(general_sum(Ids,Condition,Expression),Type,Info,LocalState,State,SumResult,WF) :- !,
1496		b_general_sum_or_mul(Ids,Condition,Expression,Type,Info,LocalState,State,SumResult,WF,sum).
1497		b_compute_expression2(general_product(Ids,Condition,Expression),Type,Info,LocalState,State,MulResult,WF) :- !,
1498		b_general_sum_or_mul(Ids,Condition,Expression,Type,Info,LocalState,State,MulResult,WF,mul).
1499		/* Begin: Extensions for Z */
1500		b_compute_expression2(if_then_else(If,Then,Else),T,_I,LocalState,State,Value,WF) :- !,
1501		opt_push_wait_flag_call_stack_info(WF,b_expr_call(if_test,If),WF2),
1502	?	b_try_check_boolean_expression_wf(If,LocalState,State,WF2,PredRes),
1503		(var(PredRes), can_get_full_fd_value(T), preferences:preference(use_clpfd_solver,true),
1504		always_well_defined(Then), always_well_defined(Else)
1505		% Note: always_well_defined_or_disprover_mode probably not ok, as we evaluate the expressions unconditionally
1506		-> b_clpfd_if_then_else(PredRes,T,Then,Else,LocalState,State,Value,WF)
1507	?	; b_compute_if_then_else(PredRes,Then,Else,LocalState,State,Value,WF)
1508		).
1509		b_compute_expression2(let_expression_global(Ids,AssignmentExprs,Expr),_T,Info,LocalState,State,Value,WF) :-
1510		debug_println(4,global_let(Ids,Info)),
1511		% store variables globally (not in LocalState) to be visible to subsidiary operation_calls
1512		!, set_up_localstate_for_global_let(Ids,AssignmentExprs,LocalState,State,LetState,WF),
1513		b_compute_expression(Expr,LocalState,LetState,Value,WF).
1514		b_compute_expression2(let_expression(Ids,AssignmentExprs,Expr),_T,_I,LocalState,State,Value,WF) :-
1515	?	!, set_up_localstate_for_let(Ids,_ParaValues,AssignmentExprs,LocalState,State,LetState,WF),
1516	?	b_compute_expression(Expr,LetState,State,Value,WF). %% NOT COVERED (30)
1517		b_compute_expression2(freetype_constructor(Id,Case,Expr),_T,_I,LocalState,State,FreeValue,WF) :-
1518		!, FreeValue = freeval(Id,Case,Value),
1519		b_compute_expression(Expr,LocalState,State,Value,WF). %% NOT COVERED (32)
1520		b_compute_expression2(freetype_destructor(Id,Case,Expr),_T,Info,LocalState,State,Value,WF) :-
1521		!, b_compute_expression(Expr,LocalState,State,freeval(Id,VCase,VValue),WF),
1522		check_freetype_case(Id,Case,VCase,VValue,Value,Info,WF).
1523		/* End: Extensions for Z */
1524		b_compute_expression2(assertion_expression(Cond,ErrMsg,Expr),T,Info,LocalState,State,Value,WF) :- !,
1525		opt_push_wait_flag_call_stack_info(WF,
1526		span_predicate(b(assertion_expression(Cond,ErrMsg,b(value(string('')),string,[])),T,Info),LocalState,State),WF2),
1527		% should we use another term for call stack?
1528		(get_preference(disprover_mode,true) -> PredRes = pred_true ; true), % in Disprover mode we know Cond must be true
1529	?	b_try_check_boolean_expression_no_enum_wf(Cond,LocalState,State,WF2,PredRes), % DO NOT ENUM, unless we cannot reify
1530		% does not make sense to enumerate PredRes as with pred_false we get no value anyway
1531		% however, we may get pending co-routines if Cond cannot be reified
1532		( PredRes==pred_false ->
1533		translate_bexpression_with_limit(Cond,100,CS),
1534		add_wd_error_span(ErrMsg,CS,span_predicate(Cond,LocalState,State),WF2),
1535		get_last_wait_flag(assertion_expression,WF2,WFC),
1536		when(nonvar(WFC),
1537		(ground_value(Value) -> true % we have a WD Error, any Value goes
1538		; b_compute_expression(Expr,LocalState,State,Value,WF2) % compute Value; avoid infinite enumeration of possible values; useful e.g. for prj1/prj2 assertion expressions
1539		))
1540	?	; b_compute_expression(Expr,LocalState,State,Value,WF),
1541		add_wd_error_if_false(PredRes,ErrMsg,Cond,span_predicate(Cond,LocalState,State),WF2)
1542		). %% NOT COVERED (34)
1543		b_compute_expression2(multiplication(Arg1,Arg2),integer,Info,LocalState,State,Value,WF) :-
1544		same_texpr(Arg1,Arg2), !, % is less useful when CLPFD is already turned on, calls square(Arg1,Value,WF)
1545		b_compute_expression(Arg1,LocalState,State,SV1,WF),
1546		unary_kernel_call(kernel_objects,square,SV1,Value,WF,multiplication(Arg1,Arg1),integer,Info).
1547		b_compute_expression2(image(Relation,Set),_EType,_Info,LocalState,State,Value,WF) :-
1548		special_operator_for_image(Relation,Kind,Args),
1549		% we have closure1(Rel)[Set] or similar -> avoid computing full closure
1550		!,
1551	?	b_compute_expression(Set,LocalState,State,SV,WF),
1552		b_compute_expressions(Args,LocalState,State,EArgs,WF),
1553	?	kernel_call(bsets_clp:image_for_special_operator(Kind,EArgs,SV,Value,WF),[SV|EArgs],WF,image(Relation,Set)).
1554		b_compute_expression2(external_function_call(FunName,Args),EType,Info,LocalState,State,Value,WF) :-
1555		!,
1556	?	b_compute_expressions(Args, LocalState,State, EvaluatedArgs, WF),
1557		push_wait_flag_call_stack_info(WF,external_call(FunName,EvaluatedArgs,Info),WF2),
1558	?	call_external_function(FunName,Args,EvaluatedArgs,Value,EType,Info,WF2).
1559		b_compute_expression2(Expression,EType,Info,LocalState,State,Res,WF) :-
1560		is_set_type(EType,Type),
1561		/* avoid evaluating certain expensive expressions:
1562		convert them into symbolic closures and expand only if really required */
1563		functor(Expression,UnOp,1),
1564		symbolic_closure_unary_operator(UnOp),
1565		/* TO DO: UNFOLD THIS OR WRAP in CONSTRUCTOR */
1566		arg(1,Expression,BType),
1567		!, %preferences:get_preference(convert_types_into_closures,true),!,
1568		% print_message(delayed_un_op(UnOp,BType)),
1569	?	b_compute_expression(BType,LocalState,State,ArgValue,WF),
1570		( do_not_keep_symbolic_unary(UnOp,ArgValue),
1571		unary_function(UnOp,Module,KernelFunction) ->
1572		/* special treatment for empty set or other situations: no need to keep symbolic */
1573	?	unary_kernel_call(Module,KernelFunction,ArgValue,Res,WF,Expression,EType,Info)
1574		;
1575		get_texpr_type(BType,ArgType),
1576		create_texpr(value(ArgValue),ArgType,[],TValue),
1577		ClosureSetExpression =.. [UnOp,TValue],
1578		construct_member_closure('_zzzz_unary',Type,Info,ClosureSetExpression,Value),
1579	?	((unop_to_be_marked_as_symbolic(UnOp,ArgValue) ; member(prob_annotation('SYMBOLIC'),Info)) ->
1580		mark_closure_as_symbolic(Value,SValue),
1581		equal_object_wf(Res,SValue,WF)
1582		; equal_object_wf(Res,Value,WF))
1583
1584		).
1585		b_compute_expression2(Expression,EType,Info,LocalState,State,Res,WF) :-
1586		is_set_type(EType,Type),
1587		/* avoid evaluating certain expensive expressions:
1588		convert them into symbolic closures and expand only if really required */
1589		functor(Expression,BinOp,2),
1590		arg(1,Expression,BType1),
1591		arg(2,Expression,BType2),
1592		kernel_mappings:symbolic_closure_binary_operator(BinOp),
1593		!,
1594		%preferences:get_preference(convert_types_into_closures,true),!,
1595	?	b_compute_expression(BType1,LocalState,State,ArgValue1,WF),
1596		(binary_arg1_determines_value(BinOp,ArgValue1,DetResult)
1597		-> /* print(det(BinOp,ArgValue1)),nl, */
1598		equal_object_wf(Res,DetResult,b_compute_expression2(BinOp),WF)
1599		; b_compute_expression(BType2,LocalState,State,ArgValue2,WF),
1600		% print_message(delayed_bin_op(BinOp,ArgValue1,ArgValue2)),
1601		(is_definitely_empty(BinOp,ArgValue1,ArgValue2)
1602		-> empty_set(Res)
1603		; if(do_not_keep_symbolic(BinOp,ArgValue1,ArgValue2,ERes,WF),
1604		% then:
1605		equal_object_wf(Res,ERes,b_compute_expression2(BinOp),WF),
1606		% else:
1607		(get_texpr_type(BType1,TypeArg1), create_texpr(value(ArgValue1),TypeArg1,[],TArg1),
1608		get_texpr_type(BType2,TypeArg2), create_texpr(value(ArgValue2),TypeArg2,[],TArg2),
1609		ClosureSetExpression =.. [BinOp,TArg1,TArg2],
1610		construct_member_closure('_zzzz_unary',Type,Info,ClosureSetExpression,Value),
1611		% print('Constructed Symbolic Closure : '), translate:print_bvalue(Value),nl,
1612	?	(binop_to_be_marked_as_symbolic(BinOp,ArgValue1,ArgValue2) ->
1613		mark_closure_as_symbolic(Value,SValue),
1614		equal_object_wf(Res,SValue,WF)
1615		; equal_object_wf(Res,Value,WF))
1616		)
1617		) % if
1618		)
1619		).
1620		b_compute_expression2(Expression,Type,Info,LocalState,State,Value,WF) :-
1621		functor(Expression,Op,1),
1622		unary_function(Op,Module,KernelFunction),
1623		arg(1,Expression,Arg1),!,
1624		%opt_push_wait_flag_call_stack_info(WF,b_operator_arg_evaluation(Op,1,[SV1],Arg1),WF1),
1625	?	b_compute_expression(Arg1,LocalState,State,SV1,WF),
1626	?	unary_kernel_call(Module,KernelFunction,SV1,Value,WF,Expression,Type,Info).
1627		b_compute_expression2(Expression,Type,Info,LocalState,State,Value,WF) :-
1628		functor(Expression,Op,2),
1629		binary_function(Op,Module,KernelFunction),
1630		arg(1,Expression,Arg1),
1631		arg(2,Expression,Arg2),!,
1632		%opt_push_wait_flag_call_stack_info(WF,b_operator_arg_evaluation(Op,1,[SV1,_],Arg1),WF1),
1633	?	b_compute_expression(Arg1,LocalState,State,SV1,WF),
1634		(binary_arg1_determines_value(Op,SV1,Result) % we could disable this if find_abort_values=true or if SV1 not guaranteed to be wd
1635		->
1636		equal_object_wf(Value,Result,b_compute_expression2(Op),WF)
1637	?	; b_compute_expression(Arg2,LocalState,State,SV2,WF),
1638	?	binary_kernel_call(Module,KernelFunction,SV1,SV2,Value,WF,Expression,Type,Info)
1639		).
1640		b_compute_expression2(operation_call_in_expr(Operation,Parameters),_T,Info,LocalState,State,Value,WF) :-
1641		!, def_get_texpr_id(Operation,op(OperationName)),
1642		% TODO: check that this is a query operation; probably done in type checker
1643		b_execute_operation_in_expression(OperationName,LocalState,State,Parameters,Value,Info,WF).
1644		b_compute_expression2(E,T,Info,_L,_S,_R,_WF) :-
1645		(T==pred -> add_internal_error('Uncovered expression; looks like a predicate in the wrong place: ',b(E,T,Info))
1646		; T==subst -> add_internal_error('Uncovered expression; looks like a substitution in the wrong place: ',b(E,T,Info))
1647		; requires_cleanup_pre(E) -> add_internal_error('Non-cleaned up ambiguous expression: ',b(E,T,Info))
1648		; add_internal_error('Uncovered expression: ',b(E,T,Info))
1649		),
1650		print_functor(E), print(' : '), print(T),nl,fail.
1651
1652		requires_cleanup_pre(mult_or_cart(_,_)).
1653		requires_cleanup_pre(minus_or_set_subtract(_,_)).
1654
1655		make_couplise([A],R) :- !,R=A.
1656		make_couplise([A,B],R) :- !,R=(A,B).
1657		make_couplise([A,B|Rest],Result) :- !,
1658		make_couplise([(A,B)|Rest],Result).
1659		make_couplise(A,_) :- add_internal_error('Illegal operation call result:',A),fail.
1660
1661		% ---
1662
1663
1664		% check if a symbolic_closure_unary_operator result should be marked with prob_annotation(SYMBOLIC)
1665		% because direct sub-args are marked SYMBOLIC
1666		unop_to_be_marked_as_symbolic(UnOp,Value) :- nonvar(Value),
1667	?	to_be_marked_as_symbolic_aux(UnOp,Value).
1668		to_be_marked_as_symbolic_aux(struct,rec(Fields)) :- !,
1669	?	member(field(_,SymbolicClosure),Fields),
1670	?	is_symbolic_closure(SymbolicClosure).
1671		%to_be_marked_as_symbolic_aux(pow_subset,SymbolicClosure) :- is_symbolic_closure(SymbolicClosure).
1672		%to_be_marked_as_symbolic_aux(pow1_subset,SymbolicClosure) :- is_symbolic_closure(SymbolicClosure).
1673	?	to_be_marked_as_symbolic_aux(_,SymbolicClosure) :- is_symbolic_closure(SymbolicClosure).
1674
1675		% check if a symbolic_closure_binary_operator result should be marked with prob_annotation(SYMBOLIC)
1676		% because direct sub-args are marked SYMBOLIC
1677		binop_to_be_marked_as_symbolic(interval,_,_) :- !, fail.
1678		%binop_to_be_marked_as_symbolic(overwrite,_,_) :- !, true. % TO DO: fix by detecting infinite <+ closures
1679	?	binop_to_be_marked_as_symbolic(set_subtraction,ArgVal1,_) :- !, is_symbolic_closure(ArgVal1).
1680		binop_to_be_marked_as_symbolic(intersection,ArgVal1,ArgVal2) :-
1681	?	(finite_reasonably_sized_set(ArgVal1) ; finite_reasonably_sized_set(ArgVal2)), !,
1682		fail. % intersection is finite and reasonably sized
1683	?	binop_to_be_marked_as_symbolic(_,ArgVal1,_) :- is_symbolic_closure(ArgVal1).
1684	?	binop_to_be_marked_as_symbolic(_,_,ArgVal2) :- is_symbolic_closure(ArgVal2).
1685		% ---
1686
1687		% check if we have a finite known set that can be reasonably represented
1688		% see small_known_set/1 is kernel_mappings
1689		finite_reasonably_sized_set(AVL) :- nonvar(AVL), AVL=avl_set(_). % already expanded; so it can be represented in memory
1690		finite_reasonably_sized_set(Closure) :- nonvar(Closure),
1691		custom_explicit_sets:is_interval_closure(Closure,From,To), integer(From), integer(To),
1692		1+To-From < 250000. % what value should we use here?
1693
1694		lazy_compute_expression(TRIGGER,AssignmentExpr,LocalState,State,IdValue,WF,Ai) :-
1695		get_enumeration_finished_wait_flag(WF,F),
1696		block_lazy_compute_expression(TRIGGER,F,AssignmentExpr,LocalState,State,IdValue,WF,Ai).
1697
1698		:- block block_lazy_compute_expression(-,-,?,?,?, ?,?,?).
1699		block_lazy_compute_expression(TRIGGER,_F,_AssignmentExpr,_LocalState,_State,_IdValue,_WF,_Ai) :-
1700		var(TRIGGER),!.
1701		block_lazy_compute_expression(pred_true,_,AssignmentExpr,LocalState,State,IdValue,WF,Ai) :-
1702		AssignmentExpr = b(Expr,Type,Infos),
1703		(Type \== pred -> b_compute_expression2(Expr,Type,Infos,LocalState,State,IdValue,WF)
1704		; IdValue == pred_true -> b_test_boolean_expression2(Expr,Infos,LocalState,State,WF,Ai,_)
1705		; IdValue == pred_false -> b_not_test_boolean_expression2(Expr,Infos,LocalState,State,WF,Ai,_)
1706		; b_check_boolean_expression(AssignmentExpr,LocalState,State,WF,PredVal,Ai,_) -> IdValue = PredVal
1707		; % reification of check_boolean_expression failed:
1708		b_try_check_failed(AssignmentExpr,LocalState,State,'$ENUMERATION',WF,IdValue,'$GENERATE_ON_DEMAND')
1709		).
1710		block_lazy_compute_expression(pred_false,_,_AssignmentExpr,_LocalState,_State,[],_WF,_Ai). % maybe generate any value ??
1711
1712		% ---
1713
1714		:- block add_wd_error_if_false(-,?,?,?,?).
1715		add_wd_error_if_false(pred_true,_,_,_,_).
1716		add_wd_error_if_false(pred_false,ErrMsg,Cond,Span,WF) :-
1717		translate_bexpression_with_limit(Cond,100,CS),
1718		%(Span=span_predicate(P,LS,State) -> tcltk_interface:write_dot_file_for_pred_expr_and_state(P, LS, State,'/tmp/prob_wd_error.dot') ; true),
1719		add_wd_error_span(ErrMsg,CS,Span,WF).
1720
1721		% ---
1722
1723
1724		:- use_module(kernel_tools,[ground_value/1]).
1725		% compute function application:
1726		b_compute_expression_function(Function,FunArg,Type,Info,LocalState,State,Res,WF) :-
1727		preferences:preference(find_abort_values,false), % the treatment below will not check, e.g., if the set extension is really a function
1728		is_extension_function(Function,FInfo,ExFun), !,
1729		/* a set extension applied to an argument: in some cases we can can first evaluate the argument,
1730		and then avoid having to compute the set_extension for all non-matching args */
1731		b_compute_expression(FunArg,LocalState,State,ArgValue,WF),
1732		% TO DO : should we only do this if ArgValue is known ?? otherwise the standard treatment is better ??
1733		% Note: b_compiler has a special rule to not remove this optimisation
1734		Span = span_predicate(b(function(Function,FunArg),Type,Info),LocalState,State),
1735		opt_push_wait_flag_call_stack_info(WF,function_call(Function,ArgValue,Info),WF2), % small performance hit; hence we only push onto call_stack in TRACE_INFO mode
1736		((memberchk(contains_wd_condition,FInfo) ; % relevant for test 1302; but machine seems to contain real WD error
1737		preferences:preference(use_clpfd_solver,false) ;
1738		ground_value(ArgValue))
1739		-> b_apply_function_set_extension(ExFun,ArgValue,LocalState,State,Res,WF2,Span)
1740		; /* the standard treatment can infer information about the result,... in clpfd_mode */
1741		b_compute_expression(Function,LocalState,State,FValue,WF),
1742		get_texpr_type(Function,FunctionType),
1743		kernel_call_apply_to(FValue,ArgValue,Res,FunctionType,Span,WF2)).
1744		%b_compute_expression_function(b(comprehension_set(Parameters,Condition),_,SInfo),Arg,Type,Info,LocalState,State,Value,WF) :- !,
1745		% b_compute_comprehension_set_symbolic(Parameters,Condition,SInfo,LocalState,State,FValue,WF),
1746		% b_compute_expression(Arg,LocalState,State,ArgValue,WF),
1747		% Span = span_predicate(b(function(Function,Arg),Type,Info),LocalState,State),
1748		% get_texpr_type(Function,FunctionType),
1749		% kernel_call_apply_to(FValue,ArgValue,Value,FunctionType,Span,WF).
1750		b_compute_expression_function(Function,FunArg,_Type,Info,LocalState,State,Value,WF) :-
1751		special_operator_for_image(Function,Kind,Args),!, % detect e.g. iterate(rel,k)(x)
1752		b_compute_expression(FunArg,LocalState,State,SV,WF),
1753		b_compute_expressions(Args,LocalState,State,EArgs,WF),
1754		kernel_call(bsets_clp:apply_fun_for_special_operator(Kind,EArgs,SV,Value,WF,Info),
1755		[SV|EArgs],WF,function(Function,FunArg)).
1756		b_compute_expression_function(Function,Arg,Type,Info,LocalState,State,Value,WF) :-
1757		opt_push_wait_flag_call_stack_info(WF,function_call(Function,ArgValue,Info),WF2),
1758	?	b_compute_expression(Function,LocalState,State,FValue,WF2),
1759	?	b_compute_expression(Arg,LocalState,State,ArgValue,WF2),
1760		Span = span_predicate(b(function(Function,Arg),Type,Info),LocalState,State),
1761		get_texpr_type(Function,FunctionType),
1762		% TODO: do we still need the span predicate when we have the function_call call_stack infos?
1763	?	kernel_call_apply_to(FValue,ArgValue,Value,FunctionType,Span,WF2).
1764
1765
1766		:- use_module(bsyntaxtree,[get_set_type/2,is_set_type/2]).
1767		:- use_module(kernel_cardinality_attr,[finite_cardinality_as_int_with_type_wf/5]).
1768		b_compute_card(Arg1,Type,Info,OuterInfo,LocalState,State,Card,WF) :-
1769	?	b_compute_card2(Arg1,Type,Info,OuterInfo,LocalState,State,Card,WF),
1770		% maybe we should move this code below inside kernel_objects ??
1771		(ground(Card) -> true
1772		; get_set_type(Type,SetElType), % TO DO: only needed for cardinality_of_set_extension_list
1773	?	kernel_objects:max_cardinality(SetElType,MaxCard), % this could be precomputed statically
1774		(number(MaxCard) -> kernel_objects:in_nat_range(Card,int(0),int(MaxCard))
1775		; kernel_objects:greater_than_equal(Card,int(0)) % not sure this is required
1776		)
1777		).
1778		b_compute_card2(set_extension(Ex),_,_,_,LocalState,State,Card,WF) :- !,
1779		b_compute_expressions(Ex,LocalState,State,ExValue,WF),
1780		kernel_objects:cardinality_of_set_extension_list(ExValue,Card,WF).
1781		b_compute_card2(range(F),_,_,_,LocalState,State,Card,WF) :- !,
1782		b_compute_expression(F,LocalState,State,SV1,WF),
1783		kernel_objects:cardinality_of_range(SV1,Card,WF).
1784		b_compute_card2(comprehension_set(Parameters,Condition),Type,Info,OuterInfo,LocalState,State,Card,WF) :- !,
1785		get_set_type(Type,SetElType),
1786		% ensure that we keep the closure and don't expand it:
1787	?	b_compute_comprehension_set_symbolic(Parameters,Condition,Info,LocalState,State,SV1,WF),
1788	?	kernel_mappings:must_succ_kernel_call(
1789		kernel_cardinality_attr:finite_cardinality_as_int_with_type_wf(SV1,SetElType,OuterInfo,Card,WF),SV1,WF,card).
1790		% TO DO: treat comprehension set + things like card({x|x>1 & x<2**e & x mod 2 = 0}) = 0
1791		b_compute_card2(Arg1,Type,Info,OuterInfo,LocalState,State,Card,WF) :-
1792		get_set_type(Type,SetElType),
1793		b_compute_expression2(Arg1,Type,Info,LocalState,State,SV1,WF),
1794	?	kernel_mappings:must_succ_kernel_call(
1795		kernel_cardinality_attr:finite_cardinality_as_int_with_type_wf(SV1,SetElType,OuterInfo,Card,WF),SV1,WF,card).
1796
1797		b_compute_max(set_extension(Ex),_,Info,LocalState,State,Max,WF) :- !,
1798		b_compute_expressions(Ex,LocalState,State,ExValue,WF),
1799		kernel_objects:maximum_of_set_extension_list(ExValue,Max,Info,WF).
1800		b_compute_max(Arg1,Type,Info,LocalState,State,Max,WF) :-
1801		b_compute_expression2_symbolic(Arg1,Type,Info,LocalState,State,SV1,WF),
1802		kernel_mappings:must_succ_kernel_call(kernel_objects:maximum_of_set(SV1,Max,Info,WF),SV1,WF,max).
1803
1804		b_compute_min(set_extension(Ex),_,Info,LocalState,State,Min,WF) :- !,
1805	?	b_compute_expressions(Ex,LocalState,State,ExValue,WF),
1806		kernel_objects:minimum_of_set_extension_list(ExValue,Min,Info,WF).
1807		/* doesnot really buy a lot: */
1808		/*b_compute_min(union(Arg1,Arg2),_,Info,LocalState,State,Min,WF) :-
1809		Arg1 = b(set_extension(Ex),Type1,Info1),
1810		!,
1811		b_compute_min(set_extension(Ex),Type1,Info1,LocalState,State,Min1,WF),
1812		b_compute_expression(Arg2,LocalState,State,SV2,WF),
1813		b_compute_min2(SV2,Min1,Min,Info,WF).
1814		:- block b_compute_min2(-,?,?,?,?).
1815		b_compute_min2([],Min1,Res,_,_WF) :- !, Res=Min1.
1816		b_compute_min2(SV1,Min1,Res,Info,WF) :-
1817		kernel_mappings:must_succ_kernel_call(kernel_objects:minimum_of_set(SV1,Min2,Info,WF),SV1,WF,min),
1818		min(Min1,Min2,Res).
1819		min(int(A),int(B),int(Res)) :- kernel_objects:minimum(A,B,Res). */
1820		b_compute_min(Arg1,Type,Info,LocalState,State,Min,WF) :-
1821		b_compute_expression2_symbolic(Arg1,Type,Info,LocalState,State,SV1,WF),
1822		kernel_mappings:must_succ_kernel_call(kernel_objects:minimum_of_set(SV1,Min,Info,WF),SV1,WF,min).
1823
1824		generate_recursive_closure(TRecId,RecValue,Parameters,Condition,LocalState,State,Result,WF) :-
1825		get_texpr_id(TRecId,RecId),
1826		add_var_to_localstate(RecId,RecValue,LocalState,State1),
1827		debug_println(9,generating_recursive_closure(RecId,Parameters)),
1828		b_generate_rec_closure_aux(RecId,Parameters,Condition,State1,State,RClosure1,WF),
1829		mark_closure_as_recursive(RClosure1,RClosure2),
1830		mark_closure(RClosure2,[recursive(TRecId)],Result),
1831		( debug_mode(off) -> true
1832		; ground_value(Result) -> true
1833		; term_variables(Result,TV),
1834		add_message(b_interpreter,'non-ground closure generated: ',TV:Result,Condition)
1835		).
1836		% a variation of b_generate_closure
1837		b_generate_rec_closure_aux(RecId,Parameters,Condition,LocalState,State,Result,WF) :-
1838		split_names_and_types(Parameters,Names,Types),
1839		construct_closure(Names,Types,ClosurePred,Result),
1840		% now add RecId to parameters to prevent looking up recursive calls
1841		b_compiler:b_compile(Condition,[RecId|Names],LocalState,State,ClosurePred,WF).
1842
1843		% check if a freetype value has the expected case, if not
1844		% generate a WD-error
1845		check_freetype_case(Id,Case,VCase,Inner,Value,Info,WF) :-
1846		get_enumeration_finished_wait_flag(WF,F),
1847		check_freetype_case2(Id,Case,VCase,Inner,Value,Info,F,WF).
1848		:- block check_freetype_case2(?,?,-,?,?,?,-,?).
1849		check_freetype_case2(Id,Case,VCase,Inner,Value,Info,_F,WF) :-
1850		( nonvar(VCase) ->
1851		( Case=VCase -> equal_object_wf(Inner,Value,check_freetype_case2,WF)
1852		;
1853		ajoin(['cannot apply destructor for data type ',Id,
1854		', expected constructor ',Case,', but got: '],Msg),
1855		add_wd_error_set_result(Msg,VCase,Inner,Value,Info,WF))
1856		; % the computation has finished without value,
1857		true). % just drop the check
1858
1859		% check if we have a set_extension argument representing an explicit function
1860		% {a |-> f1, b |-> f2, ...} or [f1,f2]
1861		is_extension_function(b(A,_,Info),Info,C) :- is_extension_function_aux(A,C).
1862		is_extension_function_aux(set_extension(Ex),CaseList) :- is_set_extension_function(Ex,CaseList).
1863		is_extension_function_aux(sequence_extension(Ex),CaseList) :- is_sequence_extension_function(Ex,1,CaseList).
1864		is_set_extension_function([],[]).
1865		is_set_extension_function([b(Couple,TC,_)|T],[case(A,B)|ST]) :- is_couple(Couple,TC,A,B),
1866		is_set_extension_function(T,ST).
1867		is_sequence_extension_function([],_,[]).
1868		is_sequence_extension_function([B|T],Nr,[case(b(value(int(Nr)),integer,[]),B)|ST]) :- N1 is Nr+1,
1869		is_sequence_extension_function(T,N1,ST).
1870
1871		is_couple(couple(A,B),_,A,B).
1872		is_couple(value((VA,VB)),couple(TA,TB), b(value(VA),TA,[]), b(value(VB),TB,[])).
1873
1874		:- use_module(kernel_equality,[equality_objects_wf/4]).
1875		b_apply_function_set_extension([],FunArgVal,_LocalState,_State,_Res,WF,Span) :-
1876		add_wd_error_span('Function applied outside of domain (#8): ','@fun'(FunArgVal,[]),Span,WF).
1877		b_apply_function_set_extension([case(A,B)|T],FunArgVal,LocalState,State,Res,WF,Span) :-
1878		b_compute_expression(A,LocalState,State,AVal,WF),
1879		equality_objects_wf(AVal,FunArgVal,EqRes,WF),
1880		% TO DO: if Res is known, we can call equality_objects(BVal,Res,ResEqRes)
1881	?	b_apply_function_set_extension_aux(EqRes,B,T,FunArgVal,LocalState,State,Res,WF,Span).
1882
1883		:- block b_apply_function_set_extension_aux(-,?,?,?, ?,?,?,?,?).
1884		b_apply_function_set_extension_aux(pred_true,B,_T,_FunArgVal,LocalState,State,Res,WF,_Span) :-
1885		b_compute_expression(B,LocalState,State,BVal,WF), %print(value(BVal)),nl,
1886	?	equal_object_wf(BVal,Res,b_apply_function_set_extension_aux,WF).
1887		b_apply_function_set_extension_aux(pred_false,_B,T,FunArgVal,LocalState,State,Res,WF,Span) :-
1888	?	b_apply_function_set_extension(T,FunArgVal,LocalState,State,Res,WF,Span).
1889
1890
1891		% --------------------- SIGMA & PI ------------------------
1892		:- use_module(bsyntaxtree,[is_membership_or_equality/3,same_id/3]).
1893		/* first clause: try to do a specific treatment for formulas of the form SIGMA(ID).(ID:SET|EXPR) */
1894		/* Advantage: will not delay as long before computing comprehension_set SET ; see test 1312 */
1895		b_general_sum_or_mul([TID],Condition,Expression,Type,_Info,LocalState,State,SumResult,WF,SUMorMUL) :-
1896		is_membership_or_equality(Condition,MID,SET),
1897		same_id(TID,MID,_),!,
1898		b_compute_expression(SET,LocalState,State,SETResult,WF),
1899		b_general_sum_or_mul_over_set([TID],SETResult,Expression,Type,LocalState,State,SumResult,WF,SUMorMUL).
1900		b_general_sum_or_mul(Ids,Condition,Expression,Type,Info,LocalState,State,SumMulResult,WF,SUMorMUL) :-
1901		b_compute_comprehension_set(Ids,Condition,Info,LocalState,State,SETResult,WF),
1902		(var(SETResult) -> perfmessagecall(sigma_pi_not_expanded_or_reified(SUMorMUL),
1903		translate:print_bexpr(Condition),Condition) ; true),
1904		b_general_sum_or_mul_over_set(Ids,SETResult,Expression,Type,LocalState,State,SumMulResult,WF,SUMorMUL).
1905
1906
1907		:- block b_general_sum_or_mul_over_set(?,-, ?,?,?,?, ?,?,?).
1908		b_general_sum_or_mul_over_set([TID],SETResult,Expression,Type,_LS,_S,SumResult,WF,SUMorMUL) :-
1909		Type=integer, % TO DO: also for real
1910		get_texpr_id(Expression,ID), % check if we just sum the elements of the list SIGMA(x).(x:S|x)
1911		get_texpr_id(TID,ID),
1912	?	sum_or_mul_of_explicit_set(SETResult,SUMorMUL,R),!,
1913		equal_object_wf(SumResult,R,b_general_sum_or_mul_over_set,WF).
1914		b_general_sum_or_mul_over_set(IDs,SETResult,Expression,Type,LocalState,State,SumResult,WF,SUMorMUL) :-
1915		expand_custom_set_to_list_wf(SETResult,ESETResult,_Done,b_general_sum_or_mul_over_set,WF),
1916	?	b_sum_or_mul_over_list(ESETResult,IDs,Expression,Type,LocalState,State,SumResult,WF,SUMorMUL).
1917
1918		b_sum_or_mul_over_list(L,IDs,Expr,Type,LS,State,Result,WF,SUMorMUL) :-
1919		get_acc_base(SUMorMUL,Type,Acc),
1920		(Type = integer -> get_wait_flag0(WF,WF0) ; true), % for real: delay until values known
1921	?	b_sum_or_mul_over_list_acc(L,IDs,Expr,Type,LS,State,Acc,Result,WF,SUMorMUL,WF0).
1922
1923		:- block b_sum_or_mul_over_list_acc(-, ?, ?,?,?,?,?, ?,?,?,?).
1924		% better if list is fully known: no constraint propagation performed during computation !
1925		% for example: SIGMA(x).(x:{-1} \/ 1..30000|x+1) goes down from 2050 ms to 1210 ms
1926		b_sum_or_mul_over_list_acc([],_,_,Type,_,_,Acc,Result,_WF,_SUMorMUL,_) :-
1927	?	get_acc_result(Type,Acc,Result).
1928		b_sum_or_mul_over_list_acc([H|T],IDs,Expr,Type,LocalState,State,Acc,Result,WF,SUMorMUL,WF0) :-
1929		add_typed_vars_to_localstate(IDs,H,LocalState,NewLocalState),
1930		b_compute_expression(Expr,NewLocalState,State,HExprVal,WF),
1931		b_sum_or_mul_over_list_acc2(HExprVal,T,IDs,Expr,Type,LocalState,State,Acc,Result,WF,SUMorMUL,WF0).
1932
1933		:- block b_sum_or_mul_over_list_acc2(?,-, ?, ?,?,?,?,?, ?,?,?,?),
1934		b_sum_or_mul_over_list_acc2(?,?, ?, ?,?,?,?,-, ?,?,?,-),
1935		b_sum_or_mul_over_list_acc2(-,?, ?, ?,?,?,?,?, ?,?,?,-). % wait until T nonvar and either Acc & HExprVal known or WF0 set
1936		% purpose: try and remain in non-CLPFD mode as long as possible to avoid overflows,... (see eg. test 1642, 1708)
1937		b_sum_or_mul_over_list_acc2(HExprVal,T,IDs,Expr,Type,LocalState,State,Acc, Result,WF,SUMorMUL,WF0) :-
1938		(nonvar(T),nonvar(Acc),ground(HExprVal)
1939		-> % we can continue computing the system without constraint propagation; is faster
1940		get_value(Type,HExprVal,HVal),
1941		compose_acc(SUMorMUL,Acc,HVal,NewAcc),
1942		b_sum_or_mul_over_list_acc(T,IDs,Expr,Type,LocalState,State,NewAcc,Result,WF,SUMorMUL,WF0)
1943		; T==[], number(Acc), get_acc_base(SUMorMUL,Type,Acc) ->
1944		/* we have just a single element left and no operator has to be applied -> no need for clpfd treatment */
1945		equal_object_wf(HExprVal,Result,b_sum_or_mul_over_list_acc)
1946		; Type=real -> % no CLP(FD) treatment possible yet
1947		when(ground(HExprVal),
1948		b_sum_or_mul_over_list_acc2(HExprVal,T,IDs,Expr,Type,LocalState,State,Acc, Result,WF,SUMorMUL,WF0))
1949		; init_clp_acc(SUMorMUL,HExprVal,int(Acc),CLPAccumulator),
1950		b_sum_or_mul_over_list_clp(T,IDs,Expr,LocalState,State,CLPAccumulator,Result,WF,SUMorMUL)
1951		).
1952
1953		% add set comprehension solution ValueForTypedIDs as individual values for every TypedIDs to LocalState
1954		add_typed_vars_to_localstate(TypedIDs,ValueForTypedIDs,LocalState,NewLocalState) :-
1955		(flatten_pairs(TypedIDs,ValueForTypedIDs,ValAsList),
1956		add_typed_vars_to_localstate_aux(TypedIDs,ValAsList,LocalState,R)
1957		-> NewLocalState = R
1958		; add_internal_error('Call failed: ',add_typed_vars_to_localstate(TypedIDs,ValueForTypedIDs,LocalState,NewLocalState)),
1959		fail
1960		).
1961		% set comprehension results for {a,b,c|P} are nested like this ((a,b),c)
1962		% first argument only used for length (to know how deep the pairs are nested)
1963		flatten_pairs(L,Pairs,FlatList) :- flatten_pairs(L,Pairs,FlatList,[]).
1964		flatten_pairs([_],A) --> !, [A].
1965		flatten_pairs([_|T],(A,B)) --> flatten_pairs(T,A) ,[B].
1966		add_typed_vars_to_localstate_aux([],_,LS,LS).
1967		add_typed_vars_to_localstate_aux([TID],[H],LocalState,NewLocalState) :- !,
1968		get_texpr_id(TID,ID), get_texpr_type(TID,TYPE),
1969		add_typed_var_to_localstate(ID,H,TYPE,LocalState,NewLocalState).
1970		add_typed_vars_to_localstate_aux([TID1|Ids],[H1|Hs],LocalState,NewLocalState) :- !,
1971		get_texpr_id(TID1,ID1), get_texpr_type(TID1,TYPE),
1972		add_typed_var_to_localstate(ID1,H1,TYPE,LocalState,LS1),
1973		add_typed_vars_to_localstate_aux(Ids,Hs,LS1,NewLocalState).
1974
1975
1976		:- block b_sum_or_mul_over_list_clp(-, ?, ?,?,?, ?, ?,?,?).
1977		b_sum_or_mul_over_list_clp([],_, _,_,_, Acc, Result,_WF,SUMorMUL) :-
1978		finalise_clp(SUMorMUL,Acc,Result).
1979		b_sum_or_mul_over_list_clp([H|T],IDs,Expr,LocalState,State,Acc, Result,WF,SUMorMUL) :-
1980		add_typed_vars_to_localstate(IDs,H,LocalState,NewLocalState),
1981		b_compute_expression(Expr,NewLocalState,State,HExprVal,WF),
1982		compose_clp(SUMorMUL,HExprVal,Acc,NewAcc),
1983		b_sum_or_mul_over_list_clp(T,IDs,Expr,LocalState,State,NewAcc,Result,WF,SUMorMUL).
1984
1985		:- use_module(kernel_reals,[is_real/2]).
1986		get_acc_base(sum,integer,R) :- !, R=0.
1987		get_acc_base(sum,real,0.0).
1988		get_acc_base(mul,integer,R) :- !, R=1.
1989		get_acc_base(mul,real,1.0).
1990		get_acc_result(integer,Nr,int(Nr)).
1991		get_acc_result(real,Nr,Real) :- is_real(Real,Nr).
1992		get_value(integer,int(Val),Val) :- !.
1993		get_value(real,Real,Nr) :- is_real(Real,Nr).
1994
1995		compose_acc(sum,A,B,C) :- C is A+B.
1996		compose_acc(mul,A,B,C) :- C is A*B.
1997		init_clp_acc(sum,int(A),int(B),Res) :- (B==0 -> Res=[A] ; Res=[A,B]). % A always not ground
1998		init_clp_acc(mul,A,B,C) :- times(A,B,C).
1999		compose_clp(sum,int(A),Acc,NewAcc) :- NewAcc = [A|Acc].
2000		compose_clp(mul,A,B,C) :- times(A,B,C).
2001		:- use_module(clpfd_interface,[clpfd_sum/2]).
2002		finalise_clp(sum,Acc,int(Result)) :-
2003		clpfd_sum(Acc,Result). % using clpfd_sum can be much more efficient: no intermediate variables set up
2004		finalise_clp(mul,int(Acc),int(Acc)).
2005
2006		/* for if-then-else in Z: compute Then or Else,
2007		depending on the outcome of the predicate */
2008		:- block b_compute_if_then_else(-,?,?,?,?,?,?).
2009		b_compute_if_then_else(pred_true,Then,_Else,LocalState,State,Value,WF) :-
2010		opt_push_wait_flag_call_stack_info(WF,b_expr_call(if_then_body,Then),WF2),
2011	?	b_compute_expression(Then,LocalState,State,Value,WF2).
2012		b_compute_if_then_else(pred_false,_Then,Else,LocalState,State,Value,WF) :-
2013		opt_push_wait_flag_call_stack_info(WF,b_expr_call(if_else_body,Else),WF2),
2014	?	b_compute_expression(Else,LocalState,State,Value,WF2).
2015
2016		:- use_module(clpfd_interface,[clpfd_if_then_else/4]).
2017		% a more sophisticated treatment, can also work backwards forcing PredRes
2018		% examples:
2019		% x = IF a<10 THEN 0 ELSE 5 END & x:6..10 & a:1..23
2020		% see must_fail_clpfd_det 132 and 133
2021		% problematic if Else contains recursion; but then we should have WD condition
2022		b_clpfd_if_then_else(PredRes,Type,Then,Else,LocalState,State,Value,WF) :-
2023		get_wait_flag0(WF,WF0),
2024		b_clpfd_if_then_else_block(PredRes,WF0,Type,Then,Else,LocalState,State,Value,WF).
2025		:- block b_clpfd_if_then_else_block(-,-,?,?,?,?,?,?,?).
2026		b_clpfd_if_then_else_block(PredRes,_,Type,Then,Else,LocalState,State,Value,WF) :- var(PredRes),!,
2027		get_full_fd_value(Type,Value,FDValue),
2028		b_compute_expression(Then,LocalState,State,ThenValue,WF),
2029		get_full_fd_value(Type,ThenValue,FDThenValue),
2030		b_compute_expression(Else,LocalState,State,ElseValue,WF),
2031		get_full_fd_value(Type,ElseValue,FDElseValue),
2032		% TO DO: catch CLPFD overflow and use equality_objects
2033		clpfd_if_then_else(PredRes,FDThenValue,FDElseValue,FDValue).
2034		b_clpfd_if_then_else_block(pred_true,_,_Type,Then,_Else,LocalState,State,Value,WF) :-
2035		b_compute_expression(Then,LocalState,State,Value,WF).
2036		b_clpfd_if_then_else_block(pred_false,_,_Type,_Then,Else,LocalState,State,Value,WF) :-
2037		b_compute_expression(Else,LocalState,State,Value,WF).
2038
2039		:- use_module(b_global_sets,[get_global_type_value/3]).
2040		% try and get full_fd_value; true if full value can be translated to CLP(FD) value
2041		get_full_fd_value(global(T),FY,X) :- get_global_type_value(FY,T,X).
2042		get_full_fd_value(integer,int(X),X).
2043		get_full_fd_value(boolean,B,FD) :- kernel_equality:prop_eq_01(B,FD).
2044		% record with single field ?
2045
2046		can_get_full_fd_value(global(_)).
2047		can_get_full_fd_value(integer).
2048		can_get_full_fd_value(boolean).
2049
2050		% a slightly improved version over set_up_localstate (not sure it is really much faster):
2051		add_lazy_let_id_to_local_state(b(identifier(ID),_,_),Trigger,IdValue,LocalState,NewState) :-
2052		% should we delete any old occurence of ID in LocalState?
2053		NewState = [bind(ID,(Trigger,IdValue))|LocalState].
2054
2055		add_lazy_let_id_and_expression(Id,IdExpr,LocalState,InState,NewLocalState,WF) :-
2056		empty_avl(Ai),
2057		add_lazy_let_id_and_expression(Id,IdExpr,LocalState,InState,NewLocalState,WF,Ai).
2058		add_lazy_let_id_and_expression(Id,IdExpr,LocalState,InState,NewLocalState,WF,Ai) :-
2059		add_lazy_let_id_to_local_state(Id,Trigger,IdValue,LocalState,NewLocalState),
2060		lazy_compute_expression(Trigger,IdExpr,LocalState,InState,IdValue,WF,Ai).
2061
2062		/* for let-statements in Z and now in B: expand localstate by new variables and assign
2063		values to them ;
2064		now Expressions are evaluated in state *with* the new identifiers !
2065		*/
2066		%set_up_localstate_for_let_no_reuse(Ids,Exprs,LocalState,State,LetState,WF) :-
2067		% set_up_localstate(Ids,Vars,LocalState,LetState),
2068		% compute_let_expressions(Exprs,Vars,LocalState,State,WF).
2069		set_up_localstate_for_let(Ids,Vars,Exprs,LocalState,State,LetState,WF) :-
2070		set_up_localstate(Ids,Vars,LocalState,LetState),
2071		%external_functions:observe_variables(Ids,Vars),
2072	?	compute_let_expressions(Exprs,Vars,LetState,State,WF).
2073		compute_let_expressions([],[],_,_,_).
2074		compute_let_expressions([Expr|RestExprs],[Var|RestVars],LocalState,State,WF) :-
2075	?	b_compute_expression(Expr,LocalState,State,Value,WF),
2076		equal_object_optimized(Var,Value,compute_let_expressions),
2077	?	compute_let_expressions(RestExprs,RestVars,LocalState,State,WF).
2078
2079		set_up_localstate_for_global_let(Ids,Exprs,LocalState,State,LetState,WF) :-
2080		set_up_localstate(Ids,Vars,State,LetState),
2081		compute_let_expressions(Exprs,Vars,LocalState,LetState,WF).
2082
2083
2084		l_compute_field([],_LS,_S,[],_WF).
2085		l_compute_field([Field|T],LS,S,[FVal|CT],WF) :-
2086	?	b_compute_field(Field,LS,S,FVal,WF),
2087	?	l_compute_field(T,LS,S,CT,WF).
2088
2089		b_compute_field(field(Name,TypeOrVal),LocalState,State,field(Name,TypeOrFieldValue),WF) :-
2090	?	b_compute_expression(TypeOrVal,LocalState,State,TypeOrFieldValue,WF).
2091
2092
2093
2094		:- use_module(b_compiler).
2095
2096		/* :- type bsets_closure +--> closure(list(type(variable_id)),
2097		list(type(basic_type_descriptor)),type(boolean_expression)). */
2098
2099		:- assert_pre(b_interpreter:b_compute_comprehension_set(Parameters,Cond,_Info,LS,State,_R,_WF),
2100		(ground_check(Parameters),
2101		bsyntaxtree:check_if_typed_predicate(Cond),type_check(LS,store),type_check(State,store)) ).
2102
2103		:- assert_post(b_interpreter:b_compute_comprehension_set(_P,_C,_Info,_LS,_State,Val,_WF),
2104		(b_interpreter:value_type(Val))). %, nonvar(Val)
2105
2106
2107
2108		b_compute_comprehension_set_symbolic(Parameters,Condition,Info,LocalState,State,Result,WF) :-
2109		% a version which never expands the generated closure
2110	?	b_generate_closure_if_necessary(Parameters,Condition,LocalState,State,CResult,WF),
2111	?	(member(prob_annotation('SYMBOLIC'),Info)
2112		-> mark_closure_as_symbolic(CResult,CRS),Result=CRS
2113		; Result=CResult). % TODO: check if we need definitely_expand_this_explicit_set
2114		% we could catch Parameters = [TID], Condition = b(member(b(identifier(ID),_TYPE,_),SET)
2115		b_compute_comprehension_set(Parameters,Condition,Info,LocalState,State,Result,WF) :-
2116	?	b_generate_closure_if_necessary(Parameters,Condition,LocalState,State,CResult,WF),
2117		b_compute_comprehension_set_aux(CResult,Info,Result,WF).
2118
2119		:- use_module(clpfd_interface,[catch_clpfd_overflow_call2/2]).
2120		b_compute_comprehension_set_aux(CResult,_,Result,_WF) :-
2121		(var(CResult) ; \+ functor(CResult,closure,3) ),!,
2122		Result=CResult.
2123		b_compute_comprehension_set_aux(CResult,Info,Result,_WF) :-
2124	?	member(prob_annotation('SYMBOLIC'),Info),!,
2125		mark_closure_as_symbolic(CResult,CRS),Result=CRS.
2126		b_compute_comprehension_set_aux(CResult,Info,Result,WF) :-
2127		(preferences:get_preference(convert_comprehension_sets_into_closures,true)
2128		-> \+ definitely_expand_this_explicit_set(CResult)
2129		; dont_expand_symbolic_explicit_set(CResult), % Note: also detects FORCE annotation
2130		perfmessage_wf(symbolic,'Keeping set comprehension symbolic (use FORCE to override this or increase SYMBOLIC_LIMIT)','',Info,WF)
2131		),!,
2132		Result=CResult.
2133		b_compute_comprehension_set_aux(CResult,Info,Result,WF) :-
2134		b_expand_compute_comprehension_set(CResult,Info,Result,WF).
2135
2136		b_expand_compute_comprehension_set(CResult,Info,Result,WF) :-
2137		% using just get_wait_flag1(b_compute_comprehension_set,WF,WF0), makes many benchmarks faster ; but e.g., test 268 fails; maybe we sholud pre-compute bexpr_variables ? and pass this to expand_only_custom_closure_global
2138		(preferences:preference(use_smt_mode,false)
2139		-> get_wait_flag(1000,b_compute_comprehension_set,WF,WF0) % ideally we should say WF0 = _ ; but for some benchmarks Rule_DB_SIGAREA_0024_ori.mch this is important to avoid expanding closures before other stuff fails
2140		% only in SMT mode can there be any benefit in expanding a non-ground closure (when it is a lambda closure)
2141		% => hence delay expansion longer, possibly detecting enumeration warnings while expanding
2142		% TO DO: for lambda closures with known domain: expand earlier !
2143		; get_wait_flag(2,b_compute_comprehension_set,WF,WF0)),
2144		kernel_objects:mark_as_to_be_computed(Result), % avoid that we instantiate this set (e.g., in check_element_of_wf: we will get a full description of the set later; see test 1353
2145		(var(WF0),var(Result) -> ground_value_check(CResult,CGr) ; true),
2146		block_compute_comprehension_set_aux(CResult,Info,Result,WF,WF0,CGr).
2147
2148		:- block block_compute_comprehension_set_aux(?,?,-,?,-,-).
2149		block_compute_comprehension_set_aux(CResult,Info,Result,WF,_WF0,_CGr) :-
2150		(
2151		nonvar(Result)
2152	?	-> equal_object_wf(CResult,Result,WF) % this may expand CResult or do other tests;
2153		% like emptyness test or symbolic equality;
2154		% if Result=[_|_] then the closure needs to be expanded anyhow, so need to try and keep symbolic
2155		;
2156	?	catch_clpfd_overflow_call2(
2157		on_enumeration_warning_with_continue(expand_only_custom_closure_global(CResult,Expansion,check_no_inf,WF),
2158		% check_no_inf: we know it is not definitely infinite; and we do not want warnings for virtual time-outs
2159		% an enumeration warning occured in the expansion scope: keep closure symbolic after all
2160		% NOTE: for this detection to work it is better to delay until the body is ground (CGr)
2161		% and not use a priority too low for WF0, otherwise Expansion will be var and enum warning may occur later
2162		b_compute_comprehension_set_sym_msg(CResult,Info,Result,WF) % Backup Call in case of enum warning
2163		,
2164		equal_object_wf(Result,Expansion,WF) % TrueContinuation
2165		% instantiating Result can trigger other code which fails and confuses on_enumeration_warning
2166		),
2167		b_compute_comprehension_set_sym(CResult,Result,WF)
2168		) % catch_clpfd_overflow_call2
2169		).
2170
2171		b_compute_comprehension_set_sym_msg(CResult,Info,Result,WF) :- CResult = closure(P,_T,B),
2172		silent_mode(off),
2173		% TO DO: should we check that this closure has not been constructed by ProB, e.g., for UNION ??
2174		% e.g., P = ['__RANGE_LAMBDA__'] what about '_zzzz_unary', '_zzzz_binary', '_prj_arg1__', ...
2175		% also: what if the enumeration warning has a pending_abort_error
2176		!,
2177		Msg = 'Keeping comprehension-set symbolic (you may want to use the /*@symbolic*/ pragma to prevent this message, unless it was due to a WD-Error), identifiers: ',
2178		(contains_info_pos(Info) -> Span=Info ; Span=B),
2179		add_message(b_compute_comprehension_set,Msg,P,Span),
2180		b_compute_comprehension_set_sym(CResult,Result,WF).
2181		b_compute_comprehension_set_sym_msg(CResult,_,Result,WF) :-
2182		b_compute_comprehension_set_sym(CResult,Result,WF).
2183
2184
2185		b_compute_comprehension_set_sym(CResult,Result,WF) :-
2186		mark_closure_as_symbolic(CResult,CRS), % prevent doing the same mistake again
2187		equal_object_wf(Result,CRS,b_compute_comprehension_set_sym,WF).
2188
2189
2190		:- use_module(closures,[construct_closure_if_necessary/4]).
2191		b_generate_forall_closure(Parameters,Condition,LocalState,State,Result,WF) :-
2192		split_names_and_types(Parameters,Names,Types),
2193		construct_closure(Names,Types,ClosurePred1,Result),
2194		(LocalState==[],State==[]
2195		-> ClosurePred = Condition % no lookups can be performed anyway; no need to compile
2196		; b_compiler:b_compile(Condition,Names,LocalState,State,ClosurePred,WF) ),
2197		add_texpr_infos(ClosurePred,[quantifier_kind(forall)],ClosurePred1). % info for call_stack
2198
2199
2200
2201		b_generate_closure_if_necessary(Parameters,Condition,LocalState,State,Result,WF) :-
2202		split_names_and_types(Parameters,Names,Types),
2203	?	b_compiler:b_compile(Condition,Names,LocalState,State,ClosurePred,WF),
2204		%print('COMPILED: '),translate:print_bexpr(ClosurePred),nl,
2205		construct_closure_if_necessary(Names,Types,ClosurePred,Result).
2206
2207
2208		:- public convert_list_of_expressions_into_sequence/2.
2209		convert_list_of_expressions_into_sequence(List,SeqValue) :-
2210		convert_list_of_expressions_into_sequence(List,1,Seq),
2211	?	equal_object_optimized(Seq,SeqValue,convert_list_of_expressions_into_sequence).
2212
2213		convert_list_of_expressions_into_sequence([],_,[]).
2214		convert_list_of_expressions_into_sequence([H|T],Cur,[(int(Cur),H)|ConvT]) :-
2215		C1 is Cur+1,
2216		convert_list_of_expressions_into_sequence(T,C1,ConvT).
2217
2218		convert_list_of_expressions_into_set_wf(ListOfElements,Set,Type,WF) :-
2219		list_of_expressions_is_ground(ListOfElements,Ground,OrderedListOfElements),
2220	?	convert_list_of_expressions_into_set1(Ground,OrderedListOfElements,Set,Type,WF).
2221		convert_list_of_expressions_into_set1(true,ListOfElements,Set,_Type,WF) :- %var(Set),
2222	?	\+ (ListOfElements = [H|_], is_symbolic_closure(H)), % list contains symbolic closures, do not try to expand to avl
2223		% see should_be_converted_to_avl_from_lists ?
2224		!, construct_avl_from_lists_wf(ListOfElements,AVLSet,WF),
2225	?	equal_object_wf(AVLSet,Set,convert_list_of_expressions_into_set1,WF).
2226		convert_list_of_expressions_into_set1(_,Seq,Set,Type,WF) :-
2227	?	kernel_objects:max_cardinality(Type,TypeMaxCard),
2228	?	convert_list_of_expressions_into_set2(Seq,1,[],Set,TypeMaxCard,WF).
2229
2230		% TO DO: sort elements : ground elements first
2231		convert_list_of_expressions_into_set2([],_,Set,Res,_,WF) :-
2232	?	equal_object_wf(Set,Res,convert_list_of_expressions_into_set2,WF).
2233		convert_list_of_expressions_into_set2([H|T],MaxSze,SetSoFar,OutSet,TypeMaxCard,WF) :-
2234		%kernel_objects:basic_type_set(Type,IntSet,MaxSze),
2235		check_set_lists_bounded(IntSet,TypeMaxCard,MaxSze),
2236		% TO DO: optimize; avoid traversing or typing elements over and over again
2237		% maybe add a max. sze argument to add_element
2238		add_element_wf(H,SetSoFar,IntSet,WF), % print(add_el(H,SetSoFar,IntSet)),nl,
2239		% TO DO: check if H in OutSet and keep track of which elements have already been covered in OutSet
2240		%check_element_of_wf(H,OutSet,WF), makes tests 114, 115, 118-120, 1063 fail ! % we could also call lazy_try_check_element_of if this turns out to be too expensive
2241		kernel_objects:lazy_try_check_element_of(H,OutSet,WF),
2242		M1 is MaxSze+1,
2243	?	convert_list_of_expressions_into_set2(T,M1,IntSet,OutSet,TypeMaxCard,WF).
2244
2245
2246		:- use_module(inf_arith).
2247
2248		% check that a set does not exceed a certain bound (to prevent infinite
2249		% or overeager enumeration of sets); Warning: will not check custom_explicit_set sizes
2250		check_set_lists_bounded(Set,TypeMaxCard,Bound) :-
2251		inf_arith:infmin(TypeMaxCard,Bound,Card),
2252		(is_inf_or_overflow_card(Card) -> true
2253		; Card<1 -> empty_set(Set)
2254		; check_set_bounded_aux(Set,Card)).
2255
2256		:- block check_set_bounded_aux(-,?).
2257		check_set_bounded_aux(CustomSet,_) :- is_custom_explicit_set(CustomSet,check_set_bounded_aux),!.
2258		check_set_bounded_aux([],_).
2259		check_set_bounded_aux([_|T],Card) :-
2260		C1 is Card-1,
2261		(C1=0 -> empty_set(T) ; check_set_bounded_aux(T,C1)).
2262
2263
2264
2265		% check if the list can be converted into AVL form; if not: re-order list so that ground elements are present first
2266		list_of_expressions_is_ground([],true,[]).
2267		list_of_expressions_is_ground([E|T],Ground,ResList) :-
2268		(should_be_converted_to_avl(E) -> ResList=[E|RT], list_of_expressions_is_ground(T,Ground,RT)
2269		; Ground=false,
2270		bring_ground_elements_forward(T,[E],ResList)
2271		).
2272
2273		bring_ground_elements_forward([],Acc,Acc).
2274		bring_ground_elements_forward([H|T],Acc,Res) :-
2275		(should_be_converted_to_avl(H) -> Res=[H|RT], bring_ground_elements_forward(T,Acc,RT)
2276		; bring_ground_elements_forward(T,[H|Acc],Res)).
2277
2278		:- use_module(kernel_card_arithmetic,[is_inf_or_overflow_card/1, safe_mul/3]).
2279		% compute cardinality of a list of parameters, such as for forall
2280		parameter_list_cardinality([],1).
2281		parameter_list_cardinality([b(identifier(_),BasicType,_)|T],Res) :-
2282	?	parameter_list_cardinality(T,TCard),
2283		(is_inf_or_overflow_card(TCard) -> Res=TCard
2284	?	; kernel_objects:max_cardinality(BasicType,Card),
2285		safe_mul(Card,TCard,Res)
2286		).
2287		% see also basic_type_list_cardinality, now moved to custom_explicit_sets
2288
2289		b_for_all(Parameters,Infos,LHS,RHS,LocalState,State,WF) :-
2290		get_wait_flag1(for_all(Parameters),WF,LWF), % hack: give total_function,... priority to set up domain/range
2291	?	b_for_all_aux(LWF,Parameters,Infos,LHS,RHS,LocalState,State,WF).
2292
2293		:- block b_for_all_aux(-,?,?,?,?,?,?,?).
2294		b_for_all_aux(_,Parameters,Infos,LHS,RHS,LocalState,State,WF) :-
2295		split_names_and_types(Parameters,Names,Types),
2296	?	b_compile(LHS,Names,LocalState,State,CLHS,WF),
2297	?	b_compile(RHS,Names,LocalState,State,CRHS,WF),
2298	?	b_for_all_aux2(Parameters,Names,Types,Infos,CLHS,CRHS,WF).
2299
2300		:- use_module(kernel_tools,[ground_bexpr/1, ground_bexpr_check/2]).
2301		b_for_all_aux2(_,_,_,_,LHS,RHS,_) :-
2302		(is_falsity(LHS) ; is_truth(RHS)),
2303		!. % quantifier always true
2304		b_for_all_aux2(Parameters,CParameters,CParameterTypes,Infos,LHS,RHS,WF) :-
2305		ground_bexpr(LHS),
2306	?	\+ obvious_enumeration(LHS,CParameters), % if we have an obvious (small) enumeration in the LHS it is often better simply to enumerate and check the RHS for every instance
2307		ground_bexpr(RHS), %print(not_exists_forall(Parameters,LHS,RHS)),nl,
2308		!,
2309		b_for_all_find_counter_example(Parameters,CParameters,CParameterTypes,Infos,LHS,RHS,WF).
2310		b_for_all_aux2(Parameters,CParameters,CParameterTypes,Infos,LHS,RHS,WF) :-
2311	?	parameter_list_cardinality(Parameters,ParCard),
2312		peel_implications(Parameters,ParCard,LHS,RHS, LHS2,RHS2),
2313	?	b_for_all_aux3(Parameters,ParCard,CParameters,CParameterTypes,Infos,LHS2,RHS2,WF).
2314
2315		b_for_all_aux3(Parameters,ParCard,CParameters,CParameterTypes,Infos,LHS,RHS,WF) :-
2316		%large_domain(Parameters,ParCard,LHS),
2317		is_infinite_or_very_large_explicit_set(closure(CParameters,CParameterTypes,LHS),10000000),
2318		% the domain is so large that we cannot possibly check all instances
2319		% in this case: we prefer to look for a counter example in the hope that the constraint solver can narrow down the search by combining LHS and not(RHS)
2320		!,
2321		perfmessage(forall,'Large forall domain: ',ParCard,Infos),
2322		ground_bexpr_check(LHS,LG),
2323		ground_bexpr_check(RHS,RG),
2324		when((nonvar(LG),nonvar(RG)),
2325		b_for_all_find_counter_example(Parameters,CParameters,CParameterTypes,Infos,LHS,RHS,WF)
2326		).
2327		b_for_all_aux3(Parameters,ParCard,_CP,_,Infos,LHS,RHS,WF) :-
2328		if(expand_forall_quantifier(Parameters,LHS,RHS,Infos,WF,ReificationVariable),
2329		(
2330		perfmessage(good(forall),'Reified forall by expanding into conjunction: ',LHS),
2331		ReificationVariable=pred_true),
2332		( % print(normal_forall(Parameters)),nl,
2333		b_generate_for_all_list_domain1(Parameters,ParCard,LHS,RHS,[],[],AllSolList,NewRHS,WF),
2334	?	expand_forall1(AllSolList,NewRHS,Parameters,WF)
2335		)).
2336
2337
2338		% a treatment of for all where we look for counter examples satisfying LHS & not(RHS)
2339		b_for_all_find_counter_example(Parameters,CParameters,CParameterTypes,Infos,LHS,RHS,WF) :-
2340		% if LHS is Parameters: avl_set(V) then we probably should not apply this rule ?
2341		create_negation(RHS,NegRHS),
2342		conjunct_predicates_with_pos_info(LHS,NegRHS,Pred0),
2343		% format('looking for: ~w ',[CParameters]), translate:print_bexpr(LHS),nl, translate:print_bexpr(NegRHS),nl,
2344		perfmessage(good(forall),translating_forall_into_not_exists(CParameters),LHS),
2345		add_texpr_infos(Pred0,[quantifier_kind(forall)],ClosureBody1), % for call_stack
2346		init_quantifier_wait_flag(WF,not(forall),Parameters,ParValues,Infos,LocalWF), % relevant for test 1904
2347		not_with_enum_warning_and_possible_delay(
2348		(custom_explicit_sets:b_test_closure(CParameters,CParameterTypes,ClosureBody1,ParValues,negative,LocalWF),
2349		perfmessage_bexpr(forall,forall_counter_example(CParameters,ParValues),LHS)
2350		),LocalWF, WF, forall(CParameters), Infos).
2351
2352		:- use_module(library(timeout),[time_out/3]).
2353		not_with_enum_warning_and_possible_delay(C,WF,OuterWF,PP,Span) :-
2354		get_preference(disprover_mode,true),
2355		% in disprover mode we do not track WD errors, no need to start_attach_inner_abort_errors
2356		!,
2357		% delay potentially expensive quantifications in the hope of finding other contradictions earlier
2358		if( (time_out(not_with_enum_warning(C,WF,PP,Span),20,TRes),TRes \== time_out),
2359		copy_wfe_from_inner_if_necessary(WF,OuterWF),
2360		(get_wait_flag(2,not_with_enum_warning_and_possible_delay,OuterWF,LWF), % which priority to use ??
2361		debug_println(19,delay_not_in_disprover_mode),
2362		not_with_enum_warning_delay(C,LWF,WF,OuterWF,PP,Span))).
2363		not_with_enum_warning_and_possible_delay(C,WF,OuterWF,PP,Span) :-
2364		start_attach_inner_abort_errors(Level,not_with_enum_warning),
2365		call_cleanup(not_with_enum_warning(C,WF,PP,Span),
2366		re_attach_pending_inner_abort_errors(Level,OuterWF,_)),
2367		copy_wfe_from_inner_if_necessary(WF,OuterWF).
2368
2369
2370		:- block not_with_enum_warning_delay(?,-,?,?,?,?).
2371		not_with_enum_warning_delay(C,_,WF,OuterWF,PP,Span) :-
2372		debug_println(19,trigger_not_with_enum_warning_delay),
2373		not_with_enum_warning(C,no_wf_available,PP,Span),
2374		copy_wfe_from_inner_if_necessary(WF,OuterWF).
2375
2376		:- use_module(avl_tools,[quick_avl_approximate_size/2]).
2377		obvious_enumeration(LHS,[Id]) :- % TO DO : allow multiple ids
2378		% TO DO: unify with is_for_all_set_membership_predicate code below
2379		TLHSMembership = b(LHSMembership,_,_),
2380	?	member_conjunct(TLHSMembership,LHS,_),
2381		obvious_enum_aux(LHSMembership,Id).
2382
2383		obvious_enum_aux(member(TID,b(value(VAL),_,_)),ID) :- get_texpr_id(TID,ID),
2384		nonvar(VAL), VAL = avl_set(AVL), % TO DO: also support interval closures ?
2385		quick_avl_approximate_size(AVL,Size),
2386		Size<256.
2387		%obvious_enum_aux(equal(LHS,RHS),ID) :- % stillposes problem for test 231, investigate
2388		% ( get_texpr_id(LHS,ID) -> get_texpr_expr(RHS,value(_))
2389		% ; get_texpr_id(RHS,ID) -> get_texpr_expr(LHS,value(_))).
2390		% % TODO: do we need to accept integer(.),... literals?
2391
2392		% expands forall quantifier and thus enables that we also propagate from right to left
2393		% This helps for test 1397 (HandshakeSimple_TotFun)
2394		% TO DO: directly call the code which tries to expand a forall quantifier
2395		expand_forall_quantifier(Parameters,LHS,RHS,Infos,WF,ReificationVariable) :-
2396		(preferences:preference(use_smt_mode,true) -> true
2397		; preferences:preference(solver_strength,SS), SS>9), % sometimes contrapositive checking maybe not useful; see test 1368
2398		% TO DO: investigate and provide more principled heuristic
2399		b_interpreter_check:b_check_forall_wf(Parameters,LHS,RHS,Infos,[],[],WF,ReificationVariable).
2400
2401		% rewrite !(x,..).( TRUTH => (LHS2 => RHS2)) into !(x,...).(LHS2 => RHS2)
2402		peel_implications(Parameters,ParCard,LHS,RHS, NewLHS,NewRHS) :-
2403		%print(forall),nl, print(Parameters),nl,print(LHS),nl,
2404		% this patterns occurs often in Event-B translations to classical B
2405		LHS=b(truth,_,_),
2406		RHS=b(implication(LHS2,RHS2),_,_), % TO DO: maybe also accept nested forall and then add to Parameters?
2407		(is_inf_or_overflow_card(ParCard) -> true ; ParCard>50),
2408		% larger bound than below: maybe user explicitly wants to expand it
2409		!,
2410		peel_implications(Parameters,ParCard,LHS2,RHS2, NewLHS,NewRHS).
2411		peel_implications(_,_,LHS,RHS, LHS,RHS).
2412
2413		b_generate_for_all_list_domain_nolwf(Parameters,LHS,RHS,LS,S,ForAllDomain,NewRHS,WF) :-
2414	?	parameter_list_cardinality(Parameters,ParCard),
2415		peel_implications(Parameters,ParCard,LHS,RHS, LHS2,RHS2),
2416		b_generate_for_all_list_domain1(Parameters,ParCard,LHS2,RHS2,LS,S,OForAllDomain,NewRHS,WF),
2417		optlist_to_list(OForAllDomain,ForAllDomain). % resolve any optional_value/2 items
2418
2419		% generate the domain of a Universally Quantified Formula as a list
2420		b_generate_for_all_list_domain1(Parameters,_ParCard,LHS,RHS,LS,S,ForAllDomain,NewRHS,WF) :-
2421		% optimized treatment for formulas of the form !x.(x:S => RHS) or !(x,y).(x|->y:S => RHS)
2422		% to do: expand to more formulas, such as !(x,y).(x:S & y:T => RHS)
2423		% or !y.(y:1..(n-1) & f(y)=TRUE => f(y+1)=TRUE) --> !y.(y:1..(n-1) => (f(y)=TRUE => f(y+1)=TRUE))
2424		% or we could try and reify set membership for small domains and trigger implication
2425		is_for_all_set_membership_predicate(LHS,Parameters,Set,Pattern,ParameterValues),!,
2426		perfmessages_bexpr_call(good(forall),['Detected forall set membership over ',Ps,': '],
2427		LHS,bsyntaxtree:def_get_texpr_ids(Parameters,Ps)),
2428		NewRHS=RHS,
2429		b_generate_set_for_all_domain(Set,LS,S,Pattern,ParameterValues,ForAllDomain,WF).
2430		b_generate_for_all_list_domain1(Parameters,ParCard,LHS,RHS,LS,S,ForAllDomain,NewRHS,WF) :-
2431		b_generate_forall_closure(Parameters,LHS,LS,S,Closure,WF), % POSSIBLY NO NEED TO COMPILE
2432		b_generate_for_all_domain2(Closure,Parameters,ParCard,LHS,RHS,ForAllDomain,NewRHS,WF).
2433
2434		b_generate_for_all_domain2(Closure,_Parameters,_,LHS,RHS,ForAllDomain,NewRHS,WF) :-
2435		(LHS=b(truth,pred,_) ; ground_value(Closure)),
2436		!, NewRHS=RHS, % nl,print('FORALL EXPAND: '),(ground_value(Closure) -> print(ground(_Parameters)),nl, print_bexpr(LHS),nl ; print('NONGROUND!!'),nl,print_bexpr(RHS),nl), %%
2437		b_expand_closure_forall_to_list(Closure,ForAllDomain,WF).
2438		b_generate_for_all_domain2(_,Parameters,_,LHS,RHS,ForAllDomain,NewRHS,WF) :-
2439		is_a_conjunct(LHS,_,_), % otherwise we have already checked for set_membership above !
2440		LHS_Membership = b(member(_,_),_,_), % TO DO: also allow conjuncts
2441	?	member_conjunct(LHS_Membership,LHS,RestLHS),
2442		% !(x). ( x:Set & RestLHS => RHS) ---> !(x).(x:Set => (RestLHS => RHS))
2443		is_for_all_set_membership_predicate(LHS_Membership,Parameters,Set,Pattern,ParameterValues),
2444	?	max_cardinality_ok_for_expansion(Set,100,[],[]), % TO DO: simplify LS,S argument <----
2445		!,
2446		% as we expand Set without RHS predicate, check if this is ok
2447		% indeed maximum cardinality of Set could be infinite !! !x.(x:NATURAL1 & x<N => P)
2448		% print('Splitting for all conjunct: '), print(Parameters),nl, print_bexpr(LHS_Membership),nl,print_bexpr(RestLHS),nl, %%
2449		perfmessage_bexpr(good(forall),'Splitting LHS of forall: ',LHS),
2450		NewRHS = b(implication(RestLHS,RHS),pred,[]), % TO DO: extract & join info
2451		b_generate_set_for_all_domain(Set,[],[],Pattern,ParameterValues,ForAllDomain,WF).
2452		b_generate_for_all_domain2(Closure,_Parameters,ParCard,LHS,RHS,ForAllDomain,NewRHS,WF) :-
2453		(is_inf_or_overflow_card(ParCard) -> true ; ParCard>8),
2454		!,
2455		NewRHS=RHS,
2456		perfmessage_bexpr(forall,'No optimisations applicable to forall (will delay until all variables are bound): ',LHS), % maybe we should generate this message only if ForAllDomain is var ?
2457		b_expand_closure_forall_to_list(Closure,ForAllDomain,WF).
2458		b_generate_for_all_domain2(_Closure,Parameters,ParCard,LHS,RHS,ForAllDomain,NewRHS,WF) :-
2459		NewLHS=b(truth,pred,[]), NewRHS=b(implication(LHS,RHS),pred,[]),
2460		b_generate_forall_closure(Parameters,NewLHS,[],[],Closure,WF),
2461		perfmessages_bexpr(good(forall),['Expanding forall with finite parameter type, card = ',ParCard,': '],LHS),
2462		b_expand_closure_forall_to_list(Closure,ForAllDomain,WF).
2463
2464		% code to decide whether a for all should be expanded if the
2465		% predicate contains a set membership predicate : !x.( (P & x:S & P') => Q)
2466		max_cardinality_ok_for_expansion(b(Expr,Type,_Info),Limit,LS,S) :- % which value to choose for Limit ??
2467	?	kernel_objects:max_cardinality(Type,TypeCard),
2468		( (number(TypeCard),TypeCard =< Limit) -> true ;
2469		max_cardinality_ok_for_expansion2(Expr,Limit,TypeCard,LS,S)).
2470
2471		max_cardinality_ok_for_expansion1(b(E,_,_),Limit,TC,LS,S) :-
2472		max_cardinality_ok_for_expansion2(E,Limit,TC,LS,S).
2473
2474		:- use_module(custom_explicit_sets,[efficient_card_for_set/3]).
2475
2476		max_cardinality_ok_for_expansion2(set_extension(E),Limit,_TC,_,_) :- !, length(E,Len), Len =< Limit.
2477		max_cardinality_ok_for_expansion2(interval(Up,Low),Limit,_TC,LS,S) :- !,
2478		get_integer(UpI,Up,LS,S), get_integer(LowI,Low,LS,S),
2479		UpI-LowI<Limit.
2480		max_cardinality_ok_for_expansion2(integer_set(GS),Limit,_TC,_LS,_S) :- !, b_global_set_cardinality(GS,Card),
2481		number(Card), Card =< Limit.
2482		max_cardinality_ok_for_expansion2(set_subtraction(A,_),Limit,TC,LS,S) :- !,
2483		max_cardinality_ok_for_expansion1(A,Limit,TC,LS,S).
2484		max_cardinality_ok_for_expansion2(image(RelA,_),Limit,TC,LS,S) :- !,
2485		max_cardinality_ok_for_expansion1(RelA,Limit,TC,LS,S).
2486		max_cardinality_ok_for_expansion2(function(_RelA,_),_Limit,_TC,_LS,_S) :- !,
2487		fail. % TO DO: we should look at the size of the range elements
2488		% max_cardinality_ok_for_expansion1(_RelA,_Limit,_TC,_LS,_S).
2489		max_cardinality_ok_for_expansion2(intersection(A,B),Limit,TC,LS,S) :- !,
2490		(max_cardinality_ok_for_expansion1(A,Limit,TC,LS,S) -> true ; max_cardinality_ok_for_expansion1(B,Limit,TC,LS,S)).
2491		max_cardinality_ok_for_expansion2(union(A,B),Limit,TC,LS,S) :- !,
2492		max_cardinality_ok_for_expansion1(A,Limit,TC,LS,S), max_cardinality_ok_for_expansion1(B,Limit,TC,LS,S).
2493		max_cardinality_ok_for_expansion2(range(A),Limit,TC,LS,S) :- !,
2494		max_cardinality_ok_for_expansion1(A,Limit,TC,LS,S).
2495		max_cardinality_ok_for_expansion2(domain(A),Limit,TC,LS,S) :- !,
2496		max_cardinality_ok_for_expansion1(A,Limit,TC,LS,S).
2497		max_cardinality_ok_for_expansion2(domain_restriction(_A,B),Limit,TC,LS,S) :- !,
2498		max_cardinality_ok_for_expansion1(B,Limit,TC,LS,S). % note: finite A does not guarantee finite result
2499		max_cardinality_ok_for_expansion2(domain_subtraction(_A,B),Limit,TC,LS,S) :- !,
2500		max_cardinality_ok_for_expansion1(B,Limit,TC,LS,S).
2501		max_cardinality_ok_for_expansion2(range_restriction(A,_B),Limit,TC,LS,S) :- !,
2502		max_cardinality_ok_for_expansion1(A,Limit,TC,LS,S). % note: finite B does not guarantee finite result
2503		max_cardinality_ok_for_expansion2(range_subtraction(A,_B),Limit,TC,LS,S) :- !,
2504		max_cardinality_ok_for_expansion1(A,Limit,TC,LS,S).
2505		max_cardinality_ok_for_expansion2(direct_product(A,B),Limit,TC,LS,S) :- !,
2506		max_cardinality_ok_for_expansion2(cartesian_product(A,B),Limit,TC,LS,S).
2507		max_cardinality_ok_for_expansion2(parallel_product(A,B),Limit,TC,LS,S) :- !,
2508		max_cardinality_ok_for_expansion2(cartesian_product(A,B),Limit,TC,LS,S).
2509		max_cardinality_ok_for_expansion2(cartesian_product(A,B),Limit,TC,LS,S) :- !,
2510		ILimit is Limit//2, ILimit>0, %use sqrt ?
2511		max_cardinality_ok_for_expansion1(A,ILimit,TC,LS,S),
2512		max_cardinality_ok_for_expansion1(B,ILimit,TC,LS,S).
2513		max_cardinality_ok_for_expansion2(value(S),Limit,_TC,_LS,_S) :- !,
2514		get_max_card_for_value(S,MaxCard),
2515		MaxCard =< Limit.
2516		max_cardinality_ok_for_expansion2(identifier(_ID),_Limit,TC,_LS,_S) :- !, number(TC).
2517		% TO DO: check if ID is fully defined; if so use card else accept as it will
2518		% probably be represented by a list and the forall constraints could be useful in finding ID's value
2519		% we have to store/compute ID anyway (could be infinite closure; hence check that TC is a number); a bit of a hack; is there a more principled way?
2520		max_cardinality_ok_for_expansion2(external_function_call(_,_),_,_,_,_) :- !,fail.
2521		max_cardinality_ok_for_expansion2(lazy_lookup_expr(_),_,_,_,_) :- !,fail.
2522		max_cardinality_ok_for_expansion2(record_field(_,_),_Limit,_TC,_LS,_S) :- !, fail.
2523		max_cardinality_ok_for_expansion2(E,Limit,TC,_LS,_S) :- functor(E,F,N),
2524		print(unknown_max_card(F/N,Limit,TC)),nl,fail.
2525
2526
2527		:- use_module(kernel_cardinality_attr,[clpfd_card_domain_for_var/3]).
2528
2529		get_max_card_for_value(S,MaxCard) :- var(S), !,
2530		clpfd_card_domain_for_var(S,_,Max), number(Max),
2531		MaxCard=Max.
2532		get_max_card_for_value([],R) :- !, R=0.
2533		get_max_card_for_value([_|T],R) :- !,get_max_card_for_value(T,TMax), R is TMax+1.
2534		get_max_card_for_value(S,Card) :- efficient_card_for_set(S,Card,C),!,
2535		call(C), number(Card).
2536
2537
2538		get_integer(X, b(Expr,integer,_),LS,S) :- get_integer2(Expr,X,LS,S).
2539		get_integer2(integer(X),X,_,_) :- number(X).
2540		get_integer2(identifier(Id),Val,LS,S) :- lookup_value(Id,LS,S,int(Val)), number(Val).
2541
2542		member_conjunct(Predicate,Conjunction,Rest) :-
2543		conjunction_to_list(Conjunction,List),
2544	?	select(Predicate,List,RestList),
2545		conjunct_predicates(RestList,Rest).
2546		% member_conjunct(Conj,Conj,b(truth,pred,[])). covered by case above
2547
2548		b_generate_set_for_all_domain(Set,LS,S,Pattern,ParameterValues,ForAllDomain,WF) :-
2549		b_compute_expression(Set,LS,S,EvSet,WF),
2550		expand_custom_set_to_list_wf(EvSet,ESet,_Done,b_generate_set_for_all_domain,WF),
2551		filter_and_convert_list_to_parameter_tuples(ESet,Pattern,ParameterValues,ForAllDomain).
2552
2553
2554		% check if it is a predicate of the form x:S or x:Sx & y:Sy ... which we can optimize
2555		% (i.e. compute SET before all values inside it are fully known)
2556		is_for_all_set_membership_predicate(LHS,Parameters,Set,Pattern,ParameterValues) :-
2557		% print('CHECK FORALL : '), translate:print_bexpr(LHS),nl,nl,
2558		get_texpr_ids(Parameters,ParIDs), % TO DO: call get_texpr_ids before
2559		same_length(ParIDs,ParameterValues),
2560		is_for_all_set_membership_predicate2(LHS,ParIDs,ParIDs,UnmatchedParIDs,Set,Pattern,ParameterValues,_UPV),
2561		UnmatchedParIDs=[].
2562
2563		% TODO: maybe also deal with existential quantifiers #x.(x|->y:Set) -> in Pattern x becomes free var
2564		is_for_all_set_membership_predicate2(LHS,All,ParIDs,UnmatchedParIDs,Set,Pattern,ParameterValues,UPV) :-
2565		is_member_test(LHS,Element,Set),
2566		!,
2567		identifiers_not_used_in_bexp(All,Set),
2568		convert_to_prolog_pattern_match(Element,ParIDs,UnmatchedParIDs,Pattern,ParameterValues,UPV).
2569		% TO DO: also allow failing pattern matches ?!; at least when splitting
2570		is_for_all_set_membership_predicate2(LHS,All,ParIDs,ParIDs2,Set,
2571		(Pat1,Pat2),ParameterValues,UPV) :-
2572		is_a_conjunct(LHS,LHS1,LHS2), % we could have something of the form x:Sx & y:Sy ...
2573		Set = b(cartesian_product(Set1,Set2),couple(T1,T2),[]),
2574		is_for_all_set_membership_predicate2(LHS1,All,ParIDs, ParIDs1,Set1,Pat1,ParameterValues,PV1),
2575		get_texpr_type(Set1,T1),
2576		!,
2577		is_for_all_set_membership_predicate2(LHS2,All,ParIDs1,ParIDs2,Set2,Pat2,PV1,UPV),
2578		get_texpr_type(Set2,T2).
2579
2580		% TO DO: maybe use a more general test to be reused in other places
2581		is_member_test(b(P,_,_),Element,Set) :- is_member_test_aux(P,Element,Set).
2582		is_member_test_aux(member(Element,Set),Element,Set).
2583		% also detect equalities: important for tests 28,29 after b_compiler can introduce equalities for singleton set memberships
2584		is_member_test_aux(equal(Element,SetVal),Element,Set) :- % TO DO : also other direction + other kinds of values ?
2585		SetVal = b(value(SV),T,I),
2586		Set = b(value([SV]),set(T),I).
2587
2588		identifiers_not_used_in_bexp(IDList,Expr) :-
2589		find_identifier_uses(Expr,[],Used),
2590		id_check(IDList,Used).
2591		id_check([],_).
2592		id_check([ID|T],Used) :-
2593		nonmember(ID,Used), !,
2594		id_check(T,Used).
2595
2596		% check if an expression can be converted to a Prolog linear unification/pattern match
2597		% give an list of free identifiers IDS
2598		convert_to_prolog_pattern_match(b(E,_,_),IDS,OutIDS,Pattern,VarsIn,VarsOut) :-
2599		convert_to_prolog_pattern_match2(E,IDS,OutIDS,Pattern,VarsIn,VarsOut).
2600
2601		convert_to_prolog_pattern_match2(identifier(ID),IDsIn,IDsOut,PatVariable,VarsIn,VarsOut) :-
2602		% check that the identifier is in the list of quantified variables and thus unbound
2603		!,
2604	?	(nth1(Nr,IDsIn,ID,IDsOut)
2605		-> nth1(Nr,VarsIn,PatVariable,VarsOut) % put fresh PatVariable in the Pattern
2606		),!.
2607		convert_to_prolog_pattern_match2(couple(ID1,ID2),IDS,OutIDS,Pattern,VarsIn,VarsOut) :-
2608		Pattern = (Pat1,Pat2),
2609		convert_to_prolog_pattern_match(ID1,IDS,RemIDS,Pat1,VarsIn,VarsInt),
2610		convert_to_prolog_pattern_match(ID2,RemIDS,OutIDS,Pat2,VarsInt,VarsOut).
2611		convert_to_prolog_pattern_match2(value(V),IDsIn,IDsOut,Pattern,VarsIn,VarsOut) :-
2612		can_be_used_for_unification(V), % check if we can use Prolog unification for equality
2613		!, Pattern=V, IDsOut=IDsIn, VarsIn=VarsOut.
2614		% TO DO: records?
2615
2616		% a pattern match code to be used with above; ensure we do not instantiate values
2617		pattern_match(PatVar,Val,Res) :- var(PatVar),!,PatVar=Val, Res=pred_true. % we have a free pattern variable
2618		pattern_match((Pat1,Pat2),(V1,V2),Res) :- !,
2619		pattern_match(Pat1,V1,R1), conjoin_simple(R1,R2,Res),
2620		pattern_match(Pat2,V2,R2).
2621		pattern_match(GroundPatVal,Val,Res) :- % we have a value that can_be_used_for_unification
2622		when( ?=(GroundPatVal,Val), (GroundPatVal=Val -> Res=pred_true ; Res=pred_false)).
2623
2624		:- block conjoin_simple(-,?,?). % TO DO: also allow second arg to unblock
2625		conjoin_simple(pred_true,X,X).
2626		conjoin_simple(pred_false,_,pred_false).
2627
2628		% similar to get_template(V,T,[])
2629		% but more restricted; we only accept those values where equality corresponds to Prolog unification
2630		% get_template is different and can assume normalized values, e.g., for empty set
2631		% pairs are treated above in convert_to_prolog_pattern_match2
2632		can_be_used_for_unification(V) :- var(V),!,fail.
2633		can_be_used_for_unification(int(V)) :- nonvar(V).
2634		can_be_used_for_unification(string(S)) :- ground(S).
2635		can_be_used_for_unification(fd(S,T)) :- ground(S), ground(T).
2636		can_be_used_for_unification(pred_false).
2637		can_be_used_for_unification(pred_true).
2638
2639
2640
2641		% take a list and a pattern and filter the values that do not match the Pattern
2642		% Unification with the Pattern also instantiates the ParameterValues
2643		% TODO: Instead of converting to a Prolog Unification we could use kernel_equality instead of pattern_match
2644		% but this is not obvious, as the pattern contains free variables and equality would never return true
2645		% we would need to apply kernel_equality only to the ground pattern parts
2646		:- block filter_and_convert_list_to_parameter_tuples(-,?,?,?).
2647		filter_and_convert_list_to_parameter_tuples([],_,_,[]).
2648		filter_and_convert_list_to_parameter_tuples([H|T],Pattern,ParameterValues,Res) :-
2649		copy_term((Pattern,ParameterValues),(CPat,CPV)),
2650		pattern_match(CPat,H,PredRes), % check if pattern matches new element H in set; careful not to instantiate H
2651	?	filter_and_convert_list_to_parameter_tuples_aux(PredRes,CPV,T,Pattern,ParameterValues,Res).
2652
2653		:- block filter_and_convert_list_to_parameter_tuples_aux(-,?,-,?,?,?).
2654		filter_and_convert_list_to_parameter_tuples_aux(PredRes,CPV,T,Pattern,ParameterValues,Res) :-
2655		var(PredRes),!, % we cannot decide yet whether the optional value is to be used or not
2656		Res = [optional_value(CPV,PredRes)|RT], % create constructor for map_optlist or similar
2657		filter_and_convert_list_to_parameter_tuples(T,Pattern,ParameterValues,RT).
2658		filter_and_convert_list_to_parameter_tuples_aux(PredRes,CPV,T,Pattern,ParameterValues,Res) :-
2659		(PredRes = pred_true % we have a match, universal quantifier applies to H
2660		-> Res = [CPV|RT]
2661		; % element of set does not match pattern; universal quantifier does not apply
2662		% ProB used to only accept non-failing pattern matches;
2663		% now we also accept tuples with static parts where Prolog unification can fail
2664		Res=RT
2665		),
2666	?	filter_and_convert_list_to_parameter_tuples(T,Pattern,ParameterValues,RT).
2667
2668		:- use_module(tools,[map_optlist/2,optlist_to_list/2]).
2669		:- use_module(library(lists),[maplist/3]).
2670		expand_forall1(OList,RHS,Parameters,WF) :-
2671		ground_bexpr(RHS), % because compiled this means we cannot do any constraint propagation on variables in RHS
2672		optlist_to_list(OList,List),
2673		ground_value(List), % ditto here: no variables on which we could do constraint propagation
2674		%% preferences:get_preference(double_evaluation_when_analysing,false), % causes test 1112 to fail TO DO:fix
2675		% otherwise we do not have a real redundancy wrt to not exists check
2676		debug_println(15,ground_forall_translating_into_not_exists(Parameters)),
2677		!,
2678		%kernel_waitflags:init_wait_flags(LocalWF,[expansion_context(forall,Parameters)]),
2679		init_quantifier_wait_flag(WF,forall,Parameters,ParResult,unknown,LocalWF),
2680		% Advantage over treatment below: NegRHS is interpreted only once
2681		% but we cannot provide any instantiations and there must not be any links with variables outside of the forall !!
2682		create_negation(RHS,NegRHS),
2683		not_with_enum_warning( (
2684		b_interpreter:test_forall_instance(NegRHS,Parameters,LocalWF,negative,ParResult), % can fail; if inconsistency detected in WF0
2685		kernel_waitflags:ground_det_wait_flag(LocalWF),
2686		member(ParResultInList,List), % check the body for every solution
2687		lists:maplist(kernel_objects:equal_object,ParResultInList,ParResult), % match parameters with the solutions of the domain
2688		kernel_waitflags:ground_wait_flags(LocalWF) % do not ground EF? ground_constraintprop_wait_flags ground_inner_wait_flags
2689		), LocalWF, forall(Parameters), RHS
2690		).
2691		expand_forall1(List,RHS,Parameters,WF) :-
2692	?	map_optlist(b_interpreter:test_forall_instance(RHS,Parameters,WF,positive),List).
2693
2694
2695		test_forall_instance(RHS,Parameters,WF,NegationContext,ParResult) :-
2696		LocalState=[],State=[],
2697	?	if(set_up_typed_localstate(Parameters,ParResult,_TypedVals,LocalState,NewLocalState,NegationContext),
2698		true,
2699		(nl,print(set_up_typed_localstate_failed(Parameters,ParResult,_,LocalState,NewLocalState)),nl,
2700		% it can happen that ParResult has constraints on it and that setting up the typing info detects the error
2701		% add_internal_error('Call failed: ', set_up_typed_localstate(Parameters,ParResult,_,LocalState,NewLocalState)),
2702		fail)),
2703	?	b_optimized_b_test_instance(RHS,NewLocalState,State,WF).
2704
2705		reification_relevant_for_op(implication(_,_)).
2706		reification_relevant_for_op(equivalence(_,_)).
2707		reification_relevant_for_op(disjunct(_,_)).
2708		% TODO: maybe check if a conjunct contains implication
2709		% relevant for example for: n=2000 & f:1..n-->BOOL & !i.(i:2..n => (f(i)=TRUE =>f(i-1)=FALSE)) & f(1)=TRUE
2710
2711		b_optimized_b_test_instance(RHS,NewLocalState,State,WF) :-
2712		get_texpr_expr(RHS,RE), reification_relevant_for_op(RE), % we will attempt reification
2713		attempt_reification,
2714		\+ always_well_defined(RHS), % this will prevent reification
2715		!,
2716		% try and compile in the hope that now the WD issue disappears:
2717		b_compiler:b_optimize(RHS,[],NewLocalState,State,NewRHS,WF),
2718		b_test_boolean_expression(NewRHS,NewLocalState,State,WF).
2719		b_optimized_b_test_instance(RHS,NewLocalState,State,WF) :-
2720	?	b_test_boolean_expression(RHS,NewLocalState,State,WF).
2721		% using b_test_inner_boolean_expression considerably slows down NQueens, Sudoku,...
2722		% WF=InnerWF. /* give the boolean expression a chance to do ground propagations first */
2723
2724
2725		% use this when the test boolean expression could be called with WF0 already set
2726		% give the inner expression a chance to do the deterministic stuff first
2727		b_test_inner_boolean_expression(Pred,LocalState,State,WF) :-
2728		kernel_waitflags:clone_wait_flags_from1(WF,GroundUponFinish,WF2),
2729		% set WF0 to variable to propagate deterministic infos first:
2730	?	b_test_boolean_expression(Pred,LocalState,State,WF2),
2731	?	kernel_waitflags:clone_wait_flags_from1_finish(WF,GroundUponFinish,WF2).
2732		% the same for testing negation of a predicate:
2733		b_not_test_inner_boolean_expression(Pred,LocalState,State,WF) :-
2734		kernel_waitflags:clone_wait_flags_from1(WF,GroundUponFinish,WF2),
2735		% set WF0 to variable to propagate deterministic infos first:
2736	?	b_not_test_boolean_expression(Pred,LocalState,State,WF2),
2737	?	kernel_waitflags:clone_wait_flags_from1_finish(WF,GroundUponFinish,WF2).
2738
2739		/* now the same as above; but without converting list of values into pairs */
2740		:- assert_pre(b_interpreter:b_expand_closure_forall_to_list(Closure,_Result,_WF),
2741		(nonvar(Closure), custom_explicit_sets:is_closure(Closure,_Parameters,_ParameterTypes,ClosureBody),
2742		nonvar(ClosureBody),
2743		bsyntaxtree:check_if_typed_predicate(ClosureBody))).
2744		:- assert_post(b_interpreter:b_expand_closure_forall_to_list(_Closure,Result,_WF),
2745		b_interpreter:value_type(Result)).
2746		b_expand_closure_forall_to_list(Closure,Result,WF) :- nonvar(Closure),
2747		Closure = closure(Parameters,ParameterTypes,ClosureBody),
2748		!,
2749		% print('Expand closure forall: '), translate:print_bexpr(ClosureBody),nl,
2750		% at the moment we may wait too long before expanding this closure
2751		% what if we have f(1) in the ClosureBody: in principle we only need to wait until f(1) known or even f sekeleton set up ? compilation now solves this issue ?
2752		(performance_monitoring_on,
2753		term_variables(ClosureBody,Vars),
2754		Vars \= []
2755		->
2756		perfmessagecall(delaying_forall(Parameters,vars(Vars),out(ParValues)),
2757		translate:print_bexpr(ClosureBody),ClosureBody)
2758		; true),
2759		ground_bexpr_check(ClosureBody,BodyGround),
2760		add_texpr_infos(ClosureBody,[quantifier_kind(forall)],ClosureBody1), % for call_stack
2761		delay_setof_list_wf( ParValues,
2762		%% (print_bt_message(expanding_forall_closure(Parameters,ClosureBody,ParValues)), %%
2763		custom_explicit_sets:b_test_closure(Parameters,ParameterTypes,ClosureBody1,
2764		ParValues,all_solutions,WF)
2765		%% ,print_bt_message(expanded(Parameters,ParValues)) ) %%
2766		,
2767		Result,
2768		BodyGround,WF).
2769		b_expand_closure_forall_to_list(Closure,Result,WF) :-
2770		add_internal_error('Illegal Call: ', b_expand_closure_forall_to_list(Closure,Result,WF)),
2771		fail.
2772
2773
2774		:- assert_pre(b_interpreter:set_up_typed_localstate(V,S,_), (list_skeleton(V),list_skeleton(S))).
2775		:- assert_post(b_interpreter:set_up_typed_localstate(_,_,R),list_skeleton(R)).
2776
2777		set_up_typed_localstate(Identifiers,InState,OutState) :-
2778	?	set_up_typed_localstate(Identifiers,_FreshVars,_TypedVals,InState,OutState,positive).
2779
2780		:- use_module(b_enumerate,[construct_typedval_infos/4]).
2781		set_up_typed_localstate([],[],[],State,State,_).
2782		set_up_typed_localstate([Identifier|IdRest],[Val|ValRest],[typedval(Val,Type,Var,TINFO)|TRest],
2783		% TO DO: add info field to typedval: source_span, and lambda_result/do_not_enumerate infos
2784		InState,OutState,NegationContext) :-
2785		% The other way round (first add Identfier, then IdRest) would be more efficient,
2786		% but we do it this way to keep compatibility with a previous version.
2787		% In specfile:compute_operation_effect, the arguments of an operation are in the same order than in the store
2788	?	set_up_typed_localstate(IdRest,ValRest,TRest,InState,InterState,NegationContext),
2789		def_get_texpr_id(Identifier,Var), get_texpr_type(Identifier,Type),
2790		get_texpr_info(Identifier,Info),
2791		triggers_enum_warning(Var,Type,Info,NegationContext,TriggersEnumWarning),
2792		get_texpr_info(Identifier,Infos),construct_typedval_infos(Var,Infos,TriggersEnumWarning,TINFO),
2793	?	add_typed_var_to_localstate(Var,Val,Type,InterState,OutState).
2794
2795		% same version; but with list of atomic ids and list of types
2796		set_up_typed_localstate2([],[],_,[],[],State,State,_).
2797		set_up_typed_localstate2([Var|IdRest],[Type|TyRest],Infos,[Val|ValRest],[typedval(Val,Type,Var,TINFO)|TRest],
2798		InState,OutState,NegationContext) :-
2799		% The other way round (first add Identfier, then IdRest) would be more efficient,
2800		% but we do it this way to keep compatibility with a previous version.
2801		% In specfile:compute_operation_effect, the arguments of an operation are in the same order than in the store
2802	?	set_up_typed_localstate2(IdRest,TyRest,Infos,ValRest,TRest,InState,InterState,NegationContext),
2803		triggers_enum_warning(Var,Type,Infos,NegationContext,TriggersEnumWarning),
2804		construct_typedval_infos(Var,Infos,TriggersEnumWarning,TINFO),
2805	?	add_typed_var_to_localstate(Var,Val,Type,InterState,OutState).
2806
2807		% possible values for NegationContext: positive, negative, all_solutions
2808		triggers_enum_warning(Id,Type,Info,all_solutions,Res) :- !,
2809		Res = trigger_throw(b(identifier(Id),Type,Info)).
2810		%triggers_enum_warning(Id,_Type,Info,NegationContext,trigger_false(Id)) :- % no longer used
2811		% NegationContext=positive, % when negated then success will occur if all possibilities have been tried out
2812		% memberchk(introduced_by(exists),Info),
2813		% %%((preferences:get_preference(disprover_mode,true),type_contains_unfixed_deferred_set(Type))-> fail % otherwise %finding a solution may depend on the size of the deferred set; true),
2814		% %% The Disprover now checks whether unfixed_deferred sets were involved; keeping track of implicit enumerations of %deferred sets is just too difficult
2815		% !.
2816		triggers_enum_warning(Id,Type,Info,_,trigger_true(b(identifier(Id),Type,Info))).
2817
2818
2819		add_typed_var_to_localstate(Var,Val,Type,InState,OutState) :-
2820		add_var_to_localstate(Var,Val,InState,OutState),
2821		%%when(ground(Val), (print(' ++ '),print(Var),print(' ---> '), print(Val),nl)),
2822	?	kernel_objects:basic_type(Val,Type). %% ,print(ok(Val)),nl.
2823
2824		/*
2825		xxb_test_exists(Parameters,Condition,Infos,LocalState,State,WF) :-
2826		b_check_boolean_expression(b(exists(Parameters,Condition),pred,Infos),LocalState,State,WF,NR),
2827		get_exists_used_ids(Parameters,Condition,Infos,Used),lookup_values_if_vars(Used,LocalState,State,WaitVars),
2828		\+ ground(WaitVars),
2829		!,
2830		debug_println(9,unfolding_exists(Parameters)), print(unfolding(Parameters)),nl,
2831		%translate:print_bexpr(Condition),nl, print(State),nl, print(LocalState),nl,nl,
2832		NR=pred_true. %, print(set_res(pred_true)),nl.
2833		% if enabled it slows down: ./probcli examples/EventBPrologPackages/SET_Game/SET_GAM_Sym_NoSet20_mch.eventb -mc 10000000 -p SYMMETRY_MODE hash -p TIME_OUT 7000 -p CLPFD TRUE -df -goal "n=18" -p MAX_OPERATIONS 20 -strict -expcterr goal_found
2834		*/
2835
2836		b_test_exists(Parameters,Condition,Infos,LocalState,State,WF) :-
2837		get_wait_flag0(WF,WF0),
2838	?	b_test_exists(WF0,Parameters,Condition,Infos,LocalState,State,WF).
2839
2840		:- block b_test_exists(-,?,?, ?,?,?,?).
2841		b_test_exists(_LWF,Parameters,Condition,Infos,LocalState,State,WF) :-
2842		if((attempt_reification, % what if there is a wd_condition attached to Condition?
2843		b_interpreter_check:b_check_exists_wf(Parameters,Condition,Infos,LocalState,State,WF,ReificationVariable)),
2844		% try and expand quantifiers of small cardinality; see also expand_forall_quantifier
2845		% tested in test 1452
2846		(debug_println(9,expanded_exists(Parameters)),
2847		ReificationVariable=pred_true),
2848	?	b_test_exists_wo_expansion(Parameters,Condition,Infos,LocalState,State,WF)).
2849
2850		%attempt_reification :- preferences:preference(use_clpfd_solver,true),!. % all tests seem to pass
2851		attempt_reification :- preferences:preference(use_smt_mode,true),!.
2852		attempt_reification :- preferences:preference(solver_strength,SS), SS>9.
2853		% TO DO: maybe take context into account: setup constants, becomes such, ... allow_skipping_over_components/reset_component_info(true)
2854
2855		:- use_module(kernel_tools,[bexpr_variables/2, value_variables/3]).
2856
2857		% we treat the existential quantifier without expansion into a disjuncition aka reification
2858		b_test_exists_wo_expansion(Parameters,Condition,Infos,LocalState,State,WF) :-
2859		%print(test_exists(Parameters,Infos)),nl,portray_waitflags(WF),nl,
2860	?	(preference(lift_existential_quantifiers,true) ; member(allow_to_lift_exists,Infos)),
2861		!, % we enumerate the exists normally; treat it just like an ordinary predicate
2862		% lifting may generate multiple solutions; but avoids delaying enumeration of quantified parameters
2863		% print('*Lifting existential quantifier: '), translate:print_bexpr(Condition),nl,
2864	?	set_up_typed_localstate(Parameters,ParaValues,TypedVals,LocalState,NewLocalState,positive),
2865		copy_wf_start(WF,b_test_exists_wo_expansion,CWF),
2866		opt_push_wait_flag_call_stack_quantifier_info(CWF,exists,Parameters,ParaValues,Infos,CWF2),
2867	?	b_test_boolean_expression(Condition,NewLocalState,State,CWF2),
2868		% often we do not need to enumerate TypedVals; they can be derived, but we could have #y.(y>x) and need to enum y
2869		b_tighter_enumerate_values_in_ctxt(TypedVals,Condition,CWF2),
2870	?	copy_wf_finish(WF,CWF2). % moving this before tighter_enum may mean that we have more precise ranges; but this can be counter-productive (e.g., for test 1162 unless we strengthen the useless enum analysis)
2871		b_test_exists_wo_expansion(Parameters,Condition,Infos,LocalState,State,WF) :-
2872		get_exists_used_ids(Parameters,Condition,Infos,Used),
2873		% IT IS IMPORTANT THAT THE USED INFO IS CORRECT ; otherwise the WaitVars will be incorrect
2874		% The used_ids info does not include the Parameters of the existential quantifier !
2875	?	set_up_typed_localstate(Parameters,ParaValues,TypedVals,LocalState,NewLocalState,positive),
2876		lookup_values_if_vars(Used,LocalState,State,WaitVarsState), % TO DO: we could use b_compiler instead
2877		% What if the Condition was compiled and now contains a previously used_variable inside a closure/value ?
2878		%term_variables((Condition,WaitVarsState),WaitVars), % this can be expensive when we have large data values (see rule_RVF219/rule_RVF219_compo.mch)
2879		bexpr_variables(Condition,CondVars),
2880		value_variables(WaitVarsState,CondVars,WaitVars),
2881		% now determine which WaitVars are really worth waiting for, e.g., do not wait for res in #x.(x:E & ... res=min(f(x)))
2882		% relevant tests: 1868, 1194, 383, 1642, 1708, 1003, 1080, 1081, 1943
2883		(remove_ids_defined_by_equality(WaitVars,LocalState,State,Infos,RealWaitVars) -> RemovedVars=true
2884		; RealWaitVars = WaitVars, RemovedVars=false),
2885		opt_push_wait_flag_call_stack_quantifier_info(WF,exists,Parameters,ParaValues,Infos,WF2),
2886		create_inner_wait_flags(WF2,expansion_context(b_test_exists,Parameters),LocalWF), % we are creating inner waitflags here as the exist will wait anyway; LocalWF shares just WFE flag with WF
2887	?	b_test_boolean_expression(Condition,NewLocalState,State,LocalWF), /* check Condition */
2888	?	ground_det_wait_flag(LocalWF), % print('det no contradiction'),nl,flush_output,
2889		b_tighter_enumerate_values_in_ctxt(TypedVals,Condition,LocalWF), % will not yet enumerate
2890		(% we could treat allow_to_lift_exists also here by setting ESWF=1; but 1162 then fails
2891		get_preference(data_validation_mode,true),
2892		not_generated_exists_paras(Parameters) % generated exists, e.g., for relational composition can lead to virtual timeouts, cf Thales_All/rule_zcpa2.mch in test 2287
2893		-> get_wait_flag(50000,b_test_exists(Parameters),WF,ESWF) % 100000 sufficient for test 1945; 869 for rule_CHAMPS in private_examples/ClearSy/2023
2894		; get_enumeration_starting_wait_flag(b_test_exists(Parameters),WF,ESWF)), %% TO DO: get flag when enumeration of infinite type starts; maybe if domain of exists is small we can start enumerating earlier ?? <-> relation with lifting exists in closure expansion heuristic
2895		when((nonvar(ESWF);ground(RealWaitVars)),b_enumerate_exists(ESWF,RemovedVars,WaitVars,Parameters,Infos,LocalWF,WF)).
2896
2897
2898		:- use_module(tools,[remove_variables/3]).
2899		:- use_module(kernel_tools,[value_variables/2]).
2900		% if we have #x.( P & y = E(x)) we do not have to wait for y to be known
2901		remove_ids_defined_by_equality(WaitVars,LocalState,State,Infos,RealWaitVars) :- WaitVars \== [],
2902		memberchk(used_ids_defined_by_equality(Ideq),Infos),
2903		Ideq = [ID1|_], % currently we only look at one used_id defined by equality,
2904		% we could have #x.(P & y=E(z) & z=E(y)): TODO: improve computation in ast_cleanup
2905		(memberchk(bind(ID1,VAL),LocalState) -> true ; memberchk(bind(ID1,VAL),State)),
2906		value_variables(VAL,VARS),
2907		remove_variables(WaitVars,VARS,RealWaitVars),
2908		debug_println(9,removed_ids_def_by_equality(WaitVars,ID1,RealWaitVars)).
2909
2910
2911		b_enumerate_exists(ESWF,RemovedVars,WaitVars,Parameters,Infos,LocalWF,WF) :-
2912		%print(enum_exists(ESWF,RemovedVars,WaitVars,Parameters,LocalWF,WF)),nl,
2913		((RemovedVars=false,var(ESWF) ; % WaitVars guaranteed to be ground
2914		ground(WaitVars)) % TODO: replace this by an optimised version of ground check
2915		-> get_idle_flag(Parameters,WF,LWF),
2916		/* allow all other co-routines waiting on WaitVars to complete */
2917		/* Note however: if WF grounding as triggered two non-deterministic co-routines this
2918		will allow the other non-determinism to run first, duplicating the number of calls !
2919		This has been fixed by storing seperate waitflag variables for same prio in kernel_waitflags
2920		TODO: However, for enumeration of FD variables this might still happen and lead to duplication of
2921		calls to b_enumerate_exists_aux_ground
2922		*/
2923		%print(get_idle(Parameters,WaitVars)),nl, %kernel_waitflags:portray_waitflags(WF),nl,nl,
2924		b_enumerate_exists_aux_ground(LWF,WaitVars,Parameters,Infos,LocalWF,WF)
2925		; debug_println(9,semi_lifting_exists(ESWF,Parameters)),
2926		% add_message_wf(exists,'Semi-lifting exists:',Parameters,Parameters,WF),portray_waitflags(LocalWF),nl,
2927		kernel_waitflags:copy_waitflag_store(LocalWF,WF) % outer WF will now drive enumeration
2928		% Note: in case a LET has been moved inside and replaced this may lead to duplication
2929		).
2930
2931		:- if(environ(prob_safe_mode,true)).
2932		get_idle_flag(Parameters,WF,LWF) :- kernel_waitflags:get_idle_wait_flag(b_enumerate_exists(Parameters),WF,LWF),
2933		(var(LWF) -> true ; add_internal_error('Illegal idle waitflag for exists:',get_idle_flag(Parameters,WF,LWF))).
2934		:- else.
2935		get_idle_flag(Parameters,WF,LWF) :- kernel_waitflags:get_idle_wait_flag(b_enumerate_exists(Parameters),WF,LWF).
2936		:- endif.
2937
2938		:- block b_enumerate_exists_aux_ground(-,?,?,?,?,?).
2939		b_enumerate_exists_aux_ground(_,_WaitVars,Parameters,Infos,LocalWF,_WF) :-
2940		/* Note: this does a local cut: so it is important
2941		that all conditions are fully evaluated before performing the cut ; otherwise
2942		solutions will be lost */
2943		% print_bt_message('ENUMERATE EXISTS'(_Parameters)),nl, % portray_waitflags(_WF),
2944		if(ground_wait_flags_for_exists(Parameters,LocalWF),true,
2945		(perfmessage(exists,'Late bound exists failed: ',Parameters,Infos),fail)).
2946
2947
2948		ground_wait_flags_for_exists(Parameters,LocalWF) :-
2949	?	\+ enumeration_warning_occured_in_error_scope,
2950		get_current_error_scope(Level),
2951	?	\+ error_manager:throw_error(Level,_,_),
2952		!, % current scope is already clean, no need to enter a fresh one
2953		ground_wait_flags_for_exists2(Parameters,LocalWF,Level).
2954		ground_wait_flags_for_exists(Parameters,LocalWF) :-
2955		enter_new_clean_error_scope(Level),
2956		% Note: see {x|x:1..10 & #y.(y>x & y*y >10)} in test 2210:
2957		% we do not want to throw enum warnings even if the outer scope does in case a solution is found
2958		% NOTE: if this engenders an enumeration warning: it may have been better to enumerate the outer WF first ?! : but as WaitVars are ground, so only failure of outer WF could help us here in preventing enumeration warning
2959		call_cleanup(ground_wait_flags_for_exists2(Parameters,LocalWF,Level),
2960		exit_error_scope(Level,_,ground_wait_flags_for_exists)).
2961
2962		ground_wait_flags_for_exists2(_Parameters,LocalWF,Level) :-
2963	?	(ground_constraintprop_wait_flags(LocalWF)
2964		-> % local cut: one solution is sufficient.
2965		clear_enumeration_warning_in_error_scope(Level)
2966		% ; %print(fail),nl, % do not clear enumeration warnings fail
2967		).
2968
2969
2970		:- use_module(b_ast_cleanup,[check_used_ids_info/4]).
2971		get_exists_used_ids(Parameters,Condition,Infos,Used) :-
2972		preference(prob_safe_mode,true),!,
2973	?	(select(used_ids(Used),Infos,Rest)
2974		-> check_used_ids_info(Parameters,Condition,Used,exists), %% comment in to check used_ids field
2975		(member(used_ids(_),Rest)
2976		-> add_internal_error('Multiple used_ids info fields:',Parameters:Infos) ; true)
2977		;
2978		add_internal_error(
2979		'Expected information of used identifiers in exists information',Parameters:Infos),
2980		bsyntaxtree:find_identifier_uses(Condition, [], Used)
2981		).
2982		get_exists_used_ids(Parameters,Condition,Infos,Used) :-
2983	?	member(used_ids(Used),Infos) -> true
2984		;
2985		add_internal_error(
2986		'Expected information of used identifiers in exists information',Parameters:Infos),
2987		bsyntaxtree:find_identifier_uses(Condition, [], Used).
2988		% what if we call test_exists for a negated universal quantifier ??
2989
2990
2991
2992
2993		:- use_module(kernel_tools,[ground_state/1]).
2994		/* the following causes performance problems with examples/B/Mathematical/GraphIso/CheckGraphIsomorphism
2995		and with lausanne.mch in SMT mode */
2996		b_not_test_exists(Parameters,Condition,Infos,LocalState,State,_,WF) :-
2997		preferences:preference(use_smt_mode,true),
2998		is_a_conjunct(Condition,LHS,RHS),
2999		(\+ ground_state(LocalState) ; \+ ground_state(State)),
3000		% TO DO: check if any of the variables in Condition are not ground
3001		% TO DO: check if used_ids exist in Infos ? memberchk(used_ids(_),Infos),
3002		!,
3003		%print(translating_not_exists_into_forall),nl,print(' '),print_bexpr(LHS),nl, print('=> '),print_bexpr(RHS),nl,
3004		(is_for_all_set_membership_predicate(RHS,Parameters,_Set,_Pattern,_ParameterValues),
3005		\+ is_for_all_set_membership_predicate(LHS,Parameters,_,_,_)
3006		-> LLHS=RHS, RRHS=LHS % swap LHS and RHS; TO DO: search for membership predicate inside LHS,RHS !!
3007		; LLHS=LHS, RRHS=RHS
3008		),
3009		safe_create_texpr(negation(RRHS),pred,NegRHS),
3010		b_for_all(Parameters,Infos,LLHS,NegRHS,LocalState,State,WF).
3011		b_not_test_exists(Parameters,Condition,Infos,[],[],no_compile,WF) :- !,
3012		% already compiled in is_empty_closure_wf
3013		ground_bexpr_check(Condition,Ground),
3014		b_not_test_exists_aux(Ground,Parameters,Condition, Infos, WF).
3015		b_not_test_exists(Parameters,Condition,Infos,LocalState,State,_,WF) :-
3016		% compile to remove dependency on unused parts of State+LocalState; will make it delay less below
3017		def_get_texpr_ids(Parameters,ParaIDs),
3018		%% print(b_not_test_exists(ParaIDs)),nl, print(state(LocalState,State)),nl, %%
3019	?	b_compiler:b_compile(Condition,ParaIDs,LocalState,State,CompiledCond,WF),
3020		(is_truth(CompiledCond) -> fail
3021		; is_falsity(CompiledCond) -> true
3022		% TO DO: we could detect equalities that will always succeed (but be careful for WD issues)
3023		; ground_bexpr_check(CompiledCond,Ground),
3024		b_not_test_exists_aux(Ground,Parameters,CompiledCond, Infos, WF)
3025		).
3026
3027		:- block b_not_test_exists_aux(-,?,?,?,?).
3028		b_not_test_exists_aux(_,Parameters,CompiledCond,Infos,WF) :-
3029		% getting an idle waitflag considerably slows down test 1739; see also ClearSy/2019_Aug/call_residue/rule_erreur.mch
3030		% slow down no longer the case with the new waitflag implementation
3031		kernel_waitflags:get_idle_wait_flag(b_not_test_exists_aux(Parameters),WF,LWF),
3032		% allow pending co-routines to complete
3033		b_not_test_exists_aux2(LWF,Parameters,CompiledCond,Infos,WF).
3034		:- block b_not_test_exists_aux2(-,?,?,?,?).
3035		b_not_test_exists_aux2(_,Parameters,CompiledCond,Infos,WF) :-
3036		% no need to create inner waitflag: we enumerate fully below: create_inner_wait_flags(WF,b_not_test_exists(Parameters),LocalWF),
3037		%init_wait_flags(LocalWF,[expansion_context(b_not_not_test_exists,Parameters)]),
3038		init_quantifier_wait_flag(WF,not(exists),Parameters,ParaResult,Infos,LocalWF),
3039		not_with_enum_warning(
3040		b_interpreter:b_not_not_test_exists_aux(Parameters,ParaResult,CompiledCond,LocalWF),
3041		LocalWF, CompiledCond, % was not_exists(Parameters), the not_exists quantifier call is on call_stack now
3042		CompiledCond),
3043		copy_wfe_from_inner_if_necessary(LocalWF,WF). % for the case that the negated call has found abort errors and WFE was not grounded
3044		b_not_not_test_exists_aux(Parameters,ParaResult,CompiledCond,LocalWF) :-
3045	?	b_interpreter:set_up_typed_localstate(Parameters,ParaResult,TypedVals,[],NewLocalState,negated),
3046		% delay generation of WD error messages until outer WFE flag set
3047	?	b_interpreter:b_test_boolean_expression(CompiledCond,NewLocalState,[],LocalWF), % check Condition
3048		b_tighter_enumerate_values_in_ctxt(TypedVals,CompiledCond,LocalWF),
3049	?	ground_inner_wait_flags(LocalWF). % does not always ground WFE if abort is pending in which case not_with_enum_warning also does not fail and keeps the co-routines
3050		% pending co-routines will be discarded by negation !
3051
3052
3053		/* --------------------------------- */
3054
3055		value_type(_X). % only used in post_conditions (assert_post)
3056		/*
3057		value_type(X) :- nonvar(X),
3058		(X = value(_) ; X = global_set(_) ;
3059		X = global_constant(_) ; X = term(_)).*/
3060
3061
3062		% look up identifiers in store, if the identifier
3063		% is not in the store, assume it's a constant and ignore it
3064		% used for determining wait variables for existential quantifier
3065		% TO DO: better deal with CSE @identifiers ?
3066		lookup_values_if_vars([],_,_,[]).
3067		lookup_values_if_vars([Id|IRest],LocalStore,Store,Values) :-
3068		( lookup_value(Id,LocalStore,Store,Val)
3069		-> (force_evaluation_of_lazy_value(Id,Val,RealVal)
3070		-> Values = [RealVal|VRest]
3071		; Values = [Val|VRest])
3072		; Values = VRest),
3073		lookup_values_if_vars(IRest,LocalStore,Store,VRest).
3074
3075		force_evaluation_of_lazy_value(Id,Value,RealVal) :- nonvar(Value), Value=(Trigger,RealVal),
3076		var(Trigger),
3077		get_preference(use_common_subexpression_elimination,true),
3078		is_lazy_let_identifier(Id),
3079		!,
3080		Trigger=pred_true. % force evaluation, as the exists will otherwise delay/flounder
3081		% Warning: this means that outer lazy_let_expressions inside an exists should be well-defined (WD)
3082
3083
3084		/* will not generate error messages; used for CSP||B when we don't know if something is a B variable or not */
3085		/* TO DO: add peel_prefix for global_sets and constants ?? */
3086		try_lookup_value_in_store_and_global_sets(Id,State,Val) :-
3087		(lookup_value(Id,State,RVal) -> RVal=Val
3088		; b_global_sets:lookup_global_constant(Id,VGC) -> Val = VGC
3089		; b_global_set_or_free_type(Id,_AnyType,Value) -> Val=Value /* global set evaluates to itself */
3090		).
3091
3092
3093		lookup_value_in_store_and_global_sets_wf(Id,Type,LocalState,State,Val,Span,WF) :-
3094		(lookup_value_with_span_wf(Id,LocalState,State,RVal,Span,WF)
3095		-> RVal=Val
3096		; lookup_value_in_global_sets_wf(Id,Type,Val,LocalState,State,Span,WF)
3097		).
3098
3099		lookup_value_in_global_sets_wf(Id,Type,Val,LocalState,State,Span,WF) :-
3100		(b_global_sets:lookup_global_constant(Id,VGC)
3101		-> Val=VGC
3102	?	; (b_global_set_or_free_type(Id,Type,Value)
3103		-> Val = Value /* global set evaluates to itself */
3104		; ((member(bind(Id,_),LocalState) ; member(bind(Id,_),State))
3105		-> Msg1 = 'Cannot determine value for identifier '
3106		; Msg1 = 'Cannot find identifier '
3107		),
3108		append(LocalState,State,LSS),
3109		translate:translate_bstate_limited(LSS,StateInfo),
3110		ajoin([Msg1,Id,':'],Msg),
3111		add_error_wf(identifier_not_found,Msg,StateInfo,Span,WF),
3112		fail % Val = term(Id) /* Val=fail */
3113		)
3114		).
3115
3116		:- use_module(probsrc(kernel_freetypes),[registered_freetype/2, registered_freetype_case_value/3]).
3117	?	b_global_set_or_free_type(Id,_,global_set(Id)) :- b_global_set(Id).
3118		b_global_set_or_free_type(Id,_,freetype(Id)) :- registered_freetype(Id,_).
3119		b_global_set_or_free_type(Id,Type,Value) :-
3120		registered_freetype_case_value(Id,Type,Value). % to instantiate the type parameters we also need the TypeId
3121		% TODO: we could also register Event-B destructors and look them up here
3122
3123		/* -----------------------------*/
3124		/* b_compute_expressions */
3125		/* -----------------------------*/
3126
3127		b_compute_expressions([], _, _, [],_WF).
3128		b_compute_expressions([EXPRsHd|EXPRsTl],LocalState,InState,[ValHd|ValTl],WF) :-
3129	?	b_compute_expression(EXPRsHd,LocalState,InState,ValHd,WF),
3130	?	b_compute_expressions(EXPRsTl,LocalState,InState,ValTl,WF).
3131
3132		% a variation of above that delays computing the expressions until Waitflag 1/2 is set
3133		b_compute_assign_expressions_when(EXPRsTl,LocalState,InState,ValTl,WF,OR) :-
3134		get_assign_expr_priority_wf(OR,WF,LWF),
3135	?	b_compute_expressions_when2(EXPRsTl,LocalState,InState,ValTl,WF,LWF).
3136		b_compute_expressions_when2([], _, _, [],_WF,_).
3137		b_compute_expressions_when2([EXPRsHd|EXPRsTl],LocalState,InState,[ValHd|ValTl],WF,LWF) :-
3138	?	b_compute_expression_when2(EXPRsHd,LocalState,InState,ValHd,WF,LWF),
3139		b_compute_expressions_when2(EXPRsTl,LocalState,InState,ValTl,WF,LWF).
3140
3141		% TO DO: add step number in OR
3142		get_assign_expr_priority_wf(output_required,_WF,LWF) :- !,
3143		% the Output of the statement is required; do not delay computing it
3144		LWF=0. % this would delay computation until WF0 is set: get_wait_flag0(WF,LWF); cf. initialisation for test 2104
3145		get_assign_expr_priority_wf(_,WF,LWF) :-
3146		% the Output is not directly required; compute it later (when we are sure that the statement actually succeeds)
3147		(preferences:preference(use_smt_mode,true)
3148		-> Prio = 2.0 % SMT Mode: we are probably doing CBC checking, we may have set up constraints on ValTl
3149		; Prio=4000), % unless the expression is inside an sequential composition: nothing can depend on ValTl; TO DO: check if we are inside a sequential composition; if not use inf priority; otherwise use 2.0 or 4
3150		get_wait_flag(Prio,get_assign_expr_priority_wf,WF,LWF).
3151
3152		:- block b_compute_expression_when2(?,?,?,?,?,-).
3153		b_compute_expression_when2(eval_must_not_fail(ErrMsg,EXPRsHd),LocalState,InState,Res,WF,_) :- !,
3154		% catch failure; in case the interpreter fails to catch wd-error itself (e.g., try_find_abort is false)
3155		if(b_compute_expression(EXPRsHd,LocalState,InState,ValHd,WF),equal_object_wf(ValHd,Res,WF),
3156		(translate:translate_bexpression_with_limit(EXPRsHd,TS),
3157		add_wd_error_span(ErrMsg,TS,span_predicate(EXPRsHd,LocalState,InState),WF))).
3158		b_compute_expression_when2(EXPRsHd,LocalState,InState,ValHd,WF,_) :-
3159		copy_wf_start(WF,b_compute_expression_when2,CWF), % not sure this is useful for expressions:
3160	?	b_compute_expression(EXPRsHd,LocalState,InState,ValHd,CWF),
3161	?	copy_wf_finish(WF,CWF).
3162
3163
3164		/* -----------------------------*/
3165		/* b_execute_statement */
3166		/* -----------------------------*/
3167		/* b_execute_statement(XMLStatements:input, StateofLocalVariables:input,
3168		StateOfGlobalVariables:input,
3169		ListOfUpdateBindingsForGlobalVariablesAndResultVariables:output) */
3170
3171		:- assert_pre(b_interpreter:b_execute_statement(Stmt,LS,IS,_OS,_WF,_Path,_OR),
3172		(bsyntaxtree:check_if_typed_substitution(Stmt),type_check(LS,store),type_check(IS,store) )).
3173		:- assert_post(b_interpreter:b_execute_statement(_Stmt,_LS,_IS,OS,_WF,_Path,_OR),
3174		(type_check(OS,store))).
3175
3176		b_execute_inner_statement(Body,LocalState,InState,OutState,WF,Path,output_required) :-
3177		get_texpr_expr(Body,BE),
3178		BE \= while(_COND,_STMT,_INV,_VARIANT), % also other non-det substitutions ??
3179		BE \= select(_),
3180		BE \= select(_,_),
3181		BE \= if(_), % case(_,_,_) statements are now translated to if-then-else in ast_cleanup
3182		!,
3183		get_wait_flag0(WF,WF0),
3184		block_execute_statement(WF0,Body,LocalState,InState,OutState,WF,Path).
3185		b_execute_inner_statement(Body,LocalState,InState,OutState,WF,Path,OR) :-
3186		get_wait_flag(2,inner_stmt,WF,LWF), % was 2.0
3187		clone_wait_flags_from1(WF,GroundUponFinish,InnerWF), % copy everything but WF0
3188		b_execute_inner_statement(Body,LocalState,InState,OutState,GroundUponFinish,InnerWF,Path,LWF,OR).
3189
3190		:- block block_execute_statement(-, ?,?,?, ?,?,?).
3191		block_execute_statement(_,Body,LocalState,InState,OutState,WF,Path) :-
3192	?	b_execute_statement(Body,LocalState,InState,OutState,WF,Path,output_required).
3193
3194		:- block b_execute_inner_statement(?,?,?,?,?,?,?,-,?).
3195		b_execute_inner_statement(Body,LocalState,InState,OutState,GUF,InnerWF,Path,_,OR) :-
3196	?	b_execute_statement(Body,LocalState,InState,OutState,InnerWF,Path,OR),
3197		(GUF=ground_upon_finish -> ground_wait_flags(InnerWF) ; ground_wait_flag0(InnerWF)).
3198
3199		:- use_module(source_profiler,[opt_add_source_location_hits/2]).
3200		:- use_module(b_operation_guards,[get_substitution_enabling_condition/4]).
3201
3202
3203		b_execute_statement_nowf(Subst,LS,S,OutS,Ctxt) :-
3204		init_wait_flags_with_call_stack(WF,[prob_command_context(Ctxt,unknown)]),
3205		b_interpreter:b_execute_statement(Subst,LS,S,OutS,WF,_Path),
3206		ground_wait_flags(WF).
3207
3208		b_execute_statement(Stmt, LS, S, OS, WF,Path) :-
3209	?	b_execute_statement(Stmt, LS, S, OS, WF,Path,output_not_required).
3210		b_execute_statement(b(Stmt,_,Infos), LS, S, OS, WF,Path,OR) :- !,
3211	?	b_execute_statement2(Stmt, Infos, LS, S, OS, WF,Path,OR).
3212		b_execute_statement(Stmt, LS, S, OS, WF,Path,OR) :-
3213		add_internal_error('Statement not properly wrapped: ',b_execute_statement(Stmt, LS, S, OS, WF,Path,OR)),
3214		b_execute_statement2(Stmt, [], LS, S, OS, WF,Path,OR).
3215
3216		% blocks should be removed by type-checker
3217		b_execute_statement2(block(Stmt),_,LS,IS,OS,WF,Path,OR) :- !,
3218		b_execute_statement(Stmt,LS,IS,OS,WF,Path,OR). %% NOT COVERED
3219		b_execute_statement2(assign(LHS,Exprs),Info,LocalState,InState,OutState,WF,assign(LHS,VALs),OR) :- !,
3220		/* Var1, ..., VarN := Expr1, ..., ExprN */
3221		/* also: Var1, fun1(arg), ... := Expr1, Expr2, ... */
3222		opt_add_source_location_hits(Info,1),
3223	?	b_compute_assign_expressions_when(Exprs,LocalState,InState,VALs,WF,OR),% VALs - a list of computed values
3224	?	b_assign_values_or_functions(LHS,VALs,LocalState,InState,OutState,WF,OR).
3225		b_execute_statement2(assign_single_id(IDE,Expr),Info,LocalState,InState,OutState,WF,assign_single_id(ID,Value),_OR) :-
3226		get_texpr_id(IDE,ID),!,
3227		opt_add_source_location_hits(Info,1),
3228	?	b_compute_expression(Expr,LocalState,InState,Value,WF), % b_compute_assign_expressions_when
3229		%b_compute_assign_expressions_when([Expr],LocalState,InState,[Value],WF),
3230		OutState=[bind(ID,Value)].
3231		b_execute_statement2(choice(ChoiceList),_,LocalState,InState,OutState,WF,Path,OR) :- !,
3232		/* CHOICE LHS OR RHS OR ... END */
3233		get_wait_flag(2,choice,WF,WFC), % % was 2.0, maybe use length of ChoiceList as Priority ??
3234		b_execute_choice(ChoiceList,LocalState,InState,OutState,WF,Path,WFC,OR).
3235		b_execute_statement2(becomes_element_of(LHS,RHS), /* LHS :: RHS */
3236		Info,LocalState,InState,OutState,WF,becomes_element_of(LHS,SingleValue),_OR) :- !,
3237		% LHS must be of the form Var1,..,Vark where all variables are disjoint
3238		opt_add_source_location_hits(Info,1),
3239		b_compute_expression(RHS,LocalState,InState,ValueSet,WF),
3240		check_element_of_wf(SingleValue,ValueSet,WF),
3241		ground_det_wait_flag(WF), %% TODO: remove this
3242		convert_pairs_into_list(LHS,SingleValue,ValList),
3243		set_up_typed_localstate(LHS,ValList,TypedVals,[],OutState,positive),
3244		b_tighter_enumerate_all_values(TypedVals,WF).
3245		b_execute_statement2(becomes_such(Vars,Condition),Info,LocalState,InState,OutState,WF,Path,_OR) :- !,
3246		/* Vars : (Condition) */
3247		opt_add_source_location_hits(Info,1),
3248	?	b_execute_becomes_such(Vars,Condition,LocalState,InState,OutState,_,Path,WF).
3249		b_execute_statement2(sequence(Seq), /* LHS ; RHS */
3250		_,LocalState,InState,OutUpdates,WF,Path,OR) :- !, %pe_print(sequence(Seq,InState)),
3251	?	b_execute_sequence(Seq,LocalState,InState,OutUpdates,WF,Path,OR).
3252		b_execute_statement2(precondition(PreCond,Body),_,LocalState,InState,OutState,WF,Path,OR) :- !,
3253		%print('*** Non-outermost PRE construct'),nl,
3254		Path=pre(PreRes,IPath),
3255		b_try_check_boolean_expression(PreCond,LocalState,InState,WF,PreRes),
3256		%used to be: ground_det_wait_flag(WF),
3257		check_precondition_result(PreRes,PreCond,LocalState,InState,WF),
3258	?	(PreRes == pred_true -> b_execute_statement(Body,LocalState,InState,OutState,WF,IPath,OR)
3259		; PreRes == pred_false -> IPath = not_executed
3260		; b_execute_inner_statement(Body,LocalState,InState,OutState,WF,IPath,OR) % with extra waitflag
3261		).
3262		b_execute_statement2(assertion(PreCond,Body),_,LocalState,InState,OutState,WF,Path,OR) :- !,
3263	?	b_execute_assertion(PreCond,Body,LocalState,InState,OutState,WF,Path,OR).
3264		b_execute_statement2(witness_then(PreCond,Body),_,LocalState,InState,OutState,WF,witness(Path),OR) :- !,
3265		b_test_boolean_expression(PreCond,LocalState,InState,WF),
3266		b_execute_inner_statement(Body,LocalState,InState,OutState,WF,Path,OR).
3267		b_execute_statement2(select(Whens),_, LocalState, InState, OutState,WF,select(Nr,Path),OR) :- !,
3268		get_texpr_expr(TExpr,select_when(PreCond, Body)), % info field not used for select_when
3269	?	optimized_nth1(Nr, Whens, TExpr), % THIS IS A CHOICE POINT if length(Whens)>1 ! <-------- TO DO guard
3270	?	b_test_boolean_expression(PreCond,LocalState,InState,WF),
3271		%used to call: ground_det_wait_flag(WF), now execute inner statement delays
3272		b_execute_inner_statement(Body,LocalState,InState,OutState,WF,Path,OR).
3273		b_execute_statement2(select(Whens,Else), Infos, LocalState, InState, OutState,WF,Path,OR) :- !,
3274		(
3275	?	b_execute_statement2(select(Whens), Infos, LocalState, InState, OutState,WF,Path,OR)
3276		; % THIS IS A CHOICE POINT ! <-------- TO DO guard
3277		findall(PC,
3278		(member(SW,Whens),get_texpr_expr(SW,select_when(PC,_))), AllPreconds),
3279		b_not_test_list_of_boolean_expression(AllPreconds,LocalState,InState,WF),
3280		Path = select(else,IPath),
3281		b_execute_inner_statement(Else,LocalState,InState,OutState,WF,IPath,OR)
3282		).
3283		b_execute_statement2(var(Parameters,Body), /* VAR _ IN _ substitution */
3284		_,LocalState,InState,NewOutState,WF,var(Names,Path),OR) :- !,
3285		/* introduces a new variable that can be assigned to */
3286		split_names_and_types(Parameters,Names,_),
3287		delete_variables_from_state(Names,InState,InState1), % in case any local parameter name is also a constant/variable: remove it % but if we do an operation_call: we leave context and it becomes visible again !!
3288		% otherwise we may think there are two updates, e.g., in WHILE loop; see Rule_DB_SIGAREA_0030 from test 1303
3289		set_up_undefined_localstate(Parameters,InState1,NewInState),
3290		delete_variables_from_state(Names,LocalState,NewLocalState),
3291		%check_valid_store(InState,var_in_state), check_valid_store(LocalState,var_local_state),
3292	?	b_execute_statement(Body,NewLocalState,NewInState,OutState,WF,Path,OR),
3293		% check_valid_store(OutState,var_out_state),
3294		filter_results(Parameters,OutState,NewOutState,WF)
3295		.
3296		/* it can be ok not to assign to a local variable */
3297
3298		%TODO(DP, 5.8.2008):
3299		b_execute_statement2(let(Parameters,Defs,Body), /* LET _ BE _ IN _ */
3300		_,LocalState,InState,OutState,WF,let(Path),OR) :- !,
3301	?	set_up_typed_localstate(Parameters,LocalState,NewLocalState),
3302		b_execute_let_definitions(Defs,NewLocalState,InState,WF),
3303	?	b_execute_statement(Body,NewLocalState,InState,OutState,WF,Path,OR).
3304		b_execute_statement2(lazy_let_subst(Id,IdExpr,Body),_,LocalState,InState,OutState,WF,lazy_let(Path),OR) :-
3305		!,
3306		add_lazy_let_id_and_expression(Id,IdExpr,LocalState,InState,NewLocalState,WF),
3307		b_execute_statement(Body,NewLocalState,InState,OutState,WF,Path,OR).
3308		b_execute_statement2(any(Parameters,PreCond,Body), /* ANY _ WHERE */
3309		Info,LocalState,InState,OutState,WF0,any(Bindings,Path),OR) :- !, %statistics(runtime,_),
3310		%print('ANY: '), print_bexpr(PreCond),nl, %%
3311	?	set_up_typed_localstate(Parameters,FreshVars,TypedVals,LocalState,NewLocalState,positive),
3312		create_any_bindings(Parameters,FreshVars,Bindings),
3313		push_wait_flag_call_stack_info(WF0,quantifier_call('ANY',Parameters,FreshVars,Info),WF),
3314	?	b_test_inner_boolean_expression(PreCond,NewLocalState,InState,WF), /* check WHERE */
3315		%%observe_state(TypedVals,WF,0), b_tracetest_boolean_expression(PreCond,NewLocalState,InState,WF,one), %% comment in for debugging
3316		b_tighter_enumerate_all_values(TypedVals,WF), % moved enumeration after test; in case WF already instantiated
3317		%TODO: check if we can use b_tighter_enumerate_values_in_ctxt
3318	?	b_execute_statement(Body,NewLocalState,InState,OutState,WF,Path,OR). /* should we use b_execute_inner_statement/LWF here ?? */
3319		b_execute_statement2(skip, /* SKIP */
3320		Info,_LocalState,_InState,OutState,_WF,skip,_OR) :- !,
3321		opt_add_source_location_hits(Info,1),
3322		OutState = [].
3323		b_execute_statement2(parallel(Statements), /* LHS || RHS */ %@@@
3324		_,LocalState,InState,OutState,WF,parallel(Paths),OR) :- !,
3325	?	b_execute_statements_in_parallel(Statements,LocalState,InState,OutState,WF,Paths,OR).
3326		b_execute_statement2(init_statement(Stmt),_,LocalState,InState,OutState,WF,Path,OR) :- !,
3327		/* Like block: but
3328		writes error messages if statement fails */ %@@@
3329		(preferences:get_preference(provide_trace_information,true)
3330		-> nl,print(' =INIT=> '),translate:print_subst(Stmt),nl, flush_output(user_output),
3331		statistics(walltime,[Tot1,_])
3332		; true),
3333	?	if(b_execute_initialisation_statement(Stmt,LocalState,InState,OutState,WF,Path,OR),
3334		(
3335		(preferences:get_preference(provide_trace_information,true)
3336		-> statistics(walltime,[Tot2,_]), Tot is Tot2-Tot1,
3337		format(' [=OK= ~w ms]~n',[Tot]), flush_output(user_output)
3338		; true)
3339		),
3340		( translate:translate_substitution(Stmt,TStmtStr),
3341		(bmachine:b_machine_temp_predicate(_TempPred)
3342		-> Msg = 'INITIALISATION statement cannot be executed with extra predicate: ',
3343		add_error_wf(initialisation_fails,Msg,TStmtStr,Stmt,WF)
3344		% do not add as state error; user requested transition
3345		; Msg = 'INITIALISATION statement fails: ',
3346		(get_substitution_enabling_condition(Stmt,SpanPred,_BSVars,_IsPreciseV)
3347		-> %insert_custom_predicate_into_guard(EnablingCondition,TempPred,SpanPred),
3348		ErrPos = span_predicate(SpanPred,LocalState,InState) % for visualising by user
3349		% Note: user can also visualise by chooise execute by predicate (in TK)
3350		; ErrPos = Stmt
3351		),
3352		% add as state error so that we can visualise span predicate
3353		add_state_error_wf(initialisation_fails,Msg,TStmtStr,ErrPos,WF) % cf test 1736 and 278
3354		%add_error_wf(initialisation_fails,Msg,TStmtStr,ErrPos,WF)
3355		),
3356		fail
3357		)
3358		).
3359		b_execute_statement2(if(IfList),_,LocalState,InState,OutState,WF,Path,OR) :- !,
3360		LWF='$GENERATE_ON_DEMAND',
3361	?	b_execute_else_list(IfList,LocalState,InState,OutState,WF,1,Path,LWF,OR).
3362		b_execute_statement2(operation_call(Operation,Results,Parameters),Info,LocalState,InState,OutState,WF,
3363		operation_call(OperationName,Results,ParamValues,ResultValues,InnerPath),OR) :- !,
3364		def_get_texpr_id(Operation,op(OperationName)),
3365	?	b_execute_operation_with_parameters(OperationName,LocalState,InState,Results,
3366		Parameters,OpOutState,ParamValues,ResultValues,InnerPath,Info,WF,OR),
3367		split_names_and_types(Results,ResultingIDs,_),
3368		store_values(ResultingIDs, ResultValues, ResultsOutState),
3369		combine_updates(ResultsOutState,OpOutState,OutState).
3370
3371		b_execute_statement2(while(COND,STMT,INV,VARIANT),
3372		Info,LocalState,InState,OutState,WF0,while(VarVal),_OR) :- !,
3373		%hit_profiler:add_profile_hit(while(COND,WF),2),
3374		% we may go around the loop many times: avoid carrying around unused variables
3375		get_while_reads_write_info_and_filter_state(Info,LocalState,InState,LS,IS,ModVars),
3376		push_wait_flag_call_stack_info(WF0,b_operator_call('WHILE',[],Info),WF), % TODO: provide subst. call stack entry
3377		%print_message(execute_while(LocalState,InState)),
3378		b_compiler:b_optimize(INV,ModVars,LS,IS,CINV,WF),
3379		b_compiler:b_optimize(COND,ModVars,LS,IS,CCOND,WF),
3380		b_compiler:b_optimize(VARIANT,ModVars,LS,IS,CVARIANT,WF),
3381		%,b_compiler:b_compile(STMT,ModVars,LS,IS,CSTMT,WF)
3382		% TO DO: maybe exclude in one go; use ordered approach ?
3383		%exclude(unused_variable(ModVars),LS,LS2), % only keep modified vars; all other compiled
3384		%exclude(unused_variable(ModVars),IS,IS2), % only keep modified vars; all other compiled
3385		b_compute_expression(CVARIANT,LS,IS,VarVal,WF),
3386		b_execute_while(CCOND,STMT,CINV,CVARIANT,ModVars,VarVal,LS,IS,OutState,WF).
3387		b_execute_statement2(external_subst_call(FunName,Args),Info,LocalState,State,OutState,WF,external_subst(FunName),_OR) :-
3388		!, b_compute_expressions(Args, LocalState,State, EvaluatedArgs, WF),
3389		push_wait_flag_call_stack_info(WF,external_call(FunName,EvaluatedArgs,Info),WF2),
3390		call_external_substitution(FunName,EvaluatedArgs,State,OutState,Info,WF2).
3391		b_execute_statement2(E,I,LS,S,O,WF,Path,OR) :-
3392		add_internal_error('Uncovered statement: ',b_execute_statement2(E,I,LS,S,O,WF,Path,OR)),
3393		print_functor(E),nl,fail.
3394
3395		% -------------------
3396
3397		b_execute_becomes_such(Vars,Condition,LocalState,InState,OutState,Values,becomes_such(Ids,Values),WF) :- !,
3398		% create the LHS variables in the local state
3399	?	set_up_typed_localstate(Vars,Values,TypedVals,LocalState,TempLocalState1,positive),
3400		get_texpr_ids(Vars,Ids),
3401		% store those values also the outgoing state
3402		store_values(Ids,Values,OutState),
3403		% there might be some variables of the form x$0 to access the
3404		% values before the substitution. We put them into the local state
3405		insert_before_substitution_variables(Vars,LocalState,InState,TempLocalState1,TempLocalState),
3406	?	b_test_inner_boolean_expression(Condition,TempLocalState,InState,WF),
3407		b_tighter_enumerate_values_in_ctxt(TypedVals,Condition,WF). % moved enumeration after test, to avoid overhead in case Condition is deterministic (see e.g. WhileAssignTupleChoose_v2)
3408
3409
3410		b_execute_sequence([],_LocalState,_InState,[],_WF,[],_OR).
3411		b_execute_sequence([First|Rest],LocalState,InState,OutUpdates,WF,Path,OR) :-
3412		(Rest == []
3413	?	-> b_execute_statement(First,LocalState,InState,OutUpdates,WF,Path,OR)
3414		; Path = sequence(Path1,RestPath),
3415	?	b_execute_statement(First,LocalState,InState,LHSUpdates,WF,Path1,output_required),
3416	?	ground_det_wait_flag(WF), % maybe better to delay next execute_statement ? TODO
3417		store_intermediate_updates_wf(InState,LHSUpdates,IntermediateState,First,WF),
3418		% TO DO: statically determine what the Rest can modify and copy over LHSUpdates not modified by Rest into OutUpdates
3419	?	b_execute_statement_list_when_state_set(Rest,LocalState,IntermediateState,
3420		LHSUpdates,OutUpdates,WF,RestPath,OR)
3421		).
3422
3423
3424		:- block check_precondition_result(-,?,?,?,?).
3425		check_precondition_result(pred_true,_,_,_,_).
3426		check_precondition_result(pred_false,PreCond,LS,S,WF) :-
3427		translate_bexpression(PreCond,PreString),
3428		add_abort_error_span(precondition_error,'Precondition violated: ',PreString,span_predicate(PreCond,LS,S),WF).
3429
3430		create_any_bindings([],[],[]).
3431		create_any_bindings([Param|Prest],[Value|Vrest],[bind(Id,Value)|Brest]) :-
3432		get_texpr_id(Param,Id),
3433		create_any_bindings(Prest,Vrest,Brest).
3434
3435		% insert the values of variables before the substitution under an
3436		% alternative name. The alternative name is given as an optional extra
3437		% information in the variable (see type-checking of becomes_such for
3438		% details). Usually (i.e. always) the alternative name is x$0 for the variable x.
3439		insert_before_substitution_variables([],_LocalState,_InState,State,State).
3440		insert_before_substitution_variables([Var|VRest],LocalState,InState,StateA,ResultStateB) :-
3441		get_texpr_info(Var,Infos),
3442	?	( member(before_substitution(_,Alternative),Infos) ->
3443		def_get_texpr_id(Var,Id),
3444		lookup_value_for_existing_id(Id,LocalState,InState,Value),
3445		store_value(Alternative,Value,StateA,StateC)
3446		;
3447		StateA = StateC),
3448		insert_before_substitution_variables(VRest,LocalState,InState,StateC,ResultStateB).
3449
3450
3451
3452		% treat the bool(.) operator
3453		b_convert_bool(Pred,LocalState,State,WF,PredRes) :-
3454		get_wait_flag0(WF,WF0), % first give a chance for PredRes to be instantiated
3455	?	b_convert_bool_wf0(Pred,LocalState,State,WF,PredRes,WF0).
3456
3457		:- block b_convert_bool_wf0(?,?,?,?,-,-).
3458		b_convert_bool_wf0(Pred,LocalState,State,WF,PredRes,_) :- PredRes==pred_true,!,
3459		%% print('bool(.)=TRUE '), translate:print_bexpr(Pred),nl, %%
3460		b_test_inner_boolean_expression(Pred,LocalState,State,WF).
3461		b_convert_bool_wf0(Pred,LocalState,State,WF,PredRes,_) :- PredRes==pred_false,!,
3462		%% print('bool(.)=FALSE '), translate:print_bexpr(Pred),nl, %%
3463		b_not_test_inner_boolean_expression(Pred,LocalState,State,WF).
3464		b_convert_bool_wf0(Pred,LocalState,State,WF,PredRes,_) :-
3465		%% print('bool(.) check : '), translate:print_bexpr(Pred),nl, % obsv(LocalState),
3466	?	b_try_check_boolean_expression_wf(Pred,LocalState,State,WF,PredRes ).
3467		%% print('finished bool(.) check : '), translate:print_bexpr(Pred),nl,translate:print_bstate(LocalState),nl.
3468
3469		% Additional time limit +TO in ms, e.g., used for CDCL(T). +TORes is time_out if a timeout occurred.
3470		b_convert_bool_timeout(Pred,LocalState,State,WF,PredRes,TO,TORes) :-
3471		get_wait_flag0(WF,WF0),
3472		b_convert_bool_wf0_timeout(Pred,LocalState,State,WF,PredRes,WF0,TO,TORes).
3473
3474		:- block b_convert_bool_wf0_timeout(?,?,?,?,-,-,?,?).
3475		b_convert_bool_wf0_timeout(Pred,LocalState,State,WF,PredRes,_,TO,TORes) :-
3476		PredRes == pred_true,
3477		!,
3478		safe_time_out(b_test_inner_boolean_expression(Pred,LocalState,State,WF),
3479		TO,
3480		TORes).
3481		b_convert_bool_wf0_timeout(Pred,LocalState,State,WF,PredRes,_,TO,TORes) :-
3482		PredRes == pred_false,
3483		!,
3484		safe_time_out(b_not_test_inner_boolean_expression(Pred,LocalState,State,WF),
3485		TO,
3486		TORes).
3487		b_convert_bool_wf0_timeout(Pred,LocalState,State,WF,PredRes,_,TO,TORes) :-
3488		safe_time_out(b_try_check_boolean_expression_wf(Pred,LocalState,State,WF,PredRes ),
3489		TO,
3490		TORes).
3491
3492		%%obsv([]).
3493		%%obsv([bind(Var,Val) | T] ) :- when(ground(Val), format("~w = ~w~n",[Var,Val])), obsv(T).
3494
3495		% check boolean expression without enumeration predicate result (unless WFE is set)
3496		b_try_check_boolean_expression_no_enum_wf(Pred,LocalState,State,WF,PredRes) :-
3497	?	b_try_check_boolean_expression_lwf(Pred,LocalState,State,WF,'$NO_ENUMERATION',PredRes,_).
3498
3499		b_try_check_boolean_expression_wf(Pred,LocalState,State,WF,PredRes) :-
3500	?	b_try_check_boolean_expression_lwf(Pred,LocalState,State,WF,'$ENUMERATION',PredRes,'$GENERATE_ON_DEMAND' ).
3501		% try to do check_boolean expression; if not possible create choice point if LWF is grounded
3502		b_try_check_boolean_expression_lwf(Pred,LocalState,InState,WF,DoEnumeration,PredRes,LWF) :-
3503	?	b_compiler:b_optimize(Pred,[],LocalState,InState,CPRED,WF), % this increases chance that check can be applied+avoids multiple computations in two branches
3504		% still: some computations may not be pre-computed, e.g., union of closures, ..., see Rule_DB_PSR_0003_C
3505	?	b_try_check_boolean_expression_lwf_c(CPRED,LocalState,InState,WF,DoEnumeration,PredRes,LWF).
3506
3507		b_try_check_boolean_expression_lwf_c(b(truth,_,_),_LocalState,_InState,_WF,_,PredRes,_LWF) :- !,
3508		% typical case in e.g. IF-THEN-ELSE
3509		PredRes= pred_true.
3510		b_try_check_boolean_expression_lwf_c(Pred,LocalState,InState,WF,DoEnumeration,PredRes,LWF) :-
3511		copy_wf_start(WF,try_check,CWF),
3512	?	if(b_check_boolean_expression_with_enum(Pred,LocalState,InState,CWF,DoEnumeration,Res),
3513		% Note: we do not use a cut here ! usually b_check will not enumerate; but on rare occasions it can (apply function in inverse,...)
3514		(PredRes=Res,
3515	?	copy_wf_finish(WF,CWF)
3516		),
3517		b_try_check_failed(Pred,LocalState,InState,WF,DoEnumeration,PredRes,LWF)
3518		).
3519		b_try_check_failed(Pred,LocalState,InState,WF,DoEnumeration,PredRes,LWF) :-
3520		% print(choice_point(LWF)),nl, translate:print_bexpr(Pred),nl,
3521		perfmessagecall(choice_point,reification_of_check_predicate_failed,translate:print_bexpr(Pred),Pred),
3522		(LWF=='$GENERATE_ON_DEMAND' -> get_binary_choice_wait_flag('$GENERATE_ON_DEMAND',WF,WF1)
3523		; var(LWF),DoEnumeration=='$NO_ENUMERATION' -> get_enumeration_finished_wait_flag(WF,WF1) % nothing will enum LWF
3524		; WF1=LWF),
3525		b_try_check_boolean_expression_lwf_block(Pred,LocalState,InState,WF,PredRes,WF1).
3526
3527		% a version of b_check_boolean_expression which will enumerate its result as last resort
3528		% should we only do this in SMT mode : preferences:preference(use_smt_mode,true) ?
3529		b_check_boolean_expression_with_enum(Pred,LocalState,State,WF,DoEnumeration,Res) :-
3530	?	b_check_boolean_expression(Pred,LocalState,State,WF,Res),
3531		(nonvar(Res) -> true
3532		; DoEnumeration=='$NO_ENUMERATION' -> get_enumeration_finished_wait_flag(WF,EWF), enum_pred_result(Res,EWF,WF)
3533		; get_wait_flag0(WF,LWF0),
3534		enum_pred_result0(Res,LWF0,WF)).
3535
3536		% first set up with wait_flag0: easy to get, avoid putting unnecessary waitflags into store
3537		% relevant for DataValidationTest.mch with n>20000
3538		:- block enum_pred_result0(-,-,?).
3539		enum_pred_result0(Res,_,WF) :- var(Res),!,
3540		get_last_wait_flag(b_check_boolean_expression_with_enum,WF,LWF),
3541		enum_pred_result(Res,LWF,WF). % before doing infinite enumerations: better do case-distinction here
3542		enum_pred_result0(_,_,_).
3543
3544		:- block enum_pred_result(-,-,?).
3545		enum_pred_result(pred_true,_,_).
3546		enum_pred_result(pred_false,_,_).
3547
3548		:- block b_try_check_boolean_expression_lwf_block(?,?,?, ?,-,-).
3549		b_try_check_boolean_expression_lwf_block(Pred,LocalState,InState,WF,PREDRES,_) :-
3550		PREDRES \== pred_false,
3551		% print(' TRUE +++++> '), translate:print_bexpr(Pred),nl,
3552	?	b_test_inner_boolean_expression(Pred,LocalState,InState,WF),
3553		PREDRES = pred_true. % set it only after we have actually checked the predicate; e.g., for IF we may execute rest of while loop etc... before actually having set up the constraint Pred; See Hansen23_WhilePerformance
3554		b_try_check_boolean_expression_lwf_block(Pred,LocalState,InState,WF,PREDRES,_) :-
3555		PREDRES \== pred_true,
3556		% print(' FALSE +++++> '), translate:print_bexpr(Pred),nl,
3557	?	b_not_test_inner_boolean_expression(Pred,LocalState,InState,WF),
3558		PREDRES = pred_false.
3559
3560		% try to do check_boolean expression; if not possible create choice point *directly*
3561		b_try_check_boolean_expression(Pred,LocalState,InState,WF,PredRes) :-
3562		b_compiler:b_optimize(Pred,[],LocalState,InState,CPRED,WF), % this increases chance that check can be applied+avoids multiple computations in two branches
3563		b_try_check_boolean_expression_c(CPRED,LocalState,InState,WF,PredRes).
3564		b_try_check_boolean_expression_c(Pred,LocalState,InState,WF,PredRes) :-
3565		copy_wf_start(WF,try_check_c,CWF),
3566		if(b_check_boolean_expression(Pred,LocalState,InState,CWF,Res),
3567		(PredRes=Res,copy_wf_finish(WF,CWF)),
3568	?	b_try_check_boolean_expression_c2(Pred,LocalState,InState,WF,PredRes)
3569		).
3570		b_try_check_boolean_expression_c2(Pred,LocalState,InState,WF,pred_true) :-
3571		%hit_profiler:add_profile_hit(b_try_check_failed(Pred),3),
3572		b_test_inner_boolean_expression(Pred,LocalState,InState,WF).
3573		b_try_check_boolean_expression_c2(Pred,LocalState,InState,WF,pred_false) :-
3574		b_not_test_inner_boolean_expression(Pred,LocalState,InState,WF).
3575
3576
3577		% WHILE SUBSTITUTION TREATMENT:
3578
3579		:- if(environ(prob_noopt_mode,true)).
3580		get_while_reads_write_info_and_filter_state(Info,LocalState,InState,LS,IS,ModVars) :-
3581		member(modifies(ModVars),Info),!,
3582		LS=LocalState, IS=InState. % do not filter state
3583		:- endif.
3584		get_while_reads_write_info_and_filter_state(Info,LocalState,InState,LS,IS,ModVars) :-
3585	?	member(reads(ReadVars),Info),
3586	?	member(modifies(ModVars),Info),!,
3587		% we may go around the loop many times: avoid carrying around unused variables
3588		ord_union(ReadVars,ModVars,ReadOrModVars),
3589		filter_states(ReadOrModVars,LocalState,InState,LS,IS).
3590		get_while_reads_write_info_and_filter_state(Info,LocalState,InState,LS,IS,ModVars) :-
3591		add_internal_error('No reads & modifies info for while loop: ',get_while_reads_write_info_and_filter_state(Info,LocalState,InState,LS,IS,ModVars)),
3592		ModVars=_, % all variables assumed to be modified
3593		LS=LocalState, IS=InState.
3594
3595		unused_variable(List,bind(Var,_)) :-
3596		% b_is_variable(Var), % TO DO: also include constants in reads Info ?
3597		ord_nonmember(Var,List).
3598		unused_localvariable(List,bind(Var,Val)) :- ord_nonmember(Var,List),
3599		(nonvar(Val),Val=(_,_) -> atom_codes(Var,Codes), Codes \= [64|_] % not a lazy_let ID starting with @
3600		% TO DO: either ensure lazy-let ids are also included in reads/writes ! or mark Val not as pair but using a special functor in add_lazy_let_id_to_local_state ?
3601		; true).
3602
3603		filter_states(ReadOrModVars,LocalState,InState,LS,IS) :-
3604		exclude(unused_localvariable(ReadOrModVars),LocalState,LS),
3605		exclude(unused_variable(ReadOrModVars),InState,IS).
3606		% TO DO: investigate whether we should use ord_intersect; ReadVars is already sorted
3607
3608		:- block lazy_exclude(-,?,?).
3609		lazy_exclude([],_,[]).
3610		lazy_exclude([bind(Var,Val)|T],ModVars,Res) :- lazy_exclude_aux(Var,Val,T,ModVars,Res).
3611		:- block lazy_exclude_aux(-,?,?,?,?).
3612		lazy_exclude_aux(Var,Val,T,ModVars,Res) :-
3613	?	(member(Var,ModVars) -> Res = [bind(Var,Val)|RT]
3614		; Res = RT),
3615		lazy_exclude(T,ModVars,RT).
3616
3617
3618		:- use_module(kernel_tools,[ground_state_check/2]).
3619		% outermost while code:; at next iteration b_execute_while1 will be called.
3620		:- block b_execute_while(?,?,?,?,?,-, ?,?,?, ?). % we block on Variant Value int(VarVal)
3621		b_execute_while(COND,STMT,INV,VARIANT,ModVars,int(VarVal),LocalState,InState,OutState,WF) :-
3622		%kernel_waitflags:get_idle_wait_flag(b_execute_while,WF,LWF),
3623		(number(VarVal),VarVal =< 50
3624		-> LWF=VarVal % we will wait anyway on GrInState below; no danger for WD issues in in b_optimize
3625		; no_pending_waitflags(WF) -> get_wait_flag0(WF,LWF) %important for e.g. PerformanceTests/While/LiftExec_LIM.mch
3626		; kernel_waitflags:get_last_wait_flag(b_execute_while1,WF,LWF) % to do: maybe get largest waitflag to avoid as much as possible that new choice points get enumerated before while triggers?
3627		% see also tests 979, 981
3628		),
3629		% before entering while loop, we wait for co-routines to complete that may have activated b_execute_while
3630		b_execute_while_idle(COND,STMT,INV,VARIANT,ModVars,int(VarVal),LocalState,InState,OutState,WF,LWF).
3631
3632		:- block b_execute_while_idle(?,?,?,?,?,?, ?,?,?, ?,-). % we block on enumeration starting wait_flag
3633		b_execute_while_idle(COND,STMT,INV,VARIANT,ModVars,int(VarVal),LocalState,InState,OutState,WF,_) :-
3634		%ground_constraintprop_wait_flags(WF),
3635		(number(VarVal), VarVal>50, preference(compile_while_body,true)
3636		% if VarVal > 50 -> worthwhile to compile STMT
3637		% TO DO: also take size of body into account, and what if only a small part of the body is reachable in each iteration
3638	?	-> b_compiler:b_optimize(STMT,ModVars,LocalState,InState,CSTMT,WF),
3639		% print(compiled_while(ModVars)),nl, translate:print_subst(CSTMT),nl,
3640		OutState=WhileOutState,
3641		exclude(unused_variable(ModVars),LocalState,LS), % only keep modified vars; all other compiled
3642		exclude(unused_variable(ModVars),InState,IS) % only keep modified vars; all other compiled
3643		; CSTMT=STMT, LS=LocalState, IS=InState,
3644		lazy_exclude(WhileOutState,ModVars,OutState) % only copy over those variables (potentially) modified by While loop
3645		% Note: it is important that we only have one copy of each modified variable in OutState
3646		),
3647		ground_state_check(InState,GrInState),
3648	?	b_execute_while_loop_block(GrInState,COND,CSTMT,INV,VARIANT,none,VarVal,LS,IS,WhileOutState,WF).
3649
3650		:- block b_execute_while_loop_block(-,?,?,?,?,?,?,?,?,?,?).
3651		b_execute_while_loop_block(_,COND,CSTMT,INV,VARIANT,none,VarVal,LS,IS,WhileOutState,WF) :-
3652	?	b_execute_while_loop(COND,CSTMT,INV,VARIANT,none,VarVal,LS,IS,WhileOutState,WF).
3653
3654		:- block b_execute_while1(?,?,?,?,?,-,?,?,?,?).
3655		b_execute_while1(COND,STMT,INV,VARIANT,PrevVariantValue,int(VarVal),LocalState,InState,OutState,WF) :-
3656		% get_last_wait_flag(while(VarVal),WF,LWF),
3657		deref_wf(WF,FreshWF),
3658		%ground_constraintprop_wait_flags(FreshWF), % this is not a good idea, co-routine may be triggered while grounding WF; this subsidiary call will prevent grounding from completing and may trigger later waitflags before earlier ones are finished
3659		% this can lead to enumeration warnings; the same applies to other calls to ground_constraintprop_wait_flags below
3660		b_execute_while_loop(COND,STMT,INV,VARIANT,PrevVariantValue,VarVal,LocalState,InState,OutState,FreshWF).
3661
3662		% block on PrevVarVal and VarVal not yet needed here; but we need it for b_execute_while_body below
3663		:- block b_execute_while_loop(?,?,?,?,-,?,?,?,?,?), b_execute_while_loop(?,?,?,?,?,-,?,?,?,?).
3664		b_execute_while_loop(COND,STMT,INV,VARIANT,PrevVarVal,VarVal,LocalState,InState,OutState,WF) :-
3665	?	b_try_check_boolean_expression_c(INV,LocalState,InState,WF,INVRes),
3666		%ground_constraintprop_wait_flags(WF), % seems to slow down interpretation
3667	?	b_check_execute_while_loop1(INVRes,COND,STMT,INV,VARIANT,PrevVarVal,VarVal,LocalState,InState,OutState,WF).
3668
3669		:- block b_check_execute_while_loop1(-,?,?,?,?,?,?,?,?,?,?).
3670		b_check_execute_while_loop1(pred_false,_COND,_STMT,INV,_VAR,_PrevVarVal,VarVal,LocalState,InState,_OutState,WF) :-
3671		add_abort_error_span(while_invariant_violation,
3672		'While INVARIANT VIOLATED, current VARIANT value: ',VarVal,span_predicate(INV,LocalState,InState),WF).
3673		b_check_execute_while_loop1(pred_true,COND,STMT,INV,VARIANT,PrevVarVal,VarVal,LocalState,InState,OutState,WF) :-
3674		b_try_check_boolean_expression_c(COND,LocalState,InState,WF,CondRes),
3675		%ground_constraintprop_wait_flags(WF), % seems to slow down interpretation
3676	?	b_check_execute_while_loop2(CondRes,COND,STMT,INV,VARIANT,PrevVarVal,VarVal,LocalState,InState,OutState,WF).
3677
3678		:- block b_check_execute_while_loop2(-,?,?,?,?,?,?,?,?,?,?).
3679		b_check_execute_while_loop2(pred_false,_COND,_STMT,_INV,_VARIANT,_PrevVarVal,_VarVal,_LS,InState,OutState,_WF) :-
3680		OutState=InState. % we copy over the while InState: the updates will be computed at the end of the while loop
3681		b_check_execute_while_loop2(pred_true,COND,STMT,INV,VARIANT,PrevVarVal,VarVal,LocalState,InState,OutState,WF) :-
3682
3683		%hit_profiler:add_profile_hit(b_execute_while_body(STMT,VarVal,PrevVarVal,LocalState),2),
3684		% TO DO: maybe only compute VARIANT now and not above ??
3685		% b_compute_expression(VARIANT,LocalState,InState,VarVal,WF),
3686		% ground_constraintprop_wait_flags(WF), %% moved here because VARIANT computed later
3687	?	b_execute_while_body(COND,STMT,INV,VARIANT,PrevVarVal,VarVal,LocalState,InState,OutState,WF).
3688
3689		%:- block b_execute_while_body(?,?,?,?,-,?,?,?,?,?), b_execute_while_body(?,?,?,?,?,-,?,?,?,?).
3690		% we must ensure VarVal and PrevVaraintValue known
3691		% the block declaration above for b_execute_while_loop already ensures this
3692		b_execute_while_body(_COND,_STMT,_INVARIANT,VAR,_PV,VarVal,LocalState,InState,_OutState,WF) :-
3693		VarVal<0, !, % more efficient than is_not_natural(int(VarVal)),
3694		%ground_constraintprop_wait_flags(WF),
3695		% add_abort_error_span will fail; hence no need to set _OutState
3696		add_abort_error_span(while_variant_error,'While VARIANT not NATURAL:',VarVal,span_predicate(VAR,LocalState,InState),WF).
3697		b_execute_while_body(_COND,_STMT,_INVARIANT,VAR,PrevVariantValue,VarVal,LocalState,InState,_OutState,WF) :-
3698		% check no longer required VarVal>=0,%is_natural(int(VarVal),WF),
3699		PrevVariantValue \= none,
3700		PrevVariantValue =< VarVal, !, %less_than_equal(int(PrevVariantValue),int(VarVal)),
3701		%ground_constraintprop_wait_flags(WF),
3702		% add_abort_error_span will fail; hence no need to set _OutState
3703		ajoin(['VARIANT = ',VarVal,', previous value = ',PrevVariantValue],Details),
3704		add_abort_error_span(while_variant_error,'While VARIANT not decreasing:',
3705		Details,span_predicate(VAR,LocalState,InState),WF).
3706		b_execute_while_body(COND,STMT,INV,VARIANT,_PrevVariantValue,VarVal,LocalState,InState,OutState,WF) :-
3707		% check no longer required due to cuts above %VarVal>=0, %is_natural(int(VarVal),WF),
3708		%(PrevVariantValue==none -> true ; less_than(int(VarVal),int(PrevVariantValue))),
3709		%ground_constraintprop_wait_flags(WF), % seems to slow down interpretation
3710		copy_wf_start(WF,while_body,CWF),
3711	?	b_execute_statement(STMT,LocalState,InState,LHSUpdates,CWF,_Path1,output_required),
3712		copy_wf_finish(WF,CWF),
3713		ground_det_wait_flag(WF), % TODO: remove this
3714		store_intermediate_updates_wf(InState,LHSUpdates,IntermediateState,STMT,WF),
3715		check_state_skeleton_bound(LHSUpdates,Bound), % otherwise variable lookups will cause problems; ensures IntermediateState skeleton bound
3716		b_execute_while_when_state_set(COND,STMT,INV,VARIANT,VarVal,LocalState,IntermediateState,OutState,WF,Bound).
3717
3718		:- block b_execute_while_when_state_set(?,?,?,?,?,?,?,?,?,-).
3719		b_execute_while_when_state_set(COND,STMT,INV,VARIANT,PrevVariantValue,LocalState,State,Res,WF,_) :-
3720		copy_wf_start(WF,while2,CWF),
3721		b_compute_expression(VARIANT,LocalState,State,VarVal,CWF),
3722		copy_wf_finish(WF,CWF),
3723		b_execute_while1(COND,STMT,INV,VARIANT,PrevVariantValue,VarVal,LocalState,State,Res,WF).
3724
3725		% ------------- IF-THEN-ELSE
3726
3727		:- block b_execute_else_list2(-,?,?,?, ?,?,?,?,?,-,?). % should we also unblock if LWF set ? needed for seq. composition to set up state ??
3728		b_execute_else_list2(PredRes,Body,Rest,LocalState,InState,OutState,InnerWF,CaseNr,Path,LWF,OR) :-
3729		%(var(PredRes) -> print('IF-THEN-ELSE ENUMERATION: '), translate:print_subst(Body),nl ; true),
3730	?	b_execute_else_list3(PredRes,Body,Rest,LocalState,InState,OutState,InnerWF,CaseNr,Path,LWF,OR).
3731
3732		b_execute_else_list3(pred_true,Body,_,LocalState,InState,OutState,WF,CaseNr,if(CaseNr,Path),_,OR) :-
3733	?	push_wait_flag_call_stack_info(WF,b_expr_call(if_then_body,Body),WF2),
3734	?	b_execute_statement(Body,LocalState,InState,OutState,WF2,Path,OR).
3735		b_execute_else_list3(pred_false,_Body,Rest,LocalState,InState,OutState,WF,CaseNr,Path,LWF,OR) :-
3736		CaseNr1 is CaseNr+1,
3737	?	b_execute_else_list(Rest,LocalState,InState,OutState,WF,CaseNr1,Path,LWF,OR).
3738
3739		b_execute_else_list([],_,_State,[],_WF,_,if_skip,_LWF,_OR). /* skip */
3740		b_execute_else_list([TExpr|Rest],LocalState,InState,OutState,WF,CaseNr,Path,LWF,OR) :-
3741		get_texpr_expr(TExpr,if_elsif(Test,Body)), % Info field not used
3742		% get_enumeration_finished_wait_flag(WF,LWF),
3743		InnerWF=WF, %clone_wait_flags_from1(WF,InnerWF),
3744		push_wait_flag_call_stack_info(InnerWF,b_expr_call(if_elsif_test,Test),WF2),
3745	?	b_try_check_boolean_expression_lwf(Test,LocalState,InState,WF2,'$ENUMERATION',PredRes,LWF),
3746		%ground_wait_flag0(InnerWF),
3747		(nonvar(PredRes)
3748		-> b_execute_else_list3(PredRes,Body,Rest,LocalState,InState,OutState,InnerWF,CaseNr,Path,LWF,OR)
3749		; (LWF == '$GENERATE_ON_DEMAND' ->
3750		get_wait_flag0(WF,LWF1),
3751		get_wait_flag_if_necessary(PredRes,LWF1,OR,WF,LWF2)
3752		; LWF2=LWF),
3753	?	b_execute_else_list2(PredRes,Body,Rest,LocalState,InState,OutState,InnerWF,CaseNr,Path,LWF2,OR)
3754		).
3755
3756		% avoid calling get_wait_flag if possible (expensive)
3757		:- block get_wait_flag_if_necessary(-,-,?,?,?).
3758		get_wait_flag_if_necessary(PredRes,_,OR,WF,LWF2) :- var(PredRes), !, % we need waitflag
3759		(preferences:preference(use_smt_mode,true) -> Prio = 2 % was 2.0
3760		; OR == output_required -> Prio = 2000
3761		; Prio = 200000 %last_finite_priority(Prio)
3762		), % TO DO: check if there is a guard inside; if not we can wait much longer; unless we are in CBC mode
3763		get_wait_flag(Prio,if_else,WF,LWF2).
3764		get_wait_flag_if_necessary(_,_,_,_,_).
3765
3766		:- block b_execute_choice(?,?,?,?,?,?,-,?).
3767		b_execute_choice(ChoiceList,LocalState,InState,OutState,WF,choice(Nr,Path),_WFC,OR) :-
3768	?	nth1(Nr,ChoiceList,Choice),
3769		b_execute_statement(Choice,LocalState,InState,OutState,WF,Path,OR).
3770
3771		% execute ASSERT PreCond THEN Body
3772		b_execute_assertion(_PreCond,Body,LocalState,InState,OutState,WF,Path,OR) :-
3773		preference(do_assert_checking,false), % ASSERT checking disabled
3774		!,
3775		b_execute_statement(Body,LocalState,InState,OutState,WF,Path,OR).
3776		b_execute_assertion(PreCond,Body,LocalState,InState,OutState,WF,Path,OR) :-
3777	?	b_try_check_boolean_expression_lwf(PreCond,LocalState,InState,WF,'$ENUMERATION',PredRes,WFC),
3778		% enumeration of PredRes before WFE set make sense, Body can instantiate values
3779		(var(PredRes) -> get_last_wait_flag(assertion,WF,WFC) ; true),
3780		b_execute_assertion_block(PredRes,PreCond,Body,LocalState,InState,OutState,WF,Path,OR).
3781
3782		:- block b_execute_assertion_block(-, ?,?,?,?, ?,?,?,?).
3783		b_execute_assertion_block(pred_true,_PreCond,Body,LocalState,InState,OutState,WF,Path,OR) :-
3784		Path = assertion(IPath),
3785		b_execute_statement(Body,LocalState,InState,OutState,WF,IPath,OR).
3786		b_execute_assertion_block(pred_false,PreCond,_Body,LocalState,InState,_OutState,WF,Path,_OR) :-
3787		Path = assertion_violated,
3788		translate_bexpression(PreCond,PreString),
3789		add_abort_error_span(assert_error,'ASSERT violated: ',PreString,span_predicate(PreCond,LocalState,InState),WF).
3790
3791		:- block check_state_skeleton_bound(-,?).
3792		check_state_skeleton_bound([],true).
3793		check_state_skeleton_bound([bind(Var,_)|T],Res) :-
3794		check_state_skeleton_bound_aux(Var,T,Res).
3795
3796		:- block check_state_skeleton_bound_aux(-,?,?).
3797		check_state_skeleton_bound_aux(Var,T,Res) :-
3798		(atomic(Var) -> true ; print('*** variable name not atomic: '), print(Var),nl),
3799		check_state_skeleton_bound(T,Res).
3800
3801
3802		b_execute_statement_list_when_state_set(StmtList,LS,State,USoFar,Res,WF,Path,OR) :-
3803		check_state_skeleton_bound(State,Bound), % otherwise variable lookups will cause problems
3804	?	b_execute_statement_when_state_set2(StmtList,LS,State,USoFar,Res,WF,Path,Bound,OR).
3805		:- block b_execute_statement_when_state_set2(?,?,?,?,?,?,?,-,?).
3806		b_execute_statement_when_state_set2(StmtList,LS,State,UpdatesSofar,Res,WF,Path,_,OR) :-
3807		copy_wf_start(WF,while2,CWF),
3808	?	b_execute_sequence(StmtList,LS,State,StmtUpdates,CWF,Path,OR),
3809	?	copy_wf_finish(WF,CWF),
3810	?	merge_updates(UpdatesSofar,StmtUpdates,Res).
3811
3812
3813		store_values([], [], []).
3814		store_values([IDsHd|IDsTl], [VALsHd|VALsTl], [bind(IDsHd,VALsHd)|OutStateTl]) :-
3815		store_values(IDsTl, VALsTl, OutStateTl).
3816
3817
3818
3819
3820		/* the B syntax does allow multiple definitions in a LET: */
3821
3822		b_execute_let_definitions(Pred,LocalState,State,WF) :-
3823		is_a_conjunct(Pred,LHS,RHS),!,
3824		b_execute_let_definitions(LHS,LocalState,State,WF),
3825		b_execute_let_definitions(RHS,LocalState,State,WF).
3826		b_execute_let_definitions(b(equal(LHS,RHS),_,_),LocalState,State,WF) :- !,
3827		b_compute_expression(LHS,LocalState,State,LHSVal,WF),
3828		b_compute_expression(RHS,LocalState,State,RHSVal,WF),
3829		% TO DO: ideally we should check if LHS is a declared identifier and is only defined once
3830		kernel_objects:equal_object_optimized(LHSVal,RHSVal,b_execute_let_definitions).
3831		b_execute_let_definitions(b(lazy_let_pred(Id,AssignmentExpr,Body),_,_),LocalState,State,WF) :- !,
3832		add_lazy_let_id_and_expression(Id,AssignmentExpr,LocalState,State,NewLocalState,WF),
3833		b_execute_let_definitions(Body,NewLocalState,State,WF).
3834		b_execute_let_definitions(P,_L,_S,WF) :-
3835		add_internal_error_wf(b_interpreter,'Let contains a predicate which is not an equality: ',P,P,WF),fail.
3836
3837
3838		/* -----------------------------------------*/
3839		/* b_assign_function */
3840		/* -----------------------------------------*/
3841
3842		b_assign_values_or_functions([],[],_LS,_S,[],_WF,_OR).
3843		b_assign_values_or_functions([TExpr|ERest],[Value|VRest],LS,S,[bind(Id,New)|NRest],WF,OR) :-
3844		get_texpr_expr(TExpr,Expr),
3845	?	b_assign_value_or_function(Expr,Value,LS,S,Id,New,WF,OR),
3846		b_assign_values_or_functions(ERest,VRest,LS,S,NRest,WF,OR).
3847
3848		:- use_module(kernel_tools,[ground_value_check/2]).
3849		:- use_module(kernel_records,[overwrite_record_wf/5]).
3850		b_assign_value_or_function(identifier(Id),Value,_LS,_S,LHS_Id,FullValue,WF,_OR) :- !,
3851		LHS_Id=Id,
3852	?	equal_object_wf(FullValue,Value,b_assign_value_or_function(Id),WF).
3853		b_assign_value_or_function(function(Fun,Arg),Value,LocalState,InState,Id,FullValue,WF,OR) :- !,
3854		%b_compute_expression(Arg,LocalState,InState,ArgVal,WF),
3855		%expand_global_sets_but_not_closures(ArgVal,EArgVal),
3856		FunMNF = eval_must_not_fail('Assignment left-hand-side (or part thereof) could not be evaluated: ',Fun), % could be f(..)(..)
3857		b_compute_assign_expressions_when([Arg,FunMNF],LocalState,InState,[ArgVal,FunVal],WF,OR), % or should we pass the OR info around ?
3858		/* we do not examine local state: these vars cannot be modified by operations !? */
3859		(OR=output_required -> override(FunVal,ArgVal,Value,NewFun,WF)
3860		; ground_value_check((FunVal,ArgVal,Value),GRV),
3861		% wait until all arguments known so that we can effiently compute override
3862		blocking_override(GRV,FunVal,ArgVal,Value,NewFun,WF)),
3863		get_texpr_expr(Fun,Lhs),
3864		b_assign_value_or_function(Lhs,NewFun,LocalState,InState,Id,FullValue,WF,OR).
3865		b_assign_value_or_function(record_field(RecordExpr,FieldName),Value,LocalState,InState,LHS_Id,FullValue,WF,OR) :-
3866		!,
3867		% we allow nested record assignments: x'Field1'Field2 := Value
3868		b_compute_expression(RecordExpr,LocalState,InState,OldRecVal,WF),
3869		overwrite_record_wf(OldRecVal,FieldName,Value,NewRecVal,WF),
3870		get_texpr_expr(RecordExpr,Lhs),
3871		b_assign_value_or_function(Lhs,NewRecVal,LocalState,InState,LHS_Id,FullValue,WF,OR).
3872		b_assign_value_or_function(LHS,_Value,_LS,_InState,_Id,_FullValue,WF,_OR) :-
3873		add_internal_error_wf(b_interpreter,'Illegal LHS for assignment (must be ID(.) or ID\'Field or ID): ',LHS,LHS,WF),
3874		fail.
3875
3876		:- block blocking_override(-,?,?,?,?,?).
3877		blocking_override(_,FunVal,ArgVal,Value,NewFun,WF) :- override(FunVal,ArgVal,Value,NewFun,WF).
3878
3879
3880		/* -----------------------------------------*/
3881		/* b_execute_statements_in_parallel */
3882		/* -----------------------------------------*/
3883		/* execute a parallel composition of statements */
3884		:- assert_pre(b_interpreter:b_execute_statements_in_parallel(Ss,LS,State,_Os,WF,_Paths,_OR),
3885		(ground_check(Ss),type_check(LS,store),
3886		type_check(State,store),type_check(WF,wait_flag))).
3887		:- assert_post(b_interpreter:b_execute_statements_in_parallel(_Ss,_LS,_State,Os,WF,_Paths,_OR),
3888		(type_check(Os,store),type_check(WF,wait_flag))).
3889
3890		b_execute_statements_in_parallel([],_,_,[],_WF,[],_OR).
3891		b_execute_statements_in_parallel([Stmt|TS],LocalState,InState,OutState,WF,[Path1|TPath],OR) :-
3892	?	b_execute_statement(Stmt,LocalState,InState,OutState1,WF,Path1,OR),
3893	?	combine_updates(OutState1,OutState2,OutState), /* merge updates */
3894	?	b_execute_statements_in_parallel(TS,LocalState,InState,OutState2,WF,TPath,OR).
3895
3896
3897		%:- block combine_updates(-,-,?).
3898		%combine_updates(A,B,C) :- (B==[] -> A=C ; combine_updates_aux(A,B,C)).
3899
3900		% TO DO: investigate whether we could also unblock on second argument and copy it to result
3901		:- block combine_updates(-,?,?). % can also be used to merge states
3902		combine_updates([],X,R) :- !,R=X.
3903	?	combine_updates([H|T],Y,Res) :- !, Res=[H|Z], combine_updates(T,Y,Z).
3904		combine_updates(X,Y,Z) :- add_internal_error('Illegal call: ',combine_updates(X,Y,Z)),fail.
3905
3906
3907
3908		b_execute_initialisation_statement(Stmt,LS,In,Out,_OUTERWF,Path,OR) :-
3909		init_wait_flags(WF,[b_execute_initialisation_statement]),
3910		% each initialisation can be executed in isolation (except in CBC mode)
3911	?	b_execute_statement(Stmt,LS,In,Out,WF,Path,OR),
3912	?	ground_wait_flags(WF).
3913
3914		% replace certain parallels by init_parallel for better error reporting in INITIALISATION
3915		% will not be used in CBC mode (by set_up_initialisation or tc_initialise)
3916		translate_init_statements(b(Stmt,subst,I),b(TStmt,subst,I)) :-
3917		tp2(Stmt,I,TStmt).
3918		tp2(assign(LHS,RHS),I,parallel(S)) :- LHS=[_,_|_],
3919		% translate multiple assignment into parallel assignments
3920		maplist(generate_assignment(I),LHS,RHS,S),
3921		!.
3922		tp2(Stmt,I,init_statement(b(Stmt,subst,I))) :- %get_preference(provide_trace_information,true),
3923		wrap_stmt(Stmt),
3924		!.
3925		% TO DO: cover WHILE
3926		tp2(parallel(S),_,parallel(TS)) :- maplist(translate_init_statements,S,TS),
3927		!.
3928		tp2(sequence(A),_,sequence(LA)) :- !,maplist(translate_init_statements,A,LA).
3929		tp2(if(A),_,if(LA)) :- !, maplist(translate_init_statements,A,LA).
3930		tp2(if_elsif(Test,Body),_,if_elsif(Test,LBody)) :- !,
3931		translate_init_statements(Body,LBody).
3932		tp2(X,_,X). % :- functor(X,F,A), nl,nl,print(uncovered(F/A)),nl,nl.
3933
3934		wrap_stmt(assign(_,_)).
3935		wrap_stmt(becomes_element_of(_,_)).
3936		wrap_stmt(becomes_such(_,_)).
3937		wrap_stmt(assign_single_id(_,_)).
3938
3939		generate_assignment(I,V,RHS,b(init_statement(b(Assign,subst,I)),subst,I)) :-
3940		Assign = assign([V],[RHS]).
3941
3942
3943
3944		/* ---------------------------------------*/
3945		/* b_execute_top_level_statement */
3946		/* ---------------------------------------*/
3947
3948		/* this is just like b_execute_statement with the
3949		only difference that a PRE-condition is treated like
3950		a select, i.e., it does not generate an abort if used
3951		outside of its condition */
3952		b_execute_top_level_statement(TExpr,LocalState,InState,OutState,WF,Path,OR) :-
3953		get_texpr_expr(TExpr,Stmt),
3954	?	b_execute_top_level_statement2(Stmt,TExpr,LocalState,InState,OutState,WF,Path,OR).
3955		b_execute_top_level_statement2(precondition(PreCond,Body),TExpr,
3956		LocalState,InState,OutState,WF,Path,OR) :-
3957		preferences:preference(treat_outermost_pre_as_select,true),!,
3958		%debug_println(9,'Top level PRE treated as SELECT'),
3959		preference(ltsmin_do_not_evaluate_top_level_guards,NO_EVAL),
3960		(NO_EVAL=full ->
3961		debug_println(9,pge_guard_will_not_be_evaluated)
3962		; NO_EVAL=true, % do not evaluate guards detected by guard splitting
3963		get_texpr_info(TExpr,Info),member(prob_annotation('LTSMIN-GUARD'),Info) ->
3964		debug_println(9,ltsmin_guard_will_not_be_evaluated)
3965	?	; b_test_boolean_expression(PreCond,LocalState,InState,WF)
3966		),
3967		% b_tracetest_boolean_expression(PreCond,LocalState,InState,WF,one), % comment in for debugging
3968	?	b_execute_statement(Body,LocalState,InState,OutState,WF,Path,OR).
3969		b_execute_top_level_statement2(lazy_let_subst(Id,IdExpr,Body),_,
3970		LocalState,InState,OutState,WF,lazy_let(Path),OR) :-
3971		!,
3972		add_lazy_let_id_and_expression(Id,IdExpr,LocalState,InState,NewLocalState,WF),
3973		b_execute_top_level_statement(Body,NewLocalState,InState,OutState,WF,Path,OR).
3974		b_execute_top_level_statement2(_,TExpr,LocalState,InState,OutState,WF,Path,OR) :-
3975	?	b_execute_statement(TExpr,LocalState,InState,OutState,WF,Path,OR).
3976
3977
3978		/* -----------------------------*/
3979		/* b_execute_operation */
3980		/* -----------------------------*/
3981		/* execute a single operation */
3982
3983		try_get_op_name(FullOperation,_Name) :- var(FullOperation),!.
3984		try_get_op_name('-->'(FO,_),Name) :- !,try_get_op_name(FO,Name).
3985		try_get_op_name(FullOperation,Name) :- functor(FullOperation,Name,_).
3986
3987
3988
3989		:- assert_pre(b_interpreter:b_execute_top_level_operation_update(_Name,_FullOperation,InState,_NewState,_P),
3990		(ground_check(InState),type_check(InState,store))).
3991		:- assert_post(b_interpreter:b_execute_top_level_operation_update(Name,_FullOperation,_InState,NewState,_Path),
3992		(type_check(NewState,store),ground_check(Name))).
3993
3994
3995		b_execute_top_level_operation_update(Name,FullOperation,InState,Updates,Path) :-
3996	?	b_execute_top_level_operation_update_wf(Name,FullOperation,InState,Updates,Path,WF),
3997	?	ground_wait_flags(WF).
3998		%store:store_updates_and_normalise(Updates,InState,NewState).
3999
4000
4001		b_execute_top_level_operation_update_wf(Name,FullOperation,InState,Updates,Path,WF) :-
4002		init_wait_flags(WF,[]), % now treated by call_stack: [expansion_context(op(Name),[])]),
4003		% b_execute_operation2 below will push_wait_flag_call_stack_info
4004		try_get_op_name(FullOperation,Name), b_top_level_operation(Name),
4005		setup_result_input_values(Name,RIV),
4006		Info=unknown, % Info extracted later for top_level
4007	?	b_execute_operation2(Name,FullOperation,InState,Updates,_,RIV,_,true,Path,Info,WF,output_not_required).
4008
4009		% set up value of read output variables *before* operation call to some dummy value
4010		setup_result_input_values(Name,ResultInputValues) :-
4011		(get_preference(allow_operations_to_read_outputs,true),
4012		b_operation_reads_output_variables(Name,_Reads,TReadsInfo) ->
4013		maplist(setup_read_output_variable,TReadsInfo,ResultInputValues)
4014		%translate_bstate_limited(ResultInputValues,TS),
4015		%ajoin(['Warning: setting read output variables in ',Name,' to default values: ',TS],Msg),
4016		%add_warning(b_interpreter,Msg),
4017		%store_error_for_context_state(eventerror(Name,event_other_error(Msg),[]),_Id)
4018		; ResultInputValues=[]).
4019
4020		:- use_module(typing_tools,[any_value_for_type/2]).
4021		setup_read_output_variable(reads_result(_,Name,Type),bind(Name,Val)) :- any_value_for_type(Type,Val).
4022
4023		% for use by CBC:
4024		b_execute_top_level_operation_wf(Name,FullOperation,ParaVals,ResultVals,InState,NewState,Path,WF) :-
4025		try_get_op_name(FullOperation,Name),
4026		if(b_top_level_operation(Name),true,
4027		(add_internal_error('Unknown operation name for b_execute_top_level_operation_wf: ',Name),fail)
4028		),
4029		% call before execute operation to copy over results immediately in case b_execute_operation2 generates choice points:
4030		store_intermediate_updates_wf(InState,Updates,NewState,operation(Name),WF), % no normalising is better for constraint propagation
4031		% TO DO?: copy over unmodified variables b_get_machine_variables(Variables),copy_unmodified_variables(Variables,OpName,InState,NewState)
4032		setup_result_input_values(Name,RIV),
4033		Info=unknown, % Info extracted later for top_level
4034		b_execute_operation2(Name,FullOperation,InState,Updates,ParaVals,RIV,ResultVals,true,Path,Info,WF,output_required).
4035		% we should ensure that Operation part is executed to instantiate NewOutState skeleton
4036
4037
4038
4039		% Note : if the argument OR (OutputRequired) has value output_required this indicates that the output
4040		% an operation or its effect is required (e.g., because of sequential composition) and the constraint solver
4041		% should not delay computing the effect of the operation
4042		% Atelier-B Handbook 6.16: [R <- op (E)]P = [X := E ; S ; R :=Y] P where op defined by X <- op(Y) = S
4043		b_execute_operation_with_parameters(Name,LocalState,InState,Results,Parameters,OutState,ParamValues,ResultValues,
4044		Path,Info,WF,OR) :-
4045		(b_is_operation_name(Name)
4046		-> b_compute_expressions(Parameters,LocalState,InState,ParamValues,WF),
4047		% TO DO : remove local vars from InState
4048		(b_operation_reads_output_variables(Name,_Reads,TReadsInfo)
4049		-> % format('Transferring outputs ~w ~w~n ~w~n',[Name,_Reads,TReadsInfo]),
4050		maplist(output_parameters_value(LocalState,InState,Results,Info,WF),TReadsInfo,ResultInputValues)
4051		; ResultInputValues=[]),
4052	?	call_b_execute_operation2(Name,InState,OutState,ParamValues,ResultInputValues,ResultValues,false,
4053		Path,Info,WF,OR)
4054		; add_internal_error('Unknown B operation, cannot call: ',
4055		b_execute_operation_with_parameters(Name,LocalState,InState,Results,Parameters,
4056		OutState,ParamValues,ResultValues,Path,Info,WF,OR)),
4057		fail
4058		).
4059
4060
4061		%b_execute_operation_in_expression(Name,_LocalState,_InState,_Parameters,_Value,Info,_WF) :-
4062		% % This clause is disabled: sometimes variables are marked as read even though they are not:
4063		% % the analysis is not precise due to sequential composition, CASE statements, ...
4064		% b_operation_reads_output_variables(Name,_Reads,_TReadsInfo),!,
4065		% add_error(b_interpreter,'Operation that reads output cannot be called in expression: ',Name,Info),
4066		% fail.
4067		b_execute_operation_in_expression(Name,LocalState,InState,Parameters,Value,Info,WF) :-
4068		% TODO: check that this is a query operation; probably done in type checker
4069		OR=output_required, % alternative: OR=output_not_required,
4070		setup_result_input_values(Name,ResultInputValues),
4071		b_compute_expressions(Parameters,LocalState,InState,ParamValues,WF),
4072		(b_get_operation_normalized_read_write_info(Name,Read,_Modified)
4073		-> true % Modified should be []
4074		; member(reads(Read),Info)
4075		-> add_message(b_interpeter,'Unregistered operation in expression: ',Name) % prefixed operation not found
4076		; add_error(b_interpeter,'Cannot obtain read-write info for operation in expression:',Name),
4077		Read=[]
4078		),
4079		create_inner_wait_flags(WF,operation_call_in_expr,OpWF),
4080		ground_value_check(ParamValues,ParaGround),
4081		exclude(unused_variable(Read),InState,IS),
4082		ground_state_check(IS,StateGround),
4083		% TO DO: in case of recursion it may be good to delay executing sub-operation until some WF is set
4084		call_b_execute_operation2(Name,IS,_OutState,ParamValues,ResultInputValues,ResultValues,false,_Path,Info,OpWF,OR),
4085		ground_inner_wf(ParaGround,StateGround,OpWF),
4086		make_couplise(ResultValues,Value).
4087
4088		% ground inner waitflags when parameters and relevant read variables fully known
4089		:- block ground_inner_wf(-,?,?), ground_inner_wf(?,-,?).
4090		ground_inner_wf(_,_,WF) :-
4091	?	ground_inner_wait_flags(WF).
4092
4093		call_b_execute_operation2(Name,InState,OutState,ParamValues,ResultInputValues,ResultValues,false,Path,Info,WF,OR) :-
4094	?	runtime_profiler:profile_single_call(Name,unknownStateId, b_interpreter:
4095		b_execute_operation2(Name,_,InState,OutState,ParamValues,ResultInputValues,ResultValues,false,Path,Info,WF,OR)
4096		).
4097
4098		output_parameters_value(LocalState,InState,Results,_,WF,reads_result(Index,ID,_Type),bind(ID,Val)) :-
4099		nth1(Index,Results,ReadResultTID),!,
4100		def_get_texpr_id(ReadResultTID,ReadID),
4101		(lookup_value_without_check(ReadID,LocalState,InState,Val)
4102		-> true %check_not_undefined(Val,ReadID,ReadResultTID)
4103		; add_error_wf(output_parameters,'Could not obtain value for read output parameter: ',ReadID,ReadResultTID,WF),
4104		Val = term(undefined)).
4105		output_parameters_value(_LocalState,_InState,_Results,Info,WF,reads_result(_Index,ID,_Type),bind(ID,Val)) :-
4106		add_error_wf(output_parameters,'Could not obtain value for read output parameter: ',ID,Info,WF),
4107		Val = term(undefined).
4108
4109		% TO DO: use this ?
4110		%:- block check_not_undefined(-,?,?).
4111		%check_not_undefined(term(undefined),ReadID,ReadResultTID) :- !,
4112		% add_error(output_parameters_value,'Output parameter not assigned to: ',ReadID,ReadResultTID).
4113		%check_not_undefined(_,_,_).
4114
4115		:- use_module(probsrc(succeed_max),[assert_max_reached/1]).
4116		% ResultInputValues: in Atelier-B result parameters can also be read !
4117		b_execute_operation2(Name,Operation,InState,Updates,ParaValues,ResultInputValues,ResultValues,_TopLvl,TransInfo,_,_WF,_OR) :-
4118		ResultInputValues = [], % in this case the operation's behaviour also depends on current value of output variables
4119		lookup_cached_transitions(Name,InState,Info,Solutions),!,
4120		(member(max_reached,Info) -> assert_max_reached(Name) ; true),
4121	?	member(trans_cached(ParaValues,ResultValues,Updates,TransInfo),Solutions),
4122		create_full_operation(Name,ResultValues,ParaValues,ResultValues,Operation).
4123		% TODO: call operation with ParaValues if not found and max_reached is true !!
4124
4125		b_execute_operation2(Name,Operation,InState,NewOutState,ParaValues,ResultInputValues,ResultValues,
4126		TopLevel,TransInfo,Info,WF,OutputRequired) :-
4127		if(b_get_machine_operation_for_animation(Name,Results,Parameters,Body,OType,TopLevel,OpPos),
4128		true,
4129		(add_error_wf(b_interpreter,'Cannot find operation:',Name,Info,WF),fail)),
4130		%% % we do not want skip the evaluation of a guard of an operation with parameters
4131		%% (Parameters==[] ->true; retractall(pge_algo:do_not_evaluate_guard)),
4132		(Info=unknown, TopLevel==true -> CallInfo=OpPos ; CallInfo=Info),
4133		push_wait_flag_call_stack_info(WF,operation_call(Name,ParaValues,CallInfo),WF2),
4134	?	b_execute_operation3(OType,Name,Operation,
4135		InState,NewOutState,
4136		Body,Parameters,ParaValues,Results,ResultInputValues,ResultValues,TopLevel,TransInfo,WF2,OutputRequired).
4137
4138		create_full_operation(Name,Results,ParaValues,ResultValues,FullOperation) :-
4139		Operation =.. [Name|ParaValues], % TO DO: catch if > 255 args (max_arity)
4140		( Results == [] -> /* we have an ordinary operation */
4141		FullOperation = Operation
4142		; FullOperation = '-->'(Operation,ResultValues)
4143		).
4144
4145		b_execute_operation3(classic,Name,Operation,InState,NewOutState,
4146		Body,Parameters,ParaValues,Results,ResultInputValues,NormalisedResultValues,TopLevel,
4147		[path(Path)], % as path is currently filtered out anyway and not stored !
4148		WF,OR) :-
4149		%print('Attempting Operation ----> '),print(Name),nl,
4150		empty_state(EmptyState),
4151	?	set_up_typed_localstate(Parameters,ParaValues,ParamTypedVals,EmptyState,LocalState,positive),
4152		l_expand_and_normalise_values(ParaValues,NormalisedParaValues,Parameters),
4153		% not useful for call_b_execute_operation2
4154		create_full_operation(Name,Results,NormalisedParaValues, % ditto
4155		NormalisedResultValues,Operation),
4156		set_up_undefined_localstate_with_predefined(Results,ResultInputValues,InState,NewInState),
4157		/* to avoid error messages with sequential composition (store_intermediate_updates) */
4158		check_additional_guard(TopLevel,LocalState,NewInState,WF),
4159		(TopLevel==true
4160	?	-> b_execute_top_level_statement(Body,LocalState,NewInState,OutState,WF,Path,OR)
4161	?	; b_execute_statement(Body,LocalState,NewInState,OutState,WF,Path,OR)
4162		),
4163		b_tighter_enumerate_all_values(ParamTypedVals,WF),
4164		% moved after execute for performance reasons; see PerformanceTests/ParameterEnumeration.mch
4165		% print_bt_message('Operation Successful ------> '),
4166		(preferences:preference(treat_outermost_pre_as_select,true),
4167		preferences:preference(require_operations_to_assign_all_outputs,true)
4168		-> ReportError = true ; ReportError = false),
4169		get_results(Results,OutState,NormalisedResultValues,NewOutState,ReportError,normalise_results,WF).
4170		b_execute_operation3(eventb_operation(ChangeSet,ParaValues,Operation),
4171		_Name,Operation, InState,Updates,
4172		TBody,Parameters,ParaValues,[],[],[],true,TransInfo,WF,OutputRequired) :-
4173		% TO DO: check if need to pass _OutputRequired to b_event
4174	?	b_execute_event_with_change_set_wf(TBody,Parameters,ParaValues,InState,ChangeSet,Updates,TransInfo,WF,OutputRequired).
4175
4176		:- use_module(b_global_sets,[add_prob_deferred_set_elements_to_store/3]).
4177		% additional guards can be set by the user to constrain/direct the execution of operations
4178		check_additional_guard(TopLevel,LocalState,State,WF) :-
4179		(TopLevel==true,
4180		bmachine:b_machine_temp_predicate(TempPred)
4181		/* an additional precondition typed in by the user */
4182		-> check_state_skeleton_bound(LocalState,LB),
4183		check_state_skeleton_bound(State,BB),
4184		check_additional_guard_when_bound(LB,BB,TempPred,LocalState,State,WF)
4185		; true
4186		).
4187
4188		:- block check_additional_guard_when_bound(-,?,?, ?,?,?), check_additional_guard_when_bound(?,-,?, ?,?,?).
4189		check_additional_guard_when_bound(_,_,TempPred,LocalState,State,WF) :-
4190		(debug_mode(on) -> print(check_additional_guard),nl, print_bexpr(TempPred),nl ; true),
4191		add_prob_deferred_set_elements_to_store(State,BState1,visible),
4192		b_test_boolean_expression(TempPred,LocalState,BState1,WF).
4193
4194		% additional properties can either be set by user or by command-line or by VALUES clause
4195		add_additional_properties(OldProperty,NewProperty) :-
4196		(bmachine:b_machine_temp_predicate(TempPred) % this overrides additional property !
4197		-> conjunct_predicates([TempPred,OldProperty],NewProperty)
4198		; findall(AddPred,b_machine_additional_property(AddPred),L),
4199		(L=[] -> NewProperty = OldProperty
4200		; conjunct_predicates([OldProperty|L],NewProperty)
4201		)
4202		).
4203
4204		% get removes results from OutState
4205		filter_results(Results,OutState,NewOutState,WF) :-
4206		get_results(Results,OutState,_ResultValues,NewOutState,false,do_not_normalise,WF).
4207		get_results(Results,OutState,ResultValues,NewOutState,ReportError,Normalise,WF) :-
4208		(Results==[] -> (ResultValues,NewOutState) = ([],OutState)
4209		; get_results1(Results,OutState,ResultValues,NewOutState,ReportError,Normalise,WF)).
4210		:- block get_results1(?,-,?,?,?,?,?).
4211		get_results1([],OutState,[],OutState,_ReportError,_Normalise,_WF).
4212		get_results1([R|Results],OutState,[NRV|ResultValues],NewOutState,ReportError,Normalise,WF) :-
4213		def_get_texpr_id(R,ResultId),
4214		lookup_and_delete_value(ResultId,RV,OutState,OutState2,ReportError,WF,Finished),
4215		get_results2(Finished,R,Results,RV,NRV,OutState2,ResultValues,NewOutState,ReportError,Normalise,WF).
4216		:- block get_results2(-,?,?,?,?,?,?,?,?,?,?).
4217		get_results2(_,R,Results,RV,NRV,OutState2,ResultValues,NewOutState,ReportError,Normalise,WF) :-
4218		(Normalise==normalise_results -> normalise_value_for_var(R,true,RV,NRV)
4219		;
4220		NRV=RV), % Maybe we should not normalise in CBC mode ?
4221		get_results1(Results,OutState2,ResultValues,NewOutState,ReportError,Normalise,WF).
4222
4223
4224
4225		/* ------------------------------------------------------------------ */
4226		/* SET UP CONSTANTS */
4227		/* ------------------------------------------------------------------ */
4228
4229		:- use_module(static_ordering).
4230
4231		:- volatile no_solution_found_for_constants/0, properties_were_filtered/1,
4232		unsat_properties_component/2, unsat_properties_enumeration_warning/1, unsat_properties_abort_error/1,
4233		unsat_properties_conjunct_inside_component/4.
4234		:- dynamic no_solution_found_for_constants/0,
4235		properties_were_filtered/1,
4236		unsat_properties_component/2, unsat_properties_enumeration_warning/1,
4237		unsat_properties_abort_error/1,
4238		unsat_properties_conjunct_inside_component/4.
4239
4240		reset_unsat_component_infos :-
4241		retractall(unsat_properties_component(_,_)),
4242		retractall(unsat_properties_enumeration_warning(_)),
4243		retractall(unsat_properties_abort_error(_)),
4244		retractall(unsat_properties_conjunct_inside_component(_,_,_,_)).
4245
4246		:- use_module(b_interpreter_components,[unsat_conjunct_inside_component/4, unsat_component_abort_error/1,
4247		unsat_component_enumeration_warning/1]).
4248		% store information about unsatisfiable components for later usage
4249		% will only be called when no solution found for components
4250		assert_unsat_component_infos(_) :-
4251	?	unsat_component(X,FalseOrUnknown), % from b_interpreter_components
4252		assertz(unsat_properties_component(X,FalseOrUnknown)),fail.
4253		assert_unsat_component_infos(_) :-
4254		unsat_component_enumeration_warning(X), % from b_interpreter_components
4255		assertz(unsat_properties_enumeration_warning(X)),fail.
4256		assert_unsat_component_infos(_) :-
4257		unsat_component_abort_error(X), % from b_interpreter_components
4258		assertz(unsat_properties_abort_error(X)),fail.
4259		assert_unsat_component_infos(_) :-
4260	?	unsat_conjunct_inside_component(X,BE,Status,Reason), % from b_interpreter_components
4261		assertz(unsat_properties_conjunct_inside_component(X,BE,Status,Reason)),fail.
4262		assert_unsat_component_infos(Status) :-
4263	?	(unsat_conjunct_inside_component(_,_,false,_) -> Status = false
4264		; unsat_component(X,false), \+ unsat_component_abort_error(X) -> Status = false % what about enumeration warnings?
4265		; Status=unknown).
4266
4267
4268		all_unsat_components_marked_prob_ignore :-
4269		unsat_properties_conjunct_inside_component(_,_,unknown,'prob-ignore'), % at least one prob-ignore was used
4270		!,
4271		\+ non_ignore_unsat_component.
4272
4273		non_ignore_unsat_component :-
4274		unsat_properties_conjunct_inside_component(_,_,Status,Reason),
4275		\+ (Status = unknown, Reason = 'prob-ignore').
4276
4277		tcltk_unsatisfiable_components_exist :- unsat_or_unknown_component_exists,!.
4278
4279		%tcltk_unsatisfiable_components(list(UnsatComponents)) :-
4280		% findall(C,unsat_properties_component(C),UnsatComponents), UnsatComponents\=[].
4281
4282		get_property_components(Components) :-
4283		b_machine_has_constants_or_properties,
4284		b_get_properties_from_machine(Properties),
4285		add_additional_properties(Properties,NewProperty),
4286		bsyntaxtree:predicate_components(NewProperty,Components),!.
4287		get_property_components([]).
4288
4289		:- dynamic uses_implementable_integers/0.
4290		:- dynamic min_max_integer_value_used/2.
4291
4292
4293		tcltk_quick_describe_unsat_properties(list(FullDescr),STATUS) :-
4294		retractall(uses_implementable_integers),
4295		retractall(min_max_integer_value_used(_,_)), assertz(min_max_integer_value_used(none,none)),
4296		get_property_components(Components),
4297		(unsat_properties_conjunct_inside_component(_,_,false,_)
4298		-> STATUS='FALSE'
4299		; all_unsat_components_marked_prob_ignore
4300		-> STATUS = 'prob-ignore'
4301		; STATUS='UNKNOWN'
4302		),
4303		findall(TP, (unsat_properties_conjunct_inside_component(CompNr,P,_Status,_ReasonMsg), % find individual conjuncts
4304		% Status can be false or unknown
4305		nth1(CompNr,Components,component(FullPred,_Vars)),
4306		check_uses_implementable_integers(FullPred), % for the min-max one may need to look at the entire component !
4307		translate_bexpression_with_limit(P,TrP),
4308		get_component_enum_warning_message(CompNr,EnumWarningAbortMsg),
4309		(EnumWarningAbortMsg = '' -> Prefix = '' ; Prefix = '\n '),
4310		get_span_msg(P,'\n ',SpanMsg),
4311		ajoin([' * ',TrP,Prefix,EnumWarningAbortMsg,SpanMsg,'\n'],TP)),
4312		D1),
4313		findall([Msg1,PS|DescrVars],
4314		(get_unsat_component_description(Components,CompNr,MaxCompNr,
4315		Size,PS,DescrVars,EnumWarningAbortMsg,SpanMsg),
4316		ajoin([' * Predicate Component ',EnumWarningAbortMsg,CompNr,'/',MaxCompNr,
4317		' (with ',Size,' conjunct(s))',SpanMsg, ':'],Msg1)),
4318		UC),
4319		append(UC,UCL), % join all component descriptions
4320		(D1=[]
4321		% TO DO: adapt message for enumeration warning
4322		-> Descr = D2,
4323		(UCL=[] -> D2 = ['The properties were satisfiable']
4324		; D2 = ['No solution found for the following predicates: '|UCL]
4325		)
4326		; Descr = ['The following properties prevented finding a solution:\n'|D12],
4327		% Comment: the predicate can trigger the computation of another earlier registered predicate
4328		% Example f = {1|->2} & f: A --> B & A = 1..5; A=1..5 triggers the check for f
4329		(UCL=[] -> D2=[]
4330		; D2 = ['\nIn addition no solution was found for the following predicates: '|UCL]
4331		),
4332		append(D1,D2,D12)),
4333		findall(W,other_warning(W),Warnings),
4334		(Warnings = [] -> FullDescr=Descr ; append(Descr,['\nWARNINGS/MESSAGES:'|Warnings],FullDescr)).
4335
4336		% called by predicate_debugger:
4337		get_unsat_component_predicate(CompNr,Predicate,Vars) :-
4338		unsat_properties_component(CompNr,_FalseOrUnknown),
4339		get_property_components(Components),
4340		nth1(CompNr,Components,component(Predicate,Vars)).
4341
4342		get_unsat_component_description(Components,CompNr,MaxCompNr,Size,PS,DescrVars,EnumWarningAbortMsg,SpanMsg) :-
4343		unsat_properties_component(CompNr,_),
4344		\+ unsat_properties_conjunct_inside_component(CompNr,_,_,_), % we have not yet dealt with this component in first findall above
4345		nth1(CompNr,Components,component(Pred,Vars)),
4346		length(Components,MaxCompNr),
4347		size_of_conjunction(Pred,Size),
4348		describe_constants(Vars,DescrVars),
4349		check_uses_implementable_integers(Pred), % store information in case it does use implementable integers for later user messages
4350		(debug_mode(on) -> Lim = 1500 ; Lim = 250),
4351		translate_bexpression_with_limit(Pred,Lim,PS),
4352		get_component_enum_warning_message(CompNr,EnumWarningAbortMsg),
4353		% note: sometimes we have a conjunction with empty span info, but different conjuncts (possibly from different files):
4354		get_span_msg(Pred,'\n ',SpanMsg).
4355
4356		get_span_msg(Pred,Prefix,SpanMsg) :-
4357		(extract_span_description(Pred,SpanStr) -> ajoin([Prefix,SpanStr],SpanMsg) ; SpanMsg = '').
4358
4359		get_component_enum_warning_message(CompNr,EnumWarningAbortMsg) :-
4360		(unsat_properties_enumeration_warning(CompNr)
4361		->(unsat_properties_abort_error(CompNr)
4362		-> EnumWarningAbortMsg = '[** with Enumeration Warning and WD-ERROR **] '
4363		; EnumWarningAbortMsg = '[* with Enumeration Warning *] ')
4364		; (unsat_properties_abort_error(CompNr)
4365		-> EnumWarningAbortMsg = '[** with WD-ERROR **] '
4366		; EnumWarningAbortMsg = '')
4367		).
4368
4369		describe_constants([],R) :- !,R=[].
4370		describe_constants(Vars,['* over identifiers : '|Vars]).
4371
4372		check_uses_implementable_integers(_) :- specfile:eventb_mode,!. % cannot use implementable integers
4373		check_uses_implementable_integers(_) :- uses_implementable_integers,!. % no need to check another component
4374		check_uses_implementable_integers(Pred) :-
4375		(uses_implementable_integers(Pred)
4376		-> assertz(uses_implementable_integers),
4377		retract(min_max_integer_value_used(Min,Max)),
4378		min_max_integer_value_used(Pred,Min,Max,NewMin,NewMax),
4379		assertz(min_max_integer_value_used(NewMin,NewMax))
4380		; true).
4381
4382		other_warning(W) :- uses_implementable_integers,
4383		preferences:get_preference(minint,MININT),
4384		preferences:get_preference(maxint,MAXINT),
4385		min_max_integer_value_used(Min,Max),
4386		( (number(Min),Min<MININT ; number(Max),Max>MAXINT)
4387		-> ajoin(['\n MININT...MAXINT only set to ',MININT,'..',MAXINT,' but integers used at least from ',Min,'..',Max],W)
4388		; (MAXINT < 127 ; MININT > -128)
4389		-> ajoin(['\n MININT...MAXINT possibly too small: ',MININT,'..',MAXINT],W)).
4390		% TO DO: we could also extract explicit integer values used in the component and compare them against MININT/MAXINT
4391		other_warning(W) :- bmachine_eventb:deferred_set_equality_without_enumeration_axioms(X,_Set),
4392		translate_bexpression_with_limit(X,XS),
4393		ajoin(['\n Set not recognized as enumerated: ',XS],W).
4394		% TO DO: generate warning if MAXINT/MININT small and NAT,NAT1 or INT was used in component(s) above
4395
4396		% call if tcltk_quick_describe_unsat_properties fails:
4397		% TODO: maxint warning above
4398		generate_unsat_properties_warnings :- uses_implementable_integers,
4399		preferences:get_preference(minint,MININT),
4400		preferences:get_preference(maxint,MAXINT),
4401		min_max_integer_value_used(Min,Max),
4402		(number(Min),Min<MININT ; number(Max),Max>MAXINT),
4403		ajoin(['MININT...MAXINT only set to ',MININT,'..',MAXINT,' but integers used at least from ',Min,'..',Max],Msg),
4404		add_warning(setup_constants_unknown,Msg),
4405		fail.
4406		generate_unsat_properties_warnings :-
4407		bmachine_eventb:deferred_set_equality_without_enumeration_axioms(X,Set),
4408		translate_bexpression_with_limit(X,TX),
4409		Eq = b(equal(X,Set),pred,[]),
4410		ajoin(['Deferred SET ',TX,' was not recognized as an enumerated set, you may want to use partition instead of the equality: '],Msg),
4411		add_warning(setup_constants_unknown,Msg,Eq,X),
4412		fail.
4413		generate_unsat_properties_warnings.
4414
4415		% -------------
4416
4417		% Complete is either complete_properties or partial_properties if properties were marked as ignore
4418		b_set_up_concrete_constants(NormalisedConstantsState,Complete) :-
4419		reset_unsat_component_infos,
4420		retractall(properties_were_filtered(_)),
4421		(no_solution_found_for_constants -> true ; assertz(no_solution_found_for_constants)),
4422		% preference(allow_incomplete_partial_setup_constants,AllowSkipping),
4423		reset_component_info(true),
4424		b_machine_has_constants_or_properties,
4425		b_get_machine_constants(UnsortedConstants),
4426		!,
4427		silent_mode(SilentMode),
4428	?	(SilentMode=on -> true ; bt_start_ms_timer('SETUP_CONSTANTS')), % TO DO: store time for unsat core
4429		b_get_properties_from_machine(MProperties),
4430		(get_preference(use_ignore_pragmas,true) % filter out prob-ignore predicates here
4431		-> conjunction_to_list(MProperties,LMP), % TO DO avoid this conversion and back
4432		exclude_count(predicate_has_ignore_pragma, LMP,LMP2,Excluded), % exclude props marked as prob-ignore
4433		conjunct_predicates(LMP2,MProperties2),
4434		%format('FILTERED (~w): ',[Excluded]),translate:print_bexpr(MProperties2),nl,
4435		(Excluded=0 -> Complete=complete_properties
4436		; assertz(properties_were_filtered(Excluded)), Complete=partial_properties)
4437		; MProperties2=MProperties,
4438		Complete=complete_properties
4439		),
4440		add_additional_properties(MProperties2,Properties),
4441		project_onto_static_assertions(Properties,UnsortedConstants,PProperties,PUnsortedConstants),
4442	?	solve_properties(PProperties,PUnsortedConstants,ConstantsState),
4443	?	(SilentMode=on -> true ; bt_stop_ms_timer('SETUP_CONSTANTS')),
4444		normalise_store(ConstantsState,NormalisedConstantsState),
4445		retractall(no_solution_found_for_constants). /* ensure that b_partial_set_up_concrete_constants fails */
4446		b_set_up_concrete_constants([],complete).
4447
4448
4449		% solve already projected and filtered properties and constants, return state with solution for constants
4450		% cbc_solve_timed almost does what we want; but looks at current state; see solve_free_aux
4451		% TODO: move this to a separate module and add cdclt
4452		solve_properties(PProperties,PUnsortedConstants,ConstantsState) :-
4453		get_preference(use_solver_on_load,Solver),
4454	?	solve_properties(Solver,PProperties,PUnsortedConstants,ConstantsState).
4455
4456		solve_properties(sat,Properties,_TypedConstants,ConstantsState) :- !,
4457	?	b2sat:solve_predicate_with_satsolver_free(Properties, ConstantsState,Result,[]),
4458		Result=solution(_).
4459		solve_properties('sat-z3',Properties,_TypedConstants,ConstantsState) :- !,
4460		b2sat:solve_predicate_with_satsolver_free(Properties, ConstantsState,Result,[use_satsolver(z3)]),
4461		Result=solution(_).
4462		solve_properties(cdclt,Properties,_TypedConstants,ConstantsState) :- !,
4463		cdclt_solver:cdclt_solve_predicate(Properties,_,Result),
4464		Result=solution(ConstantsState).
4465		solve_properties(clingo,Properties,_TypedConstants,ConstantsState) :- !,
4466		get_preference(maxNrOfInitialisations,MaxNrSols),
4467		b2asp:solve_pred_with_clingo(Properties,MaxNrSols,_,Result,_Exhaustive),
4468		% TODO: check if non_exhaustive and assert max_reached ?
4469		Result=solution(ConstantsState).
4470		solve_properties(kodkod,PProperties,PUnsortedConstants,ConstantsState) :- !,
4471	?	solve_properties(prob,PProperties,PUnsortedConstants,ConstantsState). % Kodkod processing is done elswehere
4472		solve_properties(prob,PProperties,PUnsortedConstants,ConstantsState) :- !,
4473		(preferences:preference(use_static_ordering,true)
4474		-> sort_ids_by_usage(PUnsortedConstants,PProperties,Constants,no_warnings), % no_warnings as Ids could be used in operations, assertions, ...
4475		set_up_typed_localstate(Constants,_FreshVars,TypedVals,[],SortedState,positive),
4476	?	reorder_state(PUnsortedConstants,SortedState,ConstantsState)
4477		; Constants = PUnsortedConstants,
4478	?	set_up_typed_localstate(Constants,_FreshVars,TypedVals,[],ConstantsState,positive)
4479		),
4480		% now try and load saved constants from file for sub-machines when -cache is used:
4481	?	load_partial_constants(ConstantsState,PProperties,LPProperties), % Note: this can backtrack
4482		reset_component_info(true), % reset in case load_partial_constants backtracks! relevant for test 2112
4483		b_global_sets:static_symmetry_reduction_for_global_sets(ConstantsState),
4484	?	b_trace_test_components_full(LPProperties,ConstantsState,TypedVals).
4485		solve_properties(SolverName,Properties,_TypedConstants,ConstantsState) :-
4486		temporary_set_preference(z3_solve_for_animation, true,Chng),
4487		call_cleanup(smt_solvers_interface:smt_solve_predicate_free(SolverName, Properties, ConstantsState),
4488		reset_temporary_preference(z3_solve_for_animation,Chng)).
4489
4490
4491		b_trace_test_components_full(LPProperties,ConstantsState,TypedVals) :-
4492		init_wait_flags_and_push_call_stack(no_wf_available,operation_call('SETUP_CONSTANTS',[],unknown),WF),
4493	?	b_trace_test_components_wf(LPProperties,ConstantsState,TypedVals,WF),
4494		ground_wait_flags(WF), % WF is just a dummy waitflag to pass call stack info
4495		(unsat_or_unknown_component_exists -> (!,fail) ; true). % otherwise some expressions were skipped; use partial_set_up
4496
4497		:- volatile project_properties_on_identifiers/1.
4498		:- dynamic project_properties_on_identifiers/1.
4499		set_projection_on_static_assertions(ALL) :-
4500		% set interpreter in mode which projects out all constants not needed
4501		% for static assertion checking; all variables are also projected out
4502		retractall(project_properties_on_identifiers(_)),
4503		(b_get_assertions(ALL,dynamic,[]) -> true
4504		; nl,print('*** WARNING: DYNAMIC B ASSERTIONS NOT EMPTY'),nl,nl),
4505	?	b_get_assertions(ALL,static,L),
4506		(L=[] -> nl,print('*** WARNING: NO STATIC B ASSERTIONS ***'),nl,nl ; true),
4507		conjunct_predicates(L,Conj),
4508		(debug_mode(on) -> print('Static Assertion: '),translate:print_bexpr(Conj),nl ; true),
4509		bsyntaxtree:predicate_identifiers(Conj,IDs),
4510		(debug_mode(on) -> print('IDS: '), print(IDs),nl ; true),
4511		assertz(project_properties_on_identifiers(IDs)).
4512
4513		% optionally project properties onto those required for checking assertions
4514		project_onto_static_assertions(Properties,Constants,NewProperties,NewConstants) :-
4515		%% set_projection_on_static_assertions(main), %% main or all %% set by probcli if we_need_only_static_assertions
4516		project_properties_on_identifiers(ProjIDs),
4517		bsyntaxtree:project_predicate_on_identifiers(Properties,ProjIDs,NewProperties,PIDs,_),
4518		sort(PIDs,SIPDs),
4519		debug_println(9,projecting(SIPDs)),
4520		include(keep_constant(SIPDs),Constants,NewConstants),!. % Constants is a typed identifier list.
4521		project_onto_static_assertions(Properties,Constants,Properties,Constants).
4522
4523		keep_constant(SIPDs,TypedID) :- get_texpr_id(TypedID,ID),ord_member(ID,SIPDs).
4524
4525
4526
4527		/* can be called if b_set_up_concrete_constants failed; will partially set up the state using values found in first ground value propagation phase */
4528		:- use_module(specfile,[get_specification_description/2]).
4529		b_partial_set_up_concrete_constants(NormalisedConstantsState) :-
4530		assert_unsat_component_infos(Status), % Status is false or unknown
4531		no_solution_found_for_constants,
4532		(b_partial_set_up_concrete_constants2(NormalisedConstantsState,Status)
4533		-> generate_unsat_properties_warnings
4534		; generate_unsat_properties_warnings,fail).
4535
4536		b_partial_set_up_concrete_constants2(NormalisedConstantsState,Status) :-
4537		b_get_machine_constants(Constants),
4538		Constants \= [],
4539	?	(det_solution_for_constant_was_stored(Cst1) -> true), % we have found a solution for at least one constant
4540		%set_up_typed_localstate(Constants,[],ConstantsState), -> can create call_residue due to typing fd/2 values
4541		findall(bind(ID,_),(member(TID,Constants),def_get_texpr_id(TID,ID)),ConstantsState),
4542		formatsilent('SETUP_CONSTANTS not successful, but solutions were found for some constants (e.g., ~w):~n',[Cst1]),
4543		(fill_in_det_solutions(ConstantsState,FC)
4544		-> All=all, TMSG = [')']
4545		; All=some, TMSG = [', e.g., ',Cst1,')']
4546		),
4547		(preference(allow_incomplete_partial_setup_constants,true)
4548		-> true
4549		; % fill_in_det_solutions will fail if not all constants valued and
4550		% if allow_incomplete_partial_setup_constants is false
4551		get_specification_description(properties,PS),
4552		% TO DO: determine if time-out occurred or not
4553		(Status=false
4554		-> ajoin([PS,' are unsatisfiable (but ',All,' CONSTANTS valued'|TMSG],Msg),
4555		add_error(setup_constants_inconsistent,Msg)
4556		; unsat_properties_abort_error(_)
4557		-> ajoin([PS,' are unknown due to well-definedness error(s) (but ',All,' CONSTANTS valued'|TMSG],Msg),
4558		add_error(setup_constants_unknown,Msg)
4559		; unsat_component_enumeration_warning(_)
4560		-> ajoin([PS,' are unknown due to enumeration warning(s) (but ',All,' CONSTANTS valued'|TMSG],Msg),
4561		add_error(setup_constants_unknown,Msg)
4562		; all_unsat_components_marked_prob_ignore
4563		-> ajoin([PS,' are unknown due to prob-ignore pragmas (but ',All,' CONSTANTS valued'|TMSG],Msg),
4564		add_message(setup_constants_unknown,Msg)
4565		;
4566		ajoin([PS,' are unknown (but ',All,' CONSTANTS valued'|TMSG],Msg),
4567		% typical message: but some CONSTANTS valued
4568		add_error(setup_constants_unknown,Msg)
4569		),
4570		All=all % only continue if all constants valued
4571		),
4572		normalise_store(FC,NormalisedConstantsState).
4573
4574
4575		:- use_module(store,[no_value_for_variable/2]).
4576		fill_in_det_solutions([],[]).
4577		fill_in_det_solutions([bind(Var,Val)|T],[bind(Var,FVal)|FT]) :-
4578		(det_solution_for_constant(Var,Val)
4579		-> (silent_mode(on) -> true ; write(' --det--> '),print_term_summary(bind(Var,Val))),
4580		FVal=Val
4581		; %format('No (deterministic) solution was found or stored for constant: ~w~n',[Var]), % message printed by det_solution_for_constant
4582		(preference(allow_incomplete_partial_setup_constants,true)
4583		-> no_value_for_variable(FVal,Var)
4584		; format('Aborting SETUP_CONSTANTS (set preference ALLOW_INCOMPLETE_SETUP_CONSTANTS to TRUE to allow ProB to proceed without having values for all CONSTANTS)~n',[]),
4585		fail
4586		)
4587		),
4588		fill_in_det_solutions(T,FT).
4589
4590
4591
4592		/* --------------------------------- */
4593
4594		:- use_module(b_state_model_check, [b_check_valid_state/1]).
4595
4596		% note: set_up_initialisation for CBC checks does not use this predicate
4597		b_initialise_machine(ConstantsState,NormalisedInitialVarsState,FullInitialState,Path) :-
4598	?	if(b_initialise_machine2(ConstantsState,NormalisedInitialVarsState,FullInitialState,Path),
4599		true,
4600		(\+ logged_error(initialisation_fails,_,_,_), % we have already provided a more precise error message
4601		\+ abort_error_exists_in_context_state(initialisation_fails), % ditto as a state error
4602		(bmachine:b_machine_temp_predicate(TempPred)
4603		-> add_message(initialisation_fails,'INITIALISATION FAILS with provided predicate: ',TempPred,TempPred)
4604		; b_get_initialisation_from_machine(Stmt,_OType)
4605		-> add_error(initialisation_fails,'INITIALISATION FAILS','',Stmt)
4606		; add_error(initialisation_fails,'MACHINE has no INITIALISATION clause')
4607		),
4608		fail)
4609		).
4610
4611		b_initialise_machine2(ConstantsState,NormalisedInitialVarsState,FullInitialState,Path) :-
4612		/* InitialVarsState is an ouput */
4613		b_get_initialisation_from_machine(InitStatement,OType),
4614		( InitStatement=[] ->
4615		Path = [],
4616		add_message(b_initialise_machine,'Machine has no INITIALISATION statement(s)!'),
4617		NormalisedInitialVarsState = [],
4618		FullInitialState = ConstantsState
4619		; OType == classic ->
4620		Path = [path(PathInfo)],
4621		b_get_machine_variables(DeclaredVars),
4622		set_up_undefined_localstate(DeclaredVars,ConstantsState,NewInState),
4623		/* this is if the INITIALISATION has a sequential composition; to avoid error messages */
4624		get_texpr_info(InitStatement,PosInfo),
4625		init_wait_flags_with_call_stack(WF,[operation_call('INITIALISATION',[],PosInfo)]),
4626		(bmachine:b_machine_temp_predicate(_)
4627		-> InitStatement2=InitStatement /* avoid enumerating each init statement in parallel in case additional guard links them */
4628		; translate_init_statements(InitStatement,InitStatement2)
4629		),
4630		check_additional_guard(true,InitialVarsState,ConstantsState,WF),
4631	?	b_execute_statement(InitStatement2,[],NewInState,InitialVarsState,WF,PathInfo),
4632		% Warning: in Z mode (e.g. test 565) the variable skeleton may not yet be set up !
4633		sort_variable_binding(InitialVarsState,NormalisedInitialVarsState),
4634		append(NormalisedInitialVarsState,ConstantsState,FullInitialState), % put constants at end to make sharing of complete tail-list easier for successor states; should be compatible with order in expand_const_and_vars
4635		split_names_and_types(DeclaredVars,DeclaredNames,DeclaredTypes),
4636	?	ground_wait_flags(WF),
4637
4638		b_enumerate_values_in_store(DeclaredNames,DeclaredTypes,_,InitialVarsState,WF) %% MOVED HERE TO AVOID that target values are enumerated before initialisation effect computed
4639		; OType = eventb_operation(_ChangeSet,ParaValues,_Operation) ->
4640		prepare_eventb_initialisation(ConstantsState,InitialVarsUnNormState,FullInitialUnNormState),
4641		get_texpr_expr(InitStatement,
4642		rlevent(_Name,_Sec,_Stat,Parameters,_Grd,_Thm,_Act,_VWit,_PWit,_Unmod,_AbsEv)),
4643	?	b_execute_event('initialisation',InitStatement,Parameters,ParaValues,ConstantsState,FullInitialUnNormState,Path),
4644		normalise_store(InitialVarsUnNormState,NormalisedInitialVarsState),
4645		normalise_store(FullInitialUnNormState,FullInitialState) % a bit of redundant work here; we do the work twice and try to normalise constants again !
4646		),
4647		b_check_valid_state(FullInitialState).
4648
4649		% ensure that the variables always appear in the same order as reported by b_get_machine_variables:
4650		% this is important for e.g., state_packing TO DO: we could sort them according to the variable names, but would there be a gain ??
4651		sort_variable_binding(Store,SortedStore) :- %print(sort_variable_binding(Store,SortedStore)),nl,
4652		b_get_machine_variables(Variables),
4653		sort_aux(Variables,Store,[],SortedStore).
4654		sort_aux([],S,Acc,NormRes) :- reverse(Acc,Res),
4655		normalise_store(Res,NormRes),
4656		(S=[] -> true ; add_internal_error('Unknown variable bindings: ',S)).
4657		sort_aux([TVar|T],Store,Acc,Res) :- def_get_texpr_id(TVar,ID),
4658		bselect(ID,Val,Store,Rest),
4659		sort_aux(T,Rest,[bind(ID,Val)|Acc],Res).
4660
4661		:- block bselect(?,?,-,?). % in Z mode (e.g. test 565) the variable skeleton may not yet be set up !
4662		bselect(ID,Val,[bind(ID1,Val1)|T],Rest) :- % we assume ID1 is nonvar
4663		(ID=ID1 -> Val=Val1,T=Rest
4664		; Rest = [bind(ID1,Val1)|RT],
4665		bselect(ID,Val,T,RT)).
4666
4667		prepare_eventb_initialisation(ConstantsState,InitialVarsState,FullInitialState) :-
4668		b_get_machine_variables(Variables),
4669		empty_state(Empty),
4670		set_up_typed_localstate(Variables,_,_,Empty,InitialVarsState,positive),
4671		% NormalisedInitialVarsState = InitialVarsState, % TO DO : check that b_event normalises this
4672		combine_updates(InitialVarsState,ConstantsState,FullInitialState).
4673		% put constants at end, to be compatible with b_initialise_machine2 and expand_const_and_vars order and e.g. ltsmin
4674
4675
4676
4677		reset_b_interpreter :-
4678		%reset_partial_evaluator,
4679		retractall(project_properties_on_identifiers(_)),
4680		reset_unsat_component_infos,
4681		retractall(no_solution_found_for_constants).
4682
4683		:- use_module(eventhandling,[register_event_listener/3]).
4684		:- register_event_listener(clear_specification,reset_b_interpreter,
4685		'Reset B-Interpreter Memo Table & Unsat Components.').