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