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