1		% (c) 2009-2025 Lehrstuhl fuer Softwaretechnik und Programmiersprachen,
2		% Heinrich Heine Universitaet Duesseldorf
3		% This software is licenced under EPL 1.0 (http://www.eclipse.org/org/documents/epl-v10.html)
4
5		:- module(tools_printing,[
6		print_term_summary/1, print_term_summary_hash/1,
7		print_term_summary_wo_nl/1,
8		print_value_summary/1,
9		print_functor/1,
10		print_var/1, print_vars/1,
11		watch/3,
12		trace_unify/2, trace_print/1, trace_print/2,
13		print_error/1,
14		print_message_on_stream/3,
15		format_error/2, format_error_with_nl/2,
16		no_color/0,
17		set_no_color/1, reset_no_color_to_default/0,
18		print_red/2, print_red/1, print_green/1,
19		format_with_colour/4, format_with_colour_nl/4,
20		start_terminal_colour/2,
21		reset_terminal_colour/1,
22		get_terminal_colour_code/2,
23		check_mark_symbol_codes/1, print_green_checkmark/1,
24		heavy_cross_symbol_codes/1, print_red_cross/1,
25		print_time_stamp/1,
26		print_dynamic_pred/3, print_dynamic_pred/4,
27		print_dynamic_fact/2,
28		print_goal/1,
29		nested_print_term/2, nested_print_term/1,
30		nested_write_term_to_codes/2,
31		tcltk_nested_read_prolog_file_as_codes/2,
32		write_canonical_to_codes/2,write_canonical_to_codes/3,
33		better_write_canonical_to_codes/2,better_write_canonical_to_codes/3
34		]).
35
36
37		:- use_module(module_information).
38		:- module_info(group,infrastructure).
39		:- module_info(description,'This module contains printing/debug helper predicates.').
40
41
42		:- use_module(library(terms),[term_hash/2]).
43		print_term_summary_hash(T) :- print_term_summary(T),
44		term_hash(T,H), %% (H=179896960 -> trace ; true), %%
45		format('Hash = ~w~n',H).
46
47		%:- use_module(library(terms),[term_size/2]).
48		print_term_summary(T) :- print_term_summary_wo_nl(T),
49		%term_size(T,Sz), format(' term_size: ~w',[Sz]),
50		nl.
51
52		% a special version for user friendly B Value information
53		print_value_summary(BValue) :- print_arg(BValue),nl.
54
55		print_term_summary_wo_nl(N) :- var(N),!,write('VARIABLE: '),write(N).
56		print_term_summary_wo_nl((A,B)) :- write('('), print_term_summary_wo_nl(A),
57		write(','), print_term_summary_wo_nl(B),write(')').
58		print_term_summary_wo_nl(clpfd:Call) :- !, write(clpfd:Call).
59		print_term_summary_wo_nl(Module:Call) :- !,
60		write(Module), write(':'),print_term_summary_wo_nl(Call).
61		print_term_summary_wo_nl(bind(Var,Val)) :- !,print_arg(bind(Var,Val)).
62		print_term_summary_wo_nl(N) :- functor(N,F,Arity), write(F), write('/'),write(Arity),
63		N=..[F|Args], l_print_arg(Args).
64
65		l_print_arg(V) :- var(V),!, write('...').
66		l_print_arg([]).
67		l_print_arg([H|T]) :- write(': '), print_arg(H), l_print_arg(T).
68
69		% print nested args: avoid nesting any further to avoid blowup
70		l_print_nested_arg(V) :- var(V),!, write('...').
71		l_print_nested_arg([]).
72		l_print_nested_arg([H|T]) :- write(': '), print_nested_arg(H), l_print_nested_arg(T).
73
74		print_nested_arg(N) :- var(N),!,print_var(N).
75		print_nested_arg([H|T]) :- list_skeleton_size([H|T],Sz,Type), !,
76		write(Type),
77		(Type=closed,ground([H|T]) -> write('&ground') ; true), write(' LIST.size='), write(Sz).
78		print_nested_arg(avl_set(A)) :- ground(A), avl_size(A,Sz),!, write('AVL.size='),write(Sz).
79		print_nested_arg(A) :- print_arg(A).
80
81		:- use_module(library(avl)).
82		% USE MODULE NOT PERFORMED TO AVOID LOADING translate and all dependent modules
83		%:- use_module(translate,[print_bexpr_with_limit/2, print_bstate/1]).
84
85		print_arg(N) :- var(N),!,print_var(N).
86		print_arg(int(N)) :- !, (var(N) -> print_var_integer(N) ; write(int(N))).
87		print_arg(term(F)) :- nonvar(F), F=floating(N),!, (var(N) -> write(F) ; write(N)).
88		print_arg(float(N)) :- !, write(float(N)).
89		print_arg(freeval(ID,Case,Value)) :- !, format('freeval ~w.~w : ',[ID,Case]), print_arg(Value).
90		print_arg(fd(N,GS)) :- !,
91		(number(N),b_global_sets:is_b_global_constant(GS,N,Res) -> write(Res)
92		; write('fd('),print_integer(N),format(',~w)',GS)).
93		print_arg(rec(Fields)) :- !, write('rec('), print_arg(Fields),write(')').
94		print_arg(bind(Var,Val)) :- atomic(Var), !, write(Var),write('/'),print_arg(Val).
95		print_arg(field(Var,Val)) :- atomic(Var), !, write('field('),write(Var),write('/'),print_arg(Val),write(')').
96		print_arg(typedvalc(Val,Type,VarID,EnumWarningInfos,Card)) :-
97		atomic(VarID), !, format('typedvalc for ~w :(',[VarID]),print_arg(Val),
98		format(',~w,~w,~w) ',[Type,EnumWarningInfos,Card]).
99		print_arg(wfx(WF0,_Store,WFE,_Infos)) :- !, write(wfx(WF0,'...',WFE,'...')). % do not print store and Infos: TODO we could show call_stack summary
100		print_arg(Module:Call) :- atomic(Module),!,
101		write(Module), write(':'),print_arg(Call).
102		print_arg(A) :- atomic(A),!, write(A).
103		print_arg(A) :- A=node(_,_,_,_,_),ground(A), !, write('AVLnode.size='),avl_size(A,Sz), write(Sz).
104		print_arg(avl_set(A)) :- ground(A), !,
105		(custom_explicit_sets:singleton_set(avl_set(A),El) -> write('AVL{'),print_arg(El),write('}')
106		; avl_size(A,Sz),
107		(Sz>3 -> write('AVL.size='),write(Sz)
108		; custom_explicit_sets:expand_custom_set_to_list(avl_set(A),ESet,_,print_arg),
109		write('AVL{'), l_print_nested_arg(ESet), write('}')
110		)
111		).
112		print_arg((A,B)) :- !, write('('),print_arg(A), write(','), print_arg(B), write(')').
113		print_arg(string(A)) :- !, write('string('),print_arg(A), write(')').
114		print_arg([]) :- !, write('[]').
115		print_arg([H|T]) :- T==[], !, write('['),print_arg(H),write(']').
116		print_arg([H|T]) :- nonvar(T),T=[H2|T2],T2==[], !,
117		write('['),print_arg(H),write(','),print_arg(H2),write(']').
118		print_arg([H|T]) :- nonvar(H), H=bind(_,_),!, get_list_up_to([H|T],10,S,ALL),
119		translate:print_bstate(S),
120		(ALL=all -> true ; write(', ... ')).
121		print_arg([H|T]) :- list_skeleton_size([H|T],Sz,Type), !,
122		write(Type),
123		(Type=closed,ground([H|T]) -> write('&ground') ; true),
124		write(' LIST.size='), write(Sz),
125		(Sz<35 -> write(' ['), l_print_nested_arg([H|T]), write(']') ; true).
126		print_arg(closure(P,T,B)) :- !,
127		(custom_explicit_sets:is_interval_closure(P,T,B,Low,Up)
128		-> write('SYMBOLIC-INTERVAL ['),
129		print_integer_with_var(Low), write('..'),
130		print_integer_with_var(Up), write(']')
131		; B=b(_,_,INFO),
132		findall(Ann,member(prob_annotation(Ann),INFO),Anns),
133		(closures:is_symbolic_closure(P,T,B) -> INF='ANNOTATED-'
134		; custom_explicit_sets:is_infinite_or_very_large_closure(P,T,B,200000) -> INF='INF_OR_LARGE-'
135		; INF=''),
136		format('SYMBOLIC-~wSET(~w) ~w ',[INF,Anns,P])
137		%terms:term_size(B,BSz), format('SYMBOLIC-~wSET(sz:~w,~w) ~w ',[INF,BSz,Anns,P])
138		). %, write(' | '), write(_B).
139		print_arg(mnf(Call)) :- !, write('mnf('),print_term_summary_wo_nl(Call), write(')').
140		print_arg(pp_mnf(Call)) :- !, write('mnf('),print_term_summary_wo_nl(Call), write(')').
141		print_arg(pp_cll(Call)) :- !, write('mnf('),print_term_summary_wo_nl(Call), write(')').
142		print_arg(b(Expr,T,I)) :- !,
143		(T==pred -> write('PRED(') ; write('BEXPR(')),
144		print_functor(Expr), write(','),
145		translate:print_bexpr_with_limit(b(Expr,T,I),200),
146		(error_manager:extract_line_col(b(Expr,T,I),Srow,Scol,_,_) -> format(', lne:col=~w:~w)',[Srow,Scol])
147		; write(')')).
148		print_arg(span_predicate(A,B,C)) :-
149		error_manager:extract_line_col(span_predicate(A,B,C),Srow,Scol,Erow,Ecol), !,
150		format('span_predicate(~w:~w-~w:~w)',[Srow,Scol,Erow,Ecol]).
151		print_arg(N) :- print_functor(N).
152
153		:- use_module(library(clpfd),[fd_dom/2, fd_degree/2, fd_size/2]).
154		print_var(V) :- fd_dom(V,D), D \= inf..sup, fd_size(V,Sz), fd_degree(V,Dg),!,
155		format('INT VAR: ~w:~w [sz:~w,dg:~w] ',[V,D,Sz,Dg]).
156		%write(':('),frozen(V,Goal),write_term(Goal,[max_depth(3)]),write(')').
157		print_var(V) :- write('VARIABLE: '),write(V), print_frozen_var_info(V).
158		print_var_integer(X) :- write('int(?:'),fd_dom(X,Dom),write(Dom),
159		%write(':('),frozen(X,Goal),write(Goal),write(')')
160		write(')').
161
162		% try determine variable type from frozen info
163	?	print_frozen_var_info(V) :- frozen(V,G), (print_frozen_var_info2(G,V) -> true ; true).
164		print_frozen_var_info2((A,B),V) :- !,(print_frozen_var_info2(A,V) -> true ; print_frozen_var_info2(B,V) -> true).
165		print_frozen_var_info2(true,_) :- !,fail.
166		print_frozen_var_info2(b_interpreter_check:imply_true(_,_,_),_) :- write(' : BOOL').
167		print_frozen_var_info2(bool_pred:blocking_force_eq(V,_,_),Var) :- Var==V, write(' : BOOL').
168		print_frozen_var_info2(kernel_equality:eq_empty_set(V,_),Var) :- Var==V, write(' : SET').
169		print_frozen_var_info2(kernel_equality:eq_empty_set_wf(V,_,_),Var) :- Var==V, write(' : SET').
170		print_frozen_var_info2(_:non_free(V),Var) :- Var==V, write(' : NON-FREE'). % kernel_objects
171		print_frozen_var_info2(_:ground_value_check(V,_),Var) :- Var==V, write(' : GRVAL-CHECK').
172		print_frozen_var_info2(_:Call,_Var) :- functor(Call,Functor,Arity),format(' : ~w/~w',[Functor,Arity]).
173		print_frozen_var_info2(Call,_Var) :- functor(Call,Functor,Arity),format(' : ~w/~w',[Functor,Arity]).
174		% TO DO: add other co-routines for boolean values,...
175
176		:- use_module(library(lists),[maplist/2]).
177		print_vars(V) :- maplist(tools_printing:print_var,V),nl.
178
179		print_integer(I) :- (var(I) -> fd_dom(I,Dom), write('?:'),write(Dom) ; write(I)).
180		print_integer_with_var(I) :- (var(I) -> print_var(I) ; write(I)).
181
182		get_list_up_to([],_,[],all).
183		get_list_up_to([H|T],N,R,ALL) :-
184		(N<1 -> R=[],ALL=no ; N1 is N-1, R=[H|TR], get_list_up_to(T,N1,TR,ALL)).
185
186		list_skeleton_size(X,Sz,Type) :- var(X),!,Sz=0,Type=open.
187		list_skeleton_size([],0,closed).
188		list_skeleton_size([_|T],N,Type) :- list_skeleton_size(T,NT,Type), N is NT+1.
189
190
191		print_functor(N) :- var(N),!,write('VARIABLE: '),write(N).
192		print_functor(N) :- functor(N,F,Arity), write(F), write('/'),write(Arity).
193
194		% ---------------
195
196		:- block watch(-,?,?).
197		watch([],N,Pos) :- !,print_data([],N,Pos).
198		watch([H|T],N,Pos) :- !,print_data(H,N,Pos), P1 is Pos+1, watch(H,N,Pos), watch(T,N,P1).
199		watch((P1,P2),N,Pos) :- print_data((P1,P2),N,Pos), watch(P2,N,Pos).
200		watch(Other,N,Pos) :- print_data(Other,N,Pos).
201		print_data(Data,N,Pos) :- write(N), write(' @ '), write(Pos),write(' : '), write(Data),nl.
202
203		% ---------------
204
205		:- use_module(library(lists),[maplist/3]).
206		trace_unify(A,B) :- trace_unify_aux(A,B,0).
207		trace_unify_aux(A,B,Lvl) :- (var(A);var(B)),!,indent(Lvl),write(A),write(' <-> '), write(B),
208		if(A=B,true,(write(' FAILS'),nl,fail)),nl.
209		trace_unify_aux(A,B,Lvl) :- functor(A,FA,FAN), functor(B,FB,FBN),
210		indent(Lvl),write(FA/FAN),
211		A=..[_|As], B=..[_|Bs],
212		((FA,FAN)=(FB,FBN)
213		-> (As=[] -> nl ; write('('),nl,l_trace_unify(As,Bs,Lvl))
214		; format(' FUNCTOR MISMATCH : ~w/~w <-> ~w/~w~n',[FA,FAN,FB,FBN]),
215		maplist(abstract_top_level,As,AAs), AA =..[FA|AAs],
216		maplist(abstract_top_level,Bs,ABs), AB =..[FB|ABs],
217		indent(Lvl),
218		format(' TOP: ~w <-> ~w~n',[AA,AB]),
219		fail
220		).
221		indent(0) :- !.
222		indent(X) :- X>800, !, write('*800*-'), X1 is X-800, indent(X1).
223		indent(X) :- X>80, !, write('*80*-'), X1 is X-80, indent(X1).
224		indent(X) :- X>0, write('+-'), X1 is X-1, indent(X1).
225
226		abstract_top_level(X,R) :- \+ compound(X),!,R=X.
227		abstract_top_level(X,AX) :- functor(X,F,N), functor(AX,F,N).
228
229
230		l_trace_unify([],[],L) :- indent(L), write(')'),nl.
231		l_trace_unify([A|TA],[B|TB],Lvl) :- L1 is Lvl+1, trace_unify_aux(A,B,L1),
232		l_trace_unify(TA,TB,Lvl).
233
234		% ---------------
235
236		trace_print(A) :- trace_print(A,0,4).
237		trace_print(A,Max) :- trace_print(A,0,Max).
238
239		trace_print(A,Lvl,MaxLvl) :- Lvl >= MaxLvl,!, indent(Lvl), print(A),nl.
240		trace_print(A,Lvl,_MaxLvl) :- treat_as_atomic(A),!, indent(Lvl), print(A),nl.
241		trace_print([H|T],Lvl,MaxLvl) :- !, indent(Lvl), print('['),nl,
242		l_trace_print([H|T],Lvl,MaxLvl),
243		indent(Lvl), print(']'),nl.
244		%trace_print(A,Lvl,_MaxLvl) :- functor(A,_,1), arg(1,A,AN), atomic(AN),!, indent(Lvl), print(A),nl.
245		trace_print(A,Lvl,_MaxLvl) :- A=..[_|Args], maplist(atomic,Args),!,
246		indent(Lvl), print(A),nl.
247		trace_print(A,Lvl,MaxLvl) :- functor(A,FA,FAN),
248		indent(Lvl),print(FA/FAN),print('('),nl,
249		A=..[_|As], l_trace_print(As,Lvl,MaxLvl).
250
251		:- use_module(tools_positions, [is_position/1]).
252		treat_as_atomic(A) :- var(A).
253		treat_as_atomic(A) :- atomic(A).
254		treat_as_atomic(nodeid(Pos)) :- is_position(Pos).
255		treat_as_atomic(sharing(_,_,_,_)).
256		treat_as_atomic(ID/V) :- treat_as_atomic(ID),treat_as_atomic(V).
257		treat_as_atomic([H|T]) :- T==[], treat_as_atomic(H).
258
259		l_trace_print([],L,_MaxLvl) :- indent(L), print(')'),nl.
260		l_trace_print([A|TA],Lvl,MaxLvl) :- L1 is Lvl+1, trace_print(A,L1,MaxLvl),
261		l_trace_print(TA,Lvl,MaxLvl).
262
263		% -----------------------------------
264
265		% print on error stream
266		print_error(Error) :-
267		stream_is_interactive(user_error),!,
268		start_terminal_colour([red,bold],user_error),
269		call_cleanup(print_no_col(user_error,Error),reset_terminal_colour_and_nl(user_error)).
270		%% flush_output(user_error), %%.
271		print_error(Error) :- print_no_col(user_error,Error), nl(user_error).
272
273		print_no_col(Stream,ErrorTerm) :-
274		write(Stream,'! '),
275		(var(ErrorTerm) -> write(Stream,'_')
276		; write_term(Stream,ErrorTerm,[max_depth(20),numbervars(true)])).
277
278		reset_terminal_colour_and_nl(Stream) :-
279		reset_terminal_colour(Stream),
280		nl(Stream). % for SICS prompt it is important to have nl after code to reset colour
281
282		print_message_on_stream(Stream,Color,Message) :-
283		stream_is_interactive(Stream),!,
284		start_terminal_colour(Color,Stream),
285		call_cleanup(print_no_col(Stream,Message),reset_terminal_colour_and_nl(Stream)).
286		print_message_on_stream(Stream,_Color,Message) :-
287		print_no_col(Stream,Message),
288		nl(Stream).
289
290		format_error_with_nl(Str,Args) :- format_with_colour_nl(user_error,[red,bold],Str,Args).
291		format_error(Str,Args) :- format_with_colour(user_error,[red,bold],Str,Args).
292
293		format_with_colour_nl(Stream,Colour,Str,Args) :-
294		format_with_colour(Stream,Colour,Str,Args),
295		nl(Stream). % followed by a newline *after* resetting the colours; important for SICStus prompt
296
297		format_with_colour(Stream,Colour,Str,Args) :-
298		stream_is_interactive(Stream),!,
299		start_terminal_colour(Colour,Stream),
300		call_cleanup(format(Stream,Str,Args),
301		reset_terminal_colour(Stream)).
302		format_with_colour(Stream,_Colour,Str,Args) :- format(Stream,Str,Args).
303
304		% we could provide a preference to override this; in case we do want to see the colour escape codes in a file
305		stream_is_interactive(S) :-
306		intelligent_get_stream(S,RealStream), stream_property(RealStream,interactive).
307
308		intelligent_get_stream(user_output,S) :- !, current_output(S).
309		intelligent_get_stream(user_intput,S) :- !, current_input(S).
310		intelligent_get_stream(user_error,S) :- !, prolog_flag(user_error,S).
311		intelligent_get_stream(S,S).
312
313		:- load_files(library(system), [when(compile_time), imports([environ/2])]).
314		:- if(environ(no_terminal_colors,true)).
315		no_color.
316		set_no_color(_).
317		reset_no_color_to_default.
318		print_red(X) :- write(X).
319		print_red(Stream,T) :- write(Stream,T).
320		print_green(X) :- write(X).
321		reset_terminal_colour(_).
322		start_terminal_colour(_,_).
323		:- else.
324		:- use_module(library(system),[environ/2]).
325		:- dynamic colours_disabled/0.
326		no_color :- colours_disabled.
327		set_no_color(false) :- retractall(colours_disabled).
328		set_no_color(true) :- % useful e.g. for --no-color cli flag
329		(colours_disabled -> true ; assertz(colours_disabled)).
330		reset_no_color_to_default :-
331		(no_col_env -> set_no_color(true) ; retractall(colours_disabled)).
332		%TODO: we could try and detect Windows 8 or earlier where no terminal colours are supported
333		no_col_env :- environ('NO_COLOR',_),!. % see http://no-color.org
334		no_col_env :- environ('NOCOLOR',_),!.
335		no_col_env :- environ('CLICOLOR',V), (V=0 ; V='NO' ; V='FALSE'),!.
336		no_col_env :- environ('TERM',dumb).
337		% | ?- environ('TERM',X).
338		% X = 'xterm-256color'
339
340		print_red(Stream,Term) :- no_color,!,
341		format(Stream,'~w',[Term]).
342		print_red(Stream,Term) :-
343		format(Stream,'\e[31m~w\e[0m',[Term]).
344
345		print_red(Term) :- no_color,!,
346		format('~w',[Term]).
347		print_red(Term) :-
348		format('\e[31m~w\e[0m',[Term]).
349
350		print_green(Term) :- no_color,!,
351		format('~w',[Term]).
352		print_green(Term) :-
353		format('\e[32m~w\e[0m',[Term]).
354
355		reset_terminal_colour(_) :- no_color,!.
356		reset_terminal_colour(Stream) :- write(Stream,'\e[0m').
357
358		% see https://misc.flogisoft.com/bash/tip_colors_and_formatting
359		start_terminal_colour(_,_) :- no_color,!.
360		start_terminal_colour(black,Stream) :- !, write(Stream,'\e[30m').
361		start_terminal_colour(red,Stream) :- !, write(Stream,'\e[31m').
362		start_terminal_colour(green,Stream) :- !, write(Stream,'\e[32m').
363		start_terminal_colour(yellow,Stream) :- !, write(Stream,'\e[33m').
364		start_terminal_colour(blue,Stream) :- !, write(Stream,'\e[34m').
365		start_terminal_colour(magenta,Stream) :- !, write(Stream,'\e[35m').
366		start_terminal_colour(cyan,Stream) :- !, write(Stream,'\e[36m').
367		start_terminal_colour(light_gray,Stream) :- !, write(Stream,'\e[37m').
368		start_terminal_colour(dark_gray,Stream) :- !, write(Stream,'\e[90m').
369		start_terminal_colour(light_red,Stream) :- !, write(Stream,'\e[91m').
370		start_terminal_colour(light_green,Stream) :- !, write(Stream,'\e[92m').
371		start_terminal_colour(white,Stream) :- !, write(Stream,'\e[97m').
372		start_terminal_colour(bold,Stream) :- !, write(Stream,'\e[1m').
373		start_terminal_colour(underline,Stream) :- !, write(Stream,'\e[4m').
374		start_terminal_colour(dim,Stream) :- !, write(Stream,'\e[2m').
375		start_terminal_colour(black_background,Stream) :- !, write(Stream,'\e[49m').
376		start_terminal_colour(red_background,Stream) :- !, write(Stream,'\e[41m').
377		start_terminal_colour(green_background,Stream) :- !, write(Stream,'\e[42m').
378		start_terminal_colour(yellow_background,Stream) :- !, write(Stream,'\e[43m').
379		start_terminal_colour(white_background,Stream) :- !, write(Stream,'\e[107m').
380		start_terminal_colour(blink,Stream) :- !, write(Stream,'\e[5m').
381		start_terminal_colour(reverse,Stream) :- !, write(Stream,'\e[7m'). % reversed
382		start_terminal_colour(hidden,Stream) :- !, write(Stream,'\e[8m').
383		start_terminal_colour(reset,Stream) :- !, write(Stream,'\e[0m').
384		% cursor nagivation:
385		start_terminal_colour(go_left,Stream) :- !, write(Stream,'\e[1000Dm'). % go to left of terminal
386		start_terminal_colour(go_up(Nr),Stream) :- number(Nr),!, format(Stream,'\e[~wA',[Nr]).
387		start_terminal_colour(go_down(Nr),Stream) :- number(Nr),!, format(Stream,'\e[~wB',[Nr]).
388		start_terminal_colour(go_right(Nr),Stream) :- number(Nr),!, format(Stream,'\e[~wC',[Nr]).
389		start_terminal_colour(go_left(Nr),Stream) :- number(Nr),!, format(Stream,'\e[~wD',[Nr]).
390		start_terminal_colour(clear_screen,Stream) :- write(Stream,'\e[2J').
391		start_terminal_colour(clear_screen_to_start,Stream) :- write(Stream,'\e[1J').
392		start_terminal_colour(clear_screen_to_end,Stream) :- write(Stream,'\e[0J').
393		start_terminal_colour(clear_line,Stream) :- write(Stream,'\e[2K').
394		start_terminal_colour(clear_line_to_start,Stream) :- write(Stream,'\e[1K').
395		start_terminal_colour(clear_line_to_end,Stream) :- write(Stream,'\e[0K').
396		start_terminal_colour(set_column(Nr),Stream) :- number(Nr),!, format(Stream,'\e[~wG',[Nr]).
397		start_terminal_colour(set_position(Row,Col),Stream) :- number(Row), number(Col),!,
398		format(Stream,'\e[~w;~wHm',[Row,Col]).
399		start_terminal_colour(next_line(Nr),Stream) :- number(Nr),!, format(Stream,'\e[~wE',[Nr]).
400		start_terminal_colour(prev_line(Nr),Stream) :- number(Nr),!, format(Stream,'\e[~wF',[Nr]).
401		start_terminal_colour(save_position,Stream) :- !, write(Stream,'\e[s').
402		start_terminal_colour(restore_position,Stream) :- !, write(Stream,'\e[u').
403		% more colors, not supported by all terminals:
404		start_terminal_colour(bright_red,Stream) :- !, write(Stream,'\e[31;1m'). % also 91m ?
405		start_terminal_colour(bright_green,Stream) :- !, write(Stream,'\e[32;1m').
406		start_terminal_colour(orange,Stream) :- !, write(Stream,'\e[38;5;202m').
407		start_terminal_colour(gray,Stream) :- !, write(Stream,'\e[38;5;241m').
408		start_terminal_colour(grey,Stream) :- !, write(Stream,'\e[38;5;241m').
409		start_terminal_colour(dark_red,Stream) :- !, write(Stream,'\e[38;5;52m').
410		start_terminal_colour(col256(Nr),Stream) :- number(Nr), Nr>=0, Nr=<255,!, format(Stream,'\e[38;5;~wm',[Nr]).
411		start_terminal_colour([],_Stream) :- !.
412		start_terminal_colour([H|T],Stream) :- !, start_terminal_colour(H,Stream),start_terminal_colour(T,Stream).
413		start_terminal_colour(C,_Stream) :- format(user_error,'*** UNKNOWN COLOUR: ~w~n',[C]).
414		:- endif.
415
416		get_terminal_colour_code(black,'\e[30m').
417		get_terminal_colour_code(red,'\e[31m').
418		get_terminal_colour_code(green,'\e[32m').
419		get_terminal_colour_code(yellow,'\e[33m').
420		get_terminal_colour_code(blue,'\e[34m').
421		get_terminal_colour_code(magenta,'\e[35m').
422		get_terminal_colour_code(cyan,'\e[36m').
423		get_terminal_colour_code(light_gray,'\e[37m').
424		get_terminal_colour_code(reset,'\e[0m').
425		get_terminal_colour_code(light_red,'\e[91m').
426		get_terminal_colour_code(light_green,'\e[92m').
427		get_terminal_colour_code(light_yellow,'\e[93m').
428		get_terminal_colour_code(light_blue,'\e[94m').
429		get_terminal_colour_code(light_magenta,'\e[95m').
430		get_terminal_colour_code(light_cyan,'\e[96m').
431		get_terminal_colour_code(white,'\e[97m').
432		% TODO: extend and use above
433
434		% To print out colors: between:between(0,255,Nr),format(user_output,'\e[38;5;~wm Number=~w~n',[Nr,Nr]),fail.
435		% See: https://www.lihaoyi.com/post/BuildyourownCommandLinewithANSIescapecodes.html
436
437		% creates a Unicode checkmark symbol (also used by homebrew)
438		check_mark_symbol(Atom) :- atom_codes(Atom,[10004,65038] ).
439		check_mark_symbol_codes( [10004,65038] ).
440		heavy_cross_symbol_codes( [10006,65038] ).
441
442		print_green_checkmark(Stream) :- no_color,!,
443		format(Stream,'~s',[ [10004,65038] ]).
444		print_green_checkmark(Stream) :-
445		format(Stream,'\e[32m~s\e[0m',[ [10004,65038] ]).
446
447		print_red_cross(Stream) :- no_color,!,
448		format(Stream,'~s',[ [10006,65038] ]).
449		print_red_cross(Stream) :-
450		format(Stream,'\e[31m~s\e[0m',[ [10006,65038] ]).
451
452		% -----------------------------------
453
454		:- use_module(library(system),[datime/1]).
455
456		print_time_stamp(Stream) :-
457		datime(datime(Year,Month,Day,Hour,Min,Sec)),
458		(Min<10
459		-> format(Stream,'~w/~w/~w - ~wh0~w ~ws',[Day,Month,Year,Hour,Min,Sec])
460		; format(Stream,'~w/~w/~w - ~wh~w ~ws',[Day,Month,Year,Hour,Min,Sec])
461		).
462
463		% -----------------------------------
464		print_dynamic_pred(InModule,Pred,N) :- print_dynamic_pred(user_output,InModule,Pred,N).
465
466		print_dynamic_pred(Stream,InModule,Pred,N) :- nl(Stream),
467		format(Stream,':- dynamic ~w/~w.~n',[Pred,N]),
468		functor(Call,Pred,N),
469	?	call(InModule:Call),
470		write_term(Stream,Call,[quoted(true)]),write(Stream,'.'),nl(Stream),fail.
471		print_dynamic_pred(Stream,InModule,Pred,N) :-
472		functor(Call,Pred,N),
473	?	(call(InModule:Call) -> true
474		; write_with_numbervars(Stream,Call), write(Stream,' :- fail.'),nl(Stream)),
475		nl(Stream).
476
477		write_with_numbervars(Stream,Term) :- copy_term(Term,T), numbervars(T,0,_),
478		write_term(Stream,T,[quoted(true),numbervars(true)]).
479
480		print_dynamic_fact(Stream,Fact) :-
481		functor(Fact,Pred,N),
482		format(Stream,':- dynamic ~w/~w.~n',[Pred,N]),
483		write_term(Stream,Fact,[quoted(true)]),write(Stream,'.'),nl(Stream).
484
485		% -----------------------------------
486
487		% typically used for printing call residues:
488		print_goal(V) :- var(V),!, format(' ~p~n',[V]).
489		print_goal([A|B]) :- !,print_goal(A), print_goal(B).
490		print_goal((A,B)) :- !,print_goal(A), print_goal(B).
491		print_goal(Module:(A,B)) :- !, format(' ~p:~n',[Module]), print_goal((A,B)).
492		print_goal(when(C,G)) :- !, write(' when('),
493		write_term(C,[max_depth(6)]), write(','),
494		write_term(G,[max_depth(5)]), write(')'),nl.
495		print_goal(A) :- write(' '), write_term(A,[max_depth(5)]), nl. % avoid printing huge terms
496		%print_goal(A) :- format(' ~p~n',[A]).
497
498
499		% -----------------------------------
500
501		% possible applicaton: inspect size of terms transmitted to ProB2:
502		% prob2_interface:get_machine_formulas(Formulas), tell('formulasnest.pl'), nested_print_term(Formulas,6),told.
503
504		nested_print_term(Term) :- nested_print_term(Term,10).
505		nested_print_term(Term,MaxNest) :- nested_print_term(0,MaxNest,Term).
506
507		indentws(0) :- !.
508		indentws(X) :- X>0, write(' '), X1 is X-1, indentws(X1).
509
510		:- use_module(library(terms),[term_size/2]).
511		nested_print_term(CurNesting,_Max,T) :- var(T),!, indent(CurNesting),write(T),nl.
512		nested_print_term(CurNesting,_,T) :- atom(T), !, atom_length(T,Len),
513		indent(CurNesting),
514		(Len > 100
515		-> atom_codes(T,Codes), length(Prefix,50), append(Prefix,_,Codes),
516		format('atom: len(~w): ~s...~n',[Len,Prefix])
517		; format('~w~n',[T])).
518		nested_print_term(CurNesting,_,T) :- number(T),!, indent(CurNesting), format('~w~n',[T]).
519		nested_print_term(CurNesting,MaxNesting,T) :- CurNesting >= MaxNesting,!,
520		term_size(T,Sz), functor(T,F,N),
521		indentws(CurNesting),
522		(Sz>25000 -> Msg='****' ; Msg=''), format('~w/~w :: sz(~w)~w~n',[F,N,Sz,Msg]).
523		nested_print_term(CurNesting,MaxNesting,T) :-
524		list_skeleton_size(T,Len,closed), term_size(T,Sz),!,
525		indentws(CurNesting),format('[ list_len_sz(~w,~w)~n',[Len,Sz]),
526		C1 is CurNesting+1,
527		maplist(nested_print_term(C1,MaxNesting),T),
528		indentws(CurNesting),format('] list_len(~w)~n',[Len]).
529		nested_print_term(CurNesting,MaxNesting,T) :-
530		term_size(T,Sz), functor(T,F,N),
531		indentws(CurNesting),format('~w/~w( sz(~w)~n',[F,N,Sz]),
532		T =.. [_|Args], C1 is CurNesting+1,
533		maplist(nested_print_term(C1,MaxNesting),Args),
534		indentws(CurNesting),format('~w/~w)~n',[F,N]).
535
536
537		% a version of write_term_to_codes that nests the Prolog term
538		nested_write_term_to_codes(Term,Codes) :-
539		nested_write(Term,0,Codes,[]).
540
541		:- use_module(library(codesio)).
542		% Note: write_term_to_codes(+Term, -Codes, +Options) with option indented(true) only indents clauses
543
544		nested_write(Atom,Level) --> {simple(Atom)},!, indent(Level), format_to_codes('~q',[Atom]).
545		nested_write(Term,Level) --> {Level>40},!, indent(Level), format_to_codes('~q',[Term]).
546		nested_write([H|T],Level) --> !,
547		indent(Level), "[\n",
548		{L1 is Level+1},
549		l_nested_write([H|T],L1),
550		indent(Level), "]".
551		nested_write(Compound,Level) --> {decompose_compound(Compound,F,Args)},
552		indent(Level),
553		({maplist(simple,Args)}
554		-> format_to_codes('~q',[Compound])
555		; write_to_codes(F), "(\n",
556		{L1 is Level+1},
557		l_nested_write(Args,L1),
558		indent(Level), ")"
559		).
560
561		decompose_compound(Module:Compound,Functor,Args) :- nonvar(Compound), !,
562		Compound =.. [F|Args], Functor = Module:F.
563		decompose_compound(Compound,F,Args) :- Compound =.. [F|Args].
564
565		indent(0) --> !, "".
566		indent(L) --> {L>0, L1 is L-1}, " ", indent(L1).
567
568		l_nested_write([],_) --> "".
569		l_nested_write([H],Level) --> !,
570		nested_write(H,Level), "\n".
571		l_nested_write([H|T],Level) -->
572		nested_write(H,Level), ",\n",
573		l_nested_write(T,Level).
574
575		% use_module(probsrc(tools_printing)), nested_write_term_to_codes(f(a,[0,s(X)]),C), format('~s~n',[C]).
576
577		tcltk_nested_read_prolog_file_as_codes(File,list(Codes)) :-
578		open(File, read, Stream, [encoding(utf8)]),
579		call_cleanup(nested_read_terms(Stream, Codes, []), close(Stream)).
580
581		nested_read_terms(Stream) --> {safe_read_stream(Stream,Term)},
582		({Term=end_of_file} -> "\n"
583		; nested_write(Term,0), ".\n",
584		nested_read_terms(Stream)
585		).
586
587		safe_read_stream(Stream,T) :-
588		catch(read(Stream,T), E, (
589		error_manager:add_error(nested_read_prolog_file_as_codes,'Exception reading term from file:',E),
590		T=end_of_file)).
591
592		% write_canonical that generates a code list
593		%% write_canonical_to_codes(+Term, -Codes)
594		write_canonical_to_codes(Term, Codes) :- write_canonical_to_codes(Term, Codes, []).
595
596		write_canonical_to_codes(Term, Codes, CodesOut) :-
597		write_term_to_codes(Term,Codes,CodesOut,[quoted(true),ignore_ops(true),quoted_charset(portable)]).
598
599
600		% A variant of write_canonical_to_codes that writes lists with square-brackets.
601		%% write_canonical_to_codes(+Term, -Codes)
602		better_write_canonical_to_codes(Term, Codes) :- better_write_canonical_to_codes(Term, Codes, []).
603
604		better_write_canonical_to_codes(Term, Codes, CodesOut) :-
605		proper_list(Term),
606		!,
607		Codes = [0'[ | C1],
608		better_write_canonical_to_codes_list(Term, C1, [0'] | CodesOut]).
609		better_write_canonical_to_codes(Term, Codes, CodesOut) :-
610		compound(Term),
611		!,
612		Term =.. [Functor | Args],
613		write_canonical_to_codes(Functor, Codes, C1),
614		(length(Args, L), L=0 -> CodesOut=C1 ; (
615		C1 = [0'( | C2],
616		better_write_canonical_to_codes_list(Args, C2, [0') | CodesOut])
617		)).
618		better_write_canonical_to_codes(Term, Codes, CodesOut) :-
619		!, % fallback for variables and atomic terms
620		write_canonical_to_codes(Term, Codes, CodesOut).
621
622		better_write_canonical_to_codes_list([], Codes, CodesOut) :-
623		!,
624		CodesOut=Codes.
625		better_write_canonical_to_codes_list([H|T], Codes, CodesOut) :-
626		!,
627		better_write_canonical_to_codes(H, Codes, C1),
628		(T=[] -> C1=C2 ; C1=[0', | C2]),
629		better_write_canonical_to_codes_list(T, C2, CodesOut).
630
631		proper_list(L) :- nonvar(L), L=[], !.
632		proper_list(L) :- nonvar(L), L=[_|T], !, proper_list(T).