1		% (c) 2012-2025 Lehrstuhl fuer Softwaretechnik und Programmiersprachen,
2		% Heinrich Heine Universitaet Duesseldorf
3		% This software is licenced under EPL 1.0 (http://www.eclipse.org/org/documents/epl-v10.html)
4
5		:- module(external_functions,[call_external_function/7, call_external_predicate/8,
6		call_external_substitution/6,
7		reset_external_functions/0,
8		print_external_function_instantiation_profile/0,
9		external_pred_always_true/1,
10		reset_side_effect_occurred/0,
11		side_effect_occurred/1,
12		performs_io/1, not_declarative/1,
13		is_external_function_name/1,
14		get_external_function_type/3, % version with types with Prolog variables
15		external_fun_type/3,
16		external_subst_enabling_condition/3,
17		external_fun_has_wd_condition/1,
18		external_fun_can_be_inverted/1,
19		external_function_requires_state/1,
20		expects_unevaluated_args/1,
21		do_not_evaluate_args/1,
22		reset_argv/0, set_argv_from_list/1, set_argv_from_atom/1,
23		set_current_state_for_external_fun/1, clear_state_for_external_fun/0,
24
25		observe_parameters/2, observe_state/1, observe_value/2
26		]).
27
28		% Note: there is also the predicate external_procedure_used/1 in bmachine_construction
29
30		:- use_module(error_manager).
31		:- use_module(self_check).
32		:- use_module(library(avl)).
33		:- use_module(library(lists)).
34		:- use_module(translate).
35
36		% TO DO: add external Prolog files
37		% Should we do auto-conversion of B to Prolog types ,... ?
38
39		:- use_module(kernel_waitflags).
40		:- use_module(debug).
41		:- use_module(bsyntaxtree).
42		:- use_module(custom_explicit_sets).
43
44		:- use_module(module_information,[module_info/2]).
45		:- module_info(group,external_functions).
46		:- module_info(description,'This module provides a way to call external functions and predicates.').
47
48		:- set_prolog_flag(double_quotes, codes).
49
50		:- dynamic side_effect_occurred/1.
51		% TRUE if a side effect has occured
52		% possible values (user_output, file)
53		reset_side_effect_occurred :- (retract(side_effect_occurred(_)) -> retractall(side_effect_occurred(_)) ; true).
54		assert_side_effect_occurred(Location) :-
55		(side_effect_occurred(Location) -> true ; assertz(side_effect_occurred(Location))).
56
57		:- discontiguous expects_waitflag/1.
58		:- discontiguous expects_spaninfo/1.
59		:- discontiguous expects_type/1. % only used for external functions, not predicates or subst
60		:- discontiguous performs_io/1.
61		:- discontiguous is_not_declarative/1. % does not perform io but is still not declarative, e.g., has hidden args
62		:- discontiguous does_not_modify_state/1.
63		:- discontiguous expects_unevaluated_args/1.
64		:- discontiguous do_not_evaluate_args/1. % currently only used for external predicates, not for functions
65		:- discontiguous expects_state/1. % currently only used for external predicates
66		:- discontiguous external_pred_always_true/1. % external predicates which are always true
67		:- discontiguous external_subst_enabling_condition/3. % external predicates which are always true
68		:- discontiguous external_fun_has_wd_condition/1.
69		:- discontiguous external_fun_can_be_inverted/1.
70		:- discontiguous external_function_requires_state/1. % true if the function/predicate works on the current state in the state space
71		:- discontiguous external_fun_type/3. % external_fun_type(FUN,ListOfTypeParameters,ListOfArgTypes); also applicable to external predicates
72
73		:- meta_predicate safe_call(0,-,-).
74		:- meta_predicate safe_call(0,-).
75
76		:- meta_predicate observe_ground(-,-,-,-,-,0).
77
78		not_declarative(FunName) :- if(performs_io(FunName),true,is_not_declarative(FunName)).
79
80		is_external_function_name(Name) :- if(external_fun_type(Name,_,_),true,
81		if(expects_waitflag(Name),true,
82		if(expects_spaninfo(Name),true,
83		if(external_subst_enabling_condition(Name,_,_),true,
84		if(not_declarative(Name),true,
85		if(expects_unevaluated_args(Name),true,fail)
86		))))).
87
88
89		:- use_module(state_space,[current_state_id/1, get_current_context_state/1]).
90		:- dynamic current_state_id_for_external_fun/1.
91		% some external functions access the current state; here we can set a particular state, without changing the animator/state_space
92		% useful, e.g., when exporting a VisB HTML trace when the JSON glue file uses ENABLED
93		% TODO: some commands also access the history;
94
95		% we use this rather than set_context_state because this would lead to errors being stored in the state_space
96		set_current_state_for_external_fun(ID) :-
97		asserta(current_state_id_for_external_fun(ID)).
98
99		clear_state_for_external_fun :-
100		(retract(current_state_id_for_external_fun(_)) -> true ; format('No state for external functions stored!~n',[])).
101
102		get_current_state_id(ID) :-
103		(current_state_id_for_external_fun(CID) -> ID=CID
104		; state_space:get_current_context_state(CID) -> ID=CID
105		; current_state_id(ID)).
106
107		% get current history without root (and without current state id)
108		get_current_history(History,Span) :-
109		history(RH),!,
110		(state_space:get_current_context_state(CID),
111		(current_state_id(CID)
112		-> RH=[Last|_], \+ state_space:transition(Last,CID,_) % something wrong, this cannot be last state of history
113		; true % the history was not made for context state CID
114		),
115		append(_,[CID|RH2],RH) % stop at CID which is being set; not a perfect solution; CID could occur multiple times!
116		-> true
117		; RH2=RH),
118		(RH2=[] -> History=[]
119		; reverse(RH2,[root|HH]) -> History = HH
120		; add_message(external_functions,'HISTORY does not start with root:',RH2,Span), % from ProB2: fix
121		reverse(RH2,History)
122		).
123		get_current_history(History,Span) :- add_message(external_functions,'No HISTORY available','',Span), History=[].
124
125		:- use_module(runtime_profiler,[profile_single_call/4]).
126
127		:- assert_must_succeed(( external_functions:call_external_function('COS',[b(integer(0),integer,[])],
128		[int(0)],int(100),integer,unknown,_WF) )).
129		:- assert_must_succeed(( external_functions:call_external_function('SIN',[b(integer(0),integer,[])],
130		[int(0)],int(0),integer,unknown,_WF) )).
131		% first a few hard-wired external functions for efficiency:
132		call_external_function('COS',_,[X],Value,_,_,_WF) :- !, 'COS'(X,Value). % already use safe_is
133		call_external_function('SIN',_,[X],Value,_,_,_WF) :- !, 'SIN'(X,Value).
134		call_external_function('TAN',_,[X],Value,_,_,_WF) :- !, 'TAN'(X,Value).
135		%call_external_function('STRING_APPEND',_,[A,B],Value,_,_,WF) :- !, 'STRING_APPEND'(A,B,Value,WF). % do we need safe_call?
136		%call_external_function('STRING_LENGTH',_,[A],Value,_,_,_WF) :- !, 'STRING_LENGTH'(A,Value).
137		% now the generic case:
138		call_external_function(F,Args,EvaluatedArgs,Value,Type,SpanInfo,WF) :-
139		(expects_waitflag(F)
140		-> E1=[WF],
141		(expects_spaninfo(F) -> E2=[SpanInfo|E1] ; E2=E1)
142		; E1=[],
143		(expects_spaninfo(F) -> add_call_stack_to_span(SpanInfo,WF,S2), E2=[S2|E1] ; E2=E1)
144		),
145		(expects_unevaluated_args(F) -> E3=[Args|E2] ; E3=E2),
146		(expects_type(F) -> E4=[Type|E3] ; E4=E3),
147		append(EvaluatedArgs,[Value|E4],AV),
148		% Check if there is better way to do this
149		Call =.. [F|AV],
150		% print('EXTERNAL FUNCTION CALL: '), print(F), print(' '), print(Call),nl,
151		% we could pass get_current_state_id(.) instead of unknown
152		profile_single_call(F,external_functions,unknown,safe_call(Call,SpanInfo,WF))
153		%, print(result(Value)),nl.
154		.
155
156		call_external_predicate(F,Args,EvaluatedArgs,LocalState,State,PREDRES,SpanInfo,WF) :-
157		(expects_waitflag(F)
158		-> E1=[WF],
159		(expects_spaninfo(F) -> E2=[SpanInfo|E1] ; E2=E1)
160		; E1=[],
161		(expects_spaninfo(F) -> add_call_stack_to_span(SpanInfo,WF,S2), E2=[S2|E1] ; E2=E1)
162		),
163		(expects_unevaluated_args(F) -> E3=[Args|E2] ; E3=E2),
164		(expects_state(F) -> E4=[LocalState,State|E3] ; E4=E3),
165		append(EvaluatedArgs,[PREDRES|E4],AV),
166		Call =.. [F|AV],
167		% print('EXTERNAL PREDICATE CALL: '), print(Call),nl, %%
168		profile_single_call(F,external_functions,unknown,safe_call(Call,SpanInfo,WF)).
169
170		call_external_substitution(FunName,Args,InState,OutState,Info,WF) :-
171		% TO DO: signal if substitution can be backtracked
172		get_wait_flag_for_subst(FunName,WF,Flag),
173		(does_not_modify_state(FunName) -> OutState=[] ; OutState = OutState2),
174		call_external_substitution2(Flag,FunName,Args,InState,OutState2,Info,WF).
175
176		get_wait_flag_for_subst(FunName,WF,Flag) :- perform_directly(FunName),!,
177		get_wait_flag1(WF,Flag). % ensure that precondition, ... have been evaluated
178		get_wait_flag_for_subst(FunName,WF,Flag) :- performs_io(FunName),!,
179		get_enumeration_finished_wait_flag(WF,Flag). % ensure that precondition, ... have been evaluated
180		% get_enumeration_starting_wait_flag(external(FunName),WF,Flag).
181		get_wait_flag_for_subst(FunName,WF,Flag) :- get_binary_choice_wait_flag(external(FunName),WF,Flag).
182
183		:- block call_external_substitution2(-,?,?,?,?,?,?).
184		call_external_substitution2(_,F,Args,InState,OutState,SpanInfo,WF) :-
185		(expects_waitflag(F) -> E1=[WF] ; E1=[]),
186		(expects_spaninfo(F) -> E2=[SpanInfo|E1] ; E2=E1),
187		append(Args,[InState,OutState|E2],AV),
188		Call =.. [F|AV],
189		% print('EXTERNAL SUBSTITUTION CALL: '), print(Call),nl, %%
190		profile_single_call(F,external_functions,unknown,safe_call(Call,SpanInfo,WF)).
191
192		safe_call(X,SpanInfo) :- safe_call(X,SpanInfo,no_wf_available).
193		safe_call(X,SpanInfo,WF) :-
194		catch(call(X), Exception, add_exception_error(Exception,X,SpanInfo,WF)).
195
196		safe_is(Context,X,Y,Span) :- safe_is(Context,X,Y,Span,no_wf_available).
197		safe_is(Context,X,Y,Span,WF) :- % print(safe_is(Context,X,Y)),nl,
198		catch(X is Y, Exception, add_exception_error(Exception,Context,Span,WF)). %, print(res(X)),nl.
199
200		add_exception_error(Exception,Context,Span,WF) :-
201		get_function_call_info(Context,SimplifiedContext),
202		add_exception_error2(Exception,SimplifiedContext,Span,WF),
203		(debug:debug_mode(on) -> tools_printing:print_term_summary(Context),nl ; true).
204
205		get_function_call_info(external_functions:X,Func) :- nonvar(X),!,functor(X,Func,_Arity).
206		get_function_call_info(M:X,M:Func) :- nonvar(X),!,functor(X,Func,_Arity).
207		get_function_call_info(X,X).
208
209		:- use_module(kernel_waitflags,[add_error_wf/5, add_warning_wf/5,add_wd_error_span/4]).
210		add_exception_error2(error(existence_error(procedure,external_functions:FUN),_),_X,SpanInfo,WF) :- !,
211		add_error_wf(external_functions,
212		'EXTERNAL function does not exist (check that you have an up-to-date version of ProB):',FUN,SpanInfo,WF),
213		fail.
214		add_exception_error2(error(existence_error(procedure,MODULE:FUN),_),_X,SpanInfo,WF) :- !,
215		add_error_wf(external_functions,'Predicate called by EXTERNAL function does not exist:',MODULE:FUN,SpanInfo,WF),
216		fail.
217		add_exception_error2(error(undefined,ERR),X,SpanInfo,WF) :-
218		is_error(ERR,ExprTerm),!,
219		ajoin(['Arithmetic operation ',X,' not defined:'],Msg),
220		add_error_wf(external_functions,Msg,ExprTerm,SpanInfo,WF),
221		fail.
222		add_exception_error2(error(evaluation_error(undefined),ERR),X,SpanInfo,WF) :-
223		is_error(ERR,ExprTerm),!,
224		ajoin(['Arithmetic operation ',X,' not defined for given argument(s):'],Msg),
225		add_wd_error_span(Msg,ExprTerm,SpanInfo,WF).
226		add_exception_error2(error(evaluation_error(zero_divisor),ERR),X,SpanInfo,WF) :-
227		is_error(ERR,_),!,
228		% TO DO: use add_wd_error_set_result:
229		add_wd_error_span('Division by 0 in arithmetic operation: ',X,SpanInfo,WF).
230		add_exception_error2(error(existence_error(source_sink,File),Err2),X,SpanInfo,WF) :- !,
231		(arg(1,Err2,Call), get_file_open_mode(Call,append)
232		-> ajoin(['File does not exist and cannot be created (calling external function ',X,'):'],Msg)
233		; arg(1,Err2,Call), get_file_open_mode(Call,write)
234		-> ajoin(['File cannot be created (calling external function ',X,'):'],Msg)
235		; ajoin(['File does not exist (calling external function ',X,'):'],Msg)
236		),
237		add_error_wf(external_functions,Msg,File,SpanInfo,WF),
238		fail.
239		add_exception_error2(error(consistency_error(Msg,_,format_arguments),_),_X,SpanInfo,WF) :- !,
240		add_error_wf(external_functions,'Illegal format string (see SICStus Prolog reference manual for syntax):',Msg,SpanInfo,WF),
241		fail.
242		add_exception_error2(enumeration_warning(A,B,C,D,E),X,SpanInfo,WF) :-
243		Exception = enumeration_warning(A,B,C,D,E),!,
244		debug_println(20,Exception),
245		get_predicate_name(X,Pred),
246		add_warning_wf(external_functions,'Enumeration warning occured while calling external function: ',Pred,SpanInfo,WF),
247		% or should we just print a message on the console ?
248		% or use
249		throw(Exception).
250		add_exception_error2(user_interrupt_signal,X,SpanInfo,WF) :- !,
251		get_predicate_name(X,Pred),
252		add_warning_wf(external_functions,'User Interrupt during external function evaluation: ',Pred,SpanInfo,WF),
253		throw(user_interrupt_signal).
254		add_exception_error2(Exception,X,SpanInfo,WF) :-
255		debug_println(20,Exception),
256		ajoin(['Exception occurred while calling external function ',X,':'],Msg),
257		add_error_wf(external_functions,Msg,Exception,SpanInfo,WF),
258		fail.
259
260		% get file open mode from a SICStus library call (e.g., that caused an existence_error exception)
261		get_file_open_mode(open(_File,Mode,_,_),Mode).
262		get_file_open_mode(open(_File,Mode,_),Mode).
263
264		get_predicate_name(Var,P) :- var(Var),!,P='_VAR_'.
265		get_predicate_name(external_functions:C,P) :- !, get_predicate_name(C,P).
266		get_predicate_name(Module:C,Module:P) :- !, get_predicate_name(C,P).
267		get_predicate_name(Call,F/P) :- functor(Call,F,P).
268
269		is_error(evaluation_error('is'(_,ExprTerm),2,_,_),ExprTerm).
270		is_error(domain_error('is'(_,ExprTerm),2,_,_),ExprTerm).
271
272		get_external_function_type(FunName,ArgTypes,ReturnType) :-
273		external_fun_type(FunName,TypeParas,AllTypes),
274		(member(TP,TypeParas),nonvar(TP)
275		-> add_internal_error('External function type parameter not a variable:,',
276		external_fun_type(FunName,TypeParas,AllTypes))
277		; true
278		),
279		append(ArgTypes,[ReturnType],AllTypes).
280
281		% STANDARD EXTERNAL FUNCTIONS
282
283
284		% -------------------------------
285
286
287		:- use_module(extrasrc(external_functions_reals)). % removed explicit imports for Spider
288
289
290		expects_waitflag('STRING_TO_REAL').
291		external_fun_type('STRING_TO_REAL',[],[string,real]).
292
293		expects_waitflag('RADD').
294		external_fun_type('RADD',[],[real,real,real]).
295		expects_waitflag('RSUB').
296		external_fun_type('RSUB',[],[real,real,real]).
297		expects_waitflag('RMUL').
298		external_fun_type('RMUL',[],[real,real,real]).
299		expects_waitflag('RDIV').
300		expects_spaninfo('RDIV').
301		external_fun_type('RDIV',[],[real,real,real]).
302		external_fun_has_wd_condition('RDIV').
303		expects_waitflag('RINV').
304		expects_spaninfo('RINV').
305		external_fun_type('RINV',[],[real,real]).
306		external_fun_has_wd_condition('RINV').
307
308		external_fun_type('RPI',[],[real]).
309		external_fun_type('RZERO',[],[real]).
310		external_fun_type('RONE',[],[real]).
311		external_fun_type('REULER',[],[real]).
312		external_fun_type('REPSILON',[],[real]).
313		external_fun_type('RMAXFLOAT',[],[real]).
314
315		external_fun_type('RSIN',[],[real,real]).
316		expects_waitflag('RSIN').
317		external_fun_type('RCOS',[],[real,real]).
318		expects_waitflag('RCOS').
319		external_fun_type('RTAN',[],[real,real]).
320		expects_waitflag('RTAN').
321		external_fun_type('RCOT',[],[real,real]).
322		expects_waitflag('RCOT').
323		external_fun_type('RSINH',[],[real,real]).
324		expects_waitflag('RSINH').
325		external_fun_type('RCOSH',[],[real,real]).
326		expects_waitflag('RCOSH').
327		external_fun_type('RTANH',[],[real,real]).
328		expects_waitflag('RTANH').
329		external_fun_type('RCOTH',[],[real,real]).
330		expects_waitflag('RCOTH').
331		external_fun_type('RASIN',[],[real,real]).
332		expects_waitflag('RASIN').
333		external_fun_type('RACOS',[],[real,real]).
334		expects_waitflag('RACOS').
335		external_fun_type('RATAN',[],[real,real]).
336		expects_waitflag('RATAN').
337		external_fun_type('RACOT',[],[real,real]).
338		expects_waitflag('RACOT').
339		external_fun_type('RASINH',[],[real,real]).
340		expects_waitflag('RASINH').
341		external_fun_type('RACOSH',[],[real,real]).
342		expects_waitflag('RACOSH').
343		external_fun_type('RATANH',[],[real,real]).
344		expects_waitflag('RATANH').
345		external_fun_type('RACOTH',[],[real,real]).
346		expects_waitflag('RACOTH').
347		external_fun_type('RATAN2',[],[real,real,real]).
348		expects_waitflag('RATAN2').
349		expects_spaninfo('RATAN2').
350		external_fun_type('RHYPOT',[],[real,real,real]).
351		expects_waitflag('RHYPOT').
352		expects_spaninfo('RHYPOT').
353		external_fun_type('RADIANS',[],[real,real]).
354		expects_waitflag('RADIANS').
355		expects_spaninfo('RADIANS').
356		external_fun_type('DEGREE',[],[real,real]).
357		expects_waitflag('DEGREE').
358		expects_spaninfo('DEGREE').
359
360
361		external_fun_type('RUMINUS',[],[real,real]).
362		expects_waitflag('RUMINUS').
363		external_fun_type('REXP',[],[real,real]).
364		expects_waitflag('REXP').
365		external_fun_type('RLOGe',[],[real,real]).
366		expects_waitflag('RLOGe').
367		expects_spaninfo('RLOGe').
368		external_fun_has_wd_condition('RLOGe').
369		external_fun_type('RSQRT',[],[real,real]).
370		expects_waitflag('RSQRT').
371		expects_spaninfo('RSQRT').
372		external_fun_has_wd_condition('RSQRT'). % for negative numbers obviously
373		external_fun_type('RABS',[],[real,real]).
374		expects_waitflag('RABS').
375		external_fun_type('ROUND',[],[real,integer]).
376		expects_waitflag('ROUND').
377		external_fun_type('RSIGN',[],[real,real]).
378		expects_waitflag('RSIGN').
379		external_fun_type('RINTEGER',[],[real,real]).
380		expects_waitflag('RINTEGER').
381		external_fun_type('RFRACTION',[],[real,real]).
382		expects_waitflag('RFRACTION').
383
384		expects_waitflag('RMAX').
385		expects_spaninfo('RMAX').
386		external_fun_type('RMAX',[],[real,real,real]).
387		expects_waitflag('RMIN').
388		expects_spaninfo('RMIN').
389		external_fun_type('RMIN',[],[real,real,real]).
390		expects_spaninfo('RPOW').
391		expects_waitflag('RPOW').
392		external_fun_type('RPOW',[],[real,real,real]).
393		external_fun_has_wd_condition('RPOW'). % for negative numbers, e.g., RPOW(-1.0,1.1) or RPOW(-1.0,0.5)
394		expects_spaninfo('RDECIMAL').
395		expects_waitflag('RDECIMAL').
396		external_fun_type('RDECIMAL',[],[integer,integer,real]).
397		expects_waitflag('RLOG').
398		expects_spaninfo('RLOG').
399		external_fun_type('RLOG',[],[real,real,real]).
400		external_fun_has_wd_condition('RLOG').
401
402		expects_waitflag('RLT').
403		external_fun_type('RLT',[],[real,real,boolean]).
404		expects_waitflag('REQ').
405		external_fun_type('REQ',[],[real,real,boolean]).
406		expects_waitflag('RNEQ').
407		external_fun_type('RNEQ',[],[real,real,boolean]).
408		expects_waitflag('RLEQ').
409		external_fun_type('RLEQ',[],[real,real,boolean]).
410		expects_waitflag('RGT').
411		external_fun_type('RGT',[],[real,real,boolean]).
412		expects_waitflag('RGEQ').
413		external_fun_type('RGEQ',[],[real,real,boolean]).
414		expects_waitflag('RMAXIMUM').
415		expects_spaninfo('RMAXIMUM').
416		external_fun_type('RMAXIMUM',[],[set(real),real]).
417		external_fun_has_wd_condition('RMAXIMUM'). % empty set or unbounded set
418		expects_waitflag('RMINIMUM').
419		expects_spaninfo('RMINIMUM').
420		external_fun_type('RMINIMUM',[],[set(real),real]).
421		external_fun_has_wd_condition('RMINIMUM'). % empty set or unbounded set
422
423		external_fun_type('RNEXT',[],[real,real]).
424		external_fun_type('RPREV',[],[real,real]).
425
426
427		% -------------------------------
428
429		external_fun_type('SFADD16',[],[real,real,real]).
430		external_fun_type('SFSUB16',[],[real,real,real]).
431		external_fun_type('SFMUL16',[],[real,real,real]).
432		external_fun_type('SFDIV16',[],[real,real,real]).
433		external_fun_type('SFSQRT16',[],[real,real]).
434		external_fun_type('SFMULADD16',[],[real,real,real,real]).
435		external_fun_type('SFADD32',[],[real,real,real]).
436		external_fun_type('SFSUB32',[],[real,real,real]).
437		external_fun_type('SFMUL32',[],[real,real,real]).
438		external_fun_type('SFDIV32',[],[real,real,real]).
439		external_fun_type('SFSQRT32',[],[real,real]).
440		external_fun_type('SFMULADD32',[],[real,real,real,real]).
441		external_fun_type('SFADD64',[],[real,real,real]).
442		external_fun_type('SFSUB64',[],[real,real,real]).
443		external_fun_type('SFMUL64',[],[real,real,real]).
444		external_fun_type('SFDIV64',[],[real,real,real]).
445		external_fun_type('SFSQRT64',[],[real,real]).
446		external_fun_type('SFMULADD64',[],[real,real,real,real]).
447		external_fun_type('SFADD80',[],[couple(int,int),couple(int,int),couple(int,int)]).
448		external_fun_type('SFSUB80',[],[couple(int,int),couple(int,int),couple(int,int)]).
449		external_fun_type('SFMUL80',[],[couple(int,int),couple(int,int),couple(int,int)]).
450		external_fun_type('SFDIV80',[],[couple(int,int),couple(int,int),couple(int,int)]).
451		external_fun_type('SFSQRT80',[],[couple(int,int),couple(int,int)]).
452		external_fun_type('SFADD128',[],[couple(int,int),couple(int,int),couple(int,int)]).
453		external_fun_type('SFSUB128',[],[couple(int,int),couple(int,int),couple(int,int)]).
454		external_fun_type('SFMUL128',[],[couple(int,int),couple(int,int),couple(int,int)]).
455		external_fun_type('SFDIV128',[],[couple(int,int),couple(int,int),couple(int,int)]).
456		external_fun_type('SFSQRT128',[],[couple(int,int),couple(int,int)]).
457		external_fun_type('SFMULADD128',[],[couple(int,int),couple(int,int),couple(int,int),couple(int,int)]).
458
459		% -------------------------------
460
461		:- use_module(extrasrc(external_functions_svg)). %, [svg_points/4, svg_train/8, svg_car/8, svg_axis/7, svg_set_polygon/7]).
462
463		expects_waitflag('svg_points').
464		expects_spaninfo('svg_points').
465		external_fun_type('svg_points',[T1,T2],[seq(couple(T1,T2)),string]). % T1, T2 should be numbers
466
467		expects_waitflag('svg_train').
468		expects_spaninfo('svg_train').
469		external_fun_type('svg_train',[T1,T2],[T1,T1,T2,T2,T2,string]). % T1, T2 should be numbers
470		expects_waitflag('svg_car').
471		expects_spaninfo('svg_car').
472		external_fun_type('svg_car',[T1,T2],[T1,T1,T2,T2,T2,string]). % T1, T2 should be numbers
473
474		expects_waitflag('svg_axis').
475		expects_spaninfo('svg_axis').
476		external_fun_type('svg_axis',[T1,T2],[set(T1),T2,T2,T2,string]). % T1, T2 should be numbers
477
478		expects_waitflag('svg_set_polygon').
479		expects_spaninfo('svg_set_polygon').
480		external_fun_type('svg_set_polygon',[T2],[set(integer),T2,T2,T2,string]). % T2 should be number type
481
482		expects_waitflag('svg_set_polygon_auto').
483		expects_spaninfo('svg_set_polygon_auto').
484		external_fun_type('svg_set_polygon_auto',[T2],[set(integer),T2,T2,string]). % T2 should be number type
485
486		expects_waitflag('svg_dasharray_for_intervals').
487		expects_spaninfo('svg_dasharray_for_intervals').
488		external_fun_type('svg_dasharray_for_intervals',[T1,T2],[set(couple(T1,T2)),string]). % T1, T2 should be numbers
489
490		expects_waitflag('svg_set_dasharray').
491		expects_spaninfo('svg_set_dasharray').
492		external_fun_type('svg_set_dasharray',[],[set(integer),string]).
493
494		% -------------------------------
495
496		% MATHEMATICAL FUNCTIONS
497
498		external_fun_type('COS',[],[integer,integer]).
499		:- public 'COS'/2.
500		:- block 'COS'(-,?). % redundant; we could add CLPFD constraints for R
501		'COS'(int(X),int(R)) :- cos2(100,X,R,unknown).
502		external_fun_type('COSx',[],[integer,integer,integer]).
503		expects_spaninfo('COSx').
504		:- public 'COSx'/4.
505		:- block 'COSx'(-,?,?,?),'COSx'(?,-,?,?).
506		'COSx'(int(PrecisionMultiplier),int(X),int(R),Span) :- cos2(PrecisionMultiplier,X,R,Span).
507		:- block cos2(-,?,?,?),cos2(?,-,?,?).
508		cos2(Multiplier,X,R,Span) :- safe_is('COSx',R,round(Multiplier*cos(X/Multiplier)),Span).
509
510		external_fun_type('SIN',[],[integer,integer]).
511		:- public 'SIN'/2.
512		:- block 'SIN'(-,?). % redundant; we could add CLPFD constraints for R
513		'SIN'(int(X),int(R)) :- sin2(100,X,R,unknown).
514		external_fun_type('SINx',[],[integer,integer,integer]).
515		expects_spaninfo('SINx').
516		:- public 'SINx'/4.
517		:- block 'SINx'(-,?,?,?),'SINx'(?,-,?,?).
518		'SINx'(int(PrecisionMultiplier),int(X),int(R),Span) :- %print('SINx'(PrecisionMultiplier,X,R)),nl,
519		sin2(PrecisionMultiplier,X,R,Span).
520		:- block sin2(-,?,?,?),sin2(?,-,?,?).
521		sin2(Multiplier,X,R,Span) :- safe_is('SINx',R,round(Multiplier*sin(X/Multiplier)),Span).
522
523		external_fun_type('TAN',[],[integer,integer]).
524		:- public 'TAN'/2.
525		:- block 'TAN'(-,?). % redundant; we could add CLPFD constraints for R
526		'TAN'(int(X),int(R)) :- tan2(100,X,R,unknown).
527		external_fun_type('TANx',[],[integer,integer,integer]).
528		expects_spaninfo('TANx').
529		:- public 'TANx'/4.
530		:- block 'TANx'(-,?,?,?),'TANx'(?,-,?,?).
531		'TANx'(int(PrecisionMultiplier),int(X),int(R),Span) :- tan2(PrecisionMultiplier,X,R,Span).
532		:- block tan2(?,-,?,?),tan2(-,?,?,?).
533		tan2(Multiplier,X,R,Span) :- safe_is('TANx',R,round(Multiplier*tan(X/Multiplier)),Span).
534
535
536		external_fun_type('PROLOG_FUN',[],[string,integer,integer,integer]).
537		external_fun_has_wd_condition('PROLOG_FUN').
538		expects_spaninfo('PROLOG_FUN').
539		:- public 'PROLOG_FUN'/5.
540		'PROLOG_FUN'(string(Function),int(PrecisionMultiplier),int(Argument),int(Result),Span) :-
541		prolog_fun2(Function,PrecisionMultiplier,Argument,Result,Span).
542		% Function can be:
543		% sin, cos, tan, cot, sinh, cosh, tanh, asin, acos, atan, acot, asinh, acosh, atanh, acoth, sqrt, log, exp
544		:- block prolog_fun2(?,-,?,?,?),prolog_fun2(-,?,?,?,?), prolog_fun2(?,?,-,?,?).
545		prolog_fun2(Function,Multiplier,X,R,Span) :-
546		E =.. [Function,X/Multiplier],
547		safe_is(Function,R,round(Multiplier*E),Span).
548
549		external_fun_has_wd_condition('LOGx').
550		expects_spaninfo('LOGx').
551		external_fun_type('LOGx',[],[integer,integer,integer,integer]).
552		:- public 'LOGx'/5.
553		:- block 'LOGx'(-,?,?,?,?),'LOGx'(?,-,?,?,?), 'LOGx'(?,?,-,?,?).
554		'LOGx'(int(PrecisionMultiplier),int(Base),int(X),int(R),Span) :-
555		log2(PrecisionMultiplier,Base,X,R,Span).
556		:- block log2(?,-,?,?,?),log2(-,?,?,?,?),log2(?,?,-,?,?).
557		log2(Multiplier,Base,X,R,Span) :-
558		logx_internal(Multiplier,Base,X,R,Span).
559
560		:- use_module(tools_portability, [check_arithmetic_function/1]).
561		:- if(check_arithmetic_function(log(2, 4))).
562		% Native log(Base, Power) function is available - use it.
563		logx_internal(Multiplier,Base,X,R,Span) :-
564		safe_is('LOGx',R,round(Multiplier*log(Base/Multiplier,X/Multiplier)),Span).
565		:- else.
566		% No native log(Base, Power) support, so construct it using natural logarithms.
567		logx_internal(Multiplier,Base,X,R,Span) :-
568		safe_is('LOGx',R,round(Multiplier*(log(X/Multiplier)/log(Base/Multiplier))),Span).
569		:- endif.
570
571		:- use_module(clpfd_interface,[clpfd_gcd/3, clpfd_lcm/3, clpfd_abs/2, clpfd_sign/2]).
572		external_fun_type('GCD',[],[integer,integer,integer]).
573		:- public 'GCD'/3.
574		:- block 'GCD'(-,-,-).
575		'GCD'(int(X),int(Y),int(R)) :-
576		clpfd_gcd(X,Y,R).
577
578		% least / smallest common multiple
579		external_fun_type('LCM',[],[integer,integer,integer]).
580		:- public 'LCM'/3.
581		:- block 'LCM'(-,-,-).
582		'LCM'(int(X),int(Y),int(R)) :- clpfd_lcm(X,Y,R).
583
584		external_fun_type('ABS',[],[integer,integer]).
585		external_fun_can_be_inverted('ABS'). % there are two possible input values for an output value
586		:- public 'ABS'/2.
587		:- block 'ABS'(-,-). % do we need this ??
588		'ABS'(int(X),int(R)) :-
589		clpfd_abs(X,R).
590
591		external_fun_type('SIGN',[],[integer,integer]).
592		:- public 'SIGN'/2.
593		:- block 'SIGN'(-,-).
594		'SIGN'(int(X),int(R)) :-
595		clpfd_sign(X,R).
596
597
598		% TLA style floored division
599		external_fun_has_wd_condition('FDIV').
600		expects_spaninfo('FDIV').
601		expects_waitflag('FDIV').
602		external_fun_type('FDIV',[],[integer,integer,integer]).
603		:- public 'FDIV'/5.
604		:- block 'FDIV'(-,-,-,?,?).
605		'FDIV'(X,Y,Z,Span,WF) :-
606		kernel_objects:floored_division(X,Y,Z,Span,WF).
607
608		% ceiling division
609		external_fun_has_wd_condition('CDIV').
610		expects_spaninfo('CDIV').
611		expects_waitflag('CDIV').
612		external_fun_type('CDIV',[],[integer,integer,integer]).
613		:- public 'CDIV'/5.
614		:- block 'CDIV'(-,?,?,?,?),'CDIV'(?,-,?,?,?).
615		'CDIV'(int(X),int(Y),Res,Span,WF) :-
616		ceiling_division(X,Y,Res,Span,WF).
617
618		:- block ceiling_division(-,?,?,?,?),ceiling_division(?,-,?,?,?).
619		ceiling_division(X,Y,_Res,Span,WF) :- Y=0,!,
620		add_wd_error_span('Ceiling division by zero:',X,Span,WF).
621		ceiling_division(X,Y,Res,_Span,_WF) :-
622		X mod Y =:= 0,!,
623		XY is X//Y, Res = int(XY).
624		ceiling_division(X,Y,Res,Span,WF) :-
625		kernel_objects:floored_division(int(X),int(Y),int(Z),Span,WF),
626		Z1 is 1 + Z,
627		Res = int(Z1).
628
629		external_fun_has_wd_condition('SQRT').
630		expects_spaninfo('SQRT').
631		expects_waitflag('SQRT').
632		external_fun_type('SQRT',[],[integer,integer]).
633		%external_fun_can_be_inverted('SQRT'). % TODO : comment in after fixing TODOs below
634		:- public 'SQRT'/4.
635		:- block 'SQRT'(-,?,?,?).
636		'SQRT'(int(X),R,Span,WF) :-
637		positive_integer_sqrt(X,R,Span,WF). % TO DO: maybe do CLPFD propagation?
638		% TODO: backwards propagation from R to X; if X=2 -> X=+/-4,5,6,7,8
639
640		:- block positive_integer_sqrt(-,?,?,?).
641		positive_integer_sqrt(X,_,Span,WF) :- X<0,!,
642		add_wd_error_span('Trying to compute square root of negative number:',X,Span,WF).
643		positive_integer_sqrt(X,Res,Span,_WF) :-
644		Candidate is floor(sqrt(X)), % compute using floating number function
645		(Candidate*Candidate =< X
646		-> C1 is Candidate+1,
647		(C1*C1 > X
648		-> Res = int(Candidate)
649		; (C1+1)*(C1+1) > X
650		-> Res = int(C1)
651		; % SQR is (C1+1)^2, Delta is X-SQR, write(sqr_candidate(C1,SQR,X,Delta)),nl,
652		% >>> SQRT(9999911144210000019*9999911144210000019+2)
653		add_error(external_functions,'Rounding error (2) while computing SQRT of: ',X,Span),
654		Res = int(C1)
655		)
656		; add_error(external_functions,'Rounding error (1) while computing SQRT of: ',X,Span),
657		% SQRT(999991114421000001*999991114421000001+2)
658		Res = int(Candidate)
659		).
660
661		external_fun_type('MSB',[],[integer,integer]).
662		expects_spaninfo('MSB').
663		:- public 'MSB'/3.
664		:- block 'MSB'(-,?,?).
665		'MSB'(int(X),int(R),Span) :- msb2(X,R,Span). % most significant bit
666		:- block msb2(-,?,?).
667		msb2(X,R,Span) :- safe_is('MSB',R,msb(X),Span). % TO DO: could be made reversible by propagating constraint if R known
668
669
670		external_fun_type('FACTORIAL',[],[integer,integer]).
671		expects_spaninfo('FACTORIAL').
672		expects_waitflag('FACTORIAL').
673		:- public 'FACTORIAL'/4.
674		:- block 'FACTORIAL'(-,?,?,?).
675		'FACTORIAL'(int(X),int(R),Span,WF) :- fact(X,R,Span,WF). % most significant bit
676		:- block fact(-,?,?,?).
677		fact(X,_,Span,WF) :- X<0,!, add_wd_error_span('FACTORIAL applied to negative number: ',X,Span,WF).
678		fact(X,_,Span,WF) :- X>10000,!, add_wd_error_span('FACTORIAL overflow, argument too large: ',X,Span,WF).
679		fact(X,Res,_,_) :- fact_acc(X,1,Res).
680
681		fact_acc(0,Acc,Res) :- !,Res=Acc.
682		fact_acc(N,Acc,Res) :- NAcc is Acc*N,
683		N1 is N-1, fact_acc(N1,NAcc,Res).
684
685		% TODO: fact_k, choose_nk
686
687		% BITWISE OPERATORS
688		external_fun_type('BNOT',[],[integer,integer]).
689		external_fun_can_be_inverted('BNOT').
690		expects_spaninfo('BNOT').
691		:- public 'BNOT'/3.
692		:- block 'BNOT'(-,-,?).
693		'BNOT'(int(X),int(R),Span) :- bitwise_not(X,R,Span).
694		:- block bitwise_not(-,-,?).
695		bitwise_not(X,R,Span) :- number(X),!,safe_is('BNOT',R,\(X),Span).
696		bitwise_not(X,R,Span) :- safe_is('BNOT',X,\(R),Span).
697
698		:- use_module(clpfd_interface,[clpfd_eq_expr/2]).
699
700		external_fun_type('BAND',[],[integer,integer,integer]).
701		:- public 'BAND'/3.
702		:- if((current_prolog_flag(dialect, sicstus),
703		current_prolog_flag(version_data, sicstus(4,9,_,_,_)))).
704		:- block 'BAND'(-,-,-).
705		'BAND'(int(X),int(Y),int(R)) :-
706		(preferences:preference(use_clpfd_solver,true)
707		-> clpfd_eq_expr(R,'/\\'(X,Y))
708		; bitwise_and(X,Y,R)).
709		:- else.
710		:- block 'BAND'(-,?,?),'BAND'(?,-,?).
711		'BAND'(int(X),int(Y),int(R)) :- bitwise_and(X,Y,R).
712		:- endif.
713		:- block bitwise_and(?,-,?),bitwise_and(-,?,?).
714		bitwise_and(X,Y,R) :- R is X /\ Y. % we could do some early consistency checking, e.g., when X and R known
715
716		external_fun_type('BOR',[],[integer,integer,integer]).
717		:- public 'BOR'/3.
718		:- if((current_prolog_flag(dialect, sicstus),
719		current_prolog_flag(version_data, sicstus(4,9,_,_,_)))).
720		:- block 'BOR'(-,-,-).
721		'BOR'(int(X),int(Y),int(R)) :-
722		(preferences:preference(use_clpfd_solver,true)
723		-> clpfd_eq_expr(R,'\\/'(X,Y))
724		; bitwise_or(X,Y,R)).
725		:- else.
726		:- block 'BOR'(-,?,?),'BOR'(?,-,?).
727		'BOR'(int(X),int(Y),int(R)) :- bitwise_or(X,Y,R).
728		:- block bitwise_or(?,-,?),bitwise_or(-,?,?).
729		:- endif.
730		bitwise_or(X,Y,R) :- R is X \/ Y. % we could do some early consistency checking, e.g., when X and R known
731
732		external_fun_type('BXOR',[],[integer,integer,integer]).
733		external_fun_can_be_inverted('BXOR').
734		:- public 'BXOR'/3.
735		:- if((current_prolog_flag(dialect, sicstus),
736		current_prolog_flag(version_data, sicstus(4,9,_,_,_)))).
737		:- block 'BXOR'(-,-,-).
738		'BXOR'(int(X),int(Y),int(R)) :-
739		(preferences:preference(use_clpfd_solver,true)
740		-> clpfd_eq_expr(R,xor(X,Y))
741		; bitwise_xor(X,Y,R)).
742		:- else.
743		:- block 'BXOR'(-,-,?),'BXOR'(?,-,-),'BXOR'(-,?,-).
744		'BXOR'(int(X),int(Y),int(R)) :- bitwise_xor(X,Y,R).
745		:- endif.
746		:- block bitwise_xor(-,-,?),bitwise_xor(?,-,-),bitwise_xor(-,?,-).
747		% DO WE NEED TO KNOW THE sizes of X,Y,R ?
748		bitwise_xor(X,Y,R) :- var(X),!, X is xor(R,Y).
749		bitwise_xor(X,Y,R) :- var(Y),!, Y is xor(X,R).
750		bitwise_xor(X,Y,R) :- R is xor(X,Y).
751
752		% TO DO: do some clpfd propagations ? X:0..N & Y:0..M -> BAND(X,Y) : 0..min(N,M)
753
754		% EXTERNAL_FUNCTION_BITS == INTEGER --> seq(INTEGER)
755		% BITS(x) == [0]
756		external_fun_type('BLSHIFT',[],[integer,integer,integer]).
757		:- public 'BLSHIFT'/3.
758		:- block 'BLSHIFT'(-,?,?),'BLSHIFT'(?,-,?).
759		'BLSHIFT'(int(X),int(Y),int(R)) :- bitwise_left_shift(X,Y,R).
760		:- block bitwise_left_shift(?,-,?),bitwise_left_shift(-,?,?).
761		bitwise_left_shift(X,Y,R) :- R is X << Y.
762		external_fun_type('BRSHIFT',[],[integer,integer,integer]).
763		:- public 'BRSHIFT'/3.
764		:- block 'BRSHIFT'(-,?,?),'BRSHIFT'(?,-,?).
765		'BRSHIFT'(int(X),int(Y),int(R)) :- bitwise_right_shift(X,Y,R).
766		:- block bitwise_right_shift(?,-,?),bitwise_right_shift(-,?,?).
767		bitwise_right_shift(X,Y,R) :- R is X >> Y.
768
769		:- assert_must_succeed(( external_functions:call_external_function('BITS',[12],[int(12)],R,integer,unknown,_WF),
770		equal_object(R,[(int(1),int(1)),(int(2),int(1)),(int(3),int(0)),(int(4),int(0))]) )).
771
772		external_fun_type('BITS',[],[integer,seq(integer)]).
773		:- public 'BITS'/2.
774		:- block 'BITS'(-,?).
775		'BITS'(int(X),Res) :- convert_to_bits(X,Res).
776
777		:- block convert_to_bits(-,?).
778		convert_to_bits(0,Res) :- !, convert_list_to_seq([int(0)],Res).
779		convert_to_bits(N,Res) :- convert_to_bits(N,[],List),
780		convert_list_to_seq(List,Res).
781		convert_to_bits(0,Acc,Res) :- !, Res=Acc.
782		convert_to_bits(X,Acc,Res) :- XM2 is X mod 2, XD2 is X // 2,
783		convert_to_bits(XD2,[int(XM2)|Acc],Res).
784		% TO DO: maybe do some constraint propagation from Result to number, or use CLP(FD) size info to infer size of sequence?
785
786		% -------------------------------
787
788		% THE CHOOSE operator (for TLA, recursive functions over sets,...)
789		% or choice operator from Abrial Book, page 60ff
790
791		:- use_module(kernel_waitflags,[add_wd_error_span/4]).
792		external_fun_type('CHOOSE',[X],[set(X),X]).
793		external_fun_has_wd_condition('CHOOSE').
794		expects_waitflag('CHOOSE').
795		expects_spaninfo('CHOOSE').
796		:- public 'CHOOSE'/4.
797		:- block 'CHOOSE'(-,?,?,?).
798		'CHOOSE'([],_,Span,WF) :-
799		add_wd_error_span('CHOOSE applied to empty set: ',[],Span,WF).
800		'CHOOSE'(CS,H,_,_) :- is_interval_closure_or_integerset(CS,Low,Up),
801		!,
802		choose_interval(Low,Up,H).
803		'CHOOSE'([H|T],C,_Span,WF) :- T==[], !, kernel_objects:equal_object_optimized_wf(C,H,'CHOOSE',WF).
804		'CHOOSE'([H|T],C,Span,WF) :- !,
805		ground_value_check([H|T],Gr),
806		when(nonvar(Gr),
807		(convert_to_avl([H|T],AVL) -> 'CHOOSE'(AVL,C,Span,WF)
808		; add_wd_error_span('Cannot determine minimum element for CHOOSE: ',[H|T],Span,WF),
809		kernel_objects:equal_object_wf(C,H,WF))
810		).
811		'CHOOSE'(avl_set(A),H,_,WF) :- !, avl_min(A,Min), kernel_objects:equal_object_wf(H,Min,WF).
812		'CHOOSE'(global_set(GS),H,_,_) :- !, H = fd(1,GS). % assume GS not empty, integer sets covered above
813		'CHOOSE'(freetype(ID),H,Span,WF) :- !,
814		(kernel_freetypes:enumerate_freetype_wf(basic,FV,freetype(ID),WF)
815		-> kernel_objects:equal_object_wf(FV,H,WF)
816		; add_internal_error('Could not generate freetype element: ','CHOOSE'(freetype(ID),H,Span,WF))).
817		'CHOOSE'(CS,H,Span,WF) :- custom_explicit_sets:is_cartesian_product_closure(CS,Set1,Set2),!,
818		'CHOOSE'(Set1,H1,Span,WF),
819		'CHOOSE'(Set2,H2,Span,WF),
820		kernel_objects:equal_object_wf(H,(H1,H2),WF).
821		'CHOOSE'(closure(P,T,B),H,Span,WF) :-
822		custom_explicit_sets:expand_custom_set_wf(closure(P,T,B),ER,'CHOOSE',WF),
823		'CHOOSE'(ER,H,Span,WF).
824
825		:- block choose_interval(-,?,?).
826		choose_interval(Low,_Up,H) :- number(Low),!,H=int(Low).
827		choose_interval(_Low,Up,H) :- choose_interval2(Up,H). % lower-bound is minus infinity
828		:- block choose_interval2(-,?).
829		choose_interval2(Up,H) :- number(Up),!,H=int(Up). % for those intervals we choose Up
830		choose_interval2(_,int(0)). % we have INTEGER or something equivalent; simply choose 0
831
832		:- use_module(kernel_objects,[singleton_set_element/4, singleton_set_element_wd/4]).
833		external_fun_type('MU',[X],[set(X),X]).
834		external_fun_has_wd_condition('MU').
835		expects_waitflag('MU').
836		expects_spaninfo('MU').
837		:- public 'MU'/4.
838		'MU'(Set,Res,Span,WF) :-
839		singleton_set_element(Set,Res,Span,WF).
840
841		external_fun_type('MU_WD',[X],[set(X),X]).
842		external_fun_has_wd_condition('MU_WD').
843		expects_waitflag('MU_WD').
844		expects_spaninfo('MU_WD').
845		% a version of MU which propagates more strongly from result to input
846		% but may thus fail to generate WD errors; can be used for stronger constraint propagation if MU is known to be WD
847		:- public 'MU_WD'/4.
848		'MU_WD'(Set,Res,Span,WF) :-
849		singleton_set_element_wd(Set,Res,Span,WF).
850
851
852		% choose n elements from a set
853		% will currently fail without good error message when we cannot find enough solutions
854		external_fun_type('CHOOSE_n',[X],[integer,set(X),set(X)]).
855		external_fun_has_wd_condition('CHOOSE_n').
856		expects_waitflag('CHOOSE_n').
857		expects_spaninfo('CHOOSE_n').
858		expects_type('CHOOSE_n').
859		:- public 'CHOOSE_n'/6.
860		:- block 'CHOOSE_n'(-,?,?,?,?,?).
861		'CHOOSE_n'(int(Nr),Set,Result,set(Type),Span,WF) :-
862		ground_value_check(Set,GrSet),
863		choose_n_aux(Nr,GrSet,Set,Result,Type,Span,WF).
864
865		:- block 'choose_n_aux'(-,?,?,?,?,?,?),'choose_n_aux'(?,-,?,?,?,?,?).
866		choose_n_aux(Nr,_,Set,Result,Type,Span,WF) :-
867		generate_elements(Nr,Set,[],List,Type,Span,WF),
868		equal_object_wf(List,Result,WF).
869
870		% TODO: disable enumeration warnings when generating new elements
871		generate_elements(0,_,_,Res,_,_,_) :- !, Res=[].
872		generate_elements(Nr,Set,Acc,[H|T],Type,Span,WF) :-
873		init_wait_flags_with_call_stack(WF2,[operation_call('CHOOSE_n',[int(Nr)],Span)]),
874		check_element_of_wf(H,Set,WF2),
875		not_element_of_wf(H,Acc,WF2),
876		b_enumerate:b_enumerate_typed_values([H],[Type],WF2),
877		ground_wait_flags(WF2),
878		add_element_wf(H,Acc,Acc2,no_wf_available),
879		!,
880		N1 is Nr-1,
881		generate_elements(N1,Set,Acc2,T,Type,Span,WF).
882
883
884		% -----------------
885
886		% sort a set and generate a sequence
887		% external_fun_has_wd_condition('SORT'). SORT generates virtual time-out for infinite sets; but has no WD-condition
888		% important to remove wd_condition fact to allow b_compiler to pre-compute calls to SORT
889		expects_waitflag('SORT').
890		expects_spaninfo('SORT').
891		external_fun_type('SORT',[X],[set(X),seq(X)]).
892		:- public 'SORT'/4.
893		:- block 'SORT'(-,?,?,?).
894		'SORT'([],Res,_Span,_WF) :- !, Res=[].
895		'SORT'(CS,Res,_,WF) :- custom_explicit_sets:is_custom_explicit_set(CS),!,
896		expand_custom_set_to_list_wf(CS,ER,Done,'SORT',WF),
897		sort_aux(Done,ER,Res,WF).
898		'SORT'([H|T],Res,_,WF) :-
899		when(ground([H|T]),
900		(maplist(convert_to_avl_if_possible,[H|T],List),
901		sort(List,SList),sort_aux(done,SList,Res,WF))).
902
903		convert_to_avl_if_possible(H,Res) :- convert_to_avl(H,CH),!,Res=CH.
904		convert_to_avl_if_possible(H,H) :-
905		add_warning(external_functions,'Cannot guarantee order when sorting:',H).
906
907		:- block sort_aux(-,?,?,?).
908		sort_aux(_,ER,Res,_WF) :- convert_list_to_seq(ER,Res).
909
910		% construct a B sequence from a Prolog list
911		convert_list_to_seq(ER,Res) :- convert_list_to_seq(ER,1,Seq), equal_object_optimized(Seq,Res).
912
913		convert_list_to_seq([],_,[]).
914		convert_list_to_seq([H|T],N,[(int(N),H)|CT]) :- N1 is N+1, convert_list_to_seq(T,N1,CT).
915
916		% :- use_module(library(samsort),[samsort/3]).
917		% TO DO: version of SORT with samsort/3 and user provided sorting predicate
918
919		% Z Compaction / squash operator to fill up gaps in sequence
920		external_fun_has_wd_condition('SQUASH'). % needs to be a function
921		expects_waitflag('SQUASH').
922		external_fun_type('SQUASH',[X],[set(couple(integer,X)),seq(X)]). % input not necessarily proper sequence
923
924		:- use_module(kernel_z,[compaction/3]).
925		:- public 'SQUASH'/3.
926		'SQUASH'(Sequence,Value,WF) :- compaction(Sequence,Value,WF).
927
928		external_fun_has_wd_condition('REPLACE'). % needs to be a function
929		expects_waitflag('REPLACE').
930		expects_spaninfo('REPLACE').
931		external_fun_type('REPLACE',[X],[seq(X),seq(X),seq(X),set(seq(X))]).
932		% Replace a pattern by another pattern within a sequence
933		% Currently it also performs a squashing of its arguments and does not check if its argument is a function or sequence.
934		% REPLACE([a],[b],[a,c,a]) = { [b,c,a], [a,c,b] };
935		% REPLACE([a],[],[a,c,a]) = { [c,a], [a,c] };
936		% REPLACE([a,a],[],[a,c,a]) = { }
937		:- public 'REPLACE'/6.
938		:- block 'REPLACE'(-,?,?,?,?,?), 'REPLACE'(?,-,?,?,?,?), 'REPLACE'(?,?,-,?,?,?).
939		'REPLACE'(Pat,Replacement,InSequence,Res,Span,_WF) :-
940		ground_value_check((Pat,Replacement,InSequence),Gr),
941		replace_pat_aux(Gr,Pat,Replacement,InSequence,Res,Span).
942		:- block replace_pat_aux(-,?,?,?,?,?).
943		replace_pat_aux(_,Pat,Replacement,InSequence,Res,Span) :-
944		convert_to_sorted_seq_list(Pat,PL,Span),
945		convert_to_sorted_seq_list(Replacement,RL,Span),
946		convert_to_sorted_seq_list(InSequence,SL,Span),
947		findall(ResList,replace_pattern(PL,RL,SL,ResList),ResLists),
948		equal_object_optimized(ResLists,Res,'REPLACE').
949
950		% convert argument to avl list and then on to a list of elements without indices
951		convert_to_sorted_seq_list([],List,_Span) :- !, List=[].
952		convert_to_sorted_seq_list(Sequence,List,_Span) :-
953		convert_to_avl(Sequence,avl_set(AVL)),
954		custom_explicit_sets:get_avl_sequence(AVL,List),!.
955		convert_to_sorted_seq_list(Sequence,_,Span) :-
956		add_error(external_functions,'Cannot convert argument to finite sequences: ',Sequence,Span).
957
958		replace_pattern(Pat,Rep,Seq,ResBSequence) :- % Prefix.Pat.Post ---> Prefix.Rep.Post
959		append(Pat,Post,PatPost),
960		append(Rep,Post,RepPost),
961		append(Prefix,PatPost,Seq),
962		append(Prefix,RepPost,ResList),
963		convert_list_to_seq(ResList,ResBSequence).
964
965
966		% Prolog term order on encoding
967		external_fun_type('LESS',[X],[X,X,boolean]).
968		:- public 'LESS'/3.
969		:- block 'LESS'(-,?,?), 'LESS'(?,-,?).
970		'LESS'(string(A),string(B),Res) :- !, less2(A,B,Res).
971		'LESS'(int(A),int(B),Res) :- !, less_clpfd(A,B,Res). % use CLPFD less ?
972		'LESS'(fd(A,G),fd(B,G),Res) :- !, less_clpfd(A,B,Res).
973		'LESS'(term(floating(A)),B,Res) :- !,
974		kernel_reals:real_comp_wf('<',term(floating(A)),B,Res,no_wf_available).
975		'LESS'(pred_false,B,Res) :- !, B=Res. % if B=pred_true then < , otherwise not
976		'LESS'(pred_true,_,Res) :- !, Res=pred_false.
977		% TO DO: expand finite closures, couples, avl_sets, ...
978		'LESS'(X,Y,Res) :- when((ground(X),ground(Y)), less2(X,Y,Res)).
979		% TO DO: use kernel_ordering,[ordered_value/2]).
980
981		:- use_module(clpfd_interface,[clpfd_leq_expr/2,clpfd_lt_expr/2]).
982		:- block less_clpfd(-,?,-), less_clpfd(?,-,-).
983		less_clpfd(A,B,Res) :- Res==pred_true, !, clpfd_lt_expr(A,B).
984		less_clpfd(A,B,Res) :- Res==pred_false, !, clpfd_leq_expr(B,A).
985		less_clpfd(A,B,Res) :- (A < B -> Res=pred_true ; Res=pred_false).
986
987
988		:- block less2(-,?,?), less2(?,-,?).
989		less2(A,B,Res) :- (A @< B -> Res=pred_true ; Res=pred_false).
990
991		:- use_module(kernel_ordering,[leq_ordered_value/3]).
992
993		:- public 'LEQ_SYM_BREAK'/4.
994		expects_waitflag('LEQ_SYM_BREAK').
995		external_fun_type('LEQ_SYM_BREAK',[X],[X,X,boolean]).
996		'LEQ_SYM_BREAK'(A,B,Res,WF) :- 'LEQ_SYM'(A,B,Res,WF).
997
998		expects_waitflag('LEQ_SYM').
999		external_fun_type('LEQ_SYM',[X],[X,X,boolean]).
1000		% true if arg1 <= arg2 according to Prolog term order; may return true for some symbolic representations
1001		% Note: it is sometimes ignored, e.g., by Kodkod or Z3 translation
1002		% Also: LEQ_SYM_BREAK / LEQ_SYM do not fully support all types yet, see sym_break_supported_type
1003		:- block 'LEQ_SYM'(-,?,?,?).
1004		'LEQ_SYM'(int(A),int(B),Res,_WF) :- !,
1005		b_interpreter_check:check_arithmetic_operator('<=',A,B,Res).
1006		'LEQ_SYM'(fd(A,G),fd(B,G),Res,_WF) :- !,
1007		b_interpreter_check:check_arithmetic_operator('<=',A,B,Res).
1008		'LEQ_SYM'(term(floating(A)),B,Res,WF) :- !,
1009		kernel_reals:real_comp_wf('=<',term(floating(A)),B,Res,WF).
1010		'LEQ_SYM'(pred_false,_,Res,_WF) :- !, Res=pred_true. % pred_false @< pred_true
1011		'LEQ_SYM'(pred_true,B,Res,_WF) :- !, Res=B. % if B=pred_true -> ok; otherwise Res=pred_false
1012		'LEQ_SYM'([],_,Res,_W) :- !, Res=pred_true. % the empty set is the smallest set
1013		'LEQ_SYM'(closure(_,_,_),_,Res,_) :- !, Res=pred_true. % otherwise we would have to expand it
1014		'LEQ_SYM'(global_set(_),_,Res,_) :- !, Res=pred_true. % ditto
1015		'LEQ_SYM'(X,Y,Res,WF) :- 'LEQ_SYM2'(X,Y,Res,WF).
1016
1017		:- block 'LEQ_SYM2'(?,-,?,?).
1018		%'LEQ_SYM'(X,Y,Res) :- print('LEQ_SYM'(X,Y,Res)),nl,fail.
1019		'LEQ_SYM2'(string(A),string(B),Res,_WF) :- !, less_eq2(A,B,Res).
1020		'LEQ_SYM2'(_,closure(_,_,_),Res,_WF) :- !, Res=pred_true. % we would have to expand it
1021		'LEQ_SYM2'(Set1,[],Res,WF) :- !, kernel_equality:empty_set_test_wf(Set1,Res,WF).
1022		'LEQ_SYM2'((A,B),(X,Y),Res,_WF) :- Res==pred_true,!, leq_ordered_value((A,B),(X,Y),_Equal).
1023		'LEQ_SYM2'(rec(FA),rec(FB),Res,_WF) :- Res==pred_true,!, leq_ordered_value(rec(FA),rec(FB),_Equal).
1024		% TODO: support sets, e.g., by comparing cardinality or minimal elements
1025		'LEQ_SYM2'(_A,_B,Res,_WF) :- Res=pred_true.
1026		%'LEQ_SYM2'(X,Y,Res,_WF) :- when((ground(X),ground(Y)), less_eq2(X,Y,Res)). % unsafe to use; we should normalize AVLs ...
1027		% TO DO: use kernel_ordering:leq_ordered_value/2 more or use lex_chain([[X,X],[Y,Z]],[op(#=<)]) for pairs/records of FD values
1028		% Note: it is reified in b_interpreter_check
1029
1030		:- block less_eq2(-,?,?), less_eq2(?,-,?).
1031		less_eq2(A,B,Res) :- (A @=< B -> Res=pred_true ; Res=pred_false).
1032
1033		% -------------------------------
1034
1035		% was a first prototype for implementing recursive functions
1036		% was still a bit clumsy to define recursive functions (using STRING parameter for names)
1037		% a restriction is that we can only have one version per machine, i.e.
1038		% one can only define recursive function in the CONSTANTS section and only
1039		% in a deterministic fashion not depending on enumerated constants,...
1040		% we now use generate_recursive_closure in b_interpreter for recursive_let/2 constructs
1041		%:- dynamic recursive_function/2.
1042		%expects_waitflag('REC'). % DEPRECATED
1043		%expects_spaninfo('RECx'). % DEPRECATED
1044		%expects_spaninfo('REC_LET'). % DEPRECATED
1045
1046
1047		reset_external_functions :-
1048		retractall(last_walltime(_)),
1049		reset_ident,
1050		reset_kodkod,
1051		reset_observe,
1052		close_all_files.
1053
1054		:- use_module(eventhandling,[register_event_listener/3]).
1055		:- register_event_listener(clear_specification,reset_external_functions,
1056		'Reset B External Functions.').
1057
1058		print_external_function_instantiation_profile :-
1059		%TODO: we could register number of external function calls, ..
1060		portray_instantiations.
1061
1062
1063		% -------------------------------
1064
1065		expects_waitflag('FORCE').
1066		external_fun_type('FORCE',[T],[T,T]).
1067		:- public 'FORCE'/3.
1068		% example usage halve = FORCE( %x.(x:0..1000 & x mod 2 = 0 | x/2))
1069		:- block 'FORCE'(-,?,?).
1070		%'FORCE'(A,B,_) :- print(force(A)),nl,fail.
1071		'FORCE'(avl_set(A),Result,_) :- !, equal_object(avl_set(A),Result).
1072		'FORCE'([],Result,_) :- !, equal_object([],Result).
1073		'FORCE'(closure(P,T,B),Result,WF) :- !,
1074		(debug:debug_mode(on) -> print('FORCING : '),translate:print_bvalue(closure(P,T,B)),nl ; true),
1075		custom_explicit_sets:expand_closure_to_avl_or_list(P,T,B,ExpandedValue,no_check,WF),
1076		(debug:debug_mode(on) -> print('RESULT : '),translate:print_bvalue(ExpandedValue),nl,
1077		print(' ASSIGNING TO : '), translate:print_bvalue(Result),nl
1078		; true),
1079		equal_object(ExpandedValue,Result).
1080		'FORCE'((A,B),(FA,FB),WF) :- !,'FORCE'(A,FA,WF), 'FORCE'(B,FB,WF).
1081		% TO DO: treat lists and records ...
1082		'FORCE'(A,B,_) :- equal_object_optimized(A,B,'FORCE').
1083
1084		% -----------------------------------------
1085
1086		:- use_module(tools, [read_term_from_file/2]).
1087
1088		expects_spaninfo('READ_PROB_DATA_FILE').
1089		external_fun_type('READ_PROB_DATA_FILE',[T],[set(T),string,T]).
1090		:- public 'READ_PROB_DATA_FILE'/4.
1091		:- block 'READ_PROB_DATA_FILE'(-,?,?,?), 'READ_PROB_DATA_FILE'(?,-,?,?).
1092		'READ_PROB_DATA_FILE'(_,string(File),Expr,Span) :- % first arg provides type info
1093		read_prob_data_file(File,Expr,Span).
1094
1095		:- block read_prob_data_file(-,?,?).
1096		read_prob_data_file(File,Expr,Span) :-
1097		b_absolute_file_name(File,AFile,Span),
1098		safe_call(read_term_from_file(AFile,Expr),Span). % can also be in fastrw format
1099
1100
1101
1102		% -----------------------------------------
1103
1104		:- public 'ENUM'/2.
1105		% example usage: ENUM((x,y)) : AVLSet
1106		% external function used for deriving info field annotations in ast_cleanup
1107		'ENUM'(Obj,Obj).
1108
1109		% -----------------------------------------
1110
1111		expects_unevaluated_args('DO_NOT_ENUMERATE').
1112		:- public 'DO_NOT_ENUMERATE'/3.
1113		:- block 'DO_NOT_ENUMERATE'(-,?,?).
1114		'DO_NOT_ENUMERATE'((A,B),PredRes,UEA) :- !, 'DO_NOT_ENUMERATE'(A,PredRes,UEA),'DO_NOT_ENUMERATE'(B,PredRes,UEA).
1115		'DO_NOT_ENUMERATE'(fd(V,_),PredRes,UEA) :- !, 'DO_NOT_ENUMERATE'(V,PredRes,UEA).
1116		'DO_NOT_ENUMERATE'(int(V),PredRes,UEA) :- !, 'DO_NOT_ENUMERATE'(V,PredRes,UEA).
1117		'DO_NOT_ENUMERATE'(string(V),PredRes,UEA) :- !, 'DO_NOT_ENUMERATE'(V,PredRes,UEA).
1118		'DO_NOT_ENUMERATE'(_Obj,PredRes,_UEA) :-
1119		%print('INSTANTIATED: '),nl, _UEA=[UnEvalArg],translate:print_bexpr(UnEvalArg),nl, print(_Obj),nl,
1120		PredRes=pred_true.
1121		% add_message('DO_NOT_ENUMERATE','Enumerating: ',UnEvalArgs).
1122
1123		% a utility to avoid propagation of values, can be used as "enumeration barrier"
1124		expects_waitflag('COPY').
1125		:- public 'COPY'/3.
1126		:- block 'COPY'(-,?,?).
1127		'COPY'(Val,Result,WF) :- ground_value_check(Val,GrVal),
1128		when(nonvar(GrVal),equal_object_optimized_wf(Val,Result,'COPY',WF)).
1129
1130
1131		% -------------------------------
1132
1133		:- assert_must_succeed(( external_functions:call_external_function('STRING_APPEND',[a,b],[string(a),string(b)],string(ab),string,unknown,_WF) )).
1134		% STRING MANIPULATION FUNCTIONS
1135
1136		:- use_module(kernel_strings,[b_string_append_wf/4, b_concat_sequence_of_strings_wf/4, b_string_reverse_wf/3,
1137		b_string_chars/2, b_string_codes/2, b_string_length/2,
1138		b_string_to_uppercase/2, b_string_to_lowercase/2]).
1139
1140		% function to append two strings, reversible
1141		external_fun_can_be_inverted('STRING_APPEND').
1142		expects_waitflag('STRING_APPEND').
1143		external_fun_type('STRING_APPEND',[],[string,string,string]).
1144		:- public 'STRING_APPEND'/4.
1145		'STRING_APPEND'(A,B,C,WF) :- b_string_append_wf(A,B,C,WF).
1146
1147		% function to append two strings, reversible
1148		external_fun_can_be_inverted('STRING_REV').
1149		expects_waitflag('STRING_REV').
1150		external_fun_type('STRING_REV',[],[string,string]).
1151		:- public 'STRING_REV'/3.
1152		'STRING_REV'(A,B,WF) :- b_string_reverse_wf(A,B,WF).
1153
1154		expects_waitflag('STRING_CONC').
1155		expects_spaninfo('STRING_CONC').
1156		external_fun_type('STRING_CONC',[],[seq(string),string]).
1157		:- public 'STRING_CONC'/4.
1158		:- block 'STRING_CONC'(-,?,?,?).
1159		% the conc(.) operator is mapped to this for strings (instead to concat_sequence)
1160		'STRING_CONC'(List,Res,Span,WF) :-
1161		b_concat_sequence_of_strings_wf(List,Res,Span,WF).
1162
1163		external_fun_can_be_inverted('STRING_CHARS').
1164		external_fun_type('STRING_CHARS',[],[string,seq(string)]).
1165		:- public 'STRING_CHARS'/2.
1166		'STRING_CHARS'(Str,SeqOfChars) :- b_string_chars(Str,SeqOfChars).
1167		/* Note: STRING_CONC can be used as inverse to combine the chars */
1168
1169		external_fun_can_be_inverted('CODES_TO_STRING').
1170		external_fun_type('CODES_TO_STRING',[],[seq(integer),string]).
1171		:- public 'CODES_TO_STRING'/2.
1172		'CODES_TO_STRING'(A,SeqRes) :- 'STRING_CODES'(SeqRes,A).
1173
1174		external_fun_can_be_inverted('STRING_CODES').
1175		external_fun_type('STRING_CODES',[],[string,seq(integer)]).
1176		:- public 'STRING_CODES'/2.
1177		'STRING_CODES'(A,SeqRes) :- b_string_codes(A,SeqRes).
1178
1179
1180		external_fun_type('STRING_TO_UPPER',[],[string,string]).
1181		:- public 'STRING_TO_UPPER'/2.
1182		'STRING_TO_UPPER'(S,S2) :- b_string_to_uppercase(S,S2).
1183		external_fun_type('STRING_TO_LOWER',[],[string,string]).
1184		:- public 'STRING_TO_LOWER'/2.
1185		'STRING_TO_LOWER'(S,S2) :- b_string_to_lowercase(S,S2).
1186
1187		:- use_module(kernel_strings,[b_string_equal_case_insensitive/3]).
1188		external_fun_type('STRING_EQUAL_CASE_INSENSITIVE',[],[string,string,boolean]).
1189		:- public 'GET_STRING_EQUAL_CASE_INSENSITIVE'/3.
1190		'STRING_EQUAL_CASE_INSENSITIVE'(S1,S2,Res) :- b_string_equal_case_insensitive(S1,S2,Res).
1191
1192		:- assert_must_succeed(( external_functions:call_external_function('STRING_LENGTH',[a],[string(a)],int(1),integer,unknown,_WF) )).
1193		% function to get length of a string
1194		external_fun_type('STRING_LENGTH',[],[string,integer]).
1195		:- public 'STRING_LENGTH'/2.
1196		'STRING_LENGTH'(S,L) :- b_string_length(S,L).
1197
1198		:- use_module(kernel_strings,[b_string_split_wf/4, b_string_join_wf/5]).
1199
1200		% function to split a string into a list of strings which were delimited by a separator
1201		% WARNING: if the seperator is of length more than one, then first match-strategy will be used
1202		external_fun_can_be_inverted('STRING_SPLIT').
1203		expects_waitflag('STRING_SPLIT').
1204		external_fun_type('STRING_SPLIT',[],[string,string,seq(string)]).
1205		:- public 'STRING_SPLIT'/4.
1206		'STRING_SPLIT'(Str,Sep,Strings,WF) :- b_string_split_wf(Str,Sep,Strings,WF).
1207
1208		:- public 'STRING_JOIN'/5.
1209		expects_waitflag('STRING_JOIN').
1210		expects_spaninfo('STRING_JOIN').
1211		external_fun_type('STRING_JOIN',[],[seq(string),string,string]).
1212		'STRING_JOIN'(SplitAtoms,Sep,Res,Span,WF) :- b_string_join_wf(SplitAtoms,Sep,Res,Span,WF).
1213
1214
1215		expects_waitflag('STRING_CONTAINS_STRING').
1216		external_fun_type('STRING_CONTAINS_STRING',[],[string,string,boolean]).
1217		% TRUE when arg2 occurs as contiguous substring in arg1
1218		:- public 'STRING_CONTAINS_STRING'/4.
1219		:- block 'STRING_CONTAINS_STRING'(-,?,?,?), 'STRING_CONTAINS_STRING'(?,-,?,?).
1220		'STRING_CONTAINS_STRING'(string(A),string(B),PredRes,_WF) :-
1221		string_contains_string_aux(A,B,PredRes).
1222		:- use_module(library(lists),[sublist/5]).
1223		% TO DO: we could enumerate B if A known and waitflag instantiated
1224		:- block string_contains_string_aux(-,?,?),string_contains_string_aux(?,-,?).
1225		string_contains_string_aux(A,B,PredRes) :-
1226		atom_codes(A,ACodes),
1227		atom_codes(B,BCodes),
1228	?	(sublist(ACodes,BCodes,_,_,_) -> PredRes=pred_true ; PredRes=pred_false).
1229
1230		:- use_module(kernel_strings,[b_substring_wf/6]).
1231		:- public 'SUB_STRING'/6.
1232		expects_spaninfo('SUB_STRING').
1233		expects_waitflag('SUB_STRING').
1234		external_fun_type('SUB_STRING',[],[string,integer,integer,string]).
1235		'SUB_STRING'(S,From,Len,Res,Span,WF) :- b_substring_wf(S,From,Len,Res,Span,WF).
1236
1237
1238		:- use_module(kernel_strings,[b_string_replace/4]).
1239		:- public 'STRING_REPLACE'/4.
1240		external_fun_type('STRING_REPLACE',[],[string,string,string,string]).
1241		'STRING_REPLACE'(S,Pat,New,Res) :- b_string_replace(S,Pat,New,Res).
1242
1243
1244		:- use_module(probsrc(kernel_freetypes), [get_freetype_id/2, get_freeval_type/3, registered_freetype_case_value/3]).
1245		:- use_module(probsrc(translate), [pretty_type/2]).
1246		:- use_module(probsrc(btypechecker), [unify_types_werrors/4]).
1247
1248		external_fun_type('STRING_IS_FREETYPE',[],[string,boolean]).
1249		:- public 'STRING_IS_FREETYPE'/2.
1250		:- block 'STRING_IS_FREETYPE'(-,?).
1251		'STRING_IS_FREETYPE'(string(ID),Res) :-
1252		get_freeval_type(_,ID,_) -> Res=pred_true ; Res=pred_false.
1253
1254		external_fun_has_wd_condition('STRING_TO_FREETYPE').
1255		external_fun_type('STRING_TO_FREETYPE',[F],[string,F]). % F is freetype case
1256		expects_type('STRING_TO_FREETYPE').
1257		expects_spaninfo('STRING_TO_FREETYPE').
1258		:- public 'STRING_TO_FREETYPE'/4.
1259		:- block 'STRING_TO_FREETYPE'(-,?,?,?).
1260		'STRING_TO_FREETYPE'(string(ID),Value,Type,Span) :-
1261		string_to_freetype2(ID,Value,Type,Span).
1262
1263		:- block string_to_freetype2(-,?,?,?).
1264		string_to_freetype2(ID,Value,Type,Span) :-
1265		get_freetype_id(Type,FreetypeId), !, % checks implicitly that Type is freetype
1266		check_is_freetype_case(FreetypeId,ID,ArgType,Span),
1267		(Type = set(couple(_,freetype(_)))
1268		-> ExpectedType = set(couple(ArgType,freetype(FreetypeId)))
1269		; ExpectedType = freetype(FreetypeId)
1270		),
1271		unify_types_werrors(ExpectedType,Type,Span,'STRING_TO_FREETYPE'),
1272		(registered_freetype_case_value(ID,Type,Value) -> true
1273		; add_error('STRING_TO_FREETYPE','error while accessing case value:',ID,Span)
1274		).
1275		string_to_freetype2(ID,_,Type,Span) :-
1276		(nonvar(ID) -> pretty_type(Type,TS),
1277		add_error('STRING_TO_FREETYPE','STRING_TO_FREETYPE: Type mismatch: expected FREETYPE or FREETYPE case function (T <-> FREETYPE), but was',TS,Span)
1278		; add_error('STRING_TO_FREETYPE','STRING_TO_FREETYPE cannot be inverted',ID,Span)),
1279		fail.
1280
1281		:- block check_is_freetype_case(?,-,?,?).
1282		check_is_freetype_case(FreetypeId,ID,ArgType,_) :- get_freeval_type(FreetypeId,ID,ArgType), !.
1283		check_is_freetype_case(_,ID,_,Span) :-
1284		add_error('STRING_TO_FREETYPE','STRING_TO_FREETYPE: no FREETYPE case found for string',ID,Span),
1285		fail.
1286
1287
1288		external_fun_has_wd_condition('TYPED_STRING_TO_ENUM').
1289		expects_waitflag('TYPED_STRING_TO_ENUM').
1290		expects_spaninfo('TYPED_STRING_TO_ENUM').
1291		external_fun_type('TYPED_STRING_TO_ENUM',[T],[set(T),string,T]).
1292		:- public 'TYPED_STRING_TO_ENUM'/5.
1293		:- block 'TYPED_STRING_TO_ENUM'(?,-,-,?,?),'TYPED_STRING_TO_ENUM'(-,?,?,?,?).
1294		'TYPED_STRING_TO_ENUM'(Type,string(S),Res,Span,WF) :-
1295		string_to_enum2(S,fd(Nr,GS),_,Span),
1296		check_type(Type,S,Nr,GS,Res,Span,WF).
1297
1298		:- block check_type(-,?,?, ?,?,?,?), check_type(?,-,?, ?,?,?,?), check_type(?,?,-, ?,?,?,?).
1299		check_type(GSTypeExpr,S,Nr,GS,Res,Span,WF) :-
1300		get_global_set_value_type(GSTypeExpr,'TYPED_STRING_TO_ENUM',ExpectedGS),
1301		ExpectedGS=GS,
1302		!,
1303		membership_test_wf(GSTypeExpr,fd(Nr,GS),MemTest,WF),
1304		check_value(MemTest,Nr,GS,Res,S,GSTypeExpr,Span,WF).
1305		check_type(GSTypeExpr,S,_,GS,_,Span,WF) :-
1306		get_global_set_value_type(GSTypeExpr,'TYPED_STRING_TO_ENUM',ExpectedGS),
1307		tools:ajoin(['String value ',S,' is of type ',GS,' and not of expected type:'],Msg),
1308		add_wd_error_span(Msg,ExpectedGS,Span,WF).
1309
1310		:- block check_value(-,?,?,?,?,?,?,?).
1311		check_value(pred_true,Nr,GS,Res,_,_,_,_) :- !, Res=fd(Nr,GS).
1312		check_value(pred_false,_,_GS,_,S,GSTypeExpr,Span,WF) :-
1313		tools:ajoin(['String value ',S,' is of correct type but not in set:'],Msg),
1314		translate:translate_bvalue(GSTypeExpr,SetStr),
1315		add_wd_error_span(Msg,SetStr,Span,WF).
1316
1317		% get type of a set of enumerated/deferred set elements
1318		get_global_set_value_type(global_set(GS),_,Res) :- !, Res=GS.
1319		get_global_set_value_type([fd(_,GS)|_],_,Res) :- !, Res=GS.
1320		get_global_set_value_type(avl_set(node(fd(_,GS),_True,_,_,_)),_,Res) :- !, Res=GS.
1321		get_global_set_value_type(Val,Source,_) :- translate:translate_bvalue(Val,VS),
1322		add_error(Source,'First argument of illegal type, it must be a set of deferred or enumerated set elements:',VS),fail.
1323
1324		:- use_module(probsrc(translate), [pretty_type/2]).
1325
1326		external_fun_can_be_inverted('STRING_TO_ENUM').
1327		external_fun_has_wd_condition('STRING_TO_ENUM').
1328		external_fun_type('STRING_TO_ENUM',[G],[string,G]). % G is enumerated set
1329		expects_type('STRING_TO_ENUM').
1330		expects_spaninfo('STRING_TO_ENUM').
1331		:- public 'STRING_TO_ENUM'/4.
1332		:- block 'STRING_TO_ENUM'(-,-,?,?).
1333		'STRING_TO_ENUM'(string(S),FD,global(Type),Span) :- !, string_to_enum2(S,FD,Type,Span).
1334		'STRING_TO_ENUM'(_,_,Type,Span) :- pretty_type(Type,TS),
1335		add_error('STRING_TO_ENUM','Illegal type for STRING_TO_ENUM (requires a SET type): ',TS,Span),fail.
1336
1337		:- block string_to_enum2(-,-,?,?).
1338		string_to_enum2(S,Res,Type,Span) :- nonvar(S),!,
1339		(b_global_sets:lookup_global_constant(S,FD),
1340		FD = fd(_,GS)
1341		-> check_type_aux(Type,GS,S,Span),
1342		Res=FD % fd(Nr,GS)
1343		; % TO DO: use add_wd_error_set_result
1344		add_error('STRING_TO_ENUM','Could not convert string to enumerated set element: ',S,Span),fail).
1345		string_to_enum2(S,fd(Nr,GS),Type,Span) :-
1346		string_to_enum3(S,Nr,GS,Type,Span).
1347
1348
1349		check_type_aux(Type,GS,S,Span) :- Type \= GS,!,
1350		ajoin(['String value "',S,'" has illegal type ',GS,', expected: '],Msg),
1351		add_error('STRING_TO_ENUM',Msg,Type,Span),
1352		fail.
1353		check_type_aux(_,_,_,_).
1354
1355		:- block string_to_enum3(-,-,?,?,?),string_to_enum3(-,?,-,?,?).
1356		string_to_enum3(S,Nr,GS,Type,Span) :- nonvar(S),!,
1357		(b_global_sets:lookup_global_constant(S,fd(SNr,SGS))
1358		-> check_type_aux(Type,SGS,S,Span),
1359		(SGS,SNr) = (GS,Nr)
1360		; add_error('STRING_TO_ENUM','Could not convert string to enumerated set element: ',S,Span),fail).
1361		string_to_enum3(S,Nr,GS,_,Span) :-
1362		(b_global_sets:is_b_global_constant_hash(GS,Nr,GNS)
1363		-> GNS=S
1364		; add_error('STRING_TO_ENUM','Could not convert deferred set element to string: ',GS:Nr,Span),fail).
1365
1366		:- use_module(kernel_strings,[b_string_is_int/2]).
1367		external_fun_type('STRING_IS_INT',[],[string,boolean]).
1368		:- public 'GET_STRING_IS_INT'/2.
1369		'STRING_IS_INT'(S,Res) :- b_string_is_int(S,Res).
1370
1371		:- use_module(kernel_strings,[b_string_is_number/2]).
1372		external_fun_type('STRING_IS_NUMBER',[],[string,boolean]).
1373		:- public 'GET_STRING_IS_NUMBER'/2.
1374		'STRING_IS_NUMBER'(S,Res) :- b_string_is_number(S,Res).
1375
1376		:- use_module(kernel_strings,[b_string_is_decimal/2]).
1377		external_fun_type('STRING_IS_DECIMAL',[],[string,boolean]).
1378		:- public 'GET_STRING_IS_DECIMAL'/2.
1379		'STRING_IS_DECIMAL'(S,Res) :- b_string_is_decimal(S,Res).
1380
1381		external_fun_type('STRING_IS_ALPHANUMERIC',[],[string,boolean]).
1382		:- use_module(kernel_strings,[b_string_is_alphanumerical/2]).
1383		:- public 'GET_STRING_IS_ALPHANUMERIC'/2.
1384		'STRING_IS_ALPHANUMERIC'(X,Res) :- b_string_is_alphanumerical(X,Res).
1385
1386		% synonyms as use for functions to BOOL rather than predicates
1387		'GET_STRING_EQUAL_CASE_INSENSITIVE'(S1,S2,Res) :- 'STRING_EQUAL_CASE_INSENSITIVE'(S1,S2,Res).
1388		'GET_STRING_IS_ALPHANUMERIC'(S,Res) :- 'STRING_IS_ALPHANUMERIC'(S,Res).
1389		'GET_STRING_IS_DECIMAL'(S,Res) :- 'STRING_IS_DECIMAL'(S,Res).
1390		'GET_STRING_IS_NUMBER'(S,Res) :- 'STRING_IS_NUMBER'(S,Res).
1391		'GET_STRING_IS_INT'(S,Res) :- 'STRING_IS_INT'(S,Res).
1392
1393		% A Utility to convert Decimal Strings to Integers
1394		% TO DO: make a more precise version using just integers: currently DEC_STRING_TO_INT("1024.235",2) = 102423 !
1395		external_fun_has_wd_condition('DEC_STRING_TO_INT').
1396		expects_spaninfo('DEC_STRING_TO_INT').
1397		expects_waitflag('DEC_STRING_TO_INT').
1398		external_fun_type('DEC_STRING_TO_INT',[],[string,integer,integer]).
1399
1400		:- assert_must_succeed((atom_codes(A,"1024"),
1401		external_functions:'DEC_STRING_TO_INT'(string(A),int(0),int(1024),unknown,no_wf_available))).
1402		:- assert_must_succeed((atom_codes(A,"1024.1"),
1403		external_functions:'DEC_STRING_TO_INT'(string(A),int(1),int(10241),unknown,no_wf_available))).
1404		:- public 'DEC_STRING_TO_INT'/5.
1405		:- block 'DEC_STRING_TO_INT'(-,?,?,?,?),'DEC_STRING_TO_INT'(?,-,?,?,?).
1406		'DEC_STRING_TO_INT'(string(S),int(Precision),int(Res),Span,WF) :-
1407		dec_str_to_int(S,Precision,Res,Span,WF).
1408
1409		:- use_module(tools,[split_chars/3]).
1410		:- block dec_str_to_int(-,?,?,?,?),dec_str_to_int(?,-,?,?,?).
1411		dec_str_to_int(S,Precision,Res,Span,WF) :-
1412		atom_codes(S,Codes),
1413		split_chars(Codes,".",[Left|T]),
1414		(T=[] -> Right="", dec_str_to_int2(Left,Right,Precision,Res,Span,WF)
1415		; T = [Right] -> dec_str_to_int2(Left,Right,Precision,Res,Span,WF)
1416		; %add_error(external_functions,'Expecting integer or decimal number:',S,Span),fail
1417		add_wd_error_span('String contains multiple dots, expecting integer or decimal number for DEC_STRING_TO_INT:',S,Span,WF)
1418		).
1419
1420
1421		get_sign([45|T],-1,Res) :- !,strip_ws(T,Res).
1422		get_sign([32|T],PosNeg,Res) :- !, get_sign(T,PosNeg,Res).
1423		get_sign(L,1,L).
1424		strip_ws([32|T],R) :- !, strip_ws(T,R).
1425		strip_ws(R,R).
1426
1427	?	rounding([H|_]) :- member(H,"56789").
1428
1429		is_zero(48). % code of 0
1430		is_digit(Code) :- Code >= 48, Code =< 57.
1431		check_digits(Codes,_,_,Res) :- maplist(is_digit,Codes),!,Res=ok.
1432		check_digits(Codes,Span,WF,ko) :-
1433		append([39|Codes],[39],C2), atom_codes(A,C2), % generate atom with quotes
1434		%add_error(external_functions,'Illegal number: ',A,Span),fail.
1435		add_wd_error_span('String contains illegal characters, expecting integer or decimal number for DEC_STRING_TO_INT:',A,Span,WF).
1436
1437		dec_safe_number_codes(Number,[],_,_) :- !, Number=0.
1438		dec_safe_number_codes(Number,Codes,Span,WF) :-
1439		(safe_number_codes(Nr,Codes) -> Number=Nr
1440		; append([39|Codes],[39],C2), atom_codes(A,C2),
1441		%add_error(external_functions,'Cannot convert to number: ',A,Span),fail
1442		add_wd_error_span('Cannot convert string to number for DEC_STRING_TO_INT:',A,Span,WF),
1443		Number='$WDERROR$'
1444		).
1445
1446		dec_str_to_int2(Left,Right,Precision,Res,Span,WF) :-
1447		maplist(is_zero,Right), Precision >= 0,
1448		!,
1449		dec_safe_number_codes(LeftNumber,Left,Span,WF),
1450		(LeftNumber=='$WDERROR$' -> true
1451		; safe_is('DEC_STRING_TO_INT',Res,LeftNumber*(10^Precision),Span,WF)).
1452		dec_str_to_int2(Left,Right,Precision,Res,Span,WF) :- get_sign(Left,Sign,NewLeft),
1453		check_digits(NewLeft,Span,WF,Res1), check_digits(Right,Span,WF,Res2),
1454		(Res1==ok,Res2==ok
1455		-> shift(Precision,NewLeft,Right,ResL,ResR),
1456		dec_safe_number_codes(LeftInteger,ResL,Span,WF),
1457	?	(rounding(ResR)
1458		-> Res is Sign*(LeftInteger+1)
1459		; Res is Sign*LeftInteger)
1460		; true).
1461
1462		:- use_module(library(lists),[append_length/4]).
1463		% shift decimal values left or right depending on precision argument
1464		shift(0,Left,Right,Left,Right) :- !.
1465		shift(Pos,Left,Right,ResL,ResR) :- Pos>0,!,
1466		append(Left,Left2,ResL),
1467		length(Right,RLen),
1468		(RLen >= Pos -> append_length(Left2,ResR,Right,Pos) % take first Pos elements from R and shift left of .
1469		; append(Right,Zeros,Left2), % take all of Right and add Zeros
1470		ResR = [],
1471		NrZeros is Pos - RLen,
1472		length(Zeros,NrZeros), maplist(is_zero,Zeros)
1473		).
1474		shift(Pos,Left,Right,ResL,ResR) :- % Pos < 0
1475		length(Left,LLen), PPos is -Pos,
1476		(LLen >= PPos
1477		-> Shift is LLen-PPos, append_length(ResL,L2,Left,Shift), append(L2,Right,ResR)
1478		; %Result always 0.0...
1479		NrZeros is PPos - LLen,length(Zeros,NrZeros), maplist(is_zero,Zeros),
1480		ResL = "0",
1481		append(Zeros,LR,ResR),
1482		append(Left,Right,LR)).
1483
1484		:- public 'STRING_PADLEFT'/6.
1485		external_fun_has_wd_condition('STRING_PADLEFT').
1486		expects_waitflag('STRING_PADLEFT').
1487		expects_spaninfo('STRING_PADLEFT').
1488		external_fun_type('STRING_PADLEFT',[],[string,integer,string,string]).
1489		:- block 'STRING_PADLEFT'(-,?,?,?,?,?),'STRING_PADLEFT'(?,-,?,?,?,?),'STRING_PADLEFT'(?,?,-,?,?,?).
1490		'STRING_PADLEFT'(string(S),int(Width),string(PadChar),Res,Span,WF) :-
1491		string_pad_left(S,Width,PadChar,Res,Span,WF).
1492
1493		:- block string_pad_left(-,?,?,?,?,?),string_pad_left(?,-,?,?,?,?),string_pad_left(?,?,-,?,?,?).
1494		string_pad_left(_S,_Width,PadChar,_Res,Span,WF) :-
1495		atom_length(PadChar,Len), Len \= 1,
1496		!,
1497		add_wd_error_span('STRING_PADLEFT requires padding string of length 1: ',PadChar,Span,WF).
1498		string_pad_left(S,Width,PadChar,Res,_Span,_WF) :-
1499		atom_length(S,Len),
1500		(Len >= Width % no padding necessary
1501		-> Res = string(S)
1502		; ToPad is Width-Len,
1503		atom_codes(PadChar,[PadCode]),
1504		atom_codes(S,Codes),
1505		pad_char(ToPad,PadCode,PaddedCodes,Codes),
1506		atom_codes(ResStr,PaddedCodes),
1507		Res = string(ResStr)
1508		).
1509
1510		pad_char(0,_,Res,Tail) :- !, Res=Tail.
1511		pad_char(Nr,Code,[Code|TR],Tail) :- N1 is Nr-1, pad_char(N1,Code,TR,Tail).
1512
1513
1514
1515
1516		:- use_module(kernel_strings,[b_string_to_int_wf/4]).
1517		external_fun_has_wd_condition('STRING_TO_INT').
1518		expects_waitflag('STRING_TO_INT').
1519		expects_spaninfo('STRING_TO_INT').
1520		external_fun_type('STRING_TO_INT',[],[string,integer]).
1521		:- public 'STRING_TO_INT'/4.
1522		:- block 'STRING_TO_INT'(-,-,?,?).
1523		'STRING_TO_INT'(S,I,Span,WF) :- b_string_to_int_wf(S,I,Span,WF).
1524
1525
1526		:- use_module(kernel_strings,[int_to_b_string/2]).
1527		external_fun_type('INT_TO_STRING',[],[integer,string]).
1528		:- public 'INT_TO_STRING'/2.
1529		'INT_TO_STRING'(I,S) :- int_to_b_string(I,S).
1530
1531		:- use_module(kernel_strings,[int_to_dec_b_string/3, real_to_dec_b_string/4]).
1532		external_fun_type('INT_TO_DEC_STRING',[],[integer,integer,string]).
1533		:- public 'INT_TO_DEC_STRING'/3.
1534		'INT_TO_DEC_STRING'(I,Precision,S) :- int_to_dec_b_string(I,Precision,S).
1535
1536		external_fun_type('REAL_TO_DEC_STRING',[],[real,integer,string]).
1537		expects_spaninfo('REAL_TO_DEC_STRING').
1538		:- public 'REAL_TO_DEC_STRING'/4.
1539		'REAL_TO_DEC_STRING'(R,Precision,S,Span) :- real_to_dec_b_string(R,Precision,S,Span).
1540
1541		:- use_module(tools,[safe_read_term_from_atom/2]).
1542		% only for internal use in XTL mode! (used in execute by predicate to pass terms as parameters in a B predicate)
1543		external_fun_type('STRING_TO_TERM',[],[string,string]).
1544		:- public 'STRING_TO_TERM'/2.
1545		:- block 'STRING_TO_TERM'(-,?).
1546		'STRING_TO_TERM'(string(S),term(Term)) :-
1547		safe_read_term_from_atom(S,Term).
1548
1549
1550		:- use_module(kernel_strings,[to_b_string_with_type/3,to_b_string_with_type_and_options/4,format_to_b_string/3,format_to_b_string_with_type/4]).
1551		external_fun_type('TO_STRING',[X],[X,string]).
1552		expects_waitflag('TO_STRING').
1553		expects_spaninfo('TO_STRING').
1554		expects_unevaluated_args('TO_STRING').
1555		:- public 'TO_STRING'/5.
1556		'TO_STRING'(Value,S,[TExpr],Span,WF) :-
1557		get_large_finite_wait_flag(to_string,WF,AWF), %get_enumeration_finished_wait_flag(WF,AWF),
1558		tostring6(Value,TExpr,S,Span,WF,AWF).
1559
1560		:- block tostring6(-,?,?,?,?,-).
1561		tostring6(Value,TExpr,S,_,_WF,_AWF) :- (nonvar(Value); nonvar(S)),!,
1562		get_texpr_type(TExpr, Type),
1563		to_b_string_with_type(Value,Type,S).
1564		tostring6(Val,_,string(S),Span,WF,_) :-
1565		add_wd_error_span('Could not compute value in TO_STRING',Val,Span,WF),
1566		S = '<<WELL-DEF-ERROR>>'.
1567
1568		external_fun_type('TO_STRING_UNICODE',[X],[X,string]).
1569		expects_unevaluated_args('TO_STRING_UNICODE').
1570		:- public 'TO_STRING_UNICODE'/3.
1571		'TO_STRING_UNICODE'(Value,S,[TExpr]) :-
1572		get_texpr_type(TExpr, Type),
1573		to_b_string_with_type_and_options(Value,Type,[unicode],S).
1574
1575		external_fun_type('FORMAT_TO_STRING',[X],[string,seq(X),string]).
1576		expects_unevaluated_args('FORMAT_TO_STRING').
1577		:- public 'FORMAT_TO_STRING'/4.
1578		'FORMAT_TO_STRING'(FormatString,ListOfStrings,Res,[_,TExprs]) :-
1579		(get_texpr_type(TExprs, seq(Type)) % if the type of the given format args is a sequence we can use the contained type
1580		-> format_to_b_string_with_type(FormatString,ListOfStrings,Type,Res)
1581		; format_to_b_string(FormatString,ListOfStrings,Res)).
1582
1583
1584		external_fun_type('STRINGIFY',[X],[X,string]).
1585		expects_unevaluated_args('STRINGIFY').
1586		:- public 'PRETTY_PRINT_TO_STRING'/3.
1587		:- public 'STRINGIFY'/3.
1588		% pretty print a formula to string, the value is not used (but will currently be evaluated !)
1589		% TO DO: should we enforce a certain mode? (ascii, unicode, ...)
1590
1591		'PRETTY_PRINT_TO_STRING'(V,R,A) :- 'STRINGIFY'(V,R,A). % old name
1592		'STRINGIFY'(_Value,Res,[AST]) :-
1593		translate:translate_bexpression(AST,S),
1594		Res = string(S).
1595
1596		external_fun_type('HASH',[X],[X,integer]).
1597		:- public 'HASH'/2.
1598		:- block 'HASH'(-,?).
1599		'HASH'(Value,Int) :-
1600		% TO DO: use ground_value_check
1601		when(ground(Value),(term_hash(Value,H),Int=int(H))).
1602
1603
1604		external_fun_type('TO_INT',[X],[X,integer]). % can translate enumerated/deferred set elements to integer
1605		expects_waitflag('TO_INT').
1606		expects_spaninfo('TO_INT').
1607		:- public 'TO_INT'/4.
1608		:- block 'TO_INT'(-,?,?,?).
1609		'TO_INT'(fd(X,_),I,_,_) :- !, I=int(X).
1610		'TO_INT'(int(X),I,_,_) :- !, I=int(X).
1611		'TO_INT'(string(X),I,Span,WF) :- !, 'STRING_TO_INT'(string(X),I,Span,WF).
1612		'TO_INT'(Val,_,Span,_WF) :- !, translate:translate_bvalue(Val,VS),
1613		add_error(external_functions,'Illegal argument type for TO_INT:',VS,Span).
1614
1615
1616		external_fun_has_wd_condition('INT_TO_ENUM').
1617		expects_waitflag('INT_TO_ENUM').
1618		expects_spaninfo('INT_TO_ENUM').
1619		external_fun_type('INT_TO_ENUM',[T],[set(T),integer,T]).
1620		:- public 'INT_TO_ENUM'/5.
1621		:- block 'INT_TO_ENUM'(?,-,?,?,?),'INT_TO_ENUM'(-,?,?,?,?).
1622		'INT_TO_ENUM'(GSTypeExpr,int(I),Res,Span,WF) :-
1623		get_global_set_value_type(GSTypeExpr,'INT_TO_ENUM',GS),
1624		int2enum(GS,GSTypeExpr,I,Res,Span,WF).
1625		:- use_module(b_global_sets,[b_get_fd_type_bounds/3]).
1626
1627		:- use_module(library(clpfd), []). % for .. operator
1628		:- block int2enum(?,?,-,?,?,?).
1629		int2enum(GS,_,I,_,Span,WF) :-
1630		b_get_fd_type_bounds(GS,Low,Up),
1631		(I<Low ; integer(Up),I>Up),!,
1632		tools:ajoin(['INT_TO_ENUM integer value ',I,' is not in expected range for ',GS,' :'],Msg),
1633		add_wd_error_span(Msg,Low..Up,Span,WF).
1634		int2enum(GS,GSTypeExpr,I,Res,Span,WF) :- Res = fd(I,GS),
1635		membership_test_wf(GSTypeExpr,Res,MemTest,WF),
1636		check_value(MemTest,I,GS,Res,I,GSTypeExpr,Span,WF).
1637
1638		% -------------------------------
1639		% REGULAR EXPRESSION FUNCTIONS
1640		% Using ECMAScript syntax: http://www.cplusplus.com/reference/regex/ECMAScript/
1641
1642		:- use_module(extension('regexp/regexp'),
1643		[regexp_match/4, is_regexp/1, regexp_replace/5,
1644		regexp_search_first/4, regexp_search_first_detailed/5]).
1645		external_fun_type('REGEX_MATCH',[],[string,string,boolean]).
1646		expects_spaninfo('REGEX_MATCH').
1647		:- public 'REGEX_MATCH'/4, 'REGEX_IMATCH'/4.
1648		:- block 'REGEX_MATCH'(-,?,?,?), 'REGEX_MATCH'(?,-,?,?).
1649		'REGEX_MATCH'(string(String),string(Pattern),Res,Span) :-
1650		block_regex_match(String,Pattern,match_case,Res,Span).
1651
1652		external_fun_type('REGEX_IMATCH',[],[string,string,boolean]).
1653		expects_spaninfo('REGEX_IMATCH').
1654		:- block 'REGEX_IMATCH'(-,?,?,?), 'REGEX_IMATCH'(?,-,?,?).
1655		'REGEX_IMATCH'(string(String),string(Pattern),Res,Span) :-
1656		block_regex_match(String,Pattern,ignore_case,Res,Span).
1657
1658		:- block block_regex_match(-,?,?,?,?), block_regex_match(?,-,?,?,?).
1659		block_regex_match(String,Pattern,IgnoreCase,Res,Span) :-
1660		(regexp_match(String,Pattern,IgnoreCase,Span) -> Res=pred_true ; Res=pred_false).
1661
1662		external_fun_type('IS_REGEX',[],[string,boolean]).
1663		:- public 'IS_REGEX'/2.
1664		:- block 'IS_REGEX'(-,?).
1665		'IS_REGEX'(string(Pattern),Res) :- block_is_regexp(Pattern,Res).
1666		:- block block_is_regexp(-,?).
1667		block_is_regexp(Pattern,Res) :-
1668		(is_regexp(Pattern) -> Res=pred_true ; Res=pred_false).
1669
1670
1671		:- public 'GET_IS_REGEX'/2.
1672		:- public 'GET_IS_REGEX_MATCH'/4.
1673		:- public 'GET_IS_REGEX_IMATCH'/4.
1674		expects_spaninfo('GET_IS_REGEX_MATCH').
1675		expects_spaninfo('GET_IS_REGEX_IMATCH').
1676		% synonyms as use for functions to BOOL rather than predicates
1677		'GET_IS_REGEX'(A,Res) :- 'IS_REGEX'(A,Res).
1678		'GET_IS_REGEX_MATCH'(S1,S2,Res,Span) :- 'REGEX_MATCH'(S1,S2,Res,Span).
1679		'GET_IS_REGEX_IMATCH'(S1,S2,Res,Span) :- 'REGEX_IMATCH'(S1,S2,Res,Span).
1680
1681		external_fun_type('REGEX_REPLACE',[],[string,string,string,string]).
1682		:- public 'REGEX_REPLACE'/4.
1683		:- block 'REGEX_REPLACE'(-,?,?,?), 'REGEX_REPLACE'(?,-,?,?), 'REGEX_REPLACE'(?,?,-,?).
1684		'REGEX_REPLACE'(string(String),string(Pattern),string(ReplString),Res) :-
1685		block_regex_replace(String,Pattern,match_case,ReplString,Res).
1686
1687		external_fun_type('REGEX_IREPLACE',[],[string,string,string,string]).
1688		:- public 'REGEX_IREPLACE'/4.
1689		:- block 'REGEX_IREPLACE'(-,?,?,?), 'REGEX_IREPLACE'(?,-,?,?), 'REGEX_IREPLACE'(?,?,-,?).
1690		'REGEX_IREPLACE'(string(String),string(Pattern),string(ReplString),Res) :-
1691		block_regex_replace(String,Pattern,ignore_case,ReplString,Res).
1692
1693		:- block block_regex_replace(-,?,?,?,?), block_regex_replace(?,-,?,?,?), block_regex_replace(?,?,?,-,?).
1694		block_regex_replace(String,Pattern,IgnoreCase,ReplString,Result) :-
1695		regexp_replace(String,Pattern,IgnoreCase,ReplString,Res), Result=string(Res).
1696
1697
1698		external_fun_type('REGEX_SEARCH_STR',[],[string,string,string]).
1699		:- public 'REGEX_SEARCH_STR'/3, 'REGEX_ISEARCH_STR'/3.
1700		:- block 'REGEX_SEARCH_STR'(-,?,?), 'REGEX_SEARCH_STR'(?,-,?).
1701		'REGEX_SEARCH_STR'(string(String),string(Pattern),Res) :- block_regex_search_first(String,Pattern,match_case,Res).
1702		external_fun_type('REGEX_ISEARCH_STR',[],[string,string,string]).
1703		:- block 'REGEX_ISEARCH_STR'(-,?,?), 'REGEX_ISEARCH_STR'(?,-,?).
1704		'REGEX_ISEARCH_STR'(string(String),string(Pattern),Res) :- block_regex_search_first(String,Pattern,ignore_case,Res).
1705		:- block block_regex_search_first(-,?,?,?), block_regex_search_first(?,-,?,?).
1706		block_regex_search_first(String,Pattern,IgnoreCase,Result) :-
1707		regexp_search_first(String,Pattern,IgnoreCase,Res), Result=string(Res).
1708
1709		external_fun_type('REGEX_SEARCH',[],[string,integer,string,
1710		record([field(length,integer),field(position,integer),
1711		field(string,string),
1712		field(submatches,seq(string))])]).
1713		:- public 'REGEX_SEARCH'/4, 'REGEX_ISEARCH'/4.
1714		'REGEX_SEARCH'(S,From,Pat,Res) :- 'REGEX_SEARCH5'(S,From,Pat,match_case,Res).
1715		external_fun_type('REGEX_ISEARCH',TV,T) :- external_fun_type('REGEX_SEARCH',TV,T).
1716		'REGEX_ISEARCH'(S,From,Pat,Res) :- 'REGEX_SEARCH5'(S,From,Pat,ignore_case,Res).
1717
1718		:- block 'REGEX_SEARCH5'(-,?,?,?,?), 'REGEX_SEARCH5'(?,-,?,?,?), 'REGEX_SEARCH5'(?,?,-,?,?).
1719		'REGEX_SEARCH5'(string(String),int(From),string(Pattern),IgnoreCase,Res) :-
1720		block_regex_search_first_detailed(String,From,Pattern,IgnoreCase,Res).
1721
1722		:- block block_regex_search_first_detailed(-,?,?,?,?),
1723		block_regex_search_first_detailed(?,-,?,?,?), block_regex_search_first_detailed(?,?,-,?,?).
1724		block_regex_search_first_detailed(String,FromIndex,Pattern,IgnoreCase,Result) :-
1725		regexp_search_first_detailed(String,FromIndex,Pattern,IgnoreCase,Res),
1726		construct_match_result(Res,Result).
1727
1728		construct_match_result(match(Pos,Len,[Str|SubMatches]),Res) :- !,
1729		BPos is Pos+1,
1730		maplist(mkstring,SubMatches,SubMatchesStr),
1731		convert_list_to_seq(SubMatchesStr,SubList),
1732		Res = rec([field(length,int(Len)), field(position,int(BPos)),
1733		field(string,string(Str)), field(submatches,SubList)]).
1734		construct_match_result('no-match',Res) :- !,
1735		Res = rec([field(length,int(-1)), field(position,int(-1)), field(string,string('')), field(submatches,[])]).
1736
1737		mkstring(A,string(A)).
1738
1739		:- use_module(extension('regexp/regexp'), [regexp_search_all/4]).
1740		external_fun_type('REGEX_SEARCH_ALL',[],[string,string,seq(string)]).
1741		:- public 'REGEX_SEARCH_ALL'/3, 'REGEX_ISEARCH_ALL'/3.
1742		:- block 'REGEX_SEARCH_ALL'(-,?,?), 'REGEX_SEARCH_ALL'(?,-,?).
1743		'REGEX_SEARCH_ALL'(string(String),string(Pattern),Res) :- block_regex_search_all(String,Pattern,match_case,Res).
1744
1745		external_fun_type('REGEX_ISEARCH_ALL',[],[string,string,seq(string)]).
1746		:- block 'REGEX_ISEARCH_ALL'(-,?,?), 'REGEX_ISEARCH_ALL'(?,-,?).
1747		'REGEX_ISEARCH_ALL'(string(String),string(Pattern),Res) :- block_regex_search_all(String,Pattern,ignore_case,Res).
1748
1749		:- block block_regex_search_all(-,?,?,?), block_regex_search_all(?,-,?,?).
1750		block_regex_search_all(String,Pattern,IgnoreCase,Result) :-
1751		regexp_search_all(String,Pattern,IgnoreCase,Matches),
1752		maplist(mkstring,Matches,MatchesStr),
1753		convert_list_to_seq(MatchesStr,Result).
1754
1755
1756		% -------------------------------
1757
1758		external_fun_type('SHA_HASH',[X],[X,set(couple(integer,integer))]).
1759		expects_waitflag('SHA_HASH').
1760		:- use_module(extension('probhash/probhash'),[raw_sha_hash/2]).
1761		:- use_module(store,[normalise_value_for_var/3]).
1762		:- public 'SHA_HASH'/3.
1763		:- block 'SHA_HASH'(-,?,?).
1764		'SHA_HASH'(Value,Res,WF) :-
1765		normalise_value_for_var('SHA_HASH',Value,NValue),
1766		ground_value_check(NValue,Gr),
1767		sha_hash(NValue,Gr,Res,WF).
1768		:- block sha_hash(?,-,?,?).
1769		sha_hash(Value,_,Res,WF) :-
1770		raw_sha_hash(Value,List),
1771		convert_to_int_seq(List,1,Seq),
1772		equal_object_optimized_wf(Seq,Res,'SHA_HASH',WF).
1773
1774		convert_to_int_seq([],_,[]).
1775		convert_to_int_seq([H|T],N,[(int(N),int(H))|CT]) :- N1 is N+1, convert_to_int_seq(T,N1,CT).
1776
1777		external_fun_type('SHA_HASH_HEX',[X],[X,string]).
1778		:- public 'SHA_HASH_HEX'/2.
1779		:- block 'SHA_HASH_HEX'(-,?).
1780		'SHA_HASH_HEX'(Value,Res) :-
1781		normalise_value_for_var('SHA_HASH_HEX',Value,NValue),
1782		ground_value_check(NValue,Gr),
1783		sha_hash_string(NValue,Gr,Res).
1784		:- block sha_hash_string(?,-,?).
1785		sha_hash_string(Value,_,Res) :-
1786		sha_hash_as_hex_codes(Value,SHAHexCodes), atom_codes(Atom,SHAHexCodes),
1787		Res = string(Atom).
1788
1789		:- use_module(extension('probhash/probhash'),[raw_sha_hash_file/3]).
1790		performs_io('SHA_HASH_FILE_HEX').
1791		expects_spaninfo('SHA_HASH_FILE_HEX').
1792		external_fun_type('SHA_HASH_FILE_HEX',[],[string,string]).
1793		:- public 'SHA_HASH_FILE_HEX'/3.
1794		:- block 'SHA_HASH_FILE_HEX'(-,?,?).
1795		'SHA_HASH_FILE_HEX'(string(File),Res,Span) :-
1796		sha_hash_file(File,Res,Span).
1797		:- block sha_hash_file(-,?,?).
1798		sha_hash_file(File,Res,Span) :-
1799		b_absolute_file_name(File,AFile),
1800		raw_sha_hash_file(AFile,Term,Span),
1801		get_hex_bytes(Term,SHAHexCodes), atom_codes(Atom,SHAHexCodes),
1802		Res = string(Atom).
1803
1804		% -------------------------------
1805
1806		% STRING FILE SYSTEM FUNCTIONS
1807
1808
1809		:- use_module(kernel_objects).
1810		:- use_module(library(file_systems)).
1811		performs_io('FILES').
1812		external_fun_type('FILES',[],[string,set(string)]).
1813		:- public 'FILES'/2.
1814		:- block 'FILES'(-,?).
1815		'FILES'(string(A),L) :- files2(A,L).
1816		:- block files2(-,?).
1817		files2(Dir,List) :- b_absolute_file_name(Dir,ADir),
1818		findall(string(F),file_member_of_directory(ADir,F,_FLong),L),
1819		equal_object_optimized(L,List,files2).
1820		performs_io('FULL_FILES').
1821		external_fun_type('FULL_FILES',[],[string,set(string)]).
1822		:- public 'FULL_FILES'/2.
1823		:- block 'FULL_FILES'(-,?).
1824		'FULL_FILES'(string(A),L) :- full_files2(A,L).
1825		:- block full_files2(-,?).
1826		full_files2(Dir,List) :-
1827		b_absolute_file_name(Dir,ADir),
1828		findall(string(FLong),file_member_of_directory(ADir,_F,FLong),L),
1829		equal_object_optimized(L,List,full_files2).
1830
1831
1832		performs_io('DIRECTORIES').
1833		external_fun_type('DIRECTORIES',[],[string,set(string)]).
1834		:- public 'DIRECTORIES'/2.
1835		:- block 'DIRECTORIES'(-,?).
1836		'DIRECTORIES'(string(A),L) :- dir2(A,L).
1837		:- block dir2(-,?).
1838		dir2(Dir,List) :- b_absolute_file_name(Dir,ADir),
1839		findall(string(F),directory_member_of_directory(ADir,F,_FLong),L),
1840		equal_object_optimized(L,List,dir2).
1841		performs_io('FULL_DIRECTORIES').
1842		external_fun_type('FULL_DIRECTORIES',[],[string,set(string)]).
1843		:- public 'FULL_DIRECTORIES'/2.
1844		:- block 'FULL_DIRECTORIES'(-,?).
1845		'FULL_DIRECTORIES'(string(A),L) :- full_dir2(A,L).
1846		:- block full_dir2(-,?).
1847		full_dir2(Dir,List) :- b_absolute_file_name(Dir,ADir),
1848		findall(string(FLong),directory_member_of_directory(ADir,_,FLong),L),
1849		equal_object_optimized(L,List,full_dir2).
1850
1851		:- public 'GET_FILE_EXISTS'/2.
1852		'GET_FILE_EXISTS'(S,PREDRES) :- 'FILE_EXISTS'(S,PREDRES). % synonym as external function
1853		performs_io('FILE_EXISTS').
1854		external_fun_type('FILE_EXISTS',[],[string,boolean]).
1855		:- public 'FILE_EXISTS'/2.
1856		:- block 'FILE_EXISTS'(-,?).
1857		'FILE_EXISTS'(string(A),PREDRES) :- file_exists2(A,PREDRES).
1858		:- block file_exists2(-,?).
1859		file_exists2(A,PREDRES) :- b_absolute_file_name(A,AA),
1860		(file_exists(AA) -> PREDRES=pred_true ; PREDRES=pred_false).
1861
1862		:- public 'GET_DIRECTORY_EXISTS'/2.
1863		'GET_DIRECTORY_EXISTS'(S,PREDRES) :- 'DIRECTORY_EXISTS'(S,PREDRES). % synonym as external function
1864		performs_io('DIRECTORY_EXISTS').
1865		external_fun_type('DIRECTORY_EXISTS',[],[string,boolean]).
1866		:- public 'DIRECTORY_EXISTS'/2.
1867		:- block 'DIRECTORY_EXISTS'(-,?).
1868		'DIRECTORY_EXISTS'(string(A),PREDRES) :- dir_exists2(A,PREDRES).
1869		:- block dir_exists2(-,?).
1870		dir_exists2(A,PREDRES) :- b_absolute_file_name(A,AA),
1871		(directory_exists(AA) -> PREDRES=pred_true ; PREDRES=pred_false).
1872
1873		:- use_module(tools,[get_parent_directory/2]).
1874		% a variant of the predicate b_absolute_file_name_relative_to_main_machine in bmachine using safe_call (with span):
1875		b_absolute_file_name(File,AbsFileName) :- b_absolute_file_name(File,AbsFileName,unknown).
1876		b_absolute_file_name(File,AbsFileName,Span) :-
1877		bmachine:b_get_main_filename(MainFileName),!,
1878		get_parent_directory(MainFileName,Directory),
1879		% in Jupyter main file is (machine from Jupyter cell).mch, which confuses SICStus as the file does not exist
1880		safe_call(
1881		absolute_file_name(File,AbsFileName,[relative_to(Directory)]),
1882		Span).
1883		b_absolute_file_name(File,AbsFileName,Span) :-
1884		% call is executed without machine context; we could simply throw an error and fail
1885		safe_call(
1886		absolute_file_name(File,AbsFileName),
1887		Span).
1888
1889		:- public 'GET_FILE_PROPERTY'/3.
1890		'GET_FILE_PROPERTY'(S1,S2,PREDRES) :- 'FILE_PROPERTY'(S1,S2,PREDRES). % synonym as external function
1891		performs_io('FILE_PROPERTY').
1892		external_fun_type('FILE_PROPERTY',[],[string,string,boolean]).
1893		:- public 'FILE_PROPERTY'/3.
1894		:- block 'FILE_PROPERTY'(-,?,?), 'FILE_PROPERTY'(?,-,?).
1895		'FILE_PROPERTY'(string(A),string(P),BoolRes) :-
1896		file_property2(A,P,BoolRes).
1897		:- block file_property2(-,?,?), file_property2(?,-,?).
1898		file_property2(File,Prop,BoolRes) :-
1899		b_absolute_file_name(File,AFile),
1900		file_property(AFile,Prop) -> BoolRes=pred_true ; BoolRes=pred_false.
1901		% possible properties: readable, writable, executable
1902
1903		performs_io('FILE_PROPERTY_VALUE').
1904		external_fun_type('FILE_PROPERTY_VALUE',[],[string,string,integer]).
1905		:- public 'FILE_PROPERTY_VALUE'/3.
1906		:- block 'FILE_PROPERTY_VALUE'(-,?,?), 'FILE_PROPERTY_VALUE'(?,-,?).
1907		'FILE_PROPERTY_VALUE'(string(A),string(P),int(R)) :-
1908		file_property_val2(A,P,R).
1909		:- block file_property_val2(-,?,?), file_property_val2(?,-,?).
1910		file_property_val2(File,Prop,Res) :-
1911		b_absolute_file_name(File,AFile),
1912		file_property(AFile,Prop,Val) -> Res=Val
1913		; add_error(external_functions,'Illegal FILE_PROPERTY',Prop),Res=int(-1).
1914		% possible properties:
1915		% size_in_bytes, create_timestamp, modify_timestamp, access_timestamp
1916		% + on unix the follwing is also an integer: owner_user_id, owner_group_id
1917
1918		:- public 'GET_DIRECTORY_PROPERTY'/3.
1919		'GET_DIRECTORY_PROPERTY'(S1,S2,PREDRES) :- 'DIRECTORY_PROPERTY'(S1,S2,PREDRES). % synonym as external function
1920		performs_io('DIRECTORY_PROPERTY').
1921		external_fun_type('DIRECTORY_PROPERTY',[],[string,string,boolean]).
1922		:- public 'DIRECTORY_PROPERTY'/3.
1923		:- block 'DIRECTORY_PROPERTY'(-,?,?), 'DIRECTORY_PROPERTY'(?,-,?).
1924		'DIRECTORY_PROPERTY'(string(A),string(P),BoolRes) :-
1925		dir_property2(A,P,BoolRes).
1926		:- block dir_property2(-,?,?), dir_property2(?,-,?).
1927		dir_property2(File,Prop,BoolRes) :-
1928		b_absolute_file_name(File,AFile),
1929		directory_property(AFile,Prop) -> BoolRes=pred_true ; BoolRes=pred_false.
1930
1931		performs_io('DIRECTORY_PROPERTY_VALUE').
1932		external_fun_type('DIRECTORY_PROPERTY_VALUE',[],[string,string,integer]).
1933		:- public 'DIRECTORY_PROPERTY_VALUE'/3.
1934		:- block 'DIRECTORY_PROPERTY_VALUE'(-,?,?), 'DIRECTORY_PROPERTY_VALUE'(?,-,?).
1935		'DIRECTORY_PROPERTY_VALUE'(string(A),string(P),int(R)) :-
1936		dir_property_val2(A,P,R).
1937		:- block dir_property_val2(-,?,?), dir_property_val2(?,-,?).
1938		dir_property_val2(File,Prop,Res) :-
1939		b_absolute_file_name(File,AFile),
1940		directory_property(AFile,Prop,Val) -> Res=Val
1941		; add_error(external_functions,'Illegal DIRECTORY_PROPERTY',Prop), Res=int(-1).
1942		% --------------------------------
1943
1944		% I/O
1945
1946
1947		% printf as predicate; can also be used as a function to BOOL
1948		expects_spaninfo('fprintf').
1949		external_pred_always_true('fprintf').
1950		:- public fprintf/5.
1951		:- block fprintf(-,?,?,?,?), fprintf(?,-,?,?,?), fprintf(?,?,-,?,?).
1952		fprintf(string(File),string(FormatString),Value,PredRes,Span) :- !, PredRes = pred_true,
1953		when((ground(FormatString),ground(Value)),
1954		fprintf2(File,FormatString,Value,Span)).
1955		fprintf(File,F,V,P,S) :- add_internal_error('Illegal call: ',fprintf(File,F,V,P,S)), P=pred_true.
1956
1957		expects_spaninfo('printf_opt_trace').
1958		external_pred_always_true('printf_opt_trace').
1959		:- public printf_opt_trace/5.
1960		:- block printf_opt_trace(-,?,?,?,?), printf_opt_trace(?,-,?,?,?).
1961		printf_opt_trace(string(FormatString),Value,Trace,PredRes,Span) :- !, PredRes = pred_true,
1962		when((ground(FormatString),ground(Value)),
1963		(fprintf2(user_output,FormatString,Value,Span),
1964		(Trace==pred_true -> try_trace ; true)
1965		)
1966		).
1967		printf_opt_trace(F,V,T,P,S) :- add_internal_error('Illegal call: ',printf_opt_trace(F,V,T,P,S)), P=pred_true.
1968
1969		% try to perform trace commend if we are not in compiled version
1970		try_trace :-
1971		catch(trace, error(existence_error(_,_),_), (
1972		format('Cannot trace into source code in compiled version of ProB!~n<<<Type RETURN-Key to continue>>>',[]),
1973		read_line(user_input,_),nl
1974		)).
1975
1976		expects_spaninfo('printf').
1977		external_pred_always_true('printf').
1978		external_fun_type('printf',[T],[string,seq(T),boolean]).
1979
1980		:- assert_must_succeed(external_functions:printf(string('test ok = ~w~n'),[(int(1),pred_true)],pred_true,unknown)).
1981		:- block printf(-,?,?,?), printf(?,-,?,?).
1982		printf(string(FormatString),Value,PredRes,Span) :- !, PredRes = pred_true,
1983		when((ground(FormatString),ground(Value)),
1984		fprintf2(user_output,FormatString,Value,Span)).
1985		printf(F,V,P,S) :- add_internal_error('Illegal call: ',printf(F,V,P,S)), P=pred_true.
1986
1987		expects_spaninfo('printf_two'). % print two values, triggers as soon as first value is known
1988		external_pred_always_true('printf_two').
1989		:- assert_must_succeed(external_functions:printf_two(string('test ok = ~w~n'),[(int(1),pred_true)],string('test ok = ~w~n'),[(int(1),pred_true)],pred_true,unknown)).
1990		:- public printf_two/6.
1991		:- block printf_two(-,?,?,?,?,?), printf_two(?,-,?,?,?,?).
1992		printf_two(string(FormatString),Value,string(FormatString2),Value2,PredRes,Span) :- !, PredRes = pred_true,
1993		when((ground(FormatString),ground(Value)),
1994		(fprintf2(user_output,FormatString,Value,Span),
1995		fprintf2(user_output,FormatString2,Value2,Span))).
1996		printf_two(F,V,F2,V2,P,S) :- add_internal_error('Illegal call: ',printf_two(F,V,F2,V2,P,S)), P=pred_true.
1997
1998
1999		expects_spaninfo('printf_nonvar'). % print as soon as value becomes nonvar (printf waits until the value is ground)
2000		external_pred_always_true('printf_nonvar').
2001		:- public printf_nonvar/4.
2002		:- block printf_nonvar(-,?,?,?), printf_nonvar(?,-,?,?).
2003		printf_nonvar(string(FormatString),Value,PredRes,Span) :- !, PredRes = pred_true,
2004		when((ground(FormatString),nonvar(Value)),
2005		fprintf2(user_output,FormatString,Value,Span)).
2006		printf_nonvar(F,V,P,S) :- add_internal_error('Illegal call: ',printf(F,V,P,S)), P=pred_true.
2007
2008
2009		expects_spaninfo('dprintf'). % a version of printf which delays setting itself to TRUE until printing is performed
2010		external_pred_always_true('dprintf').
2011		:- public dprintf/4.
2012		:- block dprintf(-,?,?,?), dprintf(?,-,?,?).
2013		dprintf(string(FormatString),Value,PredRes,Span) :- !,
2014		when((ground(FormatString),ground(Value)),
2015		(fprintf2(user_output,FormatString,Value,Span),PredRes = pred_true)).
2016		dprintf(F,V,P,S) :- add_internal_error('Illegal call: ',dprintf(F,V,P,S)), P=pred_true.
2017
2018		:- use_module(kernel_strings,[convert_b_sequence_to_list_of_atoms/3]).
2019		fprintf2(File,FormatString,Value,Span) :-
2020		convert_b_sequence_to_list_of_atoms(Value,ListOfAtoms,Done),
2021		when(nonvar(Done),
2022		(file_format(File,FormatString,ListOfAtoms,Span),
2023		print_hash((FormatString,Value)),
2024		print_stats,
2025		fprint_log_info(File,Span)
2026		)).
2027		%fprintf2(File,FormatString,Value,Span) :- print('BACKTRACKING ') , file_format(File,FormatString,['?'],Span),nl,fail.
2028		% warning: format can call an argument as goal with ~@; this is dangerous
2029		% and we should prohibit this
2030		% Luckily PRINTF("@: <>~@<>~n","print(danger)") where print(danger)
2031		% is arbitrary code is not a security exploit:
2032		% our PRINTF translates the argument to an atom, i.e., one could
2033		% only call Prolog predicates without arguments, anything else leads to an exception
2034		% (even PRINTF("@: <>~@<>~n","nl") leads to an exception)
2035
2036
2037		:- use_module(hashing,[my_term_hash/2]).
2038		% optionally print hash and allow breakpoints
2039		print_hash(V) :-
2040		external_fun_pref(printf_hash,'TRUE'), % use SET_PREF("printf_hash","TRUE")
2041		!,
2042		my_term_hash(V,H), format('% HASH = ~w~n',H),
2043		%((H = 158201315 ; H=29759067) -> trace ; true),
2044		true.
2045		print_hash(_).
2046
2047
2048		:- use_module(probsrc(tools),[statistics_memory_used/1]).
2049		:- dynamic nr_of_printfs/1.
2050		nr_of_printfs(0).
2051		print_stats :-
2052		external_fun_pref(printf_stats,PFS), % use SET_PREF("printf_stats","TRUE")
2053		PFS='TRUE',
2054		retract(nr_of_printfs(N)),
2055		!,
2056		N1 is N+1,
2057		assertz(nr_of_printfs(N1)),
2058		statistics(walltime,[X,SL]),
2059		statistics_memory_used(M), MB is M / 1000000, % used instead of deprecated 1048576,
2060		statistics(gc_count,GCs),
2061		format('% Call ~w at walltime ~w ms (since last ~w ms), memory ~3f MB (~w GCs)~n',[N1,X,SL,MB,GCs]).
2062		print_stats.
2063
2064		:- dynamic external_fun_pref/2.
2065		% valid keys: log_info
2066		valid_external_fun_pref(log_info).
2067		valid_external_fun_pref(printf_stats).
2068		valid_external_fun_pref(printf_hash).
2069
2070		fprint_log_info(File,Span) :- external_fun_pref(log_info,X),
2071		'GET_INFO'(string(X),string(Res)),
2072		file_format(File,'%%% ~w~n',[Res],Span).
2073		fprint_log_info(_,_).
2074
2075		% example usage SET_PREF("log_info","time") or SET_PREF("printf_stats","TRUE")
2076		external_fun_type('SET_PREF',[],[string,string,boolean]).
2077		:- public 'SET_PREF'/3.
2078		:- block 'SET_PREF'(-,?,?), 'SET_PREF'(?,-,?).
2079		'SET_PREF'(string(S),string(Val),R) :-
2080		preferences:eclipse_preference(S,Pref),!, R=pred_true,
2081		format('Setting ProB preference ~w := ~w~n',[S,Val]),
2082		preferences:set_preference(Pref,Val).
2083		'SET_PREF'(string(S),string(Val),R) :- valid_external_fun_pref(S),!,
2084		R=pred_true,
2085		retractall(external_fun_pref(S,_)),
2086		format('Setting external function preference ~w := ~w~n',[S,Val]),
2087		assertz(external_fun_pref(S,Val)).
2088		'SET_PREF'(P,V,R) :-
2089		add_internal_error('Illegal call: ','SET_PREF'(P,V,R)), R=pred_false.
2090
2091		external_fun_type('GET_PREF',[],[string,string]).
2092		expects_waitflag('GET_PREF').
2093		expects_spaninfo('GET_PREF').
2094		:- assert_must_succeed(external_functions:'GET_PREF'(string('CLPFD'),string(_),unknown,_)).
2095		:- public 'GET_PREF'/4.
2096		'GET_PREF'(Str,Res,Span,WF) :-
2097		kernel_waitflags:get_wait_flag(10,'GET_PREF',WF,WF10), % will enumerate possible input strings
2098	?	get_pref2(Str,Res,_,WF10,Span).
2099		external_fun_type('GET_PREF_DEFAULT',[],[string,string]).
2100		expects_waitflag('GET_PREF_DEFAULT').
2101		expects_spaninfo('GET_PREF_DEFAULT').
2102		:- assert_must_succeed(external_functions:'GET_PREF_DEFAULT'(string('CLPFD'),string(true),unknown,_)).
2103		:- public 'GET_PREF_DEFAULT'/4.
2104		'GET_PREF_DEFAULT'(Str,Res,Span,WF) :-
2105		(nonvar(Str) -> true
2106		; kernel_waitflags:get_wait_flag(10,'GET_PREF',WF,WF10)), % will enumerate possible input strings
2107	?	get_pref2(Str,_,Res,WF10,Span).
2108
2109		:- block get_pref2(-,?,?,-,?).
2110		get_pref2(string(S),Res,Res2,_,Span) :-
2111	?	if((preferences:eclipse_preference(S,Pref),
2112		preferences:get_preference(Pref,Val),
2113		preferences:preference_default_value(Pref,DefVal)),
2114		(make_string(Val,Res),make_string(DefVal,Res2)),
2115		(add_error(external_functions,'Illegal argument for GET_PREF: ',S,Span),
2116		fail)).
2117
2118
2119		% printf followed by fail; useful for print fail loops in the REPL
2120		expects_spaninfo('printfail').
2121		:- assert_must_fail(external_functions:printfail(string('test ok = ~w~n'),[(int(1),pred_true)],pred_true,unknown)).
2122		:- block printfail(-,?,?,?), printfail(?,-,?,?).
2123		printfail(string(FormatString),Value,PredRes,Span) :- !, PredRes = pred_true,
2124		when((ground(FormatString),ground(Value)),
2125		(fprintf2(user_output,FormatString,Value,Span),fail)).
2126		printfail(F,V,P,S) :-
2127		add_internal_error('Illegal call: ',printfail(F,V,P,S)), P=pred_true.
2128
2129		% a version of printf with automatic indenting and backtracking feedback
2130		expects_spaninfo('iprintf').
2131		external_pred_always_true('iprintf').
2132		:- assert_must_succeed(external_functions:iprintf(string('test ok = ~w~n'),[(int(1),pred_true)],pred_true,unknown)).
2133		:- block iprintf(-,?,?,?), iprintf(?,-,?,?).
2134		iprintf(string(FormatString),Value,PredRes,Span) :- !, PredRes = pred_true,
2135	?	when((ground(FormatString),ground(Value)),
2136		ifprintf2(user_output,FormatString,Value,no_trace,Span)).
2137		iprintf(F,V,P,S) :- add_internal_error('Illegal call: ',iprintf(F,V,P,S)), P=pred_true.
2138		ifprintf2(File,FormatString,Value,Trace,Span) :-
2139		my_term_hash((FormatString,Value),Hash),
2140		format(user_output,'[hash ~w] ',[Hash]), % (Hash=1087266573122589201 -> (trace ; trace,fail) ; true),
2141		translate:translate_bvalue(Value,TV),
2142	?	indent_format(File,FormatString,[TV],Trace),
2143		fprint_log_info(File,Span).
2144		expects_spaninfo('itprintf').
2145		external_pred_always_true('itprintf').
2146		:- public itprintf/4.
2147		:- block itprintf(-,?,?,?), itprintf(?,-,?,?).
2148		itprintf(string(FormatString),Value,PredRes,Span) :- PredRes = pred_true,
2149		when((ground(FormatString),ground(Value)),
2150		ifprintf2(user_output,FormatString,Value,trace,Span)).
2151
2152		% ---------------
2153
2154		% a more light-weight version of observe_indent below
2155		:- public observe/5.
2156		expects_spaninfo('observe').
2157		expects_unevaluated_args('observe').
2158		expects_waitflag('observe').
2159		external_pred_always_true('observe').
2160		external_fun_type('observe',[T],[T,boolean]).
2161		observe(Value,PredRes,[Arg],Span,WF) :-
2162		observe6(Value,PredRes,[Arg],Span,_,WF).
2163
2164		% a version which does not print instantiations; just registers them and the patterns
2165		% can be inspected later with -prob-profile (calling portray_instantiations)
2166		:- public observe_silent/5.
2167		expects_spaninfo('observe_silent').
2168		expects_unevaluated_args('observe_silent').
2169		expects_waitflag('observe_silent').
2170		external_pred_always_true('observe_silent').
2171		external_fun_type('observe_silent',[T],[T,boolean]).
2172		observe_silent(Value,PredRes,[Arg],Span,WF) :-
2173		observe6(Value,PredRes,[Arg],Span,silent,WF).
2174
2175		observe6(Value,PredRes,[Arg],_Span,IndentVar,WF) :-
2176		observe_couples(Value,Arg,IndentVar,WF),
2177		PredRes=pred_true,
2178		(Arg\=b(couple(_,_),_,_)
2179		-> true
2180		; translate_bexpression(Arg,AS),
2181		ground_value_check(Value,GrVal),
2182		block_print_value_complete(GrVal,AS,Value,IndentVar,WF)
2183		).
2184
2185		observe_couples((V1,V2),b(couple(A1,A2),_,_),IndentVar,WF) :- !,
2186		observe_couples(V1,A1,IndentVar,WF),
2187		observe_couples(V2,A2,IndentVar,WF).
2188		observe_couples(Val,Arg,IndentVar,WF) :-
2189		translate_bexpression(Arg,ArgString),
2190		(IndentVar==silent -> true ; format(user_output,' observing ~w~n',[ArgString])), % for values we could print_span
2191		ground_value_check(Val,GrVal),
2192		block_print_value(GrVal,ArgString,Val,IndentVar,WF).
2193
2194		:- block block_print_value(-,?,?,?,?).
2195		block_print_value(_,ArgString,V,IndentVar,WF) :-
2196		print_value(ArgString,V,IndentVar,WF).
2197		print_value(ArgString,V,IndentVar,WF) :-
2198		register_instantiation_wf(ArgString,WF),
2199		(IndentVar==silent -> true
2200		; translate_bvalue(V,VS), statistics(walltime,[WT,_]),
2201		get_wf_summary(WF,WS),
2202		indent_var(IndentVar),
2203		format(user_output,' ~w = ~w (walltime: ~w ms) ~w~n',[ArgString,VS,WT,WS])
2204		%,set_prolog_flag(profiling,on), print_profile
2205		).
2206		:- block block_print_value_complete(-,?,?,?,?).
2207		block_print_value_complete(_,ArgString,V,IndentVar,WF) :- print_value_complete(ArgString,V,IndentVar,WF).
2208		print_value_complete(ArgString,V,IndentVar,WF) :-
2209		register_instantiation_wf(ArgString,WF),
2210		(IndentVar==silent -> true
2211		; translate_bvalue(V,VS), statistics(walltime,[WT,_]),
2212		get_wf_summary(WF,WS),
2213		indent_var(IndentVar),
2214		format(user_output,'* Value complete: ~w = ~w (walltime: ~w ms) ~w~n------~n',[ArgString,VS,WT,WS])
2215		%,set_prolog_flag(profiling,on), print_profile,trace
2216		).
2217		% TODO: determine indentation based on overall instantiation of full value
2218
2219		:- use_module(kernel_waitflags,[get_minimum_waitflag_prio/3]).
2220		get_wf_summary(WF,R) :- debug_mode(on),get_minimum_waitflag_prio(WF,MinPrio,_Info),!, R=MinPrio.
2221		get_wf_summary(_,'').
2222
2223		% TODO: store indent var in WF store; so that we can share results/indentation amongst multiple observes
2224		% indent based upon a shared variable and increment it; it displays indentation locally for every observe call
2225		% using put_wf_dynamic_info we could display it for every WF store
2226		indent_var(X) :- var(X),!, X=inst(_). %, register_instantiation(ArgStr,Pred,Level).
2227		indent_var(inst(X)) :- !,print('.'), indent_var(X).
2228		indent_var(_) :- print('***').
2229
2230		% a small utility to observe list of atomic variable names with Prolog value terms
2231		% can be used on Ids,Vars for calls to set_up_localstate(Ids,Vars,LocalState,LetState)
2232		:- public observe_variables/2. %useful for debugging
2233		observe_variables(ListOfIDs,ListOfVals) :- observe_variables(ListOfIDs,ListOfVals,_).
2234		observe_variables([],[],_).
2235		observe_variables([TID|T],[Val|TV],IndentVar) :-
2236		(atomic(TID) -> ID=TID ; get_texpr_id(TID,ID) -> true ; ID=TID),
2237		ground_value_check(Val,GrVal),
2238		block_print_value(GrVal,ID,Val,IndentVar,no_wf_available),
2239		observe_variables(T,TV,IndentVar).
2240
2241		:- dynamic instantiation_link/4, instantiation_level_reached/1.
2242		% keep track of how variables are instantiated in which order
2243		register_instantiation(ArgStr,Pred,Level) :-
2244		(instantiation_level_reached(Level) -> true ; assertz(instantiation_level_reached(Level))),
2245		(retract(instantiation_link(Pred,ArgStr,Level,Hits))
2246		-> H1 is Hits+1
2247		; H1 is 1),
2248		assertz(instantiation_link(Pred,ArgStr,Level,H1)).
2249
2250		:- use_module(probsrc(preferences), [get_preference/2]).
2251		register_instantiation_wf(ArgInstantiated,WF) :-
2252		(get_wf_dynamic_info(WF,instantiation_info,lvl_prev(Level,PrevArgInstantiated))
2253		-> true
2254		; Level=0,
2255		(get_preference(provide_trace_information,false)
2256		-> Infos=[] % only have one virtual root
2257		; get_wait_flag_infos(WF,Infos) %portray_wait_flag_infos(Infos),
2258		% Warning: these Infos can be large terms which get asserted below; they contain the call-stack
2259		),
2260		PrevArgInstantiated = root(Infos)
2261		),
2262		register_instantiation(ArgInstantiated,PrevArgInstantiated,Level),
2263		L1 is Level+1,
2264		put_wf_dynamic_info(WF,instantiation_info,lvl_prev(L1,ArgInstantiated)).
2265
2266		reset_observe :- retractall(instantiation_level_reached(_)),
2267		retractall(instantiation_link(_,_,_,_)).
2268
2269		portray_instantiations :-
2270		(instantiation_level_reached(0) -> true),
2271		format('--- ProB instantiation patterns observed ---~n',[]),
2272		instantiation_link(root(Infos),_,0,_),
2273		format('*PATTERNS*~n',[]),
2274		portray_wait_flag_infos(Infos),
2275		(Infos=[],get_preference(provide_trace_information,false)
2276		-> format(' (Set TRACE_INFO preference to TRUE to obtain more information.)~n',[])
2277		; true),
2278		portray_inst(0,root(Infos)),
2279		fail.
2280		portray_instantiations.
2281
2282		% portray how the instantiations occurred
2283		portray_inst(Level,ArgStr) :-
2284		instantiation_link(ArgStr,Successor,Level,Hits),
2285		i_indent(Level), format(' ~w hits : ~w~n',[Hits,Successor]),
2286		L1 is Level+1,
2287		portray_inst(L1,Successor).
2288
2289		i_indent(X) :- X < 1, !, write('->').
2290		i_indent(X) :- write('-+'), X1 is X-1, i_indent(X1).
2291
2292		% ---------------
2293
2294		:- public observe_indent/5.
2295		expects_spaninfo('observe_indent').
2296		expects_unevaluated_args('observe_indent').
2297		expects_waitflag('observe_indent').
2298		external_pred_always_true('observe_indent').
2299		external_fun_type('observe_indent',[T],[T,boolean]).
2300		% observe pairs of values
2301		observe_indent(Value,PredRes,UnEvalArgs,Span,WF) :-
2302		observe2(Value,PredRes,UnEvalArgs,no_trace,Span,WF).
2303
2304		:- public tobserve/5.
2305		expects_spaninfo('tobserve'). % observe_indent but with tracing enabled
2306		expects_unevaluated_args('tobserve').
2307		expects_waitflag('tobserve').
2308		external_pred_always_true('tobserve').
2309		tobserve(Value,PredRes,UnEvalArgs,Span,WF) :-
2310		observe2(Value,PredRes,UnEvalArgs,trace,Span,WF).
2311
2312		observe2(Value,PredRes,[Arg],Trace,Span,WF) :- PredRes=pred_true,
2313		%kernel_waitflags:portray_waitflags(WF),
2314		kernel_waitflags:get_wait_flag0(WF,WF0),
2315		kernel_waitflags:get_wait_flag1(observe,WF,WF1),
2316		when(nonvar(WF0),(indent_format(user_output,'WAITFLAG 0 set~n',[],no_trace),kernel_waitflags:portray_waitflags(WF))),
2317		when(nonvar(WF1),(indent_format(user_output,'WAITFLAG 1 set~n',[],no_trace),kernel_waitflags:portray_waitflags(WF))),
2318		Hook = print_value_as_table_if_possible(Arg,Value),
2319		observe_aux(Value,Arg,1,_,Trace,Span,Hook),
2320		iprintf(string("observe full value complete: ~w~n~n"),Value,_,Span).
2321
2322		:- use_module(extrasrc(table_tools),[print_value_as_table/2]).
2323		:- public print_value_as_table_if_possible/2. % used as hook above
2324		%print_value_as_table_if_possible(_,_) :- !.
2325		print_value_as_table_if_possible(Arg,Value) :-
2326		translate:print_bexpr(Arg),nl,
2327		(print_value_as_table(Arg,Value) -> true ; true).
2328
2329		observe_aux((V1,V2),b(couple(A1,A2),_,_),Nr,R,Trace,Span,Hook) :- !,
2330		observe_aux(V1,A1,Nr,N1,Trace,Span,Hook),
2331		observe_aux(V2,A2,N1,R,Trace,Span,Hook).
2332		observe_aux(V,Arg,Nr,R,Trace,Span,Hook) :- R is Nr+1,
2333		translate:translate_bexpression(Arg,ArgString), %print(obs(Nr,ArgString)),nl,
2334		atom_codes(ArgString,ArgCodes),
2335		observe_value(V,ArgCodes,Nr,Trace,Span,Hook).
2336
2337		% entry for other modules:
2338		observe_value(Value,Info) :- (Info=[_|_] -> PCodes = Info ; atom_codes(Info,PCodes)),
2339		observe_value(Value,PCodes,1,no_trace,unknown,true).
2340
2341		observe_value(Value,ArgCodes,Nr,Trace,Span,Hook) :- %print(obs(Nr,ArgString)),nl,
2342		number_codes(Nr,NrCodes), append(NrCodes,") = ~w~n",Tail1), append(" (",Tail1,Tail2),
2343		append(ArgCodes,Tail2,FormatString),
2344		observe_set(Value,ArgCodes,1,Trace,Span,Value,Hook),
2345		when((ground(FormatString),ground(Value)),ifprintf2(user_output,FormatString,Value,Trace,Span)).
2346		observe_value_with_full_value(Value,ArgCodes,Nr,Trace,Span,FullValue,Hook) :- %print(obs(Nr,ArgString)),nl,
2347		number_codes(Nr,NrCodes), append(NrCodes,"):FULL = ~w~n",Tail1), append(" (",Tail1,Tail2),
2348		append(ArgCodes,Tail2,FormatString),
2349		observe_set(Value,ArgCodes,1,Trace,Span,Value,Hook),
2350		when((ground(FormatString),ground(Value)),
2351		observe_ground(FormatString,Value,FullValue,Trace,Span,Hook)).
2352
2353		observe_ground(FormatString,Value,FullValue,Trace,Span,Hook) :-
2354		ifprintf2(user_output,FormatString,rec([field(value,Value),field(full,FullValue)]),Trace,Span),
2355		(call(Hook) -> true ; print(hook_failed(Hook)),nl).
2356
2357
2358
2359		% observe sets and records:
2360		:- block observe_set(-,?,?,?,?,?,?).
2361		observe_set([],_ArgCodes,_,_Trace,_Span,_,_) :- !.
2362		observe_set([Value|T],ArgCodes,Pos,Trace,Span,FullValue,Hook) :- !, %print(obs(Value,Pos)),nl,
2363		append(ArgCodes," el -> ",ArgN),
2364		observe_value_with_full_value(Value,ArgN,Pos,Trace,Span,FullValue,Hook),
2365		%tools_files:put_codes(ArgN,user_output),print(Pos),print(' = '),tools_printing:print_arg(Value),nl,
2366		P1 is Pos+1, observe_set(T,ArgCodes,P1,Trace,Span,FullValue,Hook).
2367		observe_set((V1,V2),ArgCodes,Pos,Trace,Span,FullValue,Hook) :-
2368		preferences:preference(observe_precise_values,true),
2369		!, %print(obs(Value,Pos)),nl,
2370		append(ArgCodes," prj1 -> ",ArgN1),
2371		observe_value_with_full_value(V1,ArgN1,Pos,Trace,Span,FullValue,Hook),
2372		%tools_files:put_codes(ArgN,user_output),print(Pos),print(' = '),tools_printing:print_arg(Value),nl,
2373		Pos2 is Pos+1,
2374		append(ArgCodes," prj2 -> ",ArgN2),
2375		observe_value_with_full_value(V2,ArgN2,Pos2,Trace,Span,FullValue,Hook).
2376		observe_set(rec(Fields),ArgCodes,Pos,Trace,Span,_FullValue,Hook) :-
2377		preferences:preference(observe_precise_values,true),
2378		!,
2379		append(ArgCodes," rec -> ",ArgN),
2380		observe_field(Fields,ArgN,Pos,Trace,Span,Hook).
2381		observe_set(_,_,_,_,_,_,_).
2382
2383		:- block observe_field(-,?,?,?,?,?).
2384		observe_field([],ArgN,Pos,Trace,Span,_Hook) :-
2385		append(ArgN," complete (~w)~n",FormatString),
2386		ifprintf2(user_output,FormatString,Pos,Trace,Span).
2387		observe_field([field(Name,Value)|TFields],ArgN,Pos,Trace,Span,Hook) :-
2388		observe_value((string(Name),Value),ArgN,Pos,Trace,Span,Hook),
2389		observe_field(TFields,ArgN,Pos,Trace,Span,Hook).
2390
2391		:- use_module(bsyntaxtree,[get_texpr_id/2]).
2392		:- use_module(store,[lookup_value_with_span_wf/6]).
2393		% utility function for other modules to use observe on parameters
2394		observe_parameters(Parameters,LocalState) :-
2395		skel(LocalState,SetupDone),
2396		reset_ident, reset_walltime,
2397		when(nonvar(SetupDone),observe_parameters_aux(Parameters,1,LocalState)).
2398		:- block skel(-,?).
2399		skel([],pred_true).
2400		skel([_|T],Done) :- skel(T,Done).
2401		:- block observe_parameters_aux(-,?,?), observe_parameters_aux(?,?,-).
2402		observe_parameters_aux([],_,_).
2403		observe_parameters_aux([TID|T],Nr,LS) :-
2404		safe_get_texpr_id(TID,ID), atom_codes(ID,PCodes),
2405		lookup_value_with_span_wf(ID,[],LS,Value,TID,no_wf_available),
2406		debug_println(9,observing(ID,Value,LS)),
2407		Hook = print_value_as_table_if_possible(TID,Value),
2408		observe_value(Value,PCodes,Nr,no_trace,unknown,Hook),
2409		N1 is Nr+1,
2410		observe_parameters_aux(T,N1,LS).
2411		safe_get_texpr_id(TID,ID) :- (atom(TID) -> ID=TID ; get_texpr_id(TID,ID)).
2412
2413		construct_bind(Id,V,bind(Id,V)).
2414		% observe a list of identifiers and values
2415		:- public observe_state/2. % debugging utility
2416		observe_state(Ids,Values) :-
2417		maplist(construct_bind,Ids,Values,State),!,
2418		observe_state(State).
2419		observe_state(Ids,Values) :- add_internal_error('Illegal id and value lists: ',observe_state(Ids,Values)).
2420
2421		% utility to observe a state using the observe external function
2422		observe_state(State) :-
2423		reset_ident, reset_walltime,
2424		observe_state_aux(State,1).
2425		:- block observe_state_aux(-,?).
2426		observe_state_aux(no_state,_) :- !.
2427		observe_state_aux([],_) :- !.
2428		observe_state_aux(concrete_constants(C),Nr) :- !, observe_state_aux(C,Nr).
2429		observe_state_aux([Binding|T],Nr) :- get_binding_value(Binding,Nr,PCodes,Value),!,
2430		%print(observe(Id,Value,Nr,T)),nl,
2431		observe_value(Value,PCodes,Nr,no_trace,unknown,true),
2432		N1 is Nr+1,
2433		observe_state_aux(T,N1).
2434		observe_state_aux(State,Nr) :- add_internal_error('Illegal state: ',observe_state_aux(State,Nr)).
2435
2436		:- block get_binding_value(-,?,?,?).
2437		get_binding_value(bind(Id,Value),_,PCodes,Value) :- atom_codes(Id,PCodes).
2438		get_binding_value(typedval(Value,_Type,Id,_Trigger),_,PCodes,Value) :- atom_codes(Id,PCodes).
2439		get_binding_value(Value,Nr,PCodes,Value) :- number_codes(Nr,PCodes). % we have just a list of values without ids
2440
2441
2442		external_fun_type('observe_fun',[X],[X,boolean]).
2443		expects_unevaluated_args('observe_fun').
2444		external_pred_always_true('observe_fun').
2445		:- public observe_fun/3.
2446		% a specific predicate to observe enumeration of functions,...
2447		:- block observe_fun(-,-,?).
2448		observe_fun(Value,PredRes,[UnEvalArg]) :-
2449		translate:translate_bexpression(UnEvalArg,Str), format('Observe function : ~w~n',[Str]),
2450		obs_fun(Value,Str,Value),PredRes=pred_true.
2451
2452		:- block obs_fun(-,?,?).
2453		obs_fun([],_,_) :- !.
2454		obs_fun([(A,B)|T],Str,FullVal) :- !,
2455		obs_idx(A,B,Str,FullVal),
2456		obs_fun(T,Str,FullVal).
2457		obs_fun(V,Str,_) :- print(uncovered_obs_fun(V,Str)),nl.
2458
2459		:- block obs_idx(-,?,?,?), obs_idx(?,-,?,?).
2460		obs_idx(A,B,Str,FullVal) :-
2461		when(ground((A,B)),obs_idx_complete(FullVal,A,B,Str)).
2462
2463		obs_idx_complete(FullVal,A,B,Str) :-
2464		format('~n ~w = ',[Str]),obs_idx_complete_aux(FullVal,A,B).
2465		obs_idx_complete(FullVal,A,B,Str) :-
2466		format('~n [BACKTRACK] ~w = ',[Str]),obs_idx_complete_aux(FullVal,A,B),fail.
2467
2468		obs_idx_complete_aux(V,_,_) :- var(V),!,print(' OPEN '),nl.
2469		obs_idx_complete_aux([],_,_) :- !, nl.
2470		obs_idx_complete_aux([(X,Y)|T],A,B) :- !,
2471		((X,Y)==(A,B) -> print(' * ') ; print(' ')), print_bvalue((X,Y)),
2472		obs_idx_complete_aux(T,A,B).
2473		obs_idx_complete_aux(_,_,_) :- print(unknown),nl.
2474
2475
2476		% -----------------------------
2477
2478		:- public tprintf/4.
2479		expects_spaninfo('tprintf').
2480		external_pred_always_true('tprintf').
2481		% a debugging version that switches into trace mode
2482		:- block tprintf(-,?,?,?), tprintf(?,-,?,?).
2483		tprintf(string(FormatString),Value,PredRes,Span) :- PredRes = pred_true,
2484		when((ground(FormatString),ground(Value)),
2485		(fprintf2(user_output,FormatString,Value,Span),
2486		try_trace %,print_profile,set_prolog_flag(profiling,on)
2487		)).
2488
2489		:- public 'prolog_printf'/5.
2490		expects_spaninfo('prolog_printf').
2491		expects_waitflag('prolog_printf').
2492		external_pred_always_true('prolog_printf').
2493		prolog_printf(string(FormatString),Value,PredRes,Span,WF) :- PredRes = pred_true,
2494		file_format(user_output,FormatString,[initial(Value,WF)],Span),
2495		when(nonvar(Value),file_format(user_output,FormatString,[nonvar(Value,WF)],Span)),
2496		when((ground(FormatString),ground(Value)),
2497		fprintf2(user_output,FormatString,Value,Span)).
2498
2499		% vprintf: expression which returns argument as value
2500		expects_spaninfo('vprintf').
2501		external_fun_type('vprintf',[T],[string,T,T]).
2502		:- public vprintf/4.
2503		vprintf(Format,Value,ValueRes,Span) :-
2504		printf(Format,[(int(1),Value)],pred_true,Span), % use itprintf for tracing
2505		equal_object(Value,ValueRes,vprintf). % we could generate a version which only instantiates when printing done
2506		expects_spaninfo('fvprintf').
2507		:- public fvprintf/5.
2508		fvprintf(File,Format,Value,ValueRes,Span) :-
2509		fprintf(File,Format,[(int(1),Value)],pred_true,Span),
2510		equal_object(Value,ValueRes,fvprintf). % we could generate a version which only instantiates when printing done
2511
2512
2513		% PRINT a single value as substitution
2514		performs_io('PRINT').
2515		external_subst_enabling_condition('PRINT',_,Truth) :- create_texpr(truth,pred,[],Truth).
2516		does_not_modify_state('PRINT').
2517		:- public 'PRINT'/3.
2518		:- block 'PRINT'(-,?,?), 'PRINT'(?,-,?).
2519		'PRINT'(Val,_Env,OutEnv) :- %print('PRINT : '), print(Env),nl,
2520		assert_side_effect_occurred(user_output),
2521		print_value(Val),nl, OutEnv=[].
2522
2523		% PRINT a single value as substitution; show backtracking
2524		performs_io('PRINT_BT').
2525		perform_directly('PRINT_BT').
2526		external_subst_enabling_condition('PRINT_BT',_,Truth) :- create_texpr(truth,pred,[],Truth).
2527		does_not_modify_state('PRINT_BT').
2528		:- public 'PRINT_BT'/3.
2529		:- block 'PRINT_BT'(-,?,?), 'PRINT_BT'(?,-,?).
2530		'PRINT_BT'(Val,_Env,OutEnv) :- %print('PRINT : '), print(Env),nl,
2531		assert_side_effect_occurred(user_output),
2532		print_value(Val),nl, OutEnv=[].
2533		'PRINT_BT'(Val,_Env,_OutEnv) :-
2534		assert_side_effect_occurred(user_output),
2535		print('BACKTRACKING: '),print_value(Val),nl, fail.
2536
2537		print_value(Val) :- translate:translate_bvalue(Val,TV), print(TV).
2538
2539
2540		performs_io('DEBUG_PRINT_STATE').
2541		external_subst_enabling_condition('DEBUG_PRINT_STATE',_,Truth) :- create_texpr(truth,pred,[],Truth).
2542		does_not_modify_state('DEBUG_PRINT_STATE').
2543		:- public 'DEBUG_PRINT_STATE'/3.
2544		:- block 'DEBUG_PRINT_STATE'(-,?,?).
2545		'DEBUG_PRINT_STATE'(Value,Env,OutEnv) :-
2546		assert_side_effect_occurred(user_output),
2547		print_value(Value),translate:print_bstate(Env),nl, OutEnv=[].
2548
2549		% PRINTF as substitution
2550		expects_spaninfo('PRINTF').
2551		performs_io('PRINTF').
2552		external_subst_enabling_condition('PRINTF',_,Truth) :- create_texpr(truth,pred,[],Truth).
2553		does_not_modify_state('PRINTF').
2554		:- public 'PRINTF'/5.
2555		:- block 'PRINTF'(-,?,?,?,?), 'PRINTF'(?,-,?,?,?), 'PRINTF'(?,?,-,?,?).
2556		'PRINTF'(string(FormatString),Value,_Env,OutEnvModifications,Span) :-
2557		% print('PRINTF'(FormatString,Value,_Env)),nl,
2558		when((ground(FormatString),ground(Value)),
2559		(fprintf2(user_output,FormatString,Value,Span),
2560		OutEnvModifications=[] /* substitution finished */
2561		)).
2562
2563		expects_spaninfo('FPRINTF').
2564		performs_io('FPRINTF').
2565		external_subst_enabling_condition('FPRINTF',_,Truth) :- create_texpr(truth,pred,[],Truth).
2566		does_not_modify_state('FPRINTF').
2567		:- public 'FPRINTF'/6.
2568		:- block 'FPRINTF'(-,?,?,?,?,?), 'FPRINTF'(?,-,?,?,?,?), 'FPRINTF'(?,?,-,?,?,?).
2569		'FPRINTF'(string(File),string(FormatString),Value,_Env,OutEnvModifications,Span) :-
2570		when((ground(FormatString),ground(Value)),
2571		(fprintf2(File,FormatString,Value,Span),
2572		OutEnvModifications=[] /* substitution finished */
2573		)).
2574
2575		file_format(user_output,FormatString,Args,Span) :- !,
2576		assert_side_effect_occurred(user_output),
2577		safe_call(myformat(user_output,FormatString,Args,Span),Span).
2578		file_format(File,FormatString,Args,Span) :-
2579		open(File,append,Stream,[encoding(utf8)]),
2580		assert_side_effect_occurred(file),
2581		safe_call(myformat(Stream,FormatString,Args,Span),Span),
2582		close(Stream). % TO DO: call_cleanup
2583
2584		% Simple check if the user forgot to put format specifiers in the format string.
2585		format_string_is_missing_tildes(FormatString) :-
2586		atom_codes(FormatString, Codes),
2587		\+ memberchk(0'~, Codes).
2588
2589		:- meta_predicate catch_format_error(0, 0).
2590		catch_format_error(Goal, Recover) :-
2591		catch(
2592		catch(
2593		Goal,
2594		error(consistency_error(_,_,format_arguments),_), % SICStus
2595		Recover),
2596		error(format(_Message),_), % SWI
2597		Recover).
2598
2599		:- public myformat/4.
2600		myformat(Stream,FormatString,Args,Span) :-
2601		catch_format_error(
2602		(Args \== [], format_string_is_missing_tildes(FormatString) ->
2603		% backup: the user has not provided ~w annotations:
2604		% instead print just the format string and then all arguments separately.
2605		% This case was previously detected by catching format errors,
2606		% but this causes problems with incomplete or duplicated output on SWI,
2607		% because SWI reports errors only during printing
2608		% (unlike SICStus, which checks the entire format string before printing anything).
2609		format(Stream,FormatString,[]),
2610		nl(Stream),
2611		format_args(Stream,Args)
2612		; format(Stream,FormatString,Args)
2613		),
2614		(length(Args,NrArgs),
2615		ajoin(['Illegal format string, expecting ',NrArgs,' ~w arguments (see SICStus Prolog reference manual for syntax):'],Msg),
2616		add_error(external_functions,Msg,FormatString,Span),
2617		format_args(Stream,Args))
2618		),
2619		flush_output(Stream).
2620
2621		format_args(_Stream,[]).
2622		format_args(Stream,[H|T]) :- format(Stream,'~w~n',H), format_args(Stream,T).
2623
2624		% a format with indentation and backtracking info:
2625		:- dynamic indentation_level/1.
2626		indentation_level(0).
2627		inc_indent :- retract(indentation_level(X)), X1 is X+1, assertz(indentation_level(X1)).
2628		dec_indent :- retract(indentation_level(X)), X1 is X-1, assertz(indentation_level(X1)).
2629		reset_ident :- retractall(indentation_level(_)), assertz(indentation_level(0)).
2630		get_indent_level(L) :- indentation_level(LL), L is ceiling(sqrt(LL)).
2631		indent(Stream) :- get_indent_level(L), %(L>28 -> trace ; true),
2632		indent_aux(L,Stream).
2633		indent_aux(X,Stream) :- X < 1, !, write(Stream,' ').
2634		indent_aux(X,Stream) :- write(Stream,'+-'), X1 is X-1, indent_aux(X1,Stream).
2635
2636		indent_format(Stream,Format,Args,Trace) :- inc_indent,
2637		indent(Stream), format(Stream,Format,Args),
2638		print_walltime(Stream),
2639		% my_term_hash(Args,Hash), format(Stream,'[hash ~w]~n',[Hash]), (Hash=101755762 -> trace ; true), %%
2640		flush_output(Stream),
2641		(Trace=trace -> try_trace ; true).
2642		%indent_format(_Stream,_Format,Args,_Trace) :- my_term_hash(Args,Hash),(Hash=553878463258718990 -> try_trace).
2643		indent_format(Stream,Format,Args,Trace) :-
2644		indent(Stream), write(Stream,'BACKTRACKING '),
2645		% my_term_hash(Args,Hash), format(Stream,'[hash ~w] ',[Hash]), %% (Hash=553878463258718990 -> try_trace ; true), %%
2646		format(Stream,Format,Args),
2647		print_walltime(Stream), %% comment in to see walltime info
2648		flush_output(Stream),
2649		dec_indent,
2650		(Trace=trace -> try_trace ; true),
2651		fail.
2652
2653		:- dynamic ref_walltime/1, prev_walltime/1.
2654		reset_walltime :- retractall(prev_walltime(_)), retractall(ref_walltime(_)),
2655		statistics(walltime,[WT,_]),
2656		assertz(prev_walltime(WT)),
2657		assertz(ref_walltime(WT)).
2658		print_walltime(File) :- statistics(walltime,[WT,_]),
2659		(ref_walltime(RefWT) -> RWT is WT-RefWT ; RWT = 0, assertz(ref_walltime(WT))),
2660		(retract(prev_walltime(PWT)) -> T is WT-PWT, indent(File),format(File,' ~w ms (walltime; total ~w ms)~n',[T,RWT])
2661		; true),
2662		assertz(prev_walltime(WT)).
2663		:- public 'TRACE'/2.
2664		:- block 'TRACE'(-,?).
2665		'TRACE'(pred_true,R) :- !,trace,R=pred_true.
2666		'TRACE'(pred_false,pred_true).
2667
2668		% --------------------------------------------
2669
2670		% ARGV, ARGC
2671
2672		:- dynamic argv_string/2, argc_number/1.
2673		argc_number(0).
2674		reset_argv :-
2675		retractall(argv_string(_,_)),
2676		retractall(argc_number(_)),
2677		assertz(argc_number(0)).
2678
2679		:- use_module(kernel_strings,[split_atom_string/3]).
2680		% call to set the commandline arguments, e.g., from probcli
2681		set_argv_from_atom(X) :-
2682		retractall(argv_string(_,_)),
2683		retractall(argc_number(_)),
2684		split_atom_string(X,' ',List),
2685		set_argv_from_list(List).
2686		set_argv_from_list(List) :-
2687		retractall(argv_string(_,_)),
2688		retractall(argc_number(_)),
2689		set_argv_from_list_aux(List).
2690		set_argv_from_list_aux(List) :-
2691		length(List,Len),
2692		assertz(argc_number(Len)),
2693		debug:debug_println(9,argc(Len)),
2694		nth1(N,List,String), % we number the arguments in B style
2695		debug:debug_println(9,argv(N,String)),
2696		assertz(argv_string(N,String)),
2697		fail.
2698		set_argv_from_list_aux(_).
2699
2700		external_fun_type('ARGV',[],[integer,string]).
2701		% access to the command-line arguments provided to probcli (after --)
2702		% first argument is ARGV(1) not ARGV(0)
2703		:- public 'ARGV'/2.
2704		:- block 'ARGV'(-,?).
2705		'ARGV'(int(N),S) :- argv2(N,S).
2706		:- block argv2(-,?).
2707		argv2(Nr,Res) :- % print(get_argv(Nr,Res)),nl,
2708		(argv_string(Nr,S) -> Res=string(S)
2709		; Nr=0 -> add_error(external_functions,'Command-line argument does not exist, numbering starts at 1: ',Nr), Res=string('')
2710		; add_error(external_functions,'Command-line argument does not exist: ',Nr), Res=string('')).
2711
2712		external_fun_type('ARGC',[],[integer]).
2713		:- public 'ARGC'/1.
2714		'ARGC'(int(X)) :- argc_number(X).
2715
2716		% --------------------------------------------
2717
2718		% RANDOM
2719
2720		:- assert_must_succeed(( external_functions:call_external_function('RANDOM',[0,1],[int(0),int(1)],int(0),integer,unknown,_WF) )).
2721		:- use_module(library(random),[random/3, random/1]).
2722		% Generate a random number >= Low and < Up
2723		% warning: this is not a mathematical function
2724		:- public 'RANDOM'/3.
2725		is_not_declarative('RANDOM').
2726		external_fun_type('RANDOM',[],[integer,integer,integer]).
2727		:- block 'RANDOM'(-,?,?), 'RANDOM'(?,-,?).
2728		'RANDOM'(int(Low),int(Up),int(R)) :- random2(Low,Up,R).
2729		:- block random2(-,?,?), random2(?,-,?).
2730		random2(L,U,R) :- random(L, U, R). % also works with reals
2731
2732		:- public 'RAND'/3.
2733		is_not_declarative('RAND').
2734		external_fun_type('RAND',[],[real,real,real]).
2735		:- block 'RAND'(-,?,?), 'RAND'(?,-,?).
2736		'RAND'(RLow,Rup,RR) :- is_real(RLow,Low),
2737		is_real(Rup,Up), is_real(RR,R),
2738		random2(Low,Up,R).
2739
2740
2741		% pick a random element from a set
2742		:- public 'random_element'/4.
2743		is_not_declarative('random_element').
2744		external_fun_type('random_element',[T],[set(T),T]).
2745		expects_waitflag('random_element').
2746		expects_spaninfo('random_element').
2747		:- block 'random_element'(-,?,?,?).
2748		random_element([],_,Span,WF) :- !,
2749		add_wd_error_span('random_element applied to empty set: ',[],Span,WF).
2750		random_element([H|T],El,_,WF) :- !,
2751		expand_custom_set_to_list_wf(T,ET,_Done,'random_element',WF),
2752		block_length(ET,1,Len),
2753		random_select_from_list([H|ET],Len,El).
2754		random_element(CS,Res,_,_) :- is_interval_closure_or_integerset(CS,Low,Up,finite),!,
2755		U1 is Up+1,
2756		random(Low,U1,H), Res = int(H).
2757		random_element(CS,X,Span,WF) :-
2758		custom_explicit_sets:expand_custom_set_wf(CS,ER,random_element,WF),
2759		random_element(ER,X,Span,WF).
2760
2761		:- block block_length(-,?,?).
2762		block_length([],Acc,Acc).
2763		block_length([_|T],Acc,R) :- A1 is Acc+1, block_length(T,A1,R).
2764
2765		:- use_module(library(random),[random_member/2]).
2766		:- block random_select_from_list(?,-,?).
2767		random_select_from_list(List,_,Res) :-
2768		random_member(El,List),
2769		kernel_objects:equal_object(El,Res).
2770
2771		:- use_module(library(random),[random_numlist/4]).
2772		:- public 'random_numset'/6.
2773		is_not_declarative('random_numset').
2774		external_fun_type('random_numset',[],[integer,integer,integer,integer,set(integer)]).
2775		expects_waitflag('random_numset').
2776		:- block random_numset(-,?,?,?,?,?),random_numset(?,-,?,?,?,?),random_numset(?,?,-,?,?,?),random_numset(?,?,?,-,?,?).
2777		random_numset(int(P),int(Q),int(Low),int(Up),Res,WF) :-
2778		Prob is P/Q,
2779		random_numlist(Prob,Low,Up,List),
2780		maplist(gen_int,List,IntList),
2781		kernel_objects:equal_object_optimized_wf(IntList,Res,random_numset,WF).
2782
2783		gen_int(I,int(I)).
2784
2785
2786		:- public 'NORMAL'/3.
2787		is_not_declarative('NORMAL').
2788		external_fun_type('NORMAL',[],[integer,integer,integer]).
2789		% GAUSSIAN Distribution
2790		:- block 'NORMAL'(-,?,?), 'NORMAL'(?,-,?).
2791		'NORMAL'(int(Mu),int(Sigma),int(R)) :- random_normal(Mu,Sigma,R).
2792
2793		:- block random_normal(-,?,-), random_normal(?,-,?).
2794		random_normal(Mu,Sigma,R) :-
2795		random_normal(N),
2796		R is round(Mu+N*Sigma).
2797
2798		:- use_module(kernel_reals,[is_real/2]).
2799		:- public 'RNORMAL'/3.
2800		is_not_declarative('RNORMAL').
2801		external_fun_type('RNORMAL',[],[real,real,real]).
2802		:- block 'RNORMAL'(-,?,?), 'RNORMAL'(?,-,?).
2803		'RNORMAL'(RMU,RSigma,RR) :- is_real(RMU,MU),
2804		is_real(RSigma,Sigma), is_real(RR,R),
2805		random_normal_real(MU,Sigma,R).
2806
2807		:- block random_normal_real(-,?,-), random_normal_real(?,-,?).
2808		random_normal_real(Mu,Sigma,R) :-
2809		random_normal(N),
2810		R is (Mu+N*Sigma).
2811
2812		% inspired by: https://stackoverflow.com/questions/44503752/how-to-generate-normal-distributed-random-numbers-in-prolog
2813		% https://en.wikipedia.org/wiki/Box–Muller_transform
2814		:- dynamic cached_gauss/1.
2815		:- use_module(library(random),[random/1]).
2816		random_normal(R) :- retract(cached_gauss(N)),!,R=N.
2817		random_normal(R) :-
2818		random(U1), random(U2),
2819		Z0 is sqrt(-2 * log(U1)) * cos(2*pi*U2),
2820		Z1 is sqrt(-2 * log(U1)) * sin(2*pi*U2),
2821		assertz(cached_gauss(Z1)),
2822		R = Z0.
2823
2824		% generates a random subset of a finite set
2825		:- public 'random_subset'/4.
2826		is_not_declarative('random_subset').
2827		external_fun_type('random_subset',[T],[set(T),set(T)]).
2828		expects_waitflag('random_subset').
2829		expects_spaninfo('random_subset').
2830		:- block 'random_subset'(-,?,?,?).
2831		random_subset(Set,Subset,Span,WF) :- !,
2832		expand_custom_set_to_list_wf(Set,ESet,Done,'random_subset',WF),
2833		random_subset_aux(Done,ESet,Subset,Span,WF).
2834
2835		:- use_module(library(random),[random_subseq/3]).
2836		:- block random_subset_aux(-,?,?,?,?).
2837		random_subset_aux(_Done,ESet,Subset,_Span,WF) :-
2838		random_subseq(ESet,Result,_Rest),
2839		kernel_objects:equal_object_wf(Result,Subset,WF).
2840
2841		% generates a random subset of a finite set
2842		:- public 'random_ordering'/4.
2843		is_not_declarative('random_ordering').
2844		external_fun_type('random_ordering',[T],[set(T),seq(T)]).
2845		expects_waitflag('random_ordering').
2846		expects_spaninfo('random_ordering').
2847		:- block 'random_ordering'(-,?,?,?).
2848		random_ordering(Set,Permutation,Span,WF) :- !,
2849		expand_custom_set_to_list_wf(Set,ESet,Done,'random_ordering',WF),
2850		random_perm_aux(Done,ESet,Permutation,Span,WF).
2851
2852		:- use_module(library(random),[random_permutation/2]).
2853		:- block random_perm_aux(-,?,?,?,?).
2854		random_perm_aux(_Done,ESet,Permutation,_Span,_WF) :-
2855		random_permutation(ESet,Result),
2856		convert_list_to_seq(Result,Permutation). % should we call WF version
2857
2858		% generates a random subset of a finite sequence
2859		:- public 'random_permutation'/4.
2860		is_not_declarative('random_permutation').
2861		external_fun_type('random_permutation',[T],[seq(T),seq(T)]).
2862		expects_waitflag('random_permutation').
2863		expects_spaninfo('random_permutation').
2864		:- block 'random_permutation'(-,?,?,?).
2865		random_permutation(Set,Permutation,Span,WF) :- !,
2866		expand_custom_set_to_list_wf(Set,ESet,Done,'random_permutation',WF),
2867		random_perm_seq_aux(Done,ESet,Permutation,Span,WF).
2868
2869		:- block random_perm_seq_aux(-,?,?,?,?).
2870		random_perm_seq_aux(_Done,ESet,Permutation,_Span,_WF) :-
2871		sort(ESet,Sorted),
2872		maplist(drop_index,Sorted,PrologList),
2873		random_permutation(PrologList,Result),
2874		convert_list_to_seq(Result,Permutation). % should we call WF version
2875
2876		drop_index((int(_),El),El).
2877
2878		:- use_module(library(system)).
2879
2880		:- assert_must_succeed(( external_functions:call_external_function('TIME',[y],[string(year)],int(Y),integer,unknown,_WF), number(Y), Y>2011 )).
2881		:- assert_must_succeed(( external_functions:call_external_function('TIME',[m],[string(month)],int(M),integer,unknown,_WF), number(M), M>0, M<13 )).
2882		external_fun_type('TIME',[],[string,integer]).
2883		:- public 'TIME'/2.
2884		is_not_declarative('TIME'). % as time can change with next call
2885		'TIME'(string(S),int(N)) :- time2(S,N).
2886		:- block time2(-,?).
2887		time2(now,N) :- !, now(N). % provide UNIX timesstamp
2888		time2(year,N) :- !,datime(datime(N,_,_,_,_,_)).
2889		time2(month,N) :- !,datime(datime(_,N,_,_,_,_)).
2890		time2(day,N) :- !,datime(datime(_,_,N,_,_,_)).
2891		time2(hour,N) :- !,datime(datime(_,_,_,N,_,_)).
2892		time2(min,N) :- !,datime(datime(_,_,_,_,N,_)).
2893		time2(sec,N) :- !,datime(datime(_,_,_,_,_,N)).
2894		time2(OTHER,_) :- add_error(time2,'Illegal time field (must be now,year,month,day,hour,min,sec): ',OTHER),fail.
2895
2896		:- assert_must_succeed(( external_functions:call_external_function('GET_INFO',[time],[string(time)],string(M),string,unknown,_WF), atom(M) )).
2897		external_fun_type('GET_INFO',[],[string,string]).
2898		:- public 'GET_INFO'/2.
2899		'GET_INFO'(string(S),Res) :- get_info2(S,Res).
2900		:- use_module(library(codesio)).
2901		:- block get_info2(-,?).
2902		get_info2(time,Res) :- !, datime(datime(Year,Month,Day,Hour,Min,Sec)),
2903		(Min<10
2904		-> format_to_codes('~w/~w/~w - ~wh0~w ~ws',[Day,Month,Year,Hour,Min,Sec],Codes)
2905		; format_to_codes('~w/~w/~w - ~wh~w ~ws',[Day,Month,Year,Hour,Min,Sec],Codes)
2906		),
2907		atom_codes(INFO, Codes), Res=string(INFO).
2908		get_info2(OTHER,_) :- add_error(time2,'Illegal GET_INFO field (must be time): ',OTHER),fail.
2909
2910		:- public 'TIMESTAMP_INFO'/3.
2911		:- assert_must_succeed(external_functions:'TIMESTAMP_INFO'(string('year'),int(1498484624),int(2017))).
2912		:- assert_must_succeed(external_functions:'TIMESTAMP_INFO'(string('month'),int(1498484624),int(6))).
2913		% second argument is ticks obtained by TIME("now")
2914		external_fun_type('TIMESTAMP_INFO',[],[string,integer,integer]).
2915		:- block 'TIMESTAMP_INFO'(-,-,-).
2916		'TIMESTAMP_INFO'(string(S),int(Ticks),int(Res)) :- time_info2(S,Ticks,Res).
2917		:- block time_info2(-,?,?), time_info2(?,-,?).
2918		time_info2(year,Ticks,N) :- !,datime(Ticks,datime(N,_,_,_,_,_)).
2919		time_info2(month,Ticks,N) :- !,datime(Ticks,datime(_,N,_,_,_,_)).
2920		time_info2(day,Ticks,N) :- !,datime(Ticks,datime(_,_,N,_,_,_)).
2921		time_info2(hour,Ticks,N) :- !,datime(Ticks,datime(_,_,_,N,_,_)).
2922		time_info2(min,Ticks,N) :- !,datime(Ticks,datime(_,_,_,_,N,_)).
2923		time_info2(sec,Ticks,N) :- !,datime(Ticks,datime(_,_,_,_,_,N)).
2924		time_info2(OTHER,_,_) :- add_error(time_info2,'Illegal time field (must be now,year,month,day,hour,min,sec): ',OTHER),fail.
2925
2926		:- public 'TIMESTAMP'/7.
2927		% TIMESTAMP/datime converts between a Unix timestamp (UTC) and *local* time.
2928		% To avoid depending on the system time zone,
2929		% build the timestamp dynamically based on the expected test date.
2930		% This way the timestamp varies slightly depending on the system time zone,
2931		% but the date will always be consistent.
2932		:- assert_must_succeed((
2933		datime(Timestamp, datime(2017,6,26,15,43,44)),
2934		% Sanity check to ensure that Timestamp is roughly in the right range.
2935		Timestamp >= 1498437824, Timestamp =< 1498545824,
2936		external_functions:'TIMESTAMP'(int(2017),int(6),int(26),int(H),int(Min),int(S),int(Timestamp)),
2937		H==15, Min==43, S==44
2938		)).
2939		external_fun_type('TIMESTAMP',[],[integer,integer,integer,integer,integer,integer,integer]).
2940		:- block 'TIMESTAMP'(-,-,-,-,-,-,-).
2941		'TIMESTAMP'(int(Y),int(M),int(D),int(H),int(Min),int(S),int(Res)) :-
2942		timestamp2(Y,M,D,H,Min,S,Res).
2943
2944		:- block timestamp2(-,?,?,?,?,?,-), timestamp2(?,-,?,?,?,?,-), timestamp2(?,?,-,?,?,?,-),
2945		timestamp2(?,?,?,-,?,?,-), timestamp2(?,?,?,?,?,-,-).
2946		timestamp2(Y,M,D,H,Min,S,ResTimeStamp) :- datime(ResTimeStamp, datime(Y,M,D,H,Min,S)).
2947
2948
2949		:- public 'WALLTIME'/1.
2950		is_not_declarative('WALLTIME'). % as time can change with next call
2951		'WALLTIME'(int(X)) :- statistics(walltime,[X,_]).
2952
2953		:- volatile last_walltime/1.
2954		:- dynamic last_walltime/1.
2955		:- public 'DELTA_WALLTIME'/1.
2956		is_not_declarative('DELTA_WALLTIME'). % as time can change with next call
2957		'DELTA_WALLTIME'(int(D)) :- statistics(walltime,[X,_]),
2958		(retract(last_walltime(L)) -> D is X-L ; D = 0),
2959		assertz(last_walltime(X)).
2960
2961		:- public 'RUNTIME'/1.
2962		is_not_declarative('RUNTIME'). % as time can change with next call
2963		'RUNTIME'(int(X)) :- statistics(runtime,[X,_]).
2964
2965		:- public 'SLEEP'/3.
2966		external_subst_enabling_condition('SLEEP',_,Truth) :- create_texpr(truth,pred,[],Truth).
2967		:- use_module(library(system),[sleep/1]).
2968		:- block 'SLEEP'(-,?,?), 'SLEEP'(?,-,?).
2969		'SLEEP'(int(X),_Env,OutEnvModifications) :- when(nonvar(X),
2970		(Seconds is X / 1000, sleep(Seconds), OutEnvModifications=[])).
2971
2972
2973		%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2974		% check if a given expression is valued in the deterministic phase; warn otherwise
2975
2976		:- use_module(kernel_tools,[ground_value_check/2]).
2977		expects_spaninfo('CHECK_DET').
2978		expects_unevaluated_args('CHECK_DET').
2979		expects_waitflag('CHECK_DET').
2980		:- public 'CHECK_DET'/5.
2981		'CHECK_DET'(Value,PredRes,[UnEvalArg],Span,WF) :-
2982		ground_value_check(Value,Ground),
2983		kernel_waitflags:get_wait_flag0(WF,WF0),
2984		kernel_waitflags:get_wait_flag1(WF,WF1),
2985		PredRes=pred_true,
2986		check_det_aux(Ground,Value,WF0,WF1,UnEvalArg,Span).
2987
2988		:- block check_det_aux(-,?,?,-,?,?).
2989		check_det_aux(Ground,Value,_WF0,_WF1,UnEvalArg,Span) :- var(Ground),!,
2990		translate:translate_bexpression(UnEvalArg,S),
2991		add_error(external_functions,'Argument has not been computed deterministically: ',S,Span),
2992		translate:print_bvalue(Value),nl.
2993		check_det_aux(_Ground,Value,WF0,WF1,UnEvalArg,_Span) :- debug:debug_mode(on),!,
2994		translate:translate_bexpression(UnEvalArg,S),
2995		format('Value determined (WF0=~w,WF1=~w) : ~w~n',[WF0,WF1,S]),
2996		translate:print_bvalue(Value),nl.
2997		check_det_aux(_Ground,_Value,_WF0,_WF1,_UnEvalArgs,_Span).
2998
2999		% check if a given expression has already a ground value when
3000		% the predicate is called
3001
3002		% the predicate is true when the value is ground, false otherwise
3003		:- public 'IS_DETERMINED'/2.
3004		'IS_DETERMINED'(Value,PredRes) :- ground(Value),!,PredRes=pred_true.
3005		'IS_DETERMINED'(_Value,pred_false).
3006
3007		% other variant: the predicate is always true, the information if the variable is written
3008		% to a file to check it later.
3009		expects_spaninfo('IS_DETERMINED_INTO_FILE').
3010		:- public 'IS_DETERMINED_INTO_FILE'/5.
3011		'IS_DETERMINED_INTO_FILE'(FileValue,VariableValue,Value,PredRes,SpanInfo) :-
3012		check_value_is_string(FileValue,'IS_DETERMINED_INTO_FILE','file name',SpanInfo,File),
3013		check_value_is_string(VariableValue,'IS_DETERMINED_INTO_FILE','variable name',SpanInfo,Varname),
3014		( ground(File) ->
3015		open(File,write,S,[encoding(utf8)]),
3016		call_cleanup( check_determined2(Value,S,Varname), close(S))
3017		;
3018		add_error(external_functions,'### EXTERNAL Unspecified file in check_determined','',SpanInfo)),
3019		PredRes = pred_true.
3020		check_determined2(Value,S,Varname) :-
3021		check_determined3(Value,Varname,Term),
3022		writeq(S,Term),write(S,'.\n').
3023		check_determined3(Value,Name,Term) :- ground(Value),!,Term=determined_value(Name,Value).
3024		check_determined3(_Value,Name,not_determined_value(Name)).
3025
3026		check_value_is_string(string(S),_PredName,_Location,_SpanInfo,String) :-
3027		!, String=S.
3028		check_value_is_string(Value,PredName,Location,SpanInfo,_String) :-
3029		atom_concat('### EXTERNAL ',PredName,Msg1),
3030		atom_concat(Msg1,': Type error, expected string as ',Msg2),
3031		atom_concat(Msg2,Location,Msg),
3032		add_error(external_functions,Msg,Value,SpanInfo),
3033		fail.
3034
3035
3036		:- public 'SEE'/3.
3037		is_not_declarative('SEE').
3038		:- dynamic open_stream/2.
3039		'SEE'(string(File),_S,[]) :- b_absolute_file_name(File,AFile),
3040		open_stream(AFile,_),!,
3041		print('File already open: '), print(File),nl.
3042		'SEE'(string(File),_S,[]) :-
3043		b_absolute_file_name(File,AFile),
3044		open_absolute_file_for_reading(AFile,_Stream).
3045
3046		open_file_for_reading_if_necessary(File,Stream) :-
3047		b_absolute_file_name(File,AFile),
3048		(open_stream(AFile,S) -> Stream=S
3049		; open_absolute_file_for_reading(AFile,Stream)).
3050		open_absolute_file_for_reading(AFile,Stream) :-
3051		open(AFile,read,Stream,[encoding(utf8)]),
3052		print(opened_file(AFile,Stream)),nl,
3053		assert_side_effect_occurred(file),
3054		assertz(open_stream(AFile,Stream)).
3055
3056		%correct_file_open_mode(read).
3057		%correct_file_open_mode(write).
3058		%correct_file_open_mode(append).
3059
3060		:- public 'GET_CODE'/2.
3061		performs_io('GET_CODE').
3062		'GET_CODE'(string(File),int(Code)) :-
3063		b_absolute_file_name(File,AFile),
3064		open_stream(AFile,S),
3065		assert_side_effect_occurred(file),
3066		get_code(S,Code). %,print(got_code(S,Code)),nl.
3067
3068		:- public 'GET_CODE_STDIN'/1.
3069		performs_io('GET_CODE_STDIN').
3070		'GET_CODE_STDIN'(int(Code)) :-
3071		get_code(user_input,Code). % can be problematic if called in ProB2UI
3072		% TODO: check get_prob_application_type(prob2) ?
3073
3074		:- public 'SEEN'/3.
3075		is_not_declarative('SEEN').
3076		'SEEN'(string(File),_S,[]) :- b_absolute_file_name(File,AFile),
3077		retract(open_stream(AFile,S)),
3078		assert_side_effect_occurred(file),
3079		close(S).
3080
3081		close_all_files :- retract(open_stream(_File,S)),
3082		close(S),fail.
3083		close_all_files.
3084
3085
3086		open_utf8_file_for_reading(AFile,Stream,SpanInfo) :-
3087		safe_call(open(AFile,read,Stream,[encoding(utf8)]),SpanInfo).
3088
3089		:- public 'READ_FILE_AS_STRINGS'/3.
3090		performs_io('READ_FILE_AS_STRINGS').
3091		external_subst_enabling_condition('READ_FILE_AS_STRINGS',_,Truth) :- create_texpr(truth,pred,[],Truth).
3092		expects_spaninfo('READ_FILE_AS_STRINGS').
3093		:- block 'READ_FILE_AS_STRINGS'(-,?,?).
3094		'READ_FILE_AS_STRINGS'(string(File),Res,SpanInfo) :-
3095		b_absolute_file_name(File,AFile,SpanInfo),
3096		open_utf8_file_for_reading(AFile,Stream,SpanInfo),!,
3097		format('% Opened file: ~w~n',[File]),
3098		% no side-effect: as everything read in one go
3099		call_cleanup(read_lines(Stream,Res),
3100		close(Stream)).
3101		'READ_FILE_AS_STRINGS'(string(File),_Res,_SpanInfo) :-
3102		format('% Opening file failed: ~w~n',[File]),fail.
3103		read_lines(File,Res) :- read_lines_loop(1,File,Lines),
3104		kernel_objects:equal_object(Res,Lines).
3105		read_lines_loop(Nr,Stream,Lines) :- read_line(Stream,Line),
3106		debug:debug_println(9,read_line(Nr,Line)),
3107		(Line = end_of_file -> Lines = []
3108		; atom_codes(Atom,Line), Lines = [(int(Nr),string(Atom))|T],
3109		N1 is Nr+1,read_lines_loop(N1,Stream,T)).
3110
3111
3112		:- public 'READ_FILE_AS_STRING'/3.
3113		performs_io('READ_FILE_AS_STRING').
3114		external_subst_enabling_condition('READ_FILE_AS_STRING',_,Truth) :- create_texpr(truth,pred,[],Truth).
3115		expects_spaninfo('READ_FILE_AS_STRING').
3116		:- block 'READ_FILE_AS_STRING'(-,?,?).
3117		'READ_FILE_AS_STRING'(string(File),Res,SpanInfo) :-
3118		b_absolute_file_name(File,AFile,SpanInfo),
3119		open_utf8_file_for_reading(AFile,Stream,SpanInfo),!,
3120		format('% Opened file: ~w~n',[File]),
3121		% no side-effect: as everything read in one go
3122		call_cleanup(read_all_codes(Stream,All,[]),
3123		close(Stream)),
3124		atom_codes(ResStr,All), Res = string(ResStr).
3125
3126		% read all codes in the stream:
3127		read_all_codes(Stream) --> {read_line(Stream,Line), Line \= end_of_file, !},
3128		Line, "\n",
3129		read_all_codes(Stream).
3130		read_all_codes(_) --> "".
3131
3132
3133		:- public 'READ_LINE'/3.
3134		expects_spaninfo('READ_LINE').
3135		external_subst_enabling_condition('READ_LINE',_,Truth) :- create_texpr(truth,pred,[],Truth).
3136		performs_io('READ_LINE').
3137		'READ_LINE'(string(File),Res,_SpanInfo) :-
3138		open_file_for_reading_if_necessary(File,Stream),
3139		read_line(Stream,Line),
3140		debug:debug_println(9,read_line(Line)),
3141		assert_side_effect_occurred(file),
3142		(Line = end_of_file
3143		-> add_error(external_functions,'Attempting to read past EOF: ',File),
3144		Res = ""
3145		; atom_codes(Atom,Line), Res = string(Atom)).
3146
3147		is_not_declarative('EOF').
3148		:- public 'EOF'/2.
3149		'EOF'(string(File),Res) :- eof2(File,Res).
3150		:- block eof2(-,?).
3151		eof2(File,Res) :-
3152		open_file_for_reading_if_necessary(File,Stream),
3153		((peek_code(Stream,C), C = -1) -> Res = pred_true ; Res = pred_false). % for Linux compatibility
3154		% (at_end_of_stream(Stream) -> Res = pred_true ; Res=pred_false).
3155
3156		is_not_declarative('EOF_STDIN').
3157		:- public 'EOF_STDIN'/2.
3158		'EOF_STDIN'(_,Res) :- % dummy argument to enable valid external predicate type declarations
3159		((peek_code(user_input,C), C = -1) -> Res = pred_true ; Res = pred_false).
3160
3161
3162		external_fun_type('CURRENT_FILE_POSITION',[],[string,string,integer]).
3163		is_not_declarative('CURRENT_FILE_POSITION').
3164		:- public 'CURRENT_FILE_POSITION'/3.
3165		'CURRENT_FILE_POSITION'(string(File),string(Field),Res) :-
3166		open_file_for_reading_if_necessary(File,Stream),
3167		stream_position(Stream,Pos),
3168		% POS must be one of byte_count [only for binary streams], line_count, character_count, line_position
3169		stream_position_data(Field,Pos,R), Res=int(R).
3170
3171		%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3172
3173		:- public 'ADD_ERROR'/6.
3174		expects_spaninfo('ADD_ERROR').
3175		expects_waitflag('ADD_ERROR').
3176		performs_io('ADD_ERROR').
3177		'ADD_ERROR'(string(Msg),Expr,_State,[],SpanInfo,WF) :-
3178		add_error_wf('ADD_ERROR',Msg,Expr,SpanInfo,WF).
3179
3180		:- public 'ADD_STATE_ERROR'/6.
3181		expects_spaninfo('ADD_STATE_ERROR').
3182		expects_waitflag('ADD_STATE_ERROR').
3183		performs_io('ADD_STATE_ERROR').
3184		'ADD_STATE_ERROR'(string(Msg),Expr,_State,[],SpanInfo,WF) :-
3185		%add_wd_error_span_now(Msg,Expr,SpanInfo,WF).
3186		%add_wd_error_span(Msg,Expr,SpanInfo,WF).
3187		add_state_error_wf('ADD_STATE_ERROR',Msg,Expr,SpanInfo,WF). % does not fail
3188
3189		:- public 'ADD_WARNING'/6.
3190		expects_spaninfo('ADD_WARNING').
3191		expects_waitflag('ADD_WARNING').
3192		performs_io('ADD_WARNING').
3193		'ADD_WARNING'(string(Msg),Expr,_State,[],SpanInfo,WF) :-
3194		add_warning_wf('ADD_WARNING',Msg,Expr,SpanInfo,WF).
3195
3196
3197		:- public 'ADD_ERRORS'/5.
3198		expects_spaninfo('ADD_ERRORS').
3199		expects_waitflag('ADD_ERRORS').
3200		performs_io('ADD_ERRORS').
3201		:- block 'ADD_ERRORS'(-,?,?,?,?).
3202		'ADD_ERRORS'(SetOfStrings,_State,[],SpanInfo,WF) :-
3203		expand_custom_set_to_list_wf(SetOfStrings,ESet,_,add_errors,WF),
3204		add_errors_aux(ESet,SpanInfo,WF).
3205		:- block add_errors_aux(-,?,?).
3206		add_errors_aux([],_SpanInfo,_WF).
3207		add_errors_aux([string(Msg)|T],SpanInfo,WF) :-
3208		add_error('ADD_ERRORS',Msg,'',SpanInfo),
3209		add_errors_aux(T,SpanInfo,WF).
3210
3211		:- public 'ADD_STATE_ERRORS'/5.
3212		expects_spaninfo('ADD_STATE_ERRORS').
3213		expects_waitflag('ADD_STATE_ERRORS').
3214		performs_io('ADD_STATE_ERRORS').
3215		:- block 'ADD_STATE_ERRORS'(-,?,?,?,?).
3216		'ADD_STATE_ERRORS'(SetOfStrings,_State,[],SpanInfo,WF) :-
3217		expand_custom_set_to_list_wf(SetOfStrings,ESet,_,add_state_errors,WF),
3218		add_state_errors_aux(ESet,SpanInfo,WF).
3219		:- block add_state_errors_aux(-,?,?).
3220		add_state_errors_aux([],_SpanInfo,_WF).
3221		add_state_errors_aux([string(Msg)|T],SpanInfo,WF) :-
3222		add_state_error_wf('ADD_STATE_ERRORS',Msg,'',SpanInfo,WF),
3223		add_state_errors_aux(T,SpanInfo,WF).
3224
3225		:- public 'ADD_WARNINGS'/5.
3226		expects_spaninfo('ADD_WARNINGS').
3227		expects_waitflag('ADD_WARNINGS').
3228		performs_io('ADD_WARNINGS').
3229		:- block 'ADD_WARNINGS'(-,?,?,?,?).
3230		'ADD_WARNINGS'(SetOfStrings,_State,[],SpanInfo,WF) :-
3231		expand_custom_set_to_list_wf(SetOfStrings,ESet,_,add_warnings,WF),
3232		add_warnings_aux(ESet,SpanInfo,WF).
3233		:- block add_warnings_aux(-,?,?).
3234		add_warnings_aux([],_SpanInfo,_WF).
3235		add_warnings_aux([string(Msg)|T],SpanInfo,WF) :-
3236		add_warning('ADD_WARNINGS',Msg,'',SpanInfo),
3237		% we do not add with WF and call stack: call stack contains call to ADD_WARNINGS with all error messages again
3238		add_warnings_aux(T,SpanInfo,WF).
3239
3240		:- public 'ASSERT_TRUE'/5.
3241		expects_spaninfo('ASSERT_TRUE').
3242		expects_waitflag('ASSERT_TRUE').
3243		external_fun_has_wd_condition('ASSERT_TRUE').
3244
3245		'ASSERT_TRUE'(PredVal,string(Msg),PredRes,SpanInfo,WF) :-
3246		assert_true(PredVal,Msg,PredRes,SpanInfo,WF).
3247
3248		:- block assert_true(-,?,?,?,?).
3249		assert_true(pred_true,_Msg,pred_true,_SpanInfo,_WF).
3250		assert_true(pred_false,Msg,Res,SpanInfo,WF) :-
3251		debug_format(19,'% Waiting for enumeration to finish to raise ASSERT_TRUE:~n ~w~n',[Msg]),
3252		add_error_ef('ASSERT_TRUE',Msg,'',SpanInfo,WF,Res).
3253
3254		% we could also use: add_wd_error_set_result
3255		add_error_ef(Source,Msg,Term,Span,WF,Res) :-
3256		get_enumeration_finished_wait_flag(WF,AWF),
3257		add_error_ef_aux(AWF,Source,Msg,Term,Span,WF,Res).
3258
3259		:- block add_error_ef_aux(-,?,?,?,?,?,?).
3260		add_error_ef_aux(_AWF,Source,Msg,Term,Span,_WF,Res) :-
3261		add_error(Source,Msg,Term,Span),
3262		Res = pred_false.
3263
3264		:- public 'ASSERT_EXPR'/6.
3265		expects_spaninfo('ASSERT_EXPR').
3266		expects_waitflag('ASSERT_EXPR').
3267		external_fun_has_wd_condition('ASSERT_EXPR').
3268		external_fun_type('ASSERT_EXPR',[T],[boolean,string,T,T]).
3269
3270		'ASSERT_EXPR'(PredVal,string(Msg),ExprVal,Res,SpanInfo,WF) :-
3271		% TO DO: call assertion_expression(Cond,ErrMsg,Expr)
3272		assert_expr(PredVal,Msg,ExprVal,Res,SpanInfo,WF).
3273
3274		:- block assert_expr(-,?,?,?,?,?).
3275		assert_expr(pred_true,_Msg,ExprVal,Res,_SpanInfo,_WF) :-
3276		Res = ExprVal.
3277		assert_expr(pred_false,Msg,_ExprVal,Res,SpanInfo,WF) :-
3278		add_error_ef('ASSERT_EXPR',Msg,'',SpanInfo,WF,Res).
3279
3280		% --------------------------
3281		% Reflection Functions
3282
3283		external_fun_type('STATE_AS_STRING',[],[integer,string]).
3284		external_function_requires_state('STATE_AS_STRING').
3285		:- public 'STATE_AS_STRING'/3.
3286		expects_waitflag('STATE_AS_STRING').
3287		'STATE_AS_STRING'(int(X),StateStr,WF) :-
3288		state_space:get_state_space_stats(NrNodes,_NrTransitions,_ProcessedNodes),
3289		get_wait_flag(NrNodes,'STATE_AS_STRING',WF,LWF),
3290		get_state2(X,StateStr,LWF).
3291		:- block get_state2(-,?,-).
3292		get_state2(X,StateStr,_) :-
3293		convert_id_to_nr(IDX,X),
3294		state_space:visited_expression(IDX,S),
3295		translate:translate_any_state(S,Str),
3296		StateStr = string(Str).
3297
3298		:- public 'CURRENT_STATE_AS_TYPED_STRING'/1.
3299		external_function_requires_state('CURRENT_STATE_AS_TYPED_STRING').
3300		external_fun_type('CURRENT_STATE_AS_TYPED_STRING',[],[string]).
3301		% translate current state values as parseable string
3302		'CURRENT_STATE_AS_TYPED_STRING'(string(Translation)) :-
3303		'VARS_AS_TYPED_STRING'(string(''),string(Translation)).
3304
3305		external_function_requires_state('VARS_AS_TYPED_STRING').
3306		external_fun_type('VARS_AS_TYPED_STRING',[],[string,string]).
3307		:- block 'VARS_AS_TYPED_STRING'(-,?).
3308		'VARS_AS_TYPED_STRING'(string(Prefix),string(Translation)) :-
3309		get_current_state_id(ID),
3310		visited_expression(ID,State),
3311		state_corresponds_to_fully_setup_b_machine(State,FullState),
3312		b_get_machine_constants(Constants),
3313		include(identifier_matches_prefix(Prefix),Constants,C1),
3314		b_get_machine_variables(Vars),
3315		include(identifier_matches_prefix(Prefix),Vars,V1),
3316		append(C1,V1,Ids),
3317		findall(Equality,(member(TID,Ids),
3318		generate_equality(TID,FullState,Equality)),Eqs),
3319		generate_typing_predicates(Ids,TypePreds),
3320		append(TypePreds,Eqs,Ps),
3321		conjunct_predicates(Ps,Pred),
3322		translate_bexpr_to_parseable(Pred,Translation).
3323
3324		:- use_module(probsrc(tools_strings), [atom_prefix/2]).
3325		identifier_matches_prefix(Prefix,b(identifier(ID),_,_)) :- atom_prefix(Prefix,ID).
3326
3327		generate_equality(TID,FullState,Equality) :- TID = b(identifier(ID),Type,_),
3328		if(member(bind(ID,Val),FullState),
3329		safe_create_texpr(equal(TID,b(value(Val),Type,[])),pred,Equality),
3330		add_error_fail('VARS_AS_TYPED_STRING','Could not find identifier:',TID)).
3331
3332		:- use_module(state_space,[visited_expression/2]).
3333		:- use_module(probsrc(tools_strings),[match_atom/3]).
3334		:- use_module(specfile,[property/2]).
3335		:- public 'STATE_PROPERTY'/3.
3336		% a useful function for VisB and XTL or CSP models to query state of model
3337		expects_spaninfo('STATE_PROPERTY').
3338		external_function_requires_state('STATE_PROPERTY').
3339		external_fun_type('STATE_PROPERTY',[],[string,string]).
3340		:- block 'STATE_PROPERTY'(-,?,?).
3341		'STATE_PROPERTY'(string(Prop),Res,Span) :- state_property2(Prop,Res,Span).
3342		:- block state_property2(-,?,?).
3343		state_property2(Prop,Res,Span) :-
3344		get_current_state_id(ID),
3345		visited_expression(ID,State),
3346		atom_codes(Prop,PC),
3347		(property(State,'='(StateProp,Val)), % TODO: this leads to error in B mode due to atom_codes error
3348		match_atom(Prop,PC,StateProp)
3349		-> (atom(Val) -> Res = string(Val)
3350		; number(Val), number_codes(Val,CC), atom_codes(Atom,CC) -> Res = string(Atom)
3351		; add_message(external_functions,'Cannot convert STATE_PROPERTY value to STRING ',Val,Span),
3352		Res = string('UNKNOWN')
3353		)
3354		; add_message(external_functions,'Unknown value for STATE_PROPERTY: ',Prop,Span),
3355		Res = string('UNKNOWN')
3356		).
3357
3358
3359		:- public 'STATE_SUCC'/5.
3360		external_fun_type('STATE_SUCC',[],[integer,integer,boolean]).
3361		expects_waitflag('STATE_SUCC').
3362		expects_spaninfo('STATE_SUCC').
3363		'STATE_SUCC'(X,Y,Res,Span,WF) :- 'STATE_TRANS'(X,_,Y,Res,Span,WF).
3364
3365		% synonym for function to BOOL rather than predicate
3366		'GET_IS_ENABLED'(OperationName,Res,Span,WF) :- 'ENABLED'(OperationName,Res,Span,WF).
3367		:- public 'GET_IS_ENABLED'/4.
3368		expects_waitflag('ENABLED').
3369		expects_waitflag('GET_IS_ENABLED').
3370		expects_spaninfo('ENABLED').
3371		expects_spaninfo('GET_IS_ENABLED').
3372		external_function_requires_state('ENABLED').
3373		external_function_requires_state('GET_IS_ENABLED').
3374		external_fun_type('ENABLED',[],[string,boolean]).
3375		'ENABLED'(OperationName,Res,Span,WF) :-
3376		get_current_state_id(ID),
3377		tcltk_interface:compute_all_transitions_if_necessary(ID,false),
3378		NrOps = 10, get_wait_flag(NrOps,'ENABLED',WF,LWF),
3379		% format('Checking ENABLED of ~w in state ~w~n',[OperationName,ID]),
3380		enabled_op(ID,OperationName,Res,Span,LWF).
3381
3382		:- use_module(probsrc(specfile),[b_or_z_mode/0, get_possible_event/1]).
3383		:- block enabled_op(?,-,?,?,-).
3384		enabled_op(ID,string(OpName),Res,Span,_) :-
3385		(var(OpName) -> get_possible_event(OpName) % is b_top_level_operation in b_or_z_mode
3386		; b_or_z_mode, \+ get_possible_event(OpName)
3387		-> (b_is_operation_name(OpName)
3388		-> add_warning('ENABLED','Not a top-level operation, use GET_GUARD_STATUS for: ',OpName,Span)
3389		; add_warning('ENABLED','Unknown operation/event: ',OpName,Span)
3390		)
3391		; true
3392		),
3393		(state_space_transition(ID,_,string(OpName),_,unknown) -> Res=pred_true
3394		; Res=pred_false,
3395		(get_preference(maxNrOfEnablingsPerOperation,0)
3396		-> add_warning('ENABLED','MAX_OPERATIONS is 0, you may want to use GET_GUARD_STATUS instead for: ',OpName,Span); true)
3397		).
3398
3399
3400		:- use_module(b_operation_guards,[get_quantified_operation_enabling_condition/5]).
3401		:- public 'GET_GUARD_STATUS'/4.
3402		expects_waitflag('GET_GUARD_STATUS').
3403		expects_spaninfo('GET_GUARD_STATUS').
3404		%expects_state('GET_GUARD_STATUS'). % passing state does not always work: to the outside it looks like this call requires no variables and constants
3405		external_function_requires_state('GET_GUARD_STATUS').
3406		external_fun_type('GET_GUARD_STATUS',[],[string,boolean]).
3407		% in contrast to ENABLED, this external function works by computing the guard and evaluating it
3408		% ENABLED just checks the state space; which is in principle more efficient but does not work when
3409		% either MAX_OPERATIONS=0 or subsidiary operations are inspected
3410		'GET_GUARD_STATUS'(Op,PredRes,Span,WF) :-
3411		get_current_state_id(ID),
3412		NrOps = 10, get_wait_flag(NrOps,'GET_GUARD_STATUS',WF,LWF),
3413		get_guard_status(ID,Op,PredRes,Span,WF,LWF).
3414		:- block get_guard_status(?,-,?,?,?,-).
3415		get_guard_status(ID,string(OpName),PredRes,Span,WF,_) :-
3416		Simplify=true,
3417		if(get_quantified_operation_enabling_condition(OpName, BExpr, _BSVars, Precise, Simplify),
3418		((Precise=precise -> true
3419		; add_message('GET_GUARD_STATUS','Guard of operation/event not precise: ',OpName,Span)),
3420		test_formula_in_state(ID,BExpr,PredRes,WF)),
3421		(add_error('GET_GUARD_STATUS','Unknown operation/event: ',OpName,Span),
3422		PredRes=pred_false)).
3423
3424
3425		% synonym for function to BOOL rather than predicate
3426		'GET_IS_ENABLED_TRANSITION'(OperationName,Res,WF) :- 'ENABLED_TRANSITION'(OperationName,Res,WF).
3427		:- public 'GET_IS_ENABLED_TRANSITION'/3.
3428		% a variation of ENABLED where we can check for arguments; useful for VisB but it relies on argument order
3429		external_fun_type('ENABLED_TRANSITION',[],[string,boolean]).
3430		expects_waitflag('ENABLED_TRANSITION').
3431		expects_waitflag('GET_IS_ENABLED_TRANSITION').
3432		external_function_requires_state('ENABLED_TRANSITION').
3433		external_function_requires_state('GET_IS_ENABLED_TRANSITION').
3434		'ENABLED_TRANSITION'(TransString,Res,WF) :-
3435		get_current_state_id(ID),
3436		tcltk_interface:compute_all_transitions_if_necessary(ID,false),
3437		NrOps = 10, get_wait_flag(NrOps,'GET_IS_ENABLED_TRANSITION',WF,LWF),
3438		% format('Checking ENABLED_TRANSITION of ~w in state ~w~n',[TransString,ID]),
3439		enabled_trans(ID,TransString,Res,LWF).
3440
3441		:- block enabled_trans(?,-,?,-),enabled_trans(?,-,-,?).
3442		enabled_trans(ID,string(TransitionStr),Res,LWF) :-
3443		enabled_trans2(ID,TransitionStr,Res,LWF).
3444		:- block enabled_trans2(?,-,?,-),enabled_trans2(?,-,-,?).
3445		enabled_trans2(ID,TransitionStr,Res,_) :- var(TransitionStr),!,
3446		(Res=pred_true -> transition_string(ID,Str,1000,_), TransitionStr=Str
3447		; enabled_trans2(ID,TransitionStr,Res,_) % wait until TransitionStr is known
3448		).
3449		enabled_trans2(ID,TransitionStr,Res,_) :-
3450		atom_length(TransitionStr,Limit),
3451		(transition_string(ID,TransitionStr,Limit,_) -> Res=pred_true ; Res=pred_false).
3452
3453		:- use_module(state_space,[transition/4]).
3454		:- use_module(translate,[translate_event_with_src_and_target_id/5]).
3455		transition_string(ID,TransitionStr,Limit,ToID) :-
3456		transition(ID,TransitionTerm,_TransID,ToID),
3457		% This will currently also output --> Res for operation results; probably we do not want that
3458		translate_event_with_src_and_target_id(TransitionTerm,ID,ToID,Limit,TransitionStr).
3459
3460		:- public 'NON_DET_STATE'/1.
3461		%is_not_declarative('NON_DET_STATE'). % depends on current state, but for any given state it is declarative
3462		external_fun_type('NON_DET_STATE',[],[boolean]).
3463		external_function_requires_state('NON_DET_STATE').
3464		% check if there is a non-deterministic transition: same transition different target state
3465		% similar to tcltk_goto_a_non_deterministic_node
3466		'NON_DET_STATE'(Res) :- get_current_state_id(ID),
3467		non_det_transition(ID,_OperationName,_,_), !,
3468		Res = pred_true.
3469		'NON_DET_STATE'(pred_false).
3470
3471		:- public 'NON_DET_OUTPUT_STATE'/1.
3472		%is_not_declarative('NON_DET_OUTPUT_STATE'). % depends on current state, but for any given state it is declarative
3473		external_function_requires_state('NON_DET_OUTPUT_STATE').
3474		external_fun_type('NON_DET_OUTPUT_STATE',[],[boolean]).
3475		% check if there is a non-deterministic transition: same transition different classic B operation result
3476		% similar to tcltk_goto_a_non_deterministic_output_node
3477		'NON_DET_OUTPUT_STATE'(Res) :- get_current_state_id(ID),
3478		non_det_output_transition2(ID,_OperationName), !,
3479		Res = pred_true.
3480		'NON_DET_OUTPUT_STATE'(pred_false).
3481
3482		% check if we find a state ID where OperationName leads to two different states with same arguments
3483		non_det_transition(ID,OperationName,TID1,TID2) :-
3484		tcltk_interface:compute_all_transitions_if_necessary(ID,false),
3485		transition(ID,Transition,TID1,ID1),
3486		get_operation_name(Transition,OperationName),
3487		get_operation_arguments(Transition,OperationArgs),
3488		transition(ID,Transition2,TID2,ID2),
3489		TID2 > TID1, ID1 \= ID2,
3490		get_operation_name(Transition2,OperationName), % same operation
3491		get_operation_arguments(Transition2,OperationArgs). % same arguments
3492
3493		:- use_module(probltlsrc(ltl_propositions), [non_det_output_transition/4]).
3494		% check if we find a state where an operation with output/result parameters is non-det in the output
3495		non_det_output_transition2(ID,OperationName) :-
3496		tcltk_interface:compute_all_transitions_if_necessary(ID,false), % TODO: detect if we are looping and computing guards/actions
3497		non_det_output_transition(ID,OperationName,_TID1,_TID2).
3498
3499		:- public 'GET_IS_DET'/3.
3500		expects_spaninfo('GET_IS_DET').
3501		external_function_requires_state('GET_IS_DET').
3502		external_fun_type('GET_IS_DET',[],[string,boolean]).
3503		% check if there is a non-deterministic transition for a given operation: same transition different target state
3504		:- block 'GET_IS_DET'(-,?,?).
3505		'GET_IS_DET'(string(OperationName),Res,Span) :-
3506		get_current_state_id(ID),
3507		nondet_op2(ID,OperationName,'GET_IS_DET',Res,Span).
3508
3509
3510		:- public 'GET_IS_DET_OUTPUT'/3.
3511		expects_spaninfo('GET_IS_DET_OUTPUT').
3512		external_function_requires_state('GET_IS_DET_OUTPUT').
3513		external_fun_type('GET_IS_DET_OUTPUT',[],[string,boolean]).
3514		% check if there is a non-deterministic transition for a given operation: same transition different target state
3515		:- block 'GET_IS_DET_OUTPUT'(-,?,?).
3516		'GET_IS_DET_OUTPUT'(string(OperationName),Res,Span) :-
3517		get_current_state_id(ID),
3518		nondet_op2(ID,OperationName,'GET_IS_DET_OUTPUT',Res,Span).
3519
3520		:- block nondet_op2(?,-,?,?,?).
3521		nondet_op2(_ID,OperationName,XFUN,Res,Span) :- \+ b_top_level_operation(OperationName),!,
3522		add_error(XFUN,'Not a valid top-level operation:',OperationName,Span),
3523		Res = pred_false.
3524		% Check if it has outputs and throw warning if not ?
3525		nondet_op2(ID,OperationName,'GET_IS_DET',Res,_Span) :-
3526		non_det_transition(ID,OperationName,_,_),
3527		!,
3528		Res = pred_false.
3529		nondet_op2(ID,OperationName,'GET_IS_DET_OUTPUT',Res,_Span) :-
3530		non_det_output_transition2(ID,OperationName),
3531		!,
3532		Res = pred_false.
3533		nondet_op2(_,_,_,pred_true,_Span).
3534
3535		:- public 'NON_DET_OUTPUT_OPERATIONS'/1.
3536		external_function_requires_state('NON_DET_OUTPUT_OPERATIONS').
3537		external_fun_type('NON_DET_OUTPUT_OPERATIONS',[],[set(string)]).
3538		'NON_DET_OUTPUT_OPERATIONS'(Res) :-
3539		get_current_state_id(ID),
3540		findall(string(OpName),
3541		non_det_output_transition2(ID,OpName),
3542		List),
3543		sort(List,SList),
3544		kernel_objects:equal_object_optimized(SList,Res).
3545
3546
3547		% -------------------
3548
3549		% usage e.g. for scheduler.mch: {x|x:PID & GET_IS_ENABLED_WITH_ARGS("new",x)=TRUE}
3550		expects_waitflag('GET_IS_ENABLED_WITH_ARGS').
3551		external_fun_type('GET_IS_ENABLED_WITH_ARGS',[X],[string,X,boolean]).
3552		expects_spaninfo('GET_IS_ENABLED_WITH_ARGS').
3553		external_function_requires_state('GET_IS_ENABLED_WITH_ARGS').
3554		expects_unevaluated_args('GET_IS_ENABLED_WITH_ARGS').
3555		:- public 'GET_IS_ENABLED_WITH_ARGS'/6.
3556		:- block 'GET_IS_ENABLED_WITH_ARGS'(-,?,?,?,?,?).
3557		% we would expect the operation name to be known statically, as the type of the arguments may differ amongst operations
3558		'GET_IS_ENABLED_WITH_ARGS'(OperationName,OperationArgs,Res,[OpNameExpr,UnEvalArgs|_],SpanInfo,WF) :-
3559		OperationName = string(OpName),
3560		check_operation_name_and_arg_type(OpName,UnEvalArgs,'GET_IS_ENABLED_WITH_ARGS',OpNameExpr),
3561		get_current_state_id(CurID),
3562		tcltk_interface:compute_all_transitions_if_necessary(CurID,false),
3563		'STATE_TRANS_ARGS'(int(CurID),OperationName,OperationArgs,_,Res,SpanInfo,WF).
3564
3565		%:- block check_operation_name(-,?,?).
3566		%check_operation_name(OpName,_,_) :- b_top_level_operation(OpName),!.
3567		%check_operation_name(OpName,XFUN,Span) :-
3568		% add_error(XFUN,'Unknown operation name:',OpName,Span).
3569		:- use_module(bmachine,[b_get_machine_operation_for_animation/4, b_is_operation_name/1]).
3570		:- block check_operation_name_and_arg_type(-,?,?,?).
3571		check_operation_name_and_arg_type(OpName,Args,XFUN,_) :- b_top_level_operation(OpName),!,
3572		get_texpr_type(Args,ArgType),
3573		b_get_machine_operation_for_animation(OpName,_Results,Parameters,_Body),
3574		check_argument_type_against_params(Parameters,OpName,ArgType,XFUN,Args).
3575		check_operation_name_and_arg_type(OpName,_,XFUN,Span) :- b_is_operation_name(OpName),!,
3576		% will never be executed as transition in state_space
3577		add_warning(XFUN,'Not a top-level operation name:',OpName,Span).
3578		check_operation_name_and_arg_type(OpName,_,XFUN,Span) :-
3579		add_error(XFUN,'Unknown operation name:',OpName,Span).
3580
3581		check_argument_type_against_params([],OpName,_,XFUN,Args) :- !,
3582		add_error(XFUN,'Operation has no arguments, use GET_IS_ENABLED instead:',OpName,Args).
3583		check_argument_type_against_params([Para],_OpName,ArgType,XFUN,Args) :- !,
3584		check_type(Para,ArgType,XFUN,Args).
3585		check_argument_type_against_params([Para|TParas],OpName,couple(PType1,PTypeRest),XFUN,Args) :- !,
3586		check_type(Para,PType1,XFUN,Args),
3587		check_argument_type_against_params(TParas,OpName,PTypeRest,XFUN,Args).
3588		check_argument_type_against_params(_,OpName,_ArgType,XFUN,Args) :- !,
3589		add_error(XFUN,'Not enough arugments provided for operation:',OpName,Args).
3590
3591		:- use_module(probsrc(btypechecker), [lookup_type_for_expr/2, unify_types_werrors/4]).
3592		check_type(Arg1,Type2,XFUN,Pos) :-
3593		get_texpr_type(Arg1,Type1),
3594		unify_types_werrors(Type1,Type2,Pos,XFUN).
3595
3596
3597		external_fun_type('STATE_TRANS',[],[integer,string,integer,boolean]).
3598		expects_waitflag('STATE_TRANS').
3599		expects_spaninfo('STATE_TRANS').
3600		'STATE_TRANS'(int(X),OperationName,int(Y),Res,SpanInfo,WF) :-
3601		'STATE_TRANS_ARGS'(int(X),OperationName,_,int(Y),Res,SpanInfo,WF).
3602
3603		external_fun_type('STATE_TRANS_ARGS',[X],[integer,string,X,integer,boolean]).
3604		expects_waitflag('STATE_TRANS_ARGS').
3605		expects_spaninfo('STATE_TRANS_ARGS').
3606		'STATE_TRANS_ARGS'(int(X),OperationName,OperationArgs,int(Y),Res,SpanInfo,WF) :-
3607		(nonvar(X)
3608		-> true
3609		; state_space:get_state_space_stats(NrNodes,_NrTransitions,_ProcessedNodes),
3610		get_wait_flag(NrNodes,'STATE_TRANS',WF,LWF)
3611		),
3612		get_wait_flag1('STATE_TRANS_ARGS',WF,WF1),
3613		get_succ2(X,OperationName,OperationArgs,Y,Res,LWF,WF1,SpanInfo).
3614		:- block get_succ2(-,?,?,-,?,-,?,?),
3615		get_succ2(?,?,?,?,?,?,-,?). % wait at least until WF1 (or at least wf0); as we do non-deterministic enumeration ! (e.g., otherwise b_interpreter_components gets confused !!)
3616		get_succ2(X,OperationName,OperationArgs,Y,Res,_,_,Pos) :- convert_id_to_nr(IDX,X),
3617		if((state_space_transition(IDX,IDY,OperationName,OperationArgs,Pos),
3618		convert_id_to_nr(IDY,Y)),
3619		Res=pred_true,Res=pred_false).
3620
3621		state_space_transition(IDX,IDY,OperationName,OperationArgs,Pos) :-
3622		state_space:transition(IDX,Transition,IDY),
3623		op_functor(Transition,OperationName),
3624		op_args(Transition,OperationArgs,Pos).
3625
3626		% root is represented as -1
3627		:- block convert_id_to_nr(-,-).
3628		convert_id_to_nr(ID,X) :- ID==root, !, X is -1.
3629		convert_id_to_nr(ID,X) :- X == -1, !, ID=root.
3630		convert_id_to_nr(X,X).
3631
3632		:- use_module(specfile,[get_operation_name/2,get_operation_arguments/2, get_operation_return_values_and_arguments/3]).
3633		op_functor(OpTerm,Res) :- get_operation_name(OpTerm,Name),
3634		Res = string(Name).
3635
3636		:- use_module(tools,[convert_list_into_pairs/2]).
3637		op_args(OpTerm,OperationArgs,Pos) :-
3638		get_operation_arguments(OpTerm,As),
3639		convert_list_into_pairs(As,ArgTerm),
3640		% first check if types are compatible; user could have provided wrong types;
3641		% TODO: sometimes we check_operation_name_and_arg_type and could remove this check in then
3642		kernel_objects:check_values_have_same_type(OperationArgs,ArgTerm,Pos),
3643		kernel_objects:equal_object(OperationArgs,ArgTerm).
3644
3645
3646		:- public 'STATE_SAT'/4.
3647		expects_waitflag('STATE_SAT').
3648		external_fun_type('STATE_SAT',[],[integer,string,boolean]).
3649		% check whether formula as string holds in a state
3650		:- block 'STATE_SAT'(?,-,?,?).
3651		'STATE_SAT'(int(X),string(Formula),Res,WF) :- %print(parsing(Formula)),nl, trace,
3652		parse_pred(Formula,TFormula),
3653		state_space:get_state_space_stats(NrNodes,_NrTransitions,_ProcessedNodes),
3654		get_wait_flag(NrNodes,'STATE_SAT',WF,LWF),
3655		state_sat2(X,TFormula,Res,LWF,WF).
3656		:- block state_sat2(?,-,?,?,?),state_sat2(-,?,?,-,?).
3657		state_sat2(X,TFormula,PredRes,_,WF) :-
3658		(number(X) -> test_formula_in_state(X,TFormula,PredRes,WF)
3659		; test_formula_in_state(ID,TFormula,PredRes,WF), ID \= root, X=ID % avoid CLPFD errors on X
3660		).
3661
3662		:- use_module(b_global_sets,[add_prob_deferred_set_elements_to_store/3]).
3663		:- use_module(specfile,[state_corresponds_to_fully_setup_b_machine/2]).
3664		%:- use_module(b_interpreter,[b_try_check_boolean_expression_wf/5]).
3665		test_formula_in_state(ID,Pred,PredRes,WF) :-
3666		state_space:visited_expression(ID,State),
3667		state_corresponds_to_fully_setup_b_machine(State,FullState),
3668		add_prob_deferred_set_elements_to_store(FullState,FullState1,visible),
3669		debug_println(9,check(Pred,FullState1,PredRes)),
3670		b_interpreter:b_try_check_boolean_expression_wf(Pred,[],FullState1,WF,PredRes).
3671
3672
3673		:- public 'EVAL'/6.
3674		expects_waitflag('EVAL'). % external function with unknown return type
3675		expects_type('EVAL').
3676		expects_spaninfo('EVAL').
3677		:- block 'EVAL'(?,-,?,?,?,?).
3678		'EVAL'(int(X),string(Expr),Value,Type,Span,WF) :-
3679		state_eval1(X,Expr,Value,pred_true,Type,Span,WF).
3680
3681		% evaluate expression and check whether value corresponds to provided value
3682		% (needed for type inference of the external predicate)
3683		%:- block 'STATE_EVAL'(?,-,?,?,?,?,?).
3684		%'STATE_EVAL'(int(X),string(Expr),Value,PredRes,Span,WF) :-
3685		% state_eval1(X,Expr,Value,PredRes,any,Span,WF).
3686
3687		:- use_module(btypechecker, [unify_types_strict/2]).
3688		:- block state_eval1(?,-,?,?,?,?,?).
3689		state_eval1(X,Expr,Value,PredRes,ExpectedType,Span,WF) :-
3690		% string must be provided ; we assume it will be ground
3691		parse_expr(Expr,TExpr),
3692		get_texpr_type(TExpr,Type),
3693		(unify_types_strict(ExpectedType,Type) -> true
3694		; pretty_type(Type,TS), pretty_type(ExpectedType,ETS),
3695		ajoin(['Type ',TS, ' does not match expected type ', ETS, ' for:'],Msg),
3696		add_error('EVAL',Msg,Expr,Span),fail
3697		),
3698		state_space:get_state_space_stats(NrNodes,_NrTransitions,_ProcessedNodes),
3699		get_wait_flag(NrNodes,'STATE_SAT',WF,LWF),
3700		state_eval2(X,TExpr,Value,LWF,PredRes).
3701		:- block state_eval2(?,-,?,?,?),state_eval2(-,?,?,-,?).
3702		state_eval2(X,TExpr,Value,_,PredRes) :-
3703		(number(X)
3704		-> eval_formula_in_state(TExpr,PredRes,X,Value)
3705		; eval_formula_in_state(TExpr,PredRes,ID,Value), ID \= root, X=ID % avoid CLPFD errors on X
3706		).
3707		:- use_module(kernel_equality,[equality_objects/3]).
3708		eval_formula_in_state(TExpr,PredRes,ID,Value) :-
3709		state_space:visited_expression(ID,State),
3710		state_corresponds_to_fully_setup_b_machine(State,FullState),
3711		add_prob_deferred_set_elements_to_store(FullState,FullState1,visible),
3712		debug_println(9,eval(TExpr,FullState1,Value)),
3713		equality_objects(Value,TExprValue,PredRes), % TO DO: Stronger Checks that types compatible
3714		b_interpreter:b_compute_expression_nowf(TExpr,[],FullState1,TExprValue,'STATE_EVAL',ID).
3715
3716		:- use_module(library(terms),[term_hash/2]).
3717		:- use_module(bmachine,[b_parse_machine_predicate/3]).
3718		:- dynamic parse_pred_cache/3.
3719		parse_pred(PredStr,TPred) :- term_hash(PredStr,Hash), parse_pred(PredStr,Hash,TPred).
3720		parse_pred(PredStr,Hash,TPred) :- parse_pred_cache(Hash,PredStr,TC),!, TPred=TC.
3721		parse_pred(PredStr,Hash,TPred) :-
3722		b_parse_machine_predicate(PredStr,[prob_ids(visible),variables],TC),
3723		assertz(parse_pred_cache(Hash,PredStr,TC)),
3724		TPred=TC.
3725
3726		:- dynamic parse_expr_cache/3.
3727		parse_expr(ExprStr,TExpr) :- term_hash(ExprStr,Hash), parse_expr(ExprStr,Hash,TExpr).
3728		parse_expr(ExprStr,Hash,TExpr) :- parse_expr_cache(Hash,ExprStr,TC),!, TExpr=TC.
3729		parse_expr(ExprStr,Hash,TExpr) :-
3730		atom_codes(ExprStr,Codes), %print(parsing(Expr,Codes)),nl,
3731		bmachine:b_parse_machine_expression_from_codes_with_prob_ids(Codes,TC),
3732		assertz(parse_expr_cache(Hash,ExprStr,TC)),
3733		TExpr=TC.
3734
3735		:- use_module(kernel_strings,[generate_code_sequence/3]).
3736		external_fun_type('HISTORY',[],[seq(integer)]).
3737		expects_spaninfo('HISTORY').
3738		:- public 'HISTORY'/2.
3739		'HISTORY'(Value,Span) :-
3740		get_current_history(H,Span), % does not include current state
3741		generate_code_sequence(H,1,Hist),
3742		kernel_objects:equal_object(Value,Hist).
3743
3744
3745		:- use_module(probsrc(state_space), [visited_state_corresponds_to_initialised_b_machine/1,history/1]).
3746
3747
3748		external_fun_type('EVAL_OVER_HISTORY',[X],[X,integer,seq(X)]).
3749		expects_unevaluated_args('EVAL_OVER_HISTORY').
3750		expects_spaninfo('EVAL_OVER_HISTORY').
3751		is_not_declarative('EVAL_OVER_HISTORY'). % depends on history, not explicitly part of arguments
3752
3753		:- public 'EVAL_OVER_HISTORY'/5.
3754		% related to tcltk_evaluate_expression_over_history
3755		:- block 'EVAL_OVER_HISTORY'(-,?,?,?,?), 'EVAL_OVER_HISTORY'(?,-,?,?,?).
3756		'EVAL_OVER_HISTORY'(CurValue,int(Limit),Res,Infos,Span) :-
3757		eval_over_history(CurValue,Limit,Res,Infos,Span).
3758
3759		:- use_module(probsrc(tools_lists),[include_maplist/3]).
3760		:- block eval_over_history(?,-,?,?,?).
3761		eval_over_history(CurValue,Limit,Res,[AST|_],Span) :-
3762		get_current_history(H,Span), % does not include current state
3763		(H=[ID1|SeqOfStateIds], \+visited_state_corresponds_to_initialised_b_machine(ID1) -> true ; SeqOfStateIds=H),
3764		(Limit<0 -> Seq2=SeqOfStateIds ; limit_history(SeqOfStateIds,Limit,Seq2,_Len)),
3765		include_maplist(eval_formula_in_state(AST,pred_true),Seq2,Values),
3766		append(Values,[CurValue],AllValues),
3767		convert_list_to_seq(AllValues,Res).
3768
3769		limit_history([],_,[],0).
3770		limit_history([H|T],Lim,Res,Len1) :- limit_history(T,Lim,TRes,Len), Len1 is Len+1,
3771		(Len >= Lim -> Res = TRes ; Res = [H|TRes]).
3772
3773
3774		:- use_module(probsrc(bool_pred),[negate/2]).
3775		external_fun_type('CHANGED',[X],[X,boolean]).
3776		expects_unevaluated_args('CHANGED').
3777		expects_spaninfo('CHANGED').
3778		is_not_declarative('CHANGED'). % depends on history, not explicitly part of arguments
3779
3780		:- public 'CHANGED'/4.
3781		% check if an expression has changed wrt the preceding state in the history
3782		:- block 'CHANGED'(-,?,?,?).
3783		'CHANGED'(CurValue,Res,[AST|_],Span) :-
3784		(get_current_history(H,Span),
3785		last(H,PrevID), % get_current_predecessor_state_id does not take current_state_id_for_external_fun into account
3786		visited_state_corresponds_to_initialised_b_machine(PrevID)
3787		-> eval_formula_in_state(AST,pred_true,PrevID,PrevValue),
3788		% TODO: the AST could refer to local variables, e.g., if CHANGED is called in a set comprehension
3789		% currently this will lead to identifier not found error messages
3790		equality_objects(CurValue,PrevValue,EqRes),
3791		negate(EqRes,Res)
3792		; Res=pred_false
3793		).
3794		external_fun_type('INCREASING',[X],[X,boolean]).
3795		expects_unevaluated_args('INCREASING').
3796		expects_spaninfo('INCREASING').
3797		is_not_declarative('INCREASING'). % depends on history, not explicitly part of arguments
3798
3799		:- public 'INCREASING'/4.
3800		% check if an expression has increased wrt the preceding state in the history
3801		:- block 'INCREASING'(-,?,?,?).
3802		'INCREASING'(CurValue,Res,[AST|_],Span) :-
3803		(get_current_history(H,Span),
3804		last(H,PrevID), % get_current_predecessor_state_id does not take current_state_id_for_external_fun into account
3805		visited_state_corresponds_to_initialised_b_machine(PrevID)
3806		-> eval_formula_in_state(AST,pred_true,PrevID,PrevValue),
3807		'LESS'(PrevValue,CurValue,Res) % LESS can handle numbers, strings, enumerated sets, ...
3808		; Res=pred_false
3809		).
3810
3811
3812		:- use_module(state_space,[is_initial_state_id/1]).
3813
3814		:- public 'INITIAL_STATE'/3.
3815		expects_waitflag('INITIAL_STATE'). % external function with unknown return type
3816		'INITIAL_STATE'(int(InitialState),PredRes,WF) :-
3817		get_wait_flag(2,'INITIAL_STATE',WF,LWF),
3818		is_init2(InitialState,PredRes,LWF).
3819		:- block is_init2(-,-,?), is_init2(-,?,-).
3820		is_init2(InitialState,PredRes,_) :-
3821		PredRes == pred_true,!,
3822		is_initial_state_id(InitialState).
3823		is_init2(InitialState,PredRes,_) :- number(InitialState),!,
3824		(is_initial_state_id(InitialState) -> PredRes=pred_true ; PredRes=pred_false).
3825		is_init2(InitialState,PredRes,_LWF) :-
3826		PredRes == pred_false,!,
3827		when(nonvar(InitialState), \+is_initial_state_id(InitialState)).
3828		is_init2(InitialState,PredRes,LWF) :-
3829		add_internal_error('Uncovered case: ', is_init2(InitialState,PredRes,LWF)),fail.
3830
3831
3832		% provide information about a particular B machine in the project
3833		:- public 'MACHINE_INFO'/4.
3834		expects_waitflag('MACHINE_INFO').
3835		external_fun_type('MACHINE_INFO',[],[string,string,string]).
3836		:- block 'MACHINE_INFO'(?,-,?,?).
3837		'MACHINE_INFO'(M,string(I),Value,WF) :-
3838		get_wait_flag(2,'MACHINE_INFO',WF,LWF), % TO DO: use number of machines
3839		machine_info2(I,M,Value,LWF).
3840
3841		:- use_module(b_machine_hierarchy,[machine_type/2]).
3842		:- block machine_info2(-,?,?,?), machine_info2(?,-,?,-).
3843		machine_info2(INFO,M,Value,_LWF) :-
3844		(ground(M) -> M = string(MachineName) ; true),
3845		machine_info3(INFO,MachineName,Type),
3846		(M,Value) = (string(MachineName),string(Type)).
3847
3848		:- use_module(b_machine_hierarchy,[machine_type/2]).
3849		% :- use_module(extension('probhash/probhash'),[raw_sha_hash/2]). % already imported above
3850		:- use_module(bmachine,[get_full_b_machine/2]).
3851		machine_info3('TYPE',MachineName,Type) :- !, machine_type(MachineName,Type).
3852		% SHA_HASH
3853		machine_info3(INFO,_,_) :- add_error('MACHINE_INFO','Unknown info field (TYPE recognised): ',INFO),fail.
3854
3855
3856		:- use_module(tools_strings,[get_hex_codes/2]).
3857		external_fun_type('INT_TO_HEX_STRING',[],[integer,string]).
3858		:- public 'INT_TO_HEX_STRING'/2.
3859		:- block 'INT_TO_HEX_STRING'(-,?).
3860		'INT_TO_HEX_STRING'(int(Int),Res) :- int_to_hex(Int,Res).
3861
3862		:- block int_to_hex(-,?).
3863		int_to_hex(Int,Res) :-
3864		(Int >= 0 -> Nat=Int ; Nat is -(Int)),
3865		get_hex_codes(Nat,Chars),
3866		(Int >= 0 -> atom_codes(Atom,Chars) ; atom_codes(Atom,[45|Chars])), % "-" = [45]
3867		Res = string(Atom).
3868
3869
3870		:- use_module(tools_strings,[get_hex_bytes/2]).
3871		sha_hash_as_hex_codes(Term,SHAHexCodes) :-
3872		raw_sha_hash(Term,RawListOfBytes),
3873		get_hex_bytes(RawListOfBytes,SHAHexCodes).
3874
3875
3876
3877		%-------------------
3878
3879		% returns list of strings for info string such as files, variables,...
3880		external_fun_type('PROJECT_STATISTICS',[],[string,integer]).
3881		expects_waitflag('PROJECT_STATISTICS').
3882		expects_spaninfo('PROJECT_STATISTICS').
3883		:- public 'PROJECT_STATISTICS'/4.
3884		'PROJECT_STATISTICS'(Str,Res,Span,WF) :-
3885		kernel_waitflags:get_wait_flag(10,'PROJECT_STATISTICS',WF,WF10), % will enumerate possible input strings
3886		project_stats1(Str,Res,WF10,Span).
3887
3888		:- use_module(bmachine,[b_machine_statistics/2]).
3889		:- block project_stats1(-,?,-,?).
3890		project_stats1(string(INFO),Res,_,Span) :-
3891		if(b_machine_statistics(INFO,Nr), Res=int(Nr),
3892		add_error('PROJECT_STATISTICS','Unknown info field: ',INFO,Span)).
3893
3894
3895		% returns list of strings for info string such as files, variables,...
3896		external_fun_type('PROJECT_INFO',[],[string,set(string)]).
3897		expects_waitflag('PROJECT_INFO').
3898		expects_spaninfo('PROJECT_INFO').
3899		:- public 'PROJECT_INFO'/4.
3900		'PROJECT_INFO'(Str,Res,Span,WF) :-
3901		kernel_waitflags:get_wait_flag(10,'PROJECT_INFO',WF,WF10), % will enumerate possible input strings
3902		project_info1(Str,Res,WF10,Span).
3903
3904		:- block project_info1(-,?,-,?).
3905		project_info1(string(INFO),Res,_,_Span) :- INFO==help,!,
3906		L = [files, absolute-files, main-file, main-machine, sha-hash,
3907		variables, constants, sets, operations, assertion_labels, invariant_labels],
3908		maplist(make_string,L,SL),
3909		kernel_objects:equal_object(SL,Res).
3910		project_info1(string(INFO),Res,_,Span) :-
3911		if(list_info(INFO,L),
3912		(maplist(make_string,L,SL),
3913		kernel_objects:equal_object(SL,Res)),
3914		(add_error(external_functions,'Illegal argument for PROJECT_INFO or :list (use help to obtain valid arguments) : ',INFO,Span),
3915		fail)).
3916
3917		:- use_module(bmachine).
3918		:- use_module(bsyntaxtree, [get_texpr_ids/2, get_texpr_label/2]).
3919		:- use_module(tools,[get_tail_filename/2]).
3920		list_info(files,TL) :- (b_get_all_used_filenames(L) -> true ; L=[]), maplist(get_tail_filename,L,TL).
3921		list_info('absolute-files',L) :- (b_get_all_used_filenames(L) -> true ; L=[]).
3922		list_info('main-file',L) :- (b_get_main_filename(F) -> get_tail_filename(F,TF),L=[TF] ; L=[]).
3923		list_info('main-machine',L) :- findall(Name,get_full_b_machine(Name,_),L). % gets only the main machine
3924		list_info('sha-hash',[AtomHash]) :-
3925		get_full_b_machine_sha_hash(Bytes),
3926		get_hex_bytes(Bytes,Hash), atom_codes(AtomHash,Hash).
3927		list_info(variables,L) :- b_get_machine_variables(LT), get_texpr_ids(LT,L).
3928		list_info(constants,L) :- b_get_machine_constants(LT), get_texpr_ids(LT,L).
3929		list_info(sets,L) :- findall(S,b_get_machine_set(S),L).
3930		list_info(operations,L) :- findall(S,b_top_level_operation(S),L).
3931		list_info(assertion_labels,L) :-
3932		findall(ID,(b_get_assertions(all,_,Ass), member(Assertion,Ass),get_texpr_label(Assertion,ID)),L).
3933		list_info(invariant_labels,L) :-
3934		findall(ID,(b_get_invariant_from_machine(C), conjunction_to_list(C,CL),
3935		member(Inv,CL),get_texpr_label(Inv,ID)),L).
3936
3937
3938		make_string(X,Res) :- atom(X),!,Res=string(X).
3939		make_string(X,Res) :- format_to_codes('~w',X,C), atom_codes(Atom,C), Res=string(Atom).
3940
3941		% obtain the source code of an identifier
3942		external_fun_type('SOURCE',[],[string,string]).
3943		:- public 'SOURCE'/2.
3944		'SOURCE'(string(ID),SourceCode) :- source2(ID,SourceCode).
3945		:- block source2(-,?).
3946		source2(ID,SourceCode) :-
3947		source_code_for_identifier(ID,_,_,_OriginStr,_,Source),
3948		translate:translate_bexpression(Source,SC),
3949		SourceCode = string(SC).
3950
3951
3952		% obtain various information about ProB (STRING result)
3953		external_fun_type('PROB_INFO_STR',[],[string,string]).
3954		expects_waitflag('PROB_INFO_STR').
3955		:- assert_must_succeed(external_functions:'PROB_INFO_STR'(string('prob-version'),string(_),_)).
3956		:- public 'PROB_INFO_STR'/3.
3957		% :- block 'PROB_INFO_STR'(-,?). % no block: this way we can via backtracking generate solutions
3958		'PROB_INFO_STR'(Str,Res,WF) :-
3959		kernel_waitflags:get_wait_flag(10,'PROB_INFO_STR',WF,WF10), % will enumerate possible input strings
3960		prob_info1(Str,Res,WF10,WF).
3961
3962		:- use_module(tools,[ajoin_with_sep/3]).
3963		:- block prob_info1(-,?,-,?).
3964		prob_info1(string(INFO),Res,_,WF) :-
3965		if(prob_info2(INFO,Str),true,
3966		(findall(I,prob_info2(I,_),Is),
3967		ajoin_with_sep(['Unknown info field, known fields:'|Is],' ',Msg),
3968		add_error_wf('PROB_INFO_STR',Msg,I,unknown,WF),
3969		Str = 'ERROR'
3970		)),
3971		make_string(Str,Res).
3972
3973		:- use_module(probsrc(tools_strings),[ajoin/2]).
3974		:- use_module(parsercall,[get_parser_version/1, get_java_command_path/1, get_java_fullversion/3]).
3975		:- use_module(version, [version_str/1, revision/1, lastchangeddate/1]).
3976		prob_info2('prob-version',V) :- version_str(V).
3977		prob_info2('parser-version',V) :- get_parser_version(V).
3978		prob_info2('prolog-version',V) :- current_prolog_flag(version,V).
3979		prob_info2('prob-revision',V) :- revision(V).
3980		prob_info2('prob-last-changed-date',V) :- lastchangeddate(V).
3981		prob_info2('java-version',V) :- get_java_fullversion(Maj,Min,Sfx), ajoin([Maj,'.',Min,'.',Sfx],V).
3982		prob_info2('java-command-path',V) :- get_java_command_path(V).
3983		prob_info2('current-time',V) :- get_info2(time,string(V)). % Maybe we can get rid of GET_INFO ?
3984
3985
3986		% obtain various information about ProB (INTEGER result)
3987		external_fun_type('PROB_STATISTICS',[],[string,integer]).
3988		expects_waitflag('PROB_STATISTICS').
3989		expects_spaninfo('PROB_STATISTICS').
3990		external_function_requires_state('PROB_STATISTICS'). % e.g., for current-state-id
3991		:- public 'PROB_STATISTICS'/4.
3992		'PROB_STATISTICS'(Str,Res,Span,WF) :-
3993		kernel_waitflags:get_wait_flag(10,'PROB_STATISTICS',WF,WF10), % will enumerate possible input strings
3994		prob_info_int1(Str,Res,Span,WF10,WF).
3995
3996		% old name of function:
3997		:- public 'PROB_INFO_INT'/4.
3998		'PROB_INFO_INT'(Str,Res,Span,WF) :- 'PROB_STATISTICS'(Str,Res,Span,WF).
3999
4000		:- block prob_info_int1(-,?,?,-,?).
4001		prob_info_int1(string(INFO),Res,Span,_,WF) :-
4002		if(prob_info_int1(INFO,I), Res=int(I),
4003		(add_error_wf('PROB_STATISTICS','Unknown info field: ',INFO,Span,WF),
4004		fail)).
4005
4006		:- use_module(state_space_exploration_modes,[get_current_breadth_first_level/1]).
4007		:- use_module(state_space,[get_state_space_stats/3]).
4008		prob_info_int1('current-state-id',StateIDNr) :- get_current_state_id(ID),convert_id_to_nr(ID,StateIDNr).
4009		prob_info_int1('states',NrNodes) :- get_state_space_stats(NrNodes,_,_).
4010		prob_info_int1('transitions',NrTransitions) :- get_state_space_stats(_,NrTransitions,_).
4011		prob_info_int1('processed-states',ProcessedNodes) :- get_state_space_stats(_,_,ProcessedNodes).
4012		prob_info_int1('bf-level',Level) :- (get_current_breadth_first_level(R) -> Level = R ; Level = -1).
4013		prob_info_int1('now-timestamp',N) :- now(N). % provide UNIX timesstamp
4014		prob_info_int1('prolog-runtime',V) :- statistics(runtime,[V,_]).
4015		prob_info_int1('prolog-walltime',V) :- statistics(walltime,[V,_]).
4016		prob_info_int1('prolog-memory-bytes-used',V) :- statistics(memory_used,V).
4017		prob_info_int1('prolog-memory-bytes-free',V) :- statistics(memory_free,V).
4018		prob_info_int1('prolog-global-stack-bytes-used',V) :- statistics(global_stack_used,V).
4019		prob_info_int1('prolog-local-stack-bytes-used',V) :- statistics(local_stack_used,V).
4020		%prob_info_int1('prolog-global-stack-bytes-free',V) :- statistics(global_stack_free,V).
4021		%prob_info_int1('prolog-local-stack-bytes-free',V) :- statistics(local_stack_free,V).
4022		prob_info_int1('prolog-trail-bytes-used',V) :- statistics(trail_used,V).
4023		prob_info_int1('prolog-choice-bytes-used',V) :- statistics(choice_used,V).
4024		prob_info_int1('prolog-atoms-bytes-used',V) :- statistics(atoms_used,V).
4025		prob_info_int1('prolog-atoms-nb-used',V) :- statistics(atoms_nbused,V).
4026		prob_info_int1('prolog-gc-count',V) :- statistics(gc_count,V).
4027		prob_info_int1('prolog-gc-time',V) :- statistics(gc_time,V).
4028
4029		% --------------------
4030
4031		% coverage/projection functions:
4032
4033		external_fun_type('STATE_VALUES',[T],[string,set(couple(couple(integer,integer),T))]).
4034		expects_unevaluated_args('STATE_VALUES').
4035		:- public 'STATE_VALUES'/3.
4036		:- block 'STATE_VALUES'(-,?,?).
4037		'STATE_VALUES'(_Value,Res,[AST]) :-
4038		state_space_reduction:compute_set_of_covered_values_for_typed_expression(AST,Set),
4039		kernel_objects:equal_object_optimized(Set,Res).
4040
4041		% TODO: other projection/reduction operators: projection as graph, ...
4042		% could be useful to have a minimum/maximum operator on sets which uses Prolog order in avl
4043
4044		% -----------------
4045
4046		% obtain various information about bvisual2 Formulas
4047		external_fun_type('FORMULA_INFOS',[],[string,seq(string)]).
4048		expects_waitflag('FORMULA_INFOS').
4049		:- public 'FORMULA_INFOS'/3.
4050		'FORMULA_INFOS'(Str,Res,WF) :-
4051		kernel_waitflags:get_wait_flag(10,'FORMULA_INFOS',WF,WF10), % will enumerate possible input strings
4052		formula_info(Str,_,Res,_,WF10).
4053		external_fun_type('FORMULA_VALUES',[],[string,seq(string)]).
4054		expects_waitflag('FORMULA_VALUES').
4055		:- public 'FORMULA_VALUES'/3.
4056		'FORMULA_VALUES'(Str,Res,WF) :-
4057		kernel_waitflags:get_wait_flag(10,'FORMULA_VALUES',WF,WF10), % will enumerate possible input strings
4058		formula_info(Str,_,_,Res,WF10).
4059
4060		:- use_module(extrasrc(bvisual2),[bv_get_top_level_formula/4, bv_value_to_atom/2]).
4061
4062		% valid TopLevelCategories are constants, definitions, guards_top_level, inv, sets, variables
4063		:- block formula_info(-,?,?,?,-).
4064		formula_info(string(TopLevelCategory),CatTextRes,LabelRes,ValuesRes,_) :-
4065		bv_get_top_level_formula(TopLevelCategory,CatText,Labels,Values),
4066		CatTextRes = string(CatText),
4067		maplist(make_string,Labels,LS),
4068		convert_list_to_seq(LS,LabelRes),
4069		maplist(make_value,Values,LV),
4070		convert_list_to_seq(LV,ValuesRes).
4071
4072		make_value(V,string(A)) :- bv_value_to_atom(V,A).
4073		%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4074
4075
4076		% --------------------------
4077
4078		:- use_module(covsrc(hit_profiler),[add_hit/2, add_hit_if_not_covered/2,
4079		get_profile_statistics/2, profile_functor/1]). %profiler:profile_statistics.
4080
4081		:- public 'GET_PROFILE_STATISTICS'/3.
4082		is_not_declarative('GET_PROFILE_STATISTICS').
4083		:- block 'GET_PROFILE_STATISTICS'(-,?,?).
4084		'GET_PROFILE_STATISTICS'(string(PP),_DummyType,Res) :- % DummyType is just there for typing purposes
4085		if(profile_functor(PP),
4086		(get_profile_statistics(PP,Hits),
4087		maplist(translate_hit_to_b,Hits,List)),
4088		List = []),
4089		equal_object_optimized(List,Res, 'GET_PROFILE_STATISTICS').
4090		%equal_object(List,Res,'GET_PROFILE_STATISTICS'), print(res(Res)),nl.
4091
4092		translate_hit_to_b(hit(Arg,Nr),(Arg,int(Nr))).
4093
4094		:- public 'GET_PROFILE_POINTS'/1.
4095		'GET_PROFILE_POINTS'(Res) :- findall(string(S),profile_functor(S),List),
4096		equal_object_optimized(List,Res,'PROFILE_POINT').
4097
4098		expects_spaninfo('PROFILE').
4099		:- public 'PROFILE'/5.
4100		:- block 'PROFILE'(-,?,?,?,?), 'PROFILE'(?,-,?,?,?). %, 'PROFILE'(?,-,?,?,?).
4101		'PROFILE'(string(PP),Count,Value,ValueRes,SpanInfo) :-
4102		add_profile_exf_hit(Value,PP,SpanInfo,Count),
4103		equal_object(Value,ValueRes,'PROFILE').
4104
4105		:- block add_profile_exf_hit(-,?,?,?), add_profile_exf_hit(?,-,?,?).
4106		add_profile_exf_hit(pred_true,PP,SpanInfo,Count) :- !, add_value_hit(Count,pred_true,PP,SpanInfo).
4107		add_profile_exf_hit(pred_false,PP,SpanInfo,Count) :- !, add_value_hit(Count,pred_false,PP,SpanInfo).
4108		add_profile_exf_hit(int(X),PP,SpanInfo,Count) :- !, add_int_hit(X,PP,SpanInfo,Count).
4109		add_profile_exf_hit(string(X),PP,SpanInfo,Count) :- !, add_string_hit(X,PP,SpanInfo,Count).
4110		add_profile_exf_hit(Value,PP,SpanInfo,Count) :- when(ground(Value), add_complex_hit(Value,PP,SpanInfo,Count)).
4111
4112		add_complex_hit(Value,PP,SpanInfo,Count) :- print(PP), print(' : '), translate:print_bvalue(Value),nl,
4113		add_value_hit(Count,Value,PP,SpanInfo).
4114
4115		:- block add_int_hit(-,?,?,?).
4116		add_int_hit(X,PP,SpanInfo,Count) :- add_value_hit(Count,int(X),PP,SpanInfo).
4117		:- block add_string_hit(-,?,?,?).
4118		add_string_hit(X,PP,SpanInfo,Count) :- add_value_hit(Count,string(X),PP,SpanInfo).
4119
4120		add_value_hit(pred_true,Val,PP,_) :- add_hit(PP,Val).
4121		add_value_hit(pred_false,Val,PP,_) :- add_hit_if_not_covered(PP,Val).
4122
4123		% -------------------
4124
4125		:- use_module(memoization,[get_complete_memoization_expansion/6]).
4126
4127		expects_spaninfo('MEMOIZE_STORED_FUNCTION').
4128		expects_waitflag('MEMOIZE_STORED_FUNCTION').
4129		:- public 'MEMOIZE_STORED_FUNCTION'/4.
4130		:- block 'MEMOIZE_STORED_FUNCTION'(-,?,?,?).
4131		'MEMOIZE_STORED_FUNCTION'(int(MemoID),Res,Span,WF) :- memoize_get_aux(MemoID,Res,Span,WF).
4132
4133		:- block memoize_get_aux(-,?,?,?).
4134		memoize_get_aux(MemoID,Res,Span,WF) :-
4135		if(get_complete_memoization_expansion(MemoID,RV,_Done,Span,'MEMOIZE_STORED_FUNCTION',WF),
4136		kernel_objects:equal_object_wf(Res,RV,WF),
4137		add_error(external_functions,'Function ID not registered:',MemoID,Span)).
4138
4139		% -------------------
4140
4141		:- use_module(eval_let_store,[stored_let_value/3, set_stored_let_value/3,
4142		retract_stored_let_value/3, reset_let_values/0,
4143		extend_state_with_stored_lets/2, get_stored_let_typing_scope/1]).
4144
4145		:- public 'STORE'/4.
4146		external_fun_type('STORE',[X],[X,X]).
4147		expects_waitflag('STORE').
4148		expects_unevaluated_args('STORE').
4149		% stores values just like :let in the REPL does, but can be used within a predicate;
4150		% here name inferred from AST and it is a transparent function for more convenient annotation
4151		:- block 'STORE'(-,?,?,?).
4152		'STORE'(Val,Res,[TVal],WF) :- equal_object_optimized_wf(Val,Res,'STORE',WF),
4153		(translate:try_get_identifier(TVal,ID) -> true % also checks for was_identifier
4154		; translate:translate_bexpression(TVal,ID),
4155		add_warning('STORE','The expression is not an identifier:',ID,TVal)
4156		),
4157		'STORE_VALUE'(string(ID),Val,pred_true,[_,TVal],WF).
4158
4159		external_fun_type('STORE_VALUE',[X],[string,X,boolean]).
4160		expects_waitflag('STORE_VALUE').
4161		expects_unevaluated_args('STORE_VALUE').
4162		% stores values just like :let in the REPL does, but can be used within a predicate
4163		:- block 'STORE_VALUE'(-,?,?,?,?).
4164		'STORE_VALUE'(string(ID),Val,PredRes,[_,TVal],WF) :- PredRes=pred_true,
4165		get_enumeration_finished_wait_flag(WF,EWF),
4166		get_texpr_type(TVal,Type),
4167		store_value(ID,Type,Val,EWF).
4168
4169		:- block store_value(-,?,?,?), store_value(?,?,?,-).
4170		store_value(ID,Type,Val,_) :-
4171		set_stored_let_value(ID,Type,Val).
4172
4173
4174		:- use_module(btypechecker, [unify_types_werrors/4]).
4175		:- public 'RECALL_VALUE'/5.
4176		external_fun_type('RECALL_VALUE',[X],[string,X]).
4177		expects_waitflag('RECALL_VALUE').
4178		expects_spaninfo('RECALL_VALUE').
4179		expects_type('RECALL_VALUE').
4180		:- block 'RECALL_VALUE'(-,?,?,?,?).
4181		'RECALL_VALUE'(string(ID),Res,Type,Span,WF) :-
4182		recall_value(ID,Res,Type,Span,WF).
4183
4184		recall_value(ID,Res,Type,Span,WF) :-
4185		stored_let_value(ID,StoredType,Val),
4186		!,
4187		(unify_types_werrors(Type,StoredType,Span,'RECALL_VALUE')
4188		-> equal_object_optimized_wf(Val,Res,'RECALL_VALUE',WF)
4189		; add_error_wf('RECALL_VALUE','Stored value has incompatible type:',ID,Span,WF)
4190		).
4191		recall_value(ID,_,_,Span,WF) :-
4192		add_error_wf('RECALL_VALUE','No value stored with STORE_VALUE or :let for:',ID,Span,WF),
4193		fail.
4194
4195		% TODO: do we need a DELETE_STORED_VALUE external function
4196
4197		% -------------------
4198		% a few ugraphs (unweighted graphs) utilities:
4199
4200		% an alternate implementation of closure1
4201		expects_spaninfo('CLOSURE1').
4202		external_fun_type('CLOSURE1',[X],[set(couple(X,X)),set(couple(X,X))]).
4203		:- public 'CLOSURE1'/3.
4204		:- block 'CLOSURE1'(-,?,?).
4205		'CLOSURE1'([],Res,_) :- !, kernel_objects:equal_object(Res,[]).
4206		'CLOSURE1'(avl_set(A),Res,_) :- !, closure1_for_avl_set(A,R), kernel_objects:equal_object_optimized(R,Res).
4207		'CLOSURE1'(A,Res,Span) :- ground_value_check(A,Gr), closure1_gr(A,Gr,Res,Span).
4208
4209		closure1_gr(Set,_,Res,Span) :- convert_to_avl(Set,AVL),!, 'CLOSURE1'(AVL,Res,Span).
4210		closure1_gr(Set,_,_,Span) :-
4211		add_error(external_functions,'Cannot convert CLOSURE1 argument to set: ',Set,Span).
4212
4213		% compute strongly connected components
4214		expects_spaninfo('SCCS').
4215		external_fun_type('SCCS',[X],[set(couple(X,X)),set(set(X))]).
4216		:- public 'SCCS'/3.
4217		:- block 'SCCS'(-,?,?).
4218		'SCCS'([],Res,_) :- !, kernel_objects:equal_object(Res,[]).
4219		'SCCS'(avl_set(A),Res,_) :- !, sccs_for_avl_set(A,R), kernel_objects:equal_object_optimized(R,Res).
4220		'SCCS'(A,Res,Span) :- ground_value_check(A,Gr), sccs_gr(A,Gr,Res,Span).
4221
4222		sccs_gr(Set,_,Res,Span) :- convert_to_avl(Set,AVL),!, 'SCCS'(AVL,Res,Span).
4223		sccs_gr(Set,_,_,Span) :-
4224		add_error(external_functions,'Cannot convert SCCS argument to set: ',Set,Span).
4225
4226		:- use_module(extrasrc(avl_ugraphs),[avl_transitive_closure/2, avl_scc_sets/2]).
4227		closure1_for_avl_set(A,Res) :-
4228		avl_transitive_closure(A,TC),
4229		construct_avl_set(TC,Res).
4230		sccs_for_avl_set(A,Res) :-
4231		avl_scc_sets(A,TC),
4232		construct_avl_set(TC,Res).
4233		construct_avl_set(Avl,Res) :- empty_avl(Avl) -> Res = [] ; Res = avl_set(Avl).
4234		% -------------------
4235
4236		reset_kodkod :-
4237		true. %retractall(kodkod_pred(_,_)).
4238
4239		%:- use_module(probsrc(bsyntaxtree), [b_compute_expression/5]).
4240
4241		% KODKOD(ProblemID, LocalIDsOfPredicate, WaitToBeGroundBeforePosting, PredicateAsBooleanFunction)
4242		% EXTERNAL_PREDICATE_KODKOD(T1,T2) == INTEGER*T1*T2*BOOL;
4243		%:- dynamic kodkod_pred/2. % now stored as attribute in WF store
4244		do_not_evaluate_args('KODKOD').
4245		expects_unevaluated_args('KODKOD').
4246		expects_waitflag('KODKOD').
4247		expects_spaninfo('KODKOD').
4248		expects_state('KODKOD').
4249
4250		:- use_module(bsyntaxtree,[create_negation/2]).
4251		:- use_module(b_compiler,[b_optimize/6]).
4252		:- use_module(b_interpreter,[b_compute_expression/5]).
4253		:- public 'KODKOD'/6.
4254		:- block 'KODKOD'(-,?,?,?,?,?).
4255		'KODKOD'(PredRes,LocalState,State,UnevaluatedArgs,Span,WF) :-
4256		UnevaluatedArgs = [TID,IDEXPR,WAITIDEXPR,UEA],
4257		get_integer(TID,ID),
4258		construct_predicate(UEA,KPredicate),
4259		(PredRes == pred_false -> create_negation(KPredicate,Predicate) ; Predicate=KPredicate),
4260		must_get_identifiers('KODKOD',IDEXPR,TIdentifiers),
4261		get_texpr_ids(TIdentifiers,Ids),
4262		b_compute_expression(WAITIDEXPR,LocalState,State,WaitVal,WF),
4263		when(ground(WaitVal),
4264		( b_optimize(Predicate,Ids,LocalState,State,CPredicate,WF),
4265		(debug:debug_mode(off) -> true
4266		; add_message(kodkod,'STORING FOR KODKOD : ',ID:PredRes,Span), translate:print_bexpr(CPredicate),nl),
4267		kernel_waitflags:my_add_predicate_to_kodkod(WF,ID,CPredicate),
4268		%assertz(kodkod_pred(ID,CPredicate)), % TO DO: attach to WF Store !; assertz will break Prolog variable links !
4269		% TO DO: retract upon backtracking + store negation if PredRes = pred_false
4270		PredRes=pred_true
4271		)).
4272
4273
4274		:- use_module(probsrc(bsyntaxtree), [safe_create_texpr/3]).
4275		construct_predicate(b(convert_bool(P),_,_),Res) :- !, Res=P.
4276		construct_predicate(BoolExpr,Res) :-
4277		safe_create_texpr(equal(BoolExpr,b(boolean_true,boolean,[])),pred,Res).
4278
4279		:- use_module(kodkodsrc(kodkod), [replace_by_kodkod/3]).
4280		% EXTERNAL_PREDICATE_KODKOD_SOLVE(T1,T2) == INTEGER*T1*T2;
4281		expects_unevaluated_args('KODKOD_SOLVE').
4282		expects_waitflag('KODKOD_SOLVE').
4283		expects_state('KODKOD_SOLVE').
4284		:- public 'KODKOD_SOLVE'/8.
4285		:- block 'KODKOD_SOLVE'(-,?,?,?,?,?,?,?).
4286		'KODKOD_SOLVE'(int(ID),Ids,WaitIds,PredRes,LocalState,State,UEA,WF) :-
4287		when(ground(WaitIds),
4288		kodkod_solve_aux(ID,Ids,WaitIds,PredRes,LocalState,State,UEA,WF)).
4289
4290		:- use_module(library(ordsets),[ord_subtract/3]).
4291		kodkod_solve_aux(ID,Ids,_WaitIds,PredRes,LocalState,State,UEA,WF) :-
4292		%print(trigger_SOLVE(_WaitIds)),nl,
4293		get_wait_flag(2,'KODKOD_SOLVE',WF,LWF), % give other co-routines chance to fire
4294		kodkod_solve_aux2(ID,Ids,PredRes,LocalState,State,UEA,WF,LWF).
4295
4296		:- block kodkod_solve_aux2(?,?,?,?,?,?,?,-).
4297		kodkod_solve_aux2(ID,_,PredRes,LocalState,State,[_,IDEXPR,WAITIDEXPR],WF,_) :-
4298		%print(ls(LocalState,State)),nl,
4299		%findall(P,kodkod_pred(ID,P),Ps), % TO DO: obtain from WF Store
4300		kernel_waitflags:my_get_kodkod_predicates(WF,ID,Ps),
4301		length(Ps,Len),
4302		reverse(Ps,RPs), % we reverse Ps to put predicates in same order they were added by KODKOD / seems to influence analysis time
4303		conjunct_predicates(RPs,Predicate),
4304		%translate:print_bexpr(Predicate),nl,
4305		must_get_identifiers('KODKOD_SOLVE',IDEXPR,TIdentifiers),
4306		get_texpr_ids(TIdentifiers,Ids),
4307		((get_identifiers(WAITIDEXPR,TWaitIds,[]), get_texpr_ids(TWaitIds,WaitIds),
4308		sort(WaitIds,SWIds),
4309		formatsilent('KODKOD_SOLVE Problem ~w (~w conjuncts), Identifiers: ~w, Waiting for ~w~n',[ID,Len,Ids,SWIds]),
4310		sort(Ids,SIds),
4311		ord_subtract(SIds,SWIds,IdsToSolve))
4312		-> b_optimize(Predicate,IdsToSolve,LocalState,State,CPredicate,WF), % inline known values
4313		(silent_mode(on) -> true ; print('compiled: '),translate:print_bexpr(CPredicate),nl,nl)
4314		; CPredicate=Predicate
4315		),
4316		(replace_by_kodkod(TIdentifiers,CPredicate,NewPredicate)
4317		-> (silent_mode(on) -> true ; print('AFTER KODKOD: '),translate:print_bexpr(NewPredicate),nl),
4318		b_interpreter:b_test_boolean_expression(NewPredicate,LocalState,State,WF)
4319		; print('KODKOD cannot be applied'),nl,
4320		b_interpreter:b_test_boolean_expression(CPredicate,LocalState,State,WF)
4321		),
4322		PredRes=pred_true.
4323
4324		must_get_identifiers(PP,TExpr,Res) :-
4325		(get_identifiers(TExpr,Ids,[]) -> Res=Ids
4326		; add_error(PP,'Could not get identifiers: ',TExpr),fail).
4327
4328		get_identifiers(b(couple(A1,A2),_,_)) --> !, get_identifiers(A1), get_identifiers(A2).
4329		get_identifiers(b(identifier(ID),T,I)) --> [b(identifier(ID),T,I)].
4330		get_identifiers(b(integer(_),_,_)) --> []. % to do: accept other ground values; in case they are compiled
4331		get_identifiers(b(value(_),_,_)) --> []. % identifier has already been compiled
4332		get_identifiers(b(string(_),_,_)) --> [].
4333
4334
4335		% -------------------
4336		do_not_evaluate_args('SATSOLVER').
4337		expects_unevaluated_args('SATSOLVER').
4338		expects_waitflag('SATSOLVER').
4339		expects_spaninfo('SATSOLVER').
4340		expects_state('SATSOLVER').
4341
4342		:- use_module(kernel_tools,[value_variables/2]).
4343		:- public 'SATSOLVER'/6.
4344		:- block 'SATSOLVER'(-,?,?,?,?,?).
4345		'SATSOLVER'(PredRes,LocalState,State,UnevaluatedArgs,Span,WF) :-
4346		UnevaluatedArgs = [TID,IDEXPR,WAITIDEXPR,UEA],
4347		get_integer(TID,ID),
4348		construct_predicate(UEA,KPredicate),
4349		(PredRes == pred_false -> create_negation(KPredicate,Predicate) ; Predicate=KPredicate),
4350		must_get_identifiers('SATSOLVER',IDEXPR,TIdentifiers),
4351		get_texpr_ids(TIdentifiers,Ids),
4352		% Note: the Ids are not really necessary here; they are just used for b_optimize; see SATSOLVER_SOLVE below
4353		b_interpreter:b_compute_expression(WAITIDEXPR,LocalState,State,WaitVal,WF),
4354		value_variables(WaitVal,WVars),
4355		when(ground(WVars),
4356		( %print(compile_for(ID,Ids)),nl,
4357		%nl,add_message(satsolver,'Optimzing for SATSOLVER_SOLVE: ',Predicate,Span), debug:nl_time,
4358		%translate:nested_print_bexpr(Predicate),nl,
4359		b_optimize(Predicate,Ids,LocalState,State,CPredicate,WF), % Ids are left in the closure
4360		(debug:debug_mode(off) -> true
4361		; add_message(satsolver,'Storing for SATSOLVER_SOLVE: ',CPredicate,Span)
4362		),
4363		kernel_waitflags:my_add_predicate_to_satsolver(WF,ID,CPredicate),
4364		% TO DO: retract upon backtracking + store negation if PredRes = pred_false
4365		PredRes=pred_true
4366		)).
4367
4368		expects_unevaluated_args('SATSOLVER_SOLVE').
4369		expects_waitflag('SATSOLVER_SOLVE').
4370		expects_state('SATSOLVER_SOLVE').
4371		:- public 'SATSOLVER_SOLVE'/8.
4372		:- block 'SATSOLVER_SOLVE'(-,?,?,?,?,?,?,?).
4373		'SATSOLVER_SOLVE'(int(ID),Ids,WaitIds,PredRes,LocalState,State,UEA,WF) :-
4374		value_variables(WaitIds,WVars),
4375		get_wait_flag1('SATSOLVER_SOLVE',WF,WF1),
4376		when(ground((WF1,WVars)),
4377		satsolver_solve_aux(ID,Ids,WaitIds,PredRes,LocalState,State,UEA,WF)).
4378		% Note: the Ids are not really necessary here; they are just used for b_optimize
4379		% The b_to_cnf conversion will look up all identifiers anyway, identifier or value(_) node makes no difference!
4380		% TODO: probably remove them
4381
4382		:- use_module(library(ordsets),[ord_subtract/3]).
4383		satsolver_solve_aux(ID,Ids,_WaitIds,PredRes,LocalState,State,UEA,WF) :-
4384		%print(trigger_SOLVE(_WaitIds)),nl,
4385		get_idle_wait_flag('SATSOLVER_SOLVE',WF,LWF), % give other co-routines chance to fire
4386		satsolver_solve_aux2(ID,Ids,PredRes,LocalState,State,UEA,WF,LWF).
4387
4388		:- use_module(extension('satsolver/b2sat'), [solve_predicate_with_satsolver/2]).
4389
4390		:- block satsolver_solve_aux2(?,?,?,?,?,?,?,-).
4391		satsolver_solve_aux2(ID,_,PredRes,LocalState,State,[_,IDEXPR,WAITIDEXPR],WF,_) :-
4392		print('SATSOLVER_SOLVE:'),nl,
4393		kernel_waitflags:my_get_satsolver_predicates(WF,ID,Ps),
4394		length(Ps,Len), format('Got ~w SATSOLVER predicates for ID: ~w~n',[Len,ID]),
4395		reverse(Ps,RPs), % we reverse Ps to put predicates in same order they were added, necessary??
4396		conjunct_predicates(RPs,Predicate),
4397		%translate:print_bexpr(Predicate),nl,
4398		must_get_identifiers('SATSOLVER_SOLVE',IDEXPR,TIdentifiers),
4399		get_texpr_ids(TIdentifiers,Ids),
4400		((get_identifiers(WAITIDEXPR,TWaitIds,[]), get_texpr_ids(TWaitIds,WaitIds),
4401		sort(WaitIds,SWIds),
4402		formatsilent('Sat Solver identifiers: ~w ; waiting for ~w~n',[Ids,SWIds]),
4403		sort(Ids,SIds),
4404		ord_subtract(SIds,SWIds,IdsToSolve))
4405		-> b_optimize(Predicate,IdsToSolve,LocalState,State,CPredicate,WF), % inline known values
4406		(debug_mode(off) -> true
4407		; print('compiled: '),translate:print_bexpr(CPredicate),nl,nl)
4408		; CPredicate=Predicate
4409		),
4410		(solve_predicate_with_satsolver(CPredicate,State)
4411		% if(b_interpreter:b_test_boolean_expression(CPredicate,[],State,WF),print(ok),
4412		% add_error_wf('SATSOLVER_SOLVE','SAT result not confirmed by ProB:',ID,CPredicate,WF))
4413		% TODO: catch errors if b_sat fails!
4414		%-> true
4415		% ; print('Calling SAT solver failed'),nl,
4416		% b_interpreter:b_test_boolean_expression(CPredicate,LocalState,State,WF)
4417		),
4418		PredRes=pred_true.
4419		% -------------------
4420
4421
4422		expects_waitflag('UNSAT_CORE'). % WF not used at the moment
4423		expects_spaninfo('UNSAT_CORE').
4424		:- public 'UNSAT_CORE'/5.
4425		% EXTERNAL_FUNCTION_UNSAT_CORE(T) == (POW(T)-->BOOL)*POW(T) --> POW(T);
4426		% UNSAT_CORE(Fun,Set) == Set
4427		% example: UNSAT_CORE(f,0..200) = {2} with f = %x.(x:POW(INTEGER)|bool(x /\ 1..2={}))
4428		'UNSAT_CORE'(FunToBool,Set,ValueRes,SpanInfo,WF) :-
4429		'UNSAT_CORE_ACC'(FunToBool,Set,[],ValueRes,SpanInfo,WF).
4430
4431
4432		expects_waitflag('UNSAT_CORE_ACC'). % WF not used at the moment
4433		expects_spaninfo('UNSAT_CORE_ACC').
4434		% EXTERNAL_FUNCTION_UNSAT_CORE_ACC(T) == (POW(T)-->BOOL)*POW(T)*POW(T) --> POW(T);
4435		% UNSAT_CORE_ACC(Fun,Set,Acc) == Set\/Acc;
4436		% example: UNSAT_CORE_ACC(f,0..200,{}) = {2} & f = %x.(x:POW(INTEGER)|bool(x /\ 1..2={}))
4437		% provides a way to initialise the accumulator of the unsat core computation
4438		'UNSAT_CORE_ACC'(FunToBool,Set,Acc,ValueRes,SpanInfo,WF) :-
4439		expand_custom_set_to_list_wf(Set,ESet,_,compute_apply_true,WF),
4440		expand_custom_set_to_list_wf(Acc,EAcc,_,compute_apply_true,WF),
4441		debug_println(9,computing_unsat_core(ESet,EAcc)),
4442		when(ground((FunToBool,ESet)), compute_unsat_core(ESet,FunToBool,no_time_out,EAcc,ValueRes,SpanInfo,WF)).
4443
4444		% EXTERNAL_FUNCTION_UNSAT_CORE_ACC_TIMEOUT(T) == (POW(T)-->BOOL)*POW(T)*POW(T)*INTEGER --> POW(T);
4445		% UNSAT_CORE_ACC_TIMEOUT(Fun,Set,Acc,TO) == Set\/Acc;
4446		% example: UNSAT_CORE_ACC_TIMEOUT(f,0..200,{},100) = {2} & f = %x.(x:POW(INTEGER)|bool(x /\ 1..2={}))
4447		expects_waitflag('UNSAT_CORE_ACC_TIMEOUT'). % WF not used at the moment
4448		expects_spaninfo('UNSAT_CORE_ACC_TIMEOUT').
4449		:- public 'UNSAT_CORE_ACC_TIMEOUT'/7.
4450		'UNSAT_CORE_ACC_TIMEOUT'(FunToBool,Set,Acc,int(TimeOut),ValueRes,SpanInfo,WF) :-
4451		expand_custom_set_to_list_wf(Set,ESet,_,compute_apply_true,WF),
4452		expand_custom_set_to_list_wf(Acc,EAcc,_,compute_apply_true,WF),
4453		debug_println(9,computing_unsat_core(ESet,EAcc)),
4454		when(ground((FunToBool,ESet,TimeOut)), compute_unsat_core(ESet,FunToBool,TimeOut,EAcc,ValueRes,SpanInfo,WF)).
4455
4456		compute_unsat_core([],_FunToBool,_TimeOut,Core,Result,_SpanInfo,WF) :- equal_object_wf(Result,Core,WF).
4457		compute_unsat_core([H|T],FunToBool,TimeOut,Core,Result,SpanInfo,WF) :-
4458		debug_println(9,trying_to_remove(H,core(Core))),
4459		append(Core,T,CoreT),
4460		if(compute_apply_true_timeout(TimeOut,FunToBool,CoreT,SpanInfo),
4461		compute_unsat_core(T,FunToBool,TimeOut,[H|Core],Result,SpanInfo,WF), % we found a solution, H is needed in core
4462		compute_unsat_core(T,FunToBool,TimeOut, Core, Result,SpanInfo,WF) % contradiction also exists without H
4463		).
4464
4465		:- use_module(library(timeout)).
4466		compute_apply_true_timeout(no_time_out,FunToBool,CoreT,SpanInfo) :- !,
4467		compute_apply_true(FunToBool,CoreT,SpanInfo).
4468		compute_apply_true_timeout(TO,FunToBool,CoreT,SpanInfo) :-
4469		time_out(compute_apply_true(FunToBool,CoreT,SpanInfo), TO, TORes),
4470		(TORes == success -> true ,format(user_output,'~nSUCCESS~n~n',[])
4471		; format(user_output,'~nTIME-OUT: ~w~n~n',[TORes]),fail). % treat time-out like failure
4472
4473		compute_apply_true(FunToBool,CoreT,SpanInfo) :-
4474		init_wait_flags_with_call_stack(WF1,[prob_command_context(compute_apply_true,unknown)]),
4475		bsets_clp:apply_to(FunToBool,CoreT,pred_true,SpanInfo,WF1), % TO DO: also pass function type
4476		ground_wait_flags(WF1).
4477
4478		expects_waitflag('MAX_SAT').
4479		expects_spaninfo('MAX_SAT').
4480		:- public 'MAX_SAT'/5.
4481		% EXTERNAL_FUNCTION_MAX_SAT(T) == (POW(T)-->BOOL)*POW(T) --> POW(T);
4482		% MAX_SAT(Fun,Set) == Set;
4483		% example: MAX_SAT(f,0..3) = {0,3} & f = %x.(x:POW(INTEGER)|bool(x /\ 1..2={}))
4484
4485		'MAX_SAT'(FunToBool,Set,ValueRes,SpanInfo,WF) :-
4486		expand_custom_set_to_list_wf(Set,ESet,_,compute_apply_true,WF),
4487		debug_println(9,computing_unsat_core(ESet)),
4488		when(ground((FunToBool,ESet)), compute_maxsat_ground(ESet,FunToBool,ValueRes,SpanInfo,WF)).
4489
4490		compute_maxsat_ground(ESet,FunToBool,ValueRes,SpanInfo,WF) :-
4491		debug_println(9,computing_maxsat(ESet)), %nl,reset_walltime,
4492		get_wait_flag(1,'MAX_SAT',WF,LWF), % avoid computing straightaway in case pending co-routines fail; not really sure it is needed
4493		when(nonvar(LWF),compute_maxsat(ESet,FunToBool,[],ValueRes,SpanInfo,WF)).
4494		compute_maxsat([],_FunToBool,Core,Result,_SpanInfo,_WF) :- equal_object(Result,Core).
4495		compute_maxsat([H|T],FunToBool,Core,Result,SpanInfo,WF) :-
4496		debug_println(9,trying_to_add(H,core(Core))),
4497		%nl,nl,nl,print(maxsat(H,Core)),nl, print_walltime(user_output),nl,
4498		if(compute_apply_true(FunToBool,[H|Core],SpanInfo),
4499		compute_maxsat(T,FunToBool,[H|Core],Result,SpanInfo,WF),
4500		compute_maxsat(T,FunToBool, Core, Result,SpanInfo,WF) % contradiction also exists without H
4501		).
4502
4503		% can be used to maximize a bounded integer expression
4504		% more limited than optimizing_solver (only optimizing integers), but using inlined branch and bound enumeration
4505		% example usage: xx:1..10 & res=10*xx-xx*xx & MAXIMIZE_EXPR(res)
4506		:- use_module(clpfd_interface,[clpfd_domain/3, clpfd_inrange/3, clpfd_size/2, clpfd_eq/2]).
4507		expects_waitflag('MAXIMIZE_EXPR').
4508		expects_spaninfo('MAXIMIZE_EXPR').
4509		:- public 'MAXIMIZE_EXPR'/4.
4510		'MAXIMIZE_EXPR'(int(X),PredRes,Span,WF) :-
4511		%get_wait_flag1('MAXIMIZE_EXPR',WF,LWF),
4512		get_wait_flag(2,'MAXIMIZE_EXPR',WF,LWF),
4513		PredRes=pred_true,
4514		maximize_expr_wf(LWF,X,Span,WF).
4515		:- block maximize_expr_wf(-,?,?,?).
4516		maximize_expr_wf(_LWF,X,Span,WF) :-
4517		clpfd_size(X,Size), Size \= sup,
4518		clpfd_domain(X,Min,Max),
4519		Mid is round((Min + Max)/2),
4520		!,
4521		maximize_expr_6(Min,Mid,Max,X,Span,WF).
4522		maximize_expr_wf(_,_,Span,_) :-
4523		add_error(external_functions,'MAXIMIZE_EXPR/MINIMIZE_EXPR called on unbounded expression',Span),
4524		fail.
4525		maximize_expr_6(M,M,M,X,Span,WF) :- !, X=M,
4526		add_message(external_functions,'Checking optimisation target for MAXIMIZE_EXPR/MINIMIZE_EXPR: ',X,Span),
4527		ground_wait_flags(WF). % NOTE: without fully grounding WF: we do not know if a solution has really been found !
4528		maximize_expr_6(Min,Mid,Max,X,Span,WF) :- % tools_printing:print_term_summary(maximize_expr_6(Min,Mid,Max,X)),nl,
4529		%add_message(external_functions,'Optimisation target for MAXIMIZE_EXPR/MINIMIZE_EXPR: ',Min:Max,Span),
4530		if( (clpfd_inrange(X,Mid,Max),
4531		NMid is round((Mid+Max)/2),
4532		maximize_expr_6(Mid,NMid,Max,X,Span,WF)),
4533		true, % we found a solution in the upper half
4534		(Mid>Min, M1 is Mid-1,
4535		clpfd_inrange(X,Min,M1),
4536		NMid is round((Min+M1)/2),
4537		maximize_expr_6(Min,NMid,M1,X,Span,WF)
4538		) ).
4539
4540		expects_waitflag('MINIMIZE_EXPR').
4541		expects_spaninfo('MINIMIZE_EXPR').
4542		:- public 'MINIMIZE_EXPR'/4.
4543		'MINIMIZE_EXPR'(int(X),PredRes,Span,WF) :-
4544		clpfd_eq(-X,MaxVar),
4545		'MAXIMIZE_EXPR'(int(MaxVar),PredRes,Span,WF).
4546
4547
4548		:- use_module(kernel_tools,[bexpr_variables/2]).
4549		% maximize is actually quite similar to CHOOSE; but it will choose maximum and use special algorithm for closures
4550		expects_waitflag('MAXIMIZE').
4551		expects_spaninfo('MAXIMIZE').
4552		:- public 'MAXIMIZE'/4.
4553		:- block 'MAXIMIZE'(-,?,?,?).
4554		'MAXIMIZE'([],_,Span,WF) :- !,
4555		add_wd_error_span('MAXIMIZE applied to empty set: ',[],Span,WF).
4556		'MAXIMIZE'(avl_set(A),H,_,_) :- !, avl_max(A,Max),kernel_objects:equal_object(H,Max).
4557		'MAXIMIZE'(closure(P,T,Body),FunValue,SpanInfo,WF) :- !,
4558		bexpr_variables(Body,ClosureWaitVars),
4559		debug_println(19,wait_maximize(P,ClosureWaitVars)),
4560		when(ground(ClosureWaitVars),maximize_closure(P,T,Body,FunValue,SpanInfo,WF)).
4561		'MAXIMIZE'([H|T],C,Span,WF) :- !,
4562		when(ground([H|T]),
4563		(convert_to_avl([H|T],AVL) -> 'MAXIMIZE'(AVL,C,Span,WF)
4564		; add_wd_error_span('Cannot determine maximum element for MAXIMIZE: ',[H|T],Span,WF),
4565		kernel_objects:equal_object_wf(C,H,WF))
4566		).
4567		'MAXIMIZE'(_,_,SpanInfo,_WF) :-
4568		add_error(external_functions,'MAXIMIZE requires set of values',SpanInfo),
4569		fail.
4570
4571		% move to optimizing solver
4572		% difference here is that entire constraint is re-set up every time; allowing Kodkod to be used
4573		maximize_closure(Parameters,ParameterTypes,ClosureBody,FunValue,_SpanInfo,WF) :-
4574		debug_println(maximizing(Parameters)),
4575		length(Parameters,Len), length(ParValues,Len),
4576		test_closure(Parameters,ParameterTypes,ClosureBody,ParValues),
4577		debug_println(19,found_initial_solution(ParValues)),
4578		!,
4579		maximize_closure2(Parameters,ParameterTypes,ClosureBody,ParValues,FunValue,WF).
4580		maximize_closure(_Parameters,_ParameterTypes,_ClosureBody,_FunValue,SpanInfo,_WF) :-
4581		add_error(external_functions,'MAXIMIZE: could not find solution for set comprehension',SpanInfo),
4582		fail.
4583
4584		maximize_closure2(Parameters,ParameterTypes,ClosureBody,PrevSol,FunValue,WF) :-
4585		Parameters=[PMax|_], ParameterTypes=[T1|_],
4586		PrevSol = [ PrevVal | _],
4587		debug_println(19,trying_to_improve_upon(PrevVal,PMax)),
4588		better_sol_pred(PMax,T1,PrevVal,Better),
4589		%translate:print_bexpr(Better),nl,
4590		bsyntaxtree:conjunct_predicates([Better,ClosureBody],NewBody),
4591		length(Parameters,Len), length(NewParValues,Len),
4592		test_closure(Parameters,ParameterTypes,NewBody,NewParValues),
4593		debug_println(19,found_better_solution(NewParValues)),
4594		!,
4595		maximize_closure2(Parameters,ParameterTypes,ClosureBody,NewParValues,FunValue,WF).
4596		maximize_closure2(_Parameters,_ParameterTypes,_ClosureBody,PrevSol,FunValue,WF) :-
4597		debug_println(19,cannot_improve),
4598		tools:convert_list_into_pairs(PrevSol,ParTuple),
4599		kernel_objects:equal_object_wf(ParTuple,FunValue,WF).
4600
4601		:- use_module(probsrc(solver_interface),[apply_kodkod_or_other_optimisations/4]).
4602		test_closure(Parameters,ParameterTypes,Body,ParValues) :-
4603		apply_kodkod_or_other_optimisations(Parameters,ParameterTypes,Body,Body2),
4604		custom_explicit_sets:b_test_closure(Parameters,ParameterTypes,Body2,ParValues,positive,no_wf_available). % positive instead of all_solutions
4605
4606		% generate predicate for better solution; % TO DO: support MINIMIZE by inverting args
4607		% TO DO: support more types: couples, booleans, ...
4608		better_sol_pred(PMax,integer,PrevVal,Better) :- !,
4609		Better = b(less(b(value(PrevVal),integer,[]),b(identifier(PMax),integer,[])),pred,[]).
4610		better_sol_pred(PMax,set(T1),PrevVal,Better) :- !,
4611		% WARNING: for sets we will only find one maximum, not all due to the cuts in maximize_closure(2) above
4612		Better = b(subset_strict(b(value(PrevVal),set(T1),[]),b(identifier(PMax),set(T1),[])),pred,[]).
4613		better_sol_pred(PMax,Type,_Val,_) :-
4614		add_error(external_functions,'MAXIMIZE requires first argument of set comprehension to be integer or set; cannot optimize: ',PMax:Type),fail.
4615
4616		% ----------------------------------
4617
4618		% EXTERNAL_FUNCTION_READ_XML == STRING --> seq(XML_ELement_Type);
4619		% with XML_ELement_Type == struct( recId: NATURAL1, pId:NATURAL, element:STRING, attributes: STRING +-> STRING, meta: STRING +-> STRING );
4620
4621		% XML_ELement_Type from LibraryXML.def:
4622		xml_element_type(record([ field(recId,integer), field(pId, integer), field(element,string),
4623		field(attributes, set(couple(string,string))),
4624		field(meta, set(couple(string,string))) ]) ).
4625
4626		performs_io('READ_XML').
4627		expects_spaninfo('READ_XML').
4628		:- public 'READ_XML'/3.
4629		:- block 'READ_XML'(-,?,?).
4630		'READ_XML'(string(File),Res,Span) :-
4631		read_xml(File,auto,Res,Span).
4632
4633		%expects_spaninfo('READ_XML'). both versions expect span info
4634		external_fun_type('READ_XML',[],[string,string,seq(XT)]) :- xml_element_type(XT).
4635		:- public 'READ_XML'/4.
4636		:- block 'READ_XML'(-,?,?,?),'READ_XML'(?,-,?,?).
4637		'READ_XML'(string(File),string(Encoding),Res,Span) :-
4638		read_xml(File,Encoding,Res,Span).
4639
4640
4641		:- use_module(tools, [read_string_from_file/3, detect_xml_encoding/3]).
4642		:- use_module(extrasrc(xml2b), [convert_xml_to_b/4]).
4643		:- use_module(preferences, [is_of_type/2]).
4644		:- block read_xml(-,?,?,?), read_xml(?,-,?,?).
4645		read_xml(File,EncodingPref,Res,Span) :-
4646		b_absolute_file_name(File,AFile,Span),
4647		(EncodingPref = 'auto',
4648		detect_xml_encoding(AFile,_Version,HeaderEncoding)
4649		-> (is_of_type(HeaderEncoding,text_encoding)
4650		-> Encoding=HeaderEncoding
4651		; add_warning(read_xml,'Illegal encoding in XML header (must be "UTF-8", "UTF-16", "ISO-8859-1",...): ',HeaderEncoding),
4652		Encoding=auto
4653		)
4654		; is_of_type(EncodingPref,text_encoding) -> Encoding = EncodingPref
4655		; add_error(read_xml,'Illegal encoding preference (must be "auto", "UTF-8", "UTF-16", "ISO-8859-1",...): ',EncodingPref),
4656		Encoding=auto
4657		),
4658		statistics(walltime,_),
4659		safe_call(read_string_from_file(AFile,Encoding,Codes),Span),
4660		statistics(walltime,[_,W1]), formatsilent('% Walltime ~w ms to read in ~w~n',[W1,AFile]),
4661		convert_xml_to_b(Codes,BDataSequence,File,Span),
4662		statistics(walltime,[_,W2]),
4663		formatsilent('% Walltime ~w ms to parse and convert XML in ~w~n',[W2,AFile]),
4664		kernel_objects:equal_object_optimized(Res,BDataSequence).
4665
4666
4667		external_fun_type('READ_XML_FROM_STRING',[],[string,seq(XT)]) :- xml_element_type(XT).
4668		expects_spaninfo('READ_XML_FROM_STRING').
4669		:- public 'READ_XML_FROM_STRING'/3.
4670		:- block 'READ_XML_FROM_STRING'(-,?,?).
4671		'READ_XML_FROM_STRING'(string(Contents),Res,Span) :-
4672		atom_codes(Contents,Codes),
4673		statistics(walltime,[W1,_]),
4674		convert_xml_to_b(Codes,BDataSequence,'string',Span),
4675		statistics(walltime,[W2,_]), W is W2-W1,
4676		formatsilent('% Walltime ~w ms to parse and convert XML~n',[W]),
4677		kernel_objects:equal_object_optimized(Res,BDataSequence).
4678
4679		:- use_module(extrasrc(json_parser),[json_parse_file/3,json_parse/3]).
4680		:- use_module(extrasrc(json_freetype),[json_parser_to_json_freetype/2]).
4681		performs_io('READ_JSON').
4682		external_fun_type('READ_JSON',[],[string,freetype('JsonValue')]).
4683		expects_spaninfo('READ_JSON').
4684		:- public 'READ_JSON'/3.
4685		:- block 'READ_JSON'(-,?,?).
4686		'READ_JSON'(string(File),Res,Span) :-
4687		read_json(File,Res,Span).
4688		:- block read_json(-,?,?).
4689		read_json(File,Res,Span) :-
4690		b_absolute_file_name(File,AFile,Span),
4691		statistics(walltime,_),
4692		safe_call(json_parse_file(AFile,Json,[]),Span),
4693		statistics(walltime,[_,W1]), formatsilent('% Walltime ~w ms to read and parse ~w~n',[W1,AFile]),
4694		json_parser_to_json_freetype(Json,JsonFreetype),
4695		statistics(walltime,[_,W2]),
4696		formatsilent('% Walltime ~w ms to convert JSON from ~w~n',[W2,AFile]),
4697		kernel_objects:equal_object_optimized(Res,JsonFreetype).
4698
4699		:- use_module(extrasrc(xml2b), [convert_json_to_b/3]).
4700		% reads in JSON file producing the same format as READ_XML
4701		performs_io('READ_JSON_AS_XML').
4702		external_fun_type('READ_JSON_AS_XML',[],[string,seq(XT)]) :- xml_element_type(XT).
4703		expects_spaninfo('READ_JSON_AS_XML').
4704		:- public 'READ_JSON_AS_XML'/3.
4705		:- block 'READ_JSON_AS_XML'(-,?,?).
4706		'READ_JSON_AS_XML'(string(File),Res,Span) :-
4707		read_json_as_xml(File,Res,Span).
4708		:- block read_json_as_xml(-,?,?).
4709		read_json_as_xml(File,Res,Span) :-
4710		statistics(walltime,_),
4711		b_absolute_file_name(File,AFile,Span),
4712		safe_call(json_parse_file(AFile,JSONList,[position_infos(true)]),Span),
4713		statistics(walltime,[_,W1]), formatsilent('% Walltime ~w ms to read and parse ~w~n',[W1,AFile]),
4714		convert_json_to_b(JSONList,BDataSequence,Span),
4715		statistics(walltime,[_,W2]),
4716		formatsilent('% Walltime ~w ms to convert JSON from ~w~n',[W2,AFile]),
4717		kernel_objects:equal_object_optimized(Res,BDataSequence).
4718
4719		external_fun_type('READ_JSON_FROM_STRING',[],[string,freetype('JsonValue')]).
4720		expects_spaninfo('READ_JSON_FROM_STRING').
4721		:- public 'READ_JSON_FROM_STRING'/3.
4722		:- block 'READ_JSON_FROM_STRING'(-,?,?).
4723		'READ_JSON_FROM_STRING'(string(Contents),Res,Span) :-
4724		read_json_from_string(Contents,Res,Span).
4725		:- block read_json_from_string(-,?,?).
4726		read_json_from_string(Contents,Res,Span) :-
4727		statistics(walltime,_),
4728		atom_codes(Contents,Codes),
4729		safe_call(json_parse(Codes,Json,[]),Span),
4730		statistics(walltime,[_,W1]), formatsilent('% Walltime ~w ms to parse string~n',[W1]),
4731		json_parser_to_json_freetype(Json,JsonFreetype),
4732		statistics(walltime,[_,W2]),
4733		formatsilent('% Walltime ~w ms to convert JSON~n',[W2]),
4734		kernel_objects:equal_object_optimized(Res,JsonFreetype).
4735
4736		external_fun_type('READ_JSON_FROM_STRING_AS_XML',[],[string,seq(XT)]) :- xml_element_type(XT).
4737		expects_spaninfo('READ_JSON_FROM_STRING_AS_XML').
4738		:- public 'READ_JSON_FROM_STRING_AS_XML'/3.
4739		:- block 'READ_JSON_FROM_STRING_AS_XML'(-,?,?).
4740		'READ_JSON_FROM_STRING_AS_XML'(string(Contents),Res,Span) :-
4741		read_json_from_string_as_xml(Contents,Res,Span).
4742		:- block read_json_from_string_as_xml(-,?,?).
4743		read_json_from_string_as_xml(Contents,Res,Span) :-
4744		atom_codes(Contents,Codes),
4745		statistics(walltime,_),
4746		safe_call(json_parse(Codes,JSONList,[position_infos(true)]),Span),
4747		statistics(walltime,[_,W1]), formatsilent('% Walltime ~w ms to parse string~n',[W1]),
4748		convert_json_to_b(JSONList,BDataSequence,Span),
4749		statistics(walltime,[_,W2]),
4750		formatsilent('% Walltime ~w ms to convert JSON~n',[W2]),
4751		kernel_objects:equal_object_optimized(Res,BDataSequence).
4752
4753		expects_spaninfo('WRITE_XML').
4754		external_fun_type('WRITE_XML',[],[seq(XT),string]) :- xml_element_type(XT).
4755		:- public 'WRITE_XML'/4.
4756		:- block 'WRITE_XML'(-,?,?,?),'WRITE_XML'(?,-,?,?).
4757		'WRITE_XML'(Records,string(File),Res,Span) :- write_xml2(Records,File,Res,Span).
4758		:- block write_xml2(?,-,?,?).
4759		write_xml2(Records,File,Res,Span) :-
4760		b_absolute_file_name(File,AFile,Span),
4761		statistics(walltime,_),
4762		'WRITE_XML_TO_STRING'(Records,String,Span),
4763		String = string(S),
4764		when(nonvar(S),
4765		(statistics(walltime,[_,W1]), formatsilent('% Walltime ~w ms to convert XML for ~w~n',[W1,AFile]),
4766		open(AFile,write,Stream,[encoding(utf8)]),
4767		write(Stream,S),nl(Stream),
4768		close(Stream),
4769		statistics(walltime,[_,W2]), formatsilent('% Walltime ~w ms to write XML to file ~w~n',[W2,AFile]),
4770		Res = pred_true
4771		)).
4772
4773
4774		%sequence of records of type:
4775		% rec(attributes:{("version"|->"03.04")},
4776		% element:"Data",
4777		% meta:{("xmlLineNumber"|->"2")},
4778		% pId:0,
4779		% recId:1),
4780		:- use_module(probsrc(xml_prob),[xml_parse/4, xml_pp/1]).
4781		expects_spaninfo('WRITE_XML_TO_STRING').
4782		:- public 'WRITE_XML_TO_STRING'/3.
4783		:- block 'WRITE_XML_TO_STRING'(-,?,?).
4784		'WRITE_XML_TO_STRING'(Records,Res,Span) :-
4785		custom_explicit_sets:expand_custom_set_to_list(Records,ESet,Done,'WRITE_XML_TO_STRING'),
4786		ground_value_check(ESet,Gr),
4787		when((nonvar(Done),nonvar(Gr)),
4788		( % print(expanded(ESet)),nl,
4789		gen_prolog_xml_term(ESet,Prolog,Span),
4790		%print(prolog(Prolog)),nl,
4791		xml_parse(Codes,Prolog,[],Span),
4792		(debug:debug_mode(on) -> xml_pp(Prolog) ; true),
4793		atom_codes(S,Codes),
4794		Res = string(S))).
4795
4796		:- use_module(extrasrc(json_parser),[json_write/3,json_write_file/3]).
4797		:- use_module(extrasrc(json_freetype),[json_freetype_to_json_parser/2]).
4798		expects_spaninfo('WRITE_JSON').
4799		external_fun_type('WRITE_JSON',[],[freetype('JsonValue'),string]).
4800		:- public 'WRITE_JSON'/4.
4801		:- block 'WRITE_JSON'(-,?,?,?),'WRITE_JSON'(?,-,?,?).
4802		'WRITE_JSON'(JsonFreetype,string(File),Res,Span) :-
4803		ground_value_check(JsonFreetype,GrJ),
4804		write_json(GrJ,JsonFreetype,File,Res,Span).
4805		:- block write_json(-,?,?,?,?),write_json(?,?,-,?,?).
4806		write_json(_,JsonFreetype,File,Res,Span) :-
4807		statistics(walltime,_),
4808		json_freetype_to_json_parser(JsonFreetype,Json),
4809		statistics(walltime,[_,W1]), formatsilent('% Walltime ~w ms to convert JSON to parser representation for ~w~n',[W1,AFile]),
4810		b_absolute_file_name(File,AFile,Span),
4811		safe_call(json_write_file(AFile,Json,[pretty(true)]),Span),
4812		statistics(walltime,[_,W2]), formatsilent('% Walltime ~w ms to write JSON for ~w~n',[W2,AFile]),
4813		Res = pred_true.
4814
4815		expects_spaninfo('WRITE_JSON_TO_STRING').
4816		external_fun_type('WRITE_JSON_TO_STRING',[],[freetype('JsonValue'),string]).
4817		:- public 'WRITE_JSON_TO_STRING'/3.
4818		'WRITE_JSON_TO_STRING'(JsonFreetype,Res,Span) :-
4819		ground_value_check(JsonFreetype,GrJ),
4820		write_json_to_string(GrJ,JsonFreetype,Res,Span).
4821		:- block write_json_to_string(-,?,?,?).
4822		write_json_to_string(_,JsonFreetype,Res,Span) :-
4823		statistics(walltime,_),
4824		json_freetype_to_json_parser(JsonFreetype,Json),
4825		statistics(walltime,[_,W1]), formatsilent('% Walltime ~w ms to convert JSON to parser representation~n',[W1]),
4826		safe_call(json_write(Json,Codes,[pretty(true)]),Span),
4827		atom_codes(S,Codes),
4828		statistics(walltime,[_,W2]), formatsilent('% Walltime ~w ms to write JSON to string~n',[W2]),
4829		Res = string(S).
4830
4831		gen_prolog_xml_term(List,xml( [version="1.0", encoding="ASCII"], ContentList),Span) :-
4832		InitialLineNr = 2, % first line is xml-header !?
4833		gen_prolog_xml_dcg(InitialLineNr,_,0,[],ContentList,Span,List,[]).
4834
4835		gen_prolog_xml_dcg(LastLineNr,FinalLineNr,CurLevel, Parents, ResContentList,Span) -->
4836		[(int(Index),rec(Fields))],
4837		{ %print(treat(Index,Fields)),nl,
4838		get_parentId(Fields,CurLevel,Span)}, % The element should be added to the current content list
4839		!,
4840		{get_element(Fields,Element,Span),
4841		get_attributes(Fields,Attributes,Span),
4842		get_line(Fields,LineNr,Span),
4843		gen_element(LastLineNr,LineNr,Element, Attributes, InnerContentList, ResContentList, TailContentList)
4844		},
4845		gen_prolog_xml_dcg(LineNr,LineNr2,Index,[CurLevel|Parents],InnerContentList,Span),
4846		gen_prolog_xml_dcg(LineNr2,FinalLineNr,CurLevel, Parents, TailContentList,Span).
4847		gen_prolog_xml_dcg(L,L,_,_,[],_Span) --> [].
4848
4849		gen_element(LastLineNr,NewLineNr,'CText',['='(text,Codes)],[], [PCDATA|Tail],Tail) :-
4850		insert_newlines(LastLineNr,NewLineNr,Codes,NLCodes),
4851		!,
4852		PCDATA=pcdata(NLCodes).
4853		gen_element(LastLineNr,NewLineNr,Element, Attributes, InnerContentList, [pcdata(NL),XELEMENT|Tail],Tail) :-
4854		LastLineNr < NewLineNr,
4855		insert_newlines(LastLineNr,NewLineNr,[],NL),
4856		!,
4857		XELEMENT = element( Element, Attributes, InnerContentList).
4858		gen_element(_,_,Element, Attributes, InnerContentList, [XELEMENT|Tail],Tail) :-
4859		XELEMENT = element( Element, Attributes, InnerContentList).
4860
4861		insert_newlines(LastLineNr,NewLineNr,C,R) :- NewLineNr =< LastLineNr,!,R=C.
4862		% TO DO: maybe we have to use 13 on Windows ??
4863		insert_newlines(LastLineNr,NewLineNr,C,[10|Res]) :- L1 is LastLineNr+1, insert_newlines(L1,NewLineNr,C,Res).
4864
4865		get_parentId(Fields,Nr,Span) :-
4866		(member(field(pId,int(ParentID)),Fields) -> Nr=ParentID
4867		; add_error('WRITE_XML_TO_STRING','The record has no pId field: ',Fields,Span),
4868		Nr = 0).
4869		get_element(Fields,Atom,Span) :-
4870		(member(field(element,string(Atom)),Fields) -> true
4871		; add_error('WRITE_XML_TO_STRING','The record has no element field: ',Fields,Span),
4872		Atom = '??').
4873
4874		get_attributes(Fields,Attrs,Span) :-
4875		(member(field(attributes,Set),Fields)
4876		-> custom_explicit_sets:expand_custom_set_to_list(Set,ESet,_Done,'get_attributes'),
4877		(maplist(get_xml_attr,ESet,Attrs) -> true
4878		; add_error('WRITE_XML_TO_STRING','Illegal attributes field: ',ESet,Span),
4879		Attrs = []
4880		)
4881		; add_error('WRITE_XML_TO_STRING','The record has no attributes field: ',Fields,Span),
4882		Attrs = []).
4883		get_line(Fields,LineNr,Span) :-
4884		(member(field(meta,Set),Fields)
4885		-> custom_explicit_sets:expand_custom_set_to_list(Set,ESet,_Done,'get_line'),
4886		(member((string(xmlLineNumber),string(LineNrS)),ESet)
4887		-> atom_codes(LineNrS,CC), number_codes(LineNr,CC)
4888		; add_error('WRITE_XML_TO_STRING','The meta field has no xmlLineNumber entry: ',ESet,Span),
4889		LineNr = -1
4890		)
4891		; add_error('WRITE_XML_TO_STRING','The record has no meta field: ',Fields,Span),
4892		LineNr = -1).
4893
4894		get_xml_attr((string(Attr),string(Val)),'='(Attr,ValCodes)) :- atom_codes(Val,ValCodes).
4895
4896
4897		% ----------------------------------
4898		% A flexible CVS Reader that always uses the same type
4899		% rec([field(attributes,BAttributes),field(lineNr,LineNr)])
4900
4901		% EXTERNAL_FUNCTION_READ_CSV_STRINGS == STRING --> seq(CSV_ELement_Type);
4902		% with CSV_ELement_Type == STRING +-> STRING ;
4903
4904		performs_io('READ_CSV_STRINGS').
4905		expects_spaninfo('READ_CSV_STRINGS').
4906		external_fun_type('READ_CSV_STRINGS',[],[string,seq(set(couple(string,string)))]).
4907		:- public 'READ_CSV_STRINGS'/3.
4908		:- block 'READ_CSV_STRINGS'(-,?,?).
4909		'READ_CSV_STRINGS'(string(File),Res,Span) :- read_csv_strings(File,Res,Span).
4910
4911		read_csv_strings(File,ResAVL,Span) :-
4912		b_absolute_file_name(File,AFile,Span),
4913		open_utf8_file_for_reading(AFile,Stream,Span),
4914		statistics(walltime,_),
4915		read_line(Stream,Line1),
4916		(Line1 = end_of_file -> ResAVL = []
4917		; split_csv_line([],HeadersCodes,Span,Line1,[]),
4918		maplist(process_header,HeadersCodes,Headers),
4919		formatsilent('CSV Line Headers = ~w for ~w~n',[Headers,AFile]),
4920		safe_call(read_csv_strings_lines(Stream,1,Span,Headers,Res),Span),
4921		statistics(walltime,[_,W1]), formatsilent('% Walltime ~w ms to read in ~w~n',[W1,AFile]),
4922		kernel_objects:equal_object_optimized(Res,ResAVL),
4923		statistics(walltime,[_,W2]), formatsilent('% Walltime ~w ms to normalise in ~w~n',[W2,AFile])
4924		),
4925		close(Stream). % TO DO: call_cleanup
4926
4927		process_header(HeaderC,HeaderAtom) :- safe_atom_codes(HeaderAtom,HeaderC).
4928
4929		read_csv_strings_lines(Stream,PrevLineNr,Span,Headers,Res) :-
4930		read_line(Stream,Line),
4931		(Line = end_of_file -> Res = []
4932		; LineNr is PrevLineNr+1,
4933		debug_format(9,'~nCSV line ~w: ~s~n',[LineNr,Line]),
4934		split_csv_line([],AtomsC,Span,Line,[]),
4935		Res = [(int(PrevLineNr),Attrs)|ResT],
4936		construct_attributes(AtomsC,Headers,Attrs,Span,LineNr,1),
4937		read_csv_strings_lines(Stream,LineNr,Span,Headers,ResT)
4938		).
4939
4940		construct_attributes([],_,[],_,_,_).
4941		construct_attributes([ [] | T],[ _|HT],Res,Span,LineNr,ColNr) :- !, % empty column
4942		C1 is ColNr+1,
4943		construct_attributes(T,HT,Res,Span,LineNr,C1).
4944		construct_attributes([ AtomC | T], [], Res,Span,LineNr,ColNr) :- !,
4945		safe_atom_codes(A,AtomC),
4946		length(AtomC,NrChars),
4947		ajoin(['Additional field with ',NrChars,' chars on line ',LineNr,' and column ',ColNr,': '],Msg),
4948		add_warning('READ_CSV_STRINGS',Msg,A,Span),
4949		Res=[(string('ExtraField'),string(A))|TR],
4950		C1 is ColNr+1,
4951		construct_attributes(T, [], TR,Span,LineNr,C1).
4952		construct_attributes([ AtomC | T], [ Header | HT],
4953		[ (string(Header),string(A)) | ResT],Span,LineNr,ColNr) :-
4954		safe_atom_codes(A,AtomC),
4955		%format('Col ~w: ~w~n',[ColNr,A]),flush_output,
4956		C1 is ColNr+1,
4957		construct_attributes(T,HT,ResT,Span,LineNr,C1).
4958
4959		% ----------------------------------
4960		% A CSV Reader that uses the B types to adapt how it reads in values
4961
4962		performs_io('READ_CSV').
4963		expects_spaninfo('READ_CSV').
4964		expects_type('READ_CSV').
4965
4966		:- public 'READ_CSV'/6.
4967		:- block 'READ_CSV'(-,?,?,?,?,?).
4968		'READ_CSV'(string(File),BoolSkipLine1,AllowExtraValues,Res,Type,Span) :-
4969		read_csv(File,BoolSkipLine1,AllowExtraValues,pred_false,Res,Type,Span).
4970
4971		external_fun_type('READ_CSV',[T],[string,T]).
4972		:- public 'READ_CSV'/4.
4973		:- block 'READ_CSV'(-,?,?,?).
4974		'READ_CSV'(string(File),Res,Type,Span) :-
4975		read_csv(File,pred_false,pred_false,pred_false,Res,Type,Span).
4976
4977		performs_io('READ_CSV_SEQUENCE').
4978		expects_spaninfo('READ_CSV_SEQUENCE').
4979		expects_type('READ_CSV_SEQUENCE').
4980		:- public 'READ_CSV_SEQUENCE'/6.
4981		:- block 'READ_CSV_SEQUENCE'(-,?,?,?,?,?).
4982		'READ_CSV_SEQUENCE'(string(File),BoolSkipLine1,AllowExtraValues,Res,Type,Span) :-
4983		read_csv(File,BoolSkipLine1,AllowExtraValues,pred_true,Res,Type,Span).
4984
4985		:- use_module(bsyntaxtree,[get_set_type/2]).
4986		:- block read_csv(-,?,?,?,?,?,?).
4987		read_csv(File,BoolSkipLine1,AllowExtraValues,CreateSequence,Res,InType,Span) :-
4988		(CreateSequence=pred_true
4989		-> (get_set_type(InType,couple(integer,T)) -> Type=set(T), SeqIndex=1
4990		; add_error('READ_CSV_SEQUENCE','Expecting sequence as return type:',InType),
4991		Type=InType, SeqIndex=none
4992		)
4993		; SeqIndex=none,Type=InType),
4994		get_column_types(Type,Types,Skel,Vars,Span),
4995		b_absolute_file_name(File,AFile,Span),
4996		open_utf8_file_for_reading(AFile,Stream,Span),
4997		(debug:debug_mode(off) -> true
4998		; formatsilent('~nReading CSV file ~w with Types = ~w and Skel = ~w for Vars = ~w~n~n',[AFile,Types,Skel,Vars])),
4999		(read_csv_lines(1,SeqIndex,BoolSkipLine1,AllowExtraValues,Stream,Types,Skel,Vars,Res,Span) -> true
5000		; add_error('READ_CSV','Reading CSV File failed: ',AFile)),
5001		close(Stream). % TO DO: call_cleanup
5002
5003		read_csv_lines(Nr,SeqIndex,BoolSkipLine1,AllowExtraValues,Stream,Types,Skel,Vars,Res,Span) :- %print(line(Nr,Types)),nl,
5004		read_line(Stream,Line),
5005		debug:debug_println(9,read_line(Nr,Line)),
5006		(Line = end_of_file -> Res = []
5007		; split_csv_line([],AtomsC,Span,Line,[]),
5008		%print(atoms(Nr,Atoms)),nl,
5009		%maplist(convert_atom_codes(Span),Types,Atoms,Tuple), % TO DO: check same length
5010		(Nr=1,BoolSkipLine1=pred_true
5011		-> maplist(codes_to_atom,AtomsC,Atoms), format('Skipping line 1: ~w~n',[Atoms]),
5012		Res=ResT
5013		; Line=[] -> format('Skipping empty line ~w~n',[Nr]), Res=ResT
5014		; l_convert_atom_codes(Types,AtomsC,Tuple,Span,Nr,AllowExtraValues),
5015		copy_term((Vars,Skel),(Tuple,BValue)),
5016		(number(SeqIndex) -> S1 is SeqIndex+1, Res = [(int(SeqIndex),BValue)|ResT]
5017		; S1 = SeqIndex, Res = [BValue|ResT]
5018		)
5019		),
5020		N1 is Nr+1,
5021		read_csv_lines(N1,S1,BoolSkipLine1,AllowExtraValues,Stream,Types,Skel,Vars,ResT,Span)).
5022
5023		codes_to_atom(C,A) :- atom_codes(A,C).
5024
5025		l_convert_atom_codes([],[],Vals,_Span,_LineNr,_) :- !, Vals=[].
5026		l_convert_atom_codes([Type|TT],[AtomC|TC],[Val|VT],Span,LineNr,AllowExtraValues) :- !,
5027		convert_atom_codes(Span,LineNr,Type,AtomC,Val),
5028		l_convert_atom_codes(TT,TC,VT,Span,LineNr,AllowExtraValues).
5029		l_convert_atom_codes([Type|TT],[],_,Span,LineNr,_) :- !,
5030		ajoin(['Missing value(s) on CSV line ',LineNr,' for types: '],Msg),
5031		add_error('READ_CSV',Msg,[Type|TT],Span),fail.
5032		l_convert_atom_codes([],[AtomC|AT],Vals,Span,LineNr,AllowExtraValues) :- !,
5033		(AllowExtraValues=pred_true -> true
5034		; safe_atom_codes(Atom,AtomC),
5035		ajoin(['Extra value(s) on CSV line ',LineNr,' : ',Atom,' Rest = '],Msg),
5036		add_error('READ_CSV',Msg,AT,Span)
5037		), Vals=[].
5038
5039		convert_atom_codes(Span,LineNr,T,AtomC,Val) :-
5040		(convert_atom2(T,AtomC,Val,Span,LineNr) -> true ;
5041		atom_codes(Atom,AtomC),
5042		ajoin(['Could not convert value to type ',T,' on CSV line ',LineNr,': '],Msg),
5043		add_error('READ_CSV',Msg,Atom,Span),
5044		Val = term('READ_CSV_ERROR')).
5045		:- use_module(tools,[safe_number_codes/2, safe_atom_codes/2]).
5046		convert_atom2(string,C,string(A),_,_) :- safe_atom_codes(A,C).
5047		convert_atom2(integer,C,int(Nr),_Span,LineNr) :-
5048		(C=[] -> (debug:debug_mode(off) -> true ; format('Translating empty string to -1 on line ~w~n',[LineNr])),
5049		% add_warning('READ_CSV','Translating empty string to -1 on line: ',LineNr,Span),
5050		Nr is -1
5051		; safe_number_codes(Nr,C)).
5052		convert_atom2(global(G),C,FD,Span,LineNr) :- safe_atom_codes(A,C),convert_to_enum(G,A,FD,Span,LineNr).
5053		convert_atom2(boolean,C,Bool,Span,LineNr) :- safe_atom_codes(A,C),
5054		(convert_to_bool(A,Bool) -> true
5055		; ajoin(['Could not convert value to BOOL on line ',LineNr,'; assuming FALSE: '],Msg),
5056		add_warning('READ_CSV',Msg,A,Span),
5057		Bool=pred_false).
5058		% TO DO: support set(_), seq(_)
5059
5060		convert_to_bool('0',pred_false).
5061		convert_to_bool('1',pred_true).
5062		convert_to_bool('FALSE',pred_false).
5063		convert_to_bool('TRUE',pred_true).
5064		convert_to_bool('false',pred_false).
5065		convert_to_bool('true',pred_true).
5066
5067		convert_to_enum(G,A,FD,Span,LineNr) :- string_to_enum2(A,FD,_,Span),
5068		(FD=fd(_,G) -> true ; add_error('READ_CSV','Enumerated element of incorrect type: ',A:expected(G):line(LineNr),Span)).
5069
5070		% split a CSV line into individual AtomCode lists
5071		split_csv_line([],T,Span) --> " ", !, split_csv_line([],T,Span).
5072		split_csv_line(Acc,[AtomC|T],Span) --> sep, !,
5073		{reverse(Acc,AtomC)}, split_csv_line([],T,Span).
5074		split_csv_line([],[String|T],Span) --> [34], !, % "
5075		scan_to_end_of_string([],String,Span),
5076		(sep -> split_csv_line([],T,Span)
5077		; [XX] -> {add_error('READ_CSV','String not followed by separator: ',String,Span)},
5078		split_csv_line([XX],T,Span)
5079		; {T=[]}).
5080		split_csv_line(Acc,Atoms,Span) --> [X], !, split_csv_line([X|Acc],Atoms,Span).
5081		split_csv_line(Acc,[AtomC],_Span) --> !, % end of line
5082		{reverse(Acc,AtomC)}.
5083
5084		sep --> " ",!, sep.
5085		sep --> ("," ; ";" ; " ,").
5086
5087		scan_to_end_of_string(Acc,AtomC,_) --> [34],!,{reverse(Acc,AtomC)}.
5088		scan_to_end_of_string(Acc,String,Span) --> [X],!, scan_to_end_of_string([X|Acc],String,Span).
5089		scan_to_end_of_string(Acc,String,Span) -->
5090		{reverse(Acc,RAcc),atom_codes(String,RAcc),add_error('READ_CSV','String not terminated: ',String,Span)}.
5091
5092		% get the list of column types along with Value skeleton with variables in the places where CSV values should be inserted
5093		get_column_types(set(X),Types,Skel,Vars,_) :- !,flatten_pairs(X,Types,[]), %print(types(Types)),nl,
5094		flatten_pairs_value_skeleton(X,Skel,Vars,[]). % print(skel(Skel,Vars)),nl.
5095		get_column_types(seq(X),Types,Skel,Vars,Span) :- !,
5096		get_column_types(set(couple(integer,X)),Types,Skel,Vars,Span).
5097		get_column_types(Type,_,_,_,Span) :- add_error('READ_CSV','Invalid return type (must be relation): ',Type,Span),fail.
5098
5099		% flatten couple pairs and generate skeleton term
5100		flatten_pairs(couple(A,B)) --> !,flatten_pairs(A), flatten_pairs(B).
5101		flatten_pairs(record(Fields)) --> !, flatten_fields(Fields).
5102		flatten_pairs(X) --> [X].
5103
5104		/* note: currently record fields have to be alphabetically in the same order as in CSV file: the fields are sorted by ProB's kernel ! : TO DO: try and recover the original order of the fields */
5105		flatten_fields([]) --> [].
5106		flatten_fields([field(_Name,Type)|T]) --> [Type], % no nesting allowed; this has to be a basic type for CSV reading to work
5107		flatten_fields(T).
5108
5109		% generate a value skeleton
5110		flatten_pairs_value_skeleton(couple(A,B),(CA,CB)) --> !,
5111		flatten_pairs_value_skeleton(A,CA), flatten_pairs_value_skeleton(B,CB).
5112		flatten_pairs_value_skeleton(record(Fields),rec(SF)) --> !, flatten_field_skel(Fields,SF).
5113		flatten_pairs_value_skeleton(_X,Var) --> [Var].
5114
5115		flatten_field_skel([],[]) --> [].
5116		flatten_field_skel([field(Name,_Type)|T],[field(Name,Var)|ST]) --> [Var],
5117		flatten_field_skel(T,ST).
5118
5119
5120		% ----------------------------------
5121		% Writing a matrix to a .pgm graphics file
5122		% The header of such a file looks like:
5123		% P5
5124		% 752 864 (width height)
5125		% 255 (maximal pixel value)
5126		% after that we have bytes of grayscale values
5127		% https://en.wikipedia.org/wiki/Netpbm#File_formats
5128
5129		% TODO: try and support colors (.ppm files)
5130		% improve performance; possibly avoiding to expand avl_sets
5131
5132		:- use_module(probsrc(tools_io),[read_byte_line/2, read_byte_word/2, put_bytes/2]).
5133
5134		:- public 'READ_PGM_IMAGE_FILE'/4.
5135		external_fun_type('READ_PGM_IMAGE_FILE',[],[string,seq(seq(integer))]).
5136		expects_waitflag('READ_PGM_IMAGE_FILE').
5137		expects_spaninfo('READ_PGM_IMAGE_FILE').
5138		:- block 'READ_PGM_IMAGE_FILE'(-,?,?,?).
5139		'READ_PGM_IMAGE_FILE'(string(FileName),Matrix,Span,WF) :-
5140		when(nonvar(FileName),
5141		(statistics(walltime,[_,_]),
5142		b_absolute_file_name(FileName,AFile,Span),
5143		open(AFile,read,Stream,[type(binary)]),
5144		call_cleanup(read_pgm_file(Stream,MatrixList,Span,WF), close(Stream)),
5145		statistics(walltime,[_,W2]),
5146		formatsilent('% Walltime ~w ms to read matrix from PGM file ~w~n',[W2,AFile]),
5147		kernel_objects:equal_object_optimized(Matrix,MatrixList)
5148		)).
5149
5150		read_pgm_file(Stream,Matrix,Span,_WF) :-
5151		read_byte_line(Stream,FileType),
5152		(FileType = "P5"
5153		-> read_byte_number(Stream,Width,Span),
5154		read_byte_number(Stream,Height,Span),
5155		read_byte_number(Stream,MaxPix,Span),
5156		formatsilent('% Detected PGM file width=~w, height=~w, max=~w~n',[Width,Height,MaxPix]),
5157		read_pgm_matrix(1,Height,Width,MaxPix,Stream,Matrix,Span)
5158		; atom_codes(FT,FileType),
5159		add_error('READ_PGM_IMAGE_FILE','Can only support P5 grayscale type:',FT,Span),fail
5160		).
5161
5162		% read pgm bytes and covert to B sequence of sequence of numbers
5163		read_pgm_matrix(Nr,Height,_,_,Stream,Res,Span) :- Nr > Height, !,
5164		get_byte(Stream,Code),
5165		(Code = -1 -> true
5166		; add_warning('READ_PGM_IMAGE_FILE','Bytes ignored after reading rows=',Height,Span)),
5167		Res=[].
5168		read_pgm_matrix(RowNr,Height,Width,MaxPix,Stream,[(int(RowNr),Row1)|ResT],Span) :-
5169		read_pgm_row(1,Width,MaxPix,Stream,Row1,Span),
5170		N1 is RowNr+1,
5171		read_pgm_matrix(N1,Height,Width,MaxPix,Stream,ResT,Span).
5172
5173		read_pgm_row(Nr,Width,_,_Stream,Res,_Span) :- Nr>Width, !, Res=[].
5174		read_pgm_row(ColNr,Width,MaxPix,Stream,[(int(ColNr),int(Code))|ResT],Span) :-
5175		(get_byte(Stream,Code), Code >= 0
5176		-> (Code =< MaxPix -> true
5177		; add_warning('READ_PGM_IMAGE_FILE','Grayscale pixel value exceeds maximum: ',Code,Span)
5178		)
5179		; add_error('READ_PGM_IMAGE_FILE','Unexpected EOF at column:',ColNr),
5180		fail
5181		),
5182		N1 is ColNr+1,
5183		read_pgm_row(N1,Width,MaxPix,Stream,ResT,Span).
5184
5185
5186		% read a word (until ws or eof) and convert it to a number
5187		read_byte_number(Stream,Nr,Span) :- read_byte_word(Stream,Codes),
5188		(safe_number_codes(Nr,Codes) -> true
5189		; add_error('READ_PGM_IMAGE_FILE','Expected number:',Codes,Span)
5190		).
5191
5192		:- public 'WRITE_PGM_IMAGE_FILE'/5.
5193		external_fun_type('WRITE_PGM_IMAGE_FILE',[],[string,seq(seq(integer),boolean)]).
5194		expects_waitflag('WRITE_PGM_IMAGE_FILE').
5195		expects_spaninfo('WRITE_PGM_IMAGE_FILE').
5196		:- block 'WRITE_PGM_IMAGE_FILE'(-,?,?,?,?), 'WRITE_PGM_IMAGE_FILE'(?,-,?,?,?).
5197		'WRITE_PGM_IMAGE_FILE'(string(FileName),Matrix,Res,Span,WF) :-
5198		custom_explicit_sets:expand_custom_set_to_list(Matrix,ESet,Done,'WRITE_PGM_IMAGE_FILE'),
5199		ground_value_check(ESet,Gr),
5200		when((nonvar(FileName),nonvar(Done),nonvar(Gr)),
5201		(statistics(walltime,[_,_]),
5202		b_absolute_file_name(FileName,AFile,Span),
5203		open(AFile,write,Stream,[type(binary)]),
5204		call_cleanup(put_pgm_file(Stream,ESet,Width,Height,WF),
5205		close(Stream)),
5206		statistics(walltime,[_,W2]),
5207		formatsilent('% Walltime ~w ms to write matrix to PGM file (width=~w, height=~w) ~w~n',[W2,Width,Height,AFile]),
5208		Res = pred_true
5209		)).
5210
5211		put_pgm_file(Stream,ESet,Width,Height,WF) :-
5212		ESet = [(int(_),Row)|_],
5213		bsets_clp:size_of_sequence(Row,int(Width),WF),
5214		put_bytes(Stream,"P5\n"),
5215		number_codes(Width,WC), put_bytes(Stream,WC),
5216		put_bytes(Stream," "),
5217		bsets_clp:size_of_sequence(ESet,int(Height),WF),
5218		number_codes(Height,HC), put_bytes(Stream,HC),
5219		put_bytes(Stream,"\n"),
5220		put_bytes(Stream,"255\n"),
5221		sort(ESet,SESet),
5222		put_pgm_matrix(Stream,Width,SESet).
5223
5224		% put a pgm grayscale matrix as bytes into a stream
5225		put_pgm_matrix(_,_,[]).
5226		put_pgm_matrix(Stream,Width,[(int(_),RowVector)|T]) :-
5227		custom_explicit_sets:expand_custom_set_to_list(RowVector,ESet,_,'WRITE_PGM_IMAGE_FILE'),
5228		sort(ESet,SESet),
5229		put_pgm_row(Stream,Width,SESet),
5230		put_pgm_matrix(Stream,Width,T).
5231
5232		put_zeros(_,X) :- X<1, !.
5233		put_zeros(Stream,X) :- put_byte(Stream,0), X1 is X-1, put_zeros(Stream,X1).
5234
5235		put_pgm_row(Stream,W,[]) :-
5236		(W=0 -> true
5237		; add_error('WRITE_PGM_IMAGE_FILE','Illegal PGM width in row: ',W),
5238		put_zeros(Stream,W)
5239		).
5240		put_pgm_row(Stream,W,[(_,int(Pixel))|T]) :-
5241		W1 is W-1,
5242		( W<1 -> add_error('WRITE_PGM_IMAGE_FILE','Additional PGM pixel in row: ',Pixel)
5243		; Pixel >=0, Pixel =< 255
5244		-> put_byte(Stream,Pixel),
5245		put_pgm_row(Stream,W1,T)
5246		; add_error('WRITE_PGM_IMAGE_FILE','Illegal PGM pixel (must be 0..255): ',Pixel),
5247		put_byte(Stream,0),
5248		put_pgm_row(Stream,W1,T)
5249		).
5250
5251		% -----------------
5252
5253		:- use_module(extrasrc(mcts_game_play), [mcts_auto_play/4, mcts_auto_play_available/0]).
5254		external_subst_enabling_condition('MCTS_AUTO_PLAY',_,Truth) :- create_texpr(truth,pred,[],Truth).
5255		external_function_requires_state('MCTS_AUTO_PLAY').
5256		:- public 'MCTS_AUTO_PLAY'/3.
5257		:- block 'MCTS_AUTO_PLAY'(-,?,?).
5258		'MCTS_AUTO_PLAY'(_,_Env,OutEnvModifications) :- % TO DO: pass simulation runs and time_out as parameter
5259		mcts_auto_play_available,!,
5260		get_current_state_id(CurID),
5261		mcts_auto_play(CurID,_ActionAsTerm,_TransID,State2),
5262		state_space:get_variables_state_for_id(State2,OutEnvModifications).
5263		'MCTS_AUTO_PLAY'(_,_,[]).
5264
5265		% EXTERNAL_SUBSTITUTION_MCTS_AUTO_PLAY == BOOL; MCTS_AUTO_PLAY(x) == skip;
5266
5267		% -----------------
5268
5269		:- use_module(extension('zmq_rpc/zmq_rpc'),
5270		[zmq_rpc_init/2, stream_socket_rpc_init/2,
5271		zmq_rpc_destroy/1, zmq_rpc_send/4,
5272		stream_socket_rpc_accept_request/3, stream_socket_rpc_send_answer/3]).
5273
5274		% connect to a JSON-RPC ZMQ socket
5275		performs_io('ZMQ_RPC_INIT').
5276		external_fun_type('ZMQ_RPC_INIT',[],[string,integer]).
5277		:- public 'ZMQ_RPC_INIT'/2.
5278		:- block 'ZMQ_RPC_INIT'(-,?).
5279		'ZMQ_RPC_INIT'(string(Endpoint), Res) :-
5280		when(nonvar(Endpoint), zmq_rpc_init(Endpoint, Res)).
5281
5282		% connect to a JSON-RPC regular socket using ndjson single-line messages
5283		performs_io('SOCKET_RPC_INIT').
5284		external_fun_type('SOCKET_RPC_INIT',[],[integer,integer]).
5285		:- public 'SOCKET_RPC_INIT'/2.
5286		:- block 'SOCKET_RPC_INIT'(-,?).
5287		'SOCKET_RPC_INIT'(int(Port), Res) :-
5288		when(nonvar(Port), stream_socket_rpc_init(Port, Res)).
5289
5290		performs_io('ZMQ_RPC_DESTROY').
5291		external_fun_type('ZMQ_RPC_DESTROY',[],[integer]).
5292		:- public 'ZMQ_RPC_DESTROY'/3.
5293		:- block 'ZMQ_RPC_DESTROY'(-,?,?).
5294		'ZMQ_RPC_DESTROY'(int(Socket), _EnvIn, EnvOut) :-
5295		when(nonvar(Socket),zmq_rpc_destroy(Socket)),
5296		EnvOut = [].
5297
5298		performs_io('ZMQ_RPC_SEND').
5299		expects_waitflag('ZMQ_RPC_SEND').
5300		external_fun_type('ZMQ_RPC_SEND',[],[integer,string,set(couple(string,freetype('JsonValue'))),freetype('RpcResult')]).
5301		:- public 'ZMQ_RPC_SEND'/5.
5302		:- block 'ZMQ_RPC_SEND'(-,?,?,?,?), 'ZMQ_RPC_SEND'(?,-,?,?,?), 'ZMQ_RPC_SEND'(?,?,-,?,?).
5303		'ZMQ_RPC_SEND'(int(Socket), string(Name), Args, Res,WF) :-
5304		expand_custom_set_to_list_wf(Args, ExpArgs, _Done, 'ZMQ_RPC_SEND',WF),
5305		ground_value_check(ExpArgs,Ground),
5306		block_zmq_rpc_send(Socket, Name, Ground, ExpArgs, Res).
5307
5308		:- block block_zmq_rpc_send(-,?,?,?,?), block_zmq_rpc_send(?,-,?,?,?),
5309		block_zmq_rpc_send(?,?,-,?,?).
5310		block_zmq_rpc_send(Socket, Name, _, ExpArgs, Res) :-
5311		zmq_rpc_send(Socket, Name, ExpArgs, Res).
5312
5313		performs_io('SOCKET_RPC_ACCEPT').
5314		external_fun_type('SOCKET_RPC_ACCEPT',[],[integer,freetype('JsonValue')]).
5315		:- public 'SOCKET_RPC_ACCEPT'/2.
5316		:- block 'SOCKET_RPC_ACCEPT'(-,?).
5317		'SOCKET_RPC_ACCEPT'(int(Port), Request) :-
5318		when(nonvar(Port),
5319		(stream_socket_rpc_accept_request(Port,_Id,FreeVal), % the Id is stored in zmq_rpc
5320		kernel_objects:equal_object_optimized(Request,FreeVal))).
5321
5322
5323		performs_io('SOCKET_RPC_REPLY').
5324		external_fun_type('SOCKET_RPC_REPLY',[],[integer,freetype('JsonValue')]).
5325		:- public 'SOCKET_RPC_REPLY'/3.
5326		:- block 'SOCKET_RPC_REPLY'(-,?,?),'SOCKET_RPC_REPLY'(?,-,?).
5327		'SOCKET_RPC_REPLY'(int(Port), FreeVal,Res) :-
5328		ground_value_check(FreeVal,Gr),
5329		when((nonvar(Port),nonvar(Gr)),
5330		(stream_socket_rpc_send_answer(Port,_Id,FreeVal), Res=pred_true)).