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