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